ExecuteReport
  • 1 Minute to read
  • Dark
    Light
  • PDF

ExecuteReport

  • Dark
    Light
  • PDF

Article summary

Standard Form

{
  "method": "ExecuteReport",
  "filename": "%OUTPUT%SurveyDashboard.xlsx",
  "report": "Survey Dashboard",
  "byReference": true
}

Remove filename and array of models returned.    "models" [   {"model":{}},{"model":{}} ,{"model":{}}  ]

Add a dataSet to apply a filter or form an AND with existing filters for all member reports that support dataSet as an outer filter

{
  "method": "ExecuteReport",
  "report": "Survey Dashboard",
  "byReference": true,
  "dataSet": {
  }
}

4.3.7.1

Added "append": false(true) and "sheet" : string

if exporting by reference, successive calls can be appended to the same workbook, and the worksheets can be named..

Added "stack": false(true) - successive components of a dashboard are stacked vertically


[
  {
    "method": "ExecuteReport",
    "filename": "%OUTPUT%report1.xlsx",
    "sheet": "Attributes",
    "report": "Customer Attribute Index Dashboard",
    "byReference": true
  },
  {
    "method": "ExecuteReport",
    "filename": "%OUTPUT%report1.xlsx",
    "sheet": "Stats",
    "report": "Crosstab Stats Panel Dashboard",
    "byReference": true,
    "append": true
  }
]


Iterators

Iterators can be applied when the report is being exported to a workbook.

An iterator contains either a table or a list of fields. 

The referenced or inline report will be executed for every field in the list (or for the whole table)

Each result will be added to a new sheet in the workbook referenced in filename.

If using the table form, remove fields from the iteration by adding them to the ignore list.

Note: the fields and ignore list entries must be full qualified fields names.


{
  "project": "MyProject",
  "method": "ExecuteReport",
  "filename": "%OUTPUT%OccupationbyStatus.xlsx",
  "report": "Occupation by Status",
  "byReference": true,
  "iterator": {
    "field": "cust.status",
    "table": "cust",
    "ignore": [
      "cust.occupation"
    ]
  }
}

Was this article helpful?

What's Next