The bursting query is a SQL query that you define to provide BI Publisher with the required information to format and deliver the report.
BI Publisher uses the results from the bursting query to create the delivery XML.
The BI Publisher bursting engine uses the delivery XML as a mapping table for each Deliver By element. The structure of the delivery XML required by BI Publisher is as follows:
<ROWSET> <ROW> <KEY></KEY> <TEMPLATE></TEMPLATE> <LOCALE></LOCALE> <OUTPUT_FORMAT></OUTPUT_FORMAT> <DEL_CHANNEL></DEL_CHANNEL> <TIMEZONE></TIMEZONE> <CALENDAR></CALENDAR> <OUTPUT_NAME></OUTPUT_NAME> <SAVE_OUTPUT></SAVE_OUTPUT> <PARAMETER1></PARAMETER1> <PARAMETER2></PARAMETER2> <PARAMETER3></PARAMETER3> <PARAMETER4></PARAMETER4> <PARAMETER5></PARAMETER5> <PARAMETER6></PARAMETER6> <PARAMETER7></PARAMETER7> <PARAMETER8></PARAMETER8> <PARAMETER9></PARAMETER9> <PARAMETER10></PARAMETER10> </ROW> </ROWSET>
KEY — The Delivery key and must match the Deliver By element. The bursting engine uses the key to link delivery criteria to a specific section of the burst data. Ensure that you use double quotes around "KEY" in the select statement, for example:
select d.department_name as "KEY",
TEMPLATE — The name of the Layout to apply. Note that the value is the Layout name (for example, 'Customer Invoice'), not the template file name (for example, invoice.rtf).
LOCALE — The template locale, for example, 'en-US'.
OUTPUT_FORMAT — The output format. For a description of each type, see Selecting Output Formats in Report Designer's Guide for Oracle Business Intelligence Publisher. The table below shows the valid values to enter for the bursting query.
Output Format | Value to Enter in Bursting Query | Template Types That Can Generate This Output Format |
---|---|---|
Interactive |
N/A |
Not supported for bursting |
HTML |
html |
BI Publisher, RTF, XSL Stylesheet (FO) |
|
|
BI Publisher, RTF, PDF, Flash, XSL Stylesheet (FO) |
RTF |
rtf |
BI Publisher, RTF, XSL Stylesheet (FO) |
Excel (mhtml) |
excel |
BI Publisher, RTF, Excel, XSL Stylesheet (FO) |
Excel (html) |
excel2000 |
BI Publisher, RTF, Excel, XSL Stylesheet (FO) |
Excel (*.xlsx) |
xlsx |
BI Publisher, RTF, XSL Stylesheet (FO) |
PowerPoint (mhtml) |
ppt |
BI Publisher, RTF, XSL Stylesheet (FO) |
PowerPoint (.*pptx) |
pptx |
BI Publisher, RTF, XSL Stylesheet (FO) |
MHTML |
mhtml |
BI Publisher, RTF, Flash, XSL Stylesheet (FO) |
PDF/A |
pdfa |
BI Publisher, RTF, XSL Stylesheet (FO) |
PDF/X |
pdfx |
BI Publisher, RTF, XSL Stylesheet (FO) |
Zipped PDFs |
pdfz |
BI Publisher, RTF, PDF, XSL Stylesheet (FO) |
FO Formatted XML |
xslfo |
BI Publisher, RTF, XSL Stylesheet (FO) |
Data (XML) |
xml |
BI Publisher, RTF, PDF, Excel, Flash, XSL Stylesheet (FO), Etext, XSL Stylesheet (HTML XML/Text) |
Data (CSV) |
csv |
BI Publisher, RTF, PDF, Excel, Flash, XSL Stylesheet (FO), XSL Stylesheet (HTML XML/Text), Etext |
XML |
txml |
XSL Stylesheet (HTML XML/Text) |
Text |
text |
XSL Stylesheet (HTML XML/Text), Etext |
Flash |
flash |
Flash |
SAVE_OUTPUT — Indicates whether to save the output documents to BI Publisher history tables that the output can be viewed and downloaded from the Report Job History page.
Valid values are 'true' (default) and 'false'. If this property is not set, the output is saved.
DEL_CHANNEL — The delivery method. Valid values are:
FAX
FILE
FTP
WEBDAV
CONTENT
ODCS
TIMEZONE — The time zone to use for the report. Values must be in the Java format, for example: 'America/Los_Angeles'. If time zone is not provided, then the system default time zone is used to generate the report.
CALENDAR — The calendar to use for the report. Valid values are:
GREGORIAN
ARABIC_HIJRAH
ENGLISH_HIJRAH
JAPANESE_IMPERIAL
THAI_BUDDHA
ROC_OFFICIAL (Taiwan)
If not provided, the value 'GREGORIAN' is used.
OUTPUT_NAME — The name to assign to the output file in the report job history.
Delivery parameters by channel — The values required for the parameters depend on the delivery method chosen. The parameter values mappings for each method are shown in the table below. Not all delivery channels use all the parameters.
Delivery Channel | PARAMETER Values |
---|---|
|
PARAMETER1: Email address PARAMETER2: cc PARAMETER3: From PARAMETER4: Subject PARAMETER5: Message body PARAMETER6: Attachment value ('true' or 'false'). If your output format is PDF, you must set this parameter to "true" to attach the PDF to the e-mail. PARAMETER7: Reply-To PARAMETER8: Bcc (PARAMETER 9-10 are not used) |
Printer |
PARAMETER1: Printer group PARAMETER2: Printer name or for a printer on CUPS, the printer URI, for example: PARAMETER3: Number of Copies PARAMETER4: Sides. Valid values are:
If the parameter is not specified, single-sided is used. PARAMETER5: Tray. Valid values are:
If not specified, the printer default is used. PARAMETER6: Print range. For example "3" prints page 3 only, "2-5" prints pages 2-5, "1,3-5" prints pages 1 and 3-5 (PARAMETER 7-10 are not used) |
Fax |
PARAMETER1: Fax server name PARAMETER2: Fax number (PARAMETER 3-10 are not used) |
WebDAV |
PARAMETER1: Server Name P ARAMETER2: Username PARAMETER3: Password PARAMETER4: Remote Directory PARAMETER5: Remote File Name PARAMETER6: Authorization type, values are 'basic' or 'digest' (PARAMETER 7-10 are not used) |
File |
PARAMETER1: Directory PARAMETER2: File Name (PARAMETER 3-10 are not used) |
FTP and SFTP |
PARAMETER1: Server name PARAMETER2: Username PARAMETER3: Password PARAMETER4: Remote Directory PARAMETER5: Remote File Name PARAMETER6: Secure (set this value to 'true' to enable Secure FTP) (PARAMETER 7-10 are not used) |
CONTENT |
PARAMETER1: Server name PARAMETER2: Security Group PARAMETER3: Author PARAMETER4: Account (Optional) PARAMETER5: Title PARAMETER6: Primary File (or File Name) PARAMETER7: Content ID PARAMETER8: Comments (Optional) PARAMETER9: Include MetaData |
Document Cloud Services |
PARAMETER1: Server name PARAMETER2: Folder Name PARAMETER3: File Name |