Multi-Function Pane

Previous Section: VT100 Terminal

Document Home

Next Section: Status Bar

The Multi-function pane provides the user with a number of tabs - each providing a Wozterm utility.

Figure 3.13 - Multi-function pane

Item	Description
Current Tab Viewer	The Current Tab viewer displays the tool currently selected by the Tab selection panel.

Tab Selection Panel	By clicking on any of the tabs in the Tab selection panel, the user will bring to the foreground the relevant utility for use.

Command History tab

The Command History tab provides the user with a history of recently executed commands. Any command executed by a script or manually by a user via the VT100 Terminal is added to or refreshed in the command list. Commands in this list may then be edited and/or re-executed. In addition, the list may be saved to or loaded from file to allow lists with exchange specific commands to be used and recalled for particular exchanges.

Figure 3.14 - Command History tab

Item	Description
Show Command History	By clicking on the Cmd History tab in the Multi-function pane, the Command History tab will be shown.
Edit / Execute Command	By double clicking on a Command History line or pressing <ENTER> when the line is selected the command will be executed. When a line is selected the command can be edited in normal text editing mode, and executed as before.
Right-Click for Menu	Right clicking in the Command History tab will pop-up a Windows™ menu – allowing the history to be loaded/saved or cleared.

Command History tab Right-Click Menu

Right clicking in the Command History tab displays a pop-up menu.

Figure 3.15 - Command History tab Right-Click Menu	Execute Command	Only enabled if a valid command in the history is right-clicked, this menu item will re-execute the current command as if it were double-clicked or <ENTER> were pressed while it was high-lighted.
	New Command	Inserts a blank line above the current command so that a new command may be entered.
	Clear Command	Clears the current command.
	Clear All Commands	Clears all commands from the Command History.
	Open File	Shows a standard Windows™ open file dialog that allows the loading of previously created Command History (text) files.
	Reopen File	Reloads the last command history file used in this session of Wozterm. If no file has previously been loaded, the Wozterm default "CmdHist.txt" is loaded.
	Save Commands	Saves all commands currently in the history to the last command history file used in this session of Wozterm. If no file has previously been loaded, the Wozterm default "CmdHist.txt" is saved to.
	Save Commands As	Allows saving of the current commands in the history to a file other than the Wozterm default or current file.
	Cut	Cuts out the current command and places it on the Windows™ Clipboard.
	Copy	Copies the current command to the Windows™ Clipboard.
	Paste	Pastes the contents of the Windows™ Clipboard to the current line.

@WINDOW tab

The @WINDOW tab is provided by Wozterm for backwards compatibility with Ozterm. It provides Wozterm support for OVM keywords @window, @draw and @windend. The @WINDOW tab is given focus when any window processing is performed in a Wozterm script. The user may use a the <ENTER> key or using the right-click menu.

Figure 3.16 - @Window tab

Item	Description
Show @WINDOW	By clicking on the @WINDOW tab in the Multi-function pane, the @WINDOW tab will be shown.
Right-Click or <ENTER> to Submit	Right clicking in the @WINDOW tab will provide a pop-up menu with the option to submit the form. Alternately, pressing the <ENTER> key will submit the form.

@WINDOW tab Right-Click Menu

Currently, the @WINDOW tab Right-Click Menu provides the ability to submit the form displayed.

Figure 3.17 - @WINDOW tab Right-Click Menu

@Window Right-Click Menu

Font

Set a terminal font .

Submit

Submits the form displayed to Wozterm. The user may also submit by pressing the <ENTER> key.

Cancel

Cancels a form.

Text Events tab

The Text Events tab is quite similar to the Time Events tab, excluding the obvious that it’s events are based on Text received from a network element, rather than time.

Figure 3.18 - Text Events tab

Item	Description
Show Text Event tab	By clicking on the Text Events tab in the Multi-function pane, the Text Events tab will be shown.
Edit Text Event	The user may edit a single Text Event (at a time). The Inhibited attribute is assigned by Wozterm, however the other columns are editable. Active is (Y/N) only, Slogan is the exchange text you wish the event to be fired on and File Name is the Wozterm script file you wish to execute when Slogan is received. Label is the @label that you wish File Name to begin at and Log File is the file to be logged to for the event. Event Index is the index of each event.
Right-Click for Menu	Right clicking in the Text Event tab will pop-up a Windows menu.

Text Event tab Right-Click Menu

The majority of functionality provided by the Text Event tab is accessible via its right-click menu. It allows the addition, deletion and modification of text events.

Figure 3.19 - Text Event tab Right-Click Menu

Text Event tab Right-Click

Add Text Event

Produces an 'Add New Text Event' dialog box to fill in the text event details so that an event can be added.

Modify Text Event

Produces the 'Edit Text Event' Dialog box which is simply a populated form of the 'Add New Text Event' dialog box. This allows the event details to be modified.

Remove Text Event

