T24 Frequently used Core routines.doc

S no

Core routine

Description

1

APP.STATIC.TEXT

$

A%D

Returns array of application messages from the static text translation file. The messages are efine !y the application an their translations "entere !y the user# are rea in at run time. Chec&s 'hether the gi(en ate is 'or&ing ay or not

)

*.+PDATE.*ATC,

/

*ATC,.*+I0D.0IST



*D.CA0C.DA2S

3

CAC,E.READ

4

CA0C.ERATE.05CA0

7

CA0C+0ATE.C,AR8E

:

CA0E;DAR.DA2

As a !atch -o! to an existing !atch process. Ena!les application programs to initiate ahoc -o!s in the o(ernight run. Selects the IDs an !uils the -o!list for processing Calculation routine for interest accrual ta&ing into account the AI*D. Rea Parameter files This routine calculates an exchange rate gi(en a foreign amount an local currency e6ui(alent. Calculates charges9 commission an tax amounts an returns enough information to raise the accounting entries. Calculates for'ar or pre(ious ate from a start ate using the fre6uency Call =a(a program

1<

CA00=

11

CDD

1$

CDT

1)

C>?

1/

C,EC.ACC5+;T.C0ASS

1

C,EC.R5+TI;E.EXIST

13

C55;.REST5RE

14

C+S.AC.EXTRACT

17

C+ST5ER.RE0ATI5;S

1:

C+STRATE

$<

DAS

$1

D*R

Returns a fiel from a recor for @chec&file@ processing.

$$

DIETER.DATE

$)

DISP0A2.ESSA8E

This routine con(erts ates from the format use throughout 805*+S "222DD# "222DD# to the stanar +niBerse +niBerse format "either internal or external. External ates formatte as per +niBerse C5;BERSI5;s# Routine to isplay a status message for the user.

$/

D+P

Calculates the ifference9 in ays9 !et'een t'o supplie ates Calculates for'ar or pre(ious ate from a start ate using the num!er of ays. Calculates the next ate from toay@s ate an a fre6uency coe. This routine 'ill ta&e a gi(en category an sector an ensure that there is a match on the appropriate account class. This routine is use to chec& if a program is compile or not. This is program 'ill 'or& in +B-*ASE. Program restores the common (aria!les from a name common area that 'as sa(e earlier !y C55;.SABE. This 'ill return a populate C+ST5ER.P5SITI5; recor for  a gi(en account nu m!er an company. This su!routine 'ill return any customers that are relate. Perform all the tas&s in(ol(e in foreign exchange of t'o currencies on a !uysell !asis

Chec&s for uplicate occurrences of (alues in multi an su!(alue fiels at cross(aliation.

$

E.8ET.05CA0.AT

En6uiry Su!routine to calculate the local currency e6ui(alent using IDD0E.RATE.C5;B.C,EC Su!routine to return a calculate statement entry narrati(e for en6uiry purposes. The narrati(e is calculate accoring the efinitions in TRA;SACTI5;9 STT.;ARR.>5RAT an STT.;ARR.PARA Application interface routine to the accounting system. In(o&es the routines to (aliate  post entries9 etermines the suspense categories for (alue ate transactions "(alue ate accounting# an maintains currency positions. %hen Pricipal amount outstaning on the contract9 ccy9 rate an other etails are passe as incoming parameters9 this routine 'ill return caculate repayment amount. %hen Pricipal amount outstaning on the contract9 ccy9 rate an other etails are passe as incoming parameters9 this routine 'ill return ;um!er of payments ue. Calculate the yiel to maturity or internal rate of return for a series of cashflo's This routine 'ill clear each partfile is the file is istri!ute else a normal clear 'ill !e performe. Program to con(ert a currency amount to another currency amount This routine 'ill etermine the ate a payment shoul !e (alue.*ase on the ay con(ention an the !usiness centres9the (alue ate for the scheules are etermine. This routine formats rate (alues epening upon the system settings. If extene precision is on9 the maximum no. of ecimals allo'e is : else it is 3. Total no of igits allo'e for a rate (alue is 11. This routine 'ill return an interest amount !ase on a gi(en !ase amount at a specifie rate. It 'ill also return the roune amount if the currency coe is passe.

$3

E.8ET.STT.;ARRATIBE

$4

E*.ACC5+;TI;8

$7

E*.CA0C.REPA2E;T

$:

E*.CA0C.TER

)<

E*.CA0C.2T.IRR

)1

E*.C0EAR.>I0E

)$

E*.C+RR.C5;B

))

E*.DETERI;E.PA2E;T.DATE

)/

E*.>5RAT.RATE

)

E*.I;TEREST.CA0C

)3

E*.05CRE>.SET+P

)4

E*.READ.,IST5R2.REC

This routine 'ill return the local reference ata of a specifie application. This su!routine 'ill rea a recor from a specifie ,IST5R2 file Initially this 'ill !e use in E5D.C5;S50.+PDATE9 !ut can !e use else'here.

)7

E*.READ0IST

Routine to return a list of &eys from a select statement.

):

E*.R5+;D.A5+;T

>ormats amount accoring to currency efinition9 !yF  using9 !y efault9 t'o ecimal places9 5R9  using the efine num!er of ecimal places for the currency9 5R9  using the lo'est unit of currency "e.g. 1<9 <.< etc.#  A;D rouning accoring to the lo'est unit

/<

ERR

Displays error message on the same line as the input fiel or on line $$ if running uner a multiline (ersion. Can !e use only 'ithin the confines of a template program.

/1

EXCEPTI5;.058

0og all E5D errors so they can !e reporte at then en of the E5D processing. 1# >ixing ate error  This fiel inicates 'hich of the currencies has a >IXI;8 DATE rate an the current ate oes not match the ate the rate 'as last fixe. If this fiel is set9 then 1 inicates *+2.CC2 is in error9 $ that it is the SE00.CC2 an ) that !oth are. $# Suspene mar&et  This inicates that one of the currencies has ha 6uotes suspene 'hether it !e the 05CA09 *+2 or SE00 CC2. If the 05CA0 is suspene this automatically terminates the routine. >or *+2 an SE009 the routine is terminate only if the suspension inicator is not set to @*05CED@. If the routine is terminate9 a rele(ant message is returne in ETEXT. If  the inicator is set then its (alue is return in RET+R;.C5DE. ;oteF Suspension is not currently a(aila!le as an option in C+RRE;C2. )# Tolerance exceee  If the DI>>ERE;CE in terms of the local currency is greater than the maximum con(.tolerance for the company9 then this is set to @;@ inicating the rate is out of !ouns. If it is set to @5@ then the rate nees an o(errie an if set to @2@ then rate is o&ay. Deletes a recor from a file

/$

EXC,RATE

/)

>.DE0ETE

//

>.0IBE.%RITE

/

>.ATREAD

'rites the current etails in the recor to history an upates 'ith ne' etails to the recor 'ith the auit fiels Rea a imensione array from a file

/3

>.ATREAD+

Rea a imensione array recor from a file 'ith a loc&

/4

>.AT%RITE

%rites a imensione array "recor# to a file

/7

>.READ

Rea a recor from a file

/:

>.READ.,IST5R2

<

>.READ+

This su!routine 'ill rea a recor from a specifie ,IST5R2 file Rea a recor 'ith a loc&

1

>.READB

Rea a fiel on a recor from a file

$

>.%RITE

%rites a recor to a file

)

>ATA0.ERR5R

/

>C2.C5;BERT.C,EC



>IE0D.;+*ERS.T5.;AES

3

>I;D.CC2.T

Application fatal a!ortF isplays an error message9 exits from @EX@ an upates the PR5T5C50 file. Shoul !e calle for all @fatal@ errors in !oth online moe an !atch. Performs the follo'ing functionsF a# Con(erts a foreign amount to a local amount 'hen a foreign amount is passe !ut not a local. *# Con(erts a local amount to a foreign amount 'hen a local amount is passe !ut not a foreign. C#Calculates an exchange rate 'hen !oth a foreign an local amount is passe. # Recalculates foreign an local amounts an returns the ifference. e# Calculates a percentage exchange rate ifference 'hen a rate is passe. Con(erts fiels num!ers "as efine in the stanar selection recor# to fiel names Program to fin currency mar&et

4

>T.;+00S.C,

This routine 'ill chec& for a particular fiel9 if the fiel has !een expane 'ith extra multi or su!(alues9 an if there are any null (alues.

7

8ET.ACC5+;T.C5PA;2

:

8ET.C5PA;2

This routine gi(es the correct lea company mnemonic for oing the 5P> on the account file. This routine is use in places 'here the -o! runs in master company an the account recors of the other !oo& an other company ha(e the limit that exist in the aster company attache to them. get the 0ea company an its mnemonic etails

3<

8ET.05C.RE>

31

8ET.;ARRATIBE

3$

8ET.;EXT.ID

3)

8ET.SETT0EE;T.DE>A+0TS

3/

8ET.STA;DARD.SE0ECTI5;.DETS

3

8IT

33

IDESC

Su!routine to return the (alue of an Iescriptor.

34

I;P

Routine to prompt for input an (aliate. Determine if 'e@re running 8+I an in(o&e the correct routine.

37

=5+R;A0.+PDATE

3:

=+0DATE

4<

0C

41

0IIT.C,EC

4$

0IIT.C+RR.C5;B

4)

0IIT.8ET.PR5D+CT

'hen application name9 local fiel name is passe9 this routine 'ill return the local fiel position !y refering to stanar selection ta!le Su!routine to return calculate statement narrati(e using TRA;SACTI5;9 STT.;ARR.PARA an STT.;ARR.>5RAT applications. 'hen application informations are passe in common (aria!les9this routine 'ill return the ne' GID. This routine is use to get the efault account an settlement etails for a particular customer an application. Defaults may !e o!taine from Portfolio "SEC.ACC.ASTER#9 A8E;C29 C+ST5ER.CC2.ACCT or ;5STR5.ACC5+;T files. The routine reas the STA;DARD.SE0ECTI5; recor an merges the S2S an +SR fiels together. The routine contains a imensione cache of Stanar Selection recors T.SS.REC an ynamic list of Stanar Selection is T.SS.IDS.

Con(ert from =ulian to 8regorian ate format an (isa (ersa Displays recor loc&e message This su!routine is use !y applications !oth online an en of ay to (erify an upate the limits system. The application is re6uire to supply the correct (alues from the transaction in orer to gi(e the correct upate to the system. Program to con(ert a currency amount to another currency9 assuming that the call parameters ha(e pre(iously !een (aliate. The currency from is assume to !e the !ase currency. Xrate is calculate as to.ratefrom.rate !y this p rogram. This routine 'ill cater for con(ersion to a currency not efine in the current company. This su!routine is use !y applications to (aliate an efault the 0imit Reference use in a gi(en transaction. It is calle as part of the cross(aliation processing.

4/

05AD.C5PA;2

*uils an loas a company profile into I C55;. This routine must !e calle for a change of company. Su!routine to print ata to the local printer. +sing a um! terminal this is output (ia the sla(e printer port. %hen using 8+I this is sent to the 8+I Client 'hich in turn prints it on the comxlptx port. Performs the follo'ing functionsF A# Con(erts a foreign amount to a local amount 'hen a foreign amount is passe !ut not a local. *# Con(erts a local amount to a foreign amount 'hen a local amount is passe !ut not a foreign. C# Calculates an exchange rate 'hen !oth a foreign an local amount is passe. #Recalculates foreign an local amounts an returns the ifference. e# Calculates a percentage exchange rate ifference 'hen a rate is passe. f#;oteF The mile rate is use for all calculations unless a rate is explicitly passe. as&s input to a specifie format

4

05CA0.PRI;T

43

IDD0E.RATE.C5;B.C,EC

44

S

47

5>S.CA00.*+0.A;A8ER

4:

5>S.P5ST.ESSA8E

7<

5P>

71

5BE

7$

PRI;TER.C05SE

Spools report as irecte !y the report control system. This su!routine must !e use in place of the Data*asic PRI;TER C05SE statement.

7)

PRI;TER.5>>

7/

PRI;TER.5;

7

PR5

73

PR5D+CE.DEA0.S0IP

74

PST

Reirects output from the print unit to the screen. This routine must !e use instea of the Data*asic PRI;TER 5>> statement. Sets up the printer en(ironment for the report an irects output to the print u nit. This routine must !e use instea of the Data*asic PRI;TER 5; statement. 5utputs a message to the protocol file for auit or exception purposes. Routine to format  print a eal slip !ase on the DEA0.S0IP.>5RAT parameters. The DEA0.S0IP argument can !e a ynamic array of eal slip i@s to !e ER8ED prior to output. Ie you coul efine a heaer format an then merge in the actual eal slip ata. >or output if the terminal supports a local printer then this is use other'ise it gets sent (ia report control. 5penscloses printer for output an efines heaers

77

RE*+I0D.SCREE;

7:

RE>RES,.>IE0D

:<

RE

Routine to call 5>S.*+0.A;A8ER from an application use for performing 5>S transactions 'ithin transaction !ounary >ile open routine. ,anles company moification of file name hence9 it must !e calle for all file opens. Prompts for an o(errie an (aliates 2; input.

In(o&es ATRIX.A0TER to reset screen pointers for automatically expane multi(alues. This routine ta&es the fiel num!er9 multi (alue an su! (alue specifie in RE>RES,.>IE0D.;5 an forces the reisplay of the fiel9 an the enrichment. Displays a message on line $) an prompts to continue.

:1

R8.8ET.0AST.ATC,

:$

R8.8ET.05CA0.TEXT

:)

SC.>5RAT.CC2.AT

:/

SP550.REP5RT

:

ST5RE.E;D.ERR5R

:3

ST5RE.5BERRIDE

:4

TRA;SACTI5;.A*5RT

:7

TXT

::

TXTI;P

1<<

BA0IDATE.SI8;.5;

1<1

%5RI;8.DA2

1<$

5>S.*+I0D.REC5RD

1<)

Routine to (aliate sign on name  pass'or. ,anles all sms chec&s9protocol logging9 expiration of pass'ors etc. fins out 'hether the start ate an the en ate are non'or&ing ates.

Build OFS string

EB.SET.+E,T.TAS-

Appends/updates the audit felds. Coon !aria"le #$# should "e assigned %ith the last feld nu"er %rites the )urrent details in the re)ord to histor* and updates %ith ne% details to the re)ord %ith the audit felds Fa)ilitates the autoa) ee)uon o0 a ainline pro)ess 1su"roune or )oand2 at the )opleon o0  another pro)ess

OCO3O

Used 0or updang the )oents in CO3O re)ord

S.UPDATE.AUDIT.FIELDS 1
EB.&IST.'EC.('ITE 1<

1<3

Routine to return the last i from a list of is 'hich match the first fe' characters passe in argument >IRST.PART.ID. Repgen su!routine 'ill get the escription from REAR fiel of a 05CA0.TA*0E recor. P8.>I0E entry to !e use in REP8E; is R8.05CA0.TA*0E.TEXT. This su!routine 'ill recei(e t'o parameters an returns the amount to the calling program formate to the correct num!er of ecimal places incluing trailling Heros. Spools a report9 'hich has not !een create9 !y the report control system. This is only intene for use 'ith C55 files. This routine must !e use instea of executing a spool comman. Routine to store error messages !y fiel9 to !e isplaye at the en of (aliation processing. Prompts for an o(errie an stores the message in the main file recor if the user replies @2@. Su!routine to cancel the current transaction an clear eferre 'rite caches an releases loc&s. Translates ynamic messages. The message can contain a (aria!le portion e.g. RATE ::.:::: EXCEEDS T50ERA;CE *2 1<. Prompt user an accept user input