14. Buffer Functions (Polling)

The procedures in this section are used to retrieve data that has been collected from the PBX. The NLJ offers four different polling methods:

1. Menu Driven: The NLJ is contacted via modem or Console Port, and the Buffer Functions Menu is used to release data.

2. Command Driven: The NLJ is contacted via modem or Console Port, and ^Bxx commands are entered at the command prompt to release data:

3. FTP Push: The NLJ automatically downloads records via TCP/IP connection to your FTP server.

4. FTP Server: An FTP client program is used to retrieve stored data from the NLJ on demand. In this case, the NLJ functions like a standard FTP server.

14.1 Memory Partitions and Shared Data

After data is collected from the PBX, it is stored in the NLJ's flash memory. Stored data can be retrieved via the Console Port, Modem Port, or Network Port. In order to prevent conflicts when two ports attempt to access the same data, partitions are set to temporarily grant "ownership" of a specific type of data to a specific port. For example, the Console Port may own all Non-Alarm (Standard), or the Modem Port may own all records that matched Alarm Filter 1.

When a partition is set for a specific command port, other command ports will not be able to access the partitioned data. For example, if the Console Port partition is set to include all Non-Alarm data, then the Modem Port will not be able to access this data until the partition is released.

These partitions also simplify the process of clearing data after it has been read. After downloading data from your command port partition, command ^B25 or the Item 5 in the Buffer Functions menu can be used to clear the partition. Note that records that are received after the partition is set will not be erased. Once a partition is set, it will remain in effect until the partition owner exits from command mode, or invokes one of the partition release commands.

14.1.1. Partitions and Files

When data is received from the PBX, the NLJ sorts each record into one of three possible "files" according to Data Type. There are three Data Types; Standard Data (Non-Alarm Records), Records that match Alarm Filter 1, and Records that match Alarm Filter 2.

Each file contains a specific data type. When a command port sets a partition, that port is granted ownership of one or more of these files. The File List screen (Status Displays, Item 2) can be used to determine which files are linked to each command port.

Note that these files are always "open"; new data is continually added to each file. When a partition is set, all records received up to that point will be available for reading or erasure. However, new records received after the partition is set will not be available until the partition is reset.

Note also that the "Store Alarm Data" option can be used to override the default storage location for alarm records. Using this option, alarm records can be stored in the Alarm File, in the Standard File (Non-Alarm), or in both the Alarm File and Non-Alarm File. This allows Alarm Records to be used for call accounting purposes only, alarm tracking only, or for both. The "Store Alarm Data" option is located in the configuration menu for PBX Port A.

14.1.2. Setting the Partition

The following events will cause the NLJ to set a data partition:

1. Menu-Driven Read Session: When the Buffer Functions menu is used to release data, a partition will be set for the port that initiated the read session. This partition will include all data selected by the Read Session Parameters menu. For more information, please refer to Section 14.2.

2. Command Driven Read Session: When command ^B01 is invoked, a partition will be set for the port that initiated the command. This partition will include all data specified by the ^B01 command arguments. For more information, please refer to Section 14.3.

3. Set Partition Function: When the Set Partition function (Buffer Functions Menu) is performed, a partition will be set for the port that activated the function. This partition will include all data currently specified by the Read Session Parameters menu. If the Data Type has not been selected, the partition will include all data by default. For more information, please refer to Section 14.2.

4. Command ^B00: When command ^B00 (Set Partition) is invoked with the proper arguments, a partition will be set for the port that invoked the command. This partition will include all data specified by the ^B00 command arguments. For more information, please refer to Section 14.3.1.

5. FTP Push: When an FTP Push operation is in progress, a partition will be set which will include all files that were requested via the FTP Push Configuration menu. For more information, please refer to Section 14.4.

6. FTP Server: When the FTP Server function is being used to retrieve files, a partition will be set which will include all files requested by the FTP client. For more information, please refer to Section 14.5.

   Notes:

   • Partitions remain in effect until the partition owner exits command mode, invokes one of the Partition release commands, or sets a new partition.
   • Other ports are not allowed to access partitioned data until the partition is released.

14.1.3. Releasing the Partition

Any of the following events will release the partition:

1. Exit Command Mode: When the Console Port, Modem Port, or Network Port exits from command mode, the NLJ will release the partition for that port.

2. Release Partition Function: When this function (Buffer Functions Menu) is performed, the NLJ will release the partition for the port that invoked the command. For more information, please refer to Section 14.2.

3. Release Remote Partition: (Supervisor Mode Only) This function can be used to release a partition that has been established by another port. The Release Remote Partition function is available via the Buffer Functions menu, or by invoking command ^B76 with the proper arguments. For more information, please refer to the Command Reference Guide in Section 17.

4. Command ^B00,R: When command ^B00 is invoked with the "R" argument (^B00,R), the NLJ will release the partition for the port that invoked the command. For more information, please refer to Section 14.3.1.

5. At the End of an FTP Push Session: When the FTP Push feature finishes sending the requested data, the partition that was set for the FTP Push feature will be released. For more information, please refer to Section 14.4.

6. FTP Server Function: The partition that is set for the FTP Server function will be released when any of the following events occur:

   1. When the FTP client disconnects, the partition for the selected file will be released.

   2. After a file has been downloaded to the FTP client, the partition will be released if the file is deleted from the NLJ's buffer memory, either by the Auto Delete function, or by the FTP client's delete function.

   3. When the FTP client is used to select a different file, the partition for a previously selected file (if any) will be released.