Removes the record selected with the right-click that invoked the menu. WARNING: There is no verification of this function.

Add New/Modify Text Event Dialog Box

Is opened by using the Right-Click menu options of 'Add Text Event' or 'Modify Text Event'. It allows the details to be entered/modified for a text event.

Figure 3.20 - Text Event tab Add New/Modify Text Event	Inhibited	Shows the Inhibited attribute which is assigned by Wozterm.
	Active	Allows the Active attribute to be toggled.
	Slogan	Contains the exchange text you wish the event to be fired on.
	File Name	Specifies the Wozterm script file you wish to execute when Slogan is received.
	Label	Contains the @label that you wish File Name to begin at.
	Log File	Specifies the file to be logged to for the event.

Time Events tab

The Time Events tab is quite similar to the Text Events tab, excluding the obvious that it’s events are system time rather than data received from a network element.

Figure 3.21 - Time Events tab

Item	Description
Show Time Event tab	By clicking on the Time Events tab in the Multi-function pane, the Time Events tab will be shown.
Edit / Execute Command	The user may edit a single Time Event (at a time). The Inhibited attribute is assigned by Wozterm, however the other columns are editable. Active and Reschedule are (Y/N) only, and Start Time is the time that you wish the event to be fired. File Name is the Wozterm script file you wish to execute when Start Time is encountered and Label is the @label that you wish the script to begin at.
Right-Click for Menu	Right clicking in the Time Event tab will pop-up a Windows menu.

Time Event tab Right-Click Menu

The majority of functionality provided by the Time Event tab is accessible via its right-click menu. It allows the addition, deletion and modification of a Time Event.

Figure 3.22 - Time Event tab Right-Click Menu

Time Events tab Right-Click Menu

Add Time Event

Produces an 'Add New Time Event' dialog box to fill in the time event details so that an event can be added.

Modify Time Event

Produces the 'Edit Time Event' Dialog box which is simply a populated form of the 'Add New Time Event' dialog box. This allows the event details to be modified.

Remove Time Event

Removes the record selected with the right-click that invoked the menu. WARNING: There is no verification of this function.

Add New/Modify Time Event Dialog Box

Is opened by using the Right-Click menu options of 'Add Time Event' or 'Modify Time Event'. It allows the details to be entered/modified for a time event.

Figure 3.23 - Time Event tab Add New/Modify Time Event	Automatic Reschedule	Allows the Reschedule attribute to be toggled.
	Inhibited	Shows the Inhibited attribute which is assigned by Wozterm.
	Active	Allows the Active attribute to be toggled.
	Automatic Reschedule Interval	Set reschedule interval in minutes - M (eg 1M), hours - H or days -D
	Start Time	Contains the time that you wish the event to be fired.
	File Name	Specifies the Wozterm script file you wish to execute when Start Time is encountered.
	Label	Contains the @label that you wish File Name to begin at.

Function Keys tab

The Function Keys tab provides an interface allowing a user to map function keys Ctrl-F1 through Ctrl-F20 (Ctrl-Shift-F1 through Ctrl-Shift-F10 are aliases for Ctrl-F11 through Ctrl-F20) to Wozterm events. Each function key can either send characters to the currently connected NE, execute an individual host command on the currently connected NE, or execute a script.

Figure 3.24 - Function Keys tab

Item	Description
Edit Function Key mapping	Cells in the Function Key tab are editable by using the right-click menu. However, of most importance is the data placed in the Action Type column. For Function Keys to work correctly, this data can be either "RUN", "HOSTCMD", "KEYSTROKES" or "SEND". "RUN" tells Wozterm to execute the script specified in Action Text. "HOSTCMD" tells Wozterm to send the data in Action Text as a host command, and await response. "KEYSTROKES" tells Wozterm to process and send the Action Text as if it were typed into the VT100 Terminal pane. "SEND" tells Wozterm to simply send the characters in Action Text to the connected NE, without any intelligent processing or response interpretation.
Show Function Keys tab	By clicking on the Function Keys tab in the Multi-function pane, the Function Keys tab will be shown.
Right-Click for Menu	Right clicking in the Function Keys tab will pop-up a Windows menu.

Function Keys tab Right-Click Menu

The majority of functionality provided by the Function Keys tab is accessible via its right-click menu. It allows the addition, deletion and modification of a Function Key.

Figure 3.25 - Function Key tab Right-Click Menu	Define Function Key	Produces a 'Define Function Key' dialog box to allow you to fill in the relevant details to define a Function Key.
	Modify Function Key	Produces the 'Modify Function Key' dialog box which is simply a populated form of the 'Define Function Key' dialog box. This allows the function key details to be modified.
	Remove Time Event	Removes the function key selected with the right-click that invoked the menu. WARNING: There is no verification of this function.
	Copy Function Key	Copies the Function Key onto the Windows™ clipboard.
	Cut Function Key	Cuts the current Function Key from the tab and moves it onto the Windows™ clipboard.
	Paste Function Key	Pastes a Function Key from the Windows™ clipboard into the current row.

