@atlas-engine-contrib/atlas-ui_sdk v2.1.0-feature-a296ff-kvccnloj

AltasUI SDK

Beinhaltet Komponenten für die Entwicklung von Erweiterungen für die AtlasUI.

Was sind die Ziele dieses Projekts?

Dieses Projekt unterstützt bei der Entwicklung von:

• StartDialogues
• CustomForms

Relevante URLs

Das SDK benutzt die Contracts aus:

• AtlasUI Contracts

Das SDK wird in den von uns bereitgestellten CustomForm Templates verwendet:

• AtlasUI CustomForm Templates

Wie kann ich das Projekt aufsetzen?

npm install @atlas-engine-contrib/atlas-ui_sdk

Wie kann ich das Projekt benutzen?

CustomFormService

Der CustomFormService stellt Methoden für die Verarbeitung von BPMN UserTasks bereit. Diese bilden die Grundlage für die Entwicklung von CustomForms.

Instanziieren des Services

import {CustomFormService} from '@atlas-engine-contrib/atlas-ui_sdk';

let customFormService = new CustomFormService();

onUserTaskReceived

Über onUserTaskReceived können Subscriptions für das Empfangen von UserTask Notifications erstellt werden.

Die Methode erwartet einen Callback als Parameter, der dem Typen TaskReceivedCallback entspricht.

Der Callback wird jedesmal ausgelöst, wenn ein neuer UserTask zur Verarbeitung verfügbar ist und ist daher die primäre Schnittstelle für das Anzeigen von CustomForms.

customFormService.onUserTaskReceived((userTask: DataModels.UserTasks.UserTask, identity: IIdentity, state: CustomFromState | null): void => {
  // display custom form
});

removeOnUserTaskReceived

Entfernt einen zuvor über übergebenen Callback aus der Liste von Callbacks, die beim Empfangen von neuen UserTasks getriggert werden sollen.

Der hier übergebene Callback muss vom Typen TaskReceivedCallback sein.

customFormService.removeOnUserTaskChanged(callbackToRemove);

Finish UserTask

Ein UserTask kann über die folgende Schnittstelle beendet werden.

customFormService.finishUserTask(userTaskResult);

userTaskResult entspricht dabei den Eingaben, die der Benutzer für diesen UserTask getätigt hat. Das übergebene UserTaskResult muss ein gültiges JSON sein.

Siehe AtlasEngine UserTaskResult.

Abbrechen

Bricht den UserTask ab.

Achtung: Dieser Vorgang terminiert die gesamte dahinterliegende Prozessinstanz!

customFormService.abortUserTask();

Suspend

Speichern des aktuellen Stands des UserTasks zur späteren Weiterverarbeitung:

customFormService.suspend(customFormState);

Sofern für einen neuen UserTask ein customFormState vorhanden ist, wird dieser in dem Callback der onUserTaskReceived Notification mit übergeben.

Für eine detaliertere Beschreibung für die Benutzerinteraktion mit UserTasks, siehe User Interaction Component.

CustomFormsServerSideService

Dieser Service ist abgeleitet von CustomFormsService und dient zur serverseitigen Verarbeitung von UserTasks.

Instanziieren des Services

import {CustomFormsServerSideService} from '@atlas-engine-contrib/atlas-ui_sdk';

let customFormServerSideService = new CustomFormServerSideService();

Neben den in CustomFormService beschriebenen Funktionen, stellt dieser Service ebenfalls folgende Methoden bereit:

convertToCustomForms

Konvertiert die bereitgestellten Benutzereingaben für einen UserTask in das von der AtlasEngine erwartete Format und führt die gewünschte Aktion (Finish/Suspend/Abort) aus.

customFormServerSideService.convertToCustomForms();

StartDialogService

Dieser Service dient zur Interaktion mit Dialogen, die zum Starten von Prozessinstanzen verwendet werden.

Instanziieren des Services

import {StartDialogService} from '@atlas-engine-contrib/atlas-ui_sdk';

let startDialogService = new StartDialogService();

onStartDialogDisplayed

Lässt den übergebenen Callback ausführen, sobald der Dialog angezeigt wird.

startDialogService.onStartDialogDisplayed(myFancyCallback);

Der übergebene Callback muss dem Typen StartDialogDisplayedCallback entsprechen.

removeOnStartDialogDisplayed

Entfernt einen zuvor per onStartDialogDisplayed hinzugefügten Callback.

startDialogService.removeOnStartDialogDisplayed(myFancyCallback);

startProcess

Startet eine neue Prozessinstanz für das Prozessmodell mit der übergebenen ID.

startDialogService.startProcess('MyProcessModelId', {my: 'payload'});

closeStartDialog

Schließt den Dialog.

startDialogService.closeStartDialog();

destroy

Zerstört den Dialog.

startDialogService.destroy();

Wen kann ich auf das Projekt ansprechen?

• Christian Werner
• René Föhring
• Robin Lenz
• Paul Heidenreich
• Tim Hoffmann