Temenos Document Output

InclusiveBankingSuite
Document Output
Information in this document is subject to change without notice.
No part of this document may be reproduced or transmitted in any form or by any means,
for any purpose, without the express written permission of TEMENOS HEADQUARTERS SA.
© 2015 Temenos Headquarters SA - all rights reserved.

Document Output User Guide
Table of Contents
Document History ............................................................................................................................. 4
Introduction ....................................................................................................................................... 5
Document Purpose ....................................................................................................................... 5
Assumptions ................................................................................................................................. 5
Exclusions ..................................................................................................................................... 5
References .................................................................................................................................... 5
Document Output: Operations .......................................................................................................... 6
Overview ....................................................................................................................................... 6
Document Definition ...................................................................................................................... 6
Document Requests ..................................................................................................................... 7
Manual Request ........................................................................................................................ 7
Automatic Request .................................................................................................................. 10
Document Viewing ...................................................................................................................... 10
Document Output Services ......................................................................................................... 12
Document Production .............................................................................................................. 12
Bulk Document Requests ........................................................................................................ 12
Document Output: Configuration .................................................................................................... 13
Overview ..................................................................................................................................... 13
Document Production Service ................................................................................................. 14
Repository Viewer ................................................................................................................... 16
JasperReports Library ............................................................................................................. 17
Document Parameterization ....................................................................................................... 18
Parameterisation Menu ........................................................................................................... 18
General Parameters ................................................................................................................ 18
Document Classes .................................................................................................................. 24
Data Sources ........................................................................................................................... 25
Dynamic Tables ....................................................................................................................... 31
Field Conversions .................................................................................................................... 34
Document Triggers .................................................................................................................. 35
Printers .................................................................................................................................... 37
Operations Menu ..................................................................................................................... 37
Request Document.................................................................................................................. 37
Bulk Request Document ......................................................................................................... 38
Document Verify Queue .......................................................................................................... 41
View Repository ...................................................................................................................... 42
Document Processing Queue ................................................................................................. 43
List of Templates ..................................................................................................................... 44
New Template ......................................................................................................................... 45
2 InclusiveBankingSuite: Product
List Documents ........................................................................................................................ 45

New Document ........................................................................................................................ 46
Document Output: Layout Design .................................................................................................. 52
Jaspersoft Studio ........................................................................................................................ 52
Introduction .............................................................................................................................. 52
Report Life Cycle ..................................................................................................................... 52
Report Structure in Jaspersoft Studio ......................................................................................... 52
Overview ................................................................................................................................. 52
What is a Band ........................................................................................................................ 53
Band Types ............................................................................................................................. 53
Jaspersoft Studio Tutorials ...................................................................................................... 55
Working with Document Output Report File ............................................................................... 55
Overview ................................................................................................................................. 55
Defining Data Adapter ............................................................................................................. 56
Using Document Output Data ................................................................................................. 57
Designing Report Layout ......................................................................................................... 58
Creating First Document ......................................................................................................... 60
Font Extensions .......................................................................................................................... 63
Overview ................................................................................................................................. 63
Creating Font Extension .......................................................................................................... 63
Exporting Font Extension ........................................................................................................ 64
Document Output: Customization .................................................................................................. 65
Overview ..................................................................................................................................... 65
Drilldown Enquiries ..................................................................................................................... 65
View Repository ...................................................................................................................... 65
Request Account Documents .................................................................................................. 65
Request Customer Documents ............................................................................................... 66
Request Document Screen ......................................................................................................... 66
Dynamic Version Routine ........................................................................................................ 66
Document Triggers ..................................................................................................................... 66
Version Authorisation Routine ................................................................................................. 66
Delivery Module with Document Output ..................................................................................... 67
Parameterisation ..................................................................................................................... 67
Document Output API ................................................................................................................. 68
Parameterisation ..................................................................................................................... 68
Data Source ............................................................................................................................ 71
Dynamic Table ........................................................................................................................ 72
Field Conversion ..................................................................................................................... 73
Document Trigger.................................................................................................................... 73
Bulk Request ........................................................................................................................... 74
Notes .............................................................................................................................................. 75
Document History
Author Version Date
Lukasz Czechowicz 1.0 21st January 2016
Lukasz Czechowicz 1.1 28th January 2016
Lukasz Czechowicz 1.2 5th February 2016
Lukasz Czechowicz 1.3 27th September 2016
Comments:
Introduction
Document Purpose
This document provides an overview of the Document Output functionality and describes how the
functionality can be configured to meet specific business requirements. It is aimed at business users
that will work with the system and implementation teams that will configure it.
Assumptions
It is assumed that the reader of this guide is proficient in the Temenos Core Banking system, worked
with the Browser channel application and understands the structure and navigation of the
InclusiveBankingSuite Role Based Home Pages. For configuring the functionality, it is assumed that
the reader has prior implementation experience and understands the technical concepts of the
Temenos Core Banking system.
For designing the document layouts, it is assumed that Jaspersoft Studio is installed on the user’s
computer. Jaspersoft Studio can be downloaded from this website:
http://community.jaspersoft.com/project/jaspersoft-studio/releases
Please download version 6.0.4 which has been verified with this release of the
InclusiveBankingSuite Document Output functionality.
Exclusions
This document does not explain in every detail the Jaspersoft Studio application. Please refer to
the links provided throughout this document to gain better understanding of the Jaspersoft Studio
software.
References
InclusiveBankingSuite Role Based Home Pages user guide.
Jaspersoft Studio tutorial, tips & tricks and other useful information can be found on the following
website:
https://community.jaspersoft.com/project/jaspersoft-studio/resources
Complete documentation on Jaspersoft Studio can be downloaded from the following website:
http://community.jaspersoft.com/documentation?version=13758
Document Output: Operations
Overview
The Document Output functionality encompasses creation, delivery, viewing and archiving of PDF
documents in the InclusiveBankingSuite. Based on the JasperReports® Library, the world’s most
popular open source reporting engine, and Jaspersoft® Studio, the report designer, it allows pixel-
perfect document design, including sophisticated layouts containing charts, images, crosstabs and
much more.
The following are the main features of the Document Output functionality.
 Mapping data from system files, Delivery (DE) module or external sources to PDF
documents.
 Pixel-perfect PDF layout design (using external Jaspersoft Studio software).
 Automatic or ad-hoc production of PDF documents.
 Storage of PDF documents using built-in repository.
 Viewing of PDF documents from the repository directly in the Browser application.
 Automatic delivery (print, email, SMS) of PDF documents to a predefined or customer’s
preferred channels (print, email, SMS).
Document Definition
Before explaining the operations in detail, it is important to understand some of the concepts of the
Document Output solution. A Document in the Document Output module holds the following main
attributes:
 Document Class – each document is assigned a class. The document class may group
documents of similar type or indicate common characteristics. Examples of document
classes:
o Customer Letter
o Statement
o Transaction Advice
o Lending Report.
 Document Type – indicates the document category. Examples of document types:
o Welcome Letter
o Account Statement
o Cash Withdrawal Receipt
o Portfolio at Risk
 Main Data Source – this is the main driver for the document’s data mapping. Examples:
o Customer – the main data source for a Welcome Letter would be a customer
number, as such letter contains customer related data.
o Account – the main data source for an Account Statement would be an account
number, as it contains transactions from the account.
o Teller Transaction – the main data source for Cash Withdrawal Receipt would be a
teller transaction reference, as the transaction contains amount, value date, and
narrative.
o Account Officer – the main data source for Portfolio at Risk report would be an
account officer number, as the report is produced per account officer.
 Linked Customer – this is the customer the document is linked to. The document produced
would be delivered to this customer, stored in this customer’s repository, and could be
viewed from this customer’s Documents page. In most cases, the Linked Customer can be
derived from the Main Data Source.
Document Requests
Documents in the Document Output module can be requested manually or produced automatically
by the system, based on various triggers.
Manual Request
The manual document request options are available in the Single Customer View screen, in the
following sections:
 Accounts tab – documents driven by Account data source.
 Documents tab – documents driven by Customer data source.
Account Documents
In the Accounts tab, select Request Document option beside the account for which a document
needs to be produced.
This option opens up a list of account-related documents available in the system:
There is one document available in the InclusiveBankingSuite – account statement. Clicking on

the icon beside the required document, takes us to the actual document request application.
The following fields are available on this application:
Field Description
Document Description of the document being requested.
Data Source The main data source of the document being requested.
Data Source Id The ID of the above data source record, for which the document is
being requested. It is defaulted with the account number selected in
the account list.
Customer Id The linked customer number, defaulted by the system.
Settings Tab
Number of Copies The number of copies printed for this document request, if the
delivery channel is a printer.
Default Address The default address the printed document would be delivered to.
Override Address The default address can be overridden using this field.
Default Channel The default delivery channel by which the document would be
delivered.
Override Channel The default delivery channel can be overridden using this field.
Once the record is committed on this application, the document request is sent.
Customer Documents
In the Documents tab, select Request Document option above the Documents header. The
document would be produced for the currently selected customer.
This option opens up a list of customer-related documents available in the system:
There is one document available in the InclusiveBankingSuite – welcome letter. Clicking on the
icon beside the required document, takes us to the actual document request application.
It is the same application that is used for account documents. Once the record is committed on this
application, the document request is sent.
Automatic Request
The Document Output module allows automatic production of documents based on various triggers.
There are three sources of automatic document production:
 Version Event – input/authorisation of a record.
 Delivery Module – message produced by the core delivery module.
 API calls from COB jobs or other applications/processes.
Creation of the automatic document production triggers is explained in more detail in the
Configuration chapter.
Document Viewing
Documents produced by the Document Output module can be viewed directly in Browser, from the
Single Customer View screen, Documents tab.
Clicking the View icon beside the selected item opens up a new window showing the PDF
document.
Below is a view of account statement.
Below is a view of a welcome letter.
Document Output Services
Document Production
The ccc/DO.PROCESS.LOCAL and ccc/DO.PROCESS.BULK services (where ccc is a company
mnemonic) need to run in AUTO mode for the creation of PDF documents in the given company.
It is recommended to set the Review Time for the ccc/DO.PROCESS.LOCAL service as 3 seconds,
so that the documents requested for a local printer are generated shortly after the request.
Bulk Document Requests

