wfm.GetWorkItemParams

This job determines all parameters of a work item for the user who personalized the work item. All workflow variables, parameters for the input mask, content of the workflow file and additional parameters (e.g. whether a password entry is required to forward) are returned.

This job has been replaced by wfm.GetWorkItem.

1. Input Parameters

Name Type Required Description

WorkItemId

STRING

Yes

Instance ID of the activity

UserId

STRING

Yes

ID of the user

ClientTypeId

STRING

Yes

ID of the client type used

2. Output Parameters

Name Type Dependency Description

Parameters

BASE64

—

List of parameters for the data mask in XML format (see note)

ExtendedAttributes

BASE64

—

List of data for the parameters (Attribute) in XML format (see note)

File

BASE64

—

List of documents of the info/work area of the WF file in XML format (see note)

[RoutingList]

BASE64

Optional

Routing list (optional, see note)

3. Return Value

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

4. Note

Structure of Parameters
<Parameters>
  <Parameter FormField="" DataField="" Name="" Mode="" Selection=""
    InfoText="" ListType=""><![CDATA[ ]]></Parameter>
</Parameters>

Parameters — list of formal parameters:

  • FormField (STRING): ID of the field on a form sheet to which the workflow variable is assigned; if no assignment exists: name of the workflow variable

  • DataField (STRING): ID of the workflow variable

  • Name (STRING): Name of the workflow variable

  • Mode (INT): Mode of the workflow variable
    1 = input parameter, 2 = output parameter, 3 = input/output parameter

  • Selection (STRING): Selection type for workflow variables in list form (single or multi:x)

  • InfoText (STRING): Information text for workflow variables in list form

  • ListType (STRING): Type of the list (ProcessList, UserList, UserDefList)

  • CDATA: Structure and data of the workflow variable

Structure of ExtendedAttributes
<ExtendedAttributes>
  <ExtendedAttribute Name="MASKID" Value=""/>
  <ExtendedAttribute Name="SEND_BUTTON" Value="0"/>
  <ExtendedAttribute Name="SENDTO_BUTTON" Value="0"/>
  <ExtendedAttribute Name="END_BUTTON" Value="0"/>
  <ExtendedAttribute Name="SIGN_ACTIVITY" Value=""/>
  <ExtendedAttribute Name="CHECK_PASSWORD" Value=""/>
</ExtendedAttributes>

ExtendedAttributes — list of parameters (Attribute) with the following structure:

  • Name (STRING): Name of the attribute

    • MASKID: GUID of the workflow mask

    • SEND_BUTTON: Display of the forward button

    • END_BUTTON: Display of the finish button

    • SIGN_ACTIVITY: 1 = digital signature required, otherwise 0

    • CHECK_PASSWORD: 1 = password must be entered to forward, otherwise 0

  • Value: Value of the attribute

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

Docs — 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 the object (0 = no, 1 = yes)

  • OriginalId (INT): indicates which document was originally dragged into the file

  • Display (INT): indicates whether this document should be displayed in the preview (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>
  </Entries>
</RoutingList>

RoutingList — routing list (structure identical to wfm.CompleteWorkItem).