Export to PPTX for JIRA Documentation

Export to PPTX for Jira lets you automatically create Microsoft Powerpoint PPTX presentation from a group of Issues or an individual Issue in JIRA. It creates presentations with one slide for each ticket and you can customize exactly what fields of the ticket are displayed and how, using either the built in default template or a simple to create template of your own.

Export from Issue search page

1. Press the Export button in the top right of the Issue search page

   Open

   

2. Select Export to PPTX

   Open

   

    

3. Follow the Generic Export Steps

Export from individual Issue page

1. Select the more actions ellipsis and then select Export to PPTX

    

2. Follow the Generic Export Steps

Generic Export Steps

1. Either

   1. Select which template to use from the dropdown

   2. Upload a new template. See Creating a new PPTX Template

2. (optional) If using the Default template then use the checkboxes to select which fields should be exported. If you are using a custom template then you will not need to do this.

3. Press The Export button

    

Creating a new PPTX Template

1. The uploaded file can have any number of slides, but only the first slide with an “issue.fieldName” text on it will be copied and templated for each issue. The replaceable slide will keep its position in the presentation.

2. To have fields shown in a particular text box or location insert the text issue.fieldName, replacing “fieldName” with the name of the field you wish to have displayed there. For example: issue.key

3. You can see which field names are available for your selected ticket in the “Name of field” column on the Export to PPTX page.

4. On the Export to PPTX page, click the Choose file button.

5. Select your template PPTX file

6. Then press the Upload Template button

7. Once uploaded, you will receive a notification and the new template will be automatically selected. You can then proceed with step 3 of the Generic Export Steps.

Example Template Presentation

You can download an example template presentation here:

Open

Image Attachments

In custom templates, the text “issue.attachment” will be replaced with all image attachments for each issue. These images will be sized to fill as much of the textbox containing “issue.attachment” text whilst maintaining their aspect ratio.

Additionally, you can add the text “|caption” and each image will have the title of the image as a caption below it. To achieve this you need the text in a textbox to be “issue.attachment|caption”.

Comments

You can include in your exports either the first or the last comment on an issue by using “issue.comments.first” or “issue.comments.last”.

Dates

You can format dates to appear in custom formats by adding format on the end of the field and passing in a format parameter. e.g issue..created.format(“DDth MMM”) which would output dates like “12th Dec”. Currently only DD, th and MMM are supported. If you need additional date formatting needs please email exporttopptxjira@grovr.co.uk.

Links

Parts of link URLs can also be replaced in custom templates, just use fields in the Address section like you would in a normal Text Box. e.g. http://grovrdev.atlassian.net/browse/issue.key and they will be replaced as with other text.

Tables

You can display all the issues you want to export on a table on a single page. To do this just use “issue.table.field_name” instead of “issue.fieldName” and this will cause a row to be added for every issue you are exporting.

Max Rows Per Slide

You can set a maximum number of rows per slide (to stop tables overflowing slides) by adding a TextBox with the contents issue.table.maxrows=5 where 5 is the maximum number of non-header rows you want on a slide. The slide with the table will be duplicated a number of times in order to display all the issues.

Table of Contents

You can add a slide which has a table of contents and will be populated with a line for each issue you export.

To signify that a text box should be used for the table of contents, it must start with the text “issues.each:”, then the remaining text can be used to layout the table of contents exactly how you want it setup. You can use references to fields as you would in normal slide templates except that instead of writing “issue.fieldName” you need to write “issues.fieldName” with the extra “s” after issue. In addition you can use “issues.page_num” to get a reference to the page of the presentation that the issue is displayed on.

For example if you setup the following in a slide for your table of contents:

Then this will be processed and exported as the following:

Automated Export

You can make use of Jira’s Automation tools and Export to PPTX for Jira in order to have a templated presentation emailed to you on a regular schedule:

1. Navigate to the Jira automation page and create a New Rule

2. Use the “Scheduled” trigger and setup the timing as you would like it

3. Select “Next” or “New Component” and click on “Then: Add an action”

