Skip Headers
Oracle® Fusion Middleware Services Reference for Oracle WebCenter Content
11g Release 1 (11.1.1)

Part Number E11011-05
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

7 Contribution Folders Services

This chapter describes the Oracle WebCenter Content services available when using and customizing Contribution Folders services.

This chapter covers the following topics:

7.1 About Contribution Folders Services

Contribution Folders is the name given to what in earlier releases of WebCenter Content was named the Folders_g feature. Contribution Folders is supported by the Folders_g component in WebCenter Content. Contribution Folders services cannot be used with the current Folders feature (see Chapter 8).

Information about what is a WebCenter Content service and how services can be used is provided in Section 2, "Using Services." Information about basic services structure, attributes, actions, and a service example is provided in Section 3, "Customizing Services." You should be familiar with this information before customizing current services or creating new services

The locations and service types for specific Contribution Folders services are listed within each individual service.

Note:

The most commonly used services have more extensive descriptions.

7.2 Contribution Folders Services

The following services are described in this section:

7.2.1 COLLECTION_ADD

Service that creates a Contribution Folder. The most likely errors are mismatched parameters or the contribution folder does not exist.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Required Service Parameters

  • dCollectionName: The name of the Contribution Folder to create.

One of the following sets of parameters to identify the parent Contribution Folder:

  • hasParentCollectionID: (Boolean) Specifies whether the dParentCollectionID parameter is used to identify the parent Contribution Folder ID.

    dParentCollectionID: The parent Contribution Folder ID.

  • hasParentCollectionPath: (Boolean) Specifies whether the dParentCollectionPath parameter is used to identify the path to the parent Contribution Folder.

    dParentCollectionPath: The path to the parent Contribution Folder.

  • hasParentCollection GUID: (Boolean) Specifies that the dParentCollectionGUID parameter is used to identify the GUID for the parent Contribution Folder.

    dParentCollectionGUID: The parent Contribution Folder GUID.

Optional Service Parameters

  • dCollectionOwner: The Contribution Folder owner. If xForceFolderSecurity=TRUE, then the Contribution Folder owner is the same as the parent Contribution Folder's owner. Otherwise, the default is the current user.

    This setting overrides the user set as the the collection owner. The owner can access and modify the Contribution Folder despite other set security criteria.

  • dCollectionCreator: Overrides the user set as the Contribution Folder creator. The default value is the current user.

  • dCollectionModifier: Overrides the user set as the last Contribution Folder modifier. The default value is the current user.

  • ignoreMaxFolderLimit: Allows more subfolders to be added to the parent Contribution Folder than the currently set maximum limit. The default value is false.

  • mark: Sets dCollectionMark for the Contribution Folder. Contribution Folders with dCollectionMark set are not modifiable without CollectionReadOnlyMarkedFolders being set to false (not the default case). These marked Contribution Folders and their enabled/disabled state can be viewed on the System Folder Configuration page. Contribution Folders and Trash are marked folders.

  • force: Creates a Contribution Folder under the root Contribution Folder (dParentCollectionID=-1). The default value is false.

  • any system or custom metadata field: The given field and value will be set for the Contribution Folder and used as default values for content and Contribution Folders created within the Contribution Folder.

Example

IdcService=COLLECTION_ADD
hasParentCollectionID=true
dCollectionName=Products
dParentCollectionID=1
dCollectionOwner=bsmith

7.2.2 COLLECTION_ADD_LINK

Service that adds a shortcut to a Contribution Folder or content within a Contribution Folder. The shortcut references the Contribution Folder using either the Contribution Folder ID, the actual path to the Contribution Folder, or the Contribution Folder GUID.

The most likely errors are mismatched parameters or the Contribution Folder does not exist. No returned data.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_services.htm

Additional Required Service Parameters

  • One of the following sets of parameters to identify destination parent Contribution Folder for the created short cut:

    • tohasCollectionID: (Boolean) Specifies whether the todCollectionID parameter is used to identify the destination parent Contribution Folder ID.

      todCollectionID: The Contribution Folder ID that the shortcut references.

    • tohasCollectionPath: (Boolean) Specifies whether the todCollectionPath parameter is used to identify the path to the Contribution Folder.

      todCollectionPath: The path to the Contribution Folder that the shortcut references.

    • tohasCollectionGUID: (Boolean) Specifies whether the todCollectionGUID parameter is used to identify the Contribution Folder.

      todCollectionGUID: The GUID for the Contribution Folder that the shortcut references.

  • dLinkName: The name of the shortcut being created.

  • dLinkType: The type of shortcut being created. Must be either COLLECTION or CONTENT.

    • If COLLECTION is specified, then hasdCollectionID must be specified.

      hasdCollectionID: (Boolean) Specifies whether the Contribution Folder is referenced using a Collection ID.

      dCollectionID: The Contribution Folder ID of the parent Contribution Folder referenced by the shortcut.

    • If CONTENT is specified, then dRevClassID must be specified.

      dRevClassID: The revision class ID for the content item to which the shortcut points.

Example

IdcService=COLLECTION_ADD_LINK
tohasCollectionID=true
todCollectionID=999999999999000633
dLinkName=Shortcut
dLinkType=COLLECTION
hasdCollectionID=true
dCollectionID=999999999999004533

7.2.3 COLLECTION_BROWSE

Service that loads the defined Contribution Folder metadata and the Contribution Folder path. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Search Service

Location: IdcHomeDir/components/folders_g/resources/folders_interface_service.htm

Additional Required Service Parameters

  • dCollectionID: The Contribution Folder ID of the parent Contribution Folder referenced by the shortcut (for example, ="+id+").

  • hasCollectionID: (Boolean) Specifies whether the Contribution Folder has an assigned collection ID.

  • changeToUser: Reassigns the Contribution Folder to a different user.

Example

IdcService=COLLECTION_BROWSE
dCollectionID="+id+"
hasCollectionID=true
changeToUser=bsmith

7.2.4 COLLECTION_CHECKIN_NEW

Service that checks new content into a Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Doc Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.5 COLLECTION_CHECKIN_REVISION

Service that checks in a revision to an existing Contribution 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 Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Doc Service

Location: IdcHomeDir/components/folder/resources/folders_service.htm

7.2.6 COLLECTION_CHECKIN_SEL_SUB

Service that checks in a revision to an existing Contribution Folder under certain conditions. Used when the Contribution 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 Contribution Folder does not exist.

