You are viewing an earlier version of the admin guide. For the latest version, please visit EmpowerID Admin Guide v7.211.0.0.

Skip to end of banner
Go to start of banner

Localizing Emails

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Localized emails are email templates that you can add to the email messages collection to be sent automatically in response to predetermined policies, such as a password expiration notice, or to meet the needs of a linguistically diverse corporate setting. You can tailor these messages in the EmpowerID web application.

By default, the operations associated with email notifications send the email notifications (Email Message ID 1-21) for their type of operation (Single Resource, Two Resources, and Three Resources). This ensures emails are sent when there is an approval without your developers needing to create new emails for every new operation. However, you do not have to use the default emails, and developers can specify their own custom emails in Workflow Studio for the operation activity in question.

EmpowerID sends automated email notifications to users in a number of scenarios. (For more information, see Configuring EmpowerID Email Send Options.) You can customize and translate each email from the Localized Emails page so that the version sent to each user is based on the user's preferred language setting.


How to customize an email

  1. On the navbar, expand Admin, then Miscellaneous, and click Localized Emails.

  2. On the Emails tab, search for the email that you want to customize, and click the Display Name link to open it.

  3. In the Email Template Details page that appears, click the Edit button to open the edit view of the email.

  4. In edit view, you can resize the Email Body box using the grab handle at the bottom right corner.

  5. Make changes to customize the email using HTML, or clear the IsHTML checkbox to write it in plain text. 

    Text inside braces, for example, {BusinessProcessID} and {CurrentOperationName} in our example, represents a placeholder for a value to retrieve from the current record. We call these email wildcard tokens. When the email is sent, the braces and text are replaced with the retrieved values. To preserve these values, do not change the text inside braces.  EmpowerID includes some built-in email wildcard tokens that you can use in creating custom e-mail messages, as shown in the below table.

    Wildcard Token

    Value

    ViewTaskDetailsServerURL

    URL of the server for viewing task details

    TaskRespondServerURL

    URL of the server for task response

    TaskRejectServerURL

    URL of the server for task rejection

    TargetResourceName

    Name of the target resource

    InitiatorComments

    Comments entered by the initiator of the request

    WorkflowTitle

    Name of the workflow

    WorkflowDisplayName

    Friendly name of the current business process

    ReferringURL

    Referring URL for the request

    ApprovalURL

    URL for the approver

    RequestManagerLink

    URL for the manager of the requestor

    EmpowerIDWebServerName

    Name of the EmpowerID Web server

    AttributeModificationsSummary

    Summary of attribute modifications made

    Executor

    The actor / approver executing the workflow

    • .FriendlyName — the friendly name (display name ) of the request workflow

    RequestWorkflow

    the name of the request workflow

    • .FriendlyName — the friendly name of the request workflow

    RequestWorkflowID

    the ID of the request workflow

    Initiator

    the Person initiating the workflow

    • .FirstName — the first name of the Person initiating the workflow

    • .LastName — the last name of the Person initiating the workflow

    • .FriendlyName — the friendly name of the Person initiating the workflow

    • .Telephone — the telephone number of the Person initiating the workflow

    • .Email — the email address of the Person initiating the workflow

    • .BusinessPhone — the business telephone number of the initiator

    • .Company — the company of the initiator

    • .Department — the department to which the initiator belongs

    • .Description — the description of the initiator

    • .EmployeeID — the initiator's Employee ID

    • .HomeTelephone — the home telephone number of the initiator

    • .IMAddress — the instant messaging address of the initiator

    • .Login — the login information for the initiator

    • .MobilePhone — the mobile telephone number of the initiator

    • .Office — the office location for the initiator

    • .PersonalTitle — the initiator's personal title

    • .PersonID — the Person ID for the initiator

    • .PrimaryOrgRoleOrgZoneName — the name of the initiator's primary organizational role and organizational zone

    • .Title — the initiator's title

    Requestor

    the Person requesting the action that initiated the workflow

    • .FriendlyName — the friendly name of the Person requesting the action that initiated the workflow

    • .Email — the email address of the requestor

    • .BusinessPhone — the business telephone number of the requestor

    • .Company — the company of the requestor

    • .Department — the department to which the requestor belongs

    • .Description — the description of the requestor

    • .EmployeeID — the requestor's Employee ID

    • .FirstName — the first name of the requestor

    • .LastName — the last name of the requestor

    • .HomeTelephone — the home telephone number of the requestor

    • .IMAddress — the instant messaging address of the requestor

    • .Login — the login information for the requestor

    • .MobilePhone — the mobile telephone number of the requestor

    • .Office — the office location for the requestor

    • .PersonalTitle — the requestor's personal title

    • .PersonID — the Person ID for the requestor

    • .PrimaryOrgRoleOrgZoneName — the name of the initiator's primary organizational role and organizational zone

    • .Telephone — the telephone number for the requestor

    • .Title — the requestor's title

    OperationsPendingApproval

    Name of the operations pending approval

    BusinessProcessID

    ID for the business process

    DateTimeInitiated

    Date and time the current business process was initiated

    IsConfidential

    Specifies whether the current business process is confidential

    BusinessProcessTask

    Name of the business process task

    • .FriendlyName — the friendly name of the business process task

    WorkflowMessage1

    Content of a specified workflow message

    WorkflowMessage2

    Content of a specified workflow message

    WorkflowMessage3

    Content of a specified workflow message

    LogonName

    Logon name for the Person to whom the email is sent

    FriendlyName

    Friendly name of the Person to whom the email is sent

    PasswordExpires

    Date when the password expires for the Person to whom the email is sent

    CurrentOperationName

    Name of the current operation

  6. When you have finished, click Save.

To localize an email

  1. On the navbar, expand Admin, then Miscellaneous, and click Localized Emails.

  2. On the Emails tab, search for the email that you want to localize, and click the Display Name link to open it.

  3. In the Email Template Details page that appears, expand the Localized Messages accordion and then click the Add button.

  4. In the dialog that appears, select the Locale to use, select IsHTML if you want to write the email using HTML, and then write the translated values for each field.

  5. When you have finished translating, click Save. The localized message appears in the grid.



To add a new email

  1. On the navbar, expand Admin, then Miscellaneous, and click Localized Emails.

  2. Click the Add button above the grid.

  3. In the Email Template Details page that appears, in the NameDisplay NameDescription, and Email Subject fields, type "Terminate Person Workflow Initiated."

  4. In the EMail Body field, type the following text: "The {RequestWorkflow.FriendlyName} has been initiated by {Initiator.FirstName} {Initiator.LastName}."

  5. Click Save. The workflow is appended to the list of emails. If you open it for editing and expand the Formatters accordion, you can see that the Wildcard DOT Notation Formatter appears by default. This replaces wildcards with values at runtime.

  6. You can now link the new email to an Alert that sends the email each time the workflow is initiated.





  • No labels