The tlmenu Utility
This topic provides an overview of the tlmenu utility including descriptions of:
-
The tlmenu command, including its purpose, syntax and restrictions.
-
The related tlmulti command.
-
tlmenu menus, procedures and replies to prompts.
-
The Show Logging Status option.
-
How to automate procedures using an input file.
-
Naming conventions for clean logs.
-
Backup methods used.
-
Remote administration of the FailSafe secondary.
Transaction Logging terms used here are explained in Introduction to Transaction Logging, Shadow Database terms in Introduction to Shadow Database and FailSafe terms in Introduction to FailSafe Operation.
tlmenu
All operations to administer Reality resilience software are controlled by the common utility host tlmenu.
Caution
Many of the administrative procedures involved in managing resilience are complex and, if carried out incorrectly, could compromise the security and consistency of your data.
tlmenu reduces the likelihood of mistakes by guiding you through each procedure, asking for confirmation at each step. It also allows you to abort a procedure, or leave tlmenu completely, if one or more of your previous actions in a procedure are discovered to have been incorrect.
Before using tlmenu, you should read Introduction to Transaction Logging, Introduction to Rapid Recovery, Introduction to Shadow Database and/or Introduction to FailSafe Operation, as appropriate, to become familiar with the basic concepts of Reality resilience.
Enter the tlmenu command at the host command prompt (on Windows you can connect using Remote Desktop Connection).
Note
The tlmenu script resides in the REALROOT
/bin directory on the host. The directory is automatically included in your PATH when you log in.
Syntax
The principal form of the tlmenu command is as follows:
tlmenu {database}
database Specifies the local database to be administered. This can be the absolute or relative system path name of the specified database or its database name.
If database is not specified, the default database is used. If the default database is not defined, you are prompted for a database name.
Two alternate forms allow you to record a script against one database and then play it back against another:
tlmenu record script-file {database1}
tlmenu runs as normal against database1, but in addition all user input is recorded in the script-file.
tlmenu {database2} script-file
The sequence of commands recorded in the script-file is repeated for database2.
Any tlmenu command can be recorded except the dbsave backup method. Script files are also used by the tlmulti command.
Restrictions
To use tlmenu, you must be logged into the host system as the database owner (the user who created the database). Only the database owner can use tlmenu on a particular database.
If the REALUSER and REALACC environment variables are set, they must specify the owner of the database and SYSMAN, respectively, otherwise they will adversely affect the operation of tlmenu.
In Shadow Database and FailSafe configurations, the majority of tlmenu procedures can only be executed on the live or primary database, as appropriate. Exceptions to this are the procedures to Define/Redefine the Database Configuration, which must be carried out on both databases in a Shadow or FailSafe configuration, and option 1 on the Database Recovery menu, which must be executed on the Shadow or secondary database.
If you are using Database Isolation, you must use realroot to select required instance of Reality before running tlmenu.