Install Smart Analytics on Linux

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 IDOL engine 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 the IDOL services 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 or re-install the SM Smart Analytics servers on a Linux-based system, follow these steps:

1. Obtain the SM Smart Analytics installer for Linux .

2. Unpack the .zip file and then execute the binary file (setupSmartAnalyticsLinuxX64.bin) from the command line on the Linux server.

3. Read the introduction, and then press Enter.
4. Read the License Agreement, and then press Enter repeatedly until you see DO YOU ACCEPT THE TERMS OF THIS LICENSE AGREEMENTS? (Y/N).
5. Type Y, and then press Enter.
6. Select New Installation, and then press Enter.
7. Specify an installation folder, and then press Enter. The default installation folder is /opt/MicroFocus/ServiceManager9.xx/SmartAnalytics.

8. Select Quick Install or Advanced Install as your installation type, and then press Enter.

9. 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 Linux, continue with these steps:

   1. Specify the IP address of your Service Manager Server, and then press Enter.

      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.

   2. Follow the configuration steps to configure ports for these servers. Press Enter 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
   3. Check the pre-installation summary, and then press Enter.

   4. 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 Linux, continue with these steps:

   1. 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.

   2. Choose an installation template, and then press Enter. 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 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 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. Do not select IDOL content server at the same time when you have selected Proxy Server Components. If you plan to install distributed IDOL content servers on the same machine where you want to deploy the Proxy Server Components, install Proxy Server Components and distributed IDOL content servers separately by performing the install process different times.

      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.

   3. Specify the IP address of the remote machine on which you have installed or will install Smart Analytics components, and then press Enter.

   4. Follow the configuration steps to configure the components you selected. Press Enter after each configuration step.

      If you did not select Main Content, Smart Search Content 1 or Smart Search Content 2 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.

   5. Check the pre-installation summary, and then press Enter.
   6. Wait for the installation to complete.

10. Press Enter to exit the installer.

Post-install actions

1. Run the following command to import the out-of-box data before you start any components of Smart Analytics, r:

   [INSTALL_DIR]/OOBData/ImportOOBData.sh

2. Start the components of SM Smart Analytics.

   Start all the components with a single command

   To start all the components, run the following command:

   [INSTALL_DIR]/scripts/StartALL.sh

   Note  

   1. This script starts all the components that you installed one by one.
   2. By running this command, you also start components like connectors, if they are installed.

   Tip If you want to stop all these components, run the following command:

   [INSTALL_DIR]/scripts/StopALL.sh

   Start the components with separate commands

   To start a single component that you installed, run the corresponding command as follows:

   • To start a content server, run the following command:

     [INSTALL_DIR]/scripts/StartContent[x].sh

     Note Replace [x] with the number of your content server, for example, StartContent1.

     Tip If you want to stop a content server, run the following command:

     [INSTALL_DIR]/scripts/StopContent[x].sh

   • To start both the main proxy server and the Smart Search proxy server, run the following command:

     [INSTALL_DIR]/scripts/StartIDOL.sh

     Note Before you start the main proxy server, make sure all the content servers have started.

     Tip If you want to stop the main proxy server, run the following command:

     [INSTALL_DIR]/scripts/StopIDOL.sh

   • To start a Connector Framework Server (CFS), run the following command:

     [INSTALL_DIR]/scripts/StartCFS.sh

     Tip If you want to stop a Connector Framework Server (CFS), run the following command:

     [INSTALL_DIR]/scripts/StopCFS.sh

   • To start an image server, run the following command:

     [INSTALL_DIR]/scripts/StartImageServer[x].sh

     Note Replace [x] with the number of your image server, for example, StartImageServer1.

     Tip If you want to stop an image server, run the following command:

     [INSTALL_DIR]/scripts/StopImageServer[x].sh

   • To start an image proxy server, run the following command:

     [INSTALL_DIR]/scripts/StartImageDAH.sh

     Tip If you want to stop an image proxy server, run the following command:

     [INSTALL_DIR]/scripts/StopImageDAH.sh

   • To start an HTTP connector, run the following command:

     [INSTALL_DIR]/scripts/StartHTTPConnector.sh

     Tip If you want to stop an HTTP connector, run the following command:

     [INSTALL_DIR]/scripts/StopHTTPConnector.sh

   • To start a file system connector, run the following command:

     [INSTALL_DIR]/scripts/StartFileSystemConnector.sh

     Tip If you want to stop a file system connector, run the following command:

     [INSTALL_DIR]/scripts/StopFileSystemConnector.sh

   • To start an Oracle connector, run the following command:

     [INSTALL_DIR]/scripts/StartOracleConnector.sh

     Tip If you want to stop an Oracle connector, run the following command:

     [INSTALL_DIR]/scripts/StopOracleConnector.sh

   • To start an SM Service Portal content server, run the following command:

     [INSTALL_DIR]/scripts/StartContent-SMSP.sh

     Tip If you want to stop a Service Portal content server, run the following command:

     [INSTALL_DIR]/scripts/StopContent-SMSP.sh

   • To start a Query Manipulation Server, run the following command:

     [INSTALL_DIR]/scripts/StartQMS.sh

     Tip If you want to stop a Query Manipulation Server, run the following command:

     [INSTALL_DIR]/scripts/StopQMS.sh

3. 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

   • 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

   Note If you installed any connectors, you may need edit their configuration files manually. For more information, see Configure connectors.

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