14.2. Menu Driven Data Release

The NLJ menu system offers four different methods for retrieving buffered data; menu driven data release, command driven data release, FTP Push and FTP Server data transfer. During menu driven data release, the Buffer Functions menu controls and configures the data release process. The menu driven procedure consists of the following three steps:

Note: Prior to reading data, the user must configure output options for the port that will drive the data release, as described in Section 4.4.

1. Set Read Session Parameters: Use item 1 in the Buffer Functions menu to select desired data types, source port, and other options as described in Section 14.2.2.

2. Set Partition: Use item 2 in the Buffer Functions menu to set the partition for your command port as described in Section 14.2.1.

3. Begin Data Release: Use item 4 in the Buffer Functions menu to begin data release as described in Section 14.2.1.

14.2.1. The Buffer Functions Menu

After configuring the command port which will drive the data release, go to the NLJ Main Menu, type 2 and press [Enter] to display the Buffer Functions Menu as shown in Figure 14.1. The Buffer Functions menu offers the following options:

1. Read Session Parameters: Selects Read Session parameters, including the Data Type, Start Record, and Record Count. For more information on Read Session Parameters, please refer to Section 14.2.2.

2. Set Partition: Sets the partition for the user's port according to currently selected Read Session Parameters. If Read Session Parameters have not been redefined, the partition for this port will include all records by default.

 
BUFFER FUNCTIONS: 

1. Set "Read" Session Parameters 
2. Set Partition 
3. Release Partition 
4. Enter "Read" Session 
5. Erase Partition Data 
6. Erase All Data 
7. Erase All Data & Clear Alarm Clue Counters 
8. Release Remote Partition 

Enter Selection, 
Press <ESC> to return to previous menu ... 

Figure 14.1:  Buffer Functions Menu

3. Release Partition: Releases the port's partition, allowing other ports to access the formerly partitioned data.

4. Enter "Read" Session: When this item is selected, the NLJ will display a submenu before beginning data release. The following options are available:

   1. Start Data Output: To begin, press [Enter].

   2. Next Group (^B02): This is used when releasing groups of records as described in Section 14.2.2. For example, if Record Count is set at 10, the NLJ will release a group of ten records and then pause. To release the next group, invoke command ^B02 (simultaneously press [Ctrl] and [B], and then type 02).

   3. Re-read Last Data Record (^B06): This option is used when releasing groups of records as described in Section 14.2.2. For example, if Record Count is set at 5, the NLJ will release a group of five records and then pause. To resend this group, invoke command ^B06.

   4. Exit (^B30): To exit data release mode, invoke command ^B30.

   Notes:

   • When all specified records have been released, the "End Data" message is sent. If "Hold End Data" is enabled, a ^B02 command is required in order to release the End Data message and complete the data release procedure.
   • If "Data On ^B01" is disabled, a ^B02 command must be sent in order to begin the data release.

5. Erase Partition Data: Erases all data in the current partition. The NLJ will display a "Sure ?" prompt, allowing one last chance to abort the command. If confirmation is given, the NLJ will erase all data in the partition. Note that this function will not erase records received after the partition was set.

6. Erase All Data: Erases all stored records, including records in partitions owned by other ports. Note that the NLJ will not erase records that are currently being read by another port.

7. Erase All Data & Clear Alarm Counters: Erases all stored records (including records in partitions owned by other ports), and resets all Alarm Clue Counters to zero.

   Note: Erased call records cannot be recovered.

8. Release Remote Partition: (Supervisor Mode Only) Releases a partition established by another port, and allows access to data assigned to another port. Note that a remote partition cannot be released while another port is reading data from that partition.

14.2.2. Read Session Parameters

The Set Read Session Parameters submenu (Figure 14.2) is used to select options that are applied when data is released.

Note: If the port partition has not been set, the value selected for the Data Type option will determine the partition location. When a Read Session is initiated, or the Set Partition option is selected, the partition is set according to the Data Type option.

1. Source Port: The source port will always be PBX Port A.

2. Data Type: Determines which type of data will be released. The following data types may be selected:

   1. All: Release all data from the buffer. This includes both alarm data and non-alarm data.

   2. Standard (Non-Alarm): Release records that did not match an Alarm Clue.

   3. Alarm 1 (All): Release all data that matched any Alarm Clue defined for Alarm Filter 1.

   4. Alarm 1 (By Clue): Release records that matched a specific Alarm Clue defined for Alarm Filter 1.

   5. Alarm 2 (All): Release all data that matched any Alarm Clue defined for Alarm Filter 2.

   6. Alarm 2 (By Clue): Release records that matched a specific Alarm Clue defined for Alarm Filter 2.

   7. All Alarms: Release records that matched Alarm Filter 1 and records that matched Alarm Filter 2.

 
SET "READ" SESSION PARAMETERS: 

1. Source Port: 	PBX-A 
2. Data Type: 		All 
3. Start Record: 	1 
4. Record Count: 	All 

Enter Selection, 
Press <ESC> to return to previous menu ... 

Figure 14.2:  Set Read Session Parameters Menu

3. Start Record: The starting point for data release. For example, if Start Record is set at 153, the 153rd record in memory will be the first record released. Note that if a negative value is entered, the NLJ will determine the starting point by counting backwards from the end of the records in the current partition.

