Page History
HTML |
---|
<style> .release-box { height: 30px; width: 100px; padding-top: 8px; text-align: center; border-radius: 5px; font-weight: bold; background-color: #d4af37; border-color: #FCE28A; } .release-box:hover { cursor: hand; cursor: pointer; opacity: .9; } </style> <meta name="robots" content="noindex"> <div class="release-box"> <a href="https://docs.perspectium.com/display/gold" style="text-decoration: none; color: #FFFFFF; display: block;"> Gold </a> </div> |
You can install the Perspectium DataSync Agent on supported Windows and Linux devices.
Prerequisites
First, make sure that the device you are installing the DataSync Agent on meets these basic requirements.
You will also need to request the Agent Installer from Perspectium Support.
NOTE: Screenshots are for a MySQL database and may change depending on database type.
Procedure
To install the DataSync Agent, follow these steps:
UI Step |
---|
Open the Agent InstallerOpen the Agent Installer .jar file. If you didn't receive this file, you can request one from Perspectium Support. A pop-up may appear indicating that the Agent Installer file can't be opened because it is from an unidentified developer. If this happens, click OK to close the pop-up and then navigate to System Preferences > Security & Privacy. Under the General tab, locate the section beginning with Allow apps downloaded from: and click Open Anyway. Then, click Open in the resulting pop-up to open the Agent Installer wizard. |
UI Step |
---|
Accept the End User License Agreement termsCheck the box to accept the terms of the Perspectium End User License Agreement. Then, click Next. |
UI Step |
---|
Choose an installation pathChoose a directory to install the DataSync Agent files in. If you specify a new directory, that directory will first be created and then populated with the Agent files. Then, click Next. |
UI Step |
---|
Choose JDK/JRE to run the DataSync AgentChoose the directory where your Java JDK/JRE is installed. In most cases, you can use the directory defined in JAVA_HOME. Otherwise, choose the other option and then click Next to specify the JDK/JRE directory you want to use. After you finish choosing the JDK/JRE, click Next. NOTE: Your JDK/JRE must be version 1.8.0 or higher. |
Choose agent name and replicator type
Type a name for your DataSync Agent; e.g., datasyncforservicenow_to_mysql. Then, choose an option from the Replicator Type dropdown:
Finally, click Next to proceed to the next step.
Enter Perspectium Mesh authentication info
On the resulting page, enter the following to allow your DataSync Agent to authenticate when connecting to the Perspectium Integration Mesh:
Your Perspectium Integration Mesh URL (excluding "http://", "https://", "amqp://", or "amqps://")
e.g., us-east-3-dev.perspectium.net
Password used to connect to the Perspectium Integration Mesh
NOTE: If you don't know or you forgot your Perspectium Integration Mesh server URL, username, and/or password, contact Perspectium Support.
Name of the queue that will store data being shared from your ServiceNow instance to your database. Simply replace the yourqueue text here with the name of your ServiceNow instance; e.g., dev12345
Then, click Next to continue to the next step.
Enter ServiceNow and database connection info
Select how you want to install the DataSync Agent with the following:
Install the DataSync Agent through Agent Installer
Install the DataSync Agent through Command Line
On the resulting page, enter the following information to allow your DataSync Agent to connect to and authenticate with your ServiceNow instance and database server:
Your ServiceNow instance URL (excluding "http://" or "https://")
Username used to log into your ServiceNow instance (in firstname.lastname format)
Password used to log into your ServiceNow instance
Server URL for the database you will be sharing your ServiceNow instance data to (excluding "http://" or "https://")
Then, click Next to continue to the next step.
UI Step |
---|
Review and finish installationOn the Summary and Review screen, wait for the processes to finish running and then click Next. Then, on the Perform External Processes screen, wait for the processes to complete and then click Next. Finally, on the Installation Finished screen, click Done to finish installation of your DataSync Agent. NOTE: Optionally, you can Generate an automatic installation script on this screen and then choose a directory to save your install script in. This script can then be run on another device to install a DataSync Agent with the same settings you've specified here. The following system files will be installed within the bin/perspectium_data directory and used for temporary storage/caching when your DataSync for ServiceNow Agent is running:
A perspectium.log file will also be installed that contains important log messages for your DataSync for ServiceNow Agent. For more information, see monitoring DataSync Agent logs.
|
UI Step | ||
---|---|---|
(Optional) Validate your Agent configurationAfter installing your DataSync for ServiceNow Agent, it is highly recommend to confirm that you Agent is configured correctly by running the Agent validateConfiguration tool. To run the validateConfiguration tool on a Linux device, open a terminal window and change your current directory to the directory where you installed your Agent in Step #3. Then, execute the following command:
To run the validateConfiguration tool on a Windows device, navigate to the bin directory that was installed within the main Agent directory that was specified in Step #3. Then, double-click to run the validateConfiguration.bat file. The tool will attempt to connect to the Perspectium Integration Mesh, your ServiceNow instance (if configured, to test fetching a schema) and to your database, logging if it was successful making these connections or any failures that may occur. Contact support@perspectium.com if you have questions on the connection failures. |
Next steps
Start/stop the DataSync AgentSimilar topics
Content by Label showLabels false max 5 showSpace false sort modified cql label = "data-sync" and space = currentSpace()