VCC, VMD, Variables, and Node Batch File Definitions for AppTestA2 CSV

The following section shows an example batch file AppTestA2.csv that describes local and remote VCCs as well as properties, nodes, and transfer sets. AppTestA2.csv contains the tables that define the VCCs, VMDs, association control variables, and device points that allow for the following types of communication:

Remote ICCP server to pass Block 1 and Block 2 data to an application’s OPC UA client.
Remote ICCP server to pass Block 4 data to an application’s OPC UA client.
Application’s OPC UA client to pass Block 5 controls to a remote 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.

#ts_num

The #ts_num table defines one or more ICCP transfer sets and their configuration parameters.

Property	Value	In DsTransferSet template
#ts_num	1	Assigns a transfer set number that is unique to this VCC.
<do_interval>	1	A Boolean value (0 or 1) that indicates whether or not interval- based transmissions are enabled. 1 enables interval-based transmissions.
<interval_period>	10	Specifies the interval in seconds between transmissions if interval- based transmissions are enabled.
<do_integrity>	1	A Boolean value (0 or 1) that indicates whether or not integrity- based transmissions are enabled. 1 enables integrity-based transmissions
<integrity_period>	60	Specifies the integrity period in seconds between transmissions if integrity-based transmissions are enabled.
<do_change>	1	A Boolean value (0 or 1) that indicates whether or not change- based transmissions are enabled. If <do_change> is set to 1, a change in any point in the transfer set will trigger the sending of a report. In this example, <do_change> is set to 1. See the description of <do_rbe> for more information.
<buffer_time>	2	Indicates the buffer time in seconds. A non-zero buffer time with change-based transmissions enabled (<do_change> is set to 1) causes a delay of the specified number of seconds after the first change before sending a report. This delay allows subsequent changes to be included in the same report. In this example, <buffer_time> is set to 2 seconds.
<do_rbe>	1	A Boolean value (0 or 1) that indicates whether report by exception is enabled. When a report is sent because an object changed <do_change> or because a specified time period <do_interval> elapsed: Only points that changed since the last report are sent if <do_rbe> is set to 1. The whole transfer set is sent if <do_rbe> is set to 0. In this example, <do_rbe> is set to 1.
<do_initial_read>	1	A Boolean value (0 or 1) that indicates whether an initial read of data values is required. 1 directs LEC Server to perform an initial read.
<critical>	0	If <critical> is set to 1, acknowledgement is required. If not set to 1, no acknowledgement is required.
<branch>		OPC UA server branch for this transfer set’s control and status variables. Leaving blank indicates no branch.
<NS_Suffix>		OPC UA server namespace suffix for this transfer set’s control and status variables. Leaving blank indicates no namespace suffix.
<agent>	AgentS	Name of the OPC UA server agent where this transfer set’s control and status variables are available

#Blk_buflen

The #Blk4_buflen table defines a set of local ICCP Block 4 data buffers of various sizes that are created to hold Block 4 data received from the remote ICCP server. The data flow diagram shown in #Blk4MessageRouter in the next section outlines the path the buffer data takes from the remote ICCP server to the OEM’s OPC UA client.

Prototype Node Name or Property	Rows 1 through 5	Defines
#Blk4_buflen	Info_Buff_16 Info_Buff_64 Info_Buff_256 Info_Buff_1024 Info_Buff_4096	The node name
<BufLen>	16 64 256 1024 4096	The buffer length in bytes.
<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.

Prototype Node Name or Property

Rows 1 through 5

Defines

#Blk4_buflen

Info_Buff_16 Info_Buff_64 Info_Buff_256 Info_Buff_1024 Info_Buff_4096

The node name

256

1024

4096

The buffer length in bytes.

<dom_scope>

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.

#Blk4MessageRouter

The #Blk4MessageRouter table defines the fields in the messageRouterToOpcUa template that are used in the OPC UA server. The messageRouterToOpcUa mechanism provides ICCP Block 4 message routing based on the InfoRef/LocalRef pairs so that a message from ICCP will be associated with the local OPC UA variable that the remote OPC UA client has subscribed to.

