Posted on

Logging Group Common Properties

Article Contents
Logging Group Name
Logging Active
Activate Logging With Tag
Keep Items On Scan When Logging is not Active
Disable Logging Initial Values On Active
Logging Type
Logging Rate
Snapshot Time
Event Driven Logging Tag
Digital Log Type
Perform OPC Device Read
Time Of Day
Data Change Deadband
Disable New Time Stamp Check
Set Date and Time to Previous Day 11:59:59 PM
Write Data Immediately
Create Primary Index when Table is Created
Recorded Date and Time Offset
Delete Old Database Data
Enable Confirmation Tag
Enable Error Tag
Confirm With Success Immediately Before Database Write
Do Not Buffer On Error

Common Properties Tab

Logging Group Name

The name that identifies the Logging Group in the Data Logging configuration. This name appears in System Alarms if there is a failure with the data logging.

Logging Active

Enable or Disables the Logging. This can be controlled with a Tag Parameter value if Activate Logging with Tag is specified.

Activate Logging With Tag

When enabled the Logging Active (see above) selection is controlled with the specified Tag and Parameter that is specified. When the value of the Tag Parameter is True the logging is set to Active, and when the value is False the logging is set to Inactive.

Keep Items On Scan When Logging is not Active

When enabled and the logging groups is disabled the group keeps the Tags on scan to the logging group. This is helpful when using Tags or DirectOPC Items that have the Keep OPC Item On Scan set to false and you would like to keep the items on scan with the OPC Server.

Disable Logging Initial Values On Active

When logging is first made active and Data Change Logging Type (see below) is selected this option will reject the initial current values from being logging. Only new changes will be logged after the logging is active when this option is selected.

Logging Type

  • Continuous: Log data at the specified Logging Rate (see below). The minimum logging rate is 100 nanoseconds.
  • Event Driven: Log data when the Event Driven Logging Tag (see below) Parameter value transitions. The time resolution for this feature is 100 nanoseconds. The trigger can be a Boolean set to transition from False to True, True to False, or Both. The trigger can also come from an Integer tag that will trigger the logging anytime the value changes and the value is non-zero.
  • Snapshot: Log a collection of data that is buffered at the time set in Snapshot Time when the Event Driven Logging Tag Parameter value transitions.
    Specific Time Of Day: Logging occurs at the specific Time Of Day (see below).
  • Data Change Row: Will log a new row anytime one or more of the Tag values changes.
  • Data Change: Will log a new record for every tag any time they change. This logging type has a narrow table format logging the Date and Time, Tag Name Alias, and Value for each value. This logging type has the benefit of being able to specify more than 1,000 tags in a logging group, but can use up more disk space in the database engine if all of the values are changing frequently.
  • Merlin: This a special type of logging group designed specifically for an OEM customer. This type is not applicable for logging.

Logging Rate

The rate of logging when the Logging Type (see above) is set to Continuous or Snapshot. The minimum logging rate is 100 nanoseconds. Logging Active (see above) must also be set to True.

Snapshot Time

When the Logging Type is set to Snapshot this is the time to hold in a buffer at the rate specified by Logging Rate to then log when the Event Driven Logging Tag transitions.

Event Driven Logging Tag

With the Logging Type is set to Event Driven or Snapshot this is the Tag Parameter that will cause the logging to occur when the value transitions.  The trigger can be a Boolean set to transition from False to True, True to False, or Both.  The trigger can also come from an Integer tag that will trigger the logging anytime the value changes and the value is non-zero. Logging Active must also be set to True.

Digital Log Type

With the Logging Type is set to Event Driven and the Event Driven Logging Tag is specified as a Boolean Tag this will determine this is the Tag Parameter that will cause the logging to occur when the value transitions.

The trigger can be a Boolean set to transition from False to True, True to False, or Both. The trigger can also come from an Integer tag that will trigger the logging anytime the value changes and the value is non-zero. Logging Active must also be set to True.

Perform OPC Device Read

When the Logging Type is set to Event Driven this will perform a Device Read to OPC Servers on all OPC Items and synchronous read on all Open Automation Software Tags that are not defined and OPC Items.

Once all of the values are received from the synchronous blocking calls the values will be recorded.

Time Of Day

With the Logging Type set to Specific Time Of Day this will be the time that the logging will occur. Logging Active must also be set to True.

