Configuring a record producer for request edit

  • Release version: Xanadu
  • Updated September 4, 2025
  • 3 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 Configuring a record producer for request edit

    This guide explains how to configure a record producer in ServiceNow's Workplace Service Delivery to enable users to edit their submitted workplace service requests. Editable requests help keep case records up-to-date and accurate by allowing modifications post-submission. The feature works with cases created on the Workplace Case or Workplace Case Extension tables.

    Show full answer Show less

    Configuring the Edit Functionality

    • Create a record producer on the Workplace Case or Workplace Case Extension tables and map it to the Record Producer field of a Workplace Service.
    • Enable editing by selecting "Case" or "Case and Reservation" in the Available for field of the workplace service and checking the "Allow request modifications" option.
    • When enabled, users see an Edit request action on the request summary page for any associated record producers.
    • On selecting Edit, users are redirected to the familiar WSD Case Editor page where they can update details.
    • Upon saving, the Workplace Case record updates with new values, and new service item requests are created if needed.

    Best Practices for Record Producer Configuration

    • Handling default variable values: Avoid data inconsistencies by applying default values only during new submissions. Use the id parameter from the URL in client scripts to distinguish between new submissions and edits, ensuring the edit page populates variables from the submitted request.
    • Triggering submission events: In the record producer’s onSubmit client script, trigger the wsd.serviceEditor.onSubmit.success event with success: true to validate onSubmit scripts and allow the updated data to apply to the case record. The client script’s UI type should be set to All.
    • Using custom widgets: Ensure custom widgets can pre-fill data by retrieving the submitted request’s sysid from the URL parameter. This allows widgets to populate existing case data on load. Use installed variable sets such as the Workplace Service widget Variable set for item and space selection or the Multilevel space picker widget variable set for space selection only.

    Practical Outcomes for ServiceNow Customers

    By following this configuration, ServiceNow customers can provide users with a seamless way to modify workplace service requests after submission, improving data accuracy and user experience. Editing capabilities maintain the integrity of case records and automate related service item requests based on updates. The configuration supports integration with Workplace Reservation Management and custom widgets, allowing tailored and consistent interfaces for end users.

    Related Tasks and Concepts

    • Install Workplace Case Management
    • Create Workplace case and task templates
    • Configure approvals, SLAs, and escalation rules
    • Add fulfillment instructions and group related cases
    • Configure workplace services and record producers

    Configure a record producer for editable workplace service requests.

    The request edit feature in Workplace Service Delivery lets users modify the details of their submitted requests. Cases that are created with record producers on the Workplace Case or Workplace Case Extension tables can be edited, keeping records current and accurate.

    To configure the edit functionality of a record producer, follow the steps in the following sections.

    Creating a record producer

    You must first create a record producer on the Workplace Case or Workplace Case Extension tables, then map it to the Record Producer field of a Workplace Service. For more information about creating a record producer, see Configure a Record producer.

    If you want to integrate the record producer with Workplace Reservation Management, see Configuring a record producer for reservation.

    Enabling the edit functionality

    You can enable the button by selecting Case or Case and Reservation in the Available for field, then selecting the Allow request modifications field of the workplace service.

    When the Allow request modifications option is enabled on a workplace service, users see the Edit request action in the request summary page for all the record producers associated with that service.

    For more information about the fields of a workplace service, see Workplace Service form.

    Redirecting to the Case Editor page

    When users select the edit request option for their request, they’re redirected to the WSD Case Editor page, which looks like the record producer to provide a familiar interface for users.

    After making their changes, users can save the updated case, which makes the following changes:

    • The Workplace Case record is updated with the new values provided by the user.
    • New service item requests are created based on the updated case information, if necessary.

    Configuring the record producer for editing

    Handling variables with default values on load
    Condition

    Variables that have default values on load can cause data inconsistency on the edit page. The edit page must fill variables based on the submitted request.

    For example, the system tries to populate the logged-in user in the Requested for field instead of picking the data from the submitted request.

    Remedy

    While setting the default value for any variable, ensure that it only applies to the new request submission. You can use the id parameter from the page URL in the client scripts to determine whether it’s a request submission page or an edit page.

    For more information, refer to any record producers installed with Workplace Case Management, like Catering.

    Triggering an event on submission

    For the edit page, you must trigger the wsd.serviceEditor.onSubmit.success event in the onSubmit catalog client script (last executable script) of the record producer with the parameter success: true. Ensure that the last executable client script has the UI type field set to All.

    Triggering the event makes sure that all the onSubmit client scripts are validated and that the updated variable data can be used to update the case record.

    For more information, refer to any record producers installed with Workplace Case Management, like Catering.

    Using custom widgets in the record producer
    Condition

    To use custom widgets in the record producer, ensure that the widget can pre-fill data based on the submitted request. The reference for the widget can be taken from the Workplace Service widget.

    Remedy

    Ensure that if you are on the edit page, you can use the sys_id parameter from the URL to get the sys_id of the submitted request. Use the sys_id to retrieve the case data and populate the existing data on the widget during the first load.

    Alternatively, you can use the following variable sets that are installed with Workplace Case Management:

    • For both item and space selection in the request, use the Workplace Service widget Variable set.
    • For only space selection, use the Multilevel space picker widget variable set.