This article walks through the step-by-step procedure required to update older versions of the product to the latest release. This is a onetime requirement, as future updates will be handled by the new product installer.

Create License Database

Note: The License database is common to all Emgage products. If you already have an existing Emgage product with a licensing set up in your environment then you can skip this step entirely and proceed to the "Run the Upgrade" step.

  1. Open the SQL Scripts folder inside the extracted release package you were provided. This folder contains an SQL script file .sql that will automate the process of creating the license database on your SQL server.

  2. We recommend that you create the license database on the same SQL server that you originally created the other emage product-related databases. Connect to this SQL server using SQL Server Management Studio and open/execute the sql script file. This will create the AP_LicenseManagement and other databases as per the installing product.

  3. If Turbo App is being upgraded then it will create TurboApps database and the user ateraTURBOUser. If Prime is being upgraded then it will create PrimeSettings_SP database and the user primeSettingsUser .inside SQL server after successful execution.

  4. Verify that the ateraLicenseUser has the correct permission to the license database by expanding the Security > Logins objects, right-clicking ateraLicenseUser, and selecting Properties. Select the Server Roles option and ensure sysadmin is checked. Now select the User Mapping option and ensure ateraLicenseUser has db_owner rights to the AP_LicenseManagement database.

  5. Verify the db_owner is checked if not then checked it and click on OK button.

  6. Step 4 to be followed for “primeSettingsUser” for PrimeSettings_SP database.

Add License Connection String to web.config of all WFEs

Once the License database has been created, you will need to edit the web.config file of all web applications on all WFE's using Turbo Builder to add the required connection string.

  1. First, create a backup of the web.config. We recommend making a copy of the file and renaming it using the following format web_<Year>_<Month>_<Day>_<Hour>_<Minute>_<Seconds>.bak

  2. Open the web.config in the editor of your choice and do a search for connectionstrings. This will bring you to the <connectionstrings> tag, which will already contain an existing connection string with the name AteraSettings

    Copy the following connection strings and paste it to the web.config directly after the initial <connectionstrings> tag: 
    <add name="AteraPrimeLicensing" connectionString="DataSource=SERVERNAME;database=AP_LicenseManagement;User ID=ateraLicenseUser;Password=AteraPrime#1" providerName="System.Data.SqlClient" />

  3. Replace the SERVERNAME portion of the connection string with the name of the SQL server on which you created the License database.

  4. Repeat this process for the web.config of all web applications on all WFE’s using the upgrading product. 

Run the Upgrade

Note: While running the upgrade your SharePoint environment will experience 10-20 minutes of down time, while the new solutions deploy, so please plan accordingly.

  1. Open SharePoint Central Administration (run as Administrator), navigate to System Settings > Manage farm solutions and retract/remove the ateraprime.assetmanager.wsp solution.

  2. Open SharePoint site collection where you want to install Turbo Builder and select View All Site Content from Site Actions menu.

  3. Go to Style Library > Emgage folder within document libraries and delete the common and product-related folder like Turbo, TurboView, or Prime folder if it exists.

  4. If Prime is being upgraded then make sure to take a backup of all the custom .less and .css files from the Emgage | Prime Stylizer Themes and then delete Emgage | Prime Stylizer Themes.

  5. Launch SharePoint Management Shell (run as Administrator).

  6. From within SharePoint Management Shell navigate to the Solutions folder inside the extracted release package you were provided.

  7. Run the deploy.ps1 script (the command to execute is .\deploy.ps1). This script will retract the existing solutions and then deploy the new solutions. During the time the script is running your SharePoint environment will experience downtime.

  8. If the deploy.ps1 script fails to run, you may need to right-click on the deploy.ps1 file, select Properties and click Unblock (located at the bottom of the General tab). 

Activate Site Collection Features

We are almost there! Once the deployment completes we need to activate the Licensing feature.

  1. Navigate to Site settings > Site collections features and Activate the Emgage | Licensing feature if it has not already been activated. If it was already activated then deactivate and then reactivate again.

  2. For SharePoint 2013 Standard/Enterprise environments, navigate to Site settings > Manage site features and ensure the Minimal Download Strategy feature is not Active. Deactivate this feature if necessary.

  3. The following features should be deactivated and then reactivated manually in sequence to complete the upgrade procedure:

  • For TURBO Builder
    • Emgage | Asset Manager
    • Emgage | TURBO Apps

  • For Turbo View
    • Emgage | Asset Manager
    • Emgage | TURBO View Feature

  • For Prime (Activate the features which you need will like to use)
    • Emgage | Licensing
    • Emgage | Asset Manager
    • Emgage | Facebook Feed Web Part
    • Emgage | Calendar Web Part
    • Emgage | Database Doctor
    • Emgage | Facebook Feed Web Part
    • Emgage | How-Do-I Web Part
    • Emgage | News Web Part
    • Emgage | Perks Web Part
    • Emgage | Prime Alerts Widget
    • Emgage | Prime Feedback Widget
    • Emgage | Prime Footer Feature
    • Emgage | Prime Look and Feel
    • Emgage | Prime Mega Menu Feature
    • Emgage | Prime My Links Feature
    • Emgage | Theme Document Library
    • Emgage | Prime Stylizer
    • Emgage | Prime Web Part Page Templates
    • Emgage | Stocks Web Part
    • Emgage | Tasks Web Part
    • Emgage | Twitter Feed Web Part
    • Emgage | Video Player Web Part
    • Emgage | Weather Web Part

Apply the License for the product

If the above steps were performed successfully, accessing your site collection (which previously had the product we are upgrading) will now redirect you to the Emgage Products Licensing page where you can apply your product-specific license. If the product is not installed before and it has not been applied, you can also access the Emgage Products Licensing page from Site Settings > Product Licensing (under the Emgage Settings heading).

  1. While on the Emgage Product Licensing page, copy/paste your license key (provided by the Emgage support team via email) into the License Key input under the name of a product heading and click Apply License.
  2. Upon validation, the message above the License Key input will turn green and let you know the license is active. This activation only needs to be performed one time per SharePoint Farm.
  3. If your license key does not validate please contact Emgage support using the Submit a request link at the top of this page. 

Note: After successful installation, perform the following additional steps in case you see the error message "Connection String for Database not found" while accessing the product:

  1. Go to Central Administration.
  2. Go to System Settings.
  3. Select Manage Farm Solutions.
  4. Locate "aterasettingspackage.wsp"
  5. Retract it and then Re-Deploy it.
  6. Go to Manage Web Applications section.
  7. Select your web application.
  8. From the Ribbon, select Manage Features.
  9. Activate Emgage.SharePoint.Licensing WebApplication feature.