Administrationshandbuch edoc CMIS archivelink

Funktionsumfang von edoc CMIS archivelink

CMIS ist eine umfangreiche Schnittstelle mit vielen verschiedenen Services. In edoc CMIS archivelink werden nur bestimmte CMIS-Standardservices verwendet.

Die vollständige Übersicht über den CMIS-Standard 1.1 (Datenmodell und Methoden) finden Sie unter: Content Management Interoperability Services (CMIS) Version 1.1 Plus Errata 01 (in englischer Sprache). In der CMIS-Dokumentation von OASIS finden Sie bei Bedarf Details der einzelnen CMIS-Services für edoc CMIS archivelink.

In diesem Artikel finden Sie eine Übersicht der CMIS-Funktionalitäten in edoc CMIS archivelink und die unterstützten CMIS-Services, die in edoc CMIS archivelink abweichend vom CMIS-Standard verwendet werden.

In diesem Abschnitt finden Sie Details zum allgemeinen Funktionsumfang.

Allgemeine Informationen zu API-Anfragen

  • Sie müssen API-Anfragen an edoc CMIS archivelink mithilfe des Browser Binding-Formats ausführen.

  • Sie können die Standardauthentifizierung (Basic Auth) verwenden oder sich mithilfe eines Bearer Tokens authentifizieren.

  • Der Abfrageparameter suppressResponseCodes wird unterstützt.

  • Der Abfrageparameter token und das Handling mithilfe des Services getLastResult wird nicht unterstützt.

Übersicht über die unterstützten CMIS-Services

In der Übersicht finden Sie die in edoc CMIS archivelink unterstützten CMIS-Services. Darüber hinaus finden Sie eine Beschreibung von Funktionalitäten (z.B. Inputs und Outputs) pro Service, die in edoc CMIS archivelink implementiert wurden und vom CMIS-Standard abweichen.

Tipp

Mit den Zahlen in Klammern können Sie den entsprechenden Abschnitt in der OASIS-Dokumentation zum CMIS-Standard schneller finden.

Repository Services (2.2.2)

Mit den Repository Services können Sie Informationen über Repositorys und deren Objekttypen abrufen und Objekttypdefinitionen verwalten.

Unterstützter CMIS-Service “getRepositories” (2.2.2.1)

Beschreibung: Sie können alle vorhandenen Repositorys auflisten.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Unterstützter CMIS-Service “getRepositoryInfo” (2.2.2.2)

Beschreibung: Sie können Informationen zu einem einzelnen Repository abrufen.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Unterstützter CMIS-Service “getTypeChildren” (2.2.2.3)

Beschreibung: Sie können die direkten Untertypen eines Objekttyps auflisten.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Unterstützter CMIS-Service “getTypeDescendants” (2.2.2.4)

Beschreibung: Sie können die vollständige Hierarchie der Untertypen eines Objekttyps abrufen.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Unterstützter CMIS-Service “getTypeDefinition” (2.2.2.5)

Beschreibung: Sie können die Definition eines Objekttyps abrufen.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Unterstützter CMIS-Service “createType” (2.2.2.6)

Beschreibung: Sie können einen neuen Objekttyp erstellen.

Abweichungen: Objekttypen, die mithilfe des CMIS-Services createType erstellt werden, werden nicht mit dem ECM-System synchronisiert.

Unterstützter CMIS-Service “updateType” (2.2.2.7)

Beschreibung: Sie können einen vorhandenen Objekttyp ändern.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Unterstützter CMIS-Service “deleteType” (2.2.2.8)

Beschreibung: Sie können einen Objekttyp löschen.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Mit den Navigation Services können Sie die Struktur eines Repositorys durchlaufen und Beziehungen zwischen Ordnern und Objekten ermitteln.

Unterstützter CMIS-Service “getChildren” (2.2.3.1)

Beschreibung: Sie können die direkten Unterobjekte eines Objekts abrufen.

Abweichungen: Die Parameter includeRelationships und renditionFilter werden ignoriert, da das Repository beide Elemente nicht unterstützt.

Unterstützter CMIS-Service “getFolderParent” (2.2.3.4)

Beschreibung: Sie können den übergeordneten Ordner eines Ordners abrufen.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Unterstützter CMIS-Service “getObjectParents” (2.2.3.5)

