You are here

Advanced functions in the offline template builder

Use advanced SQL or XSL functions in your report layout to insert custom attribute fields, calculated using your own logic.

Before you begin

You should already be familiar with creating your own custom reports. This article assumes you have already created a report layout using the offline template builder.

We'll provide you with some examples to help you get started. Additional formulas can be found in the complete guide on BI Publisher Functions.

Formulas are defined using either XSL or SQL syntax. You cannot use both an XSL and SQL syntax within a single condition statement.

Jump to:

SQL and XSL Functions

The syntax for SQL and XSL functions for use in RTF templates is as follows:

For extended SQL functions: <?xdofx:expression?>
For extended XSL functions: <?xdoxslt:expression?>

You cannot mix SQL statements with XSL expressions in the same context. For example, assume you had two attributes, FIRST_NAME and LAST_NAME that you wanted to concatenate into a 30-character field and right pad the field with the character "x":

Incorrect syntax: <?xdofx:rpad(concat(FIRST_NAME,LAST_NAME),30, 'x')?>
Why? This syntax begins as an SQL expression, but concat is an XSL expression.

Correct syntax: <?xdofx:rpad(FIRST_NAME||LAST_NAME),30,'x')?>

Insert a Custom Field

  1. Click your mouse in the table cell where you want to place the custom field, then click Field from the insert panel. Insert any field from this list (it doesn’t matter which field is inserted as we are going to customize it’s display name and calculation)
insert a Field
  1. Right-click on the data field you inserted and select BI Publisher > Properties. Give your field a new label in Text to display
add display text
  1. Click the Advanced tab, and enter your formula in the Code field. (you’ll need to remove any text that was already entered there)
  2. Click OK. Your field will be inserted into your layout where you can apply formatting as required.
add custom code

Examples

The examples below in both XSL and SQL are specifically useful to Aconex users. 

XSL

Difference between two dates

Calculate the difference between two dates in the given locale. The dates need to be in "yyyy-mm-dd" format. This function supports only the Gregorian calendar.
Note: format is the time value for which difference is to be calculated. Valid values are: y - for year; m - for month; w - for week; d - for day; h - for hour; mi - for minute; s - for seconds; ms - for milliseconds
Formula: <?xdoxslt:date_diff(‘format’, ‘YYYY-MM-DD’, ‘YYYY-MM-DD’, $_XDOLOCALE, $_XDOTIMEZONE)?>
Sample: <?xdoxslt:date_diff(‘m’, ‘2001-04-08’, ‘2000-02-01’, $_XDOLOCALE, $_XDOTIMEZONE)?>
This example will display ‘-14’ as the result.

Add number of days to a date

Adds ‘x’ number of days to the given date_in field <?xdofx:date_in?>. Output is rendered in the same date format as that of ‘date_in’ field. 
Formula: <?xdoxslt:ora_format_date_offset(date_field, ‘x’, '+')?>
Sample: <?xdoxslt:ora_format_date_offset(date_in,4,’+’)?>

Conditional results (choose-when-otherwise)

Display different results when various conditions are met. Similar to switch/case/evaluate statements in other programming languages.
Fomula: <?choose:?> <?when:expression?> <?otherwise?><?end otherwise?> <?end choose?>
Sample: Identify all delayed steps in In- Progress Workflows that need action on priority. (if a Workflow step is delayed by over a week it needs immediate action & if it is delayed up to a week then it needs attention)
<?choose:?>
<?when:workflow_status='Completed'?><?end when?>
<?when:workflow_status='Terminated'?><?end when?>
<?when:days_late>7?>Immediate action<?end when?>
<?when:days_late=0?>On Track<?end when?>
<?when:days_late<=7?>Attention<?end when?>
<?end choose?>
Result:
‘Immediate action’ displays when days_late field <?xdofx:days_late?> is more than 7
‘Attention’ displays when days_late field <?xdofx:days_late?> is less than or equals 7

SQL

Add number of days to a date

Adds ‘x’ number of days to the given date_in field <?xdofx:date_in?>. Also formats the date output in DD-MM-YYYY.
Sample: <?format-date:xdoxslt:ora_format_date_offset(date_in,4,’+’);'DD-MM-YYYY'?>

Conditional text using ‘if’ statement

Use “if” statements to customize text in your report. As an example, for the sentence ‘The document is reviewed’, we can add the word ‘not’ depending on the value of a field named STATUS.
Sample: The document is <?if@inlines:STATUS='Overdue'?>not<?end if?> reviewed.
Result: If the STATUS is ‘Overdue’ the text will read ‘The document is not reviewed’. Otherwise, it will read ‘The document is reviewed’

Conditional results (if-then-else)

Uses an if-then-else condition to display a customized Status.  The Status displays as ‘Late’ if date_in is greater than revision_date, otherwise it displays ‘On Time’.  The field displays as ‘Not Started’ if date_in is NULL (empty).
Sample: 
<?xdofx:If(date_in IS NOT NULL) then
if(date_in>revision_date)
then ‘Late’
else ‘On Time’
end if
else ‘Not Started’
end if?>

