Zum Inhalt springen

Wiki-Quellcode von CMIS-Plugin

Zeige letzte Bearbeiter
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"/}} Das Plugin benötigt mindestend die formcycle Version 7.4.0.
5 {{/info}}
6
7 Mit dem kostenpflichtigen CMIS Plugin haben Sie die Möglichkeit, ein Content Management System, welches über eine CMIS-Schnittstelle verfügt, anzubinden. Im Umfang dieses Plugins ist das Anlegen einer Verbindung und das Erstellen von Ordnern und Dokumenten über die Schnittstelle enthalten.
8
9 == Konfiguration der CMIS-Verbindungen ==
10
11 Nach der Installation des Plugins wird ein Aus- und wieder Einloggen an formcycle benötigt, um den Menüpunkt CMIS-Verbindungen zu sehen. Über den Menüpunkt CMIS-Verbindungen besteht die Möglichkeit eine Verbindung für eine bestehende CMIS-Schnittstelle einzurichten.
12
13 === Verbindungseinstellungen ===
14
15 ; Name
16 : Der Name, welche die konfigurierte Verbindung haben soll.
17 ; Verbindungstyp
18 : Unter dem Verbindungstyp der Schnittstelle ist des Protokoll der Schnittstelle zu verstehen, welche für die Datenübertragung verwendet wird.
19 Die 3 zur Verfügung stehende Möglichkeiten sind:
20 - AtomPub
21 - Webservice (SOAP)
22 - Browser (Zugriff über die HTTP-Methoden GET und POST im Format JSON)
23 ; Server URL
24 : Die URL, unter welcher die anzubindende Schnittstelle erreichbar ist.
25 ; Repository-ID
26 : Die Kennung des anzusprechenden Repositories. Diese Einstellung ist nur relevant, falls unter einer Server-URL mehrere Repositories liegen. Kann in den meisten Fällen leer bleiben.
27 ; Verbindungsparameter
28 : Weitere Parameter, welche für die Verbindung relevant sind. Bei diesen Parametern handelt es sich um OpenCMIS Verbindungsparametern.
29
30 === Authentifizierung ===
31
32 ; Authentifizierungstyp
33 : Gibt an, wie die Authentifizierung stattfinden soll.
34 Die zur Verfügung stehenden Typen sind:
35 - Keiner
36 - Basic Auth
37 - Bearer Token
38 ; Benutzername und Passwort
39 : Der Benutzername und das Passwort für Basic Auth.
40 ; Bearer Token
41 : Der Token für die Authentifizierung über eine Bearer Token.
42
43 === Proxyeinstellungen ===
44
45 ; Proxy verwenden
46 : Gibt an, ob die Verbindung nur über einen Proxy-Server stattfinden soll.
47 ; Proxy-Host
48 : Die URL, unter welcher sich der Proxy-Server befindet.
49 ; Proxy-Port
50 : Der Port, unter welchem sich der Proxy-Server befindet.
51 ; Benutzername und Passwort
52 : Falls für den Proxy eine Authentifizierung über Basic Auth notwendig ist, können die Credentials hier angegeben werden.
53
54 Es ist ebenfalls möglich die konfigurierte Verbindung gegen die Schnittstelle zu testen. Dies ist jedoch nur möglich, falls alle für die Verbindung relevanten Felder ausgefüllt wurden. Grundlegend relevant sind hierbei die Server-URL und die Konfiguration der Authentifizierung. Weiterhin, falls ein Proxy verwendet werden soll, ist dementsprechend dessen Konfiguration notwendig.
55
56
57 == Workflow-Aktion ==
58
59 Die konfigurierten CMIS-Verbindungen können nun in der Workflow-Aktion CMIS-Objekt anlegen verwendet werden. Die Aktion ermöglicht es Ordner und Dokumente auf dem DMS, welches über eine CMIS-Schnittstelle verfügt, anzulegen.
60
61 === Objekteinstellungen ===
62
63 ; Objekt-Typ
64 : Gibt an welchen Basis-Typ das Objekt habe soll. Die Unterstützen Typen sind Ordner und Dokument.
65 ; Objekt-Typ-ID
66 : Gibt den Idententifikator des Objekt-Typen an, welcher verwendet werden soll. Wird kein spezifischer Identifikator angegeben wird der Basis Identifikator des Objekt-Typen genommen.
67 ; Objekt-Name
68 : Der Name, welches das zu erstellende Objekt haben soll.
69 ; Zielordnerpfad
70 : Der Pfad unter dem das Objekt angelegt werden soll.
71 ; Objekt-Properties
72 : Weitere Eigenschaften die für das Objekt festgelegt werden sollen. Hierbei kann jede Eigenschaft einen speziellen Datentyp besitzen, welche von der CMIS-Schnittstelle definiert ist (siehe [[hier>>https://chemistry.apache.org/docs/cmis-samples/samples/properties/index.html]]). Der Datentyp kann über die Auswahl selektiert werden. Wenn es sich um den Datentyp //DATETIME// handelt ist es wichtig, dass die übergebenen Werte für die jeweilige Eigenschaft und für alle anderen Eigenschaften vom Typ //DATETIME//, das gleiche und richtige Datumformat besitzt. Das Standardformat ist hier //dd.MM.yyyy// (z.B. 26.04.2023). Falls es sich bei den übergebenen Werten um ein anderes Datumformat handelt als der Standardwert, kann es im Eingabefeld für das Datumformat eingegeben werden. Die Syntax zur Formatierung ist detailliert beschrieben in der Dokumentation für [[Java DateTimeFormatter>>https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/format/DateTimeFormatter.html]].
73
74 === Mögliche Fehler ===
75
76 ; CONNECTION_FAILED
77 : Der Versuch ein Verbindung aufzugbauen ist gescheitert.
78 ; FILE_SYSTEM_ERROR
79 : Es gab einen Fehler beim Erhalt der Datei.
80 ; INVALID_PATH
81 : Der angegeben Pfad ist ungültig. Gibt das Pfadsegmente zurück, welches den Fehler ausgelöst hat.
82 ; AUTHENTICATION_FAILED
83 : Es war nicht möglich an der Schnittstelle zu Authentifizieren.
84 ; NOT_AUTHORIZED
85 : Die Autorisierung für der Schnittstelle reicht nicht aus
86 ; REPOSITORY_NOT_FOUND
87 : Falls ein Repository durch die Repository-ID angegeben wurde, konnte dieses nicht gefunden werden.
88 ; TYPE_NOT_SUPPORTED
89 : Der durch das Feld Objekt-Typ-ID angegebene Typ wird nicht von der Schnittstelle unterstützt.
90 ; OBJECT_PROPERTY_CREATION_FAILED
91 : Bei der Erstellung einer Objekt-Eigenschaft ist ein Fehler aufgetreten. Dies könnte bspw. bei falscher Konfiguration des Datentyps auftreten.
92
93 == Versionshistorie ==
94
95 === 1.2.2 ===
96
97 * Auswahl von Datentypen für Objekt-Eigenschaften
98
99 === 1.2.1 ===
100
101 * Fehlerbehebungen
102
103 === 1.2.0 ===
104
105 * Auswahl von mehreren Dateien und wiederholten Upload-Elementen in Workflow-Aktion möglich
106
107 === 1.1.1 ===
108
109 * Rollenrecht für die Verwaltung von CMIS-Verbindungen hinzugefügt
110
111 === 1.1.0 ===
112
113 * Datenbankänderung für CMIS-Connection Entitäten
114 * Fehlerbehebungen
115
116 === 1.0.0 ===
117
118 * Initialer Release