SRS Rules Configuration
The following are SRS rules that could be used with the Generic IVR Adapter. These SRS rules can be included in the <project>_srs_rules.sql file.
Map Customer-Defined Fields in the INCIDENTS Table
Oracle Utilities Network Management System and the Generic IVR Adapter provides a mechanism to receive additional trouble call information from the external application and have this information stored in a new customer-defined field in the INCIDENTS table of Oracle Utilities Network Management System.
The configurable TROUBLE_CALLS column name has special names '201', '202', up to '209' to serve this purpose. Normally, a regular column name in TROUBLE_CALLS like CALL_COMMENT or COMMENT in JMS Input String is tied to a specific field of the INCIDENTS table by default. For this case, it's the OP_COMMENT field. A special name like '201' could be mapped to a new field in the INCIDENTS table by using an SRS rule. The table below details how an SRS rule could be used to do this mapping. An SRS rule like this has to be used for each mapping. See Map Customer-Defined Fields in the INCIDENTS Table for more information.
Field Name
Value
SET_NAME
'config_incident'
INCIDENT_TYPE
'customer_defined'
RULE_NAME
the name of the new column in the INCIDENTS table
RULE_VALUE_1
'str', 'date', 'int', 'float'
'str' is for strings, 'date' is for dates, 'int' is for integers, and 'float' is for floats. This represents the data type of the new column.
RULE_VALUE_2
An integer, representing the value of the SRS input configuration item specifying this field -- must have a value of 200 or greater
RULE_VALUE_INTEGER_1
0 (not used)
RULE_VALUE_INTEGER_2
0 (not used)
RULE_VALUE_INTEGER_3
0 (not used)
RULE_VALUE_INTEGER_4
0 (not used)
RULE_VALUE_INTEGER_5
0 (not used)
callbackInterfaceEnabled SRS Rule
If set to 'yes' then SRS APIs for manipulating callback information will become available. It has to be set to 'yes' for Web Callback GUI to operate. This rule holds outage information in JMService memory on a special data structure until this time expires OR all customer callbacks for the outage are complete.
Field Name
Value
SET_NAME
'config'
INCIDENT_TYPE
'any'
RULE_VALUE_1
'yes' or 'no' (default: 'no')
RULE_VALUE_2
0 (not used)
RULE_VALUE_INTEGER_1
0 (not used)
RULE_VALUE_INTEGER_2
0 (not used)
RULE_VALUE_INTEGER_3
0 (not used)
RULE_VALUE_INTEGER_4
0 (not used)
RULE_VALUE_INTEGER_5
0 (not used)
useExternalCause SRS Rule
If set to 'yes' then the IVR Adapter's callback requests data flow will include the cause code when it populates the TROUBLE_CALLBACKS table. The cause code value will be taken from JOBS.CAUSE.
Field Name
Value
SET_NAME
'config'
INCIDENT_TYPE
'any'
RULE_VALUE_1
'yes' or 'no' (default: 'yes')
RULE_VALUE_2
0 (not used)
RULE_VALUE_INTEGER_1
0 (not used)
RULE_VALUE_INTEGER_2
0 (not used)
RULE_VALUE_INTEGER_3
0 (not used)
RULE_VALUE_INTEGER_4
0 (not used)
RULE_VALUE_INTEGER_5
0 (not used)
customerPhoneParentheses SRS Rule
If rule_value_1 set to 'yes', parentheses will be added to customer call phone numbers in the following format: (AREA)NUMBER. Otherwise, the number and area will be concatenated together without parentheses.
Field Name
Value
SET_NAME
'config'
INCIDENT_TYPE
'any'
RULE_VALUE_1
'yes' or 'no' (Default: 'yes')
RULE_VALUE_2
0 (not used)
RULE_VALUE_INTEGER_1
0 (not used)
RULE_VALUE_INTEGER_2
0 (not used)
RULE_VALUE_INTEGER_3
0 (not used)
RULE_VALUE_INTEGER_4
0 (not used)
RULE_VALUE_INTEGER_5
0 (not used)
defaultCallbackAgent SRS Rule
Specifies username of the default callback agent. All new callbacks will be automatically assigned to this agent. If this rule is not set then new callbacks will be left unassigned.
Note: This rule only takes effect if the rule callbackInterfaceEnabled set to 'yes'. See callbackInterfaceEnabled SRS Rule for more information. The agent name used should be considered as an external agent in the CES_USER table and should have access to the 'WCB' product per the ENV_ACCESS table. If new callbacks should be automatically assigned to the Generic IVR Adapter, then this rule should match the '-cbagent' command-line option of the Generic IVR Adapter.
Field Name
Value
SET_NAME
'config'
INCIDENT_TYPE
'any'
RULE_VALUE_1
callback agent username
RULE_VALUE_2
0 (not used)
RULE_VALUE_INTEGER_1
0 (not used)
RULE_VALUE_INTEGER_2
0 (not used)
RULE_VALUE_INTEGER_3
0 (not used)
RULE_VALUE_INTEGER_4
0 (not used)
RULE_VALUE_INTEGER_5
0 (not used)
callbackFeederTimeout SRS Rule
The maximum time allowed (in minutes) between the current time and the restoration time of a resolution in callback module before the resolution is deemed too old to remain or be loaded into the callback module. This rule holds outage info in JMService memory in a special data structure until this time expires OR all customer callbacks for the outage are complete.
If this rule is set to 0 then resolutions will be kept in JMService until all callbacks are completed.
Note: This rule must be used in conjunction with the callbackInterfaceEnabled SRS Rule.
Field Name
Value
INCIDENT_TYPE
'flowControlGeneral'
RULE_VALUE_1
"" (not used)
RULE_VALUE_2
An integer, representing a number of minutes (Default: 2880 -- 48 hours)
RULE_VALUE_INTEGER_1
0 (not used)
RULE_VALUE_INTEGER_2
0 (not used)
RULE_VALUE_INTEGER_3
0 (not used)
RULE_VALUE_INTEGER_4
0 (not used)
RULE_VALUE_INTEGER_5
0 (not used)
streetXsectionOffset SRS Rule
Specifies the size of the maximum bounding rectangle to be used in grouping street intersection fuzzy calls to supply nodes. The rectangle will be the area where:
x E [xsection_x - THIS RULE VALUE, xsection_x + THIS RULE VALUE]
and
y E [xsection_y - THIS RULE VALUE, xsection_y + THIS RULE VALUE]
This is an integer. Check your world coordinate system for a reasonable integer value.
This rule is used once for each rectangle desired (multiple instances of this rule may exist in a single rule set). For example, a larger rectangle size may be desired in a rural control zone and a smaller rectangle in an urban control zone.
Field Name
Value
RULE_VALUE_1
'' (not used)
RULE_VALUE_2
integer (Default: none)
RULE_VALUE_INTEGER_1
0 (not used)
RULE_VALUE_INTEGER_2
0 (not used)
RULE_VALUE_INTEGER_3
0 (not used)
RULE_VALUE_INTEGER_4
0 (not used)
RULE_VALUE_INTEGER_5
0 (not used)
NCG_CLS
integer, representing ncg_cls of desired applicable control zone level
NCG_IDX
integer, representing ncg_idx of desired applicable control zone level
Generic IVR Adapter Trouble Call Performance
The maximum rate at which the Generic IVR Adapter injects trouble calls into the Oracle Utilities Network Management System is initially determined using the –callperpoll and –pollperiod command line parameters in the system.dat file. If these parameters are not set, the Generic IVR Adapter will, by default, retrieve a maximum of 100 trouble calls from the TROUBLE_CALLS table every six seconds and send these calls into the MMM via JMService. This corresponds to a maximum hourly call rate of 60,000 calls per hour.
If it is necessary to change this call rate while the adapter is running, two scripts are provided: ivrCallPerPoll and ivrPollPeriod. These scripts may be used to adjust the number of calls retrieved during each poll cycle and the period between poll cycles while the adapter is running.
Note: If the adapter is restarted, these parameters (and the corresponding call rate) will revert to the command line parameters specified in the system.dat file (or the default values if no command line options are specified).
 