When using the bulk document request functionality, the ccc/DO.BULK.REQUEST service should
be running in AUTO mode.
Document Output: Configuration
Overview
The Document Output functionality can be configured to meet specific business requirements.
Before drilling into more detail, let us look at the main components of the solution and how they
work together.
Temenos Core File Storage External
Parameters / Data
Sources
Document Jaspersoft Studio

Document Layout
Definition
Library
Document
Request / Trigger
XML Data
JasperReports Library
Document
Production Service
PDF
Document
Repository Viewer Document Delivery

Document (Print/Email/SMS)
Repository
The Temenos Core components encompass the applications used for configuring the Document
Output functionality (general parameters, data mapping, template/document definitions, document
triggers, document production service) and for operating the module (document requesting and
viewing).
The File Storage area contains files used by the Document Output module. The file locations can
be configured from the general parameters application.
The External components contain 3rd party software (Jaspersoft Studio, JasperReports Library)
used for PDF design/creation and implementation specific software for document delivery
(printing, email/SMS delivery).
Document Production Service

The ccc/DO.PROCESS.LOCAL and ccc/DO.PROCESS.BULK services need to run in AUTO
mode for PDF generation. These services use Jasperreports Library, compiled .jasper report
definition and XML file with data to create the required PDF.
The services use a local file DO.QUEUE to store documents requests. This file can be searched
for document processing errors using the Document Processing Queue option in the Operations
menu.
Document production errors can be viewed from this enquiry using the View option.
Document requests can be resubmitted using the Resubmit Action.
The general flow of statuses on the DO.QUEUE record is presented below.
02 Document Missing
00 Queued
03 Customer Missing
Data Mapping 05 Data Source Error
06 Dynamic Table Error

10 Mapped
08 XML Create Error
PDF Creation 13 PDF Path Error
15 PDF Creation Error

20 Created
Optional Verification
25 Awaiting Verif.
Verification 27 Rejected
30 Verified
Repository Store Repository Error
Delivery Delivery Error
40 Complete
Repository Viewer
The repository viewer application should be installed in the web server in order to view documents
from the repository in Browser. The application is called DocRepoWebApp and is referenced in the
main parameter file. The standard location of the repository viewer is the web application server
hosting Browser.
The DocRepoWebApp application uses configuration file that defines the path to document
repository and temporary PDF creation area (used in document verification process, explained later
in this chapter), as well as document read retry parameters. The file is named web.xml and can be
found in WEB-INF folder of the main application .war folder. The following parameters are used:
<context-param>
<description>Root path of document repository</description>
<param-name>DocRepoRootPath</param-name>
<param-
value>/temenos/R14/ENV/[ENVIRONMENT]/bnk/bnk.run/T24Documents/</param-value>
</context-param>
<context-param>
<description>Work documents repository</description>
<param-name>WorkDocRepoRootPath</param-name>
<param-
value>/temenos/R14/ENV/[ENVIRONMENT]/bnk/bnk.run/T24DocumentOutput/pdf/</param-value>
</context-param>
<context-param>
<description>No of file read attempts with wait parameter</description>
<param-name>WaitNoAttempts</param-name>
<param-value>30</param-value>
</context-param>
<context-param>
<description>Sleep amount in seconds for wait parameter</description>
<param-name>WaitSleep</param-name>
<param-value>1</param-value>
</context-param>
Parameter Name Description
DocRepoRootPath Root path of document repository. This should be the same path
that is defined in Repository Path field on the main Document Output
parameter file (see next paragraph).
WorkDocRepoRootPath Working (temporary) documents path. This should be the same path
that is defined in PDF Creation Path field on the main Document
Output parameter file (see next paragraph).
WaitNoAttempts Number of file read attempts for document retrieval, used in

combination with the below parameter. Because PDF documents
are created by a service, it may take a few seconds (depending on
the service review setting) before a document becomes available in
the repository/temporary path. This parameter tells how many time
the read will be repeated before the viewer returns error (no
document).
WaitSleep Wait period in seconds between consecutive document reads.
JasperReports Library
The JasperReports library is written in Java and should be available in the Temenos
InclusiveBankingSuite environment, for generating PDF documents. The library is provided as a set
of .jar files and by default is located in the jars/DocumentOutput folder of the environment’s bnk.run
path.
The jasper_lib folder contains all the .jar files required by the JasperReports library, and is linked
through the DocumentOutput-6.0.4.jar package.
Both do_fonts.jar and DocumentOutput-6.0.4.jar packages need to be included in the CLASSPATH
environment variable (in .profile or remote.cmd), for the document output functionality to work.
Document Parameterization
The Document Output tab in the Parameterisation section of the selected Role Based Home Pages
exposes all the applications used in configuring the Document Output functionality. The entry screen
is presented below.
Parameterisation Menu
The Parameterisation menu points to the different applications and enquiries used to configure
documents.
Each of the menu items is explained in more detail in the following paragraphs.
General Parameters
The General Parameters menu opens application where the main module parameters are set.
There are two levels of parameterisation:
 Global – parameters stored under a record with ID equal to ’SYSTEM’
 Company-specific – parameters stored under a record with ID equal to the COMPANY ID.
In general, only the ‘SYSTEM’ record is required for the module to work. If the parameters are to be
specific to a particular company, then appropriate record should be created for that company, which
will override the SYSTEM record settings.
In this guide we will only use the Global parameters – record with ID equal to ‘SYSTEM’.
File Locations and Repository Settings

When the record id is input, the following screen will appear. This section defines locations for the
different files used/created by the module.
Field Description
Module Data Path This is where the Document Layout Library files will be stored. The
directory given here should exist before authorising the record. On
authorisation, the required sub-directory structure will be created
automatically.
This is where the temporary XML data files used for document
production will be stored. The directory given here may not exist
before authorising the record; it will be created automatically when
required. There are two special keywords that can be used in the
path name:
[ENVIRONMENT] – will be replaced by the environment name
originating the document
[COMPANY] – will be replaced by the company name originating
the document
These special keywords are useful when there are multiple
environments on the same server and/or multiple companies in the
same environment, to separate files produced from these separate
entities.
PDF Creation Path This is where the temporary PDF documents will be created, before
moving to document repository. The directory given here may not
exist before authorising the record; it will be created automatically
when required. There are two special keywords that can be used in
the path name:

the document
same environment, to separate files produced from these separate
entities.
Repository Type This field defines how the PDF documents will be stored in the
system. ‘Standard’ means that the documents will be stored in a
directory structure under the path given in ‘Repository Path’
parameter below. ‘User’ means that a special user routine (defined
in the ‘Repository Routine’ parameter below) would have to be
developed by a user, if e.g. storage in a database was required. The
module by default implements only the ‘Standard’ repository type.
Repository Routine This field defines the user routine to store PDF documents in
repository. More details on how the routine should be written will be
provided in the ‘Developer API’ section.
Repository Path This is the path under which the directory structure for ‘Standard’
repository type will be created and where the PDF documents will be
stored. The directory given here may not exist before authorising the
record; it will be created automatically when required. There are two
special keywords that can be used in the path name:
the document
same environment, to separate repositories maintained for these
separate entities.
Rep Viewer URL This is URL for the repository viewer used in the Browser application.
The repository viewer web application is provided as part of the
Document Output package and should be installed in the web
application server (can be the same server where Browser is
installed). The URL will point to the application server IP – i.e. only
the IP address and port number should be updated, the repository
application name (DocRepoWebApp/DownloadServlet) will remain
the same.
Retain Period This parameter defines how many days the temporary XML/PDF
files will be kept in their locations before being deleted by the
archiving process. If nothing is provided in this parameter, the
temporary files will never get deleted by the system.
Header & Footer

