LESSON

Scheduling Actions - Email

Description

Learn how to create an email action for your schedule, as well as configure an SMTP server on the Gateway.

Video recorded using: Ignition 8.1

Transcript

(open in window)

[00:00] Let's take a look at the email action. As the name implies, the email action distributes a report via email when the report is finished executing. You can see I already have a schedule created with an email action set. When creating an email action, you need to set the from address, so I went ahead and typed one out here, and then you need to specify a mail server. These are configured on the gateway webpage, and you can use the create new server link below to open this up. You can see we are brought to the email settings in the config section, and I have an SMTP server set up. If we edit this profile, we'll see that the configuration looks very similar to configuring an SMTP server for alarm notification. Additionally, I have linked below this video, the user manual page for email settings, if you wanted to use a configuration guide, I'll click back on my browser and let's use the more option to test the SMTP profile. I'll provide an email address this email is from, and then an email this is going to. We'll use the same addresses we're going to use in our email action, and then we'll click the send test email button.

[01:09] Now you can see the email went through successfully. If there's some sort of problem, you'd see an error message down here and it would give you a little more information about what was wrong. Additionally, you'll see an error message in the gateway console. Now, since the SMTP server seems to be working, I'll close my browser here and let's take a look at the rest of the properties. On the email action, we can specify the format, how many retries should the email go through in case there is a problem. And then there's this address source property. There are two types of address sources. There's email addresses and user roles. The email action will only ever use the selected address source, so I can't use both an email address and user role address source on the same action. However, I could create an additional email action on my schedule if I wanted to use both. When using email addresses, you'll see this recipient and reply to emails table down below. There are two columns.

[02:01] There's address, so wherever you want to send the report to. And then there's the method column, so you can specify to cc, blind cc and reply to. If you click the plus icon, you can add more rows. I'm going to go ahead and delete the extra rows. We can take a look at user roles. You can send your reports out to all of your users with specific roles using the recipient roles field. You also need to make sure you are selecting the correct user source. This will auto detect any roles that you have. So we have admin comma, we'll do operators. So now all my administrators and operators would get this report. You could also leave this field blank, which will send the email to all user roles in the selected user source. And down below you can use the reply to roles field to specify users that will be listed in the reply to of the email. We'll change this back to email addresses for now. Lastly, you can configure the subject of the email, the attached file name and the body of the email using expressions. Now, just like the other actions, you don't have to wait for the schedule to run.

[03:03] You can run this immediately. So let's go ahead and do that right now. And let's take a look at our inbox. You can see there are two emails. There's one from me earlier, the test email, and then my report was just sent out. We could download the report and open that up and you'll see it with sent successfully.

You are editing this transcript.

Make any corrections to improve this transcript. We'll review any changes before posting them.