Back to Top

JobTypeDescription

In this topic

  1. Summary
  2. Discussion
  3. Properties

Summary

The JobTypeDescription provides access to job type properties that can be customized before creating a job.

Discussion

The properties of the job type that can be customized and assigned to a new job being created.

Properties

PropertyExplanationData Type
AOI
(Read and Write)

The polygon object to be used as the AOI of the job. A list of polygon objects can be provided to create multiple jobs. One job is created for each polygon object provided and the polygon is used to create the AOI of the job.

Legacy:

This property has been deprecated. Use LOI instead.

Polygon
assignedTo
(Read and Write)

The user name or group name the job will be assigned to.

String
assignedType
(Read and Write)

The type of assignment for the job. Below is a list of valid strings to use when setting the job assignment.

  • User—A user in the workflow database
  • Group—A group in the workflow database
  • Unassigned—No job assignment
String
autoCommitWorkflow
(Read and Write)

Indicates whether the workflows are automatically ready for execution when the job is created.

  • True—The workflow is automatically ready for execution when the job is created.
  • False—The workflow must be committed to the database after the job is created.
Boolean
autoExecuteOnCreate
(Read and Write)

Indicates whether the job will be automatically executed after it is created.

  • True—The job automatically starts execution after it is created.
  • False—The job does not automatically start execution after it is created.
Boolean
createdBy
(Read and Write)

The user name that will be set as the creator of the job.

String
dataWorkspaceID
(Read and Write)

The ID of the data workspace to be set as the data workspace of the job.

String
description
(Read and Write)

A description about the job type.

String
dueDate
(Read and Write)

The due date that will be assigned to the job.

DateTime
extendedProperties
(Read and Write)

A dictionary containing the extended property tables of the job type. Each individual table can be obtained as its own dictionary using the table's name, and new values will be added to the table and saved back to the job type in advance of job creation. A sample is shown below.

Dictionary
jobName
(Read and Write)

The template for the name of the job.

String
jobTypeName
(Read and Write)

The name of the job type that will be used to create a job.

String
LOI
(Read and Write)

The geometry object to be used as the LOI of the job. A list of polygon or point objects can be provided to create multiple jobs. One job is created for each point or polygon object provided and the geometry is used to create the LOI of the job.

Geometry
ownedBy
(Read and Write)

The user who is the owner of the job.

String
parentJobID
(Read and Write)

The ID of the job that would be the parent of the job created.

Integer
parentJobName
(Read and Write)

The name of the job that would be the parent of the job created.

String
parentVersionName
(Read and Write)

The name of the version that would be the parent version created for the job.

String
prefix
(Read and Write)

The prefix to be added to the name of the job.

String
priority
(Read and Write)

The priority to be assigned to the job after its creation.

Integer
startDate
(Read and Write)

The date when the job will be started.

DateTime
suffix
(Read and Write)

The suffix to be added to the name of the job.

String
unionAOI
(Read and Write)

Indicates whether the list of polygon objects passed as the AOI will be merged to create one job or multiple jobs.

  • True—The workflow is automatically ready for execution when the job is created.
  • False—The workflow must be committed to the database after the job is created.
Legacy:

This property has been deprecated. Use unionLOI instead.

Boolean
unionLOI
(Read and Write)

Indicates whether the list of polygon or point objects passed as the LOI will be merged to create one job or multiple jobs.

  • True—The workflow is automatically ready for execution when the job is created.
  • False—The workflow must be committed to the database after the job is created.
Boolean
versionName
(Read and Write)

The name of the version that would be the version associated with the job.

String

Feedback on this topic?

In this topic
  1. Summary
  2. Discussion
  3. Properties