The ‘Header & Footer’ section defines static header and footer elements that may be used in the
document layout.
Field Description
Name This is the institution name that can be mapped to the PDF
document.
Address Four address lines that can be mapped to the PDF document.
Phone Contact phone number.
Fax Fax number.
Email Email address.
Website Company website.
Legal Footer This is the legal disclaimer that can be mapped to the PDF
document. Usually it appears in small letters at the bottom of
documents, and e.g. states the banking license number.
Address Mapping
The ‘Address Mapping’ section defines how the customer name, postal/legal address lines will be
built for the PDF documents. It also defines where to find the email/mobile number for customers.
Field Description
Name Field This multi-value field specifies the fields from CUSTOMER record
that will be used to build customer name to be used in the PDF
documents – in address lines. The fields given here will be separated
by space in the resulting name. In the above example, the customer
name will be built from fields TITLE, NAME.1 and SHORT.NAME.
Get Name Routine If the ‘Name Field’ parameter is not sufficient to define/retrieve the
customer name, a routine can be attached here instead, that will
return the customer name. More details on how the routine should
be written will be provided in the ‘Developer API’ section.
Address Source This field defines the address source for PDF documents. ‘Customer’
means that the address will be composed from the fields available
on the CUSTOMER record. ‘De.address’ means that the address will
be composed from the fields available on the DE.ADDRESS record.
‘Routine’ means that the address will be returned by a user-defined
routine.
DE Postal Carrier No If the ‘Address Source’ is set to ‘De.address’, then this field will allow
input and contain the carrier name/number that contains the
postal/correspondence address. For example, carrier PRINT.1.
DE Legal Carrier No If the ‘Address Source’ is set to ‘De.address’, then this field will allow
input and contain the carrier name/number that contains the legal
address. For example, carrier PRINT.2.
Postal Address Field This multi-value field defines how the postal/correspondence
address lines will be built, using fields from CUSTOMER or
DE.ADDRESS record – respectively for the ‘Address Source’ setting.
The value in this field can contain valid field name from the above
applications, optionally followed by ‘+’ character. The ‘+’ character
means that the subsequent field will be added to the same address
line. In the example above, we can see that the PO.BOX.NO will be
on the first address line, PO.SUBURB.TOWN and
PO.CITY.MUNICIP will be on the second address line, and
PO.PROV.STATE and PO.POST.CODE will be on the third line. This
field will be enabled for input only for ‘Customer’ and ‘De.address’
address sources.
Legal Address Field This multi-value field defines how the legal address lines will be built,
using fields from CUSTOMER or DE.ADDRESS record –
respectively for the ‘Address Source’ setting. The value in this field
can contain valid field name from the above applications, optionally
followed by ‘+’ character. The ‘+’ character means that the
subsequent field will be added to the same address line. This field
will be enabled for input only for ‘Customer’ and ‘De.address’
address sources.
Get Address Routine This field defines the address routine to return the address lines if
the above ‘Customer’/’De.address’ mappings are not sufficient. The
field will be enabled for input only for ‘Routine’ address source. More
details on how the routine should be written will be provided in the
‘Developer API’ section.
Email Field This field indicates which field on CUSTOMER record contains the
customer email address.
Get Email Routine This field defines the routine to return email address of the customer.
It should be used when the email address cannot be found on the
CUSTOMER record. More details on how the routine should be
written will be provided in the ‘Developer API’ section.
Mobile Field This field indicates which field on CUSTOMER record contains the
customer mobile number.
Get Mobile Routine This field defines the routine to return mobile number of the
customer. It should be used when the mobile number cannot be
found on the CUSTOMER record. More details on how the routine
should be written will be provided in the ‘Developer API’ section.
Delivery Settings
The ‘Delivery Settings’ section defines how the documents will be delivered to the respective
channels.
Field Description
Use Preferred Channel This field specifies if the delivery channel should be selected using
customer’s preferred channel. If this field is set to ‘Yes’, then the
‘Channel Routine’ below should be defined.
Channel Routine This field defines the routine used to return customer’s preferred
delivery channel. It is mandatory if the above setting is ‘Yes’. More
details on how the routine should be written will be provided in the
Print Server URL This is URL for the print server. The print server is provided as part
of the Document Output package and should be installed in the web
application server (can be the same server where T24 Browser is
installed). The URL will point to the application server IP – i.e. only
the IP address and port number should be updated, the print server
name (PrintWeb) will remain the same.
Default Printer This is the name of the default printer that will be used for printing
when no printer is defined for user/document/document class. This
printer should be available to the print server above.
Print Routine This field defines the routine to print documents, if the above print
server is not sufficient as the solution. More details on how the
routine should be written will be provided in the ‘Developer API’
section.
Send Email Routine This field defines the routine to send email messages from the
system. More details on how the routine should be written will be
Send SMS Routine This field defines the routine to send SMS messages from the
system. More details on how the routine should be written will be
Document Classes
The Document Classes menu opens application for defining document classes for the Document
Output module. Document classes are used for grouping together similar type of documents and
setting their common parameters.
Field Description
Description Description of the document class.
View Role This multi-value field specifies the user roles (USER.SMS.GROUP)
that can view documents of this class. If left blank, no viewing
restrictions will be applied at the document class level. This setting
can be overridden by similar field at the document level.
Request Role This multi-value field specifies the user roles (USER.SMS.GROUP)
that can request documents of this class. If left blank, no requesting
restrictions will be applied at the document class level. This setting
can be overridden by similar field at the document level.
Customer View This field specifies if customers are allowed to view documents of
this class (e.g. in internet banking).
Bulk Printer This is the name of the printer that will be used for printing
documents of this class, if no printer is defined for user/document.
This printer should be available to the print server setup on the
delivery parameters.
Data Sources
The Data Sources menu opens application for defining data sources for the Document Output
module. Data sources are used to define mapping between T24/external data and the PDF
documents.
There are following types of data sources available in the module:
 T24 File – data source used to map data from T24 files, e.g. CUSTOMER, ACCOUNT
 T24 Delivery – data source used to map data from T24 delivery module – specific delivery
message types
 T24 Environment – data source used to map data from T24 environment, e.g. TODAY
date, system date, current operator, etc.
 Input – data source used to map data from user input during the document generation
request
 External – data source used to map data from external files, e.g. images, text files
 Static – data source used to map static values
Each data source definition contains two common fields:
Field Description
Description Description of the data source.
Source Type Defines the type of the data source.
T24 File Data Source

T24 File Data Source is used to map data from T24 applications/files (e.g. CUSTOMER, ACCOUNT,
FUNDS.TRANSFER) into PDF document.
When ‘T24.file’ source type is selected, fields in the ‘T24 File’ tab become available for input.
Field Description
T24 Source File This field specifies from which file the data will be mapped.
Customer Field This defines the field on the above file that contains the customer
number. This is required as each document in the repository is
attached to customer. If there is no such field on the file, then the
‘Customer Routine’ must be used to define the link between this data
source and customer.
Customer Routine This field defines the routine to retrieve customer number from a ‘T24
Source File’ record. More details on how the routine should be
written will be provided in the ‘Developer API’ section.
Field Name This field together with ‘Type’, ‘Source Field’ and ‘Conversion’
constitutes a multi-value group. The ‘Field Name’ defines the name
under which this data element will be visible when designing the PDF
document layout in Jaspersoft Studio. It is recommended to name
the fields in MixedCase (e.g. AccountName instead of
ACCOUNT.NAME), for better readability in Jaspersoft Studio.
Type Defines the type of the field (Text/Number/Date).
Source Field The name of the field on ‘T24 Source File’ used to fill the data
element – as defined on the STANDARD.SELECTION record. It can
also be a routine, if prefixed with @ and not as ‘@ID’. More details
on how the routine should be written will be provided in the
Conversion This is sub-value field that can contain multiple conversions to be

applied on the ‘Source Field’ value before mapping to the PDF
document. The list of available conversions is given later in the ‘Field
Conversions’ section. It can also be a routine, if prefixed with @.
More details on how the routine should be written will be provided in
the ‘Developer API’ section.
T24 Delivery Data Source

T24 Delivery Data Source is used to map data from T24 Delivery module into PDF documents. The
mapping is based on the fields defined on DE.MESSAGE record.
When ‘T24.delivery’ source type is selected, fields in the ‘T24 Delivery’ tab become available for
input.
Field Description
DE Message Id This field specifies from which DE message type the data will be
mapped. This is a hot-field and when a value is selected, the list of
available fields from DE.MESSAGE is populated on the record.
Field Name This field together with ‘Type’, ‘Source Field’ and ‘Conversion’
the fields in MixedCase, for better readability in Jaspersoft Studio.

Such convention is also used when the list is auto-populated from
the DE.MESSAGE record. There are three special fields without
source field mapping: DE-HeaderId, DE-Customer, DE-
TransactionRef – they will be mapped from the respective
DE.O.HEADER record from the delivery module.
Type Defines the type of the field (Text/Number/Date).
Source Field The name of the field on DE.MESSAGE record used to fill the data
element.

T24 Environment Data Source

T24 Environment Data Source is used to map data from the environment where the Document
Output module resides.
When ‘T24.environment’ source type is selected, fields in the ‘T24 Environment’ tab become
available for input.
Field Description
Field Name This field together with ‘Environment Variable’ constitutes a multi-
value group. The ‘Field Name’ defines the name under which this
data element will be visible when designing the PDF document
layout in Jaspersoft Studio. It is recommended to name the fields in
MixedCase, for better readability in Jaspersoft Studio.
Environment Variable Defines which environment variable will be used to fill the data
element.
List of available environment variables:
Variable Name Description
Lworkday T24 last working day date in YYYYMMDD format.
Today T24 today date in YYYYMMDD format.
Sysdate Server date in YYYYMMDD format.
Time.hhmm Current server time in HH:MM format.
Time.hhmmss Current server time in HH:MM:SS format.
User.full Name taken from USER>USER.NAME field.
User.short Name taken from USER>USER.NAME field – first name initial only.
Input Data Source

Input Data Source is used to map data from values provided by user during document request.
When a document with input data source is requested, the system would present an additional
stage where the values should be input by user.
When ‘Input’ source type is selected, fields in the ‘Input’ tab become available for input.
Field Description
Field Name This field together with ‘Type’, ‘User Prompt’ and ‘Mandatory’ fields
the fields in MixedCase, for better readability in Jaspersoft Studio.
Type Defines the type of the field (Amount/Date/Integer/String/Text/Yn).
User Prompt Defines the prompt that the user will see for the field during
document request.
Mandatory Defines whether input into this field is mandatory for document
request.
External Data Source

External Data Source is used to link image/text files into the PDF documents. Usually an image is
used to show logo or signature on the document.
When ‘External’ source type is selected, fields in the ‘External’ tab become available for input.
Field Description
Field Name This field together with ‘Type’, ‘File Path’ and ‘File Name / Routine’
fields constitutes a multi-value group. The ‘Field Name’ defines the
name under which this data element will be visible when designing
the PDF document layout in Jaspersoft Studio. It is recommended to
name the fields in MixedCase, for better readability in Jaspersoft
Studio.
Type Defines the type of the external field (Image/Text).
File Path Path to the external file. It should include slash/backslash as the
ending character.
File Name / Routine External file name or routine that returns the file name. If routine is
required, it should be prefixed with @ character. More details on how
the routine should be written will be provided in the ‘Developer API’
section.
Static Data Source

