ScriptAPI (ArcFlow.Next) - Versionsgeschichte

Jens: Stand 4.1.09

2024-10-28T16:06:33Z

Stand 4.1.09

← Nächstältere Version		Version vom 28. Oktober 2024, 16:06 Uhr
Zeile 37:		Zeile 37:

	* code - Fehlerwert der Anweisung		* code - Fehlerwert der Anweisung
	* returnValues		* returnValues - Rückgabewert oder -werte der Funktion
	* webcode		* webcode - Fehlertext

	Eine Ausgabe von Fehlermeldungen ist mit der JavaScript-Anweisung "alert" möglich. Der Inhalt von "returnValues" ist abhängig von dem aufgerufenen Befehl und wird bei der entsprechenden Anweisung beschrieben.		Eine Ausgabe von Fehlermeldungen ist mit der JavaScript-Anweisung "alert" möglich. Der Inhalt von "returnValues" ist abhängig von dem aufgerufenen Befehl und wird bei der entsprechenden Anweisung beschrieben.
Zeile 46:		Zeile 46:
	Um auf das im Arbeitsmappenbaum ausgewählter Objekt zugreifen zu können, steht das Objekt "treeNode" zur Verfügung. Auf folgende Eigenschaften und Methoden des Objekts kann zugegriffen werden:		Um auf das im Arbeitsmappenbaum ausgewählter Objekt zugreifen zu können, steht das Objekt "treeNode" zur Verfügung. Auf folgende Eigenschaften und Methoden des Objekts kann zugegriffen werden:

	* afDocumentPath		* afDocumentPath - ?
	* check_Child_State		* check_Child_State - ?
	* check_Fokus		* check_Fokus
	* checked		* checked
Zeile 54:		Zeile 54:
	* editNameFlag		* editNameFlag
	* getCheckStatus()		* getCheckStatus()
	* getIndex()		* getIndex() - Position des Objekts im übergeordneten Objekt (Startet bei 0).
	* getNextNode()		* getNextNode()
	* getParentNode()		* getParentNode()
	* getPath()		* getPath() - Liste mit Objekten auf dem Pfad zur Root-Mappe.
	* getPreNode()		* getPreNode()
	* halfCheck		* halfCheck
	* iconSkin		* iconSkin - Symbol der Arbeitsmappe, wird noch geändert.
	* id - Id der Arbeitsmappe (10149), Archivnummer (840000012) oder Archivnummer und Anhangdateinummer (840000012_0001)		* id - Id der Arbeitsmappe (10149), Archivnummer (840000012) oder Archivnummer und Anhangdateinummer (840000012_0001)
	* isAjaxing		* isAjaxing
Zeile 67:		Zeile 67:
	* isLastNode		* isLastNode
	* isParent		* isParent
	* level		* level - Arbeitsmappenebene, kommt raus
	* mimeType - "EML", "PDF", ...		* mimeType - "EML", "PDF", ...
	* name - Name der Arbeitsmappe, des Archivs oder der Anhangdatei		* name - Name der Arbeitsmappe, des Archivs oder der Anhangdatei
Zeile 76:		Zeile 76:
	* toolTip		* toolTip
	* type - "workfolder", "archive" oder "attachment"		* type - "workfolder", "archive" oder "attachment"
	* zAsync

Jens am 18. Oktober 2024 um 15:00 Uhr

2024-10-18T15:00:31Z

