Das Plugin benötigt mindestens die formcycle Version 8.0.0.

Mit dem 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.

Inhalt

Konfiguration der CMIS-Verbindungen

Über den Menüpunkt CMIS-Verbindungen besteht die Möglichkeit eine Verbindung für eine bestehende CMIS-Schnittstelle einzurichten.

Verbindungseinstellungen

• Name
  Der Name, welche die konfigurierte Verbindung haben soll.
• Verbindungstyp
  Unter dem Verbindungstyp der Schnittstelle ist des Protokoll der Schnittstelle zu verstehen, welche für die Datenübertragung verwendet wird.
  Die 3 zur Verfügung stehende Möglichkeiten sind:
  - AtomPub
  - Browser (Zugriff über die HTTP-Methoden GET und POST im Format JSON)
• Server URL
  Die URL, unter welcher die anzubindende Schnittstelle erreichbar ist.
• Repository-ID
  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. 2.3.1+
• Verbindungsparameter
  Weitere Parameter, welche für die Verbindung relevant sind. Bei diesen Parametern handelt es sich um OpenCMIS Verbindungsparametern.

Authentifizierung

• Authentifizierungstyp
  Gibt an, wie die Authentifizierung stattfinden soll.
  Die zur Verfügung stehenden Typen sind:
  - Keiner
  - Basic Auth
• Benutzername und Passwort
  Der Benutzername und das Passwort für Basic Auth.

Proxyeinstellungen

• Proxy verwenden
  Gibt an, ob die Verbindung nur über einen Proxy-Server stattfinden soll.
• Proxy-Host
  Die URL, unter welcher sich der Proxy-Server befindet.
• Proxy-Port
  Der Port, unter welchem sich der Proxy-Server befindet.
• Benutzername und Passwort
  Falls für den Proxy eine Authentifizierung über Basic Auth notwendig ist, können die Credentials hier angegeben werden.

Vorhandene Ordner und Dokumente der CMIS-Verbindung 

Ü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.

Beispielstruktur einer CMIS-Verbindung

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.

CMIS-Abfragen

Ü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.

Workflow-Aktion - CMIS-Abfrage ausführen  2.5.0+

Diese Aktion ermöglicht es, eine CMIS-Abfrage auszuführen. Dazu muss vorher eine Verbindung in der CMIS-Verbindungsverwaltung angelegt worden sein. Innerhalb der Abfrage können Platzhalter verwendet werden, um etwa Formulardaten in die Abfrage einzuführen.

Details der CMIS-Abfrage

• Verbindung

Auswahl der vorher konfigurierten CMIS-Verbindung, welche benutzt wird zur Ausführung der CMIS-Abfrage.

• Max. Ergebnisse

Anzahl der Ergebnisse die maximal zurückgegeben werden. Dies kann genutzt werden um die Dauer der CMIS-Abfrage zu reduzieren. Standardwert ist 100.

• Rückgabe aller Dokumentversionen

Diese Option steuert, ob alle Versionen eines Dokuments in den Ergebnissen einer CMIS-Abfrage enthalten sein sollen. Wenn diese Option aktiviert ist, werden alle Versionen jedes Dokuments, das die Abfragebedingungen erfüllt, in den Ergebnissen zurückgegeben.

• CMIS-Abfrage

Eingabe der CMIS-Abfrage, welche ausgeführt werden soll. Es können Platzhalter genutzt werden, um bspw.         Formulardaten in der CMIS-Abfrage zu nutzen. 

Werte bei Erfolg

• [%$<Aktionsname>.RESULT.result[i]['key']%]
  Ein JSON-Array mit den Ergebnissen der CMIS-Abfrage. Jeder Eintrag im JSON-Array ist ein JSON-Objekt, wobei der Schlüssel dem Namen der CMIS-Eigenschaft entspricht.
• [%$<Aktionsname>.RESULT.resultCount%]
  Anzahl an gefundenen Ergebnissen der ausgeführten CMIS-Abfrage. Dieser Wert wird durch die konfigurierte Anzahl an maximalen Treffern limitiert.

