Versions Compared

Old Version 5

changes.mady.by.user user-b885f

Saved on

compared with

New Version Current

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 issues with events within the DataSync application. To configure email notifications about errors with within your Perspectium solution, navigate to Perspectium > Control and Configuration > Troubleshooting > Error Notification. The default Perspectium errors that you can configure notifications for are:

  • Perspectium Error: Be notified when there is a Perspectium error that is critical, change the filter to tailor your notifications
  • Perspectium Situation: Be notified when there is any situation, critical or not, that results in a connection error to the Perspectium Mesh
  • Perspectium Agent Error: Be notified 

    • 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:

    Perspectium Table Compare Discrepancies: Be notified 

    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 of this error.  
    Perspectium SituationNotification when a situation has occurred multiple times.  Situations include old messages that haven't been posted to the Mesh and queue monitoring errors. The batch size is defined in Perspectium > Properties as described below.
    . An example of an email created is as follows:

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

    Body:

    The following error has occurred:

    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 Agent Error / Perspectium Meshlet ErrorPerspectium Agent Error

    Notification when the DataSync Agent encounters error  or DataSync Meshlet encounters errors processing records. The Agent Both applications will send back batches of errors and this notification will create an email that contains a list of records that erroredresulted in errors, including the table the record belongs to, the record sys_id and the Agent/Meshlet's error message.  The email body

    You can control the error messages sent back by the DataSync Agent to your instance using the <error_batch_size> and <receipt_send_interval> configurations, as error messages are sent back when the batch size or the send interval has been reached, whichever comes first. For example, if the <error_batch_size> is 10 and the <receipt_send_interval> is 5, then an error message will be sent back when there are 10 errors or 5 minutes have passed, whichever occurs first. Meshlets currently will send errors based on the batch they process each time i.e. if a batch of records has 3 errors, those 3 errors will be sent back in one error message.

    An example of an email created is as follows:

    Subject: Perspectium 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: SubscripeExceptionSubscribeException: Invalid sys_id


    For more information on the email content, see the psp_agent_error_scriptnotification email script in your ServiceNow instance.

    Perspectium Connection Error

    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.. See below for configuration options (batching and interval) related to this notification. 

    An example of an email created for this notification is as follows:

    Subject: Perspectium Connection Error

    Body:

    Errors connecting to the Perspectium Integration Mesh:

    PerspectiumReplicator.fetchFromQueue:Error fetching from queue psp.out.servicenow.instance_name on https://<instance_name>.perspectium.net/: Connection refused.

    See Perspectium Logs on instance dev00000 for more information.

    Perspectium Table Compare Discrepancies

    Notification when Table Compare executes and there are discrepancies between the instance and the database the Agent is saving records tointo. Each time a Table Compare is executed and there are discrepancies found, this notification will create an email that details any the discrepancies found. The email body  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 in your ServiceNow instance.

    (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).

    To learn more about how to configure error notifications, see create a messaging notification.

    .

    Perspectium Situation

    Notification when a situation has occurred multiple times. The default value of 6 is specified in the Conditions field of the When to send tab of the notification:

    Image Added

    The following templates are included:

    NameDescription
    Perspectium Old Message AlertSituation when there is a message in a ready state in the outbound table that is "old" (created greater than 10 minutes ago by default) and has not been sent. This is generally due to the scheduled job not sending messages to the Integration Mesh because the job is not running properly or has issues connecting.
    Perspectium Queue Monitoring AlertSituation when running queue monitoring. This includes alerts you set up as well as errors getting queue information from the Integration Mesh.

    These templates are situations that will occur multiple time and cause a notification. For example, once there are 6 Perspectium Old Message Alert situations that occur, the notification will then be sent if you subscribe to this notification. An example of an email created for this notification 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



    Subscribe to a notification

    To subscribe to a Perspectium notificaton and receive emails when an event occurs

    Sending error notifications in batches

    In Perspectium Properties, you can specify whether you want to send error notification emails in batches and how frequently to send batched notification emails. Sending batched notification emails can be helpful if your ServiceNow instance is sending error notifications frequently.

    To send error notifications in batches, follow these steps:

    UI Steps


    UI Step

    Enable email sending

    Log into your ServiceNow instance and navigate 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
    Create a Perspectium connection error notification

    Select the notification to subscribe to

    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.Image RemovedConfiguration > Troubleshooting > 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 Image Modified > Image Modified or Image Addednext to Users to start adding users who will receive batched connection error 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 AddedImage Removed


    UI Step

    Save your

    Perspectium connection error

    notification changes

    In the bottom left-hand corner of the form, click Submit or Update to save the settings for your Perspectium connection error notification.your changes for users to start receiving email notifications.




    Perspectium Connection Error configuration options

    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 the Perspectium Connection Error notification should check for issues and how many times the issues occur before sending a notification.

    To configure this notification, follow these steps:

    UI Steps


    UI Step

    Set your notification batch size and timing

    Navigate to Perspectium > Control and Configuration > Properties > General Settings. Scroll to the section labeled Send notification emails in batches of. In the box underneath this label, type a number to indicate the amount of notifications that will signify one batchminimum 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.

    (info) NOTE: The notifications for Perspectium connection errors will be emailed in batches of 10 notifications every 30 minutes by default.

    Image AddedImage Removed