ICCP Reference
The following sections describe how Inter-Control Center Communications are used with Oracle Utilities Live Energy Connect.
On this page:
ICCP Indication Point Types in Oracle Utilities Live Energy Connect
The following is a list of the possible Oracle Utilities Live Energy Connect (LEC) Server types that ICCP points can have and the each type’s structure in the Oracle Utilities Live Energy server. The bold typeface in the list below is the syntax used to specify each type in the LEC server (e.g. the Type field of a PointFromIccp node might be specified as Data_RealQ).
Data_Real
floating-point: {format-width 24, exponent-width 8}
Data_State
bit-string:
{
State_hi[0],
State_lo[1],
Validity_hi[2],
Validity_lo[3],
CurrentSource_hi[4],
CurrentSource_lo[5],
NormalValue[6],
TimeStampQuality[7]
}
Data_Discrete
integer: {width 32}
Data_Flags
bit-string:
{
unused[0],
unused[1],
Validity_hi[2],
Validity_lo[3],
CurrentSource_hi[4],
CurrentSource_lo[5],
NormalValue[6],
TimeStampQuality[7]
}
Data_TimeStamp
integer: {width 32}
Note: The integer value represents seconds since Unix epoch.
COV_Counter
Unsigned: {width 16}
The following complex types are used in transferring IndicationPoint object values:
Data_RealQ STRUCTURE
{
COMPONENT Value Data_Real,
COMPONENT Flags Data_Flags
}
Data_StateQ
Data_State
Data_DiscreteQ STRUCTURE
{
COMPONENT Value Data_Discrete,
COMPONENT Flags Data_Flags
}
Data_RealQTimeTag STRUCTURE
{
COMPONENT Value Data_Real,
COMPONENT TimeStamp Data_TimeStamp,
COMPONENT Flags Data_Flags
}
Data_StateQTimeTag STRUCTURE
{
COMPONENT TimeStamp Data_TimeStamp,
COMPONENT Flags Data_State
}
Data_DiscreteQTimeTag STRUCTURE
{
COMPONENT Value Data_Discrete,
COMPONENT TimeStamp Data_TimeStamp,
COMPONENT Flags Data_Flags
}
Data_RealExtended STRUCTURE
{
COMPONENT Value Data_Real,
COMPONENT TimeStamp Data_TimeStamp,
COMPONENT Flags Data_Flags,
COMPONENT COV COVCounter
}
Data_StateExtended STRUCTURE
{
COMPONENT TimeStamp Data_TimeStamp,
COMPONENT Flags Data_State,
COMPONENT COV COVCounter
}
Data_DiscreteExtended STRUCTURE
{
COMPONENT Value Data_Discrete,
COMPONENT TimeStamp Data_TimeStamp,
COMPONENT Flags Data_Flags,
COMPONENT COV COVCounter
}
Note: Data_RealQTimeTagExtended uses TIMESTAMP_EXTENDED instead of Data_TimeStamp. The TimeTagExtended types have a millisecond time field in addition to the timestamp (and no COV field). TimeTagExtended types were added in the 2000,8 version of ICCP.
IndicationPointConfig STRUCTURE
{
COMPONENT PointType integer { width 8, range 0 .. 2 },
COMPONENT QualityClass integer { width 8, range 0 .. 1 },
COMPONENT NormalSource integer { width 8, range 0 .. 3 },
COMPONENT TimeStampClass integer { width 8, range 0 .. 1 },
COMPONENT COVClass integer { width 8, range 0 .. 1 },
}
ICCPQualityCodes
The ICCP protocol provides quality codes to represent data quality for a point. If used, these are transferred with each data item.
The quality codes for a data item are derived from the SCADA system's reliability information. The mapping of a SCADA system's data reliability information into the ICCP quality codes is a local implementation issue and can vary across organizations.
The categories of data item quality information are:
- Data Item Status or Validity
- Valid (Good)
- Invalid (Bad)
- Held
- Suspect
- Data Item Source:
- Telemetered
- Calculated
- Estimated
- Manual
- Data Item State:
- Normal
- Abnormal (off-normal)
Oracle Utilities Live Energy Connect Configuration Manager Node Templates for ICCP
One ICCP VMD and 20 ICCP node templates are provided for you in the LEC Configuration Manager. This section provides an alphabetized reference of these templates. LEC provides support for many of the conformance blocks in the ICCP protocol.
ICCP Setup Node Templates
Four of the node templates are designed to establish incoming and outgoing associations with other VMD’s:
- VccAssocInControl
- VccAssocOutControl
- VccTransferControl
- VerifyAssociation
These node templates are common to all ICCP communication and have no specific block designation.
ICCP Conformance Blocks
The following table describes the supported conformance blocks and references the templates associated with each block.
| Block | Definition | Related |
|---|---|---|
|
Block 1 Periodic System |
Includes status points, analogue points, quality flags, time stamp, change of value counter, protection events, and association objects to control ICCP sessions. |
DsTransferSet (Setup Node for Blocks 1 and 2) |
|
Block 2 Extended Data Set Condition Monitoring |
Provides report by exception capability for the data types that block 1 is able to transfer periodically. |
PointFromIccp (Input Node for Blocks 1 and 2) PointToIccp (Output Node for Blocks 1 and 2) |
|
Block 4 Information Messages |
Provides support for simple text and binary. |
ImTransferSet (Setup Node for Block 4) MessageFromIccp (Input Node for Block 4) |
|
Block 5 Device Control |
Provides device control requests: on/off, trip/close, raise/lower node and digital set points. Includes mechanisms for interlocked controls and select-beforeoperate |
ControlFromIccp (Input for Block 5) ControlToIccp (Output for Block 5) |
|
Block 8 Additional User Objects |
Provides scheduling, accounting, and outage and plant information. The term "scheduling" refers to scheduling an amount of electrical power to be transferred from one system to another on a periodic basis for a certain interval of time under the restrictions of a formal agreement. From a data exchange standpoint, "scheduling" is expanded to include the retrieval of any periodic or profile data for control center |
GetOutageFromIccp (Input Node for Block 8) GetTAQueryFromIccp SendOutageToIccp (Output Node for Block 8) SendTAQueryToIccp (Output Node for Block 8) TANoSegPeriodicFromIccp (Input Node for Block 8) TANoSegPeriodicToIccp (Output Node for Block 8) TAServerTransferSetFromIccp (Input Node for Block 8) |
ICCP Node Templates in LCM
VccCreate (VMD Resource Mapper Template)
Creates an ICCP Resource Mapper type of Virtual Manufacturing Device (VMD). This type of Virtual Device communicates to other Devices via the ICCP protocol, also known as TASE.2. The VMD created by this macro is also called a VCC (Virtual Control Center).
| Parameter | Definition | Default |
|---|---|---|
|
My VMD |
Required. Specifies the common name to be assigned to this VCC. |
No default |
|
Assoc out |
Required. Specifies whether this VCC is to have an outbound association. 1 enables an outbound association; 0 does not. |
Yes, unless the scope is VCC-wide. |
|
Assoc in |
Required. Specifies whether this VCC is to have an inbound association. 1 enables an inbound association; 0 does not. Note: A VCC can have both and inbound and outbound association. |
No, if the data type is COMMAND |
|
Client role |
Required. Specifies whether the VCC has the ICCP client role or not. 1 specifies the client role; 0 disables it. |
No default |
|
Server role |
Required. Specifies whether the VCC has the ICCP server role or not. 1 specifies the server role; 0 disables it. |
No default |
|
Flags
|
Optional. This parameter is a set of Boolean (on/off) options that enable or disable certain functions in the ICCP VMD (VCC) that you are creating. The flags argument is expressed as a series of flag keywords separated by the vertical bar (' | ') character in the Flags field. If you prefer to use a form, then click in the Flags field to view the form that allows you to set and unset flags using radio buttons. To remove a flag, unset it in the form or precede it with a minus sign in the Flags field. |
The PUSHALL_FLAG, EXCLUDE_FLAG, FAIL_LIST_FLAG, and NAMED_LIST_FLAG flags are set by default. All other flags are not set by default unless both the Assoc out and Assoc in parameters are set to ' 1 ', then the ONE_WAY_FLAG is set by default. The EXCLUDE_FLAG is set by default. |
|
NOLOG_A_FLAG: If set, directs LEC Server not to generate log messages for variable access failures. |
Not Set |
|
|
RELAY_FLAG: If set, directs LEC Server to treat incoming Information Reports and Read Event Notifications as though they were MMS Writes to a local variable by the same name as specified in the report. |
Not Set |
|
|
DOM_RELAY_FLAG: If set, directs LEC Server to treat incoming Information Reports and Read Event Notifications as though they are Writes, creating a domain-scoped variable where the domain is the remote VMD name. |
Not Set |
|
|
INFO_FLAG: If set, directs LEC Server to send out Information Reports instead of Event Notifications for pushed and polled variables and for enrolled MMS Read Events. |
Not Set |
|
|
WRITE_FLAG: If set, directs LEC Server to send out MMS Writes instead of Event Notifications for pushed and polled variables and for enrolled MMS Read Events. |
Not Set |
|
|
NOREAD_FLAG: If set, directs LEC Server not to perform an initial read of all push-list variables, directing LEC Server to refresh the variable's internal state only as writes come in. |
Not Set |
|
|
PUSHALL_FLAG: If set, directs LEC Server not to check push-list variables for changes in value, directing LEC Server to push a variable whenever a write comes in regardless of the value. |
Not Set |
|
|
BOUNCE_FLAG: If set, directs LEC Server to allow a write to a variable on a given association to trigger a notification (push list or push agent) on the same association. |
Not Set |
|
|
EXCLUDE_FLAG: If set, directs LEC Server not to allow incoming connections to this VMD except for those whose names appear in an AllowMmsInbound node. |
Set |
|
|
ONE_WAY_FLAG: If set, directs LEC Server to force outbound requests to use an outbound association. |
Not Set |
|
|
FAIL_LIST_FLAG: If set, directs LEC Server to prevent the creation of a variable list if any of its variables are non-existent. |
Not Set |
|
|
NAMED_LIST_FLAG: If set, directs LEC Server to perform an integrity scan with RBE to send a named variable list instead of an enumerated list. |
Not Set | |
|
HIDE_UNAVAILABLE_FLAG: If set, directs LEC Server to treat any variable whose value cannot be read as though the variable does not exist. |
Not Set | |
|
REDUCE_LIST_FLAG: If set and the remote ICCP server refuses to define a data set, causes the ICCP Client to attempt to read the data values and then retry the data set definition with any inaccessible data values omitted. |
Not Set | |
|
SECURITY_FLAG: If set, directs LEC Server to perform the secure ICCP procedures (certificate checking) at the ACSE level. |
Not Set | |
|
LEAP_SECOND_FLAG: If set, directs LEC Server to adjust timestamps according to the official schedule of leap seconds (as found in the srvxnt.ini file). |
Not Set | |
|
My Domain |
Required. Specifies the local domain name for server-side data. |
No default |
|
My BT ID |
Required. Specifies the local bilateral table ID. |
No default |
|
My Version |
Required. Specifies the local ICCP version, such as 1996,8. |
No default |
|
My Features |
Required. Specifies locally supported features, as twelve ones or zeros or a combination of ones and zeroes. |
No default |
|
Remote VCC |
Required. Specifies the common name of the remote VCC. Use the name of the server VCC if the client and server are different. |
No default |
|
Remote Domain |
Required. Specifies the remote domain name for server-side data. |
No default |
|
Remote BT ID |
Required. Specifies the remote bilateral table ID. |
No default |
|
Remote Version |
Required. Specifies the remote ICCP version, such as 1996,8. |
No default |
|
Remote Features |
Required. Specifies the features which must be supported by remote VCC, as twelve ones or zeros, or a combination of ones and zeros. |
No default |
|
Delay base |
Optional. Specifies the reference time in seconds relative to the present time for StartDelay (in the DsTransferSet macro). |
No default |
|
Value Poll Time |
Optional. Specifies the period in seconds for polling ICCP server variables to test for the availability of their values. |
5 seconds |
|
Value Timeout |
Optional. Specifies the seconds that LEC Server is to wait for all variables to have a value before allowing an association. A value of 0 disables the feature. |
0 seconds |
ControlFromIccp (Input Node Template)
Takes device control from the ICCP peer.
| Parameter | Definition | Required |
|---|---|---|
|
Point label |
Assigns a name that is for routing the data within LEC Server. This name will be displayed throughout LEC Configuration Manager, for example, in the Node Table, and can be used in batch files in order to create more instances of this node. Use this label whenever you refer to the node within LEC Configuration Manager, for example, when connecting this node to another node. |
Yes |
|
My domain |
Specifies the local domain name for server-side data. Leave this parameter blank if the scope is VCC-wide. |
Yes, unless the scope is VCC-wide. |
|
Flags |
This parameter is a set of Boolean (on/off) options that enable or disable certain functions in the OPC UA VMD that you are creating. The flags argument is expressed as a series of flag keywords separated by the vertical bar (' | ') character in the Flags field. If you prefer to use a form, then click in the Flags field to view the form that allows you to set and unset flags using radio buttons. To remove a flag, unset it in the form or precede it with a minus sign in the Flags field. REAL: Sets the control point to type REAL. Default: If not set, the default is type COMMAND. DISCRETE: Sets the control point to type DISCRETE. Default: If not set, the default is type COMMAND. |
No, if the data type is COMMAND |
|
SBO: Indicates whether the control point supports the select-before-operate sequence. |
Yes, if you are using SBO | |
|
TAGABLE: Indicates whether the control point supports tagging. |
No | |
|
Combine Group |
This is the name used for grouping nodes in this VMD when they are displayed in the Node Table. Specify a combine group name if you would like to group nodes together when they serve a similar function. |
No |
ControlToIccp (Output Node Template)
Transfers device control to the ICCP peer.
| Parameter | Definition | Required |
|---|---|---|
|
Point label |
Assigns a name that is for routing the data within LEC Server. This name will be displayed throughout LEC Configuration Manager, for example, in the Node Table, and can be used in batch files in order to create more instances of this node. Use this label whenever you refer to the node within LEC Configuration Manager, for example, when connecting this node to another node. |
Yes |
|
Remote VCC |
Specifies the common name of the remote VCC. Use the name of the server VCC if the client and server are different. |
Yes |
|
Remote Domain |
Specifies the remote domain name for server-side data. Leave this parameter blank if the scope is VCC-wide. |
Yes, unless the scope is VCC-wide. |
|
Flags |
This parameter is a set of Boolean (on/off) options that allows you to select a data type and specify additional options. The flags argument is expressed as a series of flag keywords separated by the vertical bar (' | ') character in the Flags field. If you prefer to use a form, then click in the Flags field to view the form that allows you to set and unset flags using radio buttons. To remove a flag, unset it in the form or precede it with a minus sign in the Flags field. REAL: Sets the control point to type REAL. Default: If not set, the default is type COMMAND. DISCRETE: Sets the control point to type DISCRETE. Default: If not set, the default is type COMMAND. |
No, if the data type is COMMAND. |
|
SBO: Indicates whether the control point supports the select-before-operate sequence. |
Yes, if you are using SBO | |
|
TAGABLE: Indicates whether the control point supports tagging. |
No | |
|
Combine Group |
This is the name used for grouping nodes in this VMD when they are displayed in the Node Table. Specify a combine group name if you would like to group nodes together when they serve a similar function. |
No |
DsTransferSet(SetupNodeTemplate)
Defines a client-side DS transfer set.
| Parameter | Definition | Required |
|---|---|---|
|
TS num |
Assigns a transfer set number that is unique to this VCC. |
Yes |
|
Remote Domain |
Specifies the remote domain for data. |
Yes |
|
Remote VCC |
Specifies the common name of the remote server's VCC. |
Yes |
|
StartTime |
Specifies the absolute start time as GMTBasedS. |
No |
|
StartDelay |
Specifies the start time in seconds relative to the #delay_base in the VccCreate VMD. |
No |
|
IntervalCheck |
Specifies the period in seconds between interval-based transmissions. |
Yes |
|
TLE |
Specifies the time limit for execution in seconds. |
No |
|
BufferTime |
Specifies the buffer time in seconds. |
No |
|
IntegrityCheck |
Specifies the period in seconds between integrity-based transmissions. |
Yes |
|
IntervalTimeOut |
Indicates whether interval based transmissions are enabled. 1 indicates that interval-based transmissions are enabled; 0 indicates that they are not. |
Yes |
|
IntegrityTimeOut |
Indicates whether integrity-based transmissions are enabled. 1 indicates that integrity-based transmissions are enabled; 0 indicates that they are not. |
Yes |
|
ObjectChange |
Indicates whether change-based transmissions are enabled. 1 indicates that change-based transmissions are enabled; 0 indicates that they are not. |
Yes |
|
OperatorRequest |
Indicates whether operator-requested transmissions are enabled. 1 indicates that operator-requested transmissions are enabled; 0 indicates that they are not. |
Yes |
|
RBE |
Indicates whether report-by-exception is enabled. 1 indicates that report- by-exception is enabled; 0 indicates that report-by-exception is not. |
Yes |
|
IntervalDelay |
Specifies the start time delay after the next time, which is a multiple of the IntervalCheck period (e.g., if IntervalCheck is 3600 seconds, and IntervalDelay is 60 seconds, poll 1 minute after each hour). Defining this parameter (even with a 0 value) enables this feature. |
No |
|
AllChangesReported |
Indicates whether or not all changes are to be reported. 1 indicates that the all-changes-reported function is enabled; 0 indicates that this function is not enabled. |
No |
|
Critical |
Indicates whether critical acknowledgment is required or not. 1 indicates that critical acknowledgment is required; 0 or no value indicates that it is not. |
No |
|
SiemensCompatibility |
Indicates whether or not to circumvent the Siemens Transfer Set domain name bug. Specifying any value directs LEC Server is to circumvent the Siemens bug. No value indicates not to circumvent this bug. |
No |
|
Do read |
Indicates whether or not LEC Server is to perform an initial read. 1 indicates to do an initial read of data values; 0 or no value indicates that LEC Server is not to perform an initial read. |
No |
|
Combine Group |
This is the name used for grouping nodes in this VMD when they are displayed in the Node Table. Specify a combine group name if you would like to group nodes together when they serve a similar function. |
No |
GetOutageFromIccp(InputNodeTemplate)
Retrieves outage data from the ICCP peer. Specifically, this outage data provides the time period when the outage occurred.
| Parameter | Definition | Required |
|---|---|---|
|
Point label |
Assigns a name that is for routing the data within LEC Server. This name will be displayed throughout LEC Configuration Manager, for example, in the Node Table, and can be used in batch files in order to create more instances of this node. Use this label whenever you refer to the node within LEC Configuration Manager. This specific label indicates the information requested about the outage. Specify one of the following:
|
Yes |
|
Type |
Specifies the data type for this outage object. Use the data type with the same name as the Point label:
|
Yes |
|
Remote VCC |
Specifies the common name of the remote VCC. Use the server VCC name if the client and server are different. |
Yes |
|
Remote Domain |
Specifies the remote domain for data. Leave this parameter blank if the scope of the data is VCC-wide. |
Yes, unless the scope is VCC-wide |
|
Combine Group |
This is the name used for grouping nodes in this VMD when they are displayed in the Node Table. Specify a combine group name if you would like to group nodes together when they serve a similar function. |
No |
GetTAQueryFromIccp(InputNodeTemplate)
Retrieves the Transfer Account Query from the ICCP peer.
| Parameter | Definition | Required |
|---|---|---|
|
Point label |
Assigns a name that is for routing the data within LEC Server. This name will be displayed throughout LEC Configuration Manager, for example, in the Node Table, and can be used in batch files in order to create more instances of this node. Use this label whenever you refer to the node within LEC Configuration Manager, for example, when connecting this node to another node. |
Yes |
|
Remote VCC |
Specifies the common name of the remote server VCC. |
Yes |
ImTransferSet(SetupNodeTemplate)
Defines a client-side information message (IM) transfer set.
| Parameter | Definition | Required |
|---|---|---|
|
Ts num |
Assigns a transfer set number that is unique to this VCC. |
Yes |
|
Remote VCC |
Specifies the common name of the remote server's VCC. |
Yes |
|
Combine Group |
This is the name used for grouping nodes in this VMD when they are displayed in the Node Table. Specify a combine group name if you would like to group nodes together when they serve a similar function. |
Yes |
MessageFromIccp(InputNodeTemplate)
Receives an information message from the ICCP peer as an IM_struct type. It is recommended that you set the RELAY_FLAG for the ICCP association. Use an update connector for this point.
| Parameter | Definition | Required |
|---|---|---|
|
Point label |
Assigns a name that is for routing the data within LEC Server. This name will be displayed throughout LEC Configuration Manager, for example, in the Node Table, and can be used in batch files in order to create more instances of this node. Use this label whenever you refer to the node within LEC Configuration Manager, for example, when connecting this node to another node. |
Yes |
|
Remote VCC |
Specifies the common name of the remote VCC. Use the server VCC if the client and server are different. |
Yes |
|
TS num |
Specifies the number of the IM transfer set. The default is 0. |
No |
|
Size |
Specifies the information buffer size in bytes. The default is 1024 |
No |
|
Remote Domain |
Specifies the domain name used in incoming Block 4 information reports. Leave this parameter blank if the scope of the information reports is VCC-wide. |
Yes, unless the scope is VCC- wide. |
MessageToIccp(OutputNodeTemplate)
Sends an information message to the ICCP Peer by writing an IM_struct type to this node. Use either an update or time-based connector.
| Parameter | Definition | Required |
|---|---|---|
|
Point label |
Assigns a name that is for routing the data within LEC Server. This name will be displayed throughout LEC Configuration Manager, for example, in the Node Table, and can be used in batch files in order to create more instances of this node. Use this label whenever you refer to the node within LEC Configuration Manager, for example, when connecting this node to another node. |
Yes |
|
Remote VCC |
Specifies the common name of the remote client VCC. |
Yes |
|
My Domain |
Specifies the domain name that is used in outgoing Block 4 information reports. Leave this parameter blank if the scope of the information reports is VCC-wide. |
Yes, unless the scope is VCC-wide. |
PointFromIccp (Input Node Template)
Retrieves indication point data from the ICCP peer.
| Parameter | Definition | Required |
|---|---|---|
|
Point label |
Assigns a name that is for routing the data within LEC Server. This name will be displayed throughout LEC Configuration Manager, for example, in the Node Table, and can be used in batch files in order to create more instances of this node. Use this label whenever you refer to the node within LEC Configuration Manager, for example, when connecting this node to another node. |
Yes |
|
Type |
The supported ICCP types are:
|
Yes |
|
Remote VCC |
Specifies the common name of the remote VCC. Use the server VCC if the client and server are different. |
Yes |
|
Remote Domain |
Specifies the remote domain for this point if the point is of domain scope. Leave blank for a VCC-wide point. |
No |
|
TS num |
Specifies the number of the transfer set to which this point is assigned |
No |
|
Combine Group |
This is the name used for grouping nodes in this VMD when they are displayed in the Node Table. Specify a combine group name if you would like to group nodes together when they serve a similar function. |
No |
|
Period |
Places a limit (in seconds) on the time LEC Server will wait between receiving reports before dis-establishing the association and then re-establishing it. Specify this limit on only one node associated with this VCC because specifying it on more than on requires more memory and will slow down performance. Note: The node must receive data at a specified time interval, not when the data changes; otherwise, the function that re-establishes the association will not work in the event that the data never changes. If this parameter is undefined or set to 0, LEC Server will wait indefinitely. |
No |
|
Variation |
Indicates whether or not the RELAY_FLAG is for this ICCP association. Enter 1 if the RELAY_FLAG is set for the ICCP association; otherwise, enter 0 or leave blank. |
No |
PointToIccp (Output Node Template)
Sends indication point data to the ICCP peer.
| Parameter | Definition | Required |
|---|---|---|
|
Point label |
Assigns a name that is for routing the data within LEC Server. This name will be displayed throughout LEC Configuration Manager, for example, in the Node Table, and can be used in batch files in order to create more instances of this node. Use this label whenever you refer to the node within LEC Configuration Manager, for example, when connecting this node to another node. |
Yes |
|
Type |
The supported ICCP types are:
|
Yes |
|
My Domain |
Specifies the local domain for this point if the point has domain scope. Leave this parameter blank if the point's scope is VCC-wide. |
Yes, unless the scope is VCC-wide. |
|
Combine Group |
This is the name used for grouping nodes in this VMD when they are displayed in the Node Table. Specify a combine group name if you would like to group nodes together when they serve a similar function. |
No |
SendOutageToIccp (Output Node Template)
Provides device outage data to the ICCP peer in order to run a planned outage.
| Parameter | Definition | Required |
|---|---|---|
| Point label |
Assigns a name that is for routing the data within LEC Server. This name will be displayed throughout LEC Configuration Manager, for example, in the Node Table, and can be used in batch files in order to create more instances of this node. Use this label whenever you refer to the node within LEC Configuration Manager. This specific label indicates information about the planned outage that LEC Server is to send to the ICCP peer. Specify one of the following:
|
Yes |
| Type |
Specifies the data type for this outage object. Use the data type with the same name as the Point label:
|
Yes |
| Remote VCC |
Specifies the X.500 common name of the remote client VCC. |
Yes |
| My Domain |
Specifies the local VCC domain issuing this report. Leave this parameter blank if this node's scope is VCC-wide. |
Yes, unless the scope is VCC-wide |
| Combine Group |
This is the name used for grouping nodes in this VMD when they are displayed in the Node Table. Specify a combine group name if you would like to group nodes together when they serve a similar function. |
No |
SendTAQueryToIccp (Output Node Template)
Sends a query to the ICCP peer.
| Parameter | Definition | Required |
|---|---|---|
|
Point label |
Assigns a name that is for routing the data within LEC Server. This name will be displayed throughout LEC Configuration Manager, for example, in the Node Table, and can be used in batch files in order to create more instances of this node. Use this label whenever you refer to the node within LEC Configuration Manager, for example, when connecting this node to another node. |
Yes |
|
Remote VCC |
Specifies the common name of the remote server VCC. |
Yes |
TANoSegPeriodicFromIccp (Input Node Template)
Retrieves "scheduling" and "accounting" information from the ICCP peer periodically. In particular, this type of node retrieves the information without segmentation.
| Parameter | Definition | Required |
|---|---|---|
|
Point label |
Assigns a name that is for routing the data within LEC Server. This name will be displayed throughout LEC Configuration Manager, for example, in the Node Table, and can be used in batch files in order to create more instances of this node. Use this label whenever you refer to the node within LEC Configuration Manager, for example, when connecting this node to another node. |
Yes |
|
Row Type |
Provides the MMS-DL (Manufacturing Messaging Service-Descriptive Language) specification of the type of data in a single matrix row. |
Yes |
| Num Floats |
Specifies the number of floats in a matrix row |
Yes |
| Num ints |
Specifies the number of integers in a matrix row. |
Yes |
| Num matrix ids |
Specifies the sum of the number of floats and integers in a matrix row. |
Yes |
| Max loc refs |
Specifies the maximum number of local refs that are allowed in the header structure |
Yes |
| Max rows |
Specifies the maximum number of matrix rows which may be passed using this point |
Yes |
| Ts num |
Specifies the number of the transfer set to which this point is assigned. |
Yes |
|
Combine Group |
This is the name used for grouping nodes in this VMD when they are displayed in the Node Table. Specify a combine group name if you would like to group nodes together when they serve a similar function. |
No |
TANoSegPeriodicToIccp (Output Node Template)
Sends "scheduling" and "accounting" information to the ICCP peer periodically. In particular this type of node sends the information without segmentation.
| Parameter | Definition | Required |
|---|---|---|
|
Point label |
Assigns a name that is for routing the data within LEC Server. This name will be displayed throughout LEC Configuration Manager, for example, in the Node Table, and can be used in batch files in order to create more instances of this node. Use this label whenever you refer to the node within LEC Configuration Manager, for example, when connecting this node to another node. |
Yes |
|
Row Type |
Provides the MMS-DL specification of the type of a single matrix row. |
Yes |
| Num matrix ids |
Indicates how many numbers are in a matrix row. These numbers can be either integers or floats, or some combination of integers and floats. |
Yes |
| Max loc refs |
Specifies the maximum number of local refs that are allowed in the header structure. |
Yes |
|
Max Rows |
Specifies the maximum number of matrix rows which may be passed using this point. |
Yes |
|
My Domain |
Specifies the domain in the local VCC of this report. Leave this parameter blank if the scope is VCC-wide. |
Yes, unless the scope is VCC- wide. |
|
Combine Group |
This is the name used for grouping nodes in this VMD when they are displayed in the Node Table. Specify a combine group name if you would like to group nodes together when they serve a similar function. |
No |
TAServerTransferSetFromIccp (Input Node Template)
Defines a server-side transfer account (TA) transfer set.
| Parameter | Definition | Required |
|---|---|---|
|
Point label |
Assigns a name that is for routing the data within LEC Server. This name will be displayed throughout LEC Configuration Manager, for example, in the Node Table, and can be used in batch files in order to create more instances of this node. Use this label whenever you refer to the node within LEC Configuration Manager, for example, when connecting this node to another node. |
Yes |
|
Remote VCC |
Specifies the common name of the remote server VCC. |
Yes |
TaTransferSet (Setup Node Template)
Defines a client-side transfer account (TA) transfer set.
| Parameter | Definition | Required |
|---|---|---|
|
Ts num |
Assigns a transfer set number that is unique to this VCC. |
Yes |
|
Remote Domain |
Assigns a transfer set number that is unique to this VCC. |
Yes |
| Remote VCC |
Specifies the common name of the remote server VCC. |
Yes |
| BeforeTheHour |
Indicates whether or not the ICCP server is to send a report before the hour. Specify 1 to direct the ICCP server to send this information before the hour; otherwise, specify 0. Often, this is referred to as "pre-schedules." |
Yes |
|
DispatchUpdate |
Indicates whether or not the ICCP server is to send a report for a dispatch update. Specify 1 to direct the ICCP server to send a report for a dispatch update; otherwise, specify 0. Often, this is referred to as "next hour schedules." |
Yes |
|
DuringTheHour |
Indicates whether or not the ICCP server is to send a report during the hour. Specify 0.1 to direct the server to send these reports during the hour; otherwise, specify 0. Often, this is referred to as "mid hour schedule changes." |
Yes |
|
AfterTheHour |
Indicates whether or not the ICCP server is to send a report after the hour. Specify 1 to direct the server to send these a report after the hour; otherwise, specify 0. Often, this is referred to as "after the hour actuals." |
Yes |
|
ActualDataUpdate |
Indicates whether or not the ICCP server is to send a report for an actual data update. Specify 1 to direct the server to send a report for an update; otherwise, specify 0. Often, this is referred to as "corrections to previous schedules." |
Yes |
|
PastHours |
Indicates whether or not the ICCP server is to send a report for data in the past. Specify 1 to direct the server to send a report for this past data; otherwise, specify 0. |
Yes |
|
ObjectChange |
Indicates whether or not the server is to send a report when any object in the transfer account changes. Specify 1 to direct the server to send a report when a change occurs; otherwise, specify 0. |
Yes |
|
OperatorRequest |
Indicates whether or not the ICCP server is to send a report when an operator at the ICCP server control requests it. Specify 1 to direct the server to send a report upon operator request; otherwise, specify 0. |
Yes |
Note: A Transfer Account object represents what, where, when, and how much is transferred between two utilities in a particular account. It may also represent generation schedules and other energy delivery schedules within a utility. It is a container for a number of different attributes and objects, which together define the entire transfer account definition, i.e. which account, when is the effective time frame, and what are the periodic or profile values of the data.
VccAssocInControl (Setup Node Template)
Establishes inbound association control, enabling and disabling the inbound ICCP association to this VCC, and reporting the association status. This node must be linked to a node in another virtual device, usually the processor, with a TwoWayConnector. The data type is <integer:32>. Control values are -1 to abort and disable, +0 to disable, and +1 to listen for an association. Status values are +0 for disabled, +1 for listening for association, and +2 for associated.
| Parameter | Definition | Required |
|---|---|---|
|
Point label |
Assigns a name that is for routing the data within LEC Server. This name will be displayed throughout LEC Configuration Manager, for example, in the Node Table, and can be used in batch files in order to create more instances of this node. Use this label whenever you refer to the node within LEC Configuration Manager, for example, when connecting this node to another node. |
Yes |
|
Remote VCC |
Specifies the common name of the remote VCC. |
Yes |
| Init state var |
Indicates whether or not LEC Server is to establish an association initially. Specify +1 if LEC Server is to enable the association initially; specify +0 if LEC Server is not to enable the association initially. |
Yes |
| Association Flags |
Each of these flags disables or enables an option for handling data and associations. By default, none of these flags are set. The flags argument is expressed as a series of flag keywords separated by the vertical bar (' | ') character in the Flags field. No If you prefer to use a form, then click in the Flags field to view the form that allows you to set and unset flags using radio buttons. To remove a flag, unset it in the form or precede it with a minus sign in the Flags field. RELAY_FLAG: If set, directs LEC Configuration Manager to treat incoming Information Reports and Read Event Notifications as though they were MMS Writes to a local variable by the same name as in the report. DOM_RELAY_FLAG: If set, directs LEC Configuration Manager to treat incoming Information Reports and Read Event Notifications as though they are Writes, creating a domain-scoped variable where the domain is the remote VMD name. INFO_FLAG: If set, directs LEC Configuration Manager to send out Information Reports instead of Event Notifications for pushed and polled variables and for enrolled MMS Read Events. BOUNCE_FLAG - If set, directs LEC Configuration Manager not to allow a write to a variable on a given association to trigger a notification (push list or push agent) on the same association. EN_OUT_FLAG - If set, directs LEC Configuration Manager to attempt to make an outbound association. SUPERCEDE_FLAG - If set and an associate request comes in while there is already an association, directs LEC Configuration Manager to abort the old association and accept the new one. If not set, LEC Configuration Manager refuses the new association. ALLOW_MULTI_FLAG - If set and an associate request comes in while there is already an association, directs LEC Configuration Manager to keep the old association and also accept the new one. If not set, refuse the new association and keep the old one. |
No |
|
Combine Group |
This is the name used for grouping nodes in this VMD when they are displayed in the Node Table. Specify a combine group name if you would like to group nodes together when they serve a similar function. |
No |
VccAssocOutControl (Setup Node Template)
Provides outbound association control, enabling and disabling the outbound ICCP association from this VCC, and reporting the association status. This node must be linked to a node in another VMD (usually the processor) with a TwoWayConnector. The data type is <integer:32>. Control values are -1 to abort and disable, +0 to disable, and +1 to try to associate. Status values are +0 for disabled, +1 for trying to associate, and +2 for associated.
| Parameter | Definition | Required |
|---|---|---|
|
Point label |
Assigns a name that is for routing the data within LEC Server. This name will be displayed throughout LEC Configuration Manager, for example, in the Node Table, and can be used in batch files in order to create more instances of this node. Use this label whenever you refer to the node within LEC Configuration Manager, for example, when connecting this node to another node. |
Yes |
|
Remote VCC |
Specifies the name of the remote VCC. |
Yes |
| Init state var |
Indicates whether or not LEC Server is to establish an association initially. Specify +1 if LEC Server is to enable the association initially; specify +0 if LEC Server is not to enable the association initially. |
Yes |
| Association Flags |
Each of these flags disables or enables an option for handling associations controlled by this node. By default, none of these flags are set. The flags argument is expressed as a series of flag keywords separated by the vertical bar (' | ') character in the Flags field. If you prefer to use a form, then click in the Flags field to view the form that allows you to set and unset flags using radio buttons. To remove a flag, unset it in the form or precede it with a minus sign in the Flags field. RELAY_FLAG: If set, directs LEC Server to treat incoming Information Reports and Read Event Notifications as though they are MMS Writes to a local variable by the same name as in the report. DOM_RELAY_FLAG: If set, directs LEC Server to treat incoming Information Reports and Read Event Notifications as though they are Writes, creating a domain-scoped variable where the domain is the remote VMD name. INFO_FLAG: If set, directs LEC Server to send out Information Reports instead of Event Notifications for pushed and polled variables and for enrolled MMS Read Events. WRITE_FLAG: If set, directs LEC Server to send out MMS Writes instead of Event Notifications for pushed and polled variables and for enrolled MMS Read Events. NOREAD_FLAG: If set, directs LEC Server to make all AA-specific PGE variables candidates for pushing (without the need for inclusion in a PUSH list). REPORT_FLAG: If set, directs LEC Server not to perform an initial read of all push- list variables, directing LEC Server to refresh the variable's internal state only as writes come in. BOUNCE_FLAG: If set, directs LEC Server not to allow a write to a variable on a given association to trigger a notification (push list or push agent) on the same association. EN_OUT_FLAG: If set, directs LEC Server to attempt to make an outbound association. SUPERCEDE_FLAG: If set and an associate request comes in while there is already an association, directs LEC Configuration Manager to abort the old association and accept the new one. If not set, LEC Configuration Manager refuses the new association. ALLOW_MULTI_FLAG: If set and an associate request comes in while there is already an association, directs LEC Server to keep the old association and also accept the new one. If not set, refuse the new association and keep the old one. |
No |
|
Combine Group |
This is the name used for grouping nodes in this VMD when they are displayed in the Node Table. Specify a combine group name if you would like to group nodes together when they serve a similar function. |
No |
VccTransferControl (Setup Node Template)
Establishes transfer set control, enabling and disabling the client-side transfer sets (data set, message, and accounts) for this VCC, and reporting the transfer set status. This node must be linked to a node in another virtual device, usually the processor, with a TwoWayConnector.
| Parameter | Definition | Required |
|---|---|---|
|
Point label |
Assigns a name that is for routing the data within LEC Server. This name will be displayed throughout LEC Configuration Manager, for example, in the Node Table, and can be used in batch files in order to create more instances of this node. Use this label whenever you refer to the node within LEC Configuration Manager, for example, when connecting this node to another node. |
Yes |
|
Type |
Specifies the data type of the transfer set, which must be a packed Boolean array type, such as <Boolean>(<pack>16). |
Yes |
| Init state var |
Specifies the name of a packed Boolean array type variable, where the true (1) array elements initially enable the corresponding transfer sets, and the false (0) elements disable them. |
Yes |
| Combine Group |
This is the name used for grouping nodes in this VMD when they are displayed in the Node Table. Specify a combine group name if you would like to group nodes together when they serve a similar function. |
No |
VerifyAssociation (Setup Node Template)
Periodically requests an ICCP Identify from the ICCP peer. If the request is not acknowledged by the time specified in the timeout parameter (default is 1 minute), then the association will be aborted. A new association can then be established.
| Parameter | Definition | Required |
|---|---|---|
|
Label |
Assigns a name that is for routing the data within LEC Server. This name will be displayed throughout LEC Configuration Manager, for example, in the Node Table, and can be used in batch files in order to create more instances of this node. Use this label whenever you refer to the node within LEC Configuration Manager, for example, when connecting this node to another node. |
Yes |
|
Remote VCC |
Specifies the common name of the remote VCC. |
Yes |
| Pclass |
Specifies the LiveData poll class controlling the frequency of issuing the identify request.
Do not use poll class 0 because it is the PUSH class, which makes no sense in this case. |
Yes |
| Timeout |
Specifies the time-out in milliseconds on all confirmed requests for the entire server. The default is 60000 (one minute). This timeout will govern how soon the identify request (and all other requests) time out. Note: Because this parameter is global, specify this parameter only once |
No |