Agent installation and configuration

Minimum resources

The host for the agent requires the following minimum resources:

• Number of CPUs (include virtualized CPUs): 4

• RAM: 8GB

Operating System

Ensure that you are running a supported operating system with all currently "critical" and "important" updates installed from update.microsoft.com.

• Windows Server 2016 (Standard, Datacenter)

  The "Server with Desktop Experience" installation option is required.

• Windows Server 2019 (Standard, Datacenter)

  The "Server with Desktop Experience" installation option is required.

Ports in use

The processing agent uses the following ports on the host server. Ensure these ports are available.

SQL

You have the option to install SQL Express on the agent host server as part of the processing agent installation, or manually install a supported version of SQL in your environment separate from the processing agent. If you choose to separately install a supported version of SQL, ensure that the supported version has all currently "critical" and "important" updates installed from update.microsoft.com up to and including the current Cumulative Update for the version.

TCP/IP Protocol must be installed and enabled (Mixed Mode Authentication)—not just Windows authentication.

File Analysis Suite supports the following versions of SQL.

• SQL 2016 SP2 (Standard, Enterprise, Express; on all supported Windows Servers)

• SQL 2017 (Standard, Enterprise, Express; on all supported Windows Servers)

• SQL 2019 (Standard, Enterprise, Express; on all supported Windows Servers)

General

The following requirements must be met for the server hosting the processing agent. Applications listed must exist on the host server prior to installing the agent.

• If processing file system documents from a host machine that has long paths enabled, long paths must also be enabled on the agent host.

• Ensure the public certificate presented by the external proxy is trustable by agent hosts. Depending on the certificate presented, this may include importing a private certificate authority (CA) certificate to the local Windows certificate store.

  IMPORTANT: If a private CA is used, ensure the private CA’s certificate is removed if the agent is uninstalled.

