• Created by user-1bc08, last modified by user-4dac1 on Apr 12, 2021

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 19 Next »


The Propertities module defines the options, settings, and preferences applied to your Perspectium application. 

To configure Perspectiujm's properties, go to Perspectium > Control and Configuration > Properties

In the following sections you can find instructions for customizing your General Settings and DataSync Settings, as well as an overview table of Perspectium Properties.

General Settings

From the Properties page, click General Settings (Perspectium > Control and Configuration > Properties > General Settings)

On the General Settings page, you can change your Perspectium Mesh Username, Password, and URL.

You can also:

Allow sharing of incidents to Perspectium Support

This feature gives you the option to send Perspectium-related incidents directly to our Support team. Enabling this option will ServiceBond your ServiceNow instance with Perspectium Support, allowing you to stay updated in real-time as our Support team works on your incident.

(info) NOTE: Display values do not ensure referential integrity when used to join with other tables. To ensure accurate joining between tables, always rely on the actual sys_id value in the reference field instead.

Prerequisites:

Instructions:

  1. In your sharing ServiceNow instance, go to Perspectium > Control and Configuration > Properties > General Settings

  2. Check the box labeled Allow sharing of incidents to Perspectium Support

  3. Scroll to the bottom and click Save

    (info) NOTE: After enabling this option in Perspectium Properties, a ServiceNow shared queue (named psp.out.perspectiumdev_support) and dynamic share (named Perspectium Support) will be created, which will allow your incidents to be shared to Perspectium Support when the Perspectium Supportassignment group is selected for ServiceNow incidents. The Perspectium Support Incident to Common Incident table map and Perspectium Support Common Incident to Incidenttransform map will also be added to your ServiceNow instance.

  4. To share an incident related to your Perspectium integration with our Support team, log into your ServiceNow instance and navigate to Incident > Create New.

  5. Fill out the details for your incident.

  6. Select Perspectium Support from the Assignment group dropdown.

  7. Click Submit.
Generate debug logging

This option enables the creation of debug logs in the Log Messages table.

To access these messages, go to Perspectium > Control and Configuration > Troubleshooting > Logs

Prerequisites:

Instructions:

  1. In your sharing ServiceNow instance, go to Perspectium > Control and Configuration > Properties > General Settings

  2. Check the box labeled Enable debug logging for a certain period of time

  3. Select a length of time for this property to be enabled from the Debug period dropdown.

  4. Click Save

Delete error messages older than 1 day in the Outbound Messages table

This option enables the removal (via data cleaners) of outbound message records in the Outbound Message table with a status of Error 24 hours after the creation of the record(s). For more information about outbound messages, see ServiceNow messages & receipts.

Prerequisites:

Instructions:

  1. In your sharing ServiceNow instance, go to Perspectium > Control and Configuration > Properties > General Settings

  2. Check the box labeled Delete error messages older than 1 day in the Outbound Messages table

  3. Click Save.
Limit bytes/records for outbound message jobs

There are two options in Perspectium Properties that allow you to limit the number of bytes or records that can be shared out for each outbound message job (MultiOutput Processing job). By default, outbound message jobs cannot share out more than 5,000,000 bytes (or 5 MB) and 8000 records for each job.

Prerequisites:

Instructions:

  1. In your sharing ServiceNow instance, go to Perspectium > Control and Configuration > Properties > General Settings

  2. (If you wish) Enter a byte limit in the field labeled Byte limit for each job that processes outbound messages (MultiOutput Processing job)

    (info) NOTE:     The value in this field will take precedence over any record limit entered for outbound message jobs.

  3. (If you wish) Enter a record limit in the field labeled Record limit for each job that processes outbound messages (MultiOutput Processing job)

  4. Click Save to save your changes.

Limit the maximum number of messages in the Outbound Messages queue

This option allows you to set a max limit for records that can appear in the Outbound Messages table. By default, this limit is set to 1,000,000 outbound messages. For more information about outbound messages, see ServiceNow messages & receipts.

Prerequisites:

