Skip to main content Skip to complementary content

ExportData method

Overview

Exports the data of any generic object to an Excel file or a open XML file.

If the object contains excluded values, those excluded values are not exported.

Default limitations in number of cells

The default maximum number of cells in the export file is:

  • 1000000 to export to an Excel file
  • 5000000 to export to a CSV file

The exported file is truncated if the number of cells exceeds the limit. A warning message with code 1000 is sent.

Information noteThere is an option to export only the possible values (qExportState is P).

Change the maximum number of cells in the exported file

The maximum number of cells can be customized in the settings.ini file using the parameter:

  • ExportMaxCellsOoXmlSheet to export to an Excel file
  • ExportMaxCellsCsv to export to a CSV file
Information noteEnd the statement in the settings.in file with a carriage return, otherwise the change is not taken into account.

Default limitation in number of columns

The default maximum number of columns in the export file is:

  • 1000 to export to a CSV file

The exported file is truncated if the number of cells exceeds the limit.A warning message with code 1000 is sent.

Information noteThere is an option to export only the possible values (qExportState is P).

Change the maximum number of columns in the exported file

The maximum number of columns can be customized in the settings.ini file using the parameter ExportMaxColumnsCsv.

Information noteEnd the statement in the settings.in file with a carriage return, otherwise the change is not taken into account.

Default limitation in size

The default size limit of an export file is:

  • 1024*1024*800 for an export to an Excel file.

If the exported file is larger than the maximum value, then an out of memory error with code 13000 is returned.

Information noteThese default settings can be changed in the settings.ini file.

Change the maximum size of the exported file

The maximum size can be customized in the settings.ini file using the parameter ExportMaxOoXmlPartSize.

Information noteEnd the statement in the settings.in file with a carriage return, otherwise the change is not taken into account.

Parameters

Name Description Type
qFileType

Type of the file to export.

This parameter is mandatory.

One of:

  • CSV_C for comma separated CSV file
  • CSV_T for tab separated CSV file
  • OOXML for open XML
qPath

Path to the definition of the object to be exported.

For example, /qHyperCubeDef.

This parameter is mandatory if the file type is CSV_C or CSV_T.

String
qFileName

Name of the exported file after download from browser.

This parameter is optional.

String
qExportState

Defines the values to be exported.

This parameter is optional. The default value is A.

One of:

  • P to export only the possible values
  • A to export all values

Outputs

The following is returned in the output:

"result": { "qUrl": "<url of the exported file>"
Information noteExported files are temporary and are available only for a certain time span and only to the user who created them.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!