Skip to main content

Self-Assessment Guide

This self-assessment guide is designed for you to verify all of the work completed on the project matches expected outcomes. Review the checklist for each section and identify items that were not completed. A nested help section is included within each checklist item, in case additional support is needed.

Gateway and Project​

Below are items that need to be completed for the Gateway and Project section.

Connections and Tags​

A named DB connection of type MySQL or MSSQL is created and shows status “Valid” in Database Connections
  • In the Gateway, go to Database -> Connections
  • Find the DB connection for the project
  • If the Status is not Valid, click on Edit to modify the DB settings to work on the local machine for testing
  • For more information visit Connecting to Databases
Use the OPC Quick Client to verify the tags inside the RioOso simulator are changing
  • In the Gateway, go to OPC Client -> OPC Quick Client
  • Find a tag to review (T8/T8:12 as an example) in the OPC-UA server
  • Select S in the Action column to subscribe to the tag and verify the tag is updating
  • For more information visit OPC Quick Client
ColdBrew UDT is created, including one parameter (brewStation), three parameterized device tags (brewType, waterTemp, status) and two memory tags (highSP, lowSP)
  • In the Designer, click on the UDT Definitions tab in the Tag Browser, and double click on the ColdBrew UDT
  • The UDT should contain a parameter called brewStation. Verify by clicking on Parameters in Categories while brewStation is selected within the Type Structure.
  • Within Type Structure, there should be five tags - brewType, waterTemp, status, highSP, lowSP
  • For the brewType, waterTemp and status tags, the OPC item path should include the brewStation parameter to replace the specific number of the tag. Verify by clicking on the tag and looking at the OPC Item Path field
  • The highSP and lowSP tags should be memory tags set to type double, with values that match the instructions. Verify by clicking on the tag and looking at the Data Type field, then the value field
  • For more information visit User Defined Types - UDTs
20 instances of ColdBrew UDT are created in Tag Browser, reflecting data from device
  • In the Designer, go to the Tags tab in the Tag Browser, and look for a folder that contains the 20 instances of the coldBrewUDT
  • The folders should be numbered from 1-20, i.e. Station 1, Station 2, etc.
  • Within each of the station folders, verify a Parameters folder exists showing the brewStation parameter that matches the number of the Station folder
  • For one of the tags within a Station folder, verify the OpcItemPath matches the device settings from the instructions (Station 3 should reflect T8:T8:7 as an example). To review the OpcItemPath, click on the arrow next to a tag name to view all of the tag properties
  • For more information visit UDT Multi-Instance Wizard
Tag history enabled for all tags on the UDT
  • In the Designer, click on the UDT Definitions tab in the Tag Browser, and double click on the ColdBrew UDT
  • For each tag, verify that the tag history symbol - a small clock icon - is located after the name of the tag within Type Structure
  • To verify tag history settings, click on a tag within Type Structure and select History in Categories
  • For tag history to work, History Enabled must be set to true and the Storage Provider set to a database connected on the Gateway
  • For more information visit Configuring Tag History

Security and Alarms​

Verify the users and roles are set up correct in Users, Roles
  • In the Gateway, go to Security -> Identity Providers
  • Select the user source created for the project, then go to More -> Manage Users
  • Verify the information entered for both users and roles matches the instructions
  • For more information visit Managing Users and Roles
Verify an identity provider named RioOsoIdP is created and uses the RioOso user source
  • In the Gateway, go to Security -> Users, Roles
  • Select the RioOsoIdP user source created for the project, then click on Settings
  • Verify the User Source is set to RioOso and the Provider Type is Ignition
  • In the Gateway, go to Security -> General
  • Verify the System Identity Provider points to the RioOsoIdP
  • In the Designer, go to the Project menu and select Project Properties
  • Verify the Identity Provider in the General section under Project is set to RioOsoIdP
  • For more information visit Configuring Identity Providers
Alarms are created on the UDT tags - two alarms on waterTemp (tempHigh, tempLow), with both alarms pointing to the setpoint tags in the UDT; one alarm on status
  • In the Designer, click on the UDT Definitions tab, and double click on the ColdBrew UDT
  • For the waterTemp and status tags, verify that the alarm symbol - a small bell - is located after the name of the tag within Type Structure
  • To verify alarm settings, click on a tag within Type Structure and select Alarms in Categories
  • Click on an Alarm, then the alarm has Alarm Mode settings and the appropriate Active Pipeline set according to the instructions
  • For more information visit Alarms in UDTs
Verify an Alarm Journal is created
  • In the Gateway, go to Alarming -> Journal
  • Verify an Alarm Journal Profile is created for the project and Enabled is set to true
  • For more information visit Alarm Journal
Verify On-Call Rosters are set up according to instructions
  • In the Gateway, go to Alarming -> On-Call Rosters
  • Find the on-call rosters created for the project, then go to More -> Manage
  • Verify the users for each roster and email address are provided in the On-Call Roster
  • For more information visit On-Call Rosters