Mögliche Fehler

• CMIS_CONNECTION_NOT_FOUND
  Fehlercode, wenn die CMIS-Verbindung nicht gefunden wurde. Dies kann passieren, wenn die Verbindung zwischenzeitlich gelöscht wurde.
• QUERY_EXECUTION_FAILED
  Fehlercode, wenn die CMIS-Abfrage nicht gegen die CMIS-Verbindung ausgeführt werden kann.
• UNABLE_TO_CONNECT
  Fehlercode, wenn die Verbindung zur CMIS-Verbindung nicht hergestellt werden konnte, etwa wenn die URL oder die Anmeldeinformationen ungültig sind.

Workflow-Aktion - CMIS-Objekt anlegen

Die konfigurierten CMIS-Verbindungen können nun in der Workflow-Aktion CMIS-Objekt anlegen verwendet werden. Die Aktion ermöglicht es Ordner, Dokumente und Items auf dem DMS, welches über eine CMIS-Schnittstelle verfügt, anzulegen.

Verbindungseinstellungen

• Verbindung
  Hier muss eine der vorhandenen CMIS-Verbindungen ausgewählt werden, um die Workflow-Aktion zu konfigurieren.
• URL
  Die konfigurierte Server-URL der ausgewählten CMIS-Verbindung.
• Verbindung testen2.2.0+
  Dieser Button überprüft die CMIS-Verbindungskonfiguration und prüft, ob eine Verbindung hergestellt werden kann.

Objekteinstellungen

• Objekttyp
  Gibt an welchen Basis-Typ das Objekt habe soll. Die Unterstützten Typen sind Ordner, Dokument und Item.
• Objekttyp-ID
  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", Item: "cmis:item"). Ü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", "cmis:folder" bzw. "cmis:item".
• Objektname
  Der Name, den das zu erstellende Objekt erhalten soll. Wenn es sich um ein Dokument handelt und kein Objektname eingegeben wurde, wird der Dateiname als Objektname verwendet. Wenn mehrere Dateien ausgewählt wurden, die erstellt werden sollen, wird ebenfalls der jeweilige Dateiname der Datei als Objektname verwendet, wenn dieses Feld leer gelassen wird.  Der Standardwert für Ordner und Item ist "output".
• Bestehenden Ordner zurückgeben 2.3.0+
  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.
• Objekt-Eigenschaften aktualisieren2.5.0+
  Diese Option ermöglicht es, die Eigenschaften eines gefundenen Ordner-Objekts zu aktualisieren. Wenn ein Ordner-Objekt mit dem angegebenen Namen gefunden wird, können Sie mit dieser Option die Eigenschaften des Ordner-Objekts aktualisieren.
• Versionsnummer zu Objektnamen hinzufügen 2.2.0+
  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.
• Dateiendung entfernen 2.5.0+
  Diese Einstellung kann für die Erstellung von CMIS-Dokumenten ausgewählt werden. Wenn sie aktiviert ist wird die Dateiendung der ausgewählten Datei entfernt. Wenn sie nicht aktiviert ist, wird die Dateiendung an den Objektnamen angefügt.
• Dokumentenversionierung aktivieren 2.4.0+
  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.
• Speichern im dynamischen Verzeichnis 2.4.0+
  Aktivieren Sie diese Option, um das Dokument oder Item 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.
• Zielordner mit Objekt-ID konfigurieren 2.6.0+
  Diese Funktion ermöglicht es, den Pfad zum Zielordner mit einer spezifischen Objekt-ID zu konfigurieren. Im Textfeld muss die Objekt-ID des Zielordners eingegeben werden. Die Objekt-ID kann aus der Übersicht der CMIS-Verbindung entnommen werden.
