ORAC Programmer Documentation

Name

orac_dba.pl - the Main Oracle module of the Orac tool

DESCRIPTION

This module sets up the program, by pulling in the required modules, setting up menus, providing the main screen, setting up global variables and giving the other modules a small library of utility functions.

back_orac

Backs out of program as nicely as possible, and saves any chosen options in the main configuration file.

fill_defaults

Picks up the users required defaults for the screen appearance, database requirements etc.

get_connected

Puts up the main dialogue to pick a new database. Allows user to change database type, if they wish. Also, sets flag to help prevent connection error messages, except on the last attempt at connection.

connector

Actually attempts the DBI database connection.

select_dbtyp

User may either be picking default database type for the first time, or changing database type. Either way, this builds up a dialogue to allow them to do this.

get_dba_user

Picks up the typical DBA user for the particular database.

get_db

Picks up database, and then configures menus accordingly.

bz

Makes the main GUI pointer go busy.

ubz

Makes the main GUI pointer go Un-busy.

bc_upd

Change the background colour on all open windows. This is where all those text and window handles come in useful.

read_language

Open up the main configurable language file, and pick up all the strings required by Orac.

get_language_data

Opens up the main configurable language file, and picks up all the strings required by Orac.

read_language_file

In the series of functions that will be modified at some unspecified date in the future, to make Orac natural language independent.

config_menu

Reads the database dependent menu configuration file, and build up menus. This function gets pretty complex, and a strong drink may be required beforehand, before attempting to work out what it is doing :)

Jareds_tools

Builds up the 'My Tools' options, where Orac users can specify their own local SQL files to generate Orac-like reports.

save_sql

Picks up the SQL the user has entered, and saves it into the appropriate file.

ed_butt

Allows configuration of 'My Tools' menus, buttons, cascades, etc. Tries to make the setting up of new buttons, cascades etc, as painless as possible.

config_Jared_tools

More functionality required to allow on-the-fly configuration of the 'My Tools' options.

This function is fairly overloaded, and may require some detailed analysis, before it becomes clearer what it's doing.

My apologies to those who may want to re-write this, and provide something much neater.

sort_this_file

Configures and sorts the users generated SQL reports buttons.

run_Jareds_tool

When user selects their own button, run the associated report.

del_Jareds_tools

If the 'My Tools' menu currently exists, then destroy it. This helps regenerate ``fresh'' menus, as required.

iconize

Take a Window handle, and tie an icon to it.

pick_up_defaults

This allows user to select main database type. Also allows selection of pre-defined background colour. Assign some pre-defined values in case the config file not yet available.

BEGIN

Special functionality to isolate acceptable errors, depending on database type, and place other errors into readable GUI windows for ease of debugging/reading by users.

Questions or Comments? kkitts@his.com