Implementation Guide for Oracle Billing Insight > Customizing the Payment Consolidator Integration Module > Creating Customized Payment Consolidation Templates >
Template Variables
The template engine hosts a pool of objects in its context in the form of a hash table. You can refer to the variables in that context by their names, between a pair of percentage sign (%) delimiters. The delimiter character distinguishes between common text messages and special placeholders, which are processed by the template engine to replace the values of the Java objects. For example, there's an IFileRecord object with the name fileHeaderRecord in the template context, and you can refer to the object using %fileRecord%. To escape %, use %%. For example, %%40 means %40. Oracle Billing Insight provides some preconfigured variables you can use in the XML template files. Some variables can be used in the record template files only. See Table 83 for a list. You can use the variables described in Table 82 in either file structured or record XML template files.
Table 82. Variables for All XML Template Files
|
|
|
cartridgeProperty |
java.util.Properties |
Contains all of the properties configured in the cartridge properties file. The cartridge properties file maps different values with the same key for a payment consolidator. You can define your own properties which can be used directly in template files by invoking the setProperty method of object cartridgeProperty, for example: $cartridgeProperty.setProperty("newKey", "newValue")$ |
template |
com.edocs.payment.util. template |
The template object used to parse the template file. |
templateDir |
java.lang.String |
The directory where the template files are located for a payment consolidator. You set this value in the Command Center when setting up the payment consolidator. |
dateUtil |
com.edocs.common.pc.util. DateUtil |
The utility class for processing data of Date type. |
stringUtil |
com.edocs.payment.util. StringUtil |
The utility class for processing data of String type. This variable makes calling the static methods of StringUtil easier. Use stringUtil.concat("a","b","c")% instead of %com.edocs.payment.util. StringUtil.concat("a","b","c")% |
decimalUtil |
com.edocs.payment.util. DecimalUtil |
The utility class for processing data of Decimal type. |
Table 83 shows the variables that you can use in record XML templates only.
Table 83. Variables for Record XML Templates Only
|
|
|
|
FileHeader |
fileHeaderRecord |
com.edocs.common.pc. core.FileRecord |
Sets or gets file header record information. |
BatchHeader |
batchHeaderRecord |
com.edocs.common.pc. core.BatchRecord |
Sets or gets batch header record information. |
Detail |
detailRecord |
com.edocs.common.pc. core.DetailRecord |
Sets or gets detail record information. |
Detail |
flexibleFields |
Java.util.HashMap |
A property member of the detail record object which is used to set or get extended field information. |
BatchTailer |
batchTailerRecord |
com.edocs.common.pc. core.BatchRecord |
Sets or gets batch tailer record information. |
FileTailer |
fileTailerRecord |
com.edocs.common.pc. core.FileRecord |
Sets or gets file tailer record information. |
|