Automic Automation / REST Agent Integration: Implementation Overview

There are different components required to integrate your Automation Engine and RESTful Web Services so that you can trigger and monitor REST Jobs from your Automic Automation system.

These are the steps you have to follow for the integration:

Download the REST Agent Installation Package

You can download the relevant Agent installation package from our download center at https://docs.automic.com/documentation or our marketplace at https://marketplace.automic.com/.

For more information, see Downloads and Marketplace.

Install the REST Agent

After downloading the relevant installation package, you have to install the Agent so that you can establish the communication between the two systems.

Important!

Before installing the Agent, check the version compatibility information in the compatibility matrix. For information about how to use the compatibility matrix, see the Compatibility Information.

You have different options to install an Agent either using the Automic Web Interface or not:

  • Install the Agent manually or in a container without using the Automic Web Interface.

    The containerized Agent installation refers to building and running a Docker image hosting Java Agents in a container.

  • Install the Agent using the Automic Web Interface.

    In this case, you create and configure an Agent (HOST) object in the Process Assembly perspective of Client 0.

Regardless of how you install the Agents, you can use them in on-premises Automic Automation systems as well as in an Automic Automation Kubernetes Edition system.

For more information about Agents and Packs see the Automic Automation documentation:

For more information on how to install the Agent, see Installing the REST Agent Manually.

Define the REST Agent

Once you have installed the Agent, you have to configure its INI file to cover your system's requirements, for example, the connection between the Agent and the Automation Engine instance. Then, you define the Agent object in AWI. There are definition pages that are common to all Agents and some that are Agent-specific.

Once the Agent is configured, you can start it.

For more information, see Defining the REST Agent.

Establish the Connection between the REST Agent and the Automation Engine

You have configured the connection between the Agent and the Automation Engine. Now you need to establish the connection between the Agent and the target Web Service. You do this through Connection objects. For more information, see Establishing the Connection between the REST Agent and the Target System.

Define REST Agent Jobs

For more information, see Defining REST Agent Jobs.

Execute REST Agent Jobs

For more information, see Executing REST Jobs.

Monitor REST Agent Jobs

For more information, see Monitoring REST Jobs.

See also:

Automic Automation / REST Agent Integration