DBA basics

This topic includes the following sections, which explain what the DBA program does, how to start it, and how to navigate the user interface.

What you can do with the DBA program
Starting DBA (xfdba)
Using menus
Using input windows
Using lists
Abandoning changes
Exiting DBA

What you can do with the DBA program

The DBA program enables you to view and customize some elements of the system catalog. It also enables you to verify a system catalog, generate a conversion setup file, and generate a system catalog that supports level-based users. The DBA features that are available to you depend on which type of user is supported for your system catalog: level-based or privilege-based. For information on user types, see Managing access with users, groups, and table settings.

DBA Feature Support
Feature	Supported with level-based users?	Supported with privilege-based users?	Notes
Generate system catalog	Supported	Not supported in DBA	You can use DBA to generate or regenerate a system catalog that supports level-based users. See Generating the system catalog.
Initialize users and groups	Supported	Not supported in DBA	You can use DBA to initialize level-based users and groups. See Initializing level-based users and groups.
Compare the system catalog to repository definitions (i.e., verify the system catalog)	Supported	Supported	See Comparing the system catalog to repository definitions.
Compare the system catalog to the database files	Supported	Not supported	See Comparing the system catalog to a database.
Generate a conversion setup file	Supported	Supported	See Generating and editing a conversion setup file.
View, add, modify, delete groups	Supported	N/A	For information on managing groups for level-based users, see Managing level-based users and groups. (Groups aren’t used for privilege-based users.)
View users	Supported	Supported	For level-based users you can view users and you can view a list of all users in a group. See Managing level-based users and groups. For privilege-based users, you can view a list of user names and their access levels (in the “GUID” column of the Users list), but nothing else. For other user information, you’ll need to query the GENESIS_AUTHS and GENESIS_USERS tables. See Managing privilege-based users and privileges.
Add, modify, delete users	Supported	Not supported in DBA	See Managing level-based users and groups.
View, add, modify, and delete tables	Supported	Supported	See Customizing tables and table elements.
View table columns	Supported	Supported	See Viewing columns in a table and Viewing information about a column.
Delete column	Supported, but not recommended	Supported, but not recommended	See Deleting a column.
View indexes and index segments	Supported	Supported	See Viewing indexes and index segments.
Delete index	Not supported	Not supported

For information on rebuilding DBA to replace the default processing DBA uses to interpret replaceable characters in Open filename fields, see Replacing the default USR_DD_FILNAM routine.

Starting DBA (xfdba)

To run DBA on a Unix system, you must have configured your session for the Synergy/DE runtime by sourcing setsde. For information, see Unix requirements.

To start DBA, do one of the following:

On Windows, from the Windows Control Panel select Synergy Control Panel, and then click the xfODBC DBA link.
On Windows or Unix, use the following syntax:

dbr SODBC_DBA:xfdba.dbr [option] [...]

On OpenVMS use the following syntax:

XFDBA [option] [...]

Options

You can use the following command line options when starting DBA. All are optional.

-c username/password/connect_filename

Specifies the username, password, and connect file. If you use this option, DBA opens the system catalog specified in the connect file. For information and examples, see Opening a system catalog from the command line.

-g conversion_setup_file

Generates a conversion setup file. Conversion_setup_file specifies the path and filename of the generated file. This setting overrides the SODBC_CNVFIL environment variable setting. For client/server configurations, the conversion setup file must be on the server. Valid only with -c.

-i

Initializes level-based user and group files to default values (i.e., restores default level-based users and groups). For information and examples, see Initializing level-based users and groups. Valid only with -c.

Do not use -i with a system catalog that supports privilege-based users. It will corrupt the system catalog.

-v verification_log

Creates a log that lists each table and compares stored counts with actual record counts. Verification_log specifies the path and filename of the generated log file. If you don’t specify a path, the log is saved to the current working directory. Valid only with -c.

Using menus

You can select a menu entry in DBA when the menu bar is active. To activate the menu bar on Windows, click the menu bar or press Alt. To activate the menu bar on Unix or OpenVMS, press Ctrl+P.

In addition to using the arrow keys to move across menu headings and among menu entries (and Enter to select a highlighted entry), you can use the following:

Quick-select characters. A quick-select character is a single character that accesses a menu or menu entry. When a menu is pulled down, you can type the quick-select character to select the menu entry. For example, if you press Alt, G, and then B, the About window opens.
Shortcuts. A shortcut is a key or key sequence associated with a menu entry—for example, F4 for Exit. You can use a shortcut any time the associated entry is valid; the menu does not have to be active. Shortcuts are different for each type of terminal. To view the shortcuts for your particular terminal, pull down any menu. Shortcuts are listed to the right of menu entries.

Using input windows

On Windows, Shift+Tab moves the cursor to the previous field in the current input window; Tab moves to the next field.

On Unix and OpenVMS, use the Up Arrow key or select Input > Previous Field or List > Previous Field to return to the previous field in the current input window. Use the Down Arrow key or select Input > Next Field or List > Next Field to move the cursor to the next field.

If a field is optional and does not have a default value, you can leave the field blank by pressing Enter. If an optional field has a default value, you can clear the field by pressing the spacebar or the Backspace key. Then press Enter to move to the next field.

To save your changes and exit the current input window or list, select General > Exit or use the Exit shortcut (F4). You are returned to the previous window or menu.

To exit an input window without saving any changes, select General > Abandon.

Using lists

To edit a list entry, highlight the entry and press Enter. If it can be edited, an input window opens. To exit a list, press F4.

In the Table List, you can search for an entry by selecting List > Find. An input window is displayed. Enter the name or partial name of the entry you wish to find. DBA highlights the first matching entry in the list.

In the Table List, columns or a portion of a column may extend beyond the edge of the window. To view hidden areas of the Table List, select List > Toggle View.

Abandoning changes

To restore the data in a field to its original state on Unix or OpenVMS (the state it was in before you typed anything), select Input > Reset Field.

To abandon changes to all fields, select General > Abandon. Data you entered in the current input window is discarded, the original data for that window is restored, and the window is closed. On Windows, the close button also abandons changes for the current input window.

Exiting DBA

To exit DBA, do one of the following:

Exit each input window and list until the main window is displayed. Then select General > Quit or press the Exit shortcut again.
To exit DBA immediately, click the close box for the application window (on Windows) or select General > Quit. DBA will quit regardless of the input window or list that’s currently open.