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 7 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.  You can also have multiple actions on the same schedule, so in addition to a Save File Action, click the plus icon again and select  any one of the other Actions (i.e., Print, FTP, Email, or Run Script).

 The following image is an example of a scheduled Email Action.  

On this page ...



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 a 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 FTP 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 the Operators, Functions, Parameters or Tags to help you create your filename.  

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', 'Body,' and 'Attachment 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 under Configure > Networking > Email Settings page, 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 for your mail server on the Gateway webpage under Email Settings.

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 address.
  • Mail Server - specify a mail server from the dropdown list.  If one doesn't exist, click on the Create new server link. The Email Settings page under the Configure section of the Gateway webpage will open.  Here you can create an SMTP profile for your mail server. 
  • Format - choose the file format from the dropdown list that you want to save the report to.
  • Retries - enter the number of retry attempts in case of a failure.
  • Recipients Source - There are two types of Recipients Source: Email Addresses and User Roles, each having a different interface. Enter one Recipients Source.
    • Email Addresses
      • Recipient Emails - enter recipients email addresses. To add multiple address, click the plus icon  on the right side of the window. 
      • Method - specify 'To,' 'CC,' or 'BCC,' as appropriate.
    • User Roles
      • User Source - select user source from the dropdown list.
      • Recipient Roles - enter user 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. 

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

Recipients Source - Email Addresses


Recipients Source - User Roles


IULocgo


Scheduling Actions - Email

Run Script

This Run Script Action allows you to store your report in a database, provide special email code, or anything else you can think of. Run Script gives you the report name and path, a mapping of the report parameters and datasets, and the bytes in whatever format you want. To configure an Run Script Action, select a schedule, create your script, and set the following configuration settings as appropriate. 

  • Add New Action - click the plus icon  and select New Run Script Action.
  • Run Script - enter your script.
  • Format - choose the file format from the dropdown list that you want to save the report to.

You can Run the script immediately by selecting the Run Script Action and pressing the double arrow icon .

 

 

 

Related Topics ...

 

  • No labels