Overview
Unimarket integrations use Workato as a SaaS based middleware for establishing the connections between Unimarket and customer Finance ERP as well as other third party systems. Workato can be used to establish direct connection for Web Services, REST APIs, and has multiple prebuilt Connectors.
When a direct connection between Unimarket and our Customers' systems cannot be established and a database connection is needed from behind the firewall, Workato has an On Premise Agent to allow Workato to establish a secure connection and polling from the Agent back to Workato to reduce the need for inbound firewall rules and exposure.
Details can be found on the Workato help documentation website at : https://docs.workato.com/on-prem.html#how-it-works
The Workato On Premise Agent is replacing the legacy Unimarket Connector (UCP) for all customer integrations
How it works
Workato on-prem connectivity has two core components:
- Tunneling
- Database, file system, and application access.
The on-prem agent runs within the customer's server, typically behind a firewall, and establishes a TLS WebSocket tunnel to connect out to Workato.
Because the on-prem agent is within the same network as systems behind the firewall, it can safely access the customers' systems and act as the agent to communicate securely out to Workato.
#Supported operating systems
The on-prem agent runs on the following systems:
- Linux (64-bit)
- Windows 7, 10, 11 (64-bit)
- Mac OS X
- Windows Server 2008 and newer (before OPA v2.8.0)
- Windows Server 2012 R2 and newer (OPA v2.8.0 onwards)
Minimum hardware requirements are:
- 8 GB of RAM
- 250 MB of disk space
- 800 Mhz 64-bit CPU (Intel/AMD).
NOTE: Unimarket provides a Demo/Test and Production environment. Each environment will connect to a separate Workato Agent which will need to be hosted on separate servers or VMs.
Installing the Workato On Premise Agent (OPA)
The installation of the On Premise Agent (OPA) is quick and easy on Linux or Windows host environments. The installation and confirming connection can take as little as 15 minutes with Linux DEB or RPM package Windows Package or Docker Image. Unimarket will provide a secure activation key that connects the On Premise Agent to the Customer's instance created by Unimarket.
Installation Details:
- Linux DEB Package
- Linux RPM Package
-
Windows Package
- There is a config.yaml file that may be required to setup for certain connections such as Oracle JDBC connections to contain the Host, Port, DB Instance and user credentials. See this config.yaml article for examples of Connection Profiles.
- Docker Image
- macOS Package
Maintaining and Updating the On Premise Agent (OPA)
Maintaining and updating the On Premise Agent (OPA) is easy and is recommended to be done during regular server maintenance cycles. Workato releases regular patches and updates to the On Premise Agent that can be found at their Release Version site.
Linux RPM Package Update
Upgrade the agent using following command:
% sudo yum upgrade workato-agent.x86_64
The service should automatically stop, upgrade and restart for systemd-based distributions. If that won't happen you have to do it manually.
Linux DEB Package Update
Upgrade the agent using following command:
% sudo apt upgrade workato-agent
The service should automatically stop, upgrade and restart for systemd-based distributions. If that won't happen you have to do it manually.
Window Package Update
The Windows host environment upgrade does require an uninstall of the existing agent service to install the new version. Full steps and details can be found on the Workato Windows OPA Upgrade site.
Unimarket can provide the upgraded package directly from Workato. Please create a support ticket by emailing support@unimarket.com to request the latest Windows OPA install package.
Roles and Responsibilities
Customer is responsible for:
- Providing and maintaining the host environment and OS.
- Applying OS security patches/updates.
- Installing of the On Premise Agent (OPA) with the provided install packages
- Maintenance of the On Premise Agent (OPA) updates with the provided update packages recommended during regular server maintenance cycles
Unimarket is responsible for:
- Establish the Workato Workspace for each customer and provision the TEST and PROD environments
- Establishing the On Premise Agent (OPA) Group within each of the provisioned environments (TEST/PROD)
- Provide the install packages based on the host environment OS
- Provide the Activation Key for any and all On Premise Agents
- Assist in troubleshooting connection or any On Premise Agent issues