Widget Library

Widgets must first be defined on the Widget Library (WIDLIB) before they can be used on a home page. The Widget Library page is separated into two sections: General Information and a table of Widget Parameters at the bottom. (Note: Widgets added to other pages in Advantage cannot be refreshed individually. Instead, you must reload the page to refresh all widgets on the page.)

Field Name	Description
ID	This is a unique identification automatically assigned by Advantage when a widget is added to the Widget Library. IDs less than 500000 are reserved for delivered and sample widgets. Numbering is controlled by a Unique Numbering record of ADV_WIDGET_LIBRARY.
Name	Indicates the name of the widget that appears online for user reference.
Type	Type Indicates the type of widget for editing and system processing. Valid values are: Application Page – Requires the selection of a value in the Page Code field to connect to a widget page (for example, ADMWL for the Worklist of ADMN). Audio – Requires a value in the Component URL that connects the widget to the external audio file. Power BI Analytic – Requires the selection of a value in the Report Name field to connect to the analytic. Image – Requires a value in the Component ID to connect to an image. Summary Number – Requires the selection of a value in the Page Code field to connect to the summary number page. Video – Requires a value in the Component URL that connects the widget to the external video file. Visualization – Requires the selection of a value in the Page Code field to connect to the visualization page. Power BI Dashboard – Requires the selection of a value in the Report Name field in the General Information section to connect to the dashboard. Power BI Paginated Report – Requires the selection of a value in the Report Name field to connect to the paginated report.
Description	An optional description of the widget for informational purposes to expand upon what is in the Name field.
Mobile	Indicates whether the widget is to be used on a mobile or non-mobile home page. If selected, the widget can only be used on a mobile home page. If not selected, the widget can only be used on non-mobile home pages.
Height	Each widget requires a defined height in pixels (for example, 600px). On a Mobile widget, Height is not editable and defaults to 180 px.
Width	Each widget requires a defined width in columns. Valid values are 1 to 8. On a Mobile widget, Width is not editable and defaults to 1 column.
Application Name	An inferred field indicating the application associated with the selection made for Page Code for system processing purposes.
Page Code	The Advantage page to connect an application page, summary number, or visualization page to the Advantage page that is the widget.
Component ID	If the Type is Image, then this field indicates the image file name. The image has to be placed under RTFiles at this folder admbase/standard/images. The value in the Component ID field should be: ‘{{image/imagefilename.png}}’. If the image is new, then you must run the Key Value Metadata Generator process to add the image to the image.pdb file. The system must be bounced after pdb deployment. Then the image can be associated with a home page.
Component URL	The URL to connect an audio or video widget to what is retrieved for the home page user.
Report Name	The Power BI Paginated Report, Power BI Dashboard, or Power BI Analytics name that will be retrieved from the Advantage Insight Server. Reports can be searched by the Power BI workspace name too.
Workspace Name	This field is visible only when the Type selected is Power BI Analytic, Power BI Dashboard, or Power BI Paginated Report. When a record is selected from the Report Name pick, the Workspace Name field is populated from the selected record in pick.

Widget Parameters holds the additional attributes required for a widget to load. For example, Row level security (RLS) for analytics required an additional parameter to support the analytics to load (RLSRole = Department Security).

When creating a new record on the Widget Library page, the Add Record action in the Widget Parameters section is enabled after successfully saving information in the General Information section.

Field Name	Description
Parameter Name	Indicates the parameter necessary for the widget. You can only select from valid widget parameters established on the Widget Parameters page for the selected Widget Type (for example, RLSRole).
Parameter Value	Indicates the parameter value for the parameter. For example, if Parameter Name is RLSRole, valid values for delivered Insight Models (Datasets) are Department Security, Department Unit Security, and No Security. For PB reports, use PB Security or No Security.
Description	Description of the parameter that is intended to capture the intended use or content of the parameter.
Report Name	If the Type field is set to Power BI Dashboard, then the Report Name field is available in the Widget Parameter grid. This field provides a pick list that lists all reports that belong to the Power BI Dashboard.

Power BI Analytic, Power BI Dashboard, and Power BI Paginated reports can be validated using the Validate Power BI Embedding button while creating/updating a widget on the WIDLIB page.

The validation result will appear in the form of a grid in a pop-up window. It will display the outcome of each step of the Power BI report validation process. This helps identify issues with the setup while creating the Power BI widget. If there are no errors on the validation window then a “Report Validation Successful” message is displayed verifying that setup is correct and the Power BI report will load properly.

Note: For multi-dataset Power BI Analytic or Power BI Paginated Report, the RLS role configured would be passed to all datasets. For example, a report uses two datasets (General Accounting and Accounts Receivable Transaction) and the Department Security role is configured as a widget parameter, then the same role would be passed to both and data would be retrieved accordingly.