HomeGuidesRecipesAPI
HomeGuidesAPILog In

CMIS Connector

📘

Deployment Feature Availability

This feature is not available in CoLo deployment.

CMIS is an interoperability standard for content and document management systems which solves the problem of each vendor having their own API specification.

SmartIQ has a CMIS Connector type within the pure cloud multi-tenant environments. Made up of both an Action and Data Connection, the CMIS Connector allows an organization to connect to their enterprise document management system for the storage and retrieval of documents and records from any system which has implemented CMIS.

Components

Action

Data Connection

  • CMIS Data

Configuration

The CMIS Connector is configured centrally, via the Settings page in Manage > Settings > CMIS. The available options are summarized below.

📘

Multiple accounts

Click the New Set button to create additional accounts. For example, Sandbox and Production. Additionally, click the Set as Default button to change the default connector set. If the previous Default was set in Design, SmartIQ will now use the new Default connector values.

Overrides for some of these options are available in the Save Document action.

Setting

Description

Host URL

The URL of the CMIS server's Atom bindings

Note: the CMIS version of the selected binding document needs to match with the selected "CMIS Version".

Service Account Username

The username of the service account to use for logging in to the CMIS server.

Service Account Password

The password of the service account to use for logging in to the CMIS server.

Default Repository ID

The default repository to use when communicating with the CMIS server.

CMIS Version

The CMIS interface version to use. Accepted values are "1.1" and "1.0".

Debug Mode

Whether to log detailed information for debugging purposes. If enabled, the messages are written to the Management console in Manage.
Where a network expection occurs, the status message returned may be explained in more detail in Microsoft's WebExceptionStatus documentation

Usage

Save Document Action

The Save Document action can be used to save one or more documents to the CMIS repository. A number of inputs are available to override the global settings.

Input

Description

Format

Access Control Entries (Principal:Permission)

Permissions to grant to CMIS principals with respect to the document.

Note: There can only be one access control entry for a given Principal.

Key-value pairs; the key should be a CMIS PrincipalId and the value should be one of write, read, or all.

Document Type

The CMIS type of the document. The default is cmis:document.

Metadata (parameter = value)

Additional data (such as author, for example) to be stored as part of the document record.

Key-value pairs; values for multi-value properties should be pipe-separated

Repository ID

The repository to use for saving the document. This is optional if a repository is set in the global settings.

Repository Path

Specifies the path within the repository at which the document should be stored.

Version State

The version state in which to create the document record.

Drop-down selection of Minor, Major, Checkout, or None.

Documents to be saved are supplied to the action by attaching them as Action Documents in Design. By default, the action will use all generated documents.

Update Document Action

The Update Document Action can be used to update one or more documents in the CMIS repository. A number of inputs are available to override the global settings.

Input

Description

Format

Access Control Entries (Principal:Permission)

Permissions to grant to CMIS principals with respect to the document.

Note: There can only be one access control entry for a given Principal.

Key-value pairs; the key should be a CMIS PrincipalId and the value should be one of write, read, or all.

Document Id (Mandatory)

Id of the document to update, which will be used to identify which document should be updated. The document type must have versioning for an update to work.

Document Type

The CMIS type of the document. The default is cmis:document.

Metadata (parameter = value)

Additional data (such as author, for example) to be stored as part of the document record. Names must match available metadata in the CMIS service.

Update has an additional metadata value of {skip}. If a metadata value is set to {skip}, no action is taken on update and allows users to skip updating values that have not changed.

Key-value pairs; values for multi-value properties should be pipe-separated

Repository ID

The repository to use for saving the document. This is optional if a repository is set in the global settings.

Repository Path

Default is root path (/), otherwise set to the folder path where content is to be saved.

Version State

The version state in which to create the document record.

Drop-down selection of Minor, Major, Checkout, or None (Default).

Data Connector

The CMIS Data Connector supports retrieving simple data about the connected CMIS repository. The available queries are:

  • List stored documents
  • List available folders
  • Fetch basic details for a document