Version 13.0 (Super Search) Upgrade

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 and Railo 3.3 with Railo 4.2 which 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 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.

Prepare Server

We recommend having at least 2GB of free hard drive space before upgrading.

If you're looking to migrate to a new server, this is a great upgrade to do so as you'll be moving away from ColdFusion or Railo 3, and migrating to Railo 4.

Configure your existing or new server with the following:

  1. Confirm your server meets the server requirements
  2. Web Server access:
    • Web Server local admin access - upgrade requires the ability to create a folder on the C drive
    • Disable Access Control
    • Disable Anti-Virus software
    • Apply pending updates and restart the Web Server
  3. ASP.NET 4.5.2 or higher
  4. DefaultAppPool (Intranet's AppPool within IIS) requires .NET CLR Version set to v4.0
  5. IIS configuration
    • Disable 'Basic Authentication' on the intranet website (eg. Default Website)
  6. SQL Server
    • The System Administrator account (SA) and password will be required during the upgrade
  7. ColdFusion / Railo Web Administrator Password
    • Example of link to ColdFusion Admin: http://<servername>/CFIDE/Administrator/index.cfm
    • Example of link to Railo Web Admin: http://<servername>/railo-context/admin/web.cfm
  8. Default browser
    • For new servers, open the default web browser (eg. Internet Explorer) and complete browser configuration.
  9. Backup the Intranet Database and site files

Provisioning a new server?

  • Copy the backups of the site files and Database (Database is only required if you're hosting the SQL server on the new server) to the new server
  • Restore the Database to the new SQL Server (if applicable)
  • Move the copied Intranet folder (e.g. site files) to the new server and place it under C:\intepubt\wwwroot
  • Proceed with upgrading on the new server

Browser Compatibility

  • This version is compatible with Chrome, Firefox, and Internet Explorer (IE) 9+.
  • IE 8 can still be used by end users (same level of compatibility as Version 12.5) but with limited functionality. Due to the Javascript limitations of IE 8, and Microsoft dropping support of this browser, it is recommended to upgrade users to IE 9 or later.

Upgrade Preparations

  1. You'll need to be a Super Admin on the Intranet
  2. Update to the latest patch for 12.5
  3. Download the 13.0 Upgrade zip file (eg. IntranetConnectionsUpgrade13.0.x.zip)
    • Login to download the file:
      • The Username is the email address of the primary contact we have on file
      • The Password is your product serial number (located on your Intranet Admin > Setup tab)
    • Save the file to C:\Temp
    • Right-click on the file > click Properties > check the box beside 'Unblock' > click OK
  4. Download one of the following scripts, depending on your environment:
  5. Replace 'connections' on the first line of InstallDetails file with your Railo/ColdFusion password
  6. In the Intranet, navigate to Admin > Setup >Execute Custom Code link under Extensions - If you do not see this link, this means that you're not a Super Admin
  7. Paste content of the downloaded script file into the Execute Custom Code text box
  8. Click execute
  9. Save the IC_12.5._InstallDetails.xml file and move it to your web server prior to upgrading

For ColdFusion environments, if you encounter 'Datasource could not be created & verified', you'll need to change the 'DBIntranetConnectionsPassword' to reflect your own password for the SQL Server 'intranetconnections' user: <cfparam type="string" name="DBIntranetConnectionsPassword" default="YOUR_PASSWORD">

If your ColdFusion/Railo admin password includes the character "#", please add an extra "#" within the InstallDetails so that it can be recognized (e.g. if your password is "SteveNash#13", then you should enter "SteveNash##13" in the file).

Environment Changes

Follow the instructions that match your environment from the 3 options below:

A) ColdFusion - Remove ColdFusion Handler Mapping

  1. On the web server, open the program Web Server Configuration Tool
    • To open the program manually, locate and run wsconfig.exe
      • ColdFusion 9 path: C:\ColdFusion9\runtime\bin\wsconfig.exe
      • ColdFusion 10 path: C:\ColdFusion10\cfusion\runtime\bin\wsconfig.exe
  2. Select All sites (server) and click Remove (Refer to image below)
  3. Restart not required
  4. Skip to the Instructions section below

It's not recommended to keep ColdFusion on the same server as Railo once the upgrade is complete. 

B) Railo

  1. On web server, open Control Panel > Programs and Features > uninstall Railo (if applicable)
  2. Continue to the Instructions section below

