Install Smart Analytics on Windows

Before you install Smart Analytics, make sure that your servers meet the system requirements as specified in System requirements.

Pre-install considerations

There are a number of key factors you should consider before deploying Smart Analytics:

• Operating system Smart Analytics supports Windows family and Linux operating system. It is recommended that all servers used utilize the same OS for easy of management.
• Storage I/O performance: Ideally, each SM Smart Analytics Component should have access to its own disk or partition, independently capable of 120 MB/s bandwidth and 180–200 IOPS (bandwidth being the more important metric).
• Storage capacity: Due to bandwidth bottlenecks of conventional HDDs, it is recommended that the size of the partitions utilized for each SM Smart Analytics Component should not exceed 300 GB.
• Network To properly interface with data repositories, Smart Analytics requires high-speed network access to the data repositories. In practice, this is accomplished by placing connectors physically “close” to the original data sources.

Install

To install Smart Analytics on a Windows-based system, follow these steps:

1. Obtain the Smart Analytics installer for Windows.

2. Unpack the .zip file and then double-click the setup application (setupSmartAnalyticsWindowsX64.exe).
3. The SM SmartAnalytics Setup wizard opens. Read the introduction, and then click Next.
4. Read the License Agreement. To continue the installation, select I accept the terms of the License Agreement, and then click Next.
5. Select New Installation, and then click Next.
6. Choose an installation folder, and then click Next. The default installation folder is C:\Program Files(x86)\Micro Focus\Service Manager x.xx\SmartAnalytics.
7. Select Quick Install or Advanced Install as your installation type, and then click Next.

