Skip To Content

Job view

Available with Workflow Manager license.

The job view provides access to the information associated with a job and gives you the ability to interact with the job. When the job view is active, the Job tab shows commands specific to a job. The job view, by default, displays the workflow of the job. The name of the job is displayed as the job view name.

Job view

In this view you can do the following:

  • View and execute the job's workflow.
  • View and modify the job's properties.
  • View the job's history.
  • View extended properties associated with the job.
  • Add job holds and dependencies.
  • View, add, or modify attachments.
  • Clone the current job.

Job summary and status

The job summary provides concise information about the active job.

Job summary

The information displayed in the job summary is described below:

  • Job Type—Template the active job is based on
  • Job ID—The unique ID of the active job
  • Assigned to—The user or group the active job is assigned to, or if the job is unassigned
  • Created By—The user or group who created the job, along with the date and time of job creation
  • Days Active—The number of days the job has been active
  • LOI Defined/Not Defined—Indicates whether the location of interest (LOI) has been defined for the active job
  • Job Notes—Opens text area to add notes including pasting an entire document in the active job. It is accessible to all users

Add job notes

Job notes is an open text area that allows you to document simple notes about a job; for example, different resolution methods attempted to correct issues in the data or instructions for how to complete a job.

  1. Click Job Notes in the job view.

    The Job Notes dialog box appears.

    Job Notes
  2. Enter the desired information.
  3. Click OK.

Note:

This functionality is controlled through privileges. If you are unable to interact with job notes, consult your ArcGIS Workflow Manager for Desktop administrator. Job notes cannot be added in offline jobs.

The status bar at the bottom displays the status of the job, the percentage of completion of the job, and the current step or steps of the job's workflow.

Job status

Workflow execution

A workflow is executed using the workflow execution tools available on the Job tab, in the Workflow group, and in the context menu available on the workflow image.

Job view ribbon buttons

A workflow can be executed only by the user to whom the job is assigned. An unassigned job's workflow cannot be executed, and similarly, a job assigned to a user group cannot be executed until it is assigned to an individual user. The workflow of a job that has holds on it cannot be executed until the holds are released. A workflow may be executed using Execute Step and Mark Step Complete on the Job tab or the context menu on the workflow image. In the workflow, the current step is highlighted with the symbology the administrator has specified. The current step can be changed in the workflow image using the context menu on the workflow image.

Workflow context menu

As the workflow progresses, the steps are displayed with a shadow to indicate they have been executed, marked as complete, or skipped. When a step is set as current step, the succeeding steps that were executed or marked as complete are displayed with the shadow; steps that were skipped are not displayed with the shadow; and all the preceding steps are considered complete and displayed with shadow.

Executed step shadows

Execute Step option

In the case of an automated step, this marks the step as started and executes the step logic associated with the step. In the case of a procedural step, it marks the step as started. If the step being executed is configured to move to the next step after execution, the current step is marked as complete, and the workflow moves to the next step after the current step is executed for both automated and procedural steps.

Mark Step Complete option

If a procedural step is not configured to move to the next step after execution, it needs to be manually marked as complete using this functionality. If a step is configured so it can be skipped, the step can be marked as complete without first executing the step.

Set as Current Step option

A step can be executed or marked as complete only if it is the current step. A step is set as current and highlighted when the workflow is being executed and the previous step has been configured to proceed to the next step. If a step other than the current step needs to be executed or marked as complete, it can be accomplished by specifying the step as current using the option on the workflow context menu.

Suspend execution of a step

Step execution may be suspended for some steps, when work is performed over a long time with a period of inactivity in between. The data editing steps configured with the Launch ArcMap step template may be suspended when the step is not configured to proceed to the next step automatically. This option gives you the ability to execute the step again after the step is suspended, when work is stopped and the job map is closed. The Launch ArcMap step can be suspended from both the job view and the map view using the Suspend Step option when the step execution is in progress. In the job view, the step execution progress is displayed when the Launch ArcMap step is executed. In the map view, the Suspend Step option is presented when you try to close the job map while the step is executing and is configured not to proceed to the next step automatically.

Workflow step help

Step help provides more descriptive information on the steps in your workflow. The information provided in step help can be used to describe the step or provide instructions on how to complete the step. The step help is displayed in a pop-up similar to the one shown below and can be configured to display content from a web URL or HTML text defined on the step type.

Step help

  1. Right-click a step to open its context menu.

    The context menu appears. Open Step Help is enabled if step help is configured for that step. Step help in the context menu

  2. Click Open Step Help.

    The step help pop-up appears. It can be resized and moved around the workflow canvas or to an alternate monitor if desired.