Data Change Deadband

With the Logging Type (see above) set to Data Change Row or Data Change this is the amount in engineering units for floating point values to change by in order for a new record to be recorded. A value of 0 disables the deadband and all value changes will be recorded. Logging Active must also be set to True.

Disable New Time Stamp Check

With the Logging Type (see above) set to Data Change Row or Data Change and a value does not change, but the time stamp does normally a new record will be recorded.  With this option selected a change in the time stamp alone will not cause a new record to be recorded.

Set Date and Time to Previous Day 11:59:59 PM

Works well with Event Driven (see above) or Specific Time Of Day (see above) logging to set the logged time stamp to the previous day date and the time at 11:59:59.000.  This helps with report queries by rolling back the date to the previous day just before midnight. Often used in end of day reporting that has to occur after midnight.

Write Data Immediately

For Continuous and Snapshot logging type’s data is normally buffered for up to 10 seconds at a time and written to the database as a bulk insert.  When the property Write Data Immediately is enabled the buffering feature is not used and data is written immediately to the database for any new records.

Create Primary Index when Table is Created

With Logging Type (see above) set to Event Driven, Data Change Row, or Data Change this option will create a primary index on the Date and Time field together with the Millisecond, Microsecond, and Nanosecond fields if they are specified. If you use this option make certain that all of the records will have a unique Date and Time for each record.

Recorded Date and Time Offset

This will offset the Date and Time recorded to the database by the offset specified.  Used commonly to change the Date and Time to a different time zone time that what the OPC Server is in.

If you prefer to use Universal Time Code select the option Use UTC TimeStamp under Configure – Options.

Delete Old Database Data

Enable to automatically delete data from the current specified database table.  When enabled specify the amount of days to keep. This feature is not available for CSV logging.

Enable Confirmation Tag

The Confirmation Tag can be set to a Boolean Tag to give feedback that the data logging has succeeded. The Tag value will be set to False when one or more records is to be recorded, then when the record has been successfully logged to the database the value of the Tag will be set to True.

Following is a common sequence of operation in the PLC:

  1. Set the confirmation bit and trigger bit in the PLC to False.
  2. Set the values to be logged.
  3. Wait for trigger bit feedback using Target of OPC Tunnel to confirm trigger has been received as False.
  4. Set the Trigger bit high.
  5. Wait for the confirmation bit to be True or the Error Integer feedback to be non-zero if there is an error.
  6. If confirmation received repeat again starting with step 1.

With the property Confirm With Success Immediately Before Database Write (see below) enabled the Confirmation Tag value will be set to True immediately unless the data quality of one or more of the values to be recorded is bad.

Enable Error Tag

The Error Tag can be set to an Integer Tag to give feedback that the data logging has failed due to 1 of 16 different reasons. The Tag value will be set to 0 when one or more records is to be recorded, then when the record has been successfully logged to the database the value of the Confirmation Tag will be set to True.

If there is an error in the recording the Error Tag value will be set to non zero for one of the following causes:

  •     ‘ 0 = No Error
  •     ‘ 1 = OAS Data Log is not licensed
  •     ‘ 2 = Error opening database connection
  •     ‘ 3 = Error opening database connection after creation
  •     ‘ 4 = Error creating database
  •     ‘ 5 = Error accessing open connect during table creation
  •     ‘ 6 = Error creating table
  •     ‘ 7 = Error creating fields
  •     ‘ 8 = Error creating stored procedure
  •     ‘ 9 = Error writing to database, command is not setup
  •     ‘ 10 = Error picking up values to write
  •     ‘ 11 = Error writing values, failed both stored procedure and udpate method
  •     ‘ 12 = Error writing values, connection is not open
  •     ‘ 13 = Error creating CSV file
  •     ‘ 14 = Error opening CSV file to append
  •     ‘ 15 = Error writing to CSV file
  •     ‘ 16 = Error in data quality, bad OPC quality or null value.

Following is a common sequence of operation in the PLC:

  1. Set the confirmation bit in the PLC to False.
  2. Set the values to be logged.
  3. Wait for trigger bit feedback using Target of OPC Tunnel to confirm trigger has been received as False.
  4. Set the Trigger bit high.
  5. Wait for the confirmation bit to be True or the Error Integer feedback to be non-zero if there is an error.
  6. If confirmation received repeat again starting with step 1.  If Error Tag value is non zero report as an alarm and try again with the same values.