8. Continue with the corresponding installation steps.

   Quick Install

   Quick Install deploys the minimum required components to perform Smart Analytics on Service Manager internal data only. It sets default configurations, and no extra data source connectors are installed.

   To perform quick installation of Smart Analytics on Windows, continue with these steps:

   1. Select Quick Install as the installation type, and then click Next.

   2. Specify the IP address of your Service Manager Server, and then click Next.

      You need to specify the IP addresses (or host names) of the Service Manager servers that are permitted to send administrative and query actions to the Smart Analytics servers. Use commas to separate multiple addresses (do not use a space before or after a comma).

      Note  

      • Service Manager Server uses load balance, therefore, all slave Service Manager addresses should be specified in this step.

      • Please use a valid FQDN or IP address for the server address. Do not use the localhost or 127.0.0.1.

   3. Follow the configuration steps to configure ports for these servers. Click Next after each step.

      • SM Smart Analytics main server
      • Main Content Server
      • Smart Search Proxy Server
      • Smart Search Content Server1
      • Smart Search Content Server2
      • Image Server
      • CFS Server
   4. Check the pre-installation summary. If you want to change your configuration, click Previous. Otherwise, click Install to start the installation.

   5. Wait for the installation to complete

   Advanced Install

   Advanced Install provides multiple installation templates, each including a group of server components and connectors. You can deploy components by selecting different installation templates for different scenarios.

   To perform advanced installation of Smart Analytics on Windows, continue with these steps:

   1. Select Advanced Install as the installation type, and then click Next.

   2. Specify the IP address of your Service Manager Server.

      You need to specify the IP addresses of the Service Manager servers that are permitted to send administrative and query actions to the Smart Analytics servers. Use commas to separate multiple addresses (do not use a space before or after a comma).

      Note  

      • Service Manager Server uses load balance, therefore, all slave Service Manager addresses should be specified in this step.

      • Please use a valid FQDN or IP address for the server address. Do not use the localhost or 127.0.0.1.

   3. Choose an installation template, and then click Next. To customize your installation, select the Customize template to choose from the available components.

      Service Manager provides six out-of-box installation templates.

      Installation template	Components included	Description
      Basic for Smart Analytics	Proxy Server Components (including DIH, DAH, community, category, agentstore, view, one second-level DIH and DAH, one main content server and two Smart Search content servers) Image Server CFS Server	Deploys the minimum required components to perform Smart Alalytics on Service Manager internal data only. No extra data source connectors are installed.
      All in one	Proxy server components (including DIH, DAH, community, category, agentstore, view, one second-level DIH and DAH, one main content server and two Smart Search content servers) Image Server CFS Server OMNI Group Server SharePoint Connector HTTP Connector File System Connector Oracle Connector	Deploys all components in one physical machine. In this way, you can use the full Smart Analytics functionality on both Service Manager without a large volume of data.
      Basic for SM Service Portal	Proxy Server Components (including DIH, DAH, community, category, agentstore, view, one second-level DIH and DAH, one main content server and two Smart Search content servers) Image Server CFS Server Portal Content Query Manipulation Server	Deploys the required components to support IDOL on Service Manager Service Portal. For more information, see Set up Smart Analytics for Service Manager Service Portal.
      Distributed IDOL content server	Content Server	Installs remote or additional content servers to handle more data.
      Distributed image server	Image Server Image Proxy Server	By default, one image server is included in the basic installation to handle OCR process. If there are too many image processing requests, you can deploy a distributed image server.
      Customize	No pre-set components	Install any component based on your customized requirements. Note Do not select Portal Content and Query Manipulation Server unless you plan to run Service Portal.

      Note If you plan to install the content servers and the proxy server on different machines, it is recommended that you install the content servers first. Because without content server installed and started, the proxy server cannot start and the OOB data cannot be imported. For detailed steps of installing Smart Analytics components on different machines, see Example: Deploying Smart Analytics on multiple servers

   4. Specify the IP addresses of the remote machines on which you have installed or will install Smart Analytics components such as content servers, CFS servers and connectors, and then click Next.

   5. Follow the configuration steps to configure the components you selected. Click Next after each configuration step.

      If you did not select Main Content, Smart Search Content 1 or Smart Search Content2 in the installation template as described in step c, the installer displays configuration pages for you to specify the IPs and ports of the remote servers on which you have installed or will install these contents servers.

      If you do not specify IPs and ports for remote content servers on the configuration pages, or you want to change your settings after installation, you need to manually edit the IPs and Ports in the following configuration files and corresponding sections:

      File	Configurations
      <Smart Analytics Installation>/IDOL/IDOLServer.cfg	[Service] …… ServiceStatusClients=…,<Remote Main Content Server IP> ServiceControlClients=…,<Remote Main Content Server IP> …… [Server] …… QueryClients=…,<Remote Main Content Server IP> AdminClients=…,<Remote Main Content Server IP> IndexClients=…,<Remote Main Content Server IP> …… [IDOLServer1] …… Host=<Remote Main Content Server IP> Port=<Remote Main Content Server Port> ……
      <Smart Analytics Installation>/level2proxy/IDOLServer.cfg	[Service] …… ServiceStatusClients=……,<First Remote Smart Search Content Server IP>,<Second Remote Smart Search Content Server IP> ServiceControlClients=……,<First Remote Smart Search Content Server IP>,<Second Remote Smart Search Content Server IP> …… [Server] …… QueryClients=……,<First Remote Smart Search Content Server IP>,<Second Remote Smart Search Content Server IP> AdminClients=……,<First Remote Smart Search Content Server IP>,<Second Remote Smart Search Content Server IP> IndexClients=……,<First Remote Smart Search Content Server IP>,<Second Remote Smart Search Content Server IP> …… [DistributionIDOLServers] Number=2 [IDOLServer<0>] Host=<First Remote Smart Search Content Server IP> Port=<First Remote Smart Search Content Server Port> …… [IDOLServer<1>] Host=<Second Remote Smart Search Content Server IP> Port=<Second Remote Smart Search Content Server Port>

      Some useful information for configuration:

      • Configure Smart Search Proxy Server > Replicas : Specifies the number of identical copies of each document to index. This is configured in the level2proxy\IDOLServer.cfg file.

        The default value is set to 0, which means that there is only one copy of each document for Smart Search. If you set the number as 1, it means that there will be two mirrored copies of the document in your Smart Search content servers.

        In Smart Search proxy level, content is distributed between virtual nodes, which the DIH assigns to its child servers. When you configure replicas, DIH copies the documents in a particular virtual node to two or more child servers. This method ensures there are two mirrored copies of the document in your system without you having to set up specifically mirrored child servers.

        Note The number of copies (that is, the value of Replicas plus one) must be no more than the number of child servers. If you create more copies than existing Smart Search child servers, DIH does not start.

      • Configure SharePoint Connector > SharePoint URL Type:

        • To retrieve all content databases and site collections, set the value of this parameter to WebApplication. Set the value of the SharepointUrl parameter to the URL of the web application. You cannot use this value with SharePoint Online.
        • To retrieve only one site collection, set the value of this parameter to SiteCollection. Set the value of the SharepointUrl parameter as the URL of the site collection.

      • Configure LDAP Repository (for OMNI Group server):

        • LDAP User Base: the base DN or top level of the directory tree you want to search for users. This indicates where in the LDAP directory tree you want to begin the search.
        • LDAPGroupBase: the base DN or top level of the directory tree you want to search for groups. This indicates where in the LDAP directory tree you want to begin the search.
        • (Optional) UserFilter: the query you want to use to retrieve the set of users you want to store in the group server. For example, UserFilter=(objectClass=hpeEmployee).
        • (Optional) GroupFilter: you can use GroupFilter to set the filter that is passed to the LDAP server to request a list of groups. For example, GroupFilter=(objectClass=hpeGroup).
   6. Check the pre-installation summary. If you want to change your configuration, click Previous. Otherwise, click Install to start the installation.

   7. Wait for the installation to complete.