Workflow step and path information

The workflow steps and path display adornments to indicate information such as the type of automated step, type of notification and path assignment. The notification adornment Sends Notification Email displays the name of the notification type configured to be sent after the step is completed when hovered over. The path assignment adornment Path Assigned To User Or Group displays the name of the user or group to whom the job is going to get assigned when hovered over. The following step type adornments are displayed for various automated steps:

  • Launch Map and Open Map Launch ArcMap and Open Map
  • Check AOI and Define AOI Check AOI and Define AOI
  • Question Step Question Step
  • Launch GP tool and Execute GP tool Launch GP Tool and Execute GP Tool
  • Execute workflow Execute Workflow
  • Launch URL and Execute URL Launch URL and Execute URL
  • Launch Executable Launch Executable
  • Open file and all other automated steps Automated Step

The workflow steps and path adornment display is based on the Display step and path adornments setting configured on the workflow. This setting is defined in the workflow profile within Workflow Manager Administrator, however once applied, this setting is consumed by ArcGIS Pro.

Descriptive Information properties

The Descriptive Information panel contains many editable job attributes, such as job name, assignment, start and due dates, priority, description, and spatial data. It can be accessed from the job view.

Descriptive Information panel

The edits can be saved or discarded using the buttons to the lower right of the descriptive information in the job view. To save edits, click Apply. To undo the edits, click Revert.

Note:

The ability to modify the Descriptive Information properties is controlled by privileges. If you are unable to edit the properties, consult with a Workflow Manager administrator in your organization.

Modify Job Details properties

Job name, job assignment, job owner, job priority, parent job, and description constitute the job details and are editable properties.

  1. Type a name in the Job Name text box to modify the name of the job.
  2. Assign the job using the Assignment drop-down arrow. Jobs can be assigned to either a user or a group stored in the WMX repository.
  3. Choose a job owner from the Job Owner drop-down list.
  4. Choose a priority from the Priority drop-down list to change the urgency of the job.
  5. Click the browse button (...) next to the Parent Job to choose another job as a parent for this job.
    Select Parent Job
    • Click None to remove an already selected parent job if necessary.
    • Click By Job ID and specify the ID of the job to be set as the parent job.
    • Click From Job List and select a job from the list to be set as the parent job.

    The current job will become a child of the chosen parent job.

  6. Type a detailed description in the Description text box to add more information about the job for reference.
  7. Click Apply to save the changes.

Modify Dates properties

The Dates section lists the project dates associated with the job. The scheduled dates represent the target project dates, while the actual start and completion dates represent the dates the job started and completed once the job is executed. All dates are editable properties on the Descriptive Information tab.

  1. Click the Date control next to any of the date fields to set the appropriate date.
  2. Click Apply to save the changes.

Modify Spatial Data properties

The Spatial Data section lists the data workspace from which spatial data for the job will be retrieved, as well as the active version of that data for the job and the parent version of the job version. The parent version is the parent for the job version. Any version can serve as a parent version, including the default or any other version that is appropriate for the organization. The job version is a child of the parent version. Spatial edits for a job are done in the job version. You can select any existing version from the Manage Version dialog box or choose to create a public version. These are all editable properties.

  1. Click the browse button (...) next to Data Workspace to display a list of data workspaces configured in the system.
  2. Choose the workspace from the list on the Select Workspace dialog box and click OK.

    The default version designated for this geodatabase is automatically displayed.

  3. Click the browse button (...) next to Parent Version to choose the target parent version of the data for this job.

    The Select Version dialog box appears with a list of versions. They can be filtered by name and owner of the version.

    Select Version

    Note:

    For a feature service data workspace, the parent version can only be sde.Default and the browse button is disabled.

  4. Choose a version.
  5. Click OK.
  6. Click the browse button (...) next to Version.

    The Manage Version dialog box appears.

    Manage Version
  7. Choose an existing version on the Manage Version dialog box and click OK.

    The job version is selected. The parent version is updated based on the selected version. If the selected version is from a feature service, the parent version is not applied.

  8. You can also create a new job version from the parent version selected in step 4.
    1. Click Create.

      The Create New Version dialog box appears. The name of the version is based on the naming scheme defined in the job template.

      Create New Version

      Note:

      If a job's spatial data comes from a feature service data workspace, a branch version can be created as the job version.

    2. Specify the name of the job version.
    3. Click OK.
Note:

