You can create email templates and associate them with a job activity to automatically send email notifications when the specified action is performed in the job.
Note:
You may need to modify custom roles to retrieve ArcGIS Enterprise portal member's email addresses with an ArcGIS Arcade expression.
Create email templates
Complete the following steps to create email templates:
- Access the Workflow Manager web app.
- Click the Design tab.
The Design page appears.
Note:
If you don't have sufficient privileges, the Design tab is not available.
- Click Templates
.Note:
If you don’t have sufficient privileges, Templates
is not available. - Click the Email Templates tab.
The Email Templates panel appears.
- Click Create New in the Email Templates panel.
- Provide a name for the email template in the Template Name text box.
- Provide email addresses separated by a semicolon in the To, CC, and BCC text boxes as necessary, or use an Arcade expression to create a dynamic list of recipients.
At least one valid email address or Arcade expression must be provided in the To, CC, or BCC text box.
Tip:
Use the $newAssignee variable with the Assign Job automated action to automatically send an email notification to the new user assigned to the step. Email notifications will not be sent if the job has not been reassigned.
One email address
user1@test.com
Multiple email addresses
user1@test.com;user2@test.com;user3@test.com;user4@test.com
One Arcade expression
"GetUser($CurrentPortal, $newAssignee)['Email']"
Multiple Arcade expressions
"GetUser($CurrentPortal, JobOwner($Job))['Email']";"GetUser($CurrentPortal, $newAssignee)['Email']";"GetUser($CurrentPortal, LastRunner($Job, 'f50d740d-cc04-9296-4ce3-181e82604465'))['Email']"
Email addresses and Arcade expressions
user1@test.com;"GetUser($CurrentPortal, JobOwner($Job))['Email']";user3@test.com;"GetUser($CurrentPortal, $newAssignee)['Email']"
Tip:
Click This input supports Arcade Expressions
and choose an Arcade expression to add it to its associated text box. - Provide 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. If the subject contains plain text and Arcade expressions, format the text as follows:
JobName($Job) + 'is ready' - Provide the message text for the email notification in the Body text box.
You can also use ArcGIS Arcade expressions to provide a dynamic value for the body. If the body contains plain text and Arcade expressions, format the text as follows:
'<b>' + JobName($Job) + '</b>, created by <b>' + JobCreator($Job) + '</b>, was started on <b>' + Text(Date(JobStartDate($Job)), 'dddd, MMMM D, Y') + '</b>.'Note:
You must enable the HTML Notification option to use HTML tags in the Body text box.
- Optionally, include attachments in your email notification using the options under Include Attachments:
Note:
If a job contains multiple attachments, they are sent as a single .zip file and the job's attachment folder structure is maintained.
- None—Don't include job attachments in the email notification.
- All—Include all job attachment folders in the email notification.
- By Folder—Provide a comma-separated list of job attachment folder names in the By Folder text box to specify the job attachment folders to include in the email notification.
Note:
Job attachment folders are contained in the workflow item and are not file system paths.
- Optionally, click Preview email to preview the email.
Note:
If the email contains a job-specific Arcade expression, you must provide a valid job ID in the Preview Email text box before you can preview the Arcade expression. 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.
The Email Preview window appears with a list of recipients and a preview of the subject and body.
- Click Save to save the email template.
Edit email templates
Complete the following steps to edit email templates:
- Access the Workflow Manager web app.
- Click the Design tab.
The Design page appears.
Note:
If you don't have sufficient privileges, the Design tab is not available.
- Click Templates .
Note:
If you don’t have sufficient privileges, Templates
is not available. - Click the Email Templates tab.
The Email Templates panel appears.
- Click the name of the email template you want to edit in the Email Templates panel.
Tip:
You can filter the list of email templates in the Email Templates panel by providing a search term in the Search Email Templates text box.
- Update the email template as necessary.
- Optionally, click Preview email to preview the email.
Note:
If the email contains a job-specific Arcade expression, you must provide a valid job ID in the Preview Email text box before you can preview the Arcade expression. 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.
The Email Preview window appears with a list of recipients and a preview of the subject and body.
- Click Save to save the changes.
Delete email templates
Deleting an email template is permanent and can’t be undone. Complete the following steps to delete an email template:
- Access the Workflow Manager web app.
- Click the Design tab.
The Design page appears.
Note:
If you don't have sufficient privileges, the Design tab is not available.
- Click Templates .
Note:
If you don’t have sufficient privileges, Templates
is not available. - Click the Email Templates tab.
The Email Templates panel appears.
- Click the name of the email template you want to delete in the Email Templates panel.
Tip:
You can filter the list of email templates in the Email Templates panel by providing a search term in the Search Email Templates text box.
- Click the More Actions button
and click Delete.A confirmation message appears.
- Click Yes to delete the email template or click No to cancel.