Case Management | X4Documentation

This adapter forms the interface to the "Case Management" functionality of the product component X4 BPM. The adapter enables, for example, the setting and reading of case data such as case status or characteristics of the case data model.

Properties

Operation

Operation executed by the adapter

Possible values:

SetFeature: Writes a feature
SetFeatures: Writes several features in one operation
GetFeatures: Returns all features of the operation
SetState: Sets the status of the operation
GetStates: Returns all possible states of the operation
GetComments: Returns all comments of the operation
GetInformation: Returns all information of the operation

Parameter

`Adapter`	Main class of the adapter (do not change!) Possible values: en.softproject.x4.server.bmn.casemanagement.adapter.CaseManagementAdapter: Main class (default)
`CaseId`	ID of the operation to be processed Possible values: Any valid user ID `%CASE_ID%`: Current case ID (default)
`CaseProcess`	Repository path to a Business Process in which the corresponding operation is defined. Possible values: Any complete repository path, e.g. `Project/Folder/Process.bpm` Any valid placeholder, e.g. `%START_PROCESS%` `%START_PROCESS%`: Calling Business Process (default)
`CaseUserId`	User ID of the owner of an operation Possible values: Any valid user ID `%USER_ID%`: Current user ID (default)
`dataformatVersion`	Version of the data format used Possible values: `1.0`: Data format used up to version 7.0 `2.0`: Used data format from version 7.0, see input examples

Status values

`1`	The operation was executed successfully.
`0`	The operation was executed but no result was found or no data was changed.
`-1`	The operation could not be executed.

Input

The adapter expects a predefined XML structure as input. The structure depends on the operation used.

If the attribute "type" is not specified for setFeature / setFeatures, the data type is "String". The other possible data types of the "Case Management" functionality correspond to those of the types there.

SetFeature-Operation:

XML

<?xml version="1.0" encoding="UTF-8" ?>
<Name>Max</Name>

SetFeatures-Operation:

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:

XML

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

Output

Depending on the operation, the adapter outputs data in different XML structures:

GetFeatures-Operation

XML

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

GetStates-Operation

XML

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

GetInformation operation

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>