Mit den ecoDMS Aktivitäten können Sie aus dem [accantum] WMS auf Dokumente in Ihrem ecoDMS System zugreifen. Dafür stehen Ihnen die Aktivitäten aus der folgenden Übersicht zur Verfügung:

Inhalt

1 Attribut zuweisen
2 Attribute ermitteln
3 Attribute speichern
4 Datei hochladen
5 Dokument herunterladen
6 Dokument in Papierkorb verschieben
7 Dokument Version hinzufügen
8 Dokument Versionen ermitteln
9 Dokumentbeziehung entfernen
10 Dokumentbeziehung hinzufügen
11 Dokumentbeziehungen ermitteln
12 Dokumente suchen
13 Klassifizierung hinzufügen
14 Lizenz Statistik für API Zugriffe ermitteln
15 Stammdaten abrufen
16 Suchfilter hinzufügen

Attribut zuweisen

Beschreibung

Diese Aktivität verändert den Wert eines Attributs in einer Attribut-Liste (EcoDocAttributes).

Eigenschaften

Eingabe

Name	Beschreibung	Datentyp	Erforderlich
Attribut-Liste	Liste von Attributen, in welcher einem Attribut ein neuer Wert zugewiesen werden soll.	EcoDocAttributes	ja
Attribut ID	ID des zu verändernden Attributs.	string	ja
Wert	Wert, welcher dem Attribut zugewiesen werden soll.	string	ja

Ausgabe

Name	Beschreibung	Datentyp	Erforderlich
Attribut-Liste	Liste von Attributen, nach Anpassung des Attributwertes durch die Aktivität.	EcoDocAttributes	ja

Attribute ermitteln

Beschreibung

Diese Aktivität ermittelt eine Liste von Attributen (EcoDocAttributes) aus einer Dokument Beschreibung (EcoDocInfo) und gibt diese als Ergebnis zurück.

Eigenschaften

Eingabe

Name	Beschreibung	Datentyp	Erforderlich
Dokument Info	ecoDMS Dokument Beschreibung.	EcoDocInfo	ja

Ausgabe

Name	Beschreibung	Datentyp	Erforderlich
Attribut-Liste	Liste von Attributen des ausgelesenen ecoDMS Dokuments.	EcoDocAttributes	ja

Attribute speichern

Beschreibung

Diese Aktivität schreibt eine Liste von Attributen (EcoDocAttributes) in eine Dokument Beschreibung (EcoDocInfo).

Eigenschaften

Eingabe

Name	Beschreibung	Datentyp	Erforderlich
Dokument Info	ecoDMS Dokument Beschreibung.	EcoDocInfo	ja
Attribut-Liste	Liste von Attributen, welche auf das ecoDMS Dokument übertragen werden soll.	EcoDocAttributes	ja

Ausgabe

Name	Beschreibung	Datentyp	Erforderlich
Dokument Info	ecoDMS Dokument Beschreibung inkl. der neuen Attribute.	EcoDocAttributes	ja

Datei hochladen

Beschreibung

Diese Aktivität lädt eine Datei aus einem Verzeichnis des Dateisystems vom WMS in ecoDMS hoch und gibt anschließend eine Beschreibung des neu angelegten Dokuments (EcoDocInfo) als Ergebnis zurück.

Eigenschaften

Eingabe

Name	Beschreibung	Datentyp	Erforderlich
Verzeichnis	Verzeichnis, in welchem sich das hochzuladende Dokument befindet.	string	ja
Dateiname	Dateiname des hochzuladenden Dokuments.	string	ja
Versionen	Kennzeichen, ob dem Dokument zu einem späteren Zeitpunkt weitere Versionen hinzugefügt werden dürfen.	bool	nein

Ausgabe

Name	Beschreibung	Datentyp	Erforderlich
Dokument Info	ecoDMS Dokument Beschreibung des hochgeladenen Dokuments.	EcoDocAttributes	ja

Dokument herunterladen

Beschreibung

Diese Aktivität lädt ein Dokument aus ecoDMS in ein Verzeichnis aus dem Dateisystem des WMS herunter.

Eigenschaften

Eingabe

Name	Beschreibung	Datentyp	Erforderlich
Dokument ID	DocId des herunterzuladenden Dokuments in ecoDMS (kann über EcoDocInfo.DocId ermittelt werden).	Int64	ja
Klassifizierung ID	ClassifyDocId der Klassifizierung des herunterzuladenden Dokuments (kann über EcoDocInfo.ClassifyDocId ermittelt werden).	Int64	nein
Version	Versions des herunterzuladenden Dokuments. Wenn keine Version angegeben wird, lädt die Aktivität automatisch die aktuellste Version des Dokuments herunter.	Int64	nein
Verzeichnis	Ziel-Verzeichnis, in welches das Dokument heruntergeladen werden soll.	string	ja
Dateiname	Dateiname des Dokuments, welches heruntergeladen werden soll. Wenn kein Dateiname angegeben wird, lädt die Aktivität das Dokument automatisch mit dem in ecoDMS hinterlegten Dateinamen herunter.	string	nein
Verzeichnis erstellen	Kennzeichen, ob das Ziel-Verzeichnis automatisch erstellt werden soll, wenn es noch nicht vorhanden ist.	bool	nein
Überschreiben	Kennzeichen, ob eine bereits existierende Datei überschrieben werden soll.	bool	nein

