Ektron 9.00

Setting Up Microsoft Search Server 2010

This section explains how to install Microsoft Search Server 2010 Express. After installing it, follow Configuring Microsoft Search Server to configure the search provider. To learn how to use the search, read Using Microsoft Search Server Features.

Best Practice 

In general, do not install Microsoft Search Server 2010 on a server that also hosts Ektron. Only install both programs on the same server in a development environment.

Prerequisites

Prerequisites

  • You have purchased and deployed Microsoft Search Server 2010See Also: Product Licensing Search
  • An understanding of Microsoft Search Server 2010Search Server 2010, Best practices for Search Server 2010
  • Both servers can browse to each other across the network
  • On your Ektron server
    • Open ports 6080 and 6081 (used by the CMS File Helper Service to communicate Ektron services and copy files between the Web and Search servers)
    • Set SQL Security to SQL Server and Windows Authentication mode
    • Create a SQL user login with at minimum execute permission (db_executor) to create a content source and register the site. That user login can be assigned other SQL roles that include minimum permissions, such as sysadmin. Microsoft Search Server 2010 uses that login to access the Ektron database.

      Best Practice 

      You should update your Ektron site's web.config file's <connectionstrings> tag with the username and password of that SQL user. Set Integrated Security to False. Then, log into Ektron to verify that the connection string is valid. See Also: Managing the web.config File

  • On your Microsoft Search Server 2010 server
  • On your database server
    • Open Port 1433
Microsoft Search Server 2010 features

Microsoft Search Server 2010 Features

  • A configuration screen for connecting Ektron server with the server hosting Microsoft Search Server 2010. That screen also monitors the status of search crawls.
    —Image—

  • You can also manage search via SharePoint 2010's Central Administration console.
    —Image—

  • Workarea screens that let you
    • view the status of search crawls
    • begin new ones if needed
    —Image—

  • Create and maintain synonym sets
    —Image—

  • Create and maintain suggested results
    —Image—

  • Manage the Integrated Search
    —Image—

  • Templated controls let developers deploy search functionality to the website
    —Image—

  • Workarea search, which lets Ektron administrators and editors find content within the Workarea
    —Image—

Installing Microsoft Search Server 2010

Installing Microsoft Search Server 2010

  1. Install Microsoft Search Server 2010.
  2. Install or upgrade Ektron on its server, using the normal procedure. See Installing Ektron, Upgrading to Ektron Version Ektron 9.00. If you already installed Ektron, skip to Step 5.
  3. During the Ektron installation, choose Microsoft Search Server 2010 (Full).
    —Image—

  4. After the Ektron database setup, the following dialog appears. Click No.
    —Image—

    The Ektron installation completes.

  5. On the Ektron server, copy C:\Program Files\Ektron\CMS400versionnumber\Utilities\SearchServer\EktronSearchConfiguration.exe.
  6. On the Microsoft Search Server 2010 server, paste and run EktronSearchConfiguration.exe. The Search Administrator Credentials screen appears.
  7. Enter the domain, username, and password of a user with Windows Administrator privileges on the server you will use for Microsoft Search Server 2010.
    —Image—

  8. Determine the location of the folder that maintains the Ektron query service files.
    —Image—

  9. Select the port number to use with the Ektron query service website.
    —Image—

  10. The following screen appears. Click Yes if you are using Microsoft Search Server 2010. Click No if you are using Microsoft FAST Search Server 2010
    —Image—

  11. The Ektron files are installed and configured. A message instructs you to run the Search Configuration utility on the Ektron server. For documentation of that process, see Configuring Microsoft Search Server.

During installation, Ektron creates a new website in IIS to host the search services.

—Image—

Troubleshooting Microsoft Search Server 2010 installation

Troubleshooting Microsoft Search Server 2010 Installation

Problem: When attempting to install or upgrade search server, an error appears: Exception has been thrown by the target of the invocation.

During the search installation, the following screen appears.

—Image—

