Connector Class
General info
Label |
Connector |
Description |
A connector holds all necessary information for the communication with his underlaying endpoints. |
Class version |
2.1387 |
Code |
4 |
Symbolic name |
MODEL_CLASS_CONNECTOR |
Lua access code |
syslib.model.classes.Connector |
Available since |
1.0 |
- Parent classes
- Child classes
-
ActionItem | BatchTracker | CloudSinkItem | DBSinkItem | Datasource | FeedbackItem | FileMonitor | GenFolder | GenItem | GenericEventBuffer | GenericTimeSeriesBuffer | HistorySinkItem | HistoryTransportManager | HistoryTransporter | HolderItem | ITLogConfigurator | InternalEventStream | LinkItem | Parameter | RedItem | ReportGenerator | ReportItem | Rule | RuleNode | SchedulerItem | ScriptEvents | SecurityPerimeter | StoredCredentialsGroup | TableHolder | TemplateNode | TimezoneAndAvailabilityTracker | Variable | VariableGroup
Attributes
| Name | Tooltip |
|---|---|
| CLASS_CONFIGURABLE | Class is manually configurable. |
| CLASS_REMOTE_COMM | Class maintains remote Communication. |
| CLASS_REMOTE | Class can only be remote to a Core and creates remote objects below itself. |
| SOT_REGULAR_OBJECT |
Properties and Subobjects
- PAttachments
- PAuxStateManagement
- PCommunicationSettings
- PComponentUpdateVerification
- PComponentVersionPolicy
- PConnectorOptions
- PCustomOptions
- PDCOMCredentials
- PDisplayAlias
- PHMUsecases
- PHostInformation
- PIoSubsystemState
- PLocation
- PLogConsoleOutput
- PObjectDescription
- PObjectName
- POpcUaConnectorOptions
- PPkgInstaller
- PSQLCatalog
- PSafMainRetentionPolicy
- PSafOptions
- PScriptLibrary
- PSoftwareInformation
- PStartupScript
- PTransmissionLimits
- PinmationComponent
- SSafRetentionPolicyDiskDate
- SSafRetentionPolicyDiskSize
- SSafRetentionPolicyDiskUsage
- SSafRetentionPolicyInMemory
- SSafRetentionPolicyNone
Performance counters
- VQTWriteOps
Code Name Description Unit 9
IoItemWriteFailure
The Count of failed V(QT) write operations against external Data Sources per Time Unit
Count (generate counter)
1
IoItemWrites
The item write commands per time unit
Count (generate counter)
8
IoItemWriteSuccess
The Count of successful V(QT) write operations against external Data Sources per Time Unit
Count (generate counter)
- ChannelDiagnostics
Code Name Description Unit 50
Lag
Lag time between the data update request and the response from the remote component
ms (Milliseconds)
243
TotalCompressionRatio
Compression ratio of data being transferred to and from various channels
Percent (Percentage)
242
TotalReceiveRate
The rate at which data is being received through various channels
Mbit (Megabit)
244
TotalSendRate
The rate at which data is being sent through various channels
Mbit (Megabit)
327
UplinkKeepAliveUtil
Inter-component keep-alive data utilization in the uplink channel
Percent (Percentage)
328
UplinkKeepAliveUtilDynData
Inter-component keep-alive utilization by dynamic real-time data (VQT data, volatile property changes, performance indicators) in the uplink channel
Percent (Percentage)
329
UplinkKeepAliveUtilVqtData
Inter-component keep-alive utilization by VQT real-time data in the uplink channel
Percent (Percentage)
- StoreAndForwardVqt
Code Name Description Unit 128
SafVqtDataBacklog
VQT data to be forwarded to a remote component or sent to the destination data store or buffer
Count (generate counter)
77
SafVqtDataBufferDisk
Number of VQT items buffered on disk
Count (generate counter)
109
SafVqtDataBufferMemory
Number of VQT items buffered in main memory
Count (generate counter)
84
SafVqtDataInserts
Current VQT data insertion rate into this component’s SaF buffer, destined for this object
Inserts (database inserts)
123
SafVqtDataPendingDeletions
Pending VQT data deletions
Count (generate counter)
83
SafVqtDataSend
Current rate of VQT data being read from this component’s SaF buffer and sent to the data store(s) or buffer(s) related to this object
Count (generate counter)
331
SafVqtStaleValueHistorization
Current insertion rate of VQT items that were historized again because they were not modified within the configured time frame
Inserts (database inserts)
- StoreAndForwardEvent
Code Name Description Unit 126
SafEventBacklog
Events to be forwarded to a remote component or sent to the destination data store
Count (generate counter)
87
SafEventBufferDisk
Number of events buffered on disk
Count (generate counter)
107
SafEventBufferMemory
Number of events buffered in main memory
Count (generate counter)
88
SafEventInserts
Current event insertion rate into the buffer
Inserts (database inserts)
125
SafEventPendingDeletions
Pending Event deletions
Count (generate counter)
90
SafEventSend
Current event send rate
Count (generate counter)
- StoreAndForwardLog
Code Name Description Unit 127
SafLogEntriesBacklog
Log entries to be forwarded to a remote component or sent to the destination data store
Count (generate counter)
78
SafLogEntriesBufferDisk
Number of buffered log entries on disk
Count (generate counter)
108
SafLogEntriesBufferMemory
Number of log entries buffered in main memory
Count (generate counter)
85
SafLogEntriesInserts
Current log entry insertion rate into the buffer
Inserts (database inserts)
124
SafLogEntriesPendingDeletions
Pending Log entry deletions
Count (generate counter)
86
SafLogEntriesSend
Current log entry send rate
Count (generate counter)
- StoreAndForwardAuditTrail
Code Name Description Unit 277
SafAuditTrailEntriesBacklog
Audit trail entries in the backlog, ready to be sent
Count (generate counter)
278
SafAuditTrailEntriesBufferDisk
Number of buffered audit trail entries on disk
Count (generate counter)
279
SafAuditTrailEntriesBufferMemory
Number of audit trail entries buffered in main memory
Count (generate counter)
280
SafAuditTrailEntriesInserts
Current audit trail entry insertion rate into the buffer
Inserts (database inserts)
281
SafAuditTrailEntriesPendingDeletions
Pending audit trail entry deletions
Count (generate counter)
283
SafAuditTrailEntriesSend
Current audit trail entry send rate
Count (generate counter)
- StoreAndForwardMsg
Code Name Description Unit 291
SafMsgBufferDisk
Number of Messages buffered on disk
Count (generate counter)
292
SafMsgBufferMemory
Number of Messages buffered in main memory
Count (generate counter)
293
SafMsgInserts
Current Message insertion rate into the buffer
Inserts (database inserts)
294
SafMsgPendingDeletions
Pending Message deletions
Count (generate counter)
296
SafMsgRead
Current Message read rate
Count (generate counter)
- StoreAndForward
Code Name Description Unit 132
SafAge
The age of the Store and Forward data buffered on disk in hours
H (Hours)
139
SafBacklog
Store and Forward items to be forwarded to a remote component or sent to the destination data store
Count (generate counter)
133
SafBufferDisk
Total number of items buffered on disk
Count (generate counter)
134
SafBufferMemory
Total number of items buffered in main memory
Count (generate counter)
110
SafDiskUsage
Disk space used by the Store and Forward system
MB (Megabyte)
135
SafInserts
Current total insertion rate of items into the Store and Forward system
Inserts (database inserts)
136
SafPendingDeletions
Total pending Store and Forward item deletions
Count (generate counter)
138
SafSend
Current total Store and Forward item send rate
Count (generate counter)
- AeRawReception
Code Name Description Unit 93
AeDiscardedInConnector
The number of events which have been discarded by connector logic
Count (generate counter)
100
AeEventFailures
The number of events which raised an error in the processing chain or contained invalid data (e.g. violating the A&E or A&C specification)
Count (generate counter)
95
AeFloodingEvents
The number of events which are flooding (based on configured frequency)
Count (generate counter)
82
AeRcvConditionEvents
The number of condition events received from the external server
Count (generate counter)
80
AeRcvSimpleEvents
The number of simple events received from the external server
Count (generate counter)
81
AeRcvTrackingEvents
The number of tracking events received from the external server
Count (generate counter)
94
AeRepetetiveEvents
The number of events which have been completely equal other than the timestamp
Count (generate counter)
96
AeTotalEvents
Overall event count
Count (generate counter)
- Hardware
Code Name Description Unit 319
ConsoleWrites
Number of bytes written from the standard console output and error streams to the service log
Count (generate counter)
72
CPU
Current CPU load on this inmation service host
Percent (Percentage)
144
DiskUsage
Current overall hard disk usage
Percent (Percentage)
74
inmationCPU
Current CPU load used by an inmation component service
Percent (Percentage)
147
inmationDiskUsage
Current hard disk usage by an inmation service component
MB (Megabyte)
177
inmationDiskUsagePercentage
Current hard disk usage (%) by an inmation service component
Percent (Percentage)
146
inmationMemoryUsage
Current main memory usage by an inmation service component
MB (Megabyte)
178
inmationMemoryUsagePercentage
Current main memory usage (% RAM) by an inmation service component
Percent (Percentage)
145
MemoryLoad
Current main memory (RAM) load
Percent (Percentage)
222
NumberActiveThreads
Number of threads
Count (generate counter)
223
NumberOpenHandles
Current number of handles open by the process
Count (generate counter)
- SQLCatalogDiagnostics
Code Name Description Unit 152
SQLCatalogDiagnosticsBacklogEgress
Changes processed from the backlog and stored in the catalog
Count (generate counter)
154
SQLCatalogDiagnosticsBacklogIngress
Changes coming into the backlog
Count (generate counter)
151
SQLCatalogDiagnosticsBacklogSize
Number of changes waiting to be stored in the catalog
Count (generate counter)
153
SQLCatalogDiagnosticsMemoryUsage
The amount of memory that the SQL Catalog is using
MB (Megabyte)
181
SQLCatalogDiagnosticsQueries
The number of queries executed on SQL Catalog
Count (generate counter)
- PersistenceDiagnostics
Code Name Description Unit 155
PersistenceDiagnosticsBacklogEgress
Dynamic value changes being persisted periodically
Count (generate counter)
156
PersistenceDiagnosticsBacklogIngress
Dynamic value changes in objects marked to be persisted periodically
Count (generate counter)
157
PersistenceDiagnosticsBacklogSize
The number of dynamic value changes in the backlog waiting to persisted periodically
Count (generate counter)
159
PersistenceDiagnosticsImmediateChanges
Dynamic value changes being persisted immediately
Count (generate counter)
158
PersistenceDiagnosticsTimeRatio
The ratio of time spent on non-persistence related work and persisting a value
Count (generate counter)
- Objects
Code Name Description Unit 42
DataObjects
This counter shows the number of I/O data objects in relation to the entire system or distinct parts such as remote components (connector or relay components)
Count (generate counter)
43
DataObjectUpdates
This counter shows the number of I/O object updates in relation to the entire system or distinct parts such as remote components (connector or relay components)
Count (generate counter)
174
ObjectCount
Difference between the number of objects created and the number of objects deleted
Count (generate counter)
175
ObjectCreations
The number of objects being created per second in this component
Count (generate counter)
176
ObjectDeletions
The number of objects being deleted per second in this component
Count (generate counter)
324
ObjectIdUsage
Current usage of available object IDs in this component
Percent (Percentage)
41
RegisteredObjects
Total number of objects registered in this component.
Count (generate counter)
- ImageSystem
Code Name Description Unit 258
imgCycleDuration
The duration of the last full image write cycle
S (Seconds)
183
imgDirtyBlocks
The total number of dirty (modified) blocks that need to be written to the image file
Count (generate counter)
185
imgErrors
The number of image write errors
Count (generate counter)
182
imgTotalBlocks
The total number of blocks in the image file
Count (generate counter)
184
imgWrites
The number of blocks successfully written to the image file
Count (generate counter)
257
imgWriteThroughput
The total volume successfully written into the image file
MB (Megabyte)
- RealTimeBuffers
Code Name Description Unit 188
rtbCurrentCapacity
The total current capacity of all the real-time buffers, in data values. This value directly corresponds to actually allocated memory.
Count (generate counter)
191
rtbIngress
The total number of data values buffered per second.
Count (generate counter)
190
rtbPeeked
The total number of data values copied by all the buffer peek operations.
Count (generate counter)
189
rtbPeeks
The total number of peek operations. The peek operations are costly because they involve copying an entire buffer.
Count (generate counter)
186
rtbTotal
The total number of real-time buffers.
Count (generate counter)
- A_E_diagnostics
Code Name Description Unit 193
aedAllocs
The number of A&E structures allocated per second.
Count (generate counter)
194
aedDeallocs
The number of A&E structures de-allocated per second.
Count (generate counter)
192
aedTotal
The total number of currently allocated A&E structures.
Count (generate counter)
- VqtWriteDiagnostics
Code Name Description Unit 196
vqtdAllocs
The number of VQT Write structures allocated per second.
Count (generate counter)
197
vqtdDeallocs
The number of VQT Write structures de-allocated per second.
Count (generate counter)
195
vqtdTotal
The total number of currently allocated VQT Write structures.
Count (generate counter)
- Lua
Code Name Description Unit 200
ActiveScripts
The number of scripts that have executed during the time period
Count (generate counter)
201
ActiveScriptsDedicated
The number of scripts that have executed during the time period, running on dedicated thread
Count (generate counter)
205
LuaAcumulatedRuntime
Accumulated runtime for all Lua scripts running during timeperiod
ms (Milliseconds)
204
LuaAverageRuntime
Accumulated Runtime for all Lua scripts running during timeperiod / divided by number of scripts
ms (Milliseconds)
202
LuaTotalMemoryUsage
Memory allocated by all Lua scripts running on this component
MB (Megabyte)
203
LuaTotalMemoryUsagePerc
Share of memory allocated by Lua scripts running on this component in the component’s total memory usage
Percent (Percentage)
198
NumberOfScripts
The total number of objects with Lua scripts (excluding libraries)
Count (generate counter)
199
NumberOfScriptsDedicated
The total number of objects with Lua scripts (excluding libraries), running on dedicated threads
Count (generate counter)
Version history
- 1.80
Date Version Name Action Old value New value 01-12-2021
2.1373
Property.HMUsecases
Insert
17-09-2021
2.1348
Property.LogConsoleOutput
Insert
- 1.76.3
Date Version Name Action Old value New value 26-05-2021
2.1262
Property.Attachments
Insert
- 1.70
Date Version Name Action Old value New value 27-08-2020
2.1247
Attribute.CLASS_SECURITY_CONTROL
Update
True
False
27-08-2020
2.1246
Attribute.CLASS_HIERARCHICAL
Update
True
False
27-08-2020
2.1245
Attribute.CLASS_SECURITY_CONTROL
Update
False
True
27-08-2020
2.1244
Attribute.CLASS_HIERARCHICAL
Update
False
True
- 1.66
Date Version Name Action Old value New value 06-05-2020
2.1235
Attribute.CLASS_NODE_SINGLETON
Update
True
False
06-05-2020
2.1234
Attribute.CLASS_NODE_SINGLETON
Update
False
True
- 1.60
Date Version Name Action Old value New value 15-10-2019
2.1203
Property.StartupScript
Insert
- 1.58
Date Version Name Action Old value New value 24-09-2019
2.1130
Property.PkgInstaller
Insert
- 1.54
Date Version Name Action Old value New value 25-06-2019
2.1083
Property.SafMaxBufferedAuditTrailEntries
Insert
- 1.40
Date Version Name Action Old value New value 20-08-2018
2.1067
SortOrder
Update
2
3
- 1.38
Date Version Name Action Old value New value 17-08-2018
2.1066
SortOrder
Update
1
2
17-08-2018
2.1065
SortOrder
Update
7
1
04-08-2018
2.1062
Theme
Update
TH_DEFAULT
TH_SERVICES
- 1.22
Date Version Name Action Old value New value 26-04-2017
2.835
Property.ComponentUpdateVerification
Insert
- 1.14
Date Version Name Action Old value New value 23-11-2016
2.808
Property.SQLCatalog
Insert