App Xchange Agent

The Trimble App Xchange Agent is an essential tool that securely moves data between your systems and the App Xchange Platform.

It is a key technical aspect of App Xchange’s integration solutions when working with Foundation Connector, Sage 100 Connector, Sage 300 Connector, Viewpoint Spectrum, and Viewpoint Vista. This lightweight Windows service acts as a broker between the App Xchange cloud platform and a third-party database. It can communicate with many kinds of databases, even those on a local server infrastructure, behind a firewall, and without web-based connectivity. It is essential for running many integrations in the Trimble Marketplace network.

The App Xchange Agent communicates with external platforms via private REST APIs and HTTPS web services to ensure all traffic is secure, encrypted, and authorized. Communications are packaged into encrypted packets, which are issued back to the platform via a response stream for efficient processing. It routinely monitors the cloud platform for instructions and automatically updates itself to the latest version. And because processing occurs on the App Xchange platform rather than the local environment, local resources are protected from expanded or inappropriate use.

The App Xchange Agent has modest system requirements and typically takes less than five minutes to install.

App Xchange Agent Minimum System Requirements

Operating System: Windows Server 2008 or newer

Architecture: X64 or x86

.NET Framework: 4.7.2 or newer (Recommended: Download the latest version recommended by Microsoft)

System Resources: The App Xchange Agent is resource-efficient and lightweight. Any general-purpose application server comparable to AWS EC2 M5 large is sufficient to host it. It just needs a stable connection that is always up.

Install the App Xchange Agent

If your database is hosted on a cloud instance, a support member from this service must complete these steps for you. If your database is self-hosted on a local server, you must be a database administrator to complete these steps on your own.

  1. Ensure that your server where the ERP is hosted meets the minimum requirements for the App Xchange Agent.
  2. Check if the App Xchange Agent is already installed on your server.
    1. In the server where the App Xchange Agent is installed, run the Task Manager.
    2. Select the Services tab.
    3. Determine if the Int.Serv.Core.ConnectorService and Int.Serv.Core.ConnectorService.Monitor services are running.
      • If neither service is present, proceed to the next step.
      • If either service is present, do not install the App Xchange Agent. Instead, email xchange_support@trimble.com using the the following template complete with the necessary information.

        Subject: Please split my App Xchange Agent

        Body:

        Hi, I have an App Xchange Agent that needs to be split. Here is the server and new workspace ID.

        Server: [Enter the name of the application server your agent is installed on]

        New integration workspace ID: [Enter the new integration workspace ID]

        Thank you.

  3. Install the App Xchange Agent.
    1. Find your activation code by opening this connector's workspace in App Xchange, selecting the workspace name or icon in the lefthand menu, and then scrolling down to the Agent Info section. Record it for later.
    2. Download the latest version of the App Xchange Agent here.
    3. Move the .zip file to the server where the ERP is hosted.
    4. Install the App Xchange Agent by following the instructions in the installation wizard. When prompted, enter your activation code.
The App Xchange Agent is installed.
Once the App Xchange Agent is installed, or if you have any issues, follow up with the integration's deployment team so they can ensure the connection is successfully established.

Restart the App Xchange Agent

Follow these steps when App Xchange Support prompts you to restart the App Xchange Agent.

If a cloud service hosts your server, a support assistant from that service must complete these steps for you. If you host your server on-premise, you must be an administrator to complete these steps.
  1. In the server where the App Xchange Agent is installed, run the Task Manager.
  2. Select the Services tab.
  3. Highlight the service named either Int.Serv.Core.ConnectorService or Ryvit Connector.
  4. Select Restart.
  5. Highlight the service named either Int.Serv.Core.ConnectorService.Monitor or Ryvit Monitor.
  6. Select Restart.
The App Xchange Agent is restarted.
Inform your Customer Success Manager.

Was this helpful? Give us feedback.