Skip to main content
Version: 1.0.0

How to Merge PDF Files

Merging PDF documents is done directly from the Jira issue view. The complete process is detailed below.

1. Accessing the Merge Tool​

To get started, navigate to the issue containing the .pdf files you want to merge.

  1. Click the More menu (the button with three dots ...) located at the top of the issue view.
  2. Select the Merge PDFs option from the dropdown menu.

Access Merge PDFs

2. Using the Merge Modal​

Clicking "Merge PDFs" will open a modal that allows you to configure the merge.

Merge Modal

Inside this modal, you can perform the following actions:

  • Name the Final File: In the Final Document Name field, enter the name you want for the resulting PDF document. By default, "merged.pdf" is suggested.
  • Select Files: The modal lists all attachments with a .pdf extension found in the issue.
    • Use the checkboxes to the left of each file to include or exclude it from the merge.
    • You must select at least two files to enable the merge button.
  • Order the Files: The order in which the files appear in the list determines the order in which they will be combined in the final PDF. To change the order, simply click and drag a file to the desired position.

Order and select files

3. Start the Merge​

Once you have named the file, selected, and ordered the PDFs, click the Merge button.

Permission Considerations​

For the PDF merge to be successful, the user must have the appropriate permissions in the Jira project to add attachments (for the merged PDF) and delete attachments (for the original PDFs).

If a user tries to merge PDFs without the permission to delete attachments, the operation will not complete, and an informative error message will be displayed:

Error message for missing permissions

Ensure you have the necessary permissions for both actions if you want to use the full functionality of the plugin.

4. Merge Result​

After a few seconds, the process will finish, and the following changes will occur in the issue:

  1. Success Message: A notification will appear at the top of the screen confirming that the merge was successful.

    Merge success message

  2. New Attachment: The newly created PDF (with the name you assigned) will be added to the Attachments section of the issue.
  3. Original Attachments Deleted: The .pdf files you selected for the merge will be deleted from the issue, thus avoiding information duplication and keeping the attachments section clean and organized.

Final result in attachments

And that's it! You have successfully merged several documents into one without leaving Jira.