Log File Transfer Utility
For Catalyst’s with firmware version 1.83 or higher, there is a utility that has been developed to aid the retrieval of log files. This command line “Log File Transfer Utility” will allow you to download Catalyst log files, without the need for third party terminal applications, such as ProComm. The Log File Transfer Utility can be scheduled to transfer log files without operator interaction. Log files are saved in the Aware\Log directory.
To provide greater flexibility with how the data is retrieved, the transfer session will use the “Transfer Options” parameters set within Alarmware. Transfer Options enable data filtering and control over log file names and formats. In addition, LOGTRAN will perform error detecting and correcting due to line noise.
The session is initiated by delivering a command line to the Windows command line interpreter. This is accomplished by:
- Typing at the command prompt in a console window
- Clicking on a configured desktop icon
- Selecting a configured Start Menu item
- Adding a “Scheduled Task” using the Windows Scheduler
The command line syntax is either:
LOGTRAN “RTU name” direct uses Alarmware’s comport settings to connect
LOGTRAN “RTU name” dial uses Alarmware’s modem settings to connect
The RTU name argument must be identical with the RTU name configured with Alarmware’s “Select RTU” dialog. If there are any blank spaces in the name, quotation marks must be used. All arguments must be specified. There are no abbreviations.
When the session has been initiated, LOGTRAN will attempt a session with the specified Catalyst using the specified communications resource. A small dialog window will indicate the session progress. The session may be aborted at any time.
LOGTRAN notes:
- If PINs are configured, Alarmware PIN must have a privilege of ACKNOWLEDGE or greater.
- If Alarmware is running, while LOGTRAN is running, then they cannot share the same communication resource. If Alarmware has control of the port, then the LOGTRAN session will fail.
Instructions for setting up a desktop icon:
- Right-click on an empty space on your Windows desktop
- Select “New” and “Shortcut”
- Click the “Browse” button to locate “logtran183.”
- Click OK.
- Click Next.
- Enter a title for the icon. Describe the Catalyst’s duties or location.
- Click Finish.
- When the icon has been created on the desktop, right click on the icon and select “Properties.”
- The command line is shown here as the “Target.” The syntax “Catalyst Name” and dial has been added to the command line. Be sure that the “Start in” directory is the same as the directory where Aware and Logtran are located.
- Click OK.
- Double-clicking on the icon will now initiate a session to the configured Catalyst.
Instructions for adding a LOGTRAN task to the Windows Scheduler:
- From the Start menu, select Accessories | System Tools | Scheduled Tasks
- When the scheduler window appears, click on the “Add a Scheduled Task” icon. This will launch the “Scheduled Task Wizard.
- Click Next.
- Click Browse.
- Browse for the Aware directory, then select logtran183.exe. Click Open.
- Type in a title for the Catalyst scheduled task. Provide some useful information within the title for later reference.
- Select the frequency of this scheduled task. In this example, “Daily” has been selected. Click Next.
- Set the time of day you would like the event to start. In this example, the scheduled task will begin at 12:00 noon. The task will be performed every day and will begin April 15, 2003. Click Next.
- The task has now been scheduled, but there are still some properties that need to be configured.
- Select the “Open advanced properties for this task when I click Finish” checkbox. Click Finish.
- The Catalyst task properties dialog will appear.
- On the “Run” line, modify the command line to include the Catalyst Name, followed by the connection type [direct or dial]. Ensure the “Start in” directory is the Aware directory.
- Click on the “Schedule” tab.
- Click on the “Advanced” button.
- In this example, the scheduler will repeat the task every 4 hours, for a 24 hour period. Click OK.
Notice the new Catalyst task is now listed among the scheduled tasks.