4. Record Count: Determines how many records are released in each group. For example, if Record Count is set at 20, the NLJ will release 20 records and then pause. Invoke command ^B02 to release the next group.

14.3. Command Driven Data Release

Data can also be released by invoking Command ^B01. The ^B01 command line can include optional arguments which are used to release specific types of data. These arguments are similar to the options offered under the Set Read Session Parameters menu. The command driven procedure consists of the following steps:

Note: Prior to reading data, the user must select output options (Output Mode, Data on ^B01, etc.) for the port that will drive the data release, as described in Section 4.4.

1. Release Data Partition: Use command ^B00 to release the current partition for your port. At the command prompt type ^B00,R and press [Enter]. Other ^B00 options are listed in Section 14.3.1.

   Notes:

   • The Release Remote Partition function (Supervisor Mode Only) can also be used to access data that has been assigned to another port. Please refer to command ^B76 in the Command Reference Guide (Section 17).
   • A remote partition cannot be released while another port is reading data from that partition.

2. Begin Data Release: Invoke command ^B01 with the appropriate arguments to release the desired data. Section 14.3.2 describes the various arguments for command ^B01.

14.3.1. Command ^B00 (Set/Release Partition)

Command ^B00 can be used to set or release the partition prior to beginning command driven data release.

Notes:

• If the ^B00 command line does not include an argument, the partition will be set to include all data by default.
• The Release partition argument (R) and the type argument cannot be combined.

Command ^B00 uses the following format:

^B00[,type] or ^B00,R

Where:

14.3.2. The ^B01 Command Line

If the ^B01 command line does not include optional arguments, and no partitions have been set, command ^B01 will release all data by default.

Note: If the partition for your port has not been set, the ^B01 command arguments will set the partition location.

Command ^B01 offers the following options:

^B01[,type][@n][,n]  [Enter]

Where:

Notes:

• If both Alarm Filters include identical clue names, the data release command must specify the desired Filter. For example, if Alarm Filters 1 and 2 both include a clue named TEST, to retrieve alarm data from filter 1, the command would be invoked as ^B01,A1,"TEST".



• Square brackets are not included in the command line.  They are shown here to indicate optional command arguments.



• Each option is preceded by a comma, with the exception of the Start Record option (@n).  Do not enter a comma before the "@" character.



• When all specified records have been released, the "End Data" message is sent. If "Hold End Data" is enabled, a ^B02 command is required in order to release the End Data message, and complete the data release operation.



• If "Data On ^B01" is disabled, a ^B02 command must be sent in order to begin data release.



• When Command ^B01,n is invoked to release data in groups of n records, type ^B02 [Enter] to release the next group of records, or type ^B06 [Enter] to resend the previous group.

14.3.3. Command ^B01 Examples

As shown in the examples below, arguments can be combined in a single command line to further define the data release format.

Examples:

• ^B01,D,10 ¾ Release all Standard (non-alarm) data in groups of ten records. Note that a ^B02 would be required in order to release any subsequent groups of data.



• ^B01,A1@10 ¾ Release all data that matched Alarm Filter 1, starting with the tenth record.



• ^B01,@65,12 ¾ Release data in groups of twelve records, beginning with the 65th record. Note that a ^B02 would be required in order to release any subsequent groups of data.

14.3.4. Other Commands Used During Data Release

The following commands are often used during command driven data release. For a complete listing of all available commands, please refer to Section 17.

1. Site ID: To send the Site ID, type ^B03  [Enter].

2. Display Current Alarm Record: Type ^B08  [Enter].

3. Remaining Memory Space: To send a message that lists the NLJ's remaining memory, type ^B21  [Enter].

4. Set-Up Switches: To send a message that lists the current status of the Set-Up Switches, type ^B24  [Enter].

5. Number of Stored Records: To send a message that lists the number of records in the current memory partition, type ^B20 and press [Enter].

6. Display Separator Line: To send a line of dashes, which can be used to visually separate downloaded data, type ^B26 and
   press [Enter].

7. Continuous Binary Block Read: To initiate a continuous binary block read, invoke command ^B07. Blocks are sent continuously, without acknowledgment, and cannot be retransmitted during the current read session. Data is sent in binary block format, regardless of the current output mode setting. All data type and source port arguments are available. For more information, please refer to Section 17.

   Note: Command ^B07 (Continuous Binary Block Read) should not be used while the Auto Delete function is enabled. If ^B07 is invoked while Auto Delete is enabled, the NLJ will erase data without waiting for the polling device to acknowledge reception.

8. Binary Information Block: To send a status information block in binary format, type ^B73 and press [Enter]. The information block includes the Site ID, current time and date, Reason for Action, Partition Record Count, and Percent Full. This information is sent in binary block format, regardless of the current output mode setting.

   Note: Responses to all of the above commands end with <Carriage Return><Line Feed>.

 
FTP PUSH CONFIGURATION:
 
FTP SERVER PARAMETERS 			ACTION PARAMETERS
 
1. Server Address: 	(undefined)    11. Read Session 
2. User Name: 		(undefined)     12. Push Action: 	Off 
3. Password: 		(undefined)     13. Periodic Push: 	1440 Min 
4. Account: 		(undefined)     14. Xmit Attempts: 	5 
5. Directory: 		(undefined)     15. Xmit Delay: 	5 Min 
   (Cont.): 				16. Auto Delete: 	On 
   (Cont.): 				17. Start Time:		(undefined)
