64250373-winfiol

WinFIOL

IN THIS DOCUMENT

Table of Contents

General

Channel Handling

Dialog Boxes and Windows

Script

Scheduler

Macros

DDE

Configuration

Advanced

WinFIOL Tools and Configuration

Miscellaneous

Glossary of Technical Terms

March, 1999

WinFIOL Printed DocumentationPage 2 of 194

EN/LZT 102 3053 R2A

WinFIOL PRINTED DOCUMENTATION

Copyright © 1999. Ericsson Business Networks AB. All rights reserved.

This document contains proprietary information, which is protected by copyright. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, recording, or by any information storage and retrieval system, or translated into another language, without prior written consent of Ericsson Business Networks AB, Stockholm, Sweden.

Microsoft is a registered trademark. Windows is a trademark of Microsoft Corporation.

NOTICE

The information in this document is subject to change without notice.

ERICSSON MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THIS MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Ericsson shall not be liable for errors contained herein nor for incidental or consequential damages in connection with the furnishing, performance or use of this material.

March 1999


Table of Contents

WinFIOL...........................................................................................................................1

IN THIS DOCUMENT.............................................................................................1

Table of Contents.............................................................................................................1General............................................................................................................................1Channel Handling.............................................................................................................1Dialog Boxes and Windows..............................................................................................1Script................................................................................................................................1Scheduler.........................................................................................................................1Macros.............................................................................................................................1DDE.................................................................................................................................1Configuration....................................................................................................................1Advanced.........................................................................................................................1WinFIOL Tools and Configuration....................................................................................1Miscellaneous..................................................................................................................1Glossary of Technical Terms............................................................................................1

TABLE OF CONTENTS.........................................................................................3

GENERAL...............................................................................................................7

About WinFIOL 5.2...........................................................................................................7What’s New in WinFIOL 5.2.............................................................................................7What’s New in WinFIOL 5.1...........................................................................................10What's new in WinFIOL 5.0............................................................................................11Select text (general).......................................................................................................12Send lines (general).......................................................................................................13Error handling (general).................................................................................................15X-modem (general)........................................................................................................15Logging (general)...........................................................................................................16Drag and Drop................................................................................................................17Options in WinFIOL........................................................................................................18Supported browsers (general)........................................................................................18

CHANNEL HANDLING........................................................................................20

Channels (general).........................................................................................................20Open Channel (general).................................................................................................20Communications Port.....................................................................................................21Port configuration...........................................................................................................22Associate with Channel..................................................................................................23Open channel.................................................................................................................23Reopen channel.............................................................................................................24Reopen channel (More)..................................................................................................24Close channel................................................................................................................25Channel mode................................................................................................................25TTY mode......................................................................................................................26Setup mode....................................................................................................................27Buffered mode................................................................................................................28

March 1999


DIALOG BOXES AND WINDOWS......................................................................29

Channel Properties Dialog Box......................................................................................29Preferences dialog box...................................................................................................42Target Manager (general)..............................................................................................53Status information..........................................................................................................54Queue............................................................................................................................55Input window..................................................................................................................56Output window...............................................................................................................58Command file window....................................................................................................59Message window............................................................................................................61Traffic setup...................................................................................................................67Scheduler window..........................................................................................................70Print Dialog Box.............................................................................................................72

SCRIPT.................................................................................................................73

Script Commands...........................................................................................................73Internal Script Commands..............................................................................................73External Script Commands.............................................................................................75Debug Script Commands...............................................................................................77Script Variables..............................................................................................................79Script Syntax Check.......................................................................................................80Script Module Contents..................................................................................................81List with External Script Commands...............................................................................82List with Internal Script Commands..............................................................................115

SCHEDULER......................................................................................................121

Scheduler (general)......................................................................................................121Schedule command files (general)...............................................................................121Scheduler exceptions (general)....................................................................................122Scheduler files (general)..............................................................................................123Time and date (general)...............................................................................................124Scheduler status (general)...........................................................................................124Scheduler options.........................................................................................................125Scheduler options: General page.................................................................................126Scheduler options: Transmit page................................................................................127

MACROS............................................................................................................128

Macros (general)..........................................................................................................128Writing a Macro............................................................................................................129List of macro commands..............................................................................................130

DDE.....................................................................................................................136

DDE communication (general).....................................................................................136DDE basics..................................................................................................................136DDE Service and Topics in WinFIOL............................................................................137DDE main topic............................................................................................................138DDE channel topics......................................................................................................143DDE channel request items..........................................................................................144DDE channel hot-links..................................................................................................145DDE channel execute commands................................................................................146

March 1999


DDE example...............................................................................................................150

CONFIGURATION..............................................................................................153

Desktop file & System file.............................................................................................153Start options.................................................................................................................154Translation file..............................................................................................................155Short commands..........................................................................................................156

ADVANCED........................................................................................................157

Detect WinFIOL (advanced).........................................................................................157Locate WinFIOL (advanced).........................................................................................157Channel File Directory..................................................................................................158Setup LDAP Connection..............................................................................................159

WINFIOL TOOLS AND CONFIGURATION.......................................................160

General........................................................................................................................160Channel files................................................................................................................160Network........................................................................................................................161WinFIOL installation.....................................................................................................162Settings........................................................................................................................162Plug-ins........................................................................................................................163Maximum number of channels.....................................................................................164

MONITORING MODULE....................................................................................165

General........................................................................................................................165List of Events................................................................................................................168List of Actions...............................................................................................................173

MISCELLANEOUS.............................................................................................177

Hot Keys in WinFIOL....................................................................................................177Print..............................................................................................................................179Log input......................................................................................................................179Log output....................................................................................................................180Open file.......................................................................................................................181Connect........................................................................................................................182Break............................................................................................................................183Release terminal..........................................................................................................184Cut text from window into clipboard..............................................................................185Copy text from window into clipboard...........................................................................185Paste text from clipboard into window..........................................................................186Delete block from text...................................................................................................187Undo last edit action.....................................................................................................188Redo last undone edit action........................................................................................188Copy text directly..........................................................................................................189Move text directly.........................................................................................................189Import block..................................................................................................................189Save.............................................................................................................................190Save as........................................................................................................................191Save all........................................................................................................................191Transmit file from disk..................................................................................................192

March 1999


Write block...................................................................................................................193Send line or block.........................................................................................................193

March 1999


General

About WinFIOL 5.2

Activate

Menu Help | About

Function

Show license and version information.

Support

For Ericsson support, please contact your local Ericsson office.

What’s New in WinFIOL 5.2

Introduction

WinFIOL 5.2 has a few new functions which are listed below.

Dial mode property page Callback modem

Callthrough modem

Dial Mode Propery Page

The Dial mode property page is used for defining the type of modem connection used to reach the remote exchange. There are three modes: Direct, Call through, and Callback. The Direct mode applies to most cases where the modem connection is created directly. Callthrough mode applies when connecting to remote modems expecting commands for e.g. selecting outgoing line. Callback mode is used for connecting to remote modems that support the call back security feature of calling back to your modem number.

You may define any conversation between WinFIOL and the remote modem by defining the prompts from the remote modem and the corresponding responses. For example, if the mode sends you the string “Please, type password->”, you can define a prompt-response pair containing this prompt and the password by pressing the Add button. When you connect to the remote modem, WinFIOL will try to read the string from the remote modem, and when it is received, send the given password. You may add any amount of prompt-response pairs. WinFIOL will expect the prompts in the given order and send the responses accordingly.

March 1999


General, continued

Dial Mode Propery Page,

continued

The dial mode interface is generic, so that basically any callback or call through modem may work with suitable settings. The CR check box tells if the remote modem expects carriage returns. If it is not checked, newline characters are used for separating lines. The response timeout tells how many seconds WinFIOL waits for a prompt from the remote modem before timing out. The callback timeout tells how long WinFIOL will wait for the callback call from the remote mode before timing out. Wait after read tells how many milliseconds’ delay there is after each read operation.

Only the modem types given below have been tested by Ericsson. Use the suggested settings.

Callback Modem

WinFIOL 5.2 supports Ericsson SBN 2319C callback modem.

For callback modem select the Callback radio button. The example settings are shown below. You may need to modify these depending on your modem configuration. Consult the modem manual.

March 1999


General, continued

Callthrough Modem

WinFIOL 5.2 supports Tracker 2600 call through modems by Data Track Technology Ltd. and the Secure Sentinel Intelligent Port Controller (IPC) Model No. 300 manufactured by MicroFrame Inc.

For call through modem select the Call through radio button. The suggested settings are shown below.

The graphic above displays example Tracker 2600 callthrough modem settings.

March 1999


General, continued

Callthrough Modem, continued

The graphic above displays example settings for the IPC device.

What’s New in WinFIOL 5.1

Introduction

WinFIOL 5.1 has a few new functions, which are listed below.

Error log

Documentation hyperlinks (see Channel properties: Browser page)

Automatically complete command (see Preferences: Miscellaneous page)

Automatically connect when sending (see Preferences: Miscellaneous page)

New Traffic setup dialog box with new options in "Flow" page.

Sounds during transmission

March 1999


General, continued

WinFIOL & Tools Configuration

WinFIOL 5.1 has a new utility called WinFIOL & Tools Configuration. With this utility, you can:

Change the channel file directory.

Define LDAP servers and directories for the Target Manager "Network" page.

Define the location of the desktop file with your personal settings.

Define the WinFIOL plug-ins to be loaded.

Define the maximum number of channel up to 100.

What's new in WinFIOL 5.0

Introduction

WinFIOL 5.0 has a number of new functions, which are listed below. Also the main menu and a number of dialog boxes have been rearranged.

Channels

Users of WinFIOL 3.x and 4.x will notice immediately that the main menu has been rearranged. The channel menu is now the left most and most important menu. Opening a channel is done from the Target Manager.

The channel properties dialog box has been rearranged. The most important pages in this dialog box are: "Protocol", "Target" and "Browser".

Scheduler

The scheduler is a new function in WinFIOL. You can schedule command files for transmission at some later time. The scheduler can be controlled from the scheduler window. Options can be changed in the scheduler options.

Preferences

All preferences are now combined in one dialog box. The following dialog boxes in WinFIOL 4.x have disappeared: button bar dialog box, tools menu dialog box and directories dialog box.

March 1999


General, continued

Other new functions

Dangerous commands Command Form Input log file New browser options, see Channel properties: Browser page Internet links in Tools menu and Tool bar user buttons

Redo last undone edit action

New and changed hotkeys

Release can now be done with Escape. The hotkey for activating help is F1 and cannot be changed. Open channel can now be done with F9. Phone book can now be activated with Shift+F9.

CommandForm can be activated with Alt+F1.

Select text (general)

Introduction

Selected text (or block) is shown in another color. WinFIOL uses two types of selected text: normal and square. See square blocks for the difference. Text selection is used to limit tasks to only a portion of the text.

March 1999


General, continued

Description

The lifetime of selected text when moving the cursor or changing the text depends on the "Block type" setting in the "Editor" page of the preferences dialog box.

The methods to clear or create a text selection are listed below:

Clear selectionClear a text selection by pressing the 5 key on the numeric keypad (Num-lock off) or by clicking with the left mouse button in the text.

Make a text selection with the mouseClick and hold down the left mouse button on the start position of the desired selection. Then move the mouse to the end position and release the mouse button. To extend text selection, hold down the Shift key when clicking the left mouse button. To select whole lines only, hold down the Ctrl key when clicking the left mouse button.

Make a text selection with the keyboardHold down the Shift key while moving the cursor with the cursor keys. Any cursor movement is permitted.

Make a text selection with special keysPress Ctrl+A to select all text. Press Ctrl+B to select all text starting at the current cursor position.

Send lines (general)

Introduction

Man-Machine Language (MML) commands are to be sent to the target exchange to which the channel is connected. MML commands can be mixed with script commands, allowing some simple programming control over an active transmission. MML commands can be sent from the input window and command file windows.

Input window

In the input window of a channel, you can type an MML command and press Enter to send it to the target exchange. In buffered mode, the MML command will only be sent if a target exchange prompt is received. In setup mode, the MML command is sent immediately.

There are four ways to send MML commands from a file to a target exchange:

Send 1 line Send more than 1 line Transmit a file

Schedule a file for transmission

March 1999


General, continued

Send 1 line

A command file is loaded in a command file window. Make sure the command file window is associated with the right channel. Position the cursor anywhere on the line you want to send. If a portion of the text is selected, clear the selection with numeric key 5 (Num-lock off). Then press F4 to send the whole line to the target exchange.

Send more than 1 line

A command file is loaded in a command file window. Make sure the command file window is associated with the right channel. Select text to be sent and press F4 to send the lines.

Transmit a file

Press F2 to transmit a command file. In this dialog box, you can define the file and the number of the first line to be transmitted. Then press Enter.

Schedule a file for transmission

Open the scheduler window and add a file to be transmitted at a certain time in future. At that point in time, the transmission automatically starts.

During transmission

When transmission of a series of commands starts, the transmission dialog box appears. From this dialog box, you can monitor, pause, resume and stop the transmission. The progress of the transmission is shown on a bar moving from 0% to 100%.

During transmission, you can continue editing text (except the text being sent), scroll through any text, change options, go to other applications etc. Even if WinFIOL is not visible or it is iconized, the transmission continues at full speed.

A file being transmitted from disk can be loaded into a command file window at any time just by opening the file. WinFIOL will automatically transmit the remaining lines from the window and not from the disk file. This is convenient when an error has occurred and you want to correct it.

The way WinFIOL functions during transmission can be changed in the traffic setup dialog box. Errors can be logged to the message window.

March 1999


General, continued

Error handling (general)

Introduction

WinFIOL has excellent capabilities of handling errors during transmission. This page describes the most important ones.

Description

When sending a series of MML commands (see Send lines (general)), an error occurs when the MML command is faulty or cannot be accepted. When that happens, WinFIOL can automatically pause the transmission, allowing you to correct the error and resume the transmission. This feature is optional and can be switched off in the "Pause" page of the traffic setup dialog box.

During transmission the transmission dialog box appears from which you can monitor, pause, resume and stop the transmission. Errors can be logged to the message window.

When transmitting a command file from disk and WinFIOL has automatically paused the transmission after an error occurred, you can load the command file into a command file window. WinFIOL will highlight the faulty line, after which you can correct the error. Then you can resume the transmission. WinFIOL will continue the transmission by sending the corrected line from the command file window.

There are many options concerning transmission which can all be switched on and off in the traffic setup dialog box.

X-modem (general)

Introduction

X-modem file transfers provide a means for sending a file from the local computer to the target exchange and receiving a file from the target exchange.

Description

WinFIOL allows file transfers using the X-modem protocol only if an MD110 target type is selected (see "Target" page of the channel properties dialog box). The data is transferred via the communications port selected for a particular channel. During active data transfer, the channel cannot be used for any other purpose, such as sending commands or transmitting data.

To start X-modem file transfer, see: X-modem file selection.

March 1999


General, continued

Logging (general)

Introduction

WinFIOL can write received data to a log file or printer. The following logging functions exist:

Log all received data to a file (log output)

Log all received data of one day to a file (daily log)

Log all received data including control codes to a file (raw received data)

Log certain printouts to a file (active printouts)

Log all received data to the printer

Log all MML commands sent from input window (log input)

Log certain data to file, printer, e-mail (monitoring module)

Output log file

The output logging function allows all received data to be logged to a log file. This log file can easily be switched on or off (see output log file).

Daily log

The daily log function also allows all received data to be logged to a log file. However, there will be one log file for each channel every day. Every day at midnight, a new log file is created. You can switch the daily log file on and off from the "Links" page of the channel properties dialog box.

Raw received data

The raw received data logging function allows all received data, including all protocol-specific control codes, to be logged to a file. Both the RS232 and Telnet protocol support this function. The name of the log file is "rawlogx.log", where x is replaced by the channel number. You can switch the raw log function on and off from the "Links" page of the channel properties dialog box.

Active printouts

The active printouts function allows certain printouts or alarms to be logged to a file. This function works only if the Active printout plug-in is installed (see also Status information).

Log to printer

This function allows all received data to be logged to the printer (see Print). Data from one channel only can be logged to the printer.

March 1999


General, continued

Input log file

The input logging function allows MML commands that are sent from the input window to be logged to a log file. This log file can easily be switched on or off (see input log file).

Monitoring module

The monitoring module is capable on logging various events to a file, printer, e-mail, mobile phone message and other media. These functions work only if the Monitoring module, which is a WinFIOL plug-in, is installed (see also Status information).

Drag and Drop

Files can be dragged from the File Manager or File Explorer and dropped into WinFIOL, where they are opened in a way that depends on the file type.

In the File Manager and File Explorer programs, you can move files around by dragging them with the mouse and dropping them into some other position. You can also drop files anywhere in WinFIOL provided that no dialog box is active.

You can drop files of the following types into WinFIOL:

Command files Channel files Message file

Macro file

You cannot mix the different file types described above when dropping them into WinFIOL. If WinFIOL does not recognize the dropped file type, it is assumed to be a command file.

Command Files

Text files containing MML commands and script commands can be dropped into WinFIOL.

If you drop one or more command files into a channel window, WinFIOL will ask you for each of the dropped files whether to transmit, schedule or load the file. If you choose to schedule the file for transmission, you will have the chance to set the time to start the transmission for each dropped file.

If you drop one or more command files into the scheduler window, WinFIOL will allow you for each of the dropped file to set the time to start the transmission.

Anywhere else in WinFIOL, you can drop one or more command files. WinFIOL will load all such files into command file windows.

March 1999


General, continued

Channel Files

One or more channel files can be dropped into WinFIOL. WinFIOL will open a channel for each such channel file.

Message Files

One message file can be dropped into WinFIOL. WinFIOL will open the message window and load the message file. If the message window already contains messages, they will be replaced.

Macro Files

One macro file can be dropped into WinFIOL. WinFIOL will run the macro from the macro file.

Options in WinFIOL

Options

All channel-specific settings can be changed in the channel properties dialog box.

All options concerning transmission of MML commands and error handling can be changed in the traffic setup dialog box.

From the Options menu, you can activate dialog boxes with which to:

change message options change scheduler options change any preferences load options from disk

save options to disk

Modes

WinFIOL has a few modes that can be changed at any time:

Channel mode Insert/Overtype mode (Keyboard: Insert) Square blocks

Block type, see the "Edit" page in the preferences dialog box

All options except the channel properties are saved in the desktop file and system file.

Supported browsers (general)

Introduction

All tools in the product "Element Management, WinFIOL and Tools" and other programs share the browser support. This help page describes which browsers are currently supported and how to configure them.

March 1999


General, continued

Description

As of this writing, the following browsers for AXE and MD110 documentation are supported:

AXE Library Explorer (ALEX), all versions DynaText, versions 2.3 and 3.1 DocView for Windows, versions 3.0 and later (AXE only)

KRSWin, version 3.2.23 (AXE only)

Configuring

AXE Library Explorer does not need any setup. Select "ALEX (remote)" when using Netscape or Internet Explorer to access a database on the net. WinFIOL and tools will remember where the databases are located. Select "ALEX (local)" when using ALEX for Windows. In this case, ALEX for Windows will remember where the databases are located. You can define the book to use by choosing the name in the second column of the list with databases in ALEX.

DynaText needs to be configured in the Browser page and DynaText setup page of the channel properties dialog box.

DocView for Windows does not need any setup. You can define the book to use by specifying the name of the database and sub-database given by DocView, separated by a comma.

KRSWin does not need any setup. KRSWin is located from the KSC.INI file in the Windows directory. You can define the book to use by choosing the name in the KRSWin Library window.

March 1999


Channel Handling

Channels (general)

Introduction

The entity responsible for communication towards a target exchange is called a channel, which is represented by a channel window. WinFIOL handles channels in an object-oriented way:

each channel is completely independent, a channel can be opened a channel can be closed channel settings (properties) can be changed

channel settings are automatically saved.

Channel windows

Each channel is visually represented by a channel window, which is split into two parts. The upper part is the output window and the lower part is the input window. A movable bar separates the input window and the output window.

Normally, up to 9 channel windows can be opened simultaneously. It is possible to close all channel windows. When a channel is closed, the communication port is also closed and all channel settings are automatically saved in the channel file.

Channel settings

A channel is normally opened from the Target Manager dialog box (see Open channel). The Target Manager maintains all channel settings in channel files. You can change the channel settings in the channel properties dialog box. All channel settings are automatically saved (see also Channel file directory).

Open Channel (general)

Introduction

This help page describes how to start a new channel. Read this if you have not worked with channels in WinFIOL 5.0 before.

Step 1: Open a channel

From the channel menu, select Open to display the Target Manager dialog box. From one of three pages, "Network", "History" and "New", you can select a target, previously opened channel or new channel respectively (the "Network" page is not always available). After pressing the "Open" button, the channel will be opened.

It is also possible to reopen a channel from the channel menu. This menu lists up to nine previously opened channels, sorted by number.

March 1999


Channel Handling, continued

Step 2: Adjust communication settings

If WinFIOL indicates that it cannot open the communications port, press OK in the diagnostics dialog box so that the channel properties dialog box appears and you can change the communications settings in the pages under "Protocol". Similarly, the diagnostics dialog box will appear if no target type has been selected in the "Target" page of the channel properties dialog box.

Step 3: Connect to an exchange

You now have a channel. When using the protocol "RS 232 (serial port)", you should have a direct connection with the target exchange. With a modem or TCP/IP network connection, you need to connect to a target exchange first. With a modem, you can specify a number when opening the port or activate the phonebook and dial a number. When using TCP/IP, log on to a server by typing the host name or IP address and press the OK button. Continue the procedure by typing your user name and password in TTY mode, followed by commands to connect to the target exchange. Once a communication path has been established with an exchange, press F5 to connect.

After closing a channel it can be reopened from the "History" page of the Target Manager dialog box or from the channel menu.

Communications Port

Introduction

The communications port is the general name for the interface to the target exchange (e.g. AXE, MD110 etc.) that each channel in WinFIOL is connected to. Examples are a serial port or TCP/IP network connection.

Port type

The port type is determined by the communication protocol, which can be selected in the "Protocol" page of the channel properties dialog box. For example, when selecting the protocol "RS 232 (serial port)", the port type is an RS 232 serial connection. Similarly, when selecting the protocol "TCP/IP (telnet)", the port type is a network TCP/IP connection, using the TELNET protocol.

March 1999



Port status

A communication port can have "closed" status, i.e. there is no connection to the target exchange (AXE, MD110 etc.). The status line shows "Port closed". The port can be opened by pressing OK in the channel properties dialog box, or from the input window by pressing Enter or Connect.

If the communication port is opened, the status line shows one of the following texts: "Port opened", "Released", "Connected", "Trying ..." or "X-modem" (see Connect, Release and X-modem).

Port configuration

The communication port can be configured in the channel properties dialog box. Depending on the communication protocol selected, e.g. the COM port, baud rate and flow control can be changed. The port configuration can also be changed with a macro command, see port configuration.

Port configuration

Introduction

The communications port can be opened with the macros OpenPort( ) and OpenPortParam( ). This help page describes the format of the configuration string.

Description

A configuration string changes the communication port parameters and its form depends on the selected communication protocol (see "Protocol" page of the channel properties dialog box). Below you will find a description of the format of the configuration strings for the communication protocols currently supported by WinFIOL.

RS232 (serial port)

The format of the configuration string for the RS232 protocol is: "<baudrate>,<parity>,<databits>,<stopbits>". Examples: "9600,e,7,1" or "4800,n,8,1". The number of the COM port (e.g. COM1, COM2) cannot be specified.

Modem (Telephony)

The format of the configuration string for the modem protocols is: "<number>", i.e. the number to dial. Examples: "12345". Which modem to use cannot be specified.

March 1999



TCP/IP (telnet)

The format of the configuration string for the TCP/IP protocol is: "<host>[,port number[,terminal type]]". The host parameter may be a TCP/IP host name or an IP address. Examples: "host.ericsson.se", "123.45.67.89". The port number is optional and should have a numeric value. The default port number (23) can be changed in the channel properties dialog box. The terminal type is optional and should be a string of 15 characters at the most. The default terminal type "unknown" can be changed in the channel properties dialog box. Example: "host.ericsson.se,23,unknown" or "123.45.67.89,,myterm".

Associate with Channel

Activate

Menu Channel | Associate with | <channel>

Function

Assign a command file window exclusively to one channel.

Description

WinFIOL normally supports up to 9 channels simultaneously. When sending one or more lines from a command file window, WinFIOL needs to know the target channel. This can be done by associating the command file window with a certain channel, the number of which is shown on the caption bar as: #1, #2 etc.

A command file window is automatically associated with the current channel when the window is first created (see new command file window and open file). A command file window can be associated to another channel from the popup menu or the main menu "Channel | Associate with".

When lines are being sent from a command file window, it cannot be associated with another channel. Also, the input or output windows cannot be associated to a channel since they represent the channel. The message window is not associated with any channel, since it can handle events from all channels. Similarly, the scheduler window is not associated with any channel.

Open channel

Activate

Tool bar

Menu Channel | Open

Macro OpenChannel( )

DDE [OpenChannel(file)]

March 1999



Function

Open a new channel from the Target Manager dialog box.

Description

