JavaScript-Bibliothek agorum.dev/js/lib/workflow

Mithilfe dieser JavaScript-Bibliothek vereinfachen Sie diverse Zugriffe zur programmatischen Steuerung von Workflows.

Diese Bibliothek beinhaltet zusätzlich alle Funktionen aus der JavaScript-Bibliothek common/workflow und erweitert diese Bibliothek um die in dieser Dokumentation aufgeführten Funktionen.

Verwendung

Diese Bibliothek binden Sie stets am Anfang eines Skripts ein:

let workflow = require('/agorum/roi/customers/agorum.dev/js/lib/workflow');

// oder mit bestimmter session
let workflow = require('/agorum/roi/customers/agorum.dev/js/lib/workflow')(scUser);

Funktionen

acquire

Nimmt einen Workflow-Schritt an oder übernimmt diesen.

Syntax

acquire(token, force);

Parameter

Parameter	Beschreibung	Pflicht	Default-Wert
token	Definiert das Token-Objekt, das das System übernimmt.	ja	–
force	Erzwingt die Übernahme, wenn der Benutzer nicht direkt als Empfänger des Tokens eingetragen ist.	nein	false

Beispiel

let workflow = require('/agorum/roi/customers/agorum.dev/js/lib/workflow');

let token; // agorum core workflow-token Objekt
workflow.acquire(token);

Rückgabewerte

Zu dieser Funktion existieren keine Rückgabewerte.

Verwendung

Diese Funktion verwenden Sie, wenn Sie ein Workflow-Token durch einen Benutzer annehmen möchten. Dabei gilt die Session des Benutzers, mit der er die Workflow-Bibliothek initialisiert hat.

Exceptions

Das System wirft eine Exception, wenn die Übernahme nicht erlaubt ist (etwa, weil der Benutzer den Schritt nicht übernehmen darf).

release

Gibt einen Workflow-Schritt ab.

Syntax

release(token);

Parameter

Parameter	Beschreibung	Pflicht	Default-Wert
token	Definiert das Token-Objekt, das das System abgibt.	ja	–

Beispiel

let workflow = require('/agorum/roi/customers/agorum.dev/js/lib/workflow');

let token; // agorum core workflow-token Objekt
workflow.release(token);

Rückgabewerte

Zu dieser Funktion existieren keine Rückgabewerte.

Verwendung

Diese Funktion verwenden Sie, wenn Sie ein Workflow-Token abgeben möchten.

Exceptions

Das System wirft eine Exception, wenn die Abgabe nicht möglich ist.

save

Speichert die übergebenen Workflow-Variablen in den Workflow.

Syntax

save(token, variables);

Parameter

Parameter	Beschreibung	Pflicht	Default-Wert
token	Definiert das Token-Objekt, das das System abgibt.	ja	–
variables	Die Variablen, die gespeichert werden sollen.	ja	–

Beispiel

let workflow = require('/agorum/roi/customers/agorum.dev/js/lib/workflow');
let { patch } = require('/agorum/roi/customers/agorum.dev/js/lib/delta');

let token; // agorum core workflow-token Objekt

// Mit der Funktion "patch" mischt das System die übergebenen Variablen mit den existierenden Variablen.
workflow.save(token, patch(workflow.get(token), {
  structureTaskComment: 'bearbeitet von roi'
}));

Rückgabewerte

Zu dieser Funktion existieren keine Rückgabewerte.

Verwendung

Diese Funktion verwenden Sie, wenn Sie ein Workflow-Token speichern möchten.

Diese Funktion verwenden Sie in der Regel mit der Funktion patch und den vorhandenen Workflow-Variablen, wie im Beispiel dargestellt.

Exceptions

Das System wirft eine Exception, wenn das Speichern nicht möglich ist (etwa, weil das Token nicht angenommen ist).

leave

Verlässt das angegebene Token über das angegebene Outlet und speichert die dazugehörigen Variablen.

Syntax

leave(token, outlet, variables);

Parameter

Parameter	Beschreibung	Pflicht	Default-Wert
token	Definiert das Token-Objekt, das das System abgibt.	ja	–
outlet	Definiert den Namen des Outlets, über den das System das Token verlässt.	ja	–
variables	Definiert die Variablen, die das System speichert.	ja	–

Beispiel

let workflow = require('/agorum/roi/customers/agorum.dev/js/lib/workflow');
let { patch } = require('/agorum/roi/customers/agorum.dev/js/lib/delta');

let token; // Workflow-Token-Objekt in agorum core 

// Mit der Funktion "patch" mischen Sie die übergebenen Variablen mit den existierenden Variablen.
workflow.leave(token, 'ok', patch(workflow.get(token), {
  structureTaskComment: 'bearbeitet von roi'
}));

Rückgabewerte

Zu dieser Funktion existieren keine Rückgabewerte.

Verwendung

Diese Funktion verwenden Sie, wenn Sie ein Workflow-Token verlassen möchten.

Sie verwenden diese Funktion in der Regel mit der Funktion patch und den vorhandenen Workflow-Variablen, wie im Beispiel dargestellt.
Diese Funktion entspricht etwa dem, was passiert, wenn ein Benutzer ein Workflow-UI über eine bestimmte Schaltfläche mit bestimmen Werten in der Bedienoberfläche verlässt.

Exceptions

Das System wirft eine Exception, wenn das Verlassen nicht möglich ist (etwa, weil das Token nicht angenommen ist).