Static Data Source is used to define static values that can be used on the PDF documents, that are
not present on the other T24 applications/files.
When ‘Static’ source type is selected, fields in the ‘Static’ tab become available for input.
Field Description
Field Name This field together with ‘Value’ constitutes a multi-value group. The
‘Field Name’ defines the name under which this data element will be
visible when designing the PDF document layout in Jaspersoft
Studio. It is recommended to name the fields in MixedCase, for better
readability in Jaspersoft Studio.
Value Value of the data element.
Dynamic Tables
The Dynamic Tables menu opens application for defining dynamic tables for the Document Output
module. Dynamic tables are used to define tabular data mapped from T24 and used by lists/charts
in the PDF documents.
There are following types of dynamic tables available in the module:
 T24 File – dynamic table built from T24 files, e.g. list of accounts for customer
 T24 Delivery – dynamic table built from T24 delivery module – based on specific delivery
message types
 T24 Routine – dynamic table built from a T24 routine.
Each dynamic table definition contains two common fields:
Field Description
Description Description of the dynamic table.
Source Type Defines the type of the dynamic table.
T24 File Dynamic Table

T24 File Dynamic Table is used to build tabular data based on T24 files/applications.
When ‘T24.file’ source type is selected, fields in the ‘T24 File’ tab become available for input.
Field Description
T24 Source File Specifies from which T24 file the dynamic table will be built.
Build Parameter This is a multi-value field to specify parameters for the dynamic table.
E.g. to list accounts of a customer, the required parameter is
customer number.
Preselection Routine Defines a routine to do initial selection before executing the select
given by the criteria fields below. Such routine could for example
read the CUSTOMER.ACCOUNT concat file instead of doing select
on the ACCOUNT file by CUSTOMER. More details on how the
section.
Criteria Name This multi-value field groups together the ‘Field’, ‘Operand’ and
‘Value’ fields below. It defines the name of the criteria to be applied
in selection. Multiple criteria are executed with OR operand.
Field This field together with ‘Operand’ and ‘Value’ form a sub-value set
used to specify conditions for the selection criteria. Multiple
conditions at this level are executed with AND operand. This field
contains the STANDARD.SELECTION field name from the file given
in ‘T24 Source File’.
Operand Operand for the condition.
Value Value for the condition. It can be a static value or value of a build
parameter – in this case it is enclosed by ‘&&’ characters.
Column Name This field together with ‘Type’, ‘Source Field’ and ‘Conversion’
constitutes a multi-value group. The ‘Column Name’ defines the
name under which column data will be visible when designing the
PDF document layout in Jaspersoft Studio. It is recommended to
name the fields in MixedCase (e.g. AccountName instead of
ACCOUNT.NAME), for better readability in Jaspersoft Studio.
Type Defines the type of the column (Text/Number/Date).
Source Field The name of the field on ‘T24 Source File’ used to fill the column
data – as defined on the STANDARD.SELECTION record.

T24 Delivery Dynamic Table

T24 Delivery Dynamic Table is used to build tabular data from T24 Delivery messages. The mapping
should be done based on the multi-value fields defined on DE.MESSAGE record.
When ‘T24.delivery’ source type is selected, fields in the ‘T24 Delivery’ tab become available for
input.
Field Description
DE Message Id This field specifies from which DE message type the dynamic table
will be built. This is a hot-field and when a value is selected, the list
of available multi-value fields from DE.MESSAGE is populated on
the record.
Column Name This field together with ‘Type’, ‘Source Field’ and ‘Conversion’
constitutes a multi-value group. The ‘Column Name’ defines the
name under which column data will be visible when designing the
PDF document layout in Jaspersoft Studio. It is recommended to
name the fields in MixedCase, for better readability in Jaspersoft
Studio.
Source Field The name of the field on DE.MESSAGE used to fill the column data.

T24 Routine Dynamic Table

T24 Routine Dynamic Table is used to build tabular data based on a user-developed routine. This
is sometimes required when the structure of the tabular data is too complex to realize on the File or
Delivery dynamic table.
When ‘T24.routine’ source type is selected, fields in the ‘T24 Routine’ tab become available for
input.
Field Description
Table Routine Defines a routine to build the dynamic table. More details on how the
section.
Build Parameter This is a multi-value field to specify parameters for the dynamic table
routine. E.g. to list transactions on an account, the required
parameter is account number.
Calculated Field This is a multi-value field to specify calculated fields returned by the
table routine on top of the table details. These may be for example
overall totals, or other useful information not fitting into the table
structure.
Column Name This field together with ‘Type’ constitutes a multi-value group. The
‘Column Name’ defines the name under which column data will be
visible when designing the PDF document layout in Jaspersoft
Studio. It is recommended to name the fields in MixedCase, for better
readability in Jaspersoft Studio.
Field Conversions
Field Conversions can be used on selected data sources and dynamic tables. They are used to
amend the field value before it is mapped to PDF document. It is possible to set multiple conversions
on a field. An example of field conversion is given below.
The following conversions are supported:
Conversion Description
VALUE-x Extract multi-value x
COUNT-VM Return number of multi-value fields.
SUBVALUE-x Extract sub-value x
COUNT-SM Return number of sub-value fields.
EXTRACT*x*y Extract string starting at x position with length y
ADDRESS-x Extract address line x from the document delivery address
ABS Extract absolute value
CDT*x Perform CDT function with 3rd argument given by x
DDMMMYYYY Convert date in internal format to DDMMMYYYY format
LINK>x>y Extract field y from application x with id given by the field value
DECRYPT*x*y Perform DECRYPT function with 2nd argument as x and 3rd as y
ENCRYPT*x*y Perform ENCRYPT function with 2nd argument as x and 3rd as y
FIELD[x,y] Extract field y from a string delimited by x
FMT*x Perform FMT function with formatting string x
@routine Call routine to perform conversion. More details on how the routine
should be written will be provided in the ‘Developer API’ section.
Document Triggers
The Document Triggers menu opens application for defining triggers to produce documents on
the back of VERSION input.
The @ID to the application should be the VERSION name to trigger document production.
Field Description
Document Required This field together with all the below fields forms a multi-value set to
configure document trigger parameters. This field defines the
document type that should be produced when a record on the
version given in @ID is authorised.
For Function Function causing the document production: Input/Reverse/

Authorise.Input/Authorise.Reverse.
Customer Field Defines which field on the application given in the record @ID
contains customer number for which the document request is done.
If there is no direct link between the application and customer, then
a routine name can be provided in this field, prefixed with @
character. More details on how the routine should be written will be
Check Field This field together with ‘Op’ and ‘Value’ fields forms a sub-value set
to define conditions for the document generation. It defines which
field on the application given in the record @ID will be subject for
document generation checking. Multiple sub-values of this group are
calculated with an AND operator.
Op Operand for the condition.
Value Value for the condition.
Change Field Defines the field to trigger the document production if the value of
the field is changed upon authorisation of the application given in the
record @ID. If complex trigger criteria are required, this field will
accept routine name prefixed with @ character. More details on how
the routine should be written will be provided in the ‘Developer API’
section.
Data Source Id Defines the field on the application given in the record @ID that will
be used as the document’s main data source id. The document’s
main data source name will be displayed before this field on selection
of the ‘Document Required’.
Number of Copies Defines how many copies of the document should be delivered
(printed).
Override Address Used to override the default delivery address of the document.
Override Channel Used to override the default delivery channel of the document.
Options Can be set to ‘Auto.launch’ to automatically display the document

after transaction input, or ‘Auto.launch.print’ to also automatically
print the document.
Printers
The Printers menu opens application for defining printers for printing the document from the
Document Output module.
Field Description
Description Description of the printer
Printer Name Printer name as defined on the system where the print server web
application resides.
Operations Menu
The Operations menu points to the different applications and enquiries involved in the Document
Output functionality.
Each of the menu items is explained in more detail in the following paragraphs.
Request Document
The Request Document menu option opens application for requesting documents.
The @ID keyed on the application should be the name of the document to be requested. Once the
document id is given, a unique number will be added to the request as below.
Field Description
Document This no-input field displays the description of the document being
requested.
Data Source This no-input field displays the main data source of the document. It
gives a hint as to the main data source id that needs to be provided
for the document production.
Data Source Id Defines the id for the document’s main data source.
Customer Id This no-input field displays the customer for whom the document will
be produced. It is populated on validation of the record.
Number of Copies The number of copies to be printed.
Default Address This no-input field displays the default delivery address for the
document.
Override Address Specifies if the document is to be delivered to a different address.
Default Channel This no-input field displays the default channel for the document
delivery.
Override Channel Specifies if the document is to be delivered to a different channel.

The drop-down list will contain only the channels supported by the
document (as defined on the document record).
In the example above, the value given in the field ‘Data Source Id’ should be the customer number
for whom the letter is requested. Once the record is committed/authorised, the request is put for
processing and the document should appear in the document repository (or in the verify queue, if
the document requires verification) shortly.
Bulk Request Document

The Bulk Request Document menu opens application for requesting a document for multiple
customers or accounts.
The @ID keyed on the application can be any string, but it is recommended to give a descriptive
name. The first tab ‘Selection’ defines the list of customers or accounts for the document generation
request.
Field Description
Description A meaningful description for the bulk request.
Action Specifies the action to be performed for this bulk request.

 Test – the selection for the bulk request will be executed and
execution report will be produced, but no documents will be
actually requested
 Run – the selection for the bulk request will be executed,
documents will be requested and execution report will be
produced
Selection Type This field defines how the selection list for bulk request will be
generated.
 1-Criteria – using selection criteria defined by fields ‘T24
Source File’, ‘Criteria Name’, ‘Field’, ‘Operand’, ‘Value’
 2-List – using selection list given in field ‘Selection List’.
 3-Command – using selection command given in field
‘Selection Command’.
 4-Routine – using T24 routine given in ‘Selection Routine’.
T24 Source File Defines the source file (CUSTOMER or ACCOUNT) for selection
criteria when ‘1-Criteria’ selection type is used.
Criteria Name This multi-value field groups together the ‘Field’, ‘Operand’ and
‘Value’ fields below. It defines the name of the criteria to be applied
in selection. Multiple criteria are executed with OR operand.
Field This field together with ‘Operand’ and ‘Value’ form a sub-value set
used to specify conditions for the selection criteria. Multiple
conditions at this level are executed with AND operand. This field
contains the STANDARD.SELECTION field name from the file given

