A Tour of the Main Window

The Oracle Tuxedo Administration Console is a Java-based applet that you can download from your company Web server into your Java enabled Web browser. The Oracle Tuxedo Administration Console enables you to manage your Oracle Tuxedo system administrative resources with the convenience of Web access.

This topic includes the following sections:

•	Main Window—describes the structure of the main window

•	Parts of the Main Window—defines main window components

•	The Tree View—describes the hierarchical tree view of administrative objects

•	The Tree View Quick Menu—explains how to use the Quick Menu to create and manipulate the administrative objects in the tree

•	The Configuration Tool Pane—describes the attributes display for administrative objects

Main Window

Figure 2‑1 illustrates the Oracle Tuxedo Administration Console main window. The main window consists of the following views:

•	A hierarchical tree of a Oracle Tuxedo Management Information Base (MIB) objects

•	Tabbed pages containing configuration information

Figure 2‑1 Oracle Tuxedo Administration Console Main Window

Why Are the Main Window Items Blank or Inactive?

The initial Oracle Tuxedo Administration Console window may only display empty panes and some toolbar buttons and menu bar items may be disabled. To access the Oracle Tuxedo system resources for system administration, you need to establish a connection to a domain or have domain connections specified in your initialization file. For more information refer to the section, “Oracle Administration Console Product Overview” on page 1‑1

The following items are unavailable until you establish a domain connection:

•	The Tree View pane and Configuration Tool pane

•	All the buttons in the toolbar (except Options and Help)

•	All the commands on the Tools menu

•	The CS Help and Help commands on the Help menu

As shown in Figure 2‑1, after you have set up and activated a domain, the Oracle Tuxedo Administration Console populates the Tree View pane with labeled icons, representing the administrative class objects in a domain. When you start using the Configuration Tool, the Oracle Tuxedo Administration Console displays tabbed pages in the Configuration Tool pane that enable you to specify configuration information.

Resizing the Tree View and Configuration Tool Panes

If you want more display space for the Tree View pane or the Configuration Tool pane, you can adjust the width of either area by doing the following:

1.	Using the mouse, point to the border that separates the two window panes (immediately to the right of the scrollbar in the Tree View area).

2.	Pressing the mouse button changes the pointer to a double-headed arrow.

3.	Drag the border to the right (to widen the Tree View pane) or to the left (to widen the Configuration Tool area).

Parts of the Main Window

This section describes the parts of the main window and the actions available from the main window menus, toolbar buttons, Tree View objects, and Configuration Tool.

Figure 2‑1 shows an Oracle Tuxedo Administration Console that has an established domain connection. Table 2‑1 describes the major parts of the Main Window.

 

Table 2‑1 Main Window

Item	Description
Menu Bar	Provides access to all actions.
Toolbar	Provides a row of buttons that allow you to activate frequently used actions or administrative tools.
Tree View pane	Displays a hierarchical representation of the administrative class objects (such as servers and clients) in a Oracle Tuxedo domain.
Configuration Tool pane	Provides a set of tab pages on which you can display, define, and modify the attributes of objects, such as the name of a machine.
Tab pages	A set of pages and labeled tabs containing fields that only display configuration information and fields that let you specify configuration information.
Configuration Tool buttons	Allow you to control the modifications you make to the configuration fields on the tab pages.

The following topics describe each of these major parts in more detail.

Menu Bar

The Menu bar appears at the top left side of the Oracle Tuxedo Administration Console main window. Table 2‑2 describes the available menu actions.

Note:

Unless specified otherwise, the phrase click means to quickly press and release the left mouse button.

 

Table 2‑2 Menu Bar Options

Menu	Description
Domain	The Domain menu contains options for specifying the domain (Oracle Tuxedo application) you will work with. This menu has the following options: • New—creates a new domain. • Open—opens an existing domain. • Exit—closes the current domain and exits the Oracle Tuxedo Administration Console applet. This menu also lists the names of all created domain names. To switch to a different domain, simply click the desired domain.
Settings	The Settings menu lets you specify the following general default settings for the session: • The location (online) of your Oracle Tuxedo documentation. • The method by which your data is sorted (by state or by name). • The default mode in which you want to work (Edit mode or View mode). The Settings menu provides the same function as the Settings toolbar button.
Tools	The Tools menu contains the same options provided by the toolbar buttons. For more information, refer to the section “Toolbar Buttons” on page 2‑7.
Help	The Help menu provides access to the main help topics and Context-Sensitive (CS) Help. These same help options are also available on the toolbar as Help and CS Help, respectively. To use CS Help, click Help—>CS Help to get the cross-hairs pointer, then click a field or specific area in the window to get information about the selected item.

