Knowledge Base Archives - Page 37 of 71 - Industrial IoT Data Platform

July 12, 2017January 31, 2023

Web HMI Dashboard Modules

Modules are each self-contained, and files relative to each can be found in the installation directory under the modules folder.
At a minimum, under each module folder you fill find a module.js file and a style.css file. The module.js file is the core module executable, and the style.css contains specific stylesheet rules used by the module. Some modules may contain other assets, such as the Demo Module.

Removing Modules
To remove a module from the application, you simply need to remove the reference to the module script and stylesheet within the index.html file. These references are found in the <head> element of the index.html file. Once you remove these references, the module will no longer appear in the list of of modules for users to select.

See lines 31 – 51 in the code below to locate the module references.

If you are interested in modifications to the Web HMI Dashboard, or would like to speak with us about creating a module specific to your application, Contact Us today!

Demo Module

The Demo Module is an example of an interactive, visual representation of a physical system, with pumps, valves, and fluid level sensors. You can click or tap on each of the valves and pumps to simulate fluid flowing into or out of the two tanks. The corresponding tags in the OAS server can be found under the WPF/New Tanks Demo structure that is present in the demo tags included with each installation.

Numeric Tag Module

This module allows you to display a real time numeric value rendered as a gauge. As values change, the needle will animate, indicating the current value.can be configured

Configuration settings

Tag Name: the tag to be visualized – click the icon to browse or manually enter the tag
Label: the text label displayed below the current value
Min/Max: the range that determines the needle position (default: 0/100)
Gain/Offset: optional multiplier and value offset applied to the raw value
Decimals/Units: number of decimal places to display, and unit suffix added to the value
Read/Write: when checked, displays an input field, allowing users to set the tag’s value

Boolean Tag Module

This module displays the current live value of a Boolean Tag. When configured to allow for read/write access, the display icon becomes a switch. If the switch is clicked or tapped, the server value will be toggled between True and False. The display can also be customized so that True and False text can be replaced with text of your choosing.

Configuration settings

Tag Name: the tag to be visualized – click the icon to browse or manually enter the tag
Label: the text label displayed with the current value
False/True: optional text to display when the value is false or true, respectively
Gain/Offset: optional multiplier and value offset applied to the raw value
Text Scale: optional scaling % applied to text
Read/Write: when checked, changes the indicator to a switch icon and allows the user o toggle the value

Tag Data Module

This modules allows for the display of multiple server Tags along with their data type and real time values. This is very useful for checking the raw data coming from the server within a single tabular format. This module also allows the end user to modify Tag values when the Read/Write option is enabled.

Configuration settings

Label: the text label displayed above the grid
Tags: the list of tags to display – click the icon to choose one or more tags
Read/Write: when checked, adds an edit button next to each tag, allowing the user to set the tag’s current value

Alarm Module

This module encapsulates the Web Alarm viewer and allows the end-user to configure it to display the columns desired. It also allows users to configure the viewer to filter alarms by type, group, status, and priority. Because it is based on the Web Alarm product, it retains all functionality. See the following for more information on Web Alarm.

Configuration settings

Label: the text label displayed above the alarms
Show Search/History: when checked, display the inline search and historical input fields
Alarm Types: list of Alarm Types to include in the display
Alarm Groups: a comma-delimited list of Alarm Groups to include in the display, defaulting to all if left blank
Network Nodes: a comma-delimited list of Network Nodes to include in the display, defaulting to localhost if left blank
Columns: list of Alarm fields to display in the grid
Include Alarms: list of Alarm statuses to include in the display
Priorities: the min and max priorities to include in the display

Trend Module

This module encapsulates the Web Trend viewer and allows the end-user to configure it to display a chart plotting both real time and historical trends. Because it is based on the Web Trend product, it retains all functionality, but requires no programming to configure. See the following for more information on Web Trend.

Configuration settings

Label: the text label displayed above the chart
Sample Rate: the frequency (in seconds) for each data point to be acquired
Timeframe: the number of seconds in the initial data set
Retain: The number of data points to retain in client memory – as more data is received, the chart will animate as it flushes non-retained values
History Data: when checked, allows users to select start and end dates for displaying historical data
Pens: click Add Tag to add a pen linked to a server tag. Each tag will include settings for Name, Label, Line style, and Y-axis range and position