Additional formulas can be found in the complete guide on BI Publisher Functions.

Sample template files with custom logic

Download our .RTF sample templates with examples of XSL/SQL logic. The two samples are provided for further learning and practicing your own formulas. 

How to use the sample files:

  1. Read through the examples below, and decide which one you'd like to try.
  2. Download the RTF template(s).
  3. Define a report data model using the specified subject areas and attributes for the chosen example. 
  4. Export the data model to XML.
  5. Import the XML file into the RTF template.
  6. Have fun! Feel free to alter the template and add your own custom logic.

We've chosen Workflows for these samples, but you can select any available subject area when you create your reports. Custom logic can also be applied to Cost printable reports. The process to create and design your RTF template (adding components such as tables and charts and using formulas) remains the same, however the main subject area selection will be specific to the Cost records (such as Change Event).

Example 1. Workflow efficiency report

Calculate the efficiency of Workflows initiated or assigned to your organization.


RTF Example 1 - Workflow efficiency report


Data Model

Main subject area: Workflow.
Attributes: Original Due Date, Estimated Due Date, Workflow Name, Workflow No, Workflow Status, Start Date.



 

Calculated Field Logic

Original days of completion

Difference between start date and original due date.

	<?xdoxslt:date_diff(‘d',
	start_date,original_due_date,
	$_XDOLOCALE, $_XDOTIMEZONE)?>

Estimated days of completion

Difference between start date and estimated due date

	<?xdoxslt:date_diff(‘d',
	start_date,estimated_due_date,
	$_XDOLOCALE, $_XDOTIMEZONE)?>

No. of Workflows

Unique count of workflow numbers.

	<?for-each:workflow?>
	<?xdoxslt:set_variable($_XDOCTX,'c',xdoxslt:get_variable($_XDOCTX,'c')+ 1) ?>
	<?end for-each?>
	<?xdoxslt:get_variable($_XDOCTX,'c') ?>

Efficiency

If the Estimated Due Date is on or before the Original Due Date, then the workflow efficiency is 1. Otherwise, the efficiency is Original Days of Completion divided by the Estimated days of completion.

	<?xdoxslt:ifelse((estimated_due_date < original_due_date),
	1.00,
	xdoxslt:div(1,(xdoxslt:div(xdoxslt:date_diff(‘d', start_date,estimated_due_date, $_XDOLOCALE,
	$_XDOTIMEZONE) , xdoxslt:date_diff(‘d', start_date,original_due_date, $_XDOLOCALE,
	$_XDOTIMEZONE)) ))
	)
	?>

Average efficiency

Sum of efficiency divided by the number of workflows.

	<?for-each:workflow?>
	<?xdoxslt:set_variable($_XDOCTX,'w',xdoxslt:get_variable($_XDOCTX,'w')+
	xdoxslt:ifelse((estimated_due_date < original_due_date),
	1.00,
	xdoxslt:div(1,(xdoxslt:div(xdoxslt:date_diff(‘d', start_date,estimated_due_date, $_XDOLOCALE,
	$_XDOTIMEZONE) , xdoxslt:date_diff(‘d', start_date,original_due_date, $_XDOLOCALE,
	$_XDOTIMEZONE)) ))
	)
	)?>
	<?end for-each?>
	<?xdoxslt:round ( xdoxslt:get_variable($_XDOCTX,'w') div xdoxslt:get_variable($_XDOCTX,'c'),3) * 100 ?>

Example 2. Workflow progress report

Calculate how documents on your Workflows are progressing. Assign a new due date to the documents attached in the Workflow steps.

Specifically:
1. Show a calculated review status of a document attached in a Workflow Step. Status is On-time or Late
2. Show the next due date (calculated using custom logic) for reviewing a given document attached in the Workflow step.


RTF Example 2 - Workflow progress report


Data Model:

Main Subject Area: Workflow Steps
Main Subject Attributes: Date In, Step Status, Workflow Name, Workflow, No, Document No, Assigned To Org. 
Supporting Subject Area: Workflow Documents
Supporting Subject Attributes: Document No, Type, Revision, Discipline, Revision Date, Date Approved



Calculated Fields:

Status

If the Date In is after the Revision Date, then the Document will be given the status “Late”. Otherwise it's “On-time”.

	<?xdofx:
	If( date_in IS NOT NULL) then
	if (date_in > revision_date)
	then 'Late'
	else 'On Time'
	end if
	else ''
	end if?>

Next Due Date

Add “N” days to the Date In (N = four days in this example)

	<?xdoxslt:ora_format_date_offset(date_in,'4', '+')?>

What's next?

Have a play with these sample RTF files and try to create more complex calculated fields using your own logic.
See the related articles for more help.

Was this article helpful?

Thanks. A ticket has been opened with the Support Central team.