What is the best way to set up a daily export of Confluence page to a pdf using scriptrunner jobs?

Aaron Andrade
Contributor
September 24, 2021

As a new Admin for JIRA/Confluence, I am trying to figure out the path of least resistance to create a scriptrunner job to do a daily export of a Confluence page to a pdf to be saved in a shared file. Any and all help is greatly appreciated.

4 answers

1 accepted

1 vote
Answer accepted
Helmy Ibrahim _Adaptavist_
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
September 25, 2021

Hi Justin,

You can call Confluence's export to PDF URL to get the PDF file. The request URL should be something like:

<Confluence_URL>/spaces/flyingpdf/pdfpageexport.action?pageId=<Page_Id>

Then, you can probably use the Apache Common IO FileUtils's copyURLToFile to download the file and save it to your destination folder - See example

Ultimately, your script in Job could be something like:

import org.apache.commons.io.FileUtils

// Replace <Confluence_URL>
// Replace <Page_Id>
def requestUrl = "<Confluence_URL>/spaces/flyingpdf/pdfpageexport.action?pageId=<Page_Id>"

// Update destinationPath with your shared directory and file name
def destinationPath = "PATH/FILENAME.pdf"

try {
URL url = new URL(requestUrl)
File destinationFile = new File(destinationPath)

FileUtils.copyURLToFile(url, destinationFile)
} catch (MalformedURLException e) {
// Handle
} catch (IOException e) {
// Handle
}

I hope this helps! 

Cheers,
Helmy

Aaron Andrade
Contributor
September 28, 2021

Helmy,

        Thank you for the response! I am building and trying it today. I hope that all goes smooth if not I'll be back ;).

Thank you,

Justin

Helmy Ibrahim _Adaptavist_
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
September 28, 2021

Hi Justin,

This post on StackOverflow should help!

Cheers,
Helmy

Like Aaron Andrade likes this
Helmy Ibrahim _Adaptavist_
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
September 28, 2021

Ah you edited your reponse.

Hope everything goes well :) 

Aaron Andrade
Contributor
September 28, 2021

I did because when I copied the path it used forward slash instead of backslash. I changed them and the error is gone. Now I am just trying to actually get the pdf to the file.

Aaron Andrade
Contributor
September 28, 2021

Helmy,

       So it runs with no errors, but I'm not actually pulling anything. The results come back as null.

image.png

Helmy Ibrahim _Adaptavist_
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
September 28, 2021

Hi Justin,

Is there a daily.pdf file created in the target directory at all?

Like Aaron Andrade likes this
Aaron Andrade
Contributor
September 28, 2021

No there is not. I for some reason thought that was naming the file. I will get that out of there.

**UPDATE** Still did not work unfortunately.

 

Helmy Ibrahim _Adaptavist_
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
September 28, 2021

Hi Justin,

Can you print the following:

def currentDir = System.getProperty("user.dir")
log.warn(currentDir)

Cheers
Helmy

Aaron Andrade
Contributor
September 28, 2021

image.png

1 vote
Jessie Wang_ScriptRunner_The Adaptavist Group
Atlassian Partner
September 28, 2022

Hi all, this script is now available in our script library for ScriptRunner for Confluence Server/DC (tested by our engineers).

Feel free to copy or customise it as you wish.

https://library.adaptavist.com/entity/export-page-as-pdf-job

0 votes
Helmy Ibrahim _Adaptavist_
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
March 10, 2022

My original script above did not handle any authentication. Please use the following script instead: https://www.mysamplecode.com/2019/04/java-download-image-from-url-authentication.html

0 votes
Helmy Ibrahim _Adaptavist_
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
September 28, 2021

Hi Justin,

You don't have to replace the string 'user.dir'. It is literally it:

System.getProperty("user.dir")

Cheers,
Helmy 

Aaron Andrade
Contributor
September 28, 2021

sorry about that.image.png

Helmy Ibrahim _Adaptavist_
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
September 28, 2021

Can you check if you actually have permission to create a file in that directory?

You can run this script in the Script Console to test:

def testFile = new File("C:/Users/jmele/Desktop/Export_Test/test.txt")

log.warn testFile.getAbsolutePath()

 

Aaron Andrade
Contributor
September 28, 2021

image.png

Helmy Ibrahim _Adaptavist_
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
September 28, 2021

Can you copy the script from the Job and run in Script Console? Also, make sure to specify the filename.

def destinationPath = "C:/Users/jmele/Desktop/Export_Test/testFile.pdf"

Then, check if the file actually created. 

Aaron Andrade
Contributor
September 28, 2021

I did the above mentioned and it did not write to the folder. It is an empty folder still.

Helmy Ibrahim _Adaptavist_
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
September 28, 2021

Sorry I missed a line, try:

def testFile = new File("C:/Users/jmele/Desktop/Export_Test/test.txt")
testFile.createNewFile()

log.warn testFile.getAbsolutePath()
Aaron Andrade
Contributor
September 28, 2021

image.pngimage.png

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
SERVER
TAGS
AUG Leaders

Atlassian Community Events