Open Source Dokumentenmanagement
Dokumentation

Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht

Navigation: Dokumentationen agorum core > agorum core JavaScript-API


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.

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);