---
sourceDocument: Xanadu API Reference
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - en-US

ft:publication_title :

    - Xanadu API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# RenderProperties - Scoped

# RenderProperties - Scoped {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 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() {#ariaid-title2}

Returns the encoded query from the URL sent to the page.
{#SRP-getEncodedQuery__table_p1p_sqz_yx__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 1. Parameters]

{#SRP-getEncodedQuery__table_p1p_sqz_yx} {#SRP-getEncodedQuery__table_q1p_sqz_yx__entry__2}

| Type | Description |
|-|-|
| String | Encoded query from the URL sent to the form. |
[Table 2. Returns]

{#SRP-getEncodedQuery__table_q1p_sqz_yx}  
The following example is used in a condition for UI action named listed in the UI Actions \[sys_ui_action\] table. See also [UI actions](https://www.servicenow.com/docs/access?context=c_UIActions&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US).

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

## Scoped RenderProperties - getListControl() {#ariaid-title3}

Returns the list control object for the page.
{#SRP-getListControl__table_qvp_n5z_yx__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 3. Parameters]

{#SRP-getListControl__table_qvp_n5z_yx} {#SRP-getListControl__table_rvp_n5z_yx__entry__2}

| Type | Description |
|-|-|
| ScopedSysListControl object | Lst control object for the page. |
[Table 4. Returns]

{#SRP-getListControl__table_rvp_n5z_yx}  
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 [UI actions](https://www.servicenow.com/docs/access?context=c_UIActions&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US).

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

## Scoped RenderProperties - getParameterValue(String parameterName) {#ariaid-title4}

Returns the value of the specified URL parameter.
{#SRP-getParameterValue_S__table_b2w_zgz_yx__entry__3}

| Name | Type | Description |
|-|-|-|
| parameterName | String | Name of the parameter passed on the URL. |
[Table 5. Parameters]

{#SRP-getParameterValue_S__table_b2w_zgz_yx} {#SRP-getParameterValue_S__table_c2w_zgz_yx__entry__2}

| Type | Description |
|-|-|
| String | The parameter's value. |
[Table 6. Returns]

{#SRP-getParameterValue_S__table_c2w_zgz_yx}  
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 [UI actions](https://www.servicenow.com/docs/access?context=c_UIActions&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US).

    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() {#ariaid-title5}

Returns the URL where the request originated.
{#SRP-getReferringURL__table_vgr_dsz_yx__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 7. Parameters]

{#SRP-getReferringURL__table_vgr_dsz_yx} {#SRP-getReferringURL__table_wgr_dsz_yx__entry__2}

| Type | Description |
|-|-|
| String | URL of the page where the request originated. |
[Table 8. Returns]

{#SRP-getReferringURL__table_wgr_dsz_yx}  
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 [UI actions](https://www.servicenow.com/docs/access?context=c_UIActions&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US).

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

## Scoped RenderProperties - getViewName() {#ariaid-title6}

Returns the name of the view in use.
{#SRP-getViewName__table_kd3_15z_yx__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 9. Parameters]

{#SRP-getViewName__table_kd3_15z_yx} {#SRP-getViewName__table_ld3_15z_yx__entry__2}

| Type | Description |
|-|-|
| String | Name of the view being used. |
[Table 10. Returns]

{#SRP-getViewName__table_ld3_15z_yx}  
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 [UI actions](https://www.servicenow.com/docs/access?context=c_UIActions&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US).

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

## Scoped RenderProperties - getWindowProperties() {#ariaid-title7}

Returns the window's properties.
{#SRP-getWindowProperties__table_fw2_kxz_yx__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 11. Parameters]

{#SRP-getWindowProperties__table_fw2_kxz_yx} {#SRP-getWindowProperties__table_gw2_kxz_yx__entry__2}

| Type | Description |
|-|-|
| Object | Window's properties. |
[Table 12. Returns]

{#SRP-getWindowProperties__table_gw2_kxz_yx}

## Scoped RenderProperties - isInDevStudio() {#ariaid-title8}

Returns true if the page is part of Studio.
{#SRP-isInDevStudio__table_ocv_yxz_yx__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 13. Parameters]

{#SRP-isInDevStudio__table_ocv_yxz_yx} {#SRP-isInDevStudio__table_pcv_yxz_yx__entry__2}

| 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. |
[Table 14. Returns]

{#SRP-isInDevStudio__table_pcv_yxz_yx}  
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 [UI actions](https://www.servicenow.com/docs/access?context=c_UIActions&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US).

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

## Scoped RenderProperties - isInteractive() {#ariaid-title9}

Returns true if this is an interactive session. An interactive session is when a user
has logged in as opposed to a REST request.
{#SRP-isInteractive__table_gwd_2tz_yx__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 15. Parameters]

{#SRP-isInteractive__table_gwd_2tz_yx} {#SRP-isInteractive__table_hwd_2tz_yx__entry__2}

| Type | Description |
|-|-|
| Boolean | Flag that indicates whether this is an interactive session. Possible values: * true: Interactive session. * false: Not an interactive session. |
[Table 16. Returns]

{#SRP-isInteractive__table_hwd_2tz_yx}

## Scoped RenderProperties - isManyToMany() {#ariaid-title10}

Returns true when the `sysparm_collection_related_file` URL parameter is
set.
{#SRP-isManyToMany__table_t2z_g4z_yx__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 17. Parameters]

{#SRP-isManyToMany__table_t2z_g4z_yx} {#SRP-isManyToMany__table_u2z_g4z_yx__entry__2}

| 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. |
[Table 18. Returns]

{#SRP-isManyToMany__table_u2z_g4z_yx}  
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 [UI actions](https://www.servicenow.com/docs/access?context=c_UIActions&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US).

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

## Scoped RenderProperties - isRelatedList() {#ariaid-title11}

Returns true when the `sys_is_related_list` URL-parameter is true.
Returns false if the parameter is not present.
{#SRP-isRelatedList__table_wwh_xlz_yx__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 19. Parameters]

{#SRP-isRelatedList__table_wwh_xlz_yx} {#SRP-isRelatedList__table_xwh_xlz_yx__entry__2}

| 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. |
[Table 20. Returns]

{#SRP-isRelatedList__table_xwh_xlz_yx}  
The following example is used in a condition for a UI action listed in the UI Actions \[sys_ui_action\] table. See also [UI actions](https://www.servicenow.com/docs/access?context=c_UIActions&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US).

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