- 8 minutes to read

Update Nodinite with the Install and Update Tool

Important

This page applies to the deprecated Nodinite Install and Update Tool for version 6.x. Nodinite version 7.x and later is installed and updated with PowerShell scripts from the Nodinite Portal; for the Log Databases in version 7, see Update Log Database.

An update replaces the Nodinite Core Services of an instance with a newer package, and updates the Configuration Database on the way. The Log Databases are the exception: when a release changes them, you update them yourself with the provided scripts before the tool lets you continue. The order matters, because the services must not write to a database while its schema changes.

graph LR S1["fa:fa-list Step 1
Select Environment"] --> S2["fa:fa-magnifying-glass Step 2
Review Update"] S2 -->|"Log Database update needed"| S3["fa:fa-database Step 3
Manage Log Databases"] S2 -->|"No Log Database update"| S4["fa:fa-arrow-turn-up Step 4
Perform Update"] S3 --> S4 style S1 fill:#2678BD style S2 fill:#2678BD style S3 fill:#E47528 style S4 fill:#93d16d

Diagram: Select and review the instance (blue), update the Log Databases manually when the release changes them (orange), then perform the update (green).

Update an existing instance of Nodinite

Before executing the Update, ensure you have downloaded the latest version of the Nodinite Core Services.
[!IMPORTANT] Always use the latest version of the Nodinite Install and Update Tool; see Release Notes for more information.

Existing instances of Nodinite are updated using the Nodinite Install and Update Tool. An Update operation always uses the highest version from the list of uploaded packages. It's only possible to perform an Update to a higher version; you can not downgrade.

  • You can change the name of the Customer in the list of instances if you click the Edit button.
    Manage Customer name
    Example: Manage Customer name in the update tool.

Use the Action button to perform operations on the Environment:

Warning

This operation merely removes the entry, you still need to Uninstall!

Step 1: Select Environment

Begin with selecting the instance to Update:

  1. Click the environment name to update
  2. Or Click the Action button and select the Update menu item
    Select environment
    Example: List of available instances to update.

There can be multiple instances to manage from the list of installed Nodinite instances. There is one table for each Customer.

Step 2: Review Update

Next, a summary of installed components eligible for an update is present in the table.
Components eligible for update
Example: Summary of components eligible for update.

Important

If there is an update to any of the Nodinite Log Databases, the update tool will only allow you to perform the Update once you have manually updated these.

We aim hard to only release an update of the Log Databases for major releases (features), never to minor builds (bugs). If you need to update the Log Databases; please follow step 3.

Application Update Database and Application Update
Application Update screen Database and Application Update screen
  1. There is an Update available for the Configuration Database. In step 4 the database is automatically updated by the system. Usually, you should not need to perform a manual update

If there is a problem updating the database or you want to update it manually, follow the How to manually update database user guide.

  1. No update is available for the Log Database since the Manual Update button does not exist. The '...' button is available to help you get the script if you need it

If there is an update available, please review step 3.

  1. There is an Update available for the Nodinite Log API

  2. Click the Update All button to open the update modal
    Update All button
    Example: Update All button to start the update process.

The Update all button is only enabled when and if a higher package version exists; please review the Download Package step.

If any of the Log Databases has version '0.0.0.0' chances are you are using SQL Server Always On Availability groups. If so, you must execute the scripts manually to update the schema. Please review the Manage Log Databases step.

Step 3: Manage Log Databases

Important

Nodinite version 7.x and later users should refer to the new Update Log Database guide, which uses the Update Guide feature in the Nodinite Web Client. The instructions below apply to the deprecated Nodinite Install and Update Tool for version 6.x only. If there is an update to the Log databases; then, you must always first update these manually using the provided scripts. There is also more to read in the How to manually update database user guide.

If there is an update to the Log databases; click on the Manage Log Databases Log Databases button:
Manage Log Databases Button
Example: Manage Log Databases button.

Follow the steps in the guide to manually update the Log databases.
Manage Log Databases
Example: Manage Log Databases view.

You can also verify if there is a need to update the Log databases in step 3. If there is nothing to update, please close this page and return to step 4.
No Log Database to update
Example: No Log Database to update.

New 6.0.0.65 From time to time, we change the indexing scheme and apply this as an optional update. You can apply this update by clicking on the Ignore Version Differences checkbox.
Run the scripts to make sure you are using the latest definitions. Doing so may drastically improve the performance and reduce IO for SQL Server.
Ignore Version Differences
Example: Ignore Version Differences option.

Tip

If the database is in FULL recovery mode You can temporarily change to SIMPLE recovery mode to speed up the update process.

Step 1: Stop Logging/Monitoring Services

Turning the services off before starting is recommended to make sure they aren't writing to the databases.

Click the Stop button to stop the Logging- and the Monitoring Service.
Stopped Services
Example: Stopped services.

Click the Next button to proceed to the next step.

Step 2: Put all archive databases into read-only mode

Click the Read-Only button to put all Archive Log databases into read-only mode.
Set read-only
Example: Set archive databases to read-only mode.

Click the Next button to proceed to the next step.

Step 3: Command line scripts

There are scripts available to update all the Log databases.

  • Active - the panel to the left. This is always just one database.
  • Archive - the panel to the right. There can be many archive databases.

Sample scripts to update Log Databases
Example: Sample scripts to update Log Databases.

Copy the script(s) and run in a CMD-prompt using the same account as the Logging Service. Then, repeat the operation using the scripts for both the Active and Archive Log Databases.

Important

The conversion process may allocate a lot of disk space. Therefore, make sure to shrink the Log Databases to reclaim the disk space as required.

Click the Next button to proceed to the next step.

Step 4: Set archive databases back from read-only mode

When all Log Databases are up to date, click on the Unset read-only mode button.
Unset read-only mode
Example: Unset read-only mode for archive databases.

Click the Next button to proceed to the next step.

Step 5: Restart services

Click the Start button to start the Logging- and the Monitoring Service.
Start Button
Example: Start services after update.

The services should promptly start and display with green icons.

Click the Next button to proceed to the next step.

Step 6: Continue updating Nodinite

Click the back to the previous page link to return to the instance view from where you can continue the update by clicking on the Update all button.

Step 6: Continue updating Nodinite
Example: Continue updating Nodinite.

Step 4: Perform Update

Now that all your Log Databases are up to date, you can initialize the update process. For each account in use for the Core Services, you must provide its password.

Advanced Tab

Different versions of the SqlPackage (DacFX) use different parameters to connect to the SQL Server. Please review the SqlPackageParams System Parameter for additional details on this topic.

Advanced Tab
Example: Advanced tab for SQL connection options.

Note

Changes are stored in the SqlPackageParams System Parameter upon a successful update.

Update Steps

  1. Select the version to update to (by default, the highest available version is pre-selected)

Important

If you perform manual updates to any of the databases in the previous steps, then make sure to select and verify the SAME version in this dialogue is selected.

  1. Enter the password for the installation/service account(s) and click on the Validate Account button

Set password for account
Example: Enter the 'Password' for the account in use to perform the installation.

  1. When all accounts are validated, you can initialize the Update process by clicking on the Update Nodinite button

Update Nodinite button
Example: All fields validated - ready to start update.

  1. A progress bar will be displayed; wait for the Update to finish (usually takes between 15 seconds and 3-5 minutes, depending on current workload, often the longest time for the update is to gracefully stop processes with work in progress)

Update progress bar
Example: Update progress bar showing installation progress.

  1. When completed successfully, click the Close button

Update completed with success
Example: Update completed successfully.

Congratulations, Nodinite is now up to date.

You can subscribe to new releases using the Nodinite Portal

Next Steps