Version 15.0 (Accelerated Search & Security) Upgrade

In this article, you'll find instructions to upgrade to Version 15.0 (Accelerated Search & Security), as well as prerequisites required prior to performing the upgrade. Learn more about the feature enhancements in Version 15.0.

Preparation is key to a successful upgrade. Ensure all of the following items have been checked off before beginning your upgrade.

In the instructions below, we reference to a path that begins with C:\sqbox, if this is not how your webserver is configured, you may see a similar configuration of:

• C:\SQBoxServices
• C:\inetpub\wwwroot\TaskManager
• C:\inetpub\wwwroot\Intranet

If none of the above paths match your configuration, please open Services on the webserver:

• ElasticSearch location - Right-click on ElasticSearch > click properties > look for path to executable and note this down (this tells you which drive to run the installes.bat on later in the instructions).
• Services/SQBoxServices - Right-click on the SQBoxTaskManager service > click properties > look for the path to executable and note this down for the prep instructions where you'll be replacing files within the services folder.
• Intranet folder location - Open IIS > right-click on the site > click explore to locate the path to the Intranet folder. Up from the Intranet folder level, you'll find the TaskManager folder which will be referenced in the prep instructions to replace the files in the TaskManager\Modules\ folder.

Windows 2012 or 2012R2 and older: If you're on an older server, please review our Software Requirements as our minimum recommendation is to use Windows Server 2016. Contact Support@icthrive.com regarding what migrating to a new server will look like.

Start by reading the Upgrade Process Overview article to understand the entire process.

1. Contact Support@icthrive.com to download the 15.0.6 Upgrade file
2. Download the current 15.0 patch file (if patches 7+ are available when upgrading)
3. Confirm the web server has the following minimum Server Specifications for 15.0:
   • CPU: 1 * Quad Core
   • RAM: 16GB
4. Apply the latest patch for your version to the intranet (14.0 Patches or 14.5 Patches)
5. Log onto your web server as a local administrator (Domain Administrator logins do not have enough rights) - disable both User Access Control and Anti-Virus software.
6. Move the ICUPG1506_FULL.zip and patch file to the web server
7. Right-click the zipped ICUPG1506_FULL.zip folder and select Properties.  At the bottom of the properties window check if there is an option for Unblock; if there is, apply the Unblock option
8. Unzip the ICUPG1506_FULL.zip folder on the C Drive (e.g.
   C:\Temp\ICUPG1506_FULL\ICUPG1506)
   • IMPORTANT: Please make sure the Upgrade file is extracted on the C Drive, otherwise the upgrade will fail
   • Inside the unzipped folder, you'll see 3 files: Services.zip, ICUPG1506.zip, DataBridgeTask.zip
9. Unzip all 3 zip files in the ICUPG1506 folder
10. Uninstall the SQBoxServices service - Open the Windows Command Prompt, navigate to the folder with the SQBoxServices.exe file (e.g. c:\sqbox\services) and execute the command: SQBoxServices.exe uninstall
11. Delete the contents of the TaskManager\Modules\ folder (default location: c:\sqbox\webroot\TaskManager\Modules\)

12. On the UPG1506_FULL folder, expand the DataBridgeTask folder and copy the folder (also named DataBridgeTask) and its contents to the TaskManager\Modules folder.

13. Make sure they are inside a DataBridgeTask Folder: c:\sqbox\webroot\TaskManager\Modules\DataBridgeTask

    • If done correctly, it should look like this:

14. Replace the Services files (default location is c:\sqbox\services) with the ICUPG1506\Services folder contents:
15. Install the new SQBoxServices service - Open the Windows Command Prompt again, navigate to the folder with the SQBoxServices.exe file and execute the command: SQBoxServices.exe install
    • If this doesn't run hit enter again and you should see the above text once it completes.

16. Start the new SQBox service - Still in the Windows Command Prompt execute the command: Sqboxservices.exe start

    •  As with the previous step, you may need to hit enter again if it doesn't display the additional text right away.
17. Take a snapshot of your server if using a VM

Uninstall all hotfixes BEFORE upgrading - (If you just applied the latest patch, skip to Upgrade Process)

The upgrader will show an error message if one or more hotfixes are installed.

1. On the Intranet, navigate to Admin > Setup tab
2. Click into each hotfix and click Revert Hotfix to uninstall them

Upgrade Process

Prior to starting your upgrade, back up your intranet database and application files, as outlined in the Upgrade Process Overview article. Do not proceed with your upgrade if you haven't backed up files.

