Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Add a data broker server script for the Playbook tab

Configure a data broker server script that connects the UI Builder component to the script include method controlling the Playbook tab visibility.

Before you begin

Role required: admin

Procedure

  1. Navigate to the All menu and enter sys_ux_data_broker_transform.list.

    The Data Broker Server Scripts table appears.

  2. Select New.

    The Data Broker Server Script form opens.

Image omitted: cmpro-data-broker-playbook.png
Data Broker Server Script form displaying sample values to configure for the playbook visibility.
  1. In the Name field, enter the name for your configuration.

  2. In the Application field, select the appropriate application scope for your implementation.

  3. In the Description field, enter a description.

    For example, Whether to show or hide the Playbook tab on the Legal Counsel Center

  4. In the Properties field, add the following JSON configuration:

    [{
                            "name": "table",
                            "label": "Table",
                            "fieldType": "string",
                            "mandatory": true
                            },
                            {
                            "name": "sysId",
                            "label": "Sys ID",
                            "fieldType": "string",
                            "mandatory": true
                            }]
    
  5. In the Script field, add the script for the data broker.

    Example:

    function transform(input) {
                            var table = input.table;
                            var sysId = input.sysId;
                            if (!table || !sysId) return true;
    
                            return sn_lg_cf_workspace.LegalUIBWorkspaceDataBrokerHelper.hidePlaybookTab(table, sysId);
                            }
    

    This function receives the table and sysId from the input, validates them, and calls the helper method to determine tab visibility.

  6. Select Update to save the data broker server script.

Parent Topic:Configuring the Playbook tab on contract repository records