wfm.LoadMasks

This job returns the specified masks or all masks for a workflow model with substructure (fields, ListCtrlCols, catalogs).

1. Input Parameters

Name Type Required Description

OrganisationId

STRING

Yes

ID of the organization in which the workflow with the masks is located.

WorkflowId

STRING

Yes

ID of the workflow with the masks.

MaskIds

STRING

Yes

IDs of the requested masks (comma-separated). Empty = all masks of the workflow model are loaded.

2. Output Parameters

Name Type Dependency Description

OrganisationId

STRING

—

ID of the organization in which the workflow with the masks is located.

WorkflowId

STRING

—

ID of the workflow with the masks.

Masks

BASE64

—

Mask data in XML format (see note).

3. Return Value

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

4. Note

Structure of Masks
<Masks>
  <Mask Id="" Name="" Flags="" FrameWidth="" FrameHeight="">
    <!-- Standard mask field -->
    <MaskField Id="" Name="" InternalName="" FieldName="" TabOrder=""
                DataType="" InpLen="" Init="" Flags="" Flags1="" Flags2=""
                InpLeft="" InpTop="" InpRight="" InpBottom=""
                FieldLeft="" FieldTop="" FieldRight="" FieldBottom=""
                ToolTip="" ValuesId="">
      <MaskFieldVal><![CDATA[ ]]></MaskFieldVal>
    </MaskField>

    <!-- List control mask field -->
    <MaskField Id="" Name="" InternalName="" TabOrder=""
                DataType="" InpLen="" Init="" Flags="" Flags1="" Flags2=""
                InpLeft="" InpTop="" InpRight="" InpBottom=""
                FieldLeft="" FieldTop="" FieldRight="" FieldBottom=""
                ToolTip="" ValuesId="">
      <MaskListCtrls>
        <MaskListCtrl ColPos="" Name="" Type="" Length=""
                      ColWidth="" Color="" TextAlign="" ValuesId=""/>
        <MaskListCtrlVal><![CDATA[ ]]></MaskListCtrlVal>
      </MaskListCtrls>
    </MaskField>

    <!-- Page control mask field -->
    <MaskField Id="" Name="" InternalName="" TabOrder=""
                DataType="" InpLen="" Init="" Flags="" Flags1="" Flags2=""
                InpLeft="" InpTop="" InpRight="" InpBottom=""
                FieldLeft="" FieldTop="" FieldRight="" FieldBottom=""
                ToolTip="" ValuesId="">
      <Page Id="" Name="" Number="" IconId="">
        <MaskFields>
          <MaskField Id="" Name="" InternalName=""
                     TabOrder="" DataType="" InpLen="" Init="" Flags="" Flags1=""
                     Flags2="" InpLeft="" InpTop="" InpRight="" InpBottom=""
                     FieldLeft="" FieldTop="" FieldRight="" FieldBottom=""
                     ToolTip="" ValuesId=""/>
        </MaskFields>
      </Page>
    </MaskField>
  </Mask>
</Masks>

Masks — list of masks; each element is of type Mask:

  • Mask — structure containing a list of mask fields of type MaskField:

    • 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 with information about a mask field; contains either the field value (MaskFieldVal) or a list of 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 MaskFields again):

    • Id (STRING): ID of the page control.

    • Name (STRING): Name of the page control.

    • Number (INT): Position (page number) of a page.

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

5. See Also

wfm.SaveMasks