For more information about versioning, see Overview of versioning.

Job history

The History panel on the job view contains a log of all activities that happen throughout the life of the job. Each of the items in the log is time stamped with the time the activity takes place and the current user accessing the job at that time. A message is also stored along with the record, explaining what happened at that point in time.

Job history

Each record is based on an activity type. Using the Workflow Manager Administrator, the message stored with this activity can be customized using an activity type to meet the business needs of your solution; once applied, this message is consumed by ArcGIS Pro. This categorization, and that these records are stored in an unversioned geodatabase table, allows for easy extraction of metrics for reporting, such as the amount of time taken to perform a step.

When the History panel is opened, the records are sorted chronologically by default; however, the table columns may be sorted as required. Clicking any of the column headers sorts the data using the column as the key. Clicking again reverses the sorting order.

Enter a comment

You can add text to the history log of a job by typing text as comments, if required. These comments will be tagged with user information and a time stamp, similar to other history records, for auditing purposes.

  1. Type the information you want added to the job record in the Enter Comment text box at the top of the History panel.
  2. Click Add to add the comment to the history.

    The comment is added as the most recent logged activity in the history, along with the user information and time stamp.

  3. Note:

    Adding a comment to the history cannot be undone.

Extended properties

Extended properties are custom properties that enable you to store business-specific properties as required. These properties are configured by job type as it is likely that different types of work will require different properties associated with them. The custom extended properties are displayed on the job view with Extended Properties as the title by default. This may appear by another name, depending on the job type configuration. You can view and update (where applicable) the 1-1 properties here. The 1-1 properties have only one record for each job in the extended property table.

Note:

To be able to edit extended properties, you must have the ManageExtendedProperties privilege.

The extended properties are stored in a geodatabase table within the Workflow Manager database. The fields can be configured in the following ways, on each job type:

  • Set field as visible and editable—The field is displayed and editable on the Extended Properties panel.
  • Set field as visible only—The field is displayed but not editable.
  • Set default value—The default value that is populated when a job is created.

Extended property view types

Several fields such as job ID and object ID are read-only and cannot be edited. The required fields are indicated by a dark red outline.

Extended required field

For more information to configure extended properties, see Extended properties in the 10.x help.

The data you can enter for the extended property fields is restricted based on the field type configured to ensure correct data is entered. Within the Extended Properties panel you can further choose a display type to store specific information.

Extended property types

The display types available in Workflow Manager are as follows:

  • Text—Presents the user with a text box.
  • Date—Allows the user to enter a date value by using a date picker in a calendar.
  • File—Allows the user to browse to a file and the path of the file is stored.
  • Folder—Allows the user to browse to a folder and the path of the folder is stored.
  • Geographic dataset—Allows the user to browse to a geodataset type and store the path. Supported types include the following:
    • File geodatabase, including datasets, feature layers, and annotation feature classes.
    • Enterprise geodatabase—Datasets, feature layers, and annotation feature classes. The enterprise geodatabase must be added to the project and appear in the Databases folder in the Catalog pane of the project to be accessible as an extended property.
    • Shapefiles.
    • Layers (all types).
    • Domain—Allows the user to select the field value from a list of domains configured on the source table.
    • Tables (all types from either a geodatabase or a folder).
    • Rasters (from either a geodatabase or a folder).
    • LAS datasets.
  • TableList—Allows the user to select the field value from a list of values (similar to a domain). The list of values comes from another table that you configure.
  • Multi-level Table List—Allows the user to select a field value from a list of values that further filters the values to be displayed and selected in the next field.

The display types available while configuring extended properties are dependent on the data type of the field in the source table. If the property is the Date data type, for example, the only display type available is date, and you can enter it manually or use the date picker. If the property is of a String data type, you can display it as a text, file, folder, geographic dataset, table list, or a multilevel table list. Text length is restricted to the characters allowed by the length of the field in the table. All other data types can only be displayed as text, a table list, or a multilevel table list.

After editing the properties on the Extended Properties panel, click Apply on the bottom of the tab and store the changes. If you are not satisfied with the edits, click Revert and revert all the properties to the values they had before editing.

You may also set up your workflows to include the Edit Extended Properties step for updating extended properties as part of a job's workflow. For more information about editing and updating extended properties using a workflow step, see Step templates.

Holds

The job holds and dependencies are managed in theHolds panel.

Job Holds

Hold

A hold suspends the job activity for an indefinite amount of time until it is released. Holds are categorized by reasons to suspend a job. The hold type is based on the Hold Types templates defined in Workflow Manager Administrator; however, once applied, they are consumed by ArcGIS Pro. Examples of job hold types could include the following:

  • Insufficient funding
  • Technical problems
  • Missing data
  • Lack of resources
  • Management approval

The job hold stores the following information:

  • Hold type—Reason for suspending the job activity.
  • Hold status—Whether the hold is active or has been released.
  • Date—When the hold is added and released.
  • Comment—Additional information provided when adding and releasing a hold. Comments added while releasing the hold will overwrite comments, if any, that were provided when the hold was added.

Note:

To be able to add holds for jobs, you must have the ManageHolds privilege. Job holds can be overridden if you have the following privileges:

  • UpdatePropsforHeldJobs—Edit job properties and extended properties.
  • CanAddAttachmentsforHeldJobs—Add attachments.
  • CanAddCommentsforHeldJobs—Add comments in the job history.

Jobs can be taken offline regardless of job holds. If the job is taken offline, you can only view job holds and cannot add or release holds. If the job is closed, you cannot add holds to the job. One job can have multiple holds and will become active again when all of the holds are released.

Add a hold with existing type to a job

  1. On the Holds tab, click Hold.
  2. Select a hold type from the preconfigured Type drop down list.
  3. If needed, type a comment.

    Providing a comment is optional when adding the hold.

  4. Click Add.

The hold is added to the job and is visible in the grid on the left side of the panel. The information about the hold type, date, and comments are also visible in the grid. The hold status is Active.

Add a hold with new type to a job

  1. On the Holds tab, click Hold.
  2. Type a name for the new hold type.

    Typing in a hold type will store the new type in the Workflow Manager database and will be available in the hold Type drop-down list.

  3. If needed, type a comment.
  4. Click Add.

The hold is added to the job and is visible in the grid on the left side of the panel. The information about the hold type, date and comment are also visible in the grid. The hold status is Active.

Release a hold

  1. On the Holds tab, expand the hold to be released.
  2. If needed, enter the hold release comment and click Release.

The hold status is Released. The Date Released and hold Comment are updated with correct information.

Note:

If a release comment is not provided, the comment provided while adding a hold is removed from Comment.

View a job hold

  1. Click Holds in Job View.

    All Active and Released holds for the job are displayed.

  2. Expand a hold in the grid to release the hold or see the comment provided when the hold was added.

Dependency

Job dependency is managed in Holds tab and can halt the execution of the job in a similar way as a job Hold. The primary difference between a job hold, which suspends all job actions, and dependency is the fact that only job execution is suspended and the job properties can still be edited while the job has an active dependency. You can define a dependency on a job to hold the execution of the current step. When the other job that the current job is dependent on reaches the status defined in the dependency, the dependency is automatically released, and the current step of the dependent job can be executed.

The job dependency is displayed with the following information:

  • Hold type—Dependency
  • Hold comment—The current job and the dependent job
  • Expand the dependency in the hold grid to see more details:
    • Held Job—The job on hold at its current step.
    • Held on Step—The current step of the held job, which cannot be executed until the dependency is released.
    • Depends on Job—The other job upon whose status the held job is dependent.
    • Depends on Status—The status of other job on which the held job is dependent. Once this status is reached, the job dependency of the held job is automatically removed.

The dependency is visible in the hold grid of both the held job and dependent job. If the job is taken offline, you can view the dependencies but cannot add or delete dependencies.

Note:

To add and delete job dependencies, you must have the ManageDependency privilege.

Add a job dependency

  1. On the Holds tab, click Dependency.
  2. Enter the ID of the job that current job will be dependent on in Job ID.
  3. Select the Status of the other job that the current job will depend on.

The execution of the current step is on hold. The dependency is added in the job hold grid. Dependency is displayed as the type of hold on the job. The comment describes that the current job is dependent on the other job.

Manage attachments

Attachments can be added to a job to provide additional background or support information to other people while working on a job. Once added as attachments, these resources can become available from all entry points of Workflow Manager (in the application or on the web), depending on the type of attachment used. Anyone with the ManageAttachment privilege can add or remove job attachments, as long as the job is assigned to you or you are the job owner. If the job is held, you can still add attachments if you have the CanAddAttachesForHeldJobs privilege. There are no restrictions on the types of files that can be added to a job, but attachments can't be added if the job is offline or closed. Some examples of attachments include:

  • Work instructions
  • Job proposals
  • Scanned support material, like paper maps
  • TIFFs for georeferencing
  • Python scripts
  • A URL to an intranet site