6. File Name: 		(undefined) 
7. File Mode: 		Append 
8. File Ext Inc: 	Off
 
MISCELLANEOUS 
21. Force FTP Push 
22. Test FTP Push 
23. Stop FTP Push


Enter Selection, 
Press <ESC> to return to previous menu ... 

Figure 14.3:  FTP Push Configuration Menu (Defaults Shown)

14.4. Retrieving Data Using FTP Push

FTP Push capability allows the NLJ to automatically download stored call records via network to your FTP server.  Downloads can be performed on demand, or according to a user-defined schedule.

In order to use this feature, your installation must include the following:

• A network connection to the NLJ.  Note that the network must be running TCP/IP in order for the NLJ's FTP Push feature to function.



• A network connected FTP server on subnet, or the gateway address must allow packets from the NLJ to be routed to your FTP server.

To configure the FTP Push function, access command mode as described in Section 17.1.  When the Main Menu appears, type 27 and press [Enter] to display the FTP Push Configuration menu as shown in Figure 14.3.

The FTP Push Configuration menu is used to select parameters that will be employed when the NLJ transfers stored data to your FTP server. To define FTP Push parameters, key in the number for the desired item, press [Enter], then follow the instructions in the resulting submenu.  The FTP Push Configuration menu includes the following items:

FTP Server Parameters:

1. Server Address:  The IP address of your FTP server (this is the address that will receive the transferred files). (Up to 15 characters, default = undefined).

2. User Name:  The name that the NLJ will use when accessing the FTP server. (Up to 16 characters, default = undefined).

3. Password:  The password that the NLJ will use when accessing the FTP server. (Up to 16 characters, default = undefined).

4. Account:  The account name that will be used to access the FTP server.  (Up to 16 characters, default = undefined).

5. Directory:  The directory on your FTP server that will receive files transferred from the NLJ. (Up to 48 characters,
   default = undefined).

   Note:  If several different NetLink units will be transferring data to the same FTP server, a unique directory / file name should be assigned to each unit.  This will prevent data from the various NetLink units from overwriting each other.

6. File Name:  The first four characters of the file name that the NLJ's FTP Push feature will assign to each "chunk" of data that is transferred from this unit. The complete file name will include these four characters, three characters which identify the source port, and one character which identifies the data type. If desired, the NLJ can also append a sequentially numbered extension to each file name. For more information, please refer to Section 14.4.1. (Up to four characters, default = undefined).

   Note:  If several different units will be transferring data to the same FTP server, a unique file name / directory should be assigned to each unit.  This will prevent the various NetLink units from overwriting each other's data.

7. File Mode:  If "Append" is selected, each data transfer will be added to the target file on the FTP server.  If "Replace" is selected, each data transfer will overwrite the target file on the FTP server.    If the target file does not exist, then both Append and Replace will create a new file. (Default = Append).

8. File Extension Increment: This option is used to enable / disable automatic sequential numbering of the file names created by the FTP Push feature. When enabled, the NLJ will append a sequentially numbered three digit file name extension (000 to 999), which will be incremented for each new file created by a successful data transfer. When disabled, the extension will not be incremented. (Default = Off).

Action Parameters:

11. Read Session:  Specifies the type(s) of file that will be sent to the FTP server.  When PBX data is collected, the NLJ sorts records according to the Alarm Filter matched.  The "Read Session" item allows you to select data based on this criteria, and also determine the starting point by record number.  For more information on file types, please refer to Section 14.1. The "Read Session Parameters" submenu includes the following:

    1. Source Port:  On NLJ-512 models, this options will always be set to PBX Port A (since this is the only available Source Port). Note that on standard NetLink units, there are three available source ports.  (Default = PBX Port A).

    2. Data Type:  Allows you to choose records based on the Data Type.  When selected, the NLJ will display a submenu, which is used to choose one of the following file types.  Note that only one file type can be selected at a given time.  (Default = All).

       1. All:  Send all records, both Alarm and Non-Alarm.

       2. Standard (Non-Alarm):  Send only records that did not match a clue for Alarm Filter 1 or Alarm Filter 2.

       3. Alarm Filter 1 (All):  Send only records that matched any clue defined for Alarm Filter 1.

       4. Alarm Filter 1 (By Clue):  Send only records that matched a specific clue defined for Alarm Filter 1.

       5. Alarm Filter 2 (All):  Send only records that matched any clue defined for Alarm Filter 2.

       6. Alarm Filter 2 (By Clue):  Send only records that matched a specific clue defined for Alarm Filter 2.

       7. All Alarms:  Send all records that matched either Alarm Filter 1 or Alarm Filter 2.

       Notes:

       • When the "By Clue" options are selected, the NLJ will prompt you to enter the clue name.  If an invalid clue name is entered, the NLJ will redisplay the prompt.
       • When a Data Type is assigned, the FTP Push function will own this partition while the data transfer is in progress.  Other users will not be able to read from the partition until the operation is complete and the FTP connection is terminated.  For example, if the FTP Push Configuration menu selects Non-Alarm data (Data Type), then the Console Port will not be able to read Non-Alarm Data until the FTP Push is complete and the partition is released.

    3. Start Record:  Determines the starting point for data release.  Note that this value can be either a positive or negative number.  (Default = 1).

       • Positive Numbers:  If a positive number is entered, the NLJ will count forward from the beginning of the selected group (Data Type).  For example, if this field is set at "15",  then the NLJ will begin with the 15th record in the group.
       • Negative Numbers:  If a negative number is entered, the NLJ will count backwards from the end of the selected group.  For example if the Start Record is "-3", then the NLJ will send the last three records in the selected group.



