On-premise agent

16min

This feature is available to Enterprise customers.
With the On-premise agent (On-prem agent) installed on your system, your  can access applications and databases on your local network without changing the settings of your firewall.
﻿
One On-prem agent can connect to many applications that are located in the same network. Currently, we provide an HTTP Agent app that allows for a connection with other custom systems that provide an API or a web service.
﻿
﻿
﻿
To start using an On-prem agent in your , you need to:
﻿Create﻿ a new On-prem agent in the On-prem agents section of the Organization dashboard.
﻿Download﻿ the On-prem agent and install﻿ it on your device.
﻿Connect a system﻿ (an application) to the installed On-prem agent.
﻿Add a connection between  and the connected system when adding the application module in your .
Add an On-prem agent
The installation process consists of three steps:
Creating an On-prem agent in the On-prem agents section, in .
Downloading the On-prem agent to your device.
Installing the On-prem agent on your device.
Only users with the Owner, Admin, and App dev organization roles can perform all three steps.
Create an On-prem agent
1
In the left sidebar, click Organization.
2
Click the On-prem agents tab.
3
Click + Create a new on-prem agent.
﻿
4
In the On-prem agent name field, enter the agent name.
﻿
5
Click Create agent. A dialog box with credentials appears.
﻿
6
Save the Client ID, the Secret, and the Base URL in a safe place. You will need these credentials in the installation stage later. 
Make sure to save the credentials in a secure location. This is the only time when  shows the On-prem agent credentials.
7
Check I saved my credentials.
8
Click Download installer.
﻿ redirects you to the download page, where you can choose your device OS and download the On-prem agent installer﻿. 
Download the On-prem agent
You need to download the installation package for the On-prem agent to run on your device.
1
Select your device's operating system and click Download.
For macOS, download the file for Linux. 
﻿
If the auto-download doesn't start automatically, use the link instead.
2
Define where you want to save the On-prem agent installation package on your device.
3
Click Save.
Install the On-prem agent
Installation is the last step you need to start using the On-prem agent in Make. Here you will find steps for installing the On-prem agent on Windows, macOS, and Linux.
You need to have Java 11 or above already installed on your device:
1
Go to the folder where you saved the On-prem agent when downloading, right-click the file, and select Run as Administrator. An installation window appears. Click Install.
﻿
You might see a warning. Click Yes to continue the installation process.
2
Insert the credentials you saved when creating the On-prem agent﻿ in Make and click Next.
﻿
3
Select the path for installation and click Next.
﻿
4
Make sure your internet connection is stable. Click Install.
5
Complete the installation by clicking Finish.
6
A confirmation window appears. Click Close.
The On-prem agent status changes to Active in Make after refreshing the On-prem agents page. You can connect a system﻿ to it.
﻿
You can also check your system to see if the installation was successful:
1
Open the Services app on your computer.
2
In the list of services, find Make Agent. If the status is Running, you can start using the On-prem agent in Make. If there is no status, check the troubleshooting guide﻿.
The installer works only for the agent you've downloaded. If you need to run more than one agent on your server, you need to download the installer once again and repeat the installation procedure.
You need to have Java 11 or above already installed on your device:
1
Go to the folder where you saved the .zip archive. 
2
Unzip the archive.
3
Open the application-local.yml file and fill in the following fields with the data you saved when adding an On-prem agent﻿ in .
make: authentication: client-id
make: authentication: client-secret
make: authentication: base-url
4
Save the changes in the file.
5
Open the Terminal.
6
Open the folder that you unzipped from the archive in the Terminal. It is called Linux-Mac.
7
Launch the file using this command: java -jar agent.jar
﻿
The system launches the On-prem agent. If you see the Successfully connected Agent with ID... and Started to poll for tasks strings, it means the agent is installed successfully. You can connect a system to it.
You need to have Java 11 or above already installed on your device:
1
Go to the folder where you saved the .zip archive. 
2
Unzip the archive.
3
Copy the application-example.yml file, and rename the copied file to application-local.yml.
4
Open the application-local.yml file and fill in the following fields with the data you saved when adding an On-prem agent﻿ in .
make: authentication: client-id
make: authentication: client-secret
make: authentication: base-url
5
Save the changes in the file.
6
Open the Terminal.
7
Open the folder that you unzipped from the archive in the Terminal. It is called Linux-Mac.
8
Launch the file using this command: java -jar agent.jar
﻿
The system launches the On-prem agent. If you see the Successfully connected Agent with ID... and Started to poll for tasks strings, it means the agent is installed successfully. You can connect a system to it.
Connect a system
Once you installed the On-prem agent, you can connect it to an application (a connected system). You can connect several systems to one On-prem agent.
Only users with the Owner, Admin, and App dev organization roles can connect a system.
Connect the HTTP system
1
In the left sidebar, click Organization.
2
Click the On-prem agents tab.
3
Click Connect system.
4
In the Name field, insert a connection name. This name appears when adding an application module to a Make.
5
In the Choose app to connect dropdown list, select the HTTP Agent app.
6
Define the base URL to the application API.
The URL contains a host, a port, and a definition of API for a particular app. If the app runs on the same device where the On-prem agent is installed, the host is localhost. If the app runs on another device, the host is the device IP address. The port and the API definition vary based on the app.
In this example URL https://localhost:3000/api
the host is localhost
the port is 3000
the definition of API is /api
﻿
7
In the URL field, insert the URL to the application API.
8
Click Save.
In the connected systems list, you will see a new connection that works with this specific On-prem agent. Now you can start building a .
You might be asked to renew the access to the connected system after a certain period of time. If so, click Revoke in the Connected systems section.
Create a connection in the scenario
To create a connection﻿, go to the  editor.
1
Click Create a new scenario.
2
Select the HTTP Agent from the dropdown list.
3
Select a module and connect it to .
4
Finishg configuring the module settings.
After adding the module, you can continue building your . The module uses your selected On-prem agent.
Currently, Make supports only HTTP Agent application for the On-prem agent usage.
On-prem agent status
The following table explains On-prem agent statuses.
Status
Description
Recommended next steps
Active
The On-prem agent is installed on your device and works under normal conditions. You can connect a system to it and use it in .
﻿
Not responding
The On-prem agent is disconnected.  checks its activity every four minutes. If the On-prem agent doesn't respond, it means the Internet connection is lost.
Check On-prem agent troubleshooting.
When in Not responding status, associated  still run, but the module using the On-prem agent shows a 500 error.
Registered
The On-prem agent is created and appears in the On-prem agents section.
Make sure to complete the installation of the On-prem agent.
Check if your firewall or anti-virus software is blocking the On-prem agent.
Stopped
The On-prem agent was stopped manually.
Make your On-prem agent active again if needed.
Troubleshooting
Here you can find solutions for the most common issues when working with the On-prem agent in .
If the installation process breaks, and the progress bar remains the same, do the following:
Check if you have these drives installed and updated:
a. Visual Studio 2019
b. AdoptOpenJDK 11
c. Java 11 and above
Restart the installation process.
The following error appears if you have the wrong version of Java installed on your device:
﻿
﻿
Open the Command line.
Use the echo %JAVA_HOME% command to make sure Java is in the Windows PATH variable.
Use the java -version command to make sure Java 11 or above is installed.
﻿
Right-click the installer and click Run as Administrator.
Check the following:
The device where the On-prem agent is installed is operational.
The device is connected to the Internet.
The Internet connection is stable.
Your firewall and anti-virus software don't block the On-prem agent.
Restart the On-prem agent on your device (Windows only):
If you open the Services app on Windows and see that the Make Agent app doesn't have the Running status, you can do the following:
Go to the folder where you saved the On-prem agent on your machine.
Open the application-local file and check your credentials: Client ID, Secret, and Base URL.
Open the logs folder and locate the problem.
﻿

Status	Description	Recommended next steps
Active	The On-prem agent is installed on your device and works under normal conditions. You can connect a system to it and use it in .
Not responding	The On-prem agent is disconnected. checks its activity every four minutes. If the On-prem agent doesn't respond, it means the Internet connection is lost.	Check On-prem agent troubleshooting. When in Not responding status, associated still run, but the module using the On-prem agent shows a 500 error.
Registered	The On-prem agent is created and appears in the On-prem agents section.	Make sure to complete the installation of the On-prem agent. Check if your firewall or anti-virus software is blocking the On-prem agent.
Stopped	The On-prem agent was stopped manually.	Make your On-prem agent active again if needed.

Devices

Keys

On-premise agent

Add an On-prem agent

Create an On-prem agent

Download the On-prem agent

Install the On-prem agent

Installation for Windows

Installation for macOS

Installation for Linux

Connect a system

Connect the HTTP system

Create a connection in the scenario

On-prem agent status

Troubleshooting

Windows installer broke in the middle of the installation

Error regarding wrong Java version when installing the On-prem agent for Windows

No permissions to run the Windows installer

On-prem agent in Not responding status in Make

On-prem agent not running on a Windows machine