in ‘T24 Source File’.
Operand Operand for the condition.
Value Value for the condition.
Selection List This should be the name of a &SAVEDLISTS& file that contains list
of customer numbers for whom the document should be requested.
Selection Command This should be a valid jBASE selection command that returns list of
ids from CUSTOMER or ACCOUNT file only.
Selection Routine T24 Routine to be used to return list of customer numbers for
selection. More details on how the routine should be written will be
The ‘Document’ tab defines which document will be requested and allows overriding the default
delivery settings.
Field Description
Document Required Contains the document name to be requested.
Data Source This no-input field displays the main data source of the document.
Number of Copies The number of copies to be printed.
Default Address This no-input field displays the default delivery address for the
document.
Override Address Specifies if the document is to be delivered to a different address.
Default Channel This no-input field displays the default channel for the document
delivery.
Override Channel Specifies if the document is to be delivered to a different channel.

The drop-down list will contain only the channels supported by the
document (as defined on the document record).
Note: T24 Service ‘XXX/DO.BULK.RUN’ should be running for processing bulk document requests.
The bulk run execution report in .csv format will be produced in the BulkRunReports subdirectory
of the main module path. It contains the customer numbers and main data source ids for which the
documents were requested.
Document Verify Queue

When a document is set to require verification, it will be initially listed in the Document Verify
Queue, from where it can be accepted or rejected. Only when the document is accepted, it will be
stored in the repository and delivered to printer/email/SMS (as per the document request).
The Document Verify Queue menu option opens the following screen.
From here, documents can be viewed, accepted or rejected, using the dropdown menu beside each
document.
View Repository
The first step in the View Repository option is to select a customer. A simple enquiry allows
searching by number, mnemonic or short name.
Once the customer is located, one should use the View Repository icon that will open the
following screen. The documents can be viewed in the right frame by clicking on the View icon.
Document Processing Queue

The Document Processing Queue enquiry list document production requests. Document
production errors can be viewed from this enquiry, and using Resubmit option, failed document
requests can be retried.
The View icon opens up the following screen:
Field Description
Queue Status Document request processing status.
Delivery Channel The channel this document is to be delivered to.
Delivery Address Delivery address type.
Name Customer name mapped for Document Output.
Address Delivery address mapped for Document Output.
Operator The user who requested this document.
Errors Document production errors, if any.
The Resubmit icon opens up the application where the document can be resubmitted.
The following Resubmit actions are available:
Resubmit Action Description
Create.data Document is reproduced from the data mapping stage – from

scratch.
Create.document Only PDF creation stage is retried, using already mapped data.
Deliver.again Only delivery (print/email/SMS) stage is retried, using already

created PDF document.
List of Templates
The List of Templates enquiry displays list of available document templates. The templates are
used to define common data elements, style and layout for PDF documents. Documents linked to
a specific template will inherit its design.
From this enquiry, document templates can be viewed (using the View Template option) or
amended (using the Amend Template option).
New Template
The New Template option above the enquiry opens up application for defining document
templates in the Document Output module.
Field Description
Description Description of the document template.
Template Action When the action is set to ‘Build’, jrxml file will be created in the
Document Output ‘JrxmlTemplates’ directory. The .jrxml file, named
as the document template, is used for layout design in the Jaspersoft
Studio.
Data Source This field together with ‘Field’ forms a multi-value set. It defines the
data sources required by the document template.
Field This sub-value field lists the fields from the above data source that
will be used by the document template.
List Documents
The List Documents enquiry displays list of available documents. Document record in the
Document Output module holds document parameters and defines data mapping (data sources and
dynamic tables). This is explained in more detail in the following paragraphs.
From this enquiry, document definitions can be viewed (using the View Document option),
amended (using the Amend Document option), or documents can be requested (using the
Request Document option).
New Document
The New Document option above the enquiry opens up application for defining documents in
the Document Output module.
Main Details
In the main section, general document parameters are defined.
Field Description
Description Description of the document.
Document Class Class of the document, picked from the list of available document
classes.
Direction Defines whether this is a simple outward document or a document

that will be signed and sent back (turnaround). If the direction is
‘Turnaround’, then by default a barcode will be added to the
document layout.
Channel This multi-value field defines the channels available for the delivery
of the document:
 Print-local – the document can be printed on a local printer
 Print-bulk – the document can be printed on a bulk printer
 Print-bureau – the document can be sent to 3rd party for

printing
 Email-attach – the document can be sent as an email
attachment
 Email-notify – the availability of the document can be
advised by email
 Sms – the availability of the document can be advised by
SMS
Delivery Address Defines the default delivery address for the document.
DE Format Link This multi-value field defines for which DE.FORMAT.PRINT records
the document can be substituted if its main data source is based on
the delivery module.
Action When the action is set to ‘Build’, jrxml file will be created in the
Document Output ‘JrxmlDocuments’ directory, either from scratch or
reusing the existing layout definition. If the action is set to ‘Recreate’,
then the jrxml file will be created based on the template to which the
document is linked. The .jrxml file, named as the document definition,
is used for layout design in the Jaspersoft Studio.
Template
In the ‘Template’ section, document can be linked to a template.
Field Description
Template The template to be used when designing the document layout.
Data Source This field together with ‘Field’ forms a multi-value set. It is a no-input
field that indicates the data sources required by the template. All
these data sources will have to be defined in the ‘Data Sources’ tab
of the document definition screen.
Field This sub-value no-input field indicates the data source fields required
by the template. All these fields will have to be defined in the ‘Data
Sources’ tab of the document definition screen.
Data Sources
In the ‘Data Sources’ section all the data sources required by the document are defined.
Field Description
Main Data Source Defines the main document’s data source that will drive PDF data
mapping.
Field This sub-value field indicates the main data source fields to be
mapped to PDF document.
Data Source This field together with ‘Link Definition’ and ‘Field’ forms a multi-value
set. It defines all the other (linked) data sources for PDF data
mapping.
Link Definition Required only for ‘T24 File’ data source types, this field defines how
the linked data source will be found based on the ‘Main Data Source’
record. The input in this field should be in format
(data_source)>(data_source_field), where (data_source) is one of
the data sources defined earlier on the screen, and
(data_source_field) is a field from the (data_source). The link can be
also prefixed with * character, to make the linked data source
optional for the document generation.
Field This sub-value field indicates the other data sources’ fields to be
mapped to PDF document.
Dynamic Tables
In the ‘Dynamic Tables’ section all the dynamic tables required by the document are defined.
Field Description
Table Name This field together with all the fields below forms a multi-value set for
defining multiple dynamic tables to be mapped to PDF document. In
this field the name of the dynamic table is input.
Columns This no-input field indicates the columns of the selected dynamic
table.
Calculated Fields This sub-value no-input field indicates the calculated fields of the
selected dynamic table.
Display Type This field defines how the dynamic table should be output on the
PDF document:
 List – as a standard column/row table; this is allowed for all
dynamic tables
 Barchart – as a bar chart; this is allowed only if the dynamic
table has 3 columns of types Text/Text/Number
 Piechart – as a pie chart; this is allowed only if the dynamic
table has 2 columns of types Text/Number
 Linechart – as a line chart; this is allowed only if the dynamic
table has 3 column of types Text/Text/Number
 Linexychart – as a line XY chart; this is allowed only if the
dynamic table has 4 columns of types
Text/Text/Number/Number
Argument Name This field together with ‘Argument Data’ forms a sub-value set. If
build arguments are required by the dynamic table, this no-input field
will indicate the argument names.
Argument Data This field defines how the build argument will be filled for building the
dynamic table. The input in this field should be in format
(data_source)>(data_source_field), where (data_source) is one of
the data sources defined earlier on the screen, and
(data_source_field) is a field from the (data_source).
Settings
In the ‘Settings’ section the additional document parameters are defined.
Field Description
View Role This multi-value field specifies the user roles (USER.SMS.GROUP)
that can view documents of this type. If left blank, no viewing
restrictions will be applied at the document type level. This setting
overrides similar field at the document class level.
Request Role This multi-value field specifies the user roles (USER.SMS.GROUP)
that can request documents of this type. If left blank, no requesting
restrictions will be applied at the document type level. This setting
overrides similar field at the document class level.
Customer View This field specifies if customers are allowed to view documents of
this type (e.g. in internet banking). It is for information only in the
current implementation.
Verification Required Specifies if verification is required before the document is released

for delivery. Verification is done from the Operations menu ->
Document Verify Queue.
Attributes This multi-value field specifies different attributes for the document:
 List.customer – the document will be available for request
from the Single Customer View Request Document option.
 List.account – the document will be available for request
from the Single Customer View Account List enquiry.
 Norepository – the document will not be stored in the
repository.
 Sensitive – the xml data file required for the document
production will be deleted once the PDF document is
created.
 No.auto.print – the document will not be automatically
printed from the system.
Bulk Printer This is the name of the printer that will be used for printing
documents of this type, if no printer is defined for user. This printer
should be available to the print server setup on the delivery
parameters.
Email & SMS

In the ‘Email & Sms’ section the format of the email/sms messages for document delivery is defined.
Field Description
Email Type Specifies if email should be sent in plain text format or HTML.
Email Subject Subject of the email sent when document is produced.
Email Body Body of the email sent when document is produced. Special values
can be included in the email body to map data from the document
data sources:
 &/& - line break
 &-& - space
 &&data_source>field_name&& - value of the field_name
field from data_source data source
Sms Text Text sent by SMS when document is produced. Special values can
be included in the sms text to map data from the document data
sources:
 &/& - line break
 &-& - space
 &&data_source>field_name&& - value of the field_name
