SC Network Port Attributes - Metasys - LIT-12011964 - Software Application - System Configuration Tool - 16.0

SCT: System Configuration Tool Help

Brand
Metasys
Product name
System Configuration Tool
Document type
User Guide
Document number
LIT-12011964
Version
16.0
Revision date
2023-10-02
Language
English
The SC Network Port object contains attributes common to many Metasys system objects. You can find a description of these common attributes in the Common Object Attributes section. This section includes attributes of the Focus/Configuration tabs.
Note: In the Notes column, attributes that are marked with a letter C are configurable, which means you set it at creation, attributes marked with the letter W are writable, which means you change it post creation, and attributes marked with the letter N indicate values not required.
Table 1. SC Network Port Attributes - Focus/Configuration Tab
Attribute Name Notes Description
Use Site Settings W

True indicates that the BACnet/SC Network Port Object (SC NPO) should use the configuration parameters configured at the Site Object.

False indicates that the SC NPO should not use the configuration parameters set by the Site Object.

Pending Network Number  

Specifies the network number that is assigned to the integration when the user sends the Activate Changes command to the engine.

The steps to perform this update on a live engine are as follows:

  1. Under Engine object select the Network tab.
  2. Change Routing Mode to Enabled, if required.
  3. Select the Eth IP Datalink or SC Network Port object and modify the Pending Network Number to the desired value.
  4. If modified in step 2, change Routing Mode to Disabled.
  5. Select Update Changes, Pending Attributes and Restart Device to command the engine to activate changes.
Secure Port Number   Represents the TCP port number the BACnet/SC Datalink binds to for secure websocket communication. Any change to this property updates the current URIs that the device uses to accept websocket connections.
JCI SC Primary Hub URI   Provides the URI for the Primary Hub Function. The value is a UTF-8 string containing a WebSocket URI as of RFC 6455, formatted as of RFC 3986. If no URI is configured, this property is an empty UTF-8 string.
JCI SC Failover Hub URI   Provides the URI for the Failover Hub Function. The value is a UTF-8 string containing a WebSocket URI as of RFC 6455, formatted as of RFC 3986. If no URI is configured, this property is an empty UTF-8 string.
JCI SC Hub Function Enable W

True indicates Hub Function is enabled.

False indicates Hub Function is not enabled.

JCI Direct Connect Enable W

True indicates that the port allows initiating or accepting BACnet/SC Direct Connections.

False indicates that this port does not allow either initiating or accepting BACnet/SC Direct Connections.

This attribute is required to be present if the port supports Direct Connections.

JCI SC Minimum Reconnect Time W Specifies the minimum time in seconds between each attempt to establish a BACnet/SC connection. It represents the minimum time the initiating peer waits before initiating a connection attempt.
JCI SC Maximum Reconnect Time W Specifies the maximum time in seconds between each attempt to establish a BACnet/SC connection. It represents the maximum time the initiating peer waits before initiating a connection attempt.
JCI SC Connect Wait Timeout W Specifies the time in seconds that a node waits for a response BVLC message while it connects to BACnet/SC.
JCI SC Disconnect Wait Timeout W Specifies the time in seconds that a node waits for a response BVLC message while it disconnects to BACnet/SC.
JCI SC Initiating Heartbeat Timeout W Specifies the time in seconds of BVLC message inactivity on a BACnet/SC connection before a Heartbeat-Request message is sent by an initiating BACnet/SC node.
Maximum Direct Connection Retries W

Indicates the maximum amount of retry attempts made when trying to establish a Direct Connection with another Node. If this value is exceeded, no more attempts are made to establish the Direct Connection.

If this value is 65535, then an infinite amount of retry attempts are made until the Direct Connection is successfully established.

If this value is 0, then no retry attempts are made if the first connection attempt fails.

It is recommended that this value is significantly large to allow any network configuration issues to be resolved and still allow the Direct Connection to automatically get established. However, if the value of this property is too large, the network and Hub Function may get flooded with messages unnecessarily, such as when a device is removed from the network or a device changed its VMAC Address.

Note: This value does not include the first connection attempt. So, if this value is 99, then 100 total connection attempts are made before giving up on the Direct Connection. The Minimum or Maximum Reconnect Time values still apply between consecutive connection attempts. If the written value is smaller than the current value, any current pending Direct Connections use the newly written value in determining if another retry is attempted.
JCI Network Port APDU Timeout W

Indicates the amount of time, in milliseconds, between retransmissions of an APDU requiring acknowledement for which no acknowledgement has been received.

This value is non-zero if the APDU Retries property is non-zero.

Note: This is a proprietary version of a BACnet Standard Device Object property which you can use in the JCI Network Port Objects to allow different values for different datalinks.
JCI Network Port APDU Segment Timeout W Indicates the amount of time, in milliseconds between retransmission of an APDU segment.
Note: This is a proprietary version of a BACnet Standard Device Object property which you can use in the JCI Network Port Objects to allow different values for different datalinks.
JCI Network Port APDU Retries W Indicates the maximum number of times that an APDU is retransmitted.
Note: This is a proprietary version of a BACnet Standard Device Object property that you can use in the JCI Network Port Objects to allow different values for different datalinks.
Advanced Logging Enabled   Use this to enable or disable advanced logging information that is printed to log files.
Enable Datalink Recovery Logic  

True enables the Datalink Recovery Logic in the BACnet/SC Network Port Object.

False disables the Datalink Recovery Logic in the BACnet/SC Network Port Object.

Item Reference   Indicates the fully qualified reference information for the object.