0% found this document useful (0 votes)
343 views11 pages

Introduction To OFS

OFS is an interface that allows transaction requests and queries to be processed by the T24 system. It provides a single entry point and supports transactions, enquiries, clearing, and XML report requests. OFS uses a comma-delimited message syntax consisting of operation, options, user information, ID information, and data. It offers features like audit trails, API hooks, multi-company and language support. Transactions and enquiries can be submitted, and responses returned, using the OFS interface.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
343 views11 pages

Introduction To OFS

OFS is an interface that allows transaction requests and queries to be processed by the T24 system. It provides a single entry point and supports transactions, enquiries, clearing, and XML report requests. OFS uses a comma-delimited message syntax consisting of operation, options, user information, ID information, and data. It offers features like audit trails, API hooks, multi-company and language support. Transactions and enquiries can be submitted, and responses returned, using the OFS interface.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 11

Introduction

OFS(Open Financial Service) is an interface that allows transaction and queries requests to be processed
by T24.

OFS is the single point of entry to T24(Gateway).Every single interaction with T24 is driven through OFS.

OFS offers the following distinct request types:

-Transactions

-Enquiries

-Clearing

-XML report requests

And offers the following features:

Audit trail of messages(optional)

API hooks for pre and post processing

Fully multi company/multi book aware

Full support of hierarchical data(multi values, sub values)

Full multi- lingual support

Configuration

Before OFS can be used, some simple configuration of OFS.SOURCE is required.

REQUEST SYNTAX

OFS uses a comma delimited message syntax.

OPERATION, OPTIONS, USER INFORMATION, ID INFORMATION,DATA

OPERATION

Indicates the operation to perform:

ENQUIRY.SELECT-runs an enquiry

CLEARING-invokes clearing(OFS.CLEARING.MANAGER)

XML.REPORT- runs an XML report

T24 application -transaction request


USER INFORMATION

Contains the details of the T24 user that will execute the transaction passed to T24.

USER.NAME/PASSWORD/COMPANY

Company is optional. The information is delimited by the / character

Ie TEST.USER/654321/GB0010001 or TEST.USER/654321

When no company is specified, the default company for the user will be used.

Replace option

Is a special option that will allow records to cleared and re-input.

OPTIONS, ID INFORMATION and DATA---they are specific to the type of request

Transactions

Example

Operation(Blue)—any T24 application is permitted

Options(Red)---The option sector is delimited by / character

VERSION/FUNCTION/PROCESSING FLAG

Where no Function is specified , it defaults to I.

Where no processing flag is specified, it defaults to PROCESS-which indicates that the message is to be
commited to the database.

VALIDATE indicates the all normal processing takes place without actually updating the database.

Examples
NB V function should be avoided as may cause long running processes to be invoked.

ID Information(Yellow)

Specifies the transaction to be used, and must be a valid key to the application being invoked. If this is
left blank it can e automatically allocated for new transactions by those application supporting this
future.

TRANSACTION.ID/MESSAGE.ID

TRANSACTION.ID

Data(Black)

Fieldname:MultiValueNumber:SubValueNumber=Content

Contains the data required to create/update the transaction, this is repeated for as many data items as
required, each item being separated by ‘,’

Content defines the data to be set to the specified field and will be validated as per the standard
application.

FieldName must be defined in the STANDARD.SELECTION record for the application.

If ‘NULL’ is specified as the field data,OFS will blank the field of all data.

To remove multi-value or sub value field a minus sign(-) should be entered into the field data. Only the
first field needs be specified as a minus to remove a sub or a multi value set.

NOTE

If a ‘,’ is required withing the field content then it should be replaced by the ‘?’ character.

Using VERSION to control application requests

Each transaction to be updated using OFS can be configured using the standard VERSION utility.

This can be used to define default values, and can be customized with user-defined sub-routines
The version will also control the handling of error messages and override conditions.

The following options are available:

Reject message on error

Place new transaction in HLD status/override condition

Automatically approve override conditions encountered

Automatically place all transactions on hold.

The VERSION field controlling this options is GTS.CONTROL

NAU Processing

There is a facility on VERSION to specify optional functionality for the processing of transactions via OFS
where $NAU record exist.

The field NAU.PROCESSING in VERSION can be set according to the type of NAU processing required.

0 Reject messages
1 Overlay message
2 Accept Reversal Deletion
3 Accept both option 1 and option 2 to this version

Non Standard Applications

Foreign Exchange Swaps-Require that information is provided for both legs of a swap within a single
message. First leg and second leg information will be separated by ‘-‘ character.

Loans and Deposit Contracts with payment schedules-Requires information for the linked application
LD.SCHEDULE.DEFINE.Field information for LD.SCHEDULE.DEFINE will be added to the message data and
separated by ‘//’ characters.The GTS.CONTROL field on both versions must be set to 1,overrides and
accepted and errors placed on hold.

Enquiries

Operation(Blue)

To run an ENQUIRY,the operation must be set to ENQUIRY.SELECT

OPTIONS(Red)

There are no options for enquiries

ID information
The ID to the enquiry to run.Mandatory.

