• AssetManagement. Folders and files for the Document Management Functionality
• Bin. Required .NET assemblies
• CMSServiceUpdate. Files to update your services
• CommonFiles. Application Global Resources, Web References and Starter Application files
• Documentation. Documentation. The site setup procedure copies this directory to the workarea directory when setting up a site.
• EktronAsyncProcessor_Service. Files needed to add Asynchronous Processor for Web Alerts
• StarterSites. Files for starter sites that have been added
• StudioHelp. Files for adding API help to Visual Studio
• SyncUpdate. Files to update eSync
• Utilities. Utilities for
  • database upgrade
  • database application strings update
  • email encrypt password tool
  • a setup SharePoint Portal
  • Document Management Registration tool
  • Load Balancing service files

• Workarea. Scripts used for the Workarea

  NOTE: The contents of this folder are later copied to a website folder, typically in the Web server’s Web root. The sample provides a good way to learn how to work with an Ektron site.

Backing up databases

To protect your database, back it up before upgrading. During the upgrade, Ektron attempts to back up your database. If that fails, use the following MSDN link for instructions on backing up and restoring your database via SQL Server.

• Backup SQL Server

NOTE: On that web page, links for restoring a backed-up database are at the bottom of MSDN resources.

Before restoring a SQL database, either stop the Ektron Windows service or force all connections closed. You need to do this because the Ektron Windows Service accesses the database. To view and update the status of the service, go to Computer Management > Services and Applications > Services. For more information, see Handling background processing functions with the Ektron Windows Service.

Upgrade overview

The upgrade procedure performs these tasks.

1. Installs new files to new directories. See also: Installing the Ektron base.
2. Removes the following folders (and their subfolders) from and copies new folders to your site directory.
   • bin
   • workarea
   • Documentation

   WARNING! Any customized files in these folders will be lost. So, only store custom files in these folders when absolutely necessary. Even then, keep a backup of customized files in another folder.

3. Updates the web.config file.
4. Updates your databases using the upgrade and language update utilities.

   NOTE: The upgrade automatically starts the IIS and Search services.

Performing the upgrade

1. If you have not done so already, install a Search provider. You must use an external search provider if you want to use search with Ektron. See also: Setting up search for your website.
2. Copy the Assets folder.

   NOTE: This step is only relevant if you are using Microsoft Search Server 2010 on a server that is different from your Ektron server.

   For Microsoft Search Server 2010 to index your Ektron assets, they must be copied from the Web server to the Search Server. This process is handled in the background once your site is up and running. However, if your site has a large number of assets, the initial copy may get clogged. To avoid this problem, inspect the size of your Ektron site's Assets folder. If it exceeds 1 gigabyte, follow these steps. Failure to do so may result in errors.

   1. Create a folder on your search server to hold the assets. The folder's path must match the path to your Ektron site's Assets folder and include EktronSearchData between C:\ and the beginning of the path.
      For example, if your site's Assets folder is C:\inetpub\wwwroot\OnTrek85\Assets, create a folder on your Search Server named C:\EktronSearchData\inetpub\wwwroot\OnTrek85\Assets.
   2. Copy the Assets folder from your Ektron site folder to the Search Server folder you created in Step a.