field from data_source data source
Document Output: Layout Design
Jaspersoft Studio
Introduction
Jaspersoft Studio is the new Eclipse-based report designer for JasperReports and JasperReports
Server. Jaspersoft Studio allows you to create sophisticated layouts containing charts, images,
subreports, crosstabs and much more. You can access your data through JDBC, TableModels,
JavaBeans, XML, Hibernate, CSV, and custom sources, then publish your reports as PDF, RTF,
XML, XLS, CSV, HTML, XHTML, text, DOCX, or OpenOffice.
Report Life Cycle

When you design a report using Jaspersoft Studio, you are creating a JRXML file, which is an XML
document that contains the definition of the report layout. The layout is completely visual, so you
can ignore the underlying structure of the JRXML file. Before executing a report, the JRXML must
be compiled in a binary object called a Jasper file. Jasper files are what you need to include within
the environment in order to run the reports.
The report execution is performed by passing a Jasper file and a data source to JasperReports.
Jaspersoft Studio also let you configure data sources and use them to test your reports.
For more details about Jaspersoft Studio, refer the links below:
https://community.jaspersoft.com/wiki/introduction-jaspersoft-studio
https://community.jaspersoft.com/wiki/designing-report-jaspersoft-studio
https://community.jaspersoft.com/wiki/exporting-reports-jaspersoft-studio
Report Structure in Jaspersoft Studio
Overview
A report in Jaspersoft Studio is defined by means of a type page. This is divided into different
horizontal portions named bands. When the report is joined with the data generating the print, these
sections are printed many times according to their function (and according to the rules that the
report author has set up). For instance, the page header is repeated at the beginning of every page,
while the detail band is repeated for every single read record.
For more details on the Jaspersoft Studio report structure, refer the link below:
https://community.jaspersoft.com/wiki/report-structure-jaspersoft-studio
What is a Band
The type page is divided into nine predefined bands to which new groups are added. In addition,
Jaspersoft Studio manages a heading band (group header) and a recapitulation band (group footer)
for every group.
A band is always wide as the page width (right and left margins excluded). However, its height, even
if it is established during the design phase, can vary during the print creation according to the
contained elements; it can "lengthen" toward the bottom of a page in an arbitrary way. This typically
occurs when bands contain subreports or text fields that have to adapt to the content vertically.
Generally, the height specified by the user should be considered "the minimal height" of the band.
Not all bands can be stretched dynamically according to the content, in particular the column footer,
page footer and last page footer bands.
The sum of all band heights (except for the background) has to always be less than or equal to the
page height minus the top and bottom margins.
Band Types
Following there is a brief description of the available bands.
Title
The title band is the first visible band. It is created only once and can be printed on a separate page.
Regarding the allowed dimensions, it is not possible during design time to exceed the report page
height (top and bottom margins are included). If the title is printed on a separate page, this band
height is not included in the calculation of the total sum of all band heights, which has to be less
than or equal to the page height, as mentioned previously.
Page Header
The page header band allows you to define a page header. The height specified during the design
phase usually does not change during the creation process (except for the insertion of vertically
resizable components, such as a text fields that contain long text and subreports). The page header
appears on all printed pages in the same position defined during the design phase. Title and
summary bands do not include the page header when printed on a separate page.
Column Header
The column header band is printed at the beginning of each detail column (The column concept will
be explained later in the "Columns" section). Usually, labels containing the column names of a
tabular report are inserted in this band.
Group Header
A report can contain zero or more group bands, which permit the collection of detail records in real
groups. A group header is always accompanied by a group footer (both can be independently visible
or not). Different properties are associated with a group. They determine its behaviour from the
graphic point of view. It is possible to always force a group header on a new page or in a new
column and to print this band on all pages if the bands below it overflow the single page (as a page
header, but at group level). It is possible to fix a minimum height required to print a group header: if
it exceeds this height, the group header band will be printed on a new page (please note that a
value too large for this property can create an infinite loop during printing).
Group Footer
The group footer band completes a group. Usually it contains fields to view subtotals or separation
graphic elements, such as lines.
Column Footer
The column footer band appears on at the end of every column. Its dimension is not resizable at
run time (not even if it contains resizable elements such as subreports or text fields with a variable
number of text lines).
Page Footer
The page footer band appears on every page where there is a page header. Like the column footer,
it is not resizable a run time.
Last Page Footer

If you want to make the last page footer different from the other footers, it is possible to use the
special last page footer band. If the band height is 0, it is completely ignored, and the layout
established for the common page will be also used for the last page.
Summary
The summary band allows to insert fields concerning total calculations, means, or whatever you
want to insert at the end of the report. In other systems, this band is often named report footer.
Background
The background band was introduced after insistent requests from many users who wanted to be
able to create watermarks and similar effects (such as a frame around the whole page). It can have
a maximum height equal to the page height.
Jaspersoft Studio Tutorials

A comprehensive user guide for Jaspersoft Studio can be found under this link:
http://community-static.jaspersoft.com/sites/default/files/docs/jaspersoft-studio-user-guide.pdf
Tutorials, tips & tricks and other useful information on the Jaspersoft Studio can be found on the
following page:
https://community.jaspersoft.com/wiki/jaspersoft-studio-tutorials-archive
Working with Document Output Report File
Overview
When a new template/document is parameterised in the InclusiveBankingSuite (defining all the data
sources/dynamic tables to map data), one should use the ‘Build’ action to produce .jrxml report file
and sample .xml data file. The .jrxml file contains definition of the report for Jaspersoft Studio. Both
files will be placed in the main module path in a subdirectory called JrxmlTemplates for templates,
and JrxmlDocuments for documents.
In this example we will open a template report and define standard elements for documents
produced from InclusiveBankingSuite.
When the Template Action is set to ‘Build’ and the record is committed, the following files should be
created in the JrxmlTemplates directory.
Note: If the T24 environment is setup locally, then the files can be opened directly from these
directories. Otherwise, it is required to transfer both files from the server to a local workstation/laptop
where the Jaspersoft Studio is installed.
When the .jrxml file is opened in Jaspersoft Studio, we should see the following screen.
This shows a blank report in the ‘Main Report’ window. On the left side, we can see the list of Data
Adapters, and Report Outline.
Defining Data Adapter

The first step required is to define data adapter for the .xml file holding sample data. This is done
by right-clicking on the ‘Data Adapter’ item and selecting ‘Create Data Adapter’ option. It will open
Data Adapter Wizard:
‘XML document’ should be selected from the list of available data adapters, and the data adapter
parameters will be defined in the next step.
The default data adapter name used by the Document Output module is ‘T24DocumentOutput’.
Please put this name in the ‘Name’ field as above. Also, please check the ‘Use the report Xpath
expression when filling the report’ option. Once this is done, the data adapter can be saved using
the ‘Finish’ button.
The newly created data adapter should then appear in the list of data adapters. Please note that
this step is only required once, during the first opening of a Document Output file, and the data
adapter will remain in the Jaspersoft Studio workspace.
Using Document Output Data

The data elements defined in T24 will be listed under the ‘Fields’ list in the Outline section of the
Jaspersoft Studio workspace.
We can see fields with names starting with ‘DoInternal’. These fields will exist in every .jrxml
document created from the Document Output module; they contain the common data elements –
customer name and address lines, institution details (to be used on header/footer).
Following there will be fields mapped from the specific template/document definition in T24. In this
example, we can see fields starting with ‘Customer’ – the name of the data source used by the
template. The name of these fields will always be in format ‘<data_source_name><field_name>’ or
‘<dynamic_table_name><column_name>’.
To use the data fields on the report, simply drag and drop the field to a respective report band.
Select ‘No Calculation Function’ in the window that will appear:
Usually, the customer name/address would go to the Title band to only appear once on the report.
The institution header/footer would be defined in the background band so that it appears on every
page.
Designing Report Layout

The ‘Palette’ tab on the right side contains all the graphical elements that can be used to define the
report layout. In our example, we will use some Static Text and Rectangle to define the template
layout. The look of each element added to the report can be changed in the Properties tab and its
respective sub-sections. In the picture below we can see the Text Field properties – changed to use
Arial font. It is however recommended, instead of setting the properties manually for each element,
to define styles for the document in Jaspersoft Studio and apply them to the elements.
Sample CustomerLetter.jrxml template file is delivered as part of the Document Output package.
Please copy the file over to your local JrxmlTemplates directory and open it in Jaspersoft Studio to
learn more about defining the report layout.
Before previewing the report in Jaspersoft Studio, the T24DocumentOutput data source needs to
be updated to point to the .xml file with sample data for the report. Please double click on the
T24DocumentOutput in the Data Adapters list, and browse for the sample file produced by the
module.
Once the data source is defined, use the Preview tab at the bottom of the report window
.
Please make sure that the report data source is T24DocumentOutput. To view the report in different
formats (e.g. PDF), please select appropriate value right to the data source selection.
When the layout is configured and the CustomerLetter template is ready, the .jrxml file should be
stored back on the server in the JrxmlTemplates folder. From now on, it can be used as template
for document definitions.
Creating First Document

In this example we will define a sample WelcomeLetter, based on the CustomerLetter template
created before.
Please open the WelcomeLetter document in T24 and review the settings. Then select ‘Build’ in the
Action field and commit the record. The document’s .jrxml file and .xml sample data file should be
created in the JrxmlDocuments folder in the main module path.
Open the file in Jaspersoft Studio. You will see that the template elements are already in place in
the document layout, and there will be additional data fields available in the Outline tab. Also, the
Detail1 band will contain columns from the main dynamic table defined on the document.
Now, please update the T24DocumentOutput data adapter to point to the sample .xml data file
created for the document, and preview the report. You should see a report like the one below.
Sample WelcomeLetter.jrxml document file is delivered as part of the Document Output package.
Please copy the file over to the JrxmlDocuments directory and open it in Jaspersoft Studio to see
how the document layout was defined.
Once the layout is ready, the document should be compiled and the compiled .jasper file should be
copied to the server into CompiledDocuments subdirectory of the main Document Output module
path. To compile the document, use the icon below.
The .jrxml report template edited should be also copied back to the server into JrxmlDocuments
directory.
The CompiledDocuments directory should contain the following files.
The JrxmlDocuments folder should contain the following files.
At this point, the document is ready to be requested/produced from T24.
Font Extensions
Overview
When using a textual element inside Jaspersoft Studio, users can select the font used. There may
be a language requiring specific font too (Chinese, Cyrillic). Although this seems simple, there are
a lot of problems when using the fonts. The main problem is that the available fonts are provided by
the operating system and for this reason:
 A font that it is available in one operating system isn't available in another. In this case, as
