# User Guide

# Reference

This chapter provides a detailed description of the Guardian User Interface components and features, and a detailed reference guide to the Guardian Command Line Interface. Topics include the following:

- Main Menu
- Main Toolbar
- Keyboard Shortcuts
- Navigation Pane
- Document Pane
- Preferences
- Wizards
- Log Files
- Command Line Interface

## Main Menu

The BEA Guardian Main Menu is located below the Main Titlebar and above the Main Toolbar. Running from left to right, the Main Menu headings are:

- File
- Tools
- Window
- Help

### File Menu

The menu options in the File menu are:

- New - Opens a submenu with:

- Domain - Invokes the Domain Activation Wizard.
- Inventory - Invokes the Inventory Wizard.
- Evaluation - Invokes the Evaluation Wizard.
- Shortcut - Invokes the Shortcut Wizard.

- Close - Closes the most recently opened or most recently active editor in the Document Pane.
- Close All - Closes all the open editors in the Document Pane.
- Print - Prints the contents of the Report tab for whichever one of these editors is active in the Document Pane:

- Domain Inventory
- Evaluation Summary
- Signature Details
- Bundle Details

- Import - Reserved for future use.
- Export - Reserved for future use.
- Exit - Closes the Guardian application.

### Tools Menu

The menu options in the Tools menu are:

- Refresh Site List - Updates the list of BEA Support site identifiers available for creating support cases.
- Purge Inactive Domains - Removes domains that have been deactivated from the Domain Explorer and the Guardian Registry. The Domain Inventories, Evaluation Summaries, and Case Creation Archives for each purged domain are deleted from the Guardian Workspace on disk.
- View Log - Opens the Guardian Log file and the Signature Log file.

### Window Menu

The menu options in the Window menu are:

- Show View - Opens a submenu with the following choices to open certain views. Please note that if a view is already open it is brought to the forefront and made active rather than cloned:

- Domain Explorer - Opens the Domain Explorer view in the Navigation Pane.
- Bundle Explorer - Opens the Bundle Explorer view in the Navigation Pane.
- Shortcut Explorer - Opens the Shortcut Explorer view in the Navigation Pane.
- Signature Explorer - Opens the Signature Explorer view in the Navigation Pane.
- Active Domains Table - Opens the Active Domains Table view in the Document Pane.
- Shortcuts Table - Opens the Shortcuts Table view in the Document Pane.
- Progress View - Opens the Progress View to the left of the Document Pane.
- Outline View - Opens the Outline View to the right of the Document Pane.

- Reset Perspective - Resets the Guardian application window settings to their original values. This includes opening and arranging all of the Navigator views, opening the Outline and Progress views, and resizing the Document Pane. Any open views and editors remain open.
- Preferences - Opens the Preferences page.

### Help Menu

The menu options in the Help menu are:

- Welcome - Opens the Guardian Welcome Page.
- Help Contents - Opens the Guardian help system, which includes the Guardian User Guide, a guide to using the Guardian help, and a utility for searching help.
- Search - Opens a utility that searches the Guardian User Guide for the text you enter.
- Dynamic Help - Opens the Guardian dynamic help system. Dynamic help displays all the help text from the Guardian User Guide relating to the currently active view or editor. The dynamic help automatically updates itself to match each view or editor you select.
- Tips and Tricks - Opens a dialog box to select a Guardian Tips and Tricks table. The Tips and Tricks table describes how to perform certain Guardian tasks more efficiently.
- Cheat Sheet - Opens a dialog box to select a Guardian Cheat Sheet. The Cheat Sheet shows how to perform certain Guardian tasks, step by step. Some of the steps can be done for you automatically at the press of a button.
- Manage Guardian - Open the Manage Guardian submenu containing the following options:

- Update Guardian - Invoke the Update Wizard.
- Manage Configuration - Open the Product Configuration Manager. You can use this to perform the following tasks:

- Scan for Updates - Search for updates for all installed features and invokes the Update Wizard.
- View Installation History - View all activites since installation of the product.
- Show Activities - Display the steps that led to the current Guardian configuration.
- Add an Extension Location - Locate and add an Extension Location to the current configuration. An Extension Location contains all features and plugins previously installed.

- Key Assist - Display a list of the Guardian Keyboard Shortcuts.
- About BEA Guardian - Display the Guardian version and features, plug-ins, and configuration details.

#### Related Tasks

- Deactivate Domain
- Submit Support Case

#### Related Reference

- Domain Activation Wizard
- Evaluation Wizard
- Shortcut Wizard
- Document Pane
- Domain Inventory
- Evaluation Summary
- Signature Details
- Bundle Details
- Navigation Pane
- Domain Explorer
- Bundle Explorer
- Shortcut Explorer
- Signature Explorer
- Active Domains Table
- Shortcuts Table
- Keyboard Shortcuts

## Main Toolbar

The BEA Guardian Main Toolbar is located below the Main Titlebar and Main Menu and above the Navigation Pane. Running from left to right, the Main Toolbar buttons are:

- Open - Opens the selected resource for editing or execution:

- Active Domains Table when Target Domains is selected in the Domain Explorer
- Domain Inventory when a Domain Inventory is selected in the Domain Explorer
- Evaluation Summary when an Evaluation Summary is selected in the Domain Explorer
- Signature Details when a signature is selected in the Signature Explorer and Bundle Explorer
- Bundle Details when a bundle is selected in the Bundle Explorer
- Evaluation Wizard when a shortcut is selected in the Shortcut Explorer.

- Print - Prints the contents of the Report tab for whichever one of these editors is active in the Document Pane:

- Domain Inventory
- Evaluation Summary
- Signature Details
- Bundle Details

- Activate - Invokes the Domain Activation Wizard.
- Inventory - Invokes the Inventory Wizard.
- Evaluate - Invokes the Evaluation Wizard.
- Update - Invokes the Update Wizard.

When the mouse pointer is over a toolbar button, a tool tip window pops up under the mouse pointer that says what the button does.

#### Related Reference

- Navigation Pane
- Document Pane
- Active Domains Table
- Domain Explorer
- Domain Inventory
- Evaluation Summary
- Signature Details
- Signature Explorer
- Bundle Explorer
- Bundle Details
- Shortcut Explorer
- Domain Activation Wizard
- Inventory Wizard
- Evaluation Wizard
- Update Wizard

## Keyboard Shortcuts

The Keyboard Shortcuts are sequences of keystrokes that enable you to perform certain Guardian graphical user interface operations without using the mouse pointer.

The following table lists the Guardian Keyboard Shortcuts and can be displayed by pressing Ctrl+Shift+L:

#### Related Reference

- Main Menu
- Main Toolbar

## Navigation Pane

The Navigation Pane contains the follow views, which by default display on the left hand side of the BEA Guardian window:

- Domain Explorer
- Bundle Explorer
- Signature Explorer
- Shortcut Explorer

### Explorer Toolbar Icons

Each Explorer toolbar may contain all or some of the following active icons:

Icon | Name
| Close
| Minimize
| Maximize
| Restore
| Expand all items
| Collapse all items
| Menu
| Link with Editor

#### Related Reference

- Domain Explorer
- Bundle Explorer
- Signature Explorer
- Shortcut Explorer

### Domain Explorer

The Domain Explorer is a Navigator view that enables you to browse and interact with the domains that you have activated.

#### Domain Nodes

The first time you activate a domain, a domain node is added to the Target Domains folder. To distinguish between domains that could have the same name, the domain node name is a generated name. The generated name includes the host name and listen port you entered in the Domain Activation Wizard. The domain node name is also known as the domainId in the Guardian Command Line Interface.

The format of the generated domain name is: <domain name>_<host name>_<listen port>. For example, guardian-test_mj23_32292, would be the domain node name for a domain named "guardian-test" activated with a host name, "mj23", and a listen port, "32292".

The Domain Explorer includes both active and inactive domain nodes. Active domain nodes are listed in bold. Inactive domain nodes are not bold. Inactive domain nodes can be removed with the Purge Inactive Domains option in the Tools menu.

