This Structure DataType holds the information for a ConnectionEndpoint configuration, including its parameters.
It is semantically equivalent to the ConnectionEndpointConfigurationType as defined in 6.11.2 and the ConnectionEndpointParameterType as defined in 6.12.2.
The ConnectionEndpointConfigurationConfDataType is formally defined in Table F.5.
Table F.5 – ConnectionEndpointConfigurationConfDataType structure
|
Name |
Type |
Description |
Optional |
|
ConnectionEndpointConfigurationConfDataType |
Structure |
Subtype of Structure defined in OPC 10000-5 |
|
|
FunctionalEntityNode |
4:NodeIdentifier |
FunctionalEntityNode specifies the identifier of the FunctionalEntity to configure for the Connection. If a RelativePath is specified, the path shall be relative to FxRoot. |
False |
|
FunctionalEntityNodeSelection |
4:NodeIdentifier[] |
Selection list options for FunctionalEntityNode. |
True |
|
FunctionalEntityNodeModify |
0:Boolean |
Flag indicating if the FunctionalEntityNode options can be modified. |
True |
|
Name |
0:String |
BrowseName of the ConnectionEndpoint to create in the AutomationComponent. |
False |
|
NameSelection |
0:String[] |
Selection list options for the endpoint name. |
True |
|
NameModify |
0:Boolean |
Flag indicating if the Name options can be modified. |
True |
|
ConnectionEndpointTypeId |
0:NodeId |
ConnectionEndpointTypeId specifies the well-known NodeId of the type definition, which shall be used to create the ConnectionEndpoint. This can be any of the subtypes of the ConnectionEndpointType (for example, PubSubConnectionEndpointType). |
False |
|
InputVariableIds |
4:NodeIdentifier[] |
InputVariableIds specifies a list of node identifiers to be used as inputs. If InputVariableIds is present, it shall contain at least one element. If the array is null or empty, the optional InputVariableIds node is not available. If a RelativePath is specified, the path shall be relative to the FunctionalEntityNode specified in the ConnectionEndpointConfigurations. |
True |
|
OutputVariableIds |
4:NodeIdentifier[] |
OutVariableIds specifies a list of node identifiers to be used as outputs. If OutputVariableIds is present, it shall contain at least one element. If the array is null or empty, the optional OutputVariableIds node is not available. If a RelativePath is specified, the path shall be relative to the FunctionalEntityNode specified in the ConnectionEndpointConfigurations. |
True |
|
IsPersistent |
0:Boolean |
IsPersistent, if TRUE, specifies the created ConnectionEndpoint shall be persistent. |
False |
|
CleanupTimeout |
0:Duration |
CleanupTimeout specifies the value to be used for the clean-up timeout. A negative number indicates an infinite timeout. A zero indicates an immediate clean-up. |
False |
|
IsPreconfigured |
0:Boolean |
IsPreconfigured, if TRUE, specifies the ConnectionEndpoint is preconfigured. |
False |
|
CommunicationLinks |
0:Structure |
CommunicationLinks specifies the configuration data related to this ConnectionEndpoint within the CommunicationModelConfiguration. If this field is set, it shall contain a subtype of 2:Communication LinkConfigurationDataType. |
True |
|
PreconfiguredPublishedDataSet |
0:String |
If it is not an empty string, it specifies the name of a preconfigured PublishedDataSet to be used for connecting the OutputVariables. |
True |
|
PublishedDataSetData |
0:PublishedDataSetDataType |
If not null, specifies a PublishedDataSet to be used for connecting the OutputVariables. |
True |
|
PreconfiguredSubscribedDataSet |
0:String |
If it is not an empty string, it specifies the name of a preconfigured StandaloneSubscribedDataSet to be used for connecting the InputVariables. |
True |
|
SubscribedDataSetData |
0:StandaloneSubscribedDataSetDataType |
If not null, specifies a SubscribedDataSet to be used for connecting the InputVariables. |
True |
|
ExpectedVerificationVariables |
NodeIdentifierValuePair[] |
Specifies the Variables and values to be verified. If a RelativePath is specified as Key, the path shall be relative to FunctionalEntityNode. If the array is null or empty or the field is not present, no Variables are verified. |
True |
|
ControlGroups |
NodeIdentifier[] |
Specifies the ControlGroups to be controlled. If a RelativePath is specified as Key, the path shall be relative to FunctionalEntityNode. If the array is null or empty or the field is not present, no ControlGroups are controlled. |
True |
|
ConfigurationData |
NodeIdentifierValuePair[] |
Specifies the parameters to apply for the configuration of the FunctionalEntityNode. If a RelativePath is specified as Key, the path shall be relative to FunctionalEntityNode. If the array is null or empty or the field is not present, no parameters are set. |
True |
|
EndpointProperties |
0:KeyValuePair[] |
The KeyValuePair array provides additional configuration properties for the endpoint. |
True |
|
AutomationComponentIndex |
0:Int32 |
Reference to the related AutomationComponent in the AutomationComponentConfigurations array of the connection set structure. |
False |
|
OutboundFlowIndex |
0:Int32 |
Reference to the related communication flow in the CommunicationFlows array of the connection set structure. Any negative number indicates that no outbound is configured. |
True |
|
InboundFlowIndex |
0:Int32 [2] |
Reference to the related communication flow in the CommunicationFlows array (Publisher configuration) of the connection set structure (first index in the array) and to the contained SubscriberConfiguration (second in index in the array). |
True |
The ConnectionEndpointConfigurationConfDataType representation in the AddressSpace is formally defined in Table F.6.
Table F.6 – ConnectionEndpointConfigurationConfDataType definition
|
Attribute |
Value |
|||||
|
BrowseName |
4:ConnectionEndpointConfigurationConfDataType |
|||||
|
IsAbstract |
False |
|||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
|
Subtype of the 0:Structure defined in OPC 10000-5 |
||||||
|
ConformanceUnits |
||||||
|
UAFX ConnectionManager Configuration |
||||||