Ausgabe

Name	Beschreibung	Datentyp	Erforderlich
Dateiname nach Download	Wenn kein Dateiname bei der Eingabe übergeben wurde, kann über diesen String der tatsächliche Name der heruntergeladenen Datei ermittelt werden.	string	nein

Dokument in Papierkorb verschieben

Beschreibung

Diese Aktivität verschiebt eine Klassifikation eines Dokuments in den Papierkorb.

Eigenschaften

Eingabe

Name	Beschreibung	Datentyp	Erforderlich
Klassifizierung ID	ClassifyDocId der Klassifizierung des Dokuments, welches in den Papierkorb verschoben werden soll.	Int64	ja

Dokument Version hinzufügen

Beschreibung

Diese Aktivität lädt eine Datei aus dem Dateisystem des WMS hoch und erzeugt daraus eine neue Version eines bestehenden Dokuments.

Eigenschaften

Eingabe

Name	Beschreibung	Datentyp	Erforderlich
Dokument ID	DocId des Dokuments, zu welchem eine neue Version hinzugefügt werden soll	Int64	ja
Verzeichnis	Verzeichnis, in welchem sich das hochzuladende Dokument befindet.	string	ja
Dateiname	Dateiname des hochzuladenden Dokuments.	string	ja
Fixieren	Kennzeichen, ob dem Dokument zu einem späteren Zeitpunkt noch weitere Versionen hinzugefügt werden dürfen.	bool	nein

Dokument Versionen ermitteln

Beschreibung

Diese Aktivität ermittelt alle verfügbaren Versionen eines Dokuments in ecoDMS.

Eigenschaften

Eingabe

Name	Beschreibung	Datentyp	Erforderlich
Dokument ID	DocId des Dokuments, zu welchem alle verfügbaren Versionen ermittelt werden sollen.	Int64	ja

Ausgabe

Name	Beschreibung	Datentyp	Erforderlich
Dokument Versionen	Liste der ermittelten Versionen des Dokuments.	List<EcoDocVersion>	ja

Dokumentbeziehung entfernen

Beschreibung

Diese Aktivität entfernt eine Beziehung (Link) zwischen zwei Klassifizierungen von Dokumenten. Die Reihenfolge bzw. Richtung ist für die Übergabe der Klassifizierungs IDs nicht von Bedeutung und wird von der API automatisch erkannt.

Eigenschaften

Eingabe

Name	Beschreibung	Datentyp	Erforderlich
Klassifizierung ID	ClassifyDocId des Klassifizierung eines Dokuments, zu welchem die Beziehung (Link) aufgehoben werden soll.	Int64	ja
Klassifizierung ID	ClassifyDocId des Klassifizierung eines Dokuments, zu welchem die Beziehung (Link) aufgehoben werden soll.	Int64	ja

Dokumentbeziehung hinzufügen

Beschreibung

Diese Aktivität stellt eine Beziehung (Link) zwischen zwei Klassifizierungen von Dokumenten her. Die Reihenfolge bzw. Richtung für die Übergabe der Klassifizierungs IDs ist nicht von Bedeutung und wird von der API automatisch bidirektional angelegt.

Eigenschaften

Eingabe

Name	Beschreibung	Datentyp	Erforderlich
Klassifizierung ID	ClassifyDocId des Klassifizierung eines Dokuments, zu welchem die Beziehung (Link) aufgehoben werden soll.	Int64	ja
Klassifizierung ID	ClassifyDocId des Klassifizierung eines Dokuments, zu welchem die Beziehung (Link) aufgehoben werden soll.	Int64	ja

Dokumentbeziehungen ermitteln

Beschreibung

Diese Aktivität ermittelt die Beziehungen (Links) von einer Klassifizierung eines Dokuments zu anderen Klassifizierungen von Dokumenten.

Eigenschaften

Eingabe

Name	Beschreibung	Datentyp	Erforderlich
Klassifizierung ID	ClassifyDocId des Klassifizierung eines Dokuments, zu welchem die Beziehungen ermittelt werden sollen.	Int64	ja

Ausgabe

Name	Beschreibung	Datentyp	Erforderlich
Klassifizierung IDs	Liste von ClassifyDocIds der Klassifizierungen, welche mit dem Dokument aus der Eingabe in Beziehung stehen.	List<Int64>	ja

Dokumente suchen

Beschreibung

Diese Aktivität sucht mit einem vorher erzeugten Suchfilter (EcoSearchFilter) nach Dokumenten in ecoDMS und gibt anschließend eine Liste von Dokument Beschreibungen (List<EcoDocInfo>) der gefundenen Dokumente als Ergebnis zurück.

