Chapter 15   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

• The Fix-It Tool

• Command Line Access of the Query/Fix-It Tool

• The Property Editor

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

1. Open the Meta-Directory console and right-click anywhere in the navigation tree.

2. 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

1. 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).

2. 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.

3. 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.

4. 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.

5. 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 chose 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.

1. Select an entry from the list in the Query Tool dialog box.

2. Right click in the Query Tool dialog box and select View selected entry from the context menu.

3. Either the Edit Entry or Property Editor dialog box will appear. The Edit Entry box will appear if any of the following is true:
   • The entry is LDAP-based.

   • The entry has a standard option class.

   • You have invoked the Query Tool from the console.

     
     
     

   In any other circumstances, the Property Editor dialog box will appear.

   
   
   

   
   

   ---

   Note	If the Edit Entry dialog box appears, you can access the Property Editor dialog by clicking Advanced.

   ---

   
   

4. Modify the fields in either dialog box as discussed in "The Property Editor".

5. 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.

1. Right click in the Query Tool dialog box to open a context menu.

2. Select Customize column headers for meta view to open the Customize Search Results Table.

   
   
   

3. Select the object class from the Objectclasses column that includes the attribute you would like to chose as a column name.

4. Select the attribute itself from the Allowed Attributes column. (Use the Control key to select more than one attribute.)

5. 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.

6. 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 coulmn itself to the left.)

   • Click Save Globally to save the headers for everyone who accesses the system.

7. 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.com

Suppose that you set up in the Customize Search Results Table, the attributes and column names in Table 15-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 15-1    Column Specifications

Attribute	Column Name
sn	Last Name
cn	Whole Name
location	Country
mail	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 15-2.

Table 15-2    Search Results for the Sample Entry

Value	Column Name
Garcia	Last Name
Frederico Garcia	Whole Name
Los Estados Unidos	Country
Garcia@siroe.com	Email Addresses
cn=Fred Garcia, ou=people, o=siroe.com	Entry Name
Fred Garcia	Nombre
Frederico Garcia	Nombre Con Idioma

Table 15-3 shows how the Query Tool decides the language subtype to choose.

Table 15-3    Query Tool Chooses the Language Subtype

Attribute	Column Name	Operation
sn	Last Name	This attribute has no language-specific version in the entry, so the default is English and Garcia is displayed under this column.
cn	Whole Name	This attribute does have language subtypes in the entry. As the preferred language is es (Spanish) and the cn attribute has an "es" version, "Frederico Garcia" is extracted.
location	Country	This attribute also has a Spanish version, which is "Los Estados Unidos", so it is extracted and displayed under this column.
mail	Email Addresses	Since there is only an English version for mail, both English values are displayed.
dn	Entry Name	This attribute is fabricated. The dn is extracted from the entry and displayed under this column. Since there is only one dn, languages are not considered.
rdn	Nombre	This attribute is fabricated. The rdn (the first part of the dn) is extracted from the entry and displayed under this column. In this case, rdn is "Fred Garcia". There is only one rdn so language is not considered. The rdn is based on an attribute that also resides in the entry, which in this case is cn. In this entry, cn has different language subtypes. For those who choose French as their preferred language, this mechanism may not be helpful, since they may want to see only French, and not the English name that constitutes the rdn.
rdntype	Nombre Con Idioma	This attribute is fabricated, and addresses the issue associated with the rdn attribute. rdntype examines the attribute that the rdn is based on and extracts all values for the attribute, respecting language preferences. In this case, the rdn is based on cn, and the language preference is es, so the tool extracts Frederico Garcia.

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

1. Right-click in the Query Tool dialog box to open the context menu.

2. Select Customize content selection filters to open the Content Selection Filters dialog box.

   
   
   

To Create a New Content Selection Filter

1. In the Content Selection Filters dialog box, click Create.

   A default of NEW FILTER appears.

2. Provide values for the following fields:

   Field	Description
   Display Name	This field carries the name of the filter. It appears in the Query Tool content selection filters drop-down list.
   ID	This read-only field is available only when a new filter is created. It is the unique identifier of the filter.
   Meta View Filter	Specify the object class by which you want entries filtered in the meta view. If you do not specify a filter in this field, the Query Tool interprets the field as (objectclass=*).
   Connector View Filter	Specify the object class by which you want entries filtered in the connector view. If you do not specify a filter in this field, the Query Tool interprets the field as (objectclass=*).
   SQL Where Clause	If the data you are searching is in an SQL-accessible database, specify the where clause of an SQL query.

