Install AutoClassifier Engine Components

Use the following steps to install AutoClassifier.

Procedure:                                             

  1. Double-click the BA Insight AutoClassifier<version>.msi to run the installer.
  2. Read and accept the End User License Agreement and click Next to continue.
  3. Continue to the Components to be installed dialog and select any of the following options:
    • Install AutoClassifier Admin Site and Engine: Select this option to install the base AutoClassifier Admin Site and Engine. This includes a single Lucene site, and can be installed on a single server or multiple servers behind load balancing. If you are installing AutoClassifier on a single server, a separate Lucene Site is not required as the needed functionality is embedded in the engine. 
    • Install AutoClassifier Adapter Crawler (optional): Select this option only if you are using AutoClassifier Adapters to crawl and tag content. For example, AutoClassifier can crawl and tag Elastic in-place. This option can be installed with or without the AutoClassifier Engine.
    • Install AutoClassifier Lucene site (optional): Select this option only if you are installing in a scaled environment. When selected, this Lucene site overrides the default site included in the Install AutoClassifier Admin Site and Engine option.
      • If the AutoClassifier Admin Site is to be installed on multiple servers for load balancing, install exactly one Lucene Site.
        • The Lucene Site cannot be scaled.
        • It is used for development purposes only.
      • If AutoClassifier is being installed on a single server, a separate Lucene Site is not required, as the needed functionality is embedded in the engine. 
      • If you set up a custom binding to your AutoClassifier Engine site, you must update it in the Lucene Site web.config file. To do so, set the new value in the AutoClassifierServiceUrl setting. For example: <value>http://company.contoso.com:8080 </value>
    • Configure Existing AutoClassifier Lucene Site: When scaling AutoClassifier, the installer can point to an existing Lucene Site.
    • Install AutoClassifier Python Script Runner Rest API (optional): Select this option if you want to use Python script capabilities in your AutoClassifier Pipelines with the AutoClassifier Python Script component. If you select this option, you must have Python 3.9.0 or later installed on your server.
      Note the following:
      • The AutoClassifier Python Script Runner Rest API runs as a Windows Service under the service account provided.
      • After Installing the AutoClassifier Python Script Runner Rest API, a new Python Script Runner Service folder is added to your installation folder under /Upland BA Insight/Upland BA Insight AutoClassifier/.
      • If you do not install the AutoClassifier Python Script Runner Rest API in your instance during the installation process, then decide later that you would like to install it, you must uninstall and reinstall your AutoClassifier instance.
    • Configure Existing AutoClassifier Python Script Runner Rest API (optional): When scaling AutoClassifier, select this option to point the installer to an existing AutoClassifier Python Script Runner Rest API.
  4. Click Next and the Specify running account dialog appears. In the Domain\User Name field, enter the account credentials that will run the installed Application Pools and Windows Services. This account must have standard privileges. In the Password field, enter the password for the account.
  5. Click Next.
  6. If you selected Install AutoClassifier Python Script Runner Rest API, the Specify the Python settings dialog appears. In the Full Path to python.exe field, enter the path to your python.exe file. If you are unsure of the path, open the Windows Command prompt and type the following command: where python. The system will display the paths where Python is installed.
  7. Click Next to continue.
  8. On the Specify the configuration ports window, accept the default configuration ports or enter your own values. Note these values in the Installation Prerequisite checklist. You must ensure that these ports are free. If another application is already using a specified port, stop that process or use a different available port for your services.
  9. Click Next to continue.
  10. Database and Logging Setup 

    If you use Microsoft Azure SQL, you can initialize and configure your database. The following authentication methods are supported:

    • SQL authentication

    • Microsoft Azure Active Directory username and password authentication

    • Microsoft Azure Active Directory Integrated authentication

    • Microsoft Azure Active Directory Service Principal authentication

    • Microsoft Azure Active Directory Managed Identity or Managed Service Identity (MSI) authentication

    Important: of the modes listed above, only Microsoft Azure Active Directory Managed Identity or Managed Service Identity (MSI) authentication requires additional managed identity configuration. If you are planning to use managed identity authentication, see enable managed identities. The remaining modes require that you specify the appropriate authentication connection property in your connection string. For more information, see Connect to Azure SQL with Microsoft Entra authentication and SqlClient in the Microsoft documentation.
    1. Database Connection String
      1. Configure the AutoClassifier database connection string, including:
        • Server
        • Database
        • Trusted Connection
        Due to a vulnerability fix on the SQL Client, the default encryption flag for SQL Connections has been changed to true. As a result, you must specify Encrypt=false in your connection string if you do not support encryption in your database. For example, Data Source=.;Initial Catalog=AutoClassifier_DB;Integrated Security=True;Encrypt=False
    2. Logging Files Path
      1. The path to the directory that will store AutoClassifier's logging files.
      2. Accept the provided default path or set to a different path as desired.
    3. File Storage Path
      1. The path to the directory that will store AutoClassifier's recorder and Lucene index files.
      2. Accept the provided default path or set to a different path as desired.
  11. Click Next to continue.
  12. If you selected Configure Existing AutoClassifier Python Script Runner Rest API, In the Python Site field, enter the address of your existing AutoClassifier Python script runner site. For example, http://<server address>:1969.
  13. Java Settings: Specify the full path to your java.exe file
    1. Full Path to java.exe:
      1. Specify the full path to your java run time environment (JRE) executable (.exe) file.
      2. For example: C:\Program Files\AdoptOpenJDK\jdk-8.0.202.08\jre\bin\java.exe
    2. Default value:
      1. JAVA_HOME environment variable (if configured)
  14. Click the buttons Next > Install > Finish sequentially, to complete your installation.
If you are installing the AutoClassifier Python Script Runner Rest API, note that your installation will take significantly longer to complete.

After you have installed AutoClassifier, you must add your license in order to be able to use AutoClassifier functionality.