CMIS document adapter

CMIS adapter enables CADMATIC eShare to connect to content management systems that implements the CMIS (Content Management Interoperability Services) standard, in order to read the folder structure and open PDF documents stored in the folders. If the adapter should support other file types, you can specify them according to the project's needs. Note that eShare cannot index these other file types, and the user needs to download the files to be able to view them in an external viewer.

A CMIS resource can contain one or more document repositories, and you need to define a separate CMIS document data source for every repository that you want CADMATIC eShare to be able to access.

Creating a CMIS document adapter

Create a CMIS adapter to enable CADMATIC eShare to connect to a content management system and access project documents stored in that system.

Prerequisites

  • You know whether to use browser binding or AtomPub binding to connect to the CMIS resource and what the connection string is.

  • You know the username and password for accessing the CMIS resource.

Do the following:

  1. Navigate to the project to edit, and then click Project Admin in the main menu. The project administration view opens.

  2. Click Adapters and Data Sources. The Adapters and Data Sources configuration view opens.

  3. Click Add.

  4. In the Available Adapter Types section, select CMIS Document Adapter, and then click Create adapter.

  5. In the Adapter section, enter a name and description (optional) for the adapter, and specify whether the adapter should be enabled.

  6. In the Adapter Configuration section, specify the following settings:

    • Binding type – Select the binding type: Browser (preferred) or AtomPub.

    • Binding URL – Specify the connection string to use for connecting to the database.

    • Authentication – Specify the type of authentication to use to connect to the database:

      • Basic (pre-emptive) – CMIS services typically use basic authentication.

      • Automatic – NTLM/Kerberos/Negotiate/Digest authentication, depending on the received challenge from the server.

    • Username – Enter the username to use to connect to the target system.

    • Password – Enter the password to use to connect to the target system.

    • Timeout – Specify the timeout (seconds) for attempting to establish connection.

  7. Click Save.

Related Actions

Creating a CMIS document data source

Add a data source to a CMIS document adapter to provide access to PDF documents in a specific repository and to enable objects in the 3D model to be automatically linked to documents.

Prerequisites

  • If you want to enable indexing, a suitable document type must be defined as described in Defining a document type.

    These example document type settings would allow eShare to index all documents in the repository:

    Detection of Document Type

    • Identifier Name: Path
    • Pattern to Match: .*

    Document Processing Rules

    • Detection of Model Objects: Automatically

Do the following:

  1. Navigate to the project to edit, and then click Project Admin in the main menu. The project administration view opens.

  2. Click Adapters and Data Sources. The Adapters and Data Sources configuration view opens.

  3. On the Adapters list, click the CMIS document adapter to which to add the data source.

  4. In the Data Sources section of the adapter settings, click Add data source.

  5. In the Available Data Source Types section, CMIS Document Data Source is already selected—click Create data source.

  6. In the Data Source section, specify the following settings:

    • Name – Enter a name for the data source.

    • Description (optional) – Enter a description for the data source.

    • State – Specify whether the data source is disabled or enabled (default).

  7. In the Groups allowed to see the data section, select user groups that should be allowed to see the data that this data source provides.

    • If no groups are selected, only administrators will see the data.

    • Add user groups with Add.

    • Remove user groups with the remove button.

    • If the All Users group is selected, other group selections will be ignored.

  8. The Adapter Configuration section is read-only, it displays the adapter configuration.

  9. In the Data Source Configuration section, specify the following settings:

    • Indexing – Select if document indexing is enabled. If you enable indexing, eShare can search for object links in documents, store those links in the project database, and use this document index to create links from 3D objects to relevant documents.

      Note: If you save the data source configuration with indexing, all data sources of the same adapter with indexing enabled, will be indexed again.

      If Enabled, specify the following settings:

      • Indexing Speed – Define the duration of indexing.

        If you select Duration, specify the target duration of each indexing round in Target Indexing Duration field (in minutes). The set duration takes effect only after the first full round of indexing has been completed. The default is 120.

        If you select As Fast As Possible, the target of each indexing round is to be completed in the shortest time as possible.

      • Indexing Mode – Indexing is done every time the data source configuration is saved. Indexing can also be triggered manually from the Project Administration's General view.

        If you select Once, indexing is done only after saving.

        If you select Daily, indexing is done once every day.

        If you select Once per Days of Week, indexing is done once on the selected days.

        If you select Given Times in Days of Week, indexing starts on given times of the day on the selected days. The times are given in the server's local time.

        If you select Days of Month, indexing is done once on the selected days of the month.

        If you select All the Time, indexing is done continuously. Warning: This can consume a lot of resources if As Fast as Possible is selected as indexing speed.

    • Folder Tree Caching – If enabled, eShare periodically retrieves and caches the document tree, and users always see the cached version of the tree.

      Caching Interval – Specifies how often eShare refreshes the folder tree cache (minutes).

      If folder tree caching is disabled (default), the document tree is retrieved from the CMIS server only when the user logs in or refreshes the browser.

    • Load Subfolders On Demand — If enabled, the entire document tree is not loaded at once, but the contents are loaded and visible following the user's examination. The default is Disabled.

    • File Types – Specifies which file types to display in the document tree. By default, all supported types are selected to be displayed.

    • Additional File Types to Show – If the document data source adapter should support other file types, list them here. Separate the file types with a comma.

    • Repository – If the data source contains multiple document repositories, select the appropriate repository from the list. The system immediately retrieves metadata attributes from that repository and displays them.

    • Base Folder (optional) – Specifies the path to the topmost folder from which to show documents. Use the slash character as a folder delimiter. For example, if base folder is defined as Isos/Hull, the document tree only lists documents that reside in the Hull folder and its subfolders.

    • Metadata Attributes – This section displays the metadata attributes that are available in the specified repository. You can specify which attributes to use in eShare and how.

      • Visible – If selected, the attribute is displayed in the attribute pane of the Documents view when a user selects or opens a document. If an attribute is visible and indexing is enabled, indexing can try to find object links from the attribute's values.
      • Searchable – If selected, the simple search function can see the attribute, and search results can display links to documents where the attribute value matches the search string. The check box is dimmed if the attribute cannot be included in search.
      • Filter – If selected, a document is listed in the document tree only if the document has this metadata attribute and the attribute value exactly matches the value defined in the By Value column (that is, wildcard characters and regular expressions are not supported).
      • By Value – Specifies the metadata attribute value (string value or boolean) that a document must have to be displayed in the document tree.

    • Folder Attributes – This section displays the folder attributes that are available in the specified repository. You can use these attributes to specify which folders to show in eShare. Filtering a folder also filters its sub-folders.

      • Filter – If selected, a folder is listed in the document tree only if the folder has this metadata attribute and the attribute value exactly matches the value defined in the By Value column (that is, wildcard characters and regular expressions are not supported).
      • By Value – Specifies the metadata attribute value (string value or boolean) that a folder must have to be displayed in the document tree.

  1. Click Save.

Results

The Documents view of the project allows browsing the specified CMIS document repository and opening documents that it contains.

Simple search can find documents that have searchable attributes.

When a user examines an object in the 3D view, if indexing is enabled and documents in the CMIS repository contain links to the object, the details pane displays links to those documents.

Related Topics

Adapters and indexing

Document handling