NetX provides an installer package for Windows that can be used for a new installation or to upgrade your existing installation.
Before you begin
Question | Answer |
---|---|
Which version are you upgrading from? |
Depending on the version you are upgrading from, you may need to update your environment to support the latest NetX version. Please review NetX 10 On-premise Dependency Changes and follow applicable instructions before attempting the upgrade. |
Are you using supported software to host the latest version of NetX? | Please review Supported Platforms to verify that your environment is supported for the latest release of NetX. |
Have you reviewed the release notes? | Occasionally, functionality is changed or removed in new releases. Make sure your users are familiar with the changes the upgrade will bring and re-train if necessary. |
Have you backed up your NetX instance? | See Backing Up NetX for more details. |
Are you running NetX in a distributed configuration? | All NetX instances must be upgraded to the same version. When upgrading, shut down all nodes and upgrade each one in succession. Only once the first node has started up completely should the other nodes be started. This is because the application may be in the middle of database schema changes that need to complete before other nodes start using the database. |
Upgrading NetX
If you are using a custom synonyms.txt file, make a copy of it before running the NetX upgrade. This file is usually located here: C:\Program Files\Solr\server\solr\netx\conf\synonyms.txt. You will need to restore this file after the upgrade.
- Download the latest NetX Windows Installer from our Service Portal.
- Right-click on the .exe file and Run As Administrator. The installation wizard will begin; click Next to continue.
- Click I Agree to accept the license agreement and continue.
- Choose the folder that your existing installation resides in.
- Choose the folder where your JDK installation resides. The installer should automatically find this location, so taking the default path is recommended. Click Next to continue.
- The installer will inform you on which version you are upgrading. Click the OK button to continue.
- To complete the installation, click Finish. Proceed to the Upgrading Solr section below.
Upgrading Solr
If you are upgrading from a version older than 10.x, and have already followed the instructions in Upgrading to Solr 8 on Windows please skip to Verifying the upgrade.
Each time that you upgrade NetX, you will need to copy the new version of the Solr core into your Solr application folder. The commands below are formatted for Powershell.
- Stop the Solr application:
& 'C:\Program Files\Solr\bin\solr.cmd' stop
- Copy the C:\Program Files\NetXposure\solr-cores\8\netx folder into C:\Program Files\Solr\server\solr\ and overwrite when prompted.
- Paste the synonyms.txt file you backed up earlier into C:\Program Files\Solr\server\solr\netx\conf and overwrite when prompted.
- Start Solr:
& 'C:\Program Files\Solr\bin\solr.cmd' start
Starting the NetX service
After the NetX application files have been upgraded, the new Solr core is copied over and the Solr service started, it's finally time to start the NetX service. Before you can do that, you must check the account that the NetX service uses to ensure it has the correct permissions.
- Open the Services console.
- Right-click on the NetX service and click Properties
- Click the Log On tab. Under Log on as, ensure that the Local System option is selected. Note: If you want to use Local Service or a custom service account instead, you will need to grant those accounts Full Control permissions to the NetX application directory before starting the service.
- Click OK to save changes.
- Right-click the NetX service again and click Start to start the service.
Some NetX upgrades include database schema changes that may take a long time to complete on your server. When you see the log entries shown below appear in the Tomcat log: C:\Program Files\NetXposure\logs\stderr.log, it's safe to assume that the core upgrade process (version control) has completed. DO NOT restart your server or stop the NetX service before you see these entries appear, or you may risk a corrupt installation or database state.
If you'd like to watch the progress of version control, you can monitor the main application log here: C:\Program Files\NetXposure\logs\exogen.log.
Wed Dec 04 12:15:38 PST 2019 EXOGEN INFO: Event channels started: category
Wed Dec 04 12:15:38 PST 2019 EXOGEN INFO: Event channels started: asset
Wed Dec 04 12:15:38 PST 2019 EXOGEN INFO: Event channels started: view
Wed Dec 04 12:15:38 PST 2019 EXOGEN INFO: Event channels started: constituent
Wed Dec 04 12:15:38 PST 2019 EXOGEN INFO: Event channels started: version
Wed Dec 04 12:15:38 PST 2019 EXOGEN INFO: Event channels started: glacier
Wed Dec 04 12:15:38 PST 2019 EXOGEN INFO: Event channels started: cache
Wed Dec 04 12:15:38 PST 2019 EXOGEN INFO: Event channels started: user
Wed Dec 04 12:15:38 PST 2019 EXOGEN INFO: Event channels started: clock
Wed Dec 04 12:15:38 PST 2019 EXOGEN INFO: Event channels started: statistics
Wed Dec 04 12:15:38 PST 2019 EXOGEN INFO: Event channels started: dataset
Wed Dec 04 12:15:38 PST 2019 EXOGEN INFO: Event channels started: system
Wed Dec 04 12:15:38 PST 2019 EXOGEN INFO: Event channels started: websocket
Wed Dec 04 12:15:38 PST 2019 EXOGEN INFO: Event channels started: view_metadata
Wed Dec 04 12:15:38 PST 2019 EXOGEN INFO: XMP engine: EXIFTOOL
Wed Dec 04 12:15:38 PST 2019 EXOGEN INFO: Event channels started.
Wed Dec 04 12:15:38 PST 2019 EXOGEN INFO: Guava services started.
Wed Dec 04 12:15:38 PST 2019 EXOGEN INFO: Database batch updater started.
Verifying the upgrade
- Log into NetX, go to System > Overview, and check the Application version. The application version should match the New Version that was listed in the installer wizard.
- Verify that assets and thumbnails are available. If they aren't, make sure that Solr is running.
- Reindexingis often recommended after an upgrade. For more information on how to perform a reindex, and how to check if a reindex is running on your site, see Rebuilding the Search Index.