Instructions:

  1. In your sharing ServiceNow instance, go to Perspectium > Control and Configuration > Properties > General Settings

  2. Check the box labeled Limit the maximum number of messages in the Outbound Messages queue

  3. Enter your desired limit in the field labeled Maximum number of messages in the Outbound Messages table. This value will only be applied if you check the box (step #2)

  4. Click Save.


The application installs a role called perspectium that has access to the Perspectium application's tables. This role can be used to limit ServiceNow users to only have access to the Perspectium application and can be given to a user used with the DataSync Agent to access ServiceNow table schemas in order to replicate accurately and dynamically to external databases.

DataSync Settings

From the Properties page, click DataSync Settings (Perspectium > Control and Configuration > Properties > DataSync Settings)

Your DataSync Settings contain the default encryption and decryption keys that are used for shared and subscribed data, as well as various configuration options for your bulk shares and inbound messages.

On the DataSync Settings page, you can:

Share display values for reference fields and choice lists

Display values are resolved display values of referenced records in the current record being shared. By default, ServiceNow display values for reference fields and choice lists will not be shared out in your dynamic shares and bulk shares. However, you can enable the sharing of display values for these fields in DataSync settings.

When enabled, display value fields that are prefixed with dv_ in the field name will be added to the shared record. 

This feature is useful if you are sharing tables that do not need to include referenced records. The display value may contain enough readable information for your report.

(info) NOTE: 

  • Display values will NOT be shared in schemas to ServiceNow instances.
  • Display values do not ensure referential integrity when used to join with other tables. To ensure accurate joining between tables, always rely on the actual sys_id value in the reference field instead.
  • With DataSync Agent, the columns for the display value will be sent to the database as a separate column, e.g. a state column have the numerical value and a dv_state column will have the actual value.

Prerequisites:

Instructions:

  1. In your sharing ServiceNow instance, go to Perspectium > Control and Configuration > Properties > DataSync Settings

  2. Check the box labeled Enable Replicator to add display value fields for reference and choice fields (prefixed with 'dv_' by default)

  3. Click Save.

Use a percentage of workers to run concurrent scheduled bulk shares

In some cases, you may find that scheduled bulk shares are impacting the performance of your ServiceNow instance, as they use too many of the instance's available scheduled jobs (workers). If this happens, a good troubleshooting practice is to specify a percentage of the workers on your ServiceNow instance's nodes that will run scheduled bulk shares concurrently.

Prerequisites:

Instructions:

  1. In your sharing ServiceNow instance, go to Perspectium > Control and Configuration > Properties > DataSync Settings

  2. Use the dropdown labeled Percentage of workers used to run concurrent Scheduled Bulk Shares to select your desired percentage

    The percentage that you choose from the dropdown will be the percentage of workers in each of your ServiceNow instance's nodes that will be used to run scheduled bulk shares that are being executed concurrently.

  3. Click Save.

Share display valuesSave Perspectium properties in the sys_properties table

This option lets you improve the overall performance of your Perspectium integration by saving all properties related to your Perspectium integration to ServiceNow's System Property (sys_properties) table. By default, this option is disabled, and your Perspectium-related properties are saved in the Perspectium Properties table (u_psp_properties). If you enable this option and then make changes to your Perspectium properties, you can then copy those properties to the Perspectium Properties table by disabling this option again.

(info) NOTE: Enabling this option will write all of Perspectium's application properties to ServiceNow's sys_properties table. The application will then use this table to access all of its properties, increasing the frequency of access to this table and its caching. Please disable this option if you run into issues.  

Prerequisites:

Instructions:

  1. In your sharing ServiceNow instance, go to Perspectium > Control and Configuration > Properties > DataSync Settings.

  2. Check the box labelled Save Perspectium properties in the sys_properties table.

  3. Click Save.

It may take 2-3 minutes for this change to be applied to your ServiceNow instance as the system saves all Perspectium properties over to the sys_properties and rebuilds the system cache.

(info) NOTE: 

  • If, after enabling this option, the u_psp_properties table is deleted, you can regenerate the u_psp_properties table by clicking Perspectium > Control and Configuration > Finish Install > Confirm.
  • If enabling this option, be sure NOT to enter a value higher than 15000000 for the com.perspectium.output_bytes_limit property or a value higher than 8000 for the com.perspectium.output_row_limit property.
Disable inbound messages

By default, DataSync for ServiceNow allows your ServiceNow instance to receive inbound messages. However, if your ServiceNow instance is to be used for sharing purposes only (and not for subscribing purposes, or the receipt of incoming messages from other apps or data sources), you have the option to disable inbound message functionality in DataSync Properties. 

For more information about message records in ServiceNow, see ServiceNow messages & receipts.

Prerequisites:

Instructions:

  1. In your sharing ServiceNow instance, go to Perspectium > Control and Configuration > Properties > DataSync Settings.

  2. Check the box labeled Disable inbound messages.

  3. Click Save.

Enable multiple jobs to process messages in the inbound table

By default, the Perspectium Replicator Subscriber scheduled job in ServiceNow pulls and processes the messages from your Mesh server's inbound queues. However, you can also have the job pull messages into the ServiceNow inbound table (psp_in_message) in a Ready state so that Perspectium Replicator Inbound Processor scheduled jobs process the inbound table. This allows you to prioritize the processing of your inbound messages by configuring the Perspectium Replicator Inbound Processor jobs to apply various filters. 

This is an advanced capability for DataSync for ServiceNow, so we recommend you enable this functionality in your test environment(s) first. Note that enabling multiple inbound processor jobs allows you to have greater control over how and when you are subscribing to data that is being shared out by other data sources/applications.

Prerequisites:

Instructions:

  1. In your sharing ServiceNow instance, go to Perspectium > Control and Configuration > Properties > DataSync Settings.

  2. Check the box labeled Allow Replicator inbound messages to go to a state of ready instead of being consumed immediately...

  3. Click Save.

  4. Now, go to Perspectium > Control and Configuration > All Scheduled Jobs.

  5. In the Schedule Jobs table, find and select the Perspectium Replicator Inbound Processor job.

  6. Within the script for this job, find the addCustomQuery function on line 50 and modify the script by adding your customer queries.

    To do this, choose one of the following options:

    • Add customer queries by key

      function addCustomQuery(igr) {
    igr.addQuery("key", "=", "dev12345");
}


      OR

    • Add customer queries by name

      function addCustomQuery(igr) {
    igr.addQuery("name", "CONTAINS", "incident");
}
  7. Click Update (top right corner).

  8. Create a copy of the modified job so you can apply other filters to enable simultaneous processing.
Skip updating the sys_domain_path field when subscribing to records

This option will skip updating the sys_domain_path field on a record to keep the value as it currently is or allow the system to update the record appropriately if the domain changes. In domain-separated ServiceNow instances (Helsinki version or later), if you update a record without changing the sys_domain field, the sys_domain_path will be updated to the default global value of “/” that comes in with the incoming record. Prior to the ServiceNow Helsinki release, the system would auto adjust to the proper domain path after updating the record.

Prerequisites:

Instructions:

  1. In your sharing ServiceNow instance, go to Perspectium > Control and Configuration > Properties > DataSync Settings.

  2. Check the box labeled skip updating the sys_domain_path field when subscribing to records.

  3. Click Save.
Alert before bulk sharing a large number of records

This option will enable an alert to pop up within your instance whenever a ServiceNow bulk share that you're trying to execute exceeds a minimum number of records. By default, the minimum number of records to trigger an alert is 1,000,000.

Prerequisites:

Instructions:

  1. In your sharing ServiceNow instance, go to Perspectium > Control and Configuration > Properties > DataSync Settings.

  2. Check the box labeled Alert me before bulk sharing a large number of records.

  3. Enter the desired minimum number of records in the field labeled Minimum number of records to trigger an alert before bulk sharing.

  4. Click Save.

Generate unique names for business rules associated with dynamic shares

This option allows you to change a setting to allow newly created business rules to have a unique name. Upon the initial creation of a dynamic share, you can choose between using Business Rule or Flow Designer. When you choose Business Rule, the dynamic share uses  to trigger sharing records out. By default, the business rule created is named Perspectium Replicate.

Prerequisites:

Instructions:

  1. In your sharing ServiceNow instance, go to Perspectium > Control and Configuration > Properties > DataSync Settings.

  2. Check the box labeled Generate unique names for the business rules associated with dynamic shares.

  3. Click Save.

Perspectium Properties Overview

Listed are a few of the Perspectium properties needed for the application:

Property nameDescriptionTypeDefault value
com.perspectium.outbound.default_disabled

Used to send messages to Perspectium Integration Mesh to monitor status of the Perspectium for ServiceNow application. 

(info) NOTE: If the Perspectium application cannot connect to the Default Mesh, this values will toggle to true

true/falsefalse
com.perspectium.scheduled_job.node

Specify node to run Perspectium Scheduled Jobs (Warning: Changing from default may affect performance)

(info) NOTE:

  • The value "Default" allows your ServiceNow instance choose which node to run scheduled jobs on
  • This feature is only available on ServiceNow production instances as developer instances only have one node
dropdownDefault

com.perspectium.enable_receipts

Generate receipts from messages received to view details about the data you are sharing to/subscribing. true/falsefalse

com.perspectium.outbound.delete_immediately 
(DataSync)

com.perspectium.observer.outbound.delete_immediately 
(Observer)

Deletes messages as soon as they are posted to the Integration Mesh, rather than updating them to sent and letting a different process delete the message. 

(info) NOTE: This can be used under systems with high volume to limit the different processes going to the Outbound Message tables. 

true/falsefalse

com.perspectium.replicator.track_shared_records

Enable shared record tracking for dynamic shares.

true/false

true