With the property Confirm With Success Immediately Before Database Write (see below) enabled only error 16 on bad data quality will be used for the confirmation.

Confirm With Success Immediately Before Database Write

With this property enabled the Confirmation Tag value will be set to True immediately unless the data quality of one or more of the values to be recorded is bad.  If this property is used make sure to enable the Store Data Logging Buffer to Disk property under Configure-Options to True so there is no data loss if there is a database engine failure.

Do Not Buffer On Error

When this property is enabled no data buffering occurs if there is an error in writing values to the database engine or CSV file.

Posted on

One Click Database

Data Logging Groups can be automatically setup by using the One Click Database feature that browses Open Automation Software Tags automatically and creates data logging groups based on the tags in a selected services. You can then modify or delete data logging groups from the configuration that you do not want.

View the following video on how to use the One Click Database Feature or follow the steps in the table below:

Step 1

OAS
Start Configure OAS application from the program group Open Automation Software.

 

 

Step 2

Select Configure – Data Logging.

Datalogging Menu

Step 3

Select the Local OAS Service by selecting the Select button or select a remote network node by entering an IP Address or Network Node Name and click on the Select button.

Network Node

Step 4

Select the One Click button in the upper menu bar.

One Click Data Logging

Step 5

In Step 1 of the One Click Database Wizard use the Tag Group Browse button to select a starting Tag Group or leave the Tag Group blank to obtain all Tags of the OAS Service defined in the Network Node and optional Live Data Node fields.

One Click Data Logging Step 1

Also specify a Group Name that will be the base group name of all of the logging groups.

Step 6

In Step 2 specify the Logging Type and other Common properties to all Logging groups.

One Click Data Logging Step 2

Step 7

In Step 3 define the names of the common database field names.

One Click Data Logging Step 3

Step 8

In Step 4 define the Database Provider, Server, Database, and base Table name to log to if logging to a database engine. You can skip this step if you plan to log only to CSV files.

One Click Data Logging Step 4

Step 9

In Step 5 define the CSV Logging Path and File Name if you wish to setup all logging groups to log to a CSV file.

One Click Data Logging Step 5

Step 10

Click the Finish button in the lower right to begin the automated setup.

Step 11

Select the Save button on the toolbar at the top.

Save Button
Step 12

Go to Configure – Options and set the default Data Logging Configuration file to the file you just saved.

Posted on

Getting Started – Data Logging

You can log any Tag or DirectOPC item value from Open Automation Software to CSV files and the database engines SQL Server, Oracle, Access, PostgreSQL, Cassandra, MongoDB, MariaDB, SQLite, InfluxDB, Amazon Aurora, Amazon RDS, Google Firebase, and MySQL.

You can view the Getting Started with Data Logging Video to familiarize yourself with the following steps to setup data logging.

Step 1

OAS
Start Configure OAS application if it is not already running.

Step 2

Select Configure – Data Logging.

Datalogging Menu

Step 3

Select the Local OAS Service by selecting the Select button.

Network Node

Step 4

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

Logging Group Name

Check Logging Active in the Common Properties Tab.

Logging Active

Step 5

Determine your table format and type of logging you wish to implement and set the Logging Type.

Loggint Type

  • Continuous: Log data in a wide table format at a specific rate.
  • Continuous Narrow: Log data in a narrow table format at a specific rate.
  • Event Driven: Log data in a wide table format when a Boolean or Integer Tag changes.
  • Snapshot: Log cached data in a wide table format when a Boolean Tag changes.  The cached data is collected prior to the event and only logged when the event occurs.
  • Specific Time Of Day: Log data in a wide table format at a specific time of day.
  • Data Change Row: Log data in a wide table format when any of the tag values change.
  • Data Change Narrow: Log data in a narrow table format when the tag value changes.
  • Merlin: Not applicable, only used for one of our OEM customers.

Wide Table Format: Specify a specific column to map the tags to log to.

Narrow Table Format: Log all tag values into 3 fields, Tag Name, Value, and Timetamp.  This type is more difficult to query directly and is not supported by trend history.

We use the default Logging Type of Continuous at a 1 second rate in this example.

Step 6

Select the Tags Tab.

