Skip to Content

CMIS-Plugin

Plugin-Download (erfordert Anmeldung)

Information

7.4.0+  The plugin requires at least formcycle version 7.4.0.

With the fee required CMIS plugin you have the possibility to connect a document management system that has a CMIS interface. The scope of this plugin includes the creation of a connection and the creation of folders and documents via the interface.

Configuration of the CMIS connections

After installing the plugin, logging out and back in to formcycle is required to see the menu item CMIS connections. The menu item CMIS connections offers the possibility to set up a connection for an existing CMIS interface.

Connection settings

Name
The name that the configured connection should have.
Connection type
The connection type of the interface is the protocol of the interface that is used for data transmission.
  The 3 available options are:
  - AtomPub
  - Web service (SOAP)
  - Browser (access via the HTTP methods GET and POST in the format JSON)
Server URL
The URL under which the interface to be connected can be reached.
Repository ID
The ID of the repository to be addressed. This setting is only relevant if there are several repositories under one server URL. Can be left blank in most cases.
Connection parameters
Additional parameters that are relevant for the connection. These parameters are OpenCMIS connection parameters.

Authentication

Authentication type
Specifies how the authentication should take place.
  The available types are:
  - None
  - Basic Auth
  - Bearer Token
User Name and Password
The username and password for Basic Auth.
Bearer Token
The token for authentication via a Bearer Token.

Proxy settings

Use proxy
Specifies whether the connection should only take place via a proxy server.
Proxy host
The URL under which the proxy server is located.
Proxy port
The port under which the proxy server is located.
User name and password
If the proxy requires authentication via Basic Auth, the credentials can be entered here.

It is also possible to test the configured connection against the interface. However, this is only possible if all fields relevant for the connection have been filled in. The server URL and the configuration of the authentication are basically relevant here. Furthermore, if a proxy is to be used, its configuration is necessary accordingly.

Workflow action

The configured CMIS connections can now be used in the workflow action Create CMIS object. The action makes it possible to create folders and documents on the DMS which has a CMIS interface.

Object settings

Object type
Specifies the base type of the object. The supported types are folder and document.
Object type ID
Specifies the identifier of the object type to be used. If no specific identifier is specified, the base identifier of the object type is taken (documents: "cmis:document", folders: "cmis:folder").
Object name
The name of the object to be created. If it is a document and nothing is specified for the object name, the file name is used for the object name. For folders the default value is "output".
Destination folder path
The path under which the object is to be created. E.g.: "/examplefolder1/examplefolder2", for the source folder either "/" or no entry can be made. When specifying a destination folder path, make sure that the path used allows folders or documents to be stored or whether the permissions are available on the CMIS interface.
Object properties
Further properties that are to be defined for the object. Each property can have a special data type, which is defined by the CMIS interface (see here). The data type can be selected via the selection. If the data type is DATETIME, it is important that the transferred values for the respective property and for all other properties of the type DATETIME have the same and correct date format. The standard format here is dd.MM.yyyy (e.g. 26.04.2023). If the values passed are a different date format than the default value, it can be entered in the date format input field. The syntax for formatting is described in detail in the documentation for Java DateTimeFormatter.

Possible errors

CONNECTION_FAILED
The attempt to establish a connection failed.
FILE_SYSTEM_ERROR
There was an error receiving the file.
INVALID_PATH
The specified path is invalid. Returns the path segment that caused the error.
AUTHENTICATION_FAILED
It was not possible to authenticate on the interface.
NOT_AUTHORIZED
The authorisation for the interface is not sufficient.
REPOSITORY_NOT_FOUND
If a repository was specified by the repository ID, it could not be found.
TYPE_NOT_SUPPORTED
The type specified by the Object Type ID field is not supported by the interface.
OBJECT_PROPERTY_CREATION_FAILED
An error occurred during the creation of an object property. This could occur, for example, if the data type is configured incorrectly.
OBJECT_CREATION_FAILED
The creation of the object on the CMIS interface failed.

Version history

1.2.3

  • Bug fixes in CMIS connection configuration interface

1.2.2

  • Selection of data types for object properties

1.2.1

  • Bug fixes

1.2.0

  • Selection of multiple files and repeated upload items in workflow action possible.

1.1.1

  • Add new role property for managing cmis connections

1.1.0

  • Database change for CMIS connection entities
  • Bug fixes

1.0.0

  • Initial release