Bastian Wieczorek commented on Feb 11, 2008



Schedules automatic server and database maintenance functions. Enter the time

in 24-hour format, where 0 is 12 AM (midnight) and 23 is 11 PM. For example:



ServerTasksAt16=Catalog, Updall, Statlog

At 3 AM, the server runs the Catalog task. At 7 AM, the server runs the Updall

task. At 4 PM, the server runs the Catalog, Updall, and Statistics tasks.

Note: Be aware when the server has users in other timezones they could be

affected by the performance hit when these values have not been configured by

an Admin who knows the "real" timezone the users are in. So adjusting these

settings to match the actual users on the system will improve performance.

Glossary of Notes Indexer Terms:

View - A view is one way of looking at all or some of the documents in the

database. By selecting the View menu, you'll see a list of available views for

the selected database.

Collection - Each view in a Notes database has a corresponding collection in

the database. A collection contains a series of indexes related to the

particular view. The collection indexes consist of:

1. An index sorted by note number.

2. The user-defined view collection (defined in the Design View Sort dialog)

3. An index of parent-child documents within the view.

Refresh - Refresh a view by pressing F9. Refreshing the view reads from the

index and repaints the screen accordingly. It does not rebuild the index.

Rebuild - Rebuild a view by pressing Shift+F9. Rebuilding a view makes a call

to NIF, and causes the current view's collection to be completely rebuilt.

Update - Pressing CTRL+SHIFT+F9 updates or builds all the views in the

database. This includes both views which are hidden and views which are open.

Pressing CTRL+SHIFT+F9 will work on server-based or local databases. If the

views are not built, Notes will build them. If the views are already built,

Notes will update them, not rebuild them.

Note: For additional information about rebuilding Notes indexes, refer to the

document titled "What Causes a Notes Indexer to Rebuild? (# 112555 ).

The Notes 'Indexer' is actually a composite of three different subsystems.

They are described below.

Discussion of NIF

The Notes Indexing Facility is comprised of a set of functions that the Notes

server uses to manipulate indexes. Most of these calls are made by the server

as users access databases (remember that Notes is client-server).

As a user makes changes to documents in a database, the current view for that

user is updated immediately. This process is necessary so that the user sees

their changes as they occur.

When a user changes documents within one view, and then switches to another

view, NIF sees that the database has been modified since the last time the

collection was rebuilt, so it forces an update to the collection. When the new

view is open, it will reflect the updated documents. Note that this update may

take some time if many documents are involved (other user's updates are

included), or if the view is complex.

An indicator at the top left corner of the view (a blue curved arrow) signals

that a view is out of date. That is, the database contains newer information

than that reflected on the screen. Pressing F9 refreshes the view. Refreshing

the view reads the index from the database, and paints it on your screen.

Clicking the indicator with the mouse button also refreshes the view. (In

Notes 3.x, the indicator that a view is out of date is a black question mark

against a yellow background.)

The workstation normally stores the current chunk (called a page) of the index

in memory. When you scroll back and forth within the view, you notice that

scrolling down once or twice is quick, but the third times takes a few

moments. This is because that third scroll has pushed you past the page of the

index held in the workstations memory. A new page must be read from the

database. This is when you may notice the blue curved arrow. It will appear

when you read a page of the index, and documents have been modified in the

database since the view was last updated.

As you scroll up and down, you will see new documents in the view as they are

updated by other users. The blue curved arrow will display until you press

F9. The view you have open may or may not change after pressing F9. This will

depend on whether the modified document are supposed to appear in this view, or

some other.

Discussion of Update

$Update.EXE is a process that runs continually, checking a work queue for

databases to update. It checks the queue every 5 seconds. If it finds a

queued request, it opens each collection within the specified database, forcing

the update of the collections' indexes.

Update is normally specified on the ServerTasks= line of the NOTES.INI. For


ServerTasks=Replica, Router, Update

The Update process works off a queue, and updates database indexes as

requested. Requests normally comes from the Replicator, Router, or a user.

Replicator When a database replicates, the Replicator adds an entry to the

Update queue.

When the Router adds a document to a database, it also adds an entry to

the Update queue.

When a user closes a database, the workstation adds an entry to the Update

queue if the database has been modified.

Update will wait to combine multiple request for the same job. About 15

minutes after the replication ends, the Update queue kicks in, updating all the

indexes on the database. When Update has refreshed all the collections, it

updates any databases that have Full Text indexes with the Index Update

Frequency set to 'hourly'.

When a user closes a database, an entry is added to the Update queue. About 15

minutes later, the collections for that database will be updated to reflect the

new documents that the user changed. If another user goes into the database

before Update has updated the collections, the collection that the user opens

is forced to update immediately. Note that this update may take some time if

many documents are involved, or if the view is complex.

Discussion of Updall

$Updall.EXE is the single-instance version of $Update. It runs until it has

processed each database, and terminates. It does not work from a queue. Like

$Update, $Updall opens databases, forcing the update of the collection. When

Update has rebuilt all the collections, it updates any databases that have Full

Text indexes. Updall also purges delete stubs from databases.

Updall is normally specified on the ServerTasksat2= line of the Notes.INI. For



Parameters for Updall

Parameter Description: What to type at Server console:

-V Update views. The database name is optional. Load UPDALL MyDB -V

-F Update all full text indexes. Load UPDALL MyDB -F

-L Update all full text indexes defined by Index Update Frequencyas 'Daily',

'Hourly', or 'Immediate'. Load UPDALL -L

-M Update all full text indexes defined by Index Update Frequencyas 'Hourly' or

'Immediate'. Load UPDALL -M

-H Update all full text indexes defined by Index Update Frequencyas 'Immediate'. Load UPDALL -H

-C Build indexes for views that haven't already been built. The database must

be specified. Load UPDALL MyDB -C

-T Update a particular view, by Title. The database and entire view title must

be specified.

* This is an undocumented parameter --

(If a view title is cascaded, the value returned by @viewtitle will not work as

an argument. In general, Notes @ commands have problems with view names that

are cascaded with synonyms.) Load UPDALL MyDB -T ($ServerAccess) -R

-R Force rebuild of every view that has been opened. The database name is

optional. This is a resource-intensive option. When running on a large

database, it is best to bring the server down, and run UPDALL from the OS/2

prompt (C:\$UPDALL Names -R).

* This is an undocumented parameter Load UPDALL MyDB -R

-X Rebuild Full-text indexes and does not rebuild views. Load UPDALL MyDB -X

Updall - Search Site options

-A Incrementally updates search-site database configurations for Release 4

search site databases. Load UPDALL -A

-B Does a full update of search-site database configurations for Release 4

search site databases. Load UPDALL MyDB -B

These parameters may be combined. For example:

Load Updall -V -M

Applies to:


Default Value:

ServerTasksAt1=Catalog, Design

ServerTasksAt2=Updall, Object Collect mailobj.nsf


UI equivalent:

None, although you can specify this setting in the NOTES.INI Settings tab of the Configuration Settings document in the Domino Directory.



Available since:

Lotus Notes/Domino x.x.x

Obsolete since:

Lotus Notes/Domino x.x.x