Application Program Interfaces
Application Program Interfaces
User Guide
Table of Contents
Introduction.............................................................................................................................................. 4
Application Overview ........................................................................................................................... 4
Application Customisation ................................................................................................................... 4
Introduction....................................................................................................................................... 4
OVERRIDE.CLASS.DETAILS........................................................................................................ 11
EB.API ............................................................................................................................................ 14
BATCH.CONTROL......................................................................................................................... 18
System Management Customisation ................................................................................................. 18
Introduction..................................................................................................................................... 18
SPF................................................................................................................................................. 18
Reporting / Enquiry Customisation .................................................................................................... 19
Introduction..................................................................................................................................... 19
ENQUIRY ....................................................................................................................................... 19
Standard Selection ......................................................................................................................... 22
REPGEN.CREATE......................................................................................................................... 25
RE.STAT.REQUEST...................................................................................................................... 28
CREATE.FICHE.TAPE................................................................................................................... 29
PRINTER.ID ................................................................................................................................... 30
Delivery System ................................................................................................................................. 31
Introduction..................................................................................................................................... 31
DE.FORMAT.SWIFT ...................................................................................................................... 31
DE.WORDS.................................................................................................................................... 33
DE.DISP.CONTROL ...................................................................................................................... 34
DE.MAPPING................................................................................................................................. 35
DE.CARRIER ................................................................................................................................. 36
DE.INTERFACE ............................................................................................................................. 37
DE.MESSAGE................................................................................................................................ 39
FT.OFS.DEFAULT.MAPPING ....................................................................................................... 40
FD.ACTIVITY ................................................................................................................................. 52
MG.ACTIVITY ................................................................................................................................ 53
Interfaces Local Clearing ................................................................................................................ 53
Introduction..................................................................................................................................... 53
FT.BC.PARAMETER...................................................................................................................... 54
FT.TAPE.PARAMS ........................................................................................................................ 64
AC.ENTRY.PARAM ....................................................................................................................... 71
Local Statutory Reporting .................................................................................................................. 73
Page 2 of 86
Introduction..................................................................................................................................... 73
BANK.RETURN.PARAMS ............................................................................................................. 73
Takeover / Installation Customisation................................................................................................ 74
Introduction..................................................................................................................................... 74
ALT.ACCT.PARAMETER............................................................................................................... 74
EBS.AUTO.FUNCTION.................................................................................................................. 75
TAKEOVER.MAPPING .................................................................................................................. 77
Limits.................................................................................................................................................. 79
Introduction..................................................................................................................................... 79
LIMIT.REFERENCE ....................................................................................................................... 79
Company Customisation.................................................................................................................... 83
Introduction..................................................................................................................................... 83
Company ........................................................................................................................................ 83
ACCOUNT.PARAMETER .............................................................................................................. 85
Page 3 of 86
Introduction
Application Overview
This chapter describes the available options for developers who wish to enhance the operation of the
current T24 system, where there are insufficient options provided by the Standard T24 utilities. Within
specific applications the system allows jBase subroutines (or jBase commands in some cases) to be
defined, which will then be invoked when running the applications. This provides a powerful tool to
allow customisation of T24 to meet regional or customer specific requirements.
All programs written should follow the programming standards, documented in the Programming
Standards section of this manual.
This chapter has been divided into the following areas of the system:
Application Customisation
Delivery System
Limits
Company Customisation
Application Customisation
Introduction
This section is concerned with the options available in customising the operation and content of T24
applications.
VERSION
The VERSION application allows user defined subroutines to be specified in the following fields:
AUT.NEW.CONTENT
VALIDATION.RTN
INPUT.ROUTINE
AUTH.ROUTINE
Page 4 of 86
AUT.NEW.CONTENT
This field would normally be used to automatically enter a value into a field specified in the associated
AUTOM.FIELD.NO, when a record is read using the I,C,H or V functions. The automatic contents are
only used if the existing content of the field matches that defined in the associated
AUT.OLD.CONTENT.
This field may also contain a sub-routine used to perform conditional defaulting, which cannot be
defined in Version, or defaulting from related files.
Format:
@subroutine name
Subroutine name must be defined in PGM.FILE as a type S application. The field
APPL.FOR.SUBR contains the application(s) allowed to use the subroutine.
Invoked:
Arguments:
None
Details:
Any subroutine defined in this field will be called from RECORD.READ. At this point
the record has been read and is contained in R.NEW. This subroutine should modify
the contents of R.NEW as required.
Note that this routine will always be invoked where defined and the contents defined in the field
AUT.OLD.CONTENT are not checked. Any conditional defaulting should be contained in the subroutine
coding.
Page 5 of 86
Example:
The following example demonstrates a routine, which will automatically default the CUSTOMER
SHORT.NAME into the field SHORT.NAME on the file DE.ADDRESS.
PGM.FILE definition:
Page 6 of 86
Program
VALIDATION.RTN
This field, together with VALIDATION.FLD, allows definitions of subroutines to be executed when
validating the contents of fields within an application. A routine defined here would normally be used to
perform specific validation or to default the contents of fields according to local requirements.
Format:
subroutine name
Subroutine name must be defined with an associated VALIDATION.FLD. This may
contain a field name, together with optional multi-value number and sub-value
number.
Invoked:
At Field Input validation time, immediately after the call to IN2xx as defined in the T
parameters for the application, and before any validation in the section
CHECK.FIELDS is executed. Also at Cross-Validation time, before the
CROSS.VALIDATION section of the application is executed. The subroutine will be
invoked from the program VERSION.VALIDATION.
Arguments:
None
Page 7 of 86
Details:
Routines defined here have the standard system variables available for checking. The following
variables should be used when performing checks/defaults:
COMI
Contains the contents of specified VALIDATION.FLD. This variable should be used when
defaulting/checking values for the specified VALIDATION.FLD, not R.NEW(AF), as this does not
contain the value at this point.
COMI.ENRI
This should contain the enrichment for the contents of COMI.
DISPLAY
Contains the formatted version of COMI for display purposes.
ETEXT
Contains any error message generated from the subroutine. This field should be populated when an
error is found.
MESSAGE
This variable can be used to determine whether the system is performing field level checks or cross
validation. At cross-validation time, it will contain the value VAL; on-line it will be null.
Example:
The following example shows an example of defaulting the CUSTOMER name based on the following
rules:
Mandatory Input
If local reference field CUST.STATUS (value #3 in LOCAL.REF) = B
CUST.STATUS = C
Page 8 of 86
Page 9 of 86
INPUT.ROUTINE
A subroutine may be executed at the unauthorised stage of transaction processing, as the final stage
before updating unauthorised files. Multiple routines may be defined by expanding the multi-values.
Routines called at this stage may be used to update local files, or to provide additional checking or
override processing. At this point of the transaction, all standard default and validation processing will
have taken place.
Format:
subroutine name
Subroutine name must be defined.
Invoked:
Arguments:
None
Updates to files must use the standard F.WRITE, F.MATWRITE and F.DELETE routines to ensure
data base integrity.
NOTE: At this point file updates may have occurred, although not written to disk, since accounting will
have been performed.
Page 10 of 86
AUTH.ROUTINE
A subroutine may be executed at the authorised stage of transaction processing, as the final stage
before updating authorised files. Multiple routines may be defined by expanding the multi-values.
Routines called at this stage may be used to update local files. No checking or override processing
should be performed at this stage, as the system cannot process error conditions at this point.
Format:
subroutine name
Subroutine name must be defined.
Invoked:
Arguments:
None
A routine used at this stage will be typically used to provide updates to local files.
OVERRIDE.CLASS.DETAILS
OVERRIDE.CLASS.DETAILS allows a subroutine to be defined to manipulate an override message
so that the conditions defined in this table may be applied to it. For example, an overdraft message
could be converted into local currency for allocating an override class depending on the amount.
DATA.DEF
This field is used to define a variable element of the override message, which may be used as the
basis for sub-classification. A routine may be defined to perform required extraction/conversion to the
elements of the override message.
Format:
@subroutine name(par1,....parn)
Subroutine name must be defined in PGM.FILE as a type V application. Where
parameters are required, these must be defined in the PGM.FILE record field
ADDITIONAL.INFO as .PAR(xx,xx...xx) where xx describes the validation rules to be
applied to the parameter. Where no parameters are required the parentheses are still
required.
Invoked:
From STORE.OVERRIDE
Arguments:
Page 11 of 86
Details:
Any subroutine defined here must return details in both OVERRIDE.VALUE and DATA.DEF. The
variable elements in the OVERRIDE.VALUE can be converted to a required value, for example
converting foreign amounts to a local currency for checking.
The DATA.DEF value can be used to return a derived value for the specified element.
Example:
The following screenshot example shows a routine used to give a different override class depending
on the amount of overdraft.
Page 12 of 86
Program LIMIT.CCY.CONV
Page 13 of 86
EB.API
After the subroutine has been written, it needs to specify in EB.API application
FIELDS
DESCRIPTION
ID
Description
Subroutine description
Protection Level
Source Type
Select BASIC
Program (ID)
For on-line applications the key to this record must be the same as the program to be run.
Format:
Subroutine name
Subroutine name is the name of the application, which can be invoked. The field
TYPE indicates the application type to be executed. For on-line use this may
H,U,L,T,W or M.
Invoked:
From RUN.APPLICATION
Arguments:
None
Details:
Any application of types H,U,L,T or W are used to maintain a file and must conform to the standard
TEMPLATE application type. See the section Template Programming for details.
Type M routines are used to execute a specific main line program where there is no standard file
maintenance required, for example a conversion program, or program to print a report. Where a
history is required of a program being run, a type W program should be used. See the section
Template Programming for details.
When a type M program is written, it must contain a SUBROUTINE statement at the start in order to
return to T24 once executed. See the Programming Standards section for details of commands, which
must not be used.
Page 14 of 86
Example:
The parameter file IBLC.PARAMETER contains local reporting codes for Belgium and Luxembourg
reporting. This is a type U routine (i.e. it does not maintain a history file).
Page 15 of 86
Program
BATCH.JOB
This field is used to define the names of subroutines or jBase commands which may be executed from
the T24 BATCH.CONTROL process. To be executed during the end of day the BATCH.JOB must be
defined on a BATCH record.
Format:
Invoked:
From B.INITIATE.PROCESS
Arguments:
None.
Details:
A subroutine may be written to perform specific end of day processing. This may have a variety of
functions, such as maintenance of local files/applications, production of reports, interface file
production etc. See the Programming Standards section for rules when writing end of day programs.
A jBase command or paragraph can also be executed from this option. Any item recognised in the
VOC file of the correct type may be executed.
Page 16 of 86
Example:
Example of UniVerse list command to produce a report on the JOURNAL file.
Page 17 of 86
BATCH.CONTROL
API calls like subroutine, script, crystal report or enquiry can be run at the pre batch stage. Multiple
calls may be defined by expanding the multi-values.
Format:
Subroutine
It
has
SPT
It
has
to
to
be
defined
Script
defined
be
in
name
VOC
in
Name
F.SCRIPT.DESIGNER
RPT
Report
Name
It has to be defined in F.REPORT.CONTROL and it has to be a crystal report.
ENQ
It
has
to
be
Enquiry
defined
in
Name
F.ENQUIRY
This is a multi-valued field and several API calls may be executed sequentially.
Invoked:
From BATCH.CONTROL. This routine is called just before control passes to the
batch menu.
Arguments:
None.
Details:
SPF
The SPF file allows definition of the command(s) used to perform the system backup and restore at
end of day.
Format:
Invoked:
Arguments:
None.
Page 18 of 86
Details:
Complex series of instructions may be specified in a UNIX shell script.
For further details see the Backup, Restore and Recovery chapter in the System Administration Guide
and the Helptext on SPF.
ENQUIRY
The ENQUIRY application provides three main areas where local routines may be added to provide
additional functionality. These are:
Selection of data where criteria cannot be easily specified within the existing application (this will
be covered under STANDARD.SELECTION).
Conversion
Local conversion routines may be written to manipulate extracted data.
Format:
@ subroutine name
Subroutine name is the name of the jBase subroutine to be executed. Note the
required space between @ and the name.
Invoked:
Arguments:
None
Page 19 of 86
Details:
The enquiry system has its own common area I_ENQUIRY.COMMON, which must be inserted at the
start of all conversion routines. This allows access to the variables controlling the enquiry processing.
See the insert in GLOBUS.BP for details of all the variables passed in this common.
The following variables are the most likely ones to be required when writing a conversion routine:
ID
R.RECORD
O.DATA
- The current incoming data being processed. This is also the returned data.
VC
VM.COUNT
SM.COUNT
Example:
The following example shows a routine, which displays either the actual maturity date of an LD/MM
deal, or displays the number of day's notice:
Page 20 of 86
BUILD.ROUTINE
A routine may be called prior to the selection phase of the enquiry when running the enquiry. This
routine should be used to manipulate the data prior to selection, for instance it could be used to build a
work file.
Subroutine name
Format:
Subroutine name is the name of the jBase subroutine to be executed. More than one
routine may be specified.
Invoked:
Arguments:
ENQUIRY
Where ENQ is a dynamic array containing the entered selection criteria as follows:
ENQ<1>
Name of enquiry
ENQ<2,x>
ENQ<3,x>
Associated Operands
ENQ<4,x,y>
Data List
Details:
The data passed in ENQ should be used within the subroutine to determine the action to be taken.
Data is not required to return to the enquiry system.
QQQ<1>
QQQ<2,x>
QQQ<3,x>
QQQ<4,x,y>
QQQ<9,z>
QQQ<10>
Page 21 of 86
Standard Selection
The STANDARD.SELECTION application allows definition of local subroutines, which can be used as
selection items in the Enquiry system. These can be used within enquiry to perform selections of data
not possible through the existing system.
They can also be used to build virtual records containing data from different files; this can be achieved
using a NOFILE record type.
Format:
Subroutine name
Subroutine name is the name of the subroutine to be executed.
Invoked:
From CONCAT.LIST.PROCESSOR
Arguments:
RTN.LIST
Where RTN.LIST is a dynamic array containing the selected keys to be returned to
the enquiry system, separated by field markers (@FM).
Page 22 of 86
Details:
The main purpose of using a routine at this point is to return a list of keys for the enquiry process to
use. Possible reasons for using a routine may be: the selection required might not be possible to be
entered directly into the enquiry system; require additional checks; or the selection may simply be too
slow and may require an alternative access method.
Since the routine will need to use the common enquiry variables, the insert I_ENQUIRY.COMMON
should always be inserted at the top of the subroutine. The main variables likely to be required are:
D.FIELDS
D.LOGICAL.OPERANDS <X>
D.RANGE.AND.VALUE <X,Y>
The routine must perform the required processing to build the RTN.LIST. Note that if this routine is
being used to pre-select data ready for a further selection within the enquiry system, if no records are
returned, the enquiry system will attempt to select the whole file. This may have performance
implications.
Since there is no actual underlying file in the system, the selection must be performed by a routine,
described in the previous section. An additional CONVERSION routine will usually be required to build
R.RECORD, the record used in the enquiry.
Page 23 of 86
For example an enquiry may be required which is driven from two files, A and B.
A NOFILE STANDARD.SELECTION record will be created containing at least one field, used to
define the selection routine
The selection routine selects files A and B and returns a list of keys in the format filename*id
A conversion routine is written, so that given filename*id it will read the correct file, and build the
data into a common format in R.RECORD
The routine is attached to field 0 in the enquiry, so that as soon as field 0 is processed,
R.RECORD contains the expected layout with data extracted from the correct file.
Page 24 of 86
REPGEN.CREATE
The repgen utility allows use of subroutines in two areas:
MODIFICATION
FL.DECISION.FR
FL.DECISION.FR
Repgen allows a subroutine to be entered to perform a selection. The value SUB must be entered in
FL.DECISION to indicate that this field contains a sub-routine definition.
Format:
Subroutine name
Subroutine name is the name of the subroutine to be executed. Only one subroutine
may be defined per read file. The subroutine name must be defined on PGM.FILE file
as a type S application.
Invoked:
Arguments:
FILENAME
Where FILENAME is the full filename to be selected.
Details:
The routine should perform the required selection of the FILENAME supplied and return an ACTIVE
select list to the RGS... program.
The REPGEN.SORT record is available in R.NEW, and may contain specified values in the fields
CONSTANTS.
Page 25 of 86
Example:
The following routine selects CUSTOMER records with a specified account officer or customer number.
Account officer is specified in Value 1 of the field CONSTANTS, customer number is specified in Value
2.
Modification
The MODIFICATION field allows a sub-routine to be called to manipulate the extracted data.
Format:
@ Subroutine name#n
Subroutine name is the name of the jBase subroutine to be executed. #n denotes the
argument number in the call to the subroutine.
The subroutine must be defined in PGM.FILE as a type R routine, together with the
required number of parameters in field ADDITIONAL.INFO as .PAR(xx, ..xx).
The actual name of the sub-routine must be defined in the PGM.FILE record in the
field BATCH.PROCESS prefixed by a @.
Invoked:
Arguments:
Par1 ,Parn
Where Parn may be any number of parameters (at least one) as per the definition in
Page 26 of 86
PGM.FILE.
Details:
All details required in the subroutine from the repgen must be passed into the subroutine as separate
arguments. A single value may be returned.
Example:
The following routine returns a formatted LIMIT.REFERENCE with leading zeroes.
Program
Page 27 of 86
RE.STAT.REQUEST
An alternative print routine may be specified instead of RE.STAT.REQUEST to produce CRF reports.
PRINT.ROUTINE
Alternative print routine to RE.STAT.PRINT standard routine
Format:
Subroutine name
Subroutine name is the name of the subroutine to be executed.
Invoked:
From RE.STAT.REQUEST$RUN
Arguments:
Details:
Production of CRF reports is a complex process extreme care should be taken if using this option.
Page 28 of 86
CREATE.FICHE.TAPE
Allows definition of a command (or routine), which can be used to create a fiche file.
TAPE.CREATE
Any jBase command or subroutine may be specified here. Usually a UNIX cat command will be used
to build a file.
Format:
Command
Command may be any executable command from jBase.
Invoked:
From EXECUTE.COMMAND.
Arguments:
None
Details:
The routine is driven from F.FICHE.HOLD.CONTROL, and will be able to pass the id in the command
line. This can then be accessed within any required routine using the system variable @SENTENCE.
LOCAL.FICHE.LOAD &FICHE.HOLD.CONTROL>@ID&
The routine would then have to check @SENTENCE[ ,2,1] in order to extract the id.
Page 29 of 86
PRINTER.ID
Allows definition of a command (or routine) that can be used to create a file of printed output. This
means that whenever T24 output is directed to this printer id, the command will be invoked.
Command
Any jBase command or subroutine may be specified here. Usually a UNIX cat command will be used
to build a file.
Format:
Command
Command may be any executable command from jBase.
Invoked:
From EXECUTE.COMMAND.
Arguments:
None
Details:
The routine is driven from F.HOLD.CONTROL, and will be able to pass the id in the command line.
This can then be accessed within any required routine using the system variable @SENTENCE.
LOCAL.PRINT.LOAD &HOLD.CONTROL>@ID&
The routine would then have to check @SENTENCE[ ,2,1] in order to extract the id.
Page 30 of 86
Delivery System
Introduction
The T24 delivery system provides the ability for user defined routines for mapping messages, control
of disposition, processing SWIFT interfaces, and for formatting inward and outward Swift messages.
The Delivery system has been further opened up to enable users to define their own formatting rules
for messages and to write interface routines, using the Generic Delivery Interface.
DE.FORMAT.SWIFT
The DE.FORMAT.SWIFT application allows a subroutine to be called for a particular Swift Field when
processing incoming Swift messages
INWARD.ROUTINE
Format:
Enter Y in field.
Subroutine must be called DE.ICONV.nn where nn is the SWIFT field tag, e.g.
DE.ICONV.61.
Invoked:
From DE.I.FORMAT.SWIFT.MESSAGE.
Arguments:
FIELD, LINE
Where FIELD contains the data from the SWIFT message for decoding
LINE contains the decoded message. Field markers should separate each
component of the LINE using the field marker, (@FM).
Details:
A routine may be written where a SWIFT field contains several components, which need to be
separated and possibly converted so that incoming processing can correctly handle the message.
Example:
The following routine decodes swift field 32, which is comprised of:
Currency (3 alpha)
Amount
E.g. 010195GBP1234,56
Page 31 of 86
Page 32 of 86
DE.WORDS
This application allows a user routine to be defined for a given language to allow translation of
numbers to words.
Format:
Subroutine Name
Invoked:
From DE.O.FORMAT.PRINT.MESSAGE
DE.O.FORMAT.TELEXP.MESSAGE
PRODUCE.DEAL.SLIP.
Arguments:
Details:
Where a new language is used which does not fit into the existing DE.WORDS format, or requires
special processing, a routine should be written to perform the conversion of numbers to words. This
may reference a DE.WORDS record for the language if required.
Page 33 of 86
DE.DISP.CONTROL
A user-defined routine may be called to provide enhanced selection for disposition control.
FIELD.NAME
Allows a subroutine to be defined to return either true or false depending on a selection match.
Format:
@Subroutine name.
Must be an entry in the VOC of type V.
Invoked:
Arguments:
The routine is passed the current DE.O.HEADER record in argument one, the
OPERAND in argument two and the CONDITION in argument three. The return
argument is argument four and should evaluate to true (1) or false (0 or null).
Details:
The routine itself should perform a selection and determine a match and set the return argument
accordingly.
Page 34 of 86
DE.MAPPING
The DE.MAPPING application allows a user subroutine to modify the information passed to
APPLICATION.HANDOFF by the calling application and hence to map additional data, which is not
normally available for the message type.
Routine
Allows a subroutine to be defined, which may modify the contents of the delivery hand-off.
Format:
@Subroutine name.
Must be an entry in the VOC of type V.
Invoked:
From APPLICATION.HANDOFF.
Arguments:
A DIMensioned array of the nine hand-off records is passed as the first argument
and a null in the second argument, which is used as a return error message.
Details:
The routine is passed all nine of the hand-off records in a DIMensioned array as the first argument and
if there is a value in the second value on return from the routine the mapping does not proceed and
the error message is handed back to the calling application.
If all the records are blanked by the call to the user routine the mapping process does not proceed and
an error returned to the calling application.
Page 35 of 86
DE.CARRIER
The delivery carrier file, DE.CARRIER, contains details of all the carriers available in Delivery. To
enable a carrier, it must be specified on the Delivery Parameter file, DE.PARM.
The id of this file is the name of the carrier, as used in DE.PRODUCT. Each record contains the
address type to be used for the carrier (i.e. when accessing DE.ADDRESS), the formatting rules
(DE.FORMAT.CARRIER) and the carrier module (e.g. DE.O.CC.SWIFT). If the carrier module is
GENERIC, i.e. the messages are handled by the generic program DE.CC.GENERIC, then the
interface must be specified. The interface must reference a record on DE.INTERFACE, which
contains details of the protocol for all generic interfaces (non-generic interface details are stored on
the parameter file, DE.PARM).
When the record is authorised, formatting and carrier files are created if they do not already exist.
These files are F.DE.O.MSG.format-module and F.DE.O.PRI.format-module for the formatting files
and F.DE.O.MSG.interface and F.DE.I.MSG.interface for the interface files.
Address
Specifies the type of record to be read from the delivery address file, DE.ADDRESS, to get the
address for this carrier the following can be keys can be used:
E.g. ADDRESS could be specified as SWIFT. Therefore, the delivery address file will be accessed
with a key of:
E.g.
USD0010001.C-10001.SWIFT.1
Carrier Module
Specifies the formatting module to be used. The rules describing the formatting of the messages
should therefore exist on the file, DE.FORMAT.format-module, e.g. DE.FORMAT.SWIFT. Various
formatting modules are included in T24 (e.g. SWIFT, PRINT, different telex formats). However, new
formatting modules can be written. The formatting rules would be specified on a new table,
DE.FORMAT.carrier-module. Therefore, a template-type program DE.FORMAT.carrier-module must
be written to define the formatting rules. The messages will then be formatted by the formatting
program, DE.O.FORMAT.format-module.MESSAGE, which would also need to be written.
Interface
Specifies the name of the interface to be used. The CARRIER.MODULE must be specified as
GENERIC. Messages will be processed by the generic delivery interface, DE.CC.GENERIC, but will
be sent/received by the interface routines specified on DE.INTERFACE. The name of the interface
specified in this field must reference a record on DE.INTERFACE.
Page 36 of 86
DE.INTERFACE
This file contains details of the protocols for all interfaces which use the Generic Delivery Interface.
The protocols for interfaces written prior to the introduction of the Generic Delivery Interface are either
stored on DE.PARM or are hard-coded in the program. Sequence numbers for existing interfaces are
stored on F.LOCKING.
The id of the file is the interface as defined in the interface field on DE.CARRIER.
There is little validation of the fields on DE.INTERFACE. This is to allow for maximum flexibility when
new interfaces are written. Each field can be used to control how the interface is defined and used,
more information on this can be found in the Helptext.
OUT.IF.ROUTINE
Defines the name of the interface routine, which is called from the generic delivery interface program,
to send the messages to the required carrier.
If this field is left blank, the messages are still written to the interface file, but it is assumed that a
separate program is invoked at a later time to send the messages (for example, to create batched
messages once a day).
Subroutine name
Format:
From DE.CC.GENERIC.
Arguments:
Details:
The routine is called from DE.CC.GENERIC, the generic delivery program. DE.CC.GENERIC controls
all the updates of the delivery files - the outward interface program merely has to send the message to
the interface required. The routine is executed. Therefore, the routine does not have to be an
Info/Basic routine. However, a VOC entry must exist for it.
IN.IF.ROUTINE
Defines the name of the interface routine, which is called from the generic delivery interface program,
to receive messages from the required carrier.
Format:
Subroutine name.
A VOC entry must exist
Invoked:
From DE.CC.GENERIC.
Arguments:
Page 37 of 86
Details:
The routine is called from DE.CC.GENERIC, the generic delivery program. DE.CC.GENERIC controls
all the updates of the delivery files - the inward interface program merely receives messages and
acknowledgements (positive or negative) from the interface required. The routine is executed.
Therefore, the routine does not have to be an Info/Basic routine. However, a VOC entry must exist for
it.
The delivery header record is passed back from the routine. Although this record will be created by
DE.CC.GENERIC, the interface routine can populate any fields recognised in the message.
Page 38 of 86
DE.MESSAGE
A routine can be defined to process inward messages to generate Funds Transfers using the OFS
module.
IN.OFS.RTN
A default routine, FT.OFS.DEFAULT.MAPPING is available for message types 100, 200, 202, and
205.
Format:
Subroutine name.
Subroutine must be defined in PGM.FILE as a type S program.
Invoked:
From FT.OFS.INWARD.MAPPING.
Defined in IN.DIR.RTN on OFS.SOURCE, this routine is called from the OFS
phantom process OFS.REQUEST.MANGER.
Arguments:
DEI.MSG.FT.IN key
R.INWARD - mapped from delivery system
R.SWIFT - swift message text
MESSAGE.TYPE - e.g. 100, 200, 202
R.DE.MESSAGE - DE.MESSAGE record
OFS.KEY - returned OFS message key
OFS.MESSAGE - returned OFS message
The source code for FT.OFS.DEFAULT.MAPPING is released and a detailed description of the default
mapping logic follows.
Page 39 of 86
FT.OFS.DEFAULT.MAPPING
R.INWARD
This record is mapped from incoming SWIFT messages by the delivery system, and is used to create
OFS messages, which will in turn create Funds transfers.
Page 40 of 86
File: FUNDS.TRANSFER
Following fields are mapped from R.INWARD, and then used to generate an OFS message.
Page 41 of 86
Page 42 of 86
Page 43 of 86
SPECIAL.FIELDS
W.ACCOUNT.FOUND set to account number, (may not be a T24 account number).
W.ACCT.FOUND set to TRUE if an account is found.
Page 44 of 86
FIND.CUSTOMERS.ACCOUNT
to
attempt
to
determine
the
to
determine
the
FIND.CUSTOMERS.ACCOUNT
Page 45 of 86
to
attempt
If CURRENCY is not equal to the local currency then the routine GET.CUSTOMERS.NOSTRO is called.
If CURRENCY is equal to the local currency the routine GET.CUSTOMERS.VOSTRO is called.
FT.CREDIT.ACCOUNT logic
W.ACCT.FOUND is set to FALSE and W.ACCOUNT.FOUND is set to null.
W.INTER.WITH is set to FALSE.
The routine TEST.INTERMEDIARY is called.
If an error message is returned then no further tests take place.
IF the message type is a 202 or 205 then the TEST.BENE.BANK routine is called.
IF an error message is returned then no further tests take place.
Page 46 of 86
If FT.CREDIT.ACCOUNT has been set then the following checks take place.
Read the ACCOUNT.FILE with FT.CREDIT.ACCT.NO.
If no record is found then set FT.BEN.ACCT.NO to
FT.CREDIT.ACCT.NO to null and return with an error message.
FT.CREDIT.ACCT.NO
and
set
If all the above tests have been passed then the following processing takes place.
The FT.TRANSACTION.TYPE will be set to "IT" unless the following conditions occur when it will be
set to "OT".
Message type is 100 and there is an account with bank.
Message type is 200, as there will always be an account with bank and the sender bank is always the
beneficiary bank.
Message type is 202, if there is no account with or intermediary then DW otherwise OT.
If INTMED.BK.ACC is set then set FT.CREDIT.ACCOUNT to this value and set W.INTER.WITH and
W.ACCT.FOUND to TRUE and return.
N.B. no validation of the account number takes place at this stage.
Page 47 of 86
If ACC.WITH.BK.ACC is set then set FT.CREDIT.ACCOUNT to this value and set W.INTER.WITH
and W.ACCT.FOUND to TRUE and return.
N.B. no validation of the account number takes place at this stage.
Page 48 of 86
If BEN.CUSTOMER is not null then set FT.BEN.CUSTOMER to this value and return.
N.B. the current version of FT.IN.PROCESSING has a further section of code, which uses
BEN.CUSTOMER to check for a VOSTRO account. This code will not be executed.
FIND.CUSTOMERS.ACCOUNT
The following logic applies to this routine.
If W.CD is set then the following logic applies.
If the customer is null and the account is set then read the account file to determine if the account is
one of ours, if it is then set FT.DEBIT.ACCOUNT to the account number.
N.B. the above processing does not take place in FT.IN.PROCESSING
Otherwise if the R.COR.BK.CD is set to "C" then call the routine GET.CUSTOMERS.NOSTRO.
If W.CD is null and W.CUS is set then the following logic applies
If CURRENCY is not equal to the local currency then the routine GET.CUSTOMERS.NOSTRO is called.
Page 49 of 86
If an account has been found then set the flag W.ACCT.FOUND to TRUE.
GET.CUSTOMERS.NOSTRO
Read the AGENCY file for W.CUS.
Locate W.ACC in the NOSTRO.ACCT.NO field of the AGENCY record. If it is found then set
W.ACCOUNT.FOUND to the relevant value, otherwise set it to null.
GET.CUSTOMERS.VOSTRO
This program calls the routine GET.AGENT with the following parameters set.
Page 50 of 86
"FT" or "ALL" must be present in the AUTORTE.APPL field of the AGENCY record.
If the AUTORTE.BANK for the relevant AUTORTE.APPL is set to "VOSTRO" or "CUSTOMER" then the
following processing applies, otherwise the AGENCY record for the AUTORTE.BANK for the relevant
AUTORTE.APPL is read, and the above validation checks apply to the new record, if successful the
following logic applies.
If OUT.CUSTOMER is not set to "VOSTRO" then read the CUSTOMER.CCY.ACCT file with a key of
W.CUS:CURRENCY:1.
If a record is found then set W.ACCOUNT.FOUND to the first account number in the list.
Page 51 of 86
FD.ACTIVITY
The Fiduciary application allows subroutines to be called to modify the contents of data passed to
delivery from the application.
HANDOFF.ROUTINE
Allows a subroutine to be defined, which may modify the contents of the delivery hand-off in record
number 7.
Format:
Subroutine name.
Subroutine must be defined in PGM.FILE as a type S program.
Invoked:
From FD.GENERATE.DELIVERY.
Arguments:
SPECIAL.REC
Where SPECIAL.REC contains the additional data to be passed to delivery from the
Fiduciary application.
Details:
The contents of SPECIAL.REC must be created within this routine. The Fiduciary common are
I_FID.COMMON is available at this point. The following variables are likely to be required:
FD$R.ORDER( )
FD$R.PLACEMENT( )
FD$R.BALANCES( )
Page 52 of 86
MG.ACTIVITY
The mortgage application allows subroutines to be called to modify the contents of data passed to
delivery from the application.
HANDOFF.ROUTINE
Allows a subroutine to be defined, which may modify the contents of the delivery hand-off.
Format:
Subroutine name.
Subroutine must be defined in PGM.FILE as a type S program.
Invoked:
From MG.DE.HANDOFF.
Arguments:
Details:
A further option allows a sub-routine to be invoked from the delivery processing, which can allow
diversion of messages with different carriers into the local clearing system according to the coded
rules.
Page 53 of 86
FT.BC.PARAMETER
This application allows customisation of existing field level validation for the BC Funds Transaction
type. Additionally subroutines may be defined to perform specific local validation within the FT module
in the following fields:
FT.VALIDATION.RTN
FT.DELIVERY.RTN
STO.VALIDATION.RTN
BULK.STO.VALID.RTN
Additionally the ability to define subroutines called from the CUSTOMER and ACCOUNT applications
is provided in the fields:
ACCOUNT.UPD.RTN
CUSTOMER.UPD.RTN
A subroutine to allow diversion of messages into the local clearing system within the delivery system
may be defined in:
DIVERSION.RTN
Format:
Subroutine name
Subroutine name contains the name of the Info Basic subroutine to be executed. The
Subroutine name defined must exist on PGM.FILE as a type S program.
Invoked:
Arguments:
Curr No
Where Curr No contains the current number of overrides held on the Funds Transfer
record.
Page 54 of 86
Details:
The purpose of a subroutine written at this point is to perform cross-validation of the input in the
FUNDS.TRANSFER record according to the local requirements.
A local clearing common area is available in the insert I_F.FT.LOCAL.COMMON, and must be
inserted at the start of the subroutine, together with Funds Transfer common area I_F.FTCOM.
FTLC$BC.PARAMS
FTLC$LOCAL.CLEARING
R.CREDIT.ACCT( )
R.DEBIT.ACCT( )
R.CHARGE.ACCT( )
All validation must be performed using the contents of R.NEW, the current record. Management of
errors must cater for the fact that the routine will be executed on-line under user control, on-line
automatically (when processing clearing tapes/files), and at end of day (when processing Standing
Orders). The common variable AUTO.PROCESS will be set to Y when processing during the end of
day, or automatically on-line. Error message processing should set ETEXT and call
STORE.END.ERROR when NOT processing automatically, otherwise the routine should return when
an error is found.
Overrides may be generated when processing manually on-line, in the standard manner, by setting
TEXT and calling STORE.OVERRIDE.
Where local reference items are used to contain local clearing elements, a list of elements can be
found in the fields REQ.LOCREF.NAME, REQ.LOCREF.APP and REQ.LOCREF.POS in the
FT.LOCAL.CLEARING record, which give the location within the LOCAL.REF field in the specified
application.
Page 55 of 86
Example:
The following example illustrates use of local reference identifiers in FT.LOCAL.CLEARING. The items
SCC.TXN.CODE is mandatory for BC transaction types:
Page 56 of 86
This code will check to see if the local reference SCC.TXN.CODE contains a value in the
FUNDS.TRANSFER record:
Format:
Subroutine Name
Subroutine Name contains the name of the subroutine to be invoked.
Invoked:
Arguments:
None
Details:
The subroutine must contain the insert files I_F.FT.LOCAL.COMMON and I_F.FTCOM, which hold the
local clearing common variables and the Funds Transfer common variables respectively.
Any of the variables described in the FT.VALIDATION.RTN may be used. Any error found should set
ETEXT. This will be detected on return to FT.DELIVERY and cause an error to be generated by Funds
Transfer.
Any additional delivery messages required must be generated by calling the subroutine
APPLICATION.HANDOFF (see Standard subroutine guide for further details). Any delivery message
used for local clearing must use the reserved range 1200 - 1300 of message types.
Page 57 of 86
Examples:
This routine will update a cross-reference file, FT.BC.XREF when a local clearing funds transfer is
authorised. The record will be deleted if a reversal is authorised. An additional check is made so that
if a reversal is attempted and there is no record present on FT.BC.XREF, the reversal will be aborted.
Page 58 of 86
STO.VALIDATION.RTN (STANDING.ORDER)
A subroutine may be defined to perform cross-validation of STANDING.ORDER records, which are
paid through the local clearing method (FUNDS.TRANSFER BC TRANSACTION.TYPE).
Format:
Subroutine Name
Subroutine name contains the name of the subroutine to be executed. It must be
defined on PGM.FILE as a type S program.
Invoked:
Arguments:
R.FT.LOCAL.CLEARING, R.FT.BC.PARAMETER
Where R.FT.LOCAL.CLEARING contains the FT.LOCAL.CLEARING
R.FT.BC.PARAMETER contains the FT.BC.PARAMETER record.
record
Details:
The contents of R.NEW should be validated according to local requirements. The validation should
ensure that information entered in the STANDING.ORDER record is sufficient, and correct, in order to
produce a valid BC FUNDS.TRANSFER record.
Error messages must be reported by setting ETEXT and calling STORE.END.ERROR in the usual
manner.
Local reference items required in the Funds Transfer to be generated are entered in the fields
FT.LOC.REF.NO (the position within local reference in Funds Transfer) and FT.LOC.REF.DATA. The
correct position of local reference items within the LOCAL.REF field in FUNDS.TRANSFER can be
checked using the variables REQ.LOCREF.NAME, REQ.LOCREF.APP and REQ.LOCREF.POS in
the FT.LOCAL.CLEARING record.
Page 59 of 86
Example:
The following subroutine performs specific validation for the Slovak clearing system:
Figure 33 - The above subroutine performs specific validation for the Slovak
clearing system
Page 60 of 86
BULK.STO.VALID.RTN (BULK.STO)
A sub-routine may be defined to perform cross-validation of Bulk Standing Order records, which are
paid through the local clearing method (FUNDS.TRANSFER BC TRANSACTION.TYPE).
Format:
Subroutine Name
Subroutine name contains the name of the subroutine to be executed. It must be
defined on PGM.FILE as a type S program.
Invoked:
Arguments:
R.FT.LOCAL.CLEARING, R.FT.BC.PARAMETER
Where R.FT.LOCAL.CLEARING contains the FT.LOCAL.CLEARING record
R.FT.BC.PARAMETER contains the FT.BC.PARAMETER record.
Details:
The contents of R.NEW should be validated according to local requirements. The validation should
ensure that information entered in the BULK.STO record is sufficient, and correct, in order to produce
a valid BC FUNDS.TRANSFER record.
Error messages must be reported by setting ETEXT and calling STORE.END.ERROR in the usual
manner.
Local reference items required in the Funds Transfer to be generated are entered in the fields
FT.LOC.REF.NO (the position within local reference in FUNDS.TRANSFER) and FT.LOC.REF.DATA.
The correct position of local reference items within the LOCAL.REF field in FUNDS.TRANSFER can
be checked using the variables REQ.LOCREF.NAME, REQ.LOCREF.APP and REQ.LOCREF.POS in
the FT.LOCAL.CLEARING record.
Page 61 of 86
Example:
The following example performs the specific validation for the Bulk Standing Orders in the Slovak
clearing system.
Page 62 of 86
ACCOUNT.UPD.RTN (ACCOUNT)
Where a clearing system requires static information from the ACCOUNT file, a subroutine may be
called to update an extract file.
Format:
Subroutine Name
Subroutine name contains the name of the subroutine to be executed. It must be
defined on PGM.FILE as a type S program.
Invoked:
Arguments:
None
Details:
The contents of R.NEW contain the current ACCOUNT record. R.OLD will contain the previous
authorised contents of the account record.
The FT.LOCAL.CLEARING record can be used top define the position of required local reference
elements within the Account local reference field.
CUSTOMER.UPD.RTN (CUSTOMER)
Where a clearing system requires static information from the CUSTOMER file, a subroutine may be
called to update an extract file.
Format:
Subroutine Name
Subroutine name contains the name of the subroutine to be executed. It must be
defined on PGM.FILE as a type S program.
Page 63 of 86
Invoked:
Arguments:
None.
Details:
The contents of R.NEW contain the current CUSTOMER record. R.OLD will contain the previous
authorised contents of the CUSTOMER record.
The FT.LOCAL.CLEARING record can be used to define the position of required local reference
elements within the CUSTOMER local reference field.
DIVERSION.RTN (Delivery)
This is the old method used for diverting messages from a standard carrier to the local clearing carrier.
It was used for the Swiss Clearing system (SIC). However, to use this, changes are required to the
Delivery system. Therefore, Generic Delivery was designed and it is this which should now be used if
you wish to direct messages to a local clearing carrier (see the section Adding a new interface in the
Delivery User Guide.
FT.TAPE.PARAMS
The FT.TAPE.PARAMS application manages import and export of data for the local clearing system(s)
installed. Data is typically downloaded or uploaded onto tapes, or directly to a specified file.
Subroutines and commands may be defined for each type of interface, which are used for:
LOAD.CMD
LOAD.ROUTINE
UPDATE.ROUTINE
CREATE.CMD
CREATE.ROUTINE
GENERATE.ROUTINE
ENQ.PURGE.ROUTINE
LOAD.CMD
A command or routine may be executed, which will be used to download a tape or file into a specific
directory on the system.
Format:
Command name
Command name contains the name of any valid jBase command, which can be
executed. This may also include a subroutine name, which can be executed. Multiple
Page 64 of 86
Arguments:
None.
Details:
Typically a UNIX command will be specified prefixed by SH -c to allow the command to run from
jBase. This could also be specified within an InfoBasic subroutine.
The command/subroutine must download the tape/file into the directory FT.IN.TAPE, with the name
Tape.Name. WORK, where Tape Name is the key to the FT.TAPE.PARAMS record.
Example:
Example of a load command:
LOAD.ROUTINE
A subroutine must be written to process the downloaded tape/file, to extract the main header
information for the file. This contains information required so that an operator can verify the correct
file/tape has been downloaded prior to updating T24 with the contents.
Format:
Subroutine Name
Subroutine name contains the name of the subroutine to be executed. It must be
defined on PGM.FILE as a type S program.
Invoked:
From FT.TAPES$RUN when the LOAD function is used, after the LOAD.CMD has
been executed
Arguments:
Page 65 of 86
Details:
The routine must process the tape which has been downloaded into a file in the directory FT.IN.TAPE
with the name Tape.Name .WORK, where Tape.Name is the key to the FT.TAPE.PARAMS record
passed as the first argument to the subroutine. Some systems will download a separate Header
record and trailer record. These must be read from an agreed location, preferably the FT.IN.TAPE
directory.
The subroutine must extract as many of the passed parameters as possible so that maximum details
may be recorded.
Page 66 of 86
Example:
The following example extracts the required details from a Swiss PTT tape, which has been
downloaded into FT.IN.TAPE directory, record PTT.WORK.
Page 67 of 86
UPDATE.ROUTINE
A subroutine must be defined to create FUNDS.TRANSFER records from the downloaded tape. This
will be executed from the FT.TAPES application.
Format:
Subroutine Name
Subroutine name contains the name of the subroutine to be executed. It must be
defined on PGM.FILE as a type S program.
Invoked:
Arguments:
TAPE.SEQ.NR, TAPE.NAME
Where TAPE.SEQ.NR is the sequence number allocated to the tape by T24.
TAPE.NAME is the name of the tape, the key to FT.TAPE.PARAMS.
Details:
The update routine must process the downloaded tape or file. Usually these processes will create
FUNDS.TRANSFER transactions for the movements.
The tape record must be read from FT.IN.TAPE directory, using the TAPE.NAME. TAPE.SEQ.NR as a
key. Once processing is complete, the FT.TAPES application will delete the downloaded file. For
further details on the required processing see the Local Clearing User Guide.
Page 68 of 86
CREATE.CMD
A command and/or subroutine can be entered, which when executed creates a tape or file. Typically
this would be used to create a clearing tape or file.
Command
Format:
Arguments:
None
Details:
Any executable command in jBase may be specified.
Example:
An example of a create command using cpio for production of a tape from the file BACS.OUT.FILE.
CREATE.ROUTINE
A routine may be specified which is used to create or manipulate an extract file that can be
downloaded using the CREATE.COMMAND.
Format:
Subroutine Name
Subroutine contains the name of the subroutine to be executed. It must be defined
on PGM.FILE as a type S program
Invoked:
Arguments:
TAPE.SEQ.NR, TAPE.NAME.
Where TAPE.SEQ.NR is the sequence number allocated by the FT.TAPES
application
TAPE.NAME is the key to the FT.TAPE.PARAMS record and identifies the type of
file being processed
Details:
The create routine will be used to create an output file for the clearing system/interface in use. The file
must be written to TAPE.NAME. TAPE.SEQ.NR within the directory FT.IN.TAPE.
Page 69 of 86
GENERATE.ROUTINE
A routine may be specified which is used to create an extract file that can be downloaded using the
CREATE.COMMAND.
Format:
Subroutine Name
Subroutine contains the name of the subroutine to be executed. It must be defined
on PGM.FILE as a type S program
Invoked:
Arguments:
Details:
The generate routine will create a file in the required format for the clearing system/interface in use.
The file must be written to TAPE.NAME. TAPE.SEQ.NR within the directory FT.IN.TAPE.
The CR.TOT, DR.TOT, NO.RECS and CHECKSUM should be calculated and returned where
available.
ENQ.PURGE.ROUTINE
Local clearing interfaces may update a file, which is used to for reporting the contents of the tape. A
routine to purge the file on a regular basis may be specified here.
Format:
Subroutine Name
Subroutine contains the name of the subroutine to be executed. It must be defined
on PGM.FILE as a type S program
Invoked:
Arguments:
PARAM.ID, R.FT.TAPE.PARAMS.
Where PARAM.ID is the key to the FT.TAPE.PARAMS record
R.FT.TAPE.PARAMS is the FT.TAPE.PARAMS record with the key PARAM.ID.
Page 70 of 86
Details:
The enquiry purge routine must determine whether the data is to be purged according to the
ENQUIRY.FILE.DAYS field in R.FT.TAPE.PARAMS.
Example:
AC.ENTRY.PARAM
The AC.ENTRY.PARAM application controls the Generic Accounting Interface. It contains booking
details of entries supplied in an external ASCII file, and the layout of the file. The standard routine
AC.INWARD.FILE should be used as the UPDATE routine in FT.TAPES to run the generic interface.
Page 71 of 86
DATA.VAL.RTN
A subroutine may be specified to validate / convert data extracted from the Ascii file. It may be either a
standard IN2 routine, or a user defined routine.
Format:
Subroutine name
Subroutine name contains the name of the user-defined subroutine to be invoked.
The routine must exist in the VOC file.
Invoked:
From AC.INWARD.FILE
Arguments:
None
Details:
The value extracted from the tape is supplied in the variable COMI and may be modified if required.
An error in the format of the value extracted should be returned in the variable ETEXT.
VALIDATION.RTN
A subroutine may be specified to validate the contents of the final extracted entry record, in order to
either reject the entry, or suspense the account number
Format:
Subroutine name
Subroutine name contains the name of the user-defined subroutine to be invoked.
The routine must exist in the VOC file.
Invoked:
From AC.INWARD.FILE
Arguments:
Details:
This routine should be used where the entry requires specific validation based on the contents of the
record. Using the ENQ.FILE.LOC field in the application, extracted data can be mapped to any field in
AC.INWARD.ENTRY, which can then be checked in the routine written here. For example a
SORT.CODE extracted could be mapped to LOCAL.REF value 2, which can then be validated in a
user routine specified at this point.
Page 72 of 86
BANK.RETURN.PARAMS
This application allows definition of subroutines to be called from the above mentioned applications at
input time to allow defaulting and validation of local reference items. The record applicable to the
company is defined in LOCAL.PROCESS in the COMPANY record.
INIT.ROUTINE
A routine may be called to initialise local variable required for the processing for the associated
APPLICATION.
Format:
Subroutine Name
Subroutine contains the name of the subroutine to be executed. It must be defined
on PGM.FILE as a type S program
Invoked:
Arguments:
None
Details:
This routine should be used to initialise variables specific to the application when the application is first
used.
The application in question can be determined from the common variable APPLICATION.
CHECK.INPUT.ROUTINE
A routine can be called at input time to validate and default local reference items for the associated
APPLICATION.
Format:
Subroutine Name
Subroutine contains the name of the subroutine to be executed. It must be defined
on PGM.FILE as a type S program
Page 73 of 86
Invoked:
Arguments:
None
Details:
The routine may use any of the system common variables available. The current contract record is
held in R.NEW. The BANK.RETURN.PARAMS record is held in common in the variable
R.BANK.RETURN.PARAMS
The fields LOCAL.REF.DESC and LOCAL.REF.POSN may be defined for each application, and allow
the correct value within the LOCAL.REF field to be identified for validation purposes.
ALT.ACCT.PARAMETER
The application ALT.ACCT.PARAMETER allows definition of the details of the account number
structure in the existing system. The old account number is stored in a cross-reference table linking it
to the new T24 account number, called ALTERNATE.ACCOUNT.
CHECKDIGIT.TYPE
The existing account number check-digit options for a T24 account are supported, but where these do
not match, a subroutine may be used to perform the validation and formatting of the alternate account
number.
Format:
@Subroutine Name
Subroutine contains the name of the subroutine to be executed. It must be defined
on PGM.FILE as a type S program
Invoked:
Arguments:
None.
Page 74 of 86
Details:
This routine should validate and format the account number; the basic type validation (i.e. alpha,
numeric) will have already been performed before the routine is called. Any account mask specified
with the routine will not be validated, and should be performed in the subroutine.
The alternate number entered is contained in COMI, and should be returned in this variable. Any error
message should be returned in ETEXT.
Example:
EBS.AUTO.FUNCTION
The system allows a subroutine to be inserted when building the input buffer when contents need to
be calculated, and when maintaining totals for the records processed.
Format:
@Subroutine Name
Subroutine contains the name of the subroutine to be executed.
Invoked:
From EBS.AUTO.FUNCTION
Arguments:
LAST.ID, INPUT$BUFFER
Where LAST.ID contains the id of record being processed
INPUT$BUFFER contains the current input buffer.
Page 75 of 86
Details:
Additional input should be added to INPUT$BUFFER, separated by spaces.
Example:
The following subroutine will cycle the interest review frequency on mortgage records to the next date.
TOTAL.FIELD
A subroutine can be used to maintain totals used for confirmation that the selection is correct.
Format:
@Subroutine Name
Subroutine contains the name of the subroutine to be executed. Must be defined on
PGM.FILE as TYPE S.
Invoked:
From EBS.AUTO.FUNCTION
Arguments:
REC.ID, RESULT
Where REC.ID contains the id of record being processed
RESULT contains the value to be added to the running total.
Page 76 of 86
Details:
The calculated/derived amount should be returned in RESULT. For example a routine may be written
to convert foreign amounts to local and return a local total.
TAKEOVER.MAPPING
Subroutines may be defined in TAKEOVER.MAPPING to format data into the expected T24 format
from the source files, and to manipulate data according to specific rules. For example a crossreference table may need to be maintained in order to build the correct link between T24 records.
DATA.SUBROUTINE
A subroutine may be called when data has been extracted from the source file. This is called prior to
the update of the T24 file.
Format:
Subroutine Name
Subroutine contains the name of the subroutine to be executed. Must be defined on
PGM.FILE as TYPE S.
Invoked:
Arguments:
None
Details:
The current record id is contained in ID.NEW and will be used to write the record. The id may be
manipulated at this point. R.NEW will contain the contents of the file mapped according to the
definitions in TAKEOVER.MAPPING. If data is to be manipulated, it should be mapped into a field in
the record, and the subroutine should perform the necessary changes.
UPDATE.SUBROUTINE
A subroutine may be invoked after extraction of data, just before the write to the unauthorised file is
executed.
Format:
Subroutine Name
Subroutine contains the name of the subroutine to be executed. Must be defined on
PGM.FILE as TYPE S.
Invoked:
Arguments:
None.
Page 77 of 86
Details:
The current record id is contained in ID.NEW and will be used to write the record. The id may be
manipulated at this point. R.NEW will contain the contents of the file mapped according to the
definitions in TAKEOVER.MAPPING. A routine called at this point may be used to update crossreference files used for take-over purposes.
Example:
The following example has been used to update DE.ADDRESS for SWIFT addresses. The incoming
key is a Customer number, which must be converted to a valid DE.ADDRESS key.
Page 78 of 86
Limits
Introduction
In order to allow complex calculations of risk factors to be applied to limit products or sub-products, the
LIMIT.REFERENCE application allows definition of a subroutine, which may be invoked. The
subroutine will return the amount of a given transaction to be recorded in the limits system.
LIMIT.REFERENCE
Format:
Subroutine Name
Subroutine contains the name of the subroutine to be executed. Must exist as a VOC
entry.
Invoked:
Arguments:
TRANSACTION.ARGUMENTS
Where TRANSACTION.ARGUMENTS contains a dynamic array of details. The
layout of this array is contained in the insert I_LIMIT.SROUTINE.
TRANSACTION.ARGUMENTS should be returned with the derived limit amount.
Details:
The following details are contained in TRANSACTION.ARGUMENTS.
<1> LIAB.ORIG
<2> CUST.NO
<3> REF.NO
<4> SER.NO
<5> TXN.REF
<6> COMPANY.MNE
<7> COMPANY.ID
<8> TXN.PERIOD
<9> TXN.DATE
Page 79 of 86
<10> TXN.CCY
<11> TXN.AMT
<12> OTH.CCY.OR.COMMITM
<13> DEAL.DESK
<14> ACC.CO
<15> ACC.NO
<16> ACC.BAL
<17> ACC.CCY
<18> CURR.NO
<19> FIND.REC
<20> CALL.TIME
<21> CALL.ID
Page 80 of 86
ONLINE
The contract is contained in the common element R.NEW. The last authorised version is in R.OLD, the
last unauthorised version is R.NEW.LAST.
END.OF.DAY
The contract should be read from the underlying application file. The application should be determined
from the TXN.REF and the transaction file opened. When opening the file, the company mnemonic
should be specified in the call to OPF to ensure the correct file is used.
Returning Information
The TRANSACTION.ARGUMENTS should contain the following.
<1> Amount 1
The amount derived to be used in updating limits. This must be the in the
currency passed in TXN.CCY, and must be returned with the same sign as the
passed TXN.AMT
<2> Amount 2
For FX deals only this should contain the equivalent percentage amount of the
other side of the deal, in the currency passed in OTH.CCY.OR.COMMITM.
Page 81 of 86
Page 82 of 86
Company Customisation
Introduction
In order to allow for different account number structures and check-digit calculations, the check-digit
type may be defined as a user routine, which will perform the desired formatting and check-digit
validation. This routine should also return the next available id if called from the ACCOUNT
application with F3 or F2 entered at awaiting id. The routine is specified in the COMPANY record.
Company
ACCT.CHECKDIG.TYPE
Format:
@Subroutine Name
Subroutine contains the name of the subroutine to be executed. Must exist as a VOC
entry.
Invoked:
Arguments:
None
Page 83 of 86
Details:
The following example formats an account number to the number of digits in the ACCOUNT.MASK in
the company record. There is no check-digit required.
Page 84 of 86
ACCOUNT.PARAMETER
The field ACCOUNTING.SUBRTN can be utilised to evoke an accounting API routine.
If this field has been populated when a T24 transaction gets committed the routine depending on
some conditions and based on certain mapping rules would then pick up values from the transaction
and would write them to a T24 work file.
Page 85 of 86
1.
2.
NB when a forward contract is reversed before the value date the FWD.STMT entries will be reversed,
with no "real" accounting having taken place, the TYPE used here is REV.AUT. Often the forward
entries will be replaced by "real" entries as the contract becomes active, for example when the
processing date is reached on a forward valued FUNDS.TRANSFER contract.
3.
4.
This is a locally developed routine that will be called during the accounting phase of any transaction
within T24 a PGM.FILE of a type S (subroutine) program needs to be created for the API program.
Page 86 of 86