Command
Usage
Description
ivrCallPerPoll
ivrCallPerPoll NUM_CALLS_PER_POLL
Changes the number of calls retrieved from the TROUBLE_CALLS table during one poll cycle.
 
ivrPollPeriod
ivrPollPeriod NUM_SECONDS
Changes the period between poll cycles where calls are retrieved from the TROUBLE_CALLS table and submitted to JMService.
 
 
Generic IVR Adapter Troubleshooting
IVRAdapter High Level Messages
The Generic IVR Adapter accepts high level messages to adjust trouble-call polling and completed-record cleanup while IVRAdapter is running. Configure the adapter as an NMS system service before using these requests. Startup options that enable individual data flows are documented separately.
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.IVRAdapter <command> [arguments]
Use the configured process name if it differs from IVRAdapter. 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.
The examples use IVRAdapter; deployments configured with the historical process name IVRGateway must target any.IVRGateway instead. Use the actual name registered by the running service.
IVRAdapter
callperpoll <count>
Set the maximum trouble calls processed per poll to a positive integer.
Applies to: The running trouble-call flow enabled by -troublecall; does not enable that flow. A zero or negative converted value leaves the previous count unchanged, although the request is acknowledged. This runtime change does not edit system.dat.
Example: Action any.IVRAdapter callperpoll 100
cleantable
Toggle periodic IVR table-cleaning processing.
Use: Oracle Support diagnostics.
Caution: Enables or disables cleanup of interface table data.
The command takes no argument: each request reverses the current cleanup-enabled flag. Cleanup uses the startup retention and interval settings (-keepdbinfo and -cleaninterval) and the completion criteria described in the command-line reference. It does not immediately delete every interface-table record.
Example: Action any.IVRAdapter cleantable
debug [<level> | <facility> <level> ...]
Use the inherited Service debug handler to set the global level or a registered facility's level. A numeric level of 0 reduces global diagnostic output; higher levels produce more detail. Without arguments, the common handler toggles global debugging. IVR troubleshooting commonly uses levels 0, 1, and 2.
Example: Action any.IVRAdapter debug 2
pollperiod <seconds>
Set the trouble-call polling interval to a positive number of seconds.
Applies to: The running trouble-call flow enabled by -troublecall; does not enable that flow. A zero or negative converted value leaves the previous interval unchanged, although the request is acknowledged. This runtime change does not edit system.dat.
Example: Action any.IVRAdapter pollperiod 6
report
Probe for a running adapter using the inherited Service status message. A responding process acknowledges the request; this is a reachability/startup check rather than a detailed data-flow or database health report.
Example: Action any.IVRAdapter report
stop
Stop IVR interface processing and exit.
Status: Deprecated.
Caution: Use the configured service shutdown procedure for routine operation.
Note: It is important that the Generic IVR Adapter is already included in the System Data file to run high-level messages properly. For more information, see Configure Adapter to run as NMS System Service.