Configuring the Adapter to Run as a System Service
Configure the TMW
ICCP Adapter by updating the
$NMS_HOME/etc/system.dat file to include the TMW 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 TMW ICCP Adapter. Search for
Tase2Adapter and make sure those lines are uncommented. You must restart the system services in order for the TMW ICCP Adapter to be properly monitored by SMService.
Below is an example of the program section in the system.dat file:
program Tase2Adapter Tase2Adapter -prm_file /users/nms1/etc/Tase2Adapter.prm
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 TMW ICCP Adapter
The command line for the TMW ICCP Adapter provides the following options:
|
|
|
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:
could be used to specify level 3 debug for the IA_ICCP debug facility.
|
-prm_file <full path to configuration file>
|
Sets the path to the file used to configure the operation of the TMW ICCP Adapter.
|
The Tase2Adapter.prm file is used to configure the operation of the Oracle Utilities Network Management System TMW ICCP Adapter. The default location for this file is the same as where the Tase2Adapter binary is located (
i.e.,
$CES_HOME/bin) but it is generally configured to be in a different location by using the
-prm_file <Tase2Adapter.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 Tase2Adapter.prm.template file in the standard
$CES_HOME/templates directory for an example
Tase2Adapter configuration file.
Fields in the Tase2Adapter.prm File
|
|
|
|
|
|
|
|
|
Used for generic configuration of program.
|
|
|
|
|
The IP address(es) of the TMW ICCP server to connect to. It could be a blank separated list of IP address of several ICCP servers. In case a failure of connection was detected by the TMW ICCP Adapter with the current ICCP server, it will traverse the ServerHostname list for the next ICCP server to connect to.
|
|
|
|
|
Time in seconds between periodic transfers of non-time critical data.
|
|
|
|
|
The maximum number of status updates to be sent to DDService at one time.
|
|
|
|
|
Identification number assigned to the SCADA in Oracle Utilities Network Management System with which the TMW ICCP Adapter is communicating. It should match an existing record in SCADA_IDS database table.
|
|
|
|
|
Dead band for analog value updates. It is the required percent change from the last reported value to trigger an update.
|
|
|
|
|
Boolean value indicating use of the ANALOG_MEASUREMENTS table.
|
|
|
|
|
Boolean value indicating use of the DIGITAL_MEASUREMENTS table.
|
|
|
|
|
Configurable duration of delay to wait after the ICCP server instances failed in succession.
|
|
|
|
|
Boolean value indicating use of the controls table for Block 5 functionality.
|
QualityCodeUseOnAssociationTimeOut
|
|
|
|
Quality code that will be sent to DDService when the communication with ICCP server is lost. A valid QualityCode must be specified if this option is used.
|
|
|
|
|
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.
|
|
|
|
|
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.
|
IgnoreCritInterSysServFail
|
|
|
|
Normally the adapter will stop if SMSserivce reports a critical service failure and not restart until services are recovered. This option disables this feature.
|
|
|
|
|
This parameter sets the quality codes that prevent switches from being operated. There is no effect on non-switch statuses.
|
|
|
|
|
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.]
|
|
|
|
|
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.
|
|
|
|
|
Timeout setting for the connection to the ICCP server.
|
|
|
|
|
ICCP Domain (VCC) Configuration.
|
|
|
|
|
OSI Transport Service Access Point (TSAP) Selector of the ICCP server.
|
|
|
|
|
OSI Session Service Access Point (SSAP) Selector of the ICCP server.
|
|
|
|
|
OSI Presentation Service Access Point (PSAP) Selector of the ICCP server.
|
|
|
|
|
Application Process Title of the ICCP server.
|
|
|
|
|
|
|
|
|
|
Comma-separated list of ICCP Data Transfer Sets.
|
|
|
|
|
OSI Transport Service Access Point (TSAP) Selector of the TMW ICCP Adapter.
|
|
|
|
|
OSI Session Service Access Point (SSAP) Selector of the TMW ICCP Adapter.
|
|
|
|
|
OSI Presentation Service Access Point (PSAP) Selector of the TMW ICCP Adapter.
|
|
|
|
|
Application Process Title of the TMW ICCP Adapter.
|
|
|
|
|
Assign an Oracle Utilities Network Management System quality to ICCP Validity Quality values
|
|
|
|
|
The value is valid. This is the default (normal) value should virtually always be 0.
|
|
|
|
|
Previous data value has been held over. Interpretation is local.
|
|
|
|
|
Data value is questionable. Interpretation is local.
|
|
|
|
|
|
|
|
|
|
Assign an Oracle Utilities Network Management System quality to ICCP Current Source Quality values.
|
|
|
|
|
Value was received from a telemetered site. This is the default (normal) value should virtually always be 0.
|
|
|
|
|
Value was calculated based on other data.
|
|
|
|
|
Value was entered manually.
|
|
|
|
|
Value was estimated (State Estimator, etc.).
|
|
|
|
|
Assign an Oracle Utilities Network Management System quality to ICCP Normal Value Quality values.
|
|
|
|
|
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.
|
|
|
|
|
The point value is not that which has been configured as normal for the point.
|
|
|
|
|
Assign an Oracle Utilities Network Management System quality to ICCP Timestamp Quality values
|
|
|
|
|
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.
|
|
|
|
|
Current value of the TimeStamp attribute contains the time stamp other than when the value was last changed.
|
|
|
|
|
Assign an Oracle Utilities 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).
|
|
|
|
|
Quality code to set if the two bit ICCP switch status is reported as "between" (0).
|
|
|
|
|
Quality code to set if the two bit ICCP switch status is reported as "invalid" (3).
|
Sample Tase2Adapter.prm Configuration File
ServerHostname=128.168.148.43
QualityCodeUseOnAssociationTimeOut=16384
TransferSets=DSTrans1,DSTrans2
The Tase2Adapter.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 Tase2Adapter.prm.
|
•
|
Assign one of the values listed below to the ICCP quality and enter it in the
Quality Rules Table
.
|
•
|
Locate the quality in the Tase2Adapter.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 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 Tase2Adapter.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.
The TMW 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 TMW ICCP Adapter. The following high-level messages can be used:
Disconnect from the ICCP server and stop the Oracle Utilities Network Management System TMW ICCP Adapter.
Empty message to determine how many Oracle Utilities Network Management System TMW 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_ICCP debug on to level 3:
Action any.Tase2Adapter debug IA_ICCP 3
Action any.Tase2Adapter debug IA_ICCP 0
Check TMW ICCP Adapter specific log file for other facilities specific to this adapter process.