AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Overview 11-1 Using the ADAP Command Line Language 11 Overview This chapter describes how to use the ADAP command line language. It tells you: ■ How to log into or out of the voice mail system from your PC. ■ How to use ADAP commands to retrieve data directly from the ADAP-supported voice mail screens.
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Logging Into the Voice Mail System 11-2 Logging Into the Voice Mail System To use ADAP commands, you must first log into the voice mail system from your PC. You can login from the MS-DOS prompt C>, from an MS-DOS batch file, or from within an application program.
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Logging Into the Voice Mail System 11-3 -I Modem initialization string flag; must be followed by modem initialization string. modem initialization string Specifies an initialization string to be sent to the modem before connection to the voice mail system is attempted. The default is a null string. -i Causes the system to bypass the search for the data set ready (DSR) signal.
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Logging Into the Voice Mail System 11-4 loginID Identifies your voice mail system login ID. password Identifies your voice mail system login password. phone number Identifies the voice mail system phone number. This number is not required for direct cable configurations. If you have a Hayes-compatible or AT&T 4000 modem, enter t in front of the phone number for touch-tone dialing.
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Logging Into the Voice Mail System 11-5 The -I feature is intended to send initialization strings to Hayes and Hayescompatible modems. However, you can use the -I option to send a startup string to any local connection-establishing device, such as a PDM or modem, that returns the string "OK" to the computer upon processing and acting on a valid string.
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Logging Into the Voice Mail System 11-6 communications port Specifies that the communications port is either 1 or 2. If no port is specified, port 1 is the default. -i Directs the system to bypass the search for the data set ready (DSR) signal. Use this option only with Hayes-compatible modems. -V Writes the ADAP version number for this command and exits without logging in.
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Logging Into the Voice Mail System 11-7 After you run the login command, perform the following steps: 1. Use one of the following procedures, depending on your PC configuration: Hayes or AT&T 4000 modem connection: a. Type atdt b. Enter the phone number of the voice mail machine administration port. MPDM connection: a. Press F1 (Break). b.
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Logging Out of the Voice Mail System 11-8 8. If this message does not appear, press Ctrl-d to log out of an R1 AUDIX system; then go back to step 1 and log in again. On a DEFINITY AUDIX or INTUITY system, press Ctrl-c to exit the login command. Then re-enter the login command and go back to step 1 to log in again. Otherwise, go on to the next step. 9. Press ESC .
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Command Line Commands 11-9 Command Format Database retrieval and modification commands are associated with specific voice mail system administrative and maintenance screens that are supported by ADAP. Each command option begins with a dash, followed immediately by a one-letter option identifier. If the option requires an argument, the argument immediately follows the option letter.
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Command Line Commands -r 11-10 Release number flag. Must be followed by the release number, which identifies the version of the DEFINITY AUDIX system (D-r3.2, D-r3.1, D-r3.0, D-r2.0, or D-r1.0), the R1 AUDIX system (r1v8, r1v7, r1v6, r1v5, r1v4_5, r1v4, r1v3, r1v2), or the INTUITY AUDIX system (I-r5.0, I-r4.0, I-r3.3, I-r3.2, or I-r2.0) with which it is communicating.
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Command Line Commands 11-11 You do this in a manner similar to the above. Prior to executing retrieval and modify commands, set the AUDIX_RELEASE environment variable to the release value you want by entering one of the commands listed below: set AUDIX_RELEASE=I-r2.0 set AUDIX_RELEASE=I-r3.2 set AUDIX_RELEASE=I-r3.3 set AUDIX RELEASE=I-r4.
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Command Line Commands 11-12 DEFINITY and INTUITY AUDIX Systems R1 AUDIX Systems Total number of bytes sent Number of screens received Number of packets sent Effective character reception rate in bits per second (b/s) Number of packets received Elapsed time of the full data transmission Number of damaged packets received Number of time-outs waiting for packets Number of packets
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Command Line Commands 11-13 All records consist of fields joined by field separators and terminated with a NEWLINE character. Each table row describes the following field characteristic: Seq. No. Sequence of the fields within the record. Field Name Identifies the field. Type Identifies field type: character, numeric, date, time, digit sequence, and logical. Max.
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Command Line Commands 11-14 Field Types There are six field types used in the ADAP command line input and output records. C (Character) Set of characters enclosed by delimiters. The default delimiter is the double quote ("). Any character (alphabetic, numeric, special character, or blank) may be in the string.
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Command Line Commands 11-15 T (Time) 4-digit time of day presented in military format hhmm. A time field does not contain a colon (:) to separate the hours and minutes. Midnight is represented by 0000. K (Digit Sequence) Contains a string of digits, possible values 0 through 9, enclosed in delimiters.
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Command Line Commands 11-16 The open ended set, is shown by a release number followed by a plus (+) sign. This means that the particular field is valid input or output for the designated release and any later, newer releases. An example of an open ended set is the r1v4_5+ designation appearing in the "machine type" field row of the record layout table above.
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Command Line Commands 11-17 NOTE: When constructing input records for ADAP commands, all fields, regardless of type, must be enclosed in double quotation marks and separated by commas. The records must be terminated with a NEWLINE. These rules hold true whether the input is redirected from a file or entered interactively from the keyboard though the use of the -i option.
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Command Line Commands 11-18 Redirecting Input from Files Once you have constructed an input file, you can use it to retrieve data. For example, if you wanted to retrieve records for all subscribers on the voice mail system, using an input file called dir.dat, you could enter the following command. getsub < dir.dat > sub.
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Command Line Commands 11-19 Delimiters You can change the output character string delimiter from double quotes (") to a delimiter of your choice. To change the delimiter, set an environment variable named DLIM to the character you want to use as the delimiter. For example, enter the following command at the DOS prompt or in the autoexec.bat file.
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Command Line Commands 11-20 The placeholding value is a zero for numeric fields that have been deleted. For deleted character, digit sequence or logical fields, the placeholding value is an empty string enclosed in a set of delimiters (which by default is "").
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Command Line Commands 11-21 The file subscr.dat is in the delimited format. It can be read from within dBASE III PLUS at the dBASE dot prompt or from a dBASE III PLUS program. From the dBASE dot prompt, you would type the following: use sub.dbf This command causes dBASE III PLUS to use the database structure relevant for the getsub data.
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Data Retrieval Commands 11-22 Data Retrieval Commands Database retrieval commands obtain a copy of data from the voice mail system internal database. The following table lists the voice mail system screens that are supported and the corresponding retrieval command. Table 11-1.
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Data Retrieval Commands Table 11-1.
AUDIX Administration and Data Acquisition Package 585-302-502 Issue 17 May 2002 11 Using the ADAP Command Line Language Database Modification Commands 11-24 Database Modification Commands You use database modification commands to modify certain data directly in the voice mail database. The following table provides you with the name of each modification command, its purpose, and the voice mail system software versions for which the commands can be used.
