How to use IBM App Connect with CMIS

CMIS (Content Management Interoperability Services) uses web services to enable different content management systems across various platforms, such as IBM® FileNet® Content Manager and Alfresco, to share information.

CMIS is a specification that provides a set of services and functions for applications to work with a variety of file-based Content Management Systems (CMS).

App Connect can help by providing you with a way to transfer data by using the CMIS smart connector (application). For example, in an App Connect flow you could use the CMIS connector to retrieve documents from FileNet in a private network; the flow could then use IBM Watson® to analyse the documents, and then upload the data to IBM Cloud® Object Storage (COS) S3 to make use of it's backup and data analytics capabilities.

Supported product and API versions

To find out which product and API versions this connector supports, see Detailed System Requirements on the IBM Support page.

Connecting to a CMIS server

To connect App Connect to an CMIS account that you want App Connect to use, you need the following connection details:

  • Browser binding URL: The URL for browser binding obtained from the CMIS server. For example https://<host:port>/<path>/browser.
  • User name: The user name used to log in to the CMIS server.
  • Password: The password for the user name.

To connect to CMIS from the App Connect Designer Connect > Applications and APIs page (previously the Catalog page) for the first time, under CMIS click Connect. For more information, see Managing accounts.

Tip:

Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Applications and APIs page, select the account, open its options menu (⋮), then click Rename Account.

What should I consider first?

Before you use App Connect Designer with CMIS, take note of the following considerations:

  • (General consideration) You can see lists of the trigger events and actions that are available on the Applications and APIs page of the App Connect Designer.

    For some applications, the events and actions depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.

  • (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.
  • App Connect supports CMIS 1.1 only.
  • #500x Internal Server errors might occur with heavy loads. This issue is caused by the number of concurrent requests that are made to CMIS from App Connect and in the process fully using the link between CMIS and the App Connect.

Events and actions

CMIS events

These events are for changes in this application that trigger a flow to start completing the actions in the flow.

Show more configurable events: Events that are shown by default are pre-configured by using optimized connectivity. More items are available after you configure events that can trigger a flow by polling this application for new or updated objects.

CMIS actions

Your flow completes these actions on this application.

Object Action Description
Documents Create document Creates a document
Delete document Deletes a document
Download document Downloads document from CMIS
Retrieve document ACL Retrieves document ACL
Retrieve documents Retrieves documents
Update document metadata Updates document metadata
Folders Create folder Creates a folder
Delete folder Deletes a folder
Retrieve folder ACL Retrieves folder ACL
Retrieve folders Retrieves folders
Update folder metadata Updates folder metadata
Repositories Retrieve repositories Retrieves repositories