TOPServer_257w_76h

Let the Client Application Know 
What's Happening with System Tags

SWTB_logo_93w_76h

clearpixel

SWTB_7Button_BlueLine_900w

System and Statistics Tags

The TOP Server exposes a number of System and Statistics tags that can be very helpful for testing your system to check for problems before, during, and after startup.  When you open up the OPC Quick Client from within the TOP Server, folders with an underscore ( _ ) will be created in the OPC Quick Client that show the full path to all these special tags.  You can see a list and details about the System tags here, as well as in the TOP Server help file. 

Statistics Tag

In addition to the System tags there are communication Statistics tags that can be accessed when you enable the Channel Diagnostics. Click Here for a listing of the Statistics Tags.

ChannelDiagnostics_CheckBoxThe Channel Properties for every Serial and Ethernet driver offer the ability to enable Channel/Protocol Diagnostics for the driver.  Slave, Unsolicited drivers, and Client type drivers will only show the number of reads or writes made to the Server.

Once diagnostics are enabled you can view the communications between the channel and the device you are connecting to when a client is requesting information from the TOP Server.  If there are no client connections or the client has not requested any tags, the TOP Server will not request information, so there will be no diagnostic information. 

Enabling diagnostics also gives you access to special Statistics Tags.  Like the System tags the Statistics tags are automatically created and can be accessed like any other tag in the TOP Server.

The Statistics tags are used to provide feedback to client applications regarding the operation of the channel communications in the TOP Server.  Because the diagnostics are at the Channel level, there is no way to separate out the communications to different devices under the same channel.  See the section on Multiple Connections for more information on how channels and devices work in the TOP Server.

Channel Level Statistics Tags
(Statistics Tags are only available when diagnostics are enabled as shown above)

Syntax Example: <channel name>._Statistics._TXBytes

The TOPIC used to access this level in DDE and SuiteLink Connections is the Channel name you configure for this driver. 
You can also customize this path for any Client connection type using the Alias Map.
You can see the full listing of Channel Level Statistic Tags in the OPC Quick Client if you open it from the TOP Server by clicking on the Quick Client Icon on the TOP Server Icon bar.

Look under the folder shown here.  ChannelDiagnostics_Folder

Tag Name

Description

_SuccessfulReads

The _SuccessfulReads tag contains a count of the number of reads this channel has completed successfully since the start of the application or since the last time the _Reset tag was invoked. This tag is formatted as unsigned 32 bit integer (Dword) and will eventually roll over. This tag is Read Only.

_SuccessfulWrites

The _SuccessfulWrites tag contains a count of the number of writes this channel has completed successfully since the start of the application or since the last time the _Reset tag was invoked. This tag is formatted as an unsigned 32 bit integer (Dword) and will eventually roll over. This tag is Read Only.

_FailedReads

The _FailedReads tag contains a count of the number of reads this channel has failed to complete since the start of the application or since the last time the _Reset tag was invoked. This count is only incremented after the channel has failed the request based on the configured timeout and retry count for the device. This tag is formatted as an unsigned 32 bit integer (Dword) and will eventually roll over. This tag is Read Only.

_FailedWrites

The _FailedWrites tag contains a count of the number of writes this channel has failed to complete since the start of the application or since the last time the _Reset tag was invoked. This count is only incremented after the channel has failed the request based on the configured timeout and retry count for the device. This tag is formatted as unsigned 32 bit integer (Dword) and will eventually roll over. This tag is Read Only.

_RxBytes

The _RxBytes tag contains a count of the number of bytes the channel has received from connected devices since the start of the application or since the last time the _Reset tag was invoked. This tag is formatted as unsigned 32 bit integer (Dword) and will eventually roll over. This tag is Read Only.

_TxBytes

The _TxBytes tag contains a count of the number of bytes the channel has sent to connected devices since the start of the application or since the last time the _Reset tag was invoked. This tag is formatted as unsigned 32 bit integer (Dword) and will eventually roll over. This tag is Read Only.

_Reset

The _Reset tag can be used to reset all diagnostic counters. The _Reset tag is formatted as a Boolean tag. Writing a non-zero value to the _Reset tag will cause the diagnostic counters to be reset. This tag is Read/Write

Tags Below are new for TOP Server Version 5

_MaxPendingReads

The _MaxPendingReads tag contains a count of the maximum number of pending read requests for the channel since the start of the application (or the _Reset tag) was invoked. This tag is formatted as an unsigned 32 bit integer. The tag is Read Only.  This tag is used to show the largest number of Pending Read from the application start-up or last time the reset bit was set.

_MaxPendingWrites

The _MaxPendingWrites tag contains a count of the maximum number of pending write requests for the channel since the start of the application (or the _Reset tag) was invoked. This tag is formatted as an unsigned 32 bit integer. The tag is Read Only. This tag is used to show the largest number of Pending Writes from the application start-up or last time the reset bit was set.

_PendingReads

The _PendingReads tag contains a count of the current pending read requests for the channel. This tag is formatted as an unsigned 32 bit integer. The tag is Read Only.

_PendingWrites

The _PendingWrites tag contains a count of the current pending write requests for the channel. This tag is formatted as an unsigned 32 bit integer. This tag is Read Only.
 

Client Write Access to System Tags

Starting with Version 5.8:

By default, writes will now be possible to TOP Server system tags via a new user management account called Data Client.

Open the TOP Server Settings by Right Clicking on the Administration Icon in your system tray (shown below)

V5_Administation_ICON_w45_h42_sharp

Choose Settings from the pop up menu and go to the User Manager Tab (shown below)

V5_UserManager_Admin

Under the properties for the Data Client user, client writes to system tags can be enabled/disabled completely by toggling the setting “Allow writes to system tags that...” or enabled/disabled for different groups of system tags using the other settings as shown.

. V5_UserManager_DataClientUser

Version 5.7 and Prior:

Open the TOP Server Settings by Right Clicking on the Administration Icon in your system tray (shown below).

V5_Administation_ICON_w45_h42_sharp

Choose Settings from the pop up menu and go to the Runtime Options Tab (shown below).

V5_Administation_RuntimeOptionsTAB

Make sure the check box below is checked to enable writes to these tags. These settings can be secured by making changes to the User Manager, also accessed through the Administration Icon.

V5_Administation_RuntimeOptions_SystemTags
.

 

 | TOP SERVER HOME  | PRODUCT DETAILS  | DRIVERS LIST  | FREE TRIAL  | ORDERING TOP SERVER  | SUPPORT  | NEWS

P: 1-888-665-3678 (US-Sales) or +1-704-849-2773 (Support & International), F: +1-704-849-6388
148A East Charles Street, Matthews, North Carolina, USA 28105
Copyright Software Toolbox, Inc., 1996-2009, All Rights Reserved Worldwide.

Wonderware, InTouch, and Invensys are registered trademarks of Invensys plc.  All  other marks are the property of their respective owners.
The Software Toolbox name and logo are registered trademarks of Software Toolbox Inc.