Define the Query for Delivery XML
The bursting query is a SQL query that you define to provide the required information to format and deliver the report.
Publisher uses the results from the bursting query to create the delivery XML.
The bursting engine uses the delivery XML as a mapping table for each Deliver By element. The structure of the delivery XML required 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 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. The following table 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
-
Publisher
-
RTF
-
XSL Stylesheet (FO)
PDF
pdf
-
Publisher
-
RTF
-
PDF
-
XSL Stylesheet (FO)
RTF
rtf
-
Publisher
-
RTF
-
XSL Stylesheet (FO)
Excel (*.xlsx)
xlsx
-
Publisher
-
RTF
-
XSL Stylesheet (FO)
PowerPoint (.*pptx)
pptx
-
Publisher
-
RTF
-
XSL Stylesheet (FO)
MHTML
mhtml
-
Publisher
-
RTF
-
XSL Stylesheet (FO)
PDF/A
pdfa
-
Publisher
-
RTF
-
XSL Stylesheet (FO)
PDF/X
pdfx
-
Publisher
-
RTF
-
XSL Stylesheet (FO)
Zipped PDFs
pdfz
-
Publisher
-
RTF
-
PDF
-
XSL Stylesheet (FO)
FO Formatted XML
xslfo
-
Publisher
-
RTF
-
XSL Stylesheet (FO)
Data (XML)
xml
-
Publisher
-
RTF
-
PDF
-
Excel
-
XSL Stylesheet (FO)
-
XSL Stylesheet (HTML XML/Text)
-
Etext
Data (CSV)
csv
-
Publisher
-
RTF
-
PDF
-
Excel
-
XSL Stylesheet (FO)
-
XSL Stylesheet (HTML XML/Text)
-
Etext
XML
txml
XSL Stylesheet (HTML XML/Text)
Text
text
-
XSL Stylesheet (HTML XML/Text)
-
Etext
-
-
SAVE_OUTPUT — Specifies whether to save the output documents to the history tables so that you can later view and download the output from the Report Job History page.
Valid values are "true" (default) and "false". If this property set to "false", the output isn't saved.
-
DEL_CHANNEL — The delivery method. Valid values are:
-
EMAIL
-
FAX
-
FTP
-
OBJECTSTORAGE
-
ODCS
-
PRINT
-
WCC
-
-
TIMEZONE — The time zone to use for the report. Values must be in the Java format, for example: "America/Los_Angeles". If time zone isn't 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 following table. 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) |
Fax |
PARAMETER1: Fax Server Name PARAMETER2: Fax number (PARAMETER 3-10 are not used) |
FTP and SFTP |
PARAMETER1: Server Name PARAMETER2: Username PARAMETER3: Password PARAMETER4: Remote Directory PARAMETER5: Remote Filename PARAMETER6: Secure (set this value to "true" to enable Secure FTP) (PARAMETER 7-10 are not used) If you want to use the FTP delivery settings configured by the administrator, don't enter the username (PARAMETER2) and password (PARAMETER3) values. Only if you want to override the configuration of the FTP server and use password-based authentication, provide the valid username (PARAMETER2) and password (PARAMETER3) credentials for the FTP server. |
Object Storage |
PARAMETER1: Server Name PARAMETER2: Prefix PARAMETER3: File Name |
ODCS (Oracle Content and Experience Cloud) |
PARAMETER1: Server Name PARAMETER2: Folder Name PARAMETER3: File Name |
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 isn't 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) |
WCC |
PARAMETER1: Server Name PARAMETER2: Security Group PARAMETER3: Author PARAMETER4: Account (Optional) PARAMETER5: Title PARAMETER6: Primary File (or File Name) PARAMETER7: Comments (Optional) PARAMETER8: Content ID (Optional. Content ID must be unique.) PARAMETER9: Custom Metadata. Set value to "on" to turn on custom metadata. |