wfm.AdhocConfigTemplate

With this job, ad hoc templates in the workflow can be configured.

1. Input Parameters

Name Type Required Description

UserId

STRING

Yes

ID of the user

OrgId

STRING

Yes

ID of the organization

Action

INT

Yes

Action to be performed:

* 1 — Save a template * 2 — Delete a template * 3 — Publish a template * 4 — Private a template

[TemplateId]

STRING

No

ID of the template. For action 1: empty when saving the template for the first time. For actions 2, 3 and 4: ID of the template to be edited.

[TemplateName]

STRING

No

Name of the template (only for action 1)

[Public]

INT

No

0 = private template, 1 = public template (only for action 1)

[Template]

BASE64

No

Template content in XML format (only for action 1, see example)

2. Output Parameters

Name Type Dependency Description

[TemplateId]

STRING

Optional

ID of the saved template (only for action 1). No return parameter for actions 2, 3 and 4.

3. Return Value

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

4. Example

Structure of Template (input parameter for action 1):

<RoutingList Id="3294B433BFF6454D9C861B86B5A8AD5D"
             ActivityId="3294B433BFF6454D9C861B86B5A8AD5D" Expandable="1">
  <Entries>
    <Entry Nr="203" Expandable="1">
      <Item Id="99825B18A8334987935684FDA3D6A40D"
            ActivityId="6EE4490A48164A0FA6DC34A80099AF66"
            ActivityName="Create invoice"
            ModelActivityName="Create invoice"
            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"
            TimerId="" TimerDuration="" TimerDurationType=""
            Changeable="1" Deleteable="0">
        <ObjectIds></ObjectIds>
      </Item>
      <Item Id="C6DA9503CD874D69A9B703D0E06A52E8"
            ActivityId="6EE4490A48164A0FA6DC34A80099AF67"
            ActivityName="Approve invoice GF"
            ModelActivityName="Approve invoice"
            TimerId="" TimerDuration="" TimerDurationType=""
            Changeable="1" Deleteable="0">
        <ObjectIds></ObjectIds>
      </Item>
    </Entry>
  </Entries>
</RoutingList>

Detailed description of RoutingList:

  • RoutingList: Routing list with the following structure (or subsets thereof)

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

    • 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. Absolute values have no meaning for the client.

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

  • Item: Describes an item in the routing list (activity, performer and optionally deadline).

    • Id (STRING): Used for identification. Must not be changed and must be sent identically in all jobs. If an item is created by the client, this must specify an ID here.

    • 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

    • TimerName (STRING): Name of the 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 the 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