JavaScript-Bibliothek common/workflows

Diese Bibliothek bietet Funktionen, um Workflows zu starten oder zu beenden.

Hinweis: Diese Bibliothek gehört zum agorum core workflow 2.0.

Verwendung

let workflows = require('common/workflows');

Funktionen

start

Startet einen Workflow.

workflows.start('Name-des-Workflows', attachments, 'Name der Instanz', parameters);

Beispiel

let objects = require('common/objects');
let workflows = require('common/workflows');

let parameters = {
  hidden_parameterForWorkflow: 'test'
};

let attachment = objects.find('id-of-attachment');
let workflowInstance = workflows.start('TestWorkflow', [ attachment ], 'Mein erster Workflow', parameters);

Um einen FileWorkflow direkt zu starten, geben Sie als Workflow-Name FileWorkflow2 an und als Instanz-Name den Namen der Bedingung.

Hinweis: Rückgabewert bei FileWorkflow2

Beim Aufruf mit dem Workflow-Namen FileWorkflow2 (Aufruf des fileworkflow) wird ab agorum core 11.14.0 kein workflowInstance-Objekt zurückgegeben. Der fileworkflow läuft synchron im aktuellen Aufruf ab, ohne dass eine JBPM-Workflow-Instanz erzeugt wird. Die Funktionen workflows.cancel() und workflows.get() sind daher nicht auf einen FileWorkflow-Aufruf anwendbar.

Die zugehörigen Protokolle finden Sie im agorum core support tool unter Workflow.

cancel

Beendet einen laufenden Workflow.

workflows.cancel(workflowInstance);

Beispiel

let objects = require('common/objects');
let workflows = require('common/workflows');

let workflowInstance = objects.find('id-of-running-workflow');

workflows.cancel(workflowInstance);

get

Liefert Variablen, Anhänge und Variablenänderungen innerhalb eines Workflow-Schritts (Activity) zurück.

workflows.get(workflowActivity);

Beispiel

let objects = require('common/objects');
let workflows = require('common/workflows');

let workflowActivity = objects.find('id-of-running-workflow-activity');

workflows.get(workflowActivity);