Outbound operations for external ECM systems and BPM stores

Use standard Enterprise Content Management (ECM) operations to interact with external ECM systems defined in the workflow automation settings page. These operations can also be used to develop applications, which use repositories that are called BPM stores.

The following table displays the name of each ECM operation and indicates whether the operation is available for an external ECM system that is defined in the workflow automation settings page. The table also indicates whether the operation is available in a BPM store.

Table 1. Operations for external ECM systems and BPM stores
Operation name	Description	Available for BPM target store and external ECM systems?	Available for the BPM managed store (deprecated)?	Available for the BPM document store?
Add document to folder	Adds a document to a folder.	Yes	Yes	No
Add folder to folder	Adds a folder to a folder	No	Yes	No
Cancel check-out document	Releases a document from the check-out state, which makes it possible for other users to work with it.	Yes	No	Yes
Check-in document	Checks in a document, giving all users access to it.	Yes	No	Yes
Check-out document	Checks out a document; only the person who checked it out can use it.	Yes	No	Yes
Copy document	Copies a document.	Yes	No	Yes
Create document	Creates a document.	Yes	No	Yes
Create folder	Creates a folder.	Yes	Yes	No
Delete document	Deletes a document.	Yes	No	Yes
Delete folder	Deletes a folder.	Yes	Yes	No
Get all document versions	Gets all versions of a document.	Yes	No	Yes
Get children	Gets the children - documents and folders - of a folder.	Yes	Yes	No
Get document	Gets a document that matches a document identifier.	Yes	No	Yes
Get document content	Gets a stream of data that is the content of the document.	Yes	No	Yes
Get documents in folder	Gets documents in a folder.	Yes	No	No
Get folder	Gets a folder that matches a folder identifier.	Yes	Yes	No
Get folder by path	Gets a folder as determined by a path to it.	Yes	No	No
Get folder tree	Gets a set of folders in an array.	Yes	No	No
Get type definition	Gets the type definition of a document or folder (including its properties).	Yes	No	Yes
Get type descendants	Gets the type definition descendants as determined by the depth level.	Yes	No	Yes
Move document	Moves a document from one folder to another.	Yes	No	No
Move folder	Moves a folder.	Yes	No	No
Remove document from folder	Removes a document from a folder.	Yes	Yes	No
Remove folder from folder	Removes a folder from a folder.	No	Yes	No
Rename document reference	Renames a document reference.	No	Yes	No
Rename folder reference	Renames a folder reference.	No	Yes	No
Search	Retrieves a set of document or folder references according to a query.	Yes	No	Yes
Set document content	Updates a document with content.	Yes	No	Yes
Update document properties	Updates the properties of a document.	Yes	No	Yes
Update folder properties	Updates the properties of a folder.	Yes	Yes	No

Note: The default one-hour cache refresh for getTypeDescendants or getTypeHierarchical causes performance issues with large data volumes. A new JVM parameter objecttypehierarchy.cache.interval allows customizing the interval in seconds. The configuration options are:

-1: Cache is never refreshed.
> 0: Cache refreshes periodically based on the specified number of seconds (e.g., 28800 = 8 hours).
0 or any negative value other than -1: Defaults to one-hour refresh interval.

Longer intervals are recommended in production to reduce unnecessary refreshes.