Domain nodes also include icons. As indicated below, one icon is for active domains and one is for inactive domains. Active domains can also be decorated with icons that indicate whether the username and password have been persisted, and whether the domain requires SSL encryption for all communication. Please note that Guardian uses 128 bit open source encryption for SSL.

Icon | Meaning
| Domain is active.
| Domain is inactive.
| Username and password have been persisted (icon decorates active domain icon).
| Domain requires 128 bit SSL (icon decorates active domain icon).

The following graphic and table shows five domains with their icons:

Domain Name | Active/ Inactive | Password Persisted/ Not Persisted | 128 bit SSL Enabled/ Not Enabled
816clusterdomain | Inactive | N/A | N/A
guardian-dev | Active | Not Persisted | Not Enabled
mydomain | Active | Persisted | Not Enabled
QA_815_windows | Active | Not Persisted | Enabled
WLS92cluster | Active | Persisted | Enabled

#### Domain History Folders

Each domain node contains folders that accumulate all your Domain Inventories and Evaluation Summaries. These folders are persisted on disk in the Guardian Workspace.

##### Inventory History Folder

Every time you activate, evaluate, or inventory a domain, a new Domain Inventory is created and added to the Inventory History folder for that domain. If you double-click a Domain Inventory, a Domain Inventory editor opens in the Document Pane.

To distinguish between Domain Inventories, the Domain Inventory name is a generated name. To enforce uniqueness, the generated name includes the domain name, host name, listen port, date and time it was created, in the format: <domain name>_<host name>_<listen port>_<date> <time>.

##### Evaluation History Folder

Every time you evaluate a domain, a new Evaluation Summary is created and added to the Evaluation History folder for that domain. If you double-click an Evaluation Summary, an Evaluation Summary editor opens in the Document Pane.

To distinguish between Evaluation Summaries, the Evaluation Summary name is a generated name. To enforce uniqueness, the generated name includes the bundle evaluated, date and time it was created, in the format: <bundle name>_<date> <time>.

The Evaluation Summary entry includes an icon that indicates whether any signatures were detected. If any signatures were detected, the icon is decorated with a severity indicator. The icon with its severity indicator identifies the most severe signature detected:

Icon | Severity | Meaning
| Critical | The evaluation detected at least one critical signature.
| Warning | The evaluation detected at least one warning signature and no critical signatures.
| Informational | The evaluation detected at least one informational signature and no critical or warning signatures.
| No Signature | The evaluation did not detect any signatures.

#### Domain Explorer Menu

Click the Domain Explorer menu icon to display a menu containing the following options:

- Filter Domain Explorer — This opens the Filter Domain Explorer dialog box. This enables you to filter out the older Domain Inventories and Evaluation Summaries.
- Link with Editor — Link selected item with an Editor.

#### Domain Explorer Context Menu

The Domain Explorer has a context menu. To open it, right-click inside the Domain Explorer. The menu that pops up includes these choices:

- Delete
- Activate
- Deactivate
- Modify Domain
- Inventory
- Add Shortcut
- Evaluate
- Evaluate Bundle

Please note that if you right-click any entry in an expanded, active domain node, or any entry in an active domain node is selected when you right-click, the Inventory, Add Shortcut, Evaluate, and Evaluate Bundle menu options will proceed as if that is the domain you want to target. Also, the Deactivate and Modify Domain menu options are unavailable unless you right-click directly on an active domain node, or an active domain node is selected when you right-click. Conversely, the Activate menu option is unavailable if an active domain node is selected.

The Delete menu option deletes the Domain Inventories and Evaluation Summaries that are selected in the Domain Explorer. It deletes the entries from the Domain Explorer as well as the underlying files from the Guardian Workspace. A confirmation box enables you to cancel the deletion. You can also use the Delete key on your keyboard to delete any selected Domain Inventories and Evaluation Summaries.

The Evaluate Bundle menu option opens a submenu that lists all the bundles available for evaluation. Selecting any of them invokes the Bundle Evaluation Wizard. The Bundle Evaluation Wizard opens with the currently selected domain and the bundle you select, just as if you had invoked a shortcut. The Bundle Evaluation Wizard works just like the Shortcut Evaluation Wizard. Unless an active domain node or one of its entries is selected, or you right-click an active domain node or one of its entries, the bundle list is greyed out and cannot be selected.

#### Domain Properties

The Domain Properties dialog box enables you to modify how BEA Guardian accesses a target domain. In particular, you can change:

- The username and password Guardian uses to access the domain
- Whether to remember the username and password
- Whether to use a proxy server to access the domain

There are two different ways to open the Domain Properties dialog box:

- Select a domain in the Active Domains Table and click the Modify Domain button.
- Right-click a domain in the Domain Explorer and select Modify Domain.

The Domain Properties dialog box includes the following components:

- The domain name, read only
- The URL of the domain's Administration Server, read only
- The username and password of an administrator account on the domain

Please note that changing the username and password in Guardian does not change the username and password on the domain.

- Whether to remember the username and password

If selected, the username and password are encrypted and stored on disk. Then, whenever you evaluate, inventory, modify, or open an admin console to the domain, or submit a support case, the domain's username and password are filled in automatically. Otherwise, you have to enter them for each operation that accesses the domain.

- Whether to use a proxy server to access the domain

If selected, you must select the name of the proxy server from the drop down list. If there are no proxy servers in the drop down list, the Enable proxy connection check box is disabled. To add a proxy server, select Proxy from the Preferences page. Please note that in order to use a proxy server, you must also manually deploy the Guardian Agent onto the target domain.

#### Related Tasks

- Evaluate Domain
- Inventory Domain
- Create Shortcut
- Submit Support Case

#### Related Reference

- Active Domains Table
- Domain Explorer
- Preferences

### Signature Explorer

The Signature Explorer is a Navigator view that enables you to browse and interact with the available signatures.

The signature entries include the following severity indicator icons. The severity indicator approximates the level of attention you should give the signature when it is detected.

Icon | Severity
| Critical
| Warning
| Informational

Double-click a signature in the Signature Explorer, to opena a Signature Details editor in the Document Pane.

#### Signature Explorer Titlebar

The Signature Explorer Titlebar contains the following active (clickable) icons:

Icon | Name
| Close
| Minimize
| Maximize
| Restore
| Menu

#### Signature Explorer Menu

Click the Signature Explorer Menu icon to open a menu of options for sorting and filtering the signature list. These are as follows:

- The Sort Signatures submenu offers you these choices:

- By Name - lists the signatures alphabetically by name. This is the default ordering when you first open the Signature Explorer.
- By Severity - groups the signatures by severity level, and then lists the signatures alphabetically by name within each severity level.

- The Filters menu option opens the Signature Filters dialog box which enables you to specify which signatures you want to see listed in the Signature Explorer.

#### Signature Explorer Context Menu

Right-click on a signature name in the Signature Explorer to display the Signature Explorer context menu with the following option:

- Annotations — This opens a submenu with the following option:

- Manage Annotations: Select this to open the Annotations Wizard. For instructions on using this wizard, see Signature Annotations on page 64 of Tasks.

#### Related Reference

- Signature Details
- Document Pane
- Filters Wizard

### Bundle Explorer

The Bundle Explorer is a Navigator view for browsing and managing the available signature bundles.

The Bundle Explorer contains a top level folder named Bundles. In the Bundles folder is a node for each bundle that is available for evaluation. Each bundle node contains all the signatures for that bundle.

Signatures are grouped into different bundles based on their characteristics. For example, the Security Advisories bundle contains signatures that detect potential security problems for which BEA has issued security advisories. The Service Pack Remedy bundle contains signatures whose resolution requires installation of a specific service pack. The Bundle Details editor describes each of the Guardian signature bundles.

The signature entries in each bundle node include the following severity indicator icons. The severity indicator approximates the level of attention you should give the signature when it is detected.

Icon | Severity
| Critical
| Warning
| Informational

Double-click a bundle in the Bundle Explorer to open a Bundle Details editor in the Document Pane. Double-click a signature in the Bundle Explorer to open a Signature Details editor in the Document Pane.

#### Bundle Explorer TitleBar

The Bundle Explorer Titlebar contains these icons you can click:

Icon | Name
| Close
| Minimize
| Maximize
| Restore
| Expand all items
| Collapse all items
| Menu

