17. Command Reference Guide
17.1. Command Mode Access
When the NLJ is properly installed and configured, command mode can be accessed by a local PC connected directly to the Console Port, by a remote PC that communicates via modem, or via TCP/IP network.
Notes:
- If the Site I.D. Message (System Parameters Menu, Item 4) has been defined, the Site I.D. will be displayed before the "PollCat-NetLink" prompt.
- When the Supervisor Password is entered, the NLJ will start in Supervisor Mode, allowing access to all menu functions. When a User password is entered, the NLJ will start in User Mode, which allows limited access to menu functions.
- The Default Supervisor Mode Password is SUPER, and the default User Mode Password is SMDR.
Remote Access (via Modem): Start your communications program and dial the NLJ unit.
The unit will respond with the "PollCat-NetLink" (password) prompt after the carrier is detected.
Key in a valid password and press [Enter]. Note that the Password feature is case-sensitive.
The Main Menu or the "Ready" prompt will be displayed. If the "Ready" prompt is displayed, press [Enter] to display the NLJ Main Menu.
Local Access (Console Port): Start your communications program.
If Set-Up Switch 7 is UP (Enable Console Port Password), the "PollCat-NetLink" (password) prompt will be displayed.
Key in a valid password and press [Enter]. Note that the Password feature is case-sensitive.
The Main Menu or the "Ready" prompt will be displayed. If the "Ready" prompt is displayed, press [Enter] to display the NLJ Main Menu.
Access via TCP/IP Network: If network parameters for the NLJ unit have been assigned (see Section 4.4.4), establish a telnet session using the following format:
telnet ipaddress [port] [Enter]
Where:
|
ipaddress |
The NLJ's assigned IP Address. |
|
port |
(Optional) The
desired Port Number. If this item is omitted, telnet will connect to
port #23 by default; Command Echo will be set according to the NLJ's
current configuration, and $FF Stuffing will be enabled. Options:
2001 Behaves the same as Port #23. 3001 Preconfigured with echo enabled and $FF Stuffing Off. |
Note: For more telnet port number options, please refer to Section 16.
If the password is enabled, the "PollCat-NetLink" (password) prompt will appear.
Key in a valid password and press [Enter]. Note that the Password feature is case-sensitive.
After a brief pause, the Main Menu or the "Ready" prompt will appear. If the "Ready" prompt is displayed, press [Enter] to display the NLJ Main Menu.
To end a session, disconnect using your Telnet software.
17.2. Command Syntax
Most commands conform to the following conventions:
17.3. Command Help
To display the Command Help screen shown in Figure 17.1, go to the Main Menu, type 5 and press [Enter]. To display additional command help, go to the Command Help screen, type A and press [Enter]. The screen shown in Figure 17.2 will be displayed.
^Bxx COMMAND HELP: ^B00 Set/Reset Memory Partition ^B20 Display Partition Record/Block Ct ^B01 Enter Data Read Mode ^B21 Display Remaining Space ^B02 Send Next Data ^B22 Display Capacity & PBX Baud ^B03 Display Site ID ^B24 Display DIP Switch Settings ^B04 Display Site ID Message ^B25 Erase Partition Data ^B05 Define End Character ^B26 Display Separator Line ^B06 Re-Send Last Data ^B27 Enter Test Message Mode ^B07 Continuous Binary Block Read ^B28 Enter Echo Test Mode ^B08 Display Current Alarm Record ^B29 Enter Passthrough Mode ^B09 Exit Cmd Mode, Disconnect ^B30 Exit, Return to Command Mode ^B11 Set Real Time Clock/Calendar ^B39 Erase All Data ^B13 Display Site ID/Alarm Messages ^B50 Default Parameters ^B16 Display System Status ^B51 Select Store Alarm Data ^B17 Display PBX Inact Parameters ^B52 Enable/Disable Hold End Data ^B18 Display Reason for Action ^B53 Enable/Disable Data Compression ^B19 Display Action Schedule ^B54 Enable/Disable Data on ^B01 ^B55 Strip Non-Printable Codes A. More ^Bxx Command Help Enter Selection, Press [ESC] to Return to Previous Menu ... |
MORE ^Bxx COMMAND HELP ^B56 Select Data Filters ^B76 Release Remote Partition ^B57 Enable/Disable XON/XOFF ^B77 Define Modem Init Message ^B59 Enable/Disable Line ID ^B78 Display Modem Messages ^B60 Define Console/Modem Bits-Parity ^B79 Define/Display Passwords ^B61 Define PBX Ports Bits-Parity ^B83 Display Alarm Clue Summary ^B62 Select Output Format ^B84 Clear Alarm Condition ^B64 Enable/Disable Wrap Around ^B86 Reset Alarm Clue Counters ^B65 Select Alarm Filters ^B89 Test Alpha Pager ^B66 Enable/Disable Time/Date Stamp ^B90 Define/Reset Modem Port ^B67 Enable/Disable Auto Delete ^B91 Define Console Port Comm ^B68 Enable/Disable Command Echo ^B92 Define PBX Port A Comm ^B70 Define/Enable/Disable Immediate ^B93 --- and 80% Callout ^B94 Enter Monitor Mode ^B71 Enable/Disable DLE Stuffing ^B95 Display Program Version ^B72 Display Time, Day, Date ^B96 --- ^B73 Send Binary Information Block ^B97 Define/Display Network Parameters ^B74 Save/Recall Parameters ^B98 Reset Network Port ^B75 Enable/Disable "SURE? (Y/N)" ^B99 Download Current Parameters Press [ESC] for Previous Screen ... |
17.4 Command Summary
^B00 Set/Reset Memory Partition
Sets or releases the memory partition for your command port.
Notes:
- If this command does not include an argument, the partition will be set to include all data by default.
- The Release partition argument (R) cannot be combined with the type argument.
- The ^B00 command line cannot specify two data types.
- Square brackets are not included in the command line. They are shown here to indicate an option.
- The Source argument is included to maintain compatibility with standard NetLink units. If the Source argument is omitted, ^B00 will set a partition for PBX Port A.
Command ^B00 uses one of the following formats:
^B00[,type][,source] [Enter] or ^B00[,R] [Enter]
Where:
| ,type |
Data Type: Offers the following options: | |
| ,D or ,STD |
Standard (Non-Alarm) Records. | |
| ,A1 or A |
Records that match Alarm Filter 1. | |
| ,A2 |
Records that match Alarm Filter 2. | |
| ,ALM |
Include All Alarm Records. | |
|
(Not Specified) |
Include all data. | |
| ,source |
Source Port: Offers the following options: | |
| ,PA |
Records received via PBX Port A. | |
|
(Not Specified) |
Records received via PBX Port A. | |
| ,R |
Release Data Partition: The "R" option cannot be combined with other ^B00 arguments. | |
Examples:
| ^B00,D |
Set partition to include all records that did not match an Alarm Clue. |
| ^B00,A1 |
Include records that matched Alarm Filter 1. |
| ^B00,R |
Release the current data partition. |
Corresponding Menu Function: Buffer Functions, Items 2 and 3.
^B01 Enter Data Release Mode
Releases data collected from the PBX.
Notes:
- When data is released in groups of "n" records (e.g. ^B01,30), command ^B02 is sent to release the next group of records.
- To exit Data Release Mode and return to command mode, type ^B30 [Enter].
- If the XON/XOFF function is enabled at the command port, the NLJ will respond to XON/XOFF flow control during data release.
- If "Data on ^B01" is disabled, and ^B01,n is invoked to release data in groups of "n" records, a ^B02 is required in order to release the first group.
- If "Hold End Data" is enabled, a ^B02 is required in order to release the End Data message.
Command Options:
When Command ^B01 is invoked, the following format is used:
^B01[,type][,source][@n][,n] [Enter]
Where:
| ,type |
Data Type: Offers the following options: | |
| ,D or ,STD |
Standard (Non-Alarm) Records. | |
| ,A or ,A1 |
Records for Alarm Filter 1. | |
| ,A2 |
Records for Alarm Filter 2. | |
| ,ALM |
Records for both Alarm Filters. | |
| ,"clue" |
Records for clue only. The clue name must be enclosed in quotes. | |
| ,source |
Source Port: Offers the following options: | |
| ,PA |
Records received via PBX Port A. | |
| (Not Specified) |
Records received via PBX Port A. | |
| @n | Offset: Data release starts with the "nth" record. For example, ^B01@50 will start with the 50th record. If a negative offset value is entered, NLJ will determine the starting point by counting backwards from the end of the current partition. | |
| ,n | Count: Releases records in groups of "n", where n is a positive, whole number. | |
^B01 Data Release Mode (Continued)
Notes:
- The Source argument is included to maintain compatibility with standard NetLink units. If the Source argument is omitted, the ^B01 command will release records that were received via PBX Port A.
- If both Alarm Filters include a clue with the same name, the command must specify the desired filter. For example, if Alarm Filters 1 and 2 both include a clue named TEST, to retrieve data from filter 1, the command line would read ^B01,A1,"TEST".
- Each command option is preceded by a comma, with the exception of the Offset option (@n). This option is preceded by the "@" character. Do not enter a comma before the
@ character.
- When the Binary Block Mode is used, commands will release blocks instead of individual records.
- Square brackets are not included in the command line. They are shown here to indicate an option.
Options can also be combined. For example, ^B01,"clue",n will release records for clue in groups of n records or blocks.
Corresponding Menu Function: Main Menu, Item 2.
^B02 Send Next Data
When Command ^B01,n is invoked, the NLJ will release a group of "n" records or blocks and then pause. To display the next group, type ^B02 [Enter]. Command ^B02 is only valid in Data Release Mode and cannot be used in an Auto Execute string.
Notes:
- If "Data on ^B01" is disabled, a ^B02 is required in order to release the first group of records.
- If "Hold End Data" is enabled, a ^B02 is required in order to release the End Data message.
^B03 Display Site ID
Displays the user-defined Site ID message. Type ^B03 [Enter].
Corresponding Menu Function: Status Displays, Item 3.
^B04 Define Site ID
(Supervisor Mode Only) Defines a Site ID Message up to 32 characters long. Type ^B04,text and press [Enter] (where "text" is the desired Site ID). The Site ID cannot include quotes or ASCII control characters (e.g. STX, ETX). If the Site ID begins with an underscore character ("_"), upon login the message will be displayed after the command prompt. To clear the Site ID, type ^B04,[Space] and press [Enter].
Notes:
- The "_" character will not appear in the displayed Site ID Message.
- If the Console Port Password is disabled, the Site ID Message will not be displayed when the unit is contacted via the Console Port.
^B05 Define End-of-Record Character
(Supervisor Mode Only) Redefines the End-of-Record (EOR) character that the NLJ expects to see at the end of each record (Default=^J). Command ^B05 uses the following format:
^B05[,port][,char] [Enter]
Note: The Port Argument is included only to maintain compatibility with standard NetLink units. If the Port argument is omitted, the ^B05 command will set the EOR character for PBX Port A.
Where:
| ,port |
Input Port: If this argument is omitted, ^B05 will define the EOR character for PBX Port A by default. | |
| ,A |
PBX Port A | |
| (Not Specified) |
PBX Port A | |
| ,char |
EOR Character: If a space character is entered, the EOR character for the target port will be cleared. | |
Corresponding Menu Function: PBX Port A Configuration menu, Item 14.
^B06 Re-send Last Data
This command is used in the event of a transmission error during the previous read. Command ^B06 will only function when ^B01,n is invoked, or when the Record Count option (Read Session Parameters) is used. To re-send data, type ^B06 [Enter].
^B07 Continuous Binary Block Read
Initiates a continuous binary block read, regardless of the current output mode setting. Blocks are sent continuously, without acknowledgment, and cannot be retransmitted during the current read session. When transmitting via modem, error correction must be enabled. A DOS program is available to convert binary data to ASCII. The following settings are automatically used:
Output Mode: Binary Block Line ID (Block #) Tag: Off DLE Stuffing: On Auto-Delete: Off
When command ^B07 is invoked, the following format is used:
^B07[,type][,source][@n]
Note: The Source argument is included to maintain compatibility with standard NetLink units. If the Source argument is omitted, the ^B07 command will release records that were received via PBX Port A.
Where:
| ,type |
Data Type: Offers the following options: | |
| ,D or ,STD |
Standard (Non-Alarm) Records. | |
| ,A or ,A1 |
Records for Alarm Filter 1. | |
| ,A2 |
Records for Alarm Filter 2 only. | |
| ,ALM |
Records for both Alarm Filters. | |
| ,"clue" |
Alarm Records for clue only. Note that the clue name must be enclosed in quotes. | |
| ,source |
Source Port: Offers the following options: | |
| ,PA |
Records received via PBX Port A. | |
| (Not Spedified) |
Records received via PBX Port A. | |
| @n | Offset: Releases records starting with the "nth" record. For example, if ^B01@234 is entered, NLJ will start with the 234th record. If a negative offset value is entered, NLJ will determine the starting point by counting backwards from the end of the current partition. | |
CAUTION: Do not invoke Command ^B07 while the Auto Delete option is enabled. If ^B07 is invoked with Auto Delete enabled, the NLJ will erase data without waiting for the polling device to acknowledge reception.
^B07 Continuous Binary Block Read (Continued)
Notes:
- To exit Continuous Binary Block Read and return to Command Mode, type ^B30 [Enter].
- If both Alarm Filters include an identical clue name, the command must specify the desired filter. For example, if Alarm Filters 1 and 2 both include a clue named TEST, to retrieve data from filter 1, the command line would read ^B07,A1,"TEST".
- Each option is preceded by a comma, with the exception of the Offset option (@n). This option is preceded by the "@" character. Do not enter a comma before the @ character.
- While Continuous Binary Block Read is active, the NLJ will respond to XON/XOFF flow control codes.
- Square brackets are not included in the command line. They are shown here to indicate an option.
Options can be combined. For example, ^B07,D@100 will release all records that did not match an Alarm Filter, starting with the 100th record.
^B08 Display Current Alarm Record
This command can be used to check the exact data record that generated an alarm. Type ^B08 and press [Enter].
^B09 Exit Command Mode (Disconnect/Hang Up)
Exits from command mode, discontinues connection to the NLJ, and resets the internal modem. To exit and disconnect, type ^B09 [Enter].
Corresponding Menu Function: Main Menu, item 8.
^B11 Set Time / Date
(Supervisor Mode Only) Sets the NLJ's real-time clock and calendar. Command ^B11 uses the following format:
^B11,hh:mm,d,MM\DD\YY [Enter]
Where:
| hh | Is the Hour (00 to 23) |
| mm | Is the Minute (00 to 59) |
| d | Is the day of the week (1=Sun., 2=Mon., 3=Tue., etc.) |
| MM | Is the Month (01 to 12) |
| DD | Is the Date (01 to 31) |
| YY | Is the Year (00 to 99) |
Corresponding Menu Function: System Parameters, Item 6.
^B13 Display Site ID Message / Alarm Message
Displays the user-defined Site ID Message, along with the name of any clue that is in the alarm state, and the status of the counter for that clue. Type ^B13 and press [Enter].
Corresponding Menu Function: Status Displays, Items 9 and 10.
^B16 Display System Status
Displays a screen which lists the status of most options and parameters. Type ^B16 [Enter].
Corresponding Menu Function: Status Displays, item 3.
^B17 Display PBX Inactivity Alarm Parameters
Displays currently defined PBX Inactivity Alarm parameters. When the argument
is omitted, the command will display parameters for Alarm 1
by default.
Command Options:
| ^B17,1 | Display Parameters for PBX Inactivity Alarm 1 (Default). |
| ^B17,2 | Display Parameters for PBX Inactivity Alarm 2. |
Corresponding Menu Functions: Status Displays, item 11 (Alarm 1); Status Displays, item 12 (Alarm 2).
^B18 Display Reason For Action
When the NLJ has generated an Alarm Action, Command ^B18 can be used to determine the reason. After receiving an Alarm Action, type ^B18 and press [Enter].
Corresponding Menu Function: Status Displays, Item 15.
^B19 Display Action Schedule
Displays parameters for the Scheduled Actions. If the argument is omitted, the command will display Schedule 1 by default.
Command Options:
| ^B19,1 | Display Parameters for Action Schedule 1 (Default). |
| ^B19,2 | Display Parameters for Action Schedule 2. |
Corresponding Menu Functions: Status Displays, item 4 (Schedule 1); Status Displays, item 5 (Schedule 2).
^B20 Display Partition Record Count
Displays the number of records in your port's current memory partition. Type ^B20 and press [Enter].
Corresponding Menu Function: Status Displays, Item 1
^B21 Display Remaining Space
Displays the approximate amount of memory (in characters/bytes) that is currently available. Type ^B21 and press [Enter].
Corresponding Menu Function: Status Displays, Item 1.
^B22 Display Memory Capacity & PBX Port Baud Rate
Lists installed memory modules, total memory capacity, and PBX Port communication parameters. Type ^B22 [Enter].
Corresponding Menu Functions: Status Displays, Items 1 and 21.
^B24 Display DIP Switch Settings
Displays the up/down configuration of the NLJ's Set-Up Switches; type ^B24 and press [Enter].
Corresponding Menu Function: Status Displays, item 3.
^B25 Erase Partition Data
Clears all call records in your port's current memory partition; type ^B25 and press [Enter].
If the "Sure" option is enabled, a prompt will be displayed before this command is completed. Type Y to proceed or N to abort, and then press [Enter].
CAUTION: Erased records cannot be recovered.
Command Options:
| ^B25 | Display "Sure" prompt (if enabled), Erase Partition Data. |
| ^B25,Y | Suppress "Sure" prompt, Erase Partition Data. |
Corresponding Menu Function: Buffer Functions, Item 5
^B26 Display Separator Line
Creates a line of dashes that can be used to visually separate displayed material. To send a line of dashes, type ^B26 [Enter].
^B27 Enter Test Message Mode
Tests the modem transmitter. When Command ^B27 is invoked, the unit will send a continuous test message. To initiate the test, type ^B27 [Enter]. To terminate the test, type ^B30 [Enter].
Corresponding Menu Function: System Diagnostics, item 2.
^B28 Enter Echo Test Mode
Tests the modem receiver. When Command ^B28 is invoked, the NLJ will echo back a test character. If characters are not echoed back, this can indicate that the modem is not receiving properly. To initiate the test, type ^B28 [Enter]. To terminate the test, type ^B30 [Enter].
^B29 Enter Pass-through Mode
(Supervisor Mode Only) Allows direct communication with a connected device. Data can be received directly from the PBX in order to check for correct reception. Commands can also be sent directly to the PBX. While Pass-Through Mode is active, additional call records will not be stored. To exit Pass-Through Mode, type ^B30 and press [Enter].
CAUTION: Do not attempt to alter PBX configuration unless you are authorized to do so. Please refer to the PBX user's guide for further instructions.
Command Options:
| ^B29,A | Pass-Through to PBX Port A. |
| ^B29,C | Pass-Through to Console Port. |
| ^B29,M | Pass-Through to Modem Port. |
Corresponding Menu Function: System Functions, item 2.
^B30 Exit, Return to Command Mode
Exits from Data Release Mode, Send Continuous Test Message Mode, Echo Test Mode, Pass-Through Mode, or Monitor Mode and returns to Command Mode. Type ^B30 [Enter].
^B39 Erase All Data
Erases all stored data, including records stored outside your port's memory partition. Command ^B39 includes an option that allows the user clear all data and reset all Alarm Clue Counters to zero.
CAUTION: Erased call records cannot be restored.
If the "Sure" option is enabled, a prompt will be displayed. Type Y to proceed, or N to abort, and then press [Enter].
Command Options:
| ^B39 | Clear all records, leave Alarm Clue Counters intact. |
| ^B39,2 | Clear all records and reset Clue Counters to zero. |
| ^B39,Y | Suppress "Sure" prompt, Clear all records, leave Alarm Clue Counters intact. Note that the Y argument can also be combined with the "2" argument (e.g. ^B39,2,Y). |
Corresponding Menu Function: Buffer Functions, item 5.
^B50 Default Parameters
(Supervisor Mode Only) Resets options and parameters to default settings. When this command is invoked, the input port and command ports are reset to the baud rate selected by the Set-Up Switches; the modem port is reset to 57600 bps, 8 bits, no parity, one stop bit.
CAUTION: Options, parameters, and filters that have been erased cannot be automatically restored.
If the "Sure" option is enabled, a prompt will be displayed. Type Y to proceed, or N to abort, and then press [Enter].
Command Options:
| ^B50 | Reset options and parameters to default state. |
| ^B50,2 | Reset options and parameters to default state. Erase Data Filter Format, Data Filter Parameters, Alarm Filter Format, Alarm Clues, and reset Alarm Clue Counters to zero. |
| ^B50,Y | Suppress "Read in Progress" prompt and "Sure" prompt, reset options and parameters to default state. Note that the "Y" argument can also be combined with the "2" argument (e.g. ^B50,2,Y). |
Corresponding Menu Function: Main Menu, item 21.
^B51 Store Alarm Data
(Supervisor Mode Only) Allows the user to determine where alarm data will be stored. The NLJ can either store alarm records in the Alarm File (default), in the Standard (non-alarm) File, or in both files. Command ^B51 uses the following format:
^B51[,port][,file] [Enter]
Note: The Port argument is included to maintain compatibility with standard NetLink units. If the argument is omitted, the command will be applied to PBX Port A.
|
,port |
Input Port:
If this argument is omitted, ^B51 will select the alarm data storage location for PBX Port A by default. | |||||
|
,A PBX Port A | ||||||
|
(Not Specified) PBX Port A | ||||||
|
,file |
Storage Location: Determines where Alarm Data from this port will be stored. Offers the following options: | |||||
|
Corresponding Menu Function: PBX Port A Config. Menu, Item 16.
^B52 Release / Hold End Data Message
Instructs the NLJ to hold or release the "END DATA" message, that is normally sent at the end of each Data Release operation. When "Hold End Data" is selected, the message will be held until a ^B02 is received. Note that this command will only effect the port that invoked the command.
Command Options:
| ^B52,1 | Release End Data Message |
| ^B52,3 | Hold End Data Message (Default) |
Corresponding Menu Function: PBX Port A Configuration Menu, Item 23.
^B53 Set Compression Mode
Determines whether data will be released in space compressed format, or decompressed (normal) format. Note that this command will only effect the port that invoked the command.
Command Options:
| ^B53,1 | Release Data in Compressed Format. |
| ^B53,2 | Release Data in Decompressed Format (Default) |
Corresponding Menu Function: Port Configuration Menus (Console Port, Modem Port, Net Port), Item 25.
^B54 Release Data on ^B01
Determines how the NLJ will react when Command ^B01,n is invoked to release data in groups of "n" records. Note that this command will only effect the port that invoked the command.
Command Options:
| ^B54,1 | Release First Group without ^B02 (Default). |
| ^B54,2 | Wait for Command ^B02. |
Corresponding Menu Function: Port Configuration Menus, Item 22.
^B55 Strip Non-Printable Codes
(Supervisor Mode Only) Conserves memory by omitting non-printable characters, such as NULs, DELs and etc. The NLJ will remove most non-printable characters except carriage returns, line feeds, and the selected EOR character.
^B55[,port][,action] [Enter]
Note: The Port argument is included to maintain compatibility with standard NetLink units. If the argument is omitted, this command will be applied to PBX Port A.
Where:
| ,port | Input Port: If this argument is omitted, ^B55 will set the Strip Non-Printable codes option for PBX Port A. | |||
|
,A PBX Port A | ||||
|
(Not Specified) PBX Port A | ||||
|
,action |
Store/Strip Codes: Offers the following options: | |||
|
Corresponding Menu Function: PBX Port A Config. Menu, Item 13.
^B56 Select Data Filters
(Supervisor Mode Only) Determines which user-defined data filter will be used. This command uses the following format:
^B56[,port][,filter] [Enter]
Note: The Port argument is included to maintain compatibility with standard NetLink units. If the argument is omitted, this command will be applied to PBX Port A.
Where:
|
,port |
Input Port: If this argument is omitted, ^B56 will assign the selected filter to PBX Port A. | |||||
|
,A PBX Port A | ||||||
|
(Not Specified) PBX Port A | ||||||
|
,filter |
Data Filter: Selects or disables the Data Filter. The following options are available: | |||||
|
Corresponding Menu Function: PBX Port A Config. Menu, Item 17.
^B57 Enable / Disable XON / XOFF Function
(Supervisor Mode Only) The NLJ can send an XOFF when memory becomes 98% full, and an XON when more data can be accepted. Command ^B57 uses the following format:
^B57[,port][,action] [Enter]
Note: The Port argument is included to maintain compatibility with standard NetLink units. If the argument is omitted, this command will be applied to PBX Port A.
Where:
| ,port | Input Port: Offers the following options: | |||
|
,A PBX Port A | ||||
|
(Not Specified) PBX Port A | ||||
|
,action |
Enable / Disable: Offers the following options: | |||
|
CAUTION: Some PBX switches may lock up when XON/XOFF is used. Other PBX switches will not respond to XON/XOFF commands. Consult your PBX User's Guide before attempting to employ this feature.
Corresponding Menu Function: PBX Port A Config. Menu, Item 4
^B59 Line ID Option
Instructs the NLJ to insert an eight digit Line ID number at the beginning of each record. Line ID numbers are not stored in memory, but are added when data is released. Each time data is polled, the first line number will always be 00000001. This command will only effect the port that invoked the command.
Command Options:
| ^B59,1 | Disable Line ID Option (Default) |
| ^B59,2 | Enable Line ID Option |
Corresponding Menu Function: Port Configuration Menus, Item 24.
^B60 Define Console/Modem Port Bits & Parity
(Supervisor Mode Only) Selects bits and parity for the Console Port or the Modem Port. Command ^B60 uses the following format:
^B60[,port][,set] [Enter]
Where:
| ,port | Port: If this argument is omitted, ^B60 will set bits and parity for the Console Port. Offers the following options: | |||||||
|
,C Set Bits/Parity for Console Port | ||||||||
|
,M Set Bits/Parity for Modem Port | ||||||||
|
,set |
Bits/Parity Setting: Sets Bits and Parity for the selected port. Offers the following options: | |||||||
|
Note: This command is included to maintain compatibility with PollCat II units. If compatibility is not an issue, use the Port Configuration Menus, or command ^B90 to set Modem Port Parameters or ^B91 to set Console Port Parameters.
Corresponding Menu Function: Port Configuration Menus (Console Port, Modem Port), Item 2.
^B61 Define PBX Port Bits and Parity
(Supervisor Mode Only) Selects bits and parity settings for PBX Port A. Command ^B61 uses the following format:
^B61[,port][,set] [Enter]
Where:
| ,port | Port: If this argument is omitted, ^B60 will set bits and parity for the PBX Port A. Offers the following options: | |||||||
|
,A Set Bits/Parity for PBX Port A | ||||||||
|
(Not Specified)Set Bits/Parity for PBX Port A | ||||||||
|
,set |
Bits/Parity Setting: Sets Bits and Parity for the selected port. Offers the following options: | |||||||
|
Notes:
- The Port argument is included to maintain compatibility with standard NetLink units. If the Port argument is omitted, this command will be applied to PBX Port A.
- This command is included to maintain compatibility with PollCat II units. If compatibility is not an issue, use the Port Configuration Menu or command ^B92 to set parameters for PBX Port A.
Corresponding Menu Function: PBX Port A Configuration Menu,
Item 2.
^B62 Select Output Format
Selects the format that will be used when data is released to the polling device. ^B62 will only effect the port that invoked the command.
Command Options:
| ^B62,1 | Release Data in ASCII Format (Default) |
| ^B62,2 | Release Data in ASCII Format |
| ^B62,3 | Release Data in Binary Block Format |
| ^B62,4 | Release Data in Xmodem Format |
| ^B62,5 | Release Data in Zmodem Format |
Corresponding Menu Function: Port Configuration Menus (Console Port, Modem Port, Net Port), Item 21).
^B64 Enable / Disable Wrap Around Mode
(Supervisor Mode Only) When the NLJ's internal memory is full, the wrap around mode allows new data to be written over older data. This allows the NLJ to continually recycle its memory.
Command Options:
| ^B64,1 | Disable Wrap Around Mode (Default) |
| ^B64,2 | Enable Wrap Around Mode |
Corresponding Menu Function: System Parameters Menu, Item 5.
^B65 Select Alarm Filters
(Supervisor Mode Only) Determines which user-defined Alarm Filter will be used. This command uses the following format:
^B65[,port][,filter] [Enter]
Note: The Port argument is included to maintain compatibility with standard NetLink units. If the argument is omitted, this command will be applied to PBX Port A.
Where:
|
,port |
Input Port: If this argument is omitted, ^B56 will assign the selected filter to PBX Port A. | |||||
|
,A PBX Port A (Default) | ||||||
|
(Not Specified) PBX Port A | ||||||
|
,filter |
Alarm Filter: Selects or disables the Alarm Filter. The following options are available: | |||||
|
Corresponding Menu Function: PBX Port A Configuration Menu,
Item 15.
^B66 Enable / Disable Time / Date Stamp
(Supervisor Mode Only) Enables the time/date stamp option for PBX Port A. The time/date stamp will be inserted at the beginning of each record, prior to storage in the NLJ's memory.
^B66[,port][,action] [Enter]
Note: The Port argument is included to maintain compatibility with NetLink units. If the Port argument is omitted, this command will be applied to PBX Port A.
Where:
|
,port |
Input Port: Offers the following options: | |||||
|
,A PBX Port A (Default) | ||||||
|
(Not Specified) PBX Port A | ||||||
|
,action |
Enable / Disable: Offers the following options: | |||||
|
Corresponding Menu Function: PBX Port A Config. Menu, Item 11.
^B67 Set Auto Delete Option
(Supervisor Mode Only) When data is released to the polling device, the Auto Delete option can automatically erase each data block from memory after reception is acknowledged. Note that this command will only effect the port that invoked the command.
Command Options:
| ^B67,1 | Disable Auto Delete Option (Default) |
| ^B67,2 | Enable Auto Delete Option |
Note: Before enabling the Auto Delete Option, please refer to the cautions listed in Section 14.6.
Corresponding Menu Function: Port Configuration Menus (Console Port, Modem Port, Net Port), Item 26.
^B68 Set Command Echo
Enables / Disables the command echo function. When enabled, commands sent to the NLJ will be echoed back to the polling device. Note that this command will only effect the port that invokes the command.
Command Options:
| ^B68,1 | Disable Command Echo |
| ^B68,2 | Enable Command Echo (Default) |
Corresponding Menu Function: Port Configuration Menus (Console Port, Modem Port, Net Port), Item 11.
^B70 Enable/Disable Immediate Callout and 80% Full Alarm
(Supervisor Mode Only) Enables and configures the Immediate Callout and 80% Full Alarm. When Immediate Callout is enabled, the NLJ will dial a user-defined Callout Number, approximately 5 seconds after a disconnect or loss of carrier. Note that the Immediate Callout feature must be enabled prior to each use.
When the 80% Full Alarm is enabled, the NLJ can perform any of the standard Alarm Actions when internal memory becomes 80% full. For more information, please refer to Section 10.
Command Options:
| ^B70 | Disable Immediate
Callout and 80% Full Alarm |
| ^B70,I,1,1 | Enable Immediate Callout |
| ^B70,I,1,2 | Disable Immediate Callout |
| ^B70,I,2,n | Define Immediate Callout Number (Where n= Desired Immediate Callout Number.) |
| ^B70,I,2,[Space] | Clear Immediate
Callout Number. |
| ^B70,%,1,1 | Enable 80% Full Alarm. |
| ^B70,%,1,2 | Disable 80% Full Alarm. |
| ^B70,%,2,x | Define notification
action; Where x is the desired
action and 1 = None, 2 = Callout, 3 = Alphanumeric Page, 4 = Numeric Page, 5 = SNMP Trap, 6 = N/A, and 7 = Console Action. |
| ^B70,%,3,n | Define number for
80% Full Callout or Page (Where n is the desired phone number.) |
| ^B70,%,3,[Space] | Clear 80% Full callout number. |
| ^B70,%,4,PagerID | Define Pager ID Number 1 for 80% Full Alarm. |
| ^B70,%,4,[Space] | Clear Pager ID Number 1. |
| ^B70,%,5,PagerID | Define Pager ID Number 2 for 80% Full Alarm. |
| ^B70,%,5,[Space] | Clear Pager ID Number 2. |
| ^B70,%,6,PagerID | Define Pager ID Number 3 for 80% Full Alarm. |
| ^B70,%,6,[Space] | Clear Pager ID Number 3. |
| ^B70,%,7,message | Define 80% Full Alarm Message. This message can be sent when the alarm generates a Callout, Alphanumeric Page, SNMP Trap or Console Action. |
| ^B70,%,7,[Space] | Clear 80% Full Alarm Message. |
| ^B70,%,8,1 | Enable Auto Execute Function for 80% Full Alarm. |
| ^B70,%,8,2 | Disable Auto Execute Function for 80% Full Alarm. |
| ^B70,%,9,cmds | Define the Auto Execute Command String for this alarm. Where cmds is a series of ^Bxx commands, with each command separated by a backslash character followed by a forward slash (\/). |
| ^B70,%,9,[Space] | Clear Auto Execute Command String. |
Corresponding Menu Function: Immediate Callout; Modem Port Configuration Menu, Item 34. 80% Full Alarm; Alarm Configuration Menu, Item 5.
^B71 Set DLE Stuffing Option
(Binary Block Mode Only) DLE Stuffing allows literal 8 bit characters to be inserted into a string of binary data. After data is released, the 8 bit characters can be retrieved and read. Note that this command will only effect the port that invoked the command.
Command Options:
| ^B71,1 | Disable DLE Stuffing Option (Default) |
| ^B71,2 | Enable DLE Stuffing Option |
Corresponding Menu Function: Port Configuration Menus (Console Port, Modem Port, Net Port), Item 29.
^B72 Display Time, Day, Date
Displays clock and calendar settings. Type ^B72 [Enter].
^B73 Send Binary Information Block
Sends a status information block in binary format. This block includes the Site ID Message, time and date, Reason for Action, Partition Record Count, and Percent Full. Information is sent in binary block format, regardless of the current output mode setting. Type ^B73 [Enter].
^B74 Save / Recall Parameters
(Supervisor Mode Only) This command is used to save newly defined parameters to flash memory, or restore previously defined parameters from flash memory. For more information, please refer to Section 13.1.
Command Options:
| ^B74 | Save Current Parameters to Flash Memory |
| ^B74,1 | Save Current Parameters to Flash Memory |
| ^B74,2 | Recall Parameters from Flash Memory |
| ,y | (Optional Argument) Suppress "Sure?" prompt |
Corresponding Menu Function: Main Menu, Item 7.
^B75 Enable / Disable "Sure?" Prompt
(Supervisor Mode Only) When certain irreversible commands are invoked, the "Sure?" prompt can be displayed to allow the user to verify that the command should be executed. When enabled, the prompt will be displayed for commands such as ^B25 (Clear Partition), ^B39 (Clear All Records), ^B50 (Reset Options to Defaults), ^B74 (Save / Recall Parameters), ^B76 (Release Remote Partition), and others. Note that this command will only effect the port that invoked the command.
Command Options:
| ^B75,1 | Disable "Sure?" Prompt |
| ^B75,2 | Enable "Sure?" Prompt (Default) |
Corresponding Menu Function: Port Configuration Menus (Console Port, Modem Port, Net Port), Item 13.
^B76 Release Remote Partition
(Supervisor Mode Only) Releases the current memory partition for the specified port.
Command Options:
| ^B76 | Release Console Port Partition |
| ^B76,c | Release Console Port Partition |
| ^B76,m | Release Modem Port Partition |
| ^B76,T1 | Release Partition for Telnet Port #1 |
| ^B76,T2 | Release Partition for Telnet Port #2 |
| ^B76,T3 | Release Partition for Telnet Port #3 |
| ^B76,F | Release FTP Server Partition |
| ,y | (Optional Argument) Suppress "Sure?" Prompt |
Corresponding Menu Function: Buffer Functions Menu, Item 8.
^B77 Define Modem Initialization Message
(Supervisor Mode Only) Defines the NLJ's modem initialization command string (AT Command String). The default string is "ATE0M0Q1&C1&D2S0=1". To redefine the initialization string, type ^B77,init [Enter], where "init" is the desired command string.
Corresponding Menu Function: Modem Port Config. Menu, Item 5.
^B78 Display Modem Message
Displays the Modem Reset Message (AT Command String), Initialization String, and Hang-Up String. Type ^B78 [Enter].
Corresponding Menu Function: Status Displays, item 25
^B79 Define / Display Passwords
(Supervisor Mode Only) Defines and/or displays the command mode passwords. The default Supervisor Level password is "SUPER", the default User 1 password is "SMDR", and the default User 2 password is not defined.
Command Options:
| ^B79 | Displays Supervisor Level Password |
| ^B79,pass | Defines "pass" as the Supervisor Level Password |
| ^B79,1,pass | Defines "pass" as the Supervisor Level Password |
| ^B79,2 | Displays the User 1 Password |
| ^B79,2,pass | Defines "pass" as the User 1 Password |
| ^B79,3 | Displays the User 2 Password |
| ^B79,3,pass | Defines "pass" as the User 2 Password |
Corresponding Menu Function: System Parameters Menu,
Items 1, 2, and 3.
^B83 Display Alarm Clue Summary
Displays a table which shows Clue Names, Threshold Counts, Actual Counts,
and Alarm Status. To display Alarm Clue counter status,
type ^B83 [Enter].
Command Options:
| ^B83,1 | Display Clue Summary for Alarm Filter 1. |
| ^B83,2 | Display Clue Summary for Alarm Filter 2. |
Corresponding Menu Function: Status Displays, item 9 (Alarm Filter 1), or item 10 (Alarm Filter 2)..
^B84 Clear Alarm Condition
Clears the Alarm Condition and cancels Alarm Actions, without resetting the Alarm Clue Counters or turning off the ALM LED.
Command Options:
| ^B84 | Clear Alarm Condition |
| ^B84,y | Suppress "Sure?" Prompt, Clear Alarm Condition. |
Corresponding Menu Function: System Functions, item 4.
^B86 Reset Alarm Clue Counters
Resets counters for specified Alarm Clue to zero. To clear an alarm condition, please use Command ^B84.
Command Options:
| ^B86,"clue" | Reset Counter for clue only. |
| ^B86,*,A1 | Reset All Counters for Alarm Filter 1. |
| ^B86,*,A2 | Reset All Counters for Alarm Filter 2. |
| ^B86,* | Reset all counters for Alarm Filters 1 and 2. |
Note: If both Alarm Filters include a clue with the same name, command ^B86 must specify the desired alarm filter.
Corresponding Menu Function: System Functions, item 5
^B89 Test Alpha Pager
To test an alphanumeric pager, type ^B89,1 [Enter], and then exit command mode. After approximately two minutes, the pager should receive the "Pager Test" message. In order for this command to function, the Pager Phone Number and Pager ID Number must first be defined via the Pager Test Submenu.
Corresponding Menu Function: System Diagnostics Menu, Item 3.
^B90 Reset Modem Port / Define Modem Port Communication Parameters
(Supervisor Mode Only) This command can be used to reset the NLJ's internal modem or redefine modem parameters.
Reset Modem: To reset the modem, use the following format:
| ^B90 | Reset Modem |
| ^B90,y | Reset Modem, Suppress "Sure?" Prompt. |
Configure Modem Port: To define modem communication parameters, use the following format:
^B90,baud,parity,data,stop [Enter]
Where:
| baud | Baud Rate: Any standard rate from 300 bps to 115.2 Kbps. It is only necessary to enter the first two characters of the baud rate. If an asterisk is entered in this field, the port will be set to the default modem port baud rate (57.6 Kbps). |
| parity | Parity Bits: None (n), Odd (o), or Even (e) |
| data | Data Bits: 7 or 8 |
| stop | Stop Bits: 1 or 2 |
Corresponding Menu Function: Modem Port Config. Menu.
^B91 Console Port Communication Parameters
(Supervisor Mode Only) Defines the baud rate, parity, data bits, and stop bits for the Console Port. This command uses the following format:
^B91,baud,parity,data,stop [Enter]
Where:
| baud | Baud Rate: Any standard rate from 300 bps to 115.2 Kbps. Note that it is only necessary to enter the first two characters of the baud rate. If an asterisk is entered in this field, the port will be set to the default rate specified by set-up switches 1, 2, and 3. |
| parity | Parity Bits: None (n), Odd (o), or Even (e) |
| data | Data Bits: 7 or 8 |
| stop | Stop Bits: 1 or 2 |
Corresponding Menu Function: Console Port Config. Menu.
^B92 PBX Port A Communication Parameters
(Supervisor Mode Only) Defines the baud rate, parity, data bits, and stop bits for PBX Port A. This command uses the following format:
^B92,baud,parity,data,stop [Enter]
Where:
| baud | Baud Rate: Any standard rate from 300 bps to 115.2 Kbps. Note that it is only necessary to enter the first two characters of the baud rate. If an asterisk is entered in this field, the port will be set to the default rate specified by set-up switches 4 and 5. |
| parity | Parity Bits: None (n), Odd (o), or Even (e) |
| data | Data Bits: 7 or 8 |
| stop | Stop Bits: 1 or 2 |
Corresponding Menu Function: PBX Port A Configuration Menu.
^B94 Enter Monitor Mode
(Supervisor Mode Only) Allows direct communication with the PBX. In Monitor Mode, data can be received directly from the PBX in order to check reception. Commands can also be sent directly to the PBX. To exit Monitor Mode, type ^B30 and press [Enter].
Command Options:
| ^B94,A | Monitor PBX Port A. |
| ^B94,C | Monitor Console Port. |
| ^B94,M | Monitor Modem Port. |
Corresponding Menu Function: System Functions, Item 3.
^B95 Display Program Version
Displays the version number of the NLJ-512 Firmware. Type ^B95 and press [Enter].
^B97 Define / Display Network Parameters
(Supervisor Mode Only) Displays and/or Defines network parameters, including the IP Address, Subnet Mask, and Gateway Address.
| ^B97 | Display Network Parameters |
| ^B97,1,IPADDR | Define IP Address; Where IPADDR is the desired IP Address. |
| ^B97,1,[Space] | Clear IP Address |
| ^B97,2,SUBNET | Define Subnet Mask Address; Where SUBNET is the desired address. |
| ^B97,2,[Space] | Clear Subnet Mask |
| ^B97,3,GATEWAY | Define Gateway Address; where GATEWAY is the desired address. |
| ^B97,3,[Space] | Clear Gateway Address |
| ^B97,4,SNMP1 | Define SNMP Manager #1; where SNMP1 is the desired SNMP Manager. |
| ^B97,4,[Space] | Clear SNMP Manager #1. |
| ^B97,5,SNMP2 | Define SNMP Manager #2; where SNMP2 is the desired SNMP Manager |
| ^B97,5,[Space] | Clear SNMP Manager #2. |
| ^B97,6,SNMPC | Define SNMP Community; where SNMPC is the desired SNMP Community. |
| ^B97,6,[Space] | Clear SNMP Community. |
Corresponding Menu Function: Display Parameters; Status Displays, item 26. Define Parameters; Port Configuration, Item 6.
^B98 Reset Network Port
(Supervisor Mode Only) Reinitializes the Network Port. Type ^B98 [Enter]. If the "Sure" option is enabled, a prompt will be displayed before this command is completed. Type Y to proceed or N to abort, and then press [Enter].
Command Options:
| ^B98 | Display "Sure" Prompt (If Enabled), Reset Network Port |
| ^B98,y | Suppress "Sure" Prompt, Reset Network Port |
Corresponding Menu Function: Network Port Configuration Menu, item 7.
^B99 Save Current Parameters
(Supervisor Mode Only) Saves currently defined NLJ parameters to an ASCII text file on your polling device. In the event of corruption or erasure, the saved parameters can be downloaded to the unit in order to restore the previous configuration.
Note that when this command is invoked, the command echo must be disabled at your command port. If the command echo is not disabled, the ^B99 command will be included in the saved parameters file, and will cause problems when the file is later uploaded to the NLJ-512 unit.
There are two ways to suppress the command echo; via the Port Configuration Menu, or by entering the ^A character in place of the ^B character. When the ^A character is substituted for the ^B character (e.g. ^A99), the command echo will be temporarily suppressed, regardless of the current command echo setting.
Please refer to Section 13.2.2 for more information.
Corresponding Menu Function: System Functions, item 6.