On-Premise Agent

On-Premise Agent

Overview

The On-Premise Agent in OneEnterprise is a lightweight proxy component that you deploy within your private network to enable secure, bidirectional communication between your on-premises systems and the OneEnterprise cloud integration platform. It acts as a trusted intermediary, allowing cloud-hosted automations to access internal resources — such as databases, ERP systems, and file servers — without exposing them directly to the internet.
Each agent is identified by a unique Key that authenticates them to the OneEnterprise platform. Once registered, you can associate the agent with one or more Connected Systems so that automations can route integration traffic through it. This module lets you create, edit, and monitor all agents registered in your environment from a single, centralized view.
Administrators and integration architects use the On-Premise Agent module to manage agent lifecycle — from initial setup and key retrieval through to monitoring which systems depend on a given agent. This guide walks you through each step of that workflow.

Key Features
  1. Centralized Agent Management: View, add, edit, and delete all on-premise agents from one screen.
  2. Unique Key Authentication: Each agent receives a platform-generated key used to authenticate outbound connections securely.
  3. Connected Systems Visibility: See which systems route traffic through each agent to assess impact before making changes.
  4. Inline Edit and Delete: Manage agent names and descriptions directly from the agent card without leaving the list view.
  5. Proxy Settings Guidance: In-context links to Knowledge Base articles about proxy server configuration are available on the Details page.

Step 1 – Navigate to On-Premise Agent

  1. Select On-Premise Agent from the left navigation sidebar. The sidebar icon resembles a connected network device.
  2. The On-Premise Agent list page opens, displaying agent cards for every agent registered in your environment.
  3. Each card shows the agent's name, a short description, the number of systems connected through it, and a Guides link.



Step 2 – Add a New Agent

  1. Select Add in the top-right corner of the On-Premise Agent page.
  2. The Details pop-up opens as an overlay on the current page.
  3. Enter a unique, descriptive name in the Name field. This field is required (marked with an asterisk *).
  4. Enter an optional description in the Description field. You can enter up to 500 characters. The character counter displays as X/500 at the bottom-right of the field.
  5. Select Save to create the agent. The pop-up closes, and the new agent card appears in the list.
  6. Select Close to discard the entry and dismiss the modal without saving.


Notes
Please note that the Name field is required. You cannot save the agent without providing a name. The description is optional but recommended to help other users identify the agent's purpose.

Step 3 – View and Manage Agent Cards

  1. After adding an agent, it appears as a card in the On-Premise Agent list.
  2. Hover over an agent card to reveal the action icons in the top-right of the card:
    1. Edit (pencil icon) — Opens the Details modal to update the agent's name or description.
    2. Delete (bin icon) — Permanently removes the agent from the platform.
  3. Select the Edit icon to update the agent name or description. The Details modal opens pre-populated with the current values.
  4. Select the Guides link at the bottom of the card to access setup and configuration documentation for that agent.
  5. Select the Systems count at the bottom of the card to view how many systems are currently routing through this agent.

3.1 Download Agent & Guides

Select Guides from the bottom of any agent card to open the Download Agent page. This page provides platform-specific guides for installing and operating the agent software on your on-premises server.

  1. The Download Guides section displays available guide cards in a two-column grid. Each card shows the operating system logo, the guide title, a short description, and a blue Download button.
  2. Each section provides one installation guide and one user guide. Identify the card that matches your server's operating system and guide type:
    1. Install Guide (iOS) — Step-by-step instructions for installing the On-Premise Agent software on an iOS environment.
    2. User Guide (iOS) — Reference documentation for operating and configuring the agent on iOS after installation.
    3. Install Guide (Windows) — Step-by-step instructions for installing the agent on a Windows server.
    4. User Guide (Windows) — Reference documentation for operating and configuring the agent on Windows after installation.
    5. Install Guide (Linux) — Step-by-step instructions for installing the agent on a Linux server.
    6. User Guide (Linux) — Reference documentation for operating and configuring the agent on Linux after installation.
  3. Select Download on the appropriate card to download the guide file to your device.
  4. Use the Install Guide when setting up a new agent. Refer to the User Guide for ongoing configuration, troubleshooting, and proxy settings.


Step 4 – Access Agent Options

  1. Select an agent card (click the card body, not the hover icons) to open the agent's Options page.
  2. The breadcrumb updates to On-Premise Agent > [Agent Name].
  3. Two options are available:
    1. Connected Systems — View all systems that are currently using this proxy agent.
    2. Details — View and modify the proxy agent's name, description, and key.
  4. Select the desired option to navigate into that section.