#### Bundle Explorer Menu

Click the Bundle Explorer Menu icon to open a menu with the following options:

- Filters... — This opens the Filters dialog box for filtering signatures in Detected Signatures lists.
- Sort Signatures — This displays a submenu with options for sorting the signatures displayed in each bundle. From the Sort Signatures submenu, you can select:

- By Bundle Name, Signature Name - lists the signatures in each bundle alphabetically by name. This is the default ordering when you first open the Bundle Explorer.
- By Bundle Name, Severity - groups the signatures in each bundle by severity level, and then lists the signatures alphabetically by name within each severity level.

Note: | Selecting either of the Sort Signatures choices collapses all the bundle nodes. To see the signatures in their new sort order, either click each bundle node individually to expand it, or click the Expand all items icon to expand all the bundle nodes.

- Link with Editor — Link selected item with an editor.

#### Bundle Explorer Context Menu

Right-click on a signature name in the Bundle Explorer to display the Bundle Explorer context menu with the following option:

- Annotations — This opens a submenu with the following option:

- Manage Annotations: Select this to open the Annotations Wizard. For instructions on using this wizard, see Signature Annotations on page 64 of Tasks.

#### Related Reference

- Bundle Details
- Document Pane
- Signature Details

### Shortcut Explorer

The Shortcut Explorer is a Navigation Pane view for managing the shortcuts you have created.

If you double-click a shortcut in the Shortcut Explorer, the Shortcut Evaluation Wizard opens with the shortcut target domain and signature bundle preselected. Shortcuts save steps by saving the domain and bundle so you do not have to select them each time you perform an evaluation.

#### Shortcut Explorer Context Menu

The Shortcut Explorer has a context menu. To open it, right-click inside the Shortcut Explorer. The menu that pops up contains the following options:

- Add Shortcut
- Delete Shortcut
- Evaluate Shortcut

If you right-click a shortcut, or a shortcut is selected when you right-click, the Delete Shortcut and Evaluate Shortcut menu options will proceed as if that is the shortcut you want to delete or evaluate. Conversely, the Delete Shortcut and Evaluate Shortcut menu options are unavailable unless you right-click directly on a shortcut, or a shortcut is selected when you right-click.

#### Related Tasks

- Create Shortcut
- Delete Shortcut
- Evaluate Shortcut

#### Related Reference

- Navigation Pane
- Shortcut Evaluation Wizard

## Document Pane

The Document Pane is the location where these BEA Guardian views and editors open, by default in the central region of the BEA Guardian window:

- Active Domains Table
- Domain Inventory
- Evaluation Summary
- Signature Details
- Bundle Details
- Shortcuts Table

#### Related Reference

- Active Domains Table
- Domain Inventory
- Evaluation Summary
- Signature Details
- Bundle Details
- Shortcuts Table

### Active Domains Table

The Active Domains Table is a Document Pane view for managing the domains you have activated.

To open the Active Domains Table, select Show View > Active Domains Table from the BEA Guardian Window Menu.

The Active Domains Table lists the active domains, each having these columns:

- Domain: the domain name
- Administration Server URL: the URL of the domain's Administration Server
- Last Evaluation: the name of the Evaluation Summary for the most recent evaluation performed.

By default, the domains are listed alphabetically by domain name. Clicking a column heading sorts the domains by that column. For example, clicking the Last Evaluation column sorts the domains alphabetically by the Evaluation Summary name of the last evaluation. Clicking the same column heading in succession alternates between sorting in alphabetical order and reverse alphabetical order.

#### Active Domains Table Toolbar

The Active Domains Table toolbar contains the following buttons. Please note that they cannot be clicked until you select one of the active domains listed:

- Open Admin Console - opens a BEA Weblogic Server Administration Console in your Web browser. The Administration Console is a Web application that is hosted by the Administration Server which you specified in the Domain Activation Wizard.

If you selected the Remember username/password check box when activating or modifying the domain, the browser will automatically log you into the Administration Console. If not, the browser will start at the Administration Console login page.

Administration Console documentation can be found on the BEA eDocs website for:

- BEA WebLogic Server 9.1
- BEA WebLogic Server 8.1

- Modify Domain - opens the Domain Properties dialog box, which enables you to change how Guardian accesses the domain.
- Deactivate Domain - invokes the Domain Deactivation Wizard to deactivate the domain.

#### Related Tasks

- Activate Domain
- Create Shortcut

#### Related Reference

- Document Pane
- Evaluation Summary
- Domain Activation Wizard
- Domain Properties
- Domain Deactivation Wizard
- Main Menu

### Domain Inventory

A Domain Inventory is an XML document, persisted in the Guardian Workspace, that describes the products in your domain. The Domain Inventory editor in the Document Pane enables you to interact with the Domain Inventory to better understand how BEA Guardian evaluates your domain.

A Domain Inventory is created when you activate a domain and a new one is created each time you evaluate a domain. You can also create a new Domain Inventory with the Inventory Wizard. The Inventory History folder in the Domain Explorer contains all the Domain Inventories for a domain.

You can open a Domain Inventory editor in any of the following ways:

- Activate a domain, or inventory a domain. Then click the OK button in the Progress View.
- Double-click a Domain Inventory in the Inventory History folder of a domain in the Domain Explorer.

#### Domain Inventory Tabs

On the bottom of the Domain Inventory editor are the following tabs for the different Domain Inventory representations. Please note that these representations are read only:

- Overview - provides a summary of the Domain Inventory. It contains the following sections:

- General Information - the domain name and date and time the Domain Inventory was created.
- Servers - the number of servers in the domain, the number of servers active at the time of the inventory, a list of the servers, and information about each server. Please note that if a server is down at the time of an evaluation, it could mask some signatures from being detected.

When you click on a server in the list, the following server information is displayed. Information on the first server in the list is displayed by default:

- Server Details - the server's name and WebLogic version, whether the server is the Administration Server or not, and whether the server is in production mode or not.
- Java Details - the Java vendor and version, and the Java Virtual Machine vendor, name, and version.
- Operating System Details - the operating system name, version, and processor architecture.

- JDBC - the number of JDBC connection pools, a list of the JDBC connection pools, and details about each JDBC connection pool.

When you click on a JDBC connection pool in the list, the following JDBC connection pool details are displayed. JDBC connection pool details on the first JDBC connection pool in the list are displayed by default:

- the JDBC connection pool name
- the JDBC data source name
- the database product name and version
- the JDBC driver name and version

- Source - provides the actual XML source for the Domain Inventory. It can be copied to your paste buffer or printed with the context menu. You can access the context menu by right-clicking inside the Domain Inventory.
- Report - provides all the information contained in the Overview tab in a printer friendly format. It can also be copied into your paste buffer or printed with the context menu.

#### Domain Inventory Outline View

When the Outline View is open and the Domain Inventory editor is active, you can use the Outline View to control what the Domain Inventory editor displays. Clicking the Overview, Source, and Report nodes in the Outline View brings the corresponding tab of the Domain Inventory editor to the forefront. Expanding the Outline View Source node enables you to select specific XML tag names, causing the Domain Inventory editor to jump to those tags and hightlight them.

#### Related Tasks

- Activate Domain
- Evaluate Domain
- Inventory Domain

#### Related Reference

- Document Pane
- Inventory Wizard
- Domain Explorer

### Evaluation Summary

An Evaluation Summary is created each time you evaluate a domain, and is persisted in the Guardian Workspace. The Evaluation Summary editor in the Document Pane enables you to interact with the Evaluation Summary and determine if you need to take any corrective action.

These are the different ways to open an Evaluation Summary:

- Conduct an evaluation. An Evaluation Summary is opened automatically when the evaluation completes.
- Double-click an Evaluation Summary entry in the Evaluation History folder of the Domain Explorer.

#### Evaluation Summary Tabs

On the bottom of the Evaluation Summary editor are the following tabs for the different Evaluation Summary representations. Please note that these representations are read only:

- Overview - provides evaluation statistics and a list of detected signatures. It also includes a description and remedy recommendation for each signature detected in the evaluation. It contains the following sections. Each section can be expanded or collapsed by clicking the triangle icon in the heading.

