File Analysis Suite 3.8.2 Connect Help Center

# Agent installation and configuration

File Analysis Suite uses a processing agent, installed on one or more host servers within the File Analysis Suite environment, to communicate with your repositories and to process your data. These installed agents work cooperatively in an agent cluster to optimize performance, load balance, and maintain high availability.

When determining the number of agents needed to process the data in your repositories, consider the following:

- the amount of data to be processed and the network-connected regions in your environment.

- expected daily throughput during initial data processing and future data processing.

Requirements for the server on which the agent is installed

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 from English Installation Media (Standard, Datacenter)

  The "Server with Desktop Experience" installation option is required. Additional language packs may be added after OS installation.

- Windows Server 2019 from English Installation Media (Standard, Datacenter)

  The "Server with Desktop Experience" installation option is required. Additional language packs may be added after OS installation.

Ports in use

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

Ports | Agent component
--- | ---
7957 | AgentAPI
7432 | PostgreSQL; will bind to the local loopback addresses of 127.0.0.1 (IPv4) and ::1 (IPv6)
7500, 7502 | CFS (Connector Framework Server)

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.

- If using Media Server for optical character recognition (OCR), File Analysis Suite agents and any Media Server host machines they interact with must be within the same network and can not have a proxy between them.

- 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+

Supported data resources

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

- Micro Focus Content Manager 9.4 and 10.0

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

- File system CIFS/ SMBv2 shares

  - Must comply with SMBv2 protocol for share name restrictions.

- Microsoft Exchange Server 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)

To fully install and configure the agent, perform the following tasks:

1. Download the agent.

   TIP: You will need to enter credentials for a File Analysis Suite user account that has the Manage agents permission for Connect. Create a user for this purpose and do not use these credentials for any other purpose.

2. Install the agent on the first agent host server.

   Install the agent on any additional agent host servers.

3. Define antivirus exclusions to ensure optimal agent performance.

4. Configure cloud connection web proxy settings (Optional) if File Analysis Suite is installed in the cloud.

5. If managing Content Manager data, complete the Content Manager integration tasks.

6. If managing O365 Exchange data, complete the Exchange connection tasks.

7. If managing SharePoint data, complete the SharePoint connection tasks.

8. If managing Google Drive data, complete the Google Drive connection tasks.

9. If connecting to repositories using custom adapters, contact File Analysis Suite support for guidance.

10. If protecting documents using Microsoft Purview Information Protection, complete the Microsoft Purview Information Protection connection tasks.

11. If performing OCR on documents, complete the Media Server connection tasks.

## Download the agent

You can download the agent from the Agent Download page.

To download the agent

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.

   TIP: Click the link icon () to copy the Gateway URL to your local clipboard.

3. In the Download Agent section, 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.

## Install the Agent

When installing and configuring the agent on the host machines, keep the following recommendations in mind.

- You will need to enter credentials for a File Analysis Suite user account that has the Manage agents permission for Connect. Create a user for this purpose and do not use these credentials for any other purpose.

- As part of the agent installation, a PostgreSQL superuser is created. The user name and password you define must conform to PostgreSQL standards.

NOTE: When you uninstall a processing agent, File Analysis Suite does not remove configuration information in `\ProgramData\Micro Focus\FAS\Agent\Config`. We keep this to preserve any custom settings This preserves any custom settings you may have put in place. If you need to fully uninstall and reinstall an agent from scratch, you can remove the `\Config` directory from the host machine.

To install the agent

1. If not already completed, copy the agent installation file (`FAS-agent-version.exe`) 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`).

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 Installation Directory dialog opens.

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

   IMPORTANT: Micro Focus recommends installation on a dedicated drive with 200GB free space.

   Click Next.

   The PostgreSQL Credentials dialog opens.

7. Define the PostgreSQL credentials to be used for File Analysis Suite.

   Option | Description
   --- | ---
   User Name | Type the User Name of the PostgreSQL superuser to be created. Limits: Must be at least one character in length; maximum 63 characters. Can contain only letters, numbers, or underscores; the first character cannot be a number. NOTE: This is not a Windows account.
   Password | Type the desired password for the superuser to be created.
   Verify Password | Re-type the password.

8. Click Next.

9. 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. TIP: Click the link icon () to copy the Gateway URL to your local clipboard.
   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.

10. 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 begins.

11. When the installation completes, click Finish.

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

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

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

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

### Reauthorize the agent

If you need to reauthorize the agent within the same tenant, you must run the credential utility and enter the credentials for the authorized user.

To reauthorize the agent

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`

   TIP: For details about the entries you will make when running the credential utility, run the credential utility from a command line with the help option.

   Example: `AccessHandler.exe /h`

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.

## Define antivirus exclusions (Optional)

To ensure that the agent runs at optimal performance, some exclusions must be defined when running an antivirus application on your agent hosts. These exclusions are specific to the File Analysis Suite agent application.

CAUTION: Although not required, Micro Focus strongly recommends that you exclude the services and paths defined in this section if you are running an antivirus application on your agent hosts. Not doing so, performance on these hosts will be dramatically reduced.

In your antivirus application, define the following exclusions.

- Folders to exclude:

  - The agent installation directory.

    Example: `C:\Program Files\Micro Focus\FAS\Agent`

- Files to exclude:

  - ACADataProcessor.exe

  - ConnectorFramework.exe

  - FileSystemProcessor.exe

  - kvoop.exe

  - postgres.exe

## Configure cloud connection web proxy settings (Optional)

The AgentAPI service controlled by the processing agent requires connectivity to the File Analysis Suite cloud components, often located away from the local network where the agent host servers are located. Although direct connectivity is ideal, use of a web proxy may be required in some environments for the agent systems to reach the File Analysis Suite cloud.

To configure the cloud connection using the agent administration UI

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 Agent API.

   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.

© Copyright 2019-2023 Micro Focus or one of its affiliates
Version 3.8.2 | Last updated January 2023
Connect
Micro Focus Marketplace
Learn
Support portal
Documentation
Contact

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to FAS.docFeedback@microfocus.com.

We appreciate your feedback!

Product: File Analysis Suite 3.8.2

Topic Title: Agent installation and configuration

Submit or view service request