This function opens the Target Manager dialog box from which you can select a new channel, a previously opened channel or a channel towards a TMOS exchange. After pressing OK, the new channel is ready to use.

If any setting is incorrect, WinFIOL shows the error (channel diagnostics) and allows you to change the setting. When the communications port of the new channel is closed, press Enter to open it. Establish then a connection using the target exchange with the phone book if necessary and connect the terminal.

When a channel with a valid channel file is closed, all channel settings are automatically saved.

Reopen channel

Activate

Menu Channel | <channel>

Macro ReopenChannel( )

Function

Reopen a previously opened channel.

Description

You can quickly reopen a channel by selecting one of the channel titles at the bottom of the channel menu. Up to 9 closed channels are listed in the Channel menu, starting with the lowest number. It is also possible to reopen channels from the Target Manager dialog box (see Open channel).

The names of the channels shown in the menu are actually the titles of the channel windows. The channel title can be defined in the "Appearance" page of the channel properties dialog box.

Reopen channel (More)

Activate

Menu Channel | Reopen | More

Function

Reopen a previously opened channel.

March 1999



Description

From a dialog box you can quickly reopen a channel. All closed channels are listed in the dialog box, provided that the channel settings have been saved to a valid channel file.

The names of the channels shown in the dialog box are actually the titles of the channel windows. The channel title can be defined in the "Appearance" page of the channel properties dialog box.

Close channel

Activate

Keyboard Ctrl+F4 (only when the channel window is active)

Menu Channel | Close

Macro CloseChannel( )

DDE [Close( )]

Function

Close the current channel window

Description

A channel can be closed at any time. You must confirm closing a channel when:

transmission is ongoing the communication port is open the channel does not have a valid channel file

the channel is locked

All channel settings are automatically saved.

Channel mode

Activate

Keyboard Alt+F5 (toggle mode)

Menu Channel | Mode

Macro SetMode( )

Function

Change the channel mode to buffered, TTY or setup mode.

March 1999



Description

The channel mode determines the extent of buffering in the input window and queuing (see queue dialog box).

In buffered mode, an MML command can be typed in the input window and will be sent to the target exchange on pressing Enter. If a target exchange prompt has not been received, the MML command is queued. This is the normal mode of operation.

In TTY mode, every character typed while the input window is active is immediately sent to the target exchange. Use this mode for typing passwords.

In setup mode, any command typed in the input window is always sent when pressing Enter, even if no target exchange prompt has been received. This mode is useful when connecting to systems other that such target exchanges (i.e. anything but IOG, MD110, Eripax etc.). This situation occurs when using the TCP/IP telnet communication protocol.

Pressing Alt+F5 changes the channel mode. When setup mode is selected as the initial mode or a setup mode prompt is defined in the "Protocol | Mode" page of the channel properties dialog box, Alt+F5 rotates through buffered, TTY and setup mode. Otherwise, Alt+F5 toggles between buffered and TTY mode only.

You can define the initial mode when opening the communication port in the "Protocol | Mode" page of the channel properties dialog box.

TTY mode

Activate


Menu Channel | Mode | TTY

Macros SetMode( ), SetTTY( )

Function

Activate TTY mode.

Description


In TTY mode, every character that is typed when the input window is active is immediately sent to the target exchange. Characters that are sent are usually echoed back so that they will appear in the output window. Additionally, all characters typed are also shown in the input window if the option "Hide characters in TTY mode" in the "Appearance" page of the channel properties dialog box is switched off.

Use this mode for typing passwords or connecting to the local port of the IOG.

March 1999



Sending special codes

By pressing BkSp in TTY mode, ASCII character 8 is sent (the same as Ctrl+H). If you want to type a backspace while connected to an IOG 11, type Ctrl+BkSp and ASCII 127 will be sent.

In TTY, it is possible to send characters with ASCII codes 1 to 26 from the input window. Press Ctrl+A to send ASCII 1, Ctrl+B to send ASCII 2 etc. Note that hot keys defined as Ctrl+x, where x is a letter between A and Z, do not work in TTY mode.

Most useful are Ctrl+D for releasing IOG 11 and Ctrl+X for releasing MD110, Ctrl+M for connect (also possible with Enter). Other useful key combinations are Ctrl+Z for FILUTIL on IOG 11 and Ctrl+E to enter ERIOS when the terminal is directly connected to the local port of IOG 11.

Setup mode

Activate


Menu Channel | Mode | Setup

Macro SetMode( )

Function

Activate setup mode.

Description


In setup mode, any command may be typed in the input window and is always sent by pressing Enter, even if no target exchange prompt has been received. This mode is useful when connecting to any system that is not a target exchange (i.e. anything but IOG, MD110, Eripax etc.). This situation occurs when using the TCP/IP telnet communication protocol.

It can be useful to define setup mode as the initial mode when opening the communication port in the "Protocol | Mode" page of the channel properties dialog box. As another feature, the channel mode can automatically switch from buffered mode to setup mode when a prompt other than a target exchange prompt is received (e.g. a UNIX prompt). Define at least the last part of the alternative prompt in the "Protocol | Mode" page of the channel properties dialog box.

In setup mode it is not possible to break, send and transmit.

March 1999



Buffered mode

Activate


Menu Channel | Mode | Buffered

Macros SetMode( ), SetTTY( )

Function

Activate buffered mode.

Description


In buffered mode, an MML command can be typed in the input window and sent to the target exchange by pressing Enter. If a target exchange prompt has not been received, the MML command is queued. This is the normal mode of operation.

Any MML commands that are queued can be viewed in and removed from the queue dialog box.

March 1999


Dialog Boxes and Windows

Channel Properties Dialog Box

Activate

Tool bar

Menu Channel | Properties

Macro ChannelProperties( )

Function

Change all settings of a channel from a dialog box.

Description

The channel properties dialog box contains a list of pages on the left side. Activating an item in this list with the mouse or cursor keys activates the page on the right side. You can press Ctrl+Tab and Shift+Ctrl+Tab anywhere in the dialog box to select the next and previous page respectively.

The following channel property pages exist:

General: channel name and informational properties

Protocol: select communication protocol

• Mode: always open port, channel mode settings

• Setup pages of communication protocol

Target: exchange type and exchange specific settings

Login/logout: automated login and logout settings

• Login: login configuration

• Logout: logout configuration

Browser: documentation browser, book and other settings

Links: preferences, additional logging, short command file and other settings

• DDE: DDE server settings

• Active printouts: active printouts logging (only if plug-in installed)

• Error log: error logging (only if plug-in installed)

• Dangerous commands: definition of dangerous MML commands (only if plug-in installed)

• Possibly any other pages added by WinFIOL plug-ins

March 1999


Dialog Boxes and Windows, continued

Description, continued

Appearance: channel specific appearance, title, filters, maximum lines

• Colors: channel specific colors

• Font: channel specific font

All channel settings are automatically saved when the channel or WinFIOL is closed (see Channels (general) and Open channel (general)).

Before activating this dialog box, be sure to activate the channel you want to change the settings of, since every channel has its own properties. Do this by activating a channel window or a command file window associated with the correct channel.

Channel properties: General page

Activate

Menu Channel | Properties | General

Function

View general information about the channel and change channel name and owner.

Description

In this page you can change the name of the channel and the owner. It also shows when the channel was first created and last modified. Additionally it tells the name of the channel file and optionally the port configuration and element name.

Options

Channel nameOwned byCreatedLast modifiedFile nameConfigurationElement name

March 1999



Channel properties: Protocol

page

Activate

Menu Channel | Properties | Protocol

Function

Select communication protocol.

Description

In this page you can select the communication protocol. Only when a protocol is selected, the channel can communicate with a target exchange. The tree on the left side of the dialog box will show additional pages under "Protocol". In these pages, you can adjust protocol specific settings.

Options

Protocol

Channel properties: Mode page

Activate

Menu Channel | Properties | Mode

Function

Define whether to open the communications port and channel mode settings.

Options

Open communication port at opening channel

Initial mode: TTY, setup or buffered

Switch from buffered mode to setup mode ...

... when receiving

Channel properties: Target page

Activate

Menu Channel | Properties | Target

March 1999



Function

Define the type of target exchange and related settings.

Description

In this page you can define the type of the target exchange to connect to. The control characters are sent when connecting, releasing and interrupting a long printout (break).

You can add up to 16 target exchange prompts. Be sure at least one prompt is defined, otherwise the connect function will not work properly.

You can change a prompt by selecting it in the list and changing it in the edit field below the list. Any character with an ASCII value between 33 (exclamation mark: !) and 126 (tilde: ~) can be typed directly, any character with an ASCII value under 33 or over 126 should be typed in parentheses, e.g. (n) with n being the ASCII value.

Options

Target exchange typeRestore default settingsControl character: SendControl character: ConnectControl character: ReleaseControl character: Using control character for break (check box)Control character: Break (edit field)Prompts: ListPrompts: Edit fieldPrompts: Sub-cmdPrompts: AddPrompts: DeleteTranslation file

Channel properties: Login/logout

page

Activate

Menu Channel | Properties | Login/logout

Function

Setup automated login and automated logout.

March 1999



Description

To enable automated login, check the Enable login checkbox. A progress dialog is shown during automated login if the Show progress dialog check box is checked for login. The login data is echoed to the main application if the Enable echoing check box is checked.

The same options apply for automated logout. Note that some or all options may be disabled for security reasons. The tree on the left side of the dialog box shows additional pages under "Login/logout". In these pages, you can define the login script and logout script.

Options

Login: Enable loginLogin: Show progress dialogLogin: Enable echoingLogout: Enable logoutLogout: Show progress dialogLogout: Enable echoing

Channel properties: Login page

Activate

Menu Channel | Properties | Login/logout | Login

Function

Define the script for automated login.

Description

The login script is displayed in lists that are divided into prompts and responses. The buttons below the list view allow you to Add, Delete, Insert and Modify lines in the login script. Double clicking on the list view has the same result as the Modify button. Dragging the lines and dropping them on their right place can easily change the order of the lines in the script. To open or save the script to a file, use the buttons right of the list. The script can be read from the file when logging in or out if the check box "Read script from file" is checked. If the check box is unchecked, the script is saved and read from the channel properties.

This page may not be visible for security reasons.

March 1999



Options

List with login scriptUse a script fileNewOpenSaveSave AsAddDeleteInsertModify

Channel properties: Logout page

Activate

Menu Channel | Properties | Login/logout | Logout

Function

Define the script for automated logout.

Description

The logout script is displayed in lists that are divided into prompts and responses. The buttons below the list view allow you to Add, Delete, Insert and Modify lines in the login script. Double clicking on the list view has the same result as the Modify button. Dragging the lines and dropping them on their right place can easily change the order of the lines in the script. To open or save the script to a file, use the buttons right of the list. The script can be read from the file when logging in or out if the check box "Read script from file" is checked. If the check box is unchecked, the script is saved and read from the channel properties.

This page may not be visible for security reasons.

Options

List with logout scriptUse a script fileNewOpenSaveSave AsAddDeleteInsertModify

March 1999



Channel properties: Browser page

Activate

Menu Channel | Properties | Browser

Function

Define which documentation browser to use and related options.

Description

Each channel has its own link to a documentation browser. Likewise, for every channel you can define which book (i.e. library or database) to use. The documentation browser is used for:

Get documentation (COD, POD, OPI etc) Build up the CommandForm in WinFIOL

Fetch data needed for analysing printouts

When connecting to an exchange from "Network" page in the Target Manager dialog box, it is likely that the documentation browser and book is automatically defined. Otherwise, you should define this information yourself.

Options

Browser typeCollectionBookCurrent bookAutomatically look up fault code (WinFIOL only)Start browser immediately (WinFIOL only)

Channel properties: DynaText

setup page

Activate

Menu Channel | Properties | Browser | Setup

Description

When using DynaText 2.3 or DynaText 3.1 as the documentation browser, you need to define the location of the DynaText program and the name of the default book. In addition, you can define some preferences.

March 1999



Options

DynaText locationDefault bookShow table of contents (TOC) in view windowClose view window on disconnection

Collection of books

In the Browser page of the channel properties dialog box, you need to define the collection of books. For DynaText, the collection of books is the location (directory) of the BOOKS sub-directory, in which all DynaText databases are stored. For instance, for a CD-ROM in drive D:, specify D:\ as the location of the book collection. Note that the directory containing the book collection always has a sub-directory called BOOKS.

Trouble shooting

When DynaText cannot be started or does not show any documentation, it could be that a DynaText plug-in is not properly installed. Follow the following steps to check this:

1 Start notepad and load the file DYNATEXT.INI that is in the same directory as DTEXT.EXE.

2 Check that the following lines exist:

PLUGIN_DIRS=<path>

DTEXT_PLUGINS=<plug-ins>

The <path> value should point to a valid directory and the <plug-ins> value should contain one or more plug-in file names (without path), separated by semicolons.

3 Check that <plug-ins> contains PLUGAPI.DLL for DynaText 2.3 and PLGAPI31.DLL for DynaText 3.1.

4 Check that the files PLUGAPI.DLL or PLGAPI31.DLL exist in the plug-in directory specified by <path>.

March 1999



Channel properties: Links page

Activate

Menu Channel | Properties | Links

Function

Define options related to restoring window text, traffic options, logging, short commands, phone book and security.

Options

Preferences: Save output window textPreferences: Save input window textPreferences: Common traffic settingsLogging: Daily logLogging: Raw dataShort command file Default phone book listSecurity level

Channel properties: DDE page

Activate

Menu Channel | Properties | Links | DDE

Description

Define channel specific DDE server settings.

March 1999



Options

Maximum DDE clientsDDE locking: NeverDDE locking: RequestDDE locking: Always

Channel properties: Active

printouts

Activate

Menu Channel | Properties | Links | Active printout

Description

Define, and view the active printouts. You can define active printouts for the current channel and all channels.

Options

Show: PrivateShow: CommonShow: BothList with active printoutsAddDeleteModifyDocumentation

Channel properties: Error log

Activate

Menu Channel | Properties | Links | Error log

Description

Define, and view the error log. You need to define error log settings for each channel.

March 1999



Options

Enable loggingLog to fileLog method: Commands onlyLog method: Printouts onlyLog method: Commands and printoutsLog method: Commands (printouts commented)Options: Add name of transmitted fileOptions: Add statistics at end of log file

Channel properties: Dangerous commands

Activate

Menu Channel | Properties | Links | Dangerous cmds.

Description

Define, and view the system and public dangerous commands. You cannot add, delete or change system dangerous commands.

Start with selecting a dangerous command file by pressing the "File" button. If you select an existing file, it will be read and the list will be filled with all dangerous commands defined in that file. If you specify a file that does not exist, any dangerous commands currently in the list will be written to that file (public list only). By pressing the "Clear" button, the list is cleared and no dangerous command file is specified.

March 1999



Options

List with dangerous commandsShowSystemPublicFileClearAddDeleteModifyDocumentation

Channel properties: Appearance

page

Activate

Menu Channel | Properties | Appearance

Description

Define appearance and related settings of the channel window.

Options

Own colorsOwn fontChannel title from: channel nameChannel title from: channel fileChannel title from: configurationChannel title from: exchange headerChannel title from: element nameFilter: Hide characters in TTY modeFilter: Hide control charactersFilter: Filter exchange headersMaximum lines: Output windowMaximum lines: Input window

March 1999



Channel properties: Colors page

Activate

Menu Channel | Properties | Appearance | Colors

Function

Change colors of the windows related to the current channel.

Description

By changing colors in the channel properties dialog box, you can override the general color setting (see: Preferences: Color page). Affected are the colors in the output windows, input windows and command file windows that are associated with the current channel.

Options

ItemsColorsDefaultBoldMore

Channel properties: Font page

Activate

Menu Channel | Properties | Appearance | Font

Function

Change current font style and size in windows related to the current channel.

Description

By changing the font in the channel properties dialog box, you can override the general color setting (see: Preferences: Font page). Affected is the font in the output windows, input windows and command file windows that are associated with the current channel.

Note: You can install more fonts in Windows with the Control Panel program. When installing WinFIOL, two additional fonts are also installed: "WinFIOL fixed" and "PlexView fixed".

March 1999



Options

FontSize and list of sizesStyle: BoldStyle: FontLine distance

Preferences dialog box

Activate

Menu Options | PreferencesMacro PreferenceDlg( )

Function

Change various personal preferences from a dialog box.

Description

The channel properties dialog box contains a list of pages on the left side. Activating an item in this list with the mouse or cursor keys activates the page on the right side. You can press Ctrl+Tab and Shift+Ctrl+Tab anywhere in the dialog box to select the next and previous page respectively.

The following channel property pages exist:

Session: define options related to starting and quitting WinFIOL

Editor: define editor related options

Miscellaneous: define some unrelated options

Directories: define how to quick-open a log file

• Default: define initial default directory and file type filters

• Transmit: define initial transmit directory and file type filters

• Log files: define initial log files directory and file type filters

• Other: define directories for scheduler, macro, message and X- modem files

Appearance: define appearance of tool bar and command file windows

• Colors: define current colors

• Font: define current font style and size

Tools page (no options)

March 1999


• Menu: define hot keys and extra tool bar buttons

• Tool bar: define menu items to be added to the Tools menu

March 1999



Preferences: Session page

Activate

Menu Options | Preferences | Session

Function

Define which windows to open when starting WinFIOL, and whether to ask for a confirmation when quitting WinFIOL.

Options

Reopen command filesList closed files in File menuReopen channel windowsAsk for confirmation when quitting

Preferences: Editor page

Activate

Menu Options | Preferences | Editor

Function

Define options related to the editor in command file windows.

Options

Options: Indent each new lineOptions: Old style cursor keysOptions: Cursor through tabsBlock type: PersistentBlock type: NormalBlock type: VolatileUndo levelsCursor shape: StandingCursor shape: LayingMake BAK file when saving command fileAuto backups and backup period

March 1999



Preferences: Miscellaneou

s page

Activate

Menu Options | Preferences | Miscellaneous

Function

Define how WinFIOL should switch windows, mouse and audible settings and input window list.

Options

Switch channel with F10 keyAuto switch to input windowMove mouse cursor at questionScroll during thumb trackBeep when showing message boxChronological list in input windowAutomatically complete commandAutomatically connect when sending

Preferences: Directories

page

Activate

Menu Options | Preferences | Directories

Macro DirDlg( )

Description

Define how to quick-open a output log file. Define directory, log file and file type settings in each of the following sub pages:

Default: define initial default directory and file type filters

Transmit: define initial transmit directory and file type filters

Log files: define initial log files directory and file type filters

Other: define directories for scheduler, macro, message and X-modem files

Options

Quick-open log file: Append existing log file

Quick-open log file: Overwrite existing log file

March 1999



Preferences: Default page

Activate

Menu Options | Preferences | Directories | Default

Macro DirDlg(1)

Function

Define the initial default directory and file types and their dynamic behavior. The default directory is used when opening, saving, importing and writing command files.

Description

The default directory is the directory where command files are stored. File selection dialog boxes for opening, saving, importing and writing a selection of command files start with the default directory. You can define for each of these actions whether the default directory should automatically change after opening, saving, importing or writing. The default directory is never permanently changed, so it does not change in the directories dialog box. The changed directory only appears in a file selection dialog box.

A file type filter can be defined for opening, saving, importing and writing a selection of command files. This is the default file type filter. Additionally, the extension of the last selected file for each of these actions can be kept for the next time.

Options

Automatically change the default directory after: Open, Save as, Import file and Write block

Change list of command file types

Retain last used file type after: Open, Save as, Import file and Write block

Preferences: Transmit

page

Activate

Menu Options | Preferences | Directories | Transmit

Macro DirDlg(2)

Function

Define the initial transmit directory and file types and their dynamic behavior. The transmit directory is the default directory from which command files are transmitted.

March 1999



Description

The file selection dialog box for transmitting a command file starts with the transmit directory. You can choose the transmit directory to be the same as the default directory. The transmit directory can automatically change after selecting a file to transmit.

The file type filter used for transmitting a command file can be the same as the default or different. The extension of the last selected transmit file can also be kept for the next time.

Options

Use default directoryTransmit directoryAutomatically change directoryChange list of transmit file typesList of file types same as defaultRetain last used file type

Preferences: Log files page

Activate

Menu Options | Preferences | Directories | Log files

Macro DirDlg(3)

Function

Define the initial log files directory and file types and their dynamic behavior. The log files directory is the default directory where log files are stored.

Description

The file selection dialog box for opening a log file starts with the log file directory. You can choose the log file directory to be the same as the default directory. The log file directory can automatically change after selecting a log file.

The file type filter used for opening a log file can be the same as the default or different. The extension of the last selected transmit file can also be kept for the next time.

March 1999



Options

Use default directoryLog file directoryAutomatically change directoryChange list of log file typesList of file types same as defaultRetain last used file type

Preferences: Other page

Activate

Menu Options | Preferences | Directories | Other

Macro DirDlg(4)

Function

Define the default directories for scheduler files, macro files, message files and X-modem files.

Description

The scheduler file directory is the directory where all scheduler files are stored (see also scheduler files (general)). This directory is fixed. When opening or saving a scheduler file, the file selection dialog box always starts with the scheduler file directory.

The macro file directory is the directory where all macro files are stored. This directory is fixed. When selecting a macro to run, the file selection dialog box always starts with the macro file directory. When compiling a macro, the macro file is written to the macro file directory if no path is specified.

The message file directory is the directory where all message files are stored (see also message window). This directory is fixed. When opening or saving messages, the file selection dialog box always starts with the message file directory.

The X-modem file directory is the directory where all files for X-modem transfer are stored. This directory is fixed. When selecting a file to send or receive, the file selection dialog box always starts with the X-modem file directory.

March 1999



Options

Scheduler file directory

Macro directory

Message file directory

X-modem file directory

Preferences: Appearance

page

Activate

Menu Options | Preferences | Appearance

Function

Define appearance of tool bar and command file windows.

Options

Display Properties

Flat tool bar buttons

Maximum line size

Visible right margin

Tab size

Preferences: Colors page

Activate

Menu Options | Preferences | Appearance | Colors

Macro Colors( )

Function

Change current colors of text windows.

Description

You can specify the general colors in the output windows, input windows and command file windows. WinFIOL automatically colors specific text such as alarms, comments etc., for easy recognition (syntax highlighting).

You can override the selected colors for a channel in the "Appearance | Colors" page of the channel properties dialog box. In this case all channel windows and associated command file windows are shown in distinctive colors.

March 1999



Options

ItemsColorsDefaultBoldMore

Preferences: Font page

Activate

Menu Options | Preferences | Appearance | Font

Macro Font( )

Function

Change current font style and size in text windows.

Description

You can specify the general font in the output windows, input windows and command file windows. The selected font style is also used for printing (see print settings).

You can override the selected font for a channel in the "Appearance | Font" page of the channel properties dialog box. In this case all channel windows and associated command file windows are shown a distinctive font.

Note: You can install more fonts in Windows with the Control Panel program. When installing WinFIOL, two additional fonts are also installed: "WinFIOL fixed" and "PlexView fixed".

Options

Font

Size and list of sizes

Style: Bold

Style: Font

Line distance

March 1999



Preferences: Menu page

Activate

Menu Options | Preferences | Tools | Menu

Macro ToolOptions( )

Function

Define menu items to be added to the Tools menu.

Description

You can add, move, change and delete menu items for the tools menu. Up to 10 extra menu items can be defined. Selecting an extra menu item can e.g. launch an application or send a MML command. Menu items appear in the tools menu in the same order as defined in this dialog box.

To add a menu item, press Add. Enter a name for the menu item. It is possible to underline a character by inserting an ampersand (&) in front of the character. Two typed ampersands will be shown only as one in the menu. In the "Path" field, define one of the following things:

