On-premise agent

this feature is available to enterprise customers with the on premise agent (on prem agent) installed on your system, your {{scenario plural lowercase}} can access applications and databases on your local network without changing the settings of your firewall on prem agent schema 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 using an http agent more detailed on prem schema to start using an on prem agent in your {{scenario singular lowercase}} , you need to on premise agent /#create an on prem agent a new on prem agent in the on prem agents section of the organization dashboard on premise agent /#download the on prem agent the on prem agent and on premise agent /#install the on prem agent it on your device on premise agent /#connect a system (an application) to the installed on prem agent on premise agent /#create a connection in the scenario between {{product name}} and the connected system when adding the application module in your {{scenario singular lowercase}} add an on prem agent the installation process consists of three steps create an on prem agent in the on prem agents section, in {{product name}} download the on prem agent to your device install 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 to create an on premise agent in the left sidebar, click org switch to the on prem agents tab click + create on prem agent in the on prem agent name field, enter the agent name, and click create agent a dialog box with credentials appears 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 {{product name}} shows the on prem agent credentials check the i saved my credentials box click download installer {{product name}} redirects you to the download page, where you can choose your device os and on premise agent /#download the on prem agent download the on prem agent to run the on prem agent on your device, you need to download its installation package once you click download installer as described in step 8 in on premise agent /#create an on prem agent section, you'll be redirected to the installation page 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 define where you want to save the on prem agent installation package on your device 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 installation for windows you need to have java 11 or above already installed on your device 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 insert the credentials you saved when on premise agent /#create an on prem agent in make and click next select the path for installation and click next make sure your internet connection is stable click install complete the installation by clicking finish 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 on premise agent /#connect a system to it active agent you can also check your system to see if the installation was successful open the services app on your computer 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 on premise agent /#troubleshooting 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 installation for macos you need to have java 11 or above already installed on your device go to the folder where you saved the zip archive unzip the archive open the application local yml file and fill in the following fields with the data you saved when on premise agent /#add an on prem agent in {{product name}} make authentication client id make authentication client secret make authentication base url save the changes in the file open the terminal open the folder that you unzipped from the archive in the terminal it is called linux mac launch the file using this command java jar agent jar mac installation command 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 installation for linux you need to have java 11 or above already installed on your device go to the folder where you saved the zip archive unzip the archive copy the application example yml file, and rename the copied file to application local yml open the application local yml file and fill in the following fields with the data you saved when on premise agent /#add an on prem agent in {{product name}} make authentication client id make authentication client secret make authentication base url save the changes in the file open the terminal open the folder that you unzipped from the archive in the terminal it is called linux mac launch the file using this command java jar agent jar mac installation command 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 have 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 in the left sidebar, click organization click the on prem agents tab click connect system in the name field, insert a connection name this name appears when adding an application module to a make in the choose app to connect dropdown list, select the http agent app 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 in the url field, insert the url to the application api 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 {{scenario singular lowercase}} 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 connect an application docid\ so88fm6pkt0g adkddfzz , go to the scenario builder click create a new scenario select the http agent from the dropdown list select a module and connect it to {{product name}} finish configuring the module settings after adding the module, you can continue building your {{scenario singular lowercase}} 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 {{scenario plural lowercase}} not responding the on prem agent is disconnected {{product name}} 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 {{scenario plural lowercase}} 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 {{product name}} windows installer broke in the middle of the installation 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 error regarding wrong java version when installing the on prem agent for windows the following error appears if you have the wrong version of java installed on your device java error 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 no permissions to run the windows installer right click the installer and click run as administrator on prem agent in not responding status in make 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) on prem agent not running on a windows machine 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