• Ensure the Windows server is permitted to communicate through TLS 1.2, using a current “safe” cipher suite to ports 9000-9999. The back office components (commonly in the cloud) implement and require an Intermediate TLS security level (https://wiki.mozilla.org/Security/Server_Side_TLS).

  IMPORTANT: By default, most supported Windows server operating systems are pre-configured to allow communication with the back office and to repository targets enforcing TLS 1.2 communication using a reduced safe set of ciphers (EX2019, O365, SPO). Ensure this connectivity is communicating with functional targets by using a web browser that utilizes Windows Schannel (Internet Explorer) or via the Invoke-WebRequest PowerShell cmdlet.

  It is possible to harden encryption in Windows server to restrict the native Schannel encryption component, used by the processing agent services, to specific operating modes and particular cipher suites (https://docs.microsoft.com/en-us/windows-server/security/tls/tls-registry-settings). The following are the minimum required values.

  • TLS 1.2 (Client): Enabled

  • Windows 2016/2019 required cipher suites

    • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384

    • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

    • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384

    • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256

• Ensure that you have administrative rights on each server. You cannot perform the installation unless you have administrative rights to perform the required tasks.

• Microsoft Outlook 2019 x64 to process PST files located on file systems.

  IMPORTANT: The default installation for Outlook 2019 is x32. Ensure you have the x64 version installed.

• SMTP (currently optional)

• .NET 4.8

  • Ensure earlier versions of SSL and TLS in Windows Schannel are disabled and that .NET applications (particularly 4.x) use the system’s Windows Schannel configuration. See https://docs.microsoft.com/en-us/officeonlineserver/enable-tls-1-1-and-tls-1-2-support-in-office-online-server#enable-strong-cryptography-in-net-framework-45-or-higher.

• Visual C++ 2019 runtime, updated to the most current version

• PowerShell 3.0+

The following resources are supported for data processing by the on-premises agent.

• Micro Focus Content Manager 9.4

  IMPORTANT: Only Microsoft SQL Server Unicode RDB datasets are supported at this time.

• File system CIFS shares

• Microsoft Exchange Server 2013, 2016, and 2019 fully updated and patched, and Office 365

• SharePoint 2016, fully updated and patched, and Office 365

  • For SharePoint 2016, Site Collections, Web Applications, and OneDrive are supported.

  • For Office 365 SharePoint, Site Collections and OneDrive are supported.

• Google Workspace's Drive (personal Google Drives are not supported)

1. From the primary navigation panel, click Agents > Agent Download.

   The Agent Download page opens.

2. Make note of the Gateway URL, including the port number, specified in the Assign Agent panel. You will need this information when you install the agent.

3. In the Download Agent section, select one of the following options.

   • Download agent only (you already have the prerequisite applications)

     IMPORTANT: Choose this option only if the prerequisite applications are already in place on the agent host machine. If a prerequisite is missing, the installation wizard will stop and you must require the missing application and then restart the installation.

   • Download agent and the supported version of the prerequisite Visual C++ and SQL Express applications.

   Click DOWNLOAD.

4. Once the download has completed, navigate to the download location and copy the agent install file to the agent host server.

   NOTE: When you copy the downloaded agent file to the local directory of the agent host server, place the file in a directory as close to the root of the destination drive as possible. Errors may occur if the file path to the installation file is too long.

   Follow the instructions to install the agent.

1. If not already completed, copy the agent installation file (FAS-agent-version.exe or FAS-agent-version.zip) to the agent host server from the download location.

2. Ensure all server requirements for the host server are in place.

3. Open the downloaded installation file (FAS-agent-version.exe).

   TIP: If you downloaded the ZIP file, extract the files and then open the installation EXE file.

4. When the installation dialog opens, review the Introduction information, and then click Next.

   TIP: You may be informed of any missing prerequisites, some of which you will need to install manually.

   • If you are missing prerequisites that require manually installation, Cancel the wizard, install the prerequisite, and then restart the installation.

   • If you are missing prerequisites that the agent installer can update, click Install in the dialog. The agent installation will continue when the prerequisite installation completes.

   The License Agreement dialog opens.

5. Review the license information, select I accept the terms of the License Agreement, and then click Next.

   The Setup Type dialog opens.

6. Define the setup options

   • Select one of the following installation options.

     • Typical installs the agent and supporting components, as well as the most current supported SQL Server Express on the agent host machine.

       This installation method automatically installs SQL Server Express with a default SQL "sa" password and configures the agent databases with a default database user and password.

       • Default sa password: P@ssw0rd1234$#@!

       • Default database user: FASdbuser

       • Default database user password: P@ssw0rd

     • Custom installs only the agent and supporting components on the agent host machine.

       This installation method requires you to configure the agent to define the databases and credentials to access them.

       IMPORTANT: Choose this option if a supported version of SQL Server is installed in your environment and accessible to the agent host machine.

   • Accept the default location (C:\Program Files\Micro Focus\FAS\Agent), or click Change to select the desired location (it must be local).

   Click Next.

   The Provide Credentials dialog opens.

7. Provide the credentials necessary for completing the installation.

   Option	Description
   URL for the cloud gateway	Type the gateway URL and port number as defined in the Assign Agent panel on the Agent Download page. This is the main access point in the cloud.
   Tenant ID	Type the tenant ID for the File Analysis Suite instance to which this agent is assigned.
   User Name	Type the User Name of a user in your tenant that will be used to connect the agent to the cloud. This user must have the Manage agents permission for the Connect component.
   Password	Type the password for the user defined.

   Click Next.

   The Ready to Install the Program dialog opens and the components install and appropriate services are started.

   NOTE: If you selected the Typical installation option, SQL Server Express will be installed at this time. Follow any on-screen prompts to complete the SQL Server installation.

8. If you need to make changes, click Back to work your way back, modify as desired, and then work forward to this dialog.

   Click Install.

   The installation of the databases and additional required components begins.

9. When the installation completes, click Finish.

   • If you chose the Typical installation, the application and databases are installed and configured.

   • If you chose the Custom installation, the Agent Admin opens. The initial configuration page appears. You can begin the configuration of this server immediately, or run the agent installation on any additional agent hosts and then configure each server.

   NOTE: The Agent Admin UI can be accessed from the Start menu. From the Start menu, click Micro Focus FAS Agent > Agent Admin.

10. Set the logon account for the File Analysis Suite services.

    The user account must be a local or domain account that is in the agent host's Administrators group and has the Logon as a service permission.

    1. Open PowerShell as an administrator.

    2. Change the directory to \Agent\bin within the agent installation path. For example, C:\Program Files\Micro Focus\FAS\Agent\bin.

    3. Run _set_services_run_as.ps1 and provide the requested information.

       Gateway URL	Type the gateway URL and port number as defined in the Assign Agent panel on the Agent Download page. This is the main access point in the cloud.
       Tenant ID	Type the tenant ID for the File Analysis Suite instance to which this agent is assigned.
       User Name	Type the User Name of the user in the Administrators group that will be used to log on to the File Analyze services. For a local user, use the format machineNetBIOS\username. For a domain user, use the format domainShortName\username. NOTE: This is different than the user defined in the installation wizard.
       Password	Type the password for the user defined.

    4. Start the Micro Focus FAS-Agent Api service.

    5. Start all other Micro Focus FAS services.

11. If you chose the Typical installation and Outlook 2013 is installed on the host, reboot the host machine.

12. Repeat the agent installation process on any additional agent host servers.

1. From the machine hosting the agent, open the credential utility, AccessHandler.exe.

   Default location: C:\Program Files\Micro Focus\FAS\Agent\bin\AccessHandler.exe

2. When prompted, type the Gateway URL including the port number, and then press Enter on your keyboard.

   This is the main access point in the cloud.

   Example: https://machine-01.domain.com:9312

3. When prompted, type your Tenant ID, and then press Enter on your keyboard.

4. When prompted, type the User Name of a user in your tenant that has the Manage agents permission for the Connect component, and then press Enter on your keyboard. Ideally, this is the same user defined when installing the agent.

5. When prompted, type the Password for the defined user and then press Enter on your keyboard.

6. Follow any additional guidance in the command prompt regarding success or failure of credential validation.

1. On the agent host server, open the Agent administration UI if it is not open already.

   From the Start menu, click Micro Focus FAS Agent > Agent Admin.

   The UI opens to the Database tab.

2. Define the details for the name, location, and access credentials of the agent databases.

   Option	Description
   Database Host	Defines the host name of the SQL server onto which the agent databases are to be installed. Default: machine name of server being configured
   Port or Instance	Defines the port number or instance name for the SQL server used for communication with the agent databases. Default: 1433
   Central Database Name	Defines the name of the Central database. Default: fas_central_machine name of server being configured
   Server Database Name	Defines the name of the data processor server database. Default: fas_dp_machine name of server being configured
   New Database User	Defines the user name for the SQL account that the agent services use to access the agent databases (using an ODBC connection). The agent installation process creates this account if it does not exist. Default: FASdbuser Limits: Fewer than 64 characters and cannot contain the following special characters: " / \ [ ] : ; | = , + * ? < > - '
   New Database User Password	Defines the password for the database user SQL account that the agent services use to access the agent databases (using an ODBC connection). The password is encrypted on-screen.
   Confirm Password	Defines the password for the database user SQL account. Ensure that this entry matches the New Database User Password entry.
   SA User Name	Defines the user name for the SQL server admin user that will have access to the agent databases. This must be "sa" or an equivalent. Default: sa
   SA Password	Defines the password for the SQL server admin user who has access to the agent databases.

   Click NEXT.

   The Database Files tab opens.

3. Define the details of the data files for the databases.

   Option	Description
   Default Data Files Directory	Defines the location to store the agent's SQL-generated data. This directory is local to the SQL server. Default: C:\Program Files\Microsoft SQL\Micro Focus FAS Agent Server\SQL version reference\MSSQL\DATA
   Number of files per filegroup	Defines the number of files per filegroup. Default: the number of CPUs detected
   Data Files Directories	Defines an alternate location to store the specific agent-generated files. These directories are local to the SQL server. Used to override the value set for the Default Data Files Directory. Defaults to the value set for the Default Data Files Directory. Changes to the Default Data Files Directory automatically; update the individual entries.

   Click NEXT.

   The Confirmation tab opens.

4. Review the details for the configuration. When viewing the database data file locations, only the individual data file paths that differ from the default data file path appear. If all of the individual data files differ from the default data file path, the default data file path does not appear.

   Click NEXT.

   The Run Database Scripts tab opens.

5. Specify the how the database creation scripts are run.

   Option	Description
   Automatically run database scripts	Specifies to automatically run the database scripts as part of this configuration process.
   Manually run database scripts	Specifies that you will manually run the database scripts. This option is useful if your environment does not support installing the SQL databases over the network.

   Click NEXT.

   • If you selected to automatically run the database scripts, the Processing tab opens; skip the next step in this procedure.

   • If you selected to manually run the database scripts, the Manual Scripts tab is added and opens.

6. If you chose to manually run the database scripts, complete the following.

   1. Review the STEPS to manually run the scripts.

   2. Log into SQL Server with the SQL server admin user that you defined in the Agent Admin.

   3. Open the specified script location and open fas_central.sql to create the central database. The file opens in SQL Server Management Studio.

      Execute the script.

   4. When the script execution finishes, open and execute fas_server.sql.

   5. When the script execution finishes, return to the Agent administration UI.

   6. On the Manual Scripts tab, click NEXT.

7. You can view the progress of the configuration on the Processing tab.

   When the configuration process completes, click NEXT.

   The configuration is complete.

   You are redirected to the agent administration UI. If you will not be processing data in Content Manager, you can close this UI. If you are processing Content Manager data (through repositories), you will use this UI to complete the integration with Content Manager. For more information, see Content Manager integration.

8. Repeat this configuration process on any additional agent host servers.

1. On an agent host server, log on to the agent administration UI.

   From the Start menu, click Micro Focus FAS Agent > Agent Admin.

2. In the navigation panel, click Advanced Settings.

   The Advanced Settings page opens.

3. In the Category list, select AgentAPI.

   The settings for the AgentAPI service display.

4. Make the following selections.

   1. In the Proxy Address URL field, enter the URL of the web proxy.

   2. In the Proxy Bypass List field, enter a comma separated list of addresses that do not use the proxy server.

   3. In the Proxy Bypass on Local field, specify whether to bypass the proxy for local addresses.

   4. In the Proxy Password field, enter the password for the user account that will access the proxy server.

   5. In the Proxy Username field, enter the username for the user account that will access the proxy server.

5. Click Save.

6. Repeat for each agent server connecting to the File Analysis Suite cloud.