- General Information - the target domain name, the signature bundle evaluated, the date and time of the evaluation, the length of time to conduct the evaluation, and the number of signatures targeted, detected, not detected, and undetectable in the evaluation.

For a given bundle of signatures, some signatures may not be used in the evaluation because they target different products than the domain has. The ones that do target what the domain has are counted as Targeted Signatures. The Targeted Signatures are divided into Detected Signatures, which are actually found on the domain; and Undetected Signatures, which are not found on the domain. If a signature fails to evaluate, it is counted as an Undetectable Signature, and is considered flawed.

- Detected Signatures - a table that includes information about every signature detected in the evaluation, including the signature name, identification number, severity, area of impact, and BEA product affected. It also includes the signature topic and subtopic, which further narrow the category of potential problem found. If you submitted any support cases to BEA, the case information is listed as well.

Clicking a detected signature displays information about it in the Description and Remedy sections. Information about the first detected signature is displayed by default. You can sort the detected signature table by clicking any of the column headings. The detected signatures are sorted by severity and name by default.

The Severity column of the detected signature table includes an icon that approximates the amount of attention you should give each signature that has been detected.

Icon | Severity
| Critical
| Warning
| Informational

- Description - information about the signature, from the signature XML file itself. Description includes the signature name, severity, category of impact (for example, Server Outage, Performance, or User Viewable Error), and a detailed description.
- Remedy - an explanation of how to resolve the potential problem, from the signature XML file itself. It includes the servers impacted by the signature and links to get more information about the potential problem.

Remedy also includes a link, Get more help from BEA Support, which opens the Support Case Wizard. Opening a support case enables you to get more help from BEA to analyze and repair the potential problem that the signature detected.

- Source - provides the actual XML source from the Evaluation Summary. It includes the raw data for each detected and undetected signature, and can be copied to your paste buffer or printed with the context menu. You can access the context menu by right-clicking inside the Evaluation Summary.
- Report - provides all the information contained in the Overview tab in a printer friendly format. It can also be copied into your paste buffer or printed with the context menu.

#### Evaluation Summary Outline View

When the Outline View is open and the Evaluation Summary editor is active, you can use the Outline View to control what the Evaluation Summary editor displays. Clicking the Overview, Source, and Report nodes in the Outline View brings the corresponding tab of the Evaluation Summary editor to the forefront. Expanding the Outline View Source node enables you to select specific XML tag names, causing the Evaluation Summary editor to jump to those tags and highlight them.

#### Related Tasks

- Evaluate Domain

#### Related Reference

- Document Pane
- Domain Explorer

### Signature Details

A signature is an XML document that identifies potential problems in your domain. The Signature Details editor in the Document Pane provides more information about each signature.

To open a Signature Details editor, double-click a signature in the Signature Explorer or Bundle Explorer.

#### Signature Details Tabs

On the bottom of the Signature Details editor are the following tabs for the different Signature Details representations. Please note that these representations are read only:

- Overview - provides information about the signature and how it was created. It contains these sections:

- General Information - the signature identifier, name, publication date, and severity level (Critical, Warning, or Informational).
- Description - an explanation of the signature in plain language, from the actual signature XML file itself.
- Target - the XPath expression used to match the signature with the target domain's Domain Inventory.

- Source - provides the actual XML source for the signature. It includes the raw data for each signature, and can be copied to your paste buffer or printed with the context menu. You can access the context menu by right-clicking inside the Signature Details editor.
- Report - provides all the information contained in the Overview tab in a printer friendly format. It can also be copied into your paste buffer or printed with the context menu.

#### Signature Details Outline View

When the Outline View is open and the Signature Details editor is active, you can use the Outline View to control what the Signature Details editor displays. Clicking the Overview, Source, and Report nodes in the Outline View brings the corresponding tabs of the Signature Details editor to the forefront. Expanding the Outline View Source node enables you to select specific XML tag names, causing the Signature Details editor to jump to those tags and hightlight them.

#### Related Reference

- Document Pane
- Signature Explorer
- Bundle Explorer

### Bundle Details

A bundle is a group of signatures that are evaluated together. The Bundle Details editor in the Document Pane provides more information about each bundle.

To open a Bundle Details editor, double-click a bundle node in the Bundle Explorer.

#### Bundle Details Tabs

On the bottom of the Bundle Details editor are the following tabs for the different Bundle Details representations. Please note that these representations are read only:

- Overview - provides information about the bundle and how it was created. It contains the following sections:

- General Information - the bundle identifier, name, creation date, and modification date.
- Description - a plain language description of the bundle.
- Signature Def - the XPath expression that created the bundle.

- Report - provides all the information contained in the Overview tab in a printer friendly format. The report can be copied to your paste buffer or printed with the context menu. You can access the context menu by right-clicking inside the Bundle Details editor.

#### Bundle Details Outline View

When the Outline View is open and the Bundle Details editor is active, you can use the Outline View to control what the Bundle Details editor displays. Clicking the Overview and Report nodes in the Outline View brings the corresponding tabs of the Bundle Details editor to the forefront.

#### Related Reference

- Document Pane
- Bundle Explorer

### Shortcuts Table

The Shortcuts Table is a view in the Document Pane that enables you to manage the shortcuts you have created.

To open the Shortcuts Table, select Show View > Shortcuts Table from the BEA Guardian Window menu.

The Shortcuts Table lists the shortcuts, each having these columns:

- Shortcut: the shortcut name
- Domain: the domain the shortcut targets
- Bundle: the signature bundle the shortcut evaluates

By default, the shortcuts are listed alphabetically by shortcut name. Clicking a column heading sorts the shortcuts by that column. For example, clicking the Domain column sorts the shortcuts alphabetically by domain name. Clicking the same column heading in succession alternates between sorting in alphabetical order and reverse alphabetical order.

#### Shortcuts Table Toolbar

The Shortcuts Table toolbar contains buttons to add and delete shortcuts:

- Clicking the Add Shortcut button invokes the Shortcut Wizard to create a new shortcut.
- Clicking the Delete Shortcut button pops up a confirmation box to confirm that you really want to delete the selected shortcut. Please note that the Delete Shortcut button can't be clicked until a shortcut has been selected.

#### Related Tasks

- Create Shortcut
- Delete Shortcut

#### Related Reference

- Document Pane
- Shortcut Wizard
- Shortcut Explorer
- Main Menu

## Preferences

The Preferences page enables you to customize the BEA Guardian environment.

These are the different ways to open the Preferences page:

- Press "Ctrl+Shift+P"
- Select Preferences from the Window menu.

The Preferences page is a dialog box that enables you to select from the following main categories:

- General - settings that control the appearance of, interaction with, and startup of Guardian. The ones most useful for Guardian are:

- Keys - enables you to change Guardian's Keyboard Shortcuts.
- Startup and Shutdown - enables you to change whether Guardian prompts you for the Guardian Workspace location when starting.

- Guardian - settings that control Guardian's data interactions and appearance. The ones most useful for Guardian are:

- BEA Support - enables you to specify whether to use Secure Sockets Layer (SSL) encryption when creating support cases, and whether to use a proxy server when updating Guardian. Please note that Guardian uses 128 bit open source encryption for SSL. BEA Support also enables you to specify the hostname, port, and (optionally) the username and password for authentication for a proxy server. This is the proxy server that the Support Case Wizard would use to create a BEA Support Case.
- Proxy - enables you to add proxy servers to use when activating domains.

- Help - settings that control how Guardian help content is displayed.
- Install/Update - settings that control how the Guardian application is updated. The Automatic Updates section enables you to tell Guardian to automatically contact the BEA Guardian update site to find new signatures and application updates. The “Enable HTTP proxy connection” field enables you to specify the host address and port of the proxy server that the Update Wizard would use to access the BEA update server to download new signatures and software updates.

#### Related Tasks

- Submit Support Case
- Automatically Update Guardian
- Activate Domain

#### Related Reference

- Keyboard Shortcuts
- Main Menu

## Wizards

BEA Guardian provides the following wizards:

- Domain Activation Wizard
- Domain Deactivation Wizard
- Evaluation Wizard
- Support Case Wizard
- Inventory Wizard
- Shortcut Wizard
- Shortcut Evaluation Wizard
- Update Wizard

