User Tools

Site Tools


updateset_installation

Update Set Installation

The following are instructions for installing the Update Set for the first time. If you are upgrading from an existing installation, please visit Upgrading an Update Set.

Prerequisite

Before we begin, make sure that you have the following information ready to configure the Perspectium Properties once that Update Set is installed. You will have to get this information from Perspectium support.

Property Example value
The user name that is used for connecting to the Perspectium message bus dev291
The user password that is used for connecting to the Perspectium message busdev291 (will be hidden by asterisks *)
The target Perspectium server or message bus endpointhttps://instance.perspectium.net/

The Perspectium application must be installed in the global scope to function properly. If the application is installed in a different application scope, it will not have access to certain built-in ServiceNow functions (such as serializing and encrypting GlideRecords) to share out data and you may see errors such as:
PerspectiumReplicator undefined, maybe missing global qualifier CloseException (java.lang.SecurityException: PerspectiumReplicator undefined, maybe missing global qualifier)

Step 1: Download

Visit the Update Set Releases page and request the download link from support@perspectium.com for the listed current version. The file will be in a zipped format representing an exported update set XML file. When prompted, save the file in your browser's designated Downloads folder. After saving the downloaded zip file, unzip it using your preferred method.

Step 2: Upload

Log into your ServiceNow instance and navigate to Retrieved Update Sets list. At the bottom of this list select the link Import Update Set from XML. The resulting page will prompt you to Choose a file to upload, select the Choose file button and browse to where you have unzipped the file in step 1. After selecting the Update Set XML file, click the Upload button. A progress worker will show the status of the upload.

You can also refer to ServiceNow's documentation for this step here

Step 3: Preview

The previewing step is a ServiceNow feature that ensures update collisions are displayed and resolved before applying the update. Because this is the first time, there should not be any collisions to be resolved. Select the Preview Update Set button and wait for it to end.

You can access more information regarding previewing of Update Sets here

Step 4: Commit

After previewing the Update Set and making sure that there are no conflicts, you are now ready to Commit it. Select the Commit Update Set button, after the progress dialog finishes showing the progress status, your Perspectium application will be installed.

More information about committing update set here

Step 5: Finish Install and Configure

v3.16.0



After committing the update set, click on the “Finish Install” module to complete the installation of the Perspectium update set

This module will check if the Perspectium application is in the global scope (and warn if it isn't), run jobs to install properties for the application, start up background running scheduled jobs and reset dynamic share rules.

Note: you will enter your properties and credentials following this. This job does not overwrite current properties in the system so you can run it any time you install a new update set. If you are applying multiple Perspectium Update Sets (Replicator and Observer) or (Replicator and SIAM sets) than you can run the Finish Install once, after committing all 3. Running it after each one is not going to break anything.

You must select the Finish Install module after committing the update set for the Perspectium application to properly function.

2016/11/01 17:47 · Paul Nguyen

Next navigate to the Perspectium application, and then the Properties page. Enter the values for the properties you have collected from the prerequisite section. Next navigate to the Replicator properties page to review its properties and make any changes as necessary.

Please verify your Perspectium properties before using the application

For update sets that come bundled with dynamic share and shared queue configurations, please verify the properties in these configurations (such as endpoint URLs and credentials) and make them “Active” so that you can properly start using the application..

After that select the Test Connection link, you should see output similar to the following.

Complete the validation by visiting the Outbound messages and filter the list by Show Matching of “test”. You should see the following entry with a state of “Sent” indicating that it was successful.

Your installation is now complete!

ACL Update Set

v3.18.0

To limit the Perspectium application to only the perspectium user that is installed with the application, you can request from support the ACL update set which will add ACL rules.

ACL update sets are available for both the Perspectium Replicator and Observer applications. ACLs will be created for the following ServiceNow tables:

Table Version Access Operation Product(s)
UI Pages (sys_ui_page) 3.18.0 read Replicator, Observer

Duplicate ACLs on the same table may conflict with each other with one overriding the other. Please verify any ACLs that exist on the above tables before installing this update set.

2017/02/10 15:42 · Paul Nguyen
2015/07/13 00:38 · David Loo
updateset_installation.txt · Last modified: 2016/04/02 20:20 by paul