Detailed Interface Description

Figure 3.2 - Wozterm File sub-menu	New Script File	Creates a new blank script editor pane for a new script file.
	New Wozterm	Runs a new session of Wozterm. The session used for the instance is the first available session - if no free sessions exist, a new session is created. If the maximum available sessions (setting in wozterm.ini) have been instantiated, an error message is returned.
	Open Script File	Opens a Wozterm script - as selected by the user from a file open dialog - into the Script Editor pane.
	Reopen Script File	Opens a Wozterm script - as selected by the user from a recently used script sub-menu - into the Script Editor pane.
	Save Script File	Saves the current Wozterm script file as viewed in the Script Editor to a file. If the script file has not been saved before Wozterm will prompt the user with a Save As dialog.
	Save Script File As	Saves the current Wozterm script as viewed in the Script Editor pane to a new file name.
	Save All Script Files	Saves all of the currently open Wozterm script files to disk.
	Close Script File	Closes the current Wozterm script as viewed in the Script Editor pane.
	Close All Script Files	Closes all of the Wozterm script files that are currently open.
	Enable Logging	Begins logging of the VT100 Terminal pane to a text file specified by the user. All logging is appended to the file specified. New files are acceptable.
	View Log File	Views the current Log File in the editor set in wozterm.ini. The default editor is notepad. This option is only available when logging.
	Disable Logging	Stops logging of the VT100 Terminal pane.
	Exit	Exits Wozterm Application. Alt+F4 also performs this function.

Script Sub-Menu

The options available to the user under the Script sub-menu are as follows. Note that Check Syntax through to Pause are available as Action Buttons.

Figure 3.3 - Wozterm User Script sub-menu	Check Syntax	Checks script in Script Editor pane for syntax errors after saving the current editor contents. Line of execution set to the first line of the script.
	Reload	Used if the script has been modified during execution and the script needs to be recompiled before continuing from the same line of execution.
	Run	Runs the most recently loaded script provided that it is free of syntax errors.
	Step	Available for use only when a script is paused during execution via a break point and the Preferences>Trace Script Files option is enabled. Script>Step or the Step Action Button will execute the next line of code and then pause execution.
	Pause	Halts the execution of the script in the Script Editor pane at the current line. The script may be restarted using Script>Run or the Run Action Button.
	Update Watches	Updates the value displayed for any variable that is being monitored in the Watches tab of the Multi-function pane.
	Clear Watches	Removes all variable monitoring from the Watches tab of the Multi-function pane.

Edit Sub-Menu
	The Edit menu is currently disabled. To Undo, Cut, Copy and Paste in Wozterm please use component specific (right-click) menus. If the desired function is not available via a menu, use Windows™ default shortcut keys - CTRL-Z for Undo, CTRL-X for Cut, CTRL-C for Copy and CTRL-V for Paste:

The options available to the user under the Mode sub-menu are as follows. Note that only one mode may be selected at any one time, and the currently selected mode is displayed in the Wozterm Status Bar.

Figure 3.4 - Wozterm Mode sub-menu	MANUAL	Dumb terminal emulation supporting little automation.
	UNIX	Automated support for telnet to Unix hosts.
	GATEWAY	Encapsulates UNIX access via an Internet Gateway.
	AOM	Automates procedures and functions required by AOM sites.
	AXE	Handles commands for AXE AT ports.
	AXE APN	Handles commands for AXE APN.
	S12	Handles commands for S12 connections.
	S12 MONI	Handles commands for S12 MONI connections.
	DMS	Handles procedures and functions required by for DMS sites.
	SDP	Handles procedures and functions required by for SDP sites.
	DCAP AXE	Automated support for AXE NEs via DCAP.
	OSS AXE	Automated support for AXE NEs via OSS.
	NEAS	Encapsulates NEAS connections.
	NEAS FD	Encapsulates Other NEAS commands.
	NEAS AOM	Automated support for AOM NEs via NEAS.
	NEAS AXE	Automated support for AXE NEs via NEAS.
	NEAS AXE APN	Automated support for AXE APN connections via NEAS.
	NEAS S12	Automated support for S12 NEs via NEAS.
	NEAS S12 MONI	Support for S12 MONI Commands via NEAS.
	NEAS DMS	Support for DMS Commands via NEAS.
	NEAS SDP	Support for SDP Commands via NEAS.
	NEM	Support for NEM Host Commands.
	NEM AXE	Automated support for AXE NEs via NEM.
	NEM AXE APN	Automated support for AXE APN commands via NEM.
	NEM AXE MTP	Automated support for AXE NEs via NEM MTP.
	NEM S12	Automated support for S12 NEs via NEM.
	NEM S12 MONI	Automated support for S12 MONI Commands via NEM.
	DEBUG SUCCESS	Debug mode used for testing Wozterm – all host commands will return success.
	DEBUG FAILURE	Debug mode used for testing Wozterm – all host commands will return failure.
	TESTING	Reserved for use by Wozterm Application Support.

