Scheduling Actions

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.

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. 

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

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. 
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. 
      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 Subject, Attachment Filename, and Body fields, or use the defaults.

Recipients and ReplyTo Emails

Recipients Source - User Roles

Arguments

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.

# 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
dataMap['shift']

# 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)