Keith’s Cheat Sheets
0 (Jun ‘14)
Common Template Tags
<?element@inline?>
Insert the value of the first element relative to the current loc.
XSLT Equivalent
<xsl:value-of select=".//element[1]"/>
Examples
<?EMPLID?> <?UNT_TRNSFR + TRF_TAKEN_GPA?>
<?namespace@begin:prefix=url?>
Declare a namespace so that it can be used to access elements.
Examples
<?namespace:ua=http://arizona.edu?>…<?ua:EMPLID?>
<?if@block:condition?> … <?end if?>
Conditionally include wrapped content where condition is a BIP
expression which can also include XSLT 1.0 functions, XPATH 1.0
expressions and BIP extended functions.
XSLT Equivalent
<xsl:if test="condition"> … </xsl:if>
Examples
<?if:PRINT_FLAG="Y"?>A block paragraph.<?end if?>
<?if@inlines:DESCR<>""?><?DESCR?><?end if?>
<?for-each@block:element?>…<?end for-each?>
Cycle through all of the matching elements.
XSLT Equivalent
<xsl:for-each select=".//element">…</xsl:for-each>
Examples
<?for-each:ACAD_PROG?> … <?end for-each?>
<?for-each@inlines:CMNT?><?CMNT?> <?end for-each?>
<?sort@incontext:element;'order';'type'?>
Paired with <?for-each?>, sort the data by element, with the
contents treated as type (text or number), ordered by order
(ascending or descending).
XSLT Equivalent
<xsl:sort select=".//element" order="order"
data-type="type" />
Examples
<?for-each:ACAD_PROG?><?sort:SEQ_NBR?>…
<?for-each-group@block:element;group?> …
<?end for-each-group?>
Cycle through all of the matching elements, but only repeat the
loop once when the group element value changes.
XSLT Equivalent
<xsl:for-each-group select=".//element"
group-by="group"> … </xsl:for-each>
Examples
<?for-each-group:ACAD_PLAN;ACAD_PROG?>
<?ACAD_PROG?>…
<?for-each@block:current-group()?> …
Paired with <?for-each-group?>, cycle through just the elements
that share the current group value.
XSLT Equivalent
<xsl:for-each select="current-group()"> …
Examples
<?for-each@inlines:current-group()?><?ACAD_PLAN?>…
Keith’s Cheat Sheets
BI Publisher Templates v1.
Page Total Template Tags
BI Publisher Templates Although designed for running totals of amounts, these can be used for any totals.
<?choose@block:current-group()?> <?add-page-total:name;'element'?>
<?when:expression?> … <?end when?> Add the numeric value of element to the total variable name, for
<?otherwise:?> … <?end otherwise?> this page only. Typically used when the element is displayed.
<?end choose?> Examples
<?UNITS?><?add-page-total:totalUnits;'UNITS'?>
Conditionally include the first true when expression content, or
the optional otherwise content. <?show-page-total:name;'format'?> see format-number
Display the current page total stored in name. This displays the
Variable & Parameter Template Tags
full total regardless where it appears on the page, inc. headers.
Examples
<?xdoxslt:set_variable($_XDOCTX,'var',val)?>
Set a BIP variable named var, with the value val. <?show-page-total:totalUnits;'999D99'?>
For special template tags for carried-forward and brought-forward usage, see the
<?xdoxslt:get_variable($_XDOCTX,'var')?> full BI Publisher documentation.
Get a BIP variable named var.
Examples Page Region & Page Number Template Tags
<?xdoxslt:set_variable($_XDOCTX, 'uaCount',
xdoxslt:get_variable($_XDOCTX, 'uaCount') + 1)?> <?start:body?> … <?end body?>
Define a region as the body of the report, which implicitly defines
<?param@begin:name;[default]?>
the header as any preceding content, and the footer following.
Define and optionally set the default value of parameter name.
Can be repeated, such as with special context @last-page/@last-
The parameter is then accessed using the variable syntax $name.
page-first, after a section break, with last header & footer too.
<?variable@begin:name;'value'?> Examples
Header region.
Define and set the XSLT variable name to the given value.
<?start:body?>Body region.<?end body?>
Footer region.
Formatting Template Tags
==============Section Break==============
<?start@last-page:body?>Notes.<?end body?>
<?attribute@inline:name;'value'?>
Set the XSL-FO formatting attribute name, to the give value. <?split-by-page-break:?>
Insert a page break. Typically used in a repeating group.
<?format-number:element;'format'?>
Examples
Display the value of element, which must be a valid number,
… <?split-by-page-break:?><end for-each?>
formatted using the following formatting rules:
0 or 9 A digit, where 0's are padded, 9's are not. <?initial-page-number:page|'auto'?>
C or L Currency symbol or Local currency symbol. Set the page number, or prevent restarting after a section break.
G or D or S Thousands Grouping (,), or Decimal (.) separators, or Sign (+). Examples
MI or PR or PT Negatives are trailing, brackets <> or parenthesis (). <?for-each-group:EMPLID;CAREER?>
Examples <?initial-page-number:1?> …
<?format-number:GPA;'0D000'?>
<?section:force-page-count;'type'?>
<?format-date:element;'format';['timezone']?> Create pages as necessary to end the report of the correct
Display the value of element, which must be a valid date or number of pages according to type which may be 'end-on-even-
date/time, formatted using the following rules: (common only) layout', 'end-on-odd-layout', 'end-on-even' or 'end-on-odd'.
YYYY or YY or CC Year as 4-digit or 2-digit or century 2-digit.
MM Month as 2-digit. <?copy-to-bookmark:?>
MON or MONTH Month name abbreviated or full padded to 9 chars. {Microsoft Word table of contents}
D or DD or DDD Day of week (7), day of month (31) or day of year (366). <?end copy-to-bookmark?>
DY or DAY Day name abbreviated or full padded to 9 chars. Create PDF bookmarks from a previously generated Word table
HH or HH12 or HH24 Hour am/pm (two forms) or 24-hour. of contents. Both the table of contents and bookmarks remain.
MI or SS of FF(1..9) Minutes or seconds or fractional second (digits).
<?convert-to-bookmark:?>
AM or A.M. or PM or P.M. AM/PM indicator with or without periods.
LONG or MEDIUM or SHORT Abstract date only formats. {Microsoft Word table of contents}
<?end convert-to-bookmark?>
LONG_TIME or MEDIUM_TIME or SHORT_TIME Abstract date/time.
Examples Create PDF bookmarks from a previously generated Word table
<?format-date:DTTM;'DD/MM/YYYY HH:MI PM'?> of contents. Only the bookmarks remain, the table is discarded.
BI Publisher Templates v1.0 (Jun ‘14)
Keith’s Cheat Sheets
Dynamic Table Column Template Tags
<?split-column-header@column:element?>
Used in a column heading to define a dynamic (cross-tab) column
which is duplicated for each value of element. Pair with below.
<?split-column-date@cell:element?>
Used in a column cell to define a dynamic (cross-tab) column
which is duplicated for each value of element. Pair with above.
<?split-column-width:width?>
Optionally used with above, to define the column width. Unless a
unit is specified, the width is considered a part of the total width.
<?split-column-width-unit:multiplier?>
Optionally used with above, to define a multiplier which causes
the width to be converted to an absolute value in points (1/72").
<?horizontal-break-table:columns?>
Optionally used with above, to set a fix number of key columns to
repeat when dynamic columns repeat onto more than one page.
Context Qualifiers
Used as <?tag@context:?> or <xsl:tag xdofo:ctx="context">
@section
Tag affects or creates an entire section, including the header and
footer. Typically used with <?for-each@section:…?>.
@column
Tag affects an entire table column. Typically used with
<?if@column:…?> to hide/show an entire column.
@cell
Tag affects just the cell of a table. Typically used in combination
with @column to create dynamic columns.
@block
Tag affects an entire block of text, such as a Word paragraph or a
table cell. This is the default context for many tags. fo:block
@inblock
Tag is a single statement within a block.
@inlines
Tag affects consecutive smaller inline statements forming a string
of text. Typically used with <?if@inlines:…?>.
@inline
Tag is a single statement. fo:inline
@incontext
Tag is inserted immediately after the surrounding tags, such as
with <?sort:…?>.
@begin or @end
Tag is placed at the beginning/end of the XSLT stylesheet. Begin
context is applied to <xsl:variable> tags unless overridden.
Keith’s Cheat Sheets
BI Publisher Templates v1.0 (Jun ‘14)
Templates & Sub-Templates <?xdoxslt:left('str',length)?> use also right()
Return just the first length characters of string str.
<?template@end:name?>
Define a named template. The content will only be included <?xdofx:length('str')?> use also upper()
when called directly or matched by applying templates. Return the length of the string str in characters.
XSLT Equivalent
<?xdofx:lower('str')?> use also upper()
<xsl:template name="name"/>
Convert all uppercase characters in str to lowercase.
<?call@inblock:name?>
<?xdofx:lpad('str',length,'char')?> use also rpad()
Call a template which will include all of its content.
XSLT Equivalent Pad left the string str, to length chars, using character char.
<xsl:call-template name="name"/>
<?xdoxslt:minimum(elements)?> use also maximum()
<?apply@inline:elements?> Return the minimum value of all elements in the set.
Call any templates which match any of the elements selected. Examples
This will only match XSLT defined templates, not BIP templates. <?xdofx:minimum(../BEGIN_DT)?>
XSLT Equivalent <?xdoxslt:next_element(current-group(),.,
<xsl:apply-templates select="elements"/>
'element')?> use also prev_element()
<?import@begin:url?> Return the relative next element in the current group.
Import an XSLT or RTF file which should contain only template
<?xdofx:replace('str','from',['to'])?>
definitions. During testing this will be like "file:///U:/filepath.rtf",
Replace any and all occurrences of from, with to, in the string str.
on the server this will be like "psxmlp://CONTENT_ID".
<?xdoxslt:replicate('str',repeat)?>
Extended Functions Replicate the string str by repeat times, concatenated.
Prefixed xdofx: which mimic SQL equivalents, and xdoxslt: which extend XSLT.
<?xdofx:round(number,[places])?> also xdoxslt:round()
<?xdoxslt:abs(number)?>
Round number to the given number of places or zero.
Return the absolute value of number.
<?xdoxslt:sec_diff('datetime1','datetime2',
<?xdofx:chr(ascii)?> $_XDOLOCALE,$_XDOTIMEZONE)?>
Return the character for the ascii value.
Calculate the difference in seconds between datetime1 and
<?xdofx:ceil(number)?> use also floor() datetime2, where both date/times must be in the format
Return the smallest integer greater than or equal to number. 'yyyy-mm-ddThh:mm:ss'.
<?xdofx:decode('str','case','res'…,['othr']) <?xdoxslt:set_array($_XDOCTX,'array',index,
Search for a match between str and any case string, then return 'value')?> use also get_array()
the result res. If no match is found, the result othr is returned. Store in the named array, at the index, the given value.
Examples
<?xdofx:decode(FLAG,'A','Active','I','Inactive')?>
<?xdofx:substr('str',start,length)?>
Extract the substring of str, from start, for length characters.
<?xdoxslt:date_diff('units','date1','date2',
$_XDOLOCALE,$_XDOTIMEZONE)?> <?xdofx:sysdate()?>
Calculate the difference between date1 and date2, where both Returns the current system date/time.
dates must be in the format 'yyyy-mm-dd', and where the result <?xdoxslt:trim('str')?> use also ltrim() & rtrim()
is in units: y, m, w, d, h, mi, s, ms Trim both leading and trailing spaces from string str.
<?xdoxslt:get_day('date',$_XDOLOCALE)?> <?xdoxslt:truncate(number,[places])?>
Extract just the day part of a date which must be in the format Truncate the number to the given decimal places, where places
'yyyy-mm-dd'. Similarly use get_month() and get_year(). can be negative, and places defaults to zero.
<?xdofx:greatest(item1,[item2,…])?> use also least()
Embedded Image XSL-FO Elements
Return the greatest of all items, all are treated as type of item1.
<fo:instream-foreign-object content-type="image/?"
<?xdofx:instr('str','srch',[start],[nth]) height="h px|in|cm|%" width="w px|in|cm|%">
Return the position of the nth occurrence of srch within str, <xsl:value-of select="BASE64" />
starting at start, which can be negative to reverse the search. </fo:instream-foreign-object>
Image types supported are "image/gif", "image/jpg" and "image/png"
BI Publisher Templates v1.0 (Jun ‘14)