Throughout this online help, a menu choice is indicated in the following form:

Menu—>Menu Item

For example, an instruction to "Click Domain—>New" means click the Domain menu to display the menu items, and then click New to select the command.

<a name="P_STOP"></a>

<a name="P_REFRESH"></a>

<a name="P_SEARCH"></a>

<a name="P_ACTIVATE"></a>

<a name="P_DEACTIVATE"></a>

<a name="P_MIGRATE"></a>

<a name="P_ULOG"></a>

<a name="P_EVENT"></a>

<a name="P_STATS"></a>

<a name="P_SETTINGS"></a>

<a name="P_CSHELP">

</a> <a name="P_HELP"></a>

Toolbar Buttons

The toolbar appears across the top of the main window, immediately below the menu bar.

Table 2‑3 describes the toolbar buttons available for frequently used administrative operations.

Table 2‑3 Administrative Operations

 

Button	Description
	Interrupts the current process and returns control to the administrator (who can then request a new operation). The Stop button allows you to interrupt the process currently underway, thus regaining control of the Oracle Tuxedo Administration Console. You can then start a new process. You cannot assume that a process you interrupt with the Stop button has been completed; it may or may not be completed before control of the Oracle Tuxedo Administration Console is returned to you.
	Updates the tree view and configuration tool pane with the most up-to-date data.
	Searches for a particular administrative object class or object in the expanded Oracle Tuxedo Administration Console tree. Click the Search button to open the search pop-up window. Enter the name of the object for which you are searching. If necessary, the Tree View is scrolled to display your target object.
	Activates all or part of a Oracle Tuxedo domain. The Activate button displays the Activate Objects window. This window contains a set of class-specific tab pages that enable you to activate all or part of a Oracle Tuxedo domain.
	Deactivates all or a part of a Oracle Tuxedo domain.
	Migrates a server group or machine to another location, or swaps the master and backup machines.
	Displays the ULOG file from a particular machine in the active domain.
	Displays the window for monitoring system-generated events.
	Displays the tab pages that allow you to view a graphical representation of Oracle Tuxedo system activity.
	Provides the option to set the following default settings for the session: • The location (online) of your Oracle Tuxedo documentation. • The method by which your data is sorted (by state or by name). • The default mode in which you want to work (edit mode or view mode).
	Invokes Context-Sensitive (CS) Help. Click the CS Help button to get the cross-hairs cursor, then click a field or specific area in a GUI window to get information about the selected item.
	Opens the Oracle Administration Console Online Help in a separate Web browser.

The Tree View

The Tree View pane appears in the left column of the main GUI window. The tree is a hierarchical representation of the administrative objects in a single Oracle Tuxedo system domain. The GUI graphically depicts the relationship between each object and the others by showing its nesting level and parent objects. You can choose to view a complete tree (comprising all configurable objects of all types in the domain) or a subset of objects.

Figure 2‑2 shows the Tree View displayed in the main window.

Figure 2‑2 The Tree in the Main GUI Window

.

You can add or omit items from the Tree View. In addition, you can add or omit items from the display. By default, the Tree View displays all administrative classes available for a selected domain.

Parts of the Tree View

The Oracle Tuxedo Administration Console Tree View contains multiple roots, one root for each administrative object. The first root consists of the application domain. The next root displays the object classes defined in the Oracle Tuxedo TMIB. Each set of object classes is a part of an application domain. The third level represents an instance of an object belonging to an object class.

The Oracle Tuxedo Administration Console can display only one domain at a time. The current domain is represented in the Tree View as multiple sets of object classes containing administrative objects. The Oracle Tuxedo Administration Console gives you control over which object classes and objects are displayed for a domain through a combination of the collapsible tree structure and a Folders checklist dialog.