fall-back solution, the default font is used for the element.
 A font can be available in different operating systems but it could be slightly different from
one to another.
In many cases this is simply unacceptable. Having a different font from the planned one probably
will require more or less space for the text and this could have an impact, not only on the graphical
appearance, but also on the layout of the report itself. PDF format has its own set of fonts, and if a
document needs to use other fonts, they must be embedded inside the PDF. To overcome this
problem, the user can use external font files instead of the system provided fonts. In this way, the
report will be independent of the operating system fonts and have the same appearance
everywhere. This can be done using a Font Extension.
Creating Font Extension

Jaspersoft Studio allows to use a wide variety of font types like TTF, SVG, WOFF and EOT. One of
the most used formats is the TTF and there are plenty of websites that collect fonts with various
licenses. Keep the font files in TTF format stored on the local drive before creating the font
extension.
In Jaspersoft Studio, go to Window > Preferences menu option, and in the Preferences window, go
to Jaspersoft Studio > Fonts item.
New fonts can be added by clicking the Add button on the right.
A unique name for the Font Extension must be provided. This is usually the name of the font being
added. In the True Type (.ttf) field in the Normal tab, the base font file should be selected. Font
variants for the Bold, Italic and Bold Italic styled text can be added separately in subsequent tabs –
if not defined, then the system will amend the base font to get the required style.
The PDF Font Name allows to specify an alternative font when the font is not available in the system
where the PDF is displayed. The Embed this font in the PDF document option means that the font
will be included within the PDF, so that even on the systems where this font is not installed, the
display will be correct. Note that embedding the font in the PDF export will make the resulting PDF
file bigger.
The Finish button completes the new font addition.
Exporting Font Extension

One of the problem that Font Extension solves is to have the same font on every system, so the
appearance of the text is the same. This is also valid for the InclusiveBankingSuite environment,
where the font extension must exist for the system to produce PDF documents with the correct
display. For proper display on the user machines, if font is not embedded within PDF, the font should
be also installed in the system.
The font extension can be exported to JAR file and linked by the Document Output JasperReports
library. Select the fonts required in the JAR file and press the Export button – then specify the file
name. This JAR file should be included in the environment CLASSPATH variable, for Document
Output JasperReports linking.
Document Output: Customization
Overview
The Document Output module provides some ways to customize the workflow for document
requests. It also provides an API for user-defined routines where non-standard logic or local
customization is required.
Drilldown Enquiries
View Repository
The ‘View Repository’ screen can be attached to any enquiry containing customer numbers. The
composite screen name used for viewing repository is DO.VIEW.REPOSITORY. It can be
attached as drilldown enquiry as below:
In the ‘Enquiry Name’ field, please input ‘COS DO.VIEW.REPOSITORY’, followed by space and
the enquiry field that contains the customer number.
Request Account Documents

The account-related documents enquiry (see Account Documents paragraph) can be attached to
any enquiry containing account numbers. It will display documents that can be requested in the
context of an account, The selection of the documents displayed is based on the ‘List.account’
attribute defined on the document record.
To attach it to another enquiry, follow the steps below:
In the ‘Enquiry Name’ field of another enquiry, input ‘DO.REQ.ACCT.DOCUMENT.LIST’, and in the
‘Sel Crit’ field, input ‘S.SOURCE.ID EQ’, followed by space and the enquiry field that contains the
account number.
When the drilldown is selected, the following enquiry will appear.
When the ‘Request Document’ is selected, in the next screen with the document request, the
account number will be prefilled.
Request Customer Documents

The customer-related documents enquiry (see Customer Documents paragraph) can be attached
to any enquiry containing customer numbers. It will display documents that can be requested in the
context of a customer. The selection of the documents displayed is based on the ‘List.customer’
attribute defined on the document record.
To attach it to another enquiry, follow the steps below:
In the ‘Enquiry Name’ field of another enquiry, input ‘DO.REQ.CUST.DOCUMENT.LIST’, and in the
‘Sel Crit’ field, input ‘S.SOURCE.ID EQ’, followed by space and the enquiry field that contains the
customer number.
When the drilldown is selected, the following enquiry will appear.
When the ‘Request Document’ is selected, in the next screen with the document request, the
customer number will be prefilled.
Request Document Screen
Dynamic Version Routine

The DO.XX.SET.VERSION.ATTRIBUTES routine should be attached as Version Rtn in
EB.DYNAMIC.ATTRIBUTES>SYSTEM record or called from within another routine, if it is already
attached there. It dynamically modifies the Request Document version where user-inputtable values
are required.
Document Triggers
Version Authorisation Routine

The DO.VA.TRIGGER.DOCUMENT routine should be attached as authorisation routine to
a version required to trigger document production. This is the version defined in the record id on the
Document Trigger application.
The routine can also be attached to VERSION.CONTROL record that the specific versions are
linked to.
Delivery Module with Document Output
Parameterisation
In order to handoff the delivery messages for pdf production, special setting is required on the
DE.PRODUCT application.
The Document Output module includes special DE.CARRIER and DE.INTERFACE records that are
used to route the delivery messages to the module.
Routing of the delivery messages to the Document Output module is done on the DE.PRODUCT
application as below.
Field Description
Carrier Addr No This field should point to DOPRINT.1 carrier for routing the delivery
message to Document Output module.
Language This field indicates the language of the delivery format.
Format This field indicates the sequence number for the delivery format.
Copies Number of copies to be produced.
The Carrier Addr No, Language and Format fields together form a key to DE.FORMAT.PRINT
record that should be linked on the DO document definition record.
DE.PRODUCT records can be setup per specific account, customer, message type, or for all
messages. Please refer to T24 Delivery documentation for more details on this application setup.
Document Output API
Parameterisation
Repository Routine
This routine is responsible for storing documents in the repository when a non-standard (file-based)
repository is required. It should be attached into ‘Repository Routine’ field on the main parameter
file. Please note that when a non-standard repository is used, the repository viewer web application
would have to be developed locally as well, but this is outside of scope of this document.
The Repository Routine should be a jBASIC routine compiled/catalogued and defined on EB.API
file. The routine name should start with DO.XX.REP. The routine takes the following arguments.
Argument Description
sInDocumentClass Class of the incoming PDF document
sInDocumentType Type (name) of the incoming PDF document
sInCustomerId Customer number the document was produced for
sInPath Path to the PDF file on the server
sInFileName Name of the PDF file on the server
sOutError Repository storage error
Get Name Routine

This routine is responsible for building the customer name for document output if the standard name
fields are not sufficient for the task. It should be attached into ‘Get Name Routine’ field on the main
parameter file.
The Get Name Routine should be a jBASIC routine compiled/catalogued and defined on EB.API
file. The routine name should start with DO.XX.NAM. The routine takes the following arguments.
sInCustomerId Incoming customer number for whom the name is built
rInCustomer Incoming customer record
sOutCustomerName Outgoing customer name
Get Address Routine

This routine is responsible for building the customer address (postal or legal) for document output
if the standard address parameterisation is not sufficient for the task. It should be attached into ‘Get
Address Routine’ field on the main parameter file.
The Get Address Routine should be a jBASIC routine compiled/catalogued and defined on EB.API
file. The routine name should start with DO.XX.ADD. The routine takes the following arguments.
sInCustomerId Incoming customer number for whom the address is built
sInAddressType Address type required: CORR for correspondence, LEGAL for legal
sOutAddressLines Outgoing address lines, separated by @FM. Please note that there
should be maximum six lines returned.
Get Email Routine

This routine is responsible for returning the customer’s email address for email delivery if the
standard email field is not sufficient for the task. It should be attached into ‘Get Email Routine’ field
on the main parameter file.
The Get Email Routine should be a jBASIC routine compiled/catalogued and defined on EB.API file.
The routine name should start with DO.XX.EMA. The routine takes the following arguments.
sInCustomerId Incoming customer number for whom the email is returned
sOutEmailAddress Outgoing email address
Get Mobile Routine

This routine is responsible for returning the customer’s mobile number for SMS delivery if the
standard mobile field is not sufficient for the task. It should be attached into ‘Get Mobile Routine’
field on the main parameter file.
The Get Mobile Routine should be a jBASIC routine compiled/catalogued and defined on EB.API
file. The routine name should start with DO.XX.MOB. The routine takes the following arguments.
sInCustomerId Incoming customer number for whom the mobile phone is returned
sOutMobileNumber Outgoing mobile number
Preferred Channel Routine

This routine is responsible for selecting the customer’s preferred channel for document delivery if
preferred channel routing is to be used. It should be attached into ‘Channel Routine’ field on the
main parameter file, when the ‘Use Preferred Channel’ flag is set to ‘Yes’. Routing to a different
channel could be done based on some customer preferences, and for specific document types (e.g.
when customer opts to receive marketing information by email only).
The Preferred Channel Routine should be a jBASIC routine compiled/catalogued and defined on
EB.API file. The routine name should start with DO.XX.PCH. The routine takes the following
arguments.
sInCustomerId Incoming customer number for whom the channel is selected
sInDocumentClass Incoming class of the document to be routed
sInDocumentType Incoming type (name) of the document to be routed
sInAllowedChannels Incoming @VM-separated list of channels allowed by the document

definition. The list can contain the following values: PRINT-LOCAL,
PRINT-BULK, PRINT-BUREAU, EMAIL-ATTACH, EMAIL-NOTIFY,
SMS.
sOutPreferredChannel Outgoing preferred channel. It should be one of the allowed channels

passed to the routine in the sInAllowedChannels argument.
sOutError Outgoing channel selection error. If set, the document will not be sent
for processing.
Print Routine
This routine is responsible for printing the PDF documents if the default method (using the print
server from Document Output module) is not applicable. It should be attached into ‘Print Routine’
field on the main parameter file.
The Print Routine should be a jBASIC routine compiled/catalogued and defined on EB.API file. The
routine name should start with DO.XX.PRINT. The routine takes the following arguments.
sInPdfPath Incoming path of the PDF document to be printed
sInPdfName Incoming name of the PDF document to be printed
sInDocumentClass Incoming class of the document to be printed
sInDocumentType Incoming type (name) of the document to be printed
sInOperator Incoming user id who requested the document
sInCountry Incoming country of the address
sInNoOfCopies Incoming number of copies required
sOutError Outgoing print error
Send Email Routine

This routine is responsible for sending email messages. It should be attached into ‘Send Email
Routine’ field on the main parameter file. By default, the Document Output module does not provide
a method for sending emails, as these will vary depending on the infrastructure available.
The Send Email Routine should be a jBASIC routine compiled/catalogued and defined on EB.API
file. The routine name should start with DO.XX.SEMAIL. The routine takes the following arguments.
sInEmailAddress Incoming email address to send the document to
sInEmailSubject Incoming email subject
sInEmailBody Incoming email body
sInAttachment Incoming path to the attachment, if present
sOutError Outgoing email sending error
Send SMS Routine

This routine is responsible for sending SMS messages. It should be attached into ‘Send SMS
Routine’ field on the main parameter file. By default, the Document Output module does not provide
a method for sending SMS messages, as these will vary depending on the infrastructure available.
The Send SMS Routine should be a jBASIC routine compiled/catalogued and defined on EB.API
file. The routine name should start with DO.XX.SSMS. The routine takes the following arguments.
sInMobileNumber Incoming mobile number to send the SMS to
sInSMSText Incoming SMS text
sOutError Outgoing SMS sending error
Data Source
Customer Routine
This routine is responsible for retrieving the customer number for a T24 File Data Source if the link
to customer cannot be defined using a field from the T24 Source File. This is required if such data
source is used as main data source on a document. The routine should be attached into ‘Customer
Routine’ field in a T24 File Data Source record.
The Customer Routine should be a jBASIC routine compiled/catalogued and defined on EB.API file.
The routine name should start with DO.XX.DSCUS. The routine takes the following arguments.
sInDataSourceName Incoming name of the data source (e.g. FundsTransfer)
sInDataSourceId Incoming source record ID (e.g. FTxxxxyyyy)
sOutCustomerId Outgoing customer number
sOutError Outgoing error if customer could not be found
Source Field Routine

This routine is responsible for extracting field value for a T24 File Data Source when the value
cannot be extracted using STANDARD.SELECTION field. The routine should be attached into
‘Source Field’ field (prefixed with @) in a T24 File Data Source Record.
The Source Field Routine should be a jBASIC routine compiled/catalogued and defined on EB.API
file. The routine name should start with DO.XX.DSSRC. The routine takes the following arguments.
rInDataSource Incoming source record (e.g. FUNDS.TRANSFER record)
sInFieldName Incoming data source field name
sOutFieldValue Outgoing field value
File Name Routine

This routine is responsible for providing a file name for an External Data Source if the file name is
to be dynamically built for a document request. This could be required if different image/text files
(e.g. customer signatures) were required in the PDF document. The routine should be attached into
‘File Name / Routine’ field (prefixed with @) in an External Data Source record.
The File Name Routine should be a jBASIC routine compiled/catalogued and defined on EB.API
file. The routine name should start with DO.XX.DSEXT. The routine takes the following arguments.
sOutFileName Outgoing external file name
Dynamic Table
Preselection Routine
This routine can be used to do a pre-selection of records in a T24 File Dynamic Table. This is useful
when there exists a concat file for the selection (e.g. when selecting accounts of a customer, one
could use the CUSTOMER.ACCOUNT concat in the pre-selection routine). The routine should be
attached into ‘Preselection Routine’ field in a T24 File Dynamic Table.
The Preselection Routine should be a jBASIC routine compiled/catalogued and defined on EB.API
file. The routine name should start with DO.XX.DTPRE. The routine takes the following arguments.
sInBuildParameterNames Incoming @FM-separated list of build parameter names
sInBuildParameterValues Incoming @FM-separated list of build parameter values
sOutIdList Outgoing list of selected record IDs
Table Routine
This routine is responsible for building a table for a T24 Routine Dynamic Table. It should be
attached into ‘Table Routine’ field in T24 Routine Dynamic Table record.
The Table Routine should be a jBASIC routine compiled/catalogued and defined on EB.API file.
The routine name should start with DO.XX.DTTAB. The routine takes the following arguments.
sInBuildParameters Incoming list of build parameters for the dynamic table
rOutTable Outgoing table built, rows separated by @FM and columns by

@VM
rOutCalculated Outgoing @FM-separated list of calculated fields
sOutError Outgoing table build error
Field Conversion
Conversion Routine
This routine can be used in conversion field on data sources/dynamic tables, prefixed with @.
The Conversion Routine should be a jBASIC routine compiled/catalogued and defined on EB.API
file. The routine name should start with DO.XX.CONV. The routine takes the following arguments.
sInRecordId Incoming id of the source record for mapping
rInRecord Incoming source record for mapping
sInOutValue Incoming/outgoing field value for conversion
Document Trigger
Customer Field Routine

This routine is responsible for extracting the customer number from an application triggering
document production, if the customer number cannot be found on the application. The routine
should be attached into ’Customer Field’ field on a Document Trigger definition record.
The Customer Field Routine should be a jBASIC routine compiled/catalogued and defined on
EB.API file. The routine name should start with DO.XX.TRCUS. The routine takes the following
arguments.
sInRecordId Incoming id of the application record
rInRecord Incoming application record
sOutCustomerNumber Outgoing customer number
Change Field Routine

This routine is responsible for deciding if a document should be produced from an application
triggering document production, when complex logic is required. The routine should be attached
into ‘Change Field’ field on a Document Trigger definition record.
The Change Field Routine should be a jBASIC routine compiled/catalogued and defined on EB.API
file. The routine name should start with DO.XX.TRCHG. The routine returns only one argument,
which should return positive value if document should be produced. The other variables required to
support the logic can be taken from common area (e.g. ID.NEW, R.NEW).
bOutProduceDocument Should return @TRUE if the document should be produced
Bulk Request
Selection Routine
This routine is responsible for returning list of customer numbers for whom document should be
produced in a bulk document request. The routine should be attached into ‘Selection Routine’ field
on a Bulk Request Document record.
The Selection Routine should be a jBASIC routine compiled/catalogued and defined on EB.API file.
The routine name should start with DO.XX.BRSEL. The routine returns only one argument, which
should contain @FM-separated list of customer numbers.
sOutCustomerIds @FM-separated list of customer numbers
Notes
Use this page to record your own notes.

Temenos Document Output

Загружено:

Сведения о документе

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

Temenos Document Output

Загружено:

Авторское право:

Доступные форматы

InclusiveBankingSuite

Information in this document is subject to change without notice.

© 2015 Temenos Headquarters SA - all rights reserved.

List Documents ........................................................................................................................ 45

Author Version Date

Lukasz Czechowicz 1.0 21st January 2016

Lukasz Czechowicz 1.1 28th January 2016

Lukasz Czechowicz 1.2 5th February 2016

Lukasz Czechowicz 1.3 27th September 2016

Document Output: Operations

This option opens up a list of account-related documents available in the system:

There is one document available in the InclusiveBankingSuite – account statement. Clicking on

The following fields are available on this application:

Document Description of the document being requested.

Customer Id The linked customer number, defaulted by the system.

This option opens up a list of customer-related documents available in the system:

Below is a view of a welcome letter.

Document Output Services

Bulk Document Requests

Document Output: Configuration

Temenos Core File Storage External

Document Jaspersoft Studio

Repository Viewer Document Delivery

Document Production Service

Document requests can be resubmitted using the Resubmit Action.

The general flow of statuses on the DO.QUEUE record is presented below.

Data Mapping 05 Data Source Error

06 Dynamic Table Error

PDF Creation 13 PDF Path Error

15 PDF Creation Error

Repository Store Repository Error

Delivery Delivery Error

Parameter Name Description

WaitNoAttempts Number of file read attempts for document retrieval, used in

WaitSleep Wait period in seconds between consecutive document reads.

File Locations and Repository Settings

[COMPANY] – will be replaced by the company name originating

Header & Footer

Phone Contact phone number.

Fax Fax number.

Email Email address.

Website Company website.

Description Description of the document class.

Description Description of the data source.

Source Type Defines the type of the data source.

T24 File Data Source

Type Defines the type of the field (Text/Number/Date).

Conversion This is sub-value field that can contain multiple conversions to be

T24 Delivery Data Source

the fields in MixedCase, for better readability in Jaspersoft Studio.

Type Defines the type of the field (Text/Number/Date).

Conversion This is sub-value field that can contain multiple conversions to be

T24 Environment Data Source

List of available environment variables:

Variable Name Description

Lworkday T24 last working day date in YYYYMMDD format.

Today T24 today date in YYYYMMDD format.

Sysdate Server date in YYYYMMDD format.

Time.hhmm Current server time in HH:MM format.

Time.hhmmss Current server time in HH:MM:SS format.

User.full Name taken from USER>USER.NAME field.

Input Data Source

Type Defines the type of the field (Amount/Date/Integer/String/Text/Yn).

External Data Source

EXTRACTxy Extract string starting at x position with length y

DECRYPTxy Perform DECRYPT function with 2nd argument as x and 3rd as y

ENCRYPTxy Perform ENCRYPT function with 2nd argument as x and 3rd as y