GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

Return to Main
Menu

CHAPTER 41

OPEN FINANCIAL SERVICE

Ref. OF April 2000 Release G10.2.02

GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

TABLE OF CONTENTS
41 OPEN FINANCIAL SERVICE...........................................................................41-1

41.1 Introduction .......................................................................................................................41-1

41.2 OFS Architecture ..............................................................................................................41-2

41.3 Definition of interface types..............................................................................................41-3

41.4 Online communication with OFS.....................................................................................41-3

41.4.1 Preparation for Online connection..................................................................................41-3
41.4.2 Online communication process.......................................................................................41-5
41.4.3 Monitoring Online Activity ............................................................................................41-5

41.5 Online request management .............................................................................................41-6

41.5.1 Using the <> tag syntax to wrap messages....................................................................41-6

41.6 Offline / Store and Forward Capability ..........................................................................41-6

41.6.1 Windows NT On-line processing ...................................................................................41-7

41.7 Batch communication with OFS. .....................................................................................41-8

41.8 Security and OFS.............................................................................................................41-10

41.9 Transaction definition and error handling options ......................................................41-11

41.10 Multi-company processing..............................................................................................41-1 1

41.11 Message Logging .............................................................................................................41-11

41.12 Customisation / API ........................................................................................................41-11

41.13 OFS MESSAGE SYNTAX .............................................................................................41-12

41.13.1 General Structure .....................................................................................................41-12
41.13.2 OPERATION...........................................................................................................41-12
41.13.3 OPTIONS ................................................................................................................41-13
41.13.4 USER INFORMATION ..........................................................................................41-13
41.13.5 TRANSACTION ID ................................................................................................41-15
41.13.6 MESSAGE DATA - applications ............................................................................41-15
41.13.7 MESSAGE DATA Enquiries................................................................................41-16
41.13.8 TRANSACTION ID returned...............................................................................41-17
41.13.9 MESSAGE DATA returned successful transaction..............................................41-17
41.13.10 MESSAGE DATA returned errors encountered...................................................41-17
41.13.11 MESSAGE DATA returned from successful Enquiry..........................................41-18
41.13.12 OFS message examples............................................................................................41-20
41.13.13 OFS Input and Output message examples ...............................................................41-21

41.14 GTS MESSAGE SYNTAX .............................................................................................41-22

41.14.1 GTS.MESSAGE examples ......................................................................................41-22

41.15 OFS SET UP EXAMPLE : .............................................................................................41-23

41.15.1 Using OFS in Batch Mode.......................................................................................41-23
41.15.1.1 Create the directories...........................................................................................41-23
41.15.1.2 Setup OFS.SOURCE ...........................................................................................41-24
41.15.1.3 Create the Phantom EB.PHANTOM record for BATCH Mode .........................41-26

Ref : OF April 2000 Release G10.2.02

GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

41.15.1.4 Test the EB.PHANTOM record ..........................................................................41-27

41.15.2 Using OFS in TELNET / Online mode....................................................................41-28

41.16 OFS Preparation for use with IBI..................................................................................41-29

41.16.1 Configuring OFS for Online Processing ..................................................................41-29
41.16.1.1 Step 1 - Pre-configuration procedures.................................................................41-29
41.16.1.2 Step 2 - Preparing OFS for Telnet Mode ............................................................41-29
41.16.1.3 Step 3 - Test the TELNET configuration ............................................................41-31

41.17 OFS message syntax example .........................................................................................41-32

41.17.1 General structure......................................................................................................41-32

41.18 Auto-shutdown and Auto-startup of EB.PHANTOMs ................................................41-33

Ref : OF April 2000 Release G10.2.02

GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

41 OPEN FINANCIAL SERVICE

41.1 Introduction

The Open Financial Service module (OFS) provides an interface to allow the update and
interrogation of GLOBUS applications. OFS provides a real time transaction and batch based
mechanism, which accepts messages in a specific format.

OFS complements the existing GLOBUS Transaction Server (GTS) module and will support
the existing field based GTS message syntax described in the GTS chapter of the user guide.

OFS provides the following functionality:

Allows online real-time updates of GLOBUS records using messages supplied in

specified OFS syntax.

Batch update of the GLOBUS database using files containing messages specified in either
GTS or OFS syntax

Allow interrogation of the GLOBUS database by returning information based on

ENQUIRY layouts in a specified layout.

Optional offline store and forward capability

Optional audit trail for each message processed

Customisation of message processing using user defined routines

Multi-company processing

Support for sub-values

Enhanced error message details

Ability to run on platforms other than UNIX (i.e. NT)

OFS may be used for a variety of external purposes, these include:

Home Banking applications

ATM processing

External dealing system feeds

Ref : OF April 2000 Release G10.2.02

41-1
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

41.2 OFS Architecture

OFS can be configured to run in several ways as outlined below.

External
Feed
OFS/GTS
batch file

OFS online
manager

OFS queue
manager

OFS Request
manager

OFS
Details OFS offline
queue

