Skip to main content

Upgrade NIM safely

Settings guide

Plan each upgrade as an operational change: protect the current state, upgrade, then validate the outcome.

Back up before every upgrade

Back up the current NIM configuration before selecting Update. Create a fresh configuration repository and download its JSON backup to an access-controlled location outside the NIM server.

Also create a snapshot to preserve the installed NIM version, configuration, internal databases, and credentials for rollback. Confirm the backups are complete before starting the upgrade.

Review changes after upgradingDirect link to Review changes after upgrading

After upgrading, review these settings and verify normal operation:

AreaReview before resuming normal operation
Studio and MCP accessReview group/resource rights and the additional NIM MCP permission limit.
Mail and exportsOnly administrators change mail settings; review export and multi-export path restrictions for other users.
RecoveryCheck snapshot contents and source-build behavior, including older snapshots without user settings/tags. Verify restored authentication and databases.
Data and anonymizationConfirm the loaded collect, Read-only state, and anonymization profiles before running functions.
AppsRetest designer/frame controls, grid sizing, and updated item properties in Run mode.
Audit historySystem-session entries are corrected automatically on first start after the auditing fix; do not edit the audit database manually.

Review the target build's release notes for version-specific changes. The older-build warnings below apply to the versions they name.

Release scheduleDirect link to Release schedule

NIM's targeted release schedule is one release per quarter. High-priority or urgent releases may be issued sooner. This is a planning target; actual release timing may vary.

Upgrade NIMDirect link to Upgrade NIM

Review the service release announcements for your installed and target builds before upgrading. In particular:

Affected builds or environmentConditionRequired action
v7.0.1864–v7.0.1866Snapshot restoration has a known issue affecting internal.passwords.Follow the snapshot recovery guidance and verify restored authentication data before relying on rollback.
Skyward Qmlativ on v7.0.1864/v7.0.1865Pagination can omit search fields after the first request.v7.0.1866 fixes this issue; review that release when planning the upgrade.
Older installations crossing v4.0.1546 or v4.0.1550The announcements require an updated license from Support.Check licensing with Support before an upgrade that crosses those changes.
Windows Server 2019 on v5.1.1708/v5.1.1710Error 87 is a documented updater issue.v5.1.1714 announces improved updating on that platform. Review the manual-installer workaround with Support for an affected installation.

When an update is available, NIM displays a notification bubble beside Settings.

Upgrade NIM safely

Back up the current configuration and installationDirect link to Back up the current configuration and installation

  1. Review and record the installed and latest available build in Configuration > Settings > Version.
  2. Create a new configuration repository, download its JSON backup, and save it outside the NIM server.
  3. Create a snapshot to preserve the current installation for rollback.
  4. Confirm the repository backup is saved and the snapshot has completed before proceeding to Run the update.

Repeat this before every upgrade. Use fresh backups that capture the current state.

Step 1 of 3
caution

Schedule production upgrades during a maintenance window. Confirm active jobs and tasks are complete before beginning.

TroubleshootingDirect link to Troubleshooting

Problem

Upgrade stays in maintenance mode

Wrapper log

Check nim.wrapper.log on the NIM server for this error. See Find log files on disk for its location.

FATAL console - Cannot open nim service on computer '.'.

Cause

When this error occurs during an upgrade, the NIM Service Account lacks permission to control the local NIM Service, including starting and stopping it.

Resolution

  1. Confirm the account configured on the NIM Service's Log On tab in services.msc.
  2. Have a server administrator grant that account permission to query status, start, and stop only the NIM Service. Follow Grant local NIM Service control for an MSA. Keep the service account outside the local Administrators group.
  3. After correcting permissions, review the wrapper log and the installed version before retrying the upgrade. If maintenance mode persists or the upgrade state is unclear, contact Support before another attempt.