Vultar T24 Data Access Components

Download as pdf or txt
Download as pdf or txt
You are on page 1of 37
At a glance
Powered by AI
The documentation discusses various components for accessing data from the T24 system including servers, drivers, and connectors. It also provides information on querying data, handling multivalue fields, and type conversions.

The main components include the Vultar T24 Data Access Server, Vultar Data Module, various DIRECT connectors for databases like Oracle and SQL Server, the Vultar JDBC and ODBC drivers.

Queries can include clauses for filtering like the WHERE clause, sorting with ORDER BY, and handling multivalue fields either by expansion or returning raw values.

Vultar Systems

Vultar T24 Data Access


Components
Documentation

29.06.2018
Contents
Overview ........................................................................................................................................................................... 3
Installation ........................................................................................................................................................................ 5
Vultar T24 Data Access Server ...................................................................................................................................... 6
Vultar Data Module (for TAFC / TAFJ Connector) ......................................................................................................... 7
Database DIRECT Connector ......................................................................................................................................... 8
Oracle DIRECT Connector ......................................................................................................................................... 8
MSSQL DIRECT Connector ........................................................................................................................................ 9
DB2 DIRECT Connector ........................................................................................................................................... 10
Vultar JDBC Driver....................................................................................................................................................... 11
Vultar ODBC Driver ..................................................................................................................................................... 13
Usage .............................................................................................................................................................................. 15
Queries........................................................................................................................................................................ 15
Simple queries ........................................................................................................................................................ 15
Where clause .......................................................................................................................................................... 16
Order by clause ....................................................................................................................................................... 17
Multivalue support ..................................................................................................................................................... 18
No expansion .......................................................................................................................................................... 18
Expanded values ..................................................................................................................................................... 19
Expand subvalues ................................................................................................................................................... 20
Values & Subvalues number ................................................................................................................................... 21
Type conversion .......................................................................................................................................................... 22
Integer conversion .................................................................................................................................................. 22
Float conversion...................................................................................................................................................... 23
Date conversion ...................................................................................................................................................... 24
Character conversion/expansion ............................................................................................................................ 25
Multivalued fields conversion................................................................................................................................. 26
Field joins .................................................................................................................................................................... 27
User Defined Functions .............................................................................................................................................. 27
Stored Procedures ...................................................................................................................................................... 30
Local fields .................................................................................................................................................................. 31

1|Page
Query local fields .................................................................................................................................................... 33
Local fields expansion ............................................................................................................................................. 34
Performance tips ............................................................................................................................................................ 35
Use multiple SPU ........................................................................................................................................................ 35
Multiple CPU/Cores server ......................................................................................................................................... 35
Fast Hard Disks............................................................................................................................................................ 35
RAM Disk Usage .......................................................................................................................................................... 35
Speed test tool ............................................................................................................................................................ 35
Free version vs Commercial version ............................................................................................................................... 35

2|Page
Overview

This manual describes Vultar T24 Data Access Components for Temenos’ T24 systems developed by VULTAR
SYSTEMS. The components allow any application using ODBC/JDBC connectivity to access T24 data.

Vultar T24 Data Access Components contains:

• T24 Data Access Server – a high performance server which allows other components to access T24 data
• Vultar Data Module – a set of jBASE routines for accessing data on T24 systems with jBASE backend DB
• ODBC driver – driver for ODBC compliant applications
• JDBC driver – type 3 JDBC driver for JDBC compliant applications

The JDBC component is a type 3 driver, also known as the Net-protocol/pure-Java Driver. Written completely in Java,
type 3 drivers are thus platform independent.

Vultar T24 Data Access Components is based upon 3-tier client-server architecture:

• Tier 1: Vultar ODBC/JDBC Client-side adapter

• Tier 2: Vultar T24 Data Access Server

• Tier 3: Optional Vultar Data Module for T24 (when using TAFC/TAFJ connector)

3|Page
The driver supports two types of connectors between Vultar Data Access Server and T24:

TAFC / TAFJ Connector


This is a universal T24 data access. It uses TAFC (or TAFJ) Temenos Application Framework to collect T24 data using
Vultar Data Module for T24 and send it to Vultar T24 Data Access Server. This connector type is compatible with all
database backends of T24 - JBASE, ORACLE, MSSQL or DB2. It is written in pure jBC code and is open source.

Database DIRECT Connector


With this connector, Vultar T24 Data Access Server can connect directly to T24 backend database and query data
with much higher speeds compared with TAFC Connector. It works only with MSSQL, ORACLE and DB2 databases.