4. Search for and select “Lookup Issues”

5. Type or paste in the JQL which will select which issues you want exported and then press Next

6. Select “Then: Add an action” again

7. Search for and select “Send web request”

8. Set the following fields

   1. URL as https://exporttopptx.grovr.co.uk/automatedExport

   2. HTTP method as “POST”

   3. Web request body as “Custom data”

   4. Enter the following into the “Custom data” text box

      { "issueKeys": "{{#lookupIssues}}{{key}},{{/}}", "baseUrl": "The root url of your JIRA e.g. grovrdev.atlassian.net", "templateName": "The name of the your template", "sharedSecret": "a secret code" }

      1. “baseUrl” should be set to the start of your Jira url, e.g. “grovrdev.atlassian.net”

      2. “templateName” should be set to the name of the template you which to export as shown in the “Select template” dropdown on the standard Export to PPTX page. (You cannot use the Default template here)

      3. “sharedSecret” should be set to a secret value for each different Jira instance. Please email exporttopptxjira@grovr.co.uk to request a sharedSecret.

   5. Add the following header with Key “Content-Type” and Value “Application/JSON”

9. You should end up with something resembling the following

10. Select “Next” or “New Component” and click on “Then: Add an action”

11. Search for and select “Send email”

12. Set to “To” and “Subject” fields as you would like and then you can use {{webResponse.body}} in the body in order to include a link to the exported presentation

13. Finally, click “Turn On” to activate your rule and use the “…” menu and select “Run Rule” to test that it is all setup correctly. Depending on the number of issues exported and the complexity of the template it may take some time for the email to be sent.

14. If you encounter any difficulties, please email exporttopptxjira@grovr.co.uk

Parent and Child Presentations

You can create templates where data from multiple “child” issues are displayed on the same slide. This is useful for example for tables of issues. The current workflow for performing this is to “Export to PPTX” a single issue which will act as the parent, “child” issues are then defined as issues in the same project as this parent but which are not the parent. If you need a different definition of parent and child issues then please email exporttopptx@grovr.co.uk.

Standard Text fields

For standard text fields, you can access fields from the parent by using parentIssue.fieldName in the same way you would in a standard presentation but with parentIssue. instead of issue.. You can access fields from the “child” issues by using childIssue.fieldName. These fields will be copied and replaced for each “child” issue with text boxes displayed below each other for each issue.

JQL Search

If you want to further filter the “child” issues which are displayed on a slide then you can add a Text Box with the contents:

jqlSearch=INSERT YOUR JQL HERE

For Example:

jqlSearch=status = “Waiting for customer”

this JQL will be ANDed along with the existing filter which defines child issues. The textbox will be deleted for the final outputted presentation. You can have different jqlSearch Text Boxes on different slides.

Charts

You can create charts for child issues from fields which have a single numerical value. You can setup the chart design as you would normally and then you can set the Chart Name (not Title) to be childIssue.fieldName for the appropriate fieldName.

You can set the Name of a chart by performing the following steps in Microsoft PowerPoint:

1. Click on your Chart in the presentation

2. Select “Home” in the PowerPoint menu bar

3. Click on the “Select” dropdown in the “Editing” section of the sub menu bar

4. Click “Selection Pane” from the dropdown

5. Enter childIssue.fieldName with the appropriate field name in the text entry box which appears on the right hand side

You can find an example of this type of presentation template here

Tables

Tables are supported as with normal templated presentations but you should use childIssue.table.fieldName in your table cells as opposed to just childIssue.fieldName

Counts

You can get counts of the total number of child issues which match various JQL queries. To do this include the text childIssues.count.filter={JQL Here} in a similar way to the JQL Search but you must include the {}s e.g. childIssues.count.filter={status = “Waiting for customer”}.

If you just want a count of the total number of child issues then you can just put in no JQL e.g. childIssues.count.filter={}.

This text will then be replaced with the number of child issues which match this query.

For any further assistance, please email exporttopptx@grovr.co.uk