Step 5 – View Agent Details and Copy the Key

  1. Select Details from the agent options page. The breadcrumb updates to On-Premise Agent > [Agent Name] > Details.
  2. The Details page displays the full agent record with three fields: Name, Description, and Key.
  3. Review the Name and Description fields. These are editable — update them as needed.
  4. Locate the Key field. This field contains the unique authentication key generated by OneEnterprise for this agent. The key is a long alphanumeric string.
  5. Select the Copy icon on the right side of the Key field to copy the key to your clipboard. Use this key when configuring the agent software on your on-premises server.
  6. Select Save in the top-right to apply any changes to the Name or Description fields.


Notes
Please note that the Key field is read-only and generated by the platform. You cannot manually set or reset the key from this screen. Store the key securely — it is used to authenticate the on-premise agent software with the OneEnterprise cloud service. Refer to the proxy settings Knowledge Base articles linked on this page if you need to configure firewall or proxy rules for the agent.

Step 6 – View Connected Systems

  1. Select Connected Systems from the agent options page. The breadcrumb updates to On-Premise Agent > [Agent Name] > Connected Systems.
  2. The Connected Systems page lists all systems in your environment that route their integration traffic through this agent.
  3. If no systems are connected, the page displays an empty-state illustration with the message: "No system connected yet."
  4. Use the Search icon (top-right) to filter the list of connected systems by name.
  5. To connect a system to this agent, navigate to the relevant system's configuration page in the Systems module and assign this agent as the proxy.

Use Cases

  1. Connecting an on-premises ERP system: An integration architect registers an On-Premise Agent on a server inside the corporate network. They copy the generated Key and configure it in the agent software. Automations in OneEnterprise then route ERP API calls through the agent without opening inbound firewall ports.
  2. Multi-agent environments: A large enterprise runs separate agents for different regions or business units. Each agent is named and described to reflect its scope (e.g., "APAC-SAP-Agent"), making it easy for the operations team to identify and manage each agent from the list view.
  3. Auditing system dependencies before decommission: Before removing a legacy on-premises server, an administrator opens the agent's Connected Systems page to confirm which systems are still routing through it. This prevents unexpected integration failures during decommission.
  4. Agent credential rotation planning: A security team reviews all registered agents and their associated systems to plan a key-rotation exercise, ensuring that all agent configurations are updated in a controlled sequence.

Field Reference

Field / Control

Type

Description

Name

Text input (required)

A unique, human-readable label for the agent. Use a descriptive name that identifies the agent's location or purpose. Required — the record cannot be saved without a value.

Description

Multi-line text area (optional)

A free-text field for additional context about the agent — its location, owner, or scope. Accepts up to 500 characters. The character counter (X / 500) displays in the bottom-right of the field.

Key

Read-only text field

A platform-generated alphanumeric string that uniquely identifies and authenticates this agent to the OneEnterprise cloud service. Use the copy icon to copy it to your clipboard for use during agent installation.

+ Add

Button (split, with dropdown)

Opens the Details modal to register a new On-Premise Agent. The dropdown chevron may expose additional creation options.

Edit (pencil icon)

Icon button (card hover)

Appears when hovering over an agent card. Opens the Details modal pre-populated with the agent's current name and description.

Delete (bin icon)

Icon button (card hover)

Permanently removes the agent record from OneEnterprise. Deleted agents cannot be recovered, and any systems assigned to them will lose their proxy route.

Connected Systems

Navigation tile

Navigates to the list of systems currently configured to route traffic through this agent. Use this view to assess impact before modifying or decommissioning an agent.

Details

Navigation tile

Navigates to the full agent record showing Name, Description, and Key fields. From here, you can edit the agent's metadata and retrieve the authentication key.

Guides

Card footer link

Opens the setup and configuration documentation for this agent type, including installation and proxy configuration instructions.

Systems

Card footer count

Displays the number of systems currently routing through this agent. A count of 0 means no systems are assigned.

Save

Button (primary)

Saves changes to the agent's Name and Description fields. Appears in both the Details modal and the full Details page.

Close

Button (secondary)

Dismisses the Details modal without saving changes. No data is written to the platform when you select Close.








































































    • Related Articles

    • On-Premise Agent Installation Guide

      Overview The OneEnterprise On-Premise Agent is a lightweight Windows service that enables secure communication between your on-premises systems and the OneEnterprise cloud platform. Once installed, the agent acts as a bridge — allowing OneEnterprise ...

    • Business Partner Dashboard

      Overview In OneEnterprise, a Business Partner refers to any individual or organization that collaborates with us on a business-to-business (B2B) level. Becoming a Business Partner is simple—anyone who registers with OneEnterprise is automatically ...

    • Contacts Dashboard

      The contact module in OneEnterprise provides a comprehensive list of all the individuals associated with your organization. From partners to colleagues, the module displays each person's contact image, name, and job title. This feature lets you ...