Prerequisites
First, you will need to install the Perspectium DataSync Express application.
For domain-separated instances, you must be in the global domain to install the application.
After you set up your properties, the Perspectium application will automatically create a shared queue and a bulk share using this shared queue so you can immediately start sharing data.
The shared queue created will be named psp.out.replicator.<instance_name>_express. For example psp.out.replicator.acme_express. This shared queue's Integration Mesh URL and credentials along with the encryption key will be updated each time you update the respective configurations in Perspectium > Control and Configuration > Properties. That is, if you update the Integration Mesh username in Perspectium properties, this shared queue's user will also be updated.
The bulk share created will use this shared queue, default to the incident table and be named First Bulk Share YYYY-MM-DD HH:MM:SS (in your local date and time, for example First Bulk Share 2024-09-15 11:37:51). You can change this to a different table and then click Execute Now to run the bulk share.
You will need a Perspectium application (such as the DataSync Agent) subscribed to this queue to consume messages and save to your target destination such as a supported database.
If you happen to delete your bulk share using this shared queue, you can go back into Perspectium > Control and Configuration > Properties and resave your properties and the bulk share will automatically be recreated for you.
If you are already have the Perspectium application installed and are upgrading and you do not have this default shared queue or a bulk share using this shared queue, both will be created for you when go back into Perspectium > Control and Configuration > Properties and save either General Settings or DataSync Settings.
Procedure
To set the initial configurations after installing the DataSync Express app into your instance, follow these steps:
Switch to the Perspectium DataSync Express Application Scope
The DataSync Express app requires your ServiceNow instance to be in its scope during registration.
NOTE: This action is only required for users with the admin role since admin users have the ability to choose different application scopes (non-admin users will automatically be in the DataSync Express scope).
Navigate to the Perspectium DataSync Express application
In the Filter Navigator of the Application Navigator, type in “perspectium” to find the Perspectium DataSync Express application:
Navigate to the Setup module and complete Setup
Navigate to Perspectium DataSync Express > Setup to access the Setup page. Then, read through and complete the setup for DataSync Express by clicking Confirm at the bottom of the page.
Complete Setup
The action will take a few seconds to complete. You will be notified on screen with a success message once the setup has been complete.
Within a few seconds after Setup has completed, you will be automatically directed to Perspectium Properties to configure your settings so that a shared queue and bulk share can be automatically created for you to start sharing. A message will appear on screen to notify you this is happening:
NOTE: Once the setup has complete, the Setup module will be made inactive and the other modules of the Perspectium DataSync Express application will be enabled so you can start using the application.
Set up application properties
After being automatically directed to Perspectium > Control and Configuration > Properties and being this is the first time you are configuring your properties, a prompt will appear to notify you to configure both General and DataSync Settings so as to automatically create a shared queue and bulk share you can use to start sharing:
- On the Properties page, click General Settings.
- In the resulting form, fill out the fields with your Perspectium Integration Mesh username, password, and server URL, and click Save.
You will be prompted to also enter your DataSync Settings to complete setting up the Perspectium application:
- Click the back arrow to go back to the Properties page, and this time click DataSync Settings
- In the resulting form, fill out the fields with your encryption and/or decryption keys
- Scroll to the bottom of the page and click Save.
Once you save your DataSync Settings, a bulk share will be created for you. The following message will be displayed and then you will be directed to the bulk share after a few seconds so you can execute it:
This bulk share will default to the incident table and use a shared queue (psp.out.replicator.<instance_name>_express) automatically created for you. You can update this to select any table you want, make other changes to the bulk share and then choose the Execute Now option to execute the bulk share.
NOTE: You will need a Perspectium application (such as the DataSync Agent) subscribed to this queue to consume messages and save to your target destination such as a supported database.
Set up table access
If you plan to share attachments, modify table access to allow the DataSync application access to read attachment records.