servicenow scripted related list

2 min read 12-10-2024

In ServiceNow, related lists are an essential feature that enables users to view and interact with related records from different tables. While the out-of-the-box related lists serve many purposes, there are times when customization is necessary. This is where Scripted Related Lists come into play. In this article, we'll explore what scripted related lists are, why they are useful, and how to create one in ServiceNow.

What is a Scripted Related List?

A Scripted Related List allows you to display records in a related list based on custom criteria. Unlike standard related lists that are predefined and linked to a particular table, scripted related lists are defined by scripts that you can write to meet specific business needs. This flexibility allows for greater control over what data is displayed and how it is displayed.

Why Use Scripted Related Lists?

There are several reasons to consider using scripted related lists in ServiceNow:

Customization: Tailor the related list to show only the relevant records that meet your specific requirements.
Complex Logic: Implement complex logic to filter or manipulate data based on specific conditions.
Enhanced User Experience: Improve the user interface by displaying relevant information in a more organized manner.

Creating a Scripted Related List

Here’s a step-by-step guide to creating a scripted related list in ServiceNow:

Step 1: Define the Related List

Navigate to the Table: Go to the table where you want to add the scripted related list.
Open the Form Layout: Click on the gear icon in the top-right corner and select "Form Layout".
Add Related List: Scroll to the Related Lists section and click on the “+” icon to add a new related list.

Step 2: Configure the Scripted Related List

Select Scripted Related List: In the related list type, select "Scripted Related List".
Set the Table: Choose the table from which the records will be fetched.

Write the Script: In the script field, you will need to write a GlideRecord script that defines how to retrieve the records. Below is a simple example of a script to fetch incident records related to a particular change request:

var gr = new GlideRecord('incident');
gr.addQuery('change_request', current.sys_id); // current is the change request
gr.query();

var result = [];
while (gr.next()) {
    result.push({
        number: gr.number,
        short_description: gr.short_description,
        state: gr.state.getDisplayValue()
    });
}
return result;

Step 3: Customize the Display

Choose Display Fields: Specify which fields you want to display in the related list (e.g., number, short description, state).
Sort Order: Define how the list should be sorted (e.g., by incident number or state).

Step 4: Test Your Scripted Related List

Save the changes and open a record of the table you modified to see the new related list.
Ensure that the records are being displayed as expected and that the logic within your script works correctly.

Conclusion

Creating a Scripted Related List in ServiceNow can significantly enhance your application's functionality by allowing you to display relevant data tailored to your business needs. With the flexibility of scripting, you can implement complex logic and improve user experience effectively. By following the steps outlined above, you can create a powerful tool that provides valuable insights right at users' fingertips.

Take advantage of this feature to optimize your ServiceNow instance and deliver a more customized experience!