Use PDIs? Take our 5-minute survey to help shape the PDI roadmap.

sarah_bioni
ServiceNow Employee

In this article, we’ll demonstrate how to create a Data Broker Server Script that retrieves the value of a specific system property by its name. This is particularly useful when building Workspace experiences that require dynamic property values through Data Resources.

 

Step 1: Define the Data Broker Properties

Add a property to capture the name of the system property you want to retrieve:

[
{
"name": "property_name",
"label": "Name of property",
"description": "Name of the required property",
"readOnly": false,
"fieldType": "string",
"mandatory": true,
"defaultValue": ""
}
]
 

This ensures the Data Broker accepts the property name as input.


Step 2: Implement the Server Script

Use the following script in your Data Broker:

function transform(input) {
var grProperties = new GlideRecord('sys_properties');
grProperties.addQuery('name', input.property_name);
grProperties.query();
if (grProperties.next()) {
return grProperties.getDisplayValue('value');
} else {
return "Property name was not found";
}
}
 

Key Points:

  • The script queries the sys_properties table.
  • If the property exists, it returns its display value.
  • If not found, it returns a friendly message.

sarah_bioni_1-1763730153408.png

 


Step 3: Configure in UI Builder

Once the Data Broker is created:

  1. Navigate to UI Builder.
  2. Add a Data Resource using your new Data Broker.
  3. Pass the property name dynamically or statically.
  4. Bind the returned value to your component.

sarah_bioni_0-1763730142886.png

 

Comments
AdemirAmaral
ServiceNow Employee

Thank you for sharing, Sarah! I followed the step-by-step instructions and it worked!

User166992
Tera Guru

Hello,

 

One recommendation, instead of querying properties table you could use gs.getProperty('') method.

 

Best Regards,

Jai

saint
Tera Expert

How is Data Broker Server Script (sys_ux_data_broker_transform) table is connected to the sys_ux_extension_point table. I want to clone the Data Broker Server Script but I'm unable to find the connection to replace it.

 

 

Version history
Last update:
‎11-21-2025 05:03 AM
Updated by:
Contributors