A Wizard is a series of one or more dialog boxes that enable you to complete certain BEA Guardian tasks. The wizard prompts you for the information BEA Guardian needs to complete the task. For example, the Evaluation Wizard prompts you for the target domain and the signature bundle to evaluate.

When all the required information is filled in, you can click the Finish button to actually execute the task. When the Domain Activation, Domain Deactivation, Evaluation, and Inventory Wizards finish, the Progress View indicates successful completion. The Update and Support Case Wizards have their own notification, and the Shortcut Wizard gives no notification.

#### Related Tasks

- Manually Deploy Guardian Agent
- Activate Domain
- Deactivate Domain
- Evaluate Domain
- Submit Support Case
- Inventory Domain
- Create Shortcut
- Evaluate Shortcut
- Automatically Update Guardian

#### Related Reference

- Domain Activation Wizard
- Domain Deactivation Wizard
- Evaluation Wizard
- Support Case Wizard
- Inventory Wizard
- Shortcut Wizard
- Shortcut Evaluation Wizard
- Update Wizard
- Domain Explorer

### Domain Activation Wizard

The Domain Activation Wizard prepares a target domain for evaluation by installing any needed Guardian Agents and creating a new Domain Inventory.

There are several different ways to invoke the Domain Activation Wizard:

- Press Ctrl+Shift+A.
- Click the Activate button on the Main Toolbar.
- Select New > Domain from the File menu.
- Right-click inside the Domain Explorer and select Activate Domain from the pop-up context menu.

The Domain Activation Wizard contains the following data entry fields:

- The communication protocol - either http://, or https:// for Secure Sockets Layer (SSL) encryption. Please note that Guardian does not use 128 bit SSL encryption for domain activation.
- The host name - the listen address of the target domain's Administration Server, for example, localhost, 66.248.193.194, or guardian-dev.bea.com
- The port number - the listen port for the target domain's Administration Server
- The username of an administrator account on the target domain
- The password of an administrator account on the target domain
- Whether to remember the username and password

If selected, the username and password are encrypted and stored on disk. Then, whenever you access the domain, the username and password are filled in automatically. Otherwise, you have to enter them. The following Guardian operations require login credentials:

- Evaluate a domain
- Inventory a domain
- Modify a domain
- Open an admin console
- Submit a support case

- Whether to use a proxy server to access the domain

If selected, you must select the name of the proxy server from the drop down list. If there are no proxy servers in the drop down list, click the Add Proxy Server link to add one. Please note that in order to use a proxy server, you must also manually deploy the Guardian Agent onto the target domain.

If a deactivated domain is selected and the Domain Explorer is active when you invoke the Domain Activation Wizard, the communication protocol, host name, and listen port fields will be filled in automatically with the values for the deactivated domain. You still must enter the username and password.

Once you have entered the required data, click the Finish button to activate the domain. A progress indicator tracks the progress as the domain is activated.

The successful completion of the Domain Activation Wizard results in:

- The domain is available for evaluation.
- Any needed Guardian Agents are installed on the domain.
- A new Domain Inventory editor is opened in the Document Pane.
- A domain node is added to the Domain Explorer, in the Target Domains folder. A Domain Inventory entry is also added to the domain node's Inventory History folder.
- The domain is added to the Active Domains Table.
- The domain is added to the Guardian Registry.
- A folder for the domain is added to the Guardian Workspace. The domain folder persists the Domain Inventories, Evaluation Summaries, and Case Creation Archives.

#### Related Tasks

- Activate Domain
- Deactivate Domain
- Evaluate Domain
- Inventory Domain
- Create Shortcut
- Submit Support Case

#### Related Reference

- Domain Explorer
- Active Domains Table
- Domain Inventory
- Evaluation Summary
- Keyboard Shortcuts
- Main Toolbar
- Main Menu

### Domain Deactivation Wizard

The Domain Deactivation Wizard makes a domain unavailable for evaluation.

There are two different ways to invoke the Domain Deactivation Wizard:

- Select a domain in the Active Domains Table and click the Deactivate Domain button.
- Right-click a domain in the Domain Explorer and select Deactivate Domain.

The Domain Deactivation Wizard dialog box prompts you for the domains to deactivate. By default, the domains selected when you invoked the Domain Deactivation Wizard are highlighted. You can deactivate multiple domains at once.

When you have selected the domains to deactivate, click the Finish button. The deactivation completes immediately because the operation is local to Guardian and the domains are not contacted.

The successful completion of the Domain Deactivation Wizard results in:

- A pop-up dialog box indicates successful completion.
- The Progress View shows the time the deactivation finished.
- The domains are removed from the Active Domains Table.
- The domains are still listed in the Domain Explorer so you can access their previous Domain Inventories and Evaluation Summaries. But they are no longer displayed with a bold font.

You can remove deactivated domains from the Domain Explorer with the Purge Inactive Domains option from the Tools menu.

- Any shortcuts that target the deactivated domains are removed from the Shortcuts Table and Shortcut Explorer.
- The domains can no longer be selected for evaluations or inventories. However, you can activate the domain again at any time.

Please note that the Domain Deactivation Wizard does not remove any of the Guardian Agents that were installed during domain activation. If you want to remove the Guardian Agents after deactivating a domain, you can use the deployment tools provided with WebLogic Server. Guardian Agents are deployed as Web Application Archive (WAR) files with the name, "bea-guardian-agent". Deployment documentation can be found on the BEA eDocs website for:

- BEA WebLogic Server 8.1
- BEA WebLogic Server 9.1
- BEA WebLogic Server 9.2

#### Related Tasks

- Deactivate Domain
- Activate Domain

#### Related Reference

- Active Domains Table
- Domain Explorer
- Domain Inventory
- Evaluation Summary
- Shortcuts Table
- Shortcut Explorer
- Main Menu

### Evaluation Wizard

The Evaluation Wizard enables you to evaluate one or more domains.

There are several different ways to invoke the Evaluation Wizard:

- Press Ctrl+Shift+E.
- Click the Evaluate button on the Main Toolbar.
- Select New > Evaluation from the File menu.
- Double-click a domain in the Active Domains Table.
- Double-click a domain in the Domain Explorer.
- Right-click a domain in the Domain Explorer, or anywhere in the Domain Explorer, and select Evaluate from the pop-up context menu.

The Evaluation Wizard dialog box contains the following data entry fields:

- The domains to evaluate - click the domain you want to evaluate. Use the Ctrl or Shift keys when clicking to select more than one domain. Please note that any domain selected with the Domain Explorer or Active Domains Table active when the Evaluation Wizard is invoked will be preselected already.
- The bundle to evaluate - for each domain, you can select one bundle to evaluate. The Default Signatures bundle is selected by default. To change the bundle, click the bundle name and select a different bundle from the drop down list.
- The domain login credentials - if you checked the Remember username/password check box when activating or modifying the domain, the username and password are already filled in. Otherwise, the domain is displayed in italics, and you must enter the username and password in the Domain Credentials section.

If you have multiple domains selected, every one must have its credentials filled in before you can launch the evaluation. If any of the selected domains are missing credentials, a message at the top of the dialog box says that the required credentials are missing and the Finish button is greyed out.

- Whether to remember the username and password - if you check the Remember username/password check box, you won't have to enter domain login credentials for any future domain access operations.
- Whether to create a shortcut - if you check the Create Shortcut check box, the domain and bundle evaluated are saved as a shortcut for future evaluations. If evaluating multiple domains, you must create a shortcut for each domain and bundle pair separately.

When you check Create Shortcut, a default shortcut name is created in the text box next to it. The default shortcut name is in the form, "<bundle name> in <domain name>". You can change the shortcut name by editing the text box.

When you have finished editing the Evaluation Wizard dialog box, you can click the Finish button to launch the evaluation. A progress indicator tracks the progress as the evaluation executes.

The successful completion of the Evaluation Wizard results in:

