---
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 - Global

# RenderProperties - Global {#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`.

## RenderProperties - getEncodedQuery() {#ariaid-title2}

Returns the encoded query from the URL sent to the page.
{#RP-getEncodedQuery__table_ksz_5ft_3y__entry__3}

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

{#RP-getEncodedQuery__table_ksz_5ft_3y} {#RP-getEncodedQuery__table_lsz_5ft_3y__entry__2}

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

{#RP-getEncodedQuery__table_lsz_5ft_3y}  
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)

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

Returns the list control object for the page.
{#RP-getListControl__table_lpg_mgt_3y__entry__3}

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

{#RP-getListControl__table_lpg_mgt_3y} {#RP-getListControl__table_mpg_mgt_3y__entry__2}

| Type | Description |
|-|-|
| SysListControl object | The list control object for the page. |
[Table 4. Returns]

{#RP-getListControl__table_mpg_mgt_3y}  
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()

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

Returns the value of the specified URL parameter.
{#RP-getParameterValue_S__table_p5t_zgt_3y__entry__3}

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

{#RP-getParameterValue_S__table_p5t_zgt_3y} {#RP-getParameterValue_S__table_q5t_zgt_3y__entry__2}

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

{#RP-getParameterValue_S__table_q5t_zgt_3y}  
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"))

## RenderProperties - getReferringURL() {#ariaid-title5}

Returns the URL where the request originated.
{#RP-getReferringURL__table_lrn_5rt_3y__entry__3}

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

{#RP-getReferringURL__table_lrn_5rt_3y} {#RP-getReferringURL__table_mrn_5rt_3y__entry__2}

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

{#RP-getReferringURL__table_mrn_5rt_3y}  
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();

## RenderProperties - getViewID() {#ariaid-title6}

Returns the view the page is using.
This method is not available in scoped applications.
{#RP-getViewID__table_z4c_lw2_zx__entry__3}

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

{#RP-getViewID__table_z4c_lw2_zx} {#RP-getViewID__table_apc_lw2_zx__entry__2}

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

{#RP-getViewID__table_apc_lw2_zx}

## RenderProperties - getViewName() {#ariaid-title7}

Returns the name of the view in use.
{#RP-getViewName__table_mxv_fst_3y__entry__3}

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

{#RP-getViewName__table_mxv_fst_3y} {#RP-getViewName__table_nxv_fst_3y__entry__2}

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

{#RP-getViewName__table_nxv_fst_3y}  
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

## RenderProperties - getWindowProperties() {#ariaid-title8}

Returns the window's properties.
{#RP-getWindowProperties__table_cvh_pst_3y__entry__3}

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

{#RP-getWindowProperties__table_cvh_pst_3y} {#RP-getWindowProperties__table_dvh_pst_3y__entry__2}

| Type | Description |
|-|-|
| Object | The window's properties |
[Table 14. Returns]

{#RP-getWindowProperties__table_dvh_pst_3y}

## RenderProperties - isInDevStudio() {#ariaid-title9}

Returns true if the page is part of Studio.
{#RP-isInDevStudio__table_sxk_zst_3y__entry__3}

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

{#RP-isInDevStudio__table_sxk_zst_3y} {#RP-isInDevStudio__table_txk_zst_3y__entry__2}

| Type | Description |
|-|-|
| Boolean | Returns true if the page is part of Studio. |
[Table 16. Returns]

{#RP-isInDevStudio__table_txk_zst_3y}  
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()

## RenderProperties - isInteractive() {#ariaid-title10}

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

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

{#RP-isInteractive__table_hvc_ktt_3y} {#RP-isInteractive__table_ivc_ktt_3y__entry__2}

| Type | Description |
|-|-|
| Boolean | True if this is an interactive session. |
[Table 18. Returns]

{#RP-isInteractive__table_ivc_ktt_3y}

## RenderProperties - isManyToMany() {#ariaid-title11}

Returns true when the `sysparm_collection_related_file` URL parameter is
set.
{#RP-isManyToMany__table_lnf_ztt_3y__entry__3}

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

{#RP-isManyToMany__table_lnf_ztt_3y} {#RP-isManyToMany__table_mnf_ztt_3y__entry__2}

| Type | Description |
|-|-|
| Boolean | Returns true when the `sysparm_collection_related_file` URL parameter is set. |
[Table 20. Returns]

{#RP-isManyToMany__table_mnf_ztt_3y}  
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()

## RenderProperties - isRelatedList() {#ariaid-title12}

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

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

{#RP-isRelatedList__table_cj5_35t_3y} {#RP-isRelatedList__table_dj5_35t_3y__entry__2}

| Type | Description |
|-|-|
| Boolean | True if the URL parameter `sys_is_related_list` is true. |
[Table 22. Returns]

{#RP-isRelatedList__table_dj5_35t_3y}  
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()