3 Basic Functions in the Design Console

This chapter describes how to use the basic features of the Design Console. Oracle recommends that you review this section before proceeding to other chapters of this guide.

This chapter contains the following sections:

Special Field and Form Types
Assignment Windows
Performing a Search

Special Field and Form Types

The actions of the basic features of the Design Console are standard for all forms. This section describes the standard actions of the Design Console and the field and window types in the Design Console main screen.

Data Fields

Data fields are display areas in forms that present information related to a specific record. For example, First Name can be a data field on the Users form.

The label of a field can be displayed in black or blue.

A black label indicates that this field is a standard field.

You can query, create, modify, or delete information in a standard field.
A blue label indicates that the data in this field is derived from a predefined list of values supplied by using a Lookup or a Date & Time window.

When you double-click this type of field, the applicable Date & Time window or Lookup window is displayed. You can then select a date, time, or a lookup value.

The value of a field can be displayed in black or red.

If the field value is displayed in black, then the data in this field is supplied by the user.

You can query or edit the information in these types of fields.
If the field value is displayed in red, then the data in this field is supplied by Oracle Identity Manager.

These values are read-only. This prevents you from overwriting critical information.

Lookup Fields

A lookup field enables you to search for a value. The following procedure describes how to use lookup fields.

To use lookup fields:

If the Lookup dialog box contains a short list of fields, click a field, then click OK.

Alternatively, you can select the field and press F4.

Click Cancel to close the Lookup window without selecting anything.

Figure 3-1 shows the Lookup dialog box.

Figure 3-1 Lookup Dialog Box

Description of "Figure 3-1 Lookup Dialog Box"
If the Lookup dialog box contains a long list of values, enter the first few characters of the value in the Find box, followed by an asterisk (*), and then click Search.

The Lookup dialog box displays the results that match your search.

Date and Time Fields

The Date & Time window enables you to select a month, year, day, and time. This window is displayed when you double-click a field that is equipped with a an option to open this window.

To select a date and time:

Double-click the field in which you want to enter a date and time.

You can also display the Date & Time window by selecting a field and pressing F4.

The Date & Time window is displayed.
From the menu, select the month.
From the Date scroll box, select the year.
Click the date on the calendar.
From the Time box, select the time.
Click OK to save your changes.

The Date & Time window closes. The field that you double-clicked in Step 1 now displays the date and time you selected.

Click Cancel to exit without saving.

List

Lists have predefined values. When you click a list, its values are displayed. If the list contains more values that can be displayed at one time, a vertical scroll bar is displayed to the right of the list.

When you select a value, the list is replaced by a field in which the selected value is displayed.

Notes Window

The Notes window enables you to enter supplemental information for a record. When used with adapters, this window also displays the code that the Design Console generated while compiling the adapter. For more information about adapters, see Oracle Identity Manager Tools Reference.

Note:

In the following procedure, if the Notes button is red, then the current record has a note. To view the note, click the button. You can enter supplemental information in this record. Each entry receives a unique date, time, and user stamp.

To use the Notes window:

1. Select the required record.
2. Click Notes.
  
  The Notes window is displayed.
3. Enter information in the text area of the Notes window.
4. Click the icon that represents a man to store your information in the Notes window.
  
  Or, click Close to close the Notes window without saving.
5. From the Toolbar, click Save.
  
  The information you entered into the Notes window is saved.

Tabs on Forms

Most forms in the Design Console contain multiple tabs. The tabs are usually in the bottom of the form. The tabs display additional information about a record, for example, the users who are employed at an organization, as shown in Figure 3-2.

Figure 3-2 Design Console - Tab on Forms

Description of "Figure 3-2 Design Console - Tab on Forms"

Each tab has its own tables and function buttons. Usually, the buttons on a tab are grayed out until the information in the upper portion of the form is saved. The table displayed in the tab enables you to view and edit the records associated with that tab item.

To modify information in a row of a tab's table, either double-click the field that contains the information you want to edit, or double-click the associated row heading.

Assignment Windows

The User Form Assignment windows enable you to select and assign entities to a record. The Assignment window is displayed when you click the Assign button.

The left pane lists items that you can assign to the record, for example, Organization. The right pane lists the items that have already been assigned to the record. Although the values available for selection in the left and right panes are unique to what is being assigned or unassigned, the buttons and general use of this dialog box are consistent throughout the application.

