--- sourceDocument: Australia Customer Service Management sourceDocumentLink: https://www.servicenow.com/docs/r/australia/customer-service-management Release : - australia ft:locale : - en-US ft:publication_title : - Australia Customer Service Management ft:clusterId : - csm bundleId : - csm workflow : - Customer and Industry --- # Portal Banner widget instance options form # Portal Banner widget instance options form {#ariaid-title1} Release version: Australia Updated September 10, 2026 ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read Summarize ![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete. ## Summary of Portal Banner widget instance options form The Portal Banner widget instance options form enables ServiceNow customers to customize the appearance and functionality of the Portal Banner widget on their portal pages. This configuration allows for personalized greetings, visual customization, and interactive elements such as search bars and buttons, enhancing user engagement on the portal. Show full answer Show less ## Instance Configuration Options The form is divided into presentation and behavior fields that allow detailed customization: * **Heading:** A required title that can include placeholders like **\** (logged-in user's name), **\** (user's salutation from the User table), and **\** (dynamic greeting based on time and user region). Default is "Home Page Banner". * **Description:** A required subtitle displayed below the heading, defaulting to "This is home page banner description". * **Background Image:** Allows selection or upload of an image from the database to serve as the banner background. * **Heading and Description Text Colors:** Customizable via hex codes, defaulting to white (#FFFFFF). * **Alignment:** Controls the banner content alignment with options Left or Center (default). Selecting None defaults to Left alignment. * **Show Search Bar:** Optionally display a search bar that supports AI-powered search for quick results. * **Primary and Secondary Buttons:** Options to show buttons with customizable labels and URLs. URLs can be absolute (full URL including protocol) or relative (path only). Buttons can be conditionally shown or hidden using scripts. * **Search Placeholder Text:** Customizable placeholder for the search input, defaulting to "Search articles and request items". ## Behavior Customization * **Buttons Condition Script:** Allows scripting to control the visibility of primary and secondary buttons dynamically. * **Widget Placeholder:** Enables embedding an additional widget within the Portal Banner widget. Only widgets from the Widgets table can be added. * **Widget Option Schema:** Defines parameters for the embedded widget, facilitating advanced customization. ## Practical Benefits for ServiceNow Customers * Personalize portal banners to greet users contextually with dynamic information. * Enhance portal aesthetics by customizing text colors, alignment, and background images. * Improve user interaction by adding search capability and actionable buttons with configurable links. * Conditionally display interface elements based on scripted logic to tailor user experience. * Embed additional widgets to extend functionality directly within the banner area. Instance options enable you to configure the Portal Banner widget on a portal page. {#banner-widget-inst-options__table_csm_base_entities__entry__2} | 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 \, \, and \. For example, you could display a banner title such as Hello Mr. Luddy! Good Morning. * \: The name of the logged-in user. * \: The salutation of the logged-in user. The \ variable details are retrieved from the User \[sys_user\] table. * \: Displays the greeting based on the part of the day of the user's region. For example, Good morning, Good afternoon, or Good evening. {#banner-widget-inst-options__ul_f5f_whp_ryb} | | Description | Required subtitle that appears under the heading. The default description is This is home page banner 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](https://www.servicenow.com/docs/access?context=c_StoringImagesInTheDatabase&version=australia&pubname=australia-platform-user-interface&ft:locale=en-US). | | 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 {#banner-widget-inst-options__ul_xgg_px5_1yb} 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](https://www.servicenow.com/docs/access?context=enable-ais-sp&version=australia&pubname=australia-platform-user-interface&ft:locale=en-US). | | 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 {#banner-widget-inst-options__ul_rfl_wqn_tyb} | | 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 {#banner-widget-inst-options__ul_ihq_xrn_tyb} | | Search Placeholder Text | Placeholder text for the search option. The default text is Search articles and request items. | [Table 1. Presentation fields on the Instance form] {#banner-widget-inst-options__table_csm_base_entities} {#banner-widget-inst-options__table_emr_mqk_2zb__entry__2} | 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](https://www.servicenow.com/docs/QKbkB0g23pgvkueR0PnwYw "Provide a link to a web page that you want to display by defining primary or secondary buttons on the Portal Banner widget. The widget displays these buttons by default."). | | 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](https://www.servicenow.com/docs/xQTL18AzaB5FrFlufJFm9Q "Add a widget for additional functionality to the Portal Banner widget and configure it. For example, you could add the Portal Quick Links widget to enable users to access knowledge articles, external URLs, catalog items, or custom pages from the Portal Banner widget."). | [Table 2. Behavior fields on the Instance form] {#banner-widget-inst-options__table_emr_mqk_2zb} **Related concepts** * [Portal Banner widget](https://www.servicenow.com/docs/QIRRyk9zfo2nT1G8C59SIg "You can use the Portal Banner widget to display announcements, new product or feature highlights, and important information on the portal page.") **Related tasks** * [Add and configure the Portal Banner widget](https://www.servicenow.com/docs/_Itl4gBbDVVWkADwP4PM9A "Add a Portal Banner widget to your portal to display announcements, feature highlights, and important information on the portal page.") * [Provide web page link buttons to display on the Portal Banner widget](https://www.servicenow.com/docs/QKbkB0g23pgvkueR0PnwYw "Provide a link to a web page that you want to display by defining primary or secondary buttons on the Portal Banner widget. The widget displays these buttons by default.") * [Add a widget in the Portal Banner widget](https://www.servicenow.com/docs/xQTL18AzaB5FrFlufJFm9Q "Add a widget for additional functionality to the Portal Banner widget and configure it. For example, you could add the Portal Quick Links widget to enable users to access knowledge articles, external URLs, catalog items, or custom pages from the Portal Banner widget.")