Configure On-Prem Agents

What are agents?

For on-premises systems, Moveworks utilizes the Moveworks Agent to securely integrate with your on-premises system. The Agent is a container based application installed on a VM or server behind your firewall. It acts as proxy for interactions between the Moveworks platform and your on-premises system in order to communicate with the system efficiently and securely.

What can you do in the Agents module in Moveworks Setup?

From the Agents module in Moveworks Setup will be able to:

  1. Learn how to deploy agents in your on-premises systems.
  2. Check the status of various agents deployed.

Prerequisites

  1. Ensure that you have an on-premise system.
  2. Please see the Moveworks Agent and Moveworks Agent Installation Guide to learn more about agents, how they work and what are the requirements for setting up agents.

Configuring Moveworks Agent

🚧

IMPORTANT: Secure Your Org Access Secret

Please be advised that the API token for the Org Access Secret is displayed only once. It is imperative that you save it immediately for future use. Please handle the secret securely.

  1. First you must generate the org secret, this will be used to deploy the Moveworks Agent in your network:
    1. Navigate to the Agents module in the left navigation bar under Core Platform.
    2. Click on the Generate Secret button in the bottom right of the Agents module. A pop-up window will appear showing the Org Access Secret.
    3. Copy the Org Access Secret and save it. You will need this value as referenced in the Installation Guide reference in the next step.
  2. Deploy Moveworks Agent in your networks.
    1. See the Moveworks Agent Installation Guide to learn how to install the Moveworks Agent.
    2. See the Moveworks Agent guide to learn more about the agent.

Checking the status and health of the agents deployed.

  1. Navigate to the Agents module in the left navigation bar under Core Platform.
  2. In the Agents module you will see a table with a view of all the agents that are deployed and reachable.

Agent Health

The Agent Health refers to the agents ability to serve requests from the Moveworks platform.

Healthy - the agent is able to successfully serve requests > 90% of the time.

Unhealthy - if out of 100 calls that Moveworks makes to the agent, 10 or more times a connection could not be established.

📘

Clarification on agent Health

It's important to distinguish that a Moveworks agent's Health refers to its ability to serve requests, and does not correspond to the health of the container itself.

Agent Status

The Agent Status refers to whether the agent is Active or Inactive.

Active - agent container is running and connected to upstream Moveworks platform.

Inactive - Any agent that fails to connect to Moveworks or has stopped running is set to inactive, it will stay in this list for around 30 minutes before disappearing.