Beschreibung: Sie können die übergeordneten Elemente eines Objekts abrufen.

Abweichungen: Die Parameter includeRelationships und renditionFilter werden ignoriert, da das Repository beide Elemente nicht unterstützt.

Unterstützter CMIS-Service “getCheckedOutDocs” (2.2.3.6)

Beschreibung: Sie können alle aktuell ausgecheckten Dokumente abrufen.

Abweichungen: Die Parameter includeRelationships und renditionFilter werden ignoriert, da das Repository beide Elemente nicht unterstützt.

Object Services (2.2.4)

Mit den Object Services können Sie CMIS-Objekte erstellen, abrufen, ändern, verschieben und löschen sowie deren Inhalte verwalten.

Unterstützter CMIS-Service “createDocument” (2.2.4.1)

Beschreibung: Sie können ein neues Dokument inklusive Inhalt und Metadaten erstellen.

Abweichungen: Die Parameter policies, addACEs und removeACEs werden ignoriert, da das Repository die Elemente nicht unterstützt. Bei der Ausgabe werden relationships, policies, renditions und acl nicht ausgegeben.

Unterstützter CMIS-Service “createFolder” (2.2.4.3)

Beschreibung: Sie können einen neuen Ordner erstellen.

Abweichungen: Die Parameter policies, addACEs und removeACEs werden ignoriert, da das Repository die Elemente nicht unterstützt. Bei der Ausgabe werden relationships, policies und acl nicht ausgegeben.

Unterstützter CMIS-Service “createItem” (2.2.4.6)

Beschreibung: Sie können ein allgemeines CMIS-Objekt ohne Dokumentinhalt erstellen.

Abweichungen: Die Parameter policies, addACEs und removeACEs werden ignoriert, da das Repository die Elemente nicht unterstützt. Bei der Ausgabe werden relationships, policies und acl nicht ausgegeben.

Unterstützter CMIS-Service “getAllowableActions” (2.2.4.7)

Beschreibung: Sie können die für ein Objekt zulässigen Aktionen abrufen.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Unterstützter CMIS-Service “getObject” (2.2.4.8)

Beschreibung: Sie können ein Objekt einschließlich seiner Metadaten abrufen.

Abweichungen: Die Parameter includeRelationships, includePolicyIds, includeACL und renditionFilter werden ignoriert, da das Repository die Elemente nicht unterstützt.

Unterstützter CMIS-Service “getProperties” (2.2.4.9)

Beschreibung: Sie können die Eigenschaften eines Objekts abrufen.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Unterstützter CMIS-Service “getObjectByPath” (2.2.4.10)

Beschreibung: Sie können ein Objekt anhand seines Repositorypfades abrufen.

Abweichungen: Die Parameter includeRelationships, includePolicyIds, includeACL und renditionFilter werden ignoriert, da das Repository die Elemente nicht unterstützt.

Unterstützter CMIS-Service “getContentStream” (2.2.4.11)

Beschreibung: Sie können den Inhalt eines Dokuments abrufen.

Abweichungen: Da Renditions (Darstellungen) nicht unterstützt werden, können Sie beim Parameter streamId nur die Haupt-Content Stream-ID angeben oder den Parameter streamId nicht angeben. Wenn Sie eine andere Stream-ID angeben, wird ein Fehler ausgegeben.

Unterstützter CMIS-Service “getRenditions” (2.2.4.12)

Beschreibung: Sie können die verfügbaren Darstellungen eines Dokuments abrufen.

Abweichungen: Renditions (Darstellungen) werden nicht unterstützt. Es wird immer zurückgegeben, dass keine Renditions existieren.

Unterstützter CMIS-Service “updateProperties” (2.2.4.13)

Beschreibung: Sie können die Eigenschaften eines Objekts ändern.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Unterstützter CMIS-Service “moveObject” (2.2.4.15)

Beschreibung: Sie können ein Objekt zwischen zwei Ordnern verschieben.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Unterstützter CMIS-Service “deleteObject” (2.2.4.16)

Beschreibung: Sie können ein einzelnes Objekt löschen.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Unterstützter CMIS-Service “deleteTree” (2.2.4.17)

Beschreibung: Sie können einen Ordner einschließlich aller enthaltenen Objekte löschen.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Unterstützter CMIS-Service “setContentStream” (2.2.4.18)