4|Page
Installation

Vultar T24 Data Access Server and Vultar ODBC/JDBC Client-Side adapter may run in various configurations. The
following diagram shows an example of such configuration:

In above example, T24 server is running on a Windows machine. Vultar T24 Data Access Server has been installed
and working on the same machine. Vultar ODBC/JDBC Client-Side adapter is cross-platform; hence, T24 data may be
served to some ETL software running on UNIX or Linux machine. At the same time, users working on Windows
desktops may query T24 data as well using Vultar JDBC Client-Side adapter. In case T24 environment is running on
Linux/Unix server, Vultar T24 Data Access Server should be installed on a dedicated Windows machine:

5|Page
Vultar T24 Data Access Server

Vultar T24 Data Access Server is installed by running the corresponding installation kit t24das.exe.

Server will be installed as Windows Service. Besides that, a console version of server will be installed as well.

Vultar T24 Data Access Server installation package contains the following files:

vtconsole.exe Vultar T24 Data Access Server - console application.

vtservice.exe Vultar T24 Data Access Server – Windows service application.

Vultar T24 Data Access Server parameter file.


config.ini
Will be installed in c:\ProgramData\Vultar folder.

Set up here connectivity details to your T24 database.


aliases.json Will be installed in c:\ProgramData\Vultar folder.
More details are provided in the following chapters.

Minimal Windows Server hardware requirements:

- OS: Windows XP
- RAM: 1GB
-
1. After installation update the parameters in config.ini file as follows:

;Server's port number to listen the incoming requests


;from JDBC client applications
Port=888

;Server's log level


;0 - none, 1 - errors, 2 - info, 3 - debug, 5 - full
LogLevel=2

;Folder for log files


LogDir=logs
;Oracle's libraries location
;OracleLibPath=c:\Oracle12

;Temp folder for cached results


;By default Window's %TEMP% folder will be used
;Temp=z:\

6|Page
2. Restart the service or run vtconsole.exe console application from Start menu:

Background server is running.

Press [Enter] to close the server.

After doing changes in config.ini or aliases.json files there is no need to restart the server. The changes will be
applied immediately.

TAFC Connector

Minimal requirements: Java 7.

1. Check java version. Connector supports only Java version 7 and above. From command line type:
java -version

2. Copy t24client.jar & t24client.properties files to T24 environment bnk.run folder (using SCP, FTP or Samba)

3. Start t24client.jar on T24 server:


java -jar t24client.jar

Default listening port is 8125. In case the one would like to use another port, update it in
t24client.properties file.

4. Define a new alias (or update the existing one) in aliases.json (from Server) and set the following values:
a. Name – any desired alias name (will be used in connection URL)
b. Type – “jbase”, used for this type of connectors
c. Host – IP address/hostname of the jBASE server
d. Port – port number specified in t24client.properties file (default 8125)
e. Company – default company mnemonic, used when selecting from F.* files

7|Page
Database DIRECT Connector

In case you have Oracle/MSSQL/DB2 as T24 backend database – then you can use direct connector to respective
database instead of TAFC/TAFJ Data Module. This will allow you to avoid socket connection to jBASE, will increase
speed and reduce server resources consumption.

Below you will find steps how to setup direct connectors.

Oracle DIRECT Connector


Oracle connector uses Oracle’s high performance OCI (Oracle Client Interface) library to extract data directly from
Oracle DB without involving TAFC/TAFJ. Download OCI v.12 from http://vultar.md/files/Oci12.zip, unzip it and
update config.ini file by setting OracleLibPath parameter pointing to unzipped folder.

1. Define a new alias (or update the existing one) in aliases.json (from Server) and set the following values:
a. Name – any desired alias name (will be used in connection URL)
b. Type – “Ora”, used for this type of connectors
c. Host – IP address/hostname of the Oracle server/DB name (ex. “MyOracle/T24DB”)
d. Schema – DB schema (case sensitive!)
e. User – user name
f. Password – user password

Note: If Vultar T24 Data Access Server is installed on Windows XP operating system, version 10 of OCI shall be used
instead. Download it from http://vultar.md/files/Oci10.zip. Unpack and set the path to it in OracleLibPath parameter
in config.ini file.

8|Page
MSSQL DIRECT Connector
MSSQL Direct Connector uses Microsoft’s SQL Native client library to extract data directly from MSSQL DB without
involving TAFC/TAFJ.

