Administration Through the K2 Dashboard

 

 
Note   This discussion is a brief summary only; for complete information on using the K2 Dashboard, see the Verity K2 Dashboard Administrator Guide.
 

 

The K2 Dashboard is an application with a browser-based user interface enabling you to control configuration settings for the components in your K2 system. If your K2 system consists of many K2 Servers, K2 Brokers, and indexes in different physical locations, you can use the K2 Dashboard to configure settings for the entire system from one computer.

These are some of the K2 Dashboard configuration tasks you can apply to a distributed environment:

Add a new service (K2 Broker, K2 Server, K2 Ticket Server, or other service).

 

Manage and monitor the status of a K2 service.

 

Create and manage collections and their style sets.

 

Attach a collection or other index to a K2 Server.

 

Assign security to an index.

 

Generate user activity reports.

 

Set logging options and view log files.

 

Create a user defined job, a scripted command to run any command-line tool directly from the K2 Dashboard.

 

Use user-defined jobs to optimize collections or stage indexes.

 

Add and remove administrative users.

 

Manage license keys.

 

Using the K2 Dashboard

To use the K2 Dashboard, you launch it and log in. After login, the K2 Dashboard home page appears (Figure 2-7).


Figure 2-7    K2 Dashboard home page



Note these areas of the K2 Dashboard screen:

Menu bar. Across the top area of the window. Includes these links:

 

Home. Displays the K2 Dashboard home page (the page shown in Figure 2-7).

Preferences.

Help. Displays the Verity K2 Dashboard Administrator Guide. Context-sensitive Help is available from other Help buttons.

Logout. Ends the current K2 Dashboard session.

System View. Displays all K2 system components, grouped by type. You select a K2 component in the System View to view or change its settings through the related summary or detail page (or action page, accessed through the summary or detail page).

 

Summary pages. Each displays a summary of the components represented by the currently selected folder in the System View. For example, if you click the K2 Server folder, the summary page lists all K2 Servers in the system and gives various statistics and configuration actions for each one.

 

Summary pages offer useful overviews that allow you to monitor the performance of system services and indexes.

Detail pages. Each displays information about an individual component that has been selected either from a summary page or from within a folder in the System View. For example, if you open the K2 Server folder in the System View and then click the icon K2_Server_1 beneath it, the detail page for K2_Server_1 (Figure 2-8) appears.

 

A detail page shows an individual component’s relationship to other services and indexes in the K2 domain. It also provides access to all configuration actions available for that component.

Actions. You access most K2 Dashboard functions by selecting actions. For example, separate actions allow you to start a service, create an index, or run a collection indexing job.

 

Action links appropriate to each component are displayed in the upper area of the component’s detail page (see Figure 2-8), and as links associated with the component’s related services and indexes. Action links are also available on the K2 Dashboard home page, as shown in Figure 2-7.


Figure 2-8    Action links on the K2_Server_1 detail page



When you click an action link, the K2 Dashboard displays information related to that action. For example, to view the service logs for K2_Server_1 in Figure 2-8, click the View Logs action link. The K2_Server_1 detail page is replaced by the View Logs page.


Figure 2-9    View Logs page



You can then perform additional actions using the controls on this page.

Notifications. K2 Dashboard notifications are displayed on the home page and on summary, detail, and action pages. They show system messages and prompt you to perform required actions, such as restarting a K2 Server.

 

Using the StyleSet Editor

A style set is the complete set of style files, the Verity configuration files that control many aspects of indexing behavior and index structure. Before you create a collection, you need to select or create the style set that it will use.

Style files generally have the scope of an individual collection. When creating a collection, you typically create (copy and modify) a set of style files customized for that collection.

Verity K2 includes the StyleSet Editor application, which offers a graphical approach to creating and modifying style files. You can launch the StyleSet Editor from the K2 Dashboard. Figure 2-10 shows the Create Styleset page.


Figure 2-10    Create Styleset page (in K2 Dashboard)



Clicking Continue brings up the StyleSet Editor’s Collection Fields Definition page (Figure 2-11).


Figure 2-11    Collection Fields Definition page (in StyleSet Editor)



The StyleSet Editor’s user interface is gateway-specific; the fields, tabs, and navigation features that you see depend on which gateway your style set will be used with.

Once you create a style set through the StyleSet Editor, it is automatically registered and stored with the Master Administration Server, and then it is available to assign to a collection. For more information, see the chapter on identifying style sets in the Verity K2 Dashboard Administrator Guide.