Script API Template - AnalyticsGate/AGR-OnPrem-Setups GitHub Wiki

input

Description

The path to the template for the report. The formats xlsx, xlsb, and xlsm can be used. Source specifications are possible in three formats, examples of which are given below: e.g. content:///ExecutiveDashboard.xlsx - The template is included in the app. e.g. content://[CONTENTLIBARYNAME]/ExecutiveDashboard.xlsm - The template is stored in a content library. e.g. lib://[LIBFOLDER]/ExecutiveDashboard.xlsb - The template is stored in the file system.

Required: Yes (not necessary in notification/alerting mode)

Example Use content library

input: content://[CONTENTLIBARYNAME]/ExecutiveDashboard.xlsm

Use lib folder - The template is stored in the filesystem.

input: lib://[LIBFOLDER]/ExecutiveDashboard.xlsb

output

Description

The name of the resulting report. If a valid file extension (see "outputFormat") is used here, it is not necessary to specify the "outputFormat" option. Qlik formulas can be used to create the name.

Required: Yes

Default: pdf

Example

output: Result.pdf

outputFormat

Description

The output format of the report. The following output formats are possible: pdf, xlsx, xlsm, xlsb, xls, csv, tsv, pptx, docx, html, markdown, ods, svg, tiff, spreadsheetML

Default: pdf

Example

outputFormat: xlsx

outputPassword

Description

The password for the report can be specified in plain text or as encrypted Base64 text. If an encrypted Base64 text is to be used, the option "useBase64Password" must be enabled.

Example

outputPassword: 123456

useBase64Password

Description

If an "outputPassword” with encrypted Base64-text is to be used, this parameter must be set to "true”.

Default: false

Example

useBase64Password: true

encryptType

Description

Sets the encryption algorithm. The possible choice is AES256 or RSA256.

• Long texts can only be encrypted with AES256.
• With RSA you can encrypt only up to 64 characters.

Default: RSA256

Example

encryptType: AES256

outputFormatOptions

Description

Additional control options for format specific adjustments like encoding or a password. See the following links.

PDF: https://apireference.aspose.com/cells/net/aspose.cells/pdfsaveoptions

HTML: https://apireference.aspose.com/cells/net/aspose.cells/htmlsaveoptions

Markdown: https://apireference.aspose.com/cells/net/aspose.cells/markdownsaveoptions

ODS: https://apireference.aspose.com/cells/net/aspose.cells/odssaveoptions

XML (SpreadsheetML): https://apireference.aspose.com/cells/net/aspose.cells/spreadsheetml2003saveoptions

SVG: https://apireference.aspose.com/cells/net/aspose.cells/svgsaveoptions

TXT, CSV, TAB: https://apireference.aspose.com/cells/net/aspose.cells/txtsaveoptions

TIFF: https://apireference.aspose.com/cells/net/aspose.cells/imagesaveoptions

Example

outputFormatOptions:
{
	PROPERTY: VALUE
}

selections

Description

The filters to be set in Qlik while processing. You can use several static but only one dynamic filter. When using a dynamic filter, all field values of the filter are looped.

Example

selections:
[
   {
       type: static
       name: Fiscal Year
       values: 2020
   }
]