Versions Compared

Old Version 17

changes.mady.by.user Paul Scott

Saved on

compared with

New Version Current

changes.mady.by.user Aaron Huffman

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


New_in
Version8.0.7



Scripting_function



Panel
titleDescription

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 replaces the deprecated system.dataset.dataSetToExcel function.


Panel
titleClient Permission Restrictions

This scripting function has no Client Permission restrictions.


Panel
titleSyntax

system.dataset.toExcel(showHeaders, dataset, [nullsEmpty], [sheetNames])

  • Parameters

Boolean showHeaders - If True, the spreadsheet will include a header row. If False, the header row will be omitted. 

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

Boolean nullsEmpty - If True, the spreadsheet will leave cells with NULL values empty, instead of allowing Excel to provide a default value like 0. Defaults to False. [Optional]

New_in
Version8.0.16



List sheetNames - Expects a list of strings, where each string is a name for one of the datasets. When used, there must be an equal number of string names in sheetName as there are datasets in the dataset parameter. Names provided in this parameter may be sanitized into acceptable Excel sheet names. [Optional]

  • Returns

Array - A byte array representing an Excel workbook.

  • Scope

Gateway, Vision Client, Perspective Session



Panel
titleCode Examples


Code Block
languagepy
titleCode 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.runQueryrunNamedQuery("SELECT * FROM example1 LIMIT 100")
results = system.dataset.toDataSet(resultsFetch Records",{})
spreadsheet = system.dataset.toExcel(True, [results])
filePath = "C:\\output\\results.xls"
system.file.writeFile(filePath, spreadsheet)




Panel
titleKeywords

system dataset toExcel, dataset.toExcel