Actions Sub-Menu

The options available to the user under the Actions sub-menu are as follows:

Figure 3.5 - Wozterm Actions sub-menu	Connect	Connects to a remote Network Element (NE). A dialog box will appear requiring connection details (see figure 4.3).
	Reconnect	Connects to a remote Network Element (NE) - as selected by the user from a recently used connections sub-menu - a dialog box will appear requiring the completion of connection details (see figure 4.3).
	Disconnect	Disconnects from the current NE. Confirmation of disconnect can be found in the Wozterm Status Bar.
	Logon	Used to gain a command prompt from a NE. Modifies connection to be in the logged on state.
	Logoff	Returns the current connection to the logged off state.
	Send Break	Sends a break signal to the currently connected NE.
	General Utilities	Runs the General Utilities script.
	B Number Analysis	Runs the B Number Analysis script.
	Reset Wozterm	Attempts to return the current NE session to a responsive (known) state.

Preferences Sub-Menu

The options available to the user under the Preferences sub-menu are as follows. Note that "Trace Script Files", "Show Hints", "Auto Logon after Connect" and "Show Runtime Error Dialog" are individual options, while "Warn/Error On Implicit Hostcmd" are paired as unique options.

Figure 3.7 - Wozterm Preferences sub-menu	Auto Save Script Files	Toggles the script auto-save feature. Automatically saves scripts when any changes are made to them.
	Trace Script Files	Toggles script debugging functionality. When enabled, debugging information such as current execution line and watch variables are updated in real-time. In addition, the user will be able to Step following a breakpoint.
	Show Alt+G Etc Script Files	When toggled, the Script File editor will open when the script is compiled using Alt+G. This applies to various other shortcut keys.
	Show Panel Help	Toggles "Screen Tip" functionality for the panels like terminal & command file view.
	Warn On Implicit Hostcmd	Highlights all implicit host commands as warnings (blue text) during compilation. Script will still execute.
	Error On Implicit Hostcmd	Highlights all implicit host commands as errors (red text) during compilation. Script will not execute.
	Auto Logon After Connect	Where applicable, a connect will automatically be followed by a logon.
	Disable Bell Sounding	Disable or enable if the bell is to sound when beep character received in the terminal window.
	Set KEYTIMEOUT value	Sets default time in seconds for user to cancel a pending time event
	Com Port Settings	Sets preferences for serial communication (can also be set in script using @baud)
	Switch Scripting Mode	Switch scripting engine to either Auto (run but not edit Wozterm & Ozterm scripts) , Wozterm (run & edit Wozterm scripts only), Ozterm (run & edit Ozterm scripts only).

Help Sub-Menu

The options available to the user under the Help sub-menu are as follows:

Figure 3.8 - Wozterm Help sub-menu	NE Command Description	Launches the Wozhelp application and searches for help specific to the last command executed.
	NE Printout Description	Launches the Wozhelp application and searches for help specific to the last printout detected.
	Wozterm User Manual	Opens the Wozterm User Manual in you default Web Browser.
	Wozterm / Wozix Language Guide	View (in your default Web Browser) a Wozterm Script Language Language Guide. The Language Guide is loaded from within the user manual held locally.
	Wozterm Home Page	Opens the Wozterm homepage in your default Web Browser.
	Ozterm Home Page	Opens the official Telstra Ozterm homepage in your default Web Browser.
	About Wozterm	Displays an about dialog box containing program version, copyright and support contact information.

Previous Section: Overview

Document Home

Next Section: Script Editor

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.