Figure 2‑3 shows the top part of the sample tree shown in Figure 2‑2. (Machines, Groups, Servers, Routing Tables, and so on, are examples of object classes. The FML and VIEW tables shown under Routing Tables are examples of objects belonging to the Routing Tables class.)

Figure 2‑3 Domain Tree Hierarchy

Tree View Hierarchy

The following sections describe all the administrative objects that can appear in the Tree View.

Oracle Tuxedo System Domains and Classes

Table 2‑4 lists the domain and class parts of the Tree View, their associated icons, and briefly describes each part.

Table 2‑4 Tree View

 

Tree Item	Icon	Description
Domain		The Oracle Tuxedo Administration Console displays the domain icon and the name of a domain (Oracle Tuxedo system application) as the tree root. Domains can be connected, unconnected, and inactive.
Administrative Class		The folder icon and administrative name represent each object class (such as Machines, Servers, Clients, Factories, and so forth). • Closed folders with a plus sign (+) indicate the folders contain objects. • Open folders with a minus indicate all folder objects are displayed. The Tree View displays the individual objects that are part of a class below the class folder.

Oracle Tuxedo Administration Console Class Objects

Table 2‑5 describes the individual objects contained within a Oracle Tuxedo system TMIB class and their associated icons.

Table 2‑5 TMIB Class

 

Tree Items	Icon	Description
Machines		Machines represent the machines on which the applications reside. The machines are listed in the Tree View by their configuration name and have three states: active, suspended, and unknown.
Groups		Groups represent the administrative resources that are configured as groups and reside on a machine. These resources include servers. As an administrative unit, you can activate, deactivate, and migrate groups.
Servers		Servers represent the server-side of a client/server application pair. The servers respond to requests from clients. The server icons represent Oracle Tuxedo system-based application servers. Servers correspond to an operating system (OS) process.
Routing Tables		The routing tables enable a system administrator to set up a name and target service where messages and other data can be sent.
Service Defaults		Service defaults enable a system administrator to define standard settings for attributes for services such as priority, timeouts, loads, and routing.
Services		Services represent modules of application code that carry out a service request. These are the Oracle Tuxedo system services.
Devices		Devices represent Oracle Tuxedo system files (TUXCONFIG, TLOG, and so on) that reside on physical storage devices.
Clients		Clients represent the processes that attach to the domain of the Oracle Tuxedo servers.
WS Listeners		The Oracle Tuxedo Workstation Listeners (WSL) are processes that act as the single point of contact for Workstation clients. They also handle the distribution of workstation connections to Oracle Tuxedo Workstation Handlers (WSH). WSLs feature the same icons as servers.
WS Handlers		The Oracle Tuxedo Workstation Handlers (WSH) are surrogate clients responsible for managing a set of Workstation client connections. These handlers are started dynamically by the workstation listener.
Bridges		Bridges are used to maintain virtual circuits to other nodes participating in an application for the purpose of transferring application messages between nodes.
ACLs ACL Principals ACL Groups		Access Control List (ACLs) are the administrative resources used to manage standard access control list security. The following types of ACL objects are included: • ACLs represent a list of groups allowed access to services, applications, queues, and events. This list is used to check authorization. • ACL Principals refer to application administrators, application operators, clients, and remote domain names that can access a Oracle Tuxedo system application. • ACL Groups are a group or collection of principals who have access to a Oracle Tuxedo system application.

Oracle Tuxedo Administration Console Application Queue Class Objects

Table 2‑6 describes the individual application queue and related class objects contained within a Oracle Tuxedo system TMIB class and their associated icons.

Table 2‑6 TMIB Class

 

Tree Items	Icon	Description
Application Queues		An application queue represents the storage area where messages are queued.
Application Queue Messages, Spaces, and Transactions		• Application Queue Messages are messages stored in application queues. • Application Queue Spaces are storage spaces that contain one or more application queues. • Application Queue Transactions are transactions associated with a queue space.
Transactions		A transaction is a unit of activity that a Oracle Tuxedo system application handles in a distributed client-server context.

Oracle Tuxedo CORBA System Class Objects

Table 2‑7 lists the individual Oracle Tuxedo CORBA administrative class objects and their associated icons.

Table 2‑7 CORBA Administrative Class

 