Eigenschaften

Eingabe

Name	Beschreibung	Datentyp	Erforderlich
Suchfilter	Suchfilter, welcher für die Suche nach Dokumenten angewendet werden soll.	EcoSearchFilter	ja
Max. Ergebnisse	Ergebnisse auf die hier angegebene maximale Anzahl von Datensätzen begrenzen	long / Int64	nein

Ausgabe

Name	Beschreibung	Datentyp	Erforderlich
Dokument Liste	Liste von Dokument Beschreibungen, welche bei der Suche gefunden wurden.	List<EcoDocInfo>	ja

Beispiel zur Anwendung von Ergebnissen innerhalb einer ForEach Aktivität

Klassifizierung hinzufügen

Beschreibung

Diese Aktivität fügt eine neue Klassifizierung anhand einer Attribut-Liste (EcoDocAttributes) zu einem bestehenden und über eine Dokument Beschreibung (EcoDocInfo) adressierten Dokument hinzu, und gibt die Dokument Beschreibung (EcoDocInfo) der neuen Klassifizierung als Ergebnis zurück.

Eigenschaften

Eingabe

Name	Beschreibung	Datentyp	Erforderlich
Dokument Info	Dokument Beschreibung, welcher ein neuer Satz von Attributen zugewiesen werden soll.	EcoDocInfo	ja
Attribut-Liste	Liste von Attributen, welche der Dokument Beschreibung für das Anlegen einer neuen Klassifizierung hinzugefügt werden soll.	EcoDocAttributes	ja

Ausgabe

Name	Beschreibung	Datentyp	Erforderlich
Dokument Info	Dokument Beschreibung der neu angelegten Klassifizierung.	EcoDocInfo	ja

Lizenz Statistik für API Zugriffe ermitteln

Beschreibung

Diese Aktivität ermittelt die noch verbleibenden lizensierten ecoDMS API Zugriffe im aktuellen Zeitraum (siehe Vorbereitung und Konfiguration ) und gibt die Anzahl der verbleibenden API Zugriffe als Ergebnis zurück.

Eigenschaften

Ausgabe

Name	Beschreibung	Datentyp	Erforderlich
API Zugriffe	Variable, in welcher die ermittelte Anzahl der restlichen API Zugriffe für den aktuellen Zeitraum zurückgegeben wird.	Int64	ja

Stammdaten abrufen

Beschreibung

Diese Aktivität ermittelt die aktuellen Stammdaten aus dem ecoDMS System: Ordner, Typen, Attribute und Status. Mit dem zurückgegebenen Objekt vom Typ EcoConfigData können Namen und IDs von Stammdatenobjekten auch ohne vorherige Zuordnungen von WMS Variablen ermittelt werden.

Eigenschaften

Ausgabe

Name	Beschreibung	Datentyp	Erforderlich
Konfiguration	Objekt mit Informationen zu Stammdaten aus ecoDMS.	EcoConfigData	ja

Suchfilter hinzufügen

Beschreibung

Diese Aktivität erzeugt oder ergänzt einen Suchfilter für die Suche nach Dokumenten. Soll nach einer Kombination aus mehreren Attributen gesucht werden, kann zuerst ein Suchfilter erzeugt, und dieser über weitere Aufrufe der Aktivität ergänzt werden.

Neben den in den Stammdaten von ecoDMS festgelegten Attributen bietet das System auch noch ein weiteres Attribut für die Suche nach Inhalten aus dem Volltext eines Dokuments an. Dieses Attribut kann über die Attribut ID "fulltext" und den Operator "ilike" manuell angesteuert werden.

Neben den Attributen aus den Zuordnungen können Dokumente auch anhand der folgenden Standard-Klassifizierungsattribute der ecoDMS API gesucht werden: "mainfolder", "folder", "status", "docart", "bemerkung", "docid", "revision", "fulltext", "defdate", "cdate", "changeid", "ctimestamp".

Eigenschaften

Eingabe

Name	Beschreibung	Datentyp	Erforderlich
Attribut ID	ID des Attributs, nach welches dem Suchfilter hinzugefügt werden soll.	string	ja
Operator	Operator für den neuen Eintrag im Suchfilter. Gültige Werte für den Operator sind "=", "<>", "<", ">", "<=", ">=" und "ilike".	string	ja
Wert	Wert, nach welchem gesucht werden soll. Bei Anwendung des Operators "ilike" können auch unscharfe Suchen über die Wildcards "%" (mehrere beliebige Zeichen) und "_" (ein beliebiges Zeichen) durchgeführt werden.	string	ja

Ein-/Ausgabe

Name	Beschreibung	Datentyp	Erforderlich
Suchfilter	Dokument Beschreibung der neu angelegten Klassifizierung.	EcoDocInfo	ja
Überschreiben	Kennzeichen, ob der Suchfilter überschrieben, oder ein zusätzlicher Eintrag zu einem bestehenden Suchfilter hinzugefügt werden soll.	bool	nein