User Tools

Site Tools


ets_agent

ETS Agent

v3.21.0

The Perspectium ETS Agent processes batches of replicated table data from a ServiceNow instance and writes it to a relational database such as MYSQL or Oracle.

The agent has the same requirements as the Replicator Agent as noted here.

Installation

The agent is packaged as a zip file that you can unzip to where you would like to install it. Once unzipped, you will have the following directories:

Configurations

To configure the agent, run setup.sh (Linux) or setup.bat (Windows) located in <agent_installed_directory>/bin. The agent's configuration file is located in <agent_installed_directory>/conf/agent.properties. The service wrapper configuration is located in <agent_installed_directory>/conf/wrapper.conf. The setup script updates the necessary properties in both of these files.

The following configurations are available for the agent:

MBS Configuration

Configuration information for connecting to Perspectium MBS as provided by Perspectium:

Attribute Description
mbs_url URL of the Perspectium MBS server Required
mbs_user Username for the Perspectium MBS server Required
mbs_password Password for the Perspectium MBS server Required
mbs_queue Queue on the Perspectium MBS server to read messages from Required

The mbs_queue must start with the name of the ServiceNow instance that the messages are coming from. For example if the messages were shared from dev24440.service-now.com the queue would look like: dev24440.psp.out.replicator.example_queue

Database Configuration

Configuration information for the database the agent will be integrating with:

db_type Database type (mysql or oracle) Required
db_host Database host Required
db_port Database port number Required
db_name Database schema name Required
db_user Database user Required
db_password Password for database user Required

Proxy Configuration

The ETS Agent supports optionally using an HTTP/HTTPS proxy for the agent to connect outside the network to MBS.

Description
proxy_url URL of the proxy server to connect to. Optional
proxy_user Username for the proxy server. Optional
proxy_password Password for the proxy server. Optional

Batch Configuration

decryption_key Key string used to decrypt messages Required
sleep_milliseconds Polling interval in milliseconds Required

Sample Configuration File

#Perspectium ETS Agent Configuration File
#   To encrypt property values such as passwords, prefix the value with encrypt:
#MBS Configuration
mbs_url=http://localhost:8080/bulkout
mbs_user=username
mbs_password=password
mbs_queue=queue_name

#Database Configuration
#db_type=mysql|oracle
db_type=mysql
db_host=localhost
db_port=3306
db_name=database_name
db_user=username
db_password=password

#Batch Configuration
decryption_key=The cow jumped over the moon
sleep_milliseconds=5000

Running the Agent

The ETS Agent runs by executing scripts in the <agent_installed_directory>/bin directory. It can be run in the console or installed as a Windows service or Linux Daemon.

STARTING THE AGENT IN THE CONSOLE

  • cd to the /bin subdirectory of your install directory
  • run runConsole.sh (linux) or runConsole.bat (windows)

STOPPING THE AGENT

  • cd to the /bin subdirectory of your install directory
  • run stop.sh (linux) or stop.bat (windows)

INSTALLING WINDOWS SERVICE OR LINUX DAEMON

  • As Adminstrator, cd to the /bin subdirectory of your install directory
  • run installDaemon.sh (linux) or installService.bat (windows)

STARTING WINDOWS SERVICE OR LINUX DAEMON

  • As Adminstrator, cd to the /bin subdirectory of your install directory
  • run startDaemon.sh (linux) or startService.bat (windows)

STOPPING WINDOWS SERVICE OR LINUX DAEMON

  • As Adminstrator, cd to the /bin subdirectory of your install directory
  • run stopDaemon.sh (linux) or stopService.bat (windows)

UNINSTALLING WINDOWS SERVICE OR LINUX DAEMON

  • As Adminstrator, cd to the /bin subdirectory of your install directory
  • run uninstallDaemon.sh (linux) or uninstallService.bat (windows)

TROUBLESHOOTING

  • log files are located in the /logs sub-directory of your install directory
  • Verify that the attributes in your Agent's agent.properties file match the attributes that were given to you by Perspectium. The agent.properties file can be found in the /conf sub-directory in your install directory.
  • Contact Perspectium support at support@perspectium.com. Include any logs you that contain the errors, and the agent.properties file of your agent.
ets_agent.txt · Last modified: 2017/06/06 15:16 by torrens