Skip to main content

Create and manage user-defined settings

Available with Workflow Manager license.

User-defined settings provide a secure way for workflow item administrators to store information, such as credentials for a web request or commonly used file paths. Stored settings are available in your workflows as dynamic job properties.

You can use encrypted user-defined settings only in the items that the following table contains:

Item Where supported
Webhook job creation Username, Password, Fallback Username, and Fallback Password; Header Name, Value, and Secret
Send Web Request step or web request template Authorization tab, Body tab
Reconcile and Post step Run as different user credentials

Add user-defined settings

To add user-defined settings, do the following:

  1. Access the Workflow Manager web app.

  2. Click the Design tab.

    The Design page appears.

    Note:

    If you don't have sufficient privileges, the Design tab is not available.

  3. Click Settings .

    Note:

    If you don't have sufficient privileges, Settings is not available.

  4. Click the User Defined Settings tab.

  5. Click Add Setting.

  6. Provide a name for the setting in the Name text box.

  7. Provide a value for the setting in the Value text box.

  8. Optionally, check the Encrypt check box to encrypt the stored value.

    Note:

    If you are transitioning from a federated Workflow Manager Server site to workflow management services in ArcGIS Enterprise on Kubernetes and have encrypted user-defined settings, the values are blank after the transition and must be updated in each workflow item.

  9. Repeat steps 5 through 8 to add more settings.

  10. Click Save to save the settings.

Edit user-defined settings

To edit user-defined settings, do the following:

  1. Access the Workflow Manager web app.

  2. Click the Design tab.

    The Design page appears.

    Note:

    If you don't have sufficient privileges, the Design tab is not available.

  3. Click Settings .

    Note:

    If you don't have sufficient privileges, Settings is not available.

  4. Click the User Defined Settings tab.

  5. Update the settings as necessary.

  6. Click Save to save the changes.

Delete user-defined settings

Deleting a user-defined setting is permanent and can't be undone. To delete user-defined settings, do the following:

  1. Access the Workflow Manager web app.

  2. Click the Design tab.

    The Design page appears.

    Note:

    If you don't have sufficient privileges, the Design tab is not available.

  3. Click Settings .

    Note:

    If you don't have sufficient privileges, Settings is not available.

  4. Click the User Defined Settings tab.

  5. Hover over the setting you want to delete and click Delete Setting .

    The Delete User Setting dialog box appears.

    Caution:

    Deleted user settings can't be recovered.

  6. Click Yes to delete the setting or click No to cancel.