wfm.GetWorkItem

This job starts a work item. The work item is personalized for the specified user. Additionally, all required data (mask, file and workflow variables) for the client are returned.

1. Input Parameters

Name Type Required Description

UserId

STRING

Yes

ID of the user

WorkItemId

STRING

Yes

Instance ID of the activity

ClientTypeId

STRING

Yes

ID of the client type used

2. Output Parameters

Name Type Dependency Description

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)

Masks

BASE64

—

Mask data in XML format (see note)

Parameters

BASE64

—

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

[RoutingList]

BASE64

Optional

Routing list (optional, see note)

3. Return Value

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

4. See Also

wfm.GetWorkItemList, wfm.CancelWorkItem, wfm.CompleteWorkItem

5. Note

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="" Type="" Rights="" Location="" Workspace="" Deleteable="0" Moveable="1"
      UseActiveVariant="" OriginalId="" Display=""/>
  </Docs>
</File>

File encapsulates the parameters Workspace and Infospace. Docs is a list of document parameters (Doc):

  • Id (INT): ID of the document from the DMS

  • Type (INT): Type of the document

  • Rights (INT): Access rights
    0 = accessDenied, 1 = accessView, 2 = accessEdit, 4 = accessDelete, 8 = accessEditDataSheet, 15 = accessAll

  • Location (INT): Location of the document (1 = SDREL, 2 = WF archive)

  • Workspace (INT): indicates whether the object is in the info area (0) or work area (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 Masks
<Masks>
  <Mask Id="" Name="" Flags="" FrameWidth="" FrameHeight="">
    <MaskField Id="" Name="" InternalName="" TabOrder="" DataType="" InpLen="" Init=""
      Flags="" Flags1="" Flags2="" InpLeft="" InpTop="" InpRight="" InpBottom=""
      FieldLeft="" FieldTop="" FieldRight="" FieldBottom="" ToolTip="" ValuesId="">
      <MaskFieldVal><![CDATA[ ]]></MaskFieldVal>
    </MaskField>
  </Mask>
</Masks>

Masks — list of masks (Mask):

  • Id (STRING): ID of the mask

  • Name (STRING): Name of the mask

  • Flags (INT): Flags

  • FrameWidth (INT): Width of the mask

  • FrameHeight (INT): Height of the mask

  • MaskField: Structure containing information about a mask field; contains either the value of the mask field (MaskFieldVal) or a list of mask field controls (MaskListCtrls)

    • Id (STRING): ID of the mask field

    • Name (STRING): Name

    • InternalName (STRING): Internal name

    • TabOrder (INT): Tab order

    • DataType (INT): Data type

    • InpLen (INT): Input length

    • Init (STRING): Initialization value

    • Flags (INT): Flags

    • Flags1 (INT): Additional flags

    • Flags2 (INT): Additional flags

    • InpLeft (INT): X-position of the input field

    • InpTop (INT): Y-position of the input field

    • InpRight (INT): Width of the input field

    • InpBottom (INT): Height of the input field

    • FieldLeft (INT): X-position of the field label

    • FieldTop (INT): Y-position of the field label

    • FieldRight (INT): Width of the field label in pixels

    • FieldBottom (INT): Height of the field label in pixels

    • ToolTip (INT): Tooltip

    • ValuesId (INT): Reference to list fields

    • MaskFieldVal: Value of the mask field as CDATA

    • MaskListCtrl: Structure with information about a mask field control

      • ColPos (INT): Column position

      • Name (STRING): Name

      • Type (STRING): Type

      • Length (INT): Length

      • ColWidth (INT): Column width

      • Color (INT): Color

      • TextAlign (INT): Text alignment

      • ValuesId (STRING): Reference to list fields

      • MaskListCtrlVal: Value of the mask field control as CDATA

    • Page: Structure with information about a page control (contains further mask fields)

      • Id (STRING): ID of the page control

      • Name (STRING): Name of the page control

      • Number (INT): indicates the position ("page number") of a page

      • IconId (INT): ID of the icon (from DB table Osicons) to be displayed on the page control

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 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).