RenderProperties - Scoped

  • Release version: Zurich
  • Updated July 31, 2025
  • 3 minutes to read

    • The RenderProperties API provides methods to obtain information about the current page and is available in Jelly scripts and in UI-action conditions and scripts.

    Access RenderProperties methods using the static variable RP.

    Scoped RenderProperties - getEncodedQuery()

    Returns the encoded query from the URL sent to the page.

    Table 1. Parameters
    Name Type Description
    None
    Table 2. Returns
    Type Description
    String Encoded query from the URL sent to the form.

    The following example is used in a condition for UI action named listed in the UI Actions [sys_ui_action] table. See also Defining UI actions.

    RP.getEncodedQuery() != null && (RP.getEncodedQuery().indexOf('table=global') < 0 && RP.getEncodedQuery().indexOf('table=') >= 0)

    Scoped RenderProperties - getListControl()

    Returns the list control object for the page.

    Table 3. Parameters
    Name Type Description
    None
    Table 4. Returns
    Type Description
    ScopedSysListControl object Lst control object for the page.

    The following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys_ui_action] table. See also Defining UI actions.

    current.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()

    Scoped RenderProperties - getParameterValue(String parameterName)

    Returns the value of the specified URL parameter.

    Table 5. Parameters
    Name Type Description
    parameterName String Name of the parameter passed on the URL.
    Table 6. Returns
    Type Description
    String The parameter's value.

    The following example is used in a condition for the Insert and Stay UI action for configuration items listed in the UI Actions [sys_ui_action] table. See also Defining UI actions.

    current.canCreate() && (!current.instanceOf('task') || gs.getProperty('glide.ui.task.insert') == 'true') && (!current.instanceOf('sys_db_object')) && JSUtil.nil(RP.getParameterValue("sysparm_changeset"))

    Scoped RenderProperties - getReferringURL()

    Returns the URL where the request originated.

    Table 7. Parameters
    Name Type Description
    None
    Table 8. Returns
    Type Description
    String URL of the page where the request originated.

    The following example is used in a condition for the Import Sets UI action for import set row listed in the UI Actions [sys_ui_action] table. See also Defining UI actions.

    RP.getReferringURL().indexOf("sys_import_set.do") == -1 && new global.ImportSetRowHelper().canReadImportSets();

    Scoped RenderProperties - getViewName()

    Returns the name of the view in use.

    Table 9. Parameters
    Name Type Description
    None
    Table 10. Returns
    Type Description
    String Name of the view being used.

    The following example is used in a condition named New for action assignment. This UI action is listed in the UI Actions [sys_ui_action] table. See also Defining UI actions.

    RP.getViewName() != '' && RP.getViewName() != null && RP.getViewName() != undefined

    Scoped RenderProperties - getWindowProperties()

    Returns the window's properties.

    Table 11. Parameters
    Name Type Description
    None
    Table 12. Returns
    Type Description
    Object Window's properties.

    Scoped RenderProperties - isInDevStudio()

    Returns true if the page is part of Studio.

    Table 13. Parameters
    Name Type Description
    None
    Table 14. Returns
    Type Description
    Boolean Flag that indicates whether the page is part of Studio.
    Possible values:
    • true: Page is part of Studio.
    • false: Page isn't part of Studio.

    The following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys_ui_action] table. See also Defining UI actions.

    current.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()

    Scoped RenderProperties - isInteractive()

    Returns true if this is an interactive session. An interactive session is when a user has logged in as opposed to a REST request.

    Table 15. Parameters
    Name Type Description
    None
    Table 16. Returns
    Type Description
    Boolean Flag that indicates whether this is an interactive session.
    Possible values:
    • true: Interactive session.
    • false: Not an interactive session.

    Scoped RenderProperties - isManyToMany()

    Returns true when the sysparm_collection_related_file URL parameter is set.

    Table 17. Parameters
    Name Type Description
    None
    Table 18. Returns
    Type Description
    Boolean Flag that indicates whether the sysparm_collection_related_file URL parameter is set.
    Possible values:
    • true: Parameter is set.
    • false: Parameter isn't set.

    The following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys_ui_action] table. See also Defining UI actions.

    current.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()

    Scoped RenderProperties - isRelatedList()

    Returns true when the sys_is_related_list URL-parameter is true. Returns false if the parameter is not present.

    Table 19. Parameters
    Name Type Description
    None
    Table 20. Returns
    Type Description
    Boolean Flag that indicates whether the URL parameter sys_is_related_list is set to true.
    Possible values:
    • true: sys_is_related_list is set to true.
    • false: sys_is_related_list is set to false.

    The following example is used in a condition for a UI action listed in the UI Actions [sys_ui_action] table. See also Defining UI actions.

    current.canCreate() && RP.isRelatedList()