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:
- Communication Device Failover
- Device Settings
- Identifiers: Communication Devices
- Identifiers: remote devices
- Modems
- Polling: Failure
- Polling: Success
- Polling: Transmission
- Queue Status
- State: Communication Devices
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.
Device Settings
The following UDCs provide system-level information.
Identifiers: Communication Devices
The following UDCs provide system-level information.
Identifiers: remote devices
The following UDCs provide system-level information.
Modems
The following UDCs provide system-level information. All of these UDCs support suffixes.
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 |
Consecutive Failures |
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. |
String Input |
|
|
Last Fld Com Desc |
Last Failed Desc |
The last failed communication message (name of message in text). |
String Input |
|
|
Last Fld Com Time Num |
The time of last failed communication (OLE date/time format in GMT). |
Analog Input |
||
|
Last Fld Com Time Text |
Last Failed Time |
The time of last failed communication (MM/DD hh:mm:ss format). |
String Input |
|
|
Lst Fld UIS Desc |
Last Failed UIS Desc |
String Input |
||
|
Lst Fld UIS DevId |
Last Failed UIS DevId |
String Input |
||
|
Lst Fld UIS Tm N |
The time of last failed UIS command (OLE date/time format in GMT). |
Analog Input |
||
|
Lst Fld UIS Tm T |
Last Failed UIS Time |
The time of last failed UIS command (MM/DD hh:mm:ss format). |
String Input |
|
|
Sec Lst Fld Comm |
SYCSLFCS |
Secs Since Failure |
The elapsed time (in seconds) since the last failed communication.
Points using this UDC update in the following conditions:
|
Analog Input |
|
Ttl Fld Msgs |
Failed Msgs |
Analog Input |
||
|
Ttl Fld Msgs CRC |
Failed CRC |
Analog Input |
||
|
Ttl Fld Msgs No Resp |
Failed No Resp |
Analog Input |
||
|
Ttl Fld Msgs Other |
Failed Other |
The number of total failed message other than CRC or no response. |
Analog Input |
|
|
Ttl Fld UIS Cmds |
Failed UIS Cmds |
Analog Input |
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 |
Success 1st Att |
Analog Input |
||
|
# Succ Msgs Nth Att |
Success Nth Att |
The number of successful messages on attempts subsequent to the first. |
Analog Input |
|
|
# Succ Msgs Ttl |
Success Msgs |
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. |
Analog Input |
|
|
% Succ Msgs 1st Att |
Percent 1st Att |
Analog Input |
||
|
% Succ Msgs Nth Att |
Percent Nth Att |
The percentage of successful messages on attempts subsequent to the first. |
Analog Input |
|
|
% Succ Msgs Ttl |
Success % |
Analog Input |
||
|
Avg Succ Resp Time |
Avg. Resp Time (ms) |
Analog Input |
||
|
Last Succ Resp Time |
Analog Input |
|||
|
Last Succ Com Desc |
Last Succ Desc |
String Input |
||
|
Last Succ Com Time Num |
Analog Input |
|||
|
Last Succ Com Time Text |
Last Succ Time |
The time of last successful communication (MM/DD hh:mm:ss format, local system time). |
String Input |
|
|
Lst Succ UIS Desc |
Last Succ UIS Desc |
String Input |
||
|
Lst Succ UIS DevId |
Last Succ UIS DevId |
String Input |
||
|
Lst Succ UIS Tm N |
The time of last successful UIS command (OLE date/time format in GMT). |
Analog Input |
||
|
Lst Succ UIS Tm T |
Last Succ UIS Time |
The time of last successful UIS command (MM/DD hh:mm:ss format, local system time). |
String Input |
|
|
Sec Lst Succ Comm |
SYCSLSCS |
Secs Since Success |
Elapsed time (in seconds) since the last successful communication. Points using this UDC update in the following conditions:
|
Analog Input |
|
Succ Bytes Rcvd: Total |
Analog Input |
|||
|
Ttl Succ UIS Cmds |
Success UIS Cmds |
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. |
Analog Input |
Polling: Transmission
The following UDCs provide system-level information. All of these UDCs support suffixes.
Queue Status
The following UDCs provide system-level information.
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. 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. Return values are:
|
Analog Input or Enum Input |
|
|
Comm Device State Text |
SYDVST8S |
The communication device state in string format. Applies only to the communication device. Return values are:
|
String Input |
|
|
Cryouts: Total |
Cryouts |
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. |
String Input |
|
|
Curr Com State Num |
Specifies the state of a device communication channel. Applies to both remote devices and communication devices. The following values are possible:
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 |
Specifies the state of a device communication channel. Applies to both remote devices and communication devices. The following values are possible:
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 |
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). 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 |
String Input |
||
|
Not Ready Events |
The current value of the consecutive Not Ready event counter. |
Analog Input |