12. Push Action:  Enables / Disables the FTP Push operation.  After you have selected FTP Push parameters, make certain to set the Push Action to On.  The Push Action must be enabled in order for the FTP Push feature to function.  (Default = Off).

    Note:  If the Push Action feature is "Off", the selected FTP Push operation will not be performed.

13. Periodic Push:  The amount of time that will elapse between FTP Push operations.  This allows you to schedule the FTP Push feature to regularly transfer data to your FTP Server.  For example, if the Periodic Push is set at 30 minutes, then every 30 minutes, the NLJ will automatically transfer stored data to your FTP Server.  (1 to 9,999 Minutes, Default = 1,440 Minutes / 24 Hours).

    Notes:

    • A periodic FTP Push operation will be delayed if targeted files are being accessed by another user at the time scheduled for data transfer.  The NLJ will delay the periodic push until the other user releases the partition, or exits from command mode.  If the delay lasts longer than the defined Xmit Delay period, the periodic push will then be canceled.
    • A periodic push will not be performed if the specified files are empty (no data).



14. Xmit Attempts:  Determines the number of times that the NLJ will attempt to retransmit data if the FTP operation fails.  (1 to 99 Attempts, Default = 5 Attempts).

    Note:  The NLJ will not perform additional transmit attempts if the specified file(s) are empty, or if the server address, username, password, or account information have not been supplied.

15. Xmit Delay:  Determines the amount of time that will elapse between Transmit Attempts (Xmit Attempts).  (1 to 99 Minutes, Default = 5 Minutes).

16. Auto Delete:  Enables/Disables the Auto Delete function for FTP Push operations.  When enabled, the NLJ will delete records from buffer memory after the FTP server acknowledges reception.  (Default = Off).

17. Start Time: Specifies an exact start time for the next FTP Push operation as described in Section 14.4.2. (Default = undefined.)

Miscellaneous:

21. Force FTP Push:  When this item is selected, the NLJ will immediately perform an FTP Push operation, using the parameters entered at items one through 16.  If there is no data in the partition (Data Type) owned by the FTP Push feature, then the NLJ will not attempt to connect to the FTP Server.  Note that the Forced FTP Push will not effect the Periodic Push schedule.

22. Test FTP Push:  Sends test data in order to determine if FTP Parameters are correctly set.  If the Test FTP Push function cannot establish a connection with the FTP server, the NLJ will display a message that describes the reason the test failed. (e.g. incorrect password).

    Note:  After you have selected new FTP Push parameters, it is recommended to use the "Test FTP Push" feature to make certain that newly selected parameters will work with your FTP server.  If the Test FTP Push function returns an error or is unable to connect to the FTP server, then parameters have probably not been correctly defined.

23. Stop FTP Push:  Terminates any FTP Push operation in progress.  Note that when this item is selected, the NLJ will immediately terminate a Periodic Push or Force FTP Push.

14.4.1. File Names Created by FTP Push

When the FTP Push feature is used to transfer data, the NLJ will assign a name to the file that receives the data. This file name will be based on the user-defined, four character base file name, plus the source port, and data type. If desired, the file name can also include an automatically incremented three character extension. As shown in the example in Figure 14.4, the file name will consist of the following components:

Notes:

• This file naming convention applies only to data that has been transferred by the FTP Push feature. A different file naming convention will be employed when data is transferred using the FTP Server feature. For more information, please refer to Section 14.5.3.



• For NLJ-512 units, the source port will always be "A" (since only one source port is available). Standard NetLink units offer three source ports.

1. File Name (Up to Four Characters):  The base file name defined via item 6 in the FTP Push Configuration menu.  If the file name is not defined, the NLJ will use the first three characters of the Site ID message.  If the Site ID message is not defined, the NLJ will use the letters "PNL".  Note that if the defined file name is less than four characters long, then the NLJ will not use the remaining characters in this field.

2. Source Port (One Character):  The NLJ will list the letter "A" to indicate that records were received via PBX Input Port A (The only source port available). Note that on standard NetLink units, this field may occupy up to three characters, in order to account for the three available source ports on the standard NetLink unit.

3. Data Type (One Character):  The selected Data Type (File Type).  The NLJ will list the number for the data type selected at the FTP Push Configuration menu (see item 11 "Read Session").  These numbers are as follows:

   1. All: Both Alarm Records and Non-Alarm Records.

   2. Standard (Non-Alarm): Only Non-Alarm Records

   3. Alarm Filter 1 (All): All records that matched any clue defined for Alarm Filter 1.

   4. Alarm Filter 1 (By Clue): Only records that matched a specific clue defined for Alarm Filter 1.

   5. Alarm Filter 2 (All): All records that matched any clue defined for Alarm Filter 2.

   6. Alarm Filter 2 (By Clue): Only records that matched a specific clue defined for Alarm Filter 2.

   7. All Alarms: All records that matched any clue defined for either Alarm Filter 1 or Alarm Filter 2.

   For example, if Data Type is defined as "All" (item 1) then the file name will have a "1" in this field.

