Portal Banner widget instance options form

Release version: Yokohama

Updated January 30, 2025

2 minutes to read

Summarize

Summarized using AI

Summary of Portal Banner widget instance options form

The Portal Banner widget instance options form allows you to configure the Portal Banner widget on a ServiceNow portal page. These options control the content, appearance, and behavior of the banner, helping you customize the user greeting experience and interactive elements such as buttons and search functionality.

Show full answer Show less

Instance Options for Presentation

Heading: Required title text that greets the signed-in user, supporting placeholders like , , and <partofday> for dynamic personalized greetings.</li> <li>Description: Required subtitle text appearing below the heading, with a default placeholder description.</li> <li>Background Image: Option to select or upload an image from the Images [dbimage] table to display as the banner background.</li> <li>Heading and Description Text Color: Hex code inputs to customize text colors, defaulting to white (#FFFFFF).</li> <li>Alignment: Sets the content alignment inside the banner, with options for Left or Center (default Center).</li> <li>Show Search Bar: Toggle to display a search bar within the banner; can be enhanced with AI search capabilities for faster results.</li> <li>Primary and Secondary Buttons: Options to show buttons with customizable labels and URLs. URLs can be absolute (including protocol) or relative (path only). Buttons open links either in the same tab or a new tab depending on the URL type.</li> <li>Search Placeholder Text: Allows customization of the placeholder text in the search bar, defaulting to "Search articles and request items."</li></ul><h2>Instance Options for Behavior</h2><ul> <li>Buttons Condition Script: A script to conditionally show or hide the primary or secondary buttons. By default, both buttons display without conditions. This extension point enables advanced customization of button visibility.</li> <li>Widget Placeholder: Enables embedding an additional widget from the Widgets [spwidget] table inside the Portal Banner widget.</li> <li>Widget Option Schema: Defines parameters for the embedded widget to configure its behavior and appearance within the banner.</li></ul><h2>Practical Application for ServiceNow Customers</h2>Using these instance options, you can create a personalized and visually appealing banner for your portal pages that enhances user engagement by greeting users dynamically, providing quick search access, and offering actionable buttons linked to internal or external resources. The flexibility to embed additional widgets and conditionally display buttons allows for tailored user experiences aligned with your organization's needs.

Instance options enable you to configure the Portal Banner widget on a portal page.

Table 1. Presentation fields on the Instance form
Instance option	Description
Heading	Required title of a Portal Banner widget to greet a user who signs in into the website. The default text is `Home Page Banner`. The heading field supports placeholder variables such as <user>, <title>, and <part_of_day>. For example, you could display a banner title such as `Hello Mr. Luddy! Good Morning.` <user>: The name of the logged-in user. <title>: The salutation of the logged-in user. The <title> variable details are retrieved from the User [sys_user] table. <part_of_day>: Displays the greeting based on the part of the day of the user's region. For example, Good morning, Good afternoon, or Good evening.
Description	Required subtitle that appears below the heading. The default description is `This is home page description`.
Background Image	Image to appear as the background on the banner. Note: You can select images from the Images [db_image] table or upload a new image to it. For more information, see Storing images in the database.
Heading Text Color Hex code	Color of the heading text in hex code format. The default value is #FFFFFF (white).
Description Text Color Hex code	Color of the description text color in hex code format. The default value is #FFFFFF (white).
Alignment	Alignment of the banner content inside the widget. The available options are: Left Center The default alignment is Center. Note: Currently, if you select None, the alignment is set to Left.
Show Search bar	Option to display the search bar on the Portal Banner widget to search content. Note: You can enable the AI search for a banner widget to get quick results. For more information, see Enable and configure AI Search in Service Portal.
Show Primary Button	Option to display the primary button on the Portal Banner widget.
Primary Button Label	Label of the primary button.
Primary Button URL	The URL that opens an internal web page or a portal page in the same tab and an external page or a portal in a new tab. The two types of primary URLs are: Absolute URL: The full URL including its protocol (http or https). For example: `https://example.servicenow.com/scripts/sn_csm_ec.js?v=3.1` Relative URL: A URL that includes only the path that comes after the domain. For example: `scripts/sn_csm_ec.js?v=3.1`
Show Secondary Button	Option to display a secondary button on the banner widget.
Secondary Button Label	Label of a secondary button.
Secondary Button URL	The URL that opens an internal web page or a portal page in the same tab and an external page or a portal in a new tab. The two types of secondary URLs are: Absolute URL: The full URL including its protocol (http or https). For example: `https://example.servicenow.com/scripts/sn_csm_ec.js?v=3.1` Relative URL: A URL that includes only the path that comes after the domain. For example: `scripts/sn_csm_ec.js?v=3.1`
Search Placeholder Text	Placeholder text for the search option. The default text is `Search articles and request items`.

Table 2. Behavior fields on the Instance form
Instance option	Description
Buttons Condition Script	Script to show or hide the primary or secondary button. You can use the scripted extension point to implement the condition script. By default, the new script displays both buttons and doesn’t include any condition. For more information, see Provide web page link buttons to display on the Portal Banner widget.
Widget Placeholder	Option to embed an additional widget on the Portal Banner widget. You can include only widgets from the Widgets [sp_widget] table.
Widget Option Schema	Defines the parameters of the widget that you want to add. For more information, see Add a widget in the Portal Banner widget.