Service Class: Doc Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.7 COLLECTION_COPY_ALL

Service that copies all content residing in the specified Contribution Folder to the destination Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.8 COLLECTION_COPY_COLLECTION

Service that copies a specified Contribution Folder and places the copy into a different Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist. No returned data.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Required Service Paremeters

One of the following sets of parameters to identify the destination parent Contribution Folder for the copied Contribution Folder:

  • tohasCollectionID: (Boolean) Specifies whether the todCollectionID parameter is used to identify the destination parent Contribution Folder ID.

    todCollectionID: The destination parent Contribution Folder ID.

  • tohasCollectionPath: (Boolean) Specifies whether the todCollectionPath parameter is used to identify the path to the destination parent Contribution Folder.

    todCollectionPath: The path to the destination parent Contribution Folder.

  • tohasCollection GUID: (Boolean) Specifies whether the todCollectionGUID parameter is used to identify the destination parent Contribution Folder.

    todCollectionGUID: The destination parent Contribution Folder GUID.

One of the following sets of parameters to identify the source Contribution Folder to be copied:

  • fromhasCollectionID: (Boolean) Specifies whether the fromdCollectionID parameter is used to identify the the source Contribution Folder.

    fromdCollectionID: The source Contribution Folder ID.

  • fromhasCollectionPath: (Boolean) Specifies whether the fromdCollectionPath parameter is used to identify the path to the source Contribution Folder.

    fromdCollectionPath: The path to the source Contribution Folder.

  • fromhasCollectionGUID: (Boolean) Specifies whether the fromdCollectionGUID parameter is used to identify the source Contribution Folder.

    fromdCollectionGUID: The source Contribution Folder GUID.

  • fromisLink: (Boolean) Specifies whether the fromdLinkID parameter is used to identify the source Contribution Folder.

    fromdLinkID: The Contribution Folder shortcut ID for the source Contribution Folder

  • fromCollectionislink: (Boolean) Specifies whether the fromdCollectionLinkID parameter is used to identify the source Contribution Folder.

    fromdCollectionLinkID: The collection shortcut ID for the source Contribution Folder.

Example

IdcService=COLLECTION_COPY_COLLECTION
tohasCollectionID=true
todCollectionID=999999999999000633
fromhasCollectionID=true
fromdCollectionID=999999999999000633

7.2.9 COLLECTION_COPY_ITEM

Service that copies a single content item in a Contribution Folder and places it in a destination Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist. No returned data.

Service Class: File Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Required Service Parameters

  • dDocName: The content ID of the content item being copied.

One of the following sets of parameters to identify the destination Contribution Folder:

  • tohasCollectionID: (Boolean) Specifies whether the todCollectionID parameter is used to identify the destination Contribution Folder.

    todCollectionID: The ID for the destination Contribution Folder.

  • tohasCollectionPath: (Boolean) Specifies whether the todCollectionPath parameter is used to identify the destination Contribution Folder.

    todCollectionPath: The path to the destination Contribution Folder.

  • tohasCollectionGUID: (Boolean) Specifies whether the todCollectionGUID parameter is used to identify the destination Contribution Folder.

    todCollectionGUID: The GUID for the destination Contribution Folder.

  • tolevel0: Specifies the base value in the path for the destination parent Contribution Folder (for example, /Contribution Folders).

    tolevel1: Specifies the next level value in the path for the destination parent Contribution Folder (for example, /t4).

    tolevel2: Specifies the next level value in the path for the destination parent Contribution Folder (for example, /1).

Example

IdcService=COLLECTION_COPY_ITEM
tohasCollectionPath=true
todCollectionPath=/Contribution Folders/t4/1
dDocName=000660

7.2.10 COLLECTION_COPY_LOT

Service that copies a set of items including content items, Contribution Folders, shortcuts to content items, and shortcuts to Contribution Folders. The copied items are placed into a single designated Contribution Folder.

The most likely errors are mismatched parameters or the designated Contribution Folder does not exist. No returned data.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Required Service Parameters

One of the following sets of parameters to identify the destination parent Contribution Folder for the copied items:

  • tohasCollectionID: (Boolean) Specifies whether the todCollectionID parameter is used to identify the destination parent Contribution Folder.

    todCollectionID: The destination parent Contribution Folder ID.

  • tohasCollectionPath: (Boolean) Specifies whether the todCollectionPath parameter is used to identify the destination parent Contribution Folder.

    todCollectionPath: The path to the destination parent Contribution Folder.

  • tohasCollection GUID: (Boolean) Specifies whether the todCollectionGUID parameter is used to identify the destination parent Contribution Folder.

    todCollectionGUID: The desintation parent Contribution Folder GUID.

Parameters to designate content items (where {n} designates an integer used to distinguish parameters particular to one item to copy from other items to copy):

  • contentselect{n}: (Boolean) Specifies whether to copy the content item. The value must be true to copy the content item.

  • fromContentisLink{n}: (Boolean) Specifies whether this is a content item or a shortcut. The value must be 0 to specify a content item.

  • fromdDocName{n}: The content ID of the content item to be copied.

Parameters to designate shortcuts to content items (where {n} designates an integer used to distinguish parameters particular to one item to copy from other items to copy):

  • contentselect{n}: (Boolean) Specifies whether to copy the content item. The value must be true to copy the content item.

  • fromContentisLink{n}: (Boolean) Specifies whether this is a content item or a shortcut. The value must be 1 to specify a shortcut.

  • fromdDocName{n}: The content ID of the content item pointed to by the shortcut.

Parameters to designate Contribution Folders (where {n} designates an integer used to distinguish parameters particular to one item to copy from other items to copy):

  • collectionselect{n}: (Boolean) Specifieswhether to copy the Contribution Folder. The value must be true to copy the Contribution Folder.

  • fromCollectionisLink{n}: (Boolean) Specifies whether this is a Contribution Folder or a shortcut. The value must be 0 to specify a Contribution Folder.

  • fromdCollectionID{n}: The dCollectionID of the Contribution Folder being copied.

  • fromhasCollectionID{n}: The value must be 1 to copy the Contribution Folder.