a Windows program a DOS program or batch file an internet address (http://www.ericsson.se) a macro (starts with %) a debug script command (starts with @)

a separator

You can press the browse button to search for programs and macros. Optionally you can define the current directory for programs. You can also define the text to be shown on the status line when the menu item is selected. When pressing OK, all menu items are immediately shown in the tools menu.

You can move the order of the tools by dragging with the mouse or holding down the Shift key and pressing the Up and Down cursor keys.

Options

Items in tools menuNamePathWorking directoryHintAddDeleteSeparatorBrowseAdvanced

March 1999



Preferences: Tool bar page

Activate

Menu Options | Preferences | Tools | Tool bar

Macro ButtonBar( )

Function

Define user buttons and/or hot keys that send an MML command or execute a macro or script command.

Description

You can add, move, change and delete user buttons for the tool bar. Up to 16 user buttons can be defined. Pressing a user button can e.g. start a macro or send a MML command. You can also assign a hot key to each user button. User buttons appear on the tool bar in the same order as defined in this dialog box.

To add a user button, press Add. Optionally press a hot key in the "Hot key" field. Only function keys in combination with Shift, Ctrl or Alt are allowed provided they are not already used by WinFIOL. In the "Command/Macro" field, you can define one of the following things:

an MML command an internet address (http://www.ericsson.se) a debug script command (starts with @)

a macro (starts with %)

Finally, select a picture for the user button from any bitmap file (BMP file). The bitmap will be copied and stored by WinFIOL. When pressing OK, all added user buttons are immediately shown on the tool bar.

Options

List with buttons and hot keysHot keyCommand / MacroAddDeletePictureMacro

March 1999



Target Manager (general)

Activate

Menu Channel | Open

General

Target Manager dialog box can be used for quickly selecting a target from a tree in the Network page or an existing channel from a list in the History page.

Details

The Target Manager dialog box is opened by selecting Open in the Channel menu. You may select a network element from the tree either by double clicking on the desired item or by pressing the Open button. A channel is created and a connection is opened to the target exchange.

The items in the tree designated with a folder icon contain more network elements on the next level. You may open the next level in the tree by clicking on the small plus sign on the left of the tree item. Free targets are marked with a green target icon. Items marked with a red target icon are already open. You cannot selecting the same channel twice.

The network data is retrieved from an LDAP server or central directory. A channel is created even if the data of the selected element is insufficient for connecting to the target. The user may edit the missing or erroneous properties in the Channel Properties dialog box.

Target Manager: Network page

Activate

Menu Channel | Open | Network

Function

Selecting a target from a hierarchical tree of target exchanges.

March 1999



Description

You can select a network element from the tree either by double clicking on the desired item or by pressing the Open button. A channel is created and a connection is opened to the target exchange.

The items in the tree designated with a folder icon contain more network elements on the next level. You may open the next level in the tree by clicking on the small plus sign on the left of the tree item. Free targets are marked with a green target icon. Items marked with a red target icon are already open. You cannot selecting the same channel twice.

The network data is retrieved from an LDAP server. A channel is created even if the data of the selected element is insufficient for connecting to the target. The user may edit the missing or erroneous properties in the Channel Properties dialog box.

Target Manager: History page

Activate

Menu Channel | Open | History

Function

Selecting a target from a list of previously opened channels.

Description

You can select an item in the listview by double clicking on the channel name or by selecting the name and pressing the Open button. The channels can be deleted from the list by selecting an item and pressing Delete button or Delete key.

You can mark any channel in the list as a favorite channel. Select the channel you want to mark as favorite and click the check box labeled "Favorite". The selected item will now contain "F" in the column marked with "Favorite".

Status information

Activate

Menu Help | Status information

Function

Activate the dialog box with status information about WinFIOL.

March 1999



Description

The "General" page of the status information dialog box shows information about the WinFIOL version, the date when it was built and the PRIM product code. It also shows the operating system this WinFIOL version is targeted for. Any operating system not listed here is not supported. The last item shows whether this version of WinFIOL is a debug version or retail version.

The "DDE status" page shows all active DDE conversations and is intended for DDE client program developers. Depending on the DDE client program, the name of the DDE client is shown in the list. For each conversation, you can lock or unlock a channel (see also the "Links | DDE" page in the Channel properties dialog box) and terminate a conversation. All hot-links established by the DDE client with WinFIOL are shown for each conversation. DDE is not supported in the UNIX version of WinFIOL (WinFIOL/U).

The "Plug-ins" page lists all installed plug-ins. Plug-ins can be installed with the WinFIOL & Tools Configuration utility supplied with WinFIOL (Windows version only). The API for plug-ins is not public.

Information in General page

Version and dateProduct identityTarget OSRelease

Information in DDE status page

List of Active conversationsHotlinksLockUnlockTerminate

Information in Plug-ins page

List of loaded plug-insPlug-in information

Queue

Activate

Menu Channel | Queue

Function

View and remove queued MML commands in a dialog box.

March 1999



Description

In buffered mode, when a MML command is sent from the input window and the port status is not "Connected" (shown on the status line), the MML command is queued. Just above the input window a ToolTip window appears showing the number of queued commands. Up to 10 MML commands can be queued.

In a dialog box, all queued MML commands are listed. One or all MML commands can be removed from the queue.

Options

List of queued commandsDeleteClear all

Input window

Activate

Tool bar

Keyboard F10

Menu Window | Input

Function

From the input window, MML commands can be sent manually to the target exchange.

March 1999



Description

The input window is the lower pane of a channel window. From the input window, you can type MML commands and send them directly to the target exchange by pressing Enter. Also some debug script commands can be typed here. Note that MML commands can also be sent from a command file window.

The input window is a line oriented editor. If the "Chronological list in input window" option is set (see "Miscellaneous" page of the preferences dialog box), each line represents a history of send MML commands, the last one sent at the bottom. Otherwise, there are no duplicate lines and the MML command sent last is always at the end of the window. While typing an MML commands in the input window, the remainder of the command is automatically filled in from the most recent command in the input window that matches the typed characters (see "Miscellaneous" page of the preferences dialog box). The maximum number of lines in the output window can be defined in the channel properties dialog box.

To send an MML command to the target exchange, press Enter. In buffered mode, the MML command is only sent when the port status is "Connected" (see status line), i.e. a target exchange prompt has been received. Otherwise, the MML command will be placed in a queue and sent as soon as a target exchange prompt has been received. Whenever commands are queued, a ToolTip window will appear just above the input window showing the number of queued commands. You can view and remove the queued commands in the queue dialog box. If the "Automatically connect when sending" option is set (see "Miscellaneous" page of the preferences dialog box), WinFIOL connects whenever the terminal is released and you send an MML command.

In TTY mode, every typed character is immediately sent to the target exchange, regardless whether a target exchange prompt is received. It is also possible to send characters with ASCII codes between 1 and 26 in TTY mode by pressing Ctrl+A to Ctrl+Z. Finally, in setup mode, any MML command is sent by pressing Enter.

It may be possible that a channel is locked by another application that communicates with WinFIOL via DDE. In this case the status line shows "Locked". You can prevent other applications from locking a channel in the "Links" page of the channel properties dialog box, although this is strongly discouraged. The status of all active DDE conversations can be monitored in the "DDE status" page in the Status information dialog box.

If the communications port is not opened, you can press Enter or Connect to open it.

By pressing Shift+F10 or right-clicking with the mouse, you can activate a popup menu. This menu appears at the upper left corner or where you clicked and contains some of the most frequently needed commands

March 1999



Documentation

Documentation concerning an MML command can be obtained by pressing Ctrl+F1 from the input window. Three situations are distinguished:

If some text is selected, the first line of the selected text serves as the keyword for obtaining documentation.

Just after sending an MML command, while the cursor is still on the last empty line of the input window, the MML command or printout of that command (and even fault code, if any) serves as keyword for obtaining documentation.

Otherwise, the MML command on the line the text cursor is at serves as the keyword for obtaining documentation.

When a fault code is received after sending an MML command, documentation about that command and fault code can be obtained automatically by setting the option "Automatically look up fault code" in the "Browser" page of the channel properties dialog box.

Command Form

The Command Form window can be activated from the input window. Position the cursor on an MML command first.

Output window

Activate

Tool bar

Keyboard F3

Menu Window | Output

Function

The output window collects all data that is received from the target exchange.

March 1999



Description

The output window is the upper pane of a channel window. All data received from the target exchange is added to the bottom of the output window, causing the lines on the window to scroll upwards. The maximum number of lines in the output window can be defined in the "Appearance" page of the channel properties dialog box.

You can scroll through the text in the output window with the cursor keys and the mouse. You can select text with the mouse in order to print, copy, search etc. Pressing Ctrl+P and Ctrl+N allows you to find errors very quickly.

If any data is received when the output window is active, the status line shows "Data received" in red. After this, reception of more data is locked until the output window is deactivated.

In the channel properties dialog box, several options concerning the output window can be changed, including: Save and restore text in the output window, own colors and font, filter target exchange headers etc. By pressing Shift+F10 or by right-clicking with the mouse, you can activate a popup menu to access some of the most frequently needed commands.

By pressing Ctrl+F1 in the output window when there is no text selected, a dialog box is shown in which MML commands and printout headers from the visible part of the output window are listed. From this dialog box, you can have the browser search for related documents. If there is any text selected in the output window, the first line of the selected text serves as a keyword to get help for (see also: help on text under cursor).

Command file window

Activate

Tool bar

Keyboard F7

Menu Window | <command file window>

Function

In a command file window MML commands can be edited and sent to a target exchange.

March 1999



Description

Any ASCII text can be loaded into a command file window. This text is typically a command file containing MML commands and script commands. Any text in a command file window can be edited with an integrated versatile editor. From a command file window, one or more MML commands and/or script commands can be sent to a target exchange. Provided there is enough memory, an unlimited number of command file windows can be opened.

Editor

The editor can hold up to 10,000,000 lines. The line length is defined in the "View" page of the preferences dialog box, with an absolute maximum of 255 characters. The editor can display a right margin and supports tabs. Several other edit options can be defined in the Edit page of the preferences dialog box.

The editor supports cut, copy and paste, undo. Square blocks represent a special type of selected text.

During ongoing transmission, the editor is locked, rendering text editing impossible. When the transmission is paused, text can only be edited on single lines in order to correct errors.

Send

MML commands and script commands can be sent to a target exchange (see Send lines (general)). The target exchange the MML commands are sent to is defined by the channel the command file window is associated with. The number of the channel the command file window is associated with is shown on the caption bar as #1, #2 etc.

Other functions

A command file window can be activated with the F7 function key or from the tool bar. Repeatedly activating a command file window will cycle through all open command file windows. At any time, a new command file window can be started. By pressing Shift+F10 or right-clicking with the mouse, you can activate a popup menu to access some of the most frequently needed commands.

By pressing Ctrl+F1 when no text is selected, help on text under the cursor is shown. If any text is selected, the first line of the selected text serves as the keyword to get help on.

By pressing Alt+F1 when the text cursor is at an MML command, the Command Form is shown. When pressing the "Insert" button in the Command Form, the line will be replaced by the MML command in the Command Form.

March 1999



Message window

Activate

Tool bar

Menu Window | Message

Function

The message window contains messages as a result of the transmission of commands.

Description

All messages and errors concerning transmission are collected and displayed in the message window. The messages shown and their appearance can be defined in the message options dialog box.

There is only one message window. The message window collects messages from all channels, it is therefore not associated with any channel. If the message window is not open no messages will be collected.

Messages can be automatically restored when the message window is opened by setting the "Restore messages" option in the message options dialog box. There are also options defining whether the message window should be opened automatically upon startup of WinFIOL.

From the message window, a popup menu can be activated with Shift+F10 or by right-clicking mouse button. From this menu it is possible to:

view the message in the output window. view the message in the log file (if a log file has been opened). view the message in the source file. mark an error as solved. clear all messages from the list. load messages from a file. save all messages to a file. print all messages. get documentation on the message.

show the message options dialog box.

View message in output

window

Activate

Keyboard Enter

Popup menu View message | Output window

March 1999



Function

Highlight the line in the output window where the result of the message is shown.

Description

During transmission, possible errors and other events can be logged in the message window. From the message in the message window, this command shows the line in the output window in which the event is logged, provided that the line has not scrolled out of the output window yet.

When pressing Enter from the message window, the last used view command (source, output window or log file) is issued.

View message in log file

Activate

Keyboard Enter

Popup menu View message | Log file

Function

Highlight the line in the log file where the result of the message is shown.

Description

During transmission, possible errors and other events can be logged in the message window. From the message in the message window, this command shows the line in the log file in which the event is logged, provided that a log file was open at the time the event occurred. If the log file is not loaded yet, it is loaded into a new command file window.


View message in source

Activate

Keyboard Enter

Popup menu View message | Source

Function

Highlight the line in the command file window where the message comes from.

March 1999



Description

During transmission, possible errors and other events can be logged in the message window. From the message in the message window, this command shows the line in a command file window that caused the message. If the command file is not loaded yet, it is loaded into a new command file window.


Mark error as solved

Activate

Keyboard Space

Popup menu Mark as solved

Function

Mark an error in the message window as solved.

Description

Error messages in the message window resulting from a faulty MML command are no longer valid when a corrected MML command is sent. The error message in the message window can be marked as solved in this case.

When command transmission is automatically paused because of an error and the faulty MML command causing the error is corrected and sent again successfully, the error in the message window is automatically marked as solved.

Clear message window

Activate

Popup menu Clear messages

Function

Discard all messages from the message window.

Description

WinFIOL will give a warning before removing all messages if the option "Give warning when clearing all messages" in the message options dialog box is switched on.

March 1999



Load messages

Activate

Tool bar

Keyboard Ctrl+O

Menu File | Open

Popup menu Load messages

Macro OpenFile( )

Function

Load messages from a binary message file into the message window.

Description

In a file selection dialog box you can select a message file to load. Note that the directory for message files can be defined in the "Directories | Other" page of the preferences dialog box. Only binary message files can be loaded into the message window (see save messages). All existing messages in the message window will be removed.

Message files saved by WinFIOL 3.x and WinFIOL 4.x can be read. However, message files saved by WinFIOL 4.x and WinFIOL 5.x cannot be read by WinFIOL 3.x or lower.

Save messages

Activate

Tool bar

Keyboard Ctrl+S

Menu File | Save

Popup menu Save messages

Macro Save( )

Function

Save all messages in the message window to a message file.

March 1999



Description

In a file selection dialog box you can select a file name for a message file. Note that the directory for message files can be defined in the "Directories | Other" page of the preferences dialog box. When saving the messages to a binary file, it can be loaded into the message window again. This is not true for a text file.

Message files saved by WinFIOL 3.x and WinFIOL 4.x can be read. However, message files saved by WinFIOL 4.x and WinFIOL 5.x cannot be read by WinFIOL 3.x or lower.

Options

Save as text

Print messages

Activate

Tool bar

Keyboard F6

Popup menu Print messages

Menu File | Print

Function

Print all messages in the message window.

Description

With this command, you can print all messages. This command will print the messages in text format, not graphically. Only message types defined in the "Types" page of the message options dialog box will be printed.

Documentation

Activate

Tool bar

Keyboard Ctrl+F1

Menu Help | Documentation

Popup menu Documentation

Function

Get documentation about the text at the text cursor position.

March 1999



Description

Depending on the type of text in the active window, relevant information is displayed. In an input window and a command file window, equipped with a text cursor, documentation is requested about the text at the cursor position. In an output window, documentation is requested about any keyword appearing in the currently visible lines (see the Find document dialog box). However, in all of these windows, if there is any selected text, documentation is requested about the first line of the selected text. In a message window, documentation is requested about the cause of an error message.

WinFIOL distinguishes between the following information types:

MML command or printout

WinFIOL will ask the documentation browser to show documentation about the MML command or printout. In an output window, with no cursor, all visible lines containing an MML command or printout are shown in a dialog box where a selection can be made before initiating the search. If the documentation browser is not yet running, it will be started.

Script command

If the text at the cursor position starts with @, and the following text is recognized as a script command, the help page for that script command is shown.

Other

If the text at the cursor position starts with #, it is a WinFIOL message and there is no help available; the messages normally speak for themselves. Also for comments, starting with ! for AXE and /* for MD110, no help is available.

Message options

Activate

Tool bar Shift +

Menu Options | Messages

Macro MessageOptions( )

Function

Change options affecting the message window.

March 1999



Description

Message options control such actions as opening and closing the message window, saving and restoring messages, what messages to show and how.

You can press Ctrl+Tab and Shift+Ctrl+Tab anywhere in the dialog box to select the next and previous page respectively. The following pages exist:

General: options defining how to restore the message window and its messages

Types: define which messages to show in the message window

Attributes: define which message attributes to show in the message window

Traffic setup

Activate

Tool bar

Keyboard F11

Menu Run | Traffic setup

Macro TrafficSetup( )

Function

Change the traffic options affecting the transmission of MML commands.

Description

Traffic options define the behavior of WinFIOL during transmission in various situations. For example, transmission can automatically be paused if an MML command is faulty and not accepted. Or, transmission can automatically pause at breakpoints or at every line.

Traffic options can be independent for each channel or common to all channels. This can be selected with the Common option in the Traffic setup dialog box and the "Common traffic settings" in the "Links" page of the Channel properties dialog box. All traffic options can be changed at any time, even during ongoing transmission, with immediate effect.


Pause: options for pausing the transmission Breakpoints: definition of breakpoints that pause the transmission Flow: options related to exchange responses Other: audible feedback and script command options

Template: loading and saving a template file

March 1999



Traffic setup: Pause page

Activate

Menu Run | Traffic setup | PauseMacro TrafficSetup(1)

Function

Define options for automatically pausing ongoing transmission.

Description

One of the more important traffic options is the Pause at exchange errors option. It is possible to define exceptions, i.e. define situations where the transmission should not pause, even if an error occurs.

Options

Exchange errorsExceptScript errorsMissing semicolonEvery line (single step)

Traffic setup: Breakpoint

page

Activate

Menu Run | Traffic setup | BreakpointMacro TrafficSetup(2)

Function

Define breakpoints to pause ongoing transmission.

Description

You can define breakpoints in commands files that cause the transmission to stop. Breakpoints can be positioned at lines by defining line numbers, bookmarks or text to be transmitted, as well as for received text and at the end of the command file. Each breakpoint can automatically be switched off when it is 'hit' (auto reset).

Options

List of breakpointsAddDeleteModifyClear allDisable all

March 1999



Traffic setup: Flow page

Activate

Menu Run | Traffic setup | Flow

Macro TrafficSetup(3)

Function

Define options related to exchange responses.

Description

Various MML commands respond differently. For instance, some need to be confirmed (with a semicolon for AXE and "Y;" for MD110), some give a busy response and some have delayed printouts. In this page you can define what WinFIOL should do in these situations.

Options

Auto confirmRetry on function busySend commentsAuto releaseAuto exit from sub command modeAuto reconnectReconnect delayAuto reenter sub command mode

Traffic setup: Other page

Activate

Menu Run | Traffic setup | Other


Function

Define audible feedback and script command options.

Description

WinFIOL can give you audible feedback when a faulty MML command is sent, when the transmission is finished or when a breakpoint is 'hit'. Instead of the default beep, you can define any sound (see Sounds during transmission).

In addition, you can define whether to ignore script commands or script variables.

March 1999



Options

Beep on errorBeep when readyBeep on breakpointIgnore script commandsIgnore script variables

Traffic setup: Template

page

Activate

Menu Run | Traffic setup | Template


Function

Load or save a template file.

Description

Zero or more traffic options can be saved in a template file (see the "Template" page of Traffic setup dialog box). With the script command @TEMPLATE the template file can be loaded during transmission causing the traffic options to change.

Options

List of traffic options to saveSaveLoadSelect all

Scheduler window

Activate

Tool bar

Menu Window | Scheduler

Macro Scheduler( )

Function

The scheduler window contains a list of files to that are scheduled for transmission.

March 1999



Description

The scheduler window contains a list of all files that are scheduled for transmission, files that are being transmitted or have finished transmission.

There is only one scheduler window, which is not associated with any channel. The scheduler is always active, even when the scheduler window is closed. Adding items for the scheduler can only be done when the scheduler window is open. A popup menu can be activated with the right mouse button or Shift+F10, from which you can add and delete items.

Options concerning the scheduler and scheduler window can be changed in the scheduler options dialog box.

The scheduler window shows information about each scheduled item in columns. You can click each column to sort. Click twice to reverse the order. The following columns exist:

status, e.g. Waiting, Pending, Active, Stopped, Finished etc. (see also Scheduler status (general))

type (currently only "Transmit")

which channel to transmit to

start time and date for transmission (see also Time and Date (general))

stop time when transmission was finished

number of times that the transmission needs to be repeated

period between repetition

name of the file to be transmitted

From the message window, a popup menu can be activated with Shift+F10 or by right-clicking mouse button. From this menu it is possible to:

edit the settings of the selected scheduled command file add a new command file to be scheduled delete the selected item delete all items in the scheduler window load a scheduler file save a scheduler file open a scheduled command file into a new command file window

show the scheduler options dialog box

March 1999



Print Dialog Box

Functions

1 Log received data to the printer.

2 Print selected or all text from a window.

Description

To log received data to the printer, switch on the option "Log output to printer" and press OK. To print text from the currently active window, press "Start printing". When printer logging is active, it is not possible to print any text from a window as well.

Options

SetupLeft marginTop marginFont sizeLine distancePrint text: Whole textPrint text: Selection onlyPrinting method: Using Print ManagerPrinting method: Directly to printer portLog output to printerForm feed

March 1999


Script

Script Commands

Activate help

Menu Help | Script

Function

Script commands allow simple programming control during transmission of command files, which consist of MML commands and script commands. Script commands have effect only when they are transmitted (see: Send lines (general)). Script commands should not be confused with macro commands.

Script commands allow simple programming control during transmission of command files, which consist of MML commands and script commands. Script commands have effect only when they are transmitted (see: Send lines (general)). Script commands should not be confused with macro commands.

Description

All script commands start with @. Any line that does not start with @ is considered a normal MML command. To get quick help on a specific script command, see Documentation.

There are two types of script commands, internal and external. The external script commands are implemented in the script plug-in and are only available if the script module is loaded. Internal script commands are always available.

List of script commands

Internal script commands

External script commands

Example (AXE)

@L pcorp.log

PCORP:BLOCK=ALL;

@C

Internal Script Commands

Activate help

Menu Help | Script

Keyboard Ctrl+F1

March 1999


Script, continued

Function

This page shows a list of all internal script commands.

Description

@A <+|-> Auto confirm

@B [+|-] Beep

@C [+label|-label] Conditional jump to label

@D <label> Label destination

@E Release

@G <+|-> Send comments

@I <filename> [n] Include file to transmit

@J <label> Unconditional jump to label

@K <HH:MM:SS> Wait until HH:MM:SS

@L <[+]filename|+|-> Log file

@M <n> Wait n minutes

@O Connect

@P <+|-> Printer log

@R <+|-> Pause on error

@S Connect

@T <n> Wait n seconds

@W [message] Wait for operator response

@X Release

@/<text>[,text][...]/ Check for text in received data

Notes:

The internal script commands @H, @N and @Z, which are supported by the DOS FIOL program, are not supported by WinFIOL.

If the option "Ignore script commands" is switched off (see traffic setup dialog box), all script commands will be ignored.

The following notation is used above:

<text> text is compulsory

[text] text is optional

x|y or-sign; define either x or y

March 1999


Script, continued

External Script Commands

Activate help

Menu Help | Script

Keyboard Ctrl+F1

Function

This page shows a list of the external script commands supported by the script module.

Description

@ASK {variable} [question]

Ask user to assign a value to the variable

@BEEP [wave file] Beep

@BREAK Break

@CHANNEL <n> Switch channel (n between 1 and max. nr. of channels)

@CLEAR Clear all previously preserved variables

@CLOSE Close log file

@COMMENT <message>

Show message in the output window

@CONFIRM [text] Confirm

@CONNECT Connect

@COPY {source} {dest} <m> <n>

Copy a sub-string

@DEC {variable} [n] Decrement variable by n

@END Stop the transmission

@ENDLOOP End of loop

@EXECUTE <program> Execute another application

@EXIT Exit include file

@FORM Form window

@GETDATE {variable} [format]

Store current date in variable

@GETDAY {variable} [days]

Store current day of week in variable

@GETTIME {variable} [format]

Store current time in variable

March 1999


Script, continued


@GOSUB <label>| {variable}

Go to subroutine

@GOTO <label>| {variable}

Go to label

@HALT Stop the transmission

@IF <condition> THEN <statement>

Conditional statement

@IFERROR THEN <statement>

Conditional statement on error

@INC {variable} [n] Increment variable by n

@INCLUDE <filename> Include file to transmit

@LABEL <label> Label destination

@LENGTH <string> {length}

Get string length

@LOG <ON filename>|<OFF>

Create log file/close log file

@LOOP <n> Loop <n> times

@MACRO <macro> Run a macro

@ONERROR [statement] Error handling

@ONRECEIVE [text [statement]]

Check all received text

@OPTION [+|-]VAR Option

@PARAM {variable} Variable from parent file

@PARAMASK {variable} <question>

Variable from parent file, ask if non-existent

@PAUSE [reason] Pause the transmission

@PORTNO <n> Switch channel (n between 1 and max. nr. of channels)

@PRESERVE Preserve all variables

@PRINTER <ON>|<OFF>

Switch on/off printer logging

@QUIET Do not show confirmation of script command

@RELEASE Release

@RETURN Return from subroutine

March 1999


Script, continued


@SCAN {variable} <text> {pos}

Scan local position of text in a variable

@SENDHEX <hh> Send hexadecimal value immediately

@SET {variable} = <expression>

Assign a value to a variable

@SETERROR [error] Set error condition

@STOP Stop the transmission

@TRACE Switch on single step transmission

@TEMPLATE <filename> Load template file

@UNTRACE Switch off single step transmission

@VERBOSE Show confirmation of script command

@WAITFOR Wait for specific text

@XMODEMRCV Receive file with X-modem

@XMODEMSEND Send file with X-modem

!@ or @! or @@ Comment (Portability)

Notes

If the option "Ignore script commands" is switched on (see traffic setup dialog box), all script commands will be ignored.

The following notation is used above:

<text> text is compulsory

[text] text is optional

x|y or-sign; define either x or y

Debug Script Commands

Introduction

A number of script commands can be typed in the input window. These are commands that can print or change the value of variables or perform certain tasks.

March 1999


Script, continued

List of debug commands

@ASK {variable} <question> Ask user to assign a value to the variable

@BEEP [wave file] Beep

@BREAK Break

@COMMENT <message> Show message in the output window

@CONNECT Connect

@COPY {source} {dest} <m> <n> Copy a sub-string

@DEC {variable} [n] Decrement variable by n

@EXECUTE <program> Execute another application

@GETDATE {variable} [format] Store current date in variable

@GETDAY {variable} [days] Store current day of week in variable

@GETTIME {variable} [format] Store current time in variable

@INC {variable} [n] Increment variable by n

@INCLUDE <filename> Include file to transmit

@LENGTH <string> {length} Get string length

@MACRO <macro> Run a macro

@ONERROR [statement] Error handling

@ONRECEIVE [text [statement]] Check all received text

@OPTION [+|-]VAR Option

@PRINTER <ON>|<OFF> Switch on/off printer logging

@RELEASE Release

@SCAN {variable} <text> {pos} Scan local position of text in a variable

@SENDHEX <hh> Send hexadecimal value immediately

@SET {variable} = <expression> Assign a value to a variable

@TRACE Switch on single step transmission

@TEMPLATE <filename> Load template file

@UNTRACE Switch off single step transmission

March 1999


Script, continued

Script Variables

Introduction

The script module supports variables that can be set and used. A variable is always enclosed in braces: {a_variable}. A variable can e.g. be set with the @SET command:

@SET {counter} = 3

@SET {message} = "Something went wrong"

Variables can be used in script commands such as @COMMENT and @IF. Variables can also be embedded in MML commands (unless this is disabled from the traffic setup dialog box

):

@SET {device} = 32

STDEP:DEV=LI-{device};

Variable name

Every variable has a unique name. The variable name is case-insensitive. If a value is assigned to an existing variable, the old value is overwritten. The maximum length of a variable name is 40 characters. A variable name must not contain any of the following characters: ~ @ # $ % ^ & * ( ) - + = [ ] ; : ' < > , . / ? | <space>. The variable name must start with a letter (a .. z or A .. Z). The variable name must always be enclosed in braces as in: {var_name}.

Variable types

There are two types of variables, numeric and text. Numeric variables can have a value between -2147483647 and +2147483648. Text variables can have a maximum length of 80 characters. The type of variable is determined when assigning a value to it. At any time, if a numeric value is assigned to a variable, it becomes a numeric variable.

Automatic variables

Every line received is stored in an automatic variable, which cannot be changed. The first line received is stored in variable {_line0}, the second in {_line1} etc. The memory pool for storing received lines is about 64 kB. The sequence is reset after every MML command sent, or when text specified with @ONRECEIVE is received. Usually, {_line0} is the MML command itself. All preceding spaces are removed from the received text stored in the {_lineX} variables. For example, " NOT ACCEPTED" will be stored as "NOT ACCEPTED".

Another automatic variable is {_onrcvline}. This variable is set when text specified with @ONRECEIVE is received and assigned the line number of the last line sent.

March 1999


Script, continued

Lifetime of variables

Variables exist during the transmission of a number of lines or a file. When the transmission is completed or stopped, the variables are lost. However, if @PRESERVE is specified at some point during the transmission, all variables will be stored and available for the next transmission. The preservation is cancelled with @CLEAR. Automatic variables cannot be preserved.

Interrogating variables

After variables have been preserved or when a transmission is paused, variables can be interrogated. To do so, type a script command in the input window, e.g. @COMMENT {a_variable}. The value of the variable will be printed in the output window. Variables can also be changed from the input window with the @SET or any other command.

Script Syntax Check

Activate

Main menu Tools | Script check

Popup menu Script check

Function

Check the syntax of all script commands, including internal script commands.

March 1999


Script, continued

Description

With this command, all script commands are checked for their syntax. Results are reported in the message window of WinFIOL. It is strongly recommended that a syntax check be performed before transmitting a file with script commands to reduce the chance of transmit-time errors.

Script commands not recognized are reported as errors. All incorrect parameters following a script command are also reported as errors. File names are not checked for validity.

If a label is referenced (with e.g. @GOTO), a check is carried out to ascertain that the label is also defined (with e.g. @LABEL. A warning is generated if this is not the case. Similarly, a label defined is checked for referencing. Note that it is permissible to use variables as a label reference, in which case a label may be referenced but this is not known until transmit-time.

A check is carried out to ascertain that all variables referenced are also defined. An example of a referenced variable: @COMMENT {x}. The following script commands define variables: @ASK, @SET, @COPY, @FORM, @GETDATE, @GETDAY, @GETTIME, @PARAM, @PARAMASK, @SCAN and @LENGTH. In case a variable is referenced but not defined, a warning is generated.

Script Module Contents

Introduction

The script module is an extension of WinFIOL. The script module implements a large number of script commands and is an addition to the internal script commands.

Description

Type the script commands in a command file. Execution takes place during command file transmission. Errors are reported during transmission. If the option "Ignore script commands" is switched on (see traffic setup dialog box), all script commands will be ignored and skipped.

A quick way to get help about a specific command is to type the full command in the command file window and press Ctrl+F1. The syntax plus an example is immediately shown.

Before starting the transmission, it is advisable to check the syntax of the script commands. Activate the syntax check from the popup menu of a command file window.

March 1999


Script, continued

List with External Script Commands

Ask for variable

Syntax

@ASK {variable} [question]

Description

This script command will cause a dialog box to appear, in which the user can type a value (text or number) for the specified variable. When multiple variables need to be initialised by the user, it is best to use the @FORM command.

The variable will be created if it doesn't exist yet. Variable names are case-insensitive. When the dialog box is displayed, the transmission is temporarily paused.

The question is optional and may contain variables.

Example (AXE)

@COMMENT Connect private meter@ASK {lidev} Give number of LI device@ASK {seprm} Give number of SEPRM deviceBLODI:DEV=LI-{lidev};BLODI:DEV=SEPRM-{seprm};SUPMI:DEV=LI-{lidev},DEV=SEPRM-{seprm};BLODE:DEV=SEPRM-{seprm};BLODE:DEV=LI-{lidev};

Beep

Syntax

@BEEP [wave file]

Description

This script command will make a short "beep" sound.

Optionally, a wave file can be specified (such as TADA.WAV). If the computer has a sound card, the specified wave file will be played. Otherwise, the normal short beep will be audible.

Example (AXE)

@COMMENT Connect private meter@BEEP@ASK {lidev} Give number of LI device@ASK {seprm} Give number of SEPRM deviceBLODI:DEV=LI-{lidev};BLODI:DEV=SEPRM-{seprm};SUPMI:DEV=LI-{lidev},DEV=SEPRM-{seprm};BLODE:DEV=SEPRM-{seprm};BLODE:DEV=LI-{lidev};

March 1999


Script, continued

Break (external script command)

Syntax

@BREAK

Description

This script command will immediately cause WinFIOL to send a break sequence to the communications port (if supported).

Example (AXE)

PCORP:BLOCK=ALL;@BREAK

Switch channel

Syntax

@CHANNEL <n>, @PORTNO <n>

Description

This script command will cause the transmission to continue on another channel. WinFIOL supports 9 to 100 channels, so n may be between 1 and the maximum number of channels. <n> may be a numeric variable. The following conditions must be met:

• n may not be the current channel

• channel n must be opened (both window and communications port)

• channel n must not be transmitting

After a successful channel switch, the progress bar in the transmission dialog box becomes purple. It is perfectly safe to close the transmission dialog box of the old channel. The transmission dialog box of the new channel is automatically started. Note that when transmitting from a command file window, that window will automatically be associated to the new channel.

Example (AXE)

Assume that this is channel 1, transmitting to AT-1. Channel 2 is connected to AT-2. Both CP-sides are initially parallel.FLSLI:SPG=0;IMLCT:SPG=0;MCDVC:IO=AT-2,SEP=YES;END;FCSEI;@CHANNEL 2@RELEASE@/SYSTEM RESTARTED/@CONNECTSYATI;@CHANNEL 1

March 1999


Script, continued

Clear preserved variables

Syntax

@CLEAR

Description

This script command will clear all preserved variables. This can prove useful for avoiding interference with existing variables. If this script command is executed from an include file, any variables from the "parent file" will not be cleared. For a more detailed description, see @PRESERVE.

Example

@PRESERVE

@SET {test} = test

@CLEAR

Close log file (external

script command)

Syntax

@CLOSE

Description

This script command will close a log file.

This script command is the same as the script command @LOG OFF and the internal script commands @C and @L-.

Example (AXE)

@LOG ON pcorp.log

PCORP:BLOCK=ALL;

@CLOSE

March 1999


Script, continued

Comment (external script

command)

Syntax

@COMMENT <text>

Description

This script command will display text in the output window.

The text will automatically be preceded by two hash marks (##). If the text specified after @COMMENT is enclosed in double quotes, it is shown in the output window without the quotes. If the text is not enclosed in double quotes, the text may contain variables (see example).

Example

@GETDATE {date}

@COMMENT The current date is: {date}

@COPY {year} {date} 1 2

@COMMENT "The current year is stored in variable {year}"

Confirm (external script

command)

Syntax

@CONFIRM [text]

Description

This script command will cause WinFIOL to suspend the transmission and show a message box. The transmission will only continue if you press the Continue button in that dialog box. This script command is the same as the internal script command @W.

Example (AXE)

REMEI:EMG=RSS0,MAG=EM-0,PCB=EMRP-A-POU;

@CONFIRM "Switch the power of the EMRP on"

RECEI:EMG=RSS0,EMRP=0-A;

March 1999


Script, continued

Connect (external script

command)

Syntax

@CONNECT

Description

This script command will immediately attempt to connect the terminal. This script command is the same as the internal script commands @S and @O.

Example (AXE, auto release and reconnect are off)

LABUP;

@RELEASE

@WAITFOR /END/

@CONNECT

Copy text

Syntax

@COPY {source} {dest} <m> <n>

Description

This script command will copy a sub-string from "source" into "dest", starting at position m, including n characters.

The source variable must exist. The destination variable will be created if it doesn't already exist. Both <m> and <n> may be numeric variables. Variable names are case-insensitive. If the source variable is empty, the destination variable will also be empty.

Example

@SET {var1} = Search target string

@COPY {var1} {var2} 8 6

@IF {var2} = "target" THEN GOTO ready

@COMMENT Could not find target (var2 = {var2})

@LABEL ready

March 1999


Script, continued

Decrement

Syntax

@DEC {var} [n]

Description

This script command will decrement a numeric variable by n.

The variable must exist and must be numeric. Variable names are case-insensitive. If n is not specified, the variable is decreased with 1.

Example (AXE)

@SET {dev} = 16

@SET {loop} = 3

@LABEL again

EXDEP:DEV=BT3-{dev};

@INC {dev} 32

@DEC {loop}

@IF {loop} > 0 THEN GOTO again

Stop transmission

Syntax

@END or: @HALT or: @STOP

Description

These script commands will cause the transmission to stop immediately. Three different script commands performing the same action are used for compatibility with other command handlers.

If the current command file is included with the @INCLUDE command, it may be better to use the @EXIT command instead.

Example (AXE)

DPWSP;

@COPY {_line4} {wo} 24 2

@IF {wo} = "WO" THEN STOP

DPPAI;

@END

March 1999


Script, continued

End of loop

Syntax

@ENDLOOP

Description

This script command marks the end of a loop created with the @LOOP command.

Example (AXE)

@LOOP 5

@T 10

PLLDP;

@ENDLOOP

Execute (external script

command)

Syntax

@EXECUTE <program>

Description

This script command will cause a specified program to be executed.

• Windows:

DOS commands cannot be executed unless they are programs. Both Windows and DOS programs can be executed. WinFIOL will continue the transmission since it cannot detect whether the program has finished or not. The program specification may contain variables.

• UNIX (WinFIOL/U):

All kinds of UNIX commands can be executed.

Example

@GETDATE {date}

@EXECUTE notepad {date}#1.log

March 1999


Script, continued

Exit include file

Syntax

@EXIT

Description

This script command will cause the transmission to end in the current command file and continue at the higher level command file (i.e. the file that included the current file). If the current command file is not included (with the @INCLUDE command), the transmission will stop as with the @END, @HALT and @STOP commands.

Example (AXE)

BLEEE:EMG=RSS0,EM=0;@IFERROR THEN GOTO repair_emrp@EXIT@LABEL repair_emrp

Form window

Syntax

@FORM <sub-command> [parameters]@FORM CREATE [title]@FORM TEXT <text> <x> <y> <w> <h>@FORM EDITTEXT {variable} <x> <y> <w>@FORM EDITNUMBER {variable} <x> <y> <w> [min] [max] [step]@FORM GETCHANNEL {variable} <x> <y> <w>@FORM RUN

Description

This script command can be used to create and run a window for entering data. This script command needs to be used multiple times with various sub-commands, where the first sub-command should always be CREATE and the last always RUN. In between these, other sub-commands can be used to add text and input fields to the window. An OK and Cancel button are automatically added.

With the CREATE sub-command a new window is created. Optionally, a title can be specified. If the text is not enclosed in double quotes, the text may contain variables (see example). The window will not be visible until the RUN sub-command.

With the TEXT sub-command any text can be added to the window. This text must be a variable or fixed text embedded in double quotes. If the text contains an ampersand sign (&), the following character will be underlined. Two ampersands will result in one being shown, not underlined. The text or variable should be

March 1999


Script, continued

Form Window, continued

followed by four numbers or variables, which are the x-position, y-position, width and height respectively.

With the EDITTEXT sub-command a edit field for entering text will be added to the window. The first parameter is a variable, which is given the value that the user types in the edit field. The variable should be followed by three numbers or variables, which are the x-position, y-position and width respectively. The height of the edit field is chosen automatically.

With the EDITNUMBER sub-command a number edit field will be added to the window. The first parameter is a variable, which is given the value that the user types in the edit field. The variable should be followed by three numbers or variables, which are the x-position, y-position and width respectively. The height of the edit field is chosen automatically. The following three numbers are optional and define the minimum allowed numerical value (default -2147483648), maximum allowed numerical value (default 2147483647) and increment (default 1).

With the GETCHANNEL sub-command a combo box will be added to the window from which a channel other than the current one can be selected. The first parameter is a variable, which is given the value of the number of the channel that the user selects. The variable should be followed by three numbers or variables, which are the x-position, y-position and width respectively. The height of the combo box is chosen automatically.

With the RUN sub-command the transmission is paused and the window is shown. The user can enter all values and press the OK button, after which the transmission continues. When the user presses Cancel, the transmission is paused.

The values for the x-position, y-position and width scale to approximately 1.5 millimeters per increment, depending on the screen resolution and monitor size. In technical Microsoft Windows terms, each increment maps to four dialog box units.

Example

@SET {value} = "a value"@SET {data} = 6@SET {channel} = 1@SET {title} = "From script"@FORM CREATE {title}@FORM TEXT "Enter &value:" 2 2 12 3@FORM EDITTEXT {value} 14 2 20@FORM TEXT "Enter &number:" 2 7 12 3@FORM EDITNUMBER {data} 14 7 20 0 15 1@FORM TEXT "Enter &channel:" 2 12 12 3@FORM GETCHANNEL {channel} 14 12 20@FORM RUN

March 1999


Script, continued

Get date

Syntax

@GETDATE {variable} [format]

Description

This script command will cause the current date to be stored in the variable specified.

The format string may consist of the following characters: y, Y, m, M, d, D, :, ., -, / and \. If a single Y, M or D is specified, the number indicating the year, month or day respectively will contain 1 to 2 characters. If YY, MM or DD is specified, each number will always contain 2 characters (starting with a zero if necessary). If YYYY is specified, the year will consist of 4 characters, starting with the century (19 or 20). If the format string is not specified, it is YYMMDD by default. Variable names are case-insensitive.

Example

@GETDATE {date}

@COMMENT The current date is: {date}

Example (AXE)

@GETDATE {date} YYMMDD

@GETTIME {time} HHMM

@GETDAY {day} SUN MON TUE WED THU FRI SAT

CACLS:DATE={date},TIME={time},DAY={day};

Example (MD110)

@GETDATE {date} YYYY-MM-DD

@GETTIME {time} HH-MM

CATII:DATE={date},TIME={time};

March 1999


Script, continued

Get day

Syntax

@GETDAY {variable} [days]

Description

This script command will cause the current day of the week to be stored in the variable specified.

Optionally, a list of days can be specified. All 7 days should be listed, starting with Sunday. All days should be separated with spaces or tabs. If the days are not specified, the variable is assigned one of the values 0 to 6, where 0 is Sunday. Variable names are case-insensitive.

Example

@GETDAY {day}

@INC {day} 1

@COMMENT The current day number is {day}

Example (AXE)

@GETDATE {date} YYMMDD

@GETTIME {time} HHMM

@GETDAY {day} SUN MON TUE WED THU FRI SAT

CACLS:DATE={date},TIME={time},DAY={day};

March 1999


Script, continued

Get time

Syntax

@GETTIME {variable} [format]

Description

This script command will cause the current time to be stored in the variable specified.

The format string may consist of the following characters: h, H, m, M, s, S, :, ., -, / and \. If a single H, M or S is specified, the number indicating the hour, minute or second respectively will contain 1 to 2 characters. If HH, MM or SS is specified, each number will always contain 2 characters (starting with a zero if necessary). If the format string is not specified, it is HHMMSS by default. Variable names are case-insensitive.

Example

@GETTIME {time} H:MM:SS@COMMENT The current time is: {time}

Example (AXE)

@GETDATE {date} YYMMDD@GETTIME {time} HHMM@GETDAY {day} SUN MON TUE WED THU FRI SATCACLS:DATE={date},TIME={time},DAY={day};

Example (MD110)

@GETDATE {date} YYYY-MM-DD@GETTIME {time} HH-MMCATII:DATE={date},TIME={time};

March 1999


Script, continued

Go to subroutine

Syntax

@GOSUB <label>| {variable}

Description

This script command will cause a jump to the subroutine specified by the label or variable label. When the subroutine returns, transmission continues on the line just after the GOSUB script command.

The label must be defined with @D or @LABEL. The subroutine will return with the script command @RETURN. If the specified label is a variable, the variable must exist and the contents of the variable must be an existing label. Subroutines may be nested. Be sure that the subroutine exists in the block of data being transmitted. It is advisable to place subroutines at the end of a file, to ensure that WinFIOL will always find them e.g. when selecting a block with Ctrl+B and transmitting it.

Example (AXE)

@SET {lidev} = 3@SET {seprm} = 19@GOSUB CONNPRM@END! Subroutine: connect private meter !! Input variables: lidev, seprm !@LABEL CONNPRMBLODI:DEV=LI-{lidev};BLODI:DEV=SEPRM-{seprm};SUPMI:DEV=LI-{lidev},DEV=SEPRM-{seprm};BLODE:DEV=SEPRM-{seprm};BLODE:DEV=LI-{lidev};@RETURN

March 1999


Script, continued

Go to label

Syntax

@GOTO <label>| {variable}

Description

This script command will cause an immediate jump to a label or variable label.

The label must be defined with @D or @LABEL. If the specified label is a variable, the variable must exist and the contents of the variable must be an existing label. This script command is the same as the internal script command @J.

Example (AXE)

DPWSP;@COPY {_line4} {wo} 24 2@IF {wo} <> "WO" THEN GOTO readyDPPAI;@LABEL ready

Stop transmission

Syntax


Description



Example (AXE)

DPWSP;@COPY {_line4} {wo} 24 2@IF {wo} = "WO" THEN STOPDPPAI;@END

March 1999


Script, continued

Conditional statement

Syntax

@IF <condition> THEN <statement>

Description

This script command will cause a statement (i.e. some other script command) to be executed if the condition is met.

The condition can be a comparison between the contents of a variable and text or a number, or two variables. The first operand must be a variable, the second may also be a constant. The following operators are defined:

= equal (text and numbers)

<> unequal (text and numbers)

> greater than (numbers only)

< less than (numbers only)

=> equal or greater than (numbers only)

<= equal or less than (numbers only)

A statement must follow the keyword "THEN". Any script command is allowed. The statement must be at the same line as the IF script command. The statement must be a script command (with or without the @ sign).

Example (AXE)

DPWSP;@SET {state} = 0@COPY {_line4} {wo} 24 4@IF {wo} <> "WO " THEN SET {state} = 1@IF {wo} <> "SB " THEN SET {state} = 2@IF {wo} <> "EX-A" THEN SET {state} = 3@IF {wo} <> "EX-B" THEN SET {state} = 4@IF {state} = 1 THEN GOTO ready...@LABEL ready

March 1999


Script, continued

Conditional statement on

error

Syntax

@IFERROR THEN <statement>

Description

This script command will cause a statement (i.e. some other script command) to be executed if WinFIOL has detected an error.

A statement must follow the keyword "THEN". Any script command is allowed. The statement must be on the same line as the IFERROR script command. The statement must be a script command (with or without the @ sign).

Example (AXE)

BLEEE:EMG=RSS0,EM=0;@IFERROR THEN GOSUB repair_emrp...@LABEL repair_emrp

Increment

Syntax

@INC {var} [n]

Description

This script command will increment a numeric variable by n.

The variable must exist and be numeric. Variable names are case-insensitive. If n is not specified, the variable is increased by 1.

Example (AXE)

@SET {dev} = 16@SET {loop} = 0@LABEL againEXDEP:DEV=BT3-{dev};@INC {dev} 32@INC {loop}@IF {loop} < 3 THEN GOTO again

March 1999


Script, continued

Include (external script

command)

Syntax

@INCLUDE <filename>

Description

This script command will cause WinFIOL to load the file with the name specified and send it before continuing.

Be sure the file specified exists. If the file is already loaded into a command file window, WinFIOL will send all lines from the window and not from the file. Transmission will start at the first line. The file specification may contain variables. This script command is the same as the internal script command @I.

Any existing variables are not transferred to the include file, unless the script commands @PARAM or @PARAMASK are used.

Example

@INCLUDE subfile.cmd

Label

Syntax

@LABEL <label>

Description

This script command will define a label.

A label can only be defined once. It is possible to jump to a label with @J, @C, @GOTO and @GOSUB. Labels are case-insensitive. When a jump to a label must be made, WinFIOL will search for the label in the file or selected text being transmitted. This script command is the same as the internal script command @D.

Example (AXE)

@SET {dev} = 0@LABEL againSTDEP:DEV=LI-{dev};@INC {dev} 1@IF {dev} < 3 THEN GOTO again

March 1999


Script, continued

Get string length

Syntax

@LENGTH <string> {length}

Description

This script command will determine the length of a string or string variable.

The string may be enclosed in double quotes for clarity. The string may also be a variable. The length of the string or variable will be stored as a numeric value in the variable {length} (or a variable with any other name). Variable names are case-insensitive.

Examples

@GETDATE {date} YYYY-M-D@LENGTH {date} {length}@LENGTH This is the string {length}@LENGTH "This is the string" {length}

Log file

Syntax

@LOG <ON filename>|<OFF>

Description

This script command will open or close a log file.

Open a log file with @LOG ON <filename>, where <filename> must be a valid file name. Close a log file with @LOG OFF. When opening a log file, a new file will be created. If a file with the same name already exists, the existing file is truncated without a warning. The log file cannot be appended. The log file specification may contain variables.

This script command is the same as the internal script command @L. With @L, it is possible to append files.

Example (AXE)

@LOG ON pcorp.logPCORP:BLOCK=ALL;@LOG OFF

Example

@GETDATE {date} YYYYMMDD@LOG ON {date}.log

March 1999


Script, continued

Loop

Syntax

@LOOP <n>

Description

This script command repeats the commands following the @LOOP command until the @ENDLOOP command is encountered. This command eliminates the need of the @LABEL, @SET, @INC, @IF and @GOTO commands to implement a loop.

<n> may be a numeric variable. If the argument <n> is zero or less then zero, all commands until the next @ENDLOOP commands are skipped. Loops can be nested up to 10 levels deep with the @LOOP command.

Example (AXE)

@LOOP 5@T 10PLLDP;@ENDLOOP

Run macro (external script

command)

Syntax

@MACRO <macro> [parameters]

Description

This script command will cause a specified macro to be run.

Before the macro is started, the transmission is paused. When the macro has been successfully run, the transmission is resumed automatically. The macro specification may contain variables.

Example

@GETDATE {date}@MACRO config.wfm {date}

March 1999


Script, continued

Error handling (external

script command)

Syntax

@ONERROR [statement]

Description

This script command will cause a statement (i.e. some other script command) to be executed every time WinFIOL detects an error.

This script command needs only to be defined once (unlike @IFERROR). To clear the error handling, specify @ONERROR without the statement. Any script command is allowed as statement. The statement must be on the same line as the ONERROR script command. The syntax of the statement will be checked only when an error really occurs. The statement must be a script command (with or without the @ sign).

Example (AXE)

@ONERROR GOSUB repair_emrpBLEEE:EMG=RSS0,EM=0;BLEEE:EMG=RSS0,EM=1;@ONERROR ! clear error handling...@LABEL repair_emrp

March 1999


Script, continued

Check all received text

Syntax@ONRECEIVE [text [statement]]

DescriptionThis script command will cause every line received to be checked for a specified text string. If a line is found containing the specified string, the statement specified will be executed.This script command needs to be defined only once with this command (like @ONERROR

). It is possible to define various error checking routines. A check is defined by specifying [text] as "text" enclosed in double quotes, or a {variable} enclosed in curly braces, followed by a statement. The statement must be a script command (with or without the @ sign).

This command can be specified more than once for different texts, allowing different checks simultaneously. A specific check is cleared by only specifying the text and omitting the statement. All checks can be cleared by omitting both the text and the statement.

Most useful is a jump to a subroutine with @GOSUB, where the text received can be analyzed and reported as faulty if applicable. Note that the system variable {_onrcvline} is automatically defined with the value of the current line number. The value of this variable does not change until the next time a specified text is received. Note also that the system variables {_lineX}, where X is 0...n, n being the number of the last received line, will automatically be set for every following line received.

Example (AXE)@CLEAR ! clear any old "onreceive"@PRESERVE ! preserve all new "onreceive"@ONRECEIVE "SIZE ALTERATION RESULT" GOSUB saa_checkSAAII:SAE=500,BLOCK=KR2,NI=32;SAAII:SAE=306,NI=200;...@ONRECEIVE "SIZE ALTERATION RESULT" ! clear error handling@END

@LABEL saa_check@WAITFOR /END/@COPY {_line3} {fcode} 21 2@IF {fcode} = "" THEN RETURN@SET {msg}=Size alteration error FCODE {fcode} on line {_onrcvline}@COMMENT {msg}@SETERROR {msg}@RETURN

March 1999


Script, continued

Option

Syntax

@OPTION [+|-]VAR

Description

This script command will enable or disable the substitution of variables in a MML command. This script command exists for backward compatibility. It is replaced by the @TEMPLATE script command.

When loading corrections for the MD110, braces should not be interpreted as variables in a command. This option can also be set and cleared from the traffic setup dialog box.

Example (MD110)

@OPTION -VARPCASI:UNIT=ELP6,CI=S52866A,REV=1-R6A,IA=450,RA=4056,BYTE=0; MOVE.B #4,($27,A6); BFEXTU D0{26:1},D1;END;

Variable from parent command file

Syntax

@PARAM {variable}

Description

This script command will import a variable from a parent command file. The parent command file is the file that includes the current command file with the @INCLUDE command.

An error occurs if the variable does not exist in the parent command file. Changing the value of the variable does not affect the variable in the parent command file. Variable names are case-insensitive.

Example (AXE)

@PARAM {lidev}@PARAM {seprm}@COMMENT Connecting private meter {seprm} to device {lidev}BLODI:DEV=LI-{lidev};BLODI:DEV=SEPRM-{seprm};SUPMI:DEV=LI-{lidev},DEV=SEPRM-{seprm};BLODE:DEV=SEPRM-{seprm};BLODE:DEV=LI-{lidev};@EXIT

March 1999


Script, continued

Variable from parent command file, ask if

non-existent

Syntax

@PARAMASK {variable} <question>

Description

This script command will import a variable from a parent command file. The parent command file is the file that includes the current command file with the @INCLUDE command. If the variable does not exist in the parent command file, a dialog box will appear in which the user can type a value (text or number) for the variable specified.

Changing the value of the variable does not affect the variable in the parent command file. Variable names are case-insensitive. When the dialog box is displayed the transmission is temporarily paused.

Example (AXE)

@PARAMASK {lidev} Give number of LI device@PARAMASK {seprm} Give number of SEPRM device@COMMENT Connecting private meter {seprm} to device {lidev}BLODI:DEV=LI-{lidev};BLODI:DEV=SEPRM-{seprm};SUPMI:DEV=LI-{lidev},DEV=SEPRM-{seprm};BLODE:DEV=SEPRM-{seprm};BLODE:DEV=LI-{lidev};@EXIT

Pause transmission

Syntax

@PAUSE [reason]

Description

This script command will pause the transmission.

If a reason is specified, it is shown at the status in the transmission dialog box. The reason should be short, in the range of 20 to 30 characters.

Example

! Plug the cable back in;@PAUSE

March 1999


Script, continued

Switch channel

Syntax

@CHANNEL <n>, @PORTNO <n>

Description

This script command will cause the transmission to continue on another channel. WinFIOL supports 9 to 100 channels, so n may be between 1 and the maximum number of channels. <n> may be a numeric variable. The following conditions must be met:

• n may not be the current channel

• channel n must be opened (both window and communications port)

• channel n must not be transmitting

After a successful channel switch, the progress bar in the transmission dialog box becomes purple. It is perfectly safe to close the transmission dialog box of the old channel. The transmission dialog box of the new channel is automatically started. Note that when transmitting from a command file window, that window will automatically be associated to the new channel.

Example (AXE)

Assume that this is channel 1, transmitting to AT-1. Channel 2 is connected to AT-2. Both CP-sides are initially parallel.

FLSLI:SPG=0;IMLCT:SPG=0;MCDVC:IO=AT-2,SEP=YES;END;FCSEI;@CHANNEL 2@RELEASE@/SYSTEM RESTARTED/@CONNECTSYATI;@CHANNEL 1

March 1999


Script, continued

Preserve variables

Syntax

@PRESERVE

Description

This script command will preserve all variables already defined and to be defined later.

Even if the transmission is stopped (i.e. not paused), the variables will be preserved for the next transmission. At the @CLEAR script command, all variables, including preserved variables from previous transmissions, will be cleared (i.e. they cease to exist).

For some applications, a number of variables are set at the beginning of a file. If the transmission is stopped due to an error, all variables will be lost. Using the @PRESERVE script command prevents this. If this script command is used, define @CLEAR on the first and last line of the file. Do not use this script command unnecessarily.

Example

@CLEAR@PRESERVE! Start a lengthy and complex transmission;! Define variables first;...@LABEL end@CLEAR

Printer logging

Syntax

@PRINTER <ON>|<OFF>

Description

This script command will start or stop printer logging.

Example (AXE)

@PRINTER ONEXEMP:RP=ALL,EM=ALL;@PRINTER OFF

March 1999


Script, continued

Quiet

Syntax

@QUIET

Description

This script command will switch off the setting to display result messages in the output window.

This setting is off by default and it can be switched on with @VERBOSE.

Example (AXE)

@VERBOSE@COPY "Search target string" {dest} 8 6@QUIET

Release (external script

command)

Syntax

@RELEASE

Description

This script command will try to release the terminal at the next prompt. This script command is the same as the internal script commands @E and @X.


LABUP;@RELEASE@WAITFOR /END/@CONNECT

March 1999


Script, continued

Return from subroutine

Syntax

@RETURN

Description

This script command will cause a jump back from a subroutine to the point where it was called.

A subroutine is called with @GOSUB. A subroutine is exited by the @RETURN script command. A jump is made to the line just after @GOSUB. Subroutines may be nested.

Example (AXE)

@SET {lidev} = 3@SET {seprm} = 19@GOSUB CONNPRM@END

! Subroutine: connect private meter !! Input variables: lidev, seprm !@LABEL CONNPRMBLODI:DEV=LI-{lidev};BLODI:DEV=SEPRM-{seprm};SUPMI:DEV=LI-{lidev},DEV=SEPRM-{seprm};BLODE:DEV=SEPRM-{seprm};BLODE:DEV=LI-{lidev};@RETURN

Scan variable

Syntax

@SCAN {string} <sub-string> {pos}

Description

This script command will scan a text variable for a sub-string.

If the sub-string is found, the position is stored in the last specified variable {pos} as a numeric value. If the sub-string is not found, {pos} will be zero. The scan is case-sensitive.

Example

@SET {var1} = Search target string@SCAN {var1} "target" {pos}@COMMENT Target found at position {pos}

March 1999


Script, continued

Send hex value

Syntax

@SENDHEX <hh>

Description

This script command will cause a hexadecimal value to be transmitted.

The value may be specified as a decimal number (0...255) or a hexadecimal number (h'00...h'FF). The value will be sent immediately.

Example (IOG 11)

@SENDHEX 5 ! Connect to ERIOS (Ctrl+E)

Set variable

Syntax

@SET {variable} = <expression>

Description

This script command will assign a value to a variable.

The variable will automatically become a text or numeric variable, depending on the type of expression. The expression can be one of the following:

Normal text Just text

Text in quotes "Just text"

Text plus variable "The date is "+{date}

Text plus variable The date is {date}

Numeric value 12

Calculation 1900+{year}

Text variables can only be combined with normal text by using the plus sign (+). Numeric values can use the following operators:

Addition {year} + 1900

Subtraction {dev} - 128

Multiplication 32 * {snt}

Division {dev} / 16

March 1999


Script, continued

Set variable, continued

And operation {dev} & h'F

Or operation {bm} | h'8000

It is permissible to use more than one operator in one expression. The order of evaluation is from left to right, regardless of the type of operator. The variable will be created if it doesn't exist yet. Variable names are case-insensitive.

Examples

@SET {dev15} = {dev0} + 15@SET {dev1} = 32*{snt} + 1@SET {text} = "Variable {dev1} has value "+{dev1}@SET {block} = ALL

Set error condition

Syntax

@SETERROR [error]

Description

This script command will set an error condition.

WinFIOL will pause the transmission if the option "pause on error" (in Traffic setup dialog box) is set. If any error text is defined, it will be shown in the message window. The error text may contain variables. This script command will not trigger any statement defined with @ONERROR.

Example (AXE)

@SAAII:SAE=500,BLOCK=LI,NI=256;@COPY {_line11} {fc} 21 2@IF {fc} <> "" THEN SETERROR Size alteration error: fc={fc}

March 1999


Script, continued

Stop transmission

Syntax


Description



Example (AXE)

DPWSP;@COPY {_line4} {wo} 24 2@IF {wo} = "WO" THEN STOPDPPAI;@END

Switch on single step

Syntax

@TRACE

Description

This script command will switch on single step transmission.

When single step transmission is active, WinFIOL pauses after each MML command transmitted. The transmission can only be resumed manually. Note that this option can also be switched on or off from the Traffic setup dialog box, option "Every line (single step)". Single step can be deactivated with the script command @UNTRACE. This command is most useful together with @VERBOSE.

Example (AXE)

@COMMENT Replace board in RSS@ASK {rss} Give name of RSS@ASK {em} Give number of EMRP@TRACEREMEI:EMG={rss},MAG=EM-{em},PCB=EMRP-A-POU;RECEI:EMG={rss},EMRP={em}-A;@UNTRACE

March 1999


Script, continued

Load template file

Syntax

@TEMPLATE <filename>

Description

This script command will load a template file and change traffic options immediately.

A template file is a file containing zero or more traffic options. All options defined in the template file that WinFIOL recognized are changed. A template file can be generated from the Traffic setup dialog box in WinFIOL. This command replaces the @OPTION command.

Example

@TEMPLATE debug.tpl

Switch off single step

Syntax

@UNTRACE

Description

This script command will switch off single step transmission.

When single step transmission is active, WinFIOL pauses after each MML command transmitted. The transmission can only be resumed manually. Note that this option can also be switched on or off from the Traffic setup dialog box, option "Every line (single step)". Single step can be activated with the script command @TRACE.

Example (AXE)

@COMMENT Replace board in RSS@ASK {rss} Give name of RSS@ASK {em} Give number of EMRP@TRACEREMEI:EMG={rss},MAG=EM-{em},PCB=EMRP-A-POU;RECEI:EMG={rss},EMRP={em}-A;@UNTRACE

March 1999


Script, continued

Verbose

Syntax

@VERBOSE

Description

This script command will switch on the setting to display result messages in the output window.

This setting is off by default, and it can be switched off with @QUIET.

Example (AXE)

@VERBOSE@COPY "Search target string" {dest} 8 6@QUIET

Wait for text

Syntax

@WAITFOR /<text>[,text][...]/

Description

This script command causes WinFIOL to pause the transmission and resume it when one of the specified texts has been received.

The text to be specified is case sensitive.


SAAII:SAE=500,BLOCK=CCD,NI=32;@RELEASE@WAITFOR /END/@COPY {_line11} {fcode} 21 2@IF {fcode} <> "" THEN GOTO error@CONNECTSAAEP:SAE=500,BLOCK=CCD;@END...@LABEL error...

March 1999


Script, continued

X-modem receive

Syntax

@XMODEMRCV <file>

Description

This script command causes WinFIOL to receive a file using the X-modem protocol.

During the file transfer, the transmission is paused and cannot be resumed. When the transfer has been completed successfully, the transmission is automatically resumed. The file specification may contain variables.

Example (MD110)

FICPI:SPATH=/SYSN/USR1/SES/DR/ADD/P/TPL19.P,IODEV=SYSTERMINAL;@XMODEMRCV filename.ext

X-modem send

Syntax

@XMODEMSEND <file>

Description

This script command causes WinFIOL to send a file using the X-modem protocol.

During the file transfer, the transmission is paused and cannot be resumed. When the transfer has been completed successfully, the transmission is automatically resumed. The file specification may contain variables.

Example (MD110)

FICPI:IODEV=SYSTERMINAL,PATH=/SYSN/USR1/SES/DR/ADD/P/TPL19.P;@XMODEMSEND filename.ext

March 1999


Script, continued

List with Internal Script Commands

Auto confirm

Syntax

@A <+|->

Description

A line starting with @A+ switches on and @A- switches off auto confirm.

When auto confirm is switched on, WinFIOL will automatically send a semicolon (;) when a command needs to be confirmed. Note that auto confirm is not available when you send a line manually (i.e. from the input window).

You can also set this value in the traffic setup dialog box.

Beep

Syntax

@B [+|-]

Description

A line starting with @B generates a single beep.

@B+ switches on and @B- switches off beep on error.

When beep on error is switched on, WinFIOL will automatically generate a short beep when an error message is received.


Conditional jump

Syntax

@C [+label|-label]

Description

If the same file contains a label (@D script command), WinFIOL will make a jump to that label depending on whether an error has occurred. An error has occurred when an error message is received. After every line sent, this value is reset.

If an error has occurred, WinFIOL will make a jump if the next line contains a @C +label, but will not make the jump if the next line has a @C -label. If an error has not occurred, the decision is reverse.

For compatibility reasons, @C without any parameters closes the current log file. It is recommended to use @L- however.

March 1999


Script, continued

Label destination

Syntax

@D <label>

Description

A line starting with @D label defines a label that exists during transfer of the file containing the line. You can define as many labels as you want. Each label should have a unique name. Labels are used for unconditional and conditional jumping (@J and @C).

Release (internal script

command)

Syntax

@E or @X

Description

A line starting with @E or @X will release the terminal directly, i.e. the release character is sent (see "Target" page of the Channel properties dialog box).

There is no difference between @E and @X; both script commands will release the terminal since it is independent of the selected target exchange type (IOG 11, MD110 etc.).

Send comments

Syntax:

@G <+|->

Description

A line starting with @G+ will switch off and @G- will switch on sending comments.

While sending comments is switched on, WinFIOL will also send lines starting with an exclamation mark (!) to AXE and lines starting with /* to MD110.


March 1999


Script, continued

Include file (internal script

command)

Syntax

@I <filename> [n]

Description

A line starting with @I filename will cause WinFIOL to load the file with the specified name and send it first before continuing. Be sure the file exists. If the file is already loaded into a command file window, WinFIOL will send all lines from the window and not from the file.

If a value n is specified, WinFIOL will start transmission from line number n. Otherwise, transmission starts from the first line.

It is possible to let WinFIOL stop when the end of the include file is reached. To do so, set the pause on EOF (end of file) option in the traffic setup dialog box.

Unconditional jump

Syntax

@J <label>

Description

If the same file contains a label (@D script command), WinFIOL will make a jump to that label if a line starts with the @J label.

Wait until HH:MM:SS

Syntax

@K <HH:MM:SS>

Description

A line starting with @K hh:mm:ss will cause WinFIOL to suspend transmission until the specified time of day has been reached. You may omit the colons in the time specification.

March 1999


Script, continued

Log file (internal script

command)

Syntax

@L <[+]filename|+|->

Description

A line starting with @L filename will open a log file with the specified name. If a file with the same name exists, its contents will be lost.

A line starting with @L +filename will append a log file with the specified name. If the log file does not exist, it will be created.

A line starting with @L+ will reopen and append the previously opened log file.

A line starting with @L- will close the log file (this is also possible with @C).

Wait n minutes

Syntax

@M <n>

Description

A line starting with @M n, n being a number, will cause WinFIOL to suspend transmission until n minutes have passed. The maximum value for n is 32767.

Printer log (internal script

command)

Syntax

@P <+|->

Description

A line starting with @P+ will switch on and @P- will switch off printer logging.

March 1999


Script, continued

Pause on error

Syntax

@R <+|->

Description

A line starting with @R+ switches on and @R- switches off pause on error.

When pause on error is switched on, WinFIOL will automatically pause the transmission when an error message is received.


Connect (internal script

command)

Syntax

@S or @O

Description

A line starting with @S or @O will immediately connect the terminal, i.e. the connect character is sent (see "Target" page of the Channel properties dialog box).

There is no difference between @S and @O; both script commands will connect the terminal, since it is independent of the selected protocol (IOG 11, MD110 etc.).

Wait n seconds

Syntax

@T <n>

Description

A line starting with @T n, n being a number, will cause WinFIOL to suspend the transmission until n seconds have passed. The maximum value for n is 32767.

March 1999


Script, continued

Wait for operator response

Syntax

@W [message]

Description

A line starting with @W will cause WinFIOL to suspend transmission and show a message box. The transmission will only continue if you press the Continue button in that dialog box.

If after @W a message is defined, this message will be shown in the dialog box. The message text should be enclosed in double quotes. Example:

@W "Check that the alarm has ceased"

Check for text in received data

Syntax

@/[text][,text][...]/

Description

A line starting with @/ will cause WinFIOL to pause the transmission immediately after the next command is sent. The transmission will be automatically resumed if the specified text is received.

If no text is specified, WinFIOL will transmit the next line immediately. This can be useful after a MML command that causes a release (see AXE example below).

All text is case sensitive. @/ is the only internal script command that can be specified on the same line as an AXE or MD110 command. In this case, the line must start with the AXE or MD110 command.

Example

In the following example, WinFIOL will transmit the following line, pause, and resume the transmission if FAULT or ERROR is received.

@/FAULT,ERROR/

In the following example for AXE, WinFIOL continue the transmission immediately after the EXIT command.

MCLOC:USR=SYSTEM,PSW=INIT;EXIT;@//@SDPWSP;

March 1999


Scheduler

Scheduler (general)

Introduction

WinFIOL has a built-in scheduler that allows you to schedule command files for transmission some time in future. All scheduled files are listed in the scheduler window.

Description

WinFIOL allows you to schedule command files for transmission to a certain channel. This channel does not have to be open; when the transmission has to start, the target channel will automatically be opened in that case. Only command files can be scheduled, macros cannot be scheduled.

The scheduler operates in the background. You can access the scheduler from the scheduler window. This window does not need to be open all the time. From the scheduler window, you can view, add, modify and delete scheduled items.

Not only command files scheduled for transmission, but also files that are transmitted immediately (see Send and Transmit) are listed in the scheduler window. In the scheduler options you can define how long files that have been transmitted remain in the scheduler window.

Schedule command files (general)

Introduction

This page describes how to schedule new files for transmission and how to change any of the scheduled data.

March 1999


Scheduler, continued

Description

To schedule a command file for transmission, you need to open the scheduler window first. From this window, you can click with the right mouse button or press Shift+F10 to activate a popup menu. From the popup menu you can view, add, delete and modify items listed in the scheduler window. Once done, it is perfectly safe to close the scheduler window again.

For each new command file you want to schedule, you need to define the following information in a dialog box:

The name of the command file. It is possible to type a file name or select one from a file selection dialog box.

The target channel. Normally, you select a channel that is currently open. It is also possible to select a channel that needs to be opened when the transmission should start. Channels opened this way are not automatically closed.

The time and date that the transmission should start. You can select a day from a calendar (see also: Time and date (general)).

Optionally, the number of times that the transmission is to be repeated. The maximum number of times is 99.

The interval between repeated transmissions. A transmission can be repeated immediately, or a certain period after the start of the previous transmission.

As long as a scheduled transmission of a command file has not started yet, you can change any of the data described above. The only way to cancel a scheduled transmission is to delete the corresponding item from the scheduler window.

If a transmission is ongoing or finished, the scheduler data for that item cannot be changed. If a command file has been transmitted already but still needs to be repeated, only the repetition data can be changed. If the starting time and date is in the past, transmission will start immediately (see also Scheduler exceptions (general)).

It is also possible to schedule a new command file with DDE (see DDE channel execute commands) or drag and drop.

Scheduler exceptions (general)

Introduction

This page describes non-trivial situations concerning the scheduler.

March 1999



Description

The most common case is that the target channel that a command file is scheduled for is open when the transmission should start. The transmission will start only when the communication port is open and no other command file is currently being transmitted to the same channel. Otherwise, the status of the scheduled item changes into pending until the conditions mentioned have changed.

The target channel may be closed at the time that a scheduled transmission should start. WinFIOL will attempt to open the channel and start the transmission. If this fails, for instance when the channel is in use by another tool, the status will change to pending.

WinFIOL might not run at the time that a scheduled transmission should start. This scheduled transmission is said to be missed. In the "Transmit" page of the scheduler options dialog box you can define what WinFIOL should do as soon as it is started.

Either the user or the system may adjust the clock, for instance at the start or end of the daylight saving period. When the time of scheduled transmissions is suddenly in the past because of such an adjustment, WinFIOL can either start the transmission immediately or ask you to confirm the start of the transmission. You can define which method to use from the "Transmit" page of the scheduler options dialog box.

Scheduler files (general)

Introduction

This page describes how WinFIOL loads and saves scheduler data and where schedule files are.

Description

When WinFIOL is closed, the scheduler contents is automatically written to the file "LastScheduled.txt". When WinFIOL starts, this file is automatically read in again and all scheduled transmissions are restored.

You can write the whole contents (i.e. all items) of the scheduler to a text file from the popup menu of the scheduler window. These files can also be read in again, replacing any existing items in the scheduler.

The directory for scheduler files can be defined in the "Directories | Other" page of the preferences dialog box.

March 1999



Time and date (general)

Introduction

This page describes the millenium change and the way WinFIOL presents time and date.

Millenium change

WinFIOL is fully tested for the change of the millenium. All functions within WinFIOL will operate properly during and after 12 o'clock midnight 1999. Functions that handle time and/or date are:

Scheduler Expiry date of a trial version of WinFIOL AXE and MD110 exchange headers CACLS( ) and CATII( ) macro commands Internal script commands @T, @M, @K External script commands @GETDATE and @GETDAY

Last used dates in the Target Manager

Time and date representatio

n

The format that WinFIOL uses to present time and date is determined by the settings in the Control Panel. These settings can be changed from the "Time" and "Date" pages of the "Regional Settings" in the Control Panel. WinFIOL uses the same style of the time and short date as defined there.

Scheduler status (general)

Introduction

Each item in the scheduler has a status. This page describes all possible status values.

Description

Waiting

The time that the command file should be transmitted is still in the future.

Pending

The time that the command file should be transmitted is not in the future anymore. The command file should be transmitted now but it is not (yet) possible. Possible causes are: the channel or communication port is not open yet or another command file is already being transmitted. The transmission will start as soon as these conditions have changed.

March 1999



Active

Transmission is ongoing. Also files that were not scheduled for transmission in future are shown in the scheduler window.

Paused

Transmission is paused.

Finished

Transmission is (successfully) finished.

Stopped

Transmission is halted by the user.

Cancelled

The command file scheduled for transmission will not be transmitted. This status will appear when transmissions are missed or when the clock has been adjusted (see Scheduler options, "Transmit" page).

Missed

WinFIOL missed the scheduled transmission of then command file. This happens when WinFIOL is not running at the time that the file should be transmitted (see Scheduler options, "Transmit" page). Right click the item in the scheduler window to start or cancel the transmission.

Scheduler options

Activate

Tool bar Shift + Menu Options | SchedulerMacro SchedulerOptions( )

Function

Change options affecting the scheduler and the scheduler window.

March 1999



Description

Scheduler options control such actions as opening and closing the scheduler window, keeping already transmitted files, and what to do with exceptions.


General: options defining how to restore the scheduler window and keeping old items

Transmit: options defining what to do with items that are missed and when the time changes

Scheduler options: General page

Activate

Menu Options | Scheduler | General

Macro SchedulerOptions(1)

Function

Define how to restore the scheduler window and keeping already transmitted files.

Description

You can define in what cases the scheduler window should be opened when WinFIOL starts up. Note that the scheduler operates normally even if the scheduler window is not open.

The scheduler window can keep items that are finished and stopped, i.e. files that were scheduled and have finished or stopped transmission. You can define when these old items should be removed from the scheduler window, if at all.

Options

Never open scheduler window at startupOnly if opened in previous session open scheduler window at startupAlways open scheduler window at startupKeep already transmitted items: NumberKeep already transmitted items: DaysKeep already transmitted items: Keep allKeep already transmitted items: Do not keep

March 1999



Scheduler options: Transmit page

Activate

Menu Options | Scheduler | Transmit

Macro SchedulerOptions(2)

Function

Define what to do with items that are missed and what to do when the time is changed.

Description

In case files are scheduled for transmission and WinFIOL is closed, these scheduled files are said to be missed. When WinFIOL starts up, it can handle missed scheduled files in one of four possible ways. The first option is cancel, which means that WinFIOL will not transmit them. The second option is to transmit these scheduled files immediately. The third is to mark all missed transmissions as missed, in which case you need to initiate transmission for each missed file from the scheduler window. The last is to ask for a confirmation, in which case you can choose one of the three first options.

In case the clock is adjusted, either by the user or automatically (for example begin or end of daylight saving period), WinFIOL can cancel all scheduled transmissions, ignore the clock adjustment, or ask you for a confirmation when the clock adjustment actually occurs.

Options

Missed items: CancelMissed items: Transmit immediatelyMissed items: Mark as missedMissed items: Ask for confirmationTime change: CancelTime change: IgnoreTime change: Ask for confirmation

March 1999


Macros

Macros (general)

Introduction

WinFIOL supports macros that can activate several functions, perform editor actions and send data. The source for a macro can be written with any editor, but they must be compiled by WinFIOL before being run. Each macro is stored in a file on disk, by default in the macro file directory (see "Directories | Other" page of Preferences dialog box). Macros created with versions of WinFIOL below 4.0 are incompatible and need to be recompiled. Macro commands cannot be mixed with script commands.

Creating a macro

With any editor you can write a macro by typing simple commands in a text file. The syntax of these commands is described in writing a macro. Then load the text file in a command file window and compile it.

Running a macro

A macro can be run in several ways:

Explicitly from the menu Tools | Macro | Run.

By pressing a hot key (see "Tools | Tool bar" page of the preferences dialog box).

By pressing a button (see "Tools | Tool bar" page of the preferences dialog box).

From the Tools menu (see "Tools | Menu" page of the preferences dialog box).

From the phone book list.

With a script command (see @MACRO).

From the command line (see start options).

From another application using DDE.

Stopping a running macro

A running macro can be interrupted by pressing Escape or from the menu Tools | Macro | Stop.

Reason for using a macro

One reason for using a macro is that you may wish to assign a hot key or user button to a specific function in WinFIOL and another to send and interpret data as part of a login procedure.

March 1999


Macros, continued

Writing a Macro

Introduction

A macro must be created by writing a macro source text file, which can contain one or more macro definitions. When the source file is complete, it must be compiled so that it can be run. Macro commands cannot be mixed with script commands.

Example macro

Each macro definition starts with "MACRO", followed by one or more specified macro commands and ends with "END".

MACRO("Send MCLOC", "MCLOC.WFM");

Connect();

SendLine("MCLOC:USR=SYSTEM,PSW=INIT;");

END;

MACRO has two parameters, a name of 30 characters or less and the name of the macro file. It is advisable to use the file extension ".wfm" (WinFIOL macro). END does not take any parameters. If no path is specified in the name of the macro file, the macro will be saved in the macro file directory (see "Directories | Other" page of the preferences dialog box).

Syntax rules

Every macro command must end with a semicolon and they are case sensitive. Empty lines are allowed. There can be only one command per line. Even commands with no parameters should have brackets (C-style). Macros cannot be nested. Spaces and tabs are allowed. Comment must start with an exclamation mark (!).

Any text (e.g. in Text( ) command) can contain a double quote by specifying two quotation marks (""), and a control character specified with ^X, where X must be between A and Z. For example, a tab (i.e. 9) should be specified as ^I (9th character in the alphabet) and a carriage return as ^M. Two consecutive ^ characters will be displayed as one.

March 1999


Macros, continued

List of macro commands

Supported macro commands in WinFIOL 5.1

BackSpace( ); Delete character before cursor

BeginDoc( ); Move cursor to start of text

BeginLine( ); Move cursor to start of line

Bookmarks( ); Bookmark dialog box

Break( ); Break

Browser( ); Run documentation browser

ButtonBar( ); Preferences: Tool bar page

CACLS( ); Send CACLS command

Capitals( ); Capital change

CATII( ); Send CATII command

Channel(channel); Activate a channel, designated 1 to 9

ChannelPropDlg( ); Channel properties dialog box. The number of the property page can no longer be specified.

CharLeft( ); Move cursor one position to the left

CharRight( ); Move cursor one position to the right

ClearBlock( ); Clear block

CloseChannel(n); Close channel window n (n between 1 and max. nr. of channels)

ClosePort( ); Close communications port of active channel

Colors( ); Preferences: Colors page

CompileMacro( ); Compile macro

Connect(timeout); Connect. Optionally specify timeout in tenths of a second; omit or 0 for no timeout. Maximum timeout 30 seconds.

CopyBlock( ); Copy block

CutBlock( ); Cut block

DelBlock( ); Delete the selected text

DelChar( ); Delete character under cursor

DelLine( ); Delete line under cursor

March 1999


Macros, continued

Supported macro commands in WinFIOL 5.1,

continued

DelWord( ); Delete word under cursor starting from the cursor position

Dial("number"); Dial a number (same as in phonebook)

DirDlg(n); "Directories" pages of the preferences dialog box. Optionally, specify a number (1 to 4) to show a sub page.

EndDoc( ); Move cursor to end of text

EndLine( ); Move cursor to end of line

Execute("Program"); Start another program. Both Windows and DOS programs can be started this way.

Expect("text",timeout); Wait for "text" to be received. Optionally, specify timeout in tenths of a second; omit or 0 for no timeout. Maximum timeout 30 seconds.

ExpectPrompt(timeout); Wait for a prompt to be received. Optionally specify timeout in tenths of a second; omit or 0 for no timeout. Maximum timeout 30 seconds.

Find("text"); Find text dialog box if "text" not specified, otherwise search for "text" directly.

FindAgain( ); Repeat last find

Font( ); Preferences: Font page

GotoLine(line); Go to line dialog box if 'line' not specified, otherwise: go to line 'line'

Hangup( ); Hang-up (same as in phonebook)

HexConvert( ); Hex/Dec converter

ImportBlock( ); Import file from disk

Insert(state); Set insert mode, state: 0=off (overtype), 1=on (insert), 2=toggle

LineDown( ); Move cursor one line down

LineUp( ); Move cursor one line up

LogAppend("file"); Open new log file; append existing file (if any)

LogClose( ); Close currently open log file

March 1999


Macros, continued


continued

LogCreate("file"); Open new log file; overwrite existing file (if any)

LogFile( ); Output log file dialog box

LogOutput( ); Output log file dialog box

LogInput( ); Input log file dialog box

MarkBlock(state); Set state for marking a block, use cursor movement afterwards. state: 0=off, 1=on, 2=toggle

Messages( ); Activate or open the message window.

MessageOptions(n); Message options. Optionally, specify the number (1 to 3) of the property page to be shown.

NextError( ); Next error

OpenChannel(n, "file"); Open channel #n, if n is 0 then the channel number is selected automatically, otherwise must be n between 1 and the maximum number of channels. Parameter "file" specifies channel file. You can use OpenPort( ) afterwards to open communications port.

OpenFile("file"); File open dialog box if "file" not specified, otherwise open "file" directly from disk.

OpenPort("config"); Open communications port, optionally specify configuration string, see port configuration.

OpenPortParam(x); Open communications port, where the xth command line parameter specifies the configuration string, see port configuration. x must be between 1 and 10

PageDown( ); Move cursor one page down

PageUp( ); Move cursor one page up

ParamLeft( ); Move cursor to previous parameter (FIOL style)

ParamRight( ); Move cursor to next parameter (FIOL style)

Password( ); Let user type password in a dialog box

PasteBlock( ); Paste block

March 1999


Macros, continued


continued

PauseTrm( ); Pause transmission

PhoneBook(n); Phone book dialog box. Optionally, specify the number (1 to 4) of the property page to be shown.

PreferenceDlg( ); Preferences dialog box. The number of the property page can no longer be specified.

PrevError( ); Previous error

Print( ); Print text / print settings

Queue( ); Queue dialog box

Quit( ); Exit WinFIOL

Release( ); Release

ReopenChannel(n); Reopen channel #n, where n is between 1 and the maximum number of channels. If channel #n cannot be reopened, the macro stops.

Replace( ); Replace text

RunMacro( ); Run macro dialog box. Any following macro commands are ignored.

Save( ); Save text to disk. It is recommended to use SaveFile( ).

SaveAll( ); Save all modified text to disk

SaveFile( ); Save text to disk. Same as Save( ).

Scheduler( ); Activate or open the scheduler window.

SchedulerOptions(n); Scheduler options. Optionally, specify the number (1 to 2) of the property page to be shown.

ScrollDown( ); Move text one line down

ScrollUp( ); Move text one line up

SelectAll( ); Select all text

SelectFrom( ); Select all text from cursor

Send("text"); Send "text" to target exchange. Specify ^M to send a carriage return, e.g. Send("DPWSP;^M"); The macro will continue immediately with the next command.

March 1999


Macros, continued


continued

SendBlock( ); Send block

SendCode(x); Send x directly to target exchange, where x can be any value between 0 and 255.

SendLine("text", timeout); Send "text" to target exchange, a carriage return will also be sent. The macro will not continue until a prompt is found. Optionally specify timeout in tenths of a second; omit or 0 for no timeout. Maximum timeout is 30 seconds.

SendParam(x); Send xth command line parameter directly to target exchange, where x can have any value between 1 and 10.

SetMode(state); Set mode, state: 0=TTY, 1=setup, 2=buffered. See also SetTTY( ).

SetTTY(state); Set TTY mode, state: 0=off, 1=on, 2=toggle. See also SetMode( ).

SquareBlock( ); Set square block mode, state: 0=off (normal), 1=on (square), 2=toggle.

Template("file"); Load a template file (see Traffic setup).

Text("text"); Insert "text" at current cursor position, insert a new line with ^M

ToolOptions( ); Preferences: Tools | Menu page

TrafficSetup(n); Traffic setup dialog box. Optionally, specify the number (1 to 5) of the property page to be shown.

Transmit("file"); Transmit file dialog box if "text" is not specified, otherwise transmit "file" directly from disk.

Undress( ); Undress text

UserName( ); Let user type user name in a dialog box.

Wait(time); Wait certain period of time. Specify time in tenths of a second, maximum 30 seconds.

WordLeft( ); Move cursor one word to the left.

WordRight( ); Move cursor one word to the right.

WriteBlock( ); Write block to disk

XModem( ); X-modem file selection

March 1999


Macros, continued


continued

XModemReceive("file"); Receive file using X-modem protocol

XModemSend("file"); Send file using X-modem protocol

Obsolete macro commands

The following macro commands existed in WinFIOL 3.x and / or WinFIOL 4.x but are not supported by WinFIOL 5.x:

ChannelSetup( ); replaced by ChannelPropDlg( );

ControlSetup( ); replaced by ChannelPropDlg( );

EditOptions( ); replaced by PreferenceDlg( );

FileOptions( ); replaced by PreferenceDlg( );

MiscOptions( ); replaced by PreferenceDlg( );

PortSetup( ); replaced by ChannelPropDlg( );

PendingPause( ); replaced by TrafficSetup( );

SetBook( ); no longer supported

ViewOptions( ); replaced by PreferenceDlg( );

March 1999


DDE

DDE communication (general)

What is DDE?

Dynamic Data Exchange, or DDE for short, is a protocol for exchanging data between applications. DDE is part of all Windows operating systems (Windows 3.11, 95 and NT). 16-bit applications can also communicate with 32-bit applications using DDE.

There is always a DDE server application and one or more DDE client applications. A DDE client can request data from the server, pass data to the server and order the server to perform a certain task. If the client so requests, the server can also automatically pass data to the client.

More general information

on DDE

This help does not explain the details of DDE. Although the underlying protocol is the same, DDE is used differently with each programming language. In C++, it is recommended to use DDEML (DDE Management Library) or any class library that embeds DDE. In Borland's Delphi, there are classes that embed DDE and hide all specifics for you. The same is true for Visual Basic. Refer to the programming documentation of your development platform for detailed information.

WinFIOL and DDE

WinFIOL is a DDE server. Any DDE client application can obtain information from WinFIOL, either on request or automatically, and order WinFIOL to perform tasks.

For example, WinFIOL can forward all received data to a DDE client for on-line processing. As another example, a DDE client can have WinFIOL transmit a command, a series of commands, or open a new channel.

What next?

Continue reading if you are developing a Windows application and you want your application to communicate with WinFIOL. It will be explained how a client can get data from WinFIOL and how it can order tasks from WinFIOL.

DDE basics

Conversation

Two applications participating in Dynamic Data Exchange are said to be engaged in a DDE conversation. A DDE conversation is the interaction between client and server applications. The application that initiates the conversation is the DDE client application; the application that responds to the client is the DDE server application (in this case WinFIOL).

March 1999


DDE, continued

Service

The service name identifies a DDE server. A client application differentiates between several DDE servers by the service name. The service name is case sensitive. As soon as the server application registers the service name, all DDE clients that use DDEML are notified that a new service has started and conversations can be set up.

Topic

The DDE topic is a general classification of data within which multiple data items may be "discussed" (exchanged) during the conversation. Each DDE conversation is uniquely defined by the service name and topic name. Because the client and server applications together identify a DDE conversation, the service name and topic defining a conversation cannot be changed during the course of the conversation. See further: DDE service and topics in WinFIOL.

Data item

A DDE data item identifies the conversation topic exchanged between the applications. Values for the data item can be passed from the server to the client, or from the client to the server.

DDE data transactions

DDE data transactions can only take place when a conversation is active. The simplest type of data transaction is when the client requests data from the server. Poke is another data transaction type where the client hands over data to the server application. The client can also order the server to execute a certain task. The client can ask the server to automatically send data to the client whenever this data changes via a hot-link.

DDE Service and Topics in WinFIOL

Service

WinFIOL supports only one service named "WinFIOL". The service name is registered during start up. Shortly after the service name is registered, DDE client applications can establish a conversation with WinFIOL. In DDEML terminology, the callback function is called with the XTYP_REGISTER transaction type. It is advisable to post a message that starts DDE conversation(s) on receiving XTYP_REGISTER in order to allow WinFIOL to finish DDE initialization.

March 1999


DDE, continued

Topics

WinFIOL supports up to n + 1 topics, where n is the maximum number of channels, which is between 9 and 100. The "Main" topic is always available and is new since version 4.0 of WinFIOL. The other topics are "Channel #1", "Channel #2" until "Channel #n"(n is the maximum number of channels), where each channel is a server for one topic. These topics are only available when the corresponding channel windows are opened. These topics already existed in WinFIOL 3.x.

Establishing a conversation

A DDE client application can establish a conversation with WinFIOL by specifying "WinFIOL" as the service name and specifying one of the available topic names. When using DDEML, the client can establish a conversation with DdeConnect( ) or DdeConnectList( ). In the latter case, it is advisable to specify the service name and not any topic name.

Immediately after establishing a conversation, the client application should tell WinFIOL its name with the "ClientName" poke transaction (see also Main topic and Channel topics). This name shows up in the DDE Status dialog box (Help | Status information). WinFIOL versions older than 4.0 do not support this data transaction.

Execute commands

Execute commands are enclosed in square brackets, as in "[Activate]". More than one execute command in one execute DDE transaction can be specified, for example; "[Connect][Send(DPWSP;)]".

DDE main topic

Description

WinFIOL supports a maximum of five simultaneous conversations for the "Main" topic. This means that another DDE client application can also establish a conversation for the same topic. The use of the "Main" topic is to get general information from WinFIOL. This topic did not exist in versions of WinFIOL older than 4.0. (See also: DDE service and topics in WinFIOL.)

The supported data item for poke is "ClientName". The supported data items for requesting data are "Information", "Channels" and "Plugin(n)", where n is 0 or greater. The supported execute commands are: "[Quit]", "[Minimize]", "[Maximize]", "[Restore]", "[Activate]", "[OpenChannel(<file>)]", where <file> is the name of a channel file.

Any installed WinFIOL plug-ins may support additional execute commands and data items for requesting data.

March 1999


DDE, continued

Poke "ClientName"

By using the poke data transaction with the data item "ClientName", a client application can tell its name to WinFIOL. This name shows up in the DDE status dialog box (Help | Status information). It is recommended that every client identifies itself immediately after establishing a conversation.

Request "Information"

Requesting data using the "Information" data item returns the following:

Version=WinFIOL 5.1 Date=9801001 Class=WFMainWindow

Target=Win32

Every line is separated by a CR-LF combination (C-style notation: "\r\n"). The "Class" information is the name of the Window class. The class name can be used in the Windows API function FindWindow( ). The "Target" information specifies the target operating system and can be Win16 or Win32 (WinFIOL 5.x will only return Win32). Future versions of WinFIOL may return more information.

Request "Channels"

Requesting data using the "Channels" data item returns for example the following:

NumChannels=3 Channel #1=<name> Channel #4=<name>

Channel #7=<name>

Every line is separated by a CR-LF combination (C-style notation: "\r\n"). The first line always starts with "NumChannels" and specifies the number of open channel windows. Every following line starts with "Channel #<n>", where <n> is the number of the channel. After the equal sign, the name of the channel is shown. Only the channel windows that are currently open are present in the list. If there are no open channel windows, "NumChannels=0" is returned. To obtain more information about a specific channel, a conversation must be established with that channel (see Channel topics).

March 1999


DDE, continued

Request "ActiveChann

el"

Requesting data using the "ActiveChannel" data item returns the currently active channel, for example:

Channel #1

This name could be used as the topic name for a conversation with the currently active channel. If there are no open channel windows, "-" is returned (one dash only). This request command is new since WinFIOL 5.1.

Request "Plugin"

When requesting plug-in information, the data item "Plugin(0)" returns data about the first loaded plug-in, the data item "Plugin(1)" about the second etc. When the nth plug-in is not loaded, no data is returned. Requesting data using the "Plugin(n)" data item returns for example the following:

Name=My own plug-in Version=1.23 Copyright=My own company

File=c:\winfiol\ownplgin.dll

Every line is separated by a CR-LF combination (C-style notation: "\r\n"). The first line shows the name of the plug-in. The second line shows the version number of the plug-in. This version number is independent of the version of WinFIOL. The next line shows copyright information and the last line the plug-in file name. Future versions of WinFIOL may return more information.

If the nth plug-in is loaded but "Plugin(n)" cannot return plug-in information, the data "internal error" is returned.

Execute "[Quit]"

This command causes WinFIOL to quit. Any execute commands following "[Quit]" are ignored.

Execute "[Minimize]"

This command causes the WinFIOL main window to minimize.

Execute "[Maximize]"

This command causes the WinFIOL main window to maximize.

Execute "[Restore]"

This command restores the WinFIOL main window to its previous size and state.

March 1999


DDE, continued

Execute "[Activate]"

This command activates the WinFIOL main window. If WinFIOL is minimized, it will be restored to its previous size and state.

Execute "[OpenChann

el(file)]"

This command opens a new channel by loading the specified channel file. If the channel file does not have a full path specification, the channel file should be present in the channel file directory (you can not define the channel file directory in WinFIOL). The client can check if a new channel is opened by requesting the currently opened channel with the "Channel" data item (see above).

March 1999


DDE, continued

Execute "[OpenChannelParam(para

meters)]"

This command opens a new channel and initializes the channel properties as specified by parameters. The parameter string can be a concatenation of channel properties, separated by a comma. The list of possible properties are listed below:

"protocol=<protocol>", where <protocol> can be "telnet", "rs232serial" or "modem"

"protocol.telnet.address=<address>", where <address> is an IP address

"protocol.telnet.port=<port>", where <port> is the IP port number

"target=<target>, where <target> can be "iog3", "iog11", "iog20", "apg30", "md110" or "eripax"

"browser=<browser>", where <browser> can be "alexremote", "alexlocal", "dynatext", "krswin" or "docview"

"browser=alexremote.book=<book>, where <book> is the documentation database

"login.access=<access>, where <access> can be "none", "read only", "write only" or "read and write"

"login.<prompt>=<response>", where <prompt> can be anything except comma and <response> can be anything except comma.

"logout.access=<access>, where <access> can be "none", "read only", "write only" or "read and write"

"logout.<prompt>=<response>", where <prompt> can be anything except comma and <response> can be anything except comma.

Example:

"[OpenChannelParam(protocol=telnet,protocol.telnet.address=12.34.56.78,target=iog11)]"

The client can check if a new channel is opened by requesting the currently opened channel with the "Channel" data item (see above). This execute command is new since WinFIOL 5.1.

March 1999


DDE, continued

DDE channel topics

Description

The topic name of a channel topic is "Channel #n", where n must be between 1 and the maximum number of channels, which is between 9 and 100. A channel topic is only available if the corresponding channel is open. WinFIOL supports a maximum of five simultaneous conversations for each channel topic. This means that another DDE client application can also establish a conversation for the same topic.

The main use of a channel topic is to get general data from a channel and send MML commands to a channel. This topic also existed in versions of WinFIOL older than 4.0, though there are new execute and poke commands. (See also: DDE service and topics in WinFIOL.)

Poke "ClientName"

By using the poke data transaction with the data item "ClientName", a client application can tell its name to WinFIOL. This name shows up in the DDE status dialog box (Help | Status information). It is recommended that every client identifies itself immediately after establishing a conversation. WinFIOL versions older than 4.0 do not support this data transaction.

Request items

The supported data items for requesting data are "Information", "Status", "Output", "Event" and "Login". Any installed WinFIOL plug-ins may support additional data items for requesting data. See further: DDE channel request items.

Hot-link items

The supported data items for hot-links are: "Status", "Output" and "Event". See further: DDE channel hot-links.

Execute commands

The supported execute commands are: "[Close]", "[Minimize]", "[Maximize]", "[Restore]", "[Activate]", "[Connect]", "[Release]", "[Break]", "[Send(MML cmd)]", "[Transmit(file)]", "[RunMacro(file)]", "[Load(file)]", "[Lock(code)]", "[XModemSend(file)]", "[XModemReceive(file)]" and "[FindDoc(book,keyword,fault code,category)]". Any installed WinFIOL plug-ins may support additional execute commands. See further: DDE channel execute commands.

March 1999


DDE, continued

DDE channel request items

Request "Information"

Requesting data using the Information data item returns the following:

Channel=1 Name=Example channel File=c:\winfiol\chnfiles\example.chn Locked=0

ExistEvent=WFExistChannel1

Every line is separated by a CR-LF combination (C-style notation: "\r\n"). The "Channel" information shows the number of the channel. The "Name" information shows the channel name. The "File" information shows the name of the channel file. If the channel does not have a corresponding channel file, "File=" is shown. The "Locked" information shows "0" if the channel is not locked and "1" if the channel is locked. A channel can be locked with the "[Lock(code)]" execute command. The "ExistEvent" information shows the name of the Win32 event object. This event will be set when the channel is closed. Another application can open the event and wait for the event to be set.

This data item returns more information than older versions of WinFIOL. Future versions of WinFIOL may return even more information.

Request "Status"

Requesting data using the "Status" data item returns the current status of the communications port. The port status is the same as shown on the status line of WinFIOL and can be one of the following: "Port closed", "Port opened", "Released", "Connected", "Trying ..." or "X-modem". Unlike the versions of WinFIOL older than 4.0, "Port blocked" will never be returned. It is possible to establish a hot-link so that WinFIOL automatically sends the new status information to the client whenever there are changes.

Request "Output"

Requesting data using the "Output" data item returns the last whole line that is received from the target exchange. It is recommended to use the "Output" hot-link to automatically obtain every line that WinFIOL receives from the target exchange.

March 1999


DDE, continued

Request "Event"

Requesting data using the "Event" data item returns the last occurred event. The events that can be returned are "Prompt found", "Started transmission from <file>", "Stopped transmission from <file>", "Paused transmission", "Resumed transmission", "Error detected, cause <cause>", "Locked", "Unlocked", "Login started", "Login stopped", "Login failed" or "Login progress, step n". For more information on the return values, see DDE channel hot-links. It is not advisable to request this data item. You can instead establish an "Event" hot-link so that WinFIOL can automatically send events to the client.

Request "Login"

Requesting data using the "Login" data item returns the last occurred login event. The login events that can be returned are "Login started", "Login stopped", "Login failed" or "Login progress, step n". You can establish an "Event" hot-link so that WinFIOL can automatically send login events to the client. This request item is new since WinFIOL 5.1.

DDE channel hot-links

Description

When establishing a hot-link with a channel topic in WinFIOL, data is automatically transferred to the client application whenever the data changes or new data is available. Warm-links are also allowed, i.e. links where the server only notifies the client of a data change, after which the client requests for data.

Using DDE messages, a hot-link can be started using the WM_DDE_ADVISE message with the fDeferUpd parameter of the DDEADVISE structure set to zero. A hot-link can be stopped by sending the WM_DDE_UNADVISE message.

Using DDEML, a hot-link can be started by calling DdeClientTransaction( ) with the XTYP_ADVSTART transaction type (the XTYPF_NODATA should be specified for a warm-link). To assure that WinFIOL does not send information at a faster rate than the client can process, specify the XTYPF_ACKREQ flag). A hot-link can be stopped by calling DdeClientTransaction( ) with the XTYP_ADVSTOP transaction type.

"Status" hot-link

A hot-link with the "Status" data item causes WinFIOL to send the status of the communications port the client application whenever the status changes. The port status is the same as shown on the status line of WinFIOL and can be one of the following: "Port closed", "Port opened", "Released", "Connected", "Trying ..." or "X-modem" (MD 110 only). Unlike versions of WinFIOL older than 4.0, "Port blocked" will never be returned.

March 1999


DDE, continued

"Output" hot-link

A hot-link with the "Output" data item causes WinFIOL to send every line it receives from the target exchange to the client application. A line received is only sent to the client application if it institutes a whole line, i.e. when it is terminated by a carriage return. This means that if only a prompt is received from the target exchange, it is not sent to the client application. Establish an "Event" hot-link to obtain this information. WinFIOL messages that start with "##", as in "## End of include file '<file>'" are also sent to the client application.

"Event" hot-link

A hot-link with the "Event" data item causes WinFIOL to send every important event to the client application. The possible events are "Prompt found", "Started transmission from <file>", "Stopped transmission from <file>", "Paused transmission", "Resumed transmission", "Error detected, cause <cause>", "Locked", "Unlocked", "Login started", "Login stopped", "Login failed" or "Login progress, step n". A channel can be locked from the "Links | DDE" page of the Channel properties dialog box or with the "[Lock(code)]" DDE execute command. When a channel is locked, the user cannot send any MML commands to the target exchange.

DDE channel execute commands

Execute "[Close]"

This command causes the channel to be closed. Any execute commands following the "[Close]" command are ignored, since the conversation is also closed. This execute command is new since WinFIOL 4.0.

Execute "[Minimize]"

This command causes the channel window to minimize. This execute command is new since WinFIOL 4.0.

Execute "[Maximize]"

This command causes the channel window to maximize. This execute command is new since WinFIOL 4.0.

March 1999


DDE, continued

Execute "[Restore]"

This command restores the channel window to its previous size and state. This execute command is new since WinFIOL 4.0.

Execute "[Activate]"

This command activates the channel window. If the channel window is minimized, it will be restored to its previous size and state. This execute command is new since WinFIOL 4.0.

Execute "[Connect]"

This command connects the channel to the target exchange.

Execute "[Release]"

This command releases the channel from the target exchange.

Execute "[Break]"

This command causes a break to be sent to the target exchange.

Execute "[Send(MML cmd)]"

This command causes an MML command to be sent to the target exchange. If the port status is not "Connected", the MML command is queued.

Execute "[Transmit(fil

e)]"

This command causes a command file to be transmitted to the target exchange. During ongoing transmission, this command is ignored. If the command file does not have a full path specification, the file should be present in the transmit directory.

March 1999


DDE, continued

Execute "[Schedule(file,yyyy,mm,dd

,r,m,p)]"

This command causes a command file to be scheduled for transmission. If the command file does not have a full path specification, the file should be present in the transmit directory. Following the file specification, the year (4 digits), month and day needs to be specified. Optionally, define the repetition (r), multiple of periods (m) and the period base (p). The period base needs to be one of the following strings: "immediately", "minute", "hour", "day", "week", "month" or "year". Examples: "[Schedule(test.cmd,1998,11,3,23,0)]" or "[Schedule(c:\temp\test.cmd,1998,11,3,23,0,3,2,day)]". This execute command is new since WinFIOL 5.0.

Execute "[Template(fil

e)]"

This command causes the channel to load a template file (see traffic setup). If the template file does not have a full path specification, the template file should be present in the channel file directory. This execute command is new since WinFIOL 4.0.

Execute "[LogCreate(f

ile)]"

This command causes the channel to create a log file for logging output. The log file is overwritten if it already exists. If the template file does not have a full path specification, the template file should be present in the log file directory. This execute command is new since WinFIOL 4.0.

Execute "[LogAppend

(file)]"

This command causes the channel to create a log file for logging output. The log file is appended to any existing log file. If the template file does not have a full path specification, the template file should be present in the log file directory. This execute command is new since WinFIOL 4.0.

Execute "[LogClose]"

This command causes the channel to close the currently open log file for logging output. This command succeeds even if no log file is open. This execute command is new since WinFIOL 4.0.

March 1999


DDE, continued

Execute "[RunMacro(fi

le)]"

This command causes a macro to be run. If the macro file does not have a full path specification, the macro file should be present in the macro directory.

Execute "[Load(file)]"

This command causes WinFIOL to load a command file into a new command file window. If the command file does not have a full path specification, the command file should be present in the default directory. The new command file window will be associated with the channel the topic is connected to. Note that in versions of WinFIOL older than 4.0, the associated channel is equal to the currently active channel.

Execute "[Lock(code)]

"

With this command, a channel can be locked when the code is "1" and unlock when the code is "0". When a channel is locked, the user cannot send any MML commands to the target exchange. A channel can also be locked from the channel properties dialog box.

Execute "[XModemSe

nd(file)]"

This command causes WinFIOL to send a file to the target exchange (currently only MD110 supports X-modem file transfer). The file should have a full path specification. X-modem file transfer is not possible during ongoing transmission.

Execute "[XModemReceive(file)]"

This command causes a WinFIOL to receive a file from the target exchange (currently only MD110 supports X-modem file transfer). The file should have a full path specification. X-modem file transmission is not possible during onging transmission.

March 1999


DDE, continued

Execute "[FindDoc(book,keyword,f

ault code,categor

y)]"

This command causes the documentation browser to search for a document containing the keyword. The book and fault code parameters are optional. In any case, all commas should be specified, for example:

"[FindDoc(,EXDAE,,COD)]"

The document categories supported are "AMOD", "BMOD", "DMOD", "FMOD", "HMOD", "OPI", "COD", "POD", "ADI", "AI", "JP", "SUR" and "FULL". If no documentation browser is selected for the channel, this command is ignored. This execute command is new since WinFIOL 4.0.

DDE example

Introduction

The example described here shows a typical DDE client application that communicates with WinFIOL. The client receives data from WinFIOL and sends MML commands to WinFIOL.

The example describes the steps to be taken, refer to DDE basics and DDE service and topics in WinFIOL for more detailed information on how to use DDE.

Example

Starting up

When the DDE client program starts up, it should initialize everything required for DDE. When using DDEML, DdeInitialize( ) should be called.

Conversation with Main topic

Next, it can establish a conversation with the Main topic of WinFIOL. Using DDEML, the service name should be "WinFIOL" and the topic name should be "Main". If the conversation is successful, proceed to the next step.

If the conversation fails, WinFIOL is not running. To start WinFIOL, see locate WinFIOL (advanced). When using DDEML, WinFIOL start up can be detected with the XTYP_REGISTER message. When this message is received, the client application should post a user message to itself (WM_USER+x or WM_COMMAND) so that the callback function that handled the XTYP_REGISTER message can return. On receiving the user message, the client can try again to establish a conversation with the Main topic.

March 1999


DDE, continued

Poke client name

In order to let WinFIOL know what client application has established a conversation, it should use the poke data transaction with the data item "ClientName" to tell the name of the client to WinFIOL. This name shows up in the DDE status dialog box (Help | Status information).

Get version and available channels

Next, the client application should request version information from WinFIOL using the "Information" data item (see DDE main topic) and check that it is equipped to the version of WinFIOL. The client can then request the available channels using the "Channels" data item. The client can choose one or more channels to establish a conversation with.

Conversation with Channel

topic

Now the client application can establish a conversation with a channel, using the channel topic "Channel #x" with x being the number of the channel. Note that the channel can be locked by selecting that action in the "Links | DDE" page of the Channel properties dialog box. The client application can also explicitly lock the channel with the "[Lock(code)]" execute command.

Poke client name

Again, the client should tell its name to WinFIOL using the poke data transaction with the data item "ClientName", only this time using the conversation with the channel.

Hot-link to get received data

Start a hot-link with the "Output" data item. From this moment onwards, WinFIOL will forward all data received from the target exchange to the client application. The client application should ignore exchange headers and lines starting with "##".

Send an MML command to

WinFIOL

The client application can send an MML command to WinFIOL. The port status can be requested with the "Status" data item. If the port status is not "Connected", use the "[Connect]" execute command first. Then use the "[Send(MML command)]" to send the MML command.

March 1999


DDE, continued

Send a series of MML commands

to WinFIOL

The easiest way is to create a command file and order WinFIOL to transmit that command file with the "[Transmit(file)]" execute command. A more interactive way is to let the client application send all commands itself with the "[Send(MML cmd)]" execute command. To prepare for this, start a hot-link with the "Event" data item. When the event "Prompt found" is received, the client application can send the next MML command.

Close conversations

At any time, the conversations with the main topic and channel topics can be closed. Similarly, WinFIOL may close the conversations. In that case, when using DDEML, the client application will receive the XTYP_DISCONNECT message for every conversation that is closed.

March 1999


Configuration

Desktop file & System file

What is a desktop file

WinFIOL saves all personal settings in the desktop file WINFIOL.DSK when it terminates. Examples of personal settings are colors, font and other preferences. Upon start up, WinFIOL reads the desktop file and restores all settings.

What is a system file

WinFIOL saves all machine-specific settings in the system file WINFIOL.SYS when it terminates. Examples of machine-specific settings are printer settings and open channels. Upon start up, WinFIOL reads the system file and restores all settings.

How to use a desktop file

Normally WinFIOL loads the default desktop file, WINFIOL.DSK. It is however possible to load another desktop file, e.g. with your personal settings. To do so, select "Load options" from the Options menu and load another desktop file. WinFIOL will immediately restore all settings defined in that desktop file.

WinFIOL will always save all changed settings to the desktop file loaded most recently.

Where the desktop file is stored

The desktop file normally resides in the WinFIOL directory. You can define a specific location with the WinFIOL & Tools Configuration utility that comes with WinFIOL. Otherwise, when WinFIOL is run from a network drive and you do not have write access, WinFIOL will store the desktop file in the Windows directory. You can override the desktop file directory with the /D start option.

Where the system file is stored

The system file normally resides in the WinFIOL directory. If the registry key HKEY_CURRENT_USER\Software\Ericsson\WinFIOL\CurrentVersion\SysPath is set to a directory path, the system file is loaded from there. Otherwise, when WinFIOL is run from a network drive and you do not have write access, WinFIOL will store the system file in the Windows directory. You can override the system file directory with the /S start option.

March 1999


Configuration, continued

Start options

Introduction

When starting WinFIOL, a number of start-up options can be defined on the command line. For example:

winfiol.exe /d /s=c:\mydir

In the example above, two start options are defined, /d and /s.

List of Start Options

When defining an option, both upper-case and lower-case characters may be used. Start options need not be separated by spaces. Below is a list of all supported start options.

/D or /D=dir

The /D option defines where the desktop file WINFIOL.DSK with all personal settings is stored. Specifying /D causes WinFIOL to load the desktop file from the Windows directory. Specifying /D=c:\mydir causes WinFIOL to load the desktop file from C:\MYDIR. Without this start option, the desktop file is loaded from the WinFIOL directory or Windows directory.

/S or /S=dir

The /S option defines where the system file WINFIOL.SYS with all communication and printer settings is stored. Specifying /S causes WinFIOL to load the system file from the Windows directory. Specifying /S=c:\mydir causes WinFIOL to load the system file from C:\MYDIR. Without this start option, the system file is loaded from the WinFIOL directory or Windows directory.

/M=macro

The /M option causes a macro to be run during start-up.

/P=file

The /P option specifies that all phonebook data is to be read from a special file. Normally, the phonebook data is in the desktop file. Note that unless /E is also specified, the phonebook data cannot be modified.

/E

The /E option allows phonebook data to be modified. This option is effective only when the /P option is also specified. If the /E option is not specified, the phonebook data cannot be modified.

March 1999



/B

The /B option specifies that WinFIOL should start without reopening any channel windows, command file windows and message window.

No start option

When specifying a command line parameter without one of the options above, WinFIOL assumes it is a file and will try to load it. This file can be a command file, channel file or message file.

However, if the string contains no backslashes and at least 2 dots, WinFIOL assumes that it is an TCP/IP host name or address respectively. In that case, a channel is connected using the specified TCP/IP address/host name, provided that WinFIOL can find a channel that accepts a TCP/IP communications driver. In order to connect to a certain host, type e.g.:

winfiol.exe 123.45.67.89 or: winfiol.exe lmf.ericsson.se

Translation file

Introduction

WinFIOL can translate certain characters when sending to and receiving from AXE or MD110. A translation table can be defined in a translation file.

Description

A translation file is an ASCII file with extension ".XLT", e.g. "ACOUNTRY.XLT". All translation files must reside in the same directory as WINFIOL.EXE. Each line in a translation file must have the following format:

<char-in-AXE>=<char-in-WinFIOL>

where <char-in-WinFIOL> is the character you see on the screen (Windows character set), and <char-in-AXE> is the character that is sent to or received from AXE (DOS character set). The character definitions must be decimal or hexadecimal (AXE format), for example:

92=153

h'5C=h'99

Lines that do not comply with this format are ignored without notification when WinFIOL reads in the translation file.

Select translation file

WinFIOL is supplied with 7 translation files. The translation file to be used needs to be defined for each channel in the "Target" page of the channel properties dialog box.

March 1999



Short commands

Introduction

WinFIOL supports short commands. Short commands start with a percentage sign (%) and are associated with other commands. Typing short commands in the input window and pressing Enter replaces them with the associated command.

Description

A short command is defined in a text file as follows:

%cmd1%EXEMP:RP=,EM=;

When you type %cmd1 in the input window and press Enter, it is replaced by EXEMP:RP=,EM=;. The file with short commands can have an unlimited number of short commands. The name of the short command itself (e.g. %cmd1) can be freely chosen.

Select short command file

The short command file to be used is defined for each channel in the "Links" page of the channel properties dialog box. The short commands are automatically loaded when a channel is opened and updated if a short command file is saved from a command file window.

March 1999


Advanced

Detect WinFIOL (advanced)

Introduction

This is advanced information for programmers!

It may be necessary for other programs to detect whether WinFIOL is currently running. To find out how to start up WinFIOL, see Locate WinFIOL (advanced).

Using the class name

The easiest way to detect WinFIOL is to use the FindWindow( ) function of the Windows API. Only specify the class name of WinFIOL, "WFMainWindow". If FindWindow( ) returns a window handle, WinFIOL is running. This method is, however, unreliable since other programs may have the same class name.

Using DDE

The recommended method for detecting whether WinFIOL is running is to use DDE. Establish a DDE conversation with the Main information using the "Information" data item. If not successful, try to establish a DDE conversation with a channel topic "Channel #1". If successful, the WinFIOL version is older than 3.x, since the Main topic is a new feature since version 4.0.topic of WinFIOL. If successful, request version

Locate WinFIOL (advanced)

Introduction

This is advanced information for programmers!

It may be necessary for other programs to locate WinFIOL in order to start it up. To find out how to detect whether WinFIOL is running, see Detect WinFIOL (advanced).

Detecting WinFIOL is different for some versions of WinFIOL. Described here is the method of detecting the 32-bit versions of WinFIOL 4.x and 5.x, the 16-bit version of WinFIOL 4.x and WinFIOL 3.2 or older (which are all 16-bit programs). Only the 32-bit method is guaranteed to work for future 32-bit versions of WinFIOL.

March 1999


Advanced, continued

All 32-bit versions

Both the installation program and WinFIOL itself register WinFIOL in the registry under the "HKEY_LOCAL_MACHINE\SOFTWARE\Ericsson\WinFIOL" key. To find out the version of WinFIOL, query the value of the sub-key "CurrentVersion". The value is the official Ericsson product registration, for example: "CRAH 301 1056 R5". To find out the path to the WinFIOL program, query the sub-key "CurrentVersion\AppPaths". The value is the full path name. Note that this path name may be enclosed in double quotes and may contain spaces. You can use the "regedit" program to view the contents of the registry.

16-bit version of WinFIOL 4.x

Both the installation program and WinFIOL itself register WinFIOL in WIN.INI. The section "[WinFIOL]" contains an entry called "AppPaths" that contains the full path of the WinFIOL program, without the program specification itself. This path specification will always be a short file name, as opposed to a long file name, with no spaces. The same section will also contain an entry called "CurrentVersion", indicating the version of WinFIOL. Example:

[WinFIOL]

CurrentVersion=CRAH 301 1056 R5

AppPaths=c:\winfiol

WinFIOL 3.2 and older

There is no reliable method for locating older versions of WinFIOL. Only if both WinFIOL and DocView for Windows are installed by the installation program, some lines in WIN.INI can be used. The section "[DocView]" contains an entry called "startwf" that contains the full path of the WinFIOL program. If this entry cannot be found, an alternative method is to use the entry "startwdv" in the section "[WinFIOL]", which contains the full path of the DocView for Windows program. WinFIOL may be in the same directory.

Channel File Directory

Introduction

The channel settings are stored in channel files, which are maintained by the Target Manager. This help page describes how to change the location of the channel files.

March 1999


Advanced, continued

Description

The installation program creates a subdirectory with the name ChnFiles, where by default all channel files are stored. At any time, you can copy existing channel files from another directory into this directory. The channel file directory can be changed in the "Channel files" page of the WinFIOL & Tools Configuration utility.

Setup LDAP Connection

Introduction

WinFIOL and related tools use the Target Manager from which you can select an exchange to connect to. The Target Manager can connect to a LDAP server that knows of all available target exchanges. In addition, there can be multiple central directories from which predefined channel data can be fetched.

Define LDAP servers and central directories

One or more LDAP servers and associated information can be defined in the "Network" page of the WinFIOL & Tools Configuration utility. With the same utility, you can also define central directories.

Setup LDAP Server

A description of setting up the LDAP server is beyond the scope of this help. There is a document describing this that you can request from your local Ericsson company.

March 1999


WinFIOL Tools and Configuration

General

The WinFIOL & Tools configuration program contains a list of pages on the left side. Activating an item in this list with the mouse or cursor keys activates the page on the right side. You can press Ctrl+Tab and Shift+Ctrl+Tab anywhere in the dialog box to select the next and previous page respectively.

The following property pages exist:

Channel files: define channel file directory Network: define channel pools WinFIOL: verify installation of WinFIOL Settings: define desktop directory Plug-ins: configure plug-ins for WinFIOL

Max. channels: define maximum number of channels

Note: The sub pages below the WinFIOL page will not be shown when WinFIOL is not installed.

Channel files

Function

Define the directory where all channel files reside.

Description

WinFIOL & Tools store all channel related information in channel files (there are exceptions). These channel files are stored in the channel file directory, which is shared among all tools.

A suitable directory is automatically chosen during installation. In this page, you can change the channel file directory. A good example is to change it to a directory on the LAN so that you can access your channel files from any computer.

This option can be used for both WinFIOL 5.0 and 5.1 and all tools in the WinFIOL & Tools package.

Options

Current

New

Move all channel files

Move all dangerous command files

Move all WinFIOL template files

Move all other files

March 1999


WinFIOL Tools and Configuration, continued

Advanced

The channel file directory is defined in the Windows registry under:

HKEY_LOCAL_MACHINE\SOFTWARE\Ericsson\WinFIOL Tools\ChnFiles

Network

Function

Add LDAP and directory nodes to the Network page of the Target Manager.

Description

The LDAP and directory nodes displayed on the WinFIOL & Tools Target Manager dialog Network page are defined on this page. If you have an LDAP directory server that contains network information you may use this page to tell WinFIOL & Tools where the server can be found. Press the Add server button and write the host name or IP address, port, and the search base for the LDAP data.

You can also add any directory that contains WinFIOL & Tools channel files to the list by pressing the Add directory button. Then the directory and its subdirectories will be displayed in the Target Manager dialog Network page treeview.

The list entries can be modified by either selecting an item and pressing the Modify button or by double-clicking on the item. Deletion is done by selecting an item and pressing the Delete button or the Delete key on the keyboard.

This option can be used for both WinFIOL 5.0 and 5.1 and all tools in the WinFIOL & Tools package. Note that WinFIOL 5.0 does not support central directories.

Options

Directory servers and central directories

Add directory

Add server

Modify

Delete

March 1999



Advanced

The LDAP server and related information is defined in the Windows registry under:

HKEY_LOCAL_MACHINE\SOFTWARE\Ericsson\WinFIOL Tools\CurrentVersion\LDAPServer

HKEY_LOCAL_MACHINE\SOFTWARE\Ericsson\WinFIOL Tools\CurrentVersion\LDAPPort

HKEY_LOCAL_MACHINE\SOFTWARE\Ericsson\WinFIOL Tools\CurrentVersion\LDAPSearchBase

WinFIOL installation

Function

Verify the installation of WinFIOL.

Description

This page shows what version of WinFIOL is currently installed and where.

The WinFIOL & Tools configuration program version 5.1 is aimed to work with WinFIOL 5.1. However, the WinFIOL options in the subpages also work with WinFIOL 5.0.

Advanced

The WinFIOL product version is defined in the Windows registry under:

HKEY_LOCAL_MACHINE\SOFTWARE\Ericsson\WinFIOL\CurrentVersion

The installation path is defined in the Windows registry under:

HKEY_LOCAL_MACHINE\SOFTWARE\Ericsson\WinFIOL\CurrentVersion\AppPaths

Settings

Function

Define the location of the WinFIOL desktop file.

March 1999



Description

WinFIOL saves all personal settings in the desktop file WINFIOL.DSK when it terminates. Examples of personal settings are colors, font and other preferences. Upon start up, WinFIOL reads the desktop file and restores all settings.

The location of the desktop file is detemined by one of the following rules (starting with the most important):

Defined by the /D start option (see start options in the WinFIOL help).

Defined in this Settings page. Select the option Use other desktop directory and fill in the location.

If you do not have write access to the directory where WinFIOL is installed, the desktop file is stored in and read from the Windows directory.

By default, the desktop file is in the same directory as the WinFIOL program.

This option can be used for both WinFIOL 5.0 and 5.1.

Options

Use other desktop directory

Location

Advanced

The location that you can define in this Settings page is defined in the Windows registry under:

HKEY_CURRENT_USER\Software\Ericsson\WinFIOL\CurrentVersion\DskPath

Plug-ins

Function

Define the plug-ins to be loaded by WinFIOL.

Description

WinFIOL allows plug-ins to be loaded. Plug-ins are modules that perform an extended task in WinFIOL. These plug-ins can be loaded into WinFIOL only, not any other program that supports plug-ins.

Various plug-ins exist today, such as the Script plug-in, Active printout plug-in, Dangerous commands plug-in and Monitoring plug-in. Other plug-ins may come available later.


March 1999



Options

Select a plug-in from the list and click to check box to install. You can scan other plug-ins from any directory.

Plug-in modules to install Scan

Module file name

Maximum number of channels

Function

Define the maximum number of channels that WinFIOL can open simultaneously.

Description

WinFIOL supports up to 100 channels. Here you can define the maximum that you want to use in WinFIOL. It is recommended to keep the maximum to 9, unless you need a lot of channels open at the same time for logging functions.


Options

Use other value (check box)

Use other value (edit field)

Advanced

The maximum number of channels is defined in the Windows registry under:

HKEY_LOCAL_MACHINE\SOFTWARE\Ericsson\WinFIOL\CurrentVersion\MaxChannels

March 1999


Monitoring Module

General

Monitoring Dialog Box

Activate

Button bar

Menu Run | Monitoring

Function

The monitoring dialog box is used to connect actions to events.

Description

An event is a certain occurrence. The monitoring module 'listens' all the time for events to happen. Once an event occurs, it is triggered and so called actions can be executed. In this dialog box, one or more actions can be connected to each event.

From the event-action tree on the left of the dialog box you can select what event or action you want to configure. On the right the currently selected event or action will be shown.

Options

Event-action treeView: By eventsView: By action typeNew eventNew actionDelete

Add a new event

Function

Connect a new event to the currently selected channel (or to the channel of the currently selected event or action).

Description

Press the "New Event" button. The New Event dialog box appears, in which you can select the type of the new event. The event can then be configured.

Remove an event by selecting it and pressing the "Delete" button.

March 1999


Monitoring Module, continued

Configuring events

Description

When you select an event in the event-action tree or add a new event, a configuration screen for that specific type of event will automatically be shown on the right side of the dialog box.

The configuration control values you select or change will automatically be stored.

List of events

Alarm/ceasing from target exchangeCommunication port closed/errorDDE execute commandError detectedText from target exchangeTransmission paused/finished

Add a new action

Function

Connect a new action to the currently selected event (or to the event of the currently selected action).

Description

Press the "New Action" button. The New Action dialog box appears, in which you can select the type of the new action. The action can then be configured.

Remove an action by selecting it and pressing the "Delete" button.

Configuring actions

Description

When you select an action in the event-action tree or add a new action, a configuration screen for that specific type of action will automatically be shown on the right side of the dialog box.

The configuration control values you select or change will automatically be stored.

March 1999



List of actions

Beep / SoundLaunch ApplicationMessage into message windowPause/Stop transmissionPost Windows messagePrint eventRun macroSend DDE messageSend e-mailSend GSM messageSend MML commandTransmit command fileWrite event to a file

Format strings

Description

A format string can be used in some actions to retrieve an parameter from the event that triggered the action. When the action is executed, the event parameter name in a format string will be replaced with its value.

The format string consists of text and references to event parameters. References to event parameters must be written using the syntax <%EventParameterName%>. For example: "Alarm <%alarmname%> received"

March 1999



List of event parameters

Event Available parameters

Values

<All event types> Channelnreventtype

"1", "2" etc.text

Alarm/ceasing from target exchange

AlarmclassAlarmcategoryalarmname

TextTexttext

Communication port closed/error

Portclosedporterror

"True", "False""True", "False"

DDE execute command

Executefunctionexecuteparameters

Texttext

Error detected Causefaultcode

Texttext

Text from target exchange

Receivedtext text

Transmission paused/finished

PausedFinishedByuserautomatically

"True", "False""True", "False""True", "False""True", "False"

List of Events

Alarm/ceasing from target

exchange

Function

WinFIOL can be configured to react when an alarm or an alarm ceasure is received from a target exchange (AXE only).

Description

When the alarm class, category and name are not defined, this event is triggered on any alarm or alarm ceasing that is received from the target exchange. By defining a specific alarm class, category or name, you can narrow the occasions that this event is triggered.

Options

AlarmAlarm ceasingAlarm classAlarm categoryAlarm name

March 1999



Parameters

The event parameters listed here can be used in the format strings of some actions. References to event parameters must be written using the syntax <%EventParameterName%>, for example: "Alarm <%alarmname%> received."


Values

Alarm/ceasing from target exchange

ChannelnrEventtypeAlarmclassAlarmcategoryalarmname

"1", "2" etc.texttexttexttext


Function

WinFIOL can be configured to react when a communication port is closed or when there is a communication error.

Options

Port closedPort error

Parameters

The event parameters listed here can be used in the format strings of some actions. References to event parameters must be written using the syntax <%EventParameterName%>, for example: "Port error = <%porterror%>."


Values


ChannelnrEventtypePortclosedporterror

"1", "2" etc.text"True", "False""True", "False"

DDE execute command

Function

WinFIOL can be configured to react when a DDE execute command is received.

March 1999



Description

A DDE client application that has a conversation with the main topic or a channel topic can send DDE execute commands. By specifying a new execute command for this event, you can effectively extend the number of DDE execute commands that WinFIOL supports.

Example

If you define as the DDE execute function: "Test" (without the quotes), a DDE client program can trigger this event by sending a DDE execute command with the following service and topic names:

Service: "WinFIOL"

Topic: "Main" or "Channel #1" or "Channel #2" etc.

Execute: "[Test]"

Options

DDE execute function

Parameters

The event parameters listed here can be used in the format strings of some actions. References to event parameters must be written using the syntax <%EventParameterName%>, for example: "DDE function = <%executefunction%>."


Values

DDE execute command

ChannelnrEventtypeExecutefunctionexecuteparameters

"1", "2" etc.texttexttext

Error detected

Function

WinFIOL can be configured to react when an error response has been received from the target exchange.

Description

Error responses are detected by WinFIOL when properly defined in the "Prompt definition" of the "Control" page of the channel properties dialog box. This event is triggered every time WinFIOL receives an error from the target exchange. By defining a specific MML command that must cause the error, you can narrow the occasions that this event is triggered.

March 1999



Options

Cause: Any MML commandCause: Specific MML commandMML command edit boxFault code

Parameters

The event parameters listed here can be used in the format strings of some actions. References to event parameters must be written using the syntax <%EventParameterName%>, for example: "Error cause = <%cause%>."


Values

Error detected ChannelnrEventtypeCausefaultcode

"1", "2" etc.texttexttext


Function

WinFIOL can be configured to react when a certain combination of text strings is received from a target exchange.

Options

Text receivedAllow other text on the same lineAdditional text: ReceivedAdditional text: Not receivedAdditional text: After n linesAdditional text: Text

March 1999



Parameters

The event parameters listed here can be used in the format strings of some actions. References to event parameters must be written using the syntax <%EventParameterName%>, for example: "The received text is: <%receivedtext%>."


Values


ChannelnrEventtypereceivedtext

"1", "2" etc.texttext

Transmission paused/finish

ed

Function

WinFIOL can be configured to react when the transmission of a command file is paused or finished.

Options

PausedFinishedBy user (manually)Automatically

Parameters

The event parameters listed here can be used in the format strings of some actions. References to event parameters must be written using the syntax <%EventParameterName%>, for example: "Transmission finished = <%finished%>."


Values

Transmission paused/finished

ChannelnrEventtypePausedFinishedByuserautomatically

"1", "2" etc.text"True", "False""True", "False""True", "False""True", "False"

March 1999



List of Actions

Beep / Sound

Function

WinFIOL can be configured to react to an event with a system beep or by playing a wave file.

Options

System beepPlay wave fileWave fileTest

Launch Application

Function

WinFIOL can be configured to react to an event by launching an application, i.e. starting a program.

Options

ApplicationWorking directoryInitial stateFormat string for command line

Message into message window

Function

WinFIOL can be configured to react to an event by storing a message into the message window.

Description

You can define the message type (any text), error (any text) and optionally cause for a message. Additionally, you can add a predefined icon to the message. The message window will not automatically be opened.

Options

TypeErrorCauseIcon

Pause/Stop transmission

Function

March 1999


WinFIOL can be configured to react to an event by pausing or stopping ongoing transmission of MML commands.

Options

Transmission: PauseTransmission: StopReason

Post Windows message

Function

WinFIOL can be configured to react to an event by posting a Windows message to a predefined window or window class.

Description

Each message is defined by a number. You can define the number of the message, but also a message name. If you define a name, the Windows API function RegisterWindowMessage( ) creates a unique number for the message.

If neither window nor class is given, the Windows message will be broadcasted to all top level windows.

Important! Use this action with the utmost caution. For instance, by specifying a number below 1024, it is possible to crash all running programs!

Options

Message name/numberWindow classWindow title

Print event

Description

WinFIOL can be configured to react to an event by printing the event. The printer should be selected in the print dialog box of WinFIOL.

Options

Format string

Run macro

Function

WinFIOL can be configured to react to an event by running a macro. The format string will be specified on the macro command line.

Options

MacroFormat string for command line

March 1999



DDE message

Function

WinFIOL can be configured to react to an event by sending a DDE execute or poke command.

Options

DDE server nameTopic nameFunction: ExecuteFunction: PokeItem nameFormat string as item data

Send e-mail

Function

WinFIOL can be configured to react to an event by sending e-mail to a predefined address.

Options

ReceiverTitleFormat string as mail contentsSetup

Send GSM message

Function

WinFIOL can be configured to react to an event by sending a GSM message to a predefined GSM number. This is implemented by sending an e-mail message.

Options

GSM numberTitleFormat string as text message

Send MML command

Function

WinFIOL can be configured to react to an event by sending an MML command to the target exchange.

Options

MML commandAuto connect

March 1999



Transmit command file

Function

WinFIOL can be configured to react to an event by transmitting a command file to the target exchange.

Options

Command file

Write event to a file

Function

WinFIOL can be configured to react to an event by writing the event to a file.

Options

File nameFail if already existsAppendTruncateFormat string

March 1999


Miscellaneous

Hot Keys in WinFIOL

F1 Context sensitive help

F2 Transmit from file

F3 Activate output window

F4 Send line or block

F5 Connect terminal

F6 Print text / print settings

F7 Activate command file window

F8 Open or close log file

F9 Open channel

F10 Activate input window

F11 Traffic setup

F12 Break

Shift+F1 Documentation browser

Ctrl+F1 Documentation

Alt+F1 CommandForm

Shift+F2 Schedule file for transmission

Ctrl+F4 Close window

Alt+F5 Toggle channel mode (TTY, setup, buffered)

Shift+F6 Switch on/off printer log

Shift+F8 Open/close log file

Shift+F9 Phone book

Shift+F10 Context sensitive popup menu

Alt+BkSp Undo last edit action

Shift+Del Cut text from window into clipboard

Ctrl+Ins Copy text from window into clipboard

Shift+Ins Paste text from clipboard into window

Ctrl+Del Delete block from text

Alt+Ins Copy text directly (persistent blocks only, see preferences)

Alt+Del Move text directly (persistent blocks only, see preferences)

Ctrl+A Select all text

March 1999


Miscellaneous, continued

Ctrl+B Select all text from cursor position

Ctrl+C Copy block from text into clipboard

Ctrl+F Find a string

Ctrl+G Go to a specific line number

Ctrl+H Activate hex/cec converter

Ctrl+I Import a file from disk into text

Ctrl+J Toggle line-breakpoint

Ctrl+K Insert a new line into the text

Ctrl+L Repeat last search operation

Ctrl+M Bookmarks

Ctrl+N Search next error

Ctrl+O Open a file and load into new command file window

Ctrl+P Search previous error

Ctrl+Q Toggle square/normal blocks

Ctrl+R Replace one or more strings

Ctrl+S Save text in active window to disk

Ctrl+T Delete word

Ctrl+V Paste block from clipboard into text

Ctrl+W Write block to disk

Ctrl+X Cut block from text into clipboard

Ctrl+Y Delete line

Ctrl+Z Undo last edit action if not in input window

Shift+Ctrl+Z Redo last undone edit action if not in input window

Ctrl+n Move cursor to bookmark n (n = 0 ... 9)

Alt+m Set bookmark m at current cursor position (m = 1 ... 9)

March 1999



Print

Activate

Tool bar

Keyboard F6, Shift+F6

Menu File | Print

Macro Print( )

Functions

1 Log received data to the printer.

2 Print selected or all text from a window.

Description

Pressing Shift+F6 toggles the print log on or off. When print log is enabled, all text appearing in the output window will be printed. You can hold down the Shift key while pressing the print button to toggle the print log on or off. It is not possible to switch the print log on if the printer is being used by another channel.

Pressing F6 shows a dialog box with all printer settings. You can define which printer to use, whether to print directly to the printer port (recommended when logging to the printer) or use the Print Manager (recommended when printing text), the left margins, font size and whether to enable print log. From this dialog box, you can also print a selection or all text in the active window.

If you choose to use the Print Manager, the printer will only start printing when the page is full or you end the print job. This is not useful when you want to log the output to the printer. If you choose to print directly to the printer port, the printer responds directly. Error handling is not as accurate however.

When printing using the Print Manager, the font selected in the Font page of the preferences dialog also applies for printing.

Options

All options are described in more detail in print dialog box.

Log input

Activate

Menu File | Log input

Macro LogInput( )

March 1999



Function

Log all commands sent from the input window.

Description

You can log every MML command that is sent from the input window to a file for later reference. Each channel can have a log file of its own provided that they are not the same. Before opening or closing a log file, activate the proper channel first.

If you want to see the contents of a log file, give the command to open a new command file window and select the input log file. Even active log files can be opened with this method.

Options

Current log file

Close

Log output

Activate

Tool bar

Keyboard F8, Shift+F8

Menu File | Log output

Macros LogFile( ), LogOutput( ), LogAppend( ), LogCreate( ), LogClose( )

DDE [LogAppend(file)], [LogCreate(file)], [LogClose]

Function

Open or close a log file for the currently active channel.

March 1999



Description

You can log all text that is received from a target exchange and shown in the output window to a file for later reference. Each channel can have a log file of its own provided that they are not the same. Before opening or closing a log file, activate the proper channel first.

Pressing F8 allows you to define a new log file or close an open log file for the currently active channel. It is not necessary to close the current log file first before opening a new one.

Pressing Shift+F8 or holding down the Shift key and clicking the log file button on the tool bar allows you to alternatively reopen the last log file used or close the current log file for the currently active channel. According to the "Quick-open log file" setting in the "Directories" page of the preferences dialog box, a previously opened log file will either be appended or overwritten.

If you want to see the contents of a log file, give the command to open a new command file window and select one of the previous log files. Even active log files can be opened with this method.

Options

Current log file

Close

Open file

Activate

Tool bar

Keyboard Ctrl+O

Menu File | Open

Macro OpenFile( )

DDE [Load(file)]

Function

Load a command file into a new command file window.

March 1999



Description

In a dialog box you define which command file you want to load into a new command file window. The new command file window will be automatically associated with the current channel.

It is possible to open files of a special type, such as macro files and message files. In that case WinFIOL will not open a new command file window, but instead run a macro or load messages into the message window respectively. Files of any other type are considered command files and are loaded into a new command file window. You can force WinFIOL to load a file into a new command file window by clicking the option "Load as Text" in the dialog box.

It is possible to select more than one file, using the mouse and the Ctrl or Shift key. Different file types may not be mixed. The list of file types can be defined in the "Directories | Default" page of the Preferences dialog box. Also the initial directory can be defined in the Directories dialog box.

Alternative

Command files can be loaded by dragging them from the File Manager or File Explorer and dropping them into WinFIOL. Note that when the files are dropped into a channel window, they will be transmitted rather than being loaded into a command file window. See also: drag and drop.

A command file can also be loaded by specifying it on the command line when starting WinFIOL (see start options).

Options

Used log files

Load as text

Connect

Activate

Tool bar

Keyboard F5

Menu Run | Connect

Macro Connect( )

DDE [Connect]

Function

Connect the terminal in order to send MML commands.

March 1999



Description

Even though a channel is connected to a target exchange using a certain communication protocol, a target exchange prompt needs to be received before any MML command can be sent. Historically, this is called "Connect". This documentation uses the term "Connect the terminal", as opposed to "Open communications port" for establishing a communication path to a target exchange. If the communications port is not opened, press Enter to open it.

AXE (e.g. IOG 11 or IOG 3) normally responds with an exchange header and a prompt. MD110 responds with a request for a password. In buffered mode, WinFIOL will not show the MD110 response but instead display a dialog box in which you can type a password. This password does not have to be terminated with a semicolon. Alternatively, you can switch to TTY mode and type the password in the input window. Be sure the option "Hide chars in TTY" in the "Style" page of the channel properties dialog box is switched on.

When attempting to send any MML commands while the terminal is not connected (i.e. released), the MML commands are queued (see queue dialog box). As soon as the terminal is connected, WinFIOL sends any queued commands.

Break

Activate

Tool bar

Keyboard F12

Menu Run | Break

Macro Break( )

DDE [Break]

Function

Interrupt long printout being received from the target exchange.

Description

Any printout received from the target exchange can be interrupted with Break. It may be necessary to give the Break command several times before it takes any effect.

Note that when connecting to a target exchange with the TCP/IP communications protocol, the break function may not work. It depends on the server whether the break function is implemented.

The break function cannot be used in setup mode.

March 1999



Release terminal

Activate

Tool bar

Keyboard Escape

Menu Run | Release

Macro Release( )

DDE [Release]

Function

Release the terminal to allow reception of delayed and spontaneous printouts.

Description

WinFIOL will try to "release the terminal" of the current channel. Once a terminal is released, delayed printouts from ordered MML commands and spontaneous printouts such as alarms can be received. Note that releasing the terminal does not cause the communication path to a target exchange to be closed.

When you try to send some MML commands to the target exchange while the terminal is released (the status line also shows: "Released"), these commands are queued and will be sent as soon as the terminal is connected. You can view and remove these queued commands in the queue dialog box.

MD110 users may be accustomed to Ctrl+X having a release function. This is not possible with WinFIOL in buffered mode, since Ctrl+X is a Windows hot key for cutting text and copying it to the clipboard. In TTY mode on the other hand, any characters with ASCII codes 1 to 26 can be sent by pressing Ctrl+A to Ctrl+Z.

Release does not work while MML commands are being transmitted. However, when the transmission is paused release is possible. WinFIOL can automatically release the terminal during transmission when an ordered MML command is sent. This feature is enabled by switching on the "Auto Release" option in the "Flow" page of the traffic setup dialog box.

Escape key for release

In older versions of WinFIOL, the F1 or F9 function key could be used for release. WinFIOL 5.x radically changes the hot key for release to Escape. F1 can be used for activating help, as with all Windows programs. Note that the old DOS version of FIOL used F1 for release.

March 1999



Cut text from window into clipboard

Activate

Tool bar

Keyboard Ctrl+X, Shift+Del

Menu Edit | Cut

Macro CutBlock( )

Function

The selected text will be copied to the clipboard and removed from the window.

Description

Cut and paste can be used to move a portion of text from one place to another. When cutting a selection of text, it is placed in the clipboard, and remains there until the next cut or copy action. The text in the clipboard can be pasted multiple times at another location inside WinFIOL or any other Windows application. The removal of the selected text can be reversed with the undo command, except in the input window.

A square block is considered a different format than a normal block. Only WinFIOL, DocView and PlexView for Windows understand the square block format. However, a square block in the clipboard can be pasted in any application as a normal block (standard text format).

You cannot cut text from an output window or cut blocks consisting of more than one line from an input window.

Note: The hot key Ctrl+X has a different effect in TTY mode.

Copy text from window into clipboard

Activate

Tool bar

Keyboard Ctrl+C, Ctrl+Ins

Menu Edit | Copy

Macro CopyBlock( )

Function

The selected text will be copied to the clipboard.

March 1999



Description

Copy and paste can be used to copy a portion of text from one place to another. When copying a selection of text, it is placed in the clipboard, and remains there until the next cut or copy action. The text in the clipboard can be pasted multiple times at another location inside WinFIOL or any other Windows application.


You can copy selected text from the input window, output window, command file window and message window.

Note: The hot key Ctrl+C has a different effect in TTY mode.

Paste text from clipboard into window

Activate

Tool bar

Keyboard Ctrl+V, Shift+Ins

Menu Edit | Paste

Macro PasteBlock( )

Function

Any text in the clipboard will be pasted at the cursor position.

March 1999



Description

Copy and paste can be used to copy a portion of text from one place to another. When copying a selection of text, it is placed in the clipboard, and remains there until the next cut or copy action. The text in the clipboard can be pasted multiple times at another location inside WinFIOL or any other Windows application. Pasting text can be reversed with the undo command, except in the input window.


In WinFIOL, to paste a square block from the clipboard as a square block in the text, be sure to switch on the "square block" setting. To paste it as a normal block, switch off the "square block" setting.

You cannot paste text into an output window, message window and scheduler window. In the input window, only the first line of a block is pasted and any other lines are ignored.

Note: The hot key Ctrl+V has a different function effect in TTY mode.

Delete block from text

Activate

Keyboard Ctrl+Del

Menu Edit | Delete

Macro DelBlock( )

Function

Delete the selected text.

Description

Any selected text will be deleted. It will not be copied to the clipboard. You cannot delete selected text from an output window. Also, you cannot delete selected text consisting of more lines from an input window.

To undo this action, press undo.

March 1999



Undo last edit action

Activate

Keyboard Alt+BkSp, Ctrl+Z

Menu Edit | Undo

Function

Undo the last edit action.

Description

All edit actions in a command file window can be undone in case of a mistake. This is applicable for cursor movements, selection of text, typing, deleting, copying, pasting etc.

After using any of the tools Undress or Capitals, all undo actions are lost.

You can set the maximum number of undo actions in the "Editor" page of the preferences dialog box.

Note: In the input window, Ctrl+Z does not perform the undo action, but sends ASCII 26 in stead, as in TTY mode.

Redo last undone edit action

Activate

Keyboard Shift+Ctrl+Z

Menu Edit | Redo

Function

Redo the last undone edit action.

Description

All edit actions in a command file window can be undone in case of a mistake. This is applicable for cursor movements, selection of text, typing, deleting, copying, pasting etc. After undoing any of these edit actions, they can be redone.

All edit actions that are undone can be redone. After normal edit actions or cursor movements however, it is never possible to redo previously undone actions.

You can set the maximum number of undo actions in the "Editor" page of the preferences dialog box. This number also applies to the maximum number of redo actions.

Note: In the input window, Shift+Ctrl+Z does not perform the undo action, but sends ASCII 26 in stead, as in TTY mode.

March 1999



Copy text directly

Activate

Keyboard Alt+Ins

Function

Copy the selected text to another position within the same window.

Description

Copying text directly works only when you have enabled the option "Persistent blocks" in the "Editor" page of the preferences dialog box dialog box. With persistent blocks, the text selection does not disappear when you move the cursor or type any text.

To copy text from one window to another, copy to the clipboard and then paste from the clipboard into another window.

You cannot copy text in an output window. Also you cannot copy text consisting of more lines in an input window.

Move text directly

Activate

Keyboard Alt+Del

Function

Move the selected text to another position within the same window.

Description

Moving text directly works only when you have enabled the Persistent blocks option in the "Editor" page of the preferences dialog box dialog box. With persistent blocks, the text selection does not disappear when you move the cursor or type any text.

To move text from one window to another, cut the desired text to the clipboard and then paste into another window.

You cannot move text in an output window. It is also not possible to move text consisting of more than one line in an input window.

Import block

Activate

Keyboard Ctrl+I

Menu Block | Import block

Macro ImportBlock( )

March 1999



Function

Load a text file from disk and insert at current cursor position.

Description

Any text file can be loaded into the current command file window. In a file selection dialog box you can type the name of the file to import. All text of the file will be inserted at the position of the text cursor. Importing a file can be undone with the undo command.

Note: The hot key Ctrl+I has a different action in TTY mode in the input window.

Save

Activate

Tool bar

Keyboard Ctrl+S

Menu File | Save

Macro Save( )

Function

Save the contents of the current window to a file on disk.

Description

When a command file window is active, the text in the window will be saved to disk. If the command file window does not have a name (i.e. file name) yet, a dialog box will appear in which you can type a file name. Any command file window with the title "nonamexx.cmd", where xx is a number, does not have a valid name. WinFIOL can automatically rename the extension of an existing file into ".bak" before overwriting the existing file. To do so, switch on the "Make BAK file when saving command file" option in the "Backup/Log" page in the preferences dialog box

When an output window is active, the text in that window will be saved to disk. A dialog box appears in which you can type a file name.

When an input window is active, the text in that window will be saved to disk. A dialog box appears in which you can type a file name.

When the message window is active, any messages can be saved to a message file. A dialog box appears in which you can type a file name.

When the scheduler window is active, any scheduled items can be saved to a file. A dialog box appears in which you can type a file name.

March 1999



Save as

Activate

Tool bar Shift +

Menu File | Save as

Macro Save( )

Function

Save contents of the currently active document window to disk.

Description

Text in the output window, input window and command file windows, messages in the message window and scheduled items in the scheduler window can be saved to disk. In a file selection dialog box you can specify a valid file name.

If a file with the same name exists already, you are asked whether you want to overwrite that file.

Save all

Activate

Menu File | Save all

Macro SaveAll( )

Function

Save text of all modified command file windows.

Description

A command file window can contain text loaded from a text file. Whenever this text is modified (e.g. by typing), it may be necessary to save the text to disk. The "Save all" command saves the text of all modified command files to disk, except for the command file windows that do not have a matching disk file (command file windows opened with New).

An alternative method to save text in command file windows is from the Windows dialog box. When editing many command files, it is recommended to switch on the "Auto backups" option in the "Editor" page of the preferences dialog box.

March 1999



Transmit file from disk

Activate

Tool bar

Keyboard F2

Menu Run | Transmit

Macro Transmit( )

DDE [Transmit(file)]

Function

Transmit or schedule a command file containing MML commands for transmission.

Description

In this dialog box, you can define what file to transmit to the currently active channel. You can transmit the command file directly or schedule the file for transmission at some later time. When you choose to transmit the command file directly, can define the line with which the transmission should start and whether an output log file should be automatically opened.

During transmission, all lines (containing MML commands), starting with the one that you specify, are sent to the target exchange one by one, until the last line is reached. Any lines starting with the @ sign are script commands which allow simple program control over a transmission.

When transmitting a file already loaded in a command file window, the data is transmitted from the window and not from the file on disk. Similarly, when you are transmitting a file from disk and you load that file into a command file window, the transmission is continued from the window and not from the file on disk. A file that is being transmitted can be loaded into a command file window any time.

When the transmission starts, you can monitor the progress and pause, resume or stop the transmission. Read more about this and other things in Error handling (general).

The transmit function cannot be used in setup mode.

Options

Start from line

Automatic log file

Schedule file for later transmission

March 1999



Write block

Activate

Keyboard Ctrl+W

Menu Block | Write block

Macro WriteBlock( )

Function

Write the selected text to a file on disk.

Description

Whenever any text is selected in a input window, output window or command file window, it can be written to disk. In a file selection dialog box you can type the name of the file to write the selected text to.

Send line or block

Activate

Tool bar

Keyboard F4

Menu Run | Send

Macro SendBlock( )

DDE [Send(command)]

Function

Send one or more MML commands to the target exchange.

March 1999



Description

This command sends one or more lines from a command file window to the target exchange. The command is sent to the target exchange of the channel with which the command file window is associated.

If no text is selected, only the current line will be sent to the target exchange. You can clear a text selection by pressing the 5 key on the numeric keypad when Num Lock is switched off.

If some text is selected, all MML commands inside the text selection will be sent to the target exchange. To send all text in a command file window, select all text first with Ctrl+A. To send all text starting from a certain line, select all text from the cursor position with Ctrl+B.

During transmission of more than one line, the progress is shown on a bar moving from 0% to 100% in the transmission dialog box. You can simultaneously perform any other task, except sending other MML commands from the same command file window and editing the text being sent. Only when transmission is paused is it possible to make some limited changes to the text being sent. To pause ongoing transmission, press the Escape key.

The way WinFIOL functions during transmission can be changed in the traffic setup dialog box. Errors can be logged to the message window.

All lines starting with the @ sign are script commands allowing simple program control over a transmission. In order to send characters with ASCII codes 1 to 26, switch to TTY mode first and press Ctrl+A to Ctrl+Z.

Note that WinFIOL automatically activates the input window when the Send command is given if the "Auto switch to input window" option in the "Miscellaneous" page of the preferences dialog box is set.

The send function cannot be used in setup mode.

March 1999

Documents

64250373-winfiol