Start/notes.ini Parameters/NSF_UpdateODS

NSF_UpdateODS

Parameter: NSF_UpdateODS
Short description: Raises a database on every compact -c automatically to the current ODS level of the version currently running. Unlike the version-fixed Create_RXX_Databases parameters, this setting remains valid across major upgrades — an "evergreen" setting.

Profile

Parameter
NSF_UpdateODS
Category
General (database format / on-disk structure)
Component
Client and server (originally documented primarily for Notes clients)
Available since
8.5
Supported versions
9.0.1, 10.0, 11.0, 12.0, 14.0, 14.5, 14.5.1
GUI equivalent
notes.ini only (no GUI)
Possible values
0 or missing = ODS remains unchanged on compact (default)
1 = ODS is raised on compact to the current level of the running version

Description

The Create_RXX_Databases parameter family (Create_R85_Databases, Create_R10_Databases, Create_R12_Databases) has the disadvantage that after every major upgrade a new parameter would have to be set to introduce new ODS levels.
NSF_UpdateODS=1 circumvents this problem: on every compact -c, the database is automatically raised to the maximum ODS level of the running Notes/Domino version.
  • Notes 11 + NSF_UpdateODS=1 + compact -c → ODS 53
  • Notes 12 + NSF_UpdateODS=1 + compact -c → ODS 55
  • Notes 14 + NSF_UpdateODS=1 + compact -c → ODS 55 (or higher, as soon as HCL introduces a new ODS)
For Notes clients, NSF_UpdateODS=1 is therefore the recommended best-practice setting, because local databases (mail archives, local replicas, cache DBs) are continuously kept at the current ODS level — without the Notes admin having to adjust notes.ini after every upgrade.
On servers, NSF_UpdateODS=1 is also functional, but in HCL docs is typically treated in the context of local client DBs. On servers, a version-fixed Create_RXX_Databases setting combined with dbmt or targeted compact -c is more often recommended.

Example configuration

Client-side best practice:
NSF_UpdateODS=1
In combination with periodic compact (Desktop Settings policy or scheduled task):
compact -c

Notes & pitfalls

  • Does not act actively — nothing happens without a subsequent compact -c. The setting only takes effect during a compact operation.
  • No downgrade: an ODS once raised cannot be downgraded to an older one. Plan a backup before the upgrade.
  • System databases: on servers, names.nsf, admin4.nsf, events4.nsf cannot be raised ad-hoc while the server is running — stop the server briefly, then upgrade with compact -c.
  • Third-party extension manager: if EXTMGR_ADDINS=... (e.g. AV hooks) is set, the ODS upgrade can fail; temporarily disable the add-in.
  • Collision with Create_RXX_Databases: both parameters can be set at the same time — generally the higher target ODS wins.
  • Note from Notes 12.0.2: when upgrading the Notes client, databases in the local data directory are automatically raised to the new ODS level — regardless of NSF_UpdateODS. With NSF_AlwaysUpgradeODS=0, the auto-upgrade can be suppressed.
  • Change takes effect immediately after set config (server) or after a Notes client restart — effect only visible on the next compact.
  • Works on all supported platforms.

Sources (HCL Product Documentation)