OFS enquiry Globus

manager Transaction

Figure 41-1OFS Architecture

The diagram illustrates the three main configurations available

Online link via a telnet connection

Store and forward via the offline queue
Batch updating via text files containing OFS/GTS type messages

Ref : OF April 2000 Release G10.2.02

41-2
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

41.3 Definition of interface types

Each type of external OFS data source is defined using the OFS.SOURCE application, which
defines the rules and processing details for that specific interface.

Details stored include:

Number of active processes allowed

Whether the link is open, or open only for enquiry processing
Routine to build the OFS syntax from incoming message
Routines to perform special processing at start up and shutdown
Routines to perform special processing for each request, before and after processing
Whether offline store and forward capability is allowed
Whether syntax is OFS or GTS compatible

41.4 Online communication with OFS

In order to communicate with OFS an external application must establish communication with
OFS. Communication takes place using a Telnet connection.

41.4.1 Preparation for Online connection

The connection will be established with the GLOBUS server supplying a pre-defined UNIX /
NT login. The LOGIN voc should be set up such that PTERM CASE NOINVERT is set and
that the routine EB.AUTO.INIT.PROCESS is launched before the EBS.LOGIN command.
See Figure 41-2 for an example.

!('92&/2*,1
OLQHVORQJ

3
3$
6(7375$735
'$7$<
37(50&$6(12,19(57
(%$872,1,7352&(66
',63/$<
',63/$<
',63/$<
',63/$<
%/2&.7(502)6%$1.
',63/$<
',63/$<
,)#77<(4
SKDQWRP
7+(1*2(;,7
,)67$57*/2%86<1!!(4
<
7+(1(%6/2*,1
,)67$57*/2%86<1!!(4
\
7+(1(%6/2*,1
(;,7
%RWWRPDWOLQH


Figure 41-2 Sample login VOC for use with online OFS Processing

Ref : OF April 2000 Release G10.2.02

41-3
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

In order to automatically start the process the LOGIN paragraph in the VOC file needs to
have the job EB.AUTO.INIT.PROCESS inserted as shown above:

When EB.AUTO.INIT.PROCESS is launched it looks for a record on the

EB.AUTO.PROCESS file with an id equal to the UNIX login id of the user logging in. If a
record exists then the OFS online application will be invoked.

The EB.AUTO.PROCESS record is updated from OFS.SOURCE - when a telnet

OFS.SOURCE record is created, an EB.AUTO.PROCESS record is created with an id
generated from the LOGIN.ID field from the OFS.SOURCE record.

Ref : OF April 2000 Release G10.2.02

41-4
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

41.4.2 Online communication process

Once the connection is established the OFS.ONLINE.MANAGER will be started

automatically. OFS.ONLINE.MANAGER performs the following functions:

Receive messages from the external application

Pass the message to the OFS.REQUEST.MANAGER to perform the required processing
Pass the message returned to the external application.

A maximum number of open OFS connections for a particular source can be specified. Each
OFS connection will continue to be active until either shutdown from GLOBUS or by the
external application. The connection can remain active during the offline mode to allow
enquiry functions to take place.

41.4.3 Monitoring Online Activity

Each online connection will use its own EB.PHANTOM record. If no free EB.PHANTOM
records exist, one will be created. As each request is received the EB.PHANTOM record keeps
a record of transaction count and status. It is therefore possible to monitor each OFS
connection by enquiry on the EB.PHANTOM records.

Figure 41-3 EP.MONITOR phantom enquiry

Ref : OF April 2000 Release G10.2.02

41-5
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

41.5 Online request management

Each online request to OFS must be supplied as a message in the specified OFS format. The
details to be supplied include:

GLOBUS user name , password, company

Application and version to be invoked
Function and transaction key
Input data to application

The OFS.REQUEST.MANAGER will attempt to process the request and return the required
data including:

Transaction key if not supplied

Updated message
Success / Fail flag
Details of error messages
Details of enquiry request

41.5.1 Using the <> tag syntax to wrap messages

Where OFS is used as an interface to an external source, for example in conjunction with the
Internet Banking Interface, it may be necessary to wrap messages to ensure consistent
delivery of data - to inform OFS of where the start and end points of a message are. This may
be done by adding to the start of a message a tag packaged between < > signs and repeating
the tag packaged between </ >. The / sign indicates the end of the message.

Example:

<MSG1>ABBREVIATION,INPUTT/******,SEC,ORIGINAL.TEXT=SECTOR</MSG1>

will enter an ABBREVIATION record, using the SMS settings of the user which signs on as
INPUTT with password ******, to edit/create the record with an ID of SEC, and
ORIGINAL.TEXT of SECTOR.

In the example above the confirmation message returned will also be prefixed with <MSG1>
and suffixed with </MSG1>.

41.6 Offline / Store and Forward Capability

If the OFS.ONLINE.MANAGER is invoked from an external application and GLOBUS is off-

line at the time, an option in the OFS.SOURCE will determine if processing is allowed.

If processing is allowed the system will return details from Enquiry requests. For application
update requests the system will allow messages to be added to a store and forward queue. In
this situation the message will be recorded as passed to the OFS.ONLINE.MANAGER, a
success / failure indicator will show that the message has been queued.

Ref : OF April 2000 Release G10.2.02

41-6
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

A background process, the OFS.QUEUE.MANAGER will be initiated when the system returns
to its online state and will submit each queued message back to the
OFS.REQUEST.MANAGER, results are written to an outward queue.

41.6.1 Windows NT On-line processing

When creating OFS.SOURCE records for Telnet (On-Line) processing it should be noted that
the LOGIN.ID should be preceded by the domain name of the NT machine. Therefore, on
UNIX you may use a Login id of user189 whereas on Windows NT this would appear like
TEMUKNT3X\user189.

Ref : OF April 2000 Release G10.2.02

41-7
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

41.7 Batch communication with OFS.

Batch and offline processing is performed by OFS.QUEUE.MANAGER running as a

phantom. The mode of operation is determined by the relevant OFS.SOURCE record
configuration. Processing is repeated at pre determined intervals defined in the relevant
EB.PHANTOM record.

Figure 41-4 Definition of OFS.SOURCE batch processing record

Ref : OF April 2000 Release G10.2.02

41-8
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

The phantom is started via EB.PHANTOM.

Figure 41-5 Setting up EB.PHANTOM to run OFS in batch mode

When running in batch mode a predetermined input directory defined in IN.QUEUE.FILE is

selected for batch input files, which will contain either OFS or GTS messages.

If IN.FILE.NAME is defined then only that file will be processed from the input directory.

Ref : OF April 2000 Release G10.2.02

41-9
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

Each input file is processed as follows:

Individual messages are extracted

A pre processor routine is called if required
The message is passed to OFS.REQUEST.MANAGER to update GLOBUS
A post update routine is called if required
The output file is updated as follows
the returned message for OFS format
the input message appended with a return code for GTS format
When all messages have been processed the output file is written to the output directory
defined in OFS.SOURCE

When running in offline mode the following processing takes place.

OFS.OFFLINE.QUEUE is selected for the relevant OFS.SOURCE.

Each record contains the identity of an OFS.REQUEST.DETAIL record, which is read and
the OFS message is extracted.
The message is processed as above.
The OFS.OFFLINE.QUEUE record is deleted and the OFS.REQUEST.DETAIL is
updated with the returned message.

41.8 Security and OFS

In order to execute an OFS transaction a sign on name and password must be supplied by the
source application. This will be validated before processing any online request.

Batch and offline processing will be controlled via the user defined in the GTS.USER.ID of
the EB.PHANTOM record used to initiate the OFS.QUEUE.MANAGER phantom. Note when
defining the USER record to be used for GTS.USER.ID that the user must have access to
application EB.PHANTOM.PH, - this is necessary for the user to be able to use OFS
TELNET.

N.B. a valid sign on and password must be supplied before the online server can accept a
message.

Once validated all access to data is controlled using the standard SMS definitions specified in
the user profile.

Ref : OF April 2000 Release G10.2.02

41-10
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

41.9 Transaction definition and error handling options

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 customised 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 transactions in HLD status on error/override condition
Automatically approve override conditions encountered.
Automatically place all transactions on hold.

41.10 Multi-company processing

OFS will allow transactions to be processed in any company that the user has access. The
company for the transaction can be specified as part of the message syntax.

41.11 Message Logging

A logging facility will be provided for all messages for a particular service. This can log all
traffic, exception messages, communication start and end or no messages.

Full history of each message can be recorded if required. The details are stored in the
OFS.REQUEST.DETAIL file if message audit is required. If message auditing is required full
details of the message and subsequent processing statuses will be recorded.

41.12 Customisation / API

Processing can be customised to suit specific requirements by the use of API at various points
within the processing path. User routines can be incorporated at the following points:

Communication Start and End

This will allow specific operations to take place at the start and end of the
communication process.

Individual message receipts and returns

This will allow manipulation of the message immediately after receipt and
immediately after return to/from the calling application.

Individual message pre and post process

This allows the message to be manipulated prior to and on return from processing from
within the OFS.REQUEST.MANAGER.

Ref : OF April 2000 Release G10.2.02

41-11
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

41.13 OFS MESSAGE SYNTAX

41.13.1 General Structure

The input/output OFS message is divided into the following components:

Operation Options User Transaction Message

, , Information , ID , Data

Figure 41-6 OFS message structure

Where:

OPERATION
Contains the GLOBUS application to be executed

OPTIONS
Contains the Version of the application, the Function to be performed and an operation flag.

USER INFORMATION
Contains the details of the GLOBUS user that will execute the transaction passed to
GLOBUS, including sign on name, password and company code.

TRANSACTION ID
Contains the transaction number for the application to be executed this can be automatically
allocated for new transactions the transaction id is left blank, and the Message Id.

MESSAGE DATA
Contains the data required to create/update the transaction, this is repeated for as many data
items as required, each item being separated by a ,.

41.13.2 OPERATION

The operation simply contains the GLOBUS application to be executed, e.g.

FUNDS.TRANSFER. In order to interrogate the GLOBUS Database the Operation should be
ENQUIRY.SELECT.

The Operation will be validated and will follow standard SMS validation based on the User
Information supplied.

Ref : OF April 2000 Release G10.2.02

41-12
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

41.13.3 OPTIONS

Version Function Operation

Name / /

Figure 41-7 Option format

The options supplied determine the version and function to be executed and are supplied in
the following format:

Version Name
This defines the name of the version of the application specified in OPERATION to be used
when executing the request.

For ENQUIRY.SELECT operation nothing must be specified, mandatory for all other
applications.

Function
The function to be used when executing the request currently only the Input function is
supported if not supplied function I will be assumed.

Operation
Can be either PROCESS or VALIDATE.

PROCESS indicates that the message is to be committed to the database.

VALIDATE indicates the all normal processing takes place without actually updating the
database, an example would be to return all default fields.

41.13.4 USER INFORMATION

User Information can be supplied in the following format:

User Sign User Company

On Name / Password / Code

Figure 41-8 User information format

User Sign On Name

The sign on name of a valid GLOBUS USER used to perform the request. This must be
supplied with each online request.

User Password

Ref : OF April 2000 Release G10.2.02

41-13
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

The password for the USER sign on name supplied. This must be supplied with each online
request.

Ref : OF April 2000 Release G10.2.02

41-14
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

Company Code
In a multi-company environment the company to enter the transaction in can be specified
this will validated against the USER profile. If not supplied the first company specified in the
USER profile will be assumed.

41.13.5 TRANSACTION ID

The transaction id and Message Id are supplied as follows:

Transaction Message
Id / Id

Figure 41-9 Transaction ID format

Transaction Id
This is passed with the transaction key to be updated, or if not specified and the GLOBUS
application allows it, a new id will be allocated.

Mandatory for Operations of ENQUIRY.SELECT, used to specify the name of the enquiry to
be executed.

Message Id
The Id of the message being currently processed can be passed in.

41.13.6 MESSAGE DATA - applications

The data required to update an application is supplied as follows:

Field Name Multi Value Sub Value Field

: Number : Number = Content

Figure 41-10 Update message format

Field Name
The field name must be defined in the STANDARD.SELECTION record for the application.
At least one field must be specified.

Multi Value Number

For multi-value fields a specific multi value number can be specified, if not specified the first
value is assumed.

Sub Value Number

Ref : OF April 2000 Release G10.2.02

41-15
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

For sub-valued fields a specific sub-value number within the multi-value can be specified, if
not defined the first sub-value is assumed.

Field Content
The content to be added to the specified field. The value supplied will be validated as per the
standard application.

Each MESSAGE.DATA specification should be separated by a ,.

N.B.
If a , (comma) character is required within the field content then it should be replaced by the
? (Question mark) character.

Foreign Exchange Swaps.

Foreign exchange swaps require that information is provided for both legs of a swap within a
single message, in this case information for the first leg is separated from information for the
second leg by a - (underscore) character. This applies to the multi value number, sub value
number, and field data parts of the message.

41.13.7 MESSAGE DATA Enquiries

The data required to initiate an Enquiry has a different layout to the standard application and
is defined as follows:
Selection Operand Field Value
Field : =

Figure 41-11 Enquiry request message format

Selection Field
The name of the field to select which must be either a valid SELECTION.FLDS for the Enquiry
or defined in the STANDARD.SELECTION record for the FILE.NAME of the Enquiry.

Operand
The operand for the selection, must be specified with a SELECTION.FLDS, may be EQ, NE,
GE, GT, LE, LT, UL, LK, NR.

Field Value
The data value for the SELECTION.FLDS and requested operand for the selection.

Each Message Data specification should be separated by a ,.

Ref : OF April 2000 Release G10.2.02

41-16
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

41.13.8 TRANSACTION ID returned

The Transaction id for applications is returned in the following format:

Transaction Message Success /

Id / Id / Fail

Figure 41-12 Transaction ID format

Transaction Id
This will either contain the id supplied initially, or if no id was supplied the next available id
(if generated) will be returned.

Message Id
This will contain the message Id of the processed message.

Success / Fail indicator

This flag will indicate the success or failure of the request for both application and enquiry
transactions. The following values can be returned:
1 Successful transaction
-1 Error encountered
-2 Override condition encountered
-3 System offline

41.13.9 MESSAGE DATA returned successful transaction

A successfully processed update will return the fully populated record in the same format as
the data passed to OFS.

41.13.10 MESSAGE DATA returned errors encountered

A transaction encountering errors when processed will return errors in the Message Data field
in the following format:

Field Name Multi Value Sub Value Error

: Number : Number = Message

Figure 41-13 Error message format

Field Name
The name of the field in error is returned, the name will be found in the Standard Selection
record for the application.

Ref : OF April 2000 Release G10.2.02

41-17
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

Multi Value Number

If an error occurs in a multi valued field the value number will be returned here, no value will
be returned for single value fields.

Sub Value Number

If an error occurs in a sub valued field the sub value number will be returned.

Error Message
The error message generated for the associated Field name, Multi Value, sub value will be
returned here. The message will be returned with variable elements expanded.

41.13.11 MESSAGE DATA returned from successful Enquiry

The data returned from enquiry will be in the following format, in three sections:

Header Column Returned

Caption , Details , Data
Details

Figure 41-14 Format of returned ENQUIRY data

Header / Header
caption = Text / ,
identifier

Figure 41-15 Header / caption details for display

Header / Caption Identifier

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

Header Text
Contains the text for the corresponding identifier.

Each repeating series of header definitions is delimited by a /.

Column Column Column

identifier : Format type : Label / ,

Figure 41-16 Column definitions for the returned data

Ref : OF April 2000 Release G10.2.02

41-18
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

Column Identifier
Contains the column identifier, which can be a name or a number. Each column to return
information must be defined in the underlying ENQUIRY.

Column Format Type

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
Indicates the name of the column used as the column header.

Each series of column details is followed by a /

Row
Tab ,
Value
column n

Figure 41-17 Row and column data in a repeating series

Row Value Column n
Each row will be comprised of a number of columns defined in the previous element of the
message data. For each column the value will be returned delimited by the <tab> character.
Each Row is delimited by a ,.

Ref : OF April 2000 Release G10.2.02

41-19
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

41.13.12 OFS message examples

SECTOR,OFS//PROCESS,PWEISS/123456,7719,DESCRIPTION::=OFS DESCRIPTION
DATA,SHORT.NAME::=OFS DATA

Operator
SECTOR,

Options
OFS//PROCESS,

N.B. input mode is assumed

User Info
PWEISS/123456,

N.B. user sign on company is assumed

Transaction ID
7719,

Field Data
DESCRIPTION::=OFS DESCRIPTION DATA,
SHORT.NAME::=OFS DATA

Field Name
DESCRIPTION
SHORT.NAME

Multi Value
: i.e. defaults to 1

Sub Value
: i.e. defaults to 1

Field Data
OFS DESCRIPTION DATA
SHORT.NAME

Ref : OF April 2000 Release G10.2.02

41-20
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

The following example relates to a foreign exchange swap transaction where information is
required for both legs of the swap, in this case the _ (underscore) character is used to delimit
information for record 1 from record 2.

FOREX,GTS//PROCESS,GTUSER/QWERTY,,DEAL.TYPE=SW,COUNTERPARTY::=10
0076,CURRENCY.BOUGHT::=USD,AMOUNT.BOUGHT::=500000,CURRENCY.SOLD::
=GBP,SPOT.RATE::=1.6,DEAL.DATE::=20011026,VALUE.DATE.BUY::=20011028_1M,
FORWARD.RATE::=_1.55,REVALUATION.TYPE:_1:=_IN,NOTES:1_1="first
leg"_"second leg",NOTES:_2:_"second-line"

VALUE.DATE.BUY::=20011028_1M,
N.B. the underscore separates the spot date for leg 1 from the forward date for leg 2.

FORWARD.RATE::=_1.55,
N.B. for the forward rate information is only required for the second leg, so the first leg
information is left blank.

NOTES:1_1="first leg"_"second leg",NOTES:_2:_"second-line"

N.B. the above example will populate the first multi value field of NOTES for both legs,
leave the first leg second multi value blank and populate the second multi value of the second
leg.

41.13.13 OFS Input and Output message examples

The following example shows input for two sector records in OFS format.

SECTOR,OF//PROCESS,OFSUSER/QWERTY,5011,DESCRIPTION=TESTreference,SHO
RT.NAME=Testref
SECTOR,OF//PROCESS,OFSUSER/QWERTY,5012,DESCRIPTION=TEST2
reference,SHORT.NAME=Test2 toooooooolooooooongref

The output for the two examples indicates that the second record has been put on hold due to
a validation error.

5011/OFS0129900088/1,DESCRIPTION=TESTreference:1:1,SHORT.NAME=Test
ref:1:1,RECORD.STATUS=INAU:1:1,CURR.NO=1:1:1,INPUTTER=-
29515_TEST1_OFSUSER:1:1,DATE.TIME=9903291339:1:1,CO.CODE=GB0010001:1:1,D
EPT.CODE=1:1:1
5012/OFS0129900089/-1,VALIDATION ERROR - ON HOLD

Ref : OF April 2000 Release G10.2.02

41-21
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

The following example shows an enquiry request followed by the returned data.

ENQUIRY.SELECT,,,ACCOUNT-LIST,CURRENCY:EQ=GBP,CUSTOMER:EQ=100053

,@ID::/CCY::/CUSTOMER::/CUST MNEMONIC::/WORK BALANCE::," 17148"

"GBP" " 100053" " DBL" " 10,000.00"," 17159" "GBP" "
100053" " DBL" " "

The returned fields are separated by the tab (ASCII 9) character with lines separated by ,
(comma).

41.14 GTS MESSAGE SYNTAX

GTS message syntax is described in the GLOBUS TRANSACTION SERVER chapter of the
user guide.

41.14.1 GTS.MESSAGE examples

Updates to two Sector records.

SECTOR,GT,I,5011,DESCRIPTION=TEST local reference,SHORT.NAME=Test Lref
SECTOR,GT,I,5012,DESCRIPTION=TEST2 local reference,SHORT.NAME=Test2 Lref
T

Forex Swap transaction

FOREX,GTS,I,,DEAL.TYPE=SW,COUNTERPARTY=100076,CURRENCY.BOUGHT=US
D,AMOUNT.BOUGHT=500000,CURRENCY.SOLD=GBP,SPOT.RATE=1.6,DEAL.DATE
=20011026,VALUE.DATE.BUY=20011028_1M,FORWARD.RATE=_1.55,REVALUATIO
N.TYPE=_IN,NOTES="first leg"_"second leg":1_1:_"second-line":_2
T

Ref : OF April 2000 Release G10.2.02

41-22
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

41.15 OFS SET UP EXAMPLE :

41.15.1 Using OFS in Batch Mode

41.15.1.1 Create the directories

OFS directories can be positioned where required assuming that access permissions are
correctly set up.

One possibility would be to create the OFS directories in the data area of a GLOBUS account
as follows (See the SYSTEM ADMINISTRATION GUIDE for more details).

If directories are created in the data area then they will be backed up when GLOBUS backups
take place.

Assume that the GLOBUS account is called bnk and that the operating system is UNIX.

Then directories could be created as follows, where the current directory is bnk.run

../bnk.data/ofsdata
../bnk.data/ofsdata/ofslog - the directory to contain log files
../bnk.data/ofsdata/ofsin - the directory to contain the input files in OFS/GTS format
../bnk.data/ofsdata/ofsout - the directory to contain the output files generated by OFS

If pre or post processing routines need to be run on batch files then additional directories may
need to be created.

Ref : OF April 2000 Release G10.2.02

41-23
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

41.15.1.2 Setup OFS.SOURCE

Once the directories are set up then an OFS.SOURCE record is updated as follows.

A record for Batch mode (initiated by EB.PHANTOM).

Figure 41-18 OFS.SOURCE sample OFS batch set up

Ref : OF April 2000 Release G10.2.02

41-24
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

Field Name Field Purpose Requirements for BATCH OFS

@ID Id Key of OFS.SOURCE ID allows alphanumeric characters. User

Record may define own appropriate name.

DESCRIPTION Simple Description Field Again, use appropriate description to

address purpose of OFS.SOURCE
record.
SOURCE.TYPE Defines whether you will be
For batch processing, select BATCH
using this OFS.SOURCE
record for BATCH or TELNET
processing
LOGIN.ID Specifies the UNIX or NT login For BATCH : Leave Blank.
that will automatically initiate
the communication with the
external source

EB.PHANT.ID Specifies the EB.PHANTOM For BATCH processing, select

record to be used for processing
batch jobs.
EB.PHANTOM record to be used.

MAX.CONNECTIONS Specifies the maximum number Number must be less than the maximum
of on-line OFS connections for number of users as defined in SPF.
the specified service which can
be active at any one time.

Defines the name of the

LOG.FILE.DIR Either refer to existing pre-defined
directory used to store the log
directory. Otherwise directory will be
files created when running OFS.
created at authorisation.
Specifies the type of OFS
LOG.DETAIL.LEVEL Can select as much or as little logging as
message logging to be
required - does not affect OFS processing.
performed by OFS
IN.QUEUE.DIR For batch processing, the OFS Batch Processing : Enter name of
directory where batches will be directory to be used for batch processing.
placed for processing

SYNTAX.TYPE Specifies the syntax type for For Batch processing, may be either GTS
messages to be received or OFS.

GENERIC.USER The Generic user is the Must be a valid user on the USER File.
GLOBUS user that will be used Must have authority to use
to access the GLOBUS server. EB.PHANTOM.PH
For external users determines
SMS options. Generic User
must have authority to use
EB.PHANTOM.PH i

IB.USER.CHECK Specifies whether transactions For Batch processing leave null..

supplied to GLOBUS using this
service requires the sign on

Ref : OF April 2000 Release G10.2.02

41-25
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

name and password to validated

for the external user.

Table 41-1 OFS.SOURCE Fields required for BATCH processing.

41.15.1.3 Create the Phantom EB.PHANTOM record for BATCH Mode

Field Name Field Purpose What to enter

@ID ID of EB.PHANTOM Recognisable name

DESCRIPTION Description Recognisable description

RUN.MODE Can either be INTERACTIVE (so Set to PHANTOM

user starts & stops each stage) or
PHANTOM (process runs
continuously in the background)

SLEEP.SECS The regularity with which the system The shorter the gap, the more resources are
checks whether there is anything in taken by the system in running the
the in directory phantom.

TIMEOUT.SECS If a process has difficulty reading At the discretion of the user. Too short a
from a specific file, such that it fails gap may result in unnecessary timeouts,
to read the file in the time set here, the too long a gap means delay before
process will stop, reporting a timeout reporting timeout.

GTS.USER.ID Defines the user that will appear in User definable, according to reporting
the audit information for the jobs requirements.
processed by that batch.

OFS.SOURCE The OFS.SOURCE record to be The id of the OFS.SOURCE record

used with this batch. previously created.

Table 41-2 EB.PHANTOM table for OFS BATCH records

An example of an EB.PHANTOM record is shown below :

Ref : OF April 2000 Release G10.2.02

41-26
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

Figure 41-19 Sample EB.PHANTOM record for OFS Batch Processes

To set the batch phantom running, the EB.PHANTOM record must be VERIFIED (select
phantom with function set to Verify and press F5)

41.15.1.4 Test the EB.PHANTOM record

Create a txt file with one or several valid OFS Messages. Two examples are shown below,
one for an enquiry and the other to create a new record.

ENQUIRY.SELECT,,<USER>/<PASSWORD>,ACCOUNT-
LIST,CUSTOMER.MNEMONIC:EQ=*
ABBREVIATION,,<USER>/<PASSWORD>,TEST1,ORIGINAL.TEXT=TEST OFS BATCH

Place the document into the ofsin directory you specified in the OFS.SOURCE record earlier.

If the document is processed and the output placed into the ofsout directory you specified in
the OFS.SOURCE above, then your OFS Batch set-up is correct. For the ABBREVIATION,
check the ABBREVIATION file to see if there is a record called TEST1.

To stop the phantom, recall the record and type in STOP in field 4, followed by F5 to
confirm.

Ref : OF April 2000 Release G10.2.02

41-27
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

41.15.2 Using OFS in TELNET / Online mode

For accessing via TELNET an Online record is needed. Note that the user will be logging in
via a remote session and the login voc will need to initiate the program
EB.AUTO.INIT.PROCESS as this will handle the interactive communication process.

Figure 41-20 OFS.SOURCE online sample set up

Ref : OF April 2000 Release G10.2.02

41-28
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

41.16 OFS Preparation for use with IBI

41.16.1 Configuring OFS for Online Processing

To install and configure OFS on the GLOBUS system, please follow the steps outlined below.

41.16.1.1 Step 1 - Pre-configuration procedures

Create a new NT or UNIX user account to be used with OFS. Consult your UNIX or NT
systems administrator for further assistance regarding this.
Ensure that the LOGIN record of the VOC file contains the correct syntax to launch the
routine EB.AUTO.INIT.PROCESS. See Figure 41-2 Sample login VOC for use with
online OFS Processing for an example of a LOGIN record which would facilitate this.

41.16.1.2 Step 2 - Preparing OFS for Telnet Mode

Create an OFS.SOURCE record for TELNET. For additional information, check the
individual help text for each field

Ref : OF April 2000 Release G10.2.02

41-29
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

Field Name Field Purpose Requirements for TELNET OFS

@ID Id Key of OFS.SOURCE ID allows alphanumeric characters. User

Record may define own appropriate name.

DESCRIPTION Simple Description Field Again, use appropriate description to

address purpose of OFS.SOURCE
record.
SOURCE.TYPE Defines whether you will be
For online processing, select TELNET.
using this OFS.SOURCE
record for BATCH or TELNET
processing
LOGIN.ID Specifies the UNIX or NT login For TELNET : UNIX servers, enter UNIX
that will automatically initiate id to be used. For NT Servers, enter
the communication with the DOMAINNAME/User ID, EG NT1/User1
external source

EB.PHANT.ID Specifies the EB.PHANTOM For TELNET, leave blank.

record to be used for processing
batch jobs.
MAX.CONNECTIONS Specifies the maximum number Number must be less than the maximum
of on-line OFS connections for number of users as defined in SPF.
the specified service, which can
be active at any one time.

Defines the name of the

LOG.FILE.DIR Either refer to existing pre-defined
directory used to store the log
directory. Otherwise directory will be
files created when running OFS.
created at authorisation.
Specifies the type of OFS
LOG.DETAIL.LEVEL Can select as much or as little logging as
message logging to be
required - does not affect OFS processing.
performed by OFS
IN.QUEUE.DIR For batch processing, the For TELNET - leave blank
directory where batches will be
placed for processing

SYNTAX.TYPE Specifies the syntax type for For OFS Online Processing requirements,
messages to be received this field must be set to OFS.

GENERIC.USER The Generic user is the Must be a valid user on the USER File.
GLOBUS user that will be used
to access the GLOBUS server

IB.USER.CHECK Specifies whether transactions If the OFS.SOURCE is to be used in

supplied to GLOBUS using this conjunction with IBI (i.e. from a web/html
service requires the sign on source) then this should be flagged Y.
name and password to validated Otherwise N or left NULL.
for the external user.

Table 41-3 OFS.SOURCE Fields required for ONLINE processing.

Ref : OF April 2000 Release G10.2.02

41-30
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

41.16.1.3 Step 3 - Test the TELNET configuration

Invoke a TELNET session with the GLOBUS server.

When prompted for your user name and password, use the NT or UNIX user you created
in Step 1
If you are using NT, you will also be prompted to enter the name of the GLOBUS account
being used.
If your set-up has been successful you will not be prompted to start GLOBUS. You will
instead be at a command line from which OFS Messages can be sent.
Press enter, if successful, you will be prompted with APPLICATION / OPERATION
MISSING
OFS is now set-up correctly
If you now type the following example OFS Message, you should get a reply,
ENQUIRY.SELECT,,< GLOBUS SIGNON NAME>/<PASSWORD<,ACCOUNT-LIST
The enquiry should now be processed and the answer displayed on your screen.

Ref : OF April 2000 Release G10.2.02

41-31
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

41.17 OFS message syntax example

41.17.1 General structure

The input/output OFS message is divided into the following components shown bellow.

Operation,Options,User Information, Transaction ID, Message data

NOTE: If left blank, certain components can be automatically allocated by the system, see
the example bellow

OFS message example (enquiry)

ENQUIRY.SELECT,,INPUTT/123456,ACCOUNT-LIST,CUSTOMER.MNEMONIC:EQ=ALEXCOURT

Operator Globus account to be executed

ENQUIRY.SELECT

Options: Version of the application

N/A

User information: Globus sign on name & password

INPUTT/123456

Transaction ID: The enquiry to be executed

ACCOUNT LIST

Message Data Enquiries: Data required to initiate an enquiry

Selection field: CUSTOMER

Operand: EQUAL TO
Field Value: ALEXCOURT

Ref : OF April 2000 Release G10.2.02

41-32
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

41.18 Auto-shutdown and Auto-startup of EB.PHANTOMs

EB.PHANTOM records can be set to automatically shut down at End-of-Day, and to

automatically restart the with Start On Line. This can be done through fields AUTO.SHUTDOWN
and AUTO.STARTUP on the EB.PHANTOM record. If AUTO.SHUTDOWN is set to Yes then at
Initiate End of Day the system looks for all EB.PHANTOM records with AUTO.SHUTDOWN set
to Y, and sets PHANT.STOP.REQ to STOP for those records. The converse occurs with
AUTO.STARTUP, where at Start Online the system looks for EB.PHANTOM records with
AUTO.STARTUP set to Y and activates them.

Figure 41-21 EB.PHANTOMs automatically closed at End of Day

Ref : OF April 2000 Release G10.2.02

41-33
GLOBUS USER GUIDE OPEN FINANCIAL SERVICE

Index of Tables & Figures

Table 41-1 OFS.SOURCE Fields required for BATCH processing...........................................................41-26
Table 41-2 EB.PHANTOM table for OFS BATCH records.......................................................................41-26
Table 41-3 OFS.SOURCE Fields required for ONLINE processing. ........................................................41-30

Figure 41-1OFS Architecture..........................................................................................................................41-2

Figure 41-2 Sample login VOC for use with online OFS Processing ...........................................................41-3
Figure 41-3 EP.MONITOR phantom enquiry ...............................................................................................41-5
Figure 41-4 Definition of OFS.SOURCE batch processing record...............................................................41-8
Figure 41-5 Setting up EB.PHANTOM to run OFS in batch mode.............................................................41-9
Figure 41-6 OFS message structure ..............................................................................................................41-12
Figure 41-7 Option format.............................................................................................................................41-13
Figure 41-8 User information format ...........................................................................................................41-13
Figure 41-9 Transaction ID format...............................................................................................................41-15
Figure 41-10 Update message format ...........................................................................................................41-15
Figure 41-11 Enquiry request message format ............................................................................................41-16
Figure 41-12 Transaction ID format.............................................................................................................41-17
Figure 41-13 Error message format..............................................................................................................41-17
Figure 41-14 Format of returned ENQUIRY data.......................................................................................41-18
Figure 41-15 Header / caption details for display........................................................................................41-18
Figure 41-16 Column definitions for the returned data ..............................................................................41-18
Figure 41-17 Row and column data in a repeating series ...........................................................................41-19
Figure 41-18 OFS.SOURCE sample OFS batch set up................................................................................41-24
Figure 41-19 Sample EB.PHANTOM record for OFS Batch Processes....................................................41-27
Figure 41-20 OFS.SOURCE online sample set up .......................................................................................41-28
Figure 41-21 EB.PHANTOMs automatically closed at End of Day...........................................................41-33

Ref : OF April 2000 Release G10.2.02

41-34