- The Progress View shows the time it finished for each domain evaluated.
- A new Evaluation Summary is opened in the Document Pane.
- The Domain Explorer is modified as follows:
- If you checked the Remember username/password check box, the domain node icon is decorated to indicate that the login credentials have been persisted.
- A new Evaluation Summary entry is added to the Evaluation History folder for each domain evaluated.
- A new Domain Inventory entry is added to the Inventory History folder for each domain evaluated.
- If you selected the Create Shortcut check box, the shortcut is added to both the Shortcut Explorer and the Shortcuts Table.

#### Related Tasks

- Evaluate Domain
- Activate Domain
- Create Shortcut

#### Related Reference

- Active Domains Table
- Domain Explorer
- Bundle Details
- Domain Activation Wizard
- Evaluation Summary
- Document Pane
- Keyboard Shortcuts
- Main Toolbar
- Main Menu

### Filters Wizard

The Filters Wizard enables you to specify which signatures to display in Signature Lists.

To open the Filters Wizard, click the Signature Explorer menu icon and select the Filters menu option.

The Filters Wizard contains the following components that determine which signatures are displayed:

- Name Filter Pattern - a text box that enables you to enter a search pattern for the signature names you want to select. For example:

- SSL* selects all signatures whose first three letters are SSL Please note that Guardian uses 128 bit open source encryption for SSL.
- *8.?* selects all the signatures relating to WebLogic Server Version 8

Whether the names you select are displayed or filtered out depends on the following radio button settings.

- Show matching names - a radio button that causes the signatures matching the Name Filter Pattern text box to be displayed rather than filtered out.
- Hide matching names - a radio button that causes the signatures matching the Name Filter Pattern text box to be filtered out rather than displayed.
- Select the severity levels to include - a check box for each severity level: Critical, Warning, or Informational that further refines which signatures are displayed. Whatever the results are of the Name Filter Pattern text box and the Show matching names and Hide matching names radio buttons, only the signatures matching the severity levels selected in these check boxes are displayed.

#### Related Reference

- Signature Explorer

### Inventory Wizard

The Inventory Wizard enables you to create a new Domain Inventory for one or more domains.

There are several different ways to invoke the Inventory Wizard:

- Press "Ctrl+Shift+I".
- Click the Inventory button on the Main Toolbar.
- Select New > Inventory from the File menu.
- Right-click a domain in the Domain Explorer, or anywhere in the Domain Explorer, and select Inventory.

The Inventory Wizard contains the following data entry fields:

- The domains to inventory - click each domain to inventory. Use the Ctrl or Shift keys when clicking to select more than one domain. Please note that any domain selected with the Domain Explorer or Active Domains Table active when the Inventory Wizard is invoked will be preselected already.
- The domain login credentials - if you checked the Remember username/password check box when activating or modifying the domain, the username and password are already filled in. Otherwise, the domain is displayed in italics, and you must enter the username and password in the Domain Credentials section.

If you have multiple domains selected, every one must have its credentials filled in before you can create the inventories. If any of the selected domains are missing credentials, a message at the top of the Inventory Wizard says that the required credentials are missing and the Finish button is greyed out.

- Whether to remember the username and password - if you check the Remember username/password check box, you won't have to enter domain login credentials for any future domain access operations.

When you have finished editing the Inventory Wizard, you can click the Finish button to create the inventories. A progress indicator tracks the progress as the inventories are created.

The successful completion of the Inventory Wizard results in:

- A new Domain Inventory editor is opened in the Document Pane for each domain you selected.
- The Domain Explorer is modified as follows:

- If you checked the Remember username/password check box, the domain node icon is decorated to indicate that the login credentials have been persisted.
- A new Domain Inventory entry is added to the Inventory History folder for each domain you selected.

#### Related Tasks

- Activate Domain
- Create Shortcut

#### Related Reference

- Domain Explorer
- Active Domains Table
- Domain Activation Wizard
- Domain Inventory
- Document Pane
- Keyboard Shortcuts
- Main Toolbar
- Main Menu

### Shortcut Wizard

The Shortcut Wizard enables you to create a shortcut.

There are several different ways to invoke the Shortcut Wizard:

- Press "Ctrl+Shift+S".
- Click the Add Shortcut button in the Shortcuts Table toolbar.
- Select New > Shortcut from the File menu.
- Right-click inside the Shortcut Explorer and select Add Shortcut.

The Shortcut Wizard contains the following data entry fields:

- The domain to evaluate - click the domain you want to evaluate. Each shortcut can only evaluate one domain and one bundle at a time. Please note that any domain selected with the Domain Explorer or Active Domains Table active when the Shortcut Wizard is invoked will be preselected already.
- The bundle to evaluate - for each domain, you can select one bundle to evaluate. The Default Signatures bundle is selected by default. To change the bundle, click the bundle name and select a different bundle from the drop down list.
- The shortcut name - when you check the Create Shortcut check box, a default shortcut name is created in the text box next to it. The default shortcut name is in the form, "<bundle name> in <domain name>". You can change the shortcut name by editing the text box.

When you have finished selecting the bundle, domain, and shortcut name, you can click the Finish button to create the shortcut. The successful completion of the Shortcut Wizard results in:

- The shortcut is added to the list of shortcuts in the Shortcut Explorer.
- The shortcut is added to the list of shortcuts in the Shortcuts Table.

Double clicking the shortcut name in the Shortcut Explorer or Shortcuts Table invokes the Shortcut Evaluation Wizard with the domain and bundle for that shortcut already selected.

#### Related Tasks

- Create Shortcut
- Delete Shortcut

#### Related Reference

- Shortcuts Table
- Shortcut Explorer
- Domain Explorer
- Active Domains Table
- Bundle Details
- Shortcut Evaluation Wizard
- Keyboard Shortcuts
- Main Menu

### Shortcut Evaluation Wizard

The Shortcut Evaluation Wizard enables you to evaluate a domain with fewer steps than it would take using the Evaluation Wizard.

You can invoke the Shortcut Evaluation Wizard in any of the following ways:

- Double-click a shortcut in the Shortcuts Table.
- Double-click a shortcut in the Shortcut Explorer.
- Right-click a shortcut in the Shortcut Explorer and select Evaluate Shortcut from the pop-up context menu.

The Shortcut Evaluation Wizard opens with the domain and bundle specified in the shortcut preselected.

You can change the bundle, but only for the current evaluation. The bundle for that shortcut will remain unchanged for future invocations of the Shortcut Evaluation Wizard.

If you checked the Remember username/password check box when activating or modifying the domain, the username and password are already filled in. Otherwise, the domain is displayed in italics, and you must enter the username and password in the Domain Credentials section.

If you check the Remember username/password check box, you will not have to enter domain login credentials for any future domain access operations.

When you have finished editing the Shortcut Evaluation Wizard dialog box, you can click the Finish button to launch the evaluation. A progress indicator tracks the progress as the evaluation executes.

The successful completion of the Evaluation Wizard results in:

- The Progress View shows the time it finished for each domain evaluated.
- A new Evaluation Summary is opened in the Document Pane.
- The Domain Explorer is modified as follows:

- If you checked the Remember username/password check box, the domain node icon is decorated to indicate that the login credentials have been persisted.
- The Evaluation Summary is added to the target domain's Evaluation History folder for each domain evaluated.
- A new Domain Inventory entry is added to the Inventory History folder for each domain evaluated.

#### Related Tasks

- Evaluate Shortcut
- Activate Domain
- Create Shortcut

#### Related Reference

- Evaluation Wizard
- Shortcuts Table
- Shortcut Explorer
- Domain Explorer
- Domain Activation Wizard
- Evaluation Summary
- Document Pane

### Support Case Wizard

The Support Case Wizard gathers the information needed to create a BEA support case. You can either connect to BEA to open an actual support case now, or save the case information in a Case Creation Archive to open a support case later.

To invoke the Support Case Wizard, click the Get more help from BEA support link in an Evaluation Summary. You can create a support case in response to any signature that is detected in an evaluation.

You can open an Evaluation Summary either by performing an evaluation, or by double-clicking the Evaluation Summary entry in the Domain Explorer.

The Support Case Wizard uses a sequence of dialog boxes to gather the information needed to open a support case and enable a BEA support engineer to begin working on it. The Support Case Wizard steps are:

