3.6.5 Upgrade procedure

(1) Procedure for backing up the data from the upgrade target

Perform the procedure below in the pre-upgrade environment.

Note

For details about the properties and directories cited in this procedure, see the documentation for the product being upgraded.

1. Create a backup folder in a location of your choice.

2. Create a folder named contents directly under the backup folder.

3. Execute the following command to export all the Operational Contents to the contents folder:

   Navigation-Platform-installation-directory\bin\npexport backup-folder-path\contents\backupcontents.zip

4. Create a folder named htdocs directly under the backup folder.

5. Copy the following folder into the htdocs folder directly under the backup folder:

   Navigation-Platform-installation-directory\PP\uCPSB\httpsd\htdocs\ucnpuserstaticfiles

6. If there are a folders other than ucnpuserstaticfiles in the htdocs source folder indicated in step 5, copy them into the htdocs folder directly under the backup folder.

   However, the ucnp folder does not need to be copied.

7. Copy the following folder to just below the backup folder:

   Navigation-Platform-installation-directory\conf

8. If you are upgrading JP1/Navigation Platform from a version earlier than 12-50 to version 12-50 or later, convert the character encoding of existing property files to UTF-8 with the native2ascii Java tool.

   You need to convert the following property files contained in the Navigation-Platform-installation-directory\conf folder, which you copied to just below the backup folder in step 7:

   • ucnp_label_user_ja.properties

   • ucnp_message_user.properties

   • ucnp_user.properties

   • ucnp_setup_user.properties

   Execute the following command to convert the character encoding of the property files to UTF-8:

   native2ascii -reverse -encoding UTF-8 name-of-property-file-to-be-converted file-name-for-temporary-storage
   copy file-name-for-temporary-storage name-of-property-file-to-be-converted

   Note:

   Make sure that this procedure for UTF-8 conversion is executed only for existing property files that need to be converted.

   Additionally, we recommend that you back up property files before converting them.

9. If plugins are being used, back them up.

   Perform the following step if you are upgrading a development environment.

   Back up the following folders by copying each folder to the backup folder:

   • Navigation-Platform-installation-directory\pluginSDK

   • Navigation-Platform-installation-directory\usrlib\sys

   • Navigation-Platform-installation-directory\PP\uCPSB\CC\server\usrconf\ejb\uCNP_J2EE\usrconf.properties

   • Navigation-Platform-installation-directory\PP\uCPSB\CC\server\usrconf\ejb\uCNP_J2EE\usrconf.cfg

   • Resource adapter settings files (connector attribute files)

     In the development environment, these files can be acquired from the location that was specified when the cjsetprop command was executed.

   If you are upgrading an execution environment, back up the following directory by copying it to the backup folder:

   • Navigation-Platform-installation-directory\plugin_files

   If the plugin data is stored in another location, obtain the required files based on the list in 6.6.1 Files that are received from the development environment, and back them up.

10. Note the number of times the database has been extended.

    For future reference, note the number of files starting with usr_contents_ in the following folder, which corresponds to the number of times the database has been extended:

    Navigation-Platform-installation-directory\PP\DB\AREA

11. Stop Navigation Platform.

12. Back up the operation logs.

    Perform this step if you have enabled the operation log function.

    Back up the following folder by copying it to the backup folder.

    Folder to back up

    Navigation-Platform-installation-directory\operationlogs

    The operation log storage folder can be changed by changing the property ucnp.base.server.operationlog.path in the user property file (ucnp_user.properties). If the property has been changed from its default value, back up the folder specified as the value of the property to the backup folder.

13. Back up the dashboard server's memory capacity settings.

    Perform this step if you are using the dashboard function.

    Create the opensearch folder in the backup directory and copy the following source folder, including the folder itself:

    Source folder

    Navigation-Platform-installation-directory\PP\OpenSearch\opensearch\config

14. Back up the tasks.

    Perform this step if you have created tasks that execute commands provided by Navigation Platform.

    Create the task folder in the backup directory, and then back up the settings of the tasks that execute commands provided by Navigation Platform.

To Page Top

