Skip to Content

Wiki source code of CMIS-Plugin

Show last authors
1 [[**Plugin-Download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/CMIS%20DMS%20System%20Anbindung%20(fc-plugin-cmis)&fileid=54831||rel="noopener noreferrer" target="_blank"]] (erfordert Anmeldung)
2
3 {{info}}
4 {{version major="7" minor="4" patch="0"/}} The plugin requires at least formcycle version 7.4.0.
5 {{/info}}
6
7 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.
8
9 == Configuration of the CMIS connections ==
10
11 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.
12
13 === Connection settings ===
14
15 ; Name
16 : The name that the configured connection should have.
17 ; Connection type
18 : The connection type of the interface is the protocol of the interface that is used for data transmission.
19 The 3 available options are:
20 - AtomPub
21 - Web service (SOAP)
22 - Browser (access via the HTTP methods GET and POST in the format JSON)
23 ; Server URL
24 : The URL under which the interface to be connected can be reached.
25 ; Repository ID
26 : 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.
27 ; Connection parameters
28 : Additional parameters that are relevant for the connection. These parameters are OpenCMIS connection parameters.
29
30 === Authentication ===
31
32 ; Authentication type
33 : Specifies how the authentication should take place.
34 The available types are:
35 - None
36 - Basic Auth
37 - Bearer Token
38 ; User Name and Password
39 : The username and password for Basic Auth.
40 ; Bearer Token
41 : The token for authentication via a Bearer Token.
42
43 === Proxy settings ===
44
45 ; Use proxy
46 : Specifies whether the connection should only take place via a proxy server.
47 ; Proxy host
48 : The URL under which the proxy server is located.
49 ; Proxy port
50 : The port under which the proxy server is located.
51 ; User name and password
52 : If the proxy requires authentication via Basic Auth, the credentials can be entered here.
53
54 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.
55
56 == Workflow action ==
57
58 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.
59
60 === Object settings ===
61
62 ; Object type
63 : Specifies the base type of the object. The supported types are folder and document.
64 ; Object type ID
65 : 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").
66 ; Object name
67 : 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".
68 ; Destination folder path
69 : 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.
70 ; Object properties
71 : 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>>https://chemistry.apache.org/docs/cmis-samples/samples/properties/index.html]]). 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>>https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/format/DateTimeFormatter.html]].
72
73 === Possible errors ===
74
75 ; CONNECTION_FAILED
76 : The attempt to establish a connection failed.
77 ; FILE_SYSTEM_ERROR
78 : There was an error receiving the file.
79 ; INVALID_PATH
80 : The specified path is invalid. Returns the path segment that caused the error.
81 ; AUTHENTICATION_FAILED
82 : It was not possible to authenticate on the interface.
83 ; NOT_AUTHORIZED
84 : The authorisation for the interface is not sufficient.
85 ; REPOSITORY_NOT_FOUND
86 : If a repository was specified by the repository ID, it could not be found.
87 ; TYPE_NOT_SUPPORTED
88 : The type specified by the Object Type ID field is not supported by the interface.
89 ; OBJECT_PROPERTY_CREATION_FAILED
90 : An error occurred during the creation of an object property. This could occur, for example, if the data type is configured incorrectly.
91 ; OBJECT_CREATION_FAILED
92 : The creation of the object on the CMIS interface failed.
93
94 == Version history ==
95
96 === 1.2.3 ===
97
98 * Bug fixes in CMIS connection configuration interface
99
100 === 1.2.2 ===
101
102 * Selection of data types for object properties
103
104 === 1.2.1 ===
105
106 * Bug fixes
107
108 === 1.2.0 ===
109
110 * Selection of multiple files and repeated upload items in workflow action possible.
111
112 === 1.1.1 ===
113
114 * Add new role property for managing cmis connections
115
116 === 1.1.0 ===
117
118 * Database change for CMIS connection entities
119 * Bug fixes
120
121 === 1.0.0 ===
122
123 * Initial release