Skip To Content

Add Attachment

The Add Attachment step allows you to add file attachments to a job or associate files with a job. When the step is run, the following buttons appear in the job tile depending on the step's configuration:

  • A Browse button appears in the job tile to allow files to be attached to the job.
    Note:

    If a list of accepted file types is configured for the step, you can only attach allowed file types to the job.

  • A Link button appears in the job tile to allow files to be associated with the job.

If help text is configured for the step, it appears at the bottom of the job tile.

Once a file is uploaded or associated with a job in the Workflow Manager web app, you can do the following:

  • Update the name of the file in the Name text box.
  • Click an action button to view an attachment, download an attachment, or copy an attachment's file path or document ID.
  • Click the Delete Attachment button Delete Attachment to delete the attachment.
Note:

To view a job's attachments in the Details panel in the Workflow Manager web app, click the Attachments tab Attachments.

Learn more about managing job attachments

Once a file is uploaded or associated with a job in ArcGIS Pro, you can do the following:

  • Update the name of the file in the Name text box.
  • Click an action button to view an attachment, open an attachment in your computer's default application, or copy the attachment text or document ID.
  • Click the Delete Attachment button Delete Attachment to delete the attachment.

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

  • Click Pause to pause the step.
    Note:

    If the step is paused, any attachments that were added remain attached to the job and their names can't be updated.

  • Click Proceed to finish the step.
Note:

If the step isn't optional, the step must be run or paused at least once before it can be finished.

Configure the step

Complete these steps to configure the Add Attachment step:

  1. Create or edit a workflow diagram to access the Step Library panel.
  2. Drag Add Attachment 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. Add the message you want to appear when the step is run in the User Prompt text box.
  5. Optionally, provide the name of the folder in which attachments will be stored in the Folder text box.

    The folder name can't contain special characters.

    Note:

    If a folder name isn't provided, a folder named General is automatically created.

  6. Optionally, allow files to be attached to jobs.
    1. In the Attachment Type section, check the Embedded check box.
    2. Provide a comma separated list of file extensions for the types of files that can be attached in the Restrict Input To The Following File Types text box.
      Caution:

      If a list of file extensions is not specified in the Restrict Input To The Following File Types text box, the types of files that can be attached to the job are limited by your ArcGIS Enterprise portal configuration.

      Learn more about supported file types in an ArcGIS Enterprise portal

  7. Optionally, allow files to be associated with jobs.
    1. In the Attachment Type section, check the Linked check box.
    2. Choose one of the linked file options:
      • URL—Associate file URLs with the job
      • File Path—Associate a file path with the job
      • Text—Associate a file or folder path or a document ID with the job
  8. Click the Options tab.
  9. 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

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

    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 code:

Return codeDescription

Success

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:

OutputDescription

F000001

The step failed to complete successfully.

S000001

The step completed successfully.

Related topics