Summary
The WorkflowConnection object provides access to methods for creating or getting a Workflow Manager job.
Discussion
Jobs are created from a job type template. All of the properties for the new job are automatically inherited from the job type and can be updated after creation using the Job methods.
Method Overview
| Method | Explanation |
| createJob ({job_type_id}, {job_type_name}) | Create a new job based on a job type. |
| getJob (jobID) | Return a single job using its job ID. |
Methods
createJob ({job_type_id}, {job_type_name})| Parameter | Explanation | Data Type |
job_type_id | The ID of the job type from which to create a new job. | Integer |
job_type_name | The name of the job type from which to create a new job. | String |
Return Value
| Data Type | Explanation |
| Job | Returns the job created as a Job. |
To create a new job requires either a job type name or a job type ID.
The following script creates two jobs in the Workflow Manager database: one defined by the job type name and the other by the job type ID.
import arcpy
import arcpywmx
#Establish a connection to a Workflow database
conn = arcpywmx.Connect(r'c:\test\Workflow.jtc')
#Create a Workflow Job of type Data Edits
job = conn.createJob(job_type_name="Data Edits")
#Create a Workflow Job of type 5
job2 = conn.createJob(job_type_id = 5)
getJob (jobID)
| Parameter | Explanation | Data Type |
jobID | The ID of the job to return. | Integer |
Return Value
| Data Type | Explanation |
| Job | Returns the job as a Job. |
Provides an easy way to retrieve a job.
Get a job from a Workflow Manager database.
import arcpy
import arcpywmx
#Establish a connection to a Workflow database
conn = arcpywmx.Connect(r'c:\test\Workflow.jtc')
#Access a Workflow Job
job = conn.getJob(99999)
Code Sample
The following script creates one job and gets another from a Workflow Manager database.
import arcpy
import arcpywmx
#Establish a connection to a Workflow database
conn = arcpywmx.Connect(r'c:\test\Workflow.jtc')
#Create a Workflow Job of type Data Edits
job = conn.createJob(job_type_name="Data Edits")
#Access a Workflow Job
job = conn.getJob(99999)