ADS Attributes - Metasys - LIT-1201793 - Software Application - Site Management Portal - 12.0.50

Metasys Site Management Portal Help

Brand
Metasys
Product name
Site Management Portal
Document type
User Guide
Document number
LIT-1201793
Version
12.0.50
Revision date
2023-06-02
Language
English

This section describes the attributes that are under the Focus/Configuration and Diagnostics tabs of the ADS device object. However, starting at Release 10.1, the Edit button for the other tabs that appear (Email, SNMP, Syslog, and Printer) is disabled. The following text appears in the window when you click any of these tabs:

This feature is now only available on the Metasys UI

For more information on Metasys UI, refer to Metasys UI Help (LIT-12011953).

The ADS object also contains attributes common to many Metasys system objects. These common attributes are not described here but are covered in the Common Object Attributes section.

Note: In the Notes column, attributes marked with the letter C are configurable, and attributes marked with the letter W are writable.
Table 1. ADS Device Object Attributes - Focus/Configuration Tab

Attribute Name

Notes

Values/Options/Range

Description

ADS Repositories

C,W

 

Lists the Metasys Server host names or IP addresses to which incoming trend and Alarm/Event data forwards. A Metasys Server cannot have its own host name or IP address in this field. Refer to the ADS/ADX Commissioning Guide (LIT-1201645) for details on configuring repositories.

ADS Repositories Status

C,W

Offline, OK

Indicates the status of the devices listed in the ADS Repositories attribute.
Note: When forwarding data to a secondary Metasys Server (that is, data forwarded to a Metasys Server is forwarded to another Metasys Server), the status does not calculate. This attribute shows only the status for the initial forward.

Alarm Snooze Time

C,W

0–75

Units = Minutes

Specifies the amount of time to delay before re-announcing an alarm.

Enabled Audit Level

C,W

See the attribute description for details on the Enabled Audit Level.

Range = 1–4 with 5 Audit Levels

Level 1 (N/A) User Action

Level 2 (1) Critical System Events

Level 3 (2) Application

Level 4 (3) Non-critical System Events

Level 5 (4) Diagnostic

Specifies which level of audit entries are added to the audit repository. Only audit entries of type Level 1 through and including the specified level are included. All other levels are not stored in the audit trail. Level 1 and Level 2 audit entries are always stored in the audit trail.
  • Level 1 and 2 (1): Stores all user action and system error audit messages.
  • Level 3 (2): Stores application audit messages in addition to Level 1 and 2 auditing.
  • Level 4 (3): Stores system audit messages in addition to Level 3 auditing.
  • Level 5 (4): Stores diagnostic audit messages in addition to Level 4 auditing

FIPS Compliance Status

Specifies whether the Metasys Server is FIPS compliant: Compliant (Licensed), Compliant (Unlicensed), or Non-Compliant (Unlicensed). FIPS compliance involves three steps: purchasing a Metasys FIPS license, enabling FIPS in the server's operating system, and installing the Metasys FIPS feature. If you complete the first two steps, but do not install the FIPS feature, the value of this attribute is Non-Compliant (Licensed).

Host Name

    Indicates the host name of the NxE whose value appears in the Transfer Buffer Full Worst NxE attribute.

JCI IP Address

C,W

 

Represents the IP address of this Metasys Server. The IP address identifies the Metasys Server on the network and assists in the routing of messages. Each Metasys Server must have a unique IP address for the network to operate properly. A write to this attribute is ignored because configuration is completed through the Windows network configuration. A read of this attribute returns either the user-specified value or the value determined from DHCP.

Certain IP addresses are invalid and cannot be written successfully. The network address portion of the IP address is computed by including all bits in which the corresponding bit from the IP mask is 1. The device address portion of the IP address is computed by including all bits in which the corresponding bit from the IP mask is 0. Neither the network address nor device address can be all zero bits or all one bits. For example, if the IP mask is 255.255.0.0, the following IP addresses are invalid: 0.0.100.100 and 100.100.0.0.

The JCI IP Address attribute can be set explicitly, or it may be automatically set using the DHCP server. Using the DHCP server, you can change this attribute even if you set it up explicitly. See the DHCP Enabled attribute.
Note: This attribute only appears in the ADS object in the SCT and is used by the SCT during a download or upload of the Metasys Server database.