Label	Icon	Description
Factory		A CORBA Factory is an interface used by a client to obtain an object reference to a CORBA object.
Interface		The interface icons represent CORBA IDL interfaces. In a CORBA development environment, an interface represents a contract with a client. Servers represent interfaces at startup. You can define the default attributes for interfaces at the domain and server group levels.
Interface Queue		An Interface Queue controls the activation of interfaces in a server. The Interface Queue represents run-time attributes as it pertains to a particular server queue.

Expanding and Collapsing the Tree View

Figure 2‑4 illustrates an expanded tree for the sample simpapp domain. The Groups folder only contains one object GROUP1 and is fully expanded as shown by the minus (-) sign next to the Groups icon. However, GROUP1 contains more items as indicated by the plus (+) sign.

Figure 2‑4 Expanded Tree

 

To display a domain tree, on the menu bar click Domain —>DomainName and select a domain. (You can also click Domain—>Open to bring up the Connect window and enter a Domain Name and TUXCONFIG path.) To expand the domain tree or any section of the domain tree, click the plus (+) sign next to the tree item.

Note:

The plus (+) sign next to a tree icon changes to a minus (-) sign when the tree cannot be expanded further.

To collapse any section of the tree, click the minus sign beside any expanded tree item. Click the minus sign beside the domain icon and the Tree View displays only the domain icon and name.

Searching for Objects in the Tree

To find a specific object in the Tree View, click the Search toolbar button. The Oracle Tuxedo Administration Console displays a Find dialog. Enter the name (or partial name) of the object you want to find and click the Next or Previous buttons to search forward or backward through the objects in the tree.

The Tree View Quick Menu

The Oracle Tuxedo Administration Console Tree View contains a convenient shortcut menu that lets you quickly select frequently performed tasks. This Quick Menu includes options for creating new objects, activating and deactivating applications and application resources, as well as other administrative tasks.

To display the Quick Menu, right-click any object in the Tree View item (domain, class, or object) and the Quick Menu is displayed in the Tree View area.

If you select an option from the Quick Menu, the Quick Menu closes and the window associated with the selected option is displayed.

To close the Quick Menu without selecting a menu item, click an area of the main window outside the Quick Menu.

Figure 2‑5 illustrates a sample pop-up Quick Menu.

Figure 2‑5 Quick Menu in the Main GUI Window

The Oracle Tuxedo Administration Console always displays the Quick Menu in the Tree View area. The Quick Menu options invoke windows and dialog boxes, or toggle between modes. What you see on the Quick Menu depends upon which item the pointer is positioned on the tree.

Table 2‑8 provides a quick list of what the Quick Menu displays for each type of tree item.

 

Table 2‑8 Quick Menus for Types of Objects

Your Object Selection	Quick Menu Options
Domain	• Edit and View • New • Delete • Folders • Activate and Deactivate • Swap Master
Folder (represents an object class)	New only.
Administrative object (such as a specific server or device)	The options vary for each type of selected object. Each administrative object has a subset of all options. Table 2‑9 contains a complete list of all possible Quick Menu options.

Quick Menu Options

To perform most Oracle Tuxedo system operations, you can select options from the Quick Menu that displays when you right-click a tree object. The options available in the Quick Menu vary depending upon the object class.

Table 2‑9 briefly describes all the menu options listed on the collective set of Quick Menus. No single Quick Menu offers all these operations; a single Quick Menu includes a subset of these options. Click the menu option to perform the operation for that domain, object class, or individual object.

 

Table 2‑9 Quick Menu Options

Select...	To...
View	Display the tab pages containing detailed configuration information about a selected object in read-only (or View) mode. For more information, refer to the section “Switching Edit and View Modes” on page 3‑4.
Edit	Display the tab pages containing detailed configuration information about a selected object in Edit mode. (You can use this option to override a default View mode setting for the session and change the attributes for the selected object. For more information, refer to “Switching Edit and View Modes” on page 3‑4.)
New	Add a new Oracle Tuxedo system object.
Delete	Delete a Oracle Tuxedo system object. You cannot delete all Oracle Tuxedo system objects in this fashion.
Folders	Display a dialog box listing all available object classes for a domain and indicate which object classes to display in the tree.
Activate	Activate a selected object.
Deactivate	Deactivate a selected object.
Swap	Migrate the master and backup servers in a distributed configuration.
Clean	Detect and remove dead clients and servers; remove partitioned machines.
Migrate	Move groups of servers to an alternate processor.
Connect	Establish a connection (bridge) between two machines.
Advertise	Advertise a service.
Unadvertise	Hide a currently advertised object from other applications.
Suspend	Prevent the application from accessing a service.
Resume	Make a currently suspended service available.
Kill	Terminate a Oracle Tuxedo system client or service.
Abort	Stop a transaction that is currently in progress and roll back all affected data.
Open	Allocate and initialize shared memory and semaphores for a /Q queue space.
Close	Remove shared memory and other IPC resources for a /Q queue space.