The data point in Blk4FromIccpRouter originates from a remote ICCP server and follows the path that is described below.

Image of Blk4MessageRouter path

Note: The messageRouterToOpcUa template takes merged ICCP message buffers from the local ICCP client and associates each buffer with the corresponding OPC UA variable in the local OPC UA server. If the OEM’s OPC UA client subscribes to these variables, it can receive updates through an update connector.

! Message router to route block 4 messages from external ICCP server to specific OPC UA points subscribed to by external UPC UA client via LEC IFE.

Prototype Node Name or Property	Rows 1 through 5	Defines
#Blk4MessageRouter	Blk4FromIccpRouter	The node name
<agent>	AgentS	Specifies whether the OPC UA VMD is a client or a server. In this case, the VMD is an OPC UA server.

#Blk4FromIccp

The #Blk4FromIccp table defines local ICCP Block 4 messaging nodes in the local OPC UA server that hold Block 4 messages originating from a remote ICCP server; the LEC Server configuration makes this data available to an external OPC UA client that has subscribed to these points by specifying InfoRef-LocalRef pairs.

Image of Blk4FromIccp path

Prototype Node Name or Property	Rows 1 through 5	Defines
#Blk4MessageRouter	Blk4FromIccpRouter	The node name
<agent>	AgentS	Specifies whether the OPC UA VMD is a client or a server. In this case, the VMD is an OPC UA server.

<InfoRef>	1blank 5 blank	ICCP InfoReference number for this message. MSG_TEST_00A_1_2 sets the number to 1 MSG_TEST_00A_X_4 does not set the InfoReference number. MSG_TEST_00A_5_X sets the number to 5. MSG_TEST_00A_X_X does not set the InfoReference number. This number is a 32-bit signed integer.
<LocalRef>	2 4 blank blank	ICCP LocalReference number for this message. The default is to accept any number. MSG_TEST_00A_1_2 sets the number to 2 MSG_TEST_00A_X_4 sets the number to 4. MSG_TEST_00A_5_X does not set the LocalReference number. MSG_TEST_00A_X_X does not set the LocalReference number. This number is a 32-bit signed integer.
<agent>	AgentS	Label of the OPC UA server agent node that is to handle the connection to the external OPC UA client.
<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. 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>	DevMESS_00A_1_2 DevMESS_00A_X_4 DevMESS_00A_5_X DevMESS_00A_X_X	Specifies the OPC UA variable name in the external OPC UA client. The default name is the same as the node label.

#Blk1FromIccp

The #Blk1FromIccp table defines local ICCP Block 1 points. The data points in these nodes originate from a remote ICCP server and are transferred to an external OPC UA client through the OPC UA mechanism of subscription.

Image of Blk1FromIccp path

