The Send Email step sends an email notification to one or more recipients when the step is run. This step type can be used to notify users when a step or job has been completed or when a step didn't complete successfully.
Note:
You must configure email settings for ArcGIS Workflow Manager before the Send Email step can be used to send email notifications.
Step configuration
To configure the step, do the following:
- Create or edit a workflow diagram to access the Step Library panel.
- Drag Send Email 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.
- Type email addresses separated by a semicolon in the To, CC, and BCC text boxes as necessary, or use an ArcGIS Arcade expression to create a dynamic list of recipients.
One email address
Multiple email addresses
[email protected];[email protected];[email protected];[email protected]
Email addresses and Arcade expressions
[email protected];"arcadeExpression()";[email protected];"arcadeExpression()"
One Arcade expression
"arcadeExpression()"
Multiple Arcade expressions
"arcadeExpression()";"arcadeExpression()";"arcadeExpression()";"arcadeExpression()"
Arcade expressions and email addresses
"arcadeExpression()";[email protected];"arcadeExpression()";[email protected]
Note:
At least one valid email address or Arcade expression must be provided in the To, CC, or BCC text box.
- Type a subject for the email notification in the Subject text box.
You can also use ArcGIS Arcade expressions to provide a dynamic value for the subject. For example, jobName($job)+' is ready'.
- Type the message text for the email notification in the Body text box.
You can also use the following example to provide a dynamic value for the body using Arcade expressions:
'<b>'+jobName($job)+'</b>, created by <b>'+jobCreator($job)+'</b>, was closed on <b>'+Text(Date(jobEndDate($job)), 'dddd, MMMM D, Y')+'</b>.'Note:
You must enable the HTML Notification option to use HTML tags in the email body field.
- Optionally, if your jobs include attachments, you can choose to include job attachments in the email notification using the following options under Include Attachments:
- None—Don't include job attachments in the email notification.
- All—Include all job attachment folders in the email notification.
- By Folder—Type a comma separated list of folder names in the By Folder text box to specify the job attachment folders to include in the email notification.
Note:
If a job contains multiple attachments, they are sent as a single ZIP file and attachment folder structure is maintained.
- Optionally, type a job ID in the Preview Email text box and click Preview to preview the email.
Note:
If the email contains an Arcade expression for the output value of a step, the step must be completed before you can preview the output value.
- 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 the additional automated steps without manual intervention.
- Run on a Schedule—Run the step according to a schedule you set.
- Manual—Run the step manually.
- 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) + '.' - 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.
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. |