1.1. Aktivierung des API Dienstes und Konfiguration von ecoDMS
API in ecoDMS aktivieren
Um die ecoDMS Aktivitäten für Accantum WMS nutzen zu können, müssen sie zuerst den API REST Service in ecoDMS aktivieren. Eine Anleitung zur Aktivierung des Dienstes finden sie im ecoDMS API Handbuch unter https://confluence.applord-gruppe.eu/api/aktivierung-des-api-dienstes.
Netzwerk und Firewall
Wenn Sie eine Firewall auf Ihren Systemen verwenden, dann stellen sie itte sicher, dass Zugriffe auf den ecoDMS API REST Service dadurch nicht blockiert werden.
Lizenzen für API Zugriffe
In einigen ecoDMS Lizenzmodellen ist die Anzahl von monatlichen Zugriffen auf den API REST Service begrenzt. Die Anzahl der verbleibenden Zugriffe errechnet sich aus der Anzahl der lizensierten Zugriffe, abzüglich der Anzahl der über die API hoch- und heruntergeladenen Dokumente.
Bitte vor einem Produktivbetrieb, ob in ihrer Lizenz eine ausreichende Anzahl von API Zugriffen enthalten ist, und lizensieren sie diese Zugriffe gegebenenfalls nach!
Die ecoDMS Aktivitäten für Accantum WMS stellen eine Aktivität zur Verfügung, über welche die noch verbleibende Anzahl von API Zugriffen im jeweiligen Zeitraum ermittelt werden kann. Es wird empfohlen einen regelmäßig automatisch ausgeführten Workflow einzurichten, welcher die verbleibenden Zugriffe ermittelt, und bei Unterschreiten eines vorher festzulegenden Grenzwertes rechtzeitig eine Alarmierung auslöst.
Upload-Größe für ecoDMS API REST Service anpassen
Der Upload von Dateien ist im ecoDMS API REST Service per Standard auf 10 MB pro Datei begrenzt. Eine Anleitung zur Anpassung des Grenzwertes finden sie im ecoDMS API Handbuch unter https://confluence.applord-gruppe.eu/api/upload-groesse
Benutzerkonto für API Zugriffe in ecoDMS einrichten
Die Anmeldung am ecoDMS API REST Service erfolgt über ein ecoDMS Benutzerkonto. Dieses Benutzerkonto muss über ausreichende Zugriffsberechtigungen verfügen, um alle gewünschten Aktionen durchführen zu können. Es wird insbesondere empfohlen dem Benutzerkonto für die API den grundsätzlichen Zugriff auf alle Dokumente durch Zuweisung der Rolle ecoSIMSALLDOCS zu ermöglichen.
1.2. Konfiguration der API Verbindung in Accantum WMS
Installation und Lizenz
Um die ecoDMS API Aktivitäten verwenden zu können, muss der Administrator diese zunächst ihrer WMS-Installation hinzufügen. Wie sie neue Aktivitäten installieren können Sie hier nachlesen.
Des Weiteren benötigen Sie eine WMS-Lizenz, welche die ecoDMS API Aktivitäten beinhaltet. Diese Lizenz erhalten sie direkt von [accantum].
Globale Einstellungen
Die Einstellungen für den Zugriff auf die ecoDMS API können im WMS Workflow-Studio für den Mandanten global vorgenommen werden.
Individuelle Einstellung in einem Workflow
Die globalen Einstellungen können in jedem einzelnen Workflow übersteuert werden.
1.3. Zuordnungen von Attributen
Der Zugriff auf IDs von Stammdaten-Objekten, wie z. B. Ordner, Typen, kann auf zwei verschiedenen Wegen realisiert werden.
1.3.1. Zuordnungen zu ecoDMS
IDs von Objekten können über die Oberfläche von Zuordnungen einer aussagekräftig benannten Variablen zugewiesen werden, welche sie anschließend im Ausdruckseditor anstelle der tatsächlichen IDs verwenden können. Der Name von Variablen ist im Editor für die Zuordnungen editierbar. Die Sortierung der Spalten kann über das Anklicken der Überschriften angepasst werden.
1.3.2. Objekt EcoConfigData
Das Objekt EcoConfigData kann im Verlauf des Workflows über die Aktivität Stammdaten abrufen erzeugt werden und verfügt über folgende Methoden:
Ausdruck | Beschreibung |
string Id = x.FoldersId(string Name) | Ermittelt die ID eines Ordners anhand des angezeigten Namens. |
string Name = x.FoldersName(string Id) | Ermittelt den Namen eines Ordners anhand der ID. |
Int64 Id = x.TypesId(string Name) | Ermittelt die ID eines Typs anhand des angezeigten Namens. |
string Name = x.TypesName(string Id) | Ermittelt den Namen eines Typs anhand der ID. |
string Id = x.AttributesId(string Name) | Ermittelt die ID eines Attributes anhand des angezeigten Namens. |
string Name = x.AttributesName(string Id) | Ermittelt den Namen eines Attributes anhand der ID. |
Int64 Id = x.StatusId(string Name) | Ermittelt die ID eines Status anhand des angezeigten Namens. |
string Name = x.StatusName(string Id) | Ermittelt den Namen eines Status anhand der ID. |