Add and configure 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 show an attachment, download an attachment, or copy an attachment's file path or document ID.
• Click the Delete Attachment button to delete the attachment.

Note:

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

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 show an attachment, open an attachment in your computer's default application, or copy the attachment text or document ID.
• Click the Delete Attachment button to delete the attachment.

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

• The step can be paused by clicking Pause.

  Note:

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

• The step can be finished by clicking Proceed.

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

To configure the step, do the following:

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

   Learn more about adding steps to a workflow diagram

   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.

   You can also use the following example to display a dynamic value using ArcGIS Arcade expressions:

   'This job is currently assigned to ' + jobOwner($job) + '.'

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 a file system path or special characters. If a folder name isn't provided, a folder named General is automatically created.

   Note:

   The folder is contained in the workflow item and is not a file system path.

6. Optionally, allow files to be attached to jobs.
   1. In the Attachment Type section, check the Embedded check box.

      Note:

      The maximum file size of each embedded attachment is determined by your feature layer.

   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.

     Note:

     If your workflow diagram is configured to automatically run a sequence of steps that includes the Evaluate Data Quality or the Run GP Service step, steps that attempt to run after the user token that started the sequence of steps expires will not run automatically. You must have a license for the ArcGIS Workflow Manager Server Advanced role to continue running the additional automated steps without manual intervention.

   • 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.

    You can also use the following example to display a dynamic value using ArcGIS Arcade expressions:

    'For further assistance, please contact ' + jobCreator($job) + '.'

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 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 values	Description
S000001	The step completed successfully.
F000001	The step failed to complete successfully.