eiConsole v.24R1
Documentation

eiPlatform

Migration Guide – Windows

Introduction

You should use the new Tomcat install when migrating or installing to the new eiPlatform version. The exe version of the install has been deprecated as of release 24R1. It is recommended to use the Tomcat install even if you are migrating to an older version of the eiPlatform.

This document assumes you are installing on a server that doesn’t have the eiPlatform running as a service. If you do, please shut it down first and set its startup type to Manual in services.

Pre-Installation Steps

We are assuming that the installation to be migrated is in:

c:\Program Files\PilotFish Technology\eiPlatform Windows

1. Backup your current Interfaces in eip-root directory in your current PilotFish eiPlatform installation directory:
  c:\Program Files\PilotFish Technology\eiPlatform Windows\eip-root\interfaces
2. Backup eipServer.conf in directory:
  c:\Program Files\PilotFish Technology\eiPlatform Windows\server\eip
3. Backup environment-settings.conf in directory:
  c:\Program Files\PilotFish Technology\eiPlatform Windows\eip-root
4. Backup logConfig.xml in directory:
  c:\Program Files\PilotFish Technology\eiPlatform Windows
5. Backup any custom lib files in:
  1. c:\Program Files\PilotFish Technology\eiPlatform Windows\runtime\lib
  2. c:\Program Files\PilotFish Technology\eiPlatform Windows\jre\lib
  3. If you are using an older version currently that supports jar’s in the Working Directory lib folder, also backup those. They can be found in {WORKING_DIRECTORY}/lib. Loading jar’s from the {WORKING_DIRECTORY}/lib has been deprecated.
6. Backup entire c:\Program Files\PilotFish Technology\eiPlatform Service directory in case you missed something in previous backup steps
7. If you are installing on a new server, copy the Backup files to the new server for use after the eiPlatform Tomcat Installation

eiPlatform Tomcat Installation

You will need to create a folder like C:\PilotFish where you’ll install the software required for the eiPlatform. We will assume C:\PilotFish as the installation folder for the rest of this document, although it could be any folder.

Step 1: Downloading and Installing OpenJDK Java 17

- Open your web browser and go to the OpenJDK archives for download at https://jdk.java.net/archive/.
- Scroll down the page to find Java 17 and click on it to expand the section.
- Under the Windows column, locate and click on the ZIP link to download the OpenJDK Java 17 for Windows.
- Save the downloaded ZIP file to a location on your computer, such as the Downloads folder.
- After the download is complete, navigate to the location where you saved the ZIP file and extract its contents.
- To extract the ZIP file, right-click on it and select Extract All. Choose the c:\PilotFish folder as the destination for the extraction.

Step 2: Downloading and Installing Apache Tomcat 10

- Open your web browser and go to the Apache Tomcat download page at https://tomcat.apache.org/download-10.cgi
- Under the Binary Distributions section, find the 64-bit Windows Service Installer and click on the link to download it.
- Save the downloaded installer to a location on your computer, such as the Downloads folder.
- After the download is complete, locate the downloaded installer and double-click it to run the installation.
- Follow the on-screen prompts in the installer. You can typically leave the default installation options as they are unless you have specific requirements.
- Make sure you select the JDK you installed in the previous step. In our case it is C:\PilotFish\openjdk-17.0.2_windows-x64_bin\jdk-17.0.2
- The following screens are the only ones where you must change the defaults.
- Select the installation directory (which should be C:\PilotFish\ based on the previous steps) and proceed with the installation.

Step 3: Deployment of the eiPlatform WAR into Tomcat

- Download the eip.war from https://customerportal.pilotfishtechnology.com/portal/
  You can log in to the customer portal with your eiConsole license credentials. If you don’t have credentials or do not see the required eip.war file, contact support@pilotfishtechnology.com for assistance.
- It will be named something like eip.war.hs.23R1.127. Rename it to eip.war.
- Navigate to the Tomcat installation directory and select the webapps subdirectory. The eip.war file should be copied into that directory.
- Copy your pflicense file into the webapps\eip folder.
  You can log in to the customer portal with your eiConsole license credentials and download it. If you don’t have credentials or do not see pflicense, contact support@pilotfishtechnology.com for assistance.
- You need to restart Tomcat (see below)

Starting and stopping the Tomcat service

- You can use the Windows Services tool to start and stop the service. This can be accessed via the Windows run prompt by specifying services.msc.
- From this dialog, select Apache Tomcat 10. The left-hand panel will then give you the option to either Start or Stop the service, if it was already running stop the service and then start
- Go to the log directory webapps\eip\logs where the eip.log file is located. Review and confirm there are no startup errors.

Configuring the eiPlatform after Tomcat Install

1. Copy the backup files from the Pre-Installation Steps – Step#1 to
  c:\PilotFish\webapps\eip\eip-root
2. Copy the backup version of eipServer.conf file from Pre-Installation Steps – Step#2 to
  c:\PilotFish\webapps\eip
3. Copy the backup version of environment-settings.conf from Pre-Installation Steps – Step#3 to
  c:\PilotFish\webapps\eip
4. Copy the backup version of logConfig.xml file from Pre-Installation Steps – Step#4 to
  c:\PilotFish\webapps\eip
5. Copy the lib files from Pre-Installation Steps – Step#5 to
  c:\PilotFish\webapps\eip\WEB-INF\lib

Post Configuring the eiPlatform Steps

After you do the configuration, please restart the server. Check the eip.log and confirm there are no errors.

Starting, Stopping and Restarting the Tomcat Service

- You can use the Windows Services tool to start and stop the service. This can be accessed via the Windows run prompt by specifying services.msc.
- From this dialog, select Apache Tomcat 10. The left-hand panel will then give you the option to either Start or Stop the service. If it was already running stop the service and then start it.
- Go to the logs webapps\eip\logs where the eip.log file is located. Review and confirm there are no startup errors.

Regression Test All Routes

Perform regression tests for all the things you know should work and were working in the older version of the eiPlatform to make sure everything is working properly with the new version.

Structured Data