Netscape Compass Server Administrator's Guide

[Contents] [Previous] [Next] [Index]

Chapter 7
Administering My Compass

My Compass enhances the Netscape Compass Server search and browse operations by periodically checking the database for new or updated information and notifying users of items that interest them. This "pushing" of information prevents users from having to repeatedly search for the same kinds of information.

This chapter contains the following information you need to administer My Compass:

My Compass Administrator Tasks

The following My Compass administrator tasks are covered in this section:

Managing the Profiler

The Profiler is a batch job, or server agent, that processes the users' interest profile requests and matches them against new or changed information in the Compass Server. The Profiler updates users' personal news pages and sends out email newsletters to users who have requested this. The Profiler is managed with the Profiler Control Panel and the Profiler Schedule Editor.

Managing the Profiler comprises the following tasks:

Configuring the Profiler Schedule

Use the Profiler Schedule Editor (as shown in Figure 7.1) to set up the times when you want the Profiler activated. See Profiler Scheduling Tips for more information.

As a general rule, always schedule the Profiler to run after the robot has completed its job. Note that you should schedule a time for the robot to start as well as for it to stop. The Profiler should be scheduled to run after the time you have scheduled for the latter.

To configure the Profiler's schedule, using the Profiler Schedule Editor, follow these steps:

  1. In the "Activate profiler daily at:" input boxes, select the hours and minutes when you want the Profiler to run by clicking the up and down arrows.

  2. To exclude Profiler runs on weekend days, in the Exclude area, click the Saturday and/or Sunday checkboxes.

  3. In the Schedule area, click the Activate radio button.

  4. Click OK to save your schedule settings.

Immediately Activating the Profiler

You can immediately activate the Profiler by clicking Activate Profiler Now on the Profiler Control Panel (shown in Figure 7.2). This is useful for sending out new information immediately, rather than waiting for the next scheduled Profiler run.

Some examples of when activating the profiler immediately would be beneficial are:

Configuring the Email Notification

You can configure the email notification to allow subscribers to receive their newsletters in email. Before email notification can be used, you must already have set up your SMTP (Simple Mail Transfer Protocol) server where undelivered newsletters are sent.

