Install SmartHub

Be sure to install all of the prerequisites listed for your SmartHub and search engine. Any issues experienced by BA Insight clients during installation are typically traced to a failure to meet the required prerequisites. You must satisfy all of the requirements listed in the Prerequisites topic for your search engine.

To be guided through installing BA Insight SmartHub v6, see the following video. While this video demonstrates installing SmartHub v5, the steps to install SmartHub v6 are the same, with very minor differences in settings. How to Install and Configure SmartHub v5 

Use the following procedure to install SmartHub.

Overview

To install SmartHub, perform the following high-level tasks:

  1. Extract the SmartHub files to a local directory.

  2. Create a SmartHub website in IIS.

  3. Set the bindings for the new SmartHub website.

  4. Assign an application pool with the required rights to the website.

Extract SmartHub Files to a Local Directory

  1. In Windows Explorer, navigate to the location where you downloaded the SmartHub installation package.
  2. Extract the archive to a directory of your choice, such as C:\Program Files\BA Insight\SmartHub\.
  3. Continue to create your SmartHub website in IIS, set the bindings for the website, and assign an application pool to the site.

Create the SmartHub Web Site in IIS

The following steps will create a new IIS website with a new application pool named SmartHub. BA Insight recommends that you allow IIS to create this new application pool, however you will want to modify the application pool after the website is created in order to specify the application pool account.

Note: When using the default settings below, the Application Pool account that is created does not have "Modify" permissions on the configuration folder and therefore cannot read or write configuration settings.To secure the configuration folder for the application pool account (using the default or custom account), see Give Read/Write Permissions to System User Running Application Pool.
  1. Open IIS manager.
  2. Expand <Sites>.
    1. Right-click <Sites> and select Add Website from the pop-up window.
  3. Site name: Enter your site name.
    1. For example, "SmartHub".
  4. Physical path: Enter the path to the unzipped SmartHub package.
  1. Click OK.
  2. Now that your SmartHub site is created, we recommend you modify your Application pool identity.
  3. Select an Application pool identity that has FULL permissions to your SmartHub installation directory and the files within it.
    1. The default AppPool identity (ApplicationPoolIdentity) DOES NOT have the necessary permissions.
    2. See the topic How to Change Your Application Pool Identity Account below.

Bindings

As part of the installation process you create both HTTP and HTTPS bindings.

  • Type: http or https.
    • SmartHub must have bindings for both HTTP and HTTPS. See the graphic above.

Use the following steps to enable both bindings in your SmartHub site:

  1. The Site Creation Wizard in IIS allows only a single binding when first creating a site (either HTTP or HTTPS). After you create your SmartHub site, create a second, additional binding to the same site (either HTTP or HTTPS):
    1. In IIS, select your SmartHub website.
    2. select the Bindings... entry from the Actions panel.
    3. In the Site Bindings window, click Add.
    4. Select the binding you are missing (HTTP or HTTPS).
    5. if you select HTTPS, choose your SSL certificate.
    6. Click OK.
  2. Port:
    1. Enter a port that is not used by another site from IIS.
      1. HTTP: Port 80 or 8080 is commonly used
      2. HTTPS: Port 443 is commonly used
  3. Host name (optional): Enter a host name to restrict access to the host name (address your users enter into a web browser).
    1. The host name can be a DNS address, local machine name, localhost, and so on.
  4. Click Save.
  5. If you select Content View from the bottom of your SmartHub Content site, your folder structure should resemble the structure shown below:

IMPORTANT! To access the site, users must have READ access to the folder.

Give Read/Write Permissions to System User Running Application Pool

Your SmartHub website requires an application pool account that has both read and write permissions to the SmartHub directory on your server. To give permissions only to the system user running the application pool, assuming you are using IIS7, perform the following steps:

  1. Open IIS7.
  2. Select the website for which you need to modify permissions.
  3. Click Basic Settings... under "Edit Site" in the right side Actions pane.
  4. Note the name of the application pool identity you are using.
    1. For example, "ApplicationPoolIdentity".
    2. Note that most Administrators change this identity to a different user account, such as <domain>\<YourSmartHubUser>.
  5. Go to Application pools in the Connections panel and find the application pool from step 4.
  6. Find the system account used for running application pool (Identity column).

    Info: To change the system account that is used to run your SmartHub Application Pool, see How to Change Your Application Pool Identity Account below.

  7. Navigate to your SmartHub site in IIS, select it, and click Edit Permissions under the Actions pane on the right side.
    1. Click the Security tab and add the desired permissions for only the user account identified in step 4.

Note: If you choose to use the default identity user account ApplicationPoolIdentity in step 3, reference this system user in the format IIS AppPool\<application_pool_name>. For example, IIS AppPool\DefaultAppPool.
Note: When adding this user, make sure to set correct locations in the Select Users or Groups dialog.
This must be set to the local machine because this is a local account.

How to Change Your Application Pool Identity Account

The SmartHub Application Pool Identity account must be the Local Administrator account with the following permissions:

  1. Run a Windows Scheduled Task (required for the BA Insight Analytics Sync Tool).
  2. Manage the Windows Service Bus (required for the BA Insight Analytics).
    To verify if the user has permission follow the next steps:
    1. Open a Service Bus PowerShell as administrator.
    2. Check to see if you have created a service namespace by issuing the following PowerShell command: Get-SBNamespace
    3. Verify if the ManageUsers group include your account.
    4. Add permissions to your account using the following PowerShell command: 
Copy
Set-SBNamespace -Name "YourNamespace" -Manage YourUser

Use the following instructions to change your Application Pool Identity account.

  1. Open IIS manager if it is not already open.
  2. Click Application Pools from the left-side Connections panel.
  3. Select the Application Pool you wish to change. Note that you can sort your Application Pools by categories such as Name, Status, Identity, Applications, and so on.
  4. In the advanced settings window, right-click the Application Pools whose identity you wish to change and select the "..." button.

  5. Select the built-in account you wish to use from the drop-down menu or click the Custom account radio button and click the Set button.
  6. Enter the credentials of the Application Pool Identity account you wish to use. Be sure to enter the account user name in the format <domain>\<name>.