wfm.CompleteWorkItem

This job transfers the processing data (variables, file) of a work item to the server and forwards the work item depending on the ActionType parameter.

1. Input Parameters

Name Type Required Description

UserId

STRING

Yes

ID of the user

WorkItemId

STRING

Yes

Instance of the activity

Parameters

BASE64

Yes

List of workflow variables in XML format (see note)

ActionType

STRING

Yes

Flag indicating what should happen to the activity.
SEND_BUTTON: Forward work item.
STOREONLY: Changes are saved, but work item is not forwarded.

SendTo

STRING

Yes

Currently not supported — pass 0.

File

BASE64

Yes

Contains documents of the workflow file in XML format (see note)

DocsDeleted

STRING

Yes

Comma-separated list of document IDs to be deleted from the WF file

ClientTypeId

STRING

Yes

ID of the client type used

[RoutingList]

BASE64

No

Routing list (see note)

2. Return Value

(INT): 0 = Job successful, otherwise error code.

3. Notes

Structure of Parameters
<Parameters>
  <Parameter Name="WF_BEARBEITER_1" DataField="9FC5D03089E843F7B2D64F1CC2421418"><![CDATA[Schulze]]></Parameter>
</Parameters>

Parameters contains a list of workflow variables (Parameter):

  • DataField (STRING): ID of the parameter

  • Name (STRING): Name of the parameter

  • CDATA: Data specifying the content of the parameter

Structure of File
<File>
  <Docs>
    <Doc Id="" Type="" Location="" Workspace="" New="" Deleteable="0" Moveable="2" UseActiveVariant="1"/>
  </Docs>
</File>

File contains a list of document parameters (Doc):

  • Id (STRING): ID of the document

  • Type (INT): Type of the document

  • Location (INT): indicates whether the document is in the SDREL (Location='1') or system archive (Location='2')

  • Workspace (INT): indicates whether the object is in the info area (0) or work area (1)

  • New (INT): indicates whether the object was newly added to the file (New='1')

  • Deleteable (INT): indicates whether the document can be deleted from the file (0 = no, 1 = yes)

  • Moveable (INT): indicates whether the document can be moved within the file (0 = no, 1 = yes)

  • UseActiveVariant (INT): indicates whether the active variant should be used for this document (0 = no, 1 = yes)

Structure of RoutingList
<RoutingList Id="3294B433BFF6454D9C861B86B5A8AD5D"
  ProcessId="BA16C21BB96D46D099E72070BCB644CC"
  ActivityId="3294B433BFF6454D9C861B86B5A8AD5D" Expandable="1">
  <Entries>
    <Entry Nr="203" Expandable="1">
      <Item Id="99825B18A8334987935684FDA3D6A40D"
        ActivityId="6EE4490A48164A0FA6DC34A80099AF66" ActivityName="Create invoice"
        ModelActivityName="Create invoice" Remark="" TimerId="" TimerDuration=""
        TimerDurationType="" Changeable="1" Deleteable="0">
        <ObjectIds></ObjectIds>
      </Item>
    </Entry>
    <Entry Nr="253" Expandable="1">
      <Item Id="E15594D692C14FDA9AFDE8FA0A43F6E4"
        ActivityId="6EE4490A48164A0FA6DC34A80099AF67" ActivityName="Approve invoice BL"
        ModelActivityName="Approve invoice" Remark="" TimerId="" TimerDuration=""
        TimerDurationType="" Changeable="1" Deleteable="0">
        <ObjectIds></ObjectIds>
      </Item>
      <Item Id="C6DA9503CD874D69A9B703D0E06A52E8"
        ActivityId="6EE4490A48164A0FA6DC34A80099AF67" ActivityName="Approve invoice GF"
        ModelActivityName="Approve invoice" Remark="" TimerId="" TimerDuration=""
        TimerDurationType="" Changeable="1" Deleteable="0">
        <ObjectIds></ObjectIds>
      </Item>
    </Entry>
  </Entries>
</RoutingList>

RoutingList — Routing list with the following structure:

  • Id (STRING): ID of the routing list. This value is set by the server and must not be changed.

  • ProcessId (STRING): Process ID

  • ActivityId (STRING): Activity ID

  • Expandable (INT): 0 = routing list cannot be expanded, 1 = routing list can be expanded

  • Entries: groups entries of the routing list; an entry consists of multiple elements that can be executed in parallel

  • Entry: describes an entry in the routing list

    • Nr (INT): used for relative sorting of entries within the routing list

    • Expandable (INT): 0 = entry cannot be expanded, 1 = entry can be expanded

  • Item: describes an item in the routing list (an activity, a performer and possibly a deadline)

    • Id (STRING): used for identification; must not be changed

    • ActivityId (STRING): ID of the activity in the workflow model

    • ActivityName (STRING): Name of the activity (need not match the name in the workflow model)

    • ActivityModelName (STRING): Name of the activity in the workflow model

    • TimerId (STRING): ID of a reminder period

    • TimerDuration (INT): Duration of the period

    • TimerDurationType (INT): 0 = no period, 1 = relative, 2 = absolute

    • Changeable (INT): 0 = no changes possible, 1 = item can be modified by client

    • Deleteable (INT): 0 = deletion not allowed, 1 = item can be deleted

    • Remark (STRING): Note for processing (text)

    • ObjectIds (STRING): List of GUIDs of performers (roles or persons), separated by commas