Define/Modify Function Key Dialog Box

Is opened by using the Right-Click menu options of 'Define Function Key' or 'Modify Function Key'. It allows the details to be entered/modified for a Function Key.

Figure 3.26 - Function Key tab Add New/Modify Function Key

Text Event tab Right-Click View Mode

Action Type

Shows the Action Type. This data can be either "RUN", "HOSTCMD", "KEYSTROKES" or "SEND". Their differences are explained above

Action Text

Specifies what Text should be run, executes etc, as specified by the Action Type.

Description

Specifies a description related to the Function Key.

Watch Variables tab

The Wozterm Watch Variables tab provides debugging information at run-time. By using Wozterm’s run-time control features - break, step, continue run - a user may monitor variables in a script to find and correct erroneous logic. Currently, the Wozterm Watch Variables tab does not support session variables. Support for these variables may be included in a future version.

Figure 3.27 - Watch Variables tab

Item	Description
Watch Indicator	The first column indicates whether the variable is currently being monitored.
Variable Name	The second column displays the name of every variable currently defined. Initially no variables are being monitored.
Variable Script Filename	The third column displays the filename of the script file where the variable was defined.
Variable Declaration Line Number	The fourth column displays the line number that the variable was declared on.
Watch Variable Value	The final column in the Watch Variables tab displays the current value of the variable being monitored. By placing breakpoints throughout a program and / or using the Step debugging feature, you may monitor the value of a variable as it changes during execution. While script execution is paused, the Watch Variable Value may also be modified via the right-click menu

Right-Click for Menu	Right clicking on a Watch Variable Value in the Watch Variable tab will pop-up a Windows™ menu. This menu allows monitoring to be added or removed from variables. The value of variables can also be modified.
Show Watch Variables	By clicking on the Watch Variables tab in the Multi-function Pane, the Watch Variables tab will be shown.

Watch Variables tab Right-Click Menu

The Watch Variables tab Right-Click Menu provides access to variable watch addition, removal and modification.

Figure 3.28 - Watch Variables tab Right-Click Menu	Watch Selected Variable	Commences the watching of the selected variable. (Alternatively mouse double-click can be used)
	Remove Selected Variable Watch	Removes watching of the currently selected variable. (Alternatively mouse double-click can be used)
	Modify Selected Variable Value	Produces a dialog box in which the user may enter a new value of the watch variable's value.
	Watch All	Adds watch to all variables
	Remove All	Removes watches from all variables

Messages tab

The Messages tab is used by Wozterm to display basic information about Wozterm state, but more importantly it is used to display script debugging information. Script compile status is shown in detail in this window, allowing for interactive script compiling/debugging.

Figure 3.29 - Messages tab

Item	Description
Messages	The Messages tab is used by Wozterm for the display of debugging messages, NE communications and actions, and Wozterm state information. All warnings are highlighted by blue text and errors, by red.

Double-Click to goto Message in Script Editor	Double-clicking on a message that has reference to a script line number will result in Wozterm moving to that line number in the Script Editor pane. This is useful when compiling a script as it provides a fast way to move between compilation warnings and errors.
Right-Click for Menu	By right-clicking in the display of the Messages tab, a Windows™ pop-up menu will appear.
Show Messages tab	By clicking on the Messages tab in the Multi-function pane, the Messages tab will be shown.

Messages tab Right-Click Menu

The Messages tab is used frequently by Wozterm - verbosely when compiling scripts with all debugging options enabled. The Messages tab Right-Click Menu provides the ability to clear the contents of the Messages tab, find a string of text and copy.

Figure 3.30 - Messages tab Right-Click Menu	Clear	Clears the entire Messages tab.
	Find	Prompts the user to enter some text to be found in the Messages tab. When the text has been found it is highlighted.
	Find Again	Searches for the same text entered earlier in the 'Find' dialog box. If Find has not been used before (ie. the Find text is blank) Find Again will prompt the user with the Find dialog to enter some text.
	Copy	Copies any selected text onto the Windows™ clipboard.

Previous Section: VT100 Terminal

Document Home

Next Section: Status Bar

This publication has been prepared and written by Telstra Corporation Limited (ACN 051 775 556), and is copyright. Other than for the purposes of and subject to the conditions prescribed under the Copyright Act, no part of it may in any form or by any means (electronic, mechanical, microcopying, photocopying, recording or otherwise) be reproduced, stored in a retrieval system or transmitted without prior written permission from the document controller. Product or company names are trademarks or registered trademarks of their respective holders.

Note for non-Telstra readers: The contents of this publication are subject to change without notice. All efforts have been made to ensure the accuracy of this publication. Notwithstanding, Telstra Corporation Limited does not assume responsibility for any errors nor for any consequences arising from any errors in this publication.