Articles in this section

Install and configure the Windows on-premise agent

Legacy production and sandbox licenses

In legacy Production and Sandbox environments, changes in one environment affect both environments. The Production and Sandbox environments share the same underlying resources. Any resource you create, edit, or delete in one environment is immediately reflected in the other.

This includes connections, imports, exports, flows, scripts, and API tokens. Use caution when editing resources in either environment.

This behavior doesn't apply to accounts on the multi-environment license, where each environment maintains its own isolated resources.

Migrations from the legacy Production/Sandbox license to the new multi-environment license are underway. Your account has not migrated to the new multi-environment license if you can toggle between environments.

Toggle to Sandbox environment.png

Minimum system requirements

  • Windows version: Windows 7 or later

  • RAM: 2 GB (Minimum), 4 GB (Recommended)

  • 2 CPU cores

Download and install the agent software

  1. Navigate to Resources → Agents.

  2. Click + Create agent.

  3. Name your agent and add a description.

  4. Click Save. Your agent now appears on the list.

  5. From the Install column, click the Download option and choose the operating system (Windows).

    360061142271-agent-1.png
  6. After downloading, install and open the agent software.

Install the agent

If you downloaded the agent to the target computer, open the agent's setup file, agent-windows.exe, in your browser and install it.

Otherwise, copy the downloaded file to the server and double-click to launch setup.

The setup prompts you to choose installation options:

  1. Install the agent for Only for me (Administrator) or Anyone who uses this computer (all users).

    1. Only for me – accessible to only one user

    2. All users – any user can run the service, but only one user should run it at a time.

      If you select All users, administrative privileges are not automatically assigned, and the auto-upgrade feature will not work. Add admin privileges manually as follows:

      1. Stop the service if it's running.

      2. Right-click Celigo Agent in your Windows Services app.

      3. Click Properties → Log on.

      4. Click on this account, write in Administrator as the username, and enter the administrator password.

      5. Restart the agent service.

  2. Click Install.

  3. Give Windows permission to trust the downloaded executable and proceed.

  4. In the Completing Agent Setup window, ensure that Run agent is checked. Then, click Finish.

The Agent shortcut is added to your desktop and Windows programs, and the software opens to ask you for an integrator.io token.

Enter agent token

An access token secures communication between the agent and integrator.io. Your agent token is automatically generated when you create the agent. To find the token:

  1. Return to integrator.io and navigate to ResourcesAgents.

  2. In the list of agents, click Show token.

  3. Click Copy (copy.svg​​) next to the unmasked access token to copy it to your clipboard.

    360061142811-agent-2.png
  4. In the agent software, enter the access token. The agent will automatically start communicating with integrator.io.

    360061148171-agent-4.png

The agent should now be online. You may need to refresh the page to confirm it's online.

image idm45220717887616

If your token is compromised, you can generate a new token:

  1. In integrator.io, navigate to Resources → Agents.

  2. Click Actions → Generate token.

This will automatically revoke the old token, so you must enter the new one.

Not required: Run the agent as a Windows service

By default, the agent runs as a standard Windows executable. Running it as a Windows service instead offers these benefits:

  • The agent will run silently and continuously after installation and each time the system starts up

  • The agent will run regardless of which user account is logged on

  • As a service, the agent can be managed and monitored from remote systems

To run the agent as a Windows service:

  1. Double-click the Agent shortcut on your desktop.

    Celigo agent icon
  2. Choose Install service.

    360076181212-agent-5.png
  3. The agent will confirm the successful installation.

  4. Click OK to dismiss the user interface.

  5. Your system must restart to run the agent as a service.

    360076181652-agent-6.png

The agent will automatically launch as a Windows service once the system restarts. However, you can choose to launch it right away. To launch it immediately:

  1. Double-click the Agent shortcut on your desktop.

  2. Click Close.

  3. Click Stop to stop it from running in the background.

  4. In Windows, search for the Services application.

  5. From the list of services, find Celigo Agent.

  6. Right-click the service and click Start to run it right away.

Agent as service 2 (1).gif

If you later decide that you prefer to run it as an executable, in the taskbar or in the background, double-click the Agent shortcut and click Uninstall service.

360076410011-agent-7.png

Set up your connection

  1. Create a connection in integrator.io from Resources → Connections or by adding a new Source or Destination app in flow builder.

  2. For the Mode, choose On-premise (the default is Cloud).

  3. Choose your Agent from the drop-down list.

    360060987632-agent-3.png

When creating an integrator.io connection that uses an on-premise agent, your settings will depend on whether the agent is installed on the same server as the application or database.

  • Same server – set the Base URI to localhost or 127.0.0.1

  • Different servers on the same network – Set the Base URI to the hostname or IP address of the system the application or database is running on.

You can run only one instance of an agent on a machine. However, the same agent can be used to talk to multiple databases and applications on the same network as the agent.

For example, if you're running SQL on two virtual machines (VM1 and VM2) and you've installed an integrator.io agent on VM1, your agent can access every SQL database on the same machine and any applications in the same network. Say you have an HTTP application running on VM2 and you want to create a connection. You can use the existing agent for that connection since VM1 and VM2 are on the same network.

So, as long as VM1 and VM2 are on the same network, you can access any application on both machines.

OAuth connections

On-premise agents route OAuth token exchange locally for HTTP connections that authenticate against private network servers. If your authorization server is on a private network, you don't need to expose it to the public internet. Make sure your agent is on the latest version to use this feature. The agent auto-update process handles this for most customers.

Note

OAuth token exchange through the agent applies only to connections configured to use an on-premise agent. Cloud-based connections are unaffected.

Exports and imports

Exports and imports that use a connection through an on-premise agent do not need any special configuration, since the agent configuration is fully contained within the connection settings. Once the connection is established, you can build flows and integrations as normal.

Verify your on-premise agent version in Windows

To verify your on-premise agent, open your Control Panel and navigate to Programs → Programs and Features. Find the agent, which may be precluded by the Celigo logo, and look at the Version column.

image-20230713-110247 (1).png