Personalizing a web widget

Depending on the settings applied by your administrator, you can personalize a web widget's title, home page, help page, and layout. Administrators can set shared settings to provide a common experience for users of a web widget.

Before you begin

The dashboard containing the web widget must be in edit mode before you can customize it. When you create a new dashboard, it is automatically in edit mode. For an existing dashboard, to enter edit mode, click and select Edit Page.

1. In the title bar, depending on your access privileges, click the icon and select Personalize.

   A settings page is displayed, where depending on shared settings applied by your administrator, you can personalize the web widget's title, home page, help page, and layout.

2. Optional: In the Widget title field provide a brief descriptive name. When selecting a title, consider the purpose of the web widget, its home page, and that the title is used in the navigation pane to access the widget.
3. Optional: In the Home page field provide a valid web address. This the web address of the page that displays by default when a user accesses the widget from the navigation pane.
   Note:

   The web widget supports substitution variables in the Home page URL field. That is, you can specify a URL that includes variables that are populated when the web widget receives an event that provides values for the specified variables. Global variables are also permissible, for example, TIP_THEME. If an appropriate value is not provided for a variable, then the URL is resolved without that element of the URL. The following examples provide details on how variables are substituted:

   • Example 1 - Global variable substitution - value exists for the specified global variable
     Specified URL in the Home page URL field:	/apm/index.html?theme=%%TIP_THEME%%
     Resolved URL with the IBM OneUI theme active:	/apm/index.html?theme=OneUI
     Resolved URL with the dark console theme active:	/apm/index.html?theme=TIPDark

   • Example 2 - Global variable substitution - value does not exist for the specified global variable
     Specified URL in the Home page URL field:	/apm/index.html?time=%%time%%
     Resolved URL: Note: In this example, the specified global variable (%time%) does not exist so the resolved URL does not include a value for the variable.	/apm/index.html?time=

   • Example 3 - Event driven variable substitution, where the event includes appropriate values for the specified variables
     Specified URL in the Home page URL field that includes the following variables: %%start%% and %%system_name%%	/apm?start=%%start%%&system_name=%%system_name%%
     Resolved URL where the event data includes the following information: { name: "NodeClickedOn", payload: { start: 0, system_name: "HULK:Primary:NT" }	/apm?start=0&system_name=HULK:Primary:NT

   • Example 4 - Variable substitution that includes an event value and a global value
     Specified URL: Variables: %%TIP_THEME%% (which is an appropriate global variable) and %%start%%	/apm?theme=%%TIP_THEME%%&start=%%start%%
     Resolved URL where the event data includes the following information, assuming that IBM One UI theme is active: { name: "NodeClickedOn", payload: { start: 0}}	/apm?theme=OneUI&start=0

   • Example 5 - Event driven variable substitution, where the received event includes a displayURL element
     Specified URL in the Home page URL field:	Any URL
     Resolved URL:	The URL specified in the displayURL element replaces the specified the Home page URL field. If the new URL includes variables, they are resolved as per the examples provided here.

4. Optional: In the Help page field, provide a relative or absolute URL to a custom help page HTML topic to replace the default help topic that is associated with the web widget.
5. Optional: Check the Show a browser control toolbar to include a web navigation toolbar, that is, standard web navigation buttons and web address entry field.
6. Click Save to commit your changes, or Restore Default Settings to reset the form.