Installing the Agent for Windows

This document guides you through the installation of a Windows agent.

The Windows agent can be used for 32-bit and 64-bit. Each version is identified using a three-digit abbreviations. These abbreviations are used in the agents' file names. In this document, the specific abbreviation is replaced by "???."

Watch the Video: Installing Windows Agents

Notes:

This page includes the following:

Supplied Installation Files

The files of the Windows agent are found in the directory IMAGE:AGENTS\WINDOWS.

Other files from this sub-directory are components of the installation program and the AE runtime system.

For information about CallAPI files and their implementation, see CallAPI for Windows.

Potential Problems

Windows Agent for System-Wide Email Connection

A system-wide email connection can be implemented using a Windows agent. For more information, see Email Connection.

Installing the Agent for Windows

  1. Install the Microsoft Visual C++ 2010 Redistributable Package.

    This installation step can be ignored if the package is already available in the required version. Refer to the Control Panel -> Add or Remove Programs to see if the package is installed, and if so, which version.

    • Host (32-bit): Install the package from the IMAGE:CRTS\WINDOWS\X86 directory.
    • Host (64-bit): Install the package from the IMAGE:CRTS\WINDOWS\X64 or IMAGE:CRTS\WINDOWS\IA64 directory.

  2. Install the agent.

    • Host (32-bit)

      1. Start the program SETUP.EXE in the directory IMAGE:AGENTS\WINDOWS\X86.
      2. Select a separate directory for the agent (such as C:\AUTOMIC\AGENT\WINDOWS). Click the large button (computer, packing and disc) to start the installation.
      3. The AE program group is automatically created and the agent specified.

    • Host (64-bit)

      1. Start the program SETUP.EXE in the directory IMAGE:AGENTS\WINDOWS\X64
      2. Select a separate directory for the agent (such as C:\AUTOMIC\AGENT\WINDOWS). Click the large button (computer, packing and disc) to start the installation.

        The AE program group is automatically created and the agent specified.

  3. Set up the system environment.

    • Host

      1. Adjust the INI file of the Windows agent (64-bit) to your system environment. For more information, see Agent Windows 64-bit.
      2. The user who starts the agent must have the following rights if the INI file parameter logon= has been set to "1":
        • Act as part of the operating system
        • Adjust memory quotas for a process
        • Allow log on locally
        • Back up files and directories **)
        • Logon as batch job *)
        • Logon as service
        • Replace a process level token
        • Restore files and directories

      *) This right is only required if you start jobs by using the start option Logon as batch user. For more information, see Windows Jobs.

      **) This right is necessary for the execution of job objects.
      For the extended File Transfer object (as of v9) this right is usually optional. It is necessary, however, when the agent transfers encrypted files with a file transfer because the agent uses the WinAPI "LoadUserProfile".

      On Windows, the Local Security Policy can be called via the Control Panel -> Administrative Tools. Rights are defined in User Rights Assignment in the Local Security settings.

      All Windows users that should execute BATCH-type jobs required the right "Read & Execute" for the agent's "bin" and "temp" directory. Otherwise, an error message occurs when the job starts (Access denied). Doing so is only necessary if the agent's INI file parameter LOGON=1 or the UC_HOSTCHAR_*'s setting ANONYMOUS_JOB is set to "N"..

    • Admin computer or Server computer
      • Adjust HEADER.WINDOWS, TRAILER.WINDOWS and RESTART.WINDOWS if necessary. For more information, see Executing Jobs.

  4. Start the agent.

    • Server computer:

    • Host:

      • Start the agent from the AE program group.
        An agent object is automatically created in system client 0000 and stored in the folder HOST.

    • Admin computer or Server computer:

      • Verify that the agent is logged on to the AE system.

        Start the AWI for client 0000. Information about agents is available in the Administration perspective. Newly logged-on agents have not yet been assigned to a client, so they are only shown in client 0000. The newly installed agent can now be assigned to clients including the required rights via the Agent object.

    You can use the ServiceManager to start and end the agent as a service. For more information, see ServiceManager.

  5. Shut down the agent. (Host)

    1. Right-click the agent in the task bar.
    2. Click Exit.

Comments

The Windows agent requires certain additional rights under Windows in order to be able to use the Windows APIs that are listed below.

The agent requires these rights in order to process file transfers and start jobs in different user contexts. Although users are defined in the Automation Engine jobs, the agent must still be able to log on with the privileges of the particular user, read user profiles and start Jobs, for example. Therefore, start the agent via the Service Manager as a SYSTEM user.

When you start the agent as a regular user, however, you should install it with the recommended additional authorizations in order to make sure that it can process the above tasks:

The right 'log on as a batch job' is required when the option "log on as a batch user" has been activated in the Windows Jobs of the AE system's Job objects.

Powershell Configuration - File Backup or Rollback

The Agent must be configured to be able to execute Powershell commands for file backup or rollback. To do so, add the following key-value pairs in the [GLOBAL] section of the INI file of the Windows Agent:

ECPEXE=powershell.exe -NonInteractive -ExecutionPolicy bypass -NoLogo -file ECPEXT=ps1

For more information, see Agent Windows 64-bit.