(2) Procedure to perform unsetup to restore the previous version's environment

Perform the unsetup procedure by consulting the documentation for the product that is to be upgraded.

To Page Top

(3) Uninstall the previous version's environment

Perform the following procedure in the environment where the unsetup procedure was completed:

1. Uninstall the product to be upgraded by following its documentation.

2. Restart the OS.

3. If there are any remaining logs or other files you want to keep in the Navigation Platform installation directory, back them up before deleting them.

4. Delete the following folder:

   Navigation-Platform-installation-directory

To Page Top

(4) Upgrade JP1/Base

In the case of an environment in which JP1/Base has been set up, perform the following procedure:

Note

For details about using JP1/Base in this procedure, see the JP1/Base User's Guide. For details about the properties in this procedure, see the documentation for the product being upgraded.

1. Upgrade JP1/Base.

   After upgrading JP1/Base, start or restart the JP1/Base-related services as needed.

2. If you are upgrading JP1/Base from a version earlier than 11-00, change the JP1 permission levels specified in JP1/Base as follows:

   Before change	After change
   JP1_IMNP_Admin	HNP_Admin
   JP1_IMNP_Editor	HNP_Editor
   JP1_IMNP_User	HNP_User

3. If the current JP1/Base version is earlier than 12-50 and that version will continue to be used without upgrading, add the JP1 permission level HNP_Creator for Content Creators to the JP1 permission levels specified in JP1/Base.

   Edit the definition in the JP1/Base user permission level file as described in the following table, and then execute the jbsaclreload command:

   File path	File name	Item to be changed	Changed definition
   %ProgramFiles(x86)%\Hitachi\JP1Base\conf\user_acl	JP1_AccessLevel	; for Hitachi Navigation Platform	HNP_Admin:HNP_CONTENTS:Refer,Update,Create,Admin HNP_Creator:HNP_CONTENTS:Refer,Update,Create HNP_Editor:HNP_CONTENTS:Refer,Update HNP_User:HNP_CONTENTS:Refer

For details about how to use the jbsaclreload command, see the manual for JP1/Base.

To Page Top

(5) Upgrade JP1/Automatic Operation

In the case of an environment linked to JP1/Automatic Operation, perform the following procedure:

1. Upgrade JP1/Automatic Operation.

   For details about how to upgrade JP1/Automatic Operation, see the JP1/Automatic Operation documentation. After upgrading JP1/Automatic Operation, start or restart the JP1/Automatic Operation-related services as needed.

2. If you are using the Automatic Operation Service Execution Plugin, delete the directory specified in the ucnp.base.client.jp1ao.submittask.passwordfile.path property.

To Page Top

(6) Upgrade Eclipse

Perform the following steps when you are upgrading a development environment.

1. Back up the settings from the Eclipse that was installed before the upgrade.

2. Uninstall the Eclipse that was installed before the upgrade.

3. Set up the new Eclipse.

   For details about setting up Eclipse, see the manual JP1/Navigation Platform Development Guide.

To Page Top

(7) Install Navigation Platform

For details about how to install Navigation Platform, see 3.5.2 Procedure for a new installation.

To Page Top

(8) Revise the user setup property file

Copy the sample file for the post-upgrade user setup property file (ucnp_setup_user.properties), and modify the settings as needed. For the location of the sample file and where to copy it to, see 8.3.2 Storage location of the user setup property file.

Because different properties will be available before and after the upgrade, and there will be properties whose default value has changed, you must not use the user setup property file that was backed up. For details about the differences between the properties before and after an upgrade, see Appendix D. Properties That Need to Be Checked When a Version Upgrade is Performed.

To Page Top

(9) Set up Navigation Platform

For details about how to set up Navigation Platform, see Chapter 4. Setting Up Navigation Platform.

To Page Top

(10) Extend the database

Use the npextendrdarea command (extend the database) to extend the database by only the number of times the database had been extended previously, which you noted during the backup procedure.

To Page Top

(11) Restore the data from the upgrade target

Restore the pre-upgrade environment by copying to the post-upgrade Navigation Platform the data that was backed up in (1) Procedure for backing up the data from the upgrade target.

