Use the Scratchpad to complete your request fulfillment tasks

  • Release version: Yokohama
  • Updated January 30, 2025
  • 2 minutes to read
  • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    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 the consumer's ServiceNow instance during request fulfillment tasks. This is particularly essential in the Zero Touch request flow, where Scratchpad updates trigger progression of the workflow on the consumer side after successful confirmation and shipment tasks.

    Show full answer Show less

    Key Features

    • Scratchpad Updates: Providers use the PSBScratchpadUtil API to send task-specific updates to consumers, ensuring synchronization between provider and consumer instances.
    • Request Confirmation: When confirming a provider task, an update with orderStatus: "confirmed" is sent, indicating the confirmation status to the consumer.
    • Shipment Updates: Shipment details are communicated with comprehensive information including order status, tracking number, carrier, model number, asset tag, and serial number for each shipped item.

    Key Outcomes

    • Order Status Accuracy: Providers can specify partiallyshipped or fullyshipped to reflect the shipment progress accurately, supporting multiple shipment scenarios.
    • Detailed Shipment Information: Each shipment includes unique tracking numbers, carrier names, and asset details (model number, asset tag, serial number) to ensure precise tracking and asset management.
    • Consumable Asset Handling: Shipment updates for consumable assets exclude asset tag and serial number, aligning with asset characteristics.
    • Single Transmission Per Asset: For multiple shipments, asset information is sent only once to avoid duplication in the consumer's instance.

    Implementing Scratchpad updates as described ensures seamless communication and workflow progression between provider and consumer ServiceNow instances during request fulfillment.

    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'
      }
    ]
    };
    
    When you ship the requested items and confirm the shipment, a Scratchpad update with the following details are sent to your consumer's ServiceNow instance:
    • 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.
      For example, consider that a requester has requested for five assets. If you ship only three assets though a shipment, you should pass the Order status as partially_shipped. When you ship the remaining two assets, you should pass the Order status as fully_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.
    Note:
    The shipment update for consumable assets doesn't include Asset tag and Serial number details. If there are multiple shipments, the information of the asset in a shipment must be sent to your consumer's ServiceNow instance only once.