Models

Action Type:

Call Function

Action Name:

spreadsheetGroupExport

Permissions:

Accessible at Manager permission level

Level

Description

None

No access allowed.

Observer

Basic event monitoring.

Operator

Same as Observer.

Manager

Model creation, export and import.

Engineer

Same as Manager.

Administrator

Same as Manager.

Function Name:

spreadsheetGroupExport

Permissions:

Accessible at Manager permission level

Input Records:

1

Input Format:

Name

spreadsheets

Data Table

List of Spreadsheets to export. Each row identifies one Spreadsheet: the context field holds the path of the context that owns it, and the spreadsheet field holds its name.

fileType

Integer

Export format. Supported values:

• 6 — .pdf

• 7 — .xlsx.

exportFormula

Boolean

Controls how formulas are exported when fileType is .xlsx.

Possible values:

true — formulas are preserved in exported cells. When the file is opened in spreadsheet software, those formulas are evaluated and their results are displayed.

false — exported cells contain static calculated values only.

When fileType is .pdf, formulas are not preserved; only calculated values are exported.

namingExpression

String

Advanced field. Expression that defines the sheet name to use for the Spreadsheet when fileType is .xlsx. The evaluation environment of this expression takes its default context from the context field of the corresponding row of the spreadsheets field. Its default table is the record that describes the Spreadsheet. If the field is empty, the function uses the Spreadsheet name. If the expression cannot be evaluated, the function fires an error event and uses the Spreadsheet name instead. When fileType is .pdf, the function does not apply sheet names, so this field has no effect.

ameSuffix

String

Advanced field. Suffix of the name of the temporary Spreadsheet copy to export, formed as <Spreadsheet name>_<nameSuffix>. When the field is filled in, the function does not export the original Spreadsheet directly. Instead, it opens a copy under that name, fully recalculates it, exports it, and then closes it. The function does not save the copy. Use this field when cell formulas depend on the name of the Spreadsheet being exported — specify the same value as in the nameSuffix field of the Spreadsheet component, which is virtual by default, so that the exported data matches the data the component displays. If the field is empty, the function exports the stored Spreadsheet as is.

Output Records:

1

Output Format:

Name

result

Data Block

Data block with exported Spreadsheet data.