Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This command creates a file, (CSV, TSV, or SSV), of the data that is stored in the Workflow Table. This file contains a header row that lists the names of the Workflow Table columns.

Option/Parameter

Description

<workflow configuration>

Specify the workflow configuration that you want to export.

<export file>

Specify the name of the export file

[-csv|-tsv|-ssv]

Specify one of the wfexport supported formats according to which the export file should be created:

  • CSV (Comma Separated Value) - Default format

  • SSV (Semicolon Separated Value)

  • TSV (Tab Separated Value)

Note

Note!

  • Text strings within each value are delimited by a quotation mark (").

  • In the export file, External References are enclosed in braces ({}) preceded by a dollar symbol ($). For example: ${mywf_abcd}. For further information see External References in the Desktop User's Guide.

  • Similarly, Execution Settings in the export file, are enclosed in braces ({}), but are preceded by a pound symbol (#). For example: #{mywf_exsettings}. For further information see Execution Settings below.

  • To prevent a workflow table column from being updated by the export file data when importing, delete that same column from the export file.

[workflow configuration password]

For an encrypted export file, provide a password. 

...

Info

Example - Export data of EC configurations

  • With an EC configuration, the export file will include:

    Code Block
    #{type=execsettings#enabled=true
        #disttype=wfcount#ecgroups=[ec1|ec2]}

  • With a disabled EC configuration, the export file will include:

    Code Block
    #{type=execsettings#enabled=false}

Return Codes

Listed below are the different The following is a list of return codes for the wfexportcommand:

Code

Description

0

Will be returned if the command was successful.

1

->Number of errors that has occurred during the export

Will be returned if the number of arguments is incorrect.

1

Will be returned If login credentials are incorrect.

1

Will be returned if configuration permission is denied.

3

Will be returned if the directory does not exist or has no write access.

5

Will be returned if the export file has an incorrect file suffix.

6

Will be returned if the configuration name is incorrect.

7

Will be returned if the configuration does not exist.

9

Will be returned if an encryption passphrase is needed.

10

Will be returned if the user does not have the read permission to access the workflow.

11

Will be returned if the configuration could not be loaded.

12

Will be returned if the export fails (refer to the logs for details).