User Tools

Site Tools


replicator_ready_to_run_agent_installation_windows

Windows Ready-to-Run Agent

Download

You will need to download this zip file (per your version):

perspectium-replicator-windows_jaz.zip

Contact support@perspectium.com if you have not received this file.

The ready-to-run agent is a zipped file that makes it possible to run the agent without the usual installation process. Setting up the configuration for agent will instead be done on ServiceNow through the Ready to Run UI page. It is recommended to have the configuration set and downloaded from ServiceNow before unzipping the agent.


Agent Requirements

These are the requirements needed to ensure that your agent can be executed properly and has the ability to be upgraded in the future.

System

System Requirements
Memory 8GB minimum
Processor Cores 4 minimum
Hard Disk Space 100GB minimum
Network Interface GigE

Network Access

The Replicator agent requires only outbound access to the Perspectium cloud and the ServiceNow instance.

Perspectium products require that your firewall settings allow traffic to and from your Perspectium MBS. This can be through any one of the following three ports: AMQP, AMQPS, or HTTPS. You will specify which protocol you will be using through the URL of the <message_connection>.

The Agent also requires that your firewall settings allow traffic to and from your ServiceNow instance. To test this access you can consult this page.

Network Requirements
AMQPS Outbound Port TCP/5671 outbound to your Perspectium MBS (amqps://example.perspectium.net)
AMQP Outbound Port TCP/5672 outbound to your Perspectium MBS (amqp://example.perspectium.net)
HTTPS Outbound Port TCP/443 outbound to your Perspectium MBS (https://example.perspectium.net)
HTTPS Outbound Port TCP/443 outbound to your ServiceNow instance

Java

Both 32 and 64 bit versions of Java are supported. The Java version must be Java 8 or higher. As of the Fluorine release, Java versions 9 and 10 are supported. It's strongly recommended that you use a server type JVM instead of a client or desktop version.

A 32 bit version of Java is required if you're running the agent on a Windows server for Agent versions under 3.24.0.

You can determine that Java is in your current path and the version by issuing the following command from the command prompt:

java -version

If you don't see something like the following then please contact your system administrator for help.

java version "1.8.0_181"

Make note of the path to Java. One way to determine the path to Java on most linux distros is to issue the following command:

which java

On Windows this is typically located in “C:\Program Files \Java\…”

On either windows/linux the installer will generally find the path to the java installation and auto-fill this for you.

Verify that Java is in your PATH system (environment) variable as some installations of Java may not add it properly. If it is not there, add the path of the JRE's bin direct as indicated here.

Supported Databases

Database Version
Oracle 11g, 12c Release 1: 12.1 - 12.2.0.1.0
SQL Server (MSSQL) 2012, 2016 recommended
MySQL 5.6 - 8.0 supported in Europium
SAP Hana SPS 12
Amazon Redshift 4.0-4.1
Amazon Aurora (MySQL compatible) N/A
IBM DB2 11
HP Vertica 8.0 - 9.21
PostgreSQL 42.2.6
Snowflake 3.9

NOTE: Perspectium uses the newest version of each of the associated JDBC drivers, which are included with the install.

NOTE: Perspectium strongly recommends placing the Agent on the same local area network as the database server.

Supported Operating Systems

The following OS versions are supported by the Replicator Agent:

OS Version
Windows Professional & Home 7 - 10
Windows Server 2012 - 2016
Linux Ubuntu 14.04 and 16.04

Setting Up the Agent


As shown above, the following zipped folder should be downloaded. You may open it and extract it to a desired directory.


Inside the zipped folder should have the following directories. After extraction, make sure that the destination of the extraction has each of the following directories and files as shown above.


In the bin folder lies the necessary files in order to run and execute processes, such as the agent and configuration validation.

?
The conf folder houses files for configuration. The agent.xml is used to declare endpoints and settings for the agent. More details to see here —-

Validating Your Configuration

After the initial set up, you can look at your configuration within the agent.xml file of the conf directory. Here you will see a generic task set up with the credentials you have just input. You can either run it now, however, it is recommended to run our tool to test and validate your current connections. It will run through your Message Bus Connections, Database Connections, and Instance Connections (to ServiceNow or elsewhere) as you have prescribed.

Following these connections it will notify you which pieces failed as well as other diagnostic information about your current configuration. To see how to run this test see here.


Installation as a Service

To ensure the Replicator agent runs all the time we'll want to do a few simple tasks to ensure that it will be automatically started when the computer is started. You should also validate that the Agent is working fully before installing it as a service.

Validation

Run the ValidateConfiguration tool mentioned above to ensure that the Replicator agent will run after making the necessary configurations

These bat files may need to be run by someone with administrator privileges and you will be prompted to verify that the command should be run as administrator.

You may want to test run the Agent by executing the agent.bat file. This will run the Agent within a command window. Once you close the window the Agent will stop.

Installation

Right click on the file installService.bat and select “Run as Administrator” to install the agent as a service. It will not function properly if you do not “Run as Administrator”.

That's it for the installation. You can then use the startService.bat or stopService.bat to stop and start the service. You could also use the Windows Services tool. This service will be given the service name specified in the installer and the display name “Perspectium Replicator Agent”. You do not need administrator privileges to Start / Stop the Agent service once it is installed.

Please refer to the Replication Agent configuration documentation to further leverage the Perspectium Replicator Agent.

Installing Multiple Agents

The name of the agent can be specified in the agent.xml and wrapper.conf. When using multiple agents, they may be differentiated by their names.

For the agent.xml, search for the following line and enter the desired name for your agent:

<task_name>name_example</task_name>

Refer to replicator_agent_tasks for more information

As for the wrapper.conf, the name can be search for the following line of code:

# Name of the service
wrapper.ntservice.name=name_example

If you want to install multiple agents as services on the same machine, you will need make sure that each Agent has a unique wrapper.name as the Service Name.

For more details see here

replicator_ready_to_run_agent_installation_windows.txt · Last modified: 2018/04/11 09:36 by willm