Prototype Node Name or Property	Rows 1 through 2	Defines or indicates
#Blk1FromIccp	MEAS_TEST_1A_00000 MEAS_TEST_1A_Fl1 MEAS_TEST_1A_Fl2 STATUS_TEST_1A_00000 STATUS_TEST_1A_Fl1 STATUS_TEST_1A_Fl2	Specifies local ICCP node names which will contain data that the configuration transmits to the local OPC UA server. The nodes beginning with MEAS will contain telemetry data, and the nodes beginning with STATUS will contain status data.
<NS_Suffix>	Reals Reals Reals Statuses Statuses Statuses	Specifies the OPC UA namespace suffix for the OPC UA server nodes that receive this data from LEC’s ICCP client nodes. Leaving blank indicates no NS suffix.
<branch>	Not set.	The OPC UA branch where these receiving points are located. Leaving it blank indicates no branch.
<type>	Data_RealQTimeTagExtend ed Data_RealQ Data_RealQ Data_StateQTimeTagExten ded Data_StateQ Data_StateQ	LEC data type of the data in the local ICCP client nodes MEAS_TEST_1A_00000, MEAS_TEST_1A_Fl1, MEAS_TEST_1A_Fl2, STATUS_TEST_1A_00000, STATUS_TEST_1A_Fl1, and STATUS_TEST_1A_Fl2.
<agent>	AgentS	Specifies a label for the local OPC UA server agent node that handles the connection to the external OPC UA client.
<dom_scope>	0	Indicates the scope of the variables in the remote VCC. The scope is VMD-specific as indicated by <dom_scope> of 0. A <dom_scope> of 1 would indicate Domain- specific scope, which refers to the domain specified by <remote_dom> in the #My_VCC table.
<ts_num>	1	Specifies the transfer set number that is unique to this VCC.
<opc_label>	"DevMeas_1A_00000" "DevMeas_1A_Fl1" "DevMeas_1A_Fl2" "DevStatus_1A_00000" "DevStatus_1A_Fl1" "DevStatus_1A_Fl2"	Specifies the OPC UA data point names. The default OPC UA point name is the node label. These points reside on the local OPC UA server. The nodes beginning with DevMeas will receive telemetry data, and the nodes beginning with DevStatus will receive status data.
<filter>		Name, either STATE or SCALE, of the filter to use for this point. Leaving blank indicates no filter.
<slope>		If SCALE filter is used, the slope (multiplier) to apply to this point. Leaving blank indicates no slope.
<offset>		If SCALE filter is used, the offset (summand) to add to this point. Leaving blank indicates no offset.
<s0>		When STATE filter is used, value to replace this point’s value with when actual value is 0. Leaving blank indicates no replacement.
<s1>		Same as above but for actual value 1.
<s2>		Same as above but for actual value 2.
<s3>		Same as above but for actual value 3.

#Blk5ToIccp

The #Blk5ToIccp table defines local ICCP Block 5 setpoint nodes. The data points that are written to these nodes originate from an external OPC UA client; the LEC Server instance transfers the values in these setpoint nodes to nodes on a peer ICCP server using the ICCP Write mechanism. #Blk5ToIccp is based on a ControlFromOpcUa template within the local OPC UA server.

Image of Blk5ToIccp path

#Blk5FToIccp, <NS_Suffix>, <branch>, <tagging_branch>, <type>, <flags>, <tagging_point>, <agent>, <ChkBkId>, <dom_scope>, <timeout>, <tag_pollclass>,<opc_label>

CONTROL_TEST_1A_00000, Discretes, ASYS,,<int:16>, DISCRETE,, AgentS, 681, 0, 6000, ,"DevCtrl_1A_00000"

CONTROL_TEST_1A_00001, Discretes, ASYS, , <int:16>, DISCRETE|SBO, , AgentS, 681, 0, 6000, ,"DevCtrl_1A_00001"

CONTROL_TEST_1A_00002, Discretes, ASYS, , <int:16>, DISCRETE|TAGABLE, , AgentS, 681, 0, 6000, ,"DevCtrl_1A_00002"

CONTROL_TEST_1A_00003, Discretes, ASYS, , <int:16>, DISCRETE|TAGABLE|SBO, , AgentS, 681, 0, 6000, ,"DevCtrl_1A_00003"

CONTROL_TEST_1A_FO1, Discretes, ASYS, ,<int:16>, DISCRETE|SBO, , AgentS, 681, 0, 6000, ,"DevCtrl_1A_ FO1"

CONTROL_TEST_1A_FO2, Discretes, ASYS, ,<int:16>, DISCRETE|SBO, , AgentS, 681, 0, 6000, ,"DevCtrl_1A_ FO2"

SETPOINT_TEST_1A_00000, Reals, ASYS, , <f-p:32:8>, REAL,, AgentS, 9, 0, 6000, ,"DevCtrl_1A_00000"

SETPOINT_TEST_1A_00001, Reals, ASYS, , <f-p:32:8>, REAL|SBO, , AgentS, 9, 0, 6000,,"DevCtrl_1A_00001"

SETPOINT_TEST_1A_00002, Reals, ASYS, , <f-p:32:8>, REAL|TAGABLE, , AgentS, 9, 0, 6000, ,"DevCtrl_1A_00002"

SETPOINT_TEST_1A_00003, Reals, ASYS, , <f-p:32:8>, REAL|TAGABLE|SBO, , AgentS, 9, 0, 6000, ,"DevCtrl_1A_00003"

