{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":895,"path":"api-reference/server-api-reference/RenderProperties-Scoped-API.md","title":"RenderProperties - Scoped","bundle":null,"doc_type":null,"release":"australia","body":"\n# RenderProperties- Scoped\n\nThe RenderProperties API provides methods to obtain information about the current page and is available in Jelly scripts and in UI-action conditions and scripts.\n\nAccess RenderProperties methods using the static variable `RP`.\n\n**Parent Topic:**[Server API reference](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/api-server.md)\n\n## Scoped RenderProperties - getEncodedQuery\\(\\)\n\nReturns the encoded query from the URL sent to the page.\n\n|Name|Type|Description|\n|----|----|-----------|\n|None| | |\n\n|Type|Description|\n|----|-----------|\n|String|Encoded query from the URL sent to the form.|\n\nThe 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-administration/c_UIActions.md).\n\n```\nRP.getEncodedQuery() != null && (RP.getEncodedQuery().indexOf('table=global') < 0 && RP.getEncodedQuery().indexOf('table=') >= 0)\n```\n\n## Scoped RenderProperties - getListControl\\(\\)\n\nReturns the list control object for the page.\n\n|Name|Type|Description|\n|----|----|-----------|\n|None| | |\n\n|Type|Description|\n|----|-----------|\n|ScopedSysListControl object|Lst control object for the page.|\n\nThe 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-administration/c_UIActions.md).\n\n```\ncurrent.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()\n```\n\n## Scoped RenderProperties - getParameterValue\\(String parameterName\\)\n\nReturns the value of the specified URL parameter.\n\n|Name|Type|Description|\n|----|----|-----------|\n|parameterName|String|Name of the parameter passed on the URL.|\n\n|Type|Description|\n|----|-----------|\n|String|The parameter's value.|\n\nThe 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-administration/c_UIActions.md).\n\n```\ncurrent.canCreate() && (!current.instanceOf('task') || gs.getProperty('glide.ui.task.insert') == 'true') && (!current.instanceOf('sys_db_object')) && JSUtil.nil(RP.getParameterValue(\"sysparm_changeset\"))\n```\n\n## Scoped RenderProperties - getReferringURL\\(\\)\n\nReturns the URL where the request originated.\n\n|Name|Type|Description|\n|----|----|-----------|\n|None| | |\n\n|Type|Description|\n|----|-----------|\n|String|URL of the page where the request originated.|\n\nThe 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-administration/c_UIActions.md).\n\n```\nRP.getReferringURL().indexOf(\"sys_import_set.do\") == -1 && new global.ImportSetRowHelper().canReadImportSets();\n```\n\n## Scoped RenderProperties - getViewName\\(\\)\n\nReturns the name of the view in use.\n\n|Name|Type|Description|\n|----|----|-----------|\n|None| | |\n\n|Type|Description|\n|----|-----------|\n|String|Name of the view being used.|\n\nThe 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-administration/c_UIActions.md).\n\n```\nRP.getViewName() != '' && RP.getViewName() != null && RP.getViewName() != undefined\n```\n\n## Scoped RenderProperties - getWindowProperties\\(\\)\n\nReturns the window's properties.\n\n|Name|Type|Description|\n|----|----|-----------|\n|None| | |\n\n|Type|Description|\n|----|-----------|\n|Object|Window's properties.|\n\n## Scoped RenderProperties - isInDevStudio\\(\\)\n\nReturns true if the page is part of Studio.\n\n|Name|Type|Description|\n|----|----|-----------|\n|None| | |\n\n<table id=\"table_pcv_yxz_yx\" class=\"returns\"><thead><tr><th>\n\nType\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nBoolean\n\n</td><td>\n\nFlag that indicates whether the page is part of Studio.Possible values:\n\n-   true: Page is part of Studio.\n-   false: Page isn't part of Studio.\n\n</td></tr></tbody>\n</table>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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-administration/c_UIActions.md).\n\n```\ncurrent.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()\n```\n\n## Scoped RenderProperties - isInteractive\\(\\)\n\nReturns true if this is an interactive session. An interactive session is when a user has logged in as opposed to a REST request.\n\n|Name|Type|Description|\n|----|----|-----------|\n|None| | |\n\n<table id=\"table_hwd_2tz_yx\" class=\"returns\"><thead><tr><th>\n\nType\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nBoolean\n\n</td><td>\n\nFlag that indicates whether this is an interactive session.Possible values:\n\n-   true: Interactive session.\n-   false: Not an interactive session.\n\n</td></tr></tbody>\n</table>## Scoped RenderProperties - isManyToMany\\(\\)\n\nReturns true when the `sysparm_collection_related_file` URL parameter is set.\n\n|Name|Type|Description|\n|----|----|-----------|\n|None| | |\n\n<table id=\"table_u2z_g4z_yx\" class=\"returns\"><thead><tr><th>\n\nType\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nBoolean\n\n</td><td>\n\nFlag that indicates whether the `sysparm_collection_related_file` URL parameter is set.Possible values:\n\n-   true: Parameter is set.\n-   false: Parameter isn't set.\n\n</td></tr></tbody>\n</table>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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-administration/c_UIActions.md).\n\n```\ncurrent.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()\n```\n\n## Scoped RenderProperties - isRelatedList\\(\\)\n\nReturns true when the `sys_is_related_list` URL-parameter is true. Returns false if the parameter is not present.\n\n|Name|Type|Description|\n|----|----|-----------|\n|None| | |\n\n<table id=\"table_xwh_xlz_yx\" class=\"returns\"><thead><tr><th>\n\nType\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nBoolean\n\n</td><td>\n\nFlag that indicates whether the URL parameter `sys_is_related_list` is set to `true`.Possible values:\n\n-   true: `sys_is_related_list` is set to `true`.\n-   false: `sys_is_related_list` is set to `false`.\n\n</td></tr></tbody>\n</table>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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-administration/c_UIActions.md).\n\n```\ncurrent.canCreate() && RP.isRelatedList()\n```\n\n"}}