• Zielordnerpfad/Zielordner-ID
  Je nach Aktivierungszustand der Option "Zielordner mit Objekt-ID konfigurieren" wird hier der Pfad, unter dem das Objekt erstellt werden soll oder die ID des Objekts des Zielordners erwartet. Über die Schaltfläche mit dem Ordnersymbol kann die Ordnerstruktur der Verbindung angezeigt werden. Hier werden alle relevanten Informationen 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 oder Objekt-ID zum ausgewählten Ordner automatisch in das Textfeld für den Zielordner kopiert werden.

• Objekt-Eigenschaften
  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. 2.2.0+

Werte bei Erfolg

• [%$<Aktionsname>.RESULT.objectPath%]
  Der Objektpfad eines CMIS-Objekts.
• [%$<Aktionsname>.RESULT.createdCount%] 2.3.0+
  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.
• [%$<Aktionsname>.RESULT.name%] 2.5.0+
  Name des CMIS-Objekts
• [%$<Aktionsname>.RESULT.objectId%] 2.5.0+
  Eindeutige ID des Objekts 
• [%$<Aktionsname>.RESULT.objectTypeId%] 2.5.0+
  Typ des Objekts 
• [%$<Aktionsname>.RESULT.baseTypeId%] 2.5.0+
  Basistyp des Objekts 
• [%$<Aktionsname>.RESULT.createdBy%] 2.5.0+
  Ersteller des Objekts
• [%$<Aktionsname>.RESULT.creationDate%] 2.5.0+
  Erstellungsdatum des Objekts 
• [%$<Aktionsname>.RESULT.lastModificationDate%] 2.5.0+
  Datum der letzten Bearbeitung 
• [%$<Aktionsname>.RESULT.lastModifiedBy%] 2.5.0+
  Benutzer, der das Objekt zuletzt bearbeitet hat 
• [%$<Aktionsname>.RESULT.changeToken%] 2.5.0+
  Token, das Änderungen am Objekt kennzeichnet 
• [%$<Aktionsname>.RESULT.objectProperties['key']%] 2.5.0+
  Ein Schlüssel-Wert-Paar-Sammlung der Objekt-Eigenschaften des erstellten CMIS-Objekts. Ein Schlüssel kann gesetzt werden, um eine bestimmte Eigenschaft auszuwählen.
• [%$<Aktionsname>.RESULT.documentsProperties[i]['key']%] 2.5.0+
  Ein JSON-Array mit allen Objekt-Eigenschaften der erstellten CMIS-Dokumente. Jeder Eintrag im JSON-Array ist ein JSON-Objekt, wobei der Schlüssel dem Namen der CMIS-Eigenschaft eines CMIS-Dokuments entspricht.

Mögliche Fehler

• CONNECTION_FAILED
  Der Versuch ein Verbindung aufzubauen ist gescheitert.
• FILE_SYSTEM_ERROR
  Es gab einen Fehler beim Erhalt der Datei.
• INVALID_PATH
  Der angegeben Pfad ist ungültig. Gibt das Pfadsegmente zurück, welches den Fehler ausgelöst hat.
• AUTHENTICATION_FAILED
  Es war nicht möglich an der Schnittstelle zu Authentifizieren.
• NOT_AUTHORIZED
  Die Autorisierung für der Schnittstelle reicht nicht aus
• REPOSITORY_NOT_FOUND
  Falls ein Repository durch die Repository-ID angegeben wurde, konnte dieses nicht gefunden werden.
• TYPE_NOT_SUPPORTED
  Der durch das Feld Objekt-Typ-ID angegebene Typ wird nicht von der Schnittstelle unterstützt.
• OBJECT_PROPERTY_CREATION_FAILED
  Die Erstellung einer Objekt-Property ist fehlgeschlagen. Das passiert bspw. wenn für ein Datum ein falsches Format genommen wurde oder die Eingabe nicht in jeweiligen Datentyp konvertiert werden konnte.
• OBJECT_CREATION_FAILED
  Das Erzeugen des Objekts auf der CMIS-Schnittstelle ist fehlgeschlagen.
• OBJECT_ALREADY_EXISTS
  Falls das Objekt am konfigurierten Ordnerpfad mit diesem Namen bereits existiert.