The
Enterprise Portal Client Application (see Figure 1)
consists of two major functional areas. The top half of the
application is where search criteria are entered. This may be either a list
of search templates and the selected search template criteria, or a list
of entities and the selected entity criteria. If you are connected to EIP
or to a content server that supports templates and has at least one template
defined, templates will be displayed. Otherwise, entities will be shown.
The lower half of the client contains the hit list of results from the search.
A toolbar is positioned across the top of the client, allowing the user
multiple selections to manipulate the behavior of the client application.
At the bottom of the search view, there is a status bar. The status bar
indicates when a search is in progress, the number of results returned
from the search, and when a search is complete. If a document is selected
for viewing the status bar indicates the status of the viewer plug-in
rendering the document.
Figure 1.
Enterprise Portal Client Application - Using templates
The search template
or entity currently selected controls the search criteria and the search
results sections of the client. A change in selection of a search template
or entity will cause the search criteria and search results sections to
change as defined for that search template or entity.
The selected template
name shows the image specified on the CMBSearchTemplateList as the background
image for the selected item. The image shown here is the unselected
image.
The unselected search template names show the image specified
on the CMBSearchTemplateList as the background image for unselected items.
The image shown here is the defalt image.
The search criteria section of the search view displays the search criteria fields for the particular search against the c.
To search, first
select the search template you wish to use. Then, type in the information
you are trying to find into one or more of the search criteria fields.
You may use wildcards if you wish in any of the search criteria fields.
The supported wild cards are *, %, _ and ?. Associated with each search
criteria field is a drop down list of operators for use in narrowing
the search. Examples of supported operators are
Like ...Search for values containing a match against the value entered.
GT...Search for values greater than the value entered.
LT...Search for values less than the value entered.
IN...Search for values containing the value of data entered.
BETWEEN ...Search for values between the two values entered.
EQ...Search
for values equal to the value entered.
Text Search Criteria
In addition to searching on indexing attributes, the search template may also contain full text search criteria (see Figure 2) . The criterion is a simple text field with a label.
The query string that is entered in the text field by the user must match the query syntax for a free or boolean text search as illustrated in theDKDatastoreTS API. See the OO and Internet Application Programming Reference for more details on Text Search query syntax.
Figure 2.
Text Search Criterion
The
search results view (see Figure 3)
contains the resulting hit list from a completed search.
You can arrange the columns in the search results section to
your preference. This is accomplished with a single click and hold
of mouse button one then drag the column to your desired location.
Sorting is available
for each column in the search results and for each column in the folder
contents section. Click mouse button two on a desired column heading,
then from the context menu select either ascending or descending order.
Alternatively, to sort ascending Click mouse button one on a desired
column.
Icons appearing
in the first column of the search results indicate the type of object
returned from the search.
represents a document. There are two ways to request that a
document be rendered for viewing. On the document double click with mouse
button one. Alternatively, on the desired document, single click with
mouse button two, then from the context menu, select view.
represents a folder. A folder can contain multiple documents
or other folders. There are two ways to open the folder view. On the
folder double click with mouse button one. Alternatively, on the desired
folder, single click with mouse button two, then from the context menu,
select view.
The
folder view (see Figure 4)
has two sections. The left portion contains the folder tree
for any folders returned from your search. The right portion of the
folder view contains the contents of the opened folder. The icon for the
open folder appears as
in the folder tree. If a folder contains another folder or
multiple folders, a hierarchical folder tree will be displayed in the
left portion of the folder view.
The keyfield groups of the documents within the opened folder appear as tabs across the top of the folder contents section. The documents within the selected keyfield group are listed in the contents section. The documents are listed by keyfields. To display the contents of a keyfield group, single click with mouse button one on the associated tab. The new keyfield group's keyfields and documents will be displayed.
There are two ways to request that a document be rendered for viewing. On the document double click with mouse button one. Alternatively, on the desired document, single click with mouse button two, then from the context menu, select view.
Documents that have versioning enabled will have an extra option in their context menus reading "All versions". To view all versions of a document, single click on the document with mouse button two and select "All versions" from the context menu. A view containing all versions of that document will be displayed in a separate window. This feature is available only when connected to Content Manager Version 8.1To return to
the search view, select the top folder which has the description "Search
Results"
Figure 3. Search View Screen Image
Figure 4. Folder View Screen Image
Toolbar Icons:
Starts to run a search.
Immediately
stops (or cancels) any search
currently in progress.
The search
criteria fields, search results list, and any default search criteria
are cleared for the
selected template.
For
all search templates, the
search criteria fields are cleared and reset with default values.
The search results sections of all search templates are also
cleared .
This button is displayed
only when connected to servers that have search templates.
Refreshes
the Enterprise Portal Client Application with any new search
templates or entities defined on the Enterprise Portal Administration
program and any modifications to existing templates or entities.
This button is displayed only when connected to servers that have search
templates.
Displays the
Options dialog
Invokes the
help facility for the Enterprise Portal Client Application.
To select multiple items for viewing, if the items happen to be sequential in the list, hold down the Shift key and use the left mouse button to select a range of items. Alternatively, to select a set of non-sequential items from the list, hold down the Ctrl key and use the left mouse button to click on those items. While still holding down the Shift or Ctrl keys, click the right mouse button and select View.
Multiple items may not be selected for updating.
Logging on:
To log on to
the EIP Federated database or to Content servers (such as Content Manager
Version 8.1), first invoke the client application. The
Logon panel (see Figure 5)
is displayed. The first field shown on the logon panel is the
Server Type field. This lists all the content server types that
are available for you to try to log into. The Enterprise Information
Portal Federated database is selected by default. Select your desired
server type. The second field shown on the logon panel is the Server
Name field. If there are known servers of that type on your system,
a list of all servers of the selected type will be shown. If no known
servers of the selected type are found, a text field will be shown for you
to enter the server name. Select the server you want to connect to from
the list, or type in the name in the text field if that is shown. Now
enter your User ID and Password in the text fields below. Press
the OK button to log in.
This feature allows you to change passwords on the content servers and on the EIP Federated database . There are two ways to change Enterprise Portal server passwords: through the Global Server password change function or through the Single Server password change function.
Global Server Password Change: On the Logon panel (see Figure 5) , enter the Userid and Password fields, and press the Update Mapping... button. This brings up the Update Userid Mapping panel (see Figure 7) which displays a list of all available servers for the user.
Single Server Password Change:
You can change a single
server password through the Server Logon Failed
panel (see Figure 6).
If a logon fails for a content server, the Server Logon Failed
panel will be displayed. This panel allows you to update the password,
retry the logon, or skip the server and continue searching without the
server. To change the password for the server:
Enterprise Portal database password change: On the Logon panel (see Figure 5) , enter the Userid and Password fields, and press the Change... button. The Change Password panel (see Figure 8) appears.
Figure 7. Update Userid
Mapping
Figure 8. Change Server
Password
Figure 9. Change Enterprise
Portal Database Password
The values associated with
items can be modified from either the search view (see
Figure 2)
or the folder view
. From the view you are in, select a single item using mouse
button two. Then, from the context menu select Edit attributes
. The edit attributes menu item is only available when a single item
is selected. If you have the authority to modify the item, selecting
Edit attributes displays
the
Edit attributes panel (see Figure 10)
containing information for the selected item. The field names
are on the left side of the dialog and the values are on the right side.
Each item belongs to a keyfield group. At the top of the dialog is a
drop-down list of available keyfield groups you can make this item belong
to. If the list is disabled, either you do not have the authority to change
the item from its current group, you do not have the authority to change
it to any other group, or changing the class or goup is not supported for
this server. If you see a table with '+' or '-' buttons on one side, then
you have the ability to add and remove children for this item. To add
a child, press on the '+' button to create a new row in the table and fill
in the values for the row. To remove a child, click on the '-' button
to delete its row in the table. Adding and removing children is supported
only on Content Manager Version 8.1 There are three buttons on the
dialog. The OK button tries to update the item using the values
you have supplied. The Cancel button stops the update process,
and if you want to start over, the
Reset button returns all the values to their settings
at the beginning of the edit session.
Figure 10. Item Attributes
Editor
You can change the options for the search template list, search template viewer, search results viewer, and application look and feel by using the options dialog. To display the options dialog (see Figure 11) press the options button on the function bar. (Note: The Search Template List tab and Search Template Viewer tab are only shown if you a connected to a server that has search templates.)
SearchTemplateList
The first tab on the dialog lists the options for the list of search template names. Here, you may choose to have the search template name list appear as a drop-down list box, a plain list, or as an image list with configurable images for selected and unselected items ( this is the default). You can also choose the URLs of the images you would like the list to use for the selected and unselected list item backgrounds. To change the look, select the radio button next to the look you would like to try. If desired, press the '...' next to the buttons to browse your system and select new background images for the list items. Then, press OK. The list of search template names should change its appearance.
SearchTemplateViewer
The second tab on the dialog
lists the options for the search template viewer. This is the region
where the search criteria for the currently selected template is shown. On
this tab, you can modify the search criteria defaults, the preferred wildcards,
and the visibility of the search buttons on the search template viewer.
The search criteria defaults define the defaults filled in by the search
template viewer when switching from the currently selected template to another
template. There are three possible values:
SearchResultsViewer
The third tab on the dialog lists the options for the search results viewer. Here you can customize the look and behavior of the search results viewer, and specify the maximum number of search results.
Grid - You can choose to show or hide horizontal or vertical lines in the search result viewer which will divide the results into a grid of cells. By default, the horizontal and vertical lines are hidden
Line Contrast - You can specify
whether you want line contrast between consecutive lines in the search results.
If you want line contrast, select the checkbox that says "Show line
contrast" . The line contrast color is shown in a small square below.
To customize the color, select the button that says "Edit color", and
choose a new color from the dialog.
Search results list - you are given two options for the behavior of the search results list when switching search templates:
Max Results - The number of search results returned from a search can be set by entering a number in the text field on the last panel which is titled: "Maximum search results returned" . If you want all of the search results returned you may enter a -1 or leave the text field blank. In a Federated environment, the maximum search results value applies to each mapping to your federated entity. So if you have more than one federated mapping, you will get a maximum result of (number of mappings) times (maximum number of search results)
Show Tree Pane - You may show or hide the tree pane that is on the left hand side of the search results list by selecting and unselecting this checkbox.
Look and Feel
This panel allows you to select
any of the Java standard look and feels or additional look and feels you
may have installed on your system. Select a radio button next to any
installed Look & Feel name, and the application will respond by changing
its look.
Figure 11. Options Dialog