Wiki-Quellcode von CMIS-Plugin

Verstecke letzte Bearbeiter

version	line-number	content
2.7	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.6	2
2.1	3	{{info}}
2.4	4	{{version major="7" minor="4" patch="0"/}} Das Plugin benötigt mindestend die formcycle Version 7.4.0.
2.1	5	{{/info}}
	6
3.7	7	Mit dem kostenpflichtigen CMIS Plugin haben Sie die Möglichkeit, ein Document 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.
2.1	8
	9	== Konfiguration der CMIS-Verbindungen ==
	10
2.5	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.
2.1	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	- Browser (Zugriff über die HTTP-Methoden GET und POST im Format JSON)
	22	; Server URL
	23	: Die URL, unter welcher die anzubindende Schnittstelle erreichbar ist.
	24	; Repository-ID
5.1	25	: Die Kennung des anzusprechenden Repositories. Diese Einstellung ist nur relevant, falls unter einer Server-URL mehrere Repositories liegen. Wird das Feld leer gelassen, wird beim Verbindungsaufbau das erste gefundene Repository verwendet. Über die Schaltfläche "Repositories suchen" werden alle auswählbaren Repositories der konfigurierten Verbindung durchsucht. Sobald Repositories gefunden wurden, sind alle IDs in einer Auswahl sichtbar und können ausgewählt werden. Informationen zum ausgewählten Repository werden über das Informationssymbol oben rechts angezeigt. {{version major="1" minor="3" patch="0"/}}
2.1	26	; Verbindungsparameter
	27	: Weitere Parameter, welche für die Verbindung relevant sind. Bei diesen Parametern handelt es sich um OpenCMIS Verbindungsparametern.
	28
	29	=== Authentifizierung ===
	30
	31	; Authentifizierungstyp
	32	: Gibt an, wie die Authentifizierung stattfinden soll.
	33	Die zur Verfügung stehenden Typen sind:
	34	- Keiner
	35	- Basic Auth
	36	; Benutzername und Passwort
	37	: Der Benutzername und das Passwort für Basic Auth.
	38
2.2	39	=== Proxyeinstellungen ===
2.1	40
	41	; Proxy verwenden
	42	: Gibt an, ob die Verbindung nur über einen Proxy-Server stattfinden soll.
	43	; Proxy-Host
	44	: Die URL, unter welcher sich der Proxy-Server befindet.
	45	; Proxy-Port
	46	: Der Port, unter welchem sich der Proxy-Server befindet.
	47	; Benutzername und Passwort
	48	: Falls für den Proxy eine Authentifizierung über Basic Auth notwendig ist, können die Credentials hier angegeben werden.
	49
	50	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.
	51
5.1	52	=== Vorhandene Ordner und Dokumente der CMIS-Verbindung {{version major="1" minor="3" patch="0"/}} ===
2.1	53
4.1	54	Über den Knopf CMIS-Objekte laden wird in diesem Bereich die Ordner- und Dateistruktur der CMIS-Verbindung angezeigt. Sichtbar sind nur die CMIS-Objekte für Nutzer, die über entsprechende Berechtigungen gemäß der konfigurierten Authentifizierung verfügen. Die angezeigte Struktur ermöglicht die Überprüfung, ob die Workflow-Aktion Ordner und Dokumente korrekt angelegt hat. Durch das Klicken auf das Kopier-Symbol wird dessen Pfad in die Zwischenablage kopiert.
	55
5.1	56	=== CMIS-Abfragen {{version major="1" minor="3" patch="0"/}} ===
4.1	57
	58	Über den Editor können CMIS-Abfragen eingegeben werden, die auf der konfigurierten CMIS-Verbindung ausgeführt werden. Die Ergebnisse werden in einer Tabelle angezeigt. Die maximale Anzahl der Ergebnisse kann angegeben werden, um die Abfrage einzuschränken und die Abfragezeit zu verkürzen.
	59
2.1	60	== Workflow-Aktion ==
	61
	62	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.
	63
4.1	64	=== Verbindungseinstellungen ===
	65
	66	; Verbindung
	67	: Hier muss eine der vorhandenen CMIS-Verbindungen ausgewählt werden, um die Workflow-Aktion zu konfigurieren.
	68	; URL
	69	: Die konfigurierte Server-URL der ausgewählten CMIS-Verbindung.
5.1	70	; Verbindung testen {{version major="1" minor="3" patch="0"/}}
4.1	71	: Dieser Button überprüft die CMIS-Verbindungskonfiguration und prüft, ob eine Verbindung hergestellt werden kann.
	72
2.1	73	=== Objekteinstellungen ===
	74
	75	; Objekt-Typ
	76	: Gibt an welchen Basis-Typ das Objekt habe soll. Die Unterstützen Typen sind Ordner und Dokument.
	77	; Objekt-Typ-ID