1. Edit the backed-up user property file (ucnp_user.properties) and service properties file (ucnp_service.ini).

   Some properties that were available in the previous version might not be available after the upgrade. Examine the differences between the properties before and after the upgrade and then edit the properties files. For details about the differences between the properties before and after an upgrade, see Appendix D. Properties That Need to Be Checked When a Version Upgrade is Performed.

   In addition, if you change the path to the installation directory upon the upgrade, you have to check all settings that contain the path.

2. If you use the dashboard function, manually migrate the settings that define users of the dashboard function. (This step is applicable only when you upgrade Navigation Platform either from Hitachi Navigation Platform 10-50 or later or from JP1/Navigation Platform versions 11-50 to 12-00.)

   Because the mode of management of users of the dashboard function (users who are allowed access to the Dashboard window) has changed since JP1/Navigation Platform 12-10, you have to manually migrate the settings that define users of the dashboard function.

   For the ucnp.base.server.dashboard.auth.userids property^# in the user property file (ucnp_user.properties), specify a list of user IDs of users who are not only allowed to log in to Navigation Platform but are also allowed access to the Dashboard window.

   #

   Immediately after setup, the following values are set. Modify these settings as necessary.

   - When JP1 authentication is used to authenticate users (user authentication by JP1/Base): user1,jp1admin

   - When an authentication scheme other than JP1 authentication is used to authenticate users: user1

   The names (user IDs) of the registered users of the dashboard function prior to the upgrade are specified in the following files:

   • Navigation- Platform-installation-directory\conf\kibana.htpasswd^#

   • backup-directory\conf\kibana.htpasswd

   #

   After the upgrade, this file is no longer used. If you do not need it, delete it.

   Note:

   Skip step 2 if you do not use the dashboard function.

3. If you have customized the contents of messages, reset the messages in the user message properties file.

   Configure the messages that were customized in the backed-up user message properties file in the post-upgrade user message properties file.

   Backed-up user message properties file	User message properties file after upgrade
   backup-directory\conf\ucnp_message_user.properties	Navigation-Platform-installation-directory\conf\ucnp_message_user.properties
   backup-directory\conf\ucnp_message_user_ja.properties	Navigation-Platform-installation-directory\conf\ucnp_message_user_ja.properties

4. If you have associated JP1 events with Operational Contents prior to the upgrade, copy the backed-up JP1 event mapping file to the folder indicated below.

   File to be copied

   Backup-directory\conf\ucnp_jp1event_mapping.txt

   Destination directory

   Navigation-Platform-installation-directory\conf

5. Restart Navigation Platform.

6. Copy the backed-up User Plugins.

   For details about the procedure to use in an execution environment, see 6.6 Applying the files created in the development environment. However, instead of the data in the section Files to import from the development environment, copy the data that was backed up in (1) Procedure for backing up the data from the upgrade target.

   In the case of a development environment, reconstruct the environment based on the following table.

   Acquired file	How to restore
   Navigation-Platform-installation-directory\pluginSDK	Copy the backed-up plugins to the following directory, overwriting any files with the same names: Copy source directory backup-directory\pluginSDK\plugin Copy destination directory Navigation-Platform-installation-directory\pluginSDK\plugin After copying the plugins, see the description about building plugins in the manual JP1/Navigation Platform Development Guide. If the installation directory has changed, change the following class paths as needed: Navigation-Platform-installation-directory\lib\ucnppluginif.jar Navigation-Platform-installation-directory\syslib\ucnpsys.jar Navigation-Platform-installation-directory\lib\ucnpclasses.jar Navigation-Platform-installation-directory\PP\uCPSB\CC\client\lib\j2ee-javax.jar
   Navigation-Platform-installation-directory\usrlib\sys	See the description about adding plugins in the manual JP1/Navigation Platform Development Guide.
   Navigation-Platform-installation-directory\PP\uCPSB\CC\server\usrconf\ejb\uCNP_J2EE\usrconf.properties	See the description about changing J2EE server settings in the manual JP1/Navigation Platform Development Guide.
   Navigation-Platform-installation-directory\PP\uCPSB\CC\server\usrconf\ejb\uCNP_J2EE\usrconf.cfg
   Resource adapter settings files (connector attribute files)	See the description about adding database connectivity in the manual JP1/Navigation Platform Development Guide.