There are three types of job attachments that can be added to a Workflow Manager job.

  • Embedded file—This option stores the file directly inside the Workflow Manager database. This is a versatile option if you want a file to be accessible from all locations via Workflow Manager. However, storing files directly in the database can increase the database size pretty quickly, and it is advised that you first contact your database administrator to find out the file size limit (maxblobsize) for your database to see if this is the right option for you.
  • Linked file—This option stores a link to a file. This saves disk space, but to be effective the file must be stored in a location that is easily accessible or on a shared file system.
  • URL—Stores a web URL in the database. This option is useful when referencing external information such as online software help.

The attachments can be added from the Job tab and Job Attachments pane. They can be managed from the Job Attachments pane. The attachments can be filtered in the Job Attachments pane in the Search box.

Note:

If the current user with appropriate privileges does not have access to the linked file and attempts to open or download the file, an option to browse to the file and repair the link will be displayed.

Add an attachment to a job

Add a new attachment to a job so that it is accessible to all users of the job.

  1. On the Job tab, in the Manage group, click Attachments, and click New Attachment.
    Add new attachment
  2. On the dialog box that appears, select the type of job attachment to be added.

    Embedded File

    Stores the file in the database

    Linked File

    Stores a link to the file location

    URL

    Stores a web URL

  3. Click the browse button and select the file to attach. For a URL, type the web address in the space provided and click OK.

The added attachment is listed under Attachments.

Add a job attachment through the Job Attachments pane

  1. On the Job tab, in the Manage group, click Attachments, and click Manage Attachments.

    The Job Attachments pane opens.

    Job Attachment pane
  2. Click Attachments.
  3. On the dialog box that appears, select the type of job attachment to be added.

    Embedded File

    Stores the file in the database

    Linked File

    Stores a link to the file location

    URL

    Stores a web URL

  4. Click the browse button and select the file to attach. For a URL, type the web address in the space provided and click OK.

The added attachment is listed in the Job Attachments pane.

Open a job attachment through the Job tab

  1. Click the browse button and select the file to attach. For a URL, type the web address in the space provided and click Ok.
  2. On the Job tab, in the Manage group, click Attachments.

    A list of job attachments is displayed in a menu.

    Attachments menu
  3. Click the name of the attachment to be opened.
  • An embedded file will open using the default program for the extension on the system.
  • A linked file will open using the default program for the extension on the system, if the user has access to the link location of the file.
  • A web URL will open in the default browser.

Open a job attachment through the Job Attachments pane

  1. On the Job tab, in the Manage group, click Attachments, and click Manage Attachments.

    The Job Attachments pane opens.

    Job Attachment pane
  2. Double-click the name of the attachment to be opened.
  • An embedded file will open using the default program for the extension on the system.
  • A linked file will open using the default program for the extension on the system, if the user has access to the link location of the file.
  • A web URL will open in the default browser.

Download a job attachment

An embedded file and linked file can be downloaded to a disk location. A linked file would be downloaded only if the link location is accessible to the user.

  1. On the Job tab, in the Manage group, click Attachments, and click Manage Attachments.

    The Job Attachments pane opens.

  2. Hover over the attachment to be downloaded and click Download Download.
  3. On the Save As dialog box, browse to the location to save the downloaded attachment.
  4. Click Save.

The file is downloaded to the specified location.

Delete a job attachment

  1. On the Job tab, in the Manage group, click Attachments, and click Manage Attachments.

    The Job Attachments pane opens.

  2. Hover over the attachment to be deleted and click Delete Delete.

The job attachment is deleted.

Clone Job

Clicking the Clone Job button creates a new job by cloning the current active job. The cloned job will have the same properties as the job such as: assigned to, parent job, data workspace, parent version, LOI, attachments, and extended properties.

Clone Job button

If LOI overlapping is set to Disallow or Disallow by Job Type, the newly cloned job will be created in one of the following ways:

  • If the cloned job is created from an open job, the newly cloned job will be created without an LOI.
  • If the cloned job is created from a closed job, the newly cloned job will be created with the same LOI as the closed job.
  • If the cloned job is created from a closed job, and you have the AOIOverlapOverride privilege, and the closed job's LOI overlaps with the LOI of an open job's LOI, a warning message will appear when a new job is created.
    LOI Warning
  • You can choose whether to copy the closed job's LOI or not.

Once the cloned job is created, its job view will open. Closed jobs can be cloned as well. This is particularly useful for creating copies of closed jobs that are used repeatedly.