`

In rare cases, after you enter a user who is a member of the Windows Administrators group, the person's credentials are nevertheless rejected. You see this error:

The Windows user entered is not an administrator on this machine. Please enter a windows user that is the Administrators group.

Solution: Add a Windows Registry key named SkipAdminCheck to the path HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Ektron. This key skips the administrator check dialog.

Configuring Microsoft Search Server

Configuring Microsoft Search Server

This section explains how to configure search using the Express or full version of Microsoft Search Server 2010. To configure a Solr search, go to Part 2: Register your Solr Site. To configure a Microsoft FAST Search Server 2010 search, go to Part 6c: Run the Ektron Search Configuration Utility

The Search Configuration screen lets you manage the Ektron's implementation of Search Server.

IMPORTANT: Ektron‘s Search Configuration screen provides access to a few commonly-used features of your search provider. To fully use search capabilities, use the search provider's administration utility.
Also, if you remove or edit Ektron website information using IIS, you must restart the Ektron Windows Service before using the Search Server Configuration screen.

Before you log into the Search Configuration screen

Before You Log into the Search Configuration Screen

  • Is the Ektron Search Server Service started?
  • For ports opened between the Ektronserver and the search server, are firewalls off?
  • Verify that the user entered during the Search Server installation is also the user running these Windows services:
    • SharePoint 2010 Timer
    • SharePoint Server Search 14
  • Verify that the user entered during the Search Server installation is also the user set in the Advanced Settings > Identity field running these Application Pools:
    • <GUID> (there may be more than one)
    • SecurityTokenServiceApplicationPool
    • SharePoint Central Administration v4
    —Image—

Logging into Ektron's search server configuration screen

Logging into Ektron's Search Configuration Screen

  1. Log on to the server hosting Search Server as an administrator.
  2. Click the Windows Start menu > All Programs > Microsoft SharePoint 2010 Products > SharePoint 2010 Central Administration. The port number appears in the browser address field, following http://server name
    —Image—

  3. Click the Windows Start menu >All Programs > Ektron > CMS400V90 > Utilities > Search Configuration. The Connection Information screen appears.
    —Image—

  4. In the CMS Server Machine Name field, enter the Ektron server.
  5. In the SharePoint Administration URL field, enter http://, your search server name, colon(:), and port number (see Part 1: Install Microsoft Search Server 2010) For example, http://MySearchServer:12345.
  6. The Search Service Applications screen appears. Select appropriate Content and Query Service applications. Click Next.
    —Image—

    Ektron's Search Server Configuration screen appears.

Managing the search configuration

Managing the Search Configuration

This section explains how to use the Search Configuration screen.

—Image—

When your Search Server configuration is properly set to connect to your Web server, the following appears on the screen.

  • CMS Database—Information about Search Server's connections to your website.
    • Site ID—The IIS site ID on the Web server.
    • Database—The database that Search Server crawls.
    • Database Server—The name or IP address of the site's Web server.
    • Site URL—The URL visitors use to view the website.
    • Version—The website's Ektron version.
  • CMS Database Connection String—Search Server uses the CMS Database Connection string to connect to your Ektron database. If the database is on the same domain as your search server, set Integrated Security to true. Otherwise, set Integrated Security to false and enter a SQL username and password.
  • Crawl Interval—Set the incremental crawl intervalWhenever a crawl finishes, Ektron begins to track the time. After the number of seconds specified in the Incremental Crawl Interval expires, Ektron checks for changes to the database. If any occurred, a new incremental crawl starts. If none occurred, the timer is reset. Incremental crawls enhance your search's performance by using fewer resources..
  • Search Server Credentials—Enter the domain, username, and password of a user with privileges to connect to Search Server.
  • Advanced Options
    • Crawl Tracing—Use the drop-down to specify a level of detail collected by the crawl log. A separate log is created for each crawl, and is saved to the Data Directory.
    • Data Directory—Identify the folder on your Search Server that stores a copy of Ektron content needed by Search Server. The directory also stores protocol logs, which track crawl activity. The default value is C:\EktronSearchData.
    • Secondary Search Servers—Use this area to add secondary search servers to a load-balanced cluster. You would only do this on a primary server, to identify its secondary servers. See Also: Setting Up a Load-Balanced Search with Microsoft Search Server 2010
      1. In the Secondary Search Servers section, click Add ().
      2. Insert the name of the secondary servers.
      3. Click Register Site.
        —Image—

Updating the site registration panel

Updating the Site Registration Panel

If you make changes to the Site Registration panel, you need to register the site again.

  1. Start the Search Configuration Utility. See Also: Logging into Ektron's Search Configuration Screen
  2. If the Ektron server has several databases, select one from the drop-down.
    —Image—

    NOTE: If your Ektron version supports multi-site, the CMS Databases drop-down lists the multi-site database only once. The site Url may correspond to the main site or any sub-site (depending on their order in IIS).

  3. In the Search Server Credentials area, enter the Domain, Username, and Password for your Search Server.
  4. Click Register Site. A confirmation window appears.
  5. Click Yes. Progress appears in a window.
    —Image—


  6. When finished, click Close.
Troubleshooting site registration

Troubleshooting Site Registration

Error: Failed to connect to specified Search Server. Please verify that your Search Server URL and port number are valid and try again.

Possible solution:

  1. Open the Windows Services control panel.
  2. Right-click Ektron Search Server Service.
  3. Choose Properties from the context menu.
  4. Select the Log On tab from the properties dialog window.
  5. Select the radio button labeled This account.
  6. Enter the credentials to match those of the SharePoint Server Search 14 (OSearch14) service.
  7. Commit your changes.
Optimizing Microsoft Search Server 2010 with Ektron

Optimizing Microsoft Search Server 2010 with Ektron

After installing Microsoft Search Server 2010, you can do several things to optimize Ektron's use of that technology. These actions ensure you are doing everything possible to help site visitors find Ektron content.

Defining unusual file extensions used in Aliasing

Defining Unusual File Extensions Used in Aliasing

Ektron's Aliasing feature lets you create human-readable URLs, such as www.ektron.com/support. The URL Aliasing Configuration screen lets you define file types that may be applied to aliased pages. See Also: Creating User-Friendly URLs with Aliasing

If you define an aliasing file type that is not on Search Server's file type list, you must add the missing type to Search Server. Follow these steps to accomplish that.

  1. Go to Windows Start button > All Programs > Microsoft Search Server > Search Administration.
  2. Click File Types (as illustrated in the following figure).
    —Image—

  3. Review the Search Server's file type list.
  4. If you do not see all extensions defined on the URL Aliasing Configuration screen, click New File Type (shown in the previous image), then add the missing file types.
Windows services used by Microsoft Search Server 2010

Windows Services Used by Microsoft Search Server 2010

Ektron's search feature uses several Windows services to monitor database updates, determine if a new crawl needs to be launched, and perform the database crawl. This section explains the operation of these services.

  • Ektron Search Server Service
    • Runs on search server and Ektron site server.
    • Responsible for communicating between servers. It triggers search tasks such as crawling, synonym sets, and so on.
    • Whenever content is added, updated or deleted, this service changes the Search Status screen's Incremental Crawl Request Pending flag to Yes. As a result, the next time the crawl interval is reached, this service launches the Ektron CMS File Helper Service. See Also: Events that Start an Incremental Crawl
  • Ektron ProtocolHandler File Helper Service
    • Uses protocolhandler.dll file
    • Runs on Ektron server during a crawl
    • Gets content updates from database server and feeds them to Search Server
  • Ektron CMSFileHelper Service
    • Runs on Ektron site server
    • Indexes assets and sends them to Ektron ProtocolHandler File Helper Service
  • Ektron Query Service—Passes search term from Ektron server to Microsoft Search Server 2010 and returns results
How services process content updates

How Services Process Content Updates

  1. As Ektron content is added, changed or deleted, the Ektron database is updated.

    NOTE: To learn about which events trigger a crawl, see Full vs. Incremental Crawls.

  2. If the change warrants a full crawl, it is launched immediately.
  3. If the change warrants an incremental crawl, the Ektron Search Server Service updates the flag that determines if a crawl needs to be started to Yes. You can view this flag on the Search Status screen's Incremental Crawl Request Pending field. When the crawl interval expires, the Ektron CMS File Helper Service sends content updates to the Ektron Protocol Handler Service.
  4. The Ektron Protocol Handler Service feeds the content updates to Search Server.
    —Image—

How queries are processed

How Queries are Processed

Querying is the process by which Ektron retrieves content from the search index.

The Ektron site uses Ektron's Query Service to connect to Microsoft Search Server 2010.

Default settings for managed properties created by Ektron

Default Settings for Managed Properties Created by Ektron

When Ektron content is crawled by Microsoft Search Server 2010, the following default values are set for these metadata properties. You can edit the values using the Microsoft Search Server 2010 Central Administration console.

  • Queryable—True
  • StemmingEnabled—False
  • RefinementEnabled—False
  • MergeCrawledProperties—True
  • SubstringEnabled—False
  • DeleteDisallowed—False
  • MappingDisallowed—False
  • MaxIndexSize—1024
  • MaxResultSize—64
  • DecimalPlaces—10
  • SortableType—SortableEnabled
  • SummaryType—Static
Setting up a load-balanced search with Microsoft Search Server 2010

Setting Up a Load-Balanced Search with Microsoft Search Server 2010

You can use load balancing to distribute your search's workload across multiple servers. Load balancing improves search's performance by significantly decreasing the time to complete search crawls and process search queries (especially when a site is under a heavy load).

This section describes 2 scenarios for setting up Load Balanced search.

Adding a site to a server that hosts Microsoft Search Server 2010 and Ektron

Adding a Site to a Server that Hosts Microsoft Search Server 2010 and Ektron

  1. On the Ektron server, run the Site Setup utility: Windows Start button > Programs > Ektron >version> Utilities > CMS400 Site Setup. See Also: Installing a Site
  2. During the Ektron installation, you are prompted to choose a search provider. Choose Microsoft Search Server 2010 Full.
    —Image—

  3. The setup continues as normal. After the installation is complete, the following dialog appears. Click Yes.
    —Image—

    The Search Configuration screen appears. For documentation of that process, see Managing the Search Configuration

Installing Microsoft Search Server 2010 to a primary server in a load balance cluster

Installing Microsoft Search Server 2010 to a Primary Server in a Load Balance Cluster

Use this procedure if you have not installed Microsoft Search Server 2010 on the primary server in a Load Balance cluster.

Prerequisites

  1. Obtain, download, and install Microsoft Search Server 2010.

    NOTE: You may be informed that you need to run the Products Preparation Tool before beginning the installation.

  2. Choose Server Farm when you are prompted for an installation type.
    —Image—

  3. On the Server Type tab, select Complete then click Install Now. Search server is installed.
    —Image—

  4. Run the Configuration Wizard, which lets you set up Microsoft Search Server 2010. The SharePoint Configuration Wizard is launched.
  5. Choose Create a new server farm on the Connect to a server farm screen.
    —Image—

  6. Specify a database server, name, and user name and password for access to the account.
    1. For Database name, accept the default of SharePoint_Config.
    2. Enter a Username and Password of a SQL user with the sysadmin role. Microsoft Search Server 2010 uses them to access your Ektron database. Click Next.
      —Image—

  7. Enter a password for access to the server farm.
    —Image—

  8. Enter a port number and Security settings. You may enter any open http port. For Security Settings, choose NTLM.
    —Image—

  9. Click OK to confirm the information you entered.
  10. Click Finish to launch the SharePoint Central Administration site to allow for additional configuration and provisioning. Noted that the first installation in a farm does not create a Web application or provision a site. See Also: SharePoint 2010 Central Administration.

    The following screen appears within SharePoint.

    —Image—

  11. Click Start the Wizard and complete the wizard.
Adding servers to a Load Balance cluster

Adding Servers to a Load Balance Cluster

Prerequisites

2 servers running Microsoft Search Server 2010; the servers cannot use Search Server Express.

See Hardware and software requirements (Search Server 2010)

When setting up search load balancing, you need to decide which server is the primary one, and which is/are the secondary one(s). This procedure describes how to set up a single secondary server in a load balanced cluster. To set up additional secondary servers, follow these instructions for each secondary server. See Also: Installing Microsoft Search Server 2010 to a Primary Server in a Load Balance Cluster

1. Install Microsoft Search Server 2010

Part 1: Install Microsoft Search Server 2010

  1. Obtain, download, and begin to install Microsoft Search Server 2010.

    NOTE: You may be informed that you need to run the Products Preparation Tool before beginning the installation.

  2. For an installation type, choose Server Farm.
    —Image—

  3. On the Server Type tab, select Complete then click Install Now.
    —Image—

    Search server is installed.

  4. Run the Configuration Wizard, which lets you set up Microsoft Search Server 2010. The SharePoint Configuration Wizard is launched.
  5. On the Connect to a server farm screen, choose Connect to an existing server farm.
    —Image—

  6. On the Specify Configuration Database Settings screen, in the Database server field, enter the primary server in the load balance cluster.
  7. Click Retrieve Database Names. The primary server's database appears in the Database name field.
    —Image—

  8. Enter the same passphrase that you entered when setting up the primary server. See Also: Installing Microsoft Search Server 2010 to a Primary Server in a Load Balance Cluster
  9. Complete the remaining prompts; the wizard uses information to configure Microsoft Search Server 2010.
2. Set up query components

Part 2: Set up Query Components

In this procedure, you create 2 query components. One defines this secondary server as a failover server, which takes over processing if the primary server goes offline. The second query component distributes the processing of search queries among search servers.

  1. Open Microsoft Search Server 2010's Central Administration screen.
    —Image—

  2. Click Manage service applications (highlighted). The Service Applications screen appears.
  3. Click Search Service Application 1. The Search Service Application 1: Search Administration screen appears.
    —Image—

  4. Scroll down to Search Application Topology and click Modify (highlighted).
    —Image—

  5. To set up the failover server, under Index partition 0, click Query Component, then Add Mirror.
    —Image—

  6. Use the following information to complete the Add Mirror Query Component screen.
    • Server—Enter the server to which you are currently signed on.
    • Associated Property database—Select the primary server and the database you specified in Step 4.
    • Location of Index—Accept the default.
    • Failover-only Query Component—Ektron recommends checking this box. If you do, and the primary search server goes offline, the secondary server processes all search queries until the primary server returns.
  7. The Search Service Application 1: Search Administration screen reappears. Click Apply Topology Changes.

    The secondary server now appears under Index Partition (highlighted).

    —Image—

  8. Set up a query component to distribute the workload of handling search queries. To do that, from the Search Application Topology area, click New > Index Partition and Query Component.
    —Image—

  9. The Add Query Component Screen appears. Complete Setting Up Microsoft Search Server 2010, but this time do not check the Failover-only Query Component box.
    —Image—

  10. The Search Service Application 1: Search Administration screen reappears. Click Apply Topology Changes.
  11. To do that, from the Search Application Topology area, click New > Crawl Component.
    —Image—

  12. Specify the fields when the Add Crawl Component screen appears.
    —Image—

    • Server—Enter the server to which you are currently signed on.
    • Associated Crawl database—Select the primary server and the database you specified in Step 4.
    • Temporary Location of Index—Accept the default.
  13. The secondary server appears under Crawl (highlighted).
    —Image—

  14. Close Search Server Administration.

    NOTE: You only need to follow the next 2 steps once. So, if you are setting up multiple secondary servers, you can skip these 2 steps after setting up the first one.

  15. On the Ektron server, copy C:\Program Files\Ektron\CMS400versionnumber\Utilities\SearchServer\EktronSearchConfiguration.exe.
  16. On both search servers, paste EktronSearchConfiguration.exe and run it.
  17. On your Ektron Web server, open the Search Configuration screen, available from C:\Program Files (x86)\Ektron\CMS400vxx\Utilities\SearchServer\Ektron.Cms.Search.Config.UI.exe.
  18. Click Advanced Options.
  19. In the Secondary Search Servers section, click Add () then insert the name of the secondary server(s).
    —Image—

  20. Click Register Site.