Service Portal properties
Summarize
Summary of Service Portal properties
Service Portal properties in ServiceNow Yokohama release allow administrators to control key aspects of the portal experience for both admins and end users. These properties are configurable via the Service Portal properties page or directly through the System Properties [sysproperties] table for advanced settings. Proper configuration of these properties enables better user experience, security, accessibility, and performance of Service Portals.
Show less
Key Properties for Managing Portal Behavior
- Default 404 page: Defines the page users see when a requested page fails to load, ensuring a user-friendly error experience.
- Show browser error messages to admins: Controls visibility of browser error messages on portal pages for admin users to aid troubleshooting.
- Stream entry limit: Limits the number of conversation or activity entries visible to users, keeping ticket views concise.
- Notification timeout: Sets how long info and error messages remain visible before auto-dismissing, enhancing message visibility management.
- Announcement sort order: Allows sorting banner announcements by start or end date, ascending or descending, for relevant display prioritization.
- Debug runtime info: Enables Angular.js debug information for developers, off by default for performance reasons.
User Criteria Properties
- User Criteria Enablement: Enables use of User Criteria records instead of roles for widget and page entitlements, offering finer-grained access control.
- Role Bypass List: Defines roles that bypass User Criteria validation, typically including admin roles for unrestricted access.
System Properties for Advanced Configuration
- ACL Enforcement for Queries: Controls if read ACLs are always enforced for filter conditions in Simple List widgets, enhancing data security.
- Human Readable URLs: Enables configuring friendly keywords in portal URLs for easier navigation and SEO benefits.
- Cross-Scope Validation: Enforces cross-scope privilege checks on form data access for stricter security.
- Notification Threshold: Sets how many notifications appear before users can clear all at once, improving notification management.
- SSO Early Redirect: Allows early redirection to the Single Sign-On Identity Provider login page, streamlining authentication flow.
- Language Selector: Enables users to switch portal content languages where supported, improving accessibility for global users.
- Ignore Intermediate SSO Pages: Defines pages to skip during SSO login, directing users straight to their intended start page.
- SCSS Parsing Option: Controls whether compiled SCSS files load as links or inline, affecting page load performance.
- Performance Analyzer Enablement: Specifies which portals display the Performance Analyzer icon for performance evaluation by admin users.
Practical Benefits for ServiceNow Customers
By configuring these properties, ServiceNow customers can:
- Customize error handling and user messaging for improved user experience.
- Control data visibility and access through user criteria and role overrides for secure portal usage.
- Enhance portal performance and debugging capabilities to optimize maintenance and troubleshooting.
- Streamline authentication with Single Sign-On enhancements for smoother end-user login.
- Support multilingual user bases with language selection capabilities.
- Monitor and optimize portal performance effectively using built-in analytics tools.
Service Portal properties control aspects of the portal experience for admin and end users.
The most commonly used Service Portal properties are set on the Service Portal properties page. Some less commonly used properties are available only from the System Properties [sys_properties] table.
You can access the properties listed in the following table by navigating to .
| Property | Description |
|---|---|
Default 404 page (page ID or sp_page sys_id) for Service Portal glide.service_portal.default_404_page |
Set the default page that your users see whenever a page can’t load properly.
|
Show a message to admin users in Service Portal pages if a browser error is encountered glide.sp.show_console_error |
|
Maximum number of stream entries displayed in Service Portal (activity widget, conversation widget, and so on) glide.service_portal.stream_entry_limit |
Limit the number of entries users can see in the ticket conversation widget. Users only see the most recent entries and can’t go further back in the history than the maximum allowed amount.
|
Duration (in seconds) info and error messages persist in the Service Portal before auto-dismissal glide.service-portal.notification_timeout.seconds |
Set the duration in seconds that non-critical notifications remain on the screen before they are auto-dismissed. If set to 0, messages do not auto-dismiss and require that a user close them.
Critical notifications should be tagged with the If the glide.ui.accessibility preference is enabled, messages don’t auto-dismiss, regardless of the system property value. To set this preference, see Enabling accessibility features. |
| Default sort order for announcements glide.service_portal.announcement.default_sort_order |
Define the sort order for banner announcements.
Options include:
|
| Enable debug runtime
information glide.sp.debug |
Controls whether the Angular.js flag
$compileProvider.debugInfoEnabled is set to true or false.
This option allows debug runtime information in the compiler, such as adding binding
information and a reference to the current scope on to DOM elements. This property
is turned off by default to improve performance on the instance.
|
| Property | Description |
|---|---|
|
Enable use of User Criteria records instead of Roles fields for Service Portal entitlements glide.service_portal.user_criteria_enabled |
Define permissions for Service Portal widgets, widget instances, pages, and search sources.
|
|
List of roles (comma-separated) that bypass User Criteria validation in Service Portal glide.sp.entitlement.override |
Allow users with a specific role to see any page, widget, widget instance, or search source regardless of user criteria.
|
You can access the properties listed in the following table in the System Properties [sys_properties] table.
| Property | Description |
|---|---|
| glide.service_portal.enable_acls_for_encoded_query_in_list |
Option to always enforce read ACLs for filter conditions specified in Simple List widget instances. If false, the Enforce field-level Read ACLs on Filter query terms option in Simple List widget instances determines whether to enforce the ACLs.
|
| glide.service_portal.enable_human_readable_urls |
Option to allow configuring human readable keywords in portal page URLs for the instance.
|
| glide.service_portal.enforce_cross_scope_check_in_form | Option to enforce validating cross-scope privileges to a table when the form widget fetches data from a table.
|
| glide.service-portal.notification.threshold |
Specify how many notifications should appear before users have the option to clear all notifications at once.
|
| glide.service_portal.sso.early_redirect.portals | Redirects users to the SSO Identify Provider (IdP) login page without first redirecting them to the portal login page. Provide a comma-separated list of portal suffixes. Note: If your portal uses a customized version
of the Login widget, you must update the sp_sso_early_redirection UI macro as needed to redirect users to the SSO Identify Provider (IdP) login page without trying to load the portal page
first.
|
| glide.sp.portals.language_selector_enabled | Allows any user to choose and view content in their preferred language. This property contains a list of portal sys IDs separated by commas. By default, the sys IDs for the Knowledge (/kb), Customer Support (/csm), and Customer Service (/csp) portals are included. For any portal specified, the language selector appears in the portal header if any languages are installed and active on the instance in addition to English.
|
| glide.sp.starting.page.ignore.list | Ignores intermediate pages used during SSO authentication in order for users to be directed to their starting page rather than an intermediate page. Provide a comma-separated list of page IDs.
|
| glide.sp.theme.parse_scss |
Option to allow compiled SCSS files to be loaded as links to improve repeat page view performance. If set to false, SCSS files are included inline in the page HTML instead.
|
| sp_allow_perf_debug_option_for_portals | Specify the portals to evaluate using the Performance Analyzer by providing a comma-separated list of portal suffixes. For users with the sp_admin or admin roles, the Performance Analyzer icon ( ) appears on pages in the specified portals.
|