1. In the ICUPG1506 folder, open the InstallDetails.txt
2. Copy the content of InstallDetails.txt to your clipboard. This script will be used to extract configuration information from your intranet to perform the migration.
   • If you've changed your Lucee administrator password from the default, update it in in text file as shown below

6. On your Intranet, go to the Admin area > Setup tab.
7. In the Settings section under Extensions, click Execute Custom Code (note: you must be logged in as a Super Admin to see this option).
8. Paste into the message box area of the execute custom code box and click Execute. Your browser will download an XML file containing the configuration details of your intranet.
   • Note: If you have hotfixes installed, you will see this warning message:
9. Save this file and place it on your web server in the ICUPG1506\config folder
10. Right-click the start.bat file located in the ICUPG1506 folder and click Run as administrator.
11. At the “Uninstalling Lucee” step, you will be prompted with the following options:
12. Click ‘Yes’ to confirm the removal of the old Lucee version
13. Next, you'll see "Source Upgrade 15.0 finished successfully!"
14. Press any key to close the window - Next, you'll install Elasticsearch 6.6.2 
    • IMPORTANT You must close the upgrader window BEFORE installing Elasticsearch to update environmental components
15. Right-click the installes.bat file located in the ICUPG1506 folder and click Run as administrator.
    • IMPORTANT: If your Elasticsearch is installed on a drive other than C, copy the installes.bat file to that drive before running it.
16. In your intranet's Admin area, look on the Setup tab to verify you're now on Version 15.0.6 
17. Install latest 15.0 patch (applicable if patch 7+ are available)
    • Copy the patch zip file into the ../intranet/updates folder
    • Right-click > properties > unblock file
18. Remove the Announcements and updates XML files from this folder: 
19. Import new IC Thrive web services certificate ws.icthrive.com into Lucee server

    • If you use http://intranet.mycompany.com to access the intranet, your URL for the console needs to be HTTP://intranet.mycompany.com/lucee/admin/server.cfm)

    • If you use http://mycompany.com/intranet to access the intranet, your URL for the console needs to be HTTP://mycompany.com/lucee/admin/server.cfm

    • If you access the console on the webserver itself, you can also use the server name in place of the intranet URL: HTTP://yourservername/lucee/admin/server.cfm

    • Click “SSL Certificates” in the left menu

    • Type in ws.icthrive.com into the Host field and 443 into the Port field

    • Click Install.

    • If your site is SSL protected (e.g. https://myintranet.domain.com/), import the SSL certificate for 'myintranet.domain.com' (replace with your site domain), into Lucee Server

20. Reboot web server

21. On the intranet, navigate to Admin > Setup tab > click Site Search from the top of the Setup tab screen

22. Adjust Search Indexing Configuration settings as desired and save/run to kick-off the indexing process

    • Note: The system needs to run full indexing for the first time so you are able to search items in your intranet with the new Elasticsearch version

    • Once your site has been indexed, you should see something similar to the screen below:

 Post-Upgrade Steps

1. On the web server, set the User Account Control setting back to its previous level, and enable the anti-virus software.
2. Delete the temporary folder ICUPG1506 on the webserver.
3. Adjust the memory settings for Lucee and ElasticSearch
4. Ensure your scheduled tasks are running (Admin > Scheduled Tasks). System Tasks should be enabled, Web Services should be enabled unless this is a development environment, and Active Directory Sync should only be enabled if you are using AD Sync.
5. Ensure that when you hover over the Admin icon and click the Stats link that the stats page opens.
6. The day after upgrading, ensure that data shows on the stats page.

Troubleshooting

Error using Search

If you encounter this error when searching on your intranet: 

Locate the web.config file on your webserver (usually found in the Intranet folder, or one level up) and remove the line <clear /> as shown below:

Save the file and try to search once more.

Issues finding items or errors with ElasticSearch - Reinstall ElasticSearch

1. Locate the ElasticSearch installation folder by opening Services > right-click on “Elasticsearch 6.6.2” > click “Properties” > copy path listed under “Patch to executable:”

2. In the Windows Command Prompt, navigate to the Elasticsearch folder (i.e.: C:\sqbox\elasticsearch\bin\) and execute the commands:
   elasticsearch-service.bat remove
   elasticsearch-service.bat install
   elasticsearch-service.bat start
   
   
   

Should you encounter any additional issues, contact support@icthrive.com for assistance.