Export/Report Action Definition

Learn to define action of Export/Report button.

Each export/report buttons calls the Command action with Command = Export. Further settings are specified by the CommandArguments parameter, e.g. {maxRows: -1, report:"ExportExcel[EmitXmlNativeFormat=true]"}.

The CommandArguments parameter supports the following parameters:

maxRows

Determines the maximum number of records to be exported.

maxRows is mandatory when defining Export All buttons (Direct Export All and Direct XslReport All Excel in UPDATE_DEFAULT).

maxRows is applied as follows:
  • if undefined, the Export All action (e.g. Direct Export All) is executed as e.g. Direct Export, i.e. only the selected records are exported.
  • if defined (e.g. {maxRows: 500}), this value is used.
  • if set to {maxRows: -1}, the value of the Export.MaxRecords Web Configuration parameter is used. For further details, see Export.MaxRecords.

report

Determines export options, the XSL transformation and plug-in defining the type, layout and content of the export or report.

Syntax:

{report: "<XSLT>[<export option1>;<export option2>;etc.],Format.<mime type>[<plug-in parameter1>;<plug-in parameter2>;etc.]"}

For a list of available export options, see Export Options.

For a list of available parameters for the PDF plug-in, see the article “How to use the reporting PDF plug-in, additional PDF plug-in parameter” at https://support.aurea.com.

Export options can be passed with and without transformations. The options, transformations and plug-ins are separated by comma. Additional options for transformations and plug-ins can be specified in square brackets following the transformation/plug-in. Options inside square brackets must be separated with a semicolon.

The options specified with (only!) the first transformation are applied to the whole report as well as to the first transformation: Therefore writing

{report:"Export.Encoding:UTF-8,ExportExcel [Export.Xml.EmitNativeFormat=true]"}

is the same as writing

{report:"ExportExcel[Export.Encoding:UTF-8; Export.Xml.EmitNativeFormat=true]"}

Examples:

without transformation:

{report: "Export.Xml.EmitConfiguration=true, Export.Xml.EmitCatalogs=true"}

with transformation:

{report:"ExportExpandHtml[Target=_blank; ContentDisposition=inline]"}

with plug-in:

{report:"ExportListPdf,Format.application/ pdf[FontFile=%WINDIR%\\Fonts\\arial.ttf]"}

with transformation and plug-in:
{report: 
"ExportListPdf[Export.Xml.EmitConfiguration=true;Export.Xml.EmitConditions=true], 
Format.application/pdf[EncryptionPassword=update;EncryptionPermissions=8;
EncryptionStrength=true]"}