Notes.ini Entry


Name:
    NSF_UpdateODS

Syntax
    NSF_UpdateODS=0 / 1

Applies to:
    Workstations

Add-on:

    First Release:
      8.5.1

    Obsolete since:

      Category:
        ODS

      Default:
        None

      UI equivalent:
        None

      Description:
      The administrator can use two methods to accomplish the ODS upgrade:
      Create a Desktop Settings policy document and enable the following option on the Mail tab:
      "Enable upgrade of all local NSFs to latest ODS version"
      This method requires the 8.5.2 Domino Directory (NAMES.NSF) on the server. The experience is the same as described below under Configuration Options.
      If a policy is not to be used, configure the upgrade of database ODS using NOTES.INI settings as described below.

      For most non-essential databases, the ODS upgrade will take place in a background process and while a database is upgraded, the end user will not be able to use the database.
      For essential databases that are in use at the point that an upgrade is attempted, the ODS upgrade will be done at the next time the database is opened, which will typically occur at client restart.
      Configuration Options - required if the Administrator is not using a Desktop Settings policy document
      The following new NOTES.INI setting performs the upgrade:
      NSF_UpdateODS=1
      With this set, the client will do a one time pass to upgrade local databases using the compact task.
      Configuration Options - Optional
      In addition, the specific ODS level that is desired should be set (if none set, ODS51 will be forced):

      To create ODS 51 databases:
      Create_R85_Databases=1
      To create ODS 48 databases:
      Create_R8_Databases=1

      Note: If you already have Create_R8_Databases=1 set, you must revise it manually to Create_R85_Databases=1; Domino will not force ODS51 when ODS 48 is already set.

      User Experience
      For databases compacted in the background, there will not be any user visible indication that the database compacts are in progress.
      If a user attempts to use a database while the compact is in progress, they will see the error:

      "Database is being Compacted; Compact must finish before use"

      For databases that are in use at the time the compact is attempted (names.nsf, cache.ndk, log.nsf, and possibly user mail files), the compact will occur at the next client restart. When the database is compacted at restart, progress will be shown in the splash screen or in the status bar, depending on when the database is opened.

      For each database that is compacted, a "Compacting..." and "Compacted...." will appear in the log.
      11/12/2009 03:01:49 PM Compacting dummy.nsf (dummy), -r -C
      11/12/2009 03:01:52 PM Compacted dummy.nsf, 0K bytes recovered (0%)

      For each database that is at the desired ODS (or later), only "Compacting..." will appear in the log
      11/12/2009 03:01:49 PM Compacting dummy.nsf (dummy), -r -C

      At the end of the upgrade, the following will appear in the log:
      10 databases had an older NSF ODS version. 8 of those databases were successfully upgraded to a later NSF ODS.

      Bookkeeping Options

      NSF_UpdatedToODS=#

      After the upgrade is attempted for all local databases, this will be set to the ODS level that was requested.

      Deleting this setting will cause the code to attempt to perform upgrades. If upgrades are not necessary, the database will be skipped.

      If the client is shut down before all databases are completed and processed, then this is not set, and the next retry will attempt compacts on databases that are not at the desired ODS.

      Clarifications/Not in scope

      If there is an error during the compact, the database ODS will not be changed. There will not be any retry logic. If there is not enough space, which can be one of the errors, then the database ODS will not be changed. If a database takes a while to compact then the user does not have access to that database during the compact. For databases always in use, their compact will be done on the next client restart, and will block user usage.