Add and configure Advanced Assignment

The Advanced Assignment step allows you to assign a subsequent step to a user based on the output value of the step. You can also configure the step to automatically assign a user or group to a subsequent step using the job's location. This is done by querying a reference layer that contains a field with a list of users or groups. Once the step is completed, the subsequent step can be automatically assigned to the chosen user or group.

When the step is run, you are prompted to choose to whom a subsequent step is assigned to. If the step is configured with a reference layer, the user or group to whom a subsequent step is assigned is determined automatically.

When the step is run, the following actions can be performed:

  • The step can be finished by clicking Proceed.
  • The step can be canceled by clicking Cancel.
Note:

If the step isn't optional, the step cannot be finished without being run.

Configure the step

To configure the step, do the following:

  1. Create or edit a workflow diagram to access the Step Library panel.
  2. Drag Advanced Assignment from the Step Library panel 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 that you want to appear when the step is run in the User Prompt text box.

    If the user prompt contains plain text and ArcGIS Arcade expressions, format the text as follows:

    'This job is currently assigned to ' + JobOwner($Job) + '.'
    Tip:

    Click This input supports Arcade Expressions This input supports Arcade expressions and choose an Arcade expression to add it to its associated text box.

  5. If you don't want all paths leading out of this step to be assigned to the chosen user or group, uncheck the Automatically Switch Assignment check box and use the output value of this step to change the assignment using a path.

    This may be required if you only want to assign one of the steps to the chosen user or group in a workflow with parallel steps.

    Note:

    When the Automatically Switch Assignment check box is checked, the chosen user or group assignment overrides all path assignments settings leading out of this step.

  6. To configure the step assignment for a group, check the Force Group Assignment check box to ensure that the step is always assigned to the group, even when the user running the step is a member of the group.
  7. Choose one of the following Assignment Method options:
    • User Defined—Manually choose the user to whom a subsequent step is assigned.
    • Spatially—Query a reference layer that contains a field with a list of users or groups using the job's location to determine the user or group to whom a subsequent step is assigned.
  8. If you chose User Defined, choose one of the following:
    • All Users—Allows any user to be assigned to a subsequent step.
    • Group—Click the Group drop-down arrow and choose a group to only allow users in the chosen group to be assigned to the subsequent step.
  9. If you chose Spatially, choose a feature service from the Feature Service drop-down menu.

    The Layer Name and Assignment Field text boxes are automatically populated with the first layer and field by default.

    If you don't have access to the selected feature service, provide the layer ID and assignment field in the Layer ID and Assignment Field text boxes.

  10. If you don't have a feature service associated with your workflow diagram, add a feature service data reference:
    1. Click Add data reference from the drop-down menu.

      The Add data reference dialog box appears.

    2. Add a data reference by doing one of the following:
      • Browse for item—Browse and choose from a list of items on the current portal.
        Tip:

        You can refine results by applying filters and tags to the search.

      • Enter item ID manually—Choose the environment where the data reference is located and provide the item ID and reference name in the Item ID and Reference Name text boxes. If you chose Other, provide the URL to the ArcGIS organization that contains the data reference in the Portal URL text box.

        The item is automatically validated by Workflow Manager and the data reference type is set in the Type bar.

        If the data reference cannot be validated, you must provide the item ID to a valid data reference that matches the set data reference type.

    3. Click OK to save the feature service data reference or click Cancel to exit.

      The feature service appears in the Feature Service drop-down menu with the Layer Name and Assignment Field text boxes automatically populated with the first layer and field by default.

      Learn more about managing data references

  11. Click the Layer Name drop-down arrow and choose the layer that you want to use as the reference layer.
  12. Click the Assignment Field drop-down arrow and choose the field that you want to use to determine the user or group assignment.
    Note:

    The field you choose can only contain users or groups.

  13. Choose one of the following Assignment Field Type options:
    • User—If the Assignment Field contains users.
    • Group—If the Assignment Field contains groups.
  14. Click the Options tab.
  15. 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.
      Note:

      If the workflow diagram is configured to automatically run a sequence of steps that includes the Run GP Service step, steps that attempt to run after the user token expires will not run automatically. The ArcGIS Workflow Manager Advanced organization extension is required to run additional automated steps without manual intervention.

    • Run on a Schedule—Run the step according to a set schedule.

      Learn more about scheduling options

  16. Optionally, choose one of the following options to configure help in the step:
    • None—Configure the step without step help.
    • Text—Configure help text for the step in the Text text box.

      You can use ArcGIS Arcade expressions to provide a dynamic value for the step help. If the step help contains plain text and Arcade expressions, format the text as follows:

      
      'For further assistance, please contact' + JobCreator($Job) + '.'

    • URL—Configure the step with a link to a help resource in the URL text box.
      Note:

      Steps that are run in the web app only support HTTP and HTTPS URL formats. Steps that are run in ArcGIS Pro support HTTP, HTTPS, and file formats.

      You can also use Arcade expressions to provide a dynamic value. If the URL contains plain text and Arcade expressions, format the text as follows:

      
      'https://pro.arcgis.com/en/pro-app/latest/tool-reference/' + JobExtendedProperty($Job, 'tools', 'toolbox') + '/' + jobExtendedProperty($job, 'tools', 'alias') + '.htm'

      Configure the Automatically Encode Arcade Result check box as follows:

      • If an Arcade expression returns special characters that must be escaped when converted to a URL, such as a space or a forward slash, ensure that the Automatically Encode Arcade Result check box is checked.
      • If an Arcade expression is used to form the base URL, uncheck the Automatically Encode Arcade Result check box.

  17. Optionally, click the Style tab to change the shape and color of the step.
  18. Optionally, click the About tab and provide a description for the step in the Step Description text box.
    Tip:

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

Return value

When the step is completed, its return value is stored to indicate the result of the step. The return value can be immediately evaluated using paths to determine the next steps in the workflow. You can also retrieve the return value for completed steps throughout the workflow using ArcGIS Arcade expressions. The following table lists the step's return values:

Return valueDescription

S000001

The step completed successfully.

F000001

The step failed to complete successfully.

Output value

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

OutputDescription

assignment

Returns the username or group ID of the user or group to whom a subsequent step is assigned.

assignmentMethod

Returns UserDefined or Spatial depending on method that was used to assign the user or group.

Related topics