In addition to regular Template Helpers, Raley provides several specific helper functions that you can use for automation of PDF exports


$raley.exportIssue($issueKey, $exportTemplateId)

Initiates export of issue specified by given $issueKey using Snapshot template with given $exportTemplateId

On successful invocation returns a String that represents export job id. You'll use that value later to send the export PDF with an email notification and/or attach it to the issue.

Usage example: 

#set($exportId = $raley.exportIssue($issue.key, "130")

In the example above, we initiate export of currrent issue using snapshot template with id "130". The ID of the export job will be stored in $exportId variable


$raley.exportIssues($jql, $exportTemplateId)

Initiates export of issues specified by given $jql JQL statement using Snapshot template with given $exportTemplateId

On successful invocation returns a String that represents export job id. You'll use that value later to send the PDF with email notification

Usage example:

#set($exportId = $raley.exportIssues("project = RNTP2", "130")

In the example above, we initiate export of all issues in project RNTP2 using Snapshot template with id "130". The ID of the export job will be stored in $exportId variable


$raley.attachToIssue($generatedPdfID, $issueKey)

Uploads the PDF export that was generated by exportIssue() or exportIssues() function to the issue identified by $issueKey

Usage example:

$raley.attachToIssue($exportId, $issue.key)

In the example above, we store the export PDF as attachment of the current issue


$raley.includeExport($generatedPdfID)

Attaches the export PDF that was created by exportIssue() or exportIssues() functions to the current Email/Slack notification

Usage example:

$raley.includeExport($exportId)

In the example above, we attach PDF previously created by an export job as Email or Slack notification attachment