User Tools

Site Tools


update_set_receipts

Receipts

The following is the default implementation of the Receipts framework. With receipts, you can track if a message was received at the other instance. When messages are received, a receipt is created in u_psp_receipt and sent back to the sender, with receipts providing information about the message such as the message's topic, type, key and the source that sent the message.

Table

The following is the structure of the receipts table. Receipts are saved in this table both on the sharing and subscribing instances.

Field Definition
Created When the receipt was created
Number Unique number for this receipt
Topic Message topic
Type Message type
Key Message key
Name Message name
Source Source where the message was originally sent from (i.e dev00000, a ServiceNow instance)
Source Record Links to the table record (i.e the incident record) that was sent/received
Source Table Links to the table of the record (i.e the incident table)

A “Receipts” module under the Replicator section will be added when the update set installed. Clicking on this module will provide a list view of receipts:

Implementation

The following are the steps needed to setup receipts on both the sharing and the subscribing instances.

1. Install the Perspectium for ServiceNow update sets and any other update sets as applicable.

2. Install the Perspectium Receipts update set.

3. Create a dynamic share with the following fields. This will be used to share receipts back to the sender.

Field Value
Table u_psp_receipt
Trigger Conditions → Create Checked
Trigger Conditions → Interactive Only Unchecked
Filter and Enrichment → Condition Source is not [instance name]

4. Create a Subscribe configuration with the following fields. This will enable sender receipts.

Field Value
Table u_psp_receipt
Trigger Conditions → Create Checked

Bismuth

If the pre-release version of receipts is currently installed, please remove all contents of the Before subscribe script that previously were needed. Failing to do so may break receipt functionality.

As of Bismuth, receipts will now natively link back to the associated table record.

Receipt Error Notification

Bismuth

As of Bismuth, Receipts can now provide notifications if the receipt acknowledgment does not get delivered successfully within a specific amount of time (default 10 minutes). If you would like to enable this feature, select the Receipt alert notification checkbox in your Dynamic Share configuration to enable.



A scheduled job will run to check for receipts that have not been received within the specified amount of time and log an error with the record's sys_id if there isn't a receipt. You can subscribe to this error using the error notification feature.

Table Rotation

Bismuth

By default, the PSP Receipt table is set to be rotated to optimize instance performance. The duration set for rotation is 30 days and 12 rotations at a time.

As a result, receipts will generally only be available for up to 30 days. If you prefer to maintain receipts for a longer period of time, you can delete the table rotation entry or change the duration and rotations to be higher.

Resharing Messages

Dubnium

Using the Receipt Status table, you can now see which receipts have been acknowledged and which have been sent but not received on the subscribing end. The status field will show the value Sent when the message has been sent and once it has been acknowledged on the subscribing side it will be changed to Received.

Use the “Reshare Record(s)“ UI action to send another copy of the message associated with the corresponding Receipt. You can select multiple records from the list or click into the form and reshare messages one by one.

There is also a scheduled job named “XPerspectium Resend Unacked Receipts” that will check every 30 minutes for unack'd receipts and reshare the messages. By default, this job is not active.

update_set_receipts.txt · Last modified: 2018/11/14 12:09 by timothy.pike