4. File Extension (Three Characters; Optional):  The NLJ can append a sequentially numbered (000 to 999) three digit extension.  This number will be incremented after each successful data transfer.  If the Data Type or Source Port are changed, the file extension will be reset to "000".

Examples:

• If the File Name is defined as "DATA", and the FTP Push Configuration menu has been set to download all data (Option 1), then the first file name written at the FTP server would be "DATAA1.000".



• If the File Name is defined as "PBX", and the FTP Push Configuration menu has been set to download Standard Data (Option 2), then the first file name written at the FTP server would be "PBXA2.000".



• If the File Name has not been defined, but the Site ID message is "WASHINGTON", and the FTP Push Configuration Menu has been set to download all alarm data (Option 7), then the first file name written at the FTP server would be "WASA7.000"

14.4.2. FTP Push Start Time

The "Start Time" parameter in the FTP Push Configuration menu allows you to specify an exact start time for an FTP Push operation. The Start Time is indicated using 24 hour (military clock) format. Note that the FTP Push operation specified by the FTP Push Start Time will be performed in addition to any Periodic Push actions that are defined, and that after the FTP Push Start Time elapses, additional Periodic Pushes will be scheduled relative to this user defined Start Time.

For example, assume that the periodic push value is 120 minutes (two hours.) Normally, the NLJ might perform a periodic push at 1:30, 3:30, 5:30 and etc. However, if the FTP Push Start Time is then set at 4:00, the NLJ will perform the 1:30 and 3:30 periodic pushes according to the previous schedule, but will then perform an additional FTP push at 4:00 (as specified by the FTP Push Start Time), the timer will then be reset, and the next periodic push will not occur until 6:00 (two hours after the start time,) and additional periodic pushes would be scheduled for two hour intervals after the FTP Push Start Time.

Providing that all FTP Server parameters are defined, and the real-time clock has been accurately set, the FTP Push Start Time will cause the unit to perform one FTP Push at the specified start time, and then reset the timer for Periodic Push operations. Once the FTP Push Start Time is selected, it will be applied once during the next 24 hour period, and that Start Time will effectively be established as the new "zero hour" for timing future periodic push operations.

Note: Although the FTP Push Start Time will normally only be observed once during the 24 hour period after it is first set, the FTP Push Start Time will also apply when any of the following events occur:

• When the FTP Push Start Time is defined or changed.
• When the "Push Action" parameter (FTP Push Configuration Menu, Item 12) is enabled or re-enabled.
• When the value for the "Periodic Push" parameter (FTP Push Configuration Menu, Item 13) is changed.
• When saved parameters are uploaded to the NLJ unit as described in Section 13.2.
• When the NLJ unit is powered Off, and then powered On again.

 
FTP SERVER CONFIGURATION
 
FTP SERVER PARAMETERS 
1. User Name: 	    (undefined) 
2. Password: 	    (undefined) 
3. Filename: 	    (undefined) 
4. Auto Delete:     Off 
5. Audit Trail:     Off 

MISCELLANEOUS 
11. Stop FTP Session

Enter Selection, 
Press <ESC> to return to previous menu ... 

Figure 14.5:  FTP Server Configuration Menu (Defaults Shown)

14.5. The FTP Server Feature

The FTP Server feature enables the NLJ unit to function like a standard FTP server. You can connect to the NLJ using the FTP client program of your choice, and then select and retrieve files. In order to use this feature, your installation must include the following components:

• A network connection to the NLJ. Note that the network must be running TCP/IP in order to use the NLJ's FTP server function.



• An FTP client (e.g. DOS FTP, WS FTP, Cute FTP, etc.) installed on the remote PC which will drive the data release.

14.5.1. Configuring the FTP Server Feature

To configure the FTP Server function, access the command mode as described in Section 17.1. From the Main Menu, type 28 and press [Enter] to display the FTP Server Configuration menu (Figure 14.5). This menu is used to define parameters that will be employed when a user attempts to create an FTP connection with the NLJ. To define FTP Server Parameters, key in the number for the desired item, press [Enter], then follow the instructions in the submenus. The FTP Server Configuration menu includes the following items:

FTP Server Parameters:

1. User Name: The name that a remote user will employ when creating an FTP connection to the NLJ. (Up to 16 Characters;
   Default = Undefined).

2. Password: The password that a remote user will employ when creating an FTP connection to the NLJ. (Up to 16 Character;
   Default = Undefined).

3. Filename: The first four characters of the file name that the NLJ's FTP Server function will assign to each category of data stored in buffer memory. The complete file name will consist of these four characters, one character which indicates the source port, and two characters which indicate data type. For more information, see Section 14.5.3. (Up to four characters; Default = Undefined).

   Note: If you are using the FTP Server function to retrieve data from several different NetLink units, a unique file name should be assigned to each unit. This will prevent the data from one unit from overwriting data from another unit.

4. Auto Delete: Enables / Disables the Auto Delete function for FTP Server operations. When enabled, the NLJ will delete records from buffer memory after your FTP client acknowledges reception. (Default = Off).

   Notes:

   • When Auto Delete is enabled, the NLJ will only delete records after your FTP client acknowledges reception. If the data transfer is aborted or interrupted, the Auto Delete Function will not delete records from memory.
   
   
   
   • When Auto Delete is enabled, the unit will not display a prompt before deleting records from buffer memory.