7. Copy the backed-up static files to the following folder:

   Navigation-Platform-installation-directory\PP\uCPSB\httpsd\htdocs

   Do not overwrite the ucnp folder directly below the destination htdocs folder.

8. Execute the following command to import the Operational Contents:

   Navigation-Platform-installation-directory\bin\npimport -d backup-folder\contents\backupcontents.zip

   Note:

   When JP1/Navigation Platform is upgraded from a version earlier than 12-50, the names of groups to which Operational Contents belong are changed if they include a backslash (\). Starting from JP1/Navigation Platform 12-50, a backslash (\) in a name of a group to which an Operational Content belongs is interpreted as a separator for group levels. To address this, a backslash (\) used in existing group names is replaced with two consecutive backslashes (\\) when they are imported (which causes no change in the displayed names).

   If the npimport command (import Operational Content) terminates with an error, message KDCZ10382-E is output, and the name of the access permission group in the message is Standard access permissions, perform the procedure described in (16) If the npimport command (import Operational Content) terminates with an error below.

To Page Top

(12) Restore the operation log

Perform this procedure if you have enabled the operation log function. In this procedure, the operation log storage folder can be changed by changing the property ucnp.base.server.operationlog.path in the user property file (ucnp_user.properties). Substitute the new folder name as appropriate.

1. Stop Navigation Platform.

2. Delete all the files in the operation log storage folder.

3. Copy the operation log.

   After renaming the operation log, copy it as follows.

   Source

   Operation log under the backup folder

   Destination

   Navigation-Platform-installation-directory\operationlogs

   After the operation log has been copied, no analysis results will be displayed in the Reporting window until the time set in the service properties file (ucnp_service.ini) has elapsed.

4. Start Navigation Platform.

To Page Top

(13) Update search data

Update the search data. If the search function is enabled but no search data update interval has been set in the service properties file, use the npupdatesearchdata command (update search data) to update the search data.

To Page Top

(14) Reconfiguring the dashboard server's memory capacity settings

Perform this step if you are using the dashboard function.

1. Open the following file in a text editor:

   backup-directory\opensearch\config\jvm.options.npsettings.txt

2. Check the memory size.

   -XmsNNNNm (NNNN: numeric value): Minimum size (MB)

   -XmxNNNNm (NNNN: numeric value): Maximum size (MB)

3. Execute the following command, in which the memory sizes checked in step 2 are specified:

   Navigation-Platform-installation-directory\bin\npdashboardsetstoragememory minimum-size maximum-size

4. Start the dashboard server.

To Page Top

(15) Restore the tasks

Perform this step if you have created tasks that execute commands provided by Navigation Platform.

From the following folder, restore the settings of the tasks that execute commands provided by Navigation Platform:

backup-directory\task

To Page Top

(16) If the npimport command (import Operational Content) terminates with an error

Perform the following procedure when the npimport command (import Operational Content) terminates with an error, message KDCZ10382-E is output, and the name of the access permission group in the message is Standard access permissions:

1. Specify true for the property ucnp.base.server.acl.defaultacl.name.japaneseonly in the user property file (ucnp_user.properties).

2. Restart Navigation Platform.

3. Execute the following command to re-import the Operational Contents:

   Navigation-Platform-installation-directory\bin\npimport -d backup-folder\contents\backupcontents.zip

4. Change the name of the access permission group.

   Log in to Navigation Platform with system administrator permissions and change the name of the access permission group Standard access permissions to a name other than or Standard access permissions. For information about how to change the name of the access permission group, see 6.2 Setting access permissions for Operational Contents (when using a directory server for user authentication).

5. Specify false for the property ucnp.base.server.acl.defaultacl.name.japaneseonly in the user property file (ucnp_user.properties).

6. Restart Navigation Platform.

To Page Top