The following are methods for working with this window:

To select multiple unconsecutive items, hold down the Ctrl key while selecting items with the mouse.

For example, you can select the User Group, the IT Resource Type Definition object, and the Form Information object, but not the Process Definition object.
To select multiple items that are listed consecutively, hold down the Shift key and select the first and last items with the mouse.
To assign one or more items, select the item and click the right arrow.
To unassign one or more items, select them, and click the left arrow.

When you are done, click OK. If you click Cancel, all assignment changes are discarded.

Performing a Search

The Design Console enables you to perform searches (queries) for records in the database. Every form in the Design Console provides a search function. The search function is also available in lookup fields.

To conduct a search, click the binoculars icon on the toolbar.

Constructing a Search Filter

You can filter the search criteria in a form field. Filtering limits the results that are returned to only the records that match the criteria you entered. If you leave all form fields blank before conducting the search, all records in the table are returned.

You can use a wildcard character in a search. The asterisk (*) wildcard character represents unspecified portions of the search criteria. You can use a wildcard character at the beginning, middle, or end of the value that you enter in a field. For example, if you enter B* in the Location field of a Design Console form and execute a search, you retrieve all records with locations that begin with the letter B (for example, Burbank, Boston, Bristol, and so on). If the asterisk is placed in the middle of a search value, as in B*on, you retrieve all records that begin with B and end with ON (for example, Brighton, Boston, and so on). If you place the asterisk at the end of the search value, as in *A, you retrieve all records that end in A (for example, Philadelphia, Tampa, and so on).

In Figure 3-3, a query is performed on the Organizational Defaults form and the Organization Name field is used to filter the search criteria. The filter Statew* ensures that only organizations with names that begin with Statew are retrieved.

Figure 3-3 Displaying the Results of a Search Query

Description of "Figure 3-3 Displaying the Results of a Search Query"

Results of a Search

After you enter the search criteria in the query fields, click the binoculars symbol or press Ctrl+Q.

One of the following occurs:

No records are returned. No records in the database match your search criteria for this form. Either the record that you are searching for no longer exists in the database, or you must modify your search criteria.
One record is returned. One record in the database matches your search criteria. The Form view displays that record.
More than one record is returned. Multiple records in the database match your search criteria. A Table view is displayed, listing all records that meet your search criteria. The first record is displayed in the Form view, as shown in Figure 3-4.

Figure 3-4 Multiple Records Returned

Description of "Figure 3-4 Multiple Records Returned"

Working with a Set of Query Results

If multiple records in the database match your search criteria, you can view details about each record. Several buttons can assist you when viewing these records in the Form view. These directional buttons, referred to as VCR buttons, are located in the toolbar. The following table describes the VCR buttons:

Buttons	Description
Description of the illustration arr.gif	Click this button to display the first record in the result set in the Form view.
Description of the illustration rtarr.gif	Click this button to display the preceding record according to the display sequence in the Table view. The record is displayed in the result set in the Form view.
Description of the illustration ltarr.gif	Click this button to display the next record (according to the display sequence in the Table view) in the result set in the Form view.
Description of the illustration arr1.gif	Click this button to display the last record in the result set in the Form view.

Optimizing Query Performance

A query that returns a large result set can require significant time to run and can affect your computer's performance. To optimize performance, use the following search techniques:

Define the scope of a search strategy as precisely as possible.

Enter the most specific information that you can when constructing your query. For example, if the first name of a contact is JOHN and the last name is JACKSON, enter both pieces of information, rather than searching only for contacts with the last name JACKSON.
Use the asterisk (*) wildcard character where possible.

If you place the asterisk in front of an alphabetic character (for example, *A), fewer records are returned as compared to when you leave a field blank.

Exceeding the Limit for a Result Set

If you have both read and write access to all forms and records in the Design Console in the System Configuration form (that is, if you are a system administrator), you can set the maximum number of records that are displayed in the result set for a search. If the number of records retrieved for a search exceeds this value, the Design Console displays the Query size exceeded dialog box, as shown in Figure 3-5.

Figure 3-5 Query Size Exceeded Dialog Box

Description of "Figure 3-5 Query Size Exceeded Dialog Box"

You are prompted to enter a specific range or subset of the result set to be viewed. In Figure 3-5, the maximum result set of 100 has been exceeded. Only records 1 through 100 will be displayed.