Tags Tab

Step 7

Select the Add Field button.

Add

Step 8

Select your Network Node in the Browse Tags window.  Then use the Tags Tree to select the Ramp.Value.

Value is the most commonly used Variable.  See Tag Variables for a complete list of all variables possible.

Local Tag

myGroup.myTag.Value

Basic Networking

\\192.168.0.1\myGroup.myTag.Value

Live Data Cloud Networking from local OAS Engine

RemoteSCADAHosting.myLiveDataCloudNode.myGroup.myTag.Value

Live Data Cloud Networking though remote OAS Engine

\\192.168.0.1\RemoteSCADAHosting.myLiveDataCloudNode.myGroup.myTag.Value

The following is an example of accessing an element of an array as a read only variable.

myGroup.myTag.Value[0]

Adding Multiple Tags

To add multiple tags from a tag group select the group and click ADD ALL TAGS FROM to add all tags in one step.  Leave the group field blank located to the right of ADD ALL TAGS FROM to add all of the tags in a service.

Click OK.

Tag Browse

Confirm that you have the correct information in the Database Tag window that pops up. Click Ok.

Database Tag

Step 9

Repeat steps 7 and 8 for the Tag Parameter Random.Value.

Repeat steps 7 and 8 for the Tag Parameter Sine.Value.

Selected Tags

Step 10

Select the Database Tab.

Database Tab

Step 11

Logging to SQL Server or SQL Server Express

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

SQL Server Setup

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.

Getting Started-Data Logging 10

You can download a free version of SQL Server Express from www.microsoft.com.

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 wish to use a name from TNSNAMES.ORA file refer to the Frequently Asked Questions in this Data Logging topic as OAS uses OracleManagedDataAccess assembly.

Logging to mySQL

All steps are the same as using SQL Server except the provider should be set to mySQL.
For maximum throughput set the following in C:\ProgramData\MySQL\MySQL Server 8.0.

max_allowed_packet=1G

Logging to MongoDB

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

Logging to PostgreSQL

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

Logging to Cassandra

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

Logging to MariaDB

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

Logging to SQLite

All steps are the same as using SQL Server except the provider should be set to SQLite and the File Path property should be set to the directory and file name for the file.

Logging to InfluxDB

All steps are the same as using SQL Server except the provider should be set to InfluxDB and you can adjust the Indexed Fields property if more than DateAndTime tag is required.

Logging to Microsoft Access

If you prefer to use Microsoft Access instead of SQL Server use the following configuration for Microsoft Access. The Database and Table will be automatically created for you. Make sure to create the directory C:\OASLoggingDemo\ on your C drive or specify a different Database path that will exist. When logging to MS Access 2007 or later use the extension .acccdb. Versions older than 2007 use the classic .mdb extension. This will switch the OAS data logging engine to use the correct provider.

MS Access Setup

Logging to Comma Separated Variable Files

Use the following configuration for CSV text logging.

Make sure to create the directory OASLogging Demo on your C drive or specify a different Database path that will exist.

CSV Setup

Step 12

Select the Add Group button in the left pane to add the Data Logging group.

Add Group

Step 13

Select the Save button on the toolbar at the top.

Save

Step 14

Save the file DemoLogging.DataLog.

Step 15

Go to Configure-Options and set the default Data Logging Configuration file to the file you just saved.

Step 16

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 or database engine failure.

After completing the above steps you can view the data in your database or CSV file.

For more detailed information on each data logging parameter view the Data Logging section in this help file or simply select the property in the Configure OAS application and hit the F1 key or select the ? near the property.

Posted on

Overview – Data Logging

The Data Logging product, which is also known as the Data Historian, allows you to log Tag data to databases and CSV files. Database logging supports SQL Server, Oracle, Access, MySQL, PostgreSQL, Cassandra, MongoDB, MariaDB, SQLite, InfluxDB, SQL Azure, Amazon Aurora, Amazon RDS, Amazon Redshift and Google Firebase.

Data logging can be configured in OAS using Logging Groups. A logging group is a configuration construct that defines the logging behavior, which tags should be logged, the database connection parameters and the data logging format type. You can define as many logging groups as you need.

Some of the key features include:

  • Interval, time, event or data change logging triggers
  • Configurable column names
  • Automatically creates tables
  • High precision timestamp
  • Supports dynamic host, database and table configuration based on Tag source
  • Expired data removal

