edoc CMIS archivelink Administration Guide

Create and edit a repository in edoc CMIS archivelink

You must create a CMIS repository in edoc CMIS archivelink to establish a connection to your ECM system. You can create multiple repositories in edoc CMIS archivelink to connect to multiple ECM systems, for example.

You need the following data from your ECM system to establish a connection:

  • Authentication method, e.g. Microsoft Graph API.

  • Authentication data, e.g. API key, secret, user name, and password.

Things to know

When you create a CMIS repository for the first time, an authentication token is automatically generated under Edit repository > Generate new authentication token. Copy the authentication token and paste it into the connection settings of your CMIS client application.

Create a CMIS repository

Suppose, you want to create a new CMIS repository to be used for archiving documents.

Here's how

  1. Go to the edoc platform system environment and open the administration of edoc CMIS archivelink in the browser.

  2. Go to Configure repositories > Create new repository.

  3. Under Enter repository name, enter any meaningful name for the connection. You'll use this name to identify the repository in the overview.

  4. Under Enter module, enter the edoc content services module that you want to use to connect to your ECM system.

    1. To connect to d.velop documents (on-premises) using the d.3 API, enter d3.

    2. To connect to d.velop documents in the cloud or on-premises using the REST API, enter d3one.

    3. To connect to Microsoft SharePoint Online, enter spog.

  5. Under Specify connection string, enter the connection string to establish a connection to your ECM system using edoc content services.

    1. For the content services module d3 (d.velop d.3ecm-API (deprecated)), use the following template and replace the placeholders with your data:

      targethost=<Base_address>;user=<ecm_service_user>;password=<ecm_service_user_password>;repositoryid=<ecm_repository_id>;
      
    2. For the d3one content services module (d.velop documents, d.velop cloud (REST API)), use the following template and replace the placeholders with your data:

      targethost=<ecm_url>;apikey=<ecm_api_key>;repositoryid=<ecm_repository_id>;
      
    3. For the spog (Microsoft SharePoint Graph API) content services module, use the following template and replace the placeholders with your data:

      targethost=<ecm_url>;tenantid=<entra_tenant>;clientid=<entra_client_id>;clientsecret=<entra_client_secret>;listid=<some_ecm_list_id_for_connection_testing>;
      
  6. If necessary, enable the following options:

    1. When deleting CMIS objects and its files also delete the associated ECM elements: When this option is enabled, the associated ECM elements in the ECM system are also permanently deleted when CMIS content streams and CMIS objects are deleted.

    2. Show ECM categories in CMIS services (e.g., "getTypeDescendants"): When enabled, all CMIS services are displayed, such as retrieving a hierarchical list of all object types.

  7. Click on Save.

Edit the created CMIS repository

Once you have created a CMIS repository, the next step is to configure the details, such as mapping categories and properties, generating an authentication token, and testing the connection.

Things to know

If the connection to the ECM system is working, the ECM properties and ECM categories needed for mapping are already displayed.

If necessary, click Start connection test to check the connection.

Here's how

  1. Copy the authentication token under Edit repository > Generate new authentication token. Copy the authentication token so you can specify it in your CMIS configuration.

  2. Under Map the ECM category to CMIS type "cmis:document", select the ECM category in the ECM system to which the CMIS documents should be mapped by default.

  3. Under Map the ECM property to CMIS property "cmis:name", select the property in the ECM system that should be assigned to CMIS documents by default as the identification property.

  4. Under Map the ECM property to CMIS property "cmis:objectid", select the CMIS object ID in the ECM system that should be mapped by default as the identification property for the CMIS object ID.

  5. Click on Save.


See also

Last updated: