UIS System UDCs

System UDCs facilitate system-level supervision of specific data points. The UDCs listed here are classified topically and include descriptions, keywords, and function.

For example, you could create a point record in the Point Service (PNT) that includes the UDC SYCSSTP. SYCSSTP would then send a notification if the percentage of successful messages on a serial radio communication device dropped below 95%.

See the following subsections for more information:

For general information about system UDCs, see System UDCs.

Suffixes

Many of the UDCs listed here can include a suffix that constrains the amount of data collected by the UDC. The constraint is time based. You could append any of these values to the end of the UDC to provide such a constraint: 2M, CD, CH, CM, LD, LH, LM, where 2M means 20 minutes, CD means current day, CH means current hour, CM means current month, LD means last day, LH means last hour, and LM means last month.

Note: The 20-minute statistics system UDC (SYCSST2M) is a special rollup of one-minute values for the 20 minutes prior to its execution. SYCSST2M (Activate 20 Min Stats) helps control the strain that constant recalculation would ordinarily put on a large system. 20-minute statistics are only applicable to communication and remote devices. The 20-minute statistics are not enabled by default due to the strain that constant recalculation can put on a large system. They can be enabled for a UIS, or just for select devices in a UIS. Optionally, you can create points for the 20-minute statistics. The suffix for the 20-minute statistic is 2M. For more information see SYCSST2M (Activate 20 Min. Stats) and Setting up 20-Minute Statistics.

Communication Device Failover

The following UDCs provide system-level information.

UDC Description UDC UI Description Description Point Type

Comm failover of primary

SYDEVFO1

 

Updates whenever the primary communication device fails over to one of the alternate devices.Click here

Analog Input

Comm failover of secondary

SYDEVFO2

 

Updates whenever the secondary communication device fails over to one of the alternate devices.Click here

Analog Input

Comm failover of tertiary

SYDEVFO3

 

Updates whenever the tertiary communication device fails over to one of the alternate devices.Click here

Analog Input

Primary Comm Failover

SYDEVPRFO

 

This point is set to 1 whenever the RTU has failed over from primary to secondary based on the Init Fail Secs setting. It is not reset to 0 until there is successful communication with the primary communication device.Click here

Analog Input

Back to top

Device Settings

The following UDCs provide system-level information.

UDC Description UDC UI Description Description Point Type

Comm Device Host Mode

SYDEVHMODE

 

The host mode of the communication device.Click here

TBD

Device Category

SYDEVCAT

 

The device category (RD, CD, ED) in string format.Click here

String Input

Device Enabled

SYDEVENABL

 

Indicates if device is enabled in the DDS (1=enabled; 0=disabled).Click here

Digital Input

Device Poll Attempts

SYDEVRETRY

 

The number of poll attempts.Click here

Analog Input

Device Poll Delay

SYDEVPDELY

 

The message delay in milliseconds.Click here

Analog Input

Device Poll Timeout

SYDEVPTOUT

 

The message timeout in milliseconds.Click here

Analog Input

Device Revision

SYDEVREV

 

The software revision number of the RTU. Posted by the EIE only if the point is defined. Only implemented for the following EIEs: AllenBradleyCIP, EProdRPC, FlowAuto, Weatherford, LufkinSam, Mercury, and ProSoft.Click here

String Input

Last User to Poll/Ctrl

SYLASTUSR

 

The last user to send/retrieve data from device/facility.Click here

String Input

Number of Configured Comms SYDEVCOMN  

Represents the number of configured comm lines for a given remote device. The value can be 1, 2, or 3.Click here

Analog Input

Back to top

Identifiers: Communication Devices

The following UDCs provide system-level information.

UDC Description UDC UI Description Description Point Type

Alternate Comm 2

SYDEVACOM2

 

The name of the configured secondary communication device. Can be used interchangeably with SYDEVSCOM.Click here

Analog Input

Alternate Comm 3

SYDEVACOM3

 

The name of the configured tertiary communication device.Click here

Analog Input

Curr Comm Line

SYDEVCOMLN

 

The currently active communication line. 1 for primary, 2 for secondary, 3 for tertiary.Click here

Analog Input

Device Comm ID

SYDEVCOMID

 

The device ID of the currently active communication device in string format.Click here

String Input

Primary Comm ID

SYDEVPCOM

 

The name of the configured primary communication device.Click here

Analog Input

Secondary Comm ID

SYDEVSCOM

 

The name of the configured secondary communication device. Can be used interchangeably with SYDEVACOM2.Click here

Analog Input

Back to top

Identifiers: remote devices

The following UDCs provide system-level information.

UDC Description UDC UI Description Description Point Type

Device Address

SYDEVADDR

 

The device address (including group address if applicable) in string format.Click here

String Input

Device Desc

SYDEVDESC

 

The device description in string format.Click here

String Input

Device ID

SYDEVID

 

The device ID in string format.Click here

String Input

Device Type

SYDEVTYPE

 

The device type (based on EIE) in string format.Click here

String Input

Back to top

Modems

The following UDCs provide system-level information. All of these UDCs support suffixes.

UDC Description UDC UI Description Description Point Type

Dial Attempts

SYCSMDATClick here

 

The number of total dial attempts (successful and failed).Click here

Analog Input

Dial Attempts Failed Busy

SYCSMDBYClick here

 

The number of failed dial attempts due to busy signal.Click here

Analog Input

Dial Attempts Failed Unknown

SYCSMDUKClick here

 

The number of failed dial attempts due to unknown reasons.Click here

Analog Input

Dial Attempts Fail No Carrier

SYCSMDNCClick here

 

The number of failed dial attempts due to no carrier.Click here

Analog Input

Dial Attempts Fail No Dial tone

SYCSMDNDClick here

 

The number of failed dial attempts due to no dial tone.Click here

Analog Input

Dial Attempts Successful

SYCSMDOKClick here

 

The number of total successful dial attempts.Click here

Analog Input

Dial Retry Attempts

SYCSMDRAClick here

 

The number of total dial retries.Click here

Analog Input

Last Dial Attempt Time

SYCSMDDTClick here

 

The time of last dial attempted (failed or succeeded) (MM/DD hh:mm:ss format).Click here

Analog Input

Modem Connect Error

SYCSMDERClick here

 

The modem connect failures reported as Error.Click here

String Input

Modem Connect No Answer

SYCSMDNAClick here

 

The modem connect failures reported as No Answer.Click here

String Input

Back to top

Polling: Failure

The following UDCs provide system-level information. Some of these UDCs support suffixes.

UDC Description UDC UI Description Description Point Type

Consecutive Fld Msgs

SYCSFSEQClick here

Consecutive Failures

The number of consecutive failed communication attempts.Click here

Analog Input

Last device to fail

SYC

 

Tracks the remote device that last had a failed message on a communication device. The comm device stores the remote ID and the current time when failures occur. The point will only update if the remote ID is not empty and the latest failure timestamp has changed.Click here

String Input

Last Fld Com Desc

SYCSLFCDClick here

Last Failed Desc

The last failed communication message (name of message in text).Click here

String Input

Last Fld Com Time Num

SYCSLFCNClick here

 

The time of last failed communication (OLE date/time format in GMT).Click here

Analog Input

Last Fld Com Time Text

SYCSLFCTClick here

Last Failed Time

The time of last failed communication (MM/DD hh:mm:ss format).Click here

String Input

Lst Fld UIS Desc

SYCSLFUDClick here

Last Failed UIS Desc

The name of last failed UIS command.Click here

String Input

Lst Fld UIS DevId

SYCSLFUIClick here

Last Failed UIS DevId

The device ID that the last failed UIS command was sent to.Click here

String Input

Lst Fld UIS Tm N

SYCSLFUNClick here

 

The time of last failed UIS command (OLE date/time format in GMT).Click here

Analog Input

Lst Fld UIS Tm T

SYCSLFUTClick here

Last Failed UIS Time

The time of last failed UIS command (MM/DD hh:mm:ss format).Click here

String Input

Sec Lst Fld Comm

SYCSLFCS

Secs Since Failure

The elapsed time (in seconds) since the last failed communication. Click here

Points using this UDC update in the following conditions:

Analog Input

Ttl Fld Msgs

SYCSFTOTClick here

Failed Msgs

The number of total failed messages for all reasons.Click here

Analog Input

Ttl Fld Msgs CRC

SYCSFCRCClick here

Failed CRC

The number of total failed messages due to CRC error.Click here

Analog Input

Ttl Fld Msgs No Resp

SYCSFNORClick here

Failed No Resp

The number of total failed messages due to no response.Click here

Analog Input

Ttl Fld Msgs Other

SYCSFOTHClick here

Failed Other

The number of total failed message other than CRC or no response.Click here

Analog Input

Ttl Fld UIS Cmds

SYCSFUTTClick here

Failed UIS Cmds

The number of total failed UIS commands.Click here

Analog Input

Back to top

Polling: Success

The following UDCs provide system-level information. Some of these UDCs support suffixes.

UDC Description UDC UI Description Description Point Type

# Succ Msgs 1st Att

SYCSS1NClick here

Success 1st Att

The number of successful messages on the first attempt.Click here

Analog Input

# Succ Msgs Nth Att

SYCSSNNClick here

Success Nth Att

The number of successful messages on attempts subsequent to the first.Click here

Analog Input

# Succ Msgs Ttl

SYCSSTNClick here

Success Msgs

The number of total successful messages.Click here

Analog Input

% Succ. 0 Attempts is Reliable

SYCSSTZR

 

Determines whether to mark the Percent Successful Communication statistic as reliable or unreliable when the attempts count is zero. Default is mark point as reliable.Click here

Analog Input

% Succ Msgs 1st Att

SYCSS1PClick here

Percent 1st Att

The percentage of successful messages on the first attempt.Click here

Analog Input

% Succ Msgs Nth Att

SYCSSNPClick here

Percent Nth Att

The percentage of successful messages on attempts subsequent to the first.Click here

Analog Input

% Succ Msgs Ttl

SYCSSTPClick here

Success %

The percentage of successful messages.Click here

Analog Input

Avg Succ Resp Time

SYCSAPRTClick here

Avg. Resp Time (ms)

The average successful response time in milliseconds.Click here

Analog Input

Last Succ Resp Time

SYCSLPRTClick here

 

The number of milliseconds for last successful response.Click here

Analog Input

Last Succ Com Desc

SYCSLSCDClick here

Last Succ Desc

The name of last successful message.Click here

String Input

Last Succ Com Time Num

SYCSLSCNClick here

 

The time of last successful communication (raw UTC time).Click here

Analog Input

Last Succ Com Time Text

SYCSLSCTClick here

Last Succ Time

The time of last successful communication (MM/DD hh:mm:ss format, local system time).Click here

String Input

Lst Succ UIS Desc

SYCSLSUDClick here

Last Succ UIS Desc

The name of last successful UIS command.Click here

String Input

Lst Succ UIS DevId

SYCSLSUIClick here

Last Succ UIS DevId

Device ID that the last successful UIS command was sent to.Click here

String Input

Lst Succ UIS Tm N

SYCSLSUNClick here

 

The time of last successful UIS command (OLE date/time format in GMT).Click here

Analog Input

Lst Succ UIS Tm T

SYCSLSUTClick here

Last Succ UIS Time

The time of last successful UIS command (MM/DD hh:mm:ss format, local system time).Click here

String Input

Sec Lst Succ Comm

SYCSLSCS

Secs Since Success

Elapsed time (in seconds) since the last successful communication.Click here

Points using this UDC update in the following conditions:

Analog Input

Succ Bytes Rcvd: Total

SYCSSBRCClick here

 

The number of successful bytes received.Click here

Analog Input

Ttl Succ UIS Cmds

SYCSSUTTClick here

Success UIS Cmds

The number of total successful UIS commands.Click here

Analog Input

Value for %Succ. For 0 Attempts

SYCSSTZA

 

Determines the value to use in calculating the percent successful when the attempt count is zero. Default is 100.Click here

Analog Input

Back to top

Polling: Transmission

The following UDCs provide system-level information. All of these UDCs support suffixes.

UDC Description UDC UI Description Description Point Type

Lst Dev Drain Tm N

SYCSLDDNClick here

 

The last time it was necessary to clear unexpected data from communications channel (OLE date/time format in GMT).Click here

Analog Input

Lst Dev Drain Tm T

SYCSLDDTClick here

Last Device Drain

The last time it was necessary to clear unexpected data from communications channel (MM/DD hh:mm:ss format).Click here

String Input

Lst Drain DevID

SYCSLDDIClick here

Last Drain DevId

The last device attempted to be communicated with when it was necessary to clear unexpected data from the communication channel.Click here

String Input

Last Message Sent Desc

SYCSLBCDClick here

 

The name of the last message sent (failed or succeeded).Click here

String Input

Last Message Sent Time

SYCSLBCTClick here

 

The time of last message sent (failed or succeeded) (MM/DD hh:mm:ss format).Click here

String Input

Ttl Atmpd Msgs

SYCSTOTClick here

Msg Attempts

The number of total attempted messages.Click here

Analog Input

Ttl Atmpd UIS Cmds

SYCSUTTClick here

 

The number of total attempted UIS commands (sum of SYCSSUTT and SYCSFUTT).Click here

Analog Input

Ttl Bytes Drained

SYCSDDBClick here

 

The total unexpected bytes cleared from the communication channel.Click here

Analog Input

Ttl Bytes Rcvd

SYCSBRCVClick here

Bytes Received

The number of total bytes received.Click here

Analog Input

Ttl Bytes Sent

SYCSBSNTClick here

Bytes Sent

The number of total bytes sent.Click here

Analog Input

Ttl Device Drains

SYCSDDTTClick here

Total Device Drains

The number of times unexpected data needed to be cleared from the communication channel.Click here

Analog Input

Back to top

Queue Status

The following UDCs provide system-level information.

UDC Description UDC UI Description Description Point Type

Avg Resp Proc. Time

SYMSARPT

 

The average number of milliseconds to process an item in the processing queue.Click here

Analog Input

Avg Ttl Mess Proc. Time

SYMSATMT

 

The average number of milliseconds to process all items in the processing queue.Click here

Analog Input

Pending Comm Queue Cnt

SYCSPEND

 

The number of messages pending in a communication queue.Click here

Analog Input

Pending Comm Queue Cnt per remote device

SYRSPEND

 

The number of messages the specified remote device has pending in its associated communication queue.Click here

Analog Input

Point Value Only Resp Queue

SYPROCQPT

 

Represents the size of the Point processing queue.

This UDC tracks process messages which do just point processing. Allows tracking of the backlog of the Point processing queue.Click here

Note: Some messages which write to the DDS may end up on the Point Processing response queue and vice-versa.

Analog Input

Processing Queue Count

SYPROCQUE

 

The number of messages in the UIS processing queue (non-communications related). Examples are device and point updates. Represents the sum of SYPROCQPT and SYPROCQTX. Generally this value is best kept to less than 2.Click here

Analog Input

Tx Writing Resp Queue

SYPROCQTX

 

Represents the size of the DDS transaction processing queue. This UDC tracks process messages which will save transaction data to the DDS. Allows tracking of the backlog of the DDS transaction processing queue.Click here

Note: Some messages which write to the Point Processing response queue may end up on the DDS transaction processing queue and vice-versa.

Analog Input

Back to top

State: Communication Devices

The following UDCs provide system-level information. Some of these UDCs support suffixes.

UDC Description UDC UI Description Description Point Type

Activate 20 Min. Stats

SYCSST2M

 

Activates the use of 20-minute statistics, which is a special rollup of one-minute values for the 20 minutes prior to execution. It helps control the strain that constant recalculation would ordinarily put on a large system.Click here

20-minute statistics are not represented as current period-last period pairs; there is no previous statistic to compare against the current one. For each minute that passes, the rollup is recalculated with the oldest value dropped off and the most recent value added on. There is no dynamic processing of the 20-minute statistic in between the one-minute processing intervals even if the statistic's point processing is forced by the device.

Activating the UDC for your UIS and selected devices does not enable mapping for the UDC. To enable mapping, you must add specific points by using the appropriate communication statistics system UDC(s) along with the required time period suffix.

20-minute statistics are applicable to communication and remote devices.

For more information, see Setting Up 20-Minute Statistics.

String Input

