reportQuery - APEXlang Reference

`reportQuery`

Parent: app

Children: sourceQuery

Direct Properties:

Property	Type	Required	Default Value	Details
`name`	`string`	Yes		data type=`string`; maxLen=255 The report query name identifies the report query. When referencing a report query as a link target, the report query name is part of the request string.

Property Groups:

output

Property	Type	Required	Default Value	Details
`fileName`	`string`	Yes		data type=`string`; maxLen=4000 The report query output filename.
`format`	`enum`	Yes	`pdf`	data type=`string`; lov=`STATIC` Valid values: `pdf` `word` `excel` `html` `xml` Applies when`type = useInstanceSettingsremotePrintServer does not support AOP_SERVER` Select the report output format. Supported formats include PDF, Microsoft Word (RTF format), Microsoft Excel (HTML format), and HTML. You can also have the output format specified by an item.
`format`	`enum`	Yes	`pdf`	data type=`string`; lov=`STATIC` Valid values: `pdf` `word` `excel` `html` `powerpoint` `markdown` `csv` `openDocumentText` `openDocumentSpreadsheet` `openDocumentPresentation` Applies when`remotePrintServer supports AOP_SERVER`
`formatItem`	`string`	No		data type=`string`; maxLen=255; textCase=`UPPER` Applies when`type = useInstanceSettings and remotePrintServer supports AOP_SERVERremotePrintServer does not support AOP_SERVER and remotePrintServer supports AOP_SERVER`
`layout`	`reference`	No		data type=`reference`; lov=`COMPONENT`; references=`reportLayout` Chose the report layout you want to use for formatting the report query result. Generic report layouts typically work with any report query. Named Column layouts work only with the report query they were created for or report queries that have a compatible list of columns.
`viewFileAs`	`enum`	Yes	`attachment`	data type=`string`; lov=`STATIC` Valid values: `attachment` `inline`

output {
  fileName: value
  format: pdf
  formatItem: value
  layout: @component
  viewFileAs: attachment
}

sessionState

Property	Type	Required	Default Value	Details
`include`	`boolean`	Yes	`false`	data type=`boolean`
`items`	`array of strings`	No		data type=`string`; maxLen=2000; textCase=`UPPER` Applies when`include = true`

sessionState {
  include: false
  items: [
    value
    value
  ]
}

advanced

Property	Type	Required	Default Value	Details
`staticId`	`string`	Yes		data type=`string`; maxLen=255 Use the Static ID to reference the report query in API Calls.

advanced {
  staticId: value
}

APEXlang Example

reportQuery sample (
    name: value
    output {
        fileName: value
        format: pdf
        formatItem: value
        layout: @component
        viewFileAs: attachment
    }
    sessionState {
        include: false
        items: [
          value
          value
        ]
    }
    advanced {
        staticId: value
    }
)