Instructions

  1. Log into the web server as a Local Administrator
  2. Right-click the Upgrade Installer on the server and click run as administrator
  3. Browse and locate the IC_12.5._InstallDetails.xml file on the web server, click Next
  4. Confirm the site files folder path, click Next
  5. Confirm Database server settings
    • Existing server - click Browse to verify that the IntranetConnections database exists, and click Next.
    • New SQL Server - enter the new connection information.
    • 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'. Have your database administrator change the password for the IntranetConnections user in SQL and update the password to match.
  6. Click Install to proceed - this process will take approximately 15 minutes
  7. Click Finish
  8. Clean-Up Old Files
    • Navigate to the /Intranet folder on your web server and confirm that the _CleanFiles folder exists
      • If this folder is missing, download the _CleanFiles.zip file and extract the contents
      • Move the /_CleanFiles folder under the Intranet folder (e.g. the path to the files inside should look like: /Intranet/_CleanFiles/run.cfm)
    • In your browser, run the cleanup script:
      • Intranet requires /intranet in the URL: http://<server name>/Intranet/_CleanFiles/run.cfm
      • Intranet doesn't require /intranet in the URL: http://<server name>/_CleanFiles/run.cfm
    • If ran correctly, you'll see the message 'Deleting files no longer needed'
  9. Browse to the Intranet

Verify Mail Server (ColdFusion environments only)

  1. Browse to the Railo Web Administrator (e.g. http://<server name>/railo-context/admin/web.cfm)
  2. Login (contact support for the default password)
  3. Click Mail under Services and confirm your mail server is listed
    • If your mail server required a username/password, you'll need to enter them.  
    • Click the checkbox next to your mail server and click Verify.

Post Upgrade Steps

Search may not be available for up to 30 minutes after the upgrade process completes as content indexes in the background.

Once the upgrade has completed successfully:

  1. Launch the intranet site and navigate to Admin > Setup
  2. If you migrated from ColdFusion the scheduled task will be missing.  Click the [create] button to configure this in the Railo Web Administrator.
  3. Verify web services are working and your maintenance expiry is up to date by running the scheduled task.
  4. Check to see if any patches are available for 13.0 (It is recommended you apply these once the search indexing is complete)
  5. 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

Once upgrade has completed, there may be some additional cleanup steps to complete depending on your environment:

ColdFusion - Uninstall ColdFusion and all of its services using add/remove programs, or Programs and Features

Railo Helicon Zoo - Follow the additional steps (Applies only in cases where Railo wasn't removed in Programs and Features mentioned in the Environment Changes section above)

  1. Stop IIS
  2. Uninstall the Helicon Zoo native module from add/remove programs, or Programs and Features
  3. Uninstall the Helicon Zoo's ISAP_Rewrite module, if present
  4. Delete the following folders:
    • C:\jetty7
    • C:\railo3
    • C:\railo - old
    • C:\Zoo
  5. Update the global IIS configuration to remove any references to Helicon Zoo
    1. Typically located in C:\Windows\System32\inetsrv\config\applicationHost.config
    2. First copy and backup this file
    3. Then use Notepad to find "Zoo" or "Helicon" entries
    4. Remove <sectionGroup> entries from <configSections> related to above terms
    5. Remove <globalModules> entries related to above terms
    6. Remove entire <heliconZooServer> node
    7. Remove <modules> entries related to above terms
  6. Start IIS and verify your site is working correctly

Related articles