Editing the Search Interface and Results Screen

The Directory Search / Directory Manager interface can sometimes cause some confusion, but it can be simplified or changed to reflect your organization’s needs.


Updating the Logo

You may want to change the Directory Search logo so that you are using your own company’s logo. The DirectorySearch.jpg logo is a 322 x 70 JPG file and is found in the .\Images folder. The image file name is controlled in the AppSettings.XML file in two places. One for the login page and one for the default page. Look for this line either in the loginPage and/or defaultPage sections:

logo="Images/DirectorySearch.jpg"

We recommend that you use an image with a similar size and aspect ratio for the best results.


Add or Remove “Edit My Info”

For customers that have Directory Update, the Edit My Info button is useful. If a user clicks this button, a In the Directory Search AppSettings.XML file, look for this line:

<directoryUpdate enabled="true" text="Edit My Info" url="https://demo.ithicos.com/DirectoryUpdate" />

To hide the button, simply change enabled=”true” to enabled=”false”. If you want to use this button, make sure that the url parameter is correct.


Customizing the Help Button

The Help button allows you to provide your own custom text in to a Help pop-up window. Look for this line in the AppSettings.XML file:

<help text="Help" visible="true" headerText="Help Information">
  <message>Please contact the Help Desk at 555-1234 or help desk page to modify uneditable fields.</message>
</help>

The Help window contents are found within the tag. Notice in the above example that we cannot use the “<” and “>” characters within the message. We have to use < and > instead.

If you do not want the Help button to be visible, simply set the visible=”true” option to visible=”false”.


Customizing the Search Options

If you click the search drop-down list, you will see “All” as well as a list of field names.


Image


There are a couple of pieces of magic here. The first is the “All” option. If you simply type in a search value, leave “All” as the type of search, and click the Search icon, all attributes (except Manager) will be searched for the search value. For example, if you type in ‘Sales’ in the Search box and click the Search icon, Directory Search will search all of the fields in the dropdown list for the text *sales*. This is a “contains” search. So, the search results returned will contain a user whose display name is Johnny Salester, user’s whose Department is Sales, Jack Johnson whose title is Sales Manages, etc…

  Note: Directory Search and Directory Manager searches are “contains” searches.

There are a few options in the AppSettings.XML file that will let you tune the search box to your own needs. Look for this line:

<searchBox showFieldList="true" includeAllOption="true" allOptionText="All" maxResults="20"></searchBox>

If you do not want to include the “All” search option, set includeAllOption=”false”. If you do not want the field list to be displayed, set showFieldList=”false”.


Adding or Removing Fields in the Search Box

How did that list of default fields get in to the search box in the first place? And, can you control which fields are displayed? Easy! Take a look further down in the AppSettings.XML file in the userList section. Within that section, you will find some of the common attributes for which people want to search. Here is an example of the displayName field.

<field id="displayName" search="true" column="true" expandView="false" export="true" />

This tag lets you determine if:

The other property in this tag is the “id” property. We use this property across multiple configuration files to refer to a specific attribute. In this case id=”displayName” is pretty obvious with respect to which attribute we are talking about. But, how do you know that for certain? The “master” file for attribute mappings is the DirectorySettings.XML file. If you look for the id=”displayName” in this file, you will find this line:

<field id="displayName" label="Display Name" attribute="displayName" visible="false" type="text" />

So, the actual LDAP attribute to which displayName refers is the LDAP attribute displayName. Kind of obvious, isn’t it? In this case, yes, but not always.


Searching by Manager

The Manager field in Active Directory is a special field. It is not a free-form text field, but rather maps to another object (user or contact) in Active Directory. If you select “Manager” from the Search dropdown list; the behavior of the search box will change.


Image


Instead of typing in free-form text, you must type in the name of a specific recipient. The box has a search helper that will help you along. And, then, when selected and you click the Search icon, you will see all of the users that are managed by that user. Searching Using a Validated List In some cases, you may want to search for users using only specific field values. A good example is Department.


Image


Instead of relying on users to type in the department name correctly (spelling counts!) you can provide a validated list of department names. How do you do this? You do this in the DirectorySettings.XML file. In this example, look for the department tag.

<field id="department" label="Department" attribute="department" visible="true" type="dropdown">
  <value>Accounting</value>
  <value>Development</value>
  <value>Engineering</value>
  <value>Human Resources</value>
  <value>Sales & Marketing</value>
</field>

Within the field tag, you provide a for each valid department name. And, you set the field type to type=”dropdown”. If you are using DirectoryUpdate, you can use the same DirectorySettings.XML file in Directory Search or Directory Manager.


Removing the Export Option

By default, the Export button is enabled. If you click the Export button, it will give you the option of exporting the search results to an Excel spreadsheet, CSV, or PDF file. If you do not wish to have these options available, look in the AppSettings.XML file for the following section.

<exports enabled="true" text="Export" fileName="UserList">
   <excel text="Excel" visible="true" />
   <csv   text="CSV"   visible="true" />
   <pdf   text="PDF"   visible="false" />
</exports>

To hide the button entirely, set the enabled=”false” option.


Controlling the Fields That Are Exported

Not all fields are exported an Excel or CSV file. The fields that will be exportable to a CSV file are controlled in the userList section of the AppSettings.XML file. For example, if you want to ensure that the city field is exported, look in the userList section of that file for the city field:

<field id="city" search="false" column="false" expandView="true" export="true" />

Make sure that export=”true” is set.


Turn Off the Filter and Sort Features

The filter bar and sort feature are features that appear as column headers above the search results screen. The filter options allow you to take the current search results and further filter by the options in the filter bar.


Image


We have found that some users find this feature confusing. If this feature is not useful for your organization, you can turn it off in the AppSettings.XML file. Look for the userList section and within the userList section, these two properties:

<userList
  filterByColumn="true"
  showFilterMenu="true">

Changing the Columns in the Search Results

We included the Display Name, E-Mail Address, Department, Title, and Office Phone as the default columns in the search results grid simply because we assumed those would be the most common columns our customers would want to see. But, this is not hard to change. In the AppSettings.XML file, the userList section has a list of fields / attributes. Let’s say that you want to remove the Title field and add the city field. Well, there are two tags inside of the userList section for those attributes:

<field id="city" search="false" column="false" expandView="true" export="true" />
<field id="title" search="true" column="true" expandView="false" export="true" />

To take the title out of the columns listing, set column=”false”. And, do add the city, set column=”true”. Not too difficult, right?


Editing the Expansion Pane

Inside the search results grid, you might notice a “>” symbol next to the search results. If you click on this symbol, it will open up the expansion pane (also known as the expandView.) The expansion pane lets you see additional information about the selected user. However, only a single expansion pane can be open at one time.


Image


Like other fields within the search grid, the attributes that are shown on the expansion pane are controlled within the userList section of the AppSettings.XML file. As an example, if you do not want the office attribute to be visible in the expansion pane, look for the office attribute within the AppSettings.XML file:

<field id="office" search="false" column="false" expandView="true" export="true" />

Set the expandView=”true” option to expandView=”false” to remove it from the expansion pane.