Parameters to designate shortcuts to Contribution Folders (where {n} designates an integer used to distinguish parameters particular to one item to copy from other items to copy):

  • collectionselect{n}: (Boolean) Specifies whether to copy the shortcut to the Contribution Folder. The value must be true to copy the shortcut.

  • fromCollectionisLink{n}: (Boolean) Specifies whether this is a Contribution Folder or a shortcut. The value must be 1 to specify a shortcut.

  • fromCollectiondLinkID{n}: The link ID of the shortcut to be copied.

  • fromdCollectionID{n}: The dCollectionID of the Contribution Folder pointed to by the shortcut.

  • fromhasCollectionID{n}: The value must be 1 to copy the shortcut to the Contribution Folder.

Example

IdcService=COLLECTION_COPY_LOT
tohasdCollectionID=true
todCollectionID=999999999999000633
contentselect=true
fromContentisLink=0
fromdDocName=PHL11GX010033

7.2.11 COLLECTION_DELETE

Service that deletes Contribution Folders. If Trash is enabled, the Contribution Folder is moved to Trash and not directly deleted.

The most likely errors are mismatched parameters or the Contribution Folder does not exist. No returned data.

Service Class: Doc Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Required Service Parameters

One of the following parameter sets is required to identify the Contribution Folder.

  • hasCollectionID: (Boolean) Specifies that the dCollectionID parameter is used to identify the Contribution Folder.

    dCollectionID: The Contribution Folder ID of the Contribution Folder to delete.

  • hasCollectionPath: (Boolean) Specifies that the dCollectionPath parameter is used to identify the Contribution Folder.

    dCollectionPath: The path of the Contribution Folder to delete.

  • hasCollectionGUID: (Boolean) Specifies that the dCollectionGUID parameter is used to identify the Contribution Folder.

    dCollectionGUID: The GUID of the Contribution Folder to delete.

Example

IdcService=COLLECTION_DELETE
hasCollectionPath=true
dCollectionPath=/Contribution Folders/dept/hr

7.2.12 COLLECTION_DELETE_ALL

Service that deletes all content residing in a Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.13 COLLECTION_DELETE_COLLECTION

Service that deletes a specified Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Search Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.14 COLLECTION_DELETE_ITEM

Service that deletes a single content item in a Contribution Folder. If Trash is enabled, the item is moved to the Trash Contribution Folder and not directly deleted. The most likely errors are mismatched parameters or the Contribution Folder does not exist. No returned data.

Service Class: Doc Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Required Service Parameters

  • dDocName: The content ID of the content item to be deleted.

Example

IdcService=COLLECTION_DELETE_ITEM
dDocName=000660

7.2.15 COLLECTION_DELETE_LOT

Service that deletes a set of items including content items, Contribution Folders, shortcuts to content items, and shortcuts to Contribution Folders. If Trash is enabled, the items are moved to Trash and not directly deleted.

The most likely errors are mismatched parameters or the Contribution Folder does not exist. No returned data.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Required Service Parameters

Parameters to designate content items (where {n} designates an integer used to distinguish parameters particular to one item to delete from other items to delete):

  • contentselect{n}: (Boolean) Specifies whether to delete the content item. The value must be true to copy the content item.

  • fromContentisLink{n}: (Boolean) Specifies whether this is a content item or a shortcut. The value must be 0 to specify a content item.

  • fromdDocName{n}: The content ID of the content item to delete.

Parameters to designate shortcuts to content items (where {n} designates an integer used to distinguish parameters particular to one item to delete from other items to delete):

  • contentselect{n}: (Boolean) Specifies whether to delete the shortcut. The value must be true to delete the shortcut.

  • fromContentisLink{n}: (Boolean) Specifies whether this is a content item or a shortcut. The value must be 1 to specify a shortcut.

  • fromContentdLinkID{n}: The link ID of the shortcut.

  • fromdDocName{n}: The content ID of the content item pointed to by the shortcut.

Parameters to designate Contribution Folders (where {n} designates an integer used to distinguish parameters particular to one item to delete from other items to delete):

  • collectionselect{n}: (Boolean) Specifies whether to delete the Contribution Folder. The value must be true to delete the Contribution Folder.

  • fromCollectionisLink{n}: (Boolean) Specifies whether this is a Contribution Folder or a shortcut. The value must be 0 to specify a Contribution Folder.

  • fromdCollectionID{n}: The dCollectionID of the Contribution Folder to delete.

  • fromhasCollectionID{n}: The value must be 1 to delete the Contribution Folder.

Parameters to designate shortcuts to Contribution Folders (where {n} designates an integer used to distinguish parameters particular to one item to delete from other items to delete):

  • collectionselect{n}: (Boolean) Specifies whether to delete the shortcut to the Contribution Folder. The value must be true to delete the shortcut.

  • fromCollectionisLink{n}: (Boolean) Specifies whether this is a Contribution Folder or a shortcut. The value must be 1 to specify a shortcut.

  • fromCollectiondLinkID{n}: The link ID of the shortcut to delete.

  • fromdCollectionID{n}: The dCollectionID of the Contribution Folder pointed to by the shortcut.

  • fromhasCollectionID{n}: The value must be 1 to delete the shortcut to the Contribution Folder.

Example

IdcService=COLLECTION_DELETE_LOT
collectionselect=true
fromCollectionisLink=0
fromdCollectionID=999999999999004955
fromhasCollectionID=1

7.2.16 COLLECTION_DISPLAY

Service that returns a list of the items contained in a Contribution Folder, including content items, Contribution Folders and short cuts. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Search Service

Location: IdcHomeDir/components/folders_g/resources/folders_interface_service.htm

Additional Required Service Parameters

One of the following parameter sets is required to identify the Contribution Folder.

  • hasCollectionID: (Boolean) Specifies that the dCollectionID parameter is used to identify the Contribution Folder.

    dCollectionID: The collection ID of the Contribution Folder.

  • hasCollectionPath: (Boolean) Specifies that the dCollectionPath parameter is used to identify the Contribution Folder.

    dCollectionPath: The path of the Contribution Folder.

  • hasCollectionGUID: (Boolean) Specifies that the dCollectionIGUID parameter is used to identify the Contribution Folder.

    dCollectionGUID: The collection GUID for the Contribution Folder.

Optional Service Parameters

  • CollectionDisplayResultSetSize: Limits the number of items returned in the COLLECTIONS and CONTENTS ResultSets and establishes the page size.

  • showCollections: Flag that signals the web UI presentation to display the COLLECTIONS ResultSet. This is effective when using CollectionDisplayResultSetSize and PageNumber.

  • showContent: Flag that signals the web UI presentation to display the CONTENTS ResultSet. This is effective when using CollectionDisplayResultSetSize and PageNumber.

  • PageNumber: Integer value 1 or greater displays the correct page size subset of data from the CONTENTS or COLLECTIONS ResultSets. Page size is set by CollectionDisplayResultSetSize.