Beschreibung: Sie können den Inhalt (Content Stream) festlegen oder ersetzen.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Unterstützter CMIS-Service “appendContentStream” (2.2.4.19)

Beschreibung: Sie können zusätzlichen Inhalt an ein Dokument anhängen.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Unterstützter CMIS-Service “deleteContentStream” (2.2.4.20)

Beschreibung: Sie können den Inhalt eines Dokuments entfernen.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Multi-filing Services (2.2.5)

Mit den Multi-filing Services können Sie Objekte mehreren Ordnern zuordnen oder bestehende Zuordnungen entfernen.

Unterstützter CMIS-Service “addObjectToFolder” (2.2.5.1)

Beschreibung: Sie können ein Objekt einem weiteren Ordner zuordnen.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Unterstützter CMIS-Service “removeObjectFromFolder” (2.2.5.2)

Beschreibung: Sie können die Zuordnung eines Objekts zu einem Ordner entfernen.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Discovery Services (2.2.6)

Mit den Discovery Services können Sie Objekte anhand von Metadaten und Suchabfragen finden.

Unterstützter CMIS-Service “query” (2.2.6.1)

Beschreibung: Sie können Objekte anhand ihrer Eigenschaften und Objekttypen suchen.

Vom Standard abweichende Inputs

  • statement: Es werden ausschließlich folgende Elemente in der SQL-Abfrage unterstützt:

    • SELECT: Unterstützt einzelne Attribute (bei Bedarf mit AS in Verbindung mit einem Alias) und * (Sternchen).

    • FROM: Unterstützt alle zulässigen Quellen.

    • WHERE: Unterstützt folgende Bedingungen und Funktionsaufrufe:

      • AND und OR

      • ANY

      • IN

      • IS NULL

      • =,!=, <,>,<=, >=

      • TIMESTAMP

      • IN_FOLDER: Ist ein Funktionsaufruf zum Prüfen, ob es sich bei dem Objekt um ein direkt untergeordnetes Objekt (child) eines angegebenen Folder-Objekts handelt.

      • IN_TREE: Ist ein Funktionsaufruf zum Prüfen, ob es sich bei dem Objekt um ein nachfolgendes Objekt (descendent) eines angegebenen Folder-Objekts handelt.

  • searchAllVersions: Das Feld wird nicht unterstützt.

  • includeRelationships: Das Feld wird nicht unterstützt.

  • renditionFilter: Das Feld wird nicht unterstützt.

Vom Standard abweichende Outputs

  • queryResults:

    • relationships: Der Feldinhalt ist immer der Wert null.

    • renditions: Der Feldinhalt ist immer der Wert null.

Versioning Services (2.2.7)

Mit den Versioning Services können Sie die Versionierung und Bearbeitung von Dokumenten steuern.

Unterstützter CMIS-Service “checkOut” (2.2.7.1)

Beschreibung: Sie können ein Dokument zur Bearbeitung auschecken.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Unterstützter CMIS-Service “cancelCheckOut” (2.2.7.2)

Beschreibung: Sie können einen Checkout verwerfen und die Bearbeitung abbrechen.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Unterstützter CMIS-Service “checkIn” (2.2.7.3)

Beschreibung: Sie können Änderungen an einem Dokument einchecken und eine neue Version erstellen.

Abweichungen: Die Parameter policies, addACEs und removeACEs werden ignoriert, da das Repository die Elemente nicht unterstützt.

Unterstützter CMIS-Service “getObjectOfLatestVersion” (2.2.7.4)

Beschreibung: Sie können die aktuellste Version eines Dokuments abrufen.

Abweichungen: Die Parameter includeRelationships, includePolicyIds, includeACL und renditionFilter werden ignoriert, da das Repository die Elemente nicht unterstützt.

Unterstützter CMIS-Service “getPropertiesOfLatestVersion” (2.2.7.5)

Beschreibung: Sie können die Eigenschaften der aktuellsten Dokumentversion abrufen.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Unterstützter CMIS-Service “getAllVersions” (2.2.7.6)

Beschreibung: Sie können alle Versionen eines Dokuments abrufen.

Abweichungen: Es gibt keine Abweichungen vom Standard.

Last updated: