Skip To Content

Update Job Properties

The Update Job Properties step allows the person running a job to update extended properties and the following job properties:

  • job_name
  • start_date
  • due_date
  • priority_rank
  • description
  • owned_by
  • job_status
  • notes
  • parent_job

When the step is run, the properties configured in the step appear in the job tile. If help text is configured for the step, it appears at the bottom of the job tile. Default or current values appear in a text box below each property that can be updated.

If a property contains an invalid value or a required property doesn't contain a value, the property is highlighted in red and the Proceed button is unavailable.


If a property is automatically updated and encounters an error, the step fails and an error appears in the job tile. The error is also written to the ArcGIS Server logs.

When you run the step, you can perform the following actions:

  • Click Cancel to cancel the step.
  • Click Proceed to finish the step.

Configure the step

Complete these steps to configure the Update Job Properties step:

  1. Create or edit a workflow diagram to access the Step Library panel.
  2. Drag Update Job Properties from the Step Library to a connection arrow of a step on the workflow canvas.

    The Step Details panel appears.

  3. Provide a name for the step in the Step Name text box.
  4. Optionally, add the message you want to appear when the step is run in the User Prompt text box.
  5. In the Arguments section, type the table name and field name of the property you want to be updated in the Job Property text box using the following syntax:

    The table name for job properties is jobs. The table names of extended properties tables can be found on the job template's Extended Properties tab.

  6. Optionally, click the Show default value button Show Default Value to define the default value and visibility settings for the property when the step is run.
    1. Choose one of the following options:
      • Value—Provide a static value.
      • Arcade Expression—Provide a dynamic value using an Arcade expression.
    2. Provide a default value for the property in the Value or Arcade Expression text box.
    3. Check the Visible check box to allow the value to be changed when the step is run.

    If a default value is not provided and the Visible check box is not checked, the current value for the job property is deleted when the step is run.

  7. Optionally, click Add New Job Property and repeat steps 5 through 6 to add additional properties.

    To delete a job property, hover over it and click the Delete Property button Delete Property.

  8. Optionally, reorder the properties.
    1. Hover over a property.
    2. Click the Reorder Property button Reorder Property and drag it to the desired location.
  9. Click the Options tab.
  10. Configure Step Options as necessary.
    • Manual—Run the step manually.
      • Optional—Allow the step to be finished without being run.
    • Automatic—Run the step as soon as it becomes active.
    • Run on a Schedule—Run the step according to a schedule you set.

      Learn more about scheduling options

  11. Optionally, provide help text for the step in the Step Help text box.
  12. Optionally, click the Style tab to change the shape and color of the step.
  13. Optionally, click the About tab and provide a description for the step in the Step Description text box.

    The About tab also contains the step's ID that can be used with dynamic job properties to obtain a step's output.

Return codes

When the step finishes running, it sends a return code to indicate the result of the step. The return code is evaluated, and the workflow follows all paths that match the step's return value. The following table lists the step's return codes:

Return codeDescription


The step failed to complete successfully.


The step completed successfully.

Step output

When the step finishes running, its output is stored and can be used to determine the path the workflow follows or be used as inputs for other steps throughout the workflow. The following table lists the step's stored outputs:



The step failed to complete successfully.


The step completed successfully.

Verwandte Themen