Results

  • ResultSets: (contain a row with Contribution Folder metadata for each Contribution Folder item directly contained by the Contribution Folder, including shortcuts to Contribution Folders)

    • CONTENTS

    • COLLECTIONS

    • METAMAPPING

    • COLUMNS

    • Fields

    • METADATA_OVERRIDE

    • PATH

    • metadata

Example

IdcService=COLLECTION_DISPLAY
hasCollectionPath=true
dCollectionPath=%2fContent%20Server%20Folders%2f

7.2.17 COLLECTION_EDIT

Service that edits a Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service type: Doc Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Required Service Parameters

  • hasCollectionID: (Boolean) Specifies whether the Contribution Folder has an assigned collection ID. If set to true, dCollectionID must be defined.

  • dCollectionID: The Contribution Folder ID of the parent Contribution Folder.

7.2.18 COLLECTION_GET_ADMIN_CONFIG

Service that retrieves the current global values defined for the Contribution Folders hierarchy. No specific collection is passed. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.19 COLLECTION_GET_ADMIN_INHERIT_CONFIG

Service that retrieves the current metadata fields that are propagated when it is requested. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.20 COLLECTION_GET_ADMIN_MARKED_CONFIG

Service that retrieves 'special' Contribution Folders and their disabled/enabled status. A disabled Contribution Folder does not show up in the hierarchy. An enabled Contribution Folder is accessible. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.21 COLLECTION_GET_ADMIN_META_CONFIG

Service that retrieves the fields from the administration metadata ResultSet for the defined Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.22 COLLECTION_GET_ADMIN_METADATA_DEFAULTS

Service that retrieves the option lists for custom fields, default metadata, and the administration metadata of the Contribution Folder configuration (retrieves field defaults). The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Doc Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.23 COLLECTION_GET_ADMIN_MOUNTED_CONFIG

Service that retrieves the Contribution Folders system configuration for the local Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Search Service

Location: IdcHomeDir/components/folders_g/resources/folders_mounted_service.htm

7.2.24 COLLECTION_GET_ARCHIVE

Service that downloads the archived Contribution Folder structure of the specified Contribution Folder. This service does not download the contents of a Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: File Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.25 COLLECTION_GET_BRANCH

Service that retrieves the structure of the specified Contribution Folder and its subfolders. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.26 COLLECTION_GET_COLLECTION

Service that retrieves all the subfolders of the specified Contribution Folder. Compare COLLECTION_GET_COLLECTIONS. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Search Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.27 COLLECTION_GET_COLLECTIONS

Service that retrieves the Contribution Folder. Compare COLLECTION_GET_COLLECTION. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Search Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Example

To retrieve a listing of hierarchical collections, the required parameters are:

hasCollectionID=1
dCollectionID=collectionnumber

7.2.28 COLLECTION_GET_CONTENT_FILE

Service that downloads the first content item of the specified Contribution Folders collection that matches the metadata of the item passed in (excluding revisions). The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: File Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.29 COLLECTION_GET_CONTENTS

Service that retrieves information for the content items contained directly in the specified Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Search Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Required Service Parameters

One of the following parameter sets is required to identify the Contribution Folder.

  • hasCollectionID: (Boolean) Specifies that the dCollectionID parameter is used to identify the Contribution Folder.

    dCollectionID: The Contribution Folder ID of the Contribution Folder.

  • hasCollectionPath: (Boolean) Specifies that the dCollectionPath parameter is used to identify the Contribution Folder.

    dCollectionPath: The path of the Contribution Folder.

  • hasCollectionGUID: (Boolean) Specifies that the dCollectionGUID parameter is used to identify the Contribution Folder.

    dCollectionGUID: The GUID of the Contribution Folder.

Results

  • ResultSets:

    • CONTENTS (contains a row with content metadata for each content item contained in the Contribution Folder)

Example

IdcService=COLLECTION_GET_CONTENTS
hasCollectionID=true
dCollectionID=999999999999000633

7.2.30 COLLECTION_GET_FILE

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 Contribution Folder does not exist.

Service Class: File Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.31 COLLECTION_GET_INFO

Service that retrieves Contribution folder information for the local Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Search Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Required Service Parameters

One of the following parameter sets is required to identify the Contribution Folder.

  • hasCollectionID: (Boolean) Specifies whether the dCollectionID parameter is used to identify the Contribution Folder.

    dCollectionID: The Contribution Folder ID of the Contribution Folder.

  • hasCollectionPath: (Boolean) Specifies whether the dCollectionPath parameter is used to identify the Contribution Folder.

    dCollectionPath: The path of the Contribution Folder.

  • hasCollectionGUID: (Boolean) Specifies that the dCollectionGUID parameter is used to identify the Contribution Folder.

    dCollectionGUID: The GUID of the Contribution Folder.

