Upgrading to NexJ CRM version 8.9

Follow these instructions to upgrade NexJ Contact version 6.1, 7.0, 7.1, or 7.2 or an earlier version of NexJ CRM to NexJ CRM version 8.9.

If you are upgrading from a version of NexJ Contact prior to version 6.1, you need to upgrade to version 6.1 and then follow these instructions to upgrade to NexJ CRM version 8.9.

Before upgrading, you must update the environment files, back up and update the application servers, and back up and upgrade the databases for your deployment. Also ensure that you have upgraded your metadata model. For more, see Upgrading models.

NexJ strongly recommends clearing or truncating the NJSession table for any upgrade that requires a reseed. Doing so preserves client user states.

As a best practice, NexJ also recommends that you upgrade the Push Redirector to match your application framework version when you upgrade the application.

To upgrade to NexJ CRM version 8.9:

1. For security reasons, NexJ Systems has changed the deployment directory structure for NexJ Server. If your upgrade to 8.9 involves deploying to the same server location you used previously for NexJ Server, you will need to make the following changes before you start up the NexJ Server:
   • To preserve transactional logs, move the files from <SERVER_HOME>\deploy\<nodeX>\data* to <SERVER_HOME>\data\<nodeX>\*.
   • If you have manually set up custom or third-party libraries (for example, jtds-*.jar) in <SERVER_HOME>\deploy\<custom>.jar, move them to <SERVER_HOME>\jvm\<custom>.jar.
   • Update the modeld service (replace modeld with the appropriate service name for NexJ Server):
     • On Windows, update the Registry using the following steps:
       1. Open the Registry Editor (Start > Run > type regedit > click OK).
       2. Navigate to HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\modeld.
       3. Update the ImagePath value by removing \lib from the path.
       4. Navigate to HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\modeld\Parameters.
       5. Update the Current Directory and -Djava.class.path values by replacing instances of \deploy with \jvm.
     • On Linux, update the modeld systemd service script using the following steps:
       1. Edit the /etc/systemd/system/modeld.service file.
       2. Replace ${MODELD_HOME}/deploy/nexj-bootstrap.jar with ${MODELD_HOME}/jvm/nexj-bootstrap.jar.
     • Alternatively (either platform), re-install the modeld service and ensure any custom changes are re-applied.

     • If you have upgraded the Push Redirector, reinstall the Push Redirector service. For example, on Windows, from the <SERVER_HOME>\bin directory, run the following commands:

       pushrd-svc.bat -u
       pushrd-svc.bat -i

2. If you run the application server in a Linux environment, you must add the Arial font, which is required by predefined reports. For more information, see Installing the Arial font in Linux environments.
3. If you are upgrading from any of the following versions, you must perform upgrade steps specific to that version:
   
   NexJ Contact version 6.X
   You must update the KYC seeder. For more information, see Updating the KYC seeder.
   
   NexJ Contact version 7.2 or earlier
   You must update State enumeration values used in integrations or transformations with external sources and in custom UIs. For more information, see Updating State enumerations for integrations and custom UIs.
   You must update ETL methods for bulk deletion. For more information, see Updating ETL methods for bulk deletion.
   It is strongly recommended that you convert any existing project .dump files to Scheme dump scripts. In NexJ CRM version 8.2, .dump files were deprecated. Scheme dump scripts replace .dump files. For more information, see Converting dump files to Scheme dump scripts.
   If you use SLM data, you must run the updateReportsByDateRange batch process in NexJ Admin Console for the first batch process. For more information, see Running the updateReportsbyDateRange batch process for SLM periods.
   
   NexJ CRM version 8.2 or earlier
   If you have customized class names for predefined schedule reports, you must update certain class names. For more information, see Updating schedule report class names.
   
   NexJ CRM version 8.3
   If you have specified unicode attribute for data source connections, you must specify the wchar attribute. The wchar attribute replaces the unicode attribute. For more information, see Setting the wchar attribute for data source connections.
4. Update the environment file or the connections file to remove old or deprecated connections. For more information, see Removing obsolete connections for version 8.9.
5. Update the environment file or the connections file with new data source connections, channel connections, and SOA connections. For more information, see Adding new connections for version 8.9.
6. Update the environment file or the server and connections files with other changes required to support new functionality. For more information, see Updating server information for version 8.9.
7. Back up application server files.
8. Back up all databases.
9. If you are upgrading from any of the following versions, you must perform upgrade steps specific to that version:
   
   NexJ Contact version 6.X
   You must create the AuditLogDatabase, LockDatabase, and ObjectQueueDatabase data sources, which are required to support new features. For more information, see Creating new required data sources for version 8.9.
   
   NexJ Contact version 7.1 or earlier
   You must create the NJStatVersion table for the StatDatabase data source. For more information, see Adding the NJStatVersion table to the StatDatabase data source for version 8.9.
10. Upgrade all databases. For more information, see Upgrading data sources for version 8.9.
11. Upgrade the application servers.
    For more information about upgrading WebSphere application servers, see Upgrading the WebSphere application server for version 8.9.

12. If you previously created anonymous NexJ user and want to now use the default user with no privileges instead, edit the appropriate security setting in your environment file.

    Info

    In NexJ CRM versions prior to 8.8, creating an anonymous NexJ user was required to synchronize NexJ CRM with Microsoft Exchange Server. Starting NexJ CRM version 8.8, this is no longer required.

    To use the default functionality for anonymous requests:

    1. In NexJ Studio, open the .server or .environment file.

    2. In the Overview tab, click the Security subtab.

    3. In the Anonymous User field, ensure that there is no user name specified.

    4. Save and close the .server or .environment file.

13. If you are upgrading from an installation of NexJ CRM that does not support rich text for document notes in Document Manager and you want to enable this feature, run the BatchUpdatePlainConvertToHTMLCommand -updateTextField batch file to enable the rich text feature. For more information, see Enabling rich text support.

14. If you use Internet Explorer version 11 Enterprise Mode, you must turn it off. NexJ CRM version 8.9 is not compatible with Internet Explorer version 11 Enterprise Mode. For more information, see https://docs.microsoft.com/en-us/internet-explorer/ie11-deploy-guide/turn-off-enterprise-mode.

15. Deploy the application.

16. Start the application and verify that it has deployed successfully.

After completing these steps, you can now run NexJ CRM version 8.9.

You might also need to perform the following upgrade steps: Additional upgrade considerations.