Introduction
The Dynamic List Report Element Plugin is used to generate dynamic list without creating multiple reports, it includes
- Dynamic List Report Element - Use the datalist ID from datalist action by using #reportBuilder.datalistId# to generate dynamic list in report
- Dynamic List Download Report Datalist Action - Button in datalist to pass datalist ID to report element
Plugin Info
Plugin Available in the Bundle:
Dynamic List Report Element
- Dynamic List Download Report Datalist Action
This plugin bundle is compatible with Joget DX 8.
Expected Outcome
Able to generate dynamic list using one configured report template.
Figure 1: Report Template
Figure 2: PDF Output
Getting Started
Steps
Where to get the plugin
Refer to Source Code and Plugin Download.
How to install and use the plugin
1. You can choose to import the demo app or create the app from scratch. For demo app, go to Joget Home or All Apps and click on Import App to import the downloaded demo app (refer to another KB - Import Joget App for more details).
2. To create the app from scratch, now we should create a report using Report Builder. If you do not have the option, please import the Report Builder by downloading from marketplace.
3. Add your desired header and configurations. Drag the Dynamic List Report Element into the content area. Configure the List value to be #reportParam.datalistId#, this value will be passed from the datalist action element to be configured later in the datalist. For more information on the plugin configuration, refer to Configure Dynamic List Report Element.
Figure 3: Report builder Dynamic List report element
4. Now let us create two datalist. You can use any source of data, for this example we will use the Platform Entity data, using the User entity for first datalist, and App Definition for second datalist. The screenshots will only show the first datalist configuration, the second datalist should be similar steps.
Figure 4: Datalist 1 source of data
Figure 5: Datalist 1 source of data platform entity
Figure 6: Datalist 1 source of data platform entity design
5. Drag the Dynamic List Download Report Datalist Action into the datalist. For more details on configuring the plugin, refer to Configure Dynamic List Download Report Datalist Action.
Figure 7: Datalist 1 Dynamic List Download Report Datalist Action
Steps to run the plugin
1. Run the UI. Go to List 1. Click on "Dynamic List Download Report" button without selecting any of the data. A PDF will be generated. For List 2, repeat the same steps and List 2 will be generated in the PDF with the configured header using Report builder.
Figure 8: UI List 1 Dynamic List Download Report button
Figure 9: PDF Output of List 1
Dynamic List Report Element Properties
Configure Dynamic List Report Element
Figure 10: Plugin Configurations for Dynamic List Report Element
Name | Description |
|---|---|
ID | ID of report element |
| Selector Class | The class for current element. |
| List * | Dynamic list to load. Use #reportParam.datalistId# paired with the Dynamic List Download Report Datalist Action to retrieve the dynamic list ID. |
| Header Background Color | The color of the list header background. Choose the color through the color picker. |
| Header Text Color | The color of the list header text. Choose the color through the color picker. |
Configure Dynamic List Download Report Datalist Action
Figure 11: Plugin Configurations for Dynamic List Download Report Datalist Action
Name | Description |
|---|---|
Label | Button label. |
| Report | Report to be generated. |
| Report Parameters | Extra parameters to pass to the report. In the report, use #reportParam.<ParamName># to access the value. Can only be used if a record is selected when clicking on download button. |
| Confirmation Message | Confirmation message before clicking on the button. Can only be used if a record is selected when clicking on download button. |
| Rename File | Option to rename the generated file.
|
| Filename | New name for generated file. Default name is recordID.pdf. |
Source Code and Plugin Download
- You can find the latest release at https://github.com/jogetoss/dynamic-list-report-element/releases.
- Upload the plugin to your Joget by navigating to Settings > Manage Plugins > Upload Plugin as admin.