Services in the Content Management toolkit

The following services are available in the Content Management toolkit for creating user interfaces to work with documents.

Table 1. Services in the Content Management toolkit
Service name Description Data type
BPM Content Store Search service The service that is used to search for folders and documents in the BPM content store.

The view builds the search query based on the values of the other configuration options for the view, and then passes the query to the search service.

Content Store Search Service
Input
  • maxItems(Integer)
  • skipCount(Integer)
  • searchAllVersions(Boolean)
  • cmisQuery (String)
The input parameters have no default values.
Output
  • searchResult(ECMSearchResult)
ECM Add external reference service Adds an external document or folder reference to the BPM managed store. ECM Add external reference service
Input
  • objectId (ECMID)
  • parentFolderId (ECMID)
  • referenceServerName (String)
  • referenceName (String)
  • serverName (String)
  • type (String)
The input parameters have no default value.
Output
None
ECM Get document service The default service that returns the document. ECM Get document service
Input
  • documentId (ECMID)
  • serverName (String) The name of the ECM Server repository.
The input parameters have no default values.
Output
  • document (ECMDocument)
ECM Get type definition service The default service that returns the type definition for the document view. ECM Get type definition service
Input
  • objectTypeId (ECMID)
  • serverName (String) The name of the ECM Server repository.
The input parameters have no default values.
Output
  • typeDefinition (ECMObjectTypeDefinition)
ECM Get type descendants service The service that returns a list of type descendants to a given depth. ECM Get type descendants service
Input
  • objectTypeId (ECMID) Used to pass the documentClassId
  • serverName (String) The name of the ECM Server repository.
  • depth (integer) Sets the descendants hierarchy depth. The default value is -1.
  • includePropertyDefintions (Boolean)
Output
  • typeDefinitions (ECMObjectTypeDefinition)(List)
ECM Get folder service The service that returns a folder. ECM Get folder service
Input
  • folderId (ECMID)
  • serverName (String) The name of the ECM Server repository.
The input parameters have no default values.
Output
  • folder (ECMFolder)
ECM Get folder by path service Gets a folder based on the specified path. ECM Get folder by path service
Input
  • path (String)
  • serverName (String)
The input parameters have no default value.
Output
  • folder (ECMFolder)
Default get related ECM folders service Gets the root ECM folder information on all available servers in the current snapshot. Default get related ECM folders service
Input
  • processInstanceId (String)
The input parameter has no default value.
Output
  • folderInfos (ECMFolderInfo)(List)
ECM Check out document service The service that is used to check out a document from the specified server. ECM Check-Out Document Service
Input
  • documentId (ECMID)
  • serverName (String)
The input parameters have no default values.
Output
  • checkedoutId (ECMID)
ECM Cancel checkout service The service that is used to cancel the check out a document from the specified server. ECM Cancel checkout service
Input
  • documentId (ECMID)
  • serverName (String) The name of the ECM Server repository.
The input parameters have no default values.
Output
None
ECM Remove document service The service that removes a specified document from a specified folder. Removing a document unfiles the document from the folder but does not delete it from the repository. ECM Remove document service
Input
  • documentId (ECMID)
  • folderID (ECMID)
  • serverName (String) The name of the ECM Server repository.
The input parameters have no default values.
Output
None
ECM Create folder service The service that creates the specified folder, with a given name, in the specified parent folder. The property sets the process subfolder ID. ECM Create folder service
Input
  • objectTypeId(ECMID)
  • parentFolderId (ECMID)
  • folderName (String)
  • serverName (String) The name of the ECM Server repository.
The input parameters have no default values.
Output
  • newFolderID (ECMID)
ECM Remove folder service The service that removes a specified folder from a specified folder. Removing a folder unfiles the folder from the parent folder but does not delete it from the repository. ECM Remove folder service
Input
  • parentFolderId (ECMID)
  • objectID (ECMID)
  • referenceServerName (String)
  • serverName (String) The name of the ECM Server repository.
The input parameters have no default values.
Output
None
ECM Delete folder service The service that permanently deletes folders. ECM Delete folder service
Input
  • folderId (ECMID)
  • serverName (String) The name of the ECM Server repository.
The input parameters have no default values.
Output
None
ECM Delete document service Specify the service used to delete documents. ECM Delete document service
Input
  • documentId(ECMID)
  • serverName(String)
  • allVersions(Boolean)
Output
None
ECM Rename folder reference service The service that renames the folder reference (not the name of the folder on the ECM system). ECM Rename folder reference service
Input
  • parentFolderId (ECMID)
  • folderId (ECMID)
  • folderServerName (String)
  • referenceName (String)
  • serverName (String) The name of the ECM Server repository.
The input parameters have no default values.
Output
None
ECM Update folder properties service The service that updates folder properties, for example, renaming the folder. ECM Update folder properties service
Input
  • folderId (ECMID)
  • serverName (String) The name of the ECM Server repository.
  • name (String)
The input parameters have no default values.
Output
  • modifiedFolderId (ECMID)
Localization service The service that is used to retrieve the globalized strings for use with this view. ECM Localization service

Additional resources

For information about how to create a coach or page, see Building coaches.
For information about standard properties (General, Configuration, Positioning, Visibility, and HTML Attributes), see View properties.