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.

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 reload 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 refresh 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 refresh 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 example:

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.
Router When the Router adds a document to a database, it also adds an entry to the Update queue.
User 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 example:

ServerTasksat2=Updall


Glossary of Notes Indexer Terms:

Indexes will not be discarded unless they have not been accessed. You can override this setting by adding the NOTES.INI variable

DEFAULT_INDEX_LIFETIME_DAYS=days

Notes/Domino can also trigger indexes to be rebuilt or refreshed due to a number of other reasons, outlined as follows:

1. Design changes to a view

The index will be rebuilt if changes are made to selection formulas or column formulas. Cosmetic design changes such as column width or heading changes will not trigger a rebuild.

2. View is corrupted

If a view is detected as corrupted, Notes flags that view to be rebuilt. The view will not be rebuilt until all users have logged out of the database and either an updall -r is run or when a user opens the database for the first time and accesses a particular view after all users have logged out. You will be able to tell that an index is corrupted because the users that are still in that view will receive errors indicating that the view is corrupted. You should also notice such errors in the log file.

3. Replication

After a database has replicated, the views will need to be incrementally updated to take account of the changes made. Notes also updates any databases that have full text indexes with the Index Update Frequency set to "hourly" or "immediate".

4. Agents

When agents that add or delete documents are run on a database, the index for that database will be incrementally updated. If the agent modifies documents, all built views will be checked, but only the affected ones will be updated.

5. Changes in the collation table

The collation table tells Notes how to sort things. If the collation table changes, then NIF must rebuild every collection. The collation table is stored in the CLS files that ship with Notes. If you upgrade to a different version of Notes, it is possible that it will contain a different collation table and therefore force a rebuild of every collection the first time they are opened. Another way to change the collation table is via the menu option Tools\Setup\User\International. That will bring up a dialog box with some collation choices. If you choose a different collation method here, all collections will be rebuilt when opened. Once a collection has been rebuilt with the new collation table, the version of the collation table is saved with the collection so NIF knows when the collation table changes.

6. Router

When the Router deposits a message in a mail database, it also places a corresponding request into the Update queue, which will cause the respective view to be updated.

7. Other causes

Pressing SHIFT+F9 rebuilds the view you are currently in. Pressing CTRL+SHIFT+F9 updates all views in the database you are in.

NOTE: It does not matter if the views are hidden or open. Pressing CTRL+SHIFT+F9 will rebuild views 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.

If the cutoff date for the database is more recent than the last time/date that the view was updated, the index will be rebuilt. The cutoff date is based on the purge interval, so by default it will be 90 days earlier than the last purge. You can see the cutoff date in the Replication Settings InfoBox in Notes/Domino R4 and R5. Purging is done at one-third the purge interval, and the replication cutoff date will be based on that purge interval. Once the replication cutoff date is reached, you will be prompted with a dialog box containing the following message:

"The Replication Cutoff Date indicates that documents before 02/28/94 01:42:02 PM should be purged from this database. Would you like it to be done now?"

One other instance only occurs for private views. If the user's privileges have changed since the last time the view was updated, then the private view will be rebuilt.

preload preload preload