Posted on

Frequently Asked Questions – Tags

Can I setup Tag programmatically?
Yes, using the OPC Systems component. The most effective method to set up multiple tags in one call is the TagCSVImport method as demonstrated in the Programmatic Interface topic in .NET Configuration - Programmatic Access Tags.
Can I access a bit of an Integer value of an Open Automation Software Tag?
Yes, set the Data Type of the Open Automation Software Tag to Signed Byte, Unsigned Byte, Short Integer, Unsigned Short Integer, Integer, Unsigned Integer, Long, or Unsigned Long. When browsing for a Tag in a client application Bit00 up to Bit63 will be available selection immediately under the Value property. myTag.Bit00 is an example of providing read and write access to bit 0 of an integer value.
A CSV Export and Import does not work when running on a system with Regional Language settings use a comma as a decimal holder.
Because the OAS Service runs under the SYSTEM Account it is not using the Regional Language settings. In some operating systems when you change the Regional Language the SYSTEM account is not updated. To correct this go to Region and Language under Control Panel, and select the Administrative tab. Select Copy settings and select the option to Copy your current settings to: Welcome screen and system accounts and select OK. Restart the OAS Services or restart the operating system. The CSV export and import will now use your decimal separator selected for the operating system.
We have accumulative value and we want to take Delta for this accumulative value at end of each hour. For example value at start of the hour is 100 and at the end of the hour it is 150, so Delta is 50 for this specific hour. How we can use calculation tag option to achieve it?
First create a String Tag called DateTime with the Data Source of DateTimeString. Next create a Double Tag called InitialValue with the Data Source of Calculation and the following Calculation. IF(SUBSTR([DateTime.Value],STRLEN([DateTime.Value])-5,5) = “00:00”,[SourceTag.Value],[InitialValue.Value]) Then you have a second Double Calculation Tag called TheDifference with the following Calculation. [SourceTag.Value]-[InitialValue.Value] A third Calculation Tag called LastHour can be used to hold the last hour’s result. IF(SUBSTR([DateTime.Value],STRLEN([DateTime.Value])-5,5) = “59:59”,[TheDifference.Value],[LastHour.Value])
I want to create a Calculation that gives a result of a sum over 15 minutes and then resets to 0.
Create a Calculation Tag with the following Calculation. AVG(IF(MOD([SumCalcs.TotalSeconds.Value],900)=0,-987654321,[SumCalcs.Input.Value]),900)*MOD([SumCalcs.TotalSeconds.Value],900)
How to display hours, minutes, and seconds as a string from Time On of a Tag.
STRFORMAT([myTagValueTimeOnTotal]%60,"00")&":"&STRFORMAT(MOD([myTagValueTimeOnTotal],60),"00")&":"&STRFORMAT(([myTagValueTimeOnTotal] - ([myTagValueTimeOnTotal]%60)*60 - MOD([myTagValueTimeOnTotal],60))*60,"00")
I want to have a bit go to true at 7, 15, and 23 hours.
  1. Create a Tag called DateAndTime with the Date Type of String and the Data Source of DateTimeString.
  2. Modify the Calculation in both Reset tags to the following.
IF(SUBSTR([DateAndTime.Value],STRLEN([DateAndTime.Value])-8,8) = ""07:00:00"",1,0)|IF(SUBSTR([DateAndTime.Value],STRLEN([DateAndTime.Value])-8,8) = ""15:00:00"",1,0)|IF(SUBSTR([DateAndTime.Value],STRLEN([DateAndTime.Value])-8,8) = ""23:00:00"",1,0)
How can I keep track of how long a Boolean Tag is on or how many times it has transitioned?
Use the Time On and Counts property.
Tag CSV Export and Import

Import CSV

Select the OAS Service that you desire to import a CSV file to the Tag configuration and click the CSV Import button on the top menu to import a Comma Separated Variable file.
CSV Import
Use the Export CSV feature to generate a CSV file. You can then use Microsoft Excel or other CSV compatible application to add or modify Tags. Only the Tag name is the required field. You can select to include or exclude all other fields. Only those fields that are found in the header will be used to update the properties of the Tags. If a Tag already exists it will be updated. If the Tag does not exist it will be created. Existing Tags that are not specified in the CSV file will not be updated or deleted. The same tag parameter structure can be used to programmatically define tags with the TagCSVImport method on the free to use OASConfig and OPCSystems components. This is demonstrated in  .NET Server Configuration-CSV Import and Export example.

