Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Syntax

...

 reporting_setupTemplate(templatePath [, useStreaming])

Description

...

Excerpt

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

...

Code Block
reporting_setupTemplate("templateFile.xlsx", false);

Example 2

...

Code Block
reporting_setupTemplate("templateFile.xlsx");

...