Task Management

Dieser Adapter ermöglicht den schnittstellenbasierten Zugriff auf Human Tasks in Business Processes mittels Technical Processes. Er bildet eine Schnittstelle, die modellierte Aufgaben und menschliche Interaktion auf Prozessebene verfügbar macht. Dies ermöglicht die Anbindung von kundenspezifischen Web Apps an Vorgänge, die mit BPMN modelliert werden oder auch die direkte Anbindung beliebiger Drittsysteme an die zentrale Vorgangssteuerung der X4 BPMS.

Für den Zugriff mit dem Adapter wird der angemeldete Benutzer in X4 Web Apps verwendet.

Eigenschaften

Operation

Bestimmt, welche Operation der Adapter durchführt

Mögliche Werte:

GetAllTasks: Alle Tasks für den angemeldeten Benutzer oder die Gruppe zurückgeben
GetTask: Einen Task für den angemeldeten Benutzer zurückgeben
EditTask: Die Aufgaben für andere Benutzer sperren und die Merkmale aktualisieren
CloseTask: Die Aufgabe mit einem Fachstatus abschließen und den Vorgang fortsetzen
DeclineTask: Die Aufgabe ablehnen und an den Eigentümer zurückgeben
ForwardTask: Die Aufgabe an eine Person oder Gruppe weitergeben
CancelTask: Die Bearbeitung der Aufgabe abbrechen und sie für andere Benutzer freigeben
ResubmitTask: Aufgabe auf Wiedervorlage setzen

Parameter

`Adapter`	Hauptklasse des Adapters (nicht verändern!) Mögliche Werte: de.softproject.x4.server.bpm.casemanagement.adapter.TaskManagement: Hauptklasse (Standard)
`limit`	Seitengröße für den Abruf der Task-Liste Der Wert ist optional. Ist der Parameter nicht gesetzt, werden alle Tasks ausgegeben. Mögliche Werte: Beliebige Zahl `> 0`
`offset`	Offset für den Abruf der Task-Liste Der Wert ist optional. Ist der Parameter nicht gesetzt, werden alle Tasks ausgegeben. Mögliche Werte: Beliebige Zahl `> 0`
`state`	Erforderlich. Zustandsfilter für den Abruf der Task-Liste Mögliche Werte: `OPEN`: Offene Tasks `IN_PROGRESS`: Task in Bearbeitung `CLOSED`: Geschlossene Tasks
`taskUuid`	UUID des Tasks Mögliche Werte: Gültige UUID, z. B. `443c498a-5868-4110-891f-42e5cb8fc24e`
`userForDebugging`	Benutzer der zum Debugging verwendet werden soll, wenn keine Anmeldung in X4 Web Apps vorhanden ist Mögliche Werte: Gültiges Benutzer-Login, z.B. `admin`
`dataformatVersion`	Version des verwendeten Datenformats Mögliche Werte: `1.0`: Verwendetes Datenformat bis Version 7.0 `2.0`: Verwendetes Datenformat ab Version 7.0, siehe Input-Beispiele

Statuswerte

`1`	Die Operation wurde erfolgreich ausgeführt.
`-1`	Die Operation konnte nicht ausgeführt werden.

Die Dokumentation der ReST-Schnittstelle finden Sie unter http://localhost:8080/X4/X4Api/.

Input

Bei folgenden Operationen wird kein Input benötigt:

GetAllTasks
GetTask
CancelTask

Folgende Operationen benötigen als Input ein XML-Dokument mit folgender Struktur:

Operation EditTask

XML

<?xml version="1.0" encoding="UTF-8"?>
<EditTask>
	<Offer> 150 Mio. €</Offer>
</EditTask>

Operation CloseTask

XML

<?xml version="1.0" encoding="UTF-8"?>
<CloseTask>
    <MarketValue>120 Mio. €</MarketValue>
    <Action>Declined</Action>
</CloseTask>

Operation DeclineTask

XML

<?xml version="1.0" encoding="UTF-8"?>
<DeclineTask>
	<Comment>string</Comment>
</DeclineTask>

Operation ForwardTask

XML

<?xml version="1.0" encoding="UTF-8"?>
<ForwardTask>
	<Comment>string</Comment>
	<Deadline>2019-04-15T11:46:02.782Z</Deadline>
	<!-- The "type" attribute must contain either USER or GROUP. -->
	<Assignment type="USER|GROUP">string</Assignment>
</ForwardTask>

Output

Bei der Operation CancelTask wird als Output das Input-Dokument ausgegeben.

Folgende Operationen geben als Output ein XML-Dokument mit folgender Struktur aus:

Operation GetAllTasks

XML

<?xml version="1.0" encoding="UTF-8"?>
<Tasks>
    <Task created="2020-12-21T09:10:53Z" creator="System" id="81f4abb5-c2f5-418e-acf5-654304234bf4">
        <Title>humantask</Title>
        <Owner>admin</Owner>
        <Assignment type="USER">admin</Assignment>
        <State>OPEN</State>
        <KeyIdentifier/>
        <CaseId>00860a8a-12b9-45b8-b271-ec5d42573c59</CaseId>
    </Task>
</Tasks>

Operationen GetTask, EditTask, CloseTask, DeclineTask und ForwardTask

XML

<?xml version="1.0" encoding="UTF-8"?>
<Task created="2020-12-21T09:10:53Z" creator="System"
      id="81f4abb5-c2f5-418e-acf5-654304234bf4">
    <Title>humantask</Title>
    <Owner>admin</Owner>
    <Assignment type="USER">admin</Assignment>
    <State>OPEN</State>
    <KeyIdentifier/>
    <CaseId>00860a8a-12b9-45b8-b271-ec5d42573c59</CaseId>
    <Actions>
        <Action displayName="done" name="Accepted"/>
        <Action displayName="Declined" name="Declined"/>
    </Actions>
    <DecliningAllowed>false</DecliningAllowed>
    <ForwardingAllowed>false</ForwardingAllowed>
    <Comments/>
    <BusinessData>
        <Company>Max Mustermann Inc.</Lastname>
        <MarketValue>100 Mio. €</MarketValue>
        <Offer>150 Mio. €</Offer>
    </BusinessData>
</Task>