ScriptAPI (ArcFlow.Next)

ScriptAPI
Grundlegende Beschreibung zur Erstellung von Skripten

Diese Seite wird zur Zeit bearbeitet. Der Inhalt kann falsch oder zumindest wahnsinnig ungenau sein. Wir sind dabei das zu beheben.

Funktionen, die häufiger gebraucht werden, können in ArcFlow.Next in der ScriptAPI mit der Programmiersprache JavaScript geschrieben werden. Das Skript wird einem Bereich zugewiesen und kann in dem Bereich aufgerufen werden. Die Addons werden über die Schaltfläche angezeigt und können dort auch aufgerufen werden. Die Zuweisung des Skripts zum Bereich wird unter "Einstellungen / Erweitert / Addons" definiert. Das Skript selbst kann unter "Einstellungen / Erweitert / Skripte" geschrieben werden. Die Einstellungen werden nur bei Benutzern angezeigt, die der Benutzergruppe "Administratoren" angehören.

Erstellen von Skripten

Um ein neues Skript zu erstellen, wird das Skript zunächst unter "Einstellungen / Erweitert / Skripte" angelegt. Die angegebene Bezeichnung wird später beim Aufrufen des Skripts benötigt. Innerhalb des Skripts stehen die Objekte "af" und "treeNode" zur Verfügung, die Zugriff auf die Befehle und Konstanten der Schnittstelle und des Baums auf der linken Seite der Applikation ermöglichen. Die meisten Befehle der Schnittstelle liefern ein Resultat zurück, mit dem der Erfolg des Befehls überprüft werden kann. Je nach Befehl enthält das zurückgegebene Objekt auch das Ergebnis des Befehls. Die Anweisungen des Skripts werden asynchron ausgeführt, wir verwenden daher in dem Beispiel das "then"-Konstrukt.

Beispiel:

af.next.AfAbmLstGet(treeNode.id).then(result => {
    alert(result.code);
});

Das geschriebene Skript wird gespeichert. Um es aufzurufen wird noch eine Stelle benötigt, wo es aufgerufen werden kann. Das erfolgt unter Einstellungen / Erweitert / Addons. Dort wird der Bereich ausgewählt, in dem das Skript aufgerufen werden kann und die Bezeichnung des Skripts angegeben. Anschließend steht der Aufruf im Bereich "Addons" zur Verfügung.

Zugriff auf die Befehle der Schnittstelle

Um Anweisungen der Schnittstelle aufzurufen, steht das Objekt "af.next" zur Verfügung. Es können alle Befehle der Schnittstelle mit "af.next.<Befehl>(<Parameter>)" aufgerufen werden. Welche Befehle zur Verfügung stehen kann der Beschreibung des Befehls entnommen werden.

Alle Befehle geben ein Ergebnis in Form eines Objektes zurück. Folgende Eigenschaften können immer abgefragt werden:

• code - Fehlerwert der Anweisung

Zugriff auf die Umgebung von ArcFlow.NEXT

Zur Verfügung stehende Umgebung Objekt "af" af.next.<Befehl>(<Parameter>) af.next.constant.AFErrOk Zugriff auf die Umgebung treeNode = ausgewähltes Objekt im Arbeitsmappenbaum treeNode.id = Id des Objekts (Arbeitsmappe oder Archivnummer) treeNode.type = "workfolder" im Falle einer Arbeitsmappe af.user Benutzer

Ausgabe mit alert()

Programmierung in einer Umgebung in der Anweisungen parallel ausgeführt werden Verwendung von .then, await, async

Rückgabewert von Anweisungen result.code = Rückgabewert der Funktion result.returnValues.abmList[0].afAbmId bei der Rückgabe einer Liste von Arbeitsmappen