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 $CES_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
The command line for the ICCP Adapter provides the following options:
IccpAdapter.prm
The IccpAdapter.prm file is used to configure the operation of the Oracle Utilities Network Management System ICCP Adapter. The default location for this file is the same as where the IccpAdapter binary is located ( i.e., $CES_HOME/bin) but it is generally configured to be in a different location by using the -prm_path <IccpAdapter.prm path> command line option. Lines in this file beginning with a ";" (semi-colon) are comments. Lines beginning with a "[" (left bracket) are block identifiers (markers). Fields marked as <Required> must be configured for proper operation and are generally site specific. See the IccpAdapter.prm.template file in the standard $CES_HOME/templates directory for an example IccpAdapter configuration file.
Fields in the IccpAdapter.prm File
Sample IccpAdapter.prm Configuration File
[IccpAdapter]
Period=5
ScadaId=1
Analogs=0
AnalogTolerance=.0001
Digitals=1
Controls=0
Port=5002
QualityCodeUseOnAssociationTimeOut=16384
Vccs=1
DisableCOV=0
[VCC1]
AssociationAddress=10
TransferSetAddress=20
NumTransferSets=16
[ValidityQuality]
Valid=
Held=
Suspect=
Notvalid=1048576
[CurrentSourceQuality]
Telemetered=
Calculated=
Entered=
Estimated=2097152
[NormalValueQuality]
Normal=
Abnormal=
[TimeStampQuality]
Valid=
Invalid=
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:
Check the Quality Rules Table to see which values have already been assigned to qualities.
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 11, use the number 2048. The following list contains the decimal values that may be assigned to new qualities: 2048, 4096, 8192, 16384, 32768, 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 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 can be dynamically controlled from Oracle Utilities Network Management System by using high-level messages. They can be used any time while running the Oracle Utilities Network Management System ICCP Adapter. The following high-level messages can be used:
Disconnect from the LiveData Server and stop the Oracle Utilities Network Management System ICCP Adapter.
Empty message to determine how many Oracle Utilities Network Management System ICCP Adapters are running.
Turn on/off debug, or set it to a specific level. On is equivalent to 1, off is 0. Level can be any integer value no less than 0.
Turn facility specific debug on/off. For example, to turn IA_RTP debug on to level 3:
Action any.IccpAdapter debug IA_RTP 3
To turn off:
Action any.IccpAdapter debug IA_RTP 0
Check ICCP Adapter specific log file for other facilities specific to this adapter process.
Causes the Oracle Utilities Network Management System ICCP Adapter currently in control to relinquish control.
Use IccpAdapterService with high-level messages for the Oracle Utilities Network Management System ICCP Adapter. For example:
Action any.IccpAdapter report