Install the DataSync Agent through Agent Installer (macOS)

If you haven't already, read over the basic prerequisites at the top of this page. When you're ready, follow these steps:

1. Open the Agent Installer .jar file (this is what you will receive 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.
   
   
2. Check the box to accept the terms of the Perspectium End User License Agreement and click Next.
   
   
3. Choose 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.
   
   

4. Choose 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.
   
   

5. Type a name for your DataSync Agent; e.g., datasyncforservicenow_to_mysql. Then, choose an option from the DataSync Type dropdown:
   
   

   Type	Description
   MySQL	Shares data to a MySQL database.
   MSSQL	Shares data to a Microsoft SQL database.
   Oracle	Shares data to an Oracle database.
   PostgresSQL	Shares data to a PostgresSQL database.
   File DataSync (advanced)	Manually set all the necessary configuration for file subscribing for the Agent in the agent.xml.   Contact Perspectium Support for more information.  Expand title Click here to see agent.xml example... Code Block language xml <?xml version="1.0" encoding="ISO-8859-1" standalone="no"?> <config> <agent> <share/> <subscribe> <task instances="1"> <task_name>file_subscribe</task_name> <message_connection password="encrypt:perspectium_password" queue="psp.out.replicator.yourqueue" use_basic_consume="false" user="perspectium_user">https://perspectium_server</message_connection> <instance_connection password="encrypt:perspectium_password" user="perspectium_user">https://yourinstance.service-now.com</instance_connection> <decryption_key>decryption_key</decryption_key> <handler>com.perspectium.replicator.file.(your_dataformat)Subscriber</handler> <files_directory>your_directory_containing_file_of_saved_records</files_directory> </task> </subscribe> </agent> </config>
   Manual Configuration (advanced)	Manually set all the necessary and advance configurations for sharing and subscribing data with the Agent in the agent.xml. See DataSync Agent configuration.   Contact Perspectium Support for more information.  Expand title Click here to see agent.xml example... Code Block language xml <?xml version="1.0" encoding="ISO-8859-1" standalone="no"?> <config> <agent> <share> <task> <task_name>yourinstance_share</task_name> <message_connection password="encrypt:perspectium_password" queue="psp.out.servicenow.yourinstance" user="perspectium_user">https://perspectium_server</message_connection> <encryption_key>decryption_key</encryption_key> </task> </share> <subscribe> <task instances="1"> <task_name>yourinstance_subscribe</task_name> <message_connection password="encrypt:perspectium_password" queue="psp.out.replicator.yourqueue" use_basic_consume="false" user="perspectium_user">https://perspectium_server</message_connection> <encryption_key>decryption_key</encryption_key> </task> </subscribe> </agent> </config>

   
   

6. In the resulting page, enter the following to allow your DataSync Agent to authenticate when connecting to the Perspectium Integration Mesh:

   Field	Information to enter
   Field	Information to enter
   Server	Your Perspectium Integration Mesh URL (excluding "http://", "https://", "amqp://", or "amqps://") e.g., <server>.perspectium.net
   User	Username used to connect to the Perspectium Integration Mesh
   Enter Password	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.
   Retype Password	Password used to connect to the Perspectium Integration Mesh
   Queue Name	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
   Encryption/Decryption Key	A key of 24+ characters (for base64, TripleDES, and AES-128 encryption) or 32+ characters (for AES-256 encryption), including spaces, which will be used to encrypt data being shared from your ServiceNow instance to your database.
   Max Reads	A maximum number of data messages that your DataSync Agent will read from the queue each time messages are processed
   Polling Interval (sec)	Time period (in seconds) for which your DataSync Agent will process messages from your shared queue

   Then, click Next to continue to the next step.

Prerequisites

 Before getting started with the DataSync Agent, check to make sure your environment meets the base agent requirements.

Procedure