- Select Server Node - identify the server node on the domain that has the detected signature. If the node preselected in the dialog box is not the correct one, then you can change it by selecting an item from the pull down list. If there is only one server in your domain, then the Administration Server is used by default and this step is skipped.
- Support Case Notes - add any additional text that you feel may help resolve the support case sooner in the Additional Case Notes section. The Default Case Notes section already contains the text from the Evaluation Summary's description and remedy sections.
- Select Case Attachments - specify which background materials to send to BEA, for example, the server log or the domain configuration file. Each signature includes a list of attachments needed to resolve the case. Some, such as the Domain Inventory, are required to create a support case. They are listed in the Case Attachments section and cannot be unselected. Others, such as the Server Log, are optional. They are listed in the Recommended Attachments section and are selected by default, but can be unselected.

If you feel additional attachments would help in resolving the support case sooner, you can add them to the Other Attachments section by clicking the plus sign icon and navigating to the attachment you want to add.

By submitting these background materials now, you save the BEA support engineer from having to contact you to get the same information later. This saves time in getting your support case resolved sooner.

- Domain Login - enter the username and password to login to the domain and get the case attachments specified in the previous step. If you checked the Remember username/password check box when activating or modifying the domain, the username and password are already filled in. If you check the Remember username/password check box, you won't have to enter domain login credentials for any future domain access operations.
- Select Case Destination - select whether to connect to BEA and create a support case now, or save the case information as a Case Creation Archive, and create a support case later. Saving the case as a Case Creation Archive may be useful for people who are not connected to the Internet and need to send it to BEA from a different machine.

If you choose to save the case as a Case Creation Archive, you must select a folder in which to save it. BEA recommends using the data/<domain node>/Case Creation Archives folder in the Guardian Workspace location you specified when you started Guardian.

- eSupport Login - enter your BEA eSupport username and password. This enables Guardian to log in to the eSupport website to get your list of available eSupport site identifiers and create the support case. If you select the Remember username/password check box, you won't have to enter your eSupport login credentials for future support cases.
- Select eSupport Site Id - if you have more than one eSupport site identifier, select the one to use for this support case. This step is skipped for most customers who have only one site identifier.

The successful completion of the Support Case Wizard results in:

- The Case Creation Complete dialog box gives you the support case number, date, and time of creation. The time includes the time zone of BEA's eSupport website. BEA recommends saving the case number to aid in future correspondence with BEA.

Once the case has been created, it is treated like any other BEA support case. But, because the Support Case Wizard included attachments specific to the case and optional notes from you, BEA's support engineers can analyze it more efficiently.

If you earlier elected to save the case as a Case Creation Archive instead of connecting to BEA, the Case Creation Complete dialog box displays the date, time, and location of the archive file.

- The Progress View shows the local time that the case was created.
- After the case has been created, the Evaluation Summary is updated with either the BEA support case number, or the name of the Case Creation Archive. The Get more help from BEA support link is no longer available.

#### Related Tasks

- Submit Support Case
- Activate Domain
- Create Shortcut

#### Related Reference

- Evaluation Summary
- Domain Explorer
- Domain Activation Wizard
- Domain Properties

### Update Wizard

The Update Wizard downloads and installs new signatures and application features from the BEA Guardian update web site, http://guardian.bea.com/.

There are several different ways to invoke the Update Wizard:

- Press Ctrl+Shift+U.
- Click the Update button on the Main Toolbar.
- Select Manage Guardian > Update Guardian from the Help Menu.

The Update Wizard uses a sequence of dialog boxes to gather the information needed to download and install new signatures and application features. The Update Wizard steps are:

- eSupport Login - enter your BEA eSupport username and password to access the Guardian update site. If you select the Remember username/password check box, you won't have to enter your eSupport login credentials for future updates.
- Select eSupport Site Id - if you have more than one eSupport site identifier, select the one to use for this update. Most customers only have one site identifier.
- eSupport Login - enter your BEA eSupport username and password again to access the Guardian update site.
- No updates for the currently installed features - if there are no new signatures or application features available, a dialog box suggests you try again later. BEA adds new signatures and application features to the Guardian update site when they are ready for customer use.
- Search Results - if there are new signatures or application features available, select which ones to install. All of them are selected by default, but you can expand the check box to select specific updates.

Guardian signature updates are grouped under the Guardian Signatures heading, Guardian application feature updates are grouped under the Guardian heading. Select the check boxes next to the signature and application feature updates you want.

- Feature License - click the radio button indicating that you accept the terms in the license agreement.
- Installation Location - you can change the installation location for each signature and application feature update, but BEA recommends using the default location. A progress indicator tracks the progress as the updates are downloaded.
- Feature Verification - once the updates are downloaded, click the Install All button to integrate all the signature and application feature updates into Guardian in one step.
- Restart Guardian - once all the updates are installed, click the Yes button to restart Guardian. When Guardian restarts, all the new signatures and application features you downloaded will be available.

#### Related Tasks

- Automatically Update Guardian

#### Related Reference

- Keyboard Shortcuts
- Main Toolbar
- Main Menu

## Log Files

The BEA Guardian Log Files contain information that is typically only needed by BEA in the unlikely event of an exception. One situation where you may want to view a log file is running command line scripts and automatically scanning the signature.log for detected signatures.

The Guardian log files are:

- `guardian.log` - located in the guardian installation directory you specified during installation. Contains information about every operation the Guardian application performs.
- `signature.log` - located in the guardian installation directory you specified during installation. Contains information about each evaluation performed.
- `.log` - located in the .metadata subdirectory of the Guardian Workspace directory you specified when starting Guardian. Contains information about certain Guardian operations.
- `install.log` - located in the configuration/org.eclipse.update subdirectory of the Guardian installation directory you specified during installation. Contains information about the Guardian installation itself.

#### Related Reference

- Signature Log File
- Guardian Log File

### Signature Log File

A Signature Log File, signature.log, is located in the guardian installation directory you specified during installation. It contains information about each evaluation performed.

#### Related Reference

- Log Files
- Guardian Log File

### Guardian Log File

The Guardian Log File, `guardian.log`, is located in the guardian installation directory you specified during installation. It contains information about every operation the BEA Guardian application performs.

#### Related Reference

- Log Files
- Signature Log File

## Command Line Interface

The BEA Guardian Command Line Interface is accessed with a Windows Command Prompt window or a Linux terminal window. The Guardian command interpreter is an executable .cmd batch file for Windows, and a .sh shell script for Linux. Both the Windows batch file and the Linux shell script are wrappers that accumulate and organize arguments to the Java command.

To use the Guardian Command Line Interface, run the guardianHeadless.cmd (for Windows) or guardianHeadless.sh (for Linux) executable file which was placed in the installation directory you specified when you installed Guardian.

If you have not previously set your Guardian Workspace location when starting the Graphical User Interface, the Guardian Command Line Interface will use a default Guardian Workspace location, unless you specify otherwise in each command. The default Guardian Workspace location is in your home directory; for example, C:\Documents and Settings\<username>\guardianWorkspace for Windows, and /home/<username>/guardianWorkspace for Linux. If you have previously set your Guardian Workspace location, the Guardian Command Line Interface will use that location for all its operations, unless you specify otherwise in each command. Identifying the Guardian Workspace location is essential for accessing the correct set of active domains, Domain Inventories, and Evaluation Summaries.

The Guardian Command Line Interface accepts a variety of commands that perform almost every task available with the Graphical User Interface. To see a list of the commands available and their syntax, type guardianHeadless -ghelp at the operating system command prompt. Please note that the Guardian Command Line Interface commands are case sensitive.

The output of each command is not sent to the console window. Instead, it is sent to the output file, headless_output.txt. The output file created in your current directory, and is overwritten each time you run it.

Also note that each command must have a prefix of `-g`, as shown in the examples below. Please pay special attention to the spacing, the arguments that require quotes, and the case sensitivity.

Examples:

- guardianHeadless.cmd -glistActiveDomains
- guardianHeadless.cmd -gactivateDomain -t http://localhost:9116 -u un -p pw -c true -data "D:\MyData\Guardian Data Directories\Installer-2079"
- guardianHeadless.cmd -gcreateShortcut -d Naxos_localhost_9116 -b 2
- guardianHeadless.cmd -gdeleteShortcut -s "Security Advisories in Naxos"

