Engine device object attributes - Metasys - LIT-12011953 - Server - Metasys UI

The engine device object contains attributes common to many Metasys system objects. This section includes attributes of the Focus/Configuration tab, the Diagnostics tab, and any other tab specific only to this object.

Note: In the Notes column, letters indicate the following: C - Configurable, D - Default Attribute for Display, N - Value Not Required, Q - BACnet Required, and W - Writable.

When you promote or demote a network engine Site Director online using Metasys UI, you are prompted for the user credentials of the Site Director you specified. These user credentials are authenticated before the promotion or demotion is permitted.

Table 1. Engine device object attributes - Focus/Configuration Tab
Attribute name	Notes	Description
Ack Forward Enable	C,W	Specifies whether all events acknowledged or discarded at a network engine are forwarded to the repository if an ADS Repository is configured. What is included are: Events and BACnet intrinsic alarm notifications generated by the engine and acknowledged by a user logged into the engine. BACnet intrinsic alarm notifications received by an engine that are acknowledged at a BACnet device and acknowledged by the engine without a user ID and forwarded to the repository. Acknowledgments are not forwarded to an repository on a dial-up connection. When you acknowledge BACnet event notifications, events are annotated with the source or device of the acknowledgment and your user name as who acknowledged the event. If an event notification from an engine is acknowledged at a third-party BACnet workstation, the event annotation at both the engine and the site include the source of the annotation. If, however, an event notification from a third-party device is acknowledged from a third-party workstation, any engine that also receives the event notification does not include a source for the acknowledgment. When that event acknowledgment is forwarded to the Site Director, the user is specified as MetasysSysAgent. When this attribute is not enabled, events acknowledged at engines are: not forwarded to the repository. All events must be acknowledged at the Site Director. locally acknowledged at the engine. This acknowledgment includes sending a BACnet alarm acknowledgment for alarm notifications received by an engine. Regardless of whether this attribute is enabled, when events are acknowledged or discarded at the Site Director, the Site Director attempts to forward the acknowledgment and discards it to the engine that initiated the event. The Ack Forward Enable attribute must always be false on engines configured for validated environments, that is, whenever signatures are required when acknowledging events. The behavior for Ack Forwarding is not well defined when an engine is configured both as a site device and as a BACnet integrated device at the same site. Although an engine can be configured both as a site device and as a BACnet integration device, this configuration is not recommended.
ADS Connection Type	C,N,W	Specifies whether the (defined in the ADS Repository attribute) is connected through a LAN or dial-up connection. If a value is specified, it overrides the value of the Default ADS Connection Type attribute. If no value is specified, the value of the Default ADS Connection Type attribute is used (Default ADS Connection Type is a site level setting sent to the site’s devices). ADS Connection Type is ignored if no is defined for this site.
ADS Delivery Time	C,N,W	Specifies the time of day when a connection should be established to the (determined by the ADS Repository attribute). A connection is attempted at a minimum of once a day at the specified time to deliver audit, alarm, and trend data to the . If a value is specified, it overrides the value of the Default ADS Delivery Time attribute. If no value is specified, the value of the Default ADS Delivery Time attribute is used (Default ADS Delivery Time is a site level setting sent out to the site’s devices). ADS Delivery Time is ignored if no is defined for this site.
ADS Priority Threshold	C,W	Specifies the priority of an event that triggers the engine to connect (dial or LAN connection) to the defined and delivers the event messages from the engine local event repository to the event repository without waiting for the ADS Delivery Time. The ADS Priority Threshold attribute is used for alarm and event management only. For example, a value of 20 for this attribute means that any event having a priority of 20 or higher (events of higher alarm priority have lower alarm priority numbers) forces a connection to the and forwards event messages from the engine local event repository to the repository of the .
ADS Repository	C,N,W	Specifies the Repository device. This is the computer that receives all audit, alarm, and trend data from a network engine. Repository refers to the three files in the that store this data. If a value is specified, it overrides the value of the Default ADS Repository attribute of the site. If no value is specified, the value of the Default ADS Repository attribute is used (Default ADS Repository is a site level setting sent to the site’s devices). When you save a change to the ADS Repository value, no authentication between the network engine and the is required. This is normal operation. Note: If the engine uses a dial-up connection to transmit data to the , then the ADS Repository must be the first IP address listed in the range specified when configuring the to Allow Incoming Connections (see External Modem Config section of the Communications tab). The Default ADS Repository of the Site is intentionally left blank and must be updated by the user (online or offline). If the user does not populate the Default ADS value and leaves the Default ADS Repository value for all devices at 0.0.0.0, the does not receive any audit, alarm, or trend data. The SCT does not automatically populate the Default ADS Repository value because of the many different possibilities that could exist during archive creation, including multiple on a site or no for a site. In these cases, it is not immediately clear which should be the Default under the Site object.
Alarm Repository Size	C,W	Specifies the maximum number of alarms that can be maintained on the local device.
Alarm Snooze Time	C,W	Specifies the amount of time to delay after an operator temporarily ignores, or snoozes an alarm before re-announcing the alarm.
Align Intervals		Specifies whether clock-aligned periodic time synchronization is enabled. If periodic time synchronization is enabled and the time synchronization interval is a factor of an hour or a day (that is, the value divides without remainder), then the beginning of the period specified for time synchronization aligns to the hour or day, respectively.
APDU Retries	C,W	Indicates the maximum number of times that an Application Layer Protocol Data Unit (APDU) (as specified by the BACnet device) is retransmitted. If the device does not perform retries, it is set to zero. If the value is greater than zero, a nonzero value appears in the APDU Timeout attribute. If you write the value of this attribute, you must reset the engine for the new settings to take effect. Recommended settings: high or medium sensitivity: 4; low sensitivity: 5. Note: If you change the value of this attribute, you must reset the network engine for the new settings to take effect.
APDU Segment Timeout	C,W	Indicates the amount of time in milliseconds between retransmission of an APDU segment. Recommended settings: high sensitivity: 4000 ms; medium sensitivity: 10000 ms; low sensitivity: 20000 ms. Note: If you change the value of this attribute, you must reset the network engine for the new settings to take effect.
APDU Timeout	C,W	Indicates the amount of time in milliseconds between retransmissions of an APDU requiring acknowledgment for which no acknowledgment has been received. Recommended settings: high sensitivity: 6000 ms; medium sensitivity: 10000 ms; low sensitivity: 20000 ms. Note: If you change the value of this attribute, you must reset the network engine for the new settings to take effect.
Appl SW Version		Identifies the version of the application software installed in the device. The content of this string is locally defined (date-and-time stamp, a programmer’s name, a host file version number, and so on).
Archive Date		Indicates the date of the last successful archive of object instances. The value of this attribute is valid when a valid archive exists and during the archive download process. The value of this attribute is ... at all other times.
Audit Action When Full	C,W	Specifies the operation of the audit trail feature when the audit repository is full. If the value is Stop, additional audit entries are discarded. If the value is Rollover, additional audit entries replace the oldest audit entries.
Audit Generate Alarm When Full	C,W	Specifies whether an alarm is generated when the audit repository is full.
Audit Repository Size	C,W	Specifies the maximum number of audit trail entries that can be maintained on the local device.
Backup And Restore State		Describes the current state of the engine during the BACnet backup or restore process. Possible values include Idle (normal operation), Start, Downloading, Provisioning, Staged, Activation, and Resetting.
Backup Fail Timeout	C,W	Specifies how long in seconds that the engine waits for the BACnet backup or restore process to complete before timing out and ending the process. Default is 120 seconds.
Backup Preparation Time		Specifies how long in seconds that the engine remains unresponsive after starting the BACnet backup procedure and before timing out and ending the process. Value is fixed at 60 seconds.
BACnet Communications Password	C,W	Provides password protection of BACnet services, such as DeviceCommunicationControl and ReinitializeDevice. Third-party workstations may use these services and must provide the password for the engine to execute the services. This attribute is user configurable if the BACnet Site attribute in the Site object is set to True. Specify a value for the BACnet Communication Password (maximum 20 characters) before using any BACnet services. This password is saved in encrypted form within the engine and within the engine's archive in SCT. Third-party workstations cannot read or write this password.
BACnet IP UDP Port	C,W	Specifies the UDP port number used to communicate with other BACnet devices over the IP network. This value allows multiple BACnet networks on a single IP network and prevents communication between the multiple BACnet networks. Note: If you change the value of this attribute, for the new settings to take effect, you must issue an Activate Changes command to the engine and select the Update All Changes Pending Attributes and Restart Device option.
BIOS Version		Specifies the BIOS version in the engine. The format of the basic input/output system (BIOS) version is <V><major release>.<minor release>. For example: V2.02. This attribute is present only for NxE engines at Release 9.0 and earlier that use a Windows Embedded operating system. It is blank or does not appear for newer engines. For NAE55/NIE55, if the BIOS version is earlier than V2.02, update the BIOS using the BIOS Update Utility. This update significantly improves overall product performance. For information on the BIOS Update Utility, refer to the BIOS Update Utility Technical Bulletin (Part No. 24-10110-42).
Configuration Files		Identifies the files within the image of the engine that you can back up.
Database Revision		Specifies a logical revision number for the device’s database. Database Revision is incremented when an object is created or deleted, an object name changes, or a restore is performed.
Device Object Identifier		Identifies a numeric code assigned to the engine. The identifier must be unique across the entire Metasys network. This attribute appears in the Focus and Configuration tabs.
Dial-up Audit Forwarding Threshold	C,W	Specifies the size limit of the audit repository (as a percent of the audit repository size) at which the network engine attempts to deliver audit entries to the when the engine has a dial-up connection. (For engines connected over a LAN, audit entries are delivered immediately.) This attribute applies only if is configured as the Site Director for the network engine. When this threshold is reached, all audits in the Local Audit Repository that have not been forwarded are forwarded to the defined ADS Repository. The default is 80%, and to ensure good performance, you should not change to a lesser number.
DST Status		Indicates whether daylight saving time is in effect (True) or not (False) at the device’s location.
Duplicate References		Lists references that are duplicated in the system. Entries in this list are object references that exist on more than one device within the system.
Enable Application Generated Audits	C,W	Enables audits of system commands. Note: If Display Object Generated Objects is set to true, these audits appear in the audit viewer of the engine or , increasing the number of audits generated.
Enabled Audit Level	C,W	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.
Event Action When Full	C,W	Specifies the operation of the Alarm and Event Management feature when the event repository is full. If the value is Stop, additional event entries are discarded. If the value is Rollover, additional event entries replace the oldest event entries.
Firmware Version		Represents the release of firmware installed in the main code section of the device. The first digit in the revision number is advanced on major releases. The second digit is advanced on minor releases. This attribute is in contrast to the Staged Firmware Version attribute, which indicates the engine's firmware version that is currently staged in the engine.
IEIEJ Function A List	C,W	Provides a list of structures with the following elements: Network Number, Device ID High Limit, and Device ID Low Limit. The first set of Who-Is messages is broadcast once the device reaches the Enable Field Commands phase of startup. At this time, a timer starts running that calls a method to send the Who-Is messages at the period specified by IEIEJ Function A Period.
IEIEJ Function A Period	C,W	Sets the period at which the IEIEJ Function A List sends the Who-Is message broadcasts. Clearing the value of this property disables the function A feature. Each destination is guaranteed to get a Who-Is message within the period specified by this property; however, if the list contains multiple destinations, the object attempts to spread out the Who-Is messages so that they are not all sent out at the same instant.
Internode Comm Timer	C,W	Controls the frequency of communication with remote Ethernet devices. This value is used by the Ethernet IP Datalink object. Among other communications, this attribute defines the frequency of the heartbeat to monitored devices (monitored at a rate of two times the Internode Comm Timer). Recommended settings: high sensitivity: 20 seconds; medium sensitivity: 120 seconds; low sensitivity: 240 seconds. Note: If you change the value of this attribute, you must reset the network engine for the new settings to take effect.
Interval Offset	C,W	Specifies the offset, in minutes, from the beginning of the period defined for time synchronization until the actual time synchronization requests are set. Interval Offset has no effect when Align Intervals is False.
Is Validated	C	Enables the MVE feature at the engine, which includes re-authentication with electronic signature and required annotation when the user makes a change to the system, such as commanding an object, acknowledging an alarm, or changing the value of an attribute. This attribute can be set to True for MVE sites only. This attribute is writable only with the SCT and JCT, and is read-only online.
JCI Exception Schedule	C,W	Indicates how long exception schedules are kept after the exception date has expired. The default value is Auto Delete 31 days, which is the same behavior prior to this release. New options are Auto Delete 7 days and Manual Delete. Note: The engine (using SCT, JCT, Metasys UI, or SMP) and FAC (at CCT) allows selections for Manual Delete, Auto Delete 31 days, and Auto Delete 7 days. Note: Manual Delete is needed for locations like Japan where the local standards state that only the BACnet workstation can delete exception schedules.
Last Restart Reason		Indicates the reasons for the last device restart. The possible reasons are: UNKNOWN: The device cannot determine the cause of the last reset. This may occur due to a startup error, shutdown error, crash, or pushing the hardware reset button. The state is UNKNOWN if the device is powered without the battery or if the Device Manager service is stopped. COLDSTART: A ReinitializeDevice request was received with a Reinitialized State of Device of COLDSTART or the device was made to COLDSTART through the user interface. WARMSTART: A ReinitializeDevice request was received with a Reinitialized State of Device of WARMSTART or the device was made to WARMSTART by some other means. WARMSTART also occurs after a download from SCT. DETECTED_POWER_LOST: The device detected that incoming power was lost. This state occurs as the result of a normal power down (with battery). DETECTED_POWERED_OFF: The device detected that its power switch was turned off. HARDWARE_WATCHDOG: The hardware watchdog timer reset the device. SOFTWARE_WATCHDOG: The software watchdog timer reset the device. This state is reported when Device Manager cannot communicate with the control engine for any reason. SUSPENDED: The device was suspended. How the device was suspended or what it means to be suspended is a local matter.
Last Restore Time		The time at which the engine was last restored. Clicking the down arrow exposes date and time details.
Local Date		Indicates the date to the best of the device’s knowledge. The Date type is a series of four one-number elements. The first number is the year (for example, 2005); the second number is the month (1..12, 1=January); the third is the day of month (1..31). To maintain compatibility with BACnet protocol, a fourth number contains the day of week (1=Monday). A value of FF * (asterisk) in any of the elements indicates the value is not specified.
Local Site Director	C,W	Specifies a resolvable host name or IP address of the Site Director. A host name may be specified only if a DNS server or other means of name resolution is available to the device. A Site Director may have more than one host name. The host name specified here must be resolvable to an IP address on the LAN or WAN on which the site’s devices exist. The Local Site Director attribute is based on the Computer Name attribute, not the Name attribute. When you change the Site Director device’s Computer Name attribute, its Local Site Director attribute automatically changes to match its Computer Name. When you change a non-Site Director device’s Computer Name, its Local Site Director attribute remains unchanged. Note: When you promote or demote a Site Director online in SMP, you may be prompted for the user credentials of the Site Director you specified. Enter these user credentials for validation before the promotion or demotion is permitted. For information designating an engine as the Site Director, refer to the NAE Commissioning Guide (LIT-1201519) .
Local Time		Indicates the time of day to the best of the device’s knowledge. The Time type is a series of four one-number elements. The first number is the hour (0..23); the second number is the minute (0..59); and the third number is the seconds (0..59). A fourth number has been added to maintain compatibility with BACnet protocol and contains the hundredths of second (0..99). A value of * (asterisk) for any number indicates the value is unspecified. This value would be used, for example, when the hundredths value is not important.
Location	C,W	Indicates the physical location of the device.
Max APDU Length	C	Indicates the maximum number of bytes that may be contained in a single, indivisible application layer protocol data unit.
Max Message Buffer	C,W	Specifies the largest piece of data that can be sent to a device at one time, excluding all communications headers. Some applications need to perform segmentation of data outside the communications system. This value is used to size the data in those situations.
Max Segments Accepted		Indicates the maximum number of segments of an APDU accepted by the device.
Model Name		Indicates the device model, the hardware revision associated with the firmware, and the code file name used to download the device.
Network Address	C,W	Specifies the BACnet network address. A change to this attribute takes effect after the next engine restart (cold or warm). If you write the value of this attribute, you must reset the engine for the new settings to take effect. Note: If you write the value of this attribute, you must reset the engine for the new settings to take effect.
OS Version		Indicates the version number of the operating system in use by the engine. This attribute is present only for engines that are running the Linux operating system.
Patch Configuration	C, W, A	Provides a mechanism to add and configure new attributes for future patch releases if required. It consists of two columns: Code and Details. The Code column is used for indexing and identifying the new feature/attribute being added. The Details column contains the parameters that are required for configuring the new feature. A total 50 codes can be used at a patch release with a range from, Code 0 to Code 49. At the next major Metasys release, new attributes will be introduced to replace the patch codes. Note: For example, as part of a patch release of Metasys 13.0, the ability to set the watchdog timeout and the LON Recovery mechanism is provided. The functionality to set the watchdog timeout is assigned to "Code 0" with a string format of "timeout=x", while “Code 1” is assigned to enable the LON Recovery mechanism with a string format of "Enabled = True ", both of which are documented as part of patch release. In the field, an engine/server can be upgraded to the patch release using MUI/SMP/SCT.
Power Consecutive Sample	C,W	Specifies the number of consecutive AC line status samples (indicate a power loss) must be received before the device concludes that a power failure has occurred. When the device concludes that power has failed, the device begins an orderly shutdown process. The process used for determining whether a power failure has occurred protects the device from shutting down during short power failures or certain brownout conditions. Using default values, a power failure of less than 5 seconds does not prompt a device shutdown. Note: If you change the Power Consecutive Sample value on a network engine with Metasys Release 9.0.7 firmware, you must restart the engine before the new setting takes effect. A restart is not necessary for engines that are running a different releases.
Power Sampling Interval	C,W	Specifies the period at which the AC line status is sampled to determine whether a power failure has occurred. This attribute is used in conjunction with the Power Consecutive Samples attribute. Note: If you change the Power Sampling Interval value on a network engine with Metasys Release 9.0.7 firmware, you must restart the engine before the new setting takes effect. A restart is not necessary for engines that are running a different release.
Process ID List	C,W	Contains a list of unsigned 32-bit numbers used to compare the Process ID sent with the BACnet events. If the event Process ID is not found on this list, then the event is ignored. An empty list or a list containing only one entry with the value of zero allows all events to be processed.
Process Unmapped Objects Alarms		Specifies whether the engine should process alarms that originate from unmapped objects. This attribute applies only to the ODS and is fixed at False for all other devices.
Protocol Obj Support		Indicates which standard BACnet object types the device’s protocol implementation supports. This attribute is a bit string that uses the Object Type (Set 508). Each bit represents a BACnet object type in that set. For example, bit 0 represents the BACnet AI object type, whereas bit 17 represents the BACnet schedule object type. If the bit is true (1), the object type is supported. If the bit is false (0), the object type is not supported. The BACnet object types supported can vary between device models.
Protocol Revision		Indicates the minor revision level of the BACnet standard the device supports.
Protocol Ser Support		Indicates which standard BACnet protocol services the device’s protocol implementation supports. For more information on the Protocol Implementation Conformance Statement (PICS) and BACnet Interoperability Building Blocks (BIBBs) of the engine. This object now supports both the BACnet UTCTimeSynchronization message and the BACnet TimeSynchronization message (non-UTC version). Third-party devices now have the ability to send the TimeSynchronization message to an engine. This attribute is a bit string that uses the Protocol Ser Support (Set 136). Each bit represents a BACnet service in that set. For example, bit 0 represents the Acknowledge Alarm service, whereas bit 12 represents the Read Property service. If the bit is true (1), the service is supported. If the bit is false (0), the service is not supported.
Protocol Version		Represents the BACnet protocol the device supports. Initial releases are Version 1; subsequent releases increase the number by one.
Restart Notification Recipients	C,W	Controls the restrictions on which devices, if any, are notified when a restart occurs. The value of this attribute is a list of BACnetRecipients. When the length of this list is empty, the device cannot send a device restart notification. The default value of this property is a single entry representing a broadcast on the local network. If the list has one or more entry, the device sends a restart notification, but only to the devices or addresses listed.
Restore Preparation Time		Specifies how long in seconds that the engine remains unresponsive after starting the BACnet restore procedure and before timing out and stopping the process. Value is fixed at 60 seconds.
Restore Completion Time		Specifies how long in seconds that the engine remains unresponsive after ending the BACnet restore procedure and before timing out and stopping the process. Value is fixed at 600 seconds.
Segmentation		Indicates if the device supports segmentation of messages and (if so) if it supports segmented transmission, reception, or both.
Site Director Online		Indicates the communication status of this device with the Site Director. This value is kept current by a command sent by the Data Refresh COV Monitor task whenever the status changes. The COV Monitor task performs this check every 80 seconds. This attribute is triggered so it can be used for an alarm.
Staged Files		List of staged files that are set for activation at a later time. For example, if the code and archive database are set for later activation, this field would read Code, Archive Database. If this attribute is empty, no files are currently staged. Possible values: Code, Archive Database, Security Database, HTTPS Certificates.
Staged Firmware Version	D	Indicates the engine firmware version that is staged for later activation. If this field is empty, no firmware files are currently staged. This attribute is in contrast to the Firmware Version attribute, which indicates the engine's firmware version that is currently active.
System Status	D	Reflects the current physical and logical state of the device.
Time of Device Restart		Indicates the time at which the device was restarted.
Time Synchronization Interval	C,W	Specifies the periodic interval, in minutes, at which TimeSynchronization and UTCTimeSynchronization requests are sent. When set to zero, then periodic time synchronization is disabled.
Time Zone	C,W	The current time zone in use at the location of the engine.
Unbound References		Lists references that are not bound in the system. This attribute indicates that a process cannot find an object either because the device on which the object is located is offline, the object has been deleted, or the object reference is incorrect.
USB Port 1 Enabled	C,W	Specifies whether USB Port 1 on the SNE or SNC network engine is enabled. This attribute applies only to the SNE and SNC models. For enhanced security, the USB port is set to Disabled by default. Before using the USB port, change this attribute to Enabled.
USB Port 2 Enabled	C,W	Specifies whether USB Port 2 on the SNE or SNC network engine is enabled. This attribute applies only to the SNE and SNC models. For enhanced security, the USB port is set to Disabled by default. Before using the USB port, change this attribute to Enabled.
External LAN	C	Specifies whether External LAN is enabled with either a USB 1 or USB 2 value based on its physical connection. You can change the configurations of the USB to Ethernet adapter in an offline database using USB Control and External LAN attributes.
UTC Time Synchronization Recipients	C,W	Lists one or more BACnet recipients to which the engine can issue a UTC Time Synchronization request. If the list is empty, the engine cannot send a UTC Time Synchronization request to a BACnet recipient. The attribute requires the following parameters that define each recipient: ID (Device ID), Address (IP Address, Network Number, UDP Port), and Broadcast (Broadcast Type, Network Number, UDP Port). Three broadcast types are available: local, remote, and global.
Vendor ID		Distinguishes proprietary extensions to the protocol using a unique vendor identification code assigned by ASHRAE. The Johnson Controls Vendor ID is 5.
Vendor Name		Identifies the manufacturer of the device.
Version		Indicates the version number of the firmware image in the engine.

Table 2. Engine device object attributes - Diagnostic tab
Attribute name	Flags	Description
Audit Rate		Specifies the number of audit messages destined for the Metasys server in the last hour (for diagnostic purposes). The value of this attribute updates every five minutes.
Audits Lost		Specifies the total number of audits that were not forwarded to the configured repository and were deleted from the engine's local repository. This count does not persist through an engine reset. The count reflects the number of lost audits since the last reset.
Average Intermittent Failure Period		Specifies the average number of seconds that devices in the transport layer are offline (for diagnostic purposes). Only times less than one minute are used in this average, to eliminate device resets. Ideally, this number should be zero, indicating there are no failures.
BACnet Broadcast Receive Rate		Indicates the number of BACnet broadcast messages received by the device in the previous minute. BACnet broadcast messages are generated as part of the normal BACnet operation, but are also generated when a BACnet device searches for another device that does not exist, such as when a device has objects with references to other nonexistent objects (called unbound references). This number increases when the number of unbound references increases on network connected devices. If this number gets too high, it indicates possible performance problems.
BACnet Routed Messages Rate		Indicates the number of BACnet messages received by the device on the IP network in the previous minute. If this number is high, it indicates that the performance of the MS/TP field bus network is affected by broadcast transmit traffic. This attribute appears only in the Snapshot Focus view.
Battery Condition		Specifies the current battery condition. It is updated every 60 seconds. For the NAE55/NIE55, a value of Fault implies the battery is missing or defective and a value of OK implies there is no known problem with the battery. For the NCE25/NAE35/NAE45, the values are: Good - Battery is operating at normal specifications. Provided the battery is fully charged, it should supply backup power to the engine three times a day for 6 minutes each time. Service - Battery useful life is predicted to end soon. We recommend you replace the battery. Backup power lasts less than 72 hours. Replace - Battery useful life is over. Replace the battery. Backup power may fail if the battery is not charged fully. Defective - Battery is either missing, disconnected, incorrectly installed, or the battery is internally shorted or otherwise defective. Take corrective action. Backup power is not provided for any duration. After a line power failure, the battery is used to supply power to the device so the device can perform an orderly shutdown without losing data. After the device shutdown process finishes, the device discontinues its use of battery power. Valid data is provided only on the engine hardware. Under device simulation, the value is Fault. Note: The SNC and SNE engines do not have this attribute because these models use a supercapacitor, not a battery.
Battery Charging		Specifies the current battery charging state in an NCE25/NAE35/NAE45. A value of False indicates the battery contains at least 80% of full charge capacity and is not currently recharging. A value of True indicates the battery contains less than 80% of full charge capacity and is currently charging. If the Battery Charging value is True and the battery is charging, the battery stops charging when it is 100% charged. Trend this attribute value to determine the current battery charge cycle time. In Simulation, this attribute is False. Note: The SNC and SNE engines do not have this attribute because these models use a supercapacitor, not a battery.
Board Temperature		Specifies the current printed wire board (PWB) temperature in degrees Celsius. It is updated every 60 seconds. It is obtained from a temperature sensor built onto the PWB. The device is designed to run reliably with a PWB temperature at or below 67 degrees Celsius. If this temperature is exceeded, appropriate measures should be taken to cool the device. Under device simulation, the value is 0. Note: The SNC and SNE engines do not have this attribute.
Count of Ethernet Driver Failures		Indicates the number of transitions (up or down) of the Ethernet datalink during the last 60 minutes. For dual port engines, the count of transitions is a consolidation of the number of transitions on both the datalinks that have occurred in the last 60 minutes. The value of this attribute updates every minute with the count being reset to zero every time the device resets.
COV Rcv Rate		Specifies the number of COV messages the engine receives from other supervisory devices or field controllers per minute. This attribute value updates every minute. Each COV message represents one object reporting a value change.
COV Tx Rate		Specifies the number of COV messages the engine sends to other supervisory devices per minute. This attribute updates every minute. Each COV message represents one object reporting a value.
CPU Temperature		Specifies the current CPU temperature in degrees Celsius for a network engine. The value, obtained from a temperature sensor built into the CPU, is updated every 60 seconds. For NxEs and NCEs, set an alarm for the CPU temperature at 70°C; for SNCs and SNEs, set an alarm for the CPU temperature at 88°C. If the temperature reaches these limits, take appropriate measures to cool the device. Under device simulation, the value is 0.
CPU Usage		Specifies a running average of CPU usage over the last 50 minutes. The value is updated every 30 seconds. The running average is calculated by adding or subtracting 1% of the difference between the current and average CPU usage. The value may not be meaningful until 50 minutes after a system restart. A value of 0% means the CPU is 100% idle. A value of 100% means the CPU is 0% idle. A value of 50% or less is considered OK, although other performance indicators should also be assessed. Under device simulation, the value is 0.
Data Collection Rate		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. Note: Starting at Release 10.0, the remote services connection to a cloud-based platform is no longer available, so this attribute does not function.
Data Usage		Indicates the number of data values currently locally stored by the Metasys 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. Note: Starting at Release 10.0, the remote services connection to a cloud-based platform is no longer available, so this attribute does not function.
Detection Interval		Indicates the time, in seconds, determined by the HTTP transport mechanism based on the Poll Rate and Network Tolerance settings. This value determines how fast a site detects a device going offline.
Duplicate References		Lists references that are duplicated in the system. Entries in this list are object references that exist on more than one device within the system.
Estimated Flash Available		Specifies the estimated flash memory available within the device for use by the user’s database and applications. This value can be used to determine whether additional use of flash can be accommodated; however, other performance indicators should also be assessed. This property’s value is calculated at the same time as the Flash Usage attribute. A negative value suggests that the flash usage should be reduced. Also, a negative value can affect system reliability now or in future releases of software.
Ethernet Port 1 Comms Quality		Denotes the Ethernet Communication Quality as experienced by the Network engine. This attribute specifies the value of consolidated TX and RX errors as a percentage of the total number of consolidated TX and RX messages exchanged on the first Ethernet port of the device. The value of this attribute updates every minute, has a unit of % with the initial Ethernet Comms Quality value starting at 100%. Note: If the port has not transmitted or received any communication, or if there are no communication errors detected, the Comms Quality will be 100%. For dual port engines (for example, the M4-SNC25151-0), if Ethernet port 2 is connected and Ethernet port 1 is NOT connected, Ethernet port 1 will always have 100% Ethernet Comms Quality
Ethernet Port 2 Comms Quality		Denotes the Ethernet Communication Quality as experienced by the Network engine. This attribute specifies the value of consolidated TX and RX errors as a percentage of the total number of consolidated TX and RX messages exchanged on the second Ethernet port of the device. The value of this attribute updates every minute, has a unit of % with the initial Ethernet Comms Quality value starting at 100%. This attribute will only be visible if the engine supports second Ethernet port. Note: At Metasys Release 13.0, this attribute will only be visible for the following engine models: M4-SNC25151-0, M4-SNC25151-04, M4-SNC16121-0, and M4-SNC16121-04 F4-SNC25151-0, F4-SNC25151-04, F4-SNC16121-0, and F4-SNC16121-04 Note: If the port has not transmitted or received any communication, or if there are no communication errors detected, the Comms Quality will be 100%. For dual port engines (for example, the M4-SNC25151-0), if Ethernet port 1 is connected and Ethernet port 2 is NOT connected, Ethernet port 2 will always have 100% Ethernet Comms Quality.
Ethernet Port 1 Error Rate		Displays the number of error packets received or transmitted by the first Ethernet port of the device every minute with a starting value of 0 and using units as messages per min. Note: On a dual port engine, certain error types may be seen on unconnected ethernet ports, even if the Ethernet Comms Quality is 100%.
Ethernet Port 2 Error Rate		Displays the number of error packets received or transmitted by the second Ethernet port of the device every minute with a starting value of 0 and using units as messages per min. This attribute will only be visible if the engine supports second Ethernet port. Note: At Metasys Release 13.0, this attribute will only be visible for the following engine models: M4-SNC25151-0, M4-SNC25151-04, M4-SNC16121-0, and M4-SNC16121-04 F4-SNC25151-0, F4-SNC25151-04, F4-SNC16121-0, and F4-SNC16121-04 Note: On a dual port engine, certain error types may be seen on unconnected ethernet ports, even if the Ethernet Comms Quality is 100%.
Event Rate		Specifies the number of event messages destined for the Metasys server in the last hour (for diagnostic purposes). The value of this attribute updates every 5 minutes.
Events Lost		Specifies the total number of events which failed to be forwarded to the configured repository and which were deleted from the engine's local repository. This count does not persist through an engine reset, and reflects the number of lost events since the last reset.
Flash Usage		Specifies the estimated percent of flash memory currently in use. The percentage is based on the portion of flash that is designated for use by the user’s database. The value is updated on device startup, after a database archive, sync or download from the SCT (offline mode), and by manual command (Update Flash Usage). A value greater than 100% can affect system reliability now or in future software releases. No restrictions are in place to prohibit use of flash over 100%. If you are simulating an NAE/NIE, your computer’s hard disk must be formatted for NTFS. If your computer’s hard disk is formatted to use FAT32 (32-bit File Allocation Table), the simulated value for the Flash Usage attribute is not accurate.
Maximum Intermittent Failure Period		Specifies the maximum number of seconds a device was offline at the transport layer (for diagnostic purposes). Only times under one minute are recorded, to eliminate device resets. The value of this attribute does not match the offline times determined from generated alarms. Ideally, this number should be zero, indicating there are no failures.
Memory Usage		Specifies the percent of system RAM that is currently in use. It is calculated as follows: Total commit charge x 100 Display Precision = 0.01 COV Increment = 0.1
Network Tolerance	C,W	Sets the timeout tolerance of the flexible polling feature (that is, changes the lower level communication timeouts). When edited by a user, this attribute is sent to the HTTP transport layer and determines how long the device waits to connect, send, and wait to receive HTTP Post responses. The setting options are LOW, MEDIUM, and HIGH. LOW is the default and matches the current behavior. The MEDIUM or HIGH setting increases the tolerance by adding longer timeouts and more retries and should be used for poor network connections. Note that it takes longer to detect an offline device as the tolerance gets higher.
Object Count		Indicates the number (count) of all of the object instances within the device. Objects of all classes are included.
Object Memory Usage		Specifies the percent of the object database that is currently in use. Each object created consumes memory within the object database. This attribute can be used to help determine the device’s capacity for additional objects; however, other performance indicators should also be assessed. Generally, the number of objects you define determines the object memory usage. This attribute is valid on the engine hardware and under device simulation. Note: If you have a large number of objects, the object memory usage increases and the archive.moi file size increases also. The archive.moi file is stored in flash memory. Also, an attempt to create an object known to require X bytes of object database may fail even if more than X bytes are available in the object database. This is because the object database is composed of multiple blocks. If the free space of each block is fewer than X bytes, the request for X bytes fails even though the sum total of free space from all blocks is greater than X bytes.
Pager Dial-up Status		Specifies the current status of the pager dial-up connection. Available only in network engines at Release 9.0 and earlier that use a Windows Embedded operating system.
Registration Usage		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. Note: Starting at Release 10.0, the remote services connection to a cloud-based platform is no longer available, so this attribute does not function.
Repository Status		Indicates the status of the communication between the device and the trend log sample repository (for diagnostic purposes). This attribute uses the Repository Status set. Uses Repository Status set: 0 = Offline 1 = OK 2 = Undefined 3 = Dialup 4 = RAP 5 = Incompatible Release
Samples Lost		Specifies the number of trend samples lost because the Metasys server did not retrieve them fast enough (for diagnostic purposes). This value resets only when the device restarts.
Sample Rate		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. Note: The sample rate at the engine is calculated based on the actual raw samples taken by every trend object. The sample rate at the is calculated once every poll cycle and is based on the number of samples received from all the Engines and the time it took to poll them. Most Engines do not forward all the samples taken between polls because the transfer setpoint is usually not set to 1 (that is, forward on every sample). The result is that the sample rate at the is less than the sum of the samples taken at all the Engines. The total sample rate is 60,000 and the total engine sample rate is larger than 100,000.
Time Between Buffer Reads		Indicates the time, in minutes, between engine trend consolidation buffer readings from the Metasys server (for diagnostic purposes).
Total Number of Power Transitions		Displays the total number of line power transitions the device has experienced since being last reset. The count will be reset to zero every time the device resets. Note: The power detection interval is hardware dependent and may differ between SNE and SNC models.
Transfer Buffer Full		Indicates the percentage full of the engine trend consolidation buffer (for diagnostic purposes).
Transport Failure Rate		Specifies the number of transport failures per day (for diagnostic purposes). This number represents how often HTTP posts from this engine 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.
Unbound References		Lists references that are not bound in the system. This attribute indicates that a process cannot find an object either because the device on which the object is located is offline, the object has been deleted, or the object reference is incorrect.
Level for All Trace Categories	C,W	Sets the same trace level for each of the trace categories. For example, if a user sets the level of this category to Warning then, the level of each of the remaining trace categories is set to Warning. The options are Off (default), Error, Warning, Info, and Verbose.
OS General Trace Category	C,W	Sets the OS General Trace Category. This category would be used to fetch logging information for the following activities/services: Https Support (Receive Request, Receive Reply, Process Device Status) XMS Dialup settings Writing communication attribute values System Network helper Router related settings Polling during Shutdown The options are Off (default), Error, Warning, Info, and Verbose.
COV Trace Category	C,W	Sets the he trace level for change of value related to following activities/services: COV Server COV Object COV Registry COV Monitor The options are Off (default), Error, Warning, Info, and Verbose.
Device List Trace Category	C,W	Sets the trace level for the Device list server related services. The options are Off (default), Error, Warning, Info, and Verbose.
MCE Trace Category	C,W	Sets the trace level of Metasys Control Engine (MCE), an object-based operating system that resides on the controller, to perform various functions based on the objects. The options are Off (default), Error, Warning, Info, and Verbose.
MMS HTTP Trace Category	C,W	Sets the trace level when registering a network device. The options are Off (default), Error, Warning, Info, and Verbose.
BACnet Integration Trace Category	C,W	Sets the trace level for any change of value related to BACnet for the following activities/services: Add an object to the list to poll Delete an object to the list to poll Performing next poll operation Start/schedule the poll time Functions and methods for the MSTP Mapper object The module to build up class information tables needed for the MSTP Integration trend object class The options are Off (default), Error, Warning, Info, and Verbose.
GSI Trace Category	C,W	Sets the trace level for the Global Status Indicator (GSI) trace category and applies to change of value related to the following activities/services: Alarm list server related activities Alarm table events Alarm list server registry Legacy alarm list monitor Legacy alarm list registry Alarms associated with specific device The options are Off (default), Error, Warning, Info, and Verbose.
NTS Trace Category	C,W	Sets the trace level for the NTS (Navigation Tree Server) trace category and applies to change of value related to the following activities/services: Nav Tree Server and Cache Tree objects Device list server Nav tree server registry Alarm list server Payload NTC services The options are Off (default), Error, Warning, Info, and Verbose.
Trend Trace Category	C,W	Sets the trace level for Trend trace category and applies to change of value related to the following activities/services: Helper functions for supporting encoding the new MMS Read Range reply BACnet trends Data collector for time series data Server data collector Trend consolidation buffer Trend dispatcher Trend Poller The options are Off (default), Error, Warning, Info, and Verbose.
LNTM Request Trace Category	C,W	Sets the trace level for the Legacy Navigation Tree Monitor (LNTM) trace category and applies to change of value of Legacy navigation tree monitor related functions. The options are Off (default), Error, Warning, Info, and Verbose.
Load Balancer Trace Category	C,W	Sets the trace level for the Load Balancer trace category and applies to change of value of the Load Balancer task for handling requests to register and deregister. The options are Off (default), Error, Warning, Info, and Verbose.
User Dictionary Trace Category	C,W	Sets the trace level for the User Dictionary trace category and applies to change of value of User Dictionary Task handling requests for user dictionary. The options are Off (default), Error, Warning, Info, and Verbose.
OS Transport Layer Trace Category	C,W	Sets the trace level for OS Transport Layer trace category and applies to change of value of OS transport layer APIs. The options are Off (default), Error, Warning, Info, and Verbose.
OS Message Dispatcher Trace Category	C,W	Sets the trace level for OS Message Dispatcher trace category and applies to change of value of Message dispatcher for a particular task thread. The options are Off (default), Error, Warning, Info, and Verbose.
OS API Task Interface Trace Category	C,W	Sets the trace level for OS API Task Interface trace category and applies to change of value of OS API Windows task interface. The options are Off (default), Error, Warning, Info, and Verbose.
Advance Helpers Trace Category	C,W	Sets the trace level for customized developer helper functions. These helper functions are introduced for easy debugging. The options are Off (default), Error, Warning, Info, and Verbose.
Last Unicast Time Sync Applied		Displays a timestamp when the Network Device had last been Unicast Time Synched with its Time Server. This attribute only displays when the Time Sync Method is selected as Windows (Unicast).
Local Clock Time Offset		Displays the time drift of the local clock from its time server. This attribute only displays when the Time Sync Method is selected as Windows (Unicast) and is not applicable for Multicast.
Last Multicast Time Sync Applied		A new attribute has been introduced in Metasys 13.0 to display a timestamp when the Network Device had last been Multicast Time Synched from its Time Server. This attribute only displays when the Time Sync Method is selected as Multicast. Note: When an engine is used as a Site Director (both as a Parent and Standalone) and uses the multicast time sync method, the displayed value of this attribute has no user significance.