Local Data

    Displays the date on the Metasys Server.

Local Time

    Displays the time on the Metasys Server.
Model Name     Contains the name of the device model. In this case, it is ADS.

Number of NxEs Reporting

   

Specifies the number of NxE devices that registered this Metasys Server as their trend repository. For an ODS or OAS, this number is always one count higher than the actual number of NxEs reporting because the ODS and OAS also have a trend repository that is included in the count.

Sample Rate

 

Units = Per Hour

See attribute description for calculation details.

Specifies the number of trend samples destined for the Metasys server in the last hour (for diagnostic purposes). The value of this attribute updates every 5 minutes.

Service Time

 

Units = Seconds

Displays the amount of time in seconds that it takes for the ADS/ADX device to poll all NxEs on the site for trend samples.

Transfer Buffer Full Worst NxE

 

Units = %

Indicates the buffer fullness, in percent, of the NxE with the fullest trend buffer of the trend poll cycle.
Table 2. ADS Device Object Attributes - Diagnostic Tab

Attribute Name

Flags

Values/Options/Range

Description

Average Intermittent Failure Period

 

IP address and Value

Units = seconds

Specifies the average number of seconds devices in the transport layer are offline (for diagnostic purposes). Only time periods less than 1 minute are used in this average, to eliminate device resets. Ideally, this number should be zero, indicating there are no failures.

Data Collection Rate

 

Units = Per Minute

Maximum value = 83333

Indicates the data value collection rate of the Ready Time Series Data feature. It represents the rate of data values collected, not the rate of data values delivered to the clients. The feature buffers data values when the data collection rate is within the maximum expected rate (83,333 data values per minute) and the client is unknown or offline. In the event of a remote connection failure, a minimum of 60 hours of data is buffered locally for automatic delivery when the error condition is resolved. This feature is only used by a Site Director and is updated every minute.

Data Usage

 

Units = %

Indicates the number of data values currently locally stored by the Ready Time Series Data feature as a percentage of the maximum allowed. Typically, data samples are routinely delivered to an online client and the data usage remains small. When the client is unknown or offline, data values continue to accumulate in local storage until limits are reached. This feature is used by a Site Director and is updated every minute.

For the ADS, data values are accumulated in memory and stored in batches in a disk-based queue limited to 10,000 entries. This attribute is based on the worst case queue usage of all clients of this feature.

Incoming Audit Rate

 

Units = Per Hour

Specifies the average rate of audits, per hour, received from other devices (NxEs or ADS/ADXs) during the previous hour. The value of this attribute updates every 5 minutes. This rate only includes audits generated by devices at Release 5.2 or later.

Incoming Event Rate

 

Units = Per Hour

Specifies the average rate of events, per hour, received from other devices (NxEs or ADS/ADXs) during the previous hour. The value of this attribute updates every 5 minutes. This rate only includes events generated by devices at Release 5.2 or later.

Maximum Intermittent Failure Period

 

IP address and Value

Units = seconds

Specifies the maximum number of seconds a device was offline at the transport layer (for diagnostic purposes). Only time period under 1 minute are recorded, to eliminate device resets. The value of this attribute does not match the offline time period determined from generated alarms. Ideally, this number should be zero, indicating there are no failures.

Outgoing Event Rate

 

Units = Per Hour

Specifies the average rate of events per hour, sent to other repositories (ADS/ADXs). This value of this attribute updates every 5 minutes. This rate only includes events generated by devices at Release 5.2 or later.

Registration Usage

 

Units = None

This attribute indicates the number of registrations used by the Metasys Ready Time Series Data feature. It is the total usage of all clients of this feature. Each registration is a sign-up for an attribute of an object. The feature supports up to 1,000 registrations per fully loaded field bus per site device. This feature is only used by a Site Director and is updated every minute.

Transport Failure Rate

 

IP address and Value

Units = Failures Per Day

Specifies the number of transport failures per day (for diagnostic purposes). This number represents how often HTTP posts from this server failed when they were sent to another device that is considered online. Failures include the inability to open the connection, to send the message, or to receive the reply. This value represents failures over the last 24 hours and is updated hourly, but does not correlate directly to the number of offline alarms generated by your system. Ideally, this number should be zero, indicating there are no failures.