Custom Module

This module allows you to specify any web URL so you may embed your custom code into the Web HMI Dashboard. You can either host the contents of a Custom module on any web server, or you may also add it to the modules folder in the application itself.

The module has a single parameter of a URL. When you use an absolute URL (containing the full URL such as “http://someurl.com/page”), the module will load from the source. If you use a relative URL (e.g. “somepage.html”) it will be loaded from the Web HMI Dashboard root folder.

This folder is located in the OAS installation directory under /webapps/webhmi.
Note: previous versions of the OAS server located these files within a www directory in the installation directory.

For example, if you create an HTML page titled index.html and you put it in a folder titled “newModule” under the modules folder, set the URL parameter to “modules/newModule/index.html”.

If you are interested in modifications to the Web HMI Dashboard, or would like to speak with us about creating a module specific to your application, Contact Us today!

July 12, 2017January 31, 2023

Web HMI Dashboard Deployment

Default installation – No web server required

Once you have configured the Web HMI Registration host and port within the steps defined in Getting Started, you can now access the Web HMI Dashboard from your browser.
Open a browser to the Web HMI Dashboard at the following address:

http(s)://<server>:<port>/app/home

For example, if you are on the same machine as the OAS Service installation, you are not using SSL, and you are using the default port, the URL will be:

http://localhost:58725/app/home

By default, the Web HMI Dashboard will run in Demo Mode which will do the following:

All logins no matter the credentials, will be allowed to log into the application and be provided individual dashboard settings
New logins will be pre-populated with demo dashboards

To alter any application configurations, locate the Web HMI Dashboard directory located in the installation directory for Open Automation Software. This is typically:

C:\Program Files\Open Automation Software\OAS

The Dashboard folder is located in the OAS installation directory under /webapps/webhmi.
Note: previous versions of the OAS server located these files within a www directory in the installation directory.

Within this directory, look in the “js” directory and locate the file app_config.js. This is a JSON file containing application settings.

oas_url : optional hard-coded URL of the OAS server location. Omit this setting and the application will assume the server:port used to connect to the app
show_login_url : <true | false> determines if the OAS url can be supplied by the user in the login screen to point the application to a specific OAS service
session_timeout : <integer> number of minutes of inactivity before the user session is ended and the login screen is displayed
demo_mode : <true | false> enables or disables demo mode, enabling logins with any credential and enabling the refresh button to reset all dashboard modifications to the defaults
demo_dashboards : a JSON representation of the demo dashboards pre-populated for new users in demo_mode

Standalone web server deployment

If you choose to host the Web HMI Dashboard on your own web server, simply copy the contents of the www directory (described above) to the web server like any other static files. Be sure to include all files and folders within the www directory.

NOTE: when hosting the Dashboard on a separate server, you must alter the app_config.js setting for oas_url. This must be the server:port of the OAS server hosting the live data. This setting must be in the form:

http(s)://<server>:<port>

July 12, 2017January 8, 2025

Getting Started – Web HMI Dashboard

NOTE: The OAS Open UIEngine is a more feature-rich, no-code HMI and application development platform for your automations than the Web HMI Dashboard, which is a basic set of tools for visualization.
See the UIEngine Documentation to learn more.

View the following video demonstrating the Web HMI Dashboard.

00:00 – Features of a WEB HMI Dashboard
01:33 – Alarm Dashboard
01:39 – Trend Dashboard
01:55 – Add a Dashboard
02:04 – Add a Module
02:59 – Built-in Modules
03:04 – Numeric Tag Module Configuration
04:53 – Boolean Tag Module
05:56 – Display Multiple Tags with real time values
07:09 – Alarms Module
08:21 – Trends Module
10:28 – Custom Module
10:34 – Configuration
11:16 – Demo Module
11:43 – Getting Started
12:58 – Open OAS Configuration App
13:20 – Static Files
14:46 – Removing a Module
16:25 – Deploying to IIS
18:41 – Conclusion

Step 1

Configure Web Services within the OAS Platform. For instructions on how to accomplish this as well as optionally using SSL for secure communications, see the following article:
Configuring OAS Web Services

Step 2

Open a browser to the Web HMI Dashboard at the following address:

http(s)://<server>:<port>/app/home

For example, if you are on the same machine as the OAS Service installation, you are not using SSL, and you are using the default port, the URL will be:

http://localhost:58725/app/home

Step 3

Once presented with the Web HMI Dashboard login screen, enter in an OAS server credential, or leave blank to use the default server credential and click “Sign In“.

Upon successfully logging in, you will be presented with your personalized Web HMI Dashboard. If the application is in Demo Mode, you will be provided with some demo dashboards and you will see live data flowing into each module. All modifications to your dashboard will be saved within your login and remembered for your next session.

Additional Configuration Settings

By default, the Web HMI Dashboard will run in Demo Mode which will do the following:

All logins no matter the credentials, will be allowed to log into the application and be provided individual dashboard settings
New logins will be pre-populated with demo dashboards

To alter any application configurations, locate the Web HMI Dashboard directory located in the installation directory for Open Automation Software. This is typically in C:\Program Files\Open Automation Software\OAS. The Dashboard directory is labeled “www“.

Within this directory, look in the “js” directory and locate the file app_config.js. This is a JSON file containing application settings.

oas_url : optional hard-coded URL of the OAS server location. Omit this setting and the application will assume the server:port used to connect to the app
show_login_url : <true | false> determines if the OAS url can be supplied by the user in the login screen to point the application to a specific OAS service
session_timeout : <integer> number of minutes of inactivity before the user session is ended and the login screen is displayed
demo_mode : <true | false> enables or disables demo mode
demo_dashboards : a JSON representation of the demo dashboards pre-populated for new users in demo_mode

July 12, 2017January 8, 2025

Overview – Web HMI Dashboard

The Web HMI Dashboard is a an application that utilizes Web HMI, Web Trend, and Web Alarm and comes included at no cost with any of these products. It allows you to visualize real time and historical data from within desktop and mobile browsers without the need for any HTML coding to deploy it.

Since it is built upon the Web HMI product, it requires the installation and licensing of Web HMI. However, it can be accessed without the installation of an additional web server, or you are free to install it on a web server of your choosing.

If you wish to integrate data into an existing web interface or your own application please see Getting Started WEb HMI, Web HMI Wizard, Web Trend, and Web Alarm for full flexibility to update any HTML element dynamically based on OAS live and historical data.

April 10, 2017December 3, 2020

Log Buffered Data from a PLC or Controller

For high speed applications with data frequency up to 100 nanoseconds, or remote systems with intermittent connectivity data can be buffered in the device and logged easily using Open Automation Software with the following guide. OAS can log this buffered data in a wide table format to a database or CSV file. This can be done with arrays or data queues in the controller.

View the following video for a complete demonstration on how to log 1 millisecond data from a controller:

This feature can be used with all data sources including Allen Bradley, Siemens, Modbus, OPC and OPC UA servers, .NET applications, and Universal Driver Interfaces running locally or remote.

When to use buffered data logging

Desired logging frequency is faster than communication rate to PLC or controller
Communication to the PLC or controller is intermittent

This guide will focus logging 3 values with 3 data arrays and 1 timestamp array.

The following simulation program will help easily simulate a controller data processing with the following application.
It is not to be used in for your final operation of logging buffered from a controller. It will help automated the tag setup and simulate data coming from a controller.
Array Data Emulator – Simulation of logging buffered data from a controller.
Download Array Data Emulator Sample Code
Note: The Array Data Emulator program you will need a license of the .NET Data Connector and Data Logging for an additional 4,007 Tags or in Demo Mode. If you need to test this feature on a production license and do not have these products contact our support team at support@oasiot.com.
You only need a Data Logging license and a Driver if using a controller as a data source.

Step 1

Create Handshaking Logic in Controller
In the controller or PLC define the following variables if they do not already exist. These variables and logic are simulated in the Array Data Emulator program.
Note: You can skip this step if you are using the Array Data Emulator in your first trial of buffered logging.

Values: Arrays containing queued values to be logged. The data type of the array can be anything you desire including Double Float, Single Float, Long Integer, Integer, Short Integer, Boolean, or Strings.
Timestamp: Optionally specify a String array containing queued timestamps for each sample in the value arrays. The values in each element would either be a date value or a string that would represent a date including milliseconds if desired.
Ready: Boolean variable that controller will set to true when the array values are all loaded and ready.
Confirmation: Boolean variable that will receive a confirmation that the values in the data array are received to be logged. When this value is set to true the controller will set this variable back to false, reset the array of values, and fill the array of the next set of data to be logged.
Error: Integer variable that will be set to an error code if there is a problem with the logging of data values.
Timeout: Internal time period the controller will wait for either the Confirmation bit or Error Integer after the Ready bit is set to true. If the time elapses without either Confirmation or Error after the Ready is set the controller will abort the logging and not reset the array and try the sequence again and post an error to the operator that logging has halted.

Create the following logic routines in the controller if they do not already exist.

Fill the Values array with the sequential values to be logged.
Set the Error integer to 0.
Set the Confirmation bit to false.
Set the Ready bit to true.
If the Confirmation feedback bit goes to true.
- Clear the Values array.
- Return back to the first step
If the Error feedback integer goes to non zero.
- Inform operations that logging has halted.
- Return back to the first step
If the Confirmation bit or Error integer are never received within the timeout period.
- Inform operations that logging has halted.
- Return back to the first step

Step 2

Create Tags
If testing without a controller run the ArrayDataEmulator.exe application from the bin/Release directory.

Click on the Create Tags button.

Run the Configure OAS application.
Select Configure-Tags and click on the Select button to the right of Network Node.

There you will see the Tags created by the Array Data Emulator program automatically which will be the same type of tags you can reuse or add manually for the controller communications. The Data Source is just set a Value for this emulation where you would set the Data Source to your controller’s communication driver.

Confirmation
Data Type: Boolean
DateArray
Data Type: Array String
Error
Data Type: Integer
Ready
Data Type: Boolean
ValueArray1
Data Type: Double
ValueArray2
Data Type: Double
ValueArray3
Data Type: Double

Step 3

Setup Data Logging
From the Configure OAS application select Configure-Data Logging and click on the Select button next to the network node field.

Getting Started-Data Logging 1

Select the Local OAS Service by selecting the Select button or the Local node in the service tree to the left.

Getting Started-Tags 4

Enter the Logging Group Name of Test in the field in the upper right.

Check Logging Active in the Common Properties Tab.

Set the Logging Type to Event Driven.

Use the Browse button to set the Trigger Tag to “Buffer Test.Ready.Value”

Set the Confirmation Tag to “Buffer Test.Confirmation.Value”

Set the Error Tag to “Buffer Test.Error.Value”

Note: For the fastest transaction processing enable the property “Confirm With Success Immediately Before Database Write”. This will send the confirmation back to the controller before logging the values to the database. You can rely on the Data Buffer feature under Configure-Options to buffer the records to disk if there is a database engine error.

Step 4

Define Date and Time to Log
Select the Tags tab in the logging group.

Uncheck the property to Include Date and Time Field.

Note: If you want to include timestamps for your date the time should come from the controller. All OAS Data Sources receive the timestamp with the value source, but in this Event Logging time the Date and Time come from the Trigger Tag value, not the array values in the controller.

Select the Add Field button.

If you want to log timestamps with your values select the Tag Parameter Buffer Test.DateArray.Value.

Add [0] to the end of the tag name to log the first element and specify the number of elements to add, the same size of the array in the controller. If using the Array Data Emulator simulation enter 1000 as the Number of Elements to Add.
Click OK

Change the field name in the next dialog to DateAndTime or to the database column name you desire for the timestamps.

Note: If each individual sample needs to be accessed as individual tags you can use the Add Tag button to add additional tags.

Change the Data Type to Date/Time.
Click OK

Step 5

Define Values to Log
Select the Add Field button again to select the data arrays.

Select the Tag Parameter Buffer Test.ValuesArray1.Value.

Add [0] to the end of the tag name and specify the number of elements to add, the same size of the array in the controller or 1000 if using the Array Data Emulator.
Click OK

Change the field name in the next dialog to Value1 or to the database column name you desire for this array.

Note: If each individual sample needs to be accessed as individual tags you can use the Add Tag button to add additional tags.

Click OK

Repeat Step 5 for Value2 and Value3 or as many additional fields you wish to add. All should have the same array size by setting the Number of Elements to Add the same.

Step 6

Specify Database Table or CSV File
Select the Database tab of CSV Logging tab to define where the data will be logged. In this example we will log the data to SQL Server.

Logging to SQL Server or SQL Server Express
Use the following configuration for SQL Server. The Database and Table will automatically be created for you.

Note: You can download a free version of SQL Server Express from https://www.microsoft.com/en-us/sql-server/sql-server-editions-express.
When installing SQL Server Express also select the option at the end to install SSMS (SQL Server Management Studio) which you can use to set security Logins and to view the data that is being logged.

Check Log To Database

The Server name may need to be adjusted from localhost to the proper Server name of the SQL Server engine you wish to log to. This Server name can be found when first bringing up the Connect dialog of the SQL Server Management Studio.

Also the login method can be with Windows Authentication or SQL Server mode. Contact your database administrator if you are unsure of what login type to use.

Set the Database name to OASSimulation

Set the Table name to DataBufferTest

Click the Add button at the bottom to add the data logging group to the OAS service.

Logging to Microsoft Azure

Use the SQL Server Provider and view the following guide to setup Microsoft Azure:

/knowledge-base/windows-azure-setup/

Logging to Oracle

If you are using Oracle you must first create the database. All other steps are the same as SQL Server except the provider should be set to Oracle. Oracle does not create the database so you will have create the database manually.

If you do not have a TNSNAMES.ORA file or need to log to a remote database engine refer to the Frequently Asked Questions in this Data Logging topic.

Logging to mySQL, MariaDB, SQLite, MongoDB, PostgreSQL

All steps are the same as using SQL Server except the provider should be set to you desired provider.

Logging to Cassandra

Cassandra requires a primary key on the Date and Time and event logging without the Date and Time included is not permitted.

Logging to Comma Separated Variable Files

Use the following configuration for CSV text logging.

Make sure to create the directory OASSimulation on your C drive or specify a different file path that will exist.

Step 7

Activate Controller Logic or Data Emulator
After completing the above steps you can enable your controller logic or click on view the data in your database or CSV file.

If running the Array Data Emulator select Run Simulation.

The data is now ready to be viewed in your destination.
If logging to SQL Server use the SQL Server Management studio to view the contents of the table DataBufferTest under the OASSimulation database.

Here you will see all of the records at the sample rate you desire with continuous data from the date and time and values. Using the Array Data Emulator the sample rate is 1 millisecond. It can be even faster if your controller has a cycle time or can process sensor data and queue it into an array at a faster rate.
The source code of the Array Data Emulator is provided in the download so you can testing logging at a faster rate or change the size of the arrays to log.

Step 8

Save Configuration for Loading
Select the Save button on the toolbar at the top under Configure-Data Logging to save a file.
Select the Save button on the toolbar at the top under Configure-Tags to save a save the tag configuration file.
Go to Configure-Options and set the default Tag and Data Logging Configuration files you just saved.

Step 9

Data Buffer to Disk on Database Engine or CSV File Lock
Important: Enable Data Buffer To Disk under Configure-Options-Data Buffering on all data source Tag servers and data logging servers to retain data on a network failure, database engine failure, or if Excel has a CSV file open as it locks it for exclusive use.
Without this property enabled data buffering on failure will use up RAM of the operating system.

For more detailed information on each data logging parameter view the Data Logging section of this Knowledge Base.

April 7, 2017February 16, 2021

How to Log Data to an Azure IoT Hub

This guide shows how to log data to an Azure IoT hub in three easy steps.

STEPS

Follow the links to the OAS Help articles:

Make sure Open Automation Software is installed and the OAS Service is running

Configure your data source

Configure Azure data logging – this consists of three sub-steps covered in the article:

Create an Azure IoT Hub (Windows Azure website)
Create an IoT Driver
Route Live Data to your Azure IoT Hub

How to Log Data From an AWS IoT Hub to a Database

Open Automation Software Tags can be defined to interface with AWS IoT Gateway with the built in AWS IoT Gateway Driver Interface. This tutorial walks you though downloading and installing OAS, configuring an AWS IoT Gateway driver, configuring tags and logging them to a database. Supported databases include SQL Server, Oracle, Access, PostgreSQL, Cassandra, MongoDB, MariaDB, SQLite, InfluxDB, MySQL, SQL Azure, Amazon Aurora, Amazon RDS, Amazon Redshift, Google Firebase, and CSV files.

Step 1. Download and Install the Open Automation Software and Start the OAS Service

If you have not already done so, you will need to download and install the OAS platform. Fully functional trial versions of the software are available for Windows, Windows IoT Core, Linux, Raspberry Pi and Docker on our downloads page.

On Windows run the downloaded Setup.exe file to install one or more of the Open Automation Software features. Select the default Typical installation if you are not sure what features to use or the Custom installation if you want to save disk space on the target system. When prompted agree to the End User License Agreement to continue the installation.

For more detailed instructions and video tutorials, visit the installation guide for your system:
Windows Installation | Linux Installation | Raspberry Pi Installation | Dockers Installation

The OAS Service Control application will appear when the installation finishes on Windows. Use this application to start the 3 Services. Run the Configure OAS application on Windows and select Configure-Tags; if the first time running, the AdminCreate utility will run to create an Administrator login as shown in Step 1 of Getting Started – Security.

Step 2. Configure Your AWS IoT Gateway Data Source

First, you will need to open the Configure OAS application from the program group Open Automation Software.

Select Configure >> License from the top menu and verify that AWS IoT is one of the available Drivers in the lower left of the form. The demo license will have this by default. If you do not see AWS IoT available, contact support@openautomationsoftware.com to update your license.

Select Configure >> Drivers from the top menu.

Select localhost or the remote service you wish to modify with the Select button to the right of the Network Node list.

The Configure Drivers Screen will appear. Select AWS IoT Gateway from the Driver dropdown box.

Enter a meaningful Driver Interface Name that you will refer to this physical connection when defining Tags with an AWS IoT Data Source.

Define the properties for the desired physical connection.

Click the Add Driver button above the Driver list in the left pane to add the Driver Interface as an available selection when defining Tags in the next step.

For more detailed instructions on configuring your AWS IoT Gateway data source, click here to see our Getting Started AWS IoT Gateway tutorial.

Step 3. Configure Your Tags

OAS provides multiple ways to add and define tags:

Manually add and define Tags using the Configure OAS application. …learn more…
CSV Import and Export …learn more…
Programatically …learn more…
One Click Allen Bradley …learn more…
One Click OPC …learn more…

To add a Tag manually:

In the OAS Configure Application, select Configure >> Tags from the top menu.

Select localhost or the remote service you wish to modify with the Select button to the right of the Network Node list.

Click on the Add Tag button located at the top of the Tag browser on the left portion of the screen.

A dialog box will appear. Enter a name for your new tag and click ok.

A configuration screen will appear for your new tag. Select your data source type in in the Data Source dropdown box.

Specify the correct data type in the Data Type dropdown box.

Click Apply Changes at the bottom right of the window.

For more detailed instructions on configuring your tags, click here to see our Getting Started Tags tutorial.

Step 4. Configure Data Logging

In the OAS Configure Application, select Configure >> Data Logging from the top menu.

Select localhost or the remote service you wish to log data from with the Select button to the right of the Network Node list.

A Logging Group screen will appear.

In the Common Tab, you will determine your table format and type of logging you wish to implement.

In the Tags Tab, you will select the tags you wish to log.

In the Database Tab, you will select what type of database you will be logging to and enter the connection parameters. OAS can log to SQL Server, Oracle, Access, PostgreSQL, Cassandra, MongoDB, MariaDB, SQLite, InfluxDB, and MySQL.