eMail Step
Description:
Send an email to a selected number of users.
Inputs
- replyTo – reply to email address
- fromEmail – from email address
- emailTo – select users to send emails to
- emailToRoles - select roles to send emails to
- emailAddresses – external email addresses
- subject – subject of the email
- body – body of the email
- cc – carbon copy list of email addresses
- bcc – blink carbon copy list of email addresses
- fileList – list of file attachments
- sendUsingQueue – sends the email message using the email queue
- priority - set priority
Returns
- True – email sent successfully
- False – failed to send the email
Usage:
FlowWright must be configured with the SMTP email server information to use this step. To do this, you must navigate to the Status - Status - Settings - Email menu option as below.
The Email Settings page is rendered as below. You must set the SMTP host, port, user, and password configuration here. Click on the Save button to confirm.
NOTE: The Email Trigger Service engine should be running for the process steps like RouteTo, Task and Email steps to use the Email Queue feature.
Example:
Let’s build and execute the “emailDef” example.
- Create a new definition called “emailDef”
- Select the definition and click the “design” button
- Drag a “email” step to the canvas
- Connect the dots between the start and “email” step
- Define a variable/global to store the result after execution
- Click on the "email" step to configure its "Settings" properties. Provide a name to the step.
- Click the "email" step to configure its "Advanced" properties. Provide the reply to the email address. Provide from an email address or use the default email address configured in app settings. Click on the button to select the users to whom to send emails. Click on the button to choose application roles to send emails to. Provide a list of external email addresses (separated by semi-colon). Provide the subject text for the message. Click on the button to provide email context information.
- Click on the button to select users to whom you want to send emails. Search for and add users to the list.
- Click on the button to select application roles to which you want to send emails. Search and add roles to the list.
- Click the "email" step to configure its "Advanced" properties. Provide the CC email addresses (separated by semi-colon). Provide the BCC email addresses (separated by semi-colon). Click on the button to add file attachments on the application server. Select if an email queue is required to send an email. Provide priority value
- Click on the button to add file attachments on the application server. Provide the file path on the server.
- The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the percent complete. This is achieved by configuring the step state and percent fields individually, as shown in the images below. Configure the “Logging” using the following properties. The "Send Test Mail" feature is provided to send a test email with the contents configured in the email body to the current (logged-in) user.
- Save the process definition, create a process instance, and execute. The step should send an email to the selected users and require the FlowWright Email service to be running. Navigate to Status—Email Queue to check on the email delivery.
Definition Sample:
You may download the sample definition(s) from the link here and later import it (drag-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.
NOTE: Please verify and complete the process steps for any missing configurations, such as file path references and database connections after import. Then, save the definition to confirm the changes.
Click here to download the sample file.