Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel6
outlinefalse
typelist
printablefalse
Multiexcerpt macro
hiddentrue
nameNOTE
fallbackfalse

LINKI DO KONKRETNYCH PARAGRAFÓW ZOSTAŁY DANE KLIENTOM! OSTROŻNIE Z EDYCJĄ STRONY

Installation for Jira Cloud

...

Features unlocked with Headless Chrome

A quick comparison of image export engines: 


Headless Chrome (Starting from BigTemplate 2.7.0)

Image export formats

PDF (exact export of browser as seen on PC/MAC)

Exportables

Gantt, Roadmap, Resources, Risks

Anchor
NodeInstallation
NodeInstallation

NodeJS Installation

Info

Installation may be different on your OS. We recommend following the official NodeJS installation guide.

Please install NodeJS (version 16.16.0 or higher) using instructions from https://docs.npmjs.com/downloading-and-installing-node-js-and-npm

NodeJS installation guide suggests NVM installation. With BigTemplate, you cannot use it. We recommend https://www.npmjs.com/package/n if you need a version manager. Using a version manager is optional, and you can also use official NodeJS installers as well.

Installation check:
Command "node -v" should return the version of the installed NodeJS.
Command "npm -v" should return the version of the installed NPM.

You can also provide a path to your npm executable in BigTemplate > Technical configuration. In such a case, the provided npm will be used instead of the global one.

If you have any further questions regarding setting up NodeJS or if, by any chance, the image export fails afterward, do not hesitate to contact our Support Team via our Service Desk.

Font requirements

Exports require TrueType fonts installed on the server. Ask your Jira system administrator to install True Type fonts on the system.

For CentOS/RHEL distributions, it can be done using:

sudo yum install -y which fontconfig gnu*fonts

For Ubuntu/Debian distributions, it can be done using:

sudo apt-get install ttf-mscorefonts-installer

or alternatively

sudo apt-get install ttf-liberation

After the installation, restart your Jira server.

...

Q. There is an error "InvalidOperationException: Cannot find any fonts installed on the system." in the logs despite the fonts installed in the system.
A. It seems like an environmental problem. In order to To fix the issue, symlinks to shared fonts should be created in the JRE fonts directory. e.g.:

ln -s /usr/share/fonts/* /opt/atlassian/jira/jre/lib/fonts/

Q: After exporting my Gantt view to PDF/PNG, all labels are missing.
A: This means you probably don't have any fonts installed. Check if there are TrueType fonts in the fonts directory:

...

If you have the fonts installed, check if fontconfig () is installed and execute fc-cache -v to update font caches.

Quick troubleshooting

Export diagnostics

Please start the troubleshooting by running export diagnostics. 

Go to App configuration > BigTemplate configuration > Technical Info and click the "Export diagnostics" button.

Expand
titleAccessing BigTemplate Configuration

Method 1: "." (dot) context

If BigGantt is a Jira add-on, you can use the Jira "." shortcut to access the BigGantt configuration.

  1. Press the "." (dot) key shortcut. Jira to open Operations Dialogue.

    Image RemovedImage Added
  2. Type in "BigTemplate" to narrow down the results:
    Image Removed

    image2021-5-19_12-30-42.pngImage Added

  3. Click on "BigTemplate configuration" to go directly to app settings in Jira.

Method 2: Jira administration drop-down

  1. Click the Jira cog at the top right and select "Manage apps" from the list:

    Image RemovedImage Added
  2. Select "BigTemplate configuration" on the left:

    Image RemovedImage Added

...

...

If everything is properly correctly set up, green checkmarks appear:

...

Failures are marked with a red "X":Image Removed

...

Internet connection check - npm status page

Check if the connection to the https://status.npmjs.org/ site is not blocked from the network where the instance is located (sometimes the problem is caused by the instance being unable to connect to the https://status.npmjs.org/ site).

Node.js or NPM installation failure

If Node.js or NPM installation and version are not correctincorrect, follow the above steps described above.

Temp directory read/write permissions failure

If the Temp directory read/write permissions are not correctincorrect, move Temp directory read permission. 

Linux

Temp directory write permission:

  1. Go to your Jira Temp dir (if you don't know the path, go to Getting the path of Jira temp directory section below).

Make sure
  1. Ensure that the user who runs Jira (by default,

it is
  1. a user named Jira) has permission to create files in this directory.

  2. Execute the following command: chmod +w path/to/temp/dir

Temp directory read permission:

  1. Go to your Jira Temp dir (if you don't know the path

go 
  1. , go to Getting the path of Jira temp directory section below)

Make sure
  1. Ensure that the user who runs Jira (by default,

it is
  1. a user named Jira) has permission to create files in this directory.

  2. Execute the following command: chmod +r path/to/temp/dir

Getting the path of Jira temp directory:

  1. Go to Jira → System → System Info

  2. Search for the following text: java.io.tmpdir

Value
  1. The value of this property is the temp directory path, e.g.

 
  1. , /opt/atlassian/jira/temp

Anchor
ExportLibraryInstallationFailure
ExportLibraryInstallationFailure

Export library installation failure

If the last point is not correctincorrect, click on the "Re-install pdf export" button.

...

Using NVM as node manager

...

  1. Please check if you use NVM as a node version manager - run this command:

    nvm --help
    to

    If it returns anything, that means that NVM is installed.

...