Comm Device State Numeric

SYDVST8N

 

The communication device state in numeric format. Applies only to the communication device.Click here

Return values are:

  • 04 - Connected
  • 05 - Not Connected
  • 06 - Paused
  • 07 - Error
  • 08 - Disabled
  • 09 - Connecting
  • 10 - IP Connecting
  • 11 - IP Connected
  • 12 - Modem Connecting
  • 13 - Modem Connected
  • 14 - Not Ready

Analog Input or Enum Input

Comm Device State Text

SYDVST8S

 

The communication device state in string format. Applies only to the communication device.Click here

Return values are:

  • Connected
  • Not Connected
  • Paused
  • Error
  • Disabled
  • Connecting
  • IP Connecting
  • IP Connected
  • Modem Connecting
  • Modem Connected
  • Not Ready

String Input

Cryouts: Total

SYCSCRYClick here

Cryouts

The number of total cryouts.Click here

Analog Input

Curr Active Device

SYCSRDVC

 

The name of the currently active device. Name is displayed only when device is active; otherwise the value is blank.Click here

String Input

Curr Com State Num

SYCSSTTNClick here

 

Specifies the state of a device communication channel. Applies to both remote devices and communication devices.Click here

The following values are possible:

  • 00: Assigned if no message has occurred since a UIS start.
  • 01: Assigned if a successful message is the most recent message to occur.
  • 02: Assigned if a failed message is the most recent message to occur.
  • 03: Assigned if a failed message is the most recent message to occur and the interval (in minutes) between the most recent failed message and the previous successful message or UIS start (if no successful message exists since UIS start) exceeds the value specified for SYCOMSTFP.

If using an enumeration input point type, use the COMSTATE table for the conversions.

See Failed Comm Transition Period for information about when 2 – Exception changes to 3 – Critical.

For strings, see SYCSSTAT.

Analog Input or Enum Input

Curr Com State Text

SYCSSTATClick here

 

Specifies the state of a device communication channel. Applies to both remote devices and communication devices.Click here

The following values are possible:

  • Unknown: Assigned if no message has occurred since a UIS start.
  • Normal: Assigned if a successful message is the most recent message to occur.
  • Exception: Assigned if a failed message is the most recent message to occur.
  • Critical: Assigned if a failed message is the most recent message to occur and the interval (in minutes) between the most recent failed message and the previous successful message or UIS start (if no successful message exists since UIS start) exceeds the value specified for SYCOMSTFP.

See Failed Comm Transition Period for information about when 2 – Exception changes to 3 – Critical.

For enumerations, see SYCSSTTN.

String Input

Failed comm transition period

SYCOMSTFP

 

Specifies the interval (in minutes) allowed before a communication state changes from 2 – Exception to 3 – Critical. The interval starts at the most recent failed message and extends to the previous successful message or UIS start (if no successful message exists since UIS start).Click here

The interval is not tied to current time. For example, imagine you set SYCOMSTFP to 20. A successful message occurs at 3:00:00AM and the comm state becomes Normal. Then no other message occurs until 3:10:00AM, when a failed message occurs and the comm state becomes Exception. At 3:45:00AM a second failed message occurs, which changes the comm state from Exception to Critical. That is because the Exception state was reached and more than 20 minutes passed since the last successful message. The change does not occur at 3:20:00AM or 3:40:00AM.

You can apply the value to a remote device, communication device, and/or an entire UIS. If you apply this value to a remote device, the value applies to all of the remote device’s facilities. If you apply this value at the UIS level, it applies to all remote devices and communication devices in that UIS. The default value at the UIS level is 480.

To change the interval for the UIS, create a point for which the facility is the applicable UIS and the UDC is SYCOMSTFP.

To change the interval for a device, create a point for which the facility is the applicable device and the UDC is SYCOMSTFP.

An edit to this setting does not take effect until a UIS start occurs.

See Failed Comm Transition Period for information about when 2 – Exception changes to 3 – Critical.

Analog Input

Last Active Device

SYCSRDVL

 

The name of the last active device.Click here

String Input

Not Ready Events

SYCSSTNRClick here

 

The current value of the consecutive Not Ready event counter.Click here

Analog Input

Back to top