9. The Start Service page opens when the installation is complete. If you want to start the services now, select Yes and then click Next. Otherwise, select No and then click Next

   Note We recommend you start the services manually after you configure the .cfg files for each connector.

10. If you selected Yes in step 8, the Import OOB Data page opens. If you want to import the out-of-box data now, select Yes and then click Next. Otherwise, select No and then click Next.

    Note Importing the out-of-box data will erase the previous data for Hot Topic Analytics.

    You can also import the out-of-box data at any time after the installation, by running the <Smart Analytics Installation>/OOBData/oobdata.cmd file.

11. Wait a few minutes for the installer to finish starting the services and importing the OOB data, and then click Done.

    Note  

    • Make sure that all the required components are started. If not, you need to start the corresponding component manually.
    • Under some circumstances, users are unable to connect to the main server in Service Manager while the status of SM Smart Analytics Main Server shows Started in the Services snap-in. You can check <Smart Analytics Installation>/IDOL/logs/application.log to see if agentstore was started. If not, restart the SM Smart Analytics Main Server service to troubleshoot the problem.

Post-install actions

After installation, you can modify the following configuration files to change the previous settings:

• Smart Analytics main server: <Smart Analytics Installation>/IDOL/IDOLServer.cfg
• Image server: <Smart Analytics Installation>/ImageServer#/ImageServer#.cfg

• Image proxy server: <Smart Analytics Installation>/ImageProxyServer/dah.cfg

  This is only required if you have installed multiple image servers in the distributed mode.

• Content server: <Smart Analytics Installation>/Content#/Content#.cfg

• CFS server: <Smart Analytics Installation>/CFS/CFS.cfg

• SharePoint connector: <Smart Analytics Installation>/SharepointRemoteConnector/SharepointRemoteConnector.cfg

• OMNI group server: <Smart Analytics Installation>/OmniGroupServer/OmniGroupServer.cfg

• HTTP connector: <Smart Analytics Installation>/HTTPConnector/httpconnector.cfg

• File system connector: <Smart Analytics Installation>/FileSystemConnector/filesystemconnector.cfg

• Oracle connector: <Smart Analytics Installation>/OracleConnector/OracleConnector.cfg

• Portal content: <Smart Analytics Installation>/Content-SMSP/Content-SMSP.cfg

• Query Manipulation Server: <Smart Analytics Installation>/QMS/QMS.cfg

Restart the corresponding components after you modify the related configuration files.