Product upgrade

Upgrade from iPortal 8C and earlier

If you are using the SuperMap iPortal 7C series or 8C version and need to upgrade to SuperMap iPortal 8C SP1 version or a newer version, please contact the SuperMap iPortal team for product upgrade service. Contact number: 010-59896716.

From the SuperMap iPortal 8C SP1 release, iPortal achieved independent deployment and no longer contained a built-in SuperMap iServer application server. The product upgrade of the previous version mainly includes the following areas:

• Portal content upgrades include online maps, registered services, created groups, managed data, managed services, services posted by portal administrators, monitoring data, etc.
• User account data upgrade
• Portal configuration information upgrade
• Front-end portal custom content upgrades

Upgrade from iPortal 8C SP1 and later

From SuperMap iPortal  8C SP1, a script file for product upgrade is provided in the product package, which can be used for quickly upgrading the iPortal version. The upgrade script file is located in the [SuperMap iPortal installation directory]\support\upgrade directory, the autoUpgrade.bat file (for Windows platform) and the autoUpgrade.sh file (for Linux platform) in the directory can help you automatically upgrade most of the portal content,  configuration files, pictures, etc. The following describes how to use the upgrade script:

1. Before upgrading iPortal, please back up the old-version iPortal to avoid possible accidents.
2. If the old-version iPortal you prepare to upgrade is running, please stop the service first.
3. Unzip the new iPortal product package that replaces the old-version iPortal.
4. Edit and save the OLD_PKG and NEW_PKG variables in the %SuperMap iPortal_HOME%\support\upgrade\autoUpgrade.bat file (corresponding to the autoUpgrade.sh file under Linux systems), as shown below:

set "OLD_PKG=D:\supermap_iportal_8.0.1a_win64_zip"

set "NEW_PKG=D:\supermap-iportal-9.1.0-win64-zip"

• OLD_PKG: The absolute path to the root directory of the old-version iPortal, cannot end with "/" or "\"
• NEW_PKG: The absolute path to the root directory of the new-version iPortal, cannot end with "/" or "\"

5. Run the upgrade script. Double-click to run autoUpgrade.bat in the Windows system. Switch to the %SuperMap iPortal_HOME%\support\upgrade directory in the Linux system, and enter the following command:

./autoUpgrade.sh

6. After running the script, the portal data, configuration files, and homepage customization in the old-version iPortal have been migrated to the new iPortal, and the product upgrade has been completed. Run {IPORTAL_HOME_NEW}\bin\startup.bat (startup.sh in Linux system) to use the new iPortal.

Note: To understand the specific operations of the script during the upgrade process, please refer to %SuperMap iPortal_HOME%\support\upgrade\readme_en_US.txt.

Contents that need to be upgraded manually

After upgrading by running the script, there are still some files need to be manually upgraded:

1. Edit the {IPORTAL_HOME_NEW}/conf/server.xml of the "new-version iPortal" according to {IPORTAL_HOME_OLD}/conf/server.xml of the "old- version iPortal", especially the Server port, connector port and other custom configurations.
2. The iportal-storage.xml in the new-version iPortal needs to be configured through the interface: Management>Server Management>Hosted Server>Hosted Data Configuration, and the parameters should be consistent with the configurations in your old-version file: {IPORTAL_HOME_OLD}/webapps/iportal/WEB-INF/iportal-storage.xml, refer to: Hosted services configuration.
3. If the "old-version iPortal" has been customized in theme, then you need to:

1) Copy the newly added custom theme file {IPORTAL_HOME_OLD}/webapps/iportal/resources/web-ui/config/themes/ThemeSetting_**.json in the "old-version iPortal" to the new-version iPortal directory {IPORTAL_HOME_NEW}/webapps/iportal /resources/web-ui/config/themes.

2) Compare the custom theme file ThemeSetting_**.json with the {IPORTAL_HOME_NEW}/webapps/iportal/resources/web-ui/config/themes/ThemeSetting_blue.json file structure of the "new-version iPortal". Then copy the newly added json object in the ThemeSetting_blue.json file to ThemeSetting_**.json, and assign a custom color value to overwrite it.

3) Refer to {IPORTAL_HOME_OLD}/webapps/iportal/resources/web-ui/config/themes/themes.json of "old-version iPortal" to edit and configure {IPORTAL_HOME_NEW}/webapps/iportal/resources/web-ui/config/themes/ themes.json of "new-version iPortal", or re-import the customized theme through the interface through Administration>Site Configuration>Site Customization>Theme Management.

4. If the "old-version iPortal" has been customized in multiple languages and new languages have been added, then you need to:

1) Compare {IPORTAL_HOME_NEW}/webapps/iportal/resources/web-ui/config/Language_**.json (new language configuration file) and {IPORTAL_HOME_NEW}/webapps/iportal/resources/web-ui/config/Language_en .json file. Copy the newly added json objects in the Language_en.json file to the Language_**.json file, translate and overwrite them.

2) Compare {IPORTAL_HOME_NEW}/webapps/iportal/resources/admin-ui/lang/Language_**.json (new language configuration file) and {IPORTAL_HOME_NEW}/webapps/iportal/resources/admin-ui/lang/Language_en .json file. Copy the newly added json objects in the Language_en.json file to the Language_**.json file, translate and overwrite them.

5. If the "old-version iPortal" has been configured with CAS single sign-on, you need to refer to {IPORTAL_HOME_OLD}/webapps/iportal/WEB-INF/shiro.ini of "the old-version iPortal" to edit and configure{IPORTAL_HOME_NEW}/webapps/iportal/WEB -INF/shiro.ini  of the "new-version iPortal" .
6. To upgrade the portal resources stored in ElasticSearch, you need to edit {IPORTAL_HOME_NEW}/webapps/iportal/WEB-INF/iportal.xml of the "new-version iPortal", and change the value of ImportalConfig>modulesConfig>searchModuleConfig>reindexAllResources to true.
7. If you want to change the version number in the copyright information, you can configure it through Administration>Site Configuration>Site Customization>General Content>Copyright Information.
8. If the old-version iPortal is a version earlier than SuperMap iPortal 10i, the homepage you customized in the old-version iPortal will not be upgraded. It is recommended that you use the new-version iPortal homepage customization function to re-customize your iPortal homepage.
9. If the old-version iPortal has been expanded the backstage management interface, you need to refer to {IPORTAL_HOME_OLD}/webapps/iportal/WEB-INF/urlrewrite.xml of the "old-version iPortal" to edit and configure {IPORTAL_HOME_NEW}/webapps/iportal/WEB-INF/urlrewrite.xml of the "new-version iPortal", copy the custom configuration items in the old version to the new version.
10. If the old-version iPortal is lower than 11i, when upgrading to 11i+, you need to edit {IPORTAL_HOME_NEW}/webapps/iportal/WEB-INF/config/search/WEB-INF/ search-beans.xml. Change
    the TCP port of the ElasticSearch server from 39300 to HTTP port 39200:

<bean id="esSetting" class="com.supermap.iportal.search.commontypes.ESSetting">

    ...

    <property name="port" value="39200"></property>  

    ...

</bean>

• port: The HTTP protocol communication port number of Elasticsearch. Default: 39200.
11. If the old-version iPortal has edited or upgraded the iportal-ehcache.xml file (located in the directory {IPORTAL_HOME_OLD}/webapps/iportal/WEB-INF)
    ), then you need to edit the {IPORTAL_HOME_NEW}/webapps/iportal/WEB-INF/iportal-ehcache.xml of the new-version iPortal by referring to the old configuration.