Description:
- Field is NOT changeable
- DA enforces the default directory for all custom menus
Best Practise:
n/a
Example(s):
UNIX: DA_HOME/output/menus
WINDOWS: DA_HOME\output\menus
Top
Description:
- Enter a menu filename
- Must include .xml file extension
Best Practise:
- Name should describe the menu purpose and remove any ambiguity
Example(s):
exadata_hang.xml
oracle_database_performance.xml
Top
Description:
- Enter the purpose of the menu
- Value is displayed at the top of the menu and used in the documentation
Best Practise:
- Have init caps
- Limited to 60 characters
Example(s):
SQL Tuning Utility - SQLTXPLAIN
DA Updates For DB Support Tools, And Other Plugins
Top
Description:
- Enter EM target(s) that align with the intent of this menu
- Multiple entries are entered using comma(s) to separate
- Currently this is a free-form field - no list of values exists
Best Practise:
- Ensure the target name matches EM target list exactly as DA discovery depends on this
Example(s):
oracle_database
host, oracle_ebs
Top
Description:
- Enter the components that are required, including their respective minimum version requirement
- Validation is done on these fields to ensure the end-user has the minimum requirements to
successfully execute your menu
Best Practise:
- DA should always be included
- RDA should be included if your menu includes RDA collections
Example(s):
Name: DA Version: 2.4.0
Name: RDA Version: 8.04
Top
Description:
- Enter a reference to call the menu from within the menu mapping section
Best Practise:
- Limit to no more than 20 characters long
- Reflect menu purpose for easier identification when selecting for map
Example(s):
main
InstallHCVE
SrPkg
Top
Description:
- Enter short description of menu's purpose
Best Practise:
- Use init caps
- Limit to no more than 60 characters long
Example(s):
Oracle Database Diagnostics
Health Check Assessments
Package, Upload Diagnostic Files
Top
Description:
- Comprised of 3 sections
1) Description
- Short explanation describing the purpose of the menu, including when to use
2) Options
- Enter the options available on this menu
3) Navigation Bar
- Common navigation available to all menus
Best Practise:
- Description
o Full sentence structure using proper grammar and spelling
o Limit to 6 - 80 character lines
o End with a blank line
- Options
o Start section with ‘Select one of the following options:’
o Prefix with a sequential number encased in ‘()’ followed by a space
o Limit to no more than 40 characters long
o Begin with a capital letter (init caps is optional)
o End with a blank line
- Navigation Bar
o For all sub-menus:
(M)ain (B)ack (H)elp (E)xit
o For 'main' menu:
(P)ackage (U)pload (H)elp (E)xit
Example(s):
'main' Example(s):
The Diagnostic Assistant Host target menu enables targeted troubleshooting
and gathering of relevant diagnostics.
Select one of the following options:
(1) Standard Collections
(2) Advanced Collections
(P)ackage (U)pload (H)elp (E)xit
Sub-menu Example(s):
The Diagnostic Assistant Host Target Standard menu includes basic, all
encompassing diagnostic tests to help narrow down the issue.
Select one of the following options:
(1) Health Check / Validation Engine [HCVE] tests
(2) Operating System and Networking tests
(3) Oracle related issue
(M)ain (B)ack (H)elp (E)xit
Top
Description:
- Maps each option defined in the 'Menu Display Text' Options section to a menu or command
- Use the drop-down list to add or remove a map entry
- Comprised of 3 sections
1) Mapping Sequence
- Enter number that corresponds to the option in the 'Menu Display Text' field
- Enter 'B' to map to the previous menu
- Enter 'M' to map back to the top-level ('main') menu
2) Mapping Type
- Enter 'menu' or 'command'
3) Mapping Reference
- Enter menu name or command name to be executed
- Use the drop-down list to select an existing menu or command
Best Practise:
1) Mapping Sequence
- Complete this field once all mapping have been entered
- This will avoid having to re-enter when new maps are added
2) Mapping Type
- n/a
3) Mapping Reference
- If a new menu or command is needed, define it first using the 'Create Menu'
or 'Create Command' button, then map it
Example(s):
1:command:rda_OS
2:command:rda_sos
3:menu:OSWatcher
B:menu:advanced
M:menu:main
Top
Description:
- Enter information to clarify menu options and usage
- Should include a title, pre-information, options description and post-information
Best Practise:
- Title
o Start with parent menu title + ‘:’ + current menu title + ‘Help’
- Pre-information
o Provide preface information that expands on the 'Menu Display Text' description
o Use proper grammar and spelling
o End with a blank line
- Options description
o Start with ‘Explanation of available options:’ followed by a blank line
o List all options included in the menu text
o Describe the option including any required inputs (remove all ambiguity)
o Provide enough detail so the user can knowledgeably choose to proceed with that menu
or collection, including list of command inputs
o End with a blank line
- Post information
o Optional
o Use this section to add links to notes, general information, etc.
Example(s):
Oracle Diagnostic Assistant Host Target Standard Menu
The Diagnostic Assistant Host Target Standard menu includes basic, all
encompassing diagnostic tests to help narrow down the issue.
Explanation of available options:
(1) Health Check / Validation Engine [HCVE] tests
o This option shows a menu of available pre-installation healthcheck
assessments using the HCVE
o Healthcheck Assessments are performed by the HCVE and the HCVE rule
engine is a tool that runs inside Remote Diagnostic Agent Framework
o The purpose of HCVE is to provide a generic engine to execute
assessment checks for customers and on the Oracle server side
environment using very abstract rules provided by the product experts
(2) Operating System and Networking tests
o Executes the RDA OS and NET modules
o No inputs required
(3) Oracle related issue
o Executes Oracle Generic RDA modules
Top
Description:
- Enter a reference to call the command from within the menu mapping section
Best Practise:
- Prefix with '<command type>_' (see 'Extended Command Help' for command type help)
- If command is a pre-requisite type, prefix with 'PREREQ_'
- Avoid numbers as references - use short identifiers instead
Example(s):
rda_onet
sql_XTRACT
PREREQ_LOV_list_all_updates
Top
Description:
- Enter short description of command's purpose
Best Practise:
- Use init caps
- Limit to no more than 35 characters long
- Do NOT include the 'command type'
Example(s):
Oracle Net Information
SQL Trace: XTRACT
List all tools LOV
Top
Description:
- Select from the list of values
- 2 types of commands can be defined
PreRequisite
List of values
'Command Name' is prefixed with 'PREREQ_'
Option selected feeds into a subsequent Pre-Requisite or standard command
Behavior is similar to a prompt
Standard
Executes one of the pre-defined command types
This is where the prompts get passed into the command
- Standard command type brief description:
For more details, see 'Extended Command Help'
Command Type = Adr --> Performs calls to adrci
Command Type = File --> Used as a wrapper class to File collection and filtering
Command Type = Java --> Used as a wrapper class to run any java class that are
found in any of the jars in the DA_HOME/lib/custom directory
Command Type = Ocm --> Performs calls to emCCR to run, setup and collect OCM
Command Type = OS: --> Enables the running of shell scripts
Command Type = Rda --> Performs calls to rda.sh/rda.cmd
Command Type = Sql --> TBD
Command Type = Sqlplus --> Supports sqlplus for Unix and PC for connecting with a
username and password. Both Unix and windows also work with
connect / as sysdba as long as ORACLE_SID is set
Command Type = System --> Performs predefined actions -- internal to DA
Command Type = Wls --> Used as a wrapper class to wls related java and specialized
WLS commands from the command line
- If a new command type is needed, log an enhancement request in the bug database to product=1330,
component=DIAGASSIST
- The drop-down list is case-sensitive and displays as code expects it
Best Practise:
- n/a
Example(s):
see Command Argument
Top
Description:
- Comprised of 3 sections
1) Command Summary
- Explains the purpose of the command
2) Input Requirements
- List what inputs will be prompted for
3) Output Details
- Describe what is to be collected
- Optional: Include example
Best Practise:
1) Command Summary
- Start with 'Command Summary' heading followed by a blank line
- Describe in detail what the command does using proper grammar and spelling
- End with a blank line
2) Input Requirements
- Start with 'Input Requirements:' heading
- List each command prompt in prompt order using bullet format
- Describe input expected and any special instructions in sub-bullet format
under the command prompt
- If an input is optional, note it as such, otherwise all inputs will be
assumed to be required
- End with a blank line
3) Output Details
- Start with 'Output Details:' heading
- Describe what the user can expect to find in the output files – no surprises!!
- End with a blank line
Example(s):
Command Summary
Net Advisor is a tool that provides advice on resolving network layer
errors encountered using Oracle Net Services.
The tool assesses information produced in a network trace file. It notes
which naming methods were used in attempting to resolve a given service
name and provides an overview of the network configuration.
Input Requirements
o Full path to the network trace file
Output Details
o An overview of the network configuration
o Conflicts or issues in the network setup of the client
o Suggestions of what to check or which actions to take for the issues found
Top
Description:
- Prompt Attributes
o There are 3 attributes that contribute to describing a prompt: Type,
Required flag and Validation Match Type (all selected from a drop-down
list of values) and used for additional validation
o 'Type' options are:
STRING: Use when the input value expected in a string
NUMBER: Use when the input value expected in a number
PASSWORD: Use when the input value expected is a password
MULTICHOICE: tbd
- Prompt Definition
o Enter 'Prompt Reference|Instructions|Default Value'
- Prompt Reference includes up to 3 parts:
o Unique identifier for the prompt
o Format: 'prompt type.menu name.prompt name'
o If prompting for a pre-requisite, 'Prompt Reference' = pre-requisite command name
o Prompt Type
- There are 4 options for 'Prompt Type':
SAVE_ONCE Value saved in .../da/output/config/user.properties
Prompt only displays the first time it is called
Saved value is always inserted on subsequent calls without re-prompting
Use Admin, Manage Properties, Versions, Latest Collections menu to
update/reset the property
SAVE_REPEAT Value saved in .../da/output/config/user.properties
Prompt displays each time is is called, displaying saved value
Entry of new value replaces the existing saved value
SAVE_WALLET MUST have 'Allow Saving Passwords' flag set to TRUE
(navigate: Admin, Manage Properties, Versions, Latest Collections
--> 1 Manage Properties
--> 5 Allow/Disallow saving passwords)
Value saved in .../da/output/config/ewallet.p12 (Secure Oracle Wallet file)
Behaves like SAVE_ONCE - saved value will always be used without re-prompting
Use Admin, Manage Properties, Versions, Latest Collections menu to
update/reset the credential
NULL Value is not saved in the user.properties file
Value will be prompted each time it is called
Previous value will not be displayed
o Menu Name
- Optional
- Enter filename without the file extension
- Used to keep the prompt specific to a menu
- If not specified, all menus will have access to the value (if saved)
o Prompt Name
- Required
- Unique name identifying the value expected
- Instructions
o Provide instructions describing the value the prompt is expecting
- Default
o Optional
o Enter a default value to confirm the most common value or to give an example for the user
Best Practise:
- Prompt Reference
o Menu Name is strongly recommended to avoid confusion with other prompts having the
same prompt name
- Instructions
o Be precise in asking what information is needed
o Carriage returns are allowed to be as descriptive as needed
- Default
o If the prompt value is a discovered environment variable (logged in
output/config/daenv.sh), use %%<variable name>%%
Example(s):
Attribute Examples:
Type : PASSWORD Required : TRUE Validation Match : blank
Type : STRING Required : FALSE Validation Match : blank
Prompt Reference Examples:
SQL_ID|Enter the SQL_ID or HASH VALUE to analyze|
SAVE_REPEAT.ORACLE_DATABASE.RAC_ROOT_TIMEOUT|Enter the ORAchk execution timout (sec)|300
SAVE_WALLET.DBMACHINE.ROOTPASS|Please enter the ssh password for root|
ORACLE_ANALYTICS.ORACLE_PARENT|Enter the Oracle Middleware home to be used for data analysis|%%MW_HOME%%
PREREQ_ADR_HOME|Enter an ADR home by number|PREREQ_ADR_HOME:name
Top
Description:
- Enter the code to be executed for this command
- Depending on the command type, there may be pre-defined activities that may
be called here (i.e. 'run_module' can be called to run the specified RDA module)
- Platform
o When the command's argument detail differs based on platform (UNIX verses WINDOWS),
multiple arguments are needed, one for each unique platform code
o Use the '+' to add platform-specific arguments
o Platform specific command argument(s) will take precedence over the generic 'All'
platforms command argument
- Argument
o 2 types of commands can be defined
1) PreRequisite
- List of values
- 'Command Name' is prefixed with 'PREREQ_'
- Option selected feeds into a subsequent pre-requisite or standard command
- Behavior is similar to a prompt
2) Standard
- Executes one of the pre-defined command types
- This is where the prompts get passed into the command using '%%' delimeters
o
Best Practise:
- When using logic, encapsulate the arguments within <![CDATA[]]>
Example(s):
RDA command:
run_profile=WebLogicServer WLS_TYPE=ONE DO-MAIN=%%DOMAIN%% SERVERS=%%SERVERS%% USER=%%USER%% PASS=%%PASS%%
SQLPLUS command:
[[CDATA{ connect / as sysdba
REM SQL extracted from OCM oracle_database.xml
set pages 10000
prompt Archive Destination
select log_mode from v\$database;]]
Open any target menu within the DA_HOME/menus directory for more command examples
Top
Description:
- Used to group commands related by a common purpose
- The standard categories are based on the MOS Knowledge tasks:
Backup and Recovery (ID=backup)
Configuration (ID=config)
Install (ID=install)
Network (ID=network)
Patching (ID=patching)
Performance (ID=performance)
Upgrade (ID=upgrade)
Other (ID=default)
- Currently, no set list of values has been defined
- Sub-categories may be defined by prefixing with standard category
- From the 'Command Edit' UI, you can only enter the Category ID
- To edit and add 'Title' and 'Description' details, expand the 'Categories'
section on the left hand side of the UI and select the category
- To create a new category, click on an existing category to open the edit box
Click 'Create Category' button and enter details
Note: At least 1 category must exist to create new categories
You can either enter the category ID when entering a command and then edit with more details
Or create your menu using an existing fmenu file as the template -- they all include at least 1 category
Best Practise:
- Follow the standard categories for the top-level category IDs and Titles
- Name sub-categories as <parent_cat>.<sub-cat>
Example(s):
Navigation:
Expand Categories on left hand side to see available categories:
Configuration
HealthCheck Validation Checks (sub-category)
Networking Failures (sub-category)
Performance
Networking Failures
Click on 'HealthCheck Validation Checks' to view category details:
Category Title = HealthCheck Validation Checks
ID = configure.HCVE
Category Description = This performs a series of PreInstallation Validation rules against the OS
Top