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

Compare with Current View Page History

« Previous Version 12 Next »


Once you have installed and configured DataSync for ServiceNow, and have successfully set up a dynamic share and understand how it works, there are various optional dynamic share settings that you can configure. These optional features can help you customize your DataSync experience and leverage DataSync's robust capabilities to make your organization's integration processes more powerful and streamlined.


What's on this page: 

Explore all of these available features below! 




Data Alignment

Data Alignment provides conflict avoidance to minimize the possibility of records becoming out of sync. For example, Instance A updates a record at the same time Instance B updates the same record—you now have the risk of conflicting records. Data Alignment (using dynamic share), is designed to minimize that risk. 

There are two connected features to achieve data alignment (enable them in the following order):

Immediately post dynamic share outbound messages

This feature is enabled in the queue record. If a dynamic share is targeting a queue that has this property enabled, it will cause their messages to be posted immediately, rather than waiting to have the multioutput processor post these messages on a scheduled basis. If the outbound message is unable to be posted immediately, it will be put into the ready state and then sent along with other outbound messages during the next execution of the multioutput processor job.

Here's how to enable the post immediately feature in a dynamic share:

  1. In your sharing ServiceNow instance, go to Perspectium > Perspectium Core Shares > Dynamic Share > View Dynamic Shares.

  2. Find and select the dynamic share for which you want to enable the feature.

  3. Under General Settings, next to the Target queue, click the (info) icon to preview the record. Then, in the resulting Queues window, click Open Record



  4. In the record's page, check the Post Immediately box.


Skip delayed updates

Using polling intervals for publish/subscribe messaging creates a potential issue for records to become out of sync if they are updated at the same time. By posting outbound messages immediately, the time frame for this issue is decreased. To further mitigate this potential issue from occurring, the subscribing system will check if the local record has been updated more recently when receiving an update. If so, the update is ignored. 

In order to enable this feature, you need to create a create a subscribe record and enable the post immediately feature outlined in the previous section.

Then, follow these instructions to ignore delayed updates:

  1. In your ServiceNow instance, enter u_psp_properties.list in the Filter navigator on the left.

  2. On the resulting PSP Properties page, under the Name column, enter com.perspectium.skip_delayed_updates in the search bar.

  3. Click the name of the property.

  4. On the resulting property page, in the Value field, enter true.



  5. Click Update.

  6. (Optional!) You can also choose to skip delayed target field updates. This will only work if the table being shared is audited since this will check if the target field has been updated more recently than the subscribed update. To enable this, return to step 2, and search for com.perspectium.skip_delayed_field_updatesClick the property and set Value to true. Then, click update. It is best not to enable this property if there are high volume dynamic shares, as this may impact performance.




Scheduled sync up

This feature sets up a recurring “catch up” job that incrementally bulk shares out a previous interval of created, updated, or deleted records. Enable this option to capture dynamic record creates, updates, or deletes that may have been missed (if business rules are bypassed programmatically (e.g., via setWorkflow('false');) or automation does not trigger business rules).

A scheduled sync up can be run with or without trigger conditions set up on your dynamic share. If your dynamic share has trigger conditions, records will be shared both out in real time and on the scheduled interval you select. If your dynamic share does not have trigger conditions, records will be shared out on the scheduled interval only.

  • Scheduled sync uses the sys_created_on and sys_updated_on column. This column should be indexed for best performance with scheduled sync up. Find more information on indexing columns here.
  • If you want to capture deletes, verify that the Delete Recovery plugin is activated.

Here's how to enable the feature:

  1. In your sharing ServiceNow instance, go to Perspectium > Perspectium Core Shares > Dynamic Share > View Dynamic Shares.

  2. Find and click into the dynamic share that you want to configure a scheduled sync up for.

  3. In the resulting dynamic share page, click the Scheduled Sync Up tab. To capture only creates and updates, check the Activate sync box. To capture only deletes, check the Activate delete sync box. To capture all creates, updates, and deletes, check both boxes.

  4. (Optional) Use the Run as field to find and select another user to run the sync as another user.

  5. From the Interval dropdown, select the interval at which you want to run the sync up—this interval indicates how frequently a bulk "catch up" share will run for this dynamic share.

  6. Click Update




Configure business rule timing and order

This feature allows you to specify when business rules should run for dynamic shares. Dynamic shares can replicate data before an action is taken on the record or after an action is taken. These before and after values can be specified in the Business Rule When dropdown of a dynamic share.

Business Rule Before

