Portal Banner widget instance options form

Washington DC Customer Service Management

Release

washingtondc

ft:locale

en-US

ft:publication_title

Washington DC Customer Service Management

ft:clusterId

csm

bundleId

csm

workflow

Customer and Industry

Portal Banner widget instance options form

Release version: Washingtondc

Updated February 1, 2024

2 minutes to read

Summarize

Summarized using AI

Summary of Portal Banner Widget Instance Options Form

The Portal Banner widget allows ServiceNow customers to customize the appearance and functionality of banners displayed on portal pages. Configuration options enable the tailoring of greetings, images, buttons, and more to enhance user experience upon signing in.

Show full answer Show less

Key Features

Heading: Required title with dynamic placeholder variables (, , <partofday>) for personalized greetings.</li><li>Description: Required subtitle that appears beneath the heading.</li><li>Background Image: Customizable image selection sourced from the Images table or uploaded directly.</li><li>Text Colors: Hex code options for heading and description text colors, defaulting to white (#FFFFFF).</li><li>Alignment: Options for content alignment, defaulting to center.</li><li>Search Bar: Option to include a search bar with AI search capabilities.</li><li>Buttons: Options to display primary and secondary buttons with customizable labels and URLs (absolute or relative).</li><li>Search Placeholder: Customizable placeholder text for the search bar, defaulting to "Search articles and request items."</li><li>Buttons Condition Script: Custom script to control the visibility of buttons.</li><li>Widget Placeholder: Capability to embed additional widgets within the Portal Banner.</li></ul><h2>Key Outcomes</h2>By utilizing these configuration options, ServiceNow customers can create engaging and personalized banner experiences that greet users effectively, facilitate navigation through search functionalities, and provide quick access to important web pages. This ultimately enhances the user experience on their portals, making interactions more intuitive and user-friendly.

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.