You will learn about OFS Response messages in this session

OFS4.OFS Response-R15 1
 At the end of this session you should be able to

1. Describe the response to OFS Transaction & Enquiry requests

OFS4.OFS Response-R15 2
 This is the- by now familiar – response to input an account .

39087//1,CUSTOMER=100724:1:1,CATEGORY=1001:1:1,ACCOUNT.TITLE.1=AAA
SHIPPING COMPANY OF PANAMA:1:1,SHORT.TITLE=AAA SHIPPING COMPANY
OF
PANAMA:1:1,POSITION.TYPE=TR:1:1,CURRENCY=USD:1:1,CURRENCY.MARKET
=1:1:1,ACCOUNT.OFFICER=27:1:1,CONDITION.GROUP=2:1:1,PASSBOOK=NO:1:
1,OPEN.CATEGORY=1001:1:1,CHARGE.CCY=USD:1:1,CHARGE.MKT=1:1:1,INTE
REST.CCY=USD:1:1,INTEREST.MKT=1:1:1,ALT.ACCT.TYPE=LEGACY:1:1,ALLOW.
NETTING=NO:1:1,SINGLE.LIMIT=Y:1:1,RECORD.STATUS=INAU:1:1,CURR.NO=1:1
:1,INPUTTER=2_OFSUSER1___OFS_TEST.BATCH:1:1,DATE.TIME=0811012041:1:
1,CO.CODE=GB0010001:1:1,DEPT.CODE=1:1:1

It seems to be composed of essentially two sections;

One which contains the id of the record(account) that was created and two some
information about the account itself.

OFS4.OFS Response-R15 3
 We can describe the syntax as above. You will now see each of the parts of the
response in detail.

OFS4.OFS Response-R15 4
 TRANSACTION ID
The transaction ID contains either the value supplied for the transaction in the
request or the value that is automatically generated by the T24 application
(when no such value had been supplied in the request).
MESSAGE ID
The Message ID contains the value of the Message ID if it had been supplied
in the request.

OFS4.OFS Response-R15 5
 SUCCESS / FAILURE INDICATOR
This part of the message indicates the status of the transaction request
processed. OFS returns one of the following values:
1 Successful transaction.
-1 Errors encountered during processing.
-2 Override condition (s) encountered during processing.
-3 T24 server is offline

OFS4.OFS Response-R15 6
 RETURNED MESSAGE DATA
A successfully processed message will contain all the fields populated in the
transaction.
Field and value pairs are separated by commas.
The format is the same as that of the request message data.
However for a unsuccessful transaction, the returned message data has a
slightly different format.

OFS4.OFS Response-R15 7
 The structure for the Returned Message Data portion of an OFS transaction response
is similar to that of the request.
The response varies depending on whether the MV and SV are supplied or not. If the
values are supplied, then the response is in the format Field Name : Multi value : Sub
value = Field Content. If the Multi value and Sub value parameters are not supplied,
then its is defaulted to 1 and appears in the GTS format as Field Name=Field value :
Multi Value: Sub Value. It is recommended that we supply the MV and SV in the
request.

Each field in this is further subdivided in to 4 different parts.

The four different parts of a Field part of the RETURNED MESSAGE DATA are:
Field Name –The field name is as in the STANDARD.SELECTION record of
the application.
Multi value number –the multi value field number is returned.
Sub value number –the sub value field number is returned.
Field content – the contents of the field

Note that unlike in a request the multi-value and sub-value positions appear next to the
values and not next to the field name.

OFS4.OFS Response-R15 8
 We shall now see various examples of OFS Transaction type requests & responses.

The example here shows a FUNDS.TRANSFER transaction – input request and it’s
response.

In this example a function and a VERSION for FUNDS.TRANSFER application are

NOT supplied. While an input function (I) will be assumed by OFS, a comma (,)
VERSION will NOT be used. An ID for the FUNDS.TRANSAFER transaction is has
been supplied in the message either, allowing id auto generation to take place

The transaction ID automatically generated by the FUNDS.TRANSFER application, is

shown in the reply. The record is only in unauthorized state (RECORD.STATUS is
INAU), implying that a comma or a zero authorizer version was not automatically used
by OFS as default.

OFS4.OFS Response-R15 9
 The example here shows a request to authorize an already input FUNDS.TRANSFER
transaction and its response.