3. Follow the steps of the installation procedure, Installing the Ektron base, which instruct you to install Ektron and restart your server. Continue to the next step when the Site Setup Selection appears.
4. The Setup wizard appears. (If this screen does not appear, launch it by following this path from the Windows Start menu: Start > Programs > Ektron > CMS400vxx > Utilities > Site Setup. If you're using Windows 8 or 2012, press the Windows key ()/Q then enter CMS400 Site Setup.)
   —Image—

   

5. The Setup Type screen appears. Choose CMS400 Upgrade and click Next.
   —Image—

   

6. Choose an application directory. If you are not sure, use the default (C:\Program Files(x86)\Ektron\CMS400vxx). This directory stores Ektron components and utilities.

   NOTE: This dialog appears only if Setup cannot detect the location of the site’s application directory.

   —Image—

   

7. If your server operating system accommodates multiple websites, select the site to which you want to upgrade Ektron. Otherwise, accept the default.
   —Image—

   

8. Select the path of the website you are upgrading. Note that the upgrade only updates the web.config file, Ektron assembly files, and Web servicesEktron Windows Service uses Windows Web Services to perform these activities: • Schedules the future publication and removal of content. • Transmits notifications that a sync should be started between the staging and production servers. • In the 3-Tier feature, transfers data between servers./Workarea components. It does not update your templates nor other files not mentioned above.
   —Image—

   

9. The following message appears. Click Yes to back up your site.

   WARNING! Ektron strongly recommends backing up your site before continuing the upgrade. If you choose No and the upgrade fails, you cannot revert the files to their original state.

   —Image—

   

10. If you choose to back up your site, a dialog asks where to store the backup, and provides a suggested folder.
    —Image—

    

11. If you chose to back up your site, you may see the following dialog.
    —Image—

    

    Click Yes if you want the installation to

    1. Enable IIS's IP Address and Domain Restrictions role.
    2. Restrict access to the /workarea/webservices and /workarea/services folders and the /workarea/ServerControlWS.asmx file, so they are only accessible from localhost.

    If you click No, the site installation is terminated.

    For more information, see https://portal.ektron.com/kb/10234/.

    If you click Yes and complete the installation, you may have to grant permission to other servers that need to access the restricted folders and file. To do this:

    1. Go to IIS.
    2. Choose the /workarea/webservices folder.
    3. Choose IP Address and Domain Restrictions.
    4. Click Add Allow Entry from the right panel
    5. Add IP addresses for each server that will access this server's /workarea/webservices folder.
    6. Repeat Steps a through e for the /workarea/services folder and the /workarea/ServerControlWS.asmx file.
12. On the Search Provider screen, determine which search provider you will use with Ektron.
    —Image—

    

    See also: Setting up search for your website.

13. The Site Options screen appears. Check the box next to each option you want to install. Boxes are grayed out if an option is not available for your site. See also:
    • Viewing network server diagnostics
    • an eSync security certificate. See also: Managing eSync security certificates.
    • Using Ektron’s Developer SDK
14. After choosing, click Install.

    NOTE:
    eSync is only available if you have the eSync modifier in your license key. SDK is only available if Visual Studio 2010 is installed on your server.
    

    —Image—

    

15. You are asked if you want to update your siteroot/widgets directory. Click Yes to install the latest widgetA mini-application that you place on a Web page using PageBuilder; a widget provides either specific functionality (calculators, search, social bars, and so on) or areas into which you can add content (content blocks, list summaries, collections, and so on).s. Before doing so, rename any customized widgets in that folder; otherwise, they will be overwritten.
16. You are notified that files are moving to the starter site directory. The Choose Destination Location screen appears.
17. Enter the path to your AssetManagement Directory.

    NOTE: This dialog appears only if the upgrade cannot find the AssetManagement directory.

    —Image—

    

18. If you chose to do so, your site is backed up. Next, the bin, Workarea and other files are updated. Any missing permissions or Index catalogs are added.

    WARNING! The previous version’s bin and Workarea folders are removed from your website. Any customized files within these folders are lost. Do not store custom files in them unless absolutely necessary. Even then, always keep a backup file in another folder.

19. Your web.config file is updated with information needed to run Ektron. If other applications use the web.config file, their sections are unaffected.
20. A dialog asks if you want to upgrade the database. Select Yes to upgrade. If you select No, the site will not work properly until the database upgrade has been run. To upgrade the database at a later time, run the Site Setup and select Database Upgrade. The site setup is located in Start > Programs > Ektron > CMS400vxX > Utilities > CMS400 Site Setup. If you're using Windows 8 or 2012, press the Windows key ()/Q then enter CMS400 Site Setup.
21. If you selected yes, the Database Upgrade Wizard appears. Click Install.
    —Image—

    

22. This screen prompts for database connection information.
    —Image—

    

    Server. List the database server on this system. To set up the database on this server, accept the default. Otherwise, enter a SQL or SQL Express server that already exists. For SQL, this would typically be (local) if it’s installed on the local server. Otherwise, enter the Server’s name. For SQL Express, enter (local)\SQLEXPRESS.

    NOTE: This dialog appears if you are using SQL Authentication. If you are using Windows Authentication, skip to the next step.

23. A dialog appears asking you to back up your database. See also: Backing up databases
    —Image—

    

24. If you clicked Yes, select the location of your database backup. If this path does not exist on your database machine, the backup will fail. Otherwise, skip to the next step.
    —Image—

    

    IMPORTANT: If the backup fails, the following message appears: Warning! The install could not backup your database. Please manually back it up now before continuing. You should manually back up your database before clicking OK.

25. If your license key was not generated for the 9.x Release, you are prompted to enter a 9.x license key. If you do not have an 9.x license key:
    • Complete the upgrade.
    • Obtain a 9.x license key from Ektron (send email to [email protected]).
    • Log in as builtin user. See also: Editing the builtin username and password.
    • Insert the key into the Settings > Configuration > Setup screen's > General tab >License Key(s) field.
26. If you selected Microsoft Search Server as a search provider, the following screen appears.
    —Image—

    

    • If you have already upgraded the search server to use the Search components, click Yes. (This would typically be the case when an Ektron site on the server is already using search).
    • If you have not set up a search provider, or the Ektron search components have not yet been installed or upgraded to , click No.

      After completing the Ektron CMS installation, install the search provider and the search components.

    If you chose Solr, the following dialog appears. Click OK.

     

    

    To complete the search setup, log on to the search server, click the Windows Start menu > All Programs > Ektron > CMS400Vxx > Utilities > Search Configuration. If you're using Windows 8 or 2012, press the Windows key ()/Q then enter Search Configuration.

    The Connection Information screen appears. See also: 

    • Installing Solr on a single on-premises (local) server
    • Setting up Microsoft Search Server 2010 Express
    • Setting Up Microsoft Search Server 2010
    • Working with Microsoft FAST search

After upgrading your site and rebuilding the solution, you are ready to use Ektron.

If you did not run the database upgrade or language update during the installation, you need to do it manually. The next sections explain how to do that.

Troubleshooting upgrade problems

Problem 1: After upgrade, Ektron does not load properly. Also, an error icon appears next to your templates when you open the project in Visual Studio.NET. The problem is that your .NET references need to be updated.

Solution 1: To verify the problem, open the Ektron solution file in Visual Studio.NET (webroot\siteroot\cms400sitename.sln; for example, cms400Intranet.sln) and look at the template files. If your references are broken (as shown in the sample screen on the left), delete all Ektron references. Then, add new references with the same name from the webroot\siteroot\bin folder.

Problem 2: When viewing a page containing Ektron server controls or API calls, the page returns a fatal error Compiler failed with Error Code 2000. Detailed compiler output may say Fatal error BC2000: compiler initialization failed unexpectedly: The filename, directory name, or volume label syntax is incorrect. This error message might appear after an upgrade.

Solution 2: To remove the error message, open up your site's .sln file in Visual Studio. Then, rebuild the solution using the Build > Rebuild solution menu option.

In this case, the error can be resolved by correcting the database settings in web.config.

NOTE: To use SQL Authentication with Microsoft SQL server (as opposed to Windows Authentication), you must have the database 'Security' properties set to allow "Windows and SQL Authentication." After changing this setting, you must restart SQL Server for it to take effect.

Problem 3: After upgrading from Ektron version 4.8 or earlier, Metadata is no longer applied or required when adding or editing content.

Solution 3: In Ektron version 4.8 or earlier, Metadata is applied globally. In later versions, metadata is applied to each folder individually. Child folders can inherit the metadata from a parent folder or they can have their own metadata settings. To set the metadata settings back to global:

1. In the Workarea, click the site root folder.
2. Next, choose View > Folder Properties.
3. Click Edit Properties.
4. Click the Metadata tab.
5. Check the all of the appropriate check boxes for Assigned and Required Metadata.
6. Click Save.

If you have not broken inheritance on any of the folders, your metadata settings are applied globally.

UTC datetime storage in the database

If you upgrade from an older version of Ektron, the UTC Converter is automatically run after the database upgrade is complete.

Dates in the CMS are stored in UTC rather than in the server time zone, and display in the local user’s selected time zone. The dates default back to the server time zone if the user is not logged in.

1. Choose one of the Ektron sites from a provided list.
2. Choose the time zone from which to convert data.
3. Click Run. The conversion occurs and UTC automatically closes.

   NOTE: If UTC Converter is opened while running an upgrade, you are not permitted to change the "Site."

After installation, you can find the UTC converter at C:\Program Files (x86)\Ektron\CMS400v93\Utilities\UTCConversion\UTCConverter.