Open Source Dokumentenmanagement
Dokumentation

Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht

Navigation: Dokumentationen agorum core > agorum core JavaScript-API

Erste Zeile eines JavaScripts

Um Skripte in agorum core korrekt auszuführen, benötigt das System bestimmte globale Parameter. Diese tragen Sie in die erste Zeile des Skripts ein:

/* global sc, sca, object, data */

Globale Parameter

Parameter Beschreibung
sc Definiert die Session, mit der der Benutzer mit agorum core verbunden ist.
sca Definiert die Session zur Nutzung als Administrator.

agorum core smart assistant konfigurator

Hinweis: Fokussieren Sie sich auf objects und benutzen Sie folder nicht mehr. Um auf einen folder zugreifen zu können, müssen Sie die Aktion auf der Baumstruktur im agorum core explorer ausführen. Andernfalls findet das System den folder nicht.

Element „Anlage“


JavaScript (Initialisierung)

/* global sc, sca, folder, objects */


JavaScript (zuvor) und JavaScript (danach)

/* global sc, sca, folder, data */
Parameter Beschreibung
folder Definiert das Ordner-Objekt des Ordners, auf dem ein Benutzer im agorum core explorer gerade positioniert ist.

Hat ein Benutzer im Feld Zielordner ein Ordner eingegeben, ist folder dieser Zielordner.
objects Definiert ein Objects-Array der Objekte, die im agorum core explorer zum Zeitpunkt der Ausführung markiert sind.
data Definiert ein Objekt, das die Eingabewerte enthält.

Element „Ablage“


JavaScript (Initialisierung)

/* global sc, sca, folder, objects */


JavaScript (zuvor) und JavaScript (danach)

/* global sc, sca, folder, objects, data */

Element „Suche“


JavaScript

/* global sc, sca, data */

Element „Server Aktion“


JavaScript (Initialisierung)

/* global sc, sca, folder, objects */


JavaScript

/* global sc, sca, folder, objects, data */

Element „Client Aktion“


JavaScript (Initialisierung)

/* global sc, sca, folder, objects */


JavaScript

/* global folderId, ids */
Parameter Beschreibung
folderId Definiert die ID des Ordners, der bei Aufruf der Aktion aktuell ist (als String).
ids Enthält alle IDs als String-Array, die markiert waren, als die Aktion ausgeführt wurde.

CronJobs

Falls Sie ein JavaScript über einen CronJob starten möchten, muss innerhalb der ersten Zeile des Skripts Folgendes vorhanden sein:

/* global object */

Workflows

Die folgende erste Zeile muss bei einem Skript vorhanden sein, das von einem Workflow verwendet wird:

/* global sc, sca, instance, token, outlets, parameters: true */
Parameter Beschreibung
instance Gilt global für alle Knoten, Verwendung etwa in instance.variables.

Das System legt alle Variablen ab, die global zur Verfügung stehen.
token Definiert den aktuellen Knoten, Verwendung etwa in token.variables.

Enthält Variablen, die nur für den Token gelten.
outlets Enthält die Keys der Transitions, Verwendung etwa beim Knoten fork.
parameters Enthält die Werte, die Sie mit parameters übergeben.

API

Die folgende erste Zeile muss bei einem Skript vorhanden sein, das von der JS-/Rest-API verwendet wird:

/* global sc, sca, Packages, request */
Parameter Beschreibung
request Enthält Werte, die von außen / extern an das Skript mitgegeben werden.

Beispiel
Ein externes System ruft ein Skript in agorum core per API auf. Dieses externe System gibt Parameter mit, die das System unter request sammelt.

Aktive Ordner

Die folgende erste Zeile muss bei einem Skript vorhanden sein, das von einem Aktiven Ordner verwendet wird:

/* global folder, parameters */
Parameter Beschreibung
folder Definiert den Aktiven Ordner, den das Skript verwendet.
parameters Enthält Parameter, die Sie übergeben.

Fileworkflow

Die folgende erste Zeile muss bei einem JavaScript vorhanden sein, das vom Fileworkflow verwendet wird:

/* global sc, folder, object, parameters */
Parameter Beschreibung
sc Admin SessionController, fileworkflow läuft immer als Administrator.
folder Optional, es kann beim Fileworkflow Aufruf ein Startordner definiert werden.
object Objekt, mit dem der Fileworkflow durchläuft.
parameters Parameter, die im Fileworkflow in der Bedienoberfläche bei Parametern definiert werden.

ContentTask

Die folgende erste Zeile muss bei einem JavaScript vorhanden sein, das vom Aktiven Ordner verwendet wird:

/* global Packages, sc, object */
Parameter Beschreibung
object Enthält das Dokument, dessen Inhalt sich geändert hat, und wird dem Skript übergeben.

Best-Practice-Tipps

new error

throw new error ('...')

Wenn Skripte in agorum core Fehler werfen, verwenden Sie new Error, um für die Fehlersuche den Stacktrace zur Verfügung zu haben.