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

« Previous Version 3 Next »

 

Scheduling Actions

There can be any number of actions associated with a Schedule from storing, distributing, or notifying users upon completion of a report.  Each action has its own custom configuration interface to make adding and editing Actions simple. The Actions you can perform following report generation are Print, FTP, Save, Email, and Run Script.  The following image is an example of a scheduled Email Action.  

 Now you can have multiple actions on the same schedule so in addition to Save File, click the plus icon again and select a new FTP action. 



Before we get started, here are a couple of functions common to all Actions. It is important to note, that before you add any Actions, you must first add a Schedule. 

 

FunctionsDescription
Select the Print Action.
 Run the selected Action immediately.
 Delete the selected Action.

Print Action

Print File is often used to create hard copies of reports automatically when the report is generated. The Print Action is used to send a report to a printer that is accessible from a computer Ignition is installed on. To configure the Print Action, select a schedule and set the following configuration settings as appropriate:

  • Add New Action - click the plus icon  and select New Print Action.
  • Primary Printer - select your primary printer from the dropdown list.
  • Backup Printer - select a backup printer from the dropdown list (optional).
  • Print Mode - select from either Vector or Raster file format.
    • Vector - uses math to draw shapes using points, lines, and curves.The most common types of vector graphics are fonts and logos.  PDF is a popular vector type. Vector based graphics like SVG image files show images with no pixelation when the size is changed. 
    • Raster - are composed of thousands of pixels or dots. Set the dpi (dots per inch). Common raster file format extensions are jpg, jpeg, png, tiff, bmp, and gif. 
  • Copies - number of copies to send to the printer.
  • Options - print options
    • Print on both sides of the sheet of paper.
    • Collate - order or arrange pages
    • Use AutoLandscape Mode - evaluates the page dimensions and determines portrait or landscape orientation.
    • Page Orientation - Portrait or Landscape 

You can also Print the report immediately by selecting the Print Action and pressing the double arrow icon .

FTP Action

FTP Action can be used to automatically upload your reports to a file server for backups or storage. To configure the FTP Action, select a schedule and set the following configuration settings as appropriate. 

  • Add New Action - click the plus icon  and select New Print Action.
  • Server Address - specify a server address.
  • Port - specify what port to use.
  • Folder Path - enter the folder path where the file should be uploaded to. 
  • Format - choose the file format from the dropdown list that you want to save the report to.                                                                  
  • Username and Password - enter the user credentials that Ignition should be using to access the FTP server.
  • SSL - mark 'true' if using an encrypted link.
  • Filename - by default, your Report Name will be used as the filename, but you can change it. You can even use any of your Parameters or Tags. 

You can also FTP the report immediately by selecting the FTP Action and pressing the double arrow icon .



Save File Action

The Save File Action will save a copy of the report to any folder the Ignition computer has access to, locally or network shared drive. If a report is saved as HTML, it will output both <report>.html and an images folder containing a .png of the report. Both parts need to be present to view the report properly.  To configure the Save File Action, select a schedule and set the following configuration settings as appropriate. 

  • Add New Action - click the plus icon  and select New Save File Action.
  • Folder Path - specify a folder path.
  • Format - choose the file format from the dropdown list that you want to save the report to.
  • Filename - by default, your Report Name will be used as the filename. You'll notice that the expression is already built for the filename, but you can change it. You can also use any of your Parameters or Tags which you'll find on the right side of the Save File Action window. 

You can Save the file immediately by selecting the Save File Action and pressing the double arrow icon .



IULocgo


Scheduling Actions - Save

Email Action

The Email Action distributes a report via email when the report is finished executing. There is a Recipients Source property that allows you to send emails using either Email Addresses or  User Roles. The 'From' address, 'Subject', email 'Body,' and attached 'Filename' are all configurable. The Subject, Filename and Body editors can utilize Expressions to dynamically add content or change names.

Email Server settings must first be configured on the Gateway webpage by going to Configuration > Email Settings, or in Email Actions and clicking the Create new server link. Once you create and save an SMTP profile, you can test your email settings on the Email Settings page under the Configure section of the Gateway webpage.  

To configure an Email Action, select a schedule and set the following configuration settings as appropriate. 

  • Add New Action - click the plus icon  and select New Email Action.
  • From Address - enter the sender's or From address.
  • Mail Server - specify a mail server.  If you need to create one, click on the Create new server link. The Email Setting page under the Configure section of the Gateway webpage will open.  Here you can create SMTP profile for your mail server. 
  • Format
  • Retries
  • Recipients Source - There are two different interfaces depending if you choose Email Addresses or User Roles. 
    • Email Addresses
      • Recipient Emails - enter recipient email addresses
    • User Roles
      • User Source - select user source
      • Recipient Roles - specify roles. This sends out reports to all users in the specified roles. If this field is left blank, an email will be sent to users in all configured roles. 

IULocgo


Scheduling Actions - Email

Select a schedule with a Email Action.  When setting an Email Action you need to sea From Address, then you need to specify a mail server. There is a certain place you have to configure the mail server on the GW webpage. Instead of having to open the GW webpage yourself, you can click on the Create new server link.  Once you click on it your web browser will open up and show you you're GW webpage. There is already one configured  on the called Mailinator. This is located on the GW webpage under the Configure tab under Configuration > Email Settings.  If we edit this profile, you'll see that the configuration looks very similar to configuring an SMTP server for alarm notifications. Lets test the SMTP profile using the Test link. enter the email address that the test is From, use the same To address that you are going to use in our report, and click the Send Test Email button.  You can see that the Email went thru successfully. If there was some sort of problem you would see an error message displayed giving you some information about what is wrong. Additionally you'll see an error message in the GW console. 

Lets take a look at the rest of the properties on the Email Action. Specify the Format and how many Retries the email should attempt in case there is a problem.

There is a Recipients Source property. There are 2 types of Recipients Sources: Email Addresses and User Roles. The Action will only ever use the selected recipient source, so I can't use both in email addresses and user role recipient 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 the Recipient Email table appear in the window. There are 2 columns. There's Address where you want to send the report to, and there is the Method column so you can specify "To, CC, BCC".  If you click on the plus icon, you can add more rows. Let's look at User Roles - you can send your reports out to all your users with specific roles, and it will auto detect any roles you already have. (i.e. Administrator, Operators). So now all my Admins and Ops would get this report.Let's change back to Email Addresses for now.

Lastly, you can configure the Subject of the email, the attached filename, and the body of the email. Now, just like the other Actions, you don't have to wait for the schedule to come.  You can run this immediately. Let's run it. You'll see that the double arrow button is grayed out when executing. When it is not grayed out, you can look at your Inbox and see your report email. 

 

 

 

 

 

Run Script

This actions is available for you to do anything else you can think of. Store your report in a database, provide special email code, or anything else. Run Script give you the report name and path, a mapping of the report parameters and datasets, and the bytes in whatever format you want.

 

 

 

  • No labels