Previous Topic

Next Topic

PlayLayout - Web Service Function

PlayLayout(ReportName=String,LayoutName=String[,FileName=String,Format=String,Selections=String]): Object

Play Layout Web Services function runs the report with ReportName using LayoutName to a disk file. Optionally specify a File Name for the report to be saved to, and optionally specify a file Format. You can also optionally specify other parameters that are valid for the report.

Use the ScriptDoc Endpoint to retrieve a list of available Reports.

PlayLayout function syntax has these named arguments:

Parameter

Description

Report Name

Required. The report to run.

Layout Name

Required. The layout for the report.

File Name

Optional. The name to save the report file as.

Format

Optional. The report format. Defaults to Adobe PDF. Select from:

  • Adobe PDF
  • CSV File
  • Tab Delimited File
  • Quoted CSV File
  • Excel XLSX File

Selections

Optional. Any other parameters valid for the report.

For example:

/playlayout(ReportName='ARCustomerReport',LayoutName='Customer',FileName='MyFileName.pdf',CustomerGroup='0000')

See Also

Company Web Service Actions and Functions

Book Contents

Book Index