About the New Option

To create a new Oracle Tuxedo system object, right-click the desired object class in the Tree View to display the Quick Menu, and then click New. The Create New Object window is displayed prompting you to enter required information about the new object. For detailed information about filling in these fields, see Chapter 3, “Creating New Domains and Administrative Class Objects.”

Using the Folders Option to Display or Hide Tree Items

You can use the Quick Menu Folders option to customize your view of the tree so that only the type(s) of objects you want to see are displayed.

You can use the Quick Menu Folders option to do the following tasks:

•	Display all classes of objects

•	Filter out types of objects that you do not want to view

•	Limit the Tree View to only one class of object

To use the Folders option, complete the following steps:

1.	Right-click a domain or administrative class object in the tree to display the Quick Menu, and then select Folders to display the Select Folders window.

Note:

The items shown in the Select Folders window will vary, depending on which type of object you have selected in the tree.

2.

The Select Folders window contains a list of all possible administrative classes and a check box beside each class name. If the check box is selected, click it to exclude that administrative class from the Tree View. If the check box is not selected, click it to display that administrative class in the Tree View.

3.	Click OK at the bottom of the list to apply your changes.

Figure 2‑6 shows the Select Folders window for domains.

Figure 2‑6 Select Folders Window

The Configuration Tool Pane

The Configuration Tool is a utility that lets you set or change the attributes for a selected class of Oracle Tuxedo system objects. When you select an object in the tree, the Configuration Tool pane for that object is displayed on the right side of the main window. As illustrated in Figure 2‑7, the Configuration Tool pane keeps the attributes for each object in a set of tabbed pages.

Figure 2‑7 Configuration Tool

The Configuration Tool pane displays a set of tab pages for your application resources and for each class of objects and services shown in the Oracle Tuxedo Administration Console Tree View.

Each collection of tabbed pages is a set of logically grouped attributes. For example, the Domains class Security tab pages contain the settings for user IDs, group IDs, and the type of security to be used in that domain.

Accessing the Configuration Tool Information for a Tree Object

To access the Configuration Tool from the tree:

1.	Click the plus sign in front of the name of a class. The Tree View expands to display a list of the objects available for that class.

2.	Click the icon or name of an object. The Configuration Tool pane displays the configuration tabs for the relevant class and the current settings for each class attribute. (Figure 2‑7 shows the Configuration Tool for the TOUPPER Service Default.)

The Configuration Tool consists of a set of tab pages and a row of buttons for controlling the changes you make in the tab pages.

The Tab Pages

The tab pages in the Configuration Tool pane are electronic forms that display and solicit (from you) information about the attributes of an administrative object.

A set of tab pages is provided for each administrative class of objects (such as machines and servers). The number of attributes associated with a class varies, depending on the class. Therefore, anywhere from one to eight tab pages may be displayed when you invoke the Configuration Tool by selecting an object in the tree.

To display a set of tab pages select an object in the tree by clicking on it.

The Configuration Tool pane displays the tab pages available for the object you have selected, as shown in Figure 2‑8.

Figure 2‑8 Tab Page in the Configuration Tool Pane

The Configuration Tool Buttons

Use the buttons at the bottom of the Configuration Tool pane to implement the changes you make in the tab pages.

<a name=T_GENERAL></a>

Table 2‑10 The Configuration Tool Buttons

Use This Button . . .	To . . .
Change	Implement the changes you have made in the tab pages.
Cancel	Nullify changes you have made in the tab pages (as long as you have not clicked Change).
New	Add an administrative object to the current domain.
Delete	Remove an object from the current domain.