To set up email notification, in the Profiler Control Panel click the Yes button to the right of Allow Email Notification. In the Mail Undelivered Newsletters To box, type in an email address. Any undelivered mail from the Profiler (for example, if user's email address is incorrect) is returned to this address.

Managing My Compass Users

Before your users can use My Compass, you must first ensure that a Netscape user account exists for each user. To access user account information, click the Users and Groups button on the Netscape Server Administration panel. Refer to Managing Netscape Servers for complete details about how to create user accounts.

The Manage My Compass Users window (as shown in Figure 7.3) allows administrators to perform searches for users (user IDs, registered, unregistered, and invalid) so they can manage My Compass user registrations.

With the Managing My Compass Users panel, you can:

Checking Subscriber Information

The Manage My Compass Users form (shown in Figure 7.3) allows you to generate a list of users at the site based on their My Compass registration status or user ID.

To check user registration information, follow these steps:

  1. Click the pop-up menu next to "Find all" and select the type of users you want to find.
    You can search for unregistered users, registered users, and invalid users.

  2. Click Find.
    A list of all the users matching your query appears.
To register one or more unregistered users, see Registering and Unregistering Users.

Registering and Unregistering Users

There are two ways that a user becomes a registered My Compass user:

NOTE: In both these situations, the user account must already exist containing basic details such as a user name, password, and email address. If the user account does not exist, use the Users and Groups button on the Netscape Administration Server to create user accounts, as described in Managing Netscape Servers.
To register users, follow these steps:

  1. Generate a list of users you want to register.
    You can use the procedure in Checking Subscriber Information to find the users. Figure 7.4 shows a typical list.

  2. Click the checkbox next to each user in this list you want to register.

  3. Set up Interest Profiles for each user by doing the following:
    1. Click the Unregistered link for each user to open the New Interest Profile form (similar to Figure 7.5) for that user.
    2. In the New Interest Profile form, type user preferences and click Save Changes to return to the list of users.
    3. Repeat this process for each new user.

  4. Choose Register in the Action pop-up menu.

  5. Click Submit to register the user(s) as My Compass users.
To unregister users, follow these steps:

  1. Perform a search for registered users.
    The process is described in Checking Subscriber Information. The result is a list of registered users, similar to the one in Figure 7.4.

  2. Select the users you want to unregister.

  3. Choose Unregister in the Action pop-up menu.

  4. Click Submit to unregister the user(s) as My Compass users.

  5. Find and delete each user's profile setup information.

Finding and Deleting Invalid Registrations

A registration becomes invalid if the user to whom the registration belongs is removed from the user directory. Invalid registrations are harmless; however, the Profiler will continue to send newsletters for invalid registrations. Deleting these is a good idea.

To delete an invalid registration, do the following:

  1. Perform a search for invalid users.

  2. From the initial Find list, select "invalid registrations."

  3. Select the check box next to the invalid registration.

  4. Select Unregister.

  5. Click Submit.

Finding a Specific User

The Manage My Compass Users Form can help you locate users either by name or by using search keys.

You can find a user with the following options:

Modifying a User's Interest Profile

You can edit a user's Interest Profile from the Manage My Compass Users Form.

  1. Search for the user whose profile you want to edit.
    This process is described in Finding a Specific User.

  2. In the Search Results window, click the Registered link to access the Interest Profile.

  3. Modify the user's Interest Profile and click Save Changes.

Purging Personal News Pages

Purging old My Compass Newsletters from the users' personal news pages helps save storage space and keeps your site up-to-date (see Figure 7.6). This feature allows you to specify the purge date for older newsletters. Simply type in a number representing the amount of days to keep newsletters. All newsletters older than those dates will be removed.

Upgrading to grapeVINE for Compass Server

This option allows you to check current version information and to visit the grapeVINE web site with the grapeVINE Version window (see Figure 7.7).

My Compass Administrator's Reference

This section describes the functions of the various elements on the My Compass administration forms.

To access the administration forms for My Compass, do the following:

  1. Access the Server Manager for the Compass Server.

  2. Click the My Compass button to access My Compass administrative features.
The My Compass Administrator interface has the following forms:

Profiler Schedule Editor

The Profiler Schedule Editor allows you to schedule the Profiler and provides status for the Profiler.

Figure 7.1    Profiler Schedule Editor

The elements of the Profiler Schedule Panel are:

Element Description
The schedule is currently On/Off

Provides the On/Off status for the Profiler scheduler.

Activate Profiler daily at:

Selects the start time for Profiler runs. Click the down arrows to set the hour and minute.

Exclude: Saturday/Sunday

Click the checkbox to exclude Profiler runs on either day.

Schedule: Activate/Deactivate

Click Activate to activate scheduling setup or Deactivate to ignore scheduling setup.

Profiler Control Panel

The Profiler Control Panel form allows you to immediately activate the Profiler and configure email settings.

Figure 7.2    Profiler Control Panel form

The elements of the Profiler Control Panel form are:

Element Description
Activate Profiler Now button

Click to start the Profiler.

Allow email notification

Click Yes to allow newsletters to be sent by email or No to deactivate email notification.

Mail undelivered newsletters to

Type in the email address where undelivered newsletters should be sent.

Manage My Compass Users Form

The Manage My Compass Users window allows you to search for users so you can manage your site's My Compass users.

Figure 7.3    Manage My Compass Users form

The elements of the Manage My Compass Users form are:

Element Description
Find all

Use the down arrow to select the type of My Compass users you want to find. Available options are:

· unregistered users

· registered users

· invalid users

whose user ID

Click the down arrows to select search options for the user ID. The search options are:

· contains

· is

· isn't

· sounds like

· start with

· ends with

blank text box

The blank text box allows you to type in specific user ID.

Find button

Click to start a search for the selected criteria.

Example Search Results Form

This window is an example showing the results of a search (see Figure 7.3).

Figure 7.4    Example search results form

The columns in the above listing and their meanings are:

Element Description
Return to Manage My Compass Users Screen button

Returns to the screen shown in Figure 7.3.

checkbox (to the left of Registration Status)

Click to select the user or click again to deselect the user.

Registration Status

Shows the My Compass user registration status. Options are:

· Registered - a registered My Compass user (Clicking this link opens the Interest Profile for the user so you can modify profile elements. See Figure 7.5.)

· Unregistered - an unregistered My Compass user (Clicking this link opens a new Interest Profile for the user so you can create a user profile.)

· Invalid - a user without a valid user ID

Name

First and last name of the user.

User ID

Login name of the user.

Select All Users checkbox

Click to select all the listed (found) users.

Action

Click the down arrow to select a registration action. Available options are:

· Register - register as a My Compass user

· Unregister - remove My Compass user account

Submit button

Click to activate registration requests.

Interest Profile Form

The Interest Profile form allows you to modify the selected My Compass user's interest profile.

Figure 7.5    Modify Interest Profile form

Element Description
Active/Inactive

Click the down arrow to select My Compass registration status. Options are:

· Active - Activates (initializes) My Compass for the user.

· Inactive - Turns off My Compass for the user.

Receive newsletters via email

Click the down arrow to select Yes (send newsletters with email) or No.

Email newsletter type

Select either HTML (recommended) or Plain Text (if your mail program does not support HTML).

Number of matches per subscription

Type in the maximum number of matching documents to send per subscription.

Next Profiler run will process documents created

Lists the date the next Profiler ran. Accumulate documents from previous Profiler runs by typing in a number and clicking the down arrow to select days, weeks, or months. The Profiler includes in your next newsletter all documents during this interval.

Save Changes button

Click to save the changes made to this user's configuration.

Delete

Delete this user. Generally used to remove My Compass users when they have been removed from the Compass Server user's listing.

Purge Personal News Pages Form

The Purge Personal News Pages form allows you to remove users' news pages older than the specified number of days.

Figure 7.6    Purge Personal News Pages form

Element Description
text box

Type in the number of days for keeping newsletters.

OK button

Click to purge newsletters older than the specified number of days.

Upgrade to grapeVINE for Compass Server Form

The Upgrade to grapeVINE for Compass Server form describes grapeVINE for Compass Server features and allows you to upgrade.

Figure 7.7    Upgrade to grapeVINE for Compass Server form

Profiler Scheduling Tips

When scheduling the Profiler, you should consider the following factors:

You have the option to activate the Profiler on weekends. You might want to activate the Profiler during weekends if:


[Contents] [Previous] [Next] [Index]

Last Updated: 02/12/98 13:34:32


Copyright © 1997 Netscape Communications Corporation

Any sample code included above is provided for your use on an "AS IS" basis, under the Netscape License Agreement - Terms of Use