Note: The Communications tab is only present for older network engines that have gray exteriors. The tab has three different configurations: Serial Port Cable Config, Internal Modem Config, and External Modem Config. Each configuration has the same set of attributes that are described in this table.

Table 3. Engine device object attributes - Communications Tab
Attribute name	Flags	Initial value	Values/options/range
Allow Incoming Connections	C,W	True	Whether the communications port is enabled to accept an incoming call from another device.
Baud Rate	C,W	115200	The configured baud rate set for the communications port.
Enabled	C,W	True	Whether the communications port is enabled to initiate a call to another device.
Extra Initialization Commands	C,W		An optional list of modem initialization commands, such as characters and symbols, necessary to establish a reliable connection.
Maximum Baud Rate	C,W	115200	The maximum configured baud rate set for the communications port.
Wait for Dial Tone Before Dialing	C,W	False	Whether the network engine should wait for the dial tone before attempting to place a call.

Table 4. Engine device object attributes - Network tab
Attribute Name	Flags	Initial Value	Values/Options/Range
Allow Http	C,W	True	Available at network engines at Release 8.1 or later. It determines whether the operating system firewall in the network engine blocks incoming traffic over the HTTP port (port 80). If the attribute is set to True, all incoming traffic over port 80 at the network engine is allowed; if set to False, all incoming traffic over port 80 at the network engine is blocked. Changing this attribute does not interfere with NAE Update Tool operations. You can set this attribute independently on each network engine, and can modify it using a schedule or other control action. You can configure a tailored summary to view the value of the attribute on all network engines at the site. You can also use the mass editing capability in SCT to modify the attribute across multiple devices. To provide the highest level of security, it is recommended that you set this attribute to False. However, if the network engine is a Site Director and has one or more child engines reporting to it that have not been upgraded to Release 8.1 or later, set the attribute to True. For a list of the tools and utilities that require port 80, refer to the Allow Http section of the NAE Commissioning Guide (LIT-1201519).
Completion Domains	C,W		Specifies a domain name that is appended to the computer name of a network engine to help the engine broadcast over the building network. For example, if you specify a completion name of mycorp.com and the name of the network engine is NAE-1, the engine is identified on the network as NAE-1.mycorp.com. Use this attribute for network engines that have difficulty communicating with their site director. If DHCP is enabled on the engine, the DHCP server populates the list of completion domains automatically. In this case, if you manually delete a domain from the list, it is readded when you save the change. Note: Depending on the model of the network engine, the full list of configured completion domains may not appear under the drop-down box in View mode. In this case, switch to Edit mode to view the full list of completion domains.
Computer Name	C,W		Identifies the network engine to the Metasys network. Changing the Computer Name online breaks any existing references between the NAE object and other objects on the site, and may break the existing network connection to other devices on the network. We do not recommend changing the Computer Name online. Instead, change the Computer Name attribute offline with the SCT by right-clicking the NAE in the navigation tree and selecting Rename. Both the Computer Name and Name attributes are changed to the new name you select. The Item Reference then updates to show the new Computer Name. Notes: If you change the value of this attribute, a confirmation message appears informing you that the Engine must be reset before the new name can be applied. The Computer Name must not consist of all numbers. For example, a computer name of N1234 is acceptable but 1234 is not.
DHCP Enabled	C,W	True	True = DHCP enabled; network engine requests IP address from DCHP server; if no server is present, APIPA addressing is used. False = DHCP disabled; network engine uses a static IP address.
DNS Server IP Addresses	C,W		List of IP addresses.
Domain Name	C,W		Note: If you change the value of this attribute, the Engine automatically resets.
Ethernet 1 Speed			The current connection speed of the network engine on the first Ethernet port. Only SNC and SNE engines have this attribute. The attribute shows Not Connected if no connection is present.
Ethernet 2 Speed			The current connection speed of the network engine on the second Ethernet port. Only the SNC has two Ethernet ports and therefore has this attribute. The attribute shows Not Connected if no connection is present.
Ethernet MAC Address			The MAC address of the network engine.
JCI IP Address	C,W		The currently assigned IP address of the network engine.
IP Mask	C,W		The currently assigned IP mask of the network engine.
IP Router Address	C,W		The currently assigned IP router that the network engine is using.
Obtain DNS Address Automatically	C,W	True (1)	Whether the DNS IP address is populated automatically.
External Ethernet MAC Address	C,W	00:00:00:00:00:00	The External Ethernet MAC address of the network engine.
External DHCP Enabled	C	False	True = External DHCP enabled; network engine requests IP address from DCHP server; if no server is present, APIPA addressing is used. False = DHCP disabled; network engine uses a static IP address.
External JCI IP Address	C, W	0	The currently assigned External IP address of the network engine.
External IP Mask	C, W	0	The currently assigned External IP mask of the network engine.
External Obtain DNS address automatically	C	False	Whether the External DNS IP address is populated automatically.
External DNS server IP addresses	C		List of External DNS server IP addresses.
Routing Mode	C,W	Disabled	The current state of the BACnet routing mode. Options are Disabled, Enabled, Enabled Without Broadcast.
IP Communication Mode			The type of BACnet communication the device will use. The options are Secure Connect Only Mode, Ethernet IP Only Mode, and Dual SC and IP Mode
Operational Certificate Satus			Displays information about the Operational Certificate that is used for BACnet Secure Connect communication. You can also obtain this information in the BACnet Management Dashboard in JCT or MUI.

