This clause defines Facets for the UAFX Information Model illustrated in Figure 2, Figure 3, and Figure 4.
Figure 2 – Structure of AutomationComponent related Facets
Figure 3 – Structure of FunctionalEntity related Facets
Figure 4 – Structure of Asset related Facets
Table 16 describes the details of the UAFX AutomationComponent 2024 Facet.
This Facet includes the functionality common to all AutomationComponents. It supersedes the UAFX AutomationComponent Facet.
Table 16 – UAFX AutomationComponent 2024 Facet
Group |
Conformance Unit / Profile Title |
Optional |
UAFX Base |
UAFX FxRoot |
False |
UAFX AutomationComponent |
UAFX AutomationComponent Base |
False |
UAFX AutomationComponent |
UAFX AutomationComponent SupportsPersistence |
True |
UAFX AutomationComponent |
UAFX AutomationComponent MaxFunctionalEntities |
False |
UAFX AutomationComponent |
UAFX AutomationComponent MaxConnections |
False |
UAFX AutomationComponent |
UAFX AutomationComponent MinConnections |
False |
UAFX AutomationComponent |
UAFX AutomationComponent MaxConnectionsPerCall |
False |
UAFX AutomationComponent |
UAFX AutomationComponent ConformanceName |
False |
UAFX AutomationComponent |
UAFX AutomationComponent ConnectionEstablishment VerifyAsset |
False |
UAFX AutomationComponent |
UAFX AutomationComponent ConnectionEstablishment VerifyFunctionalEntity |
False |
UAFX AutomationComponent |
UAFX AutomationComponent ConnectionEstablishment CreateConnectionEndPoint |
False |
UAFX AutomationComponent |
UAFX AutomationComponent ConnectionEstablishment EstablishControl |
True |
UAFX AutomationComponent |
UAFX AutomationComponent ConnectionEstablishment SetConfigurationData |
True |
UAFX AutomationComponent |
UAFX AutomationComponent ConnectionEstablishment ReassignControl |
True |
UAFX AutomationComponent |
UAFX AutomationComponent ConnectionEstablishment ReserveCommunicationIds |
False |
UAFX AutomationComponent |
UAFX AutomationComponent ConnectionEstablishment SetCommunicationConfiguration |
False |
UAFX AutomationComponent |
UAFX AutomationComponent ConnectionEstablishment EnableCommunication |
False |
UAFX AutomationComponent |
UAFX AutomationComponent ConnectionEstablishment Bundled |
True |
UAFX AutomationComponent |
UAFX AutomationComponent Descriptor |
False |
UAFX AutomationComponent |
UAFX AutomationComponent AcDescriptor DescriptorFile |
True |
UAFX AutomationComponent |
UAFX AutomationComponent AcDescriptor DescriptorIdentifier |
True |
UAFX AutomationComponent |
UAFX AutomationComponent Auditing Connection Management |
True |
UAFX AutomationComponent |
UAFX AutomationComponent Auditing Connection Cleanup |
True |
Address Space Model |
Address Space NonVolatile and Constant |
True |
Table 17 describes the details of the UAFX AutomationComponent Communication Publisher Facet.
This Facet includes the functionality needed for a UAFX Publisher.
Table 17 – UAFX AutomationComponent Communication Publisher Facet
Group |
Conformance Unit / Profile Title |
Optional |
UAFX AutomationComponent |
UAFX AutomationComponent PublisherCapabilities Base |
False |
UAFX AutomationComponent |
UAFX AutomationComponent PubSub Connections |
False |
UAFX AutomationComponent |
UAFX AutomationComponent PublisherCapabilities Preconfigured Datasets |
True |
Table 18 describes the details of the UAFX AutomationComponent Communication Subscriber Facet.
This Facet includes the functionality needed for a UAFX Subscriber.
Table 18 – UAFX AutomationComponent Communication Subscriber Facet
Group |
Conformance Unit / Profile Title |
Optional |
UAFX AutomationComponent |
UAFX AutomationComponent SubscriberCapabilities Base |
False |
UAFX AutomationComponent |
UAFX AutomationComponent AutomationComponent PubSub Connections |
False |
UAFX AutomationComponent |
UAFX AutomationComponent SubscriberCapabilities Preconfigured Datasets |
True |
Table 19 describes the details of the UAFX AutomationComponent Diagnostic Counters Facet.
This Facet includes the functionality needed for tracking AutomationComponent Connection establishment activities.
Table 19 – UAFX AutomationComponent Diagnostic Counters Facet
Group |
Conformance Unit / Profile Title |
Optional |
UAFX AutomationComponent |
UAFX AutomationComponent Diagnostics FunctionalGroup |
False |
UAFX AutomationComponent |
UAFX AutomationComponent Diagnostics EstablishCallFailed |
False |
UAFX AutomationComponent |
UAFX AutomationComponent Diagnostics EstablishCalls |
True |
UAFX AutomationComponent |
UAFX AutomationComponent Diagnostics CloseCall |
True |
Table 20 describes the details of the UAFX AutomationComponent Logging Facet.
This Facet includes the functionality needed for logging AutomationComponent activities.
Table 20 – UAFX AutomationComponent Logging Facet
Group |
Conformance Unit / Profile Title |
Optional |
UAFX AutomationComponent |
UAFX AutomationComponent Log |
False |
UAFX AutomationComponent |
UAFX AutomationComponent Connection Management Logging |
False |
UAFX AutomationComponent |
UAFX AutomationComponent Connection Cleanup Logging |
False |
Table 21 describes the details of the UAFX IFunctionalEntity Facet.
This Facet includes the functionality common to all FunctionalEntities.
Table 21 – UAFX IFunctionalEntity Facet
Group |
Conformance Unit / Profile Title |
Optional |
UAFX FunctionalEntity |
UAFX IFunctionalEntity AuthorUri |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity AuthorAssignedIdentifier |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity AuthorAssignedVersion |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity ApplicationIdentifier |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity OperationalHealth |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity OperationalHealthAlarms |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity Verify |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity InputData |
True |
UAFX FunctionalEntity |
UAFX InputsFolder SubscriberCapabilities Base |
True |
UAFX FunctionalEntity |
UAFX InputsFolder Hierarchy |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity OutputData |
True |
UAFX FunctionalEntity |
UAFX OutputsFolder PublisherCapabilities Base |
True |
UAFX FunctionalEntity |
UAFX OutputsFolder Hierarchy |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity ConfigurationData |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity ConfigurationData Configuration |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity ConfigurationData Tuning |
True |
UAFX FunctionalEntity |
UAFX ConfigurationDataFolder VariableStorage |
True |
UAFX FunctionalEntity |
UAFX ConfigurationDataFolder Hierarchy |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity Status FunctionalGroup |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity Operational FunctionalGroup |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity Diagnostics FunctionalGroup |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity Capabilities Base |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity Capabilities FeedbackSignalRequired |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity PublisherCapabilities Base |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity SubscriberCapabilities Base |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity ConnectionEndpoints |
True |
UAFX FunctionalEntity |
UAFX ConnectionEndpointsFolder CommHealth |
True |
UAFX FunctionalEntity |
UAFX ConnectionEndpoint Base |
True |
UAFX FunctionalEntity |
UAFX ConnectionEndpoint PubSub |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity ControlGroups |
True |
UAFX FunctionalEntity |
UAFX ControlGroup Base |
True |
UAFX FunctionalEntity |
UAFX ControlGroup Nested |
True |
UAFX FunctionalEntity |
UAFX ControlGroup Methods |
True |
Table 22 describes the details of the UAFX IFunctionalEntity Run-Time Diagnostic Counters Facet.
This Facet includes the functionality needed for tracking FunctionalEntity Connection operation activities.
Table 22 – UAFX IFunctionalEntity Run-Time Diagnostic Counters Facet
Group |
Conformance Unit / Profile Title |
Optional |
UAFX FunctionalEntity |
UAFX IFunctionalEntity Diagnostics FunctionalGroup |
False |
UAFX FunctionalEntity |
UAFX IFunctionalEntity Diagnostics OperationalConnectionCount |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity Diagnostics ExistingConnectionCount |
False |
UAFX FunctionalEntity |
UAFX IFunctionalEntity Diagnostics ErrorConnectionCount |
False |
UAFX FunctionalEntity |
UAFX IFunctionalEntity Diagnostics FailedConnectionCount |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity Diagnostics CleanedUpConnectionCount |
True |
Table 23 describes the details of the UAFX IFunctionalEntity Establishment Diagnostic Counters Facet.
This Facet includes the functionality needed for tracking FunctionalEntity Connection establishment activities.
Table 23 – UAFX IFunctionalEntity Establishment Diagnostic Counters Facet
Group |
Conformance Unit / Profile Title |
Optional |
UAFX FunctionalEntity |
UAFX IFunctionalEntity Diagnostics FunctionalGroup |
False |
UAFX FunctionalEntity |
UAFX IFunctionalEntity Diagnostics ExistingConnectionCount |
False |
UAFX FunctionalEntity |
UAFX IFunctionalEntity Diagnostics TotalEstablishAttemptsCount |
False |
UAFX FunctionalEntity |
UAFX IFunctionalEntity Diagnostics FailedEstablishAttemptsCount |
False |
UAFX FunctionalEntity |
UAFX IFunctionalEntity Diagnostics FailedVerificationCount |
False |
Table 24 describes the details of the UAFX FunctionalEntity Facet.
This Facet includes the base functionality for a FunctionalEntity.
Table 24 – UAFX FunctionalEntity Facet
Group |
Conformance Unit / Profile Title |
Optional |
|
UAFX IFunctionalEntity Facet |
|
UAFX FunctionalEntity |
UAFX FunctionalEntity Base |
False |
UAFX FunctionalEntity |
UAFX FunctionalEntity Type |
True |
UAFX FunctionalEntity |
UAFX FunctionalEntity SubFunctionalEntity |
True |
Table 25 describes the details of the UAFX top-level FunctionalEntity Facet.
This Facet includes the functionality needed by a FunctionalEntity that is referenced directly by the AutomationComponentType FunctionalEntities Folder.
Table 25 – UAFX top-level FunctionalEntity Facet
Group |
Conformance Unit / Profile Title |
Optional |
|
UAFX FunctionalEntity Facet |
|
UAFX FunctionalEntity |
UAFX IFunctionalEntity AuthorUri |
False |
UAFX FunctionalEntity |
UAFX IFunctionalEntity AuthorAssignedIdentifier |
False |
UAFX FunctionalEntity |
UAFX IFunctionalEntity AuthorAssignedVersion |
False |
UAFX FunctionalEntity |
UAFX IFunctionalEntity ApplicationIdentifier |
False |
UAFX FunctionalEntity |
UAFX IFunctionalEntity Verify |
False |
UAFX FunctionalEntity |
UAFX IFunctionalEntity ProcessData |
False |
UAFX FunctionalEntity |
UAFX IFunctionalEntity ConnectionEndpoints |
False |
UAFX FunctionalEntity |
UAFX ConnectionEndpoint Base |
False |
UAFX FunctionalEntity |
UAFX ConnectionEndpoint ApplicationUri |
True |
UAFX FunctionalEntity |
UAFX IFunctionalEntity OperationalHealth |
False |
Table 26 describes the details of the UAFX ConnectionEndpoint Diagnostics Facet.
This Facet includes the functionality needed to track ConnectionEndpoint creation and modification times.
Table 26 – UAFX ConnectionEndpoint Diagnostics Facet
Group |
Conformance Unit / Profile Title |
Optional |
UAFX FunctionalEntity |
UAFX ConnectionEndpoint Diagnostics FunctionalGroup |
False |
UAFX FunctionalEntity |
UAFX ConnectionEndpoint Diagnostics CreationTime |
False |
UAFX FunctionalEntity |
UAFX ConnectionEndpoint Diagnostics ModificationTime |
False |
Table 27 describes the details of the UAFX IAssetRevision Facet.
This Facet includes the functionality common to all Objects implementing the IAssetRevision Interface.
Table 27 – UAFX IAssetRevision Facet
Group |
Conformance Unit / Profile Title |
Optional |
UAFX FxAsset |
UAFX IAssetRevision Version |
True |
UAFX FxAsset |
UAFX IAssetRevision Build |
True |
UAFX FxAsset |
UAFX IAssetRevision SubBuild |
True |
UAFX FxAsset |
UAFX IAssetRevision VerifyAsset Base |
True |
UAFX FxAsset |
UAFX IAssetRevision VerifyAsset AssetIdentity |
True |
UAFX FxAsset |
UAFX IAssetRevision VerifyAsset AssetIdentityAndCompatibility |
True |
Table 28 describes the details of the UAFX IAssetExtensions Facet.
This Facet includes the functionality common to all Objects implementing the IAssetExtensions Interface.
Table 28 – UAFX IAssetExtensions Facet
Group |
Conformance Unit / Profile Title |
Optional |
UAFX FxAsset |
UAFX IAssetExtensions Connectors |
True |
Table 29 describes the details of the UAFX IAssetExtensions Diagnostic Counters Facet.
This Facet includes the functionality needed for tracking Asset resource utilization.
Table 29 – UAFX IAssetExtensions Diagnostic Counters Facet
Group |
Conformance Unit / Profile Title |
Optional |
UAFX FunctionalEntity |
UAFX IAssetExtensions Diagnostics FunctionalGroup |
False |
UAFX FunctionalEntity |
UAFX IAssetExtensions Diagnostics PowerOnUpTime |
True |
UAFX FunctionalEntity |
UAFX IAssetExtensions Diagnostics CurrentCPUUtilization |
True |
UAFX FunctionalEntity |
UAFX IAssetExtensions Diagnostics MaxCPUUtilization |
True |
UAFX FunctionalEntity |
UAFX IAssetExtensions Diagnostics CurrentMemoryUtilization |
True |
UAFX FunctionalEntity |
UAFX IAssetExtensions Diagnostics MaxMemoryUtilization |
True |
Table 30 describes the details of the UAFX Asset Facet.
This Facet includes the functionality needed for an Asset that is referenced directly by the AutomationComponentType Assets Folder.
Group |
Conformance Unit / Profile Title |
Optional |
|
UAFX IAssetRevision Facet |
|
|
DI IVendorNameplate Server Facet |
|
|
DI ITagNameplate Server Facet |
|
|
DI IDeviceHealth Server Facet |
|
UAFX FxAsset |
UAFX Asset Base |
False |
UAFX FxAsset |
UAFX FxAsset Type |
True |
UAFX FxAsset |
UAFX SoftwareUpdate |
True |
UAFX FxAsset |
UAFX IAssetRevision Version |
False |
UAFX FxAsset |
UAFX IAssetRevision VerifyAsset Base |
False |
UAFX FxAsset |
UAFX IVendorNameplate SerialNumberOrProductInstanceUri |
False |
DI Base Model |
DI IVendorNameplate ManufacturerUri |
False |
DI Base Model |
DI IVendorNameplate ProductCode |
False |
DI Base Model |
DI ITagNameplate AssetId |
False |
DI Base Model |
DI DeviceHealth Variable |
False |
Table 31 describes the details of the UAFX Slot AssetConnector Facet.
This Facet is used to for modelling an AssetConnector with a physical slot where a module can be attached.
Table 31 – UAFX Slot AssetConnector Facet
Group |
Conformance Unit / Profile Title |
Optional |
UAFX FxAsset |
UAFX AssetConnector Slot Base |
False |
UAFX FxAsset |
UAFX AssetConnector Name |
True |
UAFX FxAsset |
UAFX AssetConnector Slot LogicalId |
True |
Table 32 describes the details of the UAFX Socket AssetConnector Facet.
This Facet is used for modelling an AssetConnector with a physical socket where a cable can be connected.
Table 32 – UAFX Socket AssetConnector Facet
Group |
Conformance Unit / Profile Title |
Optional |
UAFX FxAsset |
UAFX AssetConnector Socket Base |
False |
UAFX FxAsset |
UAFX AssetConnector Id |
True |
UAFX FxAsset |
UAFX AssetConnector Kind |
True |
Table 33 describes the details of the UAFX Clamp AssetConnector Facet.
This Facet is used for modelling an AssetConnector with a wire connection where the wire needs to be connected to some termination connection.
Table 33 – UAFX Clamp AssetConnector Facet
Group |
Conformance Unit / Profile Title |
Optional |
UAFX FxAsset |
UAFX AssetConnector Clamp Base |
False |
UAFX FxAsset |
UAFX AssetConnector Id |
True |
UAFX FxAsset |
UAFX AssetConnector Kind |
True |
Table 34 describes the details of the UAFX ClampBlock AssetConnector Facet.
This Facet is used to for modelling an AssetConnector with a wire connection block, where the block contains a number of termination points for twisted pair or single wire connections.
Table 34 – UAFX ClampBlock AssetConnector Facet
Group |
Conformance Unit / Profile Title |
Optional |
UAFX FxAsset |
UAFX AssetConnector ClampBlock Base |
False |
UAFX FxAsset |
UAFX AssetConnector Id |
True |
UAFX FxAsset |
UAFX AssetConnector Kind |
True |
UAFX FxAsset |
UAFX AssetConnector ClampBlock BlockSize |
True |
UAFX FxAsset |
UAFX AssetConnector ClampBlock Nested |
True |