GeneXus For SAP Systems KPI Worklist Floorplan

Official Content

The KPI Worklist Floorplan is a set of layouts that allows you to query and view data and it also calculates a KPI which you can define. 

This article describes you how to apply it to a Transaction or Web Panel to obtain a page like the following:

KPIWorklistWebView_png

In the shown image, the KPI calculated corresponds to the average population of the country.

You can see this sample running here. It has been created using this Knowledge Base (KB).

Note: The design guideline of this floorplan is at SAP's documentation.

How to apply the KPI Worklist Floorplan

Look at the Patterns tab of the Country Transaction. If you have never applied the Fiori for Web pattern in your Knowledge Base yet, read here. Otherwise, being positioned on the Fiori for Web Pattern tab, check the Apply this pattern on save checkbox and select the offered link to choose a floorplan:

GeneXusForSAPSystems_ListAndReportPattern_Image83

Then, select the KPI Worklist option from the list given by GeneXus

SelectKPIWorklistFloorplan_png

This floorplan can be applied to a Transaction object or a Web Panel object.

How to set the KPI

By default, the KPI is an unset variable. In order to set it, you have to open the Object KPI Worklist Web Panel. 

OpenCountryKPIWebPanel_png

Note: Temporarily the Web Panel's name is not WebPanelNameKPIWorklist but it is WebPanelNameListReport.

Once there, go to the Events section.

KPIWebPanelEventsSection_png

You can program the KPI behavior on the Refresh Event.

If you want to have a dynamic KPI (the calculation changes when a filter is applied) you can solve it by using the Data Selector object generated by GeneXus:

CountryDS_png

Note: Temporarily the Data Selector's name is not YourObjectNameSimpleWorklistDS but it is YourObjectNameListReportDS.

Remeber to do it outside the code generated by GeneXus (to avoid being overwritten by GeneXus).

KPIBehaviorWebPanel_png

 

How to customize it

The following section explains how to customize your KPI Worklist.

Add/Modify/Delete actions

You can add, modify or delete actions being positioned on the KPI Worklist tab, but if you want to do this, you may prefer the GeneXus For SAP Systems List Report Floorplan

To add actions you have to right click the GridActions node and then, select from the contextual menu Add / UserAction. The action will be added outside the grid (in the section where is located the button to insert).

AddUserActionKPIWorklist_png

To modify these actions you can right click on the action node and select the 'Go to Event' option. Then, you can modify the event code, but remember to do it outside the code generated by GeneXus (to avoid being overwritten by GeneXus).

If you want to add an action inside the grid for every line, you have to right-click on the Grid node and select in the contextual menu Add / UserAction:

AddGridUserActionKPIWorklist_png

In order to modify these actions, you have to follow the next steps:

1. Right-click on the KPI Worklist tab and select Open YourObjectNameKPIWorklist.

OpenCountryKPIWebPanel_2018419112748_1_png

2. Being in the KPI Worklist Web Panel, go to the Events Section.

KPIWebPanelEventsSection_2018419112754_1_png

3. Once there, you only have to create the Click event for your customized actions.

ClickEventKPIWorklistWebPanel_png

 

Manage filters

You can manage the filters being positioned on the KPI Worklist tab.

To add filters you have to right-click on the Table Filter node and then select in the contextual menu Add and select the kind of filter you want.

AddFilterKPIWorklist_201841910562_1_png

For more information see GeneXus For SAP Filters.

 

Customize the information to be shown on the list.

You can manage the attributes to show being positioned on the KPI Worklist tab.

To prevent attributes from being shown on the KPI worklist you have to right-click the attribute and select Delete. Don't worry it will be deleted from the Web Panel, not from the Transaction.

DeleteAttrKPIWorklist_png

To add attributes to be shown in the list, you have to right-click the Grid node, then select Add / GridAttribute:

AddAttrKPIWorklist_png

Then, GeneXus will display a list of attributes for you to choose which ones you want to add. 

AttrListKPIWorklist_png

 

See Also

 

Was this page helpful?
What Is This?
Your feedback about this content is important. Let us know what you think.