Self Service Portal System Widgets
Last updated
Last updated
The "Global Search Widget - Properties" section outlines various attributes related to the global search widget. Each widget is assigned a unique Widget ID, such as "global-search," which identifies and differentiates the widget within a system. Widget filters use escaped characters and are URL encoded to ensure proper interpretation and functionality during web requests.
URL encoding is a mechanism used to convert characters into a format that can be safely transmitted over the Internet. This encoding process replaces unsafe ASCII characters with a "%" followed by two hexadecimal digits. The encoding is necessary because URLs can only be sent over the Internet using the ASCII character set, and not all characters are safe to include. Commonly encoded characters include spaces, which are represented as %20, and special symbols such as @, &, +, etc., which have specific purposes in a URL structure. URL encoding ensures these characters are correctly parsed by web browsers and servers, maintaining the integrity of data transmitted via URLs.
In URLs, certain characters are reserved for specific functions, such as slashes for paths and question marks for queries. Escaped characters are used to encode these reserved characters, making them safe for use within URLs. This involves replacing characters with a percentile symbol followed by two hexadecimal digits. For example, a space is represented as %20. This ensures that the URL is correctly interpreted by web
The Widget is a versatile component designed to fit seamlessly into various parts of an application. Think of it as a helper tool that lets you display and retrieve information based on what a user is interested in. It's like having a search assistant that adapts to what you're looking for.
By default, the Global Search widget is set up to find a variety of things, such as Calls, Requests, Service Actions, Service Bundles, and Knowledge Articles. However, you might decide that you only want it to search for particular items, like Service Actions and Knowledge Articles. To do this, you'd need to adjust the settings of the Global Search widget to narrow down the search options.
It's important to note that making these changes will impact everyone who uses the Self-Service Portal. So, before you proceed, consider how it affects the overall user experience for all users.
If you want to tailor the Global Search widget so that it better serves the needs of your users or organization, here’s a straightforward guide to help you through the process:
Access the Widget Settings: Begin by navigating to the settings area of the widget within your application. This is where you can make changes to how the widget operates.
Choose What to Search For: Decide which items you want the widget to focus on when performing a search. You can include or exclude items like Service Actions, Knowledge Articles, and others, depending on what’s most relevant.
Save Your Changes: Once you’ve made your selections, ensure you save your changes. This step is crucial for applying your new settings and ensuring the widget behaves as expected going forward.
Test the Widget: After making changes, it’s a good idea to test the widget. Make sure it’s working as intended and that the search results align with your new settings.
Keep in mind that these adjustments affect every user of the portal, so communicate any changes to your users to manage expectations and provide guidance if needed. This way, everyone benefits from a customized search experience that aligns with the organization’s goals.
The Widget is a reusable component designed to be integrated into various parts of an application. It serves as a container for dynamic content retrieval and display based on user interaction with search functionalities or other input mechanisms.
By default, the Global Search widget searches for Call, Request, Service Action, Service Bundle, and Knowledge. You might want to only allow Global search to look for Service Actions and Knowledge, for example, and to do that, you will need to alter the properties of the Global Search Widget.
Caution - this will impact the entire Self-Service Portal for all users.
To configure the Global Search Widget, several properties or props need to be set to ensure that it operates effectively. The widget is already present on the Self-Service Portal Home screen, so you will not need to add it, but you can change the way it behaves by altering its properties.
Configuration typically involves defining the following parameters:
Entities: Specify a list of entity identifiers that the widget will reference or interact with. For example, {"entities":"13,25,33"} might imply that the widget should fetch or manipulate data related to specific entities such as Knowledge, Service Action, etc.
Search Term: Use the term prop to define a default or placeholder search query, like "iphone".
Limit: Set a limit prop to control the number of results or elements the widget should process or display, e.g., limit":"3".
Ensure all entity IDs used in the entities prop are valid and correctly mapped to their descriptions (e.g., 13 for Knowledge).
Pay attention to the search term to ensure it meets use-case requirements, providing relevant and focused results.
Configure the limit based on expected data volume and user interface constraints to enhance performance and usability.
When integrating and using the widget, ensure proper handling and interpretation of the properties to suit specific application needs, while maintaining data integrity and consistent user experiences across various sections of the app. Proper URL encoding or handling of special characters might be necessary if the widget interfaces with web APIs.
By meticulously setting these properties, the React App Widget can be a powerful tool in delivering interactive and responsive user functionality.
Widget ID: global-search
Widget Props: {"entities":"13,25,33","term":"iphone","limit":"3"}
entities: 6,4,25,33,13
6 = Call 4 = Request 25 = Service Action 33 = Service Bundle 13 = Knowledge
term: sets a default value in the search box
limit: limits the maximum number of results returned