Use the Scratchpad to complete your request fulfillment tasks
Summarize
Summary of Use the Scratchpad to complete your request fulfillment tasks
The Scratchpad feature in the Service Exchange application enables providers to send real-time updates to their consumer's ServiceNow instance during request fulfillment tasks. This is essential for progressing the Zero Touch request flow, which depends on these updates after confirmation and shipment steps are completed successfully.
Show less
Providers must implement task-specific code using the PSBScratchpadUtil API to update the Scratchpad with relevant status information.
Key Features
- Confirmation Updates: When confirming a provider task, send a Scratchpad update with the order status set to
confirmed. This signals the consumer's instance that the request has been acknowledged. - Shipment Updates: After shipping assets, send detailed Scratchpad updates that include:
- Order status indicating shipment progress:
partiallyshippedorfullyshipped. - Tracking number and carrier information for each shipment.
- Details for each asset shipped, including model number, asset tag, and serial number (except for consumables, which omit asset tag and serial number).
- Order status indicating shipment progress:
- Single Notification per Asset: For multiple shipments, each asset’s shipment information must be sent only once to avoid duplicate updates.
Practical Use for ServiceNow Customers
By using the Scratchpad API with the prescribed JSON format, providers ensure that their consumers' ServiceNow instances receive accurate and timely updates. This synchronization is critical to automate the Zero Touch request flow, providing transparency and reducing manual follow-up.
Customers implementing this feature can expect improved coordination across provider and consumer environments, better tracking of order fulfillment status, and seamless progression of request workflows.
As a provider, use the Scratchpad feature of the Service Exchange application to send updates to the ServiceNow instance of your consumer while performing the request fulfillment tasks.
The Zero Touch request flow requires you to send Scratchpad updates to your consumer's ServiceNow instance when you complete the confirmation and shipment tasks successfully. Based on the updates that you send, the Zero Touch flow progresses on your consumer's ServiceNow instance.
You must include the code specific to your tasks in the PSBScratchpadUtil API. For more information, see Using the Scratchpad for Service Exchange tasks. Confirm that the Scratchpad codes associated with the tasks of your request fulfillment flow are in the following format.
Sample code for request confirmation
var scratchPadJSON = {
"orderStatus": "confirmed"
};
var value = JSON.stringify(scratchPadJSON);
var rtGR = new GlideRecord("sn_sb_pro_provider_task");
rtGR.get(<ProviderTaskID>);
if (rtGR.isValidRecord()) {
var util = new sn_sb_pro.PSBScratchpadUtil();
util.update(rtGR, "confirmation", value);
}
When you confirm a provider task, a Scratchpad update with the order status as Confirmed is sent to your consumer's ServiceNow instance.
Sample code for shipment
var scratchPadJSON = {
"orderStatus": "partially_shipped / fully_shipped"
"orderLineItems" :
[{
"status": "shipped",
"trackingNumber": "123",
"carrier": "C1",
"modelNumber": 'MD322LL/A',
"assetTag": 'P1000177',
"serialNumber": 'P1000177'
},{
"status": "shipped",
"trackingNumber": "123",
"carrier": "C1",
"modelNumber": 'MD322LL/A',
"assetTag": 'P1000178',
"serialNumber": 'P1000178'
}
]
};
- Order
status: Depending on how the provider has shipped the assets in a request, the Order status can have the following values:
- partially_shipped: Assets in the request are shipped through multiple shipments.
- fully_shipped: All the assets in the request are shipped.
- Tracking number: Every shipment has a unique tracking number.
- Carrier: The name of the carrier through which the provider shipped the assets.
- Model number: Unique model number of the asset that is shipped.
- Asset tag: Unique asset tag of the asset that is shipped.
- Serial number: Serial number of the asset.