2.2.46 wfexport

Owned by Jenni Wallin
Last updated: May 16, 2023 by Former user (Deleted)
2 min read
usage: wfexport <workflow configuration> <export file> [-csv|-tsv|-ssv] [workflow configuration password]

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.

Note!

wfexport is identical to the Workflow Table right-click command Export Table. For further information see Export Table in the Desktop User's Guide. 

<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!

  • 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. 

Example - General use of wfexport

Create the file wf_disk_collection.csv under the tmp directory.

$ wfexport Default.disk_collection /tmp/wf_disk_collection

The wf_disk_collection.csv export file:

"ID","Name","[Disk_1]Directory","[Disk_1]Filename"
 1,"workflow_1","/tmp/in","in.file"
 3,"workflow_3","/tmp/in3","in3.file"
 100,"workflow_100","/tmp/in100","in100.file"
 109,"workflow_110","/tmp/in101","in101.file"
 110,"workflow_110","/tmp/in101","in101.file"
 111,"workflow_112","/tmp/in112","${a}"
 112,"workflow_113","/tmp/in113","a"

Execution Settings

An export file of a workflow configuration may include settings for an EC or an ECSA.

Setting

Description

Valid Values

typeThe configuration type.execsettings
enabledSpecifies whether or not the configuration is enabledtrue or false
disttypeThe workflows load balancing method.

sequential, wfcount, machineload, or roundrobin. For further information see the Desktop User's Guide, in the Workflow Properties section.

ectypeThe Execution Context type on the eclist list.ec or ecsa
eclist

A vertical bar (|) delimited string of the configured ECs and ECSAs. The list is enclosed with brackets.

Note!

  • Only one ECSA at a time can be specified.

  • [] = an empty eclist.


Example - Export data of EC/ECSA configurations

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

    #{type=execsettings#enabled=true
    #disttype=wfcount#ectype=ec#eclist=[ec1 | ec2]}

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

    #{type=execsettings#enabled=true
    #disttype=sequential#ectype=ecsa#eclist=[ecsa1]}

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

    #{type=execsettings#enabled=false}

Return Codes

Listed below are the different return codes for the wfexport command:

CodeDescription

0

Will be returned if the command was successful.

1->

Number of errors that has occurred during the export.

Next:

2.2.47 wfgroupdisable