You are viewing the documentation for Blueriq 14. Documentation for other versions is available in our documentation directory.
This service makes it possible to store, update or delete a document in a Document Management System (DMS) that implement the CMIS (Content Management Interoperability Services) standard like Alfresco Document Management System and IBM FileNet.
The document to be stored in the DMS can be uploaded using the AQ_File_Upload container.
See How to setup a CMIS connection for using a DMS in combination with Blueriq.
Parameters
Name | Description | Type | Required |
---|---|---|---|
Action | Type of action to store, update or delete the document from the DMS | Domain
| True |
Delete all versions | Select option "Delete" and check this box, if you want to delete all versions of the document at once | Boolean | False |
FileId | The file id is an optional parameter, but if the file id is set the connection must also be set. NOTE: by filling this, the remove from scope option will be ignored. | Expression - String | False |
Connection | The connection is an optional parameter, but if the connection is set the file id must also be set. Note: by filling this, the remove from scope option will be ignored. | String | False |
Id | An expression to determine the ID of the document | Expression - String | True |
Object type | Submit a string that is send as objectType header to the CMIS system | Expression - String | False |
Name | An expression to determine the name of the document | Expression - String | False |
Path | An expression to determine the attribute path in the DMS | Expression -String | False |
Remove from scope | Check this box in case you want the remove the document from the session (scope) after executing the service | Boolean | False |
Output Id - Attribute | Select an attribute on which you want to store the returned object Id. This parameter is useful when working with non-unique path names. See CMIS Client component | Module element - Attribute | False |
Output Id Target Instance | Select an instance on which you want to store the return object Id. If not used, it is assumed that an instance is in scope. This parameter is useful when working with non-unique path names. See CMIS Client component | Expression - Instance | False |
It's also possible to add custom meta data fields to the document manager.
Either the Id or name are required, but you cannot use both.
It is is possible to set the object type in the cmis.properties. That object type is used if the Object type parameter of this service is not used.
For more information, see CMIS Client component.
Events
Do not forget to map the "Denied" event.Actions
The document manager has three actions: store
, update
and delete
. The behavior of these actions is as follows:
Store
Documents can be stored by Id
or by path
.
It is possible to store from a Connection or from the "Flow scope".
When storing a new document, the document Id is not yet known so it must be stored by path.
When storing from a connection
- The
fileId
andconnectionName
parameters are required when storing from a connection. - The file and its metadata will be read from the connection.
- If the path is not empty, then this path is used to store the document, if this path does not exist in the DMS yet, it will be created. If the path is empty, the document is stored in the root folder.
- If there already exists a document at the specified path or with the specified
Id
, a new (major) version is created. If no document exists a new document is created. - the new document Id is returned.
When storing from the flow scope
- The
fileId
andconnectionName
are not used, the file is obtained from the flow scope (using the fileKey) instead. - When there is no document Id, the path is used to store the document. Otherwise the path is the same as the path of the document with specified document Id.
- If the path is not empty, then this path is used to store the document, if this path does not exist in the DMS yet, it will be created. If the path is empty, the document is stored in the root folder.
- If there already exists a Document with specified
Name
or with specifiedId
, a new major version is created. If no document is found with specifiedName
or documentId a new document is created. - The new Document Id is returned.
- When
Remove from scope
is set to true, the file is removed from the flow scope. - The new document Id is put on the flowscope using the CMIS_ReturnedObjectID key.
Update
Documents can only be updated by Id
. It is possible to update from a Connection or from the "Flow scope".
When updating from a connection
- The
fileId
andconnectionName
parameters are required when updating from a connection. - The file and its metadata will be read from the connection.
- Document Id is retrieved from the metadata.
- A new major version of the document is created.
- The new document Id is returned.
When updating from the flow scope
- If there is no
Id
, thepath
andname
are retrieved from CMIS bypath
. - If there is an
Id
the thepath
andname
are retrieved from CMIS byId
. - The document properties (metadata) are updated and the CmisObject is returned. The document is NOT updated, only the metadata.
- When
Remove from scope
is set to true, the file is removed from the flow scope. - The new Document Id is put on the flowscope using the CMIS_ReturnedObjectID key.
Delete
Documents can be deleted by Id
or by path
.
When deleting
- If there is no
Id
, the document is retrieved from CMIS bypath
.- The document is then deleted using this
path
.
- The document is then deleted using this
- If there is and
Id
, the Document is retrieved from CMIS byId
.- The document is then deleted using this
Id
.
- The document is then deleted using this
- When
Remove from scope
is set to true, the file is removed from the flow scope. - The deleted document Id is put on the flowscope using the CMIS_ReturnedObjectID key.