Live Energy Connect ICCP Adapter Configuration
This section guides the user through configuration of the Oracle Utilities Network Management System Live Energy Connect ICCP Adapter. The following are assumed to be true before the adapter is installed:
• Oracle database access has been confirmed.
• Isis messaging bus has been installed and verified.
• Oracle Utilities Network Management System is installed and functional.
• Live Energy Connect server is installed, functional, and licensed.
The adapter reloads its configuration file and measurements configuration each time connection to Live Energy Connect server is lost.
Configuring the ICCP Adapter requires:
Configuring the Adapter to Run as a System Service
Configure the ICCP Adapter by updating the $NMS_HOME/etc/system.dat file to include the ICCP Adapter as a system service. There are three main sections where this service needs to be defined: the service, program and instance sections. See the $NMS_HOME/templates/system.dat.template file for examples of how to configure the ICCP Adapter. Search for IccpAdapter and make sure those lines are uncommented. You must restart the system services in order for the ICCP Adapter to be properly monitored by SMService.
Below is an example of the program section in the system.dat file:
program IccpAdapter IccpAdapter -prm_path /users/nms1/etc/
Note: It is assumed that the ICCP Adapter will reside on the same Unix or Linux server where the Oracle Utilities Network Management System services environment resides.
Command Line Options for ICCP Adapter
IccpAdapter startup options select its process name and the parameter file used to connect to Live Energy Connect. Use -prm_path for the directory containing IccpAdapter.prm, or -prm_file for a complete filename, including its path. A separate parameter file can be selected for each adapter instance. The parameter-file fields and required connection settings are described separately in this chapter.
Set startup options in the program or instance entries for the service in system.dat. Restart the affected service to apply changes. Startup options do not replace the database, rules, or interface configuration described elsewhere in this chapter.
The common Service startup options in the Configuration Guide also apply unless an adapter-specific option overrides them.
In the syntax below, angle brackets identify required values, square brackets identify optional values, and an ellipsis permits repetition. Enter values without the brackets and preserve the spelling and case shown.
IccpAdapter
-debug [<level> | <facility> [level] ...]
Set the common Service diagnostic level. A nonnegative numeric level sets global verbosity; higher values produce more detail. Facility/level pairs are accepted through the inherited parser. Omitting all values enables common debugging rather than selecting the level-0 default described in older guide text.
Example: IccpAdapter -prm_file /project/iccp/IccpAdapter.prm -debug 2
-prm_file <filename>
Select the ICCP adapter parameter file using its complete path.
Notes: Use this option with a full filename such as ${NMS_ICCP_PARAMFILE_PATH}.
Use a separate full filename for each instance when multiple ICCP adapters run in parallel, and set an appropriate unique process identity with -process_name. This selects the file; it does not populate required Live Energy Connect connection fields.
-prm_path <directory>
Select IccpAdapter.prm in the specified directory.
Notes: Compatibility directory form: always appends /IccpAdapter.prm. Use -prm_file for a full filename; do not pass a filename to -prm_path.
Use an absolute directory path for a managed service so selection does not depend on its working directory. An explicit -prm_file avoids ambiguity when the configuration file has a different name.
-process_name <name>
Set the ICCP adapter message-bus process name.
-simulator_path <absolute-directory>
Enable ICCP simulation using files from the specified directory. The path must begin with /.
Caution: Simulation only; use in a test environment.
Parameter File and Help Compatibility
The parameter file contains the adapter's Live Energy Connect connection configuration. Lines beginning with ; are comments; lines beginning with [ identify configuration blocks. Configure all required project-specific fields and use IccpAdapter.prm.template in the standard templates directory as the starting point. The individual connection fields are described in Fields in the IccpAdapter.prm File in this chapter.
Select the parameter file explicitly with -prm_file or -prm_path. The current Unix implementation opens the configured path directly; do not rely on the older guide's assertion that the default file is beside the binary in $NMS_BASE/bin.
The older guide lists IccpAdapter -help as a usage-and-exit option. This Unix adapter's startup parser and inherited Service parser do not implement -help. It is not a supported help invocation for this implementation. Use the startup reference above; do not run -help assuming it safely bypasses initialization.
IccpAdapter.prm
The IccpAdapter.prm configuration file controls the ICCP adapter connection to Live Energy Connect. Select it explicitly with -prm_file or -prm_path; do not rely on a default file beside the binary. Lines beginning with ; are comments, and lines beginning with [ identify configuration blocks. Fields marked as <Required> must be configured for proper operation and are generally site specific. Use IccpAdapter.prm.template in $NMS_BASE/templates as the starting point.
Fields in the IccpAdapter.prm File
Field name
Type
Default
Valid Values
Description
[IccpAdapter]
Marker
 
 
Used for generic configuration of program.
ServerHostname
IP address
List; (blank) space separated
<Required>
128.168.148.43 etc
The IP address(es) of the Live Energy Connect server hostname(s) to connect to. It could be a blank separated list of IP address of several Oracle Live Energy Connect servers. In case a failure of connection was detected by the ICCP Adapter with the current Live Energy Connect server, it will traverse the ServerHostname list for the next Live Energy Connect server to connect to.
Port
Integer
<Required>
[1..MAX_INT]
Blank separated list of TCP/IP port numbers that the ICCP Adapter will use for a connection attempt to a Live Energy Connect server. Parallel to the ServerHostname, it could be a list of port numbers to use to connect to the corresponding LiveData server in ServerHostname. In case there was a failure of connection with the current Live Energy Connect server, it would proceed to the next entry - in parallel with the next ServerHostname entry. 5002 is typical.
Period
Integer
10
[1..MAX_INT]
Time in seconds between periodic transfers of non-time critical data.
StatusUpdates
Integer
25
[1..MAX_INT]
The maximum number of status updates to be sent to DDService at one time.
ScadaId
Integer
1
[1..MAX_INT]
Identification number assigned to the SCADA in Oracle Utilities Network Management System with which the ICCP Adapter is communicating.
AnalogTolerance
Double
0.0F
[0.01..0.99]
Dead band for analog value updates. It is the required percent change from the last reported value to trigger an update.
Analogs
Boolean
F
[T, F]
Boolean value indicating use of the ANALOG_MEASUREMENTS table.
Digitals
Boolean
T
[T, F]
Boolean value indicating use of the DIGITAL_MEASUREMENTS table.
ReconnectPeriod
Integer
60
[0..MAX_INT]
Configurable duration of delay to wait after the Live Energy Connect server instances failed in succession.
Controls
Boolean
F
[T, F]
Boolean value indicating use of the controls table for Block 5 functionality.
QualityCodeUseOn
AssociationTimeOut
Integer
0
[0..MAX_INT]
Quality code that will be sent to DDService when the communication with LD server is lost. A valid QualityCode must be specified if this option is used.
DisableStop
Boolean
F
[T, F]
Normally the adapter will accept and process a stop high level message. This option disables this feature. When this feature is enabled, the adapter will disregard a stop high level message.
DisableCOV
Boolean
F
[T, F]
Normally the adapter will process a COV update (one or more open and close sequences within a scan cycle – normally indicating one or more momentaries) and send it to DDService. This option disables this feature.
Vccs
Integer
<Required>
[1..MAX_INT]
The number of VCCs (Virtual Control Centers) that are configured in the Live Energy Connect server.
IgnoreCritInterSysServFail
Boolean
F
[T, F]
Normally the adapter will stop if SMSserivce reports a critical service failure and not restart until services are recovered. This option disables this feature.
NoSwitchOpQualityMask
Integer
No Mask
[0..MAX_INT]
This parameter sets the quality codes that prevent switches from being operated. There is no effect on non-switch statuses.
PhaseEncodeSwitch
Boolean
F
[T, F]
If set to true, this will enable Iccp Adapter to interpret data discrete values as three-bit phase encoded statuses. [e.g., A = '001', B = '010', C = '100', etc.]
PseudoAlarms
Boolean
F
[T, F]
If set to 1, then this will set the pseudo flag for the switch entry to be sent to DDService. Generates pseudo (advisory) alarms for ICCP reported device ops rather than actually operating the switches in the Oracle Utilities Network Management System model.
SendTimeout
Integer
10
[0..MAX_INT]
Number of seconds to wait when attempting to connect ICCP Adapter to the Live Energy Connect server. If no connection is received, it will move to the next available Live Energy Connect server (if configured). Generally leave as the default.
DetachRead
Boolean
T
[T,F]
Detach the IccpAdapter internal thread that is reading the incoming RTP data stream from Isis. Generally leave as the default.
DetachWrite
Boolean
F
[T,F]
Detach the IccpAdapter internal thread that is writing the outgoing RTP data stream from Isis. Generally leave as the default
DetachHeartbeat
Boolean
F
[T,F]
Detach the IccpAdapter internal thread that is sending outgoing RTP data stream heartbeat requests from Isis. Generally leave as the default
RtuDemandScanSuffix
String
Blank (not configured); optional
-<NMS Demand Scan Attribute Name>
Suffix used to configure NMS outbound demand scan requests. Set it to -<NMS Attribute Name>. For example, if the project uses DS as the NMS demand scan attribute name, add RtuDemandScanSuffix=-DS to IccpAdapter.prm. Initiating outbound demand scan requests requires substantial project-specific configuration and support from the external SCADA system. Ask NMS Support for the knowledge article with complete configuration instructions.
[VCC#]
Marker
 
 
E.g., [VCC1]. Provides additional information for each VCC (Virtual Control Center).
AssociationAddress
Integer
<Required>
[1..MAX_INT]
RTP address in Live Energy Connect server for watching and controlling this VCCs association status
TransferSetAddress
Integer
<Required>
[1..MAX_INT]
RTP address in Live Energy Connect server for controlling the use of configured ICCP transfer sets
NumTransferSets
Integer
<Required>
[1..MAX_INT]
The total number of transfer sets that are available for use in the VCC. Number must be a multiple of 16.
AssociationName
String
Vcc Label
[a..z, A..Z, 0..9]
The name of the ICCP Association.
AssociationRestartTime
Integer
30
[1..MAX_INT]
Seconds allowed for restart before the association is considered failed.
TransferSetRestartPeriod
Integer
30
[1..MAX_INT]
Seconds allowed to restart transferset before the restart is considered failed and no additional restart attempts will be made.
TransferSetFailCountReset
Integer
60
[1..MAX_INT]
The number of fail count to be exhausted before marking the transfer set as not alive.
MaxTransferSetRestarts
Integer
10
[1..MAX_INT]
Maximum number of restart for transfer set.
TransferSetControlMask
String
<Required>
[T, F]
Transfer set control mask for the transfer set to be sent to Live Energy Connect server. One T/F flag for each TransferSet. String length must be a multiple of 16.
Example with one TransferSet enabled: "FTTTTTTTTTTTTTTT"
[ValidityQuality]
Marker
 
 
Assign an Oracle Utilities Network Management System quality to ICCP Validity Quality values
Valid
Integer
0
2**n (n=11->31)
The value is valid. This is the default (normal) value should virtually always be 0.
Held
Integer
0
2**n (n=11->31)
Previous data value has been held over. Interpretation is local.
Suspect
Integer
0
2**n (n=11->31)
Data value is questionable. Interpretation is local.
Notvalid
Integer
0
2**n (n=11->31)
The value is not valid.
[CurrentSourceQuality]
Marker
 
 
Assign an Oracle Utilities Network Management System quality to ICCP Current Source Quality values.
Telemetered
Integer
0
2**n (n=11->31)
Value was received from a telemetered site. This is the default (normal) value should virtually always be 0.
Calculated
Integer
0
2**n (n=11->31)
Value was calculated based on other data.
Entered
Integer
0
2**n (n=11->31)
Value was entered manually.
Estimated
Integer
0
2**n (n=11->31)
Value was estimated (State Estimator, etc.).
[NormalValueQuality]
Marker
 
 
Assign an Oracle Utilities Network Management System quality to ICCP Normal Value Quality values.
Normal
Integer
0
2**n (n=11->31)
The point value is that which has been configured as normal for the point. This is the default (normal) value should virtually always be 0.
Abnormal
Integer
0
2**n (n=11->31)
The point value is not that which has been configured as normal for the point.
[TimeStampQuality]
Marker
 
 
Assign an Oracle Utilities Network Management System quality to ICCP Timestamp Quality values
Valid
Integer
0
2**n (n=11->31)
Current value of the TimeStamp attribute contains the time stamp of when the value was last changed. This is the default (normal) value should virtually always be 0.
Invalid
Integer
0
2**n (n=1->31)
Current value of the TimeStamp attribute contains the time stamp other than when the value was last changed.
[SwitchStatusQuality]
Marker
 
 
Assign an Oracle Utilties Network Management System quality to the non-open/close statuses that can be returned in the two-bit ICCP status field. ICCP "open" is generally (1) and "closed" is (2).
Between
Integer
262144
2**n (n=11->31)
Quality code to set if the two bit ICCP switch status is reported as "between" (0).
Invalid
Integer
524288
2**n (n=11->31)
Quality code to set if the two bit ICCP switch status is reported as "invalid" (3).
 
Quality Codes
The IccpAdapter.prm file enables ICCP quality codes to be translated into Oracle Utilities Network Management System quality codes. In the simplest (and default) configuration, all of the ICCP quality codes (except the Between and Invalid SwitchStatusQuality codes, which need to be defined to ensure proper operation) are assigned to the 'normal' Oracle Utilities Network Management System quality code (0).
Note: Oracle Utilities Network Management System quality codes are always single bit values. Therefore, the only valid value for configuration is 0 or a proper value of 2^nth power where n=0->31. The Quality Rules Table table lists all the valid user-defined quality codes in Oracle Utilities Network Management System.
If none of the predefined quality codes are applicable, then a new code must be created. The following steps accomplish this:
• Choose an ICCP quality listed in the IccpAdapter.prm.
• Check the Quality Rules Table to see which values have already been assigned to qualities.
• Assign one of the values listed below to the ICCP quality and enter it in the Quality Rules Table.
• Locate the quality in the IccpAdapter.prm file and enter the assigned value for it.
The assigned value must be the decimal representation of 32 bits, where no more than one bit has a value of 1. For example, if the bit position is 16, use the number 65536. The following list contains the decimal values that may be assigned to new qualities: 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, 16777216, 33554432, 67108864, 134217728, 268435456, 536870912, 1073741824, 2147483648.
Values of 0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768 may not be assigned as codes for new qualities because they are already defined and used within Oracle Utilities Network Management System. The 'normal' Oracle Utilities Network Management System quality code is 0.
The adapter reads the IccpAdapter.prm file only during startup. If the quality code is added when the adapter is running, you must restart the adapter in order for it to recognize the new quality code.
High Level Messages
The ICCP Adapter accepts high level messages through the running IccpAdapter service. Use these messages to inspect its internal state, adjust diagnostics, or request that the active adapter relinquish control under the configured failover procedure. These requests do not replace the connection configuration in the adapter parameter file.
The common Service high level messages in the Configuration Guide also apply unless an adapter-specific handler overrides them. The entries below describe adapter-specific behavior and explicitly include inherited messages used in this chapter.
Send a request to the running service with:
Action any.IccpAdapter <command> [arguments]
Use the configured process name if it differs from IccpAdapter. The service target can contain a wildcard; select the intended service when changing state. Command names are normalized to lowercase; argument case follows the individual command. Output normally appears in the target service log. An acknowledgement can precede completion of the requested operation.
In the syntax below, angle brackets identify required values, square brackets identify optional values, and an ellipsis permits repetition. Enter values without the brackets and preserve the spelling and case shown.
Caution: Consult Oracle Support before first using diagnostic or maintenance commands, particularly in production. Commands can modify data, interrupt processing, or generate substantial output. Use sms-stop for routine service shutdown rather than the deprecated stop message.
IccpAdapter
debug <level|on|off> | debug <facility> <level>
Set global or registered-facility diagnostic output in the running ICCP adapter.
• debug on selects global level 1.
• debug off selects global level 0.
• debug <level> selects a nonnegative integer global level; higher levels produce more detail.
• debug <facility> <level> selects that facility's level.
Arguments: A valid value is required. Unlike the common Service no-argument toggle, this adapter rejects a debug request with no valid argument.
Examples:
Action any.IccpAdapter debug on
Action any.IccpAdapter debug 2
Action any.IccpAdapter debug off
demote
Demote the active ICCP adapter. The adapter rejects the request if it is not currently in control.
Use: Oracle Support diagnostics.
Caution: Changes which adapter controls the interface; use the configured failover procedure.
Only the adapter currently in control accepts the request. An instance not in control returns a negative/null response. Use the configured failover procedure and confirm which instance takes control afterward.
dump
Print adapter state to the service log.
Use: Oracle Support diagnostics.
report
Acknowledge an ICCP adapter status probe.
An acknowledged probe identifies a running matching adapter. Targeting a configured service name can locate its responding instances; the acknowledgement does not by itself prove that the Live Energy Connect association or data transfer is healthy.
Example: Action any.IccpAdapter report
stop
Request graceful adapter shutdown unless the disable-stop rule is configured.
Status: Deprecated.
Caution: Use the configured service shutdown procedure for routine operation.
The normal graceful-exit path disconnects the adapter from Live Energy Connect. If the disable-stop rule is set, the request is acknowledged but the adapter remains running; an acknowledgement therefore does not prove shutdown has completed.
Populating the NMS Measurements Tables
ICCP points must first be mapped to devices in the Oracle Utilities Network Management System model before sending SCADA updates to Oracle Utilities Network Management System. These ICCP points are placed in SCADA Measurements table of the Oracle Utilities Network Management System database. A process needs to be formalized to create and maintain this data. This process often depends on customer specific mechanisms used to maintain the SCADA side of the ICCP interface. As a result this process generally needs to be formalized by Live Energy Connect and the customer - potentially with help from NMS consulting.
Required NMS Data from Oracle Live Energy Connect
The following data items are required to be populated in the NMS measurements tables:
ICCP Name
• ICCP Name has to be unique.
• It is recommended for the name to be composed of alpha-numeric characters and underscore
• It is recommended for the first character of the ICCP Name to be a letter
• There should be no space, no periods and no dashes in the ICCP name.
ICCP Type
Below is a list of supported ICCP Types. Please take note of the underscore.
• Data_State
• Data_StateQ
• Data_StateQTimeTag
• Data_StateExtended
• Data_Real
• Data_RealQ
• Data_RealQTimeTag
• Data_RealExtended
• Data_Discrete
• Data_DiscreteQTimeTag
• Data_DiscreteExtended
Attribute
• The attribute should have a corresponding entry in the ATTRIBUTES table, specifically, in the NAME field in the Oracle Utilities Network Management System database. Take note that entries under the attributes column of the flat file needs to exactly match the entries in the NAME field of the ATTRIBUTES table, taking into consideration case sensitivity, underscores, etc.
NMSDeviceID
• This is the ID of the SCADA device. This ID should match a unique attribute or device name in NMS that will allow the measurement table population process to grab the appropriate NMS device handle (h_cls and h_idx) of the SCADA device. Tables that could be used in NMS to reference SCADA devices handles could be SCADA_POINTS, ALIAS_MAPPING, or a model managed device attribute table such as ATT_SWITCH.
Information Model - Database Schema
Quality Rules Table
This database table will define the quality codes that may be used for analog and digital values. This table defines the meaning of each bit in the quality codes for SCADA measurements.
Column Name
Data Type
Size
Description
Values
PRIORITY
NUMBER
 
Ranking priority of the quality code
Priority code, specifies relative importance of this quality bit over other quality bits
VALUE
NUMBER
 
Bit value used for the quality code change.
For Phase 1:
2048=No Data
4096=Old Data
STRING
VARCHAR2
10
Description of the quality code, which is displayed next to the value of the measurement when a quality exists for a measurement change.
The actual character string displayed next to the device when viewed via the Viewer
DESCRIPTION
VARCHAR2
128
Descriptive string
Any text string-usually the action taken from the SCADA Summary
COLOR
NUMBER
 
Designates which color is used in the Viewer to display the measurement when a particular quality bit is set.
Integer value for the color associated to the quality code change to be displayed
The integers are mapped to the pre-allocated colors documented in separate application file.
LOCATION
NUMBER
 
Location of symbol in relation to the device associated with the value.
only used if a symbol is defined for the quality code as opposed to just a color for a quality change
1-9; 5 overrides the device symbol
SYMBOL
NUMBER
 
The symbol used to display the value. only used if a symbol is defined for the quality code as opposed to just a color for a quality change
Valid Symbol Identification Number defined in <project>_SYMBOLS.sym. 0 if defining a text symbol.
OFF_NOMINAL
VARCHAR2
1
Whether or not the value is off-nominal
Y or N
IS_NMS
NUMBER
1
Indicates whether this rule is an internal NMS quality (1) or an external SCADA quality (0).
0 or 1
Note: If multiple bits in the quality code are set, then the color of the measurement text in the Viewer is determined by the color of the lowest order bit that is set in the quality code.
SCADA Measurements Table
The SCADA_MEASUREMENTS_ST table defines digital and analog measurements as used by Oracle Utilities Network Management System. It is a staging table used by DDService for populating the production SCADA measurements tables (ANALOG_MEASUREMENTS and DIGITAL_MEASUREMENTS).
The Oracle Utilities Network Management System ICCP Adapter communicates dynamic information to the Oracle Utilities Network Management System services. The services will cache measurements defined by this table. Population is dependent upon customer-supplied information.
 
Column Name
Data Type
Size
Description
Values
MEASUREMENT_TYPE
VARCHAR2
1
Measurement type code.
A (analog)
D (digital)
H_CLS
NUMBER
 
Class component of handle
Valid object class
H_IDX
NUMBER
 
Index component of handle
>0
PARTITION
NUMBER
 
Partition number, index component of partition handle
Valid partition or 0 for multi-partition objects
ATTRIBUTE
NUMBER
 
Attribute number which identifies measurement type
Valid attribute number
TTL
NUMBER
 
Time-To-Live Value.
LIMIT_GROUP_ID
NUMBER
 
Limit group ID
Customer defined
RTI_ALIAS
VARCHAR2
128
Alias to be used in communications between the Oracle Utilities Network Management System ICCP Adapter and Oracle Live Energy Connect server
Alphanumeric
SCADA_ID
NUMBER
 
SCADA host ID
0 (not a SCADA device), 1 (SCADA 1), 2 (SCADA 2)...
RTU_ID
VARCHAR2
32
SCADA RTU ID
String (optional)
QUALITY
NUMBER
 
Measurement internal NMS quality code
Bit mask of quality codes
VALUE
NUMBER
 
Measurement/entered value
Entered value
UPDATE_FLAG
NUMBER
 
Manual replace flag
1=true, 0=false
ICCP_OBJECT
VARCHAR2
32
ICCP Object type of the telemetered value
Alphanumeric
DISPLAY_ID
VARCHAR2
64
 
 
NORMAL_STATE
NUMBER
 
 
 
CONTROLLABLE
VARCHAR2
1
 
 
ACTIVE
VARCHAR2
1
Active flag for patch management, indicates whether the row is active within the model
Y (yes=active)
N (no=inactive)
A (local add=active)
D (local delete=inactive)
R (locally removed
dependent=inactive)
SOURCE
VARCHAR2
33
Source of the measurement.
any character string.
OFF_NOMINAL_TIME
DATE
 
When set, the time should be in the UTC time zone.
 
SCADA_QUALITY
NUMBER
 
Measurement external SCADA quality code.
Bit mask of quality codes
 
SCADA Controls Table
The SCADA_CONTROLS table defines control actions as used by Oracle Utilities Network Management System. Population is dependent upon customer-supplied information. Population of the scada_controls table is typically accomplished by first populating the scada_controls_st (staging table). The scada_controls_st staging table is populated via a product or project specific process. Once the staging table is populated running the UpdateDDS -recacheMeasures command, DDService will be asked to replace the run-time scada_controls table with the contents of the scada_controls_st staging table and reload any internal scada_controls caches.
 
Column Name
Data Type
Size
Description
Values
H_CLS
NUMBER
 
Class component of device handle.
Valid object class
H_IDX
NUMBER
 
Index component of device handle.
>0
NMS_ACTION
NUMBER
 
The Control Action ID number associated to the action.
Valid control action ID.
1 (OPEN),
2 (CLOSE)…
EXT_ACTION
NUMBER
 
Part of unique key to identify each external control action for a single device.
0..N, based on the number of control actions defined for the device.
ATTRIBUTE
NUMBER
 
If non-zero, attribute number which identifies measurement type.
0 (Ignore) or
Valid attribute number
RTI_ALIAS
VARCHAR2
128
Alias to be used in communications between the Oracle Utilities Network Management System ICCP Adapter and Oracle Live Energy Connect server.
Alphanumeric
TIMEOUT
NUMBER
 
SCADA timeout for this device.
0 = No Timeout,
>0 = timeout is seconds.
SCADA_ID
NUMBER
 
SCADA server ID.
0 (not a SCADA device),
1 (SCADA 1),
2 (SCADA 2)...
RTU_ID
VARCHAR2
64
SCADA RTU ID.
String (optional)
ACTIVE
VARCHAR2
1
Active flag for patch management; indicates whether the row is active within the model.
Y (yes=active),
N (no=inactive),
A (local add=active),
D (local delete=inactive),
R (locally removed,
dependent=inactive)
PARTITION
NUMBER
 
NMS partition number
numeric
FEEDER
VARCHAR2
100
Nominal Feeder (optional)
 
SUBSTATION
VARCHAR2
100
Nominal Substation (optional)
GANG
VARCHAR2
1
Is this a gang operated device (optional)
Y
N
 
Populating the NMS Measurements Tables
ICCP points must first be mapped to devices in the Oracle Utilities Network Management System model before sending SCADA updates to Oracle Utilities Network Management System. These ICCP points are placed in SCADA_MEASUREMENTS_ST table of the Oracle Utilities Network Management System database. A process needs to be formalized to create and maintain this data. This process often depends on customer specific mechanisms used to maintain the SCADA side of the ICCP interface.
Required NMS Data
The following data items are required to be populated in the NMS measurements tables:
 
ICCP Point Name
• ICCP Point Name has to be unique.
• It is recommended for the name to be composed of alpha-numeric characters and underscore
• It is recommended for the first character of the ICCP Name to be a letter
• There should be no space, no periods and no dashes in the ICCP name.
Attribute
• The attribute value connects a SCADA measurement to a specific device attribute in NMS. The attribute should have a corresponding entry in the ATTRIBUTES table.
SCADA ID
• SCADA system identifier. There should be a corresponding entry in the SCADA_IDS table.
NMS Device Handle
• The NMS Device Handle is the handle of the device in the NMS model associated with a particular ICCP Point. A single NMS device can have multiple ICCP points associated with it for different measurements that the SCADA system provides for the given device.
Measurement Type
• Each ICCP point represents either digital (including device status) or analog measurement.
ICCP Data Set
• The name of the data set this point is assigned to. Points assigned to the same data set share the same data transfer configuration (report by exception, integrity check, etc). There can be a limit on how many points can be assigned to a single data set. Consult your ICCP server documentation.
ICCP Data Type
• Each ICCP point has an associated data type. If data type is not specified for a point then the following defaults are used:
Device status - Data_StateExtended
Digital value - Data_DiscreteQ
Analog value - Data_RealQ
Information Model - Database Schema
Quality Rules Table
This database table will define the quality codes that may be used for analog and digital values. This table defines the meaning of each bit in the quality codes for SCADA measurements.
 
Column Name
Data Type
Size
Description
Values
PRIORITY
NUMBER
 
Ranking priority of the quality code
Priority code, specifies relative importance of this quality bit over other quality bits
VALUE
NUMBER
 
Bit value used for the quality code change.
For Phase 1:
2048=No Data
4096=Old Data
STRING
VARCHAR2
10
Description of the quality code, which is displayed next to the value of the measurement when a quality exists for a measurement change.
The actual character string displayed next to the device when viewed via the Viewer
DESCRIPTION
VARCHAR2
128
Descriptive string
Any text string-usually the action taken from the SCADA Summary
COLOR
NUMBER
 
Designates which color is used in the Viewer to display the measurement when a particular quality bit is set.
Integer value for the color associated to the quality code change to be displayed
The integers are mapped to the pre-allocated colors documented in separate application file.
LOCATION
NUMBER
 
Location of symbol in relation to the device associated with the value.
only used if a symbol is defined for the quality code as opposed to just a color for a quality change
1-9; 5 overrides the device symbol
SYMBOL
NUMBER
 
The symbol used to display the value. only used if a symbol is defined for the quality code as opposed to just a color for a quality change
Valid Symbol Identification Number defined in <project>_SYMBOLS.sym. 0 if defining a text symbol.
OFF_NOMINAL
VARCHAR2
1
Whether or not the value is off-nominal
Y or N
IS_NMS
NUMBER
1
Indicates whether this rule is an internal NMS quality (1) or an external SCADA quality (0).
0 or 1
 
Note: If multiple bits in the quality code are set, then the color of the measurement text in the Viewer is determined by the color of the lowest order bit that is set in the quality code.
SCADA Measurements Table
The SCADA_MEASUREMENTS_ST table defines digital and analog measurements as used by Oracle Utilities Network Management System. It is a staging table used by DDService for populating the production SCADA measurements tables (ANALOG_MEASUREMENTS and DIGITAL_MEASUREMENTS).
The Oracle Utilities Network Management System ICCP Adapter communicates dynamic information to the Oracle Utilities Network Management System services. The services will cache measurements defined by this table. Population is dependent upon customer-supplied information.
 
Column Name
Data Type
Size
Description
Values
MEASUREMENT_TYPE
VARCHAR2
1
Measurement type code.
A (analog)
D (digital)
H_CLS
NUMBER
 
Class component of handle
Valid object class
H_IDX
NUMBER
 
Index component of handle
>0
PARTITION
NUMBER
 
Partition number, index component of partition handle
Valid partition or 0 for multi-partition objects
ATTRIBUTE
NUMBER
 
Attribute number which identifies measurement type
Valid attribute number
TTL
NUMBER
 
Time-To-Live Value.
LIMIT_GROUP_ID
NUMBER
 
Limit group ID
Customer defined
RTI_ALIAS
VARCHAR2
128
ICCP Point Name
Alphanumeric
SCADA_ID
NUMBER
 
SCADA host ID
Foreign key into SCADA_IDS database table.
RTU_ID
VARCHAR2
32
SCADA RTU ID
String (optional)
QUALITY
NUMBER
 
Measurement internal NMS quality code
Bit mask of quality codes
VALUE
NUMBER
 
Measurement/entered value
Entered value
UPDATE_FLAG
NUMBER
 
Manual replace flag
1=true, 0=false
SCADA_QUALITY
NUMBER
 
Measurement external SCADA quality code
Bit mask of quality codes
ICCP_OBJECT
VARCHAR2
32
ICCP data type for this measurement
 
 
 
List of the supported ICCP data types:
• Data_Discrete
• Data_DiscreteQ
• Data_DiscreteQTimeTag
• Data_DiscreteExtended
• Data_Real
• Data_RealQ
• Data_RealQTimeTag
• Data_RealExtended
• Data_StateQ
• Data_StateQTimeTag
• Data_StateExtended
ICCP_DATA_SET
VARCHAR2
64
Name of the ICCP data set this measurement is assigned to.
String
DISPLAY_ID
VARCHAR2
64
 
 
NORMAL_STATE
NUMBER
 
 
 
CONTROLLABLE
VARCHAR2
1
 
 
ACTIVE
VARCHAR2
1
Active flag for patch management, indicates whether the row is active within the model
Y(yes=active), N(no=inactive),
A(local add=active),
D(local delete=inactive), R(locally removed, dependent=inactive)
SOURCE
VARCHAR2
33
Source of the measurement.
any character string.
OFF_NOMINAL_TIME
DATE
 
When set, the time should be in the UTC time zone.
 
 
 
SCADA_IDS
SCADA_IDS contains information about known SCADA systems that NMS is connected to.
Column Name
Data Type
Size
Description
Values
ID
NUMBER
 
SCADA system id
 
SCADA_NAME
VARCHAR2
32
SCADA system name
 
ADAPTER_TYPE
VARCHAR2
32
Adapter used to communicate with the SCADA system
MULTISPEAK (MultiSpeak SCADA Adapter)
RTADAPTER (Generic SCADA Adapter)
ICCP (ICCP Adapter)
ACTIVE
VARCHAR2
1
Active flag
Y - active
N - inactive