Export CSV

Select the OAS Service that you desire to extract the Tag configuration from and select click the CSV Export button to generate a Comma Separated Variable file.
CSV Export
You can then use Microsoft Excel or other CSV compatible application to add or modify Tags. Use the Import CSV feature to then import the modified CSV file.
If you wish to just export a particular Tag Group, right click on the Tag Group and select Export to CSV.
Export to CSV

Posted on

Videos – Tags

OAS Tags

Open Automation Software tags for live data connections.

Getting Started Tags

For a quick tutorial on configuring tags view the Quick Start Example – Configure Tags section or view the following video:

  • 00:00 – How to set up alarms limits
  • 00:24 – Programmatically Configure Tags
  • 01:34 – Another way to adjust the alarm limit
  • 02:17 – Alarms Group
  • 02:52 – Alarm Priority
  • 03:07 – Time Delay
  • 03:18 – Alarm Text
  • 04:55 – Alarm Tracking
  • 05:29 – Alarms Limits
  • 06:26 – Boolean Signals
  • 06:34 – Example Applications Videos
  • 07:07 – More Questions

Calculations

The following video demonstrates some of the basic functions within the Calculation Engine.  Please refer the the Calculations reference for a complete list of all current functions.

Time On and Counts

Monitor how many times a value or alarm transitions and how long it has been active.

Total

Summation for total values.

Watch Window

View multiple tag values, timestamps, and data quality using the Watch Window.

 

Posted on

Tag CSV Export and Import

Import CSV

Select the OAS Service that you desire to import a CSV file to the Tag configuration and click the CSV Import button on the top menu to import a Comma Separated Variable file.

CSV Import

Use the Export CSV feature to generate a CSV file. You can then use Microsoft Excel or other CSV compatible application to add or modify Tags. Only the Tag name is the required field.

You can select to include or exclude all other fields. Only those fields that are found in the header will be used to update the properties of the Tags. If a Tag already exists it will be updated. If the Tag does not exist it will be created. Existing Tags that are not specified in the CSV file will not be updated or deleted.

The same tag parameter structure can be used to programmatically define tags with the TagCSVImport method on the free to use OASConfig and OPCSystems components. This is demonstrated in  .NET Server Configuration-CSV Import and Export example.

Export CSV

Select the OAS Service that you desire to extract the Tag configuration from and select click the CSV Export button to generate a Comma Separated Variable file.

CSV Export

You can then use Microsoft Excel or other CSV compatible application to add or modify Tags. Use the Import CSV feature to then import the modified CSV file.

If you wish to just export a particular Tag Group, right click on the Tag Group and select Export to CSV.

Export to CSV

Posted on

Time On and Counts

View the following video for explanation of each parameter and how to enable Time On And Counts:

When this feature is enabled in a Tag Value or Alarm Limit it will keep track of how long a Boolean value is true and how many times it transitions to True.

The Time On and Counts feature will keep track of the following:

  • TimeOn – How long the point is on for the current instance in minutes.
  • TimeOnCurrentDay – How long the point is on for the current day.
  • TimeOnPeriod1 – How long the point is on for Period 1.
  • TimeOnPeriod2 – How long the point is on for Period 2.
  • TimeOnTotal – How long the point has been on for all of time.
  • CountCurrentDay – How many times the point has transitioned for the current day.
  • CountPeriod1 – How many times the point has transitioned for Period 1.
  • CountPeriod2 – How many times the point has transitioned for Period 2.
  • CountTotal – How many times the point has transitioned for all of time.

The following image shows how the points will appear for connection in a client if the High High Alarm Limit is enabled for Time On and Counts.  You can also use Value or any other Alarm Limit.

Time On and Count Parameters

Daily Reset

The time of day that the day should end to reset the Time On and Counts.

Period 1

The amount of time in minutes to keep track of for Time On and Counts for Period 1 time.

Period 2

The amount of time in minutes to keep track of for Time On and Counts for Period 2 time.

Reset Time On and Counts Tag

When defined to a Boolean tag the Time On and Counts totals will be reset with the tag is True.

