Export Job Data (Workflow Manager)

Summary

This tool will export the Workflow Manager (Classic) repository to a .jxl file in the specified folder location. The .jxl file will contain all the configuration information for the repository as well as information about all the jobs. The .jxl file can be imported into another Workflow Manager (Classic) repository using the Import Job Data tool.

Usage

  • You may have distributed repositories across multiple servers or locations to support distributed workforces. In a disconnected replication where the parent and child nodes are not connected to a network or Internet, you may need to create the replica and synchronize changes offline. The Export Job Data tool accomplishes this to allow the administrator to update the child Workflow Manager (Classic) repositories with the most up-to-date configuration. Workflow Manager (Classic) time stamps any changes, so to only get changes that are from a specific time (like last export/synchronization), you can specify a date for the Export Since parameter. This will only export elements that have changed since the specified Export Since date. To obtain changes made across a time range, use the Export Since parameter to specify a start date and the Export Until parameter to specify an end date.

  • The output of this tool is an integer export status value. The export status will be 0 upon success. You can view the export status in the messages of the Geoprocessing History item created by running this tool, or use it as a precondition to subsequent tool execution in a Model.

Parameters

LabelExplanationData Type
Folder To Export To

The location of the JXL file output from the tool. This folder can be on a local or a network drive.

Folder
Input Database Path (.jtc)
(Optional)

The Workflow Manager (Classic) connection file for the database to be exported. If no connection file is specified, the current default Workflow Manager (Classic) database in the project is used.

File
Repository Name
(Optional)

The name of the Workflow Manager (Classic) repository that contains the configuration to be shared. If repository name is not specified, the current default Workflow Manager (Classic) repository name is used.

String
Export Since
(Optional)

By specifying a date, the JXL exported will only contain changes that occurred between the specified time and the current date. The input should be in UTC time format.

Date
Export Until
(Optional)

By specifying a date, the JXL exported will only contain changes that occurred between Export Since and the specified time. The input should be in UTC time format.

Date

Derived Output

LabelExplanationData Type
Status

The result of the export job data operation. Returns 0 on success.

Long

arcpy.wmx.ExportJobData(Input_Folder, {Input_DatabasePath}, {Input_Repository_Name}, {Input_Export_Since}, {Input_Export_Until})
NameExplanationData Type
Input_Folder

The location of the JXL file output from the tool. This folder can be on a local or a network drive.

Folder
Input_DatabasePath
(Optional)

The Workflow Manager (Classic) connection file for the database to be exported. If no connection file is specified, the current default Workflow Manager (Classic) database in the project is used.

File
Input_Repository_Name
(Optional)

The name of the Workflow Manager (Classic) repository that contains the configuration to be shared. If repository name is not specified, the current default Workflow Manager (Classic) repository name is used.

String
Input_Export_Since
(Optional)

By specifying a date, the JXL exported will only contain changes that occurred between the specified time and the current date. The input should be in UTC time format.

Date
Input_Export_Until
(Optional)

By specifying a date, the JXL exported will only contain changes that occurred between Export Since and the specified time. The input should be in UTC time format.

Date

Derived Output

NameExplanationData Type
Output_Status

The result of the export job data operation. Returns 0 on success.

Long

Code sample

ExportJobData example 1 (stand-alone script)

Export the configuration, with job information, of the specified Workflow Manager (Classic) repository to a folder location. The export would be the configuration as of December 9, 2010.

# Import arcpy module
import arcpy

# Check out any necessary licenses
arcpy.CheckOutExtension("JTX")

# Local variables:
Input_Folder = "C:\\Temp"
Input_DatabasePath = "C:\\Program Files\\WMX\\Database\\wmx.jtc"
Input_Repository_Name = "Redlands_Repository"
Input_Export_Since = "12/09/2010 2:14:30 PM"
Input_Export_Until = "12/09/2012 4:00:00 PM"

# Process: Export Job Data
arcpy.ExportJobData_wmx(Input_Folder, Input_DatabasePath, Input_Repository_Name, Input_Export_Since, Input_Export_Until)
ExportJobData example 2 (stand-alone script)

Export the configuration, with job information, of the default Workflow Manager (Classic) repository to a folder location.

# Import arcpy module
import arcpy

# Check out any necessary licenses
arcpy.CheckOutExtension("JTX")

# Local variables:
Input_Folder = "C:\\Temp"

# Process: Export Job Data
arcpy.ExportJobData_wmx(Input_Folder)

Environments

This tool does not use any geoprocessing environments.

Licensing information

  • Basic: No
  • Standard: Requires Workflow Manager
  • Advanced: Requires Workflow Manager

Related topics