5. Audit Trail: Enables / Disables the Audit Trail for FTP Server operations. When enabled, the NLJ will create a log which lists all FTP connections, including the duration of the connection, password entered, and status at disconnection. (Default = Off).

Miscellaneous:

11. Stop FTP Session: Aborts any FTP session currently in progress.

14.5.2. Retrieving Data Using FTP Server

Since the FTP Server feature will function with a variety of different FTP clients (e.g. DOS FTP, WS FTP, etc.), the exact procedure will differ slightly depending on the client used. Although this section describes the general concept for transferring data using the DOS FTP client, note that the general concept can also be applied to other FTP clients.

Note: When the FTP Server feature retrieves data, records cannot be selected according to the alarm clue matched.

1. From the DOS prompt at your remote PC, type FTP ipaddress and press [Enter] (where ipaddress is the IP address assigned to the NLJ). Note that the NLJ's IP address is set using the Network Parameters menu as described in Section 4.4.4.

2. The FTP Server (NLJ) will acknowledge that a connection has been made, and that the server is ready. The FTP client will then prompt you to enter your username. Key in your username and press [Enter]. Note that the username is defined via the FTP Server Configuration menu as described in Section 14.5.1.

3. If the valid username is entered, the FTP Server will return a message which indicates that the username was accepted. The DOS FTP client will then prompt you to enter your password. Key in your password and press [Enter]. The password is defined using the FTP Server Configuration menu as described in Section 14.5.1.

4. If the valid password is entered, the FTP Server will return a message which indicates that the login was accepted, and the FTP client will display the "FTP>" prompt.

   Note: The NLJ will allow three attempts to enter a correct user name or password.

5. At the "FTP>" prompt, type dir and press [Enter]. The FTP Server will return a directory listing which indicates the names and status of the various files which contain the buffered call data.

   1. Each file will contain a specific type of data. The name of each file indicates the Data Type and Source Port for all records contained in the file. For more information on file names for the FTP Server function, please refer to Section 14.5.3.

   2. The directory listing will also indicate the number of records in each file, and the "Free" status of each file. Any file which is currently partitioned to another user will be listed as "Locked".

6. Refer to the displayed file names, and select the file which contains the data that you need to retrieve. At the "FTP>" prompt, type
   get filename and press [Enter] (where filename is the name of the file which contains the desired data.)

7. The FTP Server (the NLJ unit) will return a series of response messages, and the selected file will be transferred to the current directory on your remote PC. To retrieve additional files, repeat step 6 above.

8. When you have finished retrieving files, type bye and press [Enter]. The FTP connection will be terminated.

 
c:\data\ ftp 192.168.100.236 
Connected to 192.168.100.236. 
220 NetLink FTP server ready. 
User (192.168.100.236: (none)): WTI 
331 User name okay, need password 
Password: 
230 Login accepted. 
ftp> dir 
200 PORT command successful. 
150 Opening data connection. 
File 		Records  Status 
testAST 	   1172  Locked 
testAA1 	    990  Locked 
testAA2 	      0  Free 
226 Transfer complete. 
ftp: 350 bytes received in 0.16 Seconds 2.19 Kbytes/sec. 
ftp> get testAST 
200 PORT command successful. 
150 Opening data connection. 
226 Transfer complete. 
ftp: 107400 bytes received in 29.33 Seconds 3.66 Kbytes/sec. 
ftp> bye 
221 Goodbye 
c:\data\ 

Figure 14.6:  FTP Server Example

FTP Server Example:

Figure 14.6 shows the commands and responses that might result when a DOS FTP client connects to the NLJ FTP Server, and retrieves a file named "testAST". In Figure 14.6, note that all commands entered by the user are shown in bold text.

1. In the first line of Figure 14.6, the user invokes the FTP command at the DOS prompt, specifying the IP address for the NLJ unit. Two response messages are then displayed to acknowledge the connection, and indicate that the server is ready.

2. The DOS FTP client then prompts for a username. The user keys in the username "WTI" and presses [Enter]. The FTP server responds with a message that verifies that the username was valid.

3. Next, the FTP client prompts for a password. The user keys in the password and then presses [Enter]. The FTP server then verifies that the Login was accepted. Note that the password is not echoed back to the FTP client, and is therefore not shown in this example.

4. When the FTP client displays the "ftp>" prompt, the user keys in the dir command and presses [Enter] to display names of available files. The dir command also displays the number of records and the Locked/Free status of each file. Files listed as "Locked" are currently partitioned by another user.

5. In this example, the user wishes to retrieve the file that contains standard, non-alarm (ST) records. Therefore, the name of the file that must be retrieved is "testAST". For more information on file naming conventions for the FTP server function, please refer to Section 14.5.3. The user then checks the dir listing, locates the desired file, and checks to make certain that it is free.

6. At the "ftp>" prompt, the user keys in the get testAST command to retrieve the desired file. Several response messages are displayed to indicate that the PORT command was successful, the data connection was opened, and that the transfer is complete. The FTP speed statistics are then listed. At this point, the file "testAST" has been downloaded to the resident directory on
   the user's PC.

7. The FTP client displays the "ftp>" prompt again, and the user types "bye" and presses [Enter] to terminate the FTP session. This command is followed by a response message which indicates that the connection was successfully terminated.

