wfm.GetProcessFile

This job returns the file for a process.

1. Input Parameters

Name Type Required Description

ProcessId

STRING

Yes

ID of the process.

2. Output Parameters

Name Type Dependency Description

File

BASE64

—

The file for the process in XML format (see note).

3. Return Value

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

4. Note

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>

Detailed description of Doc:

  • Id (STRING): ID of the document

  • Type (INT): Type of the document

  • Location (INT): indicates whether the document is in the SDREL (1, SDREL is the database table root document relations) or system archive (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 (1 = yes)

  • 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 (what ID this document had)

  • Display (INT): indicates whether this document should be displayed in the preview (0 = no, 1 = yes)