Note: The Hardware tab is present only for SNC network engines.

Table 5. Engine device object attributes - Hardware tab
Attribute Name	Flags	Initial Value	Values/Options/Range
Application Class Set Version		64	Indicates the version of the application class set for the SNC.
Control Sequence In Test	C,W	0	Indicates the number assigned to the control sequence in testing mode.
Controller Number		999	Indicates the unique address of the field controller as set by the rotary switch block on the engine.
Device Model Class Set Version		65	Indicates the version of the device model class set for the SNC.
Pcode			Indicates the product code number of the SNC (for example, M4-SNC25150-0).
Startup OFF State Auto Release Time	C,W	0	Indicates the amount of time a BO is held in the OFF state at the priority set by the Startup OFF State Command Priority setting at field controller startup. This instance only applies to BO objects that have their Startup OFF State Enable parameter set to TRUE. The default value is 0. A value of 0 disables this parameter. The range is 0 to 3600 seconds.
Startup OFF State Command Priority	C,W	9	Indicates the priority at which a BO is held in the OFF state for the Startup OFF State Auto Release Time at field controller startup. This instance only applies to BO objects that have their Startup OFF State Enable parameter set to TRUE. The default value is 9. Priority 6 is not a valid selection. The range is 1 to 16.

Engine device object attributes - Metasys - LIT-12011953 - Server - Metasys UI - 7.0.50

Metasys UI Help