Introduction

The Merge PDF Datalist Action plugin is used to merge all uploaded PDF in file upload form element when user clicks on merge button in datalist.

Plugin Information

Plugins Available in the Bundle:

  1. Merge PDF Datalist Action

This plugin bundle is compatible with Joget DX 8.

Expected Outcome

The merge pdf datalist action is able to merge PDFs using button in datalist.

Figure 1: Merge PDF Button in Datalist

Getting Started

Steps

1. You can obtain the jar file by the latest release at https://github.com/jogetoss/merge-pdf-datalist-action/releases.

2. Upload the plugin jar file in Joget by going to Settings → Manage Plugins.

3. You can choose to import the demo app or create the app from scratch.

Steps for importing demo app

1. Download the demo app from https://github.com/jogetoss/merge-pdf-datalist-action (.jwa file).

2. Go to Joget Home or All Apps and click on Import App to import the downloaded demo app.

Steps for creating app from scratch

1. Create a form with a file upload field to upload PDF file.

Figure 2: Add File Upload fields in form


2. On right up corner, click on Generate App > Generate CRUD.

Figure 3: Generate CRUD for form


3. Go to the List Builder. Drag the Merge PDF Datalist Action plugin into the datalist. By dragging to column, it will download each record row individually, by dragging to the bottom it will download based on selected records. Refer to Merge PDF Datalist Action Properties for plugin configurations.

Figure 4: Drag Merge PDF Datalist Action Buttons into datalist


4. Publish and run the UI. Go to the CRUD and click New. Add a new record and upload multiple PDF files.

Figure 5: Upload some PDF files


5. Add another record to showcase downloading the zip file of all PDFs when all records are selected.

Figure 6: Add another record to upload another PDF file in another record


6. Click on Merge PDF for record1.

Figure 7: Click Merge PDF Button in Datalist


7. The two pdf on the left is the original pdf, and the pdf on the right is the merged pdf that we just downloaded.

Figure 8: Download Merged PDF


8. Now, click on the Download all merged PDF in Zip, this will download all the merged PDFs in each record as a zip file

Figure 9: Click Download all merged PDF in Zip Button in Datalist


9. The ZIP file is downloaded. Extract the file and you can get the merged PDFs from each record.

Figure 10: Download all merged PDF in zip file

Merge PDF Datalist Action Properties

Configure Merge PDF Datalist Action

Figure 11: Merge PDF Datalist Action Plugin Configurations

Name

Description

Label 

Datalist button label.

Form *

Form that contains the file upload field.

Field *

File Upload field that the PDF is uploaded to.

Record Id Column 

If not set, default value will be the primary key of the configured binder.

Confirmation Message

Confirmation message before performing action, for example "Are you sure?".

File Name

If not set, default file name will be based on record id field value.

Zip File Name

The file name of the zip file. If not set, default file name will be the button label.

Source Code and Plugin Download

You can obtain the jar file by the latest release at https://github.com/jogetoss/merge-pdf-datalist-action/releases.

Demo App Download

Download the demo app from https://github.com/jogetoss/merge-pdf-datalist-action (.jwa file).


  • No labels