Create
cancel
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in

It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

How do I render a Confluence page programatically? Edited

When somebody creates a blog post in one of our Confluence pages, we want to e-mail the content to a distribution list. I have successfully created an event listener using ScriptRunner to call a mail-dispatch API and send the raw page content, which renders all right as HTML in an e-mail client. However, any macros in the content are in raw wiki code form and are not rendered. How can I use the Confluence Java API to render the page content to (X)HTML and send that to my e-mail service?

I am well versed with the Jira Java API and ScriptRunner but am newer to the Confluence API, but I have noticed much overlap.

2 answers

1 accepted

0 votes
Answer accepted

Using the DefaultRenderer class from the Java API worked for us. The renderer will convert macros to XML format, although anything that requires Javascript would of course not render outside of Confluence.

import com.atlassian.confluence.content.render.xhtml.DefaultRenderer;
import
com.atlassian.sal.api.component.ComponentLocator;

// page is an instance of com.atlassian.confluence.core.ContentEntityObject
DefaultRenderer renderer = ComponentLocator.getComponent(DefaultRenderer);
String content = renderer.render(page)

Maybe I'm doing something wrong, but this code doesn't render macros, it outputs them as the placeholders as you would see them in the editor.

Many macros offload their loading and rendering to JavaScript and the UI so the page itself will load faster. Any content that gets rendered in the UI via AJAX/JavaScript will not appear in the XML output, so it’s not a perfect solution.

try to use page.getBodyAsString()

Hi Dar,

I found that getBodyAsString() didn't fit my needs because it returns the raw, unprocessed page XML with all the macros unrendered.

Hi Sammo,

Can you post the Scriptrunner script that you used both to a) render and b) email the blog page? Would be great to see how it's done!

Thank you!

Hi Brian, the above snippet will render the content of a page to XML (see caveat about it being imperfect). I am not exactly certain how to send an e-mail using the Confluence Java API. We are using an program called Sendy to send these newsletters out. It has a simple REST API to use.

Suggest an answer

Log in or Sign up to answer
TAGS
Community showcase
Asked in Jira Service Desk

Calling all Insight users, we need your help!

Hello Insight users,  As part of our (Mindville's) acquisition by Atlassian, our training team is looking to build some new Insight training materials. It would really helpful if you can ...

162 views 1 1
View question

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you