Dynamic List Report Element Plugin

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 #reportParam.datalistId# to generate dynamic list in report.
• Dynamic List Download Report Datalist Action - Button in datalist to pass datalist ID to report element.

Plugin information

Plugin Available in the Bundle:

1. Dynamic List Report Element.
2. Dynamic List Download Report Datalist Action.

This plugin bundle is compatible with Joget DX 8 / 9 and onwards.

Getting Started

Where to get the plugin

You can download the plugin's latest release from JogetOSS.

How to install

1. Download the plugin JAR file from the release page.
2. Go to Settings > Manage Plugins > Upload Plugin to upload the JAR file to Joget.
3. Create a report using Report Builder. If the Report Builder plugin is unavailable, download and install the plugin from the Marketplace.
4. In the Report Builder, add your desired Header and configure its Properties. Drag and drop 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 Properties.
5. Next, let us create two datalist. You can use any source of data, for this example we will use the 'Platform Entity data', 'User' entity for first datalist and 'App Definition' for second datalist. 
   • Create a new Datalist with a desired Name and ID.
   • In the List Builder click Data and choose Select Source of Data as 'Platform Entity'.
   • In Configure Platform Entity select 'User' and click Design to view the Datalist design.
   • Drag the Dynamic List Download Report Datalist Action into the datalist and choose Report as report we previously created. For more details on configuring the plugin, refer to Configure Dynamic List Download Report Datalist Action.
   • Repeat the steps to create a second datalist with 'App Definition' as its Entity.

How to use it

1. In the runtime, navigate to List 1. Click on Dynamic List Download Report button without selecting any of the data. A PDF file will be generated. For List 2, repeat the same steps and List 2 will be generated in the PDF file with the configured header using Report builder.

Configure Dynamic List Report Element Properties

Fields to configure:

• 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

Expected outcome

You able to generate dynamic list using one configured report template.

Download Sample App