SETPOINT_TEST_1A_FO1, Reals, ASYS, , <f-p:32:8>, REAL, , AgentS, 9, 0,6000,,"DevCtrl_1A_ FO1"

SETPOINT_TEST_1A_FO2, Reals, ASYS, , <f-p:32:8>, REAL, , AgentS, 9, 0,6000,,"DevCtrl_1A_ FO2"

Prototype Node Name or Property	Rows 1 through 12	Defines or indicates
#Blk5ToIccp	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 internal names for passing setpoint data in the local OPC UA server.
<NS_Suffix>	Discretes Discretes Discretes Discretes Discretes Discretes Reals Reals Reals Reals Reals Reals	Specifies the OPC UA namespace suffix for the local OPC UA server points that transmit the ICCP data. Leaving blank indicates no NS suffix.
<branch>	ASYS	The OPC UA branch where these OPC UA server points are located. Leaving it blank indicates no branch. All of these points are in the ASYS branch.
<tagging_branch>	Not set.	OPC UA tagging point branch name; the default is the OPC UA point branch name.In this example, the tagging branch name for all points is the default branch ASYS.
<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 local OPC UA server nodes from where the control information is passed.
<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 control flags of the receiving local ICCP control points: REAL – The control point is a floating- point number DISCRETE – The control point is an integer SBO – The control point supports Select Before Operate TAG – The control point supports tagging The bar (\|) represents an AND. INTEGER\|SBO indicates that the value is an integer number and that the control point supports Select Before Operate.
<tagging_point>	Not set.	OPC UA tagging point name. The OPC UA tagging point name is a variable contained in the local OPC UA server. The default is the external OPC UA point name with _TAG appended.
<agent>	AgentS	Label of the OPC UA server agent node to handle the connection with the external OPC UA client.
<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 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.
<timeout>	6000	Specifies the timeout in milliseconds to abort a pending control or set point operation.
<tag_pollclass>	Not set.	Defines the poll period. The available poll periods are as follows: 1 to specify 10 seconds 4 to specify one minute Any number between 4 and 1024 will resolve to the default, which is one minute.
<opc_label>	"DevCtrl_1A_00000" "DevCtrl_1A_00001" "DevCtrl_1A_00002" "DevCtrl_1A_00003" "DevCtrl_1A_ FO1" "DevCtrl_1A_ FO2" "DevSet_1A_00000" "DevSet_1A_00001" "DevSet_1A_00002" "DevSet_1A_00003" "DevSet_1A_ FO1" "DevSet_1A_ FO2"	Specifies the OPC UA control point name. The default OPC UA control point name is the node label. These control points reside on the local OPC UA server.

Repeated Table Headers with Additional Points

At the end of the AppTestA2.csv file, you will find three tables that have the same header information as those in sections: #Blk4_buflen, #Blk4MessageRouter, and #Blk4FromIccp.

Except for the #Blk4MessageRouter table, these tables add additional points to the configuration. For more information about these tables, see the previously described tables in the sections mentioned above.

! Information buffer for receipt of block 4 messages from external ICCP server.

#Blk4_buflen, Info_Buff_1A_16, Info_Buff_1A_64, Info_Buff_1A_256, Info_Buff_1A_1024,

Info_Buff_1A_4096,

<BufLen>, 16,

64,

256,

1024,

4096,

<dom_scope> 0

! Message router to route block 4 messages from external ICCP server to specific OPC UA points subscribed to by external UPC UA client via LEC IFE.

#Blk4MessageRouter, <agent> Blk4FromIccpRouter, AgentS

! ICCP block 4 messages from external ICCP server routed to external OPC UA client via LEC IFE.

#Blk4FromIccp,

<opc_label>

<NS_Suffix>, <branch>,

<InfoRef>,

<LocalRef>,

<agent>,

MSG_TEST_1A_1_2, MSG_TEST_1A_1_2

MSG_TEST_1A_X_4, MSG_TEST_1A_X_4

MSG_TEST_1A_5_X, MSG_TEST_1A_5_X

Messages,

AgentS,

Messages,

AgentS,

Messages,

AgentS,