reporting_setupTemplate

Owned by Former user (Deleted)
Last updated: Feb 21, 2018 by Elena Kolesnik
1 min read

Syntax

 reporting_setupTemplate(templatePath [, useStreaming])

Description

Creates an internal setup configuration associated with an external Excel template.

There can be only one call of this routine per reporting script. Every extra call will trigger an exception.

Parameters

Parameter name

Type

Required

Description

templatePath

string

Yes

The Excel file name. The file should be located in the directory: JIRA_HOME/kepler/reports

useStreamingbooleanNoThis parameter controls the writing process. If true it will allow writing a very large amount of data but it will not allow overwriting any content in the targeted sheets.

Return type

The returned value has no meaning.

Examples

Example 1

reporting_setupTemplate("templateFile.xlsx", false);

Example 2

reporting_setupTemplate("templateFile.xlsx");

Important

The template files must have been created with Excel 2007 or newer. Supported extensions are .xlsx and .xlsm. The older .xls extensions (Microsoft Office versions prior to 2007) are not supported.