Verify an Alarm Notification Profile is set up
  • In the Gateway, go to Alarming -> Notification
  • Find the alarm notification profile created for the project, and verify it shows as the Email Notification Type and Enabled is set to true
  • For more information visit Email Notification Profile
Alarm Notification pipelines created for waterTemp alarms and status alarm
  • In the Designer, click on Alarm Notification Pipelines and verify there are two pipelines created
  • One pipeline should use the alarm notification profile and the On-Call roster created for the Roasters, both set in the gateway
  • One pipeline should use the alarm notification profile and the On-Call roster created for the Administrator and Managers, both set in the gateway
  • For more information visit Alarm Notification Pipelines
(Perspective only) Verify the Security Levels match the Roles
  • In the Gateway, go to Security -> Security Levels
  • Verify the roles from Users, Roles are created within Roles in the security levels
  • In the Designer, go to the Project menu and select Project Properties
  • Verify the Security Level in the Permissions section under Perspective is set to Authenticated
  • For more information visit Security Levels

Perspective​

Below are items that need to be completed for the Perspective section.

Station View​

Station view shows a parameterized station number, brewing status of the station, water temperature
  • In Views in Perspective, select the Station View
  • Verify there is a View Parameter set on the view that is used for indirect tag and expression bindings
  • Verify all of the components are using expression or indirect tag bindings as necessary, so changing the View Parameter updates all of the components to reflect the desired Station
  • Verify there is an image that reflects the brew process
  • For more information visit Bindings in Perspective and Property Bindings in Perspective

Overview View​

Overview view is the startup main view, and shows all 20 of the Station views
  • In Views in Perspective, under Page Configuration look for a View with / as the Page URL, and verify the Primary View is set to Overview
  • Select the Overview view, and verify the view contains 20 embedded views of the Station view
  • For more information visit Initial Page URL and Perspective - Embedded View
Verify the navigation system allows for access to every view and is visible on every view
  • In Views in Perspective, in Shared Settings verify a View designed for navigation has been added to one of the dockable areas
  • Select the View designed for navigation within the Views section, and verify there is a menu system (either menu or buttons) that allows for site navigation
  • For more information visit Docked Views and Navigating in a Perspective Session
Popup view opens when a Station view is clicked, showing the station view, an XY chart of temperature history, alarm status for the Station, and fields to enter brewType and setpoints
  • In Views in Perspective, select the Station View
  • Verify there is a button in the Station View that opens the popup. The button must have an event configured and a parameter passed to the popup reflecting the station number selected
  • In Views, select the Popup View
  • Verify there is an embedded view showing the Station view
  • Verify there is a Power Chart showing the temperature, setpoint and status history for the station. The data should change when a different station is selected. The status pen should be shown on a separate axis
  • Verify there is an alarm status showing just alarms for the selected station
  • Verify the brew type can be set by the user, and that the requested changes are saved to the tag in the Tag Browser
  • Verify the setpoints can be set by the user, and that the requested changes are saved to the respective tags in the Tag Browser
  • For more information visit Perspective - Power Chart and Popup Views

Security​

Login required to access overview view, and security applied to status selector so only Roasters can change
  • In Views in Perspective, under Page Configuration right click on the Overview view and select Launch URL
  • Verify that a registered user must log in prior to viewing the Overview view
  • Verify the brew status can be set by only a Roaster user, and that the requested changes are saved to the tag in the Tag Browser
  • For more information visit Security in Perspective

Alarms View​

Alarms view displays current and historical alarms
  • In Views in Perspective, select the Alarms View
  • Verify the Alarm Status table shows alarms for all of the brewing stations
  • Verify the Alarm Journal table is only showing the last 4 hours of alarm history, and updates every 30 seconds
  • For more information visit Perspective - Alarm Status Table and Perspective - Alarm Journal Table

Vision​

Below are the items that need to be completed for the Vision section.

Station Template​

Station template shows a parameterized station number, brewing status of the station, water temperature
  • In Templates in Vision, open the Station template
  • Verify there is a parameter set on the window that is used for indirect tag and expression bindings
  • Verify all of the components are using expression or indirect tag bindings as necessary, so changing the parameter updates all of the components to reflect the desired Station
  • Verify there is an image that reflects the brew process
  • For more information visit Creating a Template

Overview Window​

Overview window is the startup main window, and shows all 20 of the Station templates
  • In Windows in Vision, open the Overview window
  • Verify the Overview window has a startup icon - a square box with a triangle inside - next to it
  • Verify the Overview view contains all 20 of the Stations, either using a template repeater or individual templates
  • For more information visit Vision - Template Repeater
Verify the navigation system allows for access to every window and is viewable on every window
  • In Windows in Vision, look for a Navigation or Menu window that has a startup icon - a square box with a triangle inside - next to it
  • If a tab strip was used, right click on the tab strip and select Customizers -> Tab Strip Customizers to verify the navigation system
  • If a tree view was used, click on the dataset viewer for the Items property in the tree view to verify the window paths were set correctly
  • If buttons were used for a menu, verify the scripts used correctly navigates to the various windows
  • For more information visit Navigation Strategies in Vision
