An Exporter is used to export data to a file stream. For instance, a BQL query can be exported to a CSV file.
If the Exporter doesn’t implement BIWbViewExporter, it can be run Station side. Station side exporters can be run through the web server.
An Exporter can be invoked by using the view ORD scheme. A default file name can also be specified…
http(s)://{hostname}/ord/{ordToDataToExport}|view:{typeSpecOfExporter}?fileName={nameOfFileToDownload};{exporterPropertyName}={encodedSimpleValue}
For instance, let’s say you want to invoke a BQL query and download it as a CSV file. Please note the correct URI encoding…
// Run the BQL 'select toPathString from baja:Component' and download 'myCsvFile.csv'.
https://niagaraisawesome/ord/station:%7Cslot:/%7Cbql:select%20toPathString%20from%20baja:Component%7Cview:file:ITableToCsv?fileName=myCsvFile
If the exporter has properties, the properties can be specified in the URI as additional view parameters. Each parameter value has to decode to a Simple. For instance, in the following example ‘pageSize’ decodes to a BSize Simple…
// Run the BQL 'select toPathString from baja:Component' and download 'myPdfFile.pdf' with a custom page size of 20 by 30 inches.
https://niagaraisawesome/ord/station:%7Cslot:/%7Cbql:select%20toPathString%20from%20baja:Component%7Cview:pdf:ITableToPdf?fileName=myPdfFile;pageSize=20%2C30