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 attach accepted file types to the job. 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 associate a URL, file path, or text with the job. For URL attachments, only HTTP and HTTPS URL formats are supported.
If the step is configured with step help, 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. Clicking a URL attachment opens the URL Redirect dialog box with options to proceed to the URL or cancel. To dismiss the URL Redirect dialog box, check the Do not show this warning again check box.
- Click Delete Attachment
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 
.
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 Delete Attachment 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
Do the following to configure the step:
- Create or edit a workflow diagram to access the Step Library panel.
- Drag Add Attachment from the Step Library panel to a connection arrow of a step on the workflow canvas.
The Step Details panel appears.
- Provide a name for the step in the Step Name text box.
- 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 Arcade expressions, format the text as follows:
'This job is currently assigned to ' + JobOwner($Job) + '.'Tip:
Click This input supports Arcade Expressions
and choose an ArcGIS Arcade expression to add it to its associated text box. - Optionally, provide the name of the folder in which attachments will be stored in the Folder Name 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.
- Optionally, allow files to be attached to jobs.
- 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.
- 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, the types of files that can be attached to the job are limited by your ArcGIS organization configuration.
Learn more about supported file types in an ArcGIS Enterprise portal
- In the Attachment Type section, check the Embedded check box.
- Optionally, allow files to be associated with jobs.
- In the Attachment Type section, check the Linked check box.
- Choose one of the linked file options:
- URL—Associate a URL 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.
- Click the Options tab.
- 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 more automated steps without manual intervention.
- Run on a Schedule—Run the step according to a schedule you set.
- Manual—Run the step manually.
- 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, you must 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 run in the web app only support HTTP and HTTPS URL formats. Steps 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, you must 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:
- 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.
- Optionally, click the Style tab to change the shape and color of the step.
- 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
to copy the step ID to your 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 value | Description |
|---|---|
| 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:
| Output | Description |
|---|---|
| <Attachment ID> | Returns an array of attachment IDs added to the step |