Data(Black)

SELECTION.FIELD:OPERAND=CRITERIA

SELECTION FIELD -Name of the field to select and must be defined in STANDARD.SELECTION

OPERAND-must be specified with a SELECTION.FLDS. may be EQ, NE, GE, GT, LE, LT,
UL, LK, and NR.

CRITERIA -data value for the SELECTION.FLDS and requested operand for the selection.

CLEARING

Operation(Blue)

To process a query request, the operation must be set to CLEARING.

Options(Red)

A company code may be specified and is used as the company that the entries are raised in.

ID Information(Yellow)-AC.ENTRY.PARAM.ID

The ID to the AC.ENTRY.PARAM that is used to define the layout of the data section.

Data(Black)

Each entry is separated by a ‘–‘

Configuration

The layout of the data section of OFS Clearing is controlled using AC.ENTRY.PARAM

XML reports

Operation (Blue)

To run an xml report, the operation must be set to XML.REPORT

Options(Red)

Either XML or ID.


ID returns the HOLD.CONTROL key that was produced when the report was run such that the xml can
be extracted asynchronously.

XML will return the xml result

ID Information(Yellow) REPORT.CONTROLID

The key of the ENQURY.REPORT to run.

Data(Black)

Not required.It is possible to verify ENQUIRY records and have the &HOLD& ID or the entire XML
message brought back in the return message.

The application title has changed from ENQUIRY.REPORT to XML.REPORT, the OFS module will translate the
XML.REPORT script and apply it to the application ENQUIRY.REPORT.

Configuration
XML reports are configured via ENQUIRY.REPORT, where the OUTPUT.FORMAT should be set to XML
and the corresponding REPORT.CONTROL record has the FORM.NAME set to HOLD.

TEC OFS Interface

Operation(Blue)

To invoke the TEC OFS interface, the operation must be set to TEC.OFS.INTERFACE

Options(Red)

Not applicable

ID Information(Yellow)

Not applicable

Data(Black)

The data passed is ‘,’ delimited and composed of:

ITEM.ID,MY.KEY,MY.DETAIL,MY.VALUE

ITEM.ID—key to TEC.ITEMS

MY.KEY –The key of the data passed


MY.DETAIL – Detail of the item
MY.VALUE ---Any value (size, time, etc.) associated with the item. Optional
RESPONSE Syntax

OFS uses a comma delimited response syntax.

Transactions format

Transaction ID

This will either contain the id supplied initially, or if no id was supplied the next available id(if generated)

Message ID

Contains the OFS message reference of the processed message.

Success Indicator

1 Successful transaction

-1 Error encountered

-2 Override condition encountered

-3 System offline

Response Data

A successfully processed update:

Transaction encountering errors:

ENQUIRIES

DATA FORMAT returned:


Header Caption Details

Identifier1=Text1/Identifier2=Text2

Identifier-contains an identifier to determine which element of the header/caption is being defined.

Text-Contains the text for the corresponding identifier

Repeating series delimited by a ‘/’.

Column Details

Identifier-Contains the column identifier, which can be name or number

Format type-Contains the type of data contained in the column ie DATE,AMOUNT

Label-Indicates the name of the column used as the column header

Each series of column details is followed by a ‘/’

Response Data

The returned field are separated by the tab(ASCII 9) character lines separated by ‘,’(comma)

Clearing

Clearing interface does not give a response for a successful transaction. In the case of an error, the
response contains the error message.

XML Reports

Report ID

ID of the report that was run


Message Reference

The OFS message reference, where applicable

Success Indicator
1 indicates the request was processed successfully.

-1 indicates that an error was encountered, in which case the Response Data holds the error message

Response Data

Contains either the key to the &HOLD& table eg 123455676778667,where the contents of the report was
stored ,or the actual XML response itself.

TEC OFS Interface

Success Indicator

1 indicates the request was processed successfully.

-1 indicates that an error was encountered, in which case the Response Data holds the error message

Response Data

Confirms the data that was sent in the request

Other Features

Multi-company processing-OFS will allow transactions to be processed in any company that the user has access.

Message Logging-A logging facility is provided for all messages for a particular service. Details are stored in the
OFS.REQUEST.DETAIL

API Hooks -User routines can be incorporated at the following points:

-Communication start and end

-Individual message receipts and returns

-Individual message pre and post process

Security and OFS

-A valid Sign on name and password must be supplied by the source application before the online server can
accept the message.
It is possible to block applications from being used with OFS by any user. This is done by adding NOFS to
ADDITIONAL.INFO field on the PGM.FILE for the application to be blocked.

Wrapping Messages with Tags

Using OFS from API Code

Do not use OFS.GLOBUS.MANAGER, OFS.REQUEST.MANAGER or OFS.PROCESSOR.MANAGER directly. These


routines are internal routines and do not form part of the T24 public API. Instead, the routine OFS.POST.MESSAGE
should be used.

A TSA service has been created to process OFS messages from outside transaction.

TSA Service Definition

To start OFS.MESAGE.SERVICE set SERVICE.CONTROL=AUTO in TSA.SERVICE

You might also like