トップへ戻る

JobTypeDescription

このトピックの内容

  1. 概要
  2. ディスカッション
  3. プロパティ
  4. コードのサンプル

概要

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

ディスカッション

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

プロパティ

プロパティ説明データ タイプ
AOI
(読み書き)

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.

レガシー:

This property has been deprecated. Use LOI instead.

Polygon
assignedTo
(読み書き)

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

String
assignedType
(読み書き)

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
(読み書き)

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
(読み書き)

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
(読み書き)

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

String
dataWorkspaceID
(読み書き)

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

String
description
(読み書き)

A description about the job type.

String
dueDate
(読み書き)

The due date that will be assigned to the job.

DateTime
extendedProperties
(読み書き)

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
(読み書き)

The template for the name of the job.

String
jobTypeName
(読み書き)

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

String
LOI
(読み書き)

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
(読み書き)

The user who is the owner of the job.

String
parentJobID
(読み書き)

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

Integer
parentJobName
(読み書き)

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

String
parentVersionName
(読み書き)

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

String
prefix
(読み書き)

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

String
priority
(読み書き)

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

Integer
startDate
(読み書き)

The date when the job will be started.

DateTime
suffix
(読み書き)

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

String
unionAOI
(読み書き)

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.
レガシー:

This property has been deprecated. Use unionLOI instead.

Boolean
unionLOI
(読み書き)

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
(読み書き)

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

String

コードのサンプル

The following script gets the job type description and updates two extended property table values prior to job creation.

import arcpy

#Establish a connection to a Workflow database
conn = arcpy.wmx.Connect(r'c:\test\Workflow.jtc')

#Get the Job Type description 
desc = conn.config.getJobTypeDescription(job_type_name="Extended Example")

#Get the Extended Properties dictionary for the Job Type
ext_prop = desc.extendedProperties

#Define new values to use for Extended Property's Name and Address
ext_prop_dict = {'NAME' : 'John Smith', 'ADDRESS' : '106 Everdale Drive' }

#Set the new values in the appropriate Extended Property table
ext_prop['TestDB.ExtendedTable'] = ext_prop_dict

#Apply the ext_prop dictionary back to the Job Type's desc object
desc.extendedProperties = ext_prop

#Create a Job using the new Job Type description
job = conn.createJob(job_type_description = desc)

#Get the Job's properties
job_props = job.getExtendedPropertyTable('TestDB.ExtendedTable')

#Print the new extended property Name value for the Job
print(str(job_props['NAME']))

このトピックへのフィードバック

このトピックの内容
  1. 概要
  2. ディスカッション
  3. プロパティ
  4. コードのサンプル