Adding Markup to the Template Layout
BI Publisher converts the formatting that you apply in the word processor to XSL-FO. You add markup to create the mapping between the layout and the XML file and to include features that cannot be represented directly in the format.
The most basic markup elements are placeholders, to define the XML data elements; and groups, to define the repeating elements.
BI Publisher provides tags to add markup to the template. For the XSL equivalents of the BI Publisher tags, see XSL Equivalents.
Creating Placeholders
The placeholder maps the template field to the XML element data field. At runtime the placeholder is replaced by the value of the element of the same name in the XML data file.
Enter placeholders in the document using the following syntax:
<?XML element tag name?>
The placeholder must match the XML element tag name exactly. It is case sensitive.
There are two ways to insert placeholders in the document, as described in the following sections:
-
Using the Basic RTF Method: Insert the placeholder syntax directly into the template document.
-
Using the Form Field Method: (Requires Microsoft Word) Insert the placeholder syntax in Microsoft Word's Text Form Field Options window. This method allows you to maintain the appearance of the template.
See Inserting a Field.
Using the Basic RTF Method
Enter the placeholder syntax in the document where you want the XML data value to appear.
Enter the element's XML tag name using the syntax:
<?XML element tag name?>
In the example, the template field "Supplier" maps to the XML element VENDOR_NAME. In the document, enter:
<?VENDOR_NAME?>
The entry in the template is shown in the following illustration.
Using the Form Field Method
Placeholder tags can be added using the Form Field method.
To use Microsoft Word's Form Field method to insert the placeholder tags:
- In the help text entry field, enter the XML element's tag name using the syntax:
<?XML element tag name?>
You can enter multiple element tag names in the text entry field.
In the example, the report field "Supplier" maps to the XML element VENDOR_NAME. In the Form Field Help Text field enter:
<?VENDOR_NAME?>
The following illustration shows the Text Form Field Options dialog and the Form Field Help Text dialog with the appropriate entries for the Supplier field.
Tip:
For longer strings of BI Publisher syntax, use the Help Key (F1) tab instead of the Status Bar tab. The text entry field on the Help Key (F1) tab allows more characters. - Click OK to apply.
The Default text is displayed in the form field on the template.
The following illustration shows the Supplier field from the template with the added form field markup.
Completing the Example
This table shows the entries made to complete the example. The Template Field Name is the display name from the template. The Default Text Entry is the value entered in the Default Text field of the Text Form Field Options dialog box (form field method only). The Placeholder Entry is the XML element tag name entered either in the Form Field Help Text field (form field method) or directly on the template.
| Template Field Name | Default Text Entry (Form Field Method) | Placeholder Entry (XML Tag Name) |
|---|---|---|
|
Invoice Num |
1234566 |
<?INVOICE_NUM?> |
|
Invoice Date |
1-Jan-2004 |
<?INVOICE_DATE?> |
|
GL Date |
1-Jan-2004 |
<?GL_DATE?> |
|
Curr |
USD |
<?INVOICE_CURRENCY_CODE?> |
|
Entered Amt |
1000.00 |
<?ENT_AMT?> |
|
Accounted Amt |
1000.00 |
<?ACCTD_AMT?> |
|
(Total of Entered Amt column) |
1000.00 |
<?ENT_SUM_VENDOR?> |
|
(Total of Accounted Amt column) |
1000.00 |
<?ACCTD_SUM_VENDOR?> |
This figure shows the Payables Invoice Register with the completed form field placeholder markup. See Using the Basic RTF Method for the completed basic RTF markup.
