This chapter describes the services available when using and customizing Folders. The location for specific Folders services are listed within each individual service.
This chapter covers the following topics:
A typical service entry is similar to the following:
COLLECTION_ADMIN_SELECT_COLLECTION DocService 56 COLLECTION_PROFILE_SELECT_COLLECTION null null !csCollectionUnableToRetrieveCollections 3:evaluate:<$isAdmin="true"$>::null 3:loadAdminQueryConfig:::null
In this example:
the first line indicates the service name: COLLECTION_ADMIN_SELECT_COLLECTION.
the second line and third lines list the service's attributes:
Service class: DocService.
Access level: 54, indicating this is Scriptable, Global, and Admin permissions.
Template: COLLECTION_PROFILE_SELECT_COLLECTION
Service type: null
Subjects Notified: null
Error message and parameter used for error message: Unable to Retrieve Collections
The remainder of the entry lists the service's actions, each line designating one action:
action type: for example, 3, indicating a Java method.
action name: for example, evaluate
action parameters: for example, <$isAdmin="true"$>. If no parameters are specified, double colons (::) are included.
action control mask: for example, 0, indicating 'Ignore error' or 2, indicating 'Must exist (at least one record must be returned by the query). If no control mask is specified, double colons (::) or 0 is included.
action error message, such as Item No Longer In History, or null if no message is available.
Each element of the service's action is separated by a colon (:).
Important:
All services have at least one required parameter. The IdcService parameter takes the name of the service as its argument. If other parameters are required, they are noted in the description of the service.See "Customizing Services" for details about a service's attributes and actions.
Individual service types are noted in each service description. The following services are described in this section:
Service that creates a Oracle Content Server folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Additional Required Service Parameters
hasParentCollectionID: Defines (true/false) whether the folder being added as a parent folder. If set to true, dParentCollectionID must be defined.
dCollectionName: The folder name.
dParentCollectionID: The folder ID for the parent folder. Used when hasParentCollectionID is set to true.
dCollectionOwner: The folder owner (defined when the folder is created).
IdcService=COLLECTION_ADD hasParentCollectionID=true dCollectionName=Products dParentCollectionID=1 dCollectionOwner=bsmith
Service that adds a shortcut to a Oracle Content Server folder. The shortcut references the folder using either the folder ID or the actual path to the folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_services.htm
Additional Required Service Parameters
dCollectionID: The folder ID of the parent folder referenced by the shortcut.
dDocID: The content ID. Used when making a shortcut to a content item rather than a folder.
dLinkName: The shortcut destination.
dLinkType: The shortcut type. Must be either COLLECTION or CONTENT.
tohasCollectionID: Defines (true/false) whether the folder is referenced using the folder ID. If set to true, todCollectionID nust be defined.
todCollectionID: The folder ID that the shortcut references.
IdcService=COLLECTION_ADD_LINK dCollectionID=194 dLinkType=COLLECTION tohasCollectionID=false todCollectionID=" "
Service that maps a folder to a local file system. Whenever the folder changes, the mapped directory is updated.
There is no security on this directory.
The most likely errors are mismatched parameters or the folder does not exist.
Service Class: Search Service
Location: IdcHomeDir/components/Folders/resources/folders_mounted_service.htm
Service that loads the defined folder metadata and the folder path. The most likely errors are mismatched parameters or the folder does not exist.
Service Class: Search Service
Location: IdcHomeDir/components/folders_g/resources/folders_interface_service.htm
Additional Required Service Parameters
dCollectionID: The folder ID of the parent folder referenced by the shortcut.
For example, ="+id+"
hasCollectionID: Defines (true/false) whether the folder has an assigned collection ID.
changeToUser: Reassigns the folder to a different user.
IdcService=COLLECTION_BROWSE dCollectionID="+id+" hasCollectionID=true changeToUser=bsmith
Service that checks new content into a folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Class: Doc Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that checks in a revision to an existing folder.
This service sends the checkin request to one of the following subservices, which are the same subservices called during checkin through the browser or Repository Manager application. (These subservices are not called during a Batch Loader or Archive import.)
COLLECTION_CHECKIN_SEL_SUB
CHECKIN_SEL_FORM
COLLECTION_SEARCH_CONTENT
CHECKOUT_BY_NAMENULL
COLLECTION_LOCKNULL
DELETE_REVNULL
This service checks security to determine if the user has sufficient permission to check in the folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Class: Doc Service
Location: IdcHomeDir/components/folder/resources/folders_service.htm
Service that checks in a revision to an existing folder under certain conditions. Used when the folder exists on the system but no valid revision was specified or when the content item is checked out (but not in a workflow).
The most likely errors are mismatched parameters or the folder does not exist.
Service Class: Doc Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that copies all content residing in the specified folder to the destination folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that copies a specified Oracle Content Server folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that copies a single content item in a folder to a destination folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: File Service
Location: IdcHomeDir/components/folders_g/resources//folders_service.htm
Service that copies a group of folders. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that deletes all content residing in a folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that deletes a specified Oracle Content Server folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Search Service
Location: IdcHomeDir/components/folders_g/resources/olders_service.htm
Service that deletes a single content item in a folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Doc Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that deletes a group of folders. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Additional Required Service Parameters
tohasCollectionID: Defines (true/false) if the collection is referenced using the collection ID. If set to true, todCollectionID nust be defined.
todCollectionID: The folder ID that the shortcut references.
todCollectionPath: The URL path to the folder.
IdcService=COLLECTION_DELETE_LOT tohasCollectionID=true todCollectionID=194 todCollectionPath=""
Service that loads folder metadata and displays the defined folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Search Service
Location: IdcHomeDir/components/folders_g/resources/folders_interface_service.htm
Additional Required Service Parameters
hasCollectionID: Defines (true/false) if the folder has an assigned collection ID.
dCollectionPath: The folder containing the folder.
orderby: Defines the column to sort on.
direction: Defines the direction of the order as descending (DESC) or ascending (ASC).
IdcService=COLLECTION_DISPLAY dCollectionPath=%2fContent%20Server%20Folders%2f orderby=dName direction=ASC
Service that edits a Oracle Content Server folder. The most likely errors are mismatched parameters or the folder does not exist.
Service type: Doc Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Additional Required Service Parameters
hasCollectionID: Defines (true/false) if the folder has an assigned collection ID.
dCollectionID: The folder ID of the parent folder referenced by the shortcut.
Service that retrieves the current global values defined for the folders hierarchy. No specific collection is passed. The most likely errors are mismatched parameters or the folder does not exist.
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service Type: Service (general service)
Service that retrieves the current metadata fields that are propagated when it is requested. The most likely errors are mismatched parameters or the folder does not exist.
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that retrieves 'special' folders and their disabled/enabled status.
A disabled folder does not show up in the hierarchy. An enabled folder is accessible.
The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that retrieves the fields from the administration metadata ResultSet for the defined folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that retrieves the option lists for custom fields, default metadata, and the administration metadata of the folder configuration (retrieves field defaults).
The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Doc Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that retrieves the folders system configuration for the local folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Search Service
Location: IdcHomeDir/components/folders_g/resources/folders_mounted_service.htm
Service that downloads the archived folder structure of the specified folder. This service does not download the contents of a folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: File Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that retrieves the structure of the specified folder and its subfolders. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that retrieves all the subfolders of the specified folder. Compare COLLECTION_GET_COLLECTIONS. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Search Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that retrieves the Oracle Content Server folder. Compare COLLECTION_GET_COLLECTION. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Search Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
To retrieve a listing of hierarchical collections, the required parameters are:
hasCollectionID=1
dCollectionID=collectionnumber
Service that downloads the first content item of the specified collection that matches the metadata of the item passed in (excluding revisions). The most likely errors are mismatched parameters or the folder does not exist.
Service Type: File Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that retrieves all the sub-content of the specified folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Search Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that determines the type of item specified and then downloads its content. The item may or may not be a content item. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: File Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that retrieves Oracle Content Server folder information for the local folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Search Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that retrieves the specified shortcut (dLinkID). The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service used to retrieve the WebDAV equivalent properties of the specified folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service used to retrieve the Default Information Field Configuration for a specific user. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that retrieves the Revision Information Field Configuration values for a specific user. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service used to determine what type of item the path being passed in is referencing (Link, Content, or Folder). The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that retrieves the folder specific search form. The most likely errors are mismatched parameters or the folder does not exist.
Search Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that retrieves the files that are usually dynamically built at the time of the request and have no counterpart on the system. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: File Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that retrieves user specific configuration for the display and behavior of their folder structure. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location; IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that updates content that has been demoted by the Oracle Content Server indexer to the local folder by the new version. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_mounted_service.htm
Service that retrieves the metadata associated with this particular folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Doc Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Additional Required Service Parameters
hasCollectionID: Defines (true/false) if the folder has an assigned collection ID.
dCollectionID: The folder ID of the parent folder referenced by the shortcut.
Service that verifies that the folder can be added by the item of the specified metadata. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that checks out a folder by name (dDocName) and locks the folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Doc Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that moves the content in a specified folder to the destination folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that moves a folder. Compare COLLECTION_MOVE_ALL. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Search Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that moves a single content item (or link) from the specified folder to the destination folder. If an item with the same file name exists in the target folder, the move fails. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Doc Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that can move multiple references to folders and content items to a destination folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Additional Required Service Parameters
tohasCollectionID: Defines (true/false) if the folder is referenced using the folder ID.
If set to true, todCollectionID must be defined.
todCollectionID: The destination folder collection ID.
todCollectionPath: The URL path to the folder.
IdcService=COLLECTION_MOVE_LOT tohasCollectionID=true todCollectionID=194 todCollectionPath=""
Service used to create a new folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Doc Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Additional Required Service Parameters
hasParentCollectionID: Defines (true/false) if the folder being added as a parent folder. If set to true, dParentCollectionID must be defined.
dParentCollectionID: The folder ID for the parent folder. Used when hasParentCollectionID is set to true.
dCollectionInherit: Used to inherit folder metadata.
IdcService=COLLECTION_NEW hasParentCollectionID=true dParentCollectionID=1 dCollectionInherit=0
Service that updates user hierarchy columns. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Doc Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that rewrites the files of the specified local folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Search Service
Location: IdcHomeDir/components/folders_g/resources/folders_mounted_service.htm
Service that removes the specified local folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Search Service
Location: IdcHomeDir/components/folders_g/resources/folders_mounted_service.htm
Service that restores a folder that is currently in the 'Trash' folder to its original location. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Search Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that restores an item that is currently in the 'Trash' folder to its original location. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Search Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that retrieves all content that matches all of the metadata that is passed in for a content item. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Search Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that displays the search results of a folder search. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Search Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that takes the uploaded archive and applies it to the system. This service deletes any folders that are in conflict with the archive. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Doc Service
Location: IdcHomeDir/components/folders_g/resources/olders_service.htm
Service that sets the user configuration for the display and behavior of their folder structure. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that undoes a checkout of a content item and makes it available for use. This service frees content after a COLLECTION_LOCK. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Doc Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that updates information for a collection. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Additional Required Service Parameters
dCollectionName: The folder name.
hasParentCollectionID: Defines (true/false) whether the folder being added as a parent folder. If set to true, dParentCollectionID must be defined.
dParentCollectionID: The folder ID for the parent folder. Used when hasParentCollectionID is set to true.
dCollectionOwner: The folder owner (defined when the folder is created).
IdcService=COLLECTION_UPDATE dCollectionName=Products dParentCollectionID=1 dCollectionOwner=bsmith
Service that updates the folders system configuration settings. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that updates the folders system configuration setting by inheriting the metadata from an existing folder (from which metadata is propagated). The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that updates the folders system metadata field default system settings. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Doc Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that updates all items in a collection and changes the defined metadata. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Service (general service)
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that updates a specific item in a collection and changes the defined metadata. Folders related service (table Folders_Services). The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Doc Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that updates folder metadata. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Meta Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that updates a folder metadata table. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Meta Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that updates the files of the specified local folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Search Service
Location: IdcHomeDir/components/folders_g/resources/folders_mounted_service.htm
Service that updates the profile metadata field defaults. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Doc Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that updates the profile metadata field defaults of a revision. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Doc Service
Location: IdcHomeDir/components/folders_g/resources//folders_service.htm
Service that refreshes the folder cache. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Meta Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that displays a folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Doc Service
Location: IdcHomeDir/components/folders_g/resources/folders_service.htm
Service that displays the root folder. The most likely errors are mismatched parameters or the folder does not exist.
Service Type: Doc Service
Location: IdcHomeDir/components/folders_g/resources//folders_service.htm