Results

  • ResultSets:

    • PATH (contains a row with Contribution Folder metadata for each Contribution Folder in the Contribution Folder's path)

Example

IdcService=COLLECTION_GET_INFO
hasCollectionID=true
dCollectionID=999999999999000633

7.2.32 COLLECTION_GET_LINKS

Service that retrieves information about the specified shortcut (dLinkID) to a content item or Contribution Folder. The most likely errors are mismatched parameters or the item or Contribution Folder does not exist.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Required Service Parameters

  • dLinkID: The link ID for a shortcut to a content item or Contribution Folder.

Optional Service Parameters

  • resultSetName: Sets the name of the returned ResultSet. The default value is LINKS.

Results

  • ResultSets:

    • $resultSetName$ (the ResultSet containing shortcut information for a content item or a Contribution Folder)

7.2.33 COLLECTION_GET_META_MAPPING

Service used to retrieve the WebDAV equivalent properties of the specified Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.34 COLLECTION_GET_PROFILE_METADATA_DEFAULTS

Service used to retrieve the Default Information Field Configuration for a specific user. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.35 COLLECTION_GET_PROFILE_METADATA_REVISION_DEFAULTS

Service that retrieves the Revision Information Field Configuration values for a specific user. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.36 COLLECTION_GET_REFERENCE

Service used to determine the existence of an item within the Contribution Folder hierarchy, and if the item exists, whether it is a Contribution Folder, content item, or a shortcut. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Required Service Parameters

One of the following parameter sets is required to identify the path.

  • hasCollectionPath: (Boolean) Specifies whether the dCollectionPath parameter is used to identify the parent Contribution Folder.

    dCollectionPath: The path of the parent Contribution Folder.

  • level0: The primary level of the parent Contribution Folder.

    level1: The secondary level of the parent Contribution Folder.

    level2: The content item within the Contribution Folder.

Optional Service Parameters

  • RevisionHistory: (Boolean) Specifies whether to include the REVISION_HISTORY result set if a content item is selected. The default value is false.

Results

  • isCollection: (Boolean) Is true if the referenced path represents a Contribution Folder.

  • isContent: (Boolean) Is true if the referenced path represents a content item. If both isCollection and isContent are false, then no item exists with the given path.

  • isLink: (Boolean) Is true if the referenced path represents a shortcut. If missing, the value is assumed false.

  • ResultSets:

    • REVISION_HISTORY (only included if the RevisionHistory and isContent parameters are true)

Partial item information is returned for the referenced item in the binder's local data (Doc Info or Contribution Folder Info).

7.2.37 COLLECTION_GET_SEARCH_FORM

Service that retrieves the Contribution Folder specific search form. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Search Type: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.38 COLLECTION_GET_SYSTEM_FILE

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 Contribution Folder does not exist.

Service Class: File Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.39 COLLECTION_GET_USER_CONFIG

Service that retrieves user specific configuration for the display and behavior of their Contribution Folder structure. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Service (general service)

Location; IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.40 COLLECTION_INFO

Service that retrieves the metadata associated with this particular Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Doc Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Required Service Parameters

One of the following sets of parameters to identify the Contribution Folder:

  • hasCollectionID: (Boolean) Specifies whether the dCollectionID parameter is used to identify the Contribution Folder.

    dCollectionID: The Contribution Folder ID of the Contribution Folder referenced by the shortcut.

  • hasCollectionPath: (Boolean) Specifies whether the dCollectionPath parameter is used to identify the Contribution Folder.

    dCollectionPath: The path of the Contribution Folder.

  • hasCollectionGUID: (Boolean) Specifies whether the dCollectionGUID parameter is used to identify the Contribution Folder.

    dCollectionGUID: The GUID of the Contribution Folder.

Results

  • canReadCollection: (Boolean) Is true if the requesting user has read privilege for the Contribution Folder.

  • canWriteCollection: (Boolean) Is true if the requesting user has write privilege for the Contribution Folder.

  • canAdminCollection: (Boolean) Is true if the requesting user has admin privilege for the Contribution Folder.

  • ResultSets:

    • PATH (contains a row with Contribution Folder information for every Contribution Folder in the Contribution Folder's path)

    • DocFormats

    • ClbraProjectsAccessLists

    • DocTypes

    • metadata

7.2.41 COLLECTION_ISVALID_META

Service that verifies that the Contribution Folder can be added by the item of the specified metadata. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.42 COLLECTION_LOCK

Service that checks out a Contribution Folder by name (dDocName) and locks the Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Doc Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.43 COLLECTION_MOVE_ALL

Service that moves all of the content in a specified Contribution Folder into a different Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist. No returned data.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Required Service Parameters

One of the following sets of parameters to identify the current source Contribution Folder of items to move:

  • fromhasCollectionID: (Boolean) Specifies whether the fromdCollectionID parameter is used to identify the source Contribution Folder.

    fromdCollectionID: The source Contribution Folder ID.

  • fromhasCollectionPath: (Boolean) Specifies whether the fromdCollectionPath parameter is used to identify the source Contribution Folder.

    fromdCollectionPath: The path to the source Contribution Folder.

  • fromhasCollectionGUID: (Boolean) Specifies whether the fromdCollectionGUID parameter is used to identify the source Contribution Folder.

    fromdCollectionGUID: The source Contribution Folder GUID.

One of the following sets of parameters to identify the destination Contribution Folder:

  • tohasCollectionID: (Boolean) Specifies whether the todCollectionID parameter is used to identify the destination parent Contribution Folder.

    todCollectionID: The ID for the destination parent Contribution Folder.

  • tohasCollectionPath: (Boolean) Specifies whether the todCollectionPath parameter is used to identify the destination parent Contribution Folder.

    todCollectionPath: The path to the destination parent Contribution Folder.

  • tohasCollectionGUID: (Boolean) Specifies whether the todCollectionGUID parameter is used to identify the destination parent Contribution Folder.

    todCollectionGUID: The GUID for the destination parent Contribution Folder.

  • tolevel0: Specifies the base value in the path for the destination parent Contribution Folder (for example, /Contribution Folders).

    tolevel1: Specifies the next level value in the path for the destination parent Contribution Folder (for example, /t4).

    tolevel2: Specifies the next level value in the path for the destination parent Contribution Folder (for example, /1).

Example

IdcService=COLLECTION_MOVE_ALL
fromhasCollectionPath=true
fromdCollectionPath=/Contribution Folders/B/1
tohasCollectionPath=true
todCollectionPath=/Contribution Folders/t4/1

7.2.44 COLLECTION_MOVE_COLLECTION

Service that moves a folder into a different Contribution Folder. Compare COLLECTION_MOVE_ALL. The most likely errors are mismatched parameters or the Contribution Folder does not exist. No returned data.

Service Class: Search Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Required Service Parameters

One of the following sets of parameters to identify the Contribution Folder to move:

  • fromhasCollectionID: (Boolean) Specifies that the fromdCollectionID parameter is used to identify the source Contribution Folder.

    fromdCollectionID: The source Contribution Folder ID.

  • fromhasCollectionPath: (Boolean) Specifies whether the fromdCollectionPath parameter is used to identify the source Contribution Folder.

    fromdCollectionPath: The path to the source Contribution Folder.

  • fromhasCollectionGUID: (Boolean) Specifies whether the fromdCollectionGUID parameter is used to identify the source Contribution Folder.

    fromdCollectionGUID: The source Contribution Folder GUID.

One of the following sets of parameters to identify the destination parent Contribution Folder:

  • tohasCollectionID: (Boolean) Specifies whether the todCollectionID parameter is used to identify the destination parent Contribution Folder.

    todCollectionID: The ID for the destination parent Contribution Folder.

  • tohasCollectionPath: (Boolean) Specifies whether the todCollectionPath parameter is used to identify the destination parent Contribution Folder.

    todCollectionPath: The path to the destination parent Contribution Folder.

  • tohasCollectionGUID: (Boolean) Specifies whether the todCollectionGUID parameter is used to identify the destination parent Contribution Folder.

    todCollectionGUID: The GUID for the destination parent Contribution Folder.

  • tolevel0: Specifies the base value in the path for the destination parent Contribution Folder (for example, /Contribution Folders).

    tolevel1: Specifies the next level value in the path for the destination parent Contribution Folder (for example, /t4).

    tolevel2: Specifies the next level value in the path for the destination parent Contribution Folder (for example, /1).

Example

IdcService=COLLECTION_MOVE_COLLECTION
fromhasCollectionID=true
fromdCollectionID=257
tohasCollectionID=true
todCollectionID=218

7.2.45 COLLECTION_MOVE_ITEM

Service that moves a single content item (or link) from the specified Contribution Folder to the destination Contribution Folder. If an item with the same file name exists in the target Contribution Folder, the move fails. The most likely errors are mismatched parameters or the Contribution Folder does not exist. No returned data.

Service Class: Doc Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Required Service Parameters

  • One of the following sets of parameters to identify the destination Contribution Folder:

    • tohasCollectionID: (Boolean) Specifies whether the todCollectionID parameter is used to identify the destination Contribution Folder.

      todCollectionID: The ID for the destination Contribution Folder.

    • tohasCollectionPath: (Boolean) Specifies whether the todCollectionPath parameter is used to identify the destination Contribution Folder.

      todCollectionPath: The path to the destination Contribution Folder.

    • tohasCollectionGUID: (Boolean) Specifies whether the todCollectionGUIID parameter is used to identify the destination Contribution Folder.

      todCollectionGUID: The GUID for the destination Contribution Folder.

    • tolevel0: Specifies the first value in the path for the destination Contribution Folder (for example, /Contribution Folders).

      tolevel1: Specifies the next level value in the path for the destination Contribution Folder (for example, /t4).

      tolevel2: Specifies the next level value in the path for the destination Contribution Folder (for example, /1).

  • One of the following sets of parameters to identify the content item to move:

    • dDocName: The Content ID for the content item.

    • fromhasCollectionPath: (Boolean) Specifies whether the fromhasCollectionPath parameter is used to identify the Contribution Folder for the content item.

      fromdCollectionPath: The path to the Contribution Folder for the content item.

    • isLink: (Boolean) Specifies whether the dLinkID parameter is used to identify the shortcut to the content item.

      dLinkID: The Link ID for the shortcut to the content item.

Optional Service Parameters

  • toContentName: New file name for the moved item.

  • destMustExist: Defines (true/false) whether the destination for the item or link to move must exist. If this parameter is false or missing, and no destination Contribution Folder is specified, then the item is removed from its current Contribution Folder (xCollectionID is set to 0).

Example

IdcService=COLLECTION_MOVE_ITEM
tohasCollectionID=true
todCollectionID=218
dDocName=TG000570
toContentName=moved_name.txt

7.2.46 COLLECTION_MOVE_LOT

Service that moves a set of items including Contribution Folders, content items, and shortcuts to Contribution Folders and content items to a single destination Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist. No returned data.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Required Service Parameters

One of the following sets of parameters to identify the destination parent Contribution Folder for the moved items.

  • tohasCollectionID: (Boolean) Specifies whether the todCollectionID parameter is used to identify the destination parent Contribution Folder.

    todCollectionID: The Contribution Folder collection ID.

  • tohasCollectionPath: (Boolean) Specifies whether the todCollectionPath parameter is used to identify the path to the destination Contribution Folder.

    todCollectionPath: The path to the destination Contribution Folder.

  • tohasCollectionGUID: (Boolean) Specifies whether the todCollectionGUID parameter is used to identify the destination Contribution Folder.

    todCollectionGUID: The GUID for the destination Contribution Folder.

Parameters required to designate content items. {n} designates an integer used to distinguish parameters particular to one item to move from other items to move.

  • contentselect{n}: (Boolean) Specifies whether to move the content item. To move the item, the value must be true.

  • fromContentisLink{n}: (Boolean) If the item is a content item and not a shortcut, the value must be 0.

  • fromdDocName{n}: The content ID of the item to move.

Parameters required to designate shortcuts to content items. {n} designates an integer used to distinguish parameters particular to one item to move from other items to move.

  • contentselect{n}: (Boolean) Specifies whether to move the shortcut. To move the shortcut, the value must be true.

  • fromContentisLink{n}: (Boolean) Specifies whether this is a shortcut and not a content item. If the item is a shortcut, the value must be 1.

  • fromContentdLinkID{n}: The link ID of the shortcut to move.

  • fromdDocName{n}: The content ID of the content item pointed to by the shortcut.

Parameters required to designate Contribution Folders. {n} designates an integer used to distinguish parameters particular to one item to move from other items to move.

  • collectionselect{n}: (Boolean) Specifies whether to move the Contribution Folder. To move the shortcut, the value must be true.

  • fromCollectionisLink{n}: (Boolean) Specifies whether this is a Contribution Folder and not a shortcut. If this is a Contribution Folder, the value must be 0.

  • fromdCollectionID{n}: The dCollectionID of the Contribution Folder to move.

  • fromhasCollectionID{n}: To move the Contribution Folder, the value must be 1.

Parameters required to designate shortcuts to Contribution Folders. {n} designates an integer used to distinguish parameters particular to one item to move from other items to move.

  • collectionselect{n}: (Boolean) Specifies whether to move the shortcut. To move the shortcut, the value must be true.

  • fromCollectionisLink{n}: (Boolean) Specifies whether this is a shortcut and not a Contribution Folder. If this is a shortcut, the value must be 1.

  • fromdCollectiondLinkID{n}: = The link ID of the shortcut to move.

  • fromdCollectionID{n}: The dCollectionID of the Contribution Folder pointed to by the shortcut.

  • fromhasCollectionID{n}: To move the Contribution Folder shortcut, the value must be 1.

Example

IdcService=COLLECTION_MOVE_LOT
tohasCollectionID=true
docCollectionID=999999999999000633
contentselect1=true
fromContentisLink1=0
fromdDocName1=PHL11GX010033

7.2.47 COLLECTION_NEW

Service used to create a new Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Doc Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Required Service Parameters

  • hasParentCollectionID: (Boolean) Specifies whether the Contribution Folder being added as a parent Contribution Folder. If set to true, dParentCollectionID must be defined.

  • dParentCollectionID: (Boolean) Specifies whether the Contribution Folder ID for the parent Contribution Folder. Used when hasParentCollectionID is set to true.

  • dCollectionInherit: (Boolean) Specifies whether to inherit Contribution Folder metadata.

Example

IdcService=COLLECTION_NEW
hasParentCollectionID=true
dParentCollectionID=1
dCollectionInherit=0

7.2.48 COLLECTION_PROFILE_GET_COLUMNS

Service that return user hierarchy column information and metadata field information. There are no parameters.

Service Class: Doc Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Returned Data

  • ResultSets:

    • COLUMNS (User-specific column set.) If the requesting user has not selected columns, the default columns returned are:

      • dFileSize

      • dDocType

      • dDocAuthor

      • dSecurityGroup

    • metadata (information about system and custom metadata fields)

7.2.49 COLLECTION_PROFILE_UPDATE_COLUMNS

Service that updates user hierarchy columns. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Doc Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.50 COLLECTION_RESTORE_COLLECTION

Service that restores a Contribution Folder that is currently in the Trash folder to its original location. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Search Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.51 COLLECTION_RESTORE_ITEM

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 Contribution Folder does not exist.

Service Class: Search Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.52 COLLECTION_SEARCH_CONTENT

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 Contribution Folder does not exist.

Service Class: Search Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.53 COLLECTION_SEARCH_RESULTS

Service that displays the search results of a search for Contribution Folders that match search criteria. Fields used for the search operands are those in the COLMETA and COLLECTIONS table. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Search Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Optional Service Parameters

  • ResultCount: Limits the number of items returned in the SearchResuls result set. The default is 25.

  • SortField: Field used as a sort key. The default is dCollectionName.

  • SortOrder: The sort direction. The default is ASC (ascending).

  • fieldname: Name of the field to be used as part of a string search condition. Example: dSecurityGroup=true

  • opfieldname: Operator, relative to the name field, to be used in a string search condition. Example: opdSecurityGroup=hasAsSubstring

  • comparefieldname: Value to be use in a string search condition, relative to named field. Example: comparedSecurityGroup=public

  • fieldnameLE or fieldnameGE: Field and value to be used in a date search condition. Example: dCreateDatedateLE=2008-03-01 00:01:00

Results

  • ResultSets:

    • SearchResults (list of Contribution Folders, with metadata, matching the search conditions)

Examples

  • startsWith search:

    dCollectionName=true&opdCollectionName=beginsWith&comparedCollectionName=a
    
  • endsWith search:

    dCollectionName=true&opdCollectionName=endsWith&comparedCollectionName=12
    
  • exact string match search:

    dCollectionName=true&opdCollectionName=equals&comparedCollectionName=A-EZ-9
    
  • field not empty search:

    dDocTitle=true&opdDocTitle=hasAsSubstring&comparedDocTitle=%
    
  • boolean field search:

    xBooleanTestField=true&opxBooleanTestField=equals&comparexBooleanTestField=1
    
  • later than search:

    dCreateDatedateGE=2009-10-01 00:01:00
    
  • earlier than search

    dCreateDatedateLE=2008-03-01 00:01:00 
    

7.2.54 COLLECTION_SET_ARCHIVE

Service that takes the uploaded archive and applies it to the system. This service deletes any Contribution Folders that are in conflict with the archive. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Doc Service

Location: IdcHomeDir/components/folders_g/resources/olders_service.htm

7.2.55 COLLECTION_SET_USER_CONFIG

Service that sets the user configuration for the display and behavior of their folder structure. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.56 COLLECTION_UNLOCK

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 Contribution Folder does not exist.

Service Class: Doc Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.57 COLLECTION_UPDATE

Service that modifies field data for a Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist. No returned data.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Required Service Parameters

One of the following sets of parameters to identify the Contribution Folder:

  • hasCollectionID: (Boolean) Specifies whether the dCollectionID parameter is used to identify the Contribution Folder.

    dCollectionID: The Contribution Folder ID.

  • hasCollectionPath: (Boolean) Specifies whether the dCollectionPath parameter is used to identify the Contribution Folder.

    dCollectionPath: The path of the Contribution Folder.

  • hasCollectionGUID: (Boolean) Specifies whether the dCollectionGUID parameter is used to identify the Contribution Folder.

    dCollectionGUID: The GUID of the Contribution Folder.

Optional Service Parameters

  • dCollectionName: Collection ID for the Contribution Folder.

  • dCollectionMark:

  • dCollectionEnabled:

  • dPromptForMetadata:

  • dCreateDate: Date the content item was created.

  • dInDate: Content release date.

  • dOutDate: Content expiration date.

  • dReleaseDate: Release state (used to indicate the Web state of the revision).

  • dLastModifiedDate: Date of the last modification to the content item.

  • dDocName: Content ID for the content item.

  • dDocType: Content item type.

  • dDocTitle: Content item title.

  • dDocAuthor: Content iem author.

  • dRevLabel: Revision label for the content item. If set, the label is used to locate the specified revision.

  • dSecurityGroup: Security group such as Public or Secure.

  • dDocAccount: Account for the content item. Required only if accounts are enabled.

  • dCollectionOwner: Contribution Folder owner.

  • dCollectionCreator: Overrides the user set as the Contribution Folder creator. The default value is the current user.

  • dCollectionModifier: Overrides the user set as the last Contribution Folder modifier. The default value is the current user.

  • x?????: Any of the fields as defined in the ColMeta table, which must exactly match the custom metadata fields in DocMeta.

Example

IdcService=COLLECTION_UPDATE
dCollectionName=Products
dParentCollectionID=1
dCollectionOwner=bsmith

7.2.58 COLLECTION_UPDATE_ADMIN_CONFIG

Service that updates the Contribution Folders system configuration settings. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.59 COLLECTION_UPDATE_ADMIN_INHERIT_CONFIG

Service that updates the Contribution Folders system configuration setting by inheriting the metadata from an existing Contribution Folder (from which metadata is propagated). The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.60 COLLECTION_UPDATE_ADMIN_METADATA_DEFAULTS

Service that updates the Contribution Folders system metadata field default system settings. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Doc Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.61 COLLECTION_UPDATE_ALL

Service that updates all items in a collection and changes the defined metadata. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.62 COLLECTION_UPDATE_ITEM

Service that updates a specific item in a collection and changes the defined metadata. Contribution Folders related service (table Folders_Services). The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Doc Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.63 COLLECTION_UPDATE_META

Service that propagates metadata values from a Contribution Folder to all underlying Contribution Folders and content. The most likely errors are mismatched parameters or the Contribution Folder does not exist. No returned data.

Service Class: Meta Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Required Service Parameters

One of the following sets of parameters to identify the Contribution Folder:

  • hasCollectionID: (Boolean) Specifies that the dCollectionID parameter is used to identify the Contribution Folder.

    dCollectionID: The Contribution Folder ID of the parent Contribution Folder.

  • hasCollectionPath: (Boolean) Specifies that the dCollectionPath parameter is used to identify the Contribution Folder.

    dCollectionPath: The path of the parent Contribution Folder.

  • hasCollectionGUID: (Boolean) Specifies that the dCollectionGUID parameter is used to identify the Contribution Folder.

    dCollectionGUID: The GUID of the parent Contribution Folder.

Example

IdcService=COLLECTION_UPDATE_META
hasCollectionGUID=true
dCollectionGUID=5A2E5617-7F95-7356-D923-F6DA894D489C

7.2.64 COLLECTION_UPDATE_META_TABLE

Service that updates a Contribution Folder metadata table. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Meta Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.65 COLLECTION_UPDATE_PROFILE_METADATA_DEFAULTS

Service that updates the profile metadata field defaults. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Doc Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.66 COLLECTION_UPDATE_PROFILE_METADATA_REVISION_DEFAULTS

Service that updates the profile metadata field defaults of a revision. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Doc Service

Location: IdcHomeDir/components/folders_g/resources//folders_service.htm

7.2.67 COLLECTION_UPDATE_STRUCTURE

Service that refreshes the Contribution Folder cache. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Meta Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.68 COLLECTION_VERIFY_FOLDER_NAME

Service that validates that the given Contribution Folder name is a valid name for a Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Required Service Parameters

One of the following sets of parameters to identify the Contribution Folder:

  • dCollectionName: The Collection ID for the Contribution Folder.

  • hasCollectionPath: (Boolean) Specifies that the dCollectionPath parameter is used to identify the Contribution Folder.

    dCollectionPath: The path of the parent Contribution Folder.

Optional Service Parameters

  • CollectionSkipIllegalFolderValidation: Allows all validation to be skipped except csCollectionFolderHasNoName. The default is false.

Configuration Parameters

  • CollectionIllegalFolderCharacters: String containing any illegal characters to use in a folder name. The default is /\:*?"<>¦

  • dCollectionNameSize: Maximum number of characters for a Contribution Folder name. The default is 100.

  • CollectionIllegalFolderPattern_1: A regular expression. If the expression matches the Contribution Folder name, the verification will fail. The default is \\..*

  • CollectionIllegalFolderPattern_2: A regular expression. If the expression matches the Contribution Folder name, the verification will fail. The default is .*\\.

  • CollectionIllegalFolderPattern_3: A regular expression. If the expression matches the Contribution Folder name, the verification will fail. The default is com[\\d]

  • CollectionIllegalFolderPattern_4: A regular expression. If the expression matches the Contribution Folder name, the verification will fail. The default is lpt[\\d]

  • CollectionIllegalFolderPattern_5: A regular expression. If the expression matches the Contribution Folder name, the verification will fail. The default is con

  • CollectionIllegalFolderPattern_6: A regular expression. If the expression matches the Contribution Folder name, the verification will fail. The default is nul

  • CollectionIllegalFolderPattern_7: A regular expression. If the expression matches the Contribution Folder name, the verification will fail. The default is prn

Additional CollectionIllegalFolderPattern_{n} variables can be added. They are evaluated by the service as long as they are in sequence.

Results

  • ResultSets:

    • SUCCESS

    • FAILED (csCollectionFolderHasNoName)

    • FAILED (csCollectionInvalidCharacter:pos=position of first bad char)

    • FAILED (csCollectionNameTooLong:folder name,number of extra characters)

    • FAILED (csCollectionIllegalPatternMatch:folder name,illegal folder pattern)

Example

IdcService=COLLECTION_VERIFY_FOLDER_NAME
hasCollectionPath=true
dCollectionPath=/Contribution Folders/dept/hr
CollectionSkipIllegalFolderValidation=true
dCollectionNameSize=90

7.2.69 FOLDERSLOCAL_BUILD_MOUNT

Service that rewrites the files of the specified local Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Search Service

Location: IdcHomeDir/components/folders_g/resources/folders_mounted_service.htm

7.2.70 FOLDERSLOCAL_CREATE_MOUNT

Service that maps a Contribution Folder to a local file system. Whenever the Contribution Folder changes, the mapped directory is updated.

There is no security on this directory.

The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: SearchService

Location: IdcHomeDir/components/Folders/resources/folders_mounted_service.htm

7.2.71 FOLDERSLOCAL_DELETE_MOUNT

Service that removes the specified local Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Search Service

Location: IdcHomeDir/components/folders_g/resources/folders_mounted_service.htm

7.2.72 FOLDERSLOCAL_UPDATE_MOUNT

Service that updates the files of the specified local Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Search Service

Location: IdcHomeDir/components/folders_g/resources/folders_mounted_service.htm

7.2.73 GET_FOLDER_HISTORY_REPORT

Service that retrieves history data for Contribution Folders. The requesting user must have admin role.

Service Class: DocService

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

Additional Required Service Parameters

  • actionDateGreaterThan: A date in ODBC format. All history data from two minutes before this time and later is returned. The two minutes is a margin for load-balanced servers. The default value is five minutes before the current time.

Results

  • ResultSets

    • HistoryReport: Each row contains information about a Contribution Folder history event: rename, update, move, or delete.

Example

IdcService=GET_FOLDER_HISTORY_REPORT
actionDateGreaterThan={ts '2010-09-09 18:04:06.293'}

7.2.74 GET_OPTION_LISTS

Contribution Folders-related service that retrieves the option lists. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Service (general service)

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.75 GOTO_COLLECTION

Service that displays a Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Doc Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm

7.2.76 GOTO_ROOT_COLLECTION

Service that displays the root Contribution Folder. The most likely errors are mismatched parameters or the Contribution Folder does not exist.

Service Class: Doc Service

Location: IdcHomeDir/components/folders_g/resources/folders_service.htm