The Kepler - Merging Documents plugin is very simple to use.
After successful installation, open an issue and you will see the plugin panel on the right.
We apply a role-based limitation to the panel display in Kepler - Merging Documents. The allowed roles are:
As User Admin,
Using Global Permission,
Using Project Permission.
For more information, please see the documentation Administrator's Guide for Cloud.
So how to proceed ?
Upload Files to Jira Attachments
Navigate to the Jira issue where you want to merge attachments.
Use the Jira interface to upload files.
After uploading, the files will appear in the issue's attachment section.
Access the Merging Documents Panel
Locate and open the Kepler - Merging Documents panel within the Jira view issue.
Click the refresh button to display all Microsoft Office and PDF attachments associated with the issue in the panel.
The panel presents attachments in a table where each row represents a file. The columns in the table are as follows :
Select / Select All: A checkbox column with two functions:
Select All (at the top): Allows you to select all files in the table for inclusion in the merged PDF.
Select (next to each file): Lets you individually select files to include in the merged PDF.
Filename: The name of the file.
Extension: The file extension (e.g., 'doc', 'rtf', 'docx', 'dot', 'docm', 'dotx', 'xls', 'xlsx', 'xlsm', 'xlt', 'xltx', 'xltm', 'csv', 'pdf').
Order Manipulation: Controls for adjusting the order of the files. This includes :
Move to Top: Move the selected file to the top of the list. Defined by icon .
Move Up: Move the selected file up one position in the list. Defined by icon .
Move Down: Move the selected file down one position in the list. Defined by icon .
Move to Bottom: Move the selected file to the bottom of the list. Defined by icon .
Or you can order your attachments using the Order list , the order list provides sorting options to arrange the table rows by :
Size: Sort files by their size.
Creation Date: Arrange files by their creation date.
Alphabetically: Sort files in alphabetical order based on filenames.
The list of authorized extensions is in expansion: 'doc', 'rtf', 'docx', 'dot', 'docm', 'dotx', 'xls', 'xlsx', 'xlsm', 'xlt', 'xltx', 'xltm', 'csv', 'pdf'
Only supported extensions will be visible in the panel.
Merge and export PDF to Jira attachments
Click the export button to combine the selected files into a single PDF document. Defined by icon ,
after clicking the Merge button, you’ll be prompted to set a prefix for the output filename.
You can refresh the list by click in the refresh icon defined by .
The merged PDF will be automatically attached to the Jira issue.
You can then access and download it as needed.
Also, the merged file is automatically added to the panel.
The merge operation may take some time, depending on the size of the files and their structure.
If a prefix is added by the user, the file will be named with the prefix followed by the timestamp.
Otherwise, the file will be named with the issue key followed by the timestamp and "-MergedFile".
For example:
With a prefix: If the user sets the prefix "Report," the resulting file will be named Report-2024-08-22-14_20_00.
Without a prefix: If the issue key is PRTP-1, the resulting file will be named PRTP-1-2024-08-22-14_20_00-MergedFile.pdf.