The Embedded Analytics Platform (EAP) uses two components to display analytics data in the Web UI: the Embedded Analytics Platform Widget and the Embedded Analytics Platform Screen. This topic details the configuration of the Embedded Analytics Platform Widget.
The Embedded Analytics Platform Widget is used to provide snapshots of analytics information made available to users as widgets on the Web UI homepage.
The following screenshot shows a Web UI homepage with two sample Embedded Analytic Platform Widgets at the bottom.
Numerous styles of EAP widgets are available, including:
- Pie Chart Widget
- Column Chart Widget
- Bar Chart Widget
- Line Chart Widget
- Area Chart
- Indicator Widget
- Scatter Chart Widget
For a full list and details of widget styles, refer to: https://documentation.sisense.com/latest/creating-dashboards/adding-widgets-to-dash/widget-designer.htm#gsc.tab=0
Note: All add-ons should be tested for adverse effects in the UI prior to release in production.
Configuring the EAP Widget
The EAP Widget provides users with a quick and simple view of specified analytics data on the Web UI's homepage. The appearance and behavior of the analytics widget is, in large part, determined by how the widget is configured in the embedded external analytics tool itself. These widgets can vary greatly based on the specific business need. Analytics homepage widgets can be single- or double-width, and multiple homepage widgets can be configured from one or more analytics dashboards.
Adding the EAP Widget
The EAP Widget must be added to the homepage prior to configuration. Details on how to do this can be found in the Adding Widgets to a Homepage topic in the Web User Interfaces documentation here.
After it has been added either close the designer and configure the screen at a later time, or continue on with the Embedded Analytics Platform Widget Properties configuration.
Setting up the EAP Widget
The EAP Widget is very similar to the EAP Screen except it is designed to present more narrowly focused views of data than the EAP screen. The Properties window for the EAP Widget in the Web UI designer is shown below. The parameters that appear in the screenshot are described in detail directly beneath the screenshot.
The EAP screen and EAP widget are configured in almost identical ways, with some minor exceptions. The configuration steps described below can be applied to configuring either the widget or the screen, except where expressly noted.
- Title: Content added to this field appears at the top of the widget, as shown below:
- URL: Enter the relevant EAP analytics server URL; for example, https://YourEAPServer/app/main#/dashboards/dashboardid/widgets/widgetid. The URL could point to a dashboard, a widget, or a view such as an admin screen. For more information and examples on how to identify / copy these URLs, see the Embedded Analytics Platform - Selecting URLs topic here.
- Double Width: If this parameter is checked, the widget is doubled in width from the standard widget's single-width size. A double-width widget is pictured below.
Filter Configuration Options: JAQL Parameters and Filter String
This section contains two fields. The top field (4) is for JAQL (JSON Query Language) filter parameters. The bottom field (7) is where the JAQL Filter String is entered. Use these options to configure the filters that display in the Right Filter Panel, which is addressed in more detail later in this topic.
- Filter parameters (field not individually labeled) – In this field, enter the relevant filter parameters (if any), e.g., ‘Attribute Value.’ Each selected parameter will be assigned a placeholder string that will be replaced with a context-specific value to be referenced in the JAQL query string. These placeholders also contain an embedded integer that identifies the sequence in which the parameter will appear in the JAQL filter string, e.g., #%0%# will appear first, #%1%# will appear second, etc. Moving a parameter up or down with the 'up' or 'down' button will automatically renumber the placeholder.
Note: It is recommended to generate the placeholders for the filter parameters before entering the JAQL filter string in the bottom field.
- The dropdown menu below the filter parameters field allows the selection of various options to create the JAQL filter parameters. The available parameters are as follows:
- Attribute Value: Returns, or filters the dashboard view for, a STEP attribute value
- Context Id: Returns the current context ID
- Locale: Returns the selected locale, which is used for the Web UI session
- Node Id: Returns the STEP ID of the current object (valid for EAP Screen only)
- Today: Returns the current date
- User Email: Returns the email address of the logged-in user (if specified).
- User Id: Returns the user ID of the logged-in user.
- User Name: Returns the name of the logged-in user.
- The field directly to the right of the dropdown menu will display when either 'Attribute Value' or 'Today' is selected. If Attribute Value is selected, the ellipsis button displays (
). Clicking this button opens the 'Select Node(s)' window, where the relevant attribute is chosen. If Today is selected, a 'Date Format' window displays in which the chosen date format is entered, e.g., yyyy-MM-dd. The date format uses the rules for SimpleDateFormat in Java.
- JAQL filter string (field not individually labeled) – In this field, enter the desired JAQL filter string. It is recommended that the string contain placeholders that correspond with the numbered dynamic values selected for the JAQL filter parameters, e.g., #%0%#. #%1%#, etc.
For more information on JAQL filter strings, see the Embedded Analytics Platform - Sample JAQL Filter topic in this guide (here). Also refer to: https://documentation.sisense.com/latest/creating-dashboards/filtering-dashboards-and-widgets/designer-filters/create-dashboard-filter.htm#gsc.tab=0