wfm.Import

This job imports an organization. For this, a file is attached to the job.

The attached file is the output file of wfm.Export — together the two jobs transport an organization from one system to another. Its structure is described in Structure of the Export File.

1. Input Files

Name Description

Import file

Name and path of the file to be imported — the .exp file from wfm.Export. If it originates from an older server version, convert it first with wfm.ConvertExportFile.

2. Input Parameters

Name Type Required Description

DoImportOrganisation

INT

Yes

Indicates whether organization data should also be imported (1 = Yes, 0 = No)

DestOrganisationId

BASE64

Yes

If organization data is to be imported: specifies the target organization. Remains empty if a new organization should be created.

WorkflowProjects

BASE64

Yes

Specifies the workflow projects to be imported in XML format (see note)

Workflows

BASE64

Yes

Specifies the workflow models to be imported in XML format (see note)

ReportConfigs

BASE64

Yes

Specifies the report configurations to be imported in XML format (see note)

Templates

BASE64

Yes

Specifies the routing list templates to be imported in XML format

3. Return Value

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

4. Output Parameters

Name Type Dependency Description

ChangedOrganisations

STRING

—

Comma-separated ID list of changed organizations

5. Note

Structure of WorkflowProjects:

<WorkflowProjects>
  <WorkflowProject Id="" DestPrjId="" DestOrgId="" Overwrite="" CompleteImport="" OldParent=""/>
  <WorkflowProject Id="" DestPrjId="" DestOrgId="" Overwrite="" CompleteImport="" OldParent=""/>
</WorkflowProjects>

Detailed description of WorkflowProject:

  • Id (STRING): ID of the project in the import file

  • DestPrjId (STRING): ID of the parent project. This is the only place in the server API where the parent/child relation between workflow projects appears — and it appears as input. No job returns it: wfm.GetProjectList returns a flat list, and the hierarchy is stored in oswfprojectsrel.

  • DestOrgId (STRING): ID of the target organization. Not specified if a new organization is created during import and the project has this new organization as target.

  • Overwrite (INT): Flag indicating whether a possibly already existing project with the same ID should be overwritten. Otherwise, a new project with a new ID is created.

  • CompleteImport (INT): Flag indicating whether the entire substructure (projects/workflows) of the project should be imported. This does not need to be listed.

  • OldParent (INT): Only relevant if the parent workflow project was copied (not overwritten). If set, the project is written to the old WF project (overwrite flag is observed); if not set, to the newly created (copied) WF project. If the parent WF project was overwritten, this flag should always be set.

Structure of Workflows:

<Workflows>
  <Workflow Id="" DestFamId="" DestOrgId="" Overwrite="" OldFamily=""/>
  <Workflow Id="" DestFamId="" DestOrgId="" Overwrite="" OldFamily=""/>
</Workflows>

Detailed description of Workflow:

  • Id (STRING): ID of the workflow in the import file

  • DestFamId (STRING): ID of the target WF family

  • DestOrgId (STRING): ID of the target organization. Not specified if a new organization is created during import and the model has this new organization as target.

  • Overwrite (INT): Flag indicating whether a possibly already existing workflow with the same ID should be overwritten. Otherwise, a new workflow with a new ID is created.

  • OldFamily (INT): Only relevant if the parent workflow family was copied (not overwritten). If set, the model is written to the old WF family (overwrite flag is observed); if not set, to the newly created (copied) WF family. If the parent WF family was overwritten, this flag should always be set.

Structure of ReportConfigs:

<ReportConfigs>
  <ReportConfig ConfigId="" Overwrite="" DestOrgId=""/>
  <ReportConfig ConfigId="" Overwrite="" DestOrgId=""/>
</ReportConfigs>

Detailed description of ReportConfig:

  • ConfigId (STRING): ID of the configuration in the import file

  • DestOrgId (STRING): ID of the target organization

  • Overwrite (INT): Flag indicating whether a possibly already existing configuration with the same ID should be overwritten. Otherwise, a new configuration with a new ID is created.

6. See Also

wfm.Export, wfm.ConvertExportFile, wfm.GetProjectList