Sun ONE Meta-Directory 5.1 Configuration and Administration Guide |
Chapter 18 Administration Tools
Meta-Directory comes with tools to help you find and fix entries that go unlinked as well as customize entry properties. This chapter contains the following sections:
The Query Tool
With the Query Tool, administrators can generate many types of searches including, but not limited to these:
- a search for all entries created in Meta-Directory in the last n hours
- a search for all entries from a connector view that are/are not joined into the meta view
- a search of statistics for joined, unjoined, or unassociated entries
- a search for all entries in a connector view that were not automatically joined into the meta view
The following sections provide procedures on accessing the Query Tool and constructing basic and extensive searches.
To Access the Query Tool
- Open the Meta-Directory console and right-click anywhere in the navigation tree.
- Choose Query from the context menu that appears.
The Query Tool opens. Alternatively, from the menu bar, open Tools and choose Query.
Searches
To request a search for entries within a meta view or a connector view specify search criteria using the tool's drop-down lists. The choices will complete the search request as follows.
Find all group choice in view choice that are associated in a particular way with an entry in view choice.
Note You can conduct an even more basic search by clicking on Fewer. This allows a search using only the first two drop-down lists.
To Do a Search
- From the Content Selection Filters drop down list ("Find all"), select the grouping you would like to search (entries, users, groups, or users and groups).
- From the Views drop-down list ("in"), select either a connector view or a meta view.
This menu shows all configured views in Meta-Directory.
- From the Linkage Selection Filters drop-down list ("that are"), select how you would like to perform your search.
The choices consist of the possible ways that entries can be linked. They include: unassociated with, joined with, joined manually with, joined automatically with, excluded from, able to delete, not able to delete, members with, or are non members with.
- From the Corresponding View drop-down list ("an entry in"), select the corresponding view.
If you selected meta view from the Views drop-down list, you will choose from participating connector views. If you selected a connector view from the Views drop-down list, your only choice will be the meta view.
- Click Search. The results appear in the bottom pane.
Extensive Searches
The Query Tool allows the administrator to build broader and more complex searches by clicking the More button and including or excluding entries in other meta or participating views.
To construct a more extensive search, build your query using the first two drop-down lists as many times as needed in the following form:
Find all group choice in view choice that are associated in a particular way with an entry in view choice [and/or that are associated in a particular way with an entry in view choice] [and/or that are associated in a particular way with an entry in view choice] [and/or that are associated in a particular way with an entry in view choice] et cetera.
You choose and or or to further refine the search request based on the variables that follow. The rest of the search request is constructed as described in "Searches". However, More can be clicked an infinite number of times, adding to the complexity of the search criteria.
Constructing a Search With an LDAP Filter
To construct a search using an LDAP filter entry, click Advanced from the Query Tool. A new field appears that enables you to enter an LDAP filter. The new LDAP filter query form is:
Find all group choice in view choice matching the LDAP filter {filter} that are associated in a particular way with an entry in view choice.
An LDAP filter or SQL Where clause can be entered in the new field; for example:
telephonenumber=4*
The rest of the query form is construct as described in "Searches".
Note The filter will be ignored if the data is not valid.
Customizing the Query Tool
The Query Tool window can be customized based on the administrator's needs. Right-click anywhere on the window to open a context menu, which provides the following customization options:
- View selected entry
- Customize column headers for meta view
- Customize content selection filters
- Customize linkage selection filters
The sections that follow provide procedures for customization.
Viewing a Selected Entry
This option lets you view and edit the properties of a chosen entry listed as the result of a search request.
- Select an entry from the list in the Query Tool dialog box.
- Right click in the Query Tool dialog box and select View selected entry from the context menu.
- Either the Edit Entry or Property Editor dialog box will appear. The Edit Entry box will appear if any of the following is true:
- Modify the fields in either dialog box as discussed in "The Property Editor".
- Click OK to return to the Query Tool.
Note For Database connectors only, the Property Editor is named the Database Entry Viewer. The Database Entry Viewer functions in the same way as the Property Editor.
Customizing Column Headers
The columns in the search result portion of the Query Tool can be customized by renaming, adding, or deleting the column headers.
- Right click in the Query Tool dialog box to open a context menu.
- Select Customize column headers for meta view to open the Customize Search Results Table.
- Select the object class from the Objectclasses column that includes the attribute you would like to chose as a column name.
- Select the attribute itself from the Allowed Attributes column. (Use the Control key to select more than one attribute.)
- Click Add to add the attribute selected.
The attribute you added now appears in the Attribute To Display field on the right side of the dialog box. For each attribute, you can enter a name in the Column Name field to represent the attribute. It is this name that will appear as the column header when you return to the Query Tool.
- Optional: Use the following buttons and checkbox as needed.
Click Remove to remove unwanted attributes displayed in the Attribute To Display field and return them to the Allowed Attributes list.
Click Move Up and Move Down to arrange attributes in the preferred order for your displayed headings. (Moving the column name up will move the column itself to the left.)
Click Save Globally to save the headers for everyone who accesses the system.
- Click OK.
The Query Tool dialog box reappears with the attributes and column names you specified. Clicking Search again will re-assemble your results based on the new columns.
Sorting the Display of Entries
You can sort entries resulting from the search request in accordance with the column labels that appear above the display of data. The labels function as a toggle; alternately sorting the data in ascending and descending order.
To sort the display, click a label. For instance, to sort entries by the meta view link, click MV Link. The sorting mark (a triangle pointing in the direction the column is sorted) appears beside MV Link in the column label.
To Specify Language Preferences
Meta-Directory provides dn, rdn, and rdtype attributes to allow language preferences. Each attribute supports only one language, so you could set one attribute's preferred language to Spanish (es), for example, while the default for all others is English (en). This entry might appear as shown in the following example:
dn: cn=Fred G. Garcia, ou=people, o=siroe.com
cn: Fred Garcia
cn;lang-es: Frederico Garcia
location: USA
location;lang-es: Los Estados Unidos
sn: Garcia
mail: Garcia@siroe.comSuppose that you set up in the Customize Search Results Table, the attributes and column names in Table 18-1. Any language can be used in the column names because the names are text strings of your choice. Some names appear in English; some are in Spanish. These column names are copied directly into the column headers in the search results table in the Query Tool dialog box.
Table 18-1    Column Specifications
Attribute
Column Name
sn
Last Name
cn
Whole Name
location
Country
Email Addresses
dn
Entry Name
rdn
Nombre
rdntype
Nombre Con Idioma
When you request a search, the Query Tool finds each qualifying entry and places its attributes in the correct columns based on your specifications in the Customize Search Results Table dialog box. The search results appear in the columns whose names are shown in Table 18-2.
Table 18-3 shows how the Query Tool decides the language subtype to choose.
Customizing Content Selection Filters
Content selection filters can be created or modified using this option. The entries added or edited in this window affect the selections available in the Query Tool Content Selection Filters drop-down list ("Find all"). The filters are used against the data in the entries of the context view (cn, sn, Location, Phonenumber, etc.).
Accessing the Content Selection Filters Window
- Right-click in the Query Tool dialog box to open the context menu.
- Select Customize content selection filters to open the Content Selection Filters dialog box.
To Create a New Content Selection Filter
- In the Content Selection Filters dialog box, click Create.
A default of NEW FILTER appears.
- Provide values for the following fields:
- Click OK to save changes and return to the Query Tool dialog box.
The new filter appears in the content selection filters drop-down list.
To Edit a Content Selection Filter
- In the Content Selection Filters dialog box, select an entry from the right pane.
The display name, associated ID and values for the meta view and connector view filters appear in the corresponding fields.
- Modify the information as needed.
- Optional: Use the following buttons and checkbox as needed.
Click Delete to remove the filter.
Click Move Up and Move Down to arrange filters in the preferred order for your content selection filters drop-down filter list.
Click Save Globally to save the filter for everyone who accesses the system.
- Click OK to save changes and return to the Query Tool dialog box. The changes are reflected in the content selection filters drop-down list.
Customizing Linkage Selection Filters
You can create or modify linkage selection filters using the Linkage Selection Filters dialog box. The filters you add or edit affect the selections available in the Query Tool Linkage Selection Filters drop-down list ("that are"). The filters in that list allow you to search for entries by their linkage information.
Accessing the Linkage Selection Filters Window
- Right-click in the Query Tool dialog box to open the context menu.
- Select Customize linkage selection filters to open the Linkage Selection Filters dialog box.
To Create a New Linkage Selection Filter
- In the Linkage Selection Filters dialog box, click Create.
A default of NEW FILTER appears in the list box at the right and in the Display Name field.
- Type the new filter's name in the Display Name field, and provide input for the remaining fields as described in "To Create a New Content Selection Filter".
- Click OK to save changes and return to the Query Tool dialog box.
Your new filter appears in the Linkage Selection Filters drop-down list.
To Edit a Linkage Selection Filter
- Select an entry from the list box at the right.
The display name, associated ID and values for the meta view and connector view filters appear in the corresponding fields.
- Modify the information as needed.
- Optional: Use the following buttons and checkbox as needed.
Click Delete to remove the filter.
Click Move Up and Move Down to arrange filters in the preferred order for your Linkage Selection Filters drop-down filter list.
Check Save Globally to save the filter for everyone who accesses the system.
- Click OK to save changes and return to the Query Tool dialog box. The changes are reflected in the Linkage Selection Filters drop-down list.
Query Tool Keyboard Shortcuts
The Query Tool provides a set of keyboard shortcuts. Table 18-4 provides a list of these shortcuts and what they do.
Table 18-4    Keyboard Shortcuts for Use With the Query Tool
Key Combination
Function
Ctrl-f
Launches the Fix-It Tool as discussed in "The Fix-It Tool".
Ctrl-h
Launches help.
Ctrl-l
Launches the Linkage Filters Editor dialog box.
Ctrl-m
Clicks the More button.
Ctrl-o
Launches the Content Selection Filters dialog box.
Ctrl-q
Exits the Query Tool.
Ctrl-s
Starts the search.
Ctrl-w
Clicks the Fewer button.
Ctrl-z
Launches the Customize Search Results Table dialog box.
Ctrl-space
Shows all of the currently selected entry.
Ctrl
Enables you to select entries one by one from the Query Tool search results table.
Shift
Enables you to select contiguous blocks of entries from the Query Tool search results table.
Enter
If search results are already displayed, launches the Fix-It Tool. If no search results yet, the search starts.
The Fix-It Tool
With the Fix-It Tool, you can create or delete manual links between entries when automated linking breaks. This allows an administrator to establish the linkages for hard to match entries or to review Meta-Directory's predetermined linking. You can also mark or unmark entries as excluded, and assign or remove ownership of an entry.
Accessing the Fix-It Tool
Select an entry from the search results table of the Query Tool and click Fix. The Fix-It Tool window appears showing attributes and values for the selected entry in the upper left hand corner. It's associated views and the partial DN of the selected entry (relative to the view's base DN) appears in the upper right hand corner. To view attributes and values for other source entries, click on the desired entry. The Fix-It Tool loads all the entries selected from the Query Tool dialog box.
Figure 18-1   
Fix-It ToolTo Link an Existing Entry to a New Entry
- Select the view entry for which you want to establish a link with a new entry.
- Click Create New Entry.
The New Entry DN Selector dialog box appears.
- Select a DN from the drop-down list (populated from your DN rules) or enter your own, and click OK.
Your input appears as a linked entry for the view you selected.
To Join, Unlink, or Exclude Entries
- Select an existing entry from the Views column.
- Click Candidates. The list of join candidates appears in the bottom pane, based on the join rules you have configured.
You can also expand the search criteria by doing the following:
Click on the triangle button below the Candidates button. A search panel appears that is preloaded with the search filter the join engine uses to retrieve join candidates. (The button is a toggle that closes the search panel when you click it again.)
Change the fields in the search panel as desired, and click Candidates.
- Select an entry from the candidates list and right-click.
A context menu appears.
- Select "Load this entry."
This adds the entry to the Fix-It Tool's set of entries. (If you selected a set of entries from the Query Tool and then invoked the Fix-It Tool, the entry you are loading is positioned following the current entry.) You can still click Prev or Next to cycle through the list of entries.
- Click one of the following radio buttons:
To Refresh a Current Entry
- Right-click on the Fix-It Tool screen.
A context menu appears.
- Select Refresh.
The status will change in the Linked Entries column.
To view and modify an entry
- Select the candidate you want to view and right-click.
A context menu appears.
- Select View this entry.
The Edit Entry dialog box appears.
- View and change the entry as described in "Viewing a Selected Entry".
Customizing the Fix-It Tool
Customize the Fix-It Tool by doing the following:
- Right-click on the Fix-It Tool screen.
A context menu appears.
- Select from the following choices:
Customization Choice
Description
One click joining mode
This feature joins a highlighted candidate with the source entry when you press Enter or click.
Auto load join candidates mode
This feature automatically searches for candidates when you switch to a new view or entry.
Auto advance entry mode
This feature automatically loads the next entry in the set. This is the default if you invoked the Fix-It Tool from the Query Tool.
Auto advance view mode
This feature automatically loads the next view. If no next view exists, the next entry in the set loads.
Auto advance unlinked view mode
This feature automatically advances to the next view with which the source entry is unlinked. It skips views with which the source entry is linked or excluded. If there are no more views, this option proceeds to the next entry.
Customize column headers
The procedure for customizing column headers is the same as for the Query Tool. To customize column headers, see "Customizing Column Headers".
Fix-It Tool Shortcuts
The Fix-It Tool provides a set of keyboard maps to enhance productivity. Table 18-5 provides list of these shortcuts.
Command Line Access of the Query/Fix-It Tool
You can invoke the Query/Fix-It Tool from the command line as well as the interface; the tool operates the same.
Note The exception to this rule is that the Property Editor dialog box appears rather than the Edit Entry dialog box. (See "Viewing a Selected Entry" for more information.)
To Invoke the Query/Fix-It Tool
- Locate either the fixittool (if you have a Solaris system) or fixittool.bat (if you have a Windows NT system) executable in the following location:
NETSITE_ROOT/bin/meta50/bin/...
- Run the command as follows:
If you provide all three of the options, the Query Tool appears directly. Otherwise, the standard console login dialog box appears.
The Property Editor
The Property Editor is used to alter the class properties for members within a connector view or a meta view.
To Alter the Properties for Members
- Click the Contents object of a particular connector or meta view.
The members for the view appear on the right pane.
- Click on a member class and right-click.
A context menu appears.
- Select Open.
The Property Editor dialog box appears.
You can use this dialog box to add, modify, or remove object classes and attribute values. You can also use an LDIF file for these purposes. Click Help for more information, or see the iPlanet Directory Server Administrator's Guide.