VCC, VMD, Variables, and Node Batch File Definitions for AppTestA1 CSV
The following section shows an example batch file AppTestA1.csv that describes local and remote VCCs as well as properties, nodes, and transfer sets. AppTestA1.csv contains the tables that define the VCCs, VMDs, association control variables, and device points that allow for the following types of communication:
- An application’s OPC UA server to pass Block 1 and Block 2 data to a remote ICCP client.
- An application’s OPC UA server to pass Block 4 data to a remote ICCP client.
- A remote ICCP client to pass Block 5 controls to an application’s OPC UA server.
On this page:
#sharemode
The share mode is set to none, meaning that its content is not for use by other batch files. It is set at the beginning of the batch file.
#sharemode
none
#My_VCC
The #My_VCC table defines one or more local VCCs, along with their association configuration parameters.
#My_VCC, <local_dom>, <remote_vcc>,
<remote_dom>,<assoc_out>,<assoc_in>,<client>,<server>, <iccp_features>, <security_flags>,
<assoc_verify>,<codemap_file>
AppTextA1A, AppLocDom, AppTestA2A, AppRemDom, 0, 1, 0, 1, 110110000000, 0, 1,AbbCodeMapping.csv
| Prototype VCC or Property | Value | In the VccCreate template, defines or indicates |
|---|---|---|
|
#My_VCC |
AppTestA1A |
The common name of the local ICCP virtual device, also known as a VCC. |
|
<local_dom> |
AppLocDom |
The local domain name for server-side data. |
|
<remote_vcc> |
AppTestA2A |
The common name of the remote VCC. |
|
<remote_dom> |
AppRemDom |
The remote domain name for server-side data. |
|
<assoc_out> |
0 |
A Boolean value (0 or 1) that indicates whether the VCC can make an outbound association or not. 0 prevents this VCC from making an outbound association. |
|
<assoc_in> |
1 |
A Boolean value (0 or 1) that indicates whether the VCC can make an inbound association or not. 1 enables an inbound association. |
|
<client> |
0 |
A Boolean value (0 or 1) that indicates whether this VCC can serve the client role or not. 0 prevents this VCC from serving the client role. Note: A VCC can be configured to be both a client and a server. |
|
<server> |
1 |
A Boolean value (0 or 1) that indicates whether this VCC can serve the server role or not. 1 enables this VCC to play the server role. |
|
<iccp_features> |
110110000000 |
Locally supported features represented with 12 1s or 0s, or a combination of both. The features represent the blocks that are supported by the VCC. These features must be the same as the remote node’s features. |
|
<security_flag> |
0 |
A Boolean value (0 or 1) that indicates whether this VCC utilizes secure ICCP or not. 0 indicates that this VCC does not use secure ICCP. |
|
<assoc_verify> |
1 |
A Boolean value (0 or 1). If <assoc_verify> is set to 1, the VCC periodically requests the peer VCC to identify itself. If the request is not acknowledged by the time specified in the timeout parameters, then the ICCP server will abort the association. The ICCP server can then establish a new association. |
|
<codemap_file> |
AbbCodeMapping.csv |
Text name of alterative codemap file for mapping ICCP quality to/from OPC UA status. Overrides default and any OPC UA server or client setting for this VCC’s points. |
#remote_vcc
The #remote_vcc table defines a named list of up to six remote ICCP peer VCCs for incoming or outgoing associations. Note that the name is only a local identifier and not part of the exchanged ICCP association information.
#remote_vcc,<remote_vcc_1>,<remote_vcc_2>,<remote_vcc_3>,<remote_vcc_4>,<remote_vc c_5>,<remote_vcc_6>
AppTestA2A
| Prototype VCC or Property | Value | Defines or indicates the names of the remote VCCs associated with this instance of LEC Server |
|---|---|---|
|
#remote_vcc |
AppTestA2A |
The common name of the remote VCC. This remote VCC is configured to have an association with AppTestA1A. |
| <remote_vcc_1> | Not set by this batch file. |
The common name of another remote VCC. This remote VCC will also be configured to have an association AppTestA1A. |
| <remote_vcc_2> | Not set by this batch file. |
|
| <remote_vcc_3> | Not set by this batch file. |
|
| <remote_vcc_4> | Not set by this batch file. |
|
| <remote_vcc_5> | Not set by this batch file. |
|
| <remote_vcc_6> | Not set by this batch file. |
|
#CommonName
The #CommonName table defines the association parameters for each local and remote VCC defined in the #My_VCC and #remote_vcc tables. You can see these settings in the LDIB Editor.
#CommonName,IpAddress,TSEL,SSEL,PSEL,ApTitle,AeQualifier,Secure
AppTestA1A, ,01, 01,
01, 1 3 9999 111, 102, 0
AppTestA2A, ,2,2, 2,1 3 9999 111,102, 0
| Prototype VCC or Property | Row 1 | Row 2 | Defines or indicates addressing and other values in the LDIB |
|---|---|---|---|
|
#CommonName |
AppTestA1A | AppTestA2A |
The common names of two different VCCs |
|
IpAddress |
Not set by the batch file. | Not set by the batch file. |
The IP addresses of each of the named VCCs |
| TSEL | 01 | 02 |
Transport selector |
| SSEL | 01 | 02 |
Session selector |
| PSEL |
0001 |
0002 |
Presentation selector |
|
ApTitle |
1 3 9999 111 | 1 3 9999 111 |
The ISO object IDs of the 3 devices |
|
AeQualifier |
102 | 102 |
Application entity qualifier10 |
|
Secure |
0 |
0 |
Enables Secure ICCP if it is set to 1 |
#AssocInControl
The #AssocInControl table defines the association control variable and its configuration parameters.
In the #AssocInControl example, the following schematic shows the connection between the ICCP AssocInControl node and the OPC UA client node that has the specified Agent, Branch, and Namespace properties.
AppTestA1A/AssocInControl allows an external OPC UA server that is connected to the local OPC UA client to enable or disable an ICCP association. This connection is key to receiving
10 The original ISO model terminology talked about entities in each layer that communicated, using the services of the layer below. There were network entities, transport entities, session entities, presentation entities, and application entities. Application entity (Ae) refers to the top-level layer, known as the application layer. An application entity is the Open System Interconnection (OSI) portion of an Application Process (AP).
Block 5 controls from a remote ICCP point or sending Block 1 and Block 2 data to this remote point.
#AssocInControl, <agent>, <branch>, <NS_Suffix>, <stale_time>, 30000, <timeout_valid_bit>
AssocInCtrl, AgentS, LECSystem, SYSTEM, 30000,
|VALID_LOW|VALID_HIGH
| Prototype Node Name or Property | Value | In the VccAssocControl template or OpcUaAgent template |
|---|---|---|
| #AssocInControl | AssocInCtrl | Specifies the name of the node that controls inbound associations. |
| <agent> | AgentS | Specifies the agent label. There is no Agent label property for AssocInCtrl, but AssocInCtrl connects to a node AppTestA1A/AssocInCtrl in the OPC UA server that requires an Agent label. |
| <branch> | LECSystem | The OPC UA branch where OPC UA server points are located. There is no Branch property for AssocInCtrl, but AssocInCtrl connects to a node AppTestA1A/AssocInCtrl in the OPC UA server that require an Agent branch. Leaving blank indicates no branch. |
| <NS_Suffix> | SYSTEM | Specifies the OPC UA namespace suffix for AppTestA1A/AssocInCtrl. Leaving blank indicates no NS suffix. |
| <stale_time> | 30000 | Specifies the period of time in milliseconds that is allowed to elapse while there is no association. After the period of time has elapsed, the association will time out, and input points from this association are assigned a quality code based on the configured timeout validity bit settings: VALID_LOW and VALID_HIGH. |
|
<timeout_valid_bit> |
|VALID_LOW|VALID_HIGH |
When the VCC is set to the Alarm state, specifies whether the VALID_LOW or the VALID_HIGH flag is set or if both are set. |
#OutboundPeerName and #InboundPeerName
The #OutboundPeerName and #InboundPeerName table defines the OPC UA server point that provides the text name of the connected outbound or inbound peer VCC.
| Prototype Node Name or Property | Value | In the VccAssocControl template or OpcUaAgent template |
|---|---|---|
| #OutboundPeerName/Inbou ndPeerName | OutboundPeer/InboundPeer | Specifies the name of the node that reports name of outbound/inbound peer |
| <agent> | AgentS | Specifies the agent label. There is no Agent label property for AssocInCtrl, but AssocInCtrl connects to a node AppTestA1A/AssocInCtrl in the OPC UA server that requires an Agent label. |
| <branch> | LECSystem | The OPC UA branch where OPC UA server points are located. There is no Branch property for AssocInCtrl, but AssocInCtrl connects to a node AppTestA1A/AssocInCtrl in the OPC UA server that require an Agent branch. Leaving blank indicates no branch. |
#Blk1ToIccp
The #Blk1ToIccp table defines the local ICCP server points that receive telemetry and status data from an external OPC UA. This data is transferred to a peer ICCP client.
| Prototype Node Name or Property | Rows 1 through 6 | Defines or indicates |
|---|---|---|
| #Blk1ToIccp |
MEAS_ 1A_00000 MEAS_TEST_1A_FI1 MEAS_TEST_1A_FI2 STATUS_TEST_1A_00 000 STATUS_TEST_1A_FI 1 STATUS_TEST_1A_FI 2 |
Specifies local ICCP node names that receive data from the external OPC UA server. The nodes beginning with MEAS receive telemetry data, and the nodes beginning with STATUS receive status data. |
| <NS_Suffix> | Reals Reals Reals Statuses Statuses Statuses | Specifies the OPC UA namespace suffix for the external OPC UA server nodes where the telemetry and status data originate. Leaving blank indicates no NS suffix. |
| <branch> | Not set. | Specifies the OPC UA branch on the external OPC UA server where the telemetry and status data is located. Leaving blank indicates no branch. |
| <type> | E Data_RealQTimeTagE xtended Data_RealQ Data_RealQ Data_StateQTimeTagE xtended Data_StateQ Data_StateQ | ICCP data type of the data in the ICCP nodes: MEAS_TEST_1A_00000 MEAS_TEST_1A_Fl1 MEAS_TEST_1A_Fl2 STATUS_TEST_1A_00000 STATUS_TEST_1A_FI1 STATUS_TEST_1A_FI2 |
| <agent> | AgentC | Label that specifies the client OPC UA agent node that handles the connection to the application’s OPC UA server. |
| <branch> | RTISystem | The OPC UA server branch where the variable is located. Leaving blank indicates no branch. |
|
NS_Suffix> |
|
The OPC UA server namespace suffix for this variable. Leaving blank indicates no namespace suffix. |
|
<opc_label> |
|
Alternative OPC UA server variable name for this point. |
#Blk5FromIccp
The #Blk5FromIccp table defines local ICCP Block 5 setpoint nodes that originate on a remote ICCP client; the LEC Server instance writes these setpoint values to nodes on an external OPC UA server.
| Prototype Node Name or Property | Rows 1 through 12 | Defines or indicates |
|---|---|---|
| #Blk5FromIccp | CONTROL_TEST_1A_00000 CONTROL_TEST_1A_00001 CONTROL_TEST_1A_00002 CONTROL_TEST_1A_00003 CONTROL_TEST_1A_ FO1 CONTROL_TEST_1A_ FO2 SETPOINT_TEST_1A_00000 SETPOINT_TEST_1A_00001 SETPOINT_TEST_1A_00002 SETPOINT_TEST_1A_00003 SETPOINT_TEST_1A_ FO1 SETPOINT_TEST_1A_ FO2 | Defines names of the local ICCP nodes that transmit control data from the ICCP peer through a two-way connector |
| <NS_Suffix> |
Discretes Discretes Discretes Discretes Discretes Discretes Reals Reals Reals Reals Reals Reals |
Specifies the OPC UA namespace suffix for the external OPC UA server points that receive the ICCP controls. Leaving blank indicates no NS suffix. |
| <branch> | ASYS | The OPC UA branch where these OPC UA server points are located. Leaving blank indicates no branch. In this example, all of the receiving server points are located in the ASYS branch. |
| <tagging_branch> | Not set. | OPC UA tagging point branch name; the default is the OPC UA control point branch name. |
| <type> | <int:16> <int:16> <int:16> <int:16> <int:16> <int:16> <f-p:32:8> <f- p:32:8> <f-p:32:8> <f-p:32:8> <f- p:32:8> <f-p:32:8> | Specifies the data type of the external, receiving OPC UA server nodes. All of the first set of points are <int:16>. All of the next set of points are <f- p:32:8>. |
| <flags> | DISCRETE DISCRETE|SBO DISCRETE|TAGABLE DISCRETE|TAGABLE|SBO DISCRETE|SBO DISCRETE|SBO REAL REAL|SBO REAL|TAGABLE REAL|TAGABLE|SBO REAL REAL | Specifies the flag or flags of the receiving ICCP control points within LEC Server: REAL – The control point is a floating-point number DISCRETE – The control point is an integer SBO – The control point supports Select Before Operate TAGABLE – The control point supports tagging |
| <tagging_point> | Not set. | OPC UA control tagging point name; the default is the OPC UA control point name with _TAG appended. |
| <agent> | AgentC | Label of the local OPC UA client agent node to handle the connection with the external OPC UA server. |
| <ChkBkId> | 681 681 681 681 681 681 9 9 9 9 9 9 | Expected Check back ID. The expected Check back ID for the first set of control points is 681. The expected Check back ID for the second set of control points is 9. |
|
<dom_scope> |
0 |
Indicates the scope of the variables in the remote VCC. The scope in that VCC is VMD-specific as indicated by <dom_scope> of 0 for all points. A <dom_scope> of 1 would indicate Domain-specific scope, which refers to the domain specified by <remote_dom> in the #My_VCC table. |
|
<opc_label> |
"DevCtrl_1A_00000" "DevCtrl_1A_00001" "DevCtrl_1A_00002" "DevCtrl_1A_00003" "DevCtrl_1A_ FO1" "DevCtrl_1A_ FO1" "DevSet_1A_00000" "DevSet_1A_00001" "DevSet_1A_00002" "DevSet_1A_00003" "DevSet_1A_ FO1" "DevSet_1A_ FO1" |
OPC UA control point labels. This variable name overrides the default name. The default name is the same as the node label. |
#ConfirmedBlk4ToIccp
The #ConfirmedBlk4ToIccp table defines local ICCP Block 4 messaging points to hold data that originate from an external OPC UA client; the local ICCP server sends each message to the remote ICCP client points. The underlying ConfirmedMessageToIccp node receives the message from the local OPC UA server node, which is a ConfirmedMessageFromOpcUa node, through a two-way connector. The ConfirmedMessageToIccp node returns a confirmation to the originating OPC UA client through the ConfirmedMessageFromOpcUa node. This confirmation indicates only that the message got to a local ICCP server and is likely to get to the remote ICCP point, but the remote ICCP client sends no confirmation indicating whether or not it received the message.
| Prototype Node Name or Property | Rows 1 to 3 | Defines |
|---|---|---|
| #Blk4ToIccp | MSG_TEST_1A_1_2 MSG_TEST_1A_X_4 MSG_TEST_1A_5_X MSG_TEST_1A_X_X | The local ICCP server point names for nodes that receive Block 4 message data for specific InfoRef/LocalRef pairs from an OPC UA server. |
| <NS_Suffix> | Messages | Specifies the OPC UA namespace suffix for these points. Leaving blank indicates no NS suffix. |
| <branch> | Not set. | The OPC UA branch where this point is located. Leaving blank indicates no branch. |
| <InfoRef> | 1 Not set. 5 Not set. | ICCP InfoReference number for this message. The default is to accept any number. MSG_TEST_1A_1_2 sets the number to 1 MSG_TEST_1A_X_4 does not set this number. MSG_TEST_1A_5_X sets the number to 5. MSG_TEST_1A_X_X does not set this number. The InfoReference number in combination with the LocalReference number are used to identify the context of a message, and internal to Oracle Utilities LEC Server to route messages to and from LEC variables. |
| <LocalRef> | 2 4 Not set. Not set. | ICCP LocalReference number for this message. The default is to accept any number. MSG_TEST_1A_1_2 sets the number to 2 MSG_TEST_1A_X_4 sets the number to 4. MSG_TEST_1A_5_X does not set this number. MSG_TEST_1A_X_X does not set this number. |
| <agent> | AgentS | Label of the OPC UA server agent node to handle the connection to the external OPC UA client. |
| <dom_scope> | 0 | Indicates the scope of the variables in the local VCC. The scope in this VCC is VMD-specific as denoted by <dom_scope> of 0. A <dom_scope> of 1 would indicate Domain-specific scope, which refers to the domain specified by <local_dom> in the #My_VCC table. |
| <opc_label> |
DevMess_1A_1_2 DevMess_1A_X_4 DevMess_1A_5_X DevMess_1A_X_X
|
Specifies the OPC UA variable name. These OPC UA variables are in the external OPC UA client where the Block 4 messages originate. They also identify where the confirmed messages are sent from the local ICCP client. These variable names override the default names. The default name is the same as the node label. |