OTHER USER MANUAL VERSIONS
Sepasoft - MES Modules
Cirrus Link - MQTT Modules
Knowledge Base Articles
The Report Workspace will open, and you'll be in the Report Overview Panel. The top of the workspace has a series of stylized panels which guide you through the creation of a new report. It's no coincidence that our Report Workspace is laid out in such a way that lets you intuitively follow the three fundamental steps to creating reports with a little help along the way: gathering data, designing reports, and setting up schedules to run and distribute reports.
For any Report, you will first need to specify one or more Data Sources in the Data panel.
With the Static CSV Data Source editor open, copy and paste the CSV data below into your Data Source editor, and give your data a meaningful name in the Data Key field: we've named ours WidgetProduction Data.This example models data collected from all the International Widget Factories, complete with production capacity, number of widgets produced, and the number of minutes it took to produce them.
Facility, Capacity, Produced, Minutes "California", 2000, 665, 345 "Texas", 3424, 1674, 924 "South Africa", 734, 232, 154 "Brazil", 1131, 882, 325 "China", 5324, 2764, 297 "Norway", 436, 143, 383 "Kenya", 1431, 423, 164 "Italy", 543, 524, 234 "Romania", 154, 78, 45 "Peru", 624, 523, 732
Here is what the data looks like in the Static CSV Data Source editor.
Next go to the Design panel, and expand the Data Sources folder in the Key Browser. You'll see that each column of data in the Static CSV data source is represented by its own Data Key. These Data Keys are automatically generated based on the table of data fed to the report system. A key may have subkeys, or 'child-keys' Accessing the data from a child-key is accomplished using the path of a key in relation to its parent, sometimes referred to as A Keychain is simply the path to your data key using 'dot notation'. For instance, the Keychain dragged into a report for our Facility key would be
The Power of Data Keys
You can have multiple keys in any text field. In addition, you can use multiple keys and common numeric operators to do calculations within the @ symbols! These are called Keychain Expressions. Expressions are not something this introductory tutorial will cover, but you can head over to the data key documentation page for more information.
Now that you have some data, let's create a simple design and see how the Data Keys can be used to create dynamic reports.
The Design Panel is where we start building the report. This section of the report has many components, such as tables and charts, that can display the results of your data sources and parameters. Components in a report are typically assigned one or more keys, which then feeds the results of our data sources and parameters directly to the component. To create comprehensive reports, you will likely find yourself combining different components. Fortunately, this is pretty easy to do using the visual Designer, so let's continue with your first report and see how easy it is.
For this report, we will aim for the following requirements:
Let's add a table and Datasource.
With the Table selected, in the bottom left corner of the Property Inspector, you will see the Configure Table tab. Note that the Data Key property on the table was automatically assigned to our WidgeProduction Data data source. Additionally, you'll see the Details Row (the dark gray bar on the table component) displays the name of our data source. This means that the table was property assigned a data source.
Alternatively, you may drag a Table component from the Component Palette on the right side of the interface. If you take this approach, you must manually assign a data source by interacting with the Data Key property on the Configure Table tab: click theicon next to the Data Key property, and select the WidgetProduction Data data source. It should look like the image below.
Now, let's add some keys to the table.
Let's take it a step further. Say you would like to calculate the efficiency of units produced per minute of production runtime. You can use the keychain expression @Produced/Minutes@, which will return the value of the Produced key divided by the value of the Minutes key. Note that this calculation is executed for each row, so it is always taking the current rows values to determine the quotient. To do this, you need to add another column in the Details Row and Header Row, using the following steps:
Lastly, let's add a total for the number of widgets produced from all facilities to your report using the following steps:
The Text Shape is great to use for a report title, although it can be used anywhere in the report to add text to the page.
In addition to a title, let's add some metadata, such as the date the report was generated. However, you don't want to type the date into the text field, because all reports you run (could be today, tomorrow or next year!) will show what date you typed. Instead, you want the date to reflect the day the report was generated.
Adding text on a page shared with a repeating component (such as a table) will add the text to all pages created by the component. In some cases, like page numbers, date, and title at the top, this is desirable.
Here is what the report look likes in the Design and Preview panels after the header and page numbers were added to the report.
To finish the report, we just need to add a chart. You may need to resize the table a little bit and add a chart right under the page header.
If we were using Query data sources, we would create an additional data source or use a nested source to get the two columns we want. For this example, let's create a subset of our original dataset (i.e., WidgeProduction Data) so we only get the data we are interested in.
Facility, Produced "California",665 "Texas", 1674 "South Africa", 232 "Brazil", 882 "China", 2764 "Norway", 143 "Kenya", 423 "Italy", 524 "Romania", 78 "Peru", 523
An easy way to do this is to select the chart and drag the 'FacilityProduced Data Source' key onto the Data Key field in the Property Inspector. Now when we generate our report with the new data, we only get a Bar Chart with the items produced for each facility.
Once your report is created, you can view the report from the Ignition runtime or Designer's Preview Mode with the Report Viewer component. You can add this component to any Vision window and select the name of your report from the Report Path parameter dropdown.
Saving a report from the Report Viewer is simply a matter of right clicking on the report in the Ignition runtime or Preview Mode of the Designer, and selecting the format you wish to save it as. Selecting from the menu will open a Save or Print dialog in the Client window as well as in Preview Mode.
The Report Viewer component supports the following options:
Once a report is designed, you can have a list of scheduled times and actions that will execute automatically at specified times using the Report Schedule functionality.
Use the following steps to create a schedule for your report.
The Save File Action saves a copy of the report to any folder Ignition has access to whether it's on your local computer or a shared drive.
Here are a few simple steps to saving a report:
Now that your schedule is complete, you may want to disable the schedule so that a new copy of this example report is not created every 12 hours. The Schedule tab has an Enabled checkbox that can be disabled to prevent the schedule from occurring.