Component properties for the Case list
Summarize
Summary of Component properties for the Case list
The Case list component properties allow ServiceNow customers to customize the behavior and appearance of the Case list component when embedded on third-party websites. These settings help tailor the component to specific user needs by controlling which elements are visible, how cases are filtered and displayed, and how users interact with the list.
Show less
Key Features
- Header Customization: Options to hide or show the header, including sub-elements like the record count, search button, filter button, refresh button, and last refreshed text.
- Data Source Configuration: Specify the table from which cases or tasks are retrieved, defaulting to the Case [sncustomerservicecase] table but supporting any extended case or task tables.
- Filtering and Querying: Use encoded queries to filter cases displayed in the list. If no query is provided, all cases are shown by default.
- Display Settings: Choose a predefined view style or customize which columns appear in the case list. Column resizing can be enabled or disabled to control the layout.
- Pagination and Error Handling: Set the number of records shown per page (default 20) and decide whether to hide error messages from end users on the third-party site.
- Empty State Handling: Option to hide the component entirely if no cases are available when the component initially loads, helping to maintain clean UI presentations.
Practical Application
By configuring these properties, ServiceNow customers can ensure the Case list component integrates seamlessly with their external websites, providing users with a clear, functional, and user-friendly experience. This includes controlling visibility of UI elements, tailoring data views to specific business needs, and managing user interactions such as searching and filtering cases.
Proper use of these properties enables efficient case management display and helps avoid errors, such as issues caused by reference columns in custom views. Customers can enhance their external portals with precise control over case presentation and user experience.
Component properties enable you to configure the behavior of the Case list component instance on a third-party website.
| Component property | Description |
|---|---|
| Hide header | Option to display header and its components. By default, it shows header. |
| Title | Required title of the Case list component. |
| Hide record count | Option switch to show or hide the total number of records on the case list. By default, it shows record count. |
| Hide search | Option switch to show or hide search button on the header. Use the Hide search option to search the case within the case list. By default, it shows search button. |
| Show filters | Option to show or hide filter button on the header. Use this option to customize the display of cases according to pre-defined filters. By default, it hides filter button. |
| Hide refresh | Option to show or hide the refresh button the header. Use this option to refresh the case list. By default, it shows a refresh button. |
| Hide last refreshed text | Option to show or hide a message on the header. Use this option to indicate when the last refresh occurred. By default, it shows last refreshed text. |
| Table | Table from which the cases or tasks shown on the Case list component. By default, this field is set to the Case [sn_customerservice_case] table. Note: Case list component can show the records from any extended table
of case or task table. |
| Query | Query to filter the case records. The default query shows all cases. Note: If no query is provided, all case records are displayed in the Case list component. For more information, see Generate an encoded query string through a filter. |
| View | Display style for the cases inside the component, chosen from the predefined views. |
| Columns |
Display columns from the case or task table. Select Add to add new columns to the case list table. Select (
Note:
|
| Disable column resizing | Option to adjust the column width. By default, column resizing is enabled. |
| Records per page | Option to show or hide the number of records that appear by default on the case list. The default value is 20. |
| Hide errors | Option to show or hide error messages for the end user on the third-party website. By default, it shows errors. |
| Hide when empty | Option to show or hide the component when there are no cases to display. By default, it shows empty list when there are no cases. Note: This property is honored when the component initially loads. If no matching
records are found for searches or query filters afterward, an empty state is shown regardless of the attribute's value. |