Command Line Option | What it does |
-debug <level> | Sets the level of debug messages generated by the adapter. <level> is a positive number, or zero. The higher the number, the more information is displayed. If <level> is omitted, it defaults to a value of 0. Debug facilities can also be specified on the command line; for example: -debug IA_RTP 3 could be used to specifiy level 3 debug for the IA_RTP debug facility. |
-prm_path <IccpAdapter.prm path> | Sets the path of the IccpAdapter.prm parameter file location. This file is used to configure the operation of the ICCP adapter. |
-help | Returns the available IccpAdapter startup parameters and definitions, then terminates. |
-prm_file | Full path and configuration file name. Used to support multiple IccpAdapter instances for a given NMS instance. |
Field name | Type | Default | Valid Values | Description |
---|---|---|---|---|
[IccpAdapter] | Marker | Used for generic configuration of program. | ||
ServerHostname | IP address List – blank 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 |
[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). |
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 | 3 | 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 |
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 | Setting for displaying measurement value in the Viewer or not. | 1 or 0. 1=yes | |
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 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 |
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 |
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 | 3 | 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 |
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 | Setting for displaying measurement value in the Viewer or not. | 1 or 0. 1=yes | |
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 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 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 |
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 |