The following is for Linux only.
Prerequisites
First, you should have received a download such as the following (per your version):
perspectium-replicator-installer-VERSION.jar
This is the file we will use to run the agent installer. Contact support@perspectium.com if you have not received this file. You may use the browser to download directly and copy the file over.
Then, check the DataSync Agent Requirements to see if your system is compatible.
Procedure
To install the DataSync Agent through the command line, follow these steps:
Creating the perspectium user
Before we start the installation, it is recommended to create a user called perspectium and install the agent as that user.
ubuntu@ip-10-221-138-246:~$ sudo adduser perspectium Adding user `perspectium' ... Adding new group `perspectium' (1001) ... Adding new user `perspectium' (1001) with group `perspectium' ... Creating home directory `/home/perspectium' ... Copying files from `/etc/skel' ... Enter new UNIX password: Retype new UNIX password: passwd: password updated successfully Changing the user information for perspectium Enter the new value, or press ENTER for the default Full Name []: Perspectium Room Number []: Work Phone []: Home Phone []: Other []: Is the information correct? [Y/n] Y ubuntu@ip-10-221-138-246:~$
Next, login or sudo to the perspectium user and copy or download the agent installation file into it. See Download. If your download is currently zipped, you can use the following command to unzip it.
perspectium@ip-10-221-138-246:~/Perspectium_Replicator$ unzip perspectium-replicator-installer.zip Archive: ../perspectium-replicator-installer.zip inflating: perspectium-replicator-installer.jar
Running the Installer
To run the installer from a linux console using a GUI, type the following (per your version):
java -jar ./perspectium-replicator-installer-VERSION.jar
The following is an example of the installation script when run in console mode (no GUI) using the “-console” switch:
perspectium@ip-10-221-138-246:~/Perspectium_Replicator$ java -jar perspectium-replicator-installer.jar -console Mar 16, 2015 2:01:17 PM INFO: Logging initialized at level 'INFO' Mar 16, 2015 2:01:17 PM INFO: Commandline arguments: Mar 16, 2015 2:01:18 PM INFO: Detected platform: ubuntu_linux,version=3.2.0-40-virtual,arch=x64,symbolicName=null,javaVersion=1.7.0_25 Welcome to the installation of Perspectium Replicator Agent 3.1.9! This software is developed by: - Perspectium Corporation <support@perspectium.com> Press 1 to continue, 2 to quit, 3 to redisplay
Press 1 to continue. You will be presented with the End User License Agreement.
Acceptance of the EULA
SOFTWARE AS A SERVICE (“SAAS “) TERMS OF SERVICE FOR END-USERS THE SERVICE PROVIDERS (DEFINED BELOW) ARE WILLING TO GRANT YOU RIGHTS TO ESTABLISH AN ACCOUNT AND TO USE THE WEB SERVICES (DEFINED BELOW) ONLY UPON THE CONDITION THAT YOU ACCEPT ALL OF THE TERMS CONTAINED IN THIS AGREEMENT. PLEASE READ THE SERVICE AGREEMENT CAREFULLY. BY CLICKING ON "I ACCEPT", YOU WILL INDICATE YOUR AGREEMENT WITH THEM. IF YOU ARE ENTERING INTO THIS AGREEMENT ON BEHALF OF A COMPANY OR OTHER LEGAL ENTITY OR PERSON, YOUR ACCEPTANCE REPRESENTS THAT YOU HAVE THE AUTHORITY TO BIND SUCH ENTITY OR PERSON TO THESE TERMS. IF YOU DO NOT AGREE WITH THESE TERMS, OR IF YOU DO NOT HAVE THE AUTHORITY TO BIND YOUR ENTITY OR PERSON, THEN THE SERVICE PROVIDERS ARE UNWILLING TO GRANT YOU RIGHTS TO ACCESS AND USE THE WEB SERVICES. SAAS TERMS OF SERVICE AGREEMENT Effective Date as of first day Perspectium services commence. ... Press Enter to continue, X to exit
Press Enter to continue until the end of the agreement. (There are about 20 pages of the EULA).
... 40. Miscellaneous. This Agreement constitutes the entire understanding of the parties with respect to the subject matter of this Agreement and merges all prior communications, understandings, and agreements. This Agreement may be modified only by a written agreement signed by the parties. The failure of either party to enforce at any time any of the provisions hereof shall not be a waiver of such provision, or any other provision, or of the right of such party thereafter to enforce any provision hereof. The application the United Nations Convention of Contracts for the International Sale of Goods is expressly excluded. This license is written in English, and English is its controlling Press Enter to continue, X to exit Press 1 to accept, 2 to reject, 3 to redisplay
Press 1 to accept the agreement.
Afterwards, you will be asked for the installation destination, this is where the agent files will be copied.
If you have a previous agent already installed in the destination directory, it will be overridden.
Select target path
Select target path [/home/perspectium/Perspectium DataSync Agent]
Press Enter to select the default or type in a new one. Keep the directory within the home of the perspectium user.
Then, the installer will scan your path for a suitable JDK or JRE and suggest the path for it.
Please choose the directory of your installed Java JDK or JRE (version 1.7.0 or higher) [/usr/lib/jvm/java-7-openjdk-amd64/jre]
If this is the right JDK or JRE (See Agent Requirements ), press Enter to select or enter a different path.
Enter Perspectium Mesh authentication info
Enter the information for accessing the Perspectium Cloud Server: Server: [] server10.perspectium.com
Enter the supplied hostname and press Enter to continue.
Contact
User: [demo] Password: [demo] Enter the information for your agent: Name: [] demo_agent Queue Name: [psp.out.replicator.yourqueue] psp.out.replicator.demo_agent
Then, enter the user, password, name of the agent and specified queue.
Select Agent type
You will now be asked to select the type of agent to install. Depending on which type, additional information may be required. For example you may be asked for database credentials for subscribing to ServiceNow and writing to a local database.
Type: 0 [x] MySQL Replicator 1 [ ] MSSQL Replicator 2 [ ] Oracle Replicator 3 [ ] File Replicator 4 [ ] Directory Replicator input selection:
Enter decryption key
After entering the agent type information, you will now be prompted for the decryption key, maximum number of records to read and the interval between reads. The decryption key should be the same as the encryption key you would have set, e.g. in ServiceNow. See Encryption.
Decryption Key: [Some decryption key here] Max Reads: [4000] Polling Interval (sec): [30]
Finish installation
The installer will now complete its task and copy the files to the target directory, you should see the following output:
[ Starting to unpack ] [ Processing package: core (1/2) ] [ Processing package: (2/2) ] [ Unpacking finished ] [ Starting processing ] Starting process Update wrapper.conf (1/3) Updating wrapper.conf... wrapper.conf configuration complete. Starting process Update license.txt (2/3) Updating license.txt... license.txt configuration complete. Starting process Update config.xml (3/3) Updating config.xml... config.xml configuration complete. Installation was successful application installed on /home/perspectium/Perspectium Replicator Agent [ Writing the uninstaller data ... ] [ Console installation done ]
(Optional) Generate an automatic installation script
After successful installation of the agent, you have the option to generate an automatic install script on the last panel of the agent installer. This is useful to install an agent on another machine using the same settings.
You can execute the auto-install.xml by running the following command:
java -jar perspectium-replicator-installer.jar auto-install.xml
You must copy and paste the created auto-install.xml along with the perspectium-datasync-installer.jar in the same folder or directory and issue the command stated above.
This will use the credentials and directory locations you used in the initial install. If you would like to change the directory where the Agent will be installed you can modify the auto-install.xml file.
(Optional) Validate 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.
(For Java 14 and Java 15 ONLY) Import new wrapper files
If you are using Java 14 or Java 15, remove the wrapper.jar and wrapperApp.jar files from the lib folder of the agent directory and import the new wrapper.jar and wrapperApp.jar files provided by Perspectium Support.
Execute the following command within the lib folder of the agent directory to remove the files:
rm wrapper.jar rm wrapperApp.jar
Then, execute the following command to add the new files:
mv wrapper.jar /Perspectium_DataSync_Agent/lib mv wrapperApp.jar /Perspectium_DataSync_Agent/lib