Description

preProcessing configures a CreateTaskGroup operation that runs before layout templates are imported and feature data is extracted. It is how a product definition declares dependencies on other task group jobs, sets task group metadata (name, dates, assignment), and schedules follow-on jobs to be created automatically when the task group reaches a configured status. preProcessing is most commonly used by workflow task group product definitions such as MGCP and TDS.

How it is used

When a job is submitted, the Topographic Production Service runs the preProcessing CreateTaskGroup operation first. The operation:

  1. Evaluates any dependencies and pauses the new task group job until each referenced task group job reaches the configured jobStatus.
  2. Applies the taskGroup metadata (name, start/end dates, and assignments).
  3. After the operations listed in the task group's operations property complete, calls for the completion of the parent job and triggers any postJobActions to create follow-on jobs.

Expected values

preProcessing defines a CreateTaskGroup operation. Standard properties include:

  • name
  • type
  • id
  • description
  • validation
  • resetSelection
  • properties
  • parameters
  • jobTemplateId
  • extendedProperties

It additionally supports three JSON arrays/objects that drive the pre-processing workflow:

  • dependencies — pauses the task group job until another task group job reaches a specific status.
  • taskGroup — defines properties of the task group such as its name, start and end dates, and assignment.
  • postJobActions — creates a child task group job after the source task group job reaches a configured status.

The following JSON examples demonstrate the syntax for dependencies, taskGroup, and postJobActions:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
"dependencies": [
  {
    "taskGroup": "< taskGroupName | productName | taskGroupId >",
    "spatialRelation": "< ANY_RELATION_TO | INTERSECTS | INTERSECTS_INTERIOR | CONTAINS | WITHIN | ARE_IDENTICAL_TO | HAVE_THEIR_CENTER_IN >",
    "jobStatus": "succeeded"
  }
],
"taskGroup": {
	"updateJobName": "<the updated name of the new job that the following properties apply to>",
	"startOn": "<start date>",
	"endOn": "<optional end date>",
	"assignTo": {
		"onCreate": "< empty | [default] | user name | group name >",

		"onFail": "< empty | [default] | user name | group name >"

	}
},
"postJobActions": [
  {
    "action": "createJob",
    "taskGroup": "<taskGroupName> | <productName> | <taskGroupId>",
    "taskGroupVersion": "<taskGroupVersion>",
    "spatialRelation": "< INTERSECTS | HAVE_THEIR_CENTER_IN >",
    "jobStatus": "< executing | succeeded | failed | cancelled | deleted | closed >",
    "waitOnAllJobs": < true | false >
  }
]

Behavior and relationships

  • When creating automated jobs, the server object extension (SOE) searches for the taskGroupName and productName values in the same map service as the parent job to avoid name conflicts across multiple map services managed by the same topographic server geodatabase. For the taskGroupId value, the scope of the search extends to topographic map services.
  • The task group specified must be linked to the same phase as the parent job and their parent project must be active. Acceptable values for assignment of the task group using onCreate and onFail include the following:
    • No value ("")—Uses the active user from the current SOE context who creates the parent job.
    • [default]—Uses the assignedTo field value from the job template.
    • user/group name—Uses the ArcGIS Workflow Manager REST API to determine whether the value represents a user or group. Once validated, the proper parameters are sent to assignStep REST endpoint on the machine.
  • When creating an automated job, the SOE uses the default area of interest (AOI) layer for the new task group job. This AOI is defined using the addTaskGroup or updateTaskGroup endpoint. If no default AOI layer is defined for a task group, the SOE uses the parent job's AOI layer.
  • The following details apply to the dependencies array:
    • spatialRelation values supported:
      • ANY_RELATION_TO
      • INTERSECTS
      • INTERSECTS_INTERIOR
      • CONTAINS
      • WITHIN
      • ARE_IDENTICAL_TO
      • HAVE_THEIR_CENTER_IN
    • Valid jobStatus values for dependencies:
      • succeeded
  • The following details apply to the postJobActions array:
    • spatialRelation values supported:
      • INTERSECTS
      • HAVE_THEIR_CENTER_IN
    • Valid jobStatus values for postJobActions:
      • executing
      • succeeded
      • failed
      • timedout
      • cancelled
      • deleted
      • closed
  • The jobStatus value can also be specified as a numeric status code, for example, 4 for succeeded.

User considerations

  • preProcessing is typically present only on workflow task group product definitions (for example, MGCP and TDS), not on individual map products such as MTM, TM, JOG-A, TPC, ONC, or CTM50.
  • When using dependencies, plan task group names and IDs carefully. taskGroupName and productName are resolved in the parent job's map service, while taskGroupId is resolved across topographic map services—use the more specific identifier when name collisions are possible.
  • postJobActions create new jobs automatically. Set waitOnAllJobs to true when the parent should wait for the configured set of child jobs to complete; otherwise the parent proceeds as soon as a single child reaches the target status.
  • Assignment behavior (onCreate, onFail) follows the rules listed in the note above; an empty string falls back to the active SOE user, while [default] defers to the job template.

Example

The following example defines a CreateProductionTaskGroup operation (operation type 23) that depends on a TDS task group job that succeeded for an intersecting AOI, sets the new task group's name and assignment, and creates a follow-on MGCP publishing job once the new task group succeeds:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
"preProcessing": {
  "name": "CreateProductionTaskGroup",
  "type": 23,
  "id": "F9C7C3B2-9D9F-4D9F-9C7C-3B29D9F4D9F0",
  "description": "Create MGCP production task group",
  "validation": 1,
  "jobTemplateId": "MGCP_TaskGroup_Template",
  "dependencies": [
    {
      "taskGroup": "TDS Publish Data Workflow Task",
      "spatialRelation": "INTERSECTS",
      "jobStatus": "succeeded"
    }
  ],
  "taskGroup": {
    "updateJobName": "MGCP_50K_[SheetID]",
    "startOn": "2026-05-01T00:00:00Z",
    "endOn": "2026-05-15T00:00:00Z",
    "assignTo": {
      "onCreate": "MGCP Editors",
      "onFail": "[default]"
    }
  },
  "postJobActions": [
    {
      "action": "createJob",
      "taskGroup": "MGCP Publish Data Workflow Task",
      "spatialRelation": "INTERSECTS",
      "jobStatus": "succeeded",
      "waitOnAllJobs": true
    }
  ]
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.