wfm.StartProcess

This job starts a workflow process. It checks if the specified user is authorized to start the process. The start activity of the process is executed. To use this job, a process instance must first be created using the wfm.CreateProcessInstance job. Documents passed to the process are always placed in the workflow file’s workspace.

1. Input Parameters

Name Type Required Description

UserId

STRING

Yes

ID of the user

ProcessId

STRING

Yes

ID of the process

Workspace

BASE64

Yes

Contains documents in XML format (see note)

DataFields

BASE64

Yes

Contains the structure and values of input variables in XML format (see note)

2. Return Value

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

3. See Also

wfm.GetOrganisationObjects, wfm.CreateProcessInstance

4. Note

Structure of Workspace
<Workspace>
  <Docs>
    <Doc Id="" Type="" Location="" Moveable="" Deleteable="" Workspace=""/>
  </Docs>
</Workspace>

Doc — Structure that encapsulates information about a document:

  • Id (INT): 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')

  • Moveable (INT): indicates whether the document can be moved from the info area to the workspace (and vice versa) (Moveable=1), otherwise 0

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

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

Structure of DataFields
<DataFields>
  <DataField Id="iSkonto">
    <![CDATA[<WFVar><String>0</String></WFVar>]]>
  </DataField>
  <DataField Id="iSkontofaehig">
    <![CDATA[<WFVar><String>0</String></WFVar>]]>
  </DataField>
  <DataField Id="lPositionen">
    <![CDATA[
      <List TypeId="920C3899284B424EACBF881EE3A714C0">
        <ListItem Id="00000000000000000000000000000001" Selection="0">
          <Record>
            <Member Name="iPosition"><STRING>1</STRING></Member>
            <Member Name="strBezeichnung"><STRING>Tisch</STRING></Member>
          </Record>
        </ListItem>
      </List>
    ]]>
  </DataField>
</DataFields>

DataField — Workflow variable:

  • Id (STRING): Name of the workflow variable

  • CDATA: Structure of the workflow variable