| !$$$$! |
Return to script that called the current script with @INCLUDE. |
| ADVANCE |
Advance a date & time by the specified interval units |
| ALL |
Used with @ORDERED(ALL) for an ORDERED response anywhere in an AXE response. |
| AND |
Boolean AND operator, returns TRUE if both expressions evaluate to TRUE. |
| AOMPWORD |
Ozterm keyword used to set or clear the AOM Password. |
| ARGCOUNT |
Returns the number of arguments passed to a script file. |
| ARGVALUE |
Returns the specified script file argument. |
| AUTODIAL |
Deprecated DOS Ozterm keyword. |
| BAUD |
Sets baud rate, bits and parity for the active COM port connection. |
| BEGIN |
Marks the beginning of a block of commands. |
| BELL |
Requests the user's PC to play a defined sound |
| BMODDIR |
Deprecated DOS Ozterm keyword. |
| BOOLEAN |
Used to define boolean type variables and arrays. |
| BOX |
Used by @DRAW as a sub-command to draw a box. |
| BREAK |
Sends a break to the currently connected host or network element. |
| BYREF |
Specifies an argument passed by reference to a procedure or function. |
| CALL |
Invoke a @FUNCTION and discard the return value. |
| CAT |
Deprecated DOS Ozterm keyword. |
| CATFILE |
Deprecated DOS Ozterm keyword. |
| CHDIR |
Changes the current working directory. |
| CHECK |
Turns runtime script error checking on or off, with optional trap. |
| CHECKSTATE |
Returns whether script runtime checking is ON or OFF. |
| CHR |
Returns the ASCII character equivalent of an integer. |
| CLEAR |
Clears a variable by setting to 0, false or an empty string depending on its type. |
| CLOSE |
Closes the specified event log file or terminal log file if no name given. |
| CLRSCR |
Clears the terminal window or @WINDOW window. |
| CMDHIST |
Save or restore the command history to or from a file. |
| CNTRLD |
Sends a CONTROL-D to host / network element |
| COMMENT |
Displays text on terminal window or @WINDOW window |
| COMMENTTML |
Displays text on the terminal window |
| CONCAT |
Concatenates 2 or more expressions together |
| CONNECT |
Establish a connection to a host, network element or Serial COM port. |
| CONSTANT |
Used in a variable declaration to define a constant. |
| COPY |
Returns a substring of a string. |
| CUP |
Used by @DRAW as a sub-command to position the cursor. |
| DEBUG |
Displays a message in the debug window |
| DEBUGLEVEL |
Sets the debug level that determines if @DEBUG messages are displayed. |
| DEC |
Decrements the value of an integer variable |
| DECIMAL |
Returns the integer value of a hexadecimal string. |
| DEFAULTVALUE |
Set a variable's default value |
| DEL5MSEC |
Pauses script execution in 5 millisecond intervals. |
| DELAY |
Pauses script execution in 1 minute intervals. |
| DELAYSEC |
Pauses script execution in 1 second intervals. |
| DIALOG |
Creates a form in a new window, with 1 or more entry fields. |
| DISCONNECT |
Does a full, or partial disconnect if a host name is given, from a network element. |
| DISKFREE |
Returns available disk space on current, or optionally specified disk in kilobytes. |
| DISPLAY |
Displays text and variable values to terminal window. |
| DO |
Used in constructing a @WHILE loop to prefix the block of code to execute. |
| DOCMD |
Perform an application dependent command. |
| DOCMDGETATTR |
Retrieve a value returned by a previous @DOCMD. |
| DOCMDSETATTR |
Sets the value of an attribute for a @DOCMD which will follow. |
| DOWNTO |
Used in constructing a decrementing @FOR loop. |
| DRAW |
Draws text and boxes in the @WINDOW window. |
| DTRBREAK |
(NOT YET SUPPORTED) Open the serial port's DTR lead for 1 second. |
| EDITFILE |
Open text editor with specified file starting at an optionally specified line number. |
| ELSE |
Used with @IF and @IFERROR to catch the fail case. |
| END |
Marks the beginning of a block of commands. |
| ENDFOR |
Ozterm keyword used to exit a |
| ENDLOOP |
Used to exit a loop before all iterations have occurred |
| EOSUB |
Return to the parent script that called the current script with @INCLUDE. |
| EPOCHTOSTR |
Converts a given epoch time stamp to a date string |
| ERASE |
Deletes a specified file. |
| ESCKEY |
Turns Escape Key checking on or off. |
| EVDELETE |
Deletes all Text or Time Events for the current file |
| EVEN |
Used with @BAUD to set parity to EVEN. |
| EVLOADED |
Checks if an event has been set using the current script file |
| EVSETPRI |
Gives priority to events using the current script file |
| EXECUTE |
Executes an external command or program. |
| FAIL |
Boolean value indicating the fail case, equivalent to 0, FALSE or OFF. |
| FALSE |
Boolean value indicating the false case, equivalent to 0, FAIL or OFF. |
| FILECHPOS |
Returns the current character position in the specified file. |
| FILECLOSE |
Closes a file opened by @FILEOPEN. |
| FILECOPY |
Creates a copy of an existing file. |
| FILEEND |
Seeks to the end of the specified file. |
| FILEERASE |
Deletes the specified file. |
| FILELNPOS |
Returns the current line number position in the specified file. |
| FILELNSTART |
Seeks to the start of the current line in the specified file. |
| FILEOPEN |
Opens a file for reading and/or writing. |
| FILEREADARRAY |
Read the contents of the specified file into a string array. |
| FILEREADB |
Reads a byte (integer ASCII value of character) from the specified file. |
| FILEREADCH |
Reads one or more characters from the specified file. |
| FILEREADLN |
Reads a line of text from the specified file. |
| FILERENAME |
Renames a file by calling the operating systems rename function. |
| FILESCANCH |
Searches the specified file for a string, or optional occurrence. |
| FILESCANLN |
Searches an open file for the next occurrence of a string. |
| FILESEEKCH |
Moves the file pointer position by the specified number of characters |
| FILESEEKLN |
Moves the file pointer position by the specified number of lines |
| FILESIZE |
Returns the size of a file in bytes. |
| FILESTART |
Seeks to the start of the specified file. |
| FILEWRITEARRAY |
Writes the contents of a string array to the specified file. |
| FILEWRITEB |
Writes a byte (ASCII character specified by integer value) to the specified file. |
| FILEWRITECH |
Writes 1 or more characters to the specified file. |
| FILEWRITELN |
Writes 0 or more strings to the specified file, and appends a newline. |
| FLUSHALL |
Destroys all {session} variables. |
| FLUSHVAR |
Destroys a single {session} variable. |
| FOR |
Used to execute an integer counting loop. |
| FORM |
Creates a form in a new window, with 1 or more entry fields. |
| FTPCHDIR |
Changes to specified directory on ftp host |
| FTPCONNECT |
Creates an ftp connection to the given host |
| FTPDELETE |
Deletes a file from an ftp host |
| FTPDIR |
Gets a directory listing and writes it to the specified file |
| FTPDISCONNECT |
Disconnects from an ftp host |
| FTPGET |
Downloads file from an ftp host |
| FTPLOGIN |
Logs into an ftp host. |
| FTPMKDIR |
Creates a directory on an ftp host |
| FTPMODE |
Sets ftp transfer mode, 0 for ASCII, non 0 for binary |
| FTPPUT |
Uploads file to an ftp host. |
| FTPPWD |
Gets the present working directory on an ftp host |
| FTPRENAME |
Renames a file on an ftp host. |
| FTPRMDIR |
Removes a directory on an ftp host. |
| FTPSIZE |
Gets the size of the given file on an host |
| FUNBUSY |
Sets the number of attempts to retry an AXE command returning FUNCTION BUSY. |
| FUNCTION |
Define a user defined function. |
| FUNKEY |
Sets an action for the specified function key (1-20). |
| GETALLMODES |
Returns all modes supported by the application. |
| GETDATE |
Returns the current PC date and time, and optionally the number of the day of week. |
| GETDATETIME |
Function returning the current PC date and time including milliseconds |
| GETDAY |
Returns name of the day for the current OR optionally a specified date. |
| GETDEST |
Returns network element name for the connected host |
| GETDIR |
Returns current working directory. |
| GETENV |
Returns value of an operating system environment variable. |
| GETEPOCH |
Returns the current Unix epoch timestamp |
| GETERRORFLAG |
Returns the state of the error flag, optional parameters return error number and error string. |
| GETEVENTLOG |
Returns name of current event log file |
| GETHEADER |
Returns last network element port header. |
| GETLOG |
Returns name of current terminal log file |
| GETMODE |
Returns current session mode. |
| GETNAME |
Returns name of the current script file including the directory path. |
| GETPASSWORD |
Returns the password for the current mode |
| GETPORT |
Deprecated DOS Ozterm keyword. |
| GETPRINT |
(NOT YET SUPPORTED) Returns current printer number. |
| GETSCHED |
Returns the date and time when the current script is scheduled to run. |
| GETSESSVARS |
Populates the specified array with the session variables. |
| GETUSERNAME |
Returns the user name for the current mode |
| GOSUB |
Used to invoke a subroutine contained within the same file or library file. |
| GOTO |
Used to jump to and continue execution after a specified label within the file. |
| HEX |
Returns hexadecimal string of an integer value. |
| HIDE |
Hides user script file window. |
| HIDECMDHIST |
Hides command history. |
| HIDETERM |
Hides terminal window. |
| HIGH |
Used by @DRAW as a sub-command to make following text appear highlighted. |
| HOSTCMD |
Sends a command to a host / network element and waits for command to complete. |
| HOSTCMDTIMEOUT |
Sets the total timeout in seconds for host commands to complete. |
| IF |
Evaluates a boolean expression to conditionally execute code. |
| IFERROR |
Evaluates and resets the runtime error flag to conditionally execute code. |
| INC |
Increment the value of an integer variable optionally by a specified amount |
| INCLUDE |
Calls another script file at runtime. |
| INHISTORY |
Indicates if a date/time is in the past. |
| INKEY |
Waits for and retrieves a user keystroke. |
| INPUT |
Requests a string from the user. |
| INSET |
Test if the first value is matched by any of the listed values. |
| INT |
Convert a number represented as a string of digits to its integer value. |
| INTEGER |
Used to define integer type variables and arrays. |
| INV |
Used by @DRAW as a sub-command to display inverse text. |
| KEYPRESS |
Ozterm script command checks for a key press. |
| KEYTIMEOUT |
Sets time in seconds for user to cancel a pending time event. |
| LABEL |
Defines a label name that can be jumped to by certain script commands. |
| LABELREF |
Defines a reference to a label name for use with @GOTO. |
| LAST |
Used with POS and STRPOS to find the last occurrence of a substring in a string. |
| LENGTH |
Returns the length of a string (number of characters). |
| LIBRARY |
Uniquely identifies a library name for a script file. |
| LOADXML |
Decodes XML data and pushes the data into session variables |
| LOG |
Enables data logging to the specified log file. |
| LOGOF |
Logs off from the current network element (used in Ozterm script files). |
| LOGOFF |
Logs off from the current network element. Only valid in Wozterm scripts. |
| LOGON |
Requests a command prompt from the current network element. |
| LOW |
Used by @DRAW as a sub-command to display normal intensity text |
| LOWCASE |
Returns the original string with all UPPER CASE characters converted to lower case. |
| MACHINEDIR |
Returns the MachineDataDirectory path of the application. |
| MARK |
Sets the starting search position for @SCAN. |
| MEMAVAIL |
Returns the physical memory (RAM) available. |
| MENU |
Displays a menu and waits for a user selection. |
| MENUARRAY |
Displays a menu and waits for a selection. |
| MKDIR |
Creates a directory. |
| MOD |
Returns the remainder after integer division. Can also be written as '%'. |
| MODE |
Sets the session mode. |
| MSGCHANGEATTR |
Changes the value of the last received message's attribute. |
| MSGCREATE |
Creates a new empty message. |
| MSGFORWARD |
Creates a new message with contents based on the last received message. |
| MSGGETATTR |
Gets the value of the last received message's attribute. |
| MSGGETATTRSIZE |
Returns the size in bytes of the last received message's attribute. |
| MSGGETTYPE |
Gets the type of the last received message (application dependent). |
| MSGIDLE |
Returns true if no messages are waiting to be received. |
| MSGLOADATTR |
Sets the contents of the outgoing message's attribute with the contents of a file. |
| MSGNEXT |
Gets (Receives) the next message. Optional parameter returns message type. |
| MSGNEXTOFTYPE |
Gets (Receives) the next message of specified type. |
| MSGSAVEATTR |
Save the contents of the last received message's attribute to a file. |
| MSGSEND |
Sends the last created message to the specified destination and returns immediately. |
| MSGSENDBLOCKING |
Sends the last created message to the specified destination and blocks execution. |
| MSGSETATTR |
Sets the value of the last created message's attribute. |
| MSGWAIT |
Waits for a message to become available to receive until timeout period (in milliseconds) expires. |
| NEXTLOOP |
Used to immediately commence the next iteration in a loop. |
| NONE |
Used with @BAUD to set parity to NONE. |
| NOT |
Boolean NOT operator, inverts the value of the boolean expression that follows it. |
| ODD |
Used with @BAUD to set parity to ODD. |
| OFF |
Equivalent to boolean FALSE. |
| OK |
Equivalent to boolean TRUE. |
| ON |
Equivalent to boolean TRUE. |
| OPENREAD |
Used to open a file for reading for use with @READ. |
| OR |
Boolean OR operator, returns TRUE if either or both of the expressions are TRUE. |
| ORD |
Returns the ASCII integer value of the first character of a string. |
| ORDERED |
Determines if an AXE ORDERED response will cause a logoff. |
| OVMVERSION |
Returns the version number of OVM (script compiler) the application is using. |
| PARAMISS |
Determines the handling of the System 12 'PARAMETER MISSING' response. |
| PATTERNCREATE |
Defines search patterns for STRARRAYPMATCH and PATTERNMATCH. |
| PATTERNDESTROY |
Destroys a previously defined pattern. |
| PATTERNDESTROYALL |
Destroys all previously defined patterns. |
| PATTERNLEVEL |
Used to set handling of wildcards and case sensitivity. |
| PATTERNMATCH |
Looks for matching patterns in data. |
| PAUSE |
Pauses script execution. Script remains in memory. |
| PORTNO |
Deprecated DOS Ozterm keyword. |
| POS |
Returns the start position of a substring within a string. |
| PRINTER |
Turns printer logging on or off. Not currently supported. |
| PROCEDURE |
Defines a user defined procedure. |
| PROGRAMDIR |
Returns the ProgramDirectory path of the application. |
| PROMPT |
Prompts user if script should continue execution. |
| QUIT |
Halts script execution and closes application. |
| RANDOM |
Generates a pseudo random number between 1 and the maximum value specified. |
| READ |
Reads a line of text from the last file opened with @OPENREAD. |
| REGRESS |
Regress a date & time by a single interval. |
| RENAME |
Renames a file by calling the operating systems rename function. |
| REPEAT |
Defines a loop that continues until a boolean condition is met. |
| REPLY |
Returns a line of text from the terminal window |
| REPLYLEN |
Returns the number of lines received since the last host command or @MARK. |
| REPORT |
Determines how the System 12 'REPORT FOLLOWS' response is handled. |
| RESOLVEIP |
Resolves the host name of a given IP |
| RESTART |
Restarts the current script file from the first line. |
| RETURN |
Forces an immediate return from a @SUBROUTINE, @PROCEDURE, @FUNCTION or @TRAP. |
| RMDIR |
Removes a directory. |
| RUN |
Current script is unloaded and control passed to the specified script. |
| SAVEDIR |
Returns the original session working directory when application was started. |
| SCAN |
Searches the terminal window for a string from the last host command or @MARK. |
| SCREENTIMEOUT |
Deprecated DOS Ozterm keyword. |
| SELFILE |
Allows the user to select a file. |
| SELPRINT |
(NOT YET SUPPORTED) Selects the printer for printer logging. |
| SEND |
Sends data to the host / network element. |
| SENDWAITFOR |
Sends data to a host and wait for a response. |
| SESSION |
Returns the current session number. |
| SESSIONDIR |
Returns the UserNonRoamingDirectory path of the application. |
| SET |
Used to set the value of a variable. |
| SETDEST |
Sets the destination name associated with the current session. |
| SETERRORFLAG |
Set or reset the error flag and error number. |
| SETPASSWORD |
Sets the default password for the specified mode. |
| SETREPLY |
Used to set OK and FAIL responses for use with @WAITREPLY. |
| SETUSERNAME |
Sets the default user name for the specified mode. |
| SINGLE |
Used with @ADVANCE to limit the change in time to 1 interval. |
| SLEEP |
Pauses script execution for approximately the number of milliseconds specified. |
| SNMPRECVTRAP |
Send an SNMP trap |
| SNMPSENDTRAP |
Send an SNMP trap |
| SQLAQPOPSTRING |
Get contents of message dequeued from Oracle Advanced Queue. |
| SQLAQPUSHSTRARR |
Puts contents of string array into Oracle Advanced Queue message for subsequent enqueue. |
| SQLAQPUSHSTRING |
Puts contents of string into Oracle Advanced Queue message for subsequent enqueue. |
| SQLBINDBYNAME |
Binds values to placeholder allocated via SQLPARSE by bind value. |
| SQLBINDBYPOS |
Binds values to memory address allocated via SQLPARSE by column (position). |
| SQLCOMMIT |
Commits changes to Oracle database. |
| SQLDQMESSAGE |
Removes message from Oracle Advanced Queue for subsequent. |
| SQLEQMESSAGE |
Enqueues message to Oracle Advanced Queue. |
| SQLEXECUTE |
Execute prepared SQL statement. |
| SQLGETFIELD |
Get field contents from current record. |
| SQLGETFIELDCOUNT |
Get number of columns in record set. |
| SQLGETFIELDNAME |
Get field name from current record. |
| SQLLOGIN |
Login to Oracle database. |
| SQLLOGOUT |
Log out from Oracle database. |
| SQLNEXT |
Get next record in set returned by SQLEXECUTE. |
| SQLPARSE |
Prepare SQL statement for subsequent execution. |
| SQLROLLBACK |
Rollback uncommitted transactions. |
| STOP |
Immediately halts script execution and unloads script. |
| STR |
Convert an integer value to its decimal string equivalent. |
| STRARRAYCHARS |
Returns the number of characters in a single dimension string array. |
| STRARRAYCONCAT |
Adds the contents of one single dimension string array to another. |
| STRARRAYCOPY |
Copies a substring of the source strarray to the destination strarray. |
| STRARRAYFLUSH |
Clear the contents of a 1 dimensional string array. |
| STRARRAYPMATCH |
Looks for matching patterns in data stored in string array. |
| STRARRAYPOP |
Pops specified number of characters from source to destination string array. |
| STRARRAYPUSH |
Pushes the source strarray onto the destination strarray |
| STRARRAYTRIM |
Trims specified characters from a string array. |
| STRARRAYTRUNC |
Truncates a string array to specified length. |
| STRBOTH |
Used with @STRARRAYTRIM to specify trim from start or end of string. |
| STRCONCAT |
Concatenates 2 or more expressions together |
| STRCOPY |
Returns a substring of a string. |
| STREAMBREAK |
Send a break on the data stream. |
| STREAMCREATE |
Create a data stream. |
| STREAMDESTROY |
Destroys a data stream. |
| STREAMDESTROYALL |
Destroys all data streams. |
| STREAMEVENT |
Process a stream event. |
| STREAMFLUSHIN |
Flushes (discards) data from the stream's input buffer. |
| STREAMFLUSHOUT |
Flushes (sends) data in the stream's output buffer. |
| STREAMGETARRAY |
Read characters (bytes) from the stream into a string array. |
| STREAMGETAVAIL |
Returns number of bytes waiting to be read, with optional timeout. |
| STREAMGETBUFF |
Read characters (bytes) from the stream. |
| STREAMGETBYTE |
Read a single character/byte from the stream. |
| STREAMGETLINE |
Read a line of data from the stream up to and including the line terminating character. |
| STREAMGETPARAM |
Not implemented. |
| STREAMGETSTATUS |
Returns the value of the stream's status flag. |
| STREAMLASTMSGSRC |
Gets the source of the last message |
| STREAMLBEND |
Returns the line number of the newest line of data in the stream's line buffer. |
| STREAMLBFLUSH |
Flushes the streams line buffer of all data. Resets STREAMLBEND, STREAMLBSTART. |
| STREAMLBGET |
Returns the contents of the specified line in the stream's line buffer. |
| STREAMLBSCAN |
Searches the stream's line buffer. |
| STREAMLBSTART |
Returns the line number of the oldest line of data in the stream's line buffer. |
| STREAMLOG |
Specify stream logfile name and begin/end logging. |
| STREAMPUT |
Sends data using the stream. |
| STREAMPUTARRAY |
Sends data using the stream. |
| STREAMPUTBYTE |
Puts the ASCII equivalent byte(s) onto the stream. |
| STREAMSETPARAM |
Sets the value of an application specific stream parameter. |
| STREAMSETSTATUS |
Sets the value of the stream's status flag. |
| STREAMWAITFOR |
Wait for any of the specified strings/patterns to be received by the stream. |
| STRING |
Used to define string type variables and arrays. |
| STRLEFT |
Used with STRARRAYTRIM to specify trim start of string. |
| STRLENGTH |
Returns the length of a string in characters/bytes. |
| STRLOWCASE |
Returns the lower case version of a string. |
| STRPOS |
Returns the position of a substring within a string |
| STRREPLACE |
Substitute specified characters of the 1st string with the 2nd string. |
| STRRIGHT |
Used with @STRARRAYTRIM to specify trim end of string. |
| STRSTRIP |
Remove the characters listed in the 2nd string from the 1st string. |
| STRTOEPOCH |
Returns the Unix epoch timestamp of the given time string |
| STRTRIM |
Removes leading and trailing whitespace from a string. |
| STRUPCASE |
Returns the upper case version of the string. |
| SUBROUTINE |
Defines a subroutine that can be invokes via a @GOSUB statement. |
| SUBROUTINEREF |
Define a reference to a subroutine which can be assigned to point to any subroutine. |
| SYSPWORD |
Ozterm keyword used to set or clear the System 12 Password. |
| TEXTEVSET |
Sets up a text event for this Wozterm session. |
| THEN |
Used with @IF and @IFERROR to perform conditional execution of script. |
| TIMEEVSET |
Sets up a time event for this Wozterm session. |
| TITLE |
Sets up a description for the current script. |
| TO |
Used in constructing an incrementing @FOR loop. |
| TRACE |
Turns script tracing on/off with optional output to file if filename given. |
| TRAP |
Defines a subroutine that can be used to perform error trapping. |
| TRIM |
Removes leading and trailing whitespace from a string. |
| TRUE |
Boolean true. Equivalent to OK and ON. |
| UNHIDE |
Show the script file window. |
| UNHIDECMDHIST |
Shows command history. |
| UNHIDETERM |
Shows terminal window. |
| UNTIL |
Defines terminating condition for @REPEAT loops. |
| UPCASE |
Returns the upper case version of the string. |
| UPPERCASEINPUT |
Turns forcing of user input text to upper case on or off, default is ON. |
| USELIBRARYFILE |
Compiles in contents of specified file at current position. |
| USERDIR |
Returns the UserRoamingDirectory path of the application. |
| VAREXIST |
Checks if the specified {session} variable exists. |
| VERSION |
Returns the version string of the application. |
| VIEWFILE |
View the contents of a file in the default editor. |
| WAIT |
Used by @CNTRLD to wait 4 seconds after a quiet line after sending a ^D. |
| WAITFOR |
Waits for specified pattern(s) to arrive within timeout period specified. |
| WAITREPLY |
Wait indefinitely for pattern(s) set with @SETREPLY to be received. |
| WHILE |
Executes a loop while a condition is met. |
| WINDEND |
Hides the window previously created with @WINDOW. |
| WINDOW |
Displays a user window, optionally use entire application window. |
| WRITE |
Opens specified file, appends supplied values as text, and closes file. |
| XOR |
Boolean exclusive OR operator returns TRUE if only one of the expressions is TRUE. |
Introduction
Contents