← Nächstältere Version		Version vom 18. Oktober 2024, 15:00 Uhr
Zeile 7:		Zeile 7:
	== Erstellen von Skripten ==		== Erstellen von Skripten ==

	Um ein neues Skript zu erstellen, wird das Skript zunächst unter [[Erweitert - Skripte (ArcFlow.~~NEXT~~)\|"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.		Um ein neues Skript zu erstellen, wird das Skript zunächst unter [[Erweitert - Skripte (ArcFlow.Next)\|"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.

	Beispiele:		Beispiele:
Zeile 26:		Zeile 26:
	</pre>		</pre>

	Das geschriebene Skript wird gespeichert. Um es aufzurufen wird noch eine Stelle benötigt, wo es aufgerufen werden kann. Das erfolgt unter [[Erweitert - Addons (ArcFlow.~~NEXT~~)\|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.		Das geschriebene Skript wird gespeichert. Um es aufzurufen wird noch eine Stelle benötigt, wo es aufgerufen werden kann. Das erfolgt unter [[Erweitert - Addons (ArcFlow.Next)\|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 ==		== Zugriff auf die Befehle der Schnittstelle ==

Jens am 15. Oktober 2024 um 09:03 Uhr

2024-10-15T09:03:37Z

← Nächstältere Version		Version vom 15. Oktober 2024, 09:03 Uhr
Zeile 9:		Zeile 9:
	Um ein neues Skript zu erstellen, wird das Skript zunächst unter [[Erweitert - Skripte (ArcFlow.NEXT)\|"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.		Um ein neues Skript zu erstellen, wird das Skript zunächst unter [[Erweitert - Skripte (ArcFlow.NEXT)\|"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~~:		Beispiele:

	<pre class=source>		<pre class=source>
Zeile 15:		Zeile 15:
	alert(result.code);		alert(result.code);
	});		});
			</pre>

			oder

			<pre class="source">
			(async function main(){
			var result = await af.next.AfAbmLstGet(treeNode.id);
			alert(result.code);
			})();
	</pre>		</pre>

Zeile 21:		Zeile 30:
	== Zugriff auf die Befehle der Schnittstelle ==		== 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.		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. Innerhalb dieses Objekts befinden sich auch die Konstanten der Schnittstelle. Sie können über "af.next.constant.<Konstante>" angegeben werden (zum Beispiel "af.next.constant.AfErrOk").

			== Auswertung des Rückgabewertes ==

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

	* code - Fehlerwert der Anweisung		* code - Fehlerwert der Anweisung
			* returnValues
			* webcode

			Eine Ausgabe von Fehlermeldungen ist mit der JavaScript-Anweisung "alert" möglich. Der Inhalt von "returnValues" ist abhängig von dem aufgerufenen Befehl und wird bei der entsprechenden Anweisung beschrieben.

	== Zugriff auf die Umgebung von ArcFlow.NEXT ==		== Zugriff auf die Umgebung von ArcFlow.NEXT ==

			Um auf das im Arbeitsmappenbaum ausgewählter Objekt zugreifen zu können, steht das Objekt "treeNode" zur Verfügung. Auf folgende Eigenschaften und Methoden des Objekts kann zugegriffen werden:

			* afDocumentPath
	~~Zur Verfügung stehende Umgebung~~		* check_Child_State
	~~Objekt "af"~~		* check_Fokus
	~~af.next.<Befehl>~~(~~<Parameter>~~)		* checked
	~~af.next.constant.AFErrOk~~		* checkedOld
	~~Zugriff auf die Umgebung~~		* chkDisabled
	~~treeNode = ausgewähltes Objekt im Arbeitsmappenbaum~~		* editNameFlag
	~~treeNode.~~id = Id ~~des Objekts~~ (~~Arbeitsmappe~~ oder Archivnummer)		* getCheckStatus()
	~~treeNode.type = "workfolder" im Falle einer Arbeitsmappe~~		* getIndex()
	~~af.user Benutzer~~		* getNextNode()
			* getParentNode()
	~~Ausgabe mit alert()~~		* getPath()
			* getPreNode()
	~~Programmierung in einer Umgebung in der Anweisungen parallel ausgeführt werden~~		* halfCheck
	~~Verwendung von~~ .~~then~~, ~~await, async~~		* iconSkin
			* id - Id der Arbeitsmappe (10149), Archivnummer (840000012) oder Archivnummer und Anhangdateinummer (840000012_0001)
	~~Rückgabewert von Anweisungen~~		* isAjaxing
	~~result.code = Rückgabewert der Funktion~~		* isFirstNode
	~~result.returnValues.abmList[0].afAbmId bei der Rückgabe einer Liste von Arbeitsmappen~~		* isHover
			* isLastNode
			* isParent
			* level
			* mimeType - "EML", "PDF", ...
			* name - Name der Arbeitsmappe, des Archivs oder der Anhangdatei
			* noCheck
			* open
			* parenTId
			* tId
			* toolTip
			* type - "workfolder", "archive" oder "attachment"
			* zAsync

Jens am 14. Oktober 2024 um 09:50 Uhr

2024-10-14T09:50:47Z

← Nächstältere Version		Version vom 14. Oktober 2024, 09:50 Uhr
Zeile 7:		Zeile 7:
	== Erstellen von Skripten ==		== Erstellen von Skripten ==

	Um ein neues Skript zu erstellen, wird das Skript zunächst unter [[Erweitert - Skripte (ArcFlow.NEXT)\|"Einstellungen / Erweitert / Skripte"]] angelegt. 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.		Um ein neues Skript zu erstellen, wird das Skript zunächst unter [[Erweitert - Skripte (ArcFlow.NEXT)\|"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:		Beispiel:
Zeile 17:		Zeile 17:
	</pre>		</pre>

	~~Vorgehen beim Schreiben eigener Skripte~~		Das geschriebene Skript wird gespeichert. Um es aufzurufen wird noch eine Stelle benötigt, wo es aufgerufen werden kann. Das erfolgt unter [[Erweitert - Addons (ArcFlow.NEXT)\|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		Zur Verfügung stehende Umgebung

Jens am 10. Oktober 2024 um 15:03 Uhr

2024-10-10T15:03:37Z

← Nächstältere Version		Version vom 10. Oktober 2024, 15:03 Uhr
Zeile 4:		Zeile 4:

	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 [[File:Menubar_addon.png\|x24px]] 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.		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 [[File:Menubar_addon.png\|x24px]] 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 [[Erweitert - Skripte (ArcFlow.NEXT)\|"Einstellungen / Erweitert / Skripte"]] angelegt. 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:

			<pre class=source>
			af.next.AfAbmLstGet(treeNode.id).then(result => {
			alert(result.code);
			});
			</pre>

	Vorgehen beim Schreiben eigener Skripte		Vorgehen beim Schreiben eigener Skripte

Jens: Steht in der freigegebenen Version noch nicht zur Verfügung.

2024-10-09T15:05:01Z

Steht in der freigegebenen Version noch nicht zur Verfügung.

← Nächstältere Version		Version vom 9. Oktober 2024, 15:05 Uhr
Zeile 3:		Zeile 3:
	{{Construction}}		{{Construction}}

	Funktionen, die häufiger gebraucht werden, können in ArcFlow.Next in der ScriptAPI mit der Programmiersprache JavaScript geschrieben werden. Das Skript kann ~~dann~~ über die Schaltfläche		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 [[File:Menubar_addon.png\|x24px]] 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.

			Vorgehen beim Schreiben eigener Skripte

			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

Jens: Stand 4.1.09 Erstellen von Skripten in ArcFlow.Next

2024-10-08T15:08:20Z

Stand 4.1.09 Erstellen von Skripten in ArcFlow.Next

Neue Seite

{{PageHeaderAdmin|ScriptAPI|Grundlegende Beschreibung zur Erstellung von Skripten}}

{{Construction}}

Funktionen, die häufiger gebraucht werden, können in ArcFlow.Next in der ScriptAPI mit der Programmiersprache JavaScript geschrieben werden. Das Skript kann dann über die Schaltfläche