Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

This function is used in Python Scripting.

Description

Formats the contents of one or more datasets as an excel spreadsheet, returning the results as a string. Each dataset specified will be added as a worksheet in the Excel workbook. This function uses an xml-format for Excel spreadsheets, not the native Excel file format.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.dataset.dataSetToExcel(showHeaders, datasets)

  • Parameters

boolean showHeaders - If true (1), the spreadsheet will include a header row.

Object[] datasets - A sequence of datasets, one for each sheet in the resulting workbook.

  • Returns

String - An Excel-compatible XML-based workbook, with one worksheet per dataset.

  • Scope

All

Code Examples
Code Snippet
#This snippet would run a SQL query against a database, and turn the results into a string that is XML that Excel can open. It then writes the string to a file on the local hard drive.
 
results = system.db.runQuery("SELECT * FROM example1 LIMIT 100")
results = system.dataset.toDataSet(results)
spreadsheet = system.dataset.dataSetToExcel(1, [results])
filePath = "C:\\output\\results.xls"
system.file.writeFile(filePath, spreadsheet)
  • No labels