Dynamic sharing a record using the before option allows you to share the record with journal fields as part of the record's XML. For example, if you share an incident record and specify “before”, the record will come with both the comments and work notes in the incident record's XML. Additionally, using the before option will cause the record to be shared before any after business rules are run. For example, if you have an after business rule that runs to update the record's state based on a specific condition, the after option will share the record out with the updated state, whereas the before option will share it with the previous state.

Business Rule After

If you dynamic share a record using the after option, the comments and work notes will not be part of the record's XML but instead will be records in the sys_journal_field table (upon saving a record into the database, ServiceNow will separate journal fields from the record and save them into the sys_journal_field and sys_audit tables which is why you want to subscribe to the sys_journal_field and sys_audit tables when subscribing on a ServiceNow instance).

Business Rule Async

When running as async, records will be sent out as .bulk, since the records are shared in the background and we will not be able to determine if the record was an insert or update at that point. Also, there is no dependency on “current” or “previous” in the Before Share script (such as checking for a condition where a field “changes”) and the “sequence” of other records being replicated cannot be guaranteed. So a change created when an incident is created where both have dynamic shares may result in the change being shared out before the incident is).

Selecting the async option will cause the trigger condition Update or Insert to be activated and the Delete trigger condition to be deactivated.

Here's how to configure business rule timing for a dynamic share:

  1. In your sharing ServiceNow instance, go to Perspectium > Perspectium Core Shares > Dynamic Share > View Dynamic Shares.

  2. Find and click into the dynamic share that you want to configure business rule timing for.

  3. In the resulting dynamic share page, under General Settings, select your choice from the Business Rule When dropdown.

  4. Click Update




Dynamic share on non-interactive updates

By default, dynamic shares have a setting that causes data to be shared out only when interactive actions are performed (for example, if a user comments on or resolves an incident), and not when non-interactive actions occur (for example, if a ServiceNow job closes resolved incidents after 7 days or an email engine creates records). 

The interactive only feature makes use of ServiceNow's interactive check to determine if a session is a user session or not. For more information, see GlideSession - isInteractive().

If you want to enable dynamic sharing of non-interactive updates, here's how:

  1. In your sharing ServiceNow instance, go to Perspectium > Perspectium Core Shares > Dynamic Share > View Dynamic Shares.

  2. Find and click into the dynamic share that you want to share non-interactive updates for.

  3. In the resulting dynamic share page, in the Runtime Settings tab, under Triggers, uncheck the Interactive only box.

  4. Click Update




Share historical data

Historical data fields refer to fields that were created or updated prior to running your initial dynamic share. You can use this feature to allow for the sharing of the following historical data fields to other ServiceNow instances:

Here'w how:

  1. In your sharing ServiceNow instance, go to Perspectium > Perspectium Core Shares > Dynamic Share > View Dynamic Shares.

  2. Find and click into the dynamic share that you want to share historical for.

  3. In the resulting dynamic share page, in the Runtime Settings tab, under Additional Records, check the Share historical data box.

  4. Click Update




Share only updated fields on updated records

This feature allows you to dynamic share only the fields of a record that have been updated, instead of resending the entire record. This can be useful when your sharing instance is updated frequently and your subscribing instance(s) is relatively static. Here's how:

  1. In your sharing ServiceNow instance, go to Perspectium > Perspectium Core Shares > Dynamic Share > View Dynamic Shares.

  2. Find and click into the dynamic share that you want to share only updated fields for.

  3. In the resulting dynamic share page, in the Data Enrichment tab, check the Share only updated fields box.

  4. (Optional) Check the Share system fields box to share out the following fields along with the updated fields in the same outbound message:

    • sys_created_by
    • sys_created_on
    • sys_mod_count
    • sys_updated_by
    • sys_updated_on

      You can also use the Select ID dropdown to choose an ID field that will always be dynamic shared out along with your updated field(s). If you don't choose a field from this dropdown, the default ID field that will be dynamic shared out is sys_id.

  5. Click Update.


MySQL error may occur when using Share system fields. When that error is received on the agent, the database will still recover and save the record. However, each record that follows will replace one another since the primary key is altered and not defined




View business rules before a dynamic share runs

This feature allows you to view any business rules that may have an impact on the dynamic share actions that occur (inserts, updates, and/or deletes). This is useful to view since the business rules that run before a dynamic share is executed often have an impact on the order of dynamic share execution. Here's how to view:

  1. In your sharing ServiceNow instance, go to Perspectium > Perspectium Core Shares > Dynamic Share > View Dynamic Shares.

  2. Find and click into the dynamic share that you want to view business rules for.

  3. At the bottom of the dynamic share form, under Related Links, click View Business Rules Before This Share. You will automatically be redirected to a list of Business Rules that will run before dynamic share actions occur.