This article will walk through the process of upgrading to Version 13.0 Super Search. Learn more about Version 13.0 features.
Unlike previous upgrades, you can't test this upgrade if your test site is on the same server as your production site. This upgrade replaces ColdFusion 8/9/10 and Railo 3.3 with Railo 4.2, and these server components are shared by your test and production site when hosted on the same server.
This version requires a minimum of 8 GB of RAM on a Windows 2008 or higher 64-bit server. The only possible exception to this is if your SQL Server database service is running on a separate machine. In this case, you can run with 4 GB of RAM. If your web server doesn't meet these requirements. it's highly recommended that you migrate to a new server.
1. Check Server Requirements
Please ensure the current server meets the server requirements for Super Search.
The upgrade will install 700MBs of new files under your web root directory (typically located on the C: drive), as well as requiring space for the new search index, depending on the number of entries and files in your installation. We recommend having at least 2GB of free hard drive space before upgrading.
This version is compatible with Chrome, Firefox, and Internet Explorer (IE) 9+.
2. Update to Latest 12.5 Patch
Always start by updating your 12.5 Mega version to the latest patch (currently Patch 17).
3. Backup Current Intranet
This upgrade will modify both your database and intranet files.
It is very important to backup both your database and files.
- Take a backup of the Intranet folder from the web root as .zip file
- Backup the database using Management Studio as a .bak file.
If you have a virtual environment, it would be recommended to take a snapshot ahead of upgrading.
1. Prepare a New Server (optional)
If you are upgrading to a new server. Please see Preparing a New Server for instructions on how to prepare the new server.
2. Export current installation details
To upgrade your intranet, certain configuration information must be provided to the upgrade installer (database and mail server settings, intranet location, etc). This information needs to be exported from your current intranet installation to the setup details file before the upgrade installer is run.
The Create Setup Details File article explains how to export your intranet configuration file.
3. Follow the instructions that match your environment from the 3 options below:
a. Remove ColdFusion Handler Mapping (Only if updating your current CF environment)
Reminder! Unlike previous upgrades, you can not test this upgrade if your test site is on the same server as your production site. This upgrade replaces ColdFusion 8/9/10 and Railo 3.3 with Railo 4.2, and these server components are shared by your test and production site when hosted on the same server.
This step can be skipped for Railo environments or those migrating to a new server.
On the web server, open the program Web Server Configuration Tool. The program name is wsconfig.exe and the path is typically C:\ColdFusion10\cfusion\runtime\bin\wsconfig.exe or C:\ColdFusion9\runtime\bin\wsconfig.exe
Use the Web Server Configuration Tool program to remove CF handler mappings from all IIS sites. On the web server, t If you are running other ColdFusion applications, you can optionally choose to remove ColdFusion handler mappings for just the intranet web site.
Simply choose the intranet site or All sites (server) and click Remove. If you need to maintain CF support for other sites, you can use this same tool to manage the handler mappings for them. If you have no other sites requiring CF, it is recommended to alter the ColdFusion services (.NET Service, Application Server, ODBC Agent, ODBC Server, etc) to Manual startup and stop these services. If you have no further requirement for ColdFusion you can permanently uninstall it after finishing the upgrade to Railo.
Note that after removing the handler mappings, you will be prompted to restart your web server. This will be done automatically by the upgrade process, so it not necessary before proceeding.
3. b. Remove Railo 3 Tomcat (Only if updating your current Railo environment)
If you have an installation of Railo 3 Tomcat on your current production server, you will first need to uninstall this before proceeding with the upgrade. The upgrade installer will perform a check first before proceeding and if it encounters an installation of Railo Tomcat, it will stop the upgrade from proceeding. There should be an option from add / remove programs to uninstall Railo.
How do you check if you have Railo Tomcat installed? Log into your intranet as a Super Admin > click admin > Setup > Execute Custom Code > paste the following script into the box provided:
Click 'Execute' to run this script > in the results screen, you should see 'Tomcat' listed here if your installation is indeed Railo Tomcat.
3. c. Railo 3
If you do not have Railo 3 Tomcat or ColdFusion installed, proceed on to #4 below.
4. Run the Upgrade Installer
When prompted for credentials, the Username is the email address of the primary contact we have on file. The password is your IC serial number
b. Run the Upgrade Installer on the server as an administrator.
NOTE: You must be logged into the server as Administrator. Logging as a non-administrator and right-clicking to "Run as Administrator" will not allow the installation to complete successfully because the installer must call several other executables during the installation process.
The upgrade install now updates to version 13.0.7.
Screen 1 - Select setup details file exported in Step 2 "Export current installation details" above.
Click Browse and select the setup details file (IC_12.5._InstallDetails.xml).
Screen 2 - Choose the Intranet folder location
If you are upgrading an existing server, click Next.
If you are upgrading to a new server, please click "Change" and select the location of your Intranet folder if this is different.
Screen 3 - Select the location of your IntranetConnections database
Click Browse to verify that the IntranetConnections database exists, and click Next.
If you have restored a copy of your database on a new SQL server, enter the new connection information. The connection information will be used during the upgrade process, as well as by the intranet to access the database after upgrade (used in Railo datasource).
In some cases, the password for the IntranetConnections SQL login can not be read from the setup details file, and you will receive an error message "Login failed for user 'IntranetConnections'. Try the default password "ICu$er&[email protected]". If this fails, please contact your database administrator.
Screen 4 - Installation
Once you click "Install" the installation will begin and take up to 15 minutes. Note that during this time IIS (Intranet Information Server) will be stopped and all websites on the server, including the intranet, will be unresponsive.
Once the installer is complete, click "Finish" to close it.
Please ensure you continue on to the next step before accessing the intranet.
5. Clean-Up Old Files (Mandatory)
If you access your site at this time, you will see something similar to the following screen:
A number of older files must be deleted for the upgraded intranet to work properly. To clean up these files:
- Confirm that the _CleanFiles folder exists under the /Intranet folder on your web server. If this does not exist, you can download it from the links available at the bottom of this article (_CleanFiles.zip). The path to the files inside should look like: /Intranet/_CleanFiles/run.cfm
- Browse to the downloaded cleanup script under your Intranet site
- Eg. http://localhost/Intranet/_CleanFiles/run.cfm
OR http://localhost/_CleanFiles/run.cfm (if website path points directly to the intranet folder)
- Eg. http://localhost/Intranet/_CleanFiles/run.cfm
You should see the above message and a list of any files that were found and deleted. It will delete files no longer in use, CF Encoded files, and hot fix files now part of the latest release.
Once this is completed you can delete this folder from your Intranet directory (_CleanFiles).
6. Verify Mail Server (CF environments only)
Browse to the Railo Web Administrator (usually http://localhost/railo-context/admin/web.cfm) and login (default password is connections). Click on Mail under Services and you should see an entry for you mail server that was migrated from CF. If your mail server required a username/password, you will need to enter them in. Once you have updated the mail server, click the checkbox beside the entry and click "verify". You should see the following message if Railo could connect to your SMTP server:
Post Upgrade Steps
Once the upgrade is complete, you can immediately start using the intranet. Note that the initial indexing of your intranet content will be done in the background, and can take between 10 to 30 mins depending on the amount of content. During this time, not all items may be returned in search.
The loading of the first intranet request can take up to a minute, as the intranet application loads. Subsequent pages will load much more quickly.
See the Super Search (V13.0) Troubleshooting Guide if there are any errors after upgrading.
Note the application will be rebuilding the search index in the background after the upgrade, and it may take several minutes before all site content is searchable.
Once the upgrade has completed successfully, please do the following:
- Launch the intranet site and browse to the Admin Setup screen.
- If you migrated from ColdFusion the scheduled task will be missing. Click the [create] button to configure this in the Railo Web Administrator.
- Verify web services are working and your maintenance expiry is up to date by running the scheduled task.
- Check to see if any patches are available for 13.0 (It is recommended you apply these once the search indexing is complete)
- If you migrated to a new server: Navigate to the intranet on the new server using the URL you will be directing users to going forward. Go to Admin > Setup > look at the Web Location. If you see any messages about the web location not matching, click 'update locations' to update all link references to the old server and point them to the new one.
Cleanup of Existing Server
If you've upgraded an existing server, it's recommended to uninstall any previous CF engine that's no longer required (Railo/Zoo or ColdFusion). ColdFusion can be removed from the Add / Remove Programs area of your server.
To remove Railo/Zoo, follow these steps:
- Stop IIS
- Uninstall the Helicon Zoo native module from Programs
- Uninstall the Helicon Zoo's ISAP_Rewrite module, if present
- Delete the following folders:
- C:\railo - old
- Update the global IIS configuration to remove any references to Helicon Zoo
- Typically located in C:\Windows\System32\inetsrv\config\applicationHost.config
- First copy and backup this file
- Then use Notepad to find "Zoo" or "Helicon" entries
- Remove <sectionGroup> entries from <configSections> related to above terms
- Remove <globalModules> entries related to above terms
- Remove entire <heliconZooServer> node
- Remove <modules> entries related to above terms
- Start IIS and verify your site is working correctly