4.1	78	: Gibt den Identifikator des Objekt-Typen an, welcher verwendet werden soll. Wird kein spezifischer Identifikator angegeben wird der Basis Identifikator des Objekt-Typen genommen (Dokumente: "cmis:document", Ordner: "cmis:folder"). Über die Auswahl oder Eingabe werden falls vorhanden mögliche IDs der CMIS-Verbindung angezeigt. Dabei handelt es sich um IDs der Basis Identifikatoren "cmis:document" bzw. "cmis:folder".
2.1	79	; Objekt-Name
4.1	80	: Der Name, welches das zu erstellende Objekt haben soll. Falls es sich um ein Dokument handelt und keine Eingabe für den Objekt-Namen erfolgte, wird der Dateiname für den Objekt-Namen verwendet. Für Ordner ist der Standardwert "output".
5.1	81	; Bestehenden Ordner zurückgeben {{version major="1" minor="3" patch="0"/}}
4.1	82	: Diese Option gibt einen Ordner zurück, wenn im angegebenen Zielordnerpfad bereits ein Ordner mit dem im Textfeld "Objekt-Name" angegebenen Objektnamen existiert. In diesem Fall wird kein neues CMIS-Objekt erzeugt, sondern das vorhandene CMIS-Objekt zurückgegeben. Diese Option kann nur aktiviert werden, wenn der Objekttyp "Ordner" ausgewählt wurde. Außerdem ist die Option "Automatische Versionsnummer hinzufügen" nicht verfügbar, wenn diese Option aktiviert ist.
5.1	83	; Versionsnummer zu Objektnamen hinzufügen {{version major="1" minor="3" patch="0"/}}
4.1	84	: Durch Anhaken dieser Option wird beim Anlegen eines CMIS-Objekts überprüft, ob der gewünschte Name des Objekts an dem konfigurierten Speicherort bereits existiert. Falls ja, erhält das Objekt stattdessen eine Versionsnummer im Namen. Ein Beispiel hierfür wäre: der konfigurierte Objekt-Name "Objekt" wird zu "Objekt (1)" angepasst oder für Dateien mit der Endung, wird "Datei.pdf" zu "Datei (1).pdf" umbenannt.
	85	; Endung der verwendeten Datei(en) nutzen
	86	: Diese Einstellung kann für die Erstellung von CMIS-Dokumenten ausgewählt werden. Wenn sie aktiviert ist und ein Objekt-Name für das Dokument konfiguriert wurde, wird die Dateiendung des Dokuments als Teil des Objekt-Namen verwendet. Diese Option ist hilfreich, falls ein eigener Objekt-Name mit Dateiendung verwendet werden soll, der nicht identisch mit dem Dateinamen ist.
5.1	87	; Dokumentenversionierung aktivieren {{version major="1" minor="3" patch="0"/}}
4.1	88	: Aktivieren Sie diese Option, um für jedes neu erstellte Dokument eine Hauptversion (Major-Version) im CMIS-Repository zu erstellen. Beachten Sie, dass diese Funktion von den Fähigkeiten des verwendeten CMIS-Repositories abhängig ist und nur funktioniert, wenn das Repository Versionierung unterstützt. Bei Deaktivierung erfolgt keine Versionierung.
5.1	89	; Speichern im dynamischen Verzeichnis {{version major="1" minor="3" patch="0"/}}
4.1	90	: Aktivieren Sie diese Option, um das Dokument ohne Zuweisung zu einem Ordner zu erstellen. Es wird in einem virtuellen, nicht sichtbaren Verzeichnis abgelegt. Voraussetzung für diese Funktion ist, dass das CMIS-Repository 'Unfiling' unterstützt. Bei Aktivierung dieser Option ist keine Eingabe eines Zielordnerpfades erforderlich.
2.2	91	; Zielordnerpfad
5.1	92	: Der Pfad, unter dem das Objekt erstellt werden soll. Bei der Angabe eines Zielordnerpfades ist darauf zu achten, dass der verwendete Pfad das Ablegen von Ordnern bzw. Dokumenten zulässt bzw. die Berechtigungen auf der CMIS-Schnittstelle vorhanden sind. Über die Schaltfläche mit dem Ordnersymbol kann die Ordnerstruktur der Verbindung angezeigt werden. Hier werden alle relevanten Information zum selektierten CMIS-Objekt angezeigt. Dies ist zum einen eine allgemeine Übersicht über die Metadaten eines CMIS-Objekts, die Objekteigenschaften des Objekts und eine Angabe der Objekttyp-IDs, die im ausgewählten Ordner angelegt werden können. Über das Kopiersymbol kann der Pfad zum ausgewählten Ordner automatisch in das Textfeld für den Zielordnerpfad kopiert werden. {{version major="1" minor="3" patch="0"/}}
2.1	93	; Objekt-Properties
5.1	94	: Hier können die Objekteigenschaften für das zu erstellende CMIS-Objekt konfiguriert werden. Hierbei muss zusätzlich festgelegt werden, welchen Datentyp die verwendete Objekt-Eigenschaft besitzt, welche von der CMIS-Schnittstelle definiert ist. Der Standardwert ist String. Bei Verwendung des Datentyp Datum muss ein Datumsformat angegeben werden. Alle verwendeten Objekt-Properties mit dem Datentyp Datum müssen das gleiche Datumsformat besitzen. Beim Betätigen des Hinzufügen-Buttons rechts oben öffnet sich ein Dialog, welcher alle möglichen Eigenschaften des ausgewählten Objekt-Typ-IDs sowie bereits konfigurierten Eigenschaften anzeigt. Hier sind die ID, der Name und der Datentyp der Objekt-Eigenschaft aufgeführt. Im Tabellenkopf kann nach dem jeweiligen Attribut gefiltert werden. Die ausgewählten Eigenschaften werden durch das Auswählen und Klicken auf den Aktualisieren-Button den bereits bestehenden Eigenschaften hinzugefügt. {{version major="1" minor="3" patch="0"/}}
2.1	95
5.1	96	=== Werte bei Erfolg {{version major="1" minor="3" patch="0"/}} ===
4.1	97
	98	; [%$<Aktionsname>.RESULT.objectPath%]
	99	: Der Ordnerpfad eines Ordner-Objekts. Für Dokumente wird ein Leerstring zurückgegeben.
	100	; [%$<Aktionsname>.RESULT.createdCount%]
	101	: Anzahl der erzeugten CMIS-Objekte. Dieser Wert ist bspw. sinnvoll wenn die Option "Bestehenden Ordner zurückgeben" aktiviert und überprüft werden soll, ob ein CMIS-Objekt erzeugt wurde oder ein bereits bestehendes Objekt gefunden wurde.
	102