Before using MSSQL Direct Connector you have to download & install SQL Native Client from Microsoft SQL Server
2012 Feature Pack. In installation instructions you will find links to sqlncli.msi files for both x32 and x64 Windows.
If you are using Windows x64 –install the x64 package. It will install both x64 and x32 clients.

1. Define a new alias (or update the existing one) in aliases.json (from Server) and set the following values:
a. Name – any desired alias name (will be used in connection URL)
b. Type – “MSSQL”, used for this type of connectors
c. Host – IP address/hostname of the MSSQL server/DB name (ex. “MyMSSQL/T24DB”)
d. Schema – DB schema (case sensitive!)
e. User – user name (set empty value “”, in case of using Windows Authentication)
f. Password – user password (set empty value “”, in case of using Windows Authentication)

9|Page
DB2 DIRECT Connector
To be implemented in next version.

10 | P a g e
TAFJ Connector
To use Vultar T24 Data Access Components with TAFJ – just configure the corresponding direct connector.

Vultar JDBC Driver


JDBC driver setup will be explained based on free SQuirreL SQL Client (http://www.squirrelsql.org/)

1. Add the driver with Driver manager (Drivers -> Add -> Extra Class Path -> Select & open the t24_jdbc.jar file).

2. Set driver’s parameters as follows:


a. Name – driver’s name, ex. T24 jdbc driver
b. Example URL – driver’s URL template, ex. jdbc:t24://host:port;alias=<alias_name>
c. Class name – driver’s class name, com.vultar.jdbc.Driver.

11 | P a g e
3. Create an alias with the following parameters:

a. Name – any desired name;


b. Driver – driver name defined in previous step
c. URL – connection URL in following format: jdbc:t24://<host>:<port>;alias=<alias_name>, where:
• Host – IP address/hostname of the server where Vultar T24 Data Access Server is running;
• Port – port number set in config.ini of the Vultar T24 Data Access Server (default is 888);
• Alias_name – alias name to T24 environment (defined in aliases.json config file);

4. Click Test ->Connect button. Connection should succeed:

12 | P a g e
Vultar ODBC Driver

1. Run driver installation t24odbc.exe which will install both 32 and 64 bit versions.

2. Launch Windows ODBC Data Source Administrator


• For 32 bit Windows open c:\Windows\SysWOW64\odbcad32.exe
• For 64 bit Windows open Control Panel -> Administrative Tools -> Data Sources (ODBC)

3. Set driver’s parameters as follows:


• Name – any desired data source name
• Vultar Server – hostname (or IP address) and port number
• Click Connect button to check connectivity and get server’s alias list
• Select alias name which will be used by selected Data Source
• Click second Connect button to connect to T24 environment and get company list

4. Select the default company which will be used when no mnemonic is specified in table names. For example
in displayed case when a SELECT * FROM F_ACCOUNT is executed, the data will be selected from
FBNK_ACCOUNT table.

5. Click OK.

6. You can select data from T24 using the free WinSQL lite SQL tool.

13 | P a g e
14 | P a g e
Usage

Queries

Simple queries
SELECT * FROM FBNK_ACCOUNT

15 | P a g e
Where clause
SELECT _ID, CUSTOMER, CATEGORY, CURRENCY FROM FBNK_ACCOUNT WHERE CURRENCY = 'EUR'

16 | P a g e
Order by clause
SELECT _ID, CUSTOMER, CATEGORY, CURRENCY FROM FBNK_ACCOUNT WHERE CURRENCY = 'EUR' ORDER BY _ID

17 | P a g e
Multivalue support

No expansion
Multivalue fields are treated as string fields with char delimited values.

SELECT _ID, FINAL_DUE_DATE, PAYMENT_DTE_DUE, PAY_TYPE, PAY_AMT_ORIG FROM FBNK_PD_PAYMENT_DUE

18 | P a g e
Expanded values
Expanding values using [EX] operand. Non multivalue fields are replicated. Subvalues are treated as string fields with
char delimited subvalues.

SELECT _ID, FINAL_DUE_DATE, PAYMENT_DTE_DUE[EX], PAY_TYPE[EX], PAY_AMT_ORIG[EX] FROM


FBNK_PD_PAYMENT_DUE

19 | P a g e
Expand subvalues
Expanded subvalues using [EX2] operand. Non subvalued fields are replicated.

SELECT _ID, FINAL_DUE_DATE, PAYMENT_DTE_DUE[EX], PAY_TYPE[EX2], PAY_AMT_ORIG[EX2] FROM


FBNK_PD_PAYMENT_DUE

20 | P a g e
Values & Subvalues number
Selecting values and subvalues numbers using [VN] and [SN] operands;

SELECT _ID, FINAL_DUE_DATE, PAYMENT_DTE_DUE[VN] as P_DTE_DUE_VN, PAYMENT_DTE_DUE[EX],


PAY_TYPE[VN] AS PAY_TYPE_VN, PAY_TYPE[SN] AS PAY_TYPE_SN, PAY_TYPE[EX2], PAY_AMT_ORIG[VN] AS
PAY_AMT_ORIG_VN, PAY_AMT_ORIG[SN] AS PAY_AMT_ORIG_SN, PAY_AMT_ORIG[EX2] FROM
FBNK_PD_PAYMENT_DUE

21 | P a g e
Type conversion
Driver supports some standard T24 field types like IN2CUS, IN2YM, IN2ACC, IN2CAT, IN2D, IN2AMT, IN2DEC, IN2R.
All other T24 field types are treated as VARCHAR type. In case a type conversion is needed for other field types –
extra operands can be used.

Integer conversion
Integer conversion with [I] operand.

SELECT _ID, CATEGORY, CATEGORY[I] AS CATEG_INT FROM FBNK_ACCOUNT

22 | P a g e
Float conversion
Float conversion with [F] operand.

SELECT ACCR_CHG_AMOUNT, ACCR_CHG_AMOUNT[F] AS ACA_F FROM FBNK_ACCOUNT

23 | P a g e
Date conversion
Date conversion with [D] operand.

SELECT CAP_DATE_CHARGE, CAP_DATE_CHARGE[D] AS CDC_D FROM FBNK_ACCOUNT

24 | P a g e
Character conversion/expansion
Sometimes field’s values can have more data than the length specified in STANDARD.SELECTION table. In this case
you can increase field’s size with [C.<nnn>] operand.

SELECT MNEMONIC, MNEMONIC[C.100] AS M_100 FROM FBNK_ACCOUNT

25 | P a g e
Multivalued fields conversion
In case a multivalue field needs expansion and conversion – a combination of expansion and conversion operands
can be used.

SELECT _ID, PAYMENT_DTE_DUE, PAYMENT_DTE_DUE[EX, D] FROM FBNK_PD_PAYMENT_DUE

26 | P a g e
Field joins
Field Joins functionality allows users to retrieve data from more than one file. This can be achieved by joining a field
from the selected file with a field from another file.

Syntax: source_field > dest_file > dest_field

source_field - field name of the source file, containing record ID of the target file
dest_file - target file name
dest_field - field name of the destination file
For example, the following query will return accounts from FBNK_ACCOUNT table and customer’s short name from
FBNK_CUSTOMER table

SELECT _ID, CURRENCY, CUSTOMER, CUSTOMER>F_CUSTOMER>SHORT_NAME FROM FBNK_ACCOUNT

User Defined Functions


User defined functions (UDF) can be used inside queries to transform extracted data.

27 | P a g e
Example:

SELECT _ID, WORKING_BALANCE, @UDF.AC.OPEN.BAL('20090101') AS BAL_YEAR FROM FBNK_ACCOUNT

Will return account number, working balance and open balance for a specific date.

You will find the source code of UDF.AC.OPEN.BAL subroutine in installation folder on your T24 environment
(bnk.run/T24DAC.BP).

Each UDF function shall have 4 parameters: PARAMS, RESULT, ID.REC, R.REC.

- PARAMS – a multivalue set of system parameters


o If PARAMS<1> has value “TYPE” then UDF shall return in RESULT variable the type of function result,
like “F” for float, “I” for integer, “D” for date, “C.128” for varchar(128)
o PARAMS<2, 1..N> contains the parameters passed to UDF in query.
For example in case of SELECT _ID, @MY.UDF(1, ‘SECOND’, 3, CURRENCY) FROM FBNK_ACCOUNT
query, PARAMS<2> array will contain:
28 | P a g e
▪ PARAMS<2, 1> = 1
▪ PARAMS<2, 2> = ‘SECOND’
▪ PARAMS<2, 3> = 3
▪ PARAMS<2, 4> = value of CURRENCY field for the corresponding record
- RESULT – in this variable the UDF’s result shall be returned
- ID.REC – in this variable is stored the ID of the currently selected record
- R.REC – this variable will contain the currently selected record

To create a new UDF, the following steps are required:

1. Create, compile & catalog the a new jBC subroutine which will have 4 required parameters (PARAMS,
RESULT, ID.REC, R.REC) and will do all the needed logic
2. Restart t24client.java module, so that the newly compiled routines will be accessible by t24client.java
module
3. Use newly created UDF in queries
4. t24client.java module shall be restarted after every UDF change

29 | P a g e
Stored Procedures
Stored procedures can be used to generate data which is not present in a table, so it can be considered as “virtual”
tables, from which data can be selected.

Example:

SELECT * FROM @SP.TABLE.FIELDS(‘ACCOUNT’) ORDER BY FIELD_NAME

This query will return list of fields for a specific T24 application (ACCOUNT in this case)

You will find the source code of @SP.TABLE.FIELDS stored procedure in installation folder on your T24 environment
(bnk.run/T24DAC.BP).

Each stored procedure shall have 3 parameters: PARAMS, RESULT, ID.REC.

- PARAMS – a multivalue set of system parameters


o If PARAMS<1> has value “FIELDS” then SP shall return in RESULT variable the list of field names and
their types in format <field name>;<type>, ex. AMOUNT;F or DESCRIPTION;C.128 or COUNT;I
o If PARAMS<1> has value “PREPARE” then SP shall return in RESULT variable the list of IDs to be
processed
30 | P a g e
o If PARAMS<1> has value “SELECT” then SP shall process the id passed in ID.REC parameter
o PARAMS<2, 1..N> contains the parameters passed to stored procedure in query.
For example in case of SELECT _ID, NAME FROM @SP.CUS.LIST(1, ‘second’, 3) query, PARAMS<2>
array will contain:
▪ PARAMS<2, 1> = 1
▪ PARAMS<2, 2> = ‘second’
▪ PARAMS<2, 3> = 3
- RESULT – in this variable the SP will return the list of ID or the selected/generated record
- ID.REC – in this variable is stored the ID which needs processing

To create a new stored procedure, the following steps are required:

1. Create, compile & catalog the a new jBC subroutine which will have 3 required parameters (PARAMS,
RESULT, ID.REC) and will do all the needed logic
2. Restart t24client.java module, so that the newly compiled routines will be accessible by t24client.java
module
3. Use newly created SP in queries

t24client.java module shall be restarted after every SP change

Local fields
Driver supports local fields selection.

In the following example FBNK_MM_MONEY_MARKET table has 3 local fields defined in LOCAL.TABLE application.

31 | P a g e
32 | P a g e
Query local fields
Local fields are selected as normal table fields.

SELECT _ID, SY_ID, SY_UNIT, SYEXVAL FROM FBNK_MM_MONEY_MARKET

33 | P a g e
Local fields expansion
Local fields are expanded as normal table fields

SELECT _ID, SY_ID[EX], SY_UNIT[EX], SYEXVAL[EX] FROM FBNK_MM_MONEY_MARKET

34 | P a g e
Performance tips

Use multiple SPU


SPU (SQL Processing Unit) is an “agent” which selects data from T24. Having more SPU will increase the selecting
speed proportional. You can find out the optimal SPU count for your environment using our included speed test tool.

Multiple CPU/Cores server


T24 Data Access Server uses parallel data processing. Installing server on a PC with multiple CPU/Cores will speed up
the data process a lot.

Fast Hard Disks


T24Data Access Server uses temporary files to store data extracted from T24. Using high speed HDD/SSD will
accelerate the extraction process.

RAM Disk Usage


Another way to speed up the temporary files process is to use RAM Disks (ex. ImDisk, an opensource project). Just
create a new RAM drive and update Temp parameter in configuration file to point to newly created drive.

Speed test tool


In the installation package (t24dac.zip) you will find SpeedTest.exe tool. It will test the driver performance with
different number of SPU to determine the optimal number of SPU.

Before running it, you must update several parameters in configuration file:

- TestAlias – the alias which needs to be tested


- TestTable – the table used for testing the selection speed. Table shall have enough number of records
- TestRecordCount – number of records to be selected from test table for testing the selection speed
- TestMinSPU – initial number of SPU to start tests with.

After running the speed test tool, you will get the running statistics with recommended number of SPU.

Free version vs Commercial version


There are some limitations in Free version comparing to a Commercial one.

1. Free version can use only 1 SPU


2. Speed limitation. Only first 10 seconds the driver will run at full speed of 1 SPU, the rest will be processed at
limited speed (300 records per second)

35 | P a g e
3. Parallel execution limitation. It is not possible to run jobs in parallel. If a job is started while another is
running – an exception will be raised.

36 | P a g e

You might also like