Case Management | X4Documentation

Diese Adapter bildet die Schnittstelle zur „Case Management“-Funktionalität der Produktkomponente X4 BPM. Der Adapter ermöglicht beispielsweise das Setzen und Auslesen von Vorgangsdaten wie Fachstatus oder Merkmalen des Fachdatenmodells.

Eigenschaften (Properties)

Operation

Vom Adapter ausgeführte Operation

Mögliche Werte:

SetFeature: Schreibt ein Feature
SetFeatures: Schreibt mehrere Features in einem Vorgang
GetFeatures: Gibt alle Features des Vorgangs zurück
SetState: Setzt den Status des Vorgangs
GetStates: Gibt alle möglichen Status des Vorgangs zurück
GetComments: Gibt alle Kommentare des Vorgangs zurück
GetInformation: Gibt alle Informationen des Vorgangs zurück

Parameter

`CaseId`	ID des zu verarbeitenden Vorgangs Mögliche Werte: Beliebige gültige Benutzer-ID `%CASE_ID%`: Aktuelle Case-ID (Standard)
`CaseProcess`	Repository-Pfad zu einem Business Process, in dem der entsprechende Vorgang definiert ist. Mögliche Werte: Beliebiger kompletter Repository-Pfad, z. B. `Project/Folder/Process.bpm` Beliebiger gültiger Platzhalter, z. B. `%START_PROCESS%` `%START_PROCESS%`: Aufrufender Business Process (Standard)
`CaseUserId`	Benutzer-ID des Besitzers eines Vorgangs Mögliche Werte: Beliebige gültige Benutzer-ID `%USER_ID%`: Aktuelle Benutzer-ID (Standard)
`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.
`0`	Die Operation wurde durchgeführt, es wurde aber kein Ergebnis gefunden oder keine Daten geändert.
`-1`	Die Operation konnte nicht ausgeführt werden.

Input

Der Adapter erwartet eine vordefinierte XML-Struktur als Input. Die Struktur ist abhängig von der verwendeten Operation.

Wird bei setFeature / setFeatures das Attribut "type" nicht angegeben, ist der Datentyp "String". Die anderen möglichen Datentypen der "Case Management"-Funktionalität entsprechen denen der dortigen Typen.

SetFeature-Operation:

Erwartete Struktur für die Operation SetFeature
XML
```
<?xml version="1.0" encoding="UTF-8" ?>
<Name>Max</Name>
```

SetFeatures-Operation:

Erwartete Struktur für die Operation SetFeatures

XML

<?xml version="1.0" encoding="UTF-8" ?>
<Features>
	<Name type="String">Max</Name>
	<Lastname type="String">Mustermann</Lastname>
	<Date type="DateTime">2018-09-27T00:00:00.000+00:00</Date>
	<IsCustomer type="Boolean">true</IsCustomer>
	<Amount type="Decimal">111.25</Amount>
	<InternalNumber type="Integer">45</InternalNumber>
</Features>

SetState-Operation:

Erwartete Struktur für die Operation SetState
XML
```
<?xml version="1.0" encoding="UTF-8" ?>
<State>NEW</State>
```

Output

Je nach Operation gibt der Adapter Daten in verschiedenen XML-Strukturen aus:

GetFeatures-Operation

Beispiel-Output für die Operation GetFeatures

XML

<?xml version="1.0" encoding="UTF-8" ?>
<Features>
	<Name>Max</Name>
	<Lastname>Mustermann</Lastname>
	<Address>Musterweg 1</Address>
</Features>

GetStates-Operation

Beispiel-Output für die Operation GetStates

XML

<?xml version="1.0" encoding="UTF-8" ?>
<CaseStates>
	<State>NEW</State>
	<State>DONE</State>
</CaseStates>

GetInformation-Operation

Beispiel-Output für die Operation GetInformation

XML

<?xml version="1.0" encoding="UTF-8" ?>
<Information>
	<Case creator="x4" created="2018-12-14T16:39:48.100+01:00">
		<Comments />
		<Features>
			<Name>Max</Name>
			<Lastname>Mustermann</Lastname>
			<Address>Musterweg 1</Address>
		</Features>
		<State>NEW</State>
		<ProcessInstanceId>18644c02-42dc-47a8-8f7f-5c70de823d54</ProcessInstanceId>
	</Case>
	<PossibleCaseStates>
		<State>NEW</State>
		<State>DONE</State>
	</PossibleCaseStates>
</Information>