Tab widget mapping form

  • Release version: Xanadu
  • Updated August 1, 2024
  • 3 minutes to read
    • Summarize
    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 Tab widget mapping form

    The Tab widget mapping form in ServiceNow enables you to display and control the visibility of widgets on specific tabs, particularly within Employee Profile pages. This form helps you organize widgets by associating them with tabs, defining their display order, and controlling which users can access them based on roles, groups, or user criteria.

    Show full answer Show less

    Key Features

    • Name: Defines the widget-mapping record name, used as the widget title in the UI.
    • Application: Select the application context, such as Employee Center Pro or Employee Center Pro Kiosk, to which the tab belongs.
    • Active: Option to activate or deactivate the widget on the tab.
    • Order: Controls the sequence in which widgets appear on the tab.
    • Tab: Associates the widget with a unique tab name.
    • Accessible by: Specifies user visibility options including Employee only, Manager only, Everyone, and combinations thereof.
    • User criteria: Allows fine-tuned control over widget visibility by including or excluding specific users, groups, or roles. Note that "Not Available For" groups override "Available For" groups, and lack of criteria defaults to visibility for all users.
    • Allow employee to control visibility: When applicable, this setting lets employees edit widget visibility on their profiles via the embedded Public Profile Visibility widget. Changes are stored in user preferences and override admin settings.
    • Widget: Selects the widget displayed on the tab. Visibility must be set true in the server script (data.isVisible = true) for it to show.
    • Widget parameters: Supports passing comma-separated parameters with default values to customize widget behavior. For example, enabling email or SMS notifications or defining default calendar views.

    Practical Implications for ServiceNow Customers

    • Use this form to tailor the Employee Profile experience by strategically placing and managing widgets on tabs.
    • Control access to sensitive or role-specific information through user criteria and visibility settings, enhancing security and usability.
    • Enable employees to manage their own profile visibility settings selectively, improving user empowerment and data privacy.
    • Optimize tab performance by limiting the number of widgets to seven or fewer, ensuring faster load times.
    • Customize widget behavior with parameters, such as enabling communication features or adjusting calendar views.

    Additional Notes

    Embedding the Public Profile Visibility widget requires using the sp-widget directive with the appropriate widget options. Be cautious when using user criteria as complex configurations may increase profile page load times. The form and its configurations are essential for managing widget visibility and user experience within Employee Center applications.

    You can use the tab widget mapping form to display widgets on a tab and control their visibility.

    Table 1. Tab widget mapping form
    Field Description
    Name Name of the widget-mapping record that is available in the widgetTitle variable of the widget options object. Use this variable value as the widget title.
    Application Application of the tab. For example, you can select one of the applications such as Employee Center Pro or Employee Center Pro Kiosk.
    Active Option to activate the widget in the tab.
    Order Order number in which you want the widget to appear on the tab.
    Tab Unique name of the tab that you want to associate with.
    Accessible by Users who can view the widgets.
    • Employee only
    • Manager only
    • Employee and manager
    • Everyone
    • Manager and Other Managers
    • Employee, Manager, and Other Managers
    • User criteria: Provide the access only to specific users, groups, and roles with the user criteria. The widget is visible to the users based on the following:
      • Available For: User group for whom the widget is visible. Define and select the user group based on your business needs.
      • Not Available For: User group for whom the widget isn’t visible. Define and select the user group based on your business needs.
      Values that are defined in the Not Available For group take precedence over the values defined in the Available For group. If both aren't defined, the widget is visible to all users. For more information on widget visibility based on user criteria, see User Criteria output.
      Note:
      Use the user criteria cautiously because the profile page load time can take longer based on your criteria.
    Based on your selection, the profile visibility is either locked or made available for editing by the employee.
    Allow employee to control visibility This field appears only when you select one of the Employee only, Employee and manager, or Everyone options.
    Note:
    To view and change the visibility setting, embed the Public Profile Visibility widget inside the configured widget.
    When you select the value as true, employees can see the edit option used to modify the visibility settings. The modified visibility setting (employee_profile.widget_visibility) is stored in the user preference table.
    Note:
    Settings configured in the Allow employee to control visibility field take precedence over the settings configured in the Accessible by field to display the information. Employees can change the admin configuration and determine how much of the profile information is visible to the public.

    Here’s a sample code for invoking the Public Profile Visibility widget. data.publicProfileWidget = $sp.getWidget("public_profile_visibility", { tabWidgetMappingId: options.tabWidgetMappingId ? options.tabWidgetMappingId : "", isUserSelectionEnabled: options.isUserSelectionEnabled ? options.isUserSelectionEnabled : "", widgetTitle: options.widgetTitle ? options.widgetTitle : “” });

    To embed it in your widget use the sp-widget directive. For example, <sp-widget widget="data.publicProfileWidget"></sp-widget>

    This field value is available in the isUserSelectionEnabled variable of the widget options object.
    Widget Widget to display on the tab.
    Note:
    Only when you map a widget to the tab, the information displays inside the tab on the employee profile page.

    When the widget is visible on the UI, set the isVisible variable value to true in the server script data object to indicate the widget visibility. For example, data.isVisible = true.

    For optimal tab load time, use a max of seven associated widgets, which can take 250 ms or equivalent.

    Note:
    If the widget type is Employee Profile Overview, you can select the set of sections to be displayed under this widget.
    Widget parameters Comma-separated list of widget parameters auto-populated with default values.

    For the Employee Schedule widget, to send Email or SMS, specify the widget parameters enable_send_email and enable_send_sms values to true. For more information, see Configure the mail and SMS send to self.

    For default calendar view, specify default_calendar_view value to day or week or month.