The following table describes each Guardian command. After that is a syntax description for each command.

Command | What It Does
activateDomain | Activates the domain specified to prepare it for evaluation and returns the domain identifier.
createShortcut | Creates a shortcut for the domain and bundle specified to save keystrokes in conducting evaluations.
deactivateDomain | Removes the domain specified from evaluation eligibility.
deleteShortcut | Deletes the shortcut specified.
evaluateDomainBundle | Evaluates the domain and bundle specified. Use the Graphical User Interface to see the evaluation results.
evaluateShortcut | Evaluates the domain and bundle associated with the shortcut specified. Use the Graphical User Interface to see the evaluation results.
help | Displays usage information.
listActiveDomains | Lists the active domains available for evaluation in domain identifier format.
listBundles | Lists the bundle identifier and bundle name of the bundles available for evaluation.
listShortcuts | Lists the shortcuts available for evaluation.
script | Executes the commands contained in the script file specified.

The following list gives the syntax for each command that accepts arguments. Optional parameters are enclosed in square brackets:

- activateDomain -t targetUrl -u username -p password [ -c persistCredentials ] [ -data workspaceDir ]

- targetUrl: the http://listen-address:port-number format address of the domain's administration server (not in quotes)
- username: administrator account username for the specified domain
- password: administrator account password for the specified domain
- persistCredentials (true or false, without quotes): whether to persist the username and password in encrypted form (default = false)
- workspaceDir: the full directory specification, in quotes, of the location of the Guardian Workspace

- createShortcut -d domainId [ -b bundleId ] [ -s shortcutName ] [ -data workspaceDir ]

- domainId: the domain identifier for the shortcut
- bundleId: the bundle identifier for the shortcut (default = 0, which is the identifier for the bundle named, "Default Signatures"). The values for all the bundles can be found with the listBundles command.
- shortcutName: the name of the shortcut in quotes (default = "<bundle name> in <domain name>")
- workspaceDir: the full directory specification, in quotes, of the location of the Guardian Workspace

- deactivateDomain -d domainId [ -l deleteUserData ] [ -data workspaceDir ]

- domainId: the domain identifier of the domain to deactivate
- deleteUserData (true or false, without quotes): whether to delete the Domain Inventories and Evaluation Summaries from the Guardian Workspace (default = false)
- workspaceDir: the full directory specification, in quotes, of the location of the Guardian Workspace

- deleteShortcut -s shortcutName [ -data workspaceDir ]

- shortcutName: the name of the shortcut to delete, in quotes, as shown with the listShortcuts command.
- workspaceDir: the full directory specification, in quotes, of the location of the Guardian Workspace

- evaluateDomainBundle -d domainId [ -b bundleId ] [ -u username -p password ] [ -c persistCredentials ] [ -data workspaceDir ]

- domainId: the domain identifier of the domain to evaluate
- bundleId: the bundle identifier for the shortcut (default = 0, which is the identifier for the bundle named, "Default Signatures"). The values for all the bundles can be found with the listBundles command.
- username: administrator account username for the specified domain (not required if persistCredentials set to true in activateDomain)
- password: administrator account password for the specified domain (not required if persistCredentials set to true in activateDomain)
- persistCredentials (true or false, without quotes): whether to persist the username and password in encrypted form (default = false)
- workspaceDir: the full directory specification, in quotes, of the location of the Guardian Workspace

- evaluateShortcut -s shortcutName [ -u username -p password ] [ -c persistCredentials ] [ -data workspaceDir ]

- shortcutName: the name of the shortcut to evaluate in quotes
- username: administrator account username for the specified domain (not required if persistCredentials set to true in activateDomain)
- password: administrator account password for the specified domain (not required if persistCredentials set to true in activateDomain)
- persistCredentials (true or false, without quotes): whether to persist the username and password in encrypted form (default = false)
- workspaceDir: the full directory specification, in quotes, of the location of the Guardian Workspace

- help
- listActiveDomains [ -data workspaceDir ]

- workspaceDir: the full directory specification, in quotes, of the location of the Guardian Workspace

- listBundles [ -data workspaceDir ]

- workspaceDir: the full directory specification, in quotes, of the location of the Guardian Workspace

- listShortcuts [ -data workspaceDir ]

- workspaceDir: the full directory specification, in quotes, of the location of the Guardian Workspace

- script -f scriptname [ -data workspaceDir ]

- scriptname: the name of a script file containing Guardian commands. Each command has to be on a separate line. See Running Scripts for more information.
- workspaceDir: the full directory specification, in quotes, of the location of the Guardian Workspace

### Using Scripts

Scripts enable you to perform several Guardian tasks by issuing a single command in the Guardian Command Line Interface. You can schedule scripts to run at specified times and intervals by using utilities such as the Windows Task Scheduler or the Linux `crontab` command.

Here is an example of a script (activate.txt) that activates several domains:

`activateDomain -t http://slp7:7001 -u un -p pw -c true
activateDomain -t http://slp8:7001 -u un -p pw -c true
activateDomain -t http://sqa-lldev:4044 -u un -p pw -c true
activateDomain -t http://slg-lldev:7001 -u un -p pw -c true
activateDomain -t http://slg-lldev:4401 -u un -p pw -c true
activateDomain -t http://mj23:32292 -u un -p pw -c true`

To run this script, enter the command:

    guardianHeadless -gscript -f activate.txt

Here is an example of a script (evaluate.txt) that evaluates several domains:

`evaluateDomainBundle -d guardian-dev_slp7_7001 -b 1
evaluateDomainBundle -d guardian-dev_slp7_7001 -b 2
evaluateDomainBundle -d guardian-dev2_slp8_7001 -b 0
evaluateDomainBundle -d guardian-qa_sqa-lldev_4044
evaluateDomainBundle -d guardian-domain_slg-lldev_7001 -b 1
evaluateDomainBundle -d guardian-domain_slg-lldev_7001 -b 2
evaluateDomainBundle -d guardian-domain_slg-lldev_4401
evaluateDomainBundle -d mydomain_mj23_32292`

To run this script, enter the command:

    guardianHeadless -gscript -f evaluate.txt

To review the results of script evaluations, use the Guardian Graphical User Interface. The Domain Explorer Evaluation History folder contains an Evaluation Summary for each evaluation performed.

### Scheduling Scripts

To schedule a script to run automatically at a specified time, you can use utilities such as the Windows Task Scheduler or the Linux crontab command. For example, to schedule the evaluate.txt script, you would schedule the command:

    guardianHeadless -gscript -f evaluate.txt

### Receiving Notifications

To receive notification of detected signatures, create an evaluation script and use the Windows Task Scheduler or the Linux crontab command to schedule the script to run at regular intervals. Each time the script runs an evaluation, the signature.log file in the Guardian installation directory is updated with an entry that tells whether the signature was detected or not. You can set a third party management tool to scan that log for detected signatures and notify you when one is found.

Each signature.log entry starts with four number signs (`####`) and includes a time stamp. Each entry with a detected signature contains `<detected>` and is followed by a brief description which is also surrounded by < >. The description includes the domain name. Following is a sample signature.log file:

`####<Tue Aug 01 16:03:47 EDT 2006> <0> <g-dev_slp7_7001> <un> <0> <000022> <not detected> <Signature 000022 (Rotational Upgrade may cause java.io.StreamCorruptedException) not detected by username un evaluating bundle ID 0 in domain ID g-dev_slp7_7001.>
####<Tue Aug 01 16:03:47 EDT 2006> <0> <g-dev_slp7_7001> <un> <0> <000027> <detected> <Signature 000027 (Native IO should be enabled in production mode for better performance) detected by username un evaluating bundle ID 0 in domain ID g-dev_slp7_7001.>
####<Tue Aug 01 16:03:47 EDT 2006> <0> <g-dev_slp7_7001> <un> <0> <000055> <not detected> <Signature 000055 (JDK 1.5 is not certified for WebLogic 8.1) not detected by username un evaluating bundle ID 0 in domain ID g-dev_slp7_7001.>`