Retain Time On and Counts on Service Restart

To retain the Time On and Counts totals after a system restart go to Configure-Options-Retain Values and enable to retain Time On and Counts to a file.

Posted on

Alarm Limits

Each tag can have adjustable or fixed alarm limits for High High, High, Low, Low Low, Rate of Change, or Digital alarms.

The video below is a 7 minute explanation of setting up Alarm Limits:

  • 00:00 – How to set up alarms limits
  • 00:24 – Programmatically Configure Tags
  • 01:34 – Another way to adjust the alarm limit
  • 02:17 – Alarms Group
  • 02:52 – Alarm Priority
  • 03:07 – Time Delay
  • 03:18 – Alarm Text
  • 04:55 – Alarm Tracking
  • 05:29 – Alarms Limits
  • 06:26 – Boolean Signals
  • 06:34 – Example Applications Videos
  • 07:07 – More Questions

Enable Alarm

To enable an Alarm Limit for a tag, check the Enable Alarm box at the top of the properties window. To enable an Alarm Limit with a tag, check the Enable with Tag.. box instead. Then use the Browse button that appears to select the tag you wish to use to enable the alarm.

Alarm Limit Source

Use the Alarm Limit Source drop down to specify the source of the alarm limit. If value is selected, enter a numeric value in the High High Limit box below. Other options include another tag or a calculation. Setting a Deadband for the alarm limit specifies an amount that the value must be within the limit before the alarm condition is cleared. When the tag value goes above the Out of Range value the alarm limit is not evaluated and the alarm is disabled.

Disabling an Alarm

Checking the Date Disable… box brings up Start and End fields; use these to disable an alarm for a date/time range. Checking the Daily Disable… box brings up hour and seconds fields; use these to disable an alarm for a certain time period each day.

Alarm Text

Use the Alarm Text box to enter the text that will be displayed in alarm notifications, on and HMI screens and recorded in alarm logging. There are five ways to set the alarm text using the Alarm Text Type dropdown.

  1. Static Alarm Text: displays the Alarm Text as is.
  2. Preset Alarm Text: brings up a Browse button to select a Dynamic Text Tag whose value will prepend the Alarm Text.
  3. Overwrite Alarm Text: brings up a Browse button to select a Dynamic Text Tag whose value will overwrite the Alarm Text.
  4. Append Alarm Text: brings up a Browse button to select a Dynamic Text Tag whose value will be appended to the Alarm Text.
  5. Calculation: allows you to create a Calculation using the Edit button to produce the Alarm Text.

Alarm Groups and Priority

Use the Group dropdown to select a an existing group to categorize an Alarm. You can also create a new group by typing into the Group dropdown. Once you have Applied Changes to the tag, the new group will be available for other alarms. Groups are used for filtering alarms for notifications, alarm logging and HMI. You can also enter a numeric Priority for each alarm. The valid range is from 0 to 2,147,483,647. This is another way to filter and organize alarms.

Other Alarm Properties

Time Delay: The Time Delay in seconds that the alarm condition must remain active before the alarm is posted as an active alarm. The date and time when the alarm first became active is used as the alarm date and time, not the date and time it was posted as an active alarm. If you would Like the AlarmStatus parameter To be Set immediate And Not wait For the Time Delay use Configure-Options To Set Update Alarm Status Immediately without Alarm Time Delay.

Log as Event: Enabling this will have record the alarm as a single event when the alarm limit is reached. It will not have an acknowledged state.

Document: Use this to associate a document with the alarm. It could be displayed for an operator in an HMI screen.

Trend Point: Check this to make the alarm limit available for trending.

Source When Bad: Allows the value and data quality to be overridden when the value quality is bad.

  1. Normal Bad Quality: When the data source is bad quality the result is bad quality. With Calculations any one of the source tags in the calculation being bad quality will cause the result to be bad quality.
  2. Set Sources To Default Value: When the data source quality is bad the source value is overridden to be what is set as Default Value with the data type of Default Value Type.
  3. Hold Sources To Last Good Value:  When the data sources quality changes to bad quality the last good value will be used as the data source. 
  4. Set Sources To Tag Value: When the data sources quality is bad the value from another Open Automation Software Tag will be used.

Enable Time on and Counts: See the Knowledge Base article, Time On and Counts, for more information.