In this example only the ID of the already input transaction, in unauthorized status, is
supplied. Also see that an authorize function A is supplied. There is also no Message
Data portion in the message.

Check the status field in the response. Yes, it is missing, since the record has become
live.

OFS4.OFS Response-R15 10
 The example here shows two things – The use of the Reverse function and the use of
the VALIDATE option.

In the example, where a reverse function (R) is supplied, notice that only the ID of an
authorised transaction is supplied in the request. There is no Message Data portion in
the message.

The VALIDATE is supplied in the Options portion, meaning that normal processing
takes place without actually updating the database.

Notice that the record status in the response shows RNAU.

OFS4.OFS Response-R15 11
 The response format is slightly different when there are errors. When a attempt to
store data in a field has failed, the error message is returned in place of field content

OFS4.OFS Response-R15 12
 A sample message is shown here. The currency of the debit account is CHF whereas
in the message it is given as AUD. This results in an error. The error message is
returned in place of the field value. “NO” in the response just indicates that the
transaction did not get through successfully.

OFS4.OFS Response-R15 13
 The response format is different if an error occurs in the operation, option , user
information or record id portion of the request. An error message alone is returned

OFS4.OFS Response-R15 14
 Here you see the transaction response when an incorrect operation, i.e. a wrong
application name is given.

OFS4.OFS Response-R15 15
 Here you see the transaction response when an incorrect option, i.e. a incorrect
process type is given.

OFS4.OFS Response-R15 16
 Here you see the transaction response when an incorrect option, i.e. a incorrect
process type is given.

OFS4.OFS Response-R15 17
OFS4.OFS Response-R15 18
 A sample enquiry request and response are shown above. The response is in three
parts if you observe carefully. First part is blank, which is the reason that the response
begins with a comma. The second part contains some labels (or descriptions), and the
third the actual data from the currency application.

OFS4.OFS Response-R15 19
 A portion of the enquiry CURRENCY-LIST is shown here. Let’s try to relate this to the
response. You can see that the second part of the response shows Field name and
Field Label pairs separated by a double colon (::) . Each pair is separated from
another by a forward slash (/)

OFS4.OFS Response-R15 20
 The diagram shows the syntax structure of an OFS Enquiry response. We will now see
each of these portions in detail

OFS4.OFS Response-R15 21
 This diagram shows the syntax structure of the Header portion of an OFS Enquiry type
response.
Each Header Caption Detail is further subdivided in to 2 different parts as shown in the
diagram.

Header Caption Identifier

This contains an identifier to determine which element of the header
or caption is being defined.
May be alphanumeric defined in the underlying ENQUIRY.

Header Text
The Header Text contains the text for the corresponding identifier.
Each repeating series of header definitions is separated by a forward
slash (/) character.

OFS4.OFS Response-R15 22
 Look at the sample enquiry and it’s response shown above. The highlighted portion
shows the header part of the response.

OFS4.OFS Response-R15 23
 Headers are shown when an enquiry field contains data meant to be displayed as a
header. Consider the field CUSTOMER.NAME in the CUSTOMER.POSITION enquiry.
This is treated as a header. Why? Though this has not been entered under the header
fields of the enquiry, but rather under the fields portion, the column position is fixed at
10,2 implying that it is to be printed only once.

OFS4.OFS Response-R15 24
 The diagram shows the syntax structure of the Column Details portion.
Column Identifier
This contains the FIELD.NAME value of the underlying ENQUIRY.

Column Format Type

This contains the type of data contained in the column. This information can be used
for formatting.
Possible types include:
DATE – Formatted using standard date formats.
AMOUNT – Formatted to an amount with decimal format

Column Label

This contains the field label as specified in the FIELD.LBL of the underlying ENQUIRY.
Column label defaults to the value of column identifier, in the absence of an entry in
FIELD.LBL.

Each series of column details is followed by a forward slash (/) character.

OFS4.OFS Response-R15 25
 Each row comprises of a number of columns as defined in the previous element of the
message data. For each column, the data value will be returned delimited by a <tab>
character. Each row is delimited by a comma (,)

OFS4.OFS Response-R15 26
OFS4.OFS Response-R15 27
OFS4.OFS Response-R15 28
OFS4.OFS Response-R15 29
 You should now be able to describe
1. OFS Transaction responses
2. OFS Enquiry responses

OFS4.OFS Response-R15 31