Task Management

The adapter enables interface-based access to human tasks in Business Processes via Technical Processes. It forms an interface that makes modelled tasks and human interaction available on process level. This enables the connection of customer-specific Web Apps to processes modeled with BPMN or the direct connection of any third-party system to the central process control of the X4 BPMS.

For access via the adapter, the user logged on in X4 Web Apps is used.

Properties

Operation

Defines the operation executed by the adapter

Possible values:

GetAllTasks: Return all tasks for the logged-in user or group
GetTask: Return one task for the user logged-in
EditTask: Lock the tasks for other users and update task information
CloseTask: Complete the task with a professional status and continue the case
DeclineTask: Decline the task and return it to the owner
ForwardTask: Forward the task to a person or group
CancelTask: Cancel task processing and release the task for other users
ResubmitTask: Set task on resubmission

Parameters

`Adapter`	Main adapter class (Do not change!) Possible values: de.softproject.x4.server.bpm.casemanagement.adapter.TaskManagement: Main class (default)
`limit`	Page size for retrieving the task list The value is optional. If the parameter is not set, all tasks will be returned. Possible values: Any number `> 0`
`offset`	Offset for retrieving the task list The value is optional. If the parameter is not set, all tasks will be returned. Possible values: Any number `> 0`
`state`	Required. State filter for retrieving the task list Possible values: `OPEN`: Open tasks `IN_PROGRESS`: Tasks in progress `CLOSED`: Closed tasks
`taskUuid`	Task UUID Possible values: Valid UUID, e.g. `443c498a-5868-4110-891f-42e5cb8fc24e`
`userForDebugging`	User to be used for debugging, if no logon exists in X4 Web Apps Possible values: Valid user login, e.g. `admin`
`dataformatVersion`	Version of the used data format Possible values: `1.0`: Used data format until version 7.0 `2.0`: Used data format since version 7.0, see sample inputs

Status values

`1`	The operation was executed successfully
`-1`	The operation could not be executed

The documentation of the ReST interface can be found at http://localhost:8080/X4/X4Api/.

Input

No input is required for following operations:

GetAllTasks
GetTask
CancelTask

The following operations require an XML document with the following structure as input:

Operation EditTask

XML

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

Operation CloseTask

XML

<?xml version="1.0" encoding="UTF-8"?>
<CloseTask>
    <MarketValue>120 million €</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

When the CancelTask operation is executed, the output is the input document.

The following operations output an XML document with the following structure:

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>

Operations GetTask, EditTask, CloseTask, DeclineTask and 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 million €</MarketValue>
        <Offer>150 million €</Offer>
    </BusinessData>
</Task>