wfm.Export

This job exports organization structure, workflow projects and/or workflows.

1. Input Parameters

Name Type Required Description

OrganisationId

STRING

Yes

ID of the organization to export from

OrgDoExport

INT

Yes

Flag: indicates whether organization data should also be exported (1 = Yes, 0 = No)

WFProjectTree

BASE64

Yes

Structure indicates which projects and workflow models should be exported (XML format, see note)

ReportConfigDoExport

INT

Yes

Flag: indicates whether report configurations of the organization should be exported

ReportConfigIds

STRING

Yes

Comma-separated list of report configuration IDs to export. If ReportConfigDoExport = 1 and this list is empty, all configurations of the organization are exported.

AdhocRoutingListTemplateDoExport

INT

Yes

Flag: indicates whether routing list templates of the organization should be exported

AdhocRoutingListTemplateIds

STRING

Yes

Comma-separated ID list of routing list templates to export. If AdhocRoutingListTemplateDoExport = 1 and this list is empty, all routing list templates of the organization are exported.

2. Return Value

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

3. Output Files

Name Description

Export file

Name and path of the export file

4. Note

Structure of WFProjectTree:

<WFProjectTree>
  <WorkflowProject Id="" CompleteExport="0">
    <WorkflowProject Id="">
      <WorkflowProject Id="" CompleteExport="0">
        <Workflow Id=""/>
        <Workflow Id=""/>
      </WorkflowProject>
    </WorkflowProject>
    <WorkflowProject Id="" CompleteExport="1"/>
    <WorkflowProject Id="" CompleteExport="1">
      <Workflow Id=""/>
      <Workflow Id=""/>
    </WorkflowProject>
  </WorkflowProject>
</WFProjectTree>

Detailed description of WFProjectTree:

  • WorkflowProject: Structure (possibly nested) indicating which workflow project (which may also be a workflow family) should be exported

    • Id (STRING): ID of the workflow project

    • CompleteExport (INT): Flag indicating whether all projects or workflows hanging under the project should be exported. If set, the sub-structure does not need to be specified further.

  • Workflow: Structure indicating which workflow should be exported

    • Id (STRING): ID of the workflow

5. See Also

wfm.Import