2.1	103	=== Mögliche Fehler ===
	104
	105	; CONNECTION_FAILED
	106	: Der Versuch ein Verbindung aufzugbauen ist gescheitert.
	107	; FILE_SYSTEM_ERROR
	108	: Es gab einen Fehler beim Erhalt der Datei.
	109	; INVALID_PATH
	110	: Der angegeben Pfad ist ungültig. Gibt das Pfadsegmente zurück, welches den Fehler ausgelöst hat.
	111	; AUTHENTICATION_FAILED
	112	: Es war nicht möglich an der Schnittstelle zu Authentifizieren.
	113	; NOT_AUTHORIZED
	114	: Die Autorisierung für der Schnittstelle reicht nicht aus
	115	; REPOSITORY_NOT_FOUND
	116	: Falls ein Repository durch die Repository-ID angegeben wurde, konnte dieses nicht gefunden werden.
	117	; TYPE_NOT_SUPPORTED
	118	: Der durch das Feld Objekt-Typ-ID angegebene Typ wird nicht von der Schnittstelle unterstützt.
3.4	119	; OBJECT_PROPERTY_CREATION_FAILED
	120	: Bei der Erstellung einer Objekt-Eigenschaft ist ein Fehler aufgetreten. Dies könnte bspw. bei falscher Konfiguration des Datentyps auftreten.
3.7	121	; OBJECT_CREATION_FAILED
	122	: Das Erzeugen des Objekts auf der CMIS-Schnittstelle ist fehlgeschlagen.
4.1	123	; OBJECT_ALREADY_EXISTS
	124	: Falls das Objekt am konfigurierten Ordnerpfad mit diesem Namen bereits existiert.
3.1	125
	126	== Versionshistorie ==
	127
6.2	128	=== 1.3.1 ===
	129
	130	* Maximale Länge des Zielordnerpfad erhöht
	131
4.1	132	=== 1.3.0 ===
	133
	134	* Anzeige von Ordnerstruktur der CMIS-Verbindung
	135	* Ausführen von CMIS-Abfragen
	136	* Unterstützung von Unfiling-Funktion und Dokumentenversionierung
	137	* Anpassungen in Workflow-Aktion-Oberfläche
	138	* Fehlerbehebungen
	139
3.7	140	=== 1.2.3 ===
	141
	142	* Fehlerbehebungen in CMIS-Verbindung Konfigurationsoberfläche
	143
3.5	144	=== 1.2.2 ===
	145
	146	* Auswahl von Datentypen für Objekt-Eigenschaften
	147
	148	=== 1.2.1 ===
	149
	150	* Fehlerbehebungen
	151
3.3	152	=== 1.2.0 ===
	153
	154	* Auswahl von mehreren Dateien und wiederholten Upload-Elementen in Workflow-Aktion möglich
	155
3.2	156	=== 1.1.1 ===
	157
	158	* Rollenrecht für die Verwaltung von CMIS-Verbindungen hinzugefügt
	159
3.1	160	=== 1.1.0 ===
	161
	162	* Datenbankänderung für CMIS-Connection Entitäten
	163	* Fehlerbehebungen
	164
	165	=== 1.0.0 ===
	166
	167	* Initialer Release