Popup window opens when a Station template is clicked, showing an easy chart of temperature history, alarms and template. Station number on the popup matches the Station clicked
  • In Templates in Vision, open the Station template
  • Verify there is a button in the Station template that opens the popup. The button must have a script configured and a parameter passed to the popup reflecting the station number selected
  • In Windows, select the Popup window
  • Verify there is a copy of the Station template
  • Verify there is an Easy Chart showing the temperature, setpoint and status history for the station. The data should change when a different station is selected. The status pen should be shown on a separate axis, with the status names shown on the axis
  • Verify there is an alarm status showing just alarms for the selected station
  • Verify the brew type can be set by the user, and that the requested changes are saved to the tag in the Tag Browser
  • Verify the setpoints can be set by the user, and that the requested changes are saved to the respective tags in the Tag Browser
  • For more information visit Popup Windows and Indirect Easy Chart

Security​

Security applied to status so only Roasters can change
  • In Templates in Vision, open the Station template
  • Find the component that allows for the status to be changed on the template
  • Right click on the component and select Security
  • In the Security Settings panel, verify only the Roaster role is set to exempt, and the Disable restriction is selected
  • The other possible method is creating a binding on the enabled property, and using the hasRole expression.
  • For more information visit Component and Window Security
Window created to edit users and roles and rosters
  • In Windows in Vision, open the window that contains the components to edit the users and rosters
  • Verify there are User Management and Roster Management components on the screen
  • Right click on the components and select Security
  • In the Security Settings panel, verify only the Administrator role is set to exempt, and the Disable restriction is selected
  • The other possible method is creating a binding on the enabled property, and using the hasRole expression.
  • For more information visit Vision - User Management and Vision - Roster Management

Alarms Window​

Alarms view displays current and historical alarms
  • In Windows in Vision, select the Alarms window
  • Verify the Alarm Status table shows alarms for all of the brewing stations
  • Verify the Alarm Journal table is only showing the last 4 hours of alarm history, and updates every 30 seconds
  • For more information visit Vision - Alarm Status Table and Vision - Alarm Journal Table

Reports​

Below are the items that need to be completed for the Reports section.

Transaction Groups​

Transaction Group created to track tag data for one brewStation, storing all tags for the brewStation every 10 seconds when the Station is set to brew
  • Click on Transaction Groups, and click on the transaction group created
  • Verify that the Basic OPC/Group Items section of the Transaction Group contains the brewType, waterTemp, status, highSP and lowSP tags for the same station
  • On the Action tab, verify the Execution Scheduling is set to a Timer of 10 seconds
  • Note the Table name in the Action tab
  • On the Trigger tab within the Transaction Group, verify the Transaction Group executes on a Trigger for the status tag, set to is Active = 1 and non-active != 1.
  • For more information visit Understanding Transaction Groups

Report Design​

Report displaying data collected in the transaction group, showing waterTemp and setpoints over time as a graph, all tags in a table, and labels showing station number, start and end dates for the report
  • Click on Reports, and click on the report created
  • In the Data tab, verify a SQL query exists using the table named in the Transaction Group
  • In the SQL statement, verify all of the tags from the table are included in the SELECT statement (i.e. SELECT brewType, waterTemp, status, highSP and lowSP FROM group_table)
  • In the SQL statement, verify the WHERE statement uses both the StartDate and EndDate (i.e. WHERE t_stamp BETWEEN ? and ?, and the Parameter 1 and Parameter 2 boxes reference the start date and end date)
  • In the Design tab, verify a chart showing the waterTemp, highSP, and lowSP over time is on the report
  • In the Design tab, verify a table showing all fields except for status is on the report
  • In the Design tab, verify there is a label showing the brewing station number and another label showing the start and end times of the report to seconds resolution
  • In the Schedule tab, verify there is a Schedule created for the report to run at 0800 and 2000
  • With the schedule selected, on the Parameters tab verify the report uses the default parameters or is set to run for the past 12 hours. If the report uses Default StartDate and End Date, in the Data Tab verify the StartDate parameter is starting 12 hours before the current time (dateArithmetic(now(), -12, "hr") as an example) and the EndDate is set to now.
  • With the schedule selected, on the Actions tab verify the report is saved as Format PDF in the C:\RioOso Folder Path.
  • For more information visit SQL Query Data Source and Report Design

Perspective Report View​

Report will use start and end time parameters to allow users to select date ranges in Perspective
  • Look for the Perspective view that contains the report viewer
  • Verify the report viewer has the report showing
  • Verify the view with the report contains date picking components, like a date range or multiple calendars
  • In Perspective, verify the StartDate and EndDate parameters are added to the params property and both dates have bindings to the date components
  • For more information visit Perspective - Report Viewer

Vision Report Window​

Report will use start and end time parameters to allow users to select date ranges in Vision
  • Look for the Vision window that contains the report viewer
  • Verify the report viewer has the report showing
  • Verify the window with the report contains date picking components, like a date range or multiple calendars
  • In Vision, verify the Report Parameters have bindings to the date components
  • For more information visit Vision - Report Viewer