UAFX Part 84: Profiles - 6.6.2 UAFX Information Model Facets

6.6.2 UAFX Information Model Facets

6.6.2.1 Overview

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

6.6.2.2 UAFX AutomationComponent Facet

Table 16 describes the details of the UAFX AutomationComponent Facet.

This Facet includes the functionality common to all AutomationComponents.

Table 16 – UAFX AutomationComponent 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 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 AcDescriptor DescriptorFile	True
UAFX AutomationComponent	UAFX AcDescriptor DescriptorIdentifier	True
UAFX AutomationComponent	UAFX Auditing Connection Management	True
UAFX AutomationComponent	UAFX Auditing Connection Cleanup	True
Address Space Model	Address Space NonVolatile and Constant	True

6.6.2.3 UAFX AutomationComponent Communication Publisher Facet

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 PublisherCapabilities	False
UAFX AutomationComponent	UAFX AutomationComponent PubSub Connections	False
UAFX AutomationComponent	UAFX PublisherCapabilities Preconfigured Datasets	True

6.6.2.4 UAFX AutomationComponent Communication Subscriber Facet

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 SubscriberCapabilities	False
UAFX AutomationComponent	UAFX AutomationComponent PubSub Connections	False
UAFX AutomationComponent	UAFX SubscriberCapabilities Preconfigured Datasets	True

6.6.2.5 UAFX IFunctionalEntity Facet

Table 19 describes the details of the UAFX IFunctionalEntity Facet.

This Facet incudes the functionality common to all FunctionalEntities.

Table 19 – 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	True
UAFX FunctionalEntity	UAFX InputsFolder Hierarchy	True
UAFX FunctionalEntity	UAFX IFunctionalEntity OutputData	True
UAFX FunctionalEntity	UAFX OutputsFolder PublisherCapabilities	True
UAFX FunctionalEntity	UAFX OutputsFolder Hierarchy	True
UAFX FunctionalEntity	UAFX IFunctionalEntity ConfigurationData	True
UAFX FunctionalEntity	UAFX ConfigurationDataFolder VariableStorage	True
UAFX FunctionalEntity	UAFX ConfigurationDataFolder Hierarchy	True
UAFX FunctionalEntity	UAFX IFunctionalEntity Capabilities	True
UAFX FunctionalEntity	UAFX IFunctionalEntity Capabilities FeedbackSignalRequired	True
UAFX FunctionalEntity	UAFX IFunctionalEntity PublisherCapabilities	True
UAFX FunctionalEntity	UAFX IFunctionalEntity SubscriberCapabilities	True
UAFX FunctionalEntity	UAFX IFunctionalEntity ConnectionEndpoints	True
UAFX FunctionalEntity	UAFX ConnectionEndpointsFolder CommHealth	True
UAFX FunctionalEntity	UAFX ConnectionEndpoint Base	True
UAFX FunctionalEntity	UAFX ConnectionEndpoint InputVariables	True
UAFX FunctionalEntity	UAFX ConnectionEndpoint OutputVariables	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

6.6.2.6 UAFX FunctionalEntity Facet

Table 20 describes the details of the UAFX FunctionalEntity Facet.

This Facet includes the base functionality for a FunctionalEntity.

Table 20 – 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

6.6.2.7 UAFX top-level FunctionalEntity Facet

Table 21 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 21 – 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 IFunctionalEntity OperationalHealth	False

6.6.2.8 UAFX IAssetRevision Facet

Table 22 describes the details of the UAFX IAssetRevision Facet.

This Facet includes the functionality common to all Objects implementing the IAssetRevision Interface.

Table 22 – 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

6.6.2.9 UAFX IAssetExtensions Facet

Table 23 describes the details of the UAFX IAssetExtensions Facet.

This Facet includes the functionality common to all Objects implementing the IAssetExtensions Interface.

Table 23 – UAFX IAssetExtensions Facet

Group	Conformance Unit / Profile Title	Optional
UAFX FxAsset	UAFX IAssetExtensions Connectors	True

6.6.2.10 DI IVendorNameplate Facet

Table 24 describes the details of the DI IVendorNameplate Facet.

This Facet includes the functionality common to all Objects implementing the IVendorNameplate Interface.

Table 24 – DI IVendorNameplate Facet

Group	Conformance Unit / Profile Title	Optional
DI	DI IVendorNameplate ManufacturerUri	True
DI	DI IVendorNameplate ProductCode	True
DI	DI IVendorNameplate HardwareRevision	True
DI	DI IVendorNameplate SoftwareRevision	True
DI	DI IVendorNameplate ProductInstanceUri	True
DI	DI IVendorNameplate Manufacturer	True
DI	DI IVendorNameplate Model	True
DI	DI IVendorNameplate DeviceRevision	True
DI	DI IVendorNameplate DeviceManual	True
DI	DI IVendorNameplate DeviceClass	True
DI	DI IVendorNameplate SerialNumber	True
DI	DI IVendorNameplate RevisionCounter	True

6.6.2.11 DI ITagNameplate Facet

Table 25 describes the details of the DI ITagNameplate Facet.

This Facet includes the functionality common to all Objects implementing the ITagNameplate Interface.

Table 25 – DI ITagNameplate Facet

Group	Conformance Unit / Profile Title	Optional
DI	DI ITagNameplate AssetId	True
DI	DI ITagNameplate ComponentName	True

6.6.2.12 DI IDeviceHealth Facet

Table 26 describes the details of the DI IDeviceHealth Facet.

This Facet includes the functionality common to all Objects implementing the IDeviceHealth Interface.

Table 26 – DI IDeviceHealth Facet

Group	Conformance Unit / Profile Title	Optional
DI Base Model	DI DeviceHealth	False
DI Base Model	DI DeviceHealthProperty	True
DI Base Model	DI HealthDiagnosticsAlarm	True

6.6.2.13 UAFX Asset Facet

Table 27 describes the details of the UAFX Asset Facet.

This Facet includes the functionaltity needed for an Asset that is referenced directly by the AutomationComponentType Assets Folder.

Table 27 – UAFX Asset Facet

Group	Conformance Unit / Profile Title	Optional
	UAFX IAssetRevision Facet
	DI IVendorNameplate Facet
	DI ITagNameplate Facet
	DI IDeviceHealth 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
UAFX FxAsset	UAFX IDeviceHealth DeviceHealthDiagnosticsAlarm	True
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 DeviceHealthProperty	False

6.6.2.14 UAFX Slot AssetConnector Facet

Table 28 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 28 – 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

6.6.2.15 UAFX Socket AssetConnector Facet

Table 29 describe the details of the UAFX Socket AssetConnector Facet.

This Facet is used to for modelling an AssetConnector with a physical socket where a cable can be connected.

Table 29 – 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

6.6.2.16 UAFX Clamp AssetConnector Facet

Table 30 describe the details of the UAFX Clamp AssetConnector Facet.

This Facet is used to for modelling an AssetConnector with a wire connection where the wire needs to be connected to some termination connection.

Table 30 – 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

6.6.2.17 UAFX ClampBlock AssetConnector Facet

Table 31 describe 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 31 – 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