IVRAdapter Command Line Options
The section below lists the possible command line options for the Generic IVR Adapter. This section also introduces a tool that randomly creates trouble calls, along with its command line options. Performance tuning and high-level diagnostic messages that could be used on the Generic IVR Adapter will be discussed in this section as well.
The Generic IVR Adapter provides various command line options that enables Data Flows and configures Data Flow behavior. The following enumerates the command line options of the Generic IVR Adapter.
This section groups the Generic IVR Adapter command line options under the context of the Data Flow or Data Flows it is associated to.
Generic IVR Adapter Generic Command Line Options
The following are the Generic IVR Adapter command line options that are independent from any Data Flow:
|
|
|
|
|
Displays the available command line options
|
|
IVRAdapter -debug LEVEL(where LEVEL is 0, 1 or 2)
|
Runs gateway in debug mode. Associated number represents the debug level range from 0 to 2.
|
Trouble Call Data Flow Command Line Options
The following are the Generic IVR Adapter command line options that are related to the Trouble Calls Data Flow. For more information, see
Trouble Calls
.
|
|
|
|
|
|
|
Enables the Trouble Calls Data Flow.
Note : This option must be enabled for CC&B - NMS integration.
|
|
|
|
IVRAdapter -callperpoll NUMBERCALLS(where NUMBERCALLS is an integer)
|
Specifies the number of calls processed in the TROUBLE_CALLS table per poll of information.
|
|
100 calls per poll of information
|
|
IVRAdapter -pollperiod SECONDS(where SECONDS is an integer)
|
Specifies the interval (in seconds) between two successive polls or queries from the TROUBLE_CALLS table
|
|
a 6 second interval between two successive polls
|
|
|
If this option is selected, not all fields in the TROUBLE_CALLS table are directly fed to JMService. Instead, some of the fields would come from the CES_CUSTOMERS table.
Note : This option should not be used in combination with the CC&B - NMS integration.
|
|
|
Callback Requests Data Flow Command Line Options
The following are the Generic IVR Adapter command line options that are related to the Callback Requests Data Flow. For more information, see
Callback Requests
.
|
|
|
|
|
|
|
Enables the Callback Requests Data Flow
|
|
|
|
IVRAdapter -cbreqinterval SECONDS(where SECONDS is an integer)
|
Specifies the interval (in seconds) between two successive polls from the list of callback requests
|
|
a 5 second interval between two successive polls.
|
|
|
Callback is submitted to IVR if requested by the customer during any call.
|
|
|
|
|
Callback is submitted to IVR if requested by the customer during the last call.
|
|
|
Callback Responses Data Flow Command Line Options
The following are the Generic IVR Adapter command line options that are related to the Callback Responses Data Flow. For more information, see
Callback Responses
.
|
|
|
|
|
|
|
Enables the Callback Responses Data Flow
|
|
|
|
IVRAdapter -cbrespinterval SECONDS (where SECONDS is an integer)
|
Specifies the interval (in seconds) between two successive polls from the TROUBLE_CALLBACKS table for received callback responses
|
|
a 5 second interval between two successive polls.
|
Command Line Options Used by Multiple Data Flows
The following are the Generic IVR Adapter command line options that are related to multiple Data Flows. On the ‘Depends On’ section, the term ‘any option that enables a Data Flow’ would pertain to either one of the following command line options: ‘troublecall’, ‘omscbreq’ and ‘omscbresp’.
|
|
|
|
|
|
|
Could be used for any of the five Data Flows. A flag that allows the Generic IVR Adapter to remove some completed records from its tables.
|
any option that enables a Data Flow
|
|
|
IVRAdapter -cleaninterval HOURS(where HOURS is an integer)
|
Could be used for any of the five Data Flows.Specifies the interval (in HOURS) between two successive attempts to delete old (i.e., completed) records from the Oracle Utilities Network Management System Generic IVR Adapter tables.
|
Cleantable and any option that enables a Data Flow
|
1 hour between to successive delete attempts
|
|
IVRAdapter -keepdbinfo DAYS (where DAYS is an integer)
|
Could be used for any of the five Data Flows.Completed records on the Generic IVR Adapter tables older than the specified number of days will be deleted. Certain criteria apply on which records of the Oracle Utilities Network Management System Generic IVR Adapter tables are removed and how the records are aged.
|
Cleantable and any option that enables a Data Flow
|
|
|
IVRAdapter -cbagent AGENTNAME (where AGENTNAME is a string)
|
Could be used for the Callback Requests and Callback Responses Data Flows.
The agent name that the Generic IVR Adapter uses in retrieving calls from the callback list. Valid agent names are located in CES_USER and ENV_ACCESS tables. The agent name used should be an external agent, as indicated in the CES_USER table.
|
|
|
For the keepdbinfo command line options, a record that starts aging on a given day, say 9:00 p.m. would be considered one day old at 9:00 p.m. the next day (and not 12:00 a.m., which is just 3 hours from the time the record started aging).
troubleCallCreate Tool Command Line Options
Random trouble calls could be created and passed to the Generic IVR Adapter using the troubleCallCreate tool. The troubleCallCreate tool inserts entries to the TROUBLE_CALLS table. From here, the Generic IVR Adapter (through the Trouble Calls Data Flow) could fetch the new records from this table and pass this information to Oracle Utilities Network Management System, so Oracle Utilities Network Management System could apply the outage analysis algorithm to predict the outage device.
Note : It is important for the Generic IVR Adapter System Variables to be setup to run the troubleCallCreate tool. For more information, see Setup the Generic IVR Adapter System Variables.
The following are the command line options for the troubleCallCreate tool:
|
|
|
|
|
|
Displays the available command line options
|
|
|
|
Runs this tool in debug mode, defaulting the debug level to 2.
|
Defaults to debug level 2
|
|
troubleCallCreate -totalcalls NUMBEROFCALLS
(where NUMBEROFCALLS is an integer)
|
Specifies the number of trouble calls to be created
|
|
|
troubleCallCreate -troublecall
|
|
|
troubleCallCreate tool on testing Trouble Calls Data Flow
As the troubleCallCreate tool randomly creates trouble calls, this tool could be used to test the Trouble Calls Data Flow. For more information about this Data Flow, see
Trouble Calls
.
The troubleCallCreate tool uses the CES_CUSTOMERS table to retrieve some customer information that would be used as entries in the TROUBLE_CALLS table. The tool always begins querying the CES_CUSTOMERS table starting from the first row, each time it is invoked.
When multiple trouble calls would be created (using the ‘totalcalls’ command line option), the troubleCallCreate tool would place a different permutation of trouble code bits for each trouble call in the TROUBLE_CALLS table.
After running the troubleCallCreate tool, the results could be verified using the following database tables:
•
|
The TR OUBLE_CALLS table is populated with a new trouble call record (or with a certain number of trouble calls, assuming that the ‘totalcalls’ command line option was used).
|
•
|
As the Generic IVR Adapter runs (using the Trouble Calls Data Flow), the INCIDENTS table is populated with new records.
|
Note: The number of new records in the INCIDENTS table is less than or equal to the total number of new trouble calls in the TROUBLE_CALLS table, as Oracle Utilities Network Management System outage analysis algorithms allow grouping of calls based on various criteria.
troubleCallCreate tool on testing Callback Requests Data Flow
The Callback Requests Data Flow could be tested as well using the troubleCallCreate tool, since all trouble calls generated by such tool requires callback. For more information about this Data Flow, see
Data Flow Details
.
•
|
For a generated trouble call, if part of the trouble code is described to be 'Power On', no record in the TROUBLE_CALLBACKS table will be generated even if the event is restored.
|