3. 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

1. 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.

2. Modify the information as needed.

3. 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.

4. 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

1. Right-click in the Query Tool dialog box to open the context menu.

2. Select Customize linkage selection filters to open the Linkage Selection Filters dialog box.

   
   
   

To Create a New Linkage Selection Filter

1. 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.

2. 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".

3. 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

1. 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.

2. Modify the information as needed.

3. 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.

4. 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 15-4 provides a list of these shortcuts and what they do.

Table 15-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 15-1   

Fix-It Tool

To Link an Existing Entry to a New Entry

1. Select the view entry for which you want to establish a link with a new entry.

2. Click Create New Entry.

   The New Entry DN Selector dialog box appears.

3. 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

1. Select an existing entry from the Views column.

2. 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:

   1. 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.)

      
      
      

   2. Change the fields in the search panel as desired, and click Candidates.

3. Select an entry from the candidates list and right-click.

   A context menu appears.

4. 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.

5. Click one of the following radio buttons:

   Manaual Operations	Description
   Join	Links the current entry and the entry selected in the Candidates table, undoing any existing exclusion. The join will appear as a linked entry.
   Unlink	Breaks any links or exclusions from the current entry to the entry in the view selected. Linked entries will disappear for the particular view.
   Exclude	Excludes the current view from the view selected, breaking any existing link. The Linked Entries column will show "Exclude" for this view.

To Refresh a Current Entry

1. Right-click on the Fix-It Tool screen.

   A context menu appears.

2. Select Refresh.

   The status will change in the Linked Entries column.

To view and modify an entry

1. Select the candidate you want to view and right-click.

   A context menu appears.

2. Select View this entry.

   The Edit Entry dialog box appears.

3. 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:

1. Right-click on the Fix-It Tool screen.

   A context menu appears.

2. 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 15-5 provides list of these shortcuts.

Table 15-5    Fix-It Tool Shorcuts 

Key Combination	Function
Ctrl-e	Excludes the current entry from the currently selected view.
Ctrl-g	Drops down or hides the search panel.
Ctrl-h	Invokes help.
Ctrl-i	Sets the "Auto advance view" mode.
Ctrl-j	Joins the current selected entry with the source entry.
Ctrl-k	Sets the "Auto advance unlinked view" mode.
Ctrl-l	Loads the currently selected entry into the Fix-It Tool as the source entry.
Ctrl-m	Clicks on the More button.
Ctrl-n	Invokes the Query Tool if not currently visible, or shifts it to the foreground if currently visible.
Ctrl-o	Toggles the one-click joining mode.
Ctrl-q	Exits the Fix-It Tool
Ctrl-r	Refreshes the current source entry. (Refetches from the Directory Server.)
Ctrl-s	Performs a candidates search.
Ctrl-t	Invokes the Customize Search Results Table dialog box.
Ctrl-u	Unlinks the current entry from the entry to which it is linked.
Ctrl-w	Clicks on the Fewer button.
Ctrl-y	Sets the "Auto advance entry" mode.
Ctrl-z	Invokes the Customize Search Results Table dialog box.
Ctrl-space	Shows all of the currently selected entry.
Enter	Joins the current selected entry with the source entry.
Shift-Up	Go up a view in the view list.
Shift-Down	Go down a view in the view list.
Right Arrow	Go to the next view, entry, or unlinked view based on the mode.
Left Arrow	Go to the previous view, entry, or unlinked view based on the mode.

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

1. 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_HOME/bin/meta50/bin/...

2. Run the command as follows:

   fixittool binddn bindpw jeadminurl

   binddn	Specifies the data server bind DN to be bound to the data server URL.
   bindpw	Specifies the password associated with the data server bind DN.
   jeadminurl	Specifies the admin server URL of the join engine.

   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

1. Click the Contents object of a particular connector or meta view.

   The members for the view appear on the right pane.

2. Click on a member class and right-click.

   A context menu appears.

   
   
   

3. 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.