Step 4: Install an Analytics Agent

Note: For MOVEit Automation Failover Environments (legacy failover): See Installing Analytics Agents in Legacy Failover Environments.

Install an Agent for each MOVEit database or MS Exchange database that you want to include in the Ipswitch Analytics environment. Install only one Agent per machine.

Recommended: Install the Agent on the machine that hosts the MOVEit database. For more information, see Configuration Options.

The machine that hosts the MOVEit database must be online and network accessible.

1. On the machine where you want to install the agent, sign in with an account that has administrator privileges.

   Recommended:

   • For MOVEit Automation and MOVEit Transfer, install the agent on the machine that hosts the MOVEit database.
   • For MS Exchange, install the agent on any machine that has network connectivity with the Exchange server and the Ipswitch Analytics server.
2. Download the appropriate Ipswitch Analytics Agent installation file, where n is the release number:
   • 64-bit: Ipswitch_Analytics_Agent64_vn.exe
   • 32-bit: Ipswitch_Analytics_Agent32_vn.exe
3. Open the Ipswitch Analytics Agent installation file. Click Next.
4. Accept the License Agreement. Click Next.
5. Select a Destination Folder. Recommended: Use the default location.

   Caution: Do not specify a destination on the desktop.

   Click Next.

6. Enter the Analytics Server Settings. The Agent forwards data from the MOVEit server to the Ipswitch Analytics Server that you specify here.
   • Ipswitch Analytics Server IP address or hostname: (From the Tomcat Settings that you entered during the Server installation).
   • Port: The port on which the Ipswitch Analytics Server accepts HTTPS connections. Default is 8443. Adhere to your IT security or other IT network policies when configuring ports.
   • Agent Access Username: The username that the Agent uses to authenticate with the Ipswitch Analytics server. You specified this username during the Ipswitch Analytics server installation. See the Installation Worksheet.
   • Agent Access Password: See the Installation Worksheet.
7. Click Next.
8. Select the Analytics Agent Type. Choose the type of server that the Ipswitch Analytics agent communicates with. Options are MOVEit Automation Server, MOVEit Transfer Server, Exchange Server.
9. If you selected Exchange Server as the agent type, the Exchange Server Settings page opens. Provide the Microsoft Exchange Server connection information.

   Click Next.

10. Enter the MOVEit Database Settings.

    Note: This dialog box appears only if you selected MOVEit Automation or MOVEit Transfer in the Analytics Agent Type dialog box.

    • Database Type: Select either MySQL or Microsoft SQL Server, depending on the type of database used by the MOVEit server you selected in the prior step.
    • Authentication Type (SQL Server only): Select the authentication type that is used for logon to the SQL Server.

      Windows: SQL Server logon will use Windows authentication. If you select this option, username must be entered in the DOMAIN\User format.

      SQL: SQL Server logon uses a separate user/password created specifically for logon to the SQL Server database.

    • Database Name: The name of the MOVEit database. If you are installing the Agent on the same machine as the MOVEit server, this field is pre-populated.
    • Hostname or IP Address: The location of the MOVEit database. The value you specify depends on your configuration:
      • If the MOVEit database is on the same machine as the MOVEit server, value is localhost.
      • If the MOVEit database and MOVEit server are on separate machines, the value is the Hostname or IP address of the machine where the database is located.

        Note: If you are installing the Agent on a machine that contains an SQL Server database with multiple instances on the same server, the Hostname or IP Address field prepopulates with the default value used by MOVEit Automation or MOVEit Transfer (for example, localhost\instance1). You can enter a different instance. If the machine does not contain MOVEit Transfer or MOVEit Automation, you must enter the instance name manually.

      • If you are installing the Agent on a machine that does not have MOVEit Transfer or MOVEit Automation, the default database name appears here (for example, moveitdmz).
    • Port: The port that is used to connect with the MOVEit database. Default is the default port value for MSSQL/MySQL.

      Note: If the MOVEit database is using a non-standard port number, you must remove the default port number and replace it with the non-standard port number.

    • Username and Password: The username and password that allows access to the MOVEit database.

      For an SQL Server database: The Authentication Type you selected in a previous step determines what user credentials you enter here. Windows authentication requires that the username be in the DOMAIN\User format.

      Tip: If you cannot locate the username and password to the MOVEit database, look in C:\MOVEitDMZ_Install.INI file (MOVEit Transfer) or C:\MOVEitCentral_Install.INI file (MOVEit Automation).

11. Click Next.
12. Enter the Analytics Agent Settings.
    • Agent Display Name: Enter a name to identify the agent (and the server with which it communicates) within Ipswitch Analytics. The name will appear in the Monitor dashboard and in reports.

      Tip: Use the MOVEit Automation name in the Agent Display Name so that in the Ipswitch Analytics interface, users can identify data that comes from this MOVEit server.

    • Is this a new or existing agent? Select an option:
      • Installing a new agent with a new name: The Agent Display Name must be unique.
      • Installing an agent already known to Analytics Server: Use this option if an agent with this display name was previously installed on this MOVEit Automation, MOVEit Transfer, or Exchange server, and was later removed. If you install a new agent on the same server, you can use the same name as the "old" agent.

    The next field appears only if you selected MOVEit Transfer or MOVEit Automation in the Analytics Agent Type dialog box.

    • Would you like to include historical data? This will import all current data from this MOVEit server:
      • Yes: Ipswitch Analytics includes all historical data from this MOVEit server.
      • No: Ipswitch Analytics reports include data from this time forward only, and does include any past data from this MOVEit server.

      See the subsection About historical data, below.

    Click Next.

13. Review the installation setup, and then click Install.

    Note: If you click Cancel, the installation stops, but the Agent installation folder remains in the installation directory that you selected. You can safely delete the Analytics Agent directory to remove any files that remain after an interruption of the installation process.

    To view the installer log after the installation finishes, select the checkbox.

    To view the log at another time: the log is located in a temp directory in the user's AppData folder. For example, C:\Users\Administrator\AppData\Local\Temp\n\MSIstring.log (where n is a number, and string is an alphanumeric string).

14. Click Finish.

    The Ipswitch Analytics Agent service is now running on this machine and immediately starts to report data to the Ipswitch Analytics Server. To disconnect this Agent, see Licensing in the Ipswitch Analytics Administrator's Guide.

To install another licensed Agent for a different MOVEit database, repeat this procedure (Step 4: Install an Analytics Agent).

About historical data

Note: Historical data can be included for MOVEit sources.

If during the Agent installation, you chose to include historical data, it might take some time (a few minutes to a few hours) to retrieve the historical data and send it to the Ipswitch Analytics server. While the data is being captured, the MOVE it server continues to operate, and you can use Ipswitch Analytics. However, because data capture is a "trickle" process, some historical data cannot be viewed until the data capture process is complete. You are not notified when the Agent finishes including all historical data. To verify that the historical data capture process is complete, run a report for a time range in the past.

If you have a large number (more than 10) Analytics Agents to be connected to the Analytics Server, the server might face heavy data volume from the agents if they all feed historical data at the same time. To make the initial data loading process run more smoothly, start the agents by smaller groups of 10 agents. Start the second group after the first group has finished loading historical data. After the historical data is loaded, the data volume returns to normal levels and all agents can stay up. Users can then start to use the Analytics Server.