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 31 Next »


Scheduling Actions

Actions can be configured to run once the report has generated at the scheduled time. 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 even have multiple actions on the same schedule. So you can save the report to the hard drive, as well as email it out to multiple users.

Before creating any Scheduling Actions, you must first create a schedule

To create an Action, click the Actions tab, click the plus icon  and select an Action. Actions can be deleted using the trash can button , and executed immediately using the double arrow button.


On this page ...



Print Action

The Print Action is used to send a report to a printer that is accessible from a computer Ignition is installed on. Here are a list of property descriptions for the Print Action.

  • Primary Printer - select a main printer from the dropdown list.
  • Backup Printer - select a secondary printer from the dropdown list (optional).
  • Print Mode - can be 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 - will attempt to print on both sides of a sheet of paper, if supported by the printer.
    • Collate - will order the pages so that a complete report prints before the next copy prints, if applicable.
    • Use AutoLandscape Mode - evaluates the page dimensions and determines portrait or landscape orientation.
    • Page Orientation - will orient the page into either portrait or landscape 

FTP Action

The FTP Action can be used to automatically upload your reports to a file server for backups or storage. Here are a list of property descriptions for the FTP Action. 

  • Server Address - server address of where your FTP files will be uploaded.
  • Port - identifies what port to use.
  • Folder Path - is 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 - user credentials that Ignition should be using to access the FTP server.
  • SSL - if 'true' an encrypted link is used.
  • Filename - by default, your Report Name with the date and time 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.  


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.

Here are a list of property descriptions for the Save File Action.

  • Folder Path - the folder path where the file should be saved to. This will be from the Gateway perspective.
  • Format -  choose the file format from the dropdown list that you want to save the report to.
  • Filename - by default, your Report Name with the date and time 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.


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.


Scheduling Actions - Email

Creating an email server

Before you setup any reports to be emailed, an email server must be configured. To create an email server if one doesn't exist, use the 'Create new server' link. This link will take you to Configure > Email Settings on the Gateway webpage. There, you will be able to create an SMTP server. For more information, refer to Gateway Settings.

Here are a list of property descriptions for the Email Action.

  • From Address -  the sender's email 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 - is the number of retry attempts in case the email that was sent failed to be delivered the first time.
  • Address Source - There are two types of Recipients Source: Email Addresses and User Roles, each having a different interface. Enter one type of Recipients Source.

    This feature is new in Ignition version 7.9.8
    Click here to check out the other new features

    There is a new 'ReplyTo' Email function that allows you to reply to email actions using the Email Address and User Roles. This simply adds those emails to the "ReplyTo" header of the email sent to the recipient list, so that if recipients choose to reply to that email, their reply is sent to those email addresses as well. 

    • Email Addresses
      • Recipient Emails - enter recipients email addresses. To add multiple addresses, click the plus icon  on the right side of the window. 
      • Method - specify how to send the email (i.e., To, CC, BCC, or ReplyTo) as appropriate. 
    • User Roles
      • Recipient User Source - is a collection of users and roles that Ignition uses to authenticate against. Select a User Source from the dropdown list.
      • Recipient Roles - enter the user roles. Reports are sent to users in the specified roles. 
      • ReplyTo User Source - select the User Source from the dropdown where the specified roles are located.
      • ReplyTo Roles - enter the user roles you want to have in the 'ReplyTo' header of the email.
  • Subject, Attachment Filename, and Body fields have defaults, but are configurable. Each field can be edited to utilize Expressions to dynamically add content or change names

Configuring an Email Action

  1. In the Schedule panel, create a Schedule to automatically email a report by clicking on the plus icon , if you don't already have one.  
  2. Next, click on the Actions tab.
  3. Click on the plus icon , and select the New Email Action from the dropdown list.
  4. Enter the sender's email address in the From Address field. 
  5. Select the Mail Server from the dropdown list.  If one does not exist, click the 'Create new server' link to create one. Refer to Gateway Settings.
  6. Select the Format from the dropdown list.
  7. Enter the number of Retry attempts in the event the email failed to be delivered the first time.
  8. You can send emails to users using either Email Addresses or User Roles. Under Address Source enter either Email Addresses or User Roles
    Note, email recipients can choose to reply to the email if they prefer, since the email address is added to the 'Reply To" header of the email.
    1. Email Addresses - enter individual email addresses under in the Recipient and ReplyTo Emails area. To add multiple addresses, click the plus icon  on the right side of the window. Next, specify the Method of how to send the email: To, CC, BCC, or ReplyTo
    2. User Roles - select the User Source from the dropdown in the Recipient User Source field.  
      1. In the Recipient Roles field, begin typing a configured role and Ignition will validate it. If this field is left blank, you will get an error. 
      2. In the Reply to User Source, select the User Source from the dropdown. (Optional)
      3. In the RepyTo Roles field, enter the role(s) you want listed in the 'ReplyTo' header of the email. (Optional)
  9. Enter in values for the SubjectAttachment Filename, and Body fields, or use the defaults.

Recipients and ReplyTo Emails

Recipients Source - User Roles

Run Script Action

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 exposes the function handleFinishedReport() which gives you the report name and path, a mapping of the report parameters and datasets, and the bytes in whatever format you want. 

Here are a list of property descriptions for the Run Script Action.

  • Run Script - create your script.
  • Format - choose the file format from the dropdown list that the reportBytes parameter should be.


Scheduling - Run Script


The handleFinishedReport function has the following arguments:

  • String reportName The name of the report for which this script should run.
  • String reportPath - The path to the report in your project.
  • PyDictionary dataMap - The Python Dictionary containing the Parameters and Data Sources that were supplied to the report. This argument allows you to directly access Parameters and Data Sources in the report. Note that once handleFinishedReport() has been called, the report has already been generated, so changing the parameters from this function will not alter the resulting report. Instead, parameters should be altered from the Parameters tab. 
  • byte[] reportBytes - The report, presented in a byte array. The format of the report depends on the format specified in the Format dropdown list. 

The dataMap Argument

There is a special argument  in the RunScript Action called dataMap that may be used to review the raw data that was used to generate the report. Below is a demonstration of using dataMap.

Using dataMap
# The dataMap argument is simply a Python Dictionary with the name of each Parameter and Data Source acting as a key.

# Assuming a Report Parameter named 'shift', the value of 'shift' may be accessed with the following

# Similar syntax may be used to extract the value from a Data Source. 
data = dataMap['myDataSource']

# Rows objects, while similar in nature to a dictionary, are different objects.

# Individual rows in the Data Source may be accessed by index.
firstRow = data[0]

# getKeys() may be called on a row to list all of the column headers in the row. 
firstHeader = firstRow.getKeys()[0]

# getKeyValue() may be used to access the value of a column in the row.
firstColumnInRow = firstRow.getKeyValue(firstHeader)

Related Topics ...


  • No labels