In this page

What is Insight?

(supported since Better PDF Exporter 1.6.0)

Insight is the leading asset management app for Jira, that allows implementing CMDB, CRM, HR, ITSM or ITIL functionality on the Jira platform.

Insight integration features

  • You can export Insight-managed objects from the custom fields of the Assets type to PDF. (Note that Jira Cloud is using a single custom field type named Assets to integrate objects managed by various asset management apps to Jira issues.)
  • You can configure the export format to include object names (e.g. "My supa dupa server"), object keys (e.g. "My supa dupa server [SRVR-123]"), object attributes (e.g. "My supa dupa server [SRVR-123] (Manufacturer=Cray Research, Vector Processors=4, Type=Supercomputer)") and any combination of these.

(Need more features? Tell us in a support ticket!)

Insight integration vs. the Insight built-in PDF exports

You may want to ask: if Insight has a built-in PDF export feature, why would you use another app for the same?

While the Insight built-in PDF exports may be sufficient for basic use cases, the Better PDF Exporter integration is more powerful in, at least, these:

If any of these are important for you, give it a try.

Tutorial video

Watch this short introductory video to see how fast you can export your Insight data to PDF! (Although the video below was captured about the app's Server version, the Cloud version is very similar.)

Export samples

Issue with objects

This straightforward PDF document (created using the default issue-fo.vm template) contains a single issue with two Insight custom fields. In addition to object names and keys, attributes are exported as comma-separated name-value pairs in brackets (the format is completely customizable).

jira-insight-fields-single-issue.pdf

Issue list with objects

Insight custom fields (see the 2 rightmost columns) are also supported when bulk-exporting issues to a table. In this example, attributes are turned off for a more compact content.

jira-insight-fields-issue-navigator.pdf

Configuration

Exporting Insight objects

The Insight and Better PDF Exporter integration relies on the Insight REST API. After configuring the API access once (based on the guide below), Better PDF Exporter will automatically recognize the Insight-managed objects and export them accordingly.

Configuring the Insight REST API access

As this integration relies on the Insight REST API, you need to configure the access token for the REST API calls in the templates:

  1. Go to JiraInsightInsight Access Tokens.
  2. Click Create a token, enter a name for the token and click Generate.
  3. Copy the access token from the dialog (using the Copy button).
  4. Go to AdministrationAdd-onsPDF Templates (under Better PDF Exporter).
  5. Open the issue-fo.vm template for editing, uncomment this variable in the top part, and paste the security token from the clipboard to the value (don't remove the quotation marks around the string!):
    ## Insight
    #set($insightAccessToken = "fc77e1e41274052ba0645a1669c62aaceb3c8102")
    
  6. Save the changes. (Don't worry about storing tokens here: this file is visible only for Jira administrators, who would have super-user permissions any way.)
  7. Similarly, set the same token in the issue-navigator-fo.vm template.
  8. Similarly, set the same token in the traceability-report-fo.vm template.

Configuring the export format for Insight objects

The default behaviour is that object names and object keys will be exported (e.g. "My supa dupa server [SRVR-123]"). You can include object name, object key and attributes by setting these configuration variables in the top part of the issue-fo.vm and issue-navigator-fo.vm templates:

## Insight
#set($exportInsightObjectNames = true) ## set to "true" to export Insight object names
#set($exportInsightObjectKeys = true) ## set to "true" to export Insight object keys
#set($exportInsightObjectAttributes = false) ## set to "true" to export Insight object attributes

If you want full control over the export format, look at the Velocity macro definition marked with this comment in issue-fo.vm, issue-navigator-fo.vm and traceability-report-fo.vm:

## Insight custom field
## ...

Note: you can absolutely have different export formats in the two templates, as issue-fo.vm typically has more space for details.

Learn more about Insight