System, alarm and session signals

YTCC provides three groups of signals without any configuration. System and Alarms signals are real signals of the project: they appear in the signal list, can be shown on screens, archived, used in alarms and read by scripts. They are read only. Session signals exist only in the browser of each operator station.

The names System, Alarms and Session are reserved; your own signals cannot start with them.

System

Signals	Type	Updated	Content
System.Time.Year, .Month, .Day, .Hour, .Minute, .Second	Int32	1 s	Local date and time
System.Time.Weekday, .WeekOfYear, .DayOfYear	Int32	1 s	Weekday (1 = Monday), ISO week, day of the year
System.Time.Date, .Clock, .DateTime	String	1 s	Date YYYY-MM-DD, time HH:MM:SS, both
System.Time.EpochMs, .UtcOffsetMin	Int64, Int32	1 s	Milliseconds since 1970, offset from UTC in minutes
System.Server.Name, .Os	String	5 s	Name and operating system of the server
System.Server.UptimeS	Int64	5 s	Seconds since the server started
System.Server.CpuPct, .MemPct, .DisksUsedPct	Float64	5 s	Processor, memory and disk use in %
System.Server.MemTotalMB, .MemUsedMB	Float64	5 s	Memory in MB
System.Server.DisksTotalGB, .DisksFreeGB	Float64	5 s	Disk space in GB
System.Server.Disks.<disk>.Mount	String	5 s	Mount point of a disk (C on Windows; root, mnt_data … on Linux)
System.Server.Disks.<disk>.TotalGB, .FreeGB, .UsedPct	Float64	5 s	Size, free space and use of the disk
System.Server.Disks.<disk>.Level	Int32	5 s	0 normal, 1 warning, 2 high, 3 critical
System.Project.Slug, .StartTime, .WorkDir, .InstallDir, .Version	String	5 s	Project code, start time, folders and version
System.Project.UptimeS	Int64	5 s	Seconds since the project started
System.Processes.Total, .Running, .Stopped	Int64	5 s	Number of processes of the project
System.Processes.<process>.Running	Bool	5 s	The process runs
System.Processes.<process>.State	String	5 s	State of the process
System.Processes.<process>.Pid, .Restarts, .UptimeS, .Port	Int64	5 s	Process number, restarts, running time, port
System.Processes.<process>.CpuPct, .MemMB	Float64	5 s	Processor use and memory of the process
System.Drivers.<driver>.Running	Bool	On change	The driver process runs
System.Drivers.<driver>.Equipments, .Connected	Int64	On change	Number of devices and of connected devices
System.Drivers.<driver>.<device>.State	Int32	On change	0 not connected, 1 connected, 2 initial sync, 3 inactive
System.Drivers.<driver>.<device>.Connected	Bool	On change	The device communicates
System.Drivers.<driver>.<device>.SentFrames, .RcvFrames, .RejFrames	Int64	On change	Frames sent, received and rejected
System.Drivers.<driver>.<device>.RxPerSec	Float64	On change	Received frames per second
System.Drivers.<driver>.<device>.LastError	String	On change	Last error reported by the driver
System.Drivers.<driver>.<device>.Timeouts, .Retries, .Reconnects	Int64	On change	Response timeouts, retries and reconnects since the driver started; 0 when the driver does not measure them
System.Drivers.<driver>.<device>.RespAvgMs, .RespMaxMs	Float64	On change	Average and longest response time in ms since the last connection; 0 when not measured
System.Drivers.<driver>.<device>.ConnectedSince	String	On change	Local time of the last connection, YYYY-MM-DD hh:mm:ss; empty when not connected
System.Drivers.<driver>.<device>.CycleMs, .LoadPct	Float64	On change	Scan cycle in ms and scan load in % (above 100 the device cannot be read as often as configured); 0 when not measured
System.Historian.DiskUsedPct, .DiskFreeGB, .TotalSizeMB, .DbSizeMB	Float64	30 s	Disk and size of the history
System.Historian.DiskLevel	Int32	30 s	0 normal to 3 critical
System.Historian.ValuesPaused, .EventsPaused, .ReservePresent	Bool	30 s	Recording of values or events paused, reserve file present
System.Historian.Tables	Int32	30 s	Number of archive tables
System.Historian.Tables.<table>.SizeMB, .MaxGB, .LimitUsedPct	Float64	30 s	Size and limit use of an archive table
System.Historian.Tables.<table>.Days, .OldestDay, .NewestDay, .Active	Int32, String, Bool	30 s	Days held, oldest and newest day, table active

Process names are the process identifiers with . instead of /. Values are published when they change and refreshed every 30 seconds. Server scripts and the electrical topology add further signals under System.Scripts.<script> and System.Elec.<page>.<device>; see Server scripts and The live single-line diagram.

Alarms

The alarm counters exist for the whole project (Alarms.Summary), for each alarm area (Alarms.Areas.<area>, sub-areas under .Sub.<sub-area>) and for each alarm group (Alarms.Groups.<group>, sub-groups under .Sub.<sub-group>). They are updated on change, at most four times a second.

Signal	Type	Content
….Active	Int32	Active alarms
….Unacked	Int32	Alarms not yet acknowledged
….Acked	Int32	Acknowledged active alarms
….ReturnedUnacked	Int32	Returned alarms not yet acknowledged
….Shelved	Int32	Shelved alarms (they count only here)
….Open	Int32	Alarms in the list (active or not yet acknowledged)
….Critical, ….High, ….Medium, ….Low	Int32	Open alarms per priority
….HighestPriority	Int32	Highest open priority: 0 none … 4 critical
….HasUnacked	Bool	At least one alarm is not acknowledged

Alarms that are out of service or suppressed are not counted. System alarms without a definition, such as communication alarms and failed commands, count in Alarms.Summary only. Area and group names are written without special characters in the path, for example Ünite 1 as unite_1.

Session

Session signals are calculated in the browser; each operator station sees its own values. They are not stored on the server and cannot be written, archived or used in server alarms.

Signal	Type	Content
Session.User.Name, .Id	String	Signed-in user
Session.User.Roles	String	Profile identifiers of the user, separated by commas
Session.User.LoginTime	String	Time of the sign-in, local time
Session.User.LoggedIn	Bool	A user is signed in
Session.User.IdleS	Int	Seconds since the last mouse, key or touch input
Session.Client.Address	String	Name of the server the browser is connected to
Session.Client.Language	String	Language of the interface
Session.Client.Page	String	Name of the current page
Session.Client.CommLostView	String	How values are shown when communication is lost: last (last known value) or unknown