Portal Banner widget instance options form
Summarize
Summary of Portal Banner widget instance options form
The Portal Banner widget instance options form allows ServiceNow customers to customize the appearance and behavior of the Portal Banner on their portal pages. This configuration enables personalized greetings, visual branding, and interactive elements to enhance user engagement upon sign-in.
Show less
Instance Configuration Options
The form is divided into presentation and behavior settings that control the banner's content, style, and interactive features:
- Heading: Required title displayed on the banner, customizable with placeholders like
<user>(logged-in user's name),<title>(user salutation from the User table), and<partofday>(greeting based on user’s region and time of day). - Description: Required subtitle text shown below the heading.
- Background Image: Option to select or upload an image stored in the database to use as the banner background.
- Text Colors: Hex code inputs for customizing the heading and description text colors, defaulting to white (#FFFFFF).
- Alignment: Controls content alignment within the banner; options include Left or Center (default is Center). Selecting None defaults to Left alignment.
- Show Search Bar: Optionally display a search bar within the banner, supporting AI search to enhance content discovery.
- Primary and Secondary Buttons: Options to show one or two buttons with configurable labels and URLs. URLs can be absolute (full URL with protocol) or relative (path only). Buttons open internal pages in the same tab or external pages in new tabs.
- Search Placeholder Text: Customizable placeholder text for the search input, defaulting to "Search articles and request items."
Behavior Configuration
- Buttons Condition Script: Scripted logic to dynamically show or hide primary and secondary buttons based on custom conditions. By default, both buttons are shown without conditions.
- Widget Placeholder: Allows embedding an additional widget from the Widgets table within the Portal Banner for extended functionality.
- Widget Option Schema: Defines parameters for the embedded widget, enabling further customization.
Practical Benefits
By using these instance options, ServiceNow customers can tailor the Portal Banner to present personalized greetings, reinforce branding with custom images and colors, and enhance user navigation with search and actionable buttons. The ability to embed widgets and conditionally display buttons provides flexibility to meet diverse portal requirements.
Instance options enable you to configure the Portal Banner widget on a portal page.
| 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.
|
| 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:
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:
|
| 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:
|
| Search Placeholder Text | Placeholder text for the search option. The default text is Search articles and request items. |
| 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. |