14.5.3. File Names for the FTP Server Function

When your FTP program connects to the NLJ, it will display a series of file names. Each file name denotes the type of data stored in the corresponding file. The file names generated by the FTP server function are based on the user-selected basic file name, the source port, and the data type. As shown in Figure 14.7, the file name will consist of the following components.

Notes:

• This file naming convention applies only to the FTP Server function. A different convention is used when data is transferred using FTP Push. For more information, please refer to Section 14.4.1.



• For NLJ-512 units, the source port will always be "A" (since only one source port is available). Standard NetLink units offer three source ports.

1. File Name (Up to Four Characters):  The base file name defined via item number 3 in the FTP Server Configuration menu. If the file name is not defined, the NLJ will use the first three characters of the Site ID message.  If the Site ID message is not defined, the NLJ will use the letters "PNL".  Note that if the defined file name is less than four characters long, then the NLJ will not use the remaining characters in this field.

2. Source Port (One Character):  The NLJ will list the letter "A" here to indicate that records were received via PBX Input Port A (The only source port available).

3. Data Type (Two Characters):  The NLJ will list one of three different data types: ST indicates that the file contains Standard (Non-Alarm) data, A1 indicates that the file contains records that matched Alarm Filter 1, and A2 indicates that the file contains records that matched Alarm Filter 2.

Examples:

• If the base file name is defined as "TEST", and the File contains standard, non-alarm data (ST), the file name would be "TESTAST".



• If the base file name is "PBX", and the file contains records that matched Alarm Filter 2 (A2), then the file name would be "PBXAA2".



• If the base file name is not defined, but the site ID is "ACME", and the file contains records that matched Alarm Filter 1 (A1), then the file name would be "ACMAA1".

14.5.4. Commands Supported by FTP Server

The FTP Server function supports the following commands:

• ABOR - Aborts the current FTP operation.



• DELE filename - Deletes the specified file name from the FTP Server, where filename is the file you intend to delete. The DELE command can only be applied to the last file read.

  Note: If a file transfer is aborted before completion, the DELE command will still delete the target file, even though the file has not yet been transferred to your remote PC.

• HELP cmdname - Displays help information for the specified command (where cmdname is the target command). If cmdname is omitted, then the HELP command will display a summary of all available FTP commands.



• LIST (Also DIR or LS) - Displays a listing of all files residing in the current directory at the FTP server.



• NOOP - (No Operation) Keeps the FTP connection alive without actually initiating a command function.



• PASS password - The FTP client uses this command to submit the user-entered password to the FTP Server (the NLJ).



• PORT h1,h2,h3,h4,p1,p2 - Sends the client's IP address and port number to the FTP Server, where h1,h2,h3,h4 is the IP address and p1,p2 is the port number.



• PWD - Displays the current active directory at the FTP Server.



• QUIT - Terminates the FTP connection.



• RETR filename - Retrieves the specified file from the FTP Server, where filename is the desired file.



• SYST - Displays the type of Operating System that is used by the FTP Server (e.g. Unix).



• TYPE [A|I] - Specifies the type of file that is being transferred as either A (ASCII) or I (Image/Binary).



• USER username - The FTP client uses this command to submit the entered username to the FTP Server.



• XPWD - Displays the currently active directory at the FTP Server.

14.5.5. Response Messages Generated by the FTP Server Function

The FTP Server function will send the following messages in response to commands issued by the FTP client:

Positive Intermediate Reply
331 User name okay, need password.

Permanent Negative Completion Reply
500 Invalid userid/password.
500 Syntax error (command unrecognized).
501 Syntax error (invalid argument).
502 Unknown help command.
530 Please login with USER and PASS.
530 Already logged in.
530 TYPE is not supported.
550 File can't be retrieved, partition set by other port.
550 File can't be deleted, partition is not set.
553 File doesn't exist.
553 File is empty.

14.6. The Auto Delete Function

When the Auto Delete option is enabled, the NLJ will delete data from internal memory immediately after the polling device acknowledges reception.

Notes and Cautions:

• When Auto Delete is enabled, the "Hold End Data" function must also be enabled. The data release command must also specify the number of records that will be included in each read. This will ensure that data will not be deleted until reception is acknowledged.



• Do not invoke Command ^B07 (Continuous Binary Block Read) while Auto Delete is enabled, because the NLJ will erase data without waiting for the polling device to acknowledge reception.



• When Auto Delete is enabled, data cannot be released according to the Clue Name matched.



• When Auto Delete is used with ASCII, Binary Block, or Xmodem data release, data is deleted in 16 kilobyte blocks. Auto Delete will not clear a block unless all data from the 16K block has been released. Therefore, if the user releases only part of a block, resets the partition, and then re-invokes the original data release command, records from the partial (undeleted) block will be released again.



• Auto Delete functions independently for each command port and for each FTP method. In other words, Auto Delete may be enabled for menu driven data retrieval via the Network Port, and at the same time, disabled for the FTP Push function.

14.7. Zmodem Data Release Mode

When using Zmodem to release data, make certain your communications program (e.g. ProComm) is set to prompt for a new file name when downloaded data is stored. This will prevent the communications program from accidentally overwriting data from the previous download. When the NLJ's Auto Delete function is enabled, the "prompt for filename" option also prevents the unit from deleting unread data when ProComm's crash recovery feature is enabled.