Versions Compared

Old Version 8

changes.mady.by.user user-b885f

Saved on

compared with

New Version 9

changes.mady.by.user user-1bc08

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

You can specify users in your ServiceNow instance who will receive email notifications about errors and other events within the DataSync application. To configure notifications within your Perspectium solution, navigate to Perspectium > Control and Configuration > Error Notification.

Perspectium notifications are created as ServiceNow email notifications in order to send emails natively through the instance and some notifications use notification email scripts for the email's subject and body content. See email notifications and notification email scripts for more information.

(info) NOTE: Since these notifications use built-in ServiceNow functionality, you are able to view and change the notifications and their content from the default behavior. However this is only recommended for advanced users as changes may cause the notifications to not function properly. 

The following notifications are included with the DataSync app:

NameDescription
Perspectium ErrorNotification when there is an error in the Perspectium Logs. When the DataSync application encounters an issue and logs an error, you can use this notification to be notified . An example of an email created is as follows:

Subject: Perspectium Error: perspectium - psp.out.replicator.queue_name 

Body:

Instance: perspectium

Name: psp.out.replicator.queue_name

Value: 2020-10-28 20:08:26: Error getting metrics for queue psp.out.replicator.testqueue on https://<server>.perspectium.net/ 

Perspectium SituationNotification when a situation has occurred multiple times (default value of 6). Situations include old messages that haven't been posted to the Mesh and queue monitoring errors. An example of an email created is as follows:

Subject: Perspectium Situation Triggered: Perspectium Old Message Alert 

Body:

Situation: messages that have been sitting in a outbound for more than the specified time

Perspectium Agent Error

Notification when the DataSync Agent encounters errors processing records. The Agent will send back batches of errors and this notification will create an email that contains a list of records that resulted in errors, including the table the record belongs to, the record sys_id and the Agent's error message.  An example of an email created is as follows:

Subject: Perspectium DataSync Agent (psp_test_agent) Errors

Body:

Errors have occurred in the DataSync Agent when attempting to process the following records:


Table: incident, Record: 72c645032f431010744b90bcf699b67c

Error: SubscribeException: Invalid sys_id


Table: incident, Record: 72c645032f431010744b90bcf699b67d

Error: SubscripeException: Invalid sys_id


For more information on the email content, see the psp_agent_error_scriptnotification email script.

Perspectium Table Compare Discrepancies

Notification when Table Compare executes and there are discrepancies between the instance and the database the Agent is saving records into. Each time a Table Compare is executed and there are discrepancies found, this notification will create an email that details the discrepancies. An example of an email created is as follows:

Subject: Perspectium Table Compare Discrepancies

Body:

Discrepancies found in the DataSync Agent database:


Table Compare e84d1fd6db80641024df4870399619aa found discrepancies. There were 1 missing records and 0 additional records. Missing records will be reshared and additional records will be removed.


For more information on the email content, see the psp_table_compare_script notification email script.



Subscribe to a notification

To subscribe to a Perspectium notificaton and receive emails when an event occurs, follow these steps:

UI Steps


UI Step

Enable email sending

Navigate to System Mailboxes > Administration > Email Properties. In the upper left-hand corner of the form, check the Yes | No box under Email sending enabled to allow emails to be sent from your ServiceNow instance.


UI Step

Select the notification to subscribe to

Navigate to Perspectium > Control and Configuration > Error Notification and open the notification you want to subscribe to.


UI Step

Choose users who will receive error notification emails

Click the Who will receive tab. Then, click > next to Users to start adding users who will receive the notification emails.

(info) NOTE: The users that you specify to receive email notifications for must have an email entered in the Email field of their User Profile (Username > Profile).


Image RemovedImage Added


UI Step

Save your notification changes

In the bottom left-hand corner of the form, click Update to save your changes for users to start receiving email notifications.




Get notified of Perspectium Integration Mesh connection issues

You can setup notification when the DataSync app has connection issues with the Perspectium Integration Mesh. That is, when the application attempts to connect to the Mesh to post messages being shared and if applicable, when it tries to fetch messages being subscribed.

To avoid temporary short term connection issues (i.e. there was a single connection issue and the app was able to connect on the next attempt to share data to the Mesh), you can configure how frequently it should check for issues and how many times the issues occur before sending a notification.

To be notified of connection issues, follow these steps:

UI Steps


UI Step

Create a Perspectium connection error notification

Navigate to Perspectium > Control and Configuration > Error Notification and click New. Type any Name for your error notification and choose a Table to send notifications for. Scroll down to the When to send tab, and select Event is fired from the Send when drop down. Then, select perspectium.connection.error.threshold from the Event name dropdown.


UI Step

Choose users who will receive error notification emails

Click the Who will receive tab. Then, click > next to Users to start adding users who will receive batched connection error notification emails.


UI Step

Save your new notification

In the bottom left-hand corner of the form, click Submit to save the settings for your Perspectium connection error notification.


UI Step

Set your notification batch size and timing

Navigate to Perspectium > Control and Configuration > Properties. Scroll to the section labeled Send notification emails in batches of. In the box underneath this label, type a number to indicate the minimum number (batch) of connection errors before sending a notification. Next, scroll to the section labeled Send notification emails about connection errors in batches every and choose a time interval to send batched notifications in. This interval controls how often the application should check for connection issues. The default values are batches of 5 and every 30 minutes to trigger a notification.

For example, with the default batch size of 5 and an interval of 30 minutes, every 30 minutes the app will check if there are more than 5 connection issues and if so, send a notification.

Finally, click Save at the bottom of the page to save your Perspectium properties. Once these two properties are setup, your notifications will be emailed in batches at the specified intervals to the users you configured in Step #3.