Run an on-prem agent

An on-prem agent requires an active connection between the agent running within your network and Workato's On-prem group dashboard (opens new window).

You can temporarily disable this connection, such as when restarting or upgrading the on-prem agent.

Activate an agent through the installer

ALLOW TRAFFIC TO WORKATO FROM YOUR SERVER

Ensure traffic to Workato is allowed from your server to use OPA. Refer to security allowlists to add Workato to your allowlist.

Disable on-prem agent

Complete the following steps to disable an on-prem agent:

1

Sign in to Workato. The Orchestrate platform displays by default.

2

Go to Tools > On-prem groups and select the on-prem group that contains the agent you plan to disable.

3

Go to the agent's Version column and click ... (ellipsis).

4

Click Disable.

Disable an agent in Workato.

Alternatively, for agents installed on Windows machines, you can stop the old agent by terminating the Workato Agent Windows service or the console-based agent.

Complete the following steps to stop the Workato on-prem agent Windows service:

1

Press Win + R, type services.msc, and press Enter.

2

Go to the Services window and locate the agent.

3

Right-click the agent and select Stop.

4

Wait for the agent to stop completely before closing the window.

Complete the following steps to stop a console-based agent:

1

Press Ctrl + Shift + Esc to open Task Manager.

2

Go to the Processes tab and locate the agent process you plan to stop.

3

Right-click the agent process and select End Task.

Re-establish connection with on-prem agent

To reconnect your on-prem agent to Workato, you have to do the following steps. Please follow the instructions according to your network's operating system.

Run an agent on Linux

To start the agent service in the background, use:

systemctl start workato-agent.service

To enable the agent to start on system boot, use:

systemctl enable workato-agent.service

Linux log files

Log files are stored in /var/log/messages by default for on-prem agents operating as a Linux service through systemd. Because this file also contains logs from other Linux services, you must use the journalctl command to access OPA specific logs.

journalctl -u [name of the OPA service].service

The -u switch filters the logs returned by the service that created them. Replace [name of the OPA service] with the name you set for the OPA during installation.

You can further refine your log search using the following commands:

• > [output-file]: Exports the result of journalctl to a file.
• --since: Limits the generated logs to after a specific date and time.
• --until: Limits the generated logs to before a specific date and time.

For example:

journalctl -u workato.service --since "2020-07-26 23:15:00" --until "2020-08-5 23:20:00" > OPALogs.txt

Refer to Loggly's Using journalctl (opens new window) guide for additional journalctl information.

OPA LOG CONTENTS

The level of detail included in your OPA logs depends on your agent configuration. Refer to the Workato logging levels section for more information.

Running on Windows 64-bit

For on-prem agents installed in Windows, run the agent as a Windows console application or as a Windows Service.

You can activate the OPA by starting the Workato on-prem agent Windows service or using the activation script, depending on your setup.

Complete the following steps to start the Workato on-prem agent Windows service:

1

Press Win + R, type services.msc, and press Enter.

2

Go to the Services window and locate the agent.

3

Right-click the agent and select Start

4

Wait for the agent to finish starting before closing the window

Complete the following steps to start the agent using a command script:

1

Go to the bin folder inside your OPA installation folder (C:\Program Files\Workato Agent by default).

2

Run the activate.cmd script.

3

Provide the Activation command from Workato's OPA setup wizard when prompted. The code is valid for one hour. Click Regenerate code in the setup wizard to generate a new code if it expires. You must add the --proxy-host=<host-ip-address> and --proxy-port=<port number> parameters to the Activation command if you're using a proxy.

You can run the activate.cmd script with the -help parameter to display the full list of accepted input properties.

Using Windows Service

The installer automatically registers an agent (WorkatoAgent) as a Windows service . However, the agent does not start automatically. Navigate to the service configuration (Control Panel → System and Security → Administrative Tools → Services → WorkatoAgent) to configure service auto-start or change user account.

Windows log files

Log files are stored in %SYSTEMROOT%\System32\LogFiles\Workato by default for on-prem agents operating as a Windows service. You can navigate to this file manually or use the shortcut in the Start menu under All apps > Workato.

Complete the following steps to change the log storage location:

1

Open the Windows Start menu.

2

Go to All apps > Workato.

3

Click Service Wrapper Configuration to open the configuration menu.

4

Go to the Logging tab.

5

Enter a new log storage location in the Log path field.

6

Click Apply, then OK.

OPA LOG CONTENTS

The level of detail included in your OPA logs depends on your agent configuration. Refer to the Workato logging levels section for more information.

On-prem agent is reconnected

To finish re-establishing the connection, go to the On-prem group dashboard and connect to your on-prem agent.

Step	Description
Enable agent	From the Workato On-prem group dashboard, select Enable agent.
Connection established	Workato will send a request to your on-prem agent to establish a connection. If successful, the status will return to Active.