Professional Documents
Culture Documents
Administrators Guide
Installation & Setup
No part of this document may be reproduced or transmitted in any form or by any means,
electronic or mechanical, for any purpose, without the express written permission of TEMENOS Holdings NV.
T24 Software Development Kit – Administrators Guide
Table of Content
Overview .................................................................................................................................................. 3
What is TSDK ...................................................................................................................................... 3
Getting TSDK ....................................................................................................................................... 3
Copyright and licenses......................................................................................................................... 3
System Requirements ............................................................................................................................. 3
Supported Hardware ............................................................................................................................ 3
Memory and Disk Space Requirements .............................................................................................. 3
Before Installing ....................................................................................................................................... 3
Pre-requisites ....................................................................................................................................... 3
Creating TSDK Classes........................................................................................................................... 3
WS.DEPLOY .................................................................................................................................... 4
WS.CREATE.TSDK ......................................................................................................................... 5
WS.CREATE .................................................................................................................................... 6
TSDK Generation Process ............................................................................................................... 7
Installing the TSDK JAR Files .......................................................................................................... 7
Installation and Setup .............................................................................................................................. 8
Creating and Packaging the T24 server class ............................................................................... 10
Package and deploy the class ....................................................................................................... 10
EB.API ................................................................................................................................................... 10
T24 Tables ......................................................................................................................................... 10
EB.API ............................................................................................................................................ 10
Set up the EB.API record for the new class ................................................................................... 11
Configure API hook to use EB.API ................................................................................................. 11
Javadoc Overview ................................................................................................................................. 12
Creation .......................................................................................................................................... 12
Troubleshooting ..................................................................................................................................... 14
Overview
What is TSDK
For many years, T24 has had an extensive range of API hooks to allow the customisation and
extension of T24’s business logic to meet the needs of an individual institution. However, historically
such code has had to be written in basic.
This document sets out the steps required to install and configure T24 Software Development kit
(TSDK)
Getting TSDK
T24 Software Development Kit is a free toolkit that comes with T24 Browser. Once you have T24
Browser, your distribution should automatically include the TSDK
System Requirements
Supported Hardware
All java dependent platforms are supported. Which ever platform that has T24 installed is compatible
with TSDK.
Before Installing
Pre-requisites
TSDK requires a number of Temenos products installed
• T24
• jBASE – from version 4.1.4.15 onwards
• T24 Browser (for Web Server Validation)
• T24 Connector (for Web Server Validation)
client has written their own local, then the TSDK Application classes can be re-created to include such
changes. Tools are provided to create a full set of application/enquiry classes, as well as individual
application/enquiry classes.
To create the full “tsdk.jar” file containing all the T24 applications, “WS.DEPLOY” and
“WS.CREATE.TSDK” should be used.
To create individual TSDK classes, or a sub-set of classes, of T24 applications, “WS.DEPLOY” and
“WS.CREATE” should be used.
The following sections describe each of these tools.
WS.DEPLOY
In order to create the TSDK (either a full set of TSDK classes or individual classes) a deployment
descriptor must first be created using T24. This is done using the T24 application “WS.DEPLOY”.
Please note that this application is also used to create Web Services.
WS.DEPLOY provides information regarding the type of TSDK (or Web Service) that is to be created,
as well as location information for the created files.
Whether creating a full set of TSDK classes or a sub-set of classes, create a WS.DEPLOY record
called “RUN.TSDK” similar to Figure 1 below :
• WSDL PATH: The path for the Web Service Definition Language (WSDL) file for Web Services.
Currently not used.
• DEFINITION PATH: The path for the definition XML file for the Web Service. Currently not used.
• CODE PATH: Defines the location for the generated java, class and JAR files. This can be a sub-
directory relative to the user's .run directory, or a full pathname. The user must have permission
to write to the directory.
• TYPE: Defines the type of deployment descriptor. It can be one of the following values:
o TSDK: Used for TSDK class creation.
o WEB.SERVICE - Used for Web Services class creation.
WS.CREATE.TSDK
To create a full set of T24 TSDK application classes, “WS.CREATE.TSDK” should be run. This
includes creating a record defining the details for the TSDK, and using the T24 Verify function on the
record to actually create the TSDK.
Create a WS.CREATE.TSDK record called “RUN.TSDK” similar to Figure 2 below:
The record should be authorised and then the Verify function run. The Verify function actually creates
the TSDK.
NOTE : Depending on the processor of the server, the creation of a full TSDK can take a few
hours. When run in “Classic” the creation of java, class and JAR files are reported to the
console allowing monitoring of the process.
WS.CREATE
To create a single or sub-set of T24 TSDK application classes, “WS.CREATE” should be run. This
includes creating a record defining the details for the TSDK, and using the T24 Verify function on the
record to actually create the specified TSDK classes.
Create a WS.CREATE record similar to Figure 3 below:
• WEB SERVICE URL: The URL for the Web Service as used for the Web Service Definition
Language (WSDL). Currently not used.
• DEPLOY TYPE: Deploy Type is the key to the WS.DEPLOY record created earlier.
• JAR NAME: The name of the Java Archive (JAR) file to create if required. If this is not specified
then the application will only create the Java and class files.
• JAR LOCATION: The directory location of the Java Archive (JAR) file to create if required. This is
only used if a JAR is required, as determined by the JAR Name field. This can be a relative path
to the account .run directory or a full pathname.
When WS.CREATE.TSDK and WS.CREATE records are verified java, class and JAR files are created
by the TSDK engine. This process runs the following steps :
1. The TSDK engine uses the Location field of the WS.DEPLOY record to indicate where to put
the files created. The location can either be a full pathname (e.g.
“/t24/srdevb/srdevb.run/srdevb/tsdk”) or a relative pathname relative to the T24 account “.run”
directory (e.g. “tsdk”). The following directories will be generated from the above settings
under the account “.run” directory :
a. tsdk/src
- This will contain all of the java files created
b. tsdk/classes
- This will contain all of the class files generated from the src directory
c. tsdk/tsdk.jar
- This jar file contains all of the generated classes. The default name of the
JAR file is “tsdk.jar” but this can be specified in the WS.CREATE record,
2. When the Verify function is run a Java source file is created for each T24 application and is
then compiled in to a Java class file. Once all of the class files have been created, they are
added to the JAR file.
3. The tsdk.jar (or the name specified in the WS.CREATE record) is the final product and will
contain all of the applications and tables in class form.
4. The TSDK generation process for a full set of TSDK classes may take several hours to run.
/t24/srdevb/srdevb.java/lib/tsdk.jar; /t24/srdevb/srdevb.java/lib/tsdklocal.jar
The TSDK product will also require the following jBASE libraries that can be found in the jBASE home
directory:
javaobjex.jar
jbase.jar
1. Create a folder and unzip the tsdkelibs.zip and tsdktlibs.zip into that folder.
[YOURLIB.jar] The directory where the jar containing all custom validation classes has been deployed.
EB.API
T24 Tables
EB.API
The EB.API table defines BASIC and Java hooks used to validate T24 application data.
A new record in the application EB.API should be created for each new Validation Class. The name of
the class should be the key to the record. See the diagram below for an example on how to set up the
record:
This EB.API routine can then be attached to the relevant VERSION record (i.e. in this case a FOREX
VERSION record).
For a T24 server validation routine the field ‘Validation Rtn’ is assigned the EB.API record id. See the
figure below:
Javadoc Overview
Javadoc is HTML pages describing a set of packages, classes and their methods. These are to be
used when developing T24 routines.
The TSDK comes with 2 sets of Javadoc :-
1. The TSDK Foundation classes documentation (tsdkfoundationDoc.zip)
2. The TSDK Application classes documentation (tsdkDoc.zip)
The TSDK Foundation classes documentation describes the classes and methods for the core TSDK
functionality (e.g. for TContract, TEnquiry, ClassLoader, etc).
The TSDK Applications classes documentation describes the classes and methods for the T24
applications (e.g. for Account, Customer, Abbreviation, etc).
In order to create this documentation, each Java source file must contain javadoc directives, such as
“@param” and “@return” which detail the parameters and return values of a method). For more
details on javadoc please refer to: http://java.sun.com/j2se/javadoc/.
Each Java class created by the TSDK application classes automatically contain javadoc directives as
generated by the WS.CREATE.TSDK program. The TSDK Foundation classes should have javadoc
directives in them also as provided by Temenos.
Creation
The Javadoc can be created in 2 different ways :-
1. By using the javadoc program on the command line
Command Line
1. When creating javadoc for a large amount of class file, the Java Virtual Machine memory
amount must be specified on the command. Failure to do this may cause Java OutOfMemory
errors.
2. The javadoc command to create the documentation is of the form :-
javadoc -J-Xmx256m -d ..\docs\tsdkDoc -subpackages com
where :-
javadoc The Java program to run
-J-Xmx256m Increase the memory allocation for the program
-d ..\docs\tsdkDoc Where to create the documents. This directory should differ
depending on whether the TSDK foundation or
application classes are being documented.
In general, this should be “tsdkfoundationDoc” for the
foundation classes, and “tsdkDoc” for the application
classes.
-subpackages com Build documents for sub packages under the ‘com’ directory
3. For delivery, the created documentation should be zipped. For foundation classes the file is
called “tsdkfoundationDoc.zip” and for application classes the file is called “tsdkDoc.zip”.
Troubleshooting
When running a Java routine attached to a VERSION record, a number of error messages may be
displayed :