Toggle to view Version/Application specific helptext

ENQUIRY
This file holds the parameter definitions of the enquiries used by the enquiry
system.

It allows the user/programmer to define an on-line enquiry without any coding

requirements. Essentially the parameters specify the file to be listed, the fields
to be displayed and where, the formats and conversions to be applied prior to
display and the break points (if any) to be used.

In addition to this, the parameters can also define internally calculated data,
totals/sub-totals, decision processing, user routines and finally a link to a lower
level enquiry.

Enquiries may be used to produce reports online, or from the end of day, by using
the ENQUIRY.REPORT application to execute the report.

ACCOUNT.NO.FLD
ACTIVITY
ATTRIBS
ATTRIBUTES
AUTO.CONVERSION
BREAK.FIELDS
BUILD.ROUTINE
CLOSE.BRACKET
COL.WIDTH
COLUMN
COMMENTS
COMP.FOR.ENQ
COMPANY.SELECT
CONVERSION
CUSTOMER.NO.FLD
DESCRIPT
DISPLAY.BREAK
ENQUIRY
ENQUIRY.GRAPH.ID
ENQUIRY.NAME
EXPOSE
EXPOSE.DESC
FIELD
FIELD.DISP.TYPE
FIELD.LABEL
FIELD.LBL
FIELD.NAME
FILE.NAME
FILE.PRODUCT
FILE.VERSION
FIXED.SELECTION
FIXED.SORT
HEADER
K.TYPE
LABEL.FIELD
LENGTH.MASK
LIAB.LC
LINES.O.SIDE.PAGE
LINES.OSIDE.PAGE
LL.DESCRIPT
MULTI.FIELDS
NEXT.LEVEL.FIELDS
NEXT.LVL.FLDS
NO.MANDATORY.SELECTION
NUMBER.OF.FIELDS
NXT.DESC
NXT.LVL.DESC
OPEN.BRACKET
OPERATION
PAGE.FIELDS
PAGE.SIZE
POPUP.DROPDOWN.FLD
PROCESS.BREAKS
PRODUCT
REAL.TIME.FILES
REL.NEXT.FIELD
REQUIRED.SEL
RESERVED.1
RESERVED.2
RESERVED.3
RESERVED.4
SECTION
SEL.CRIT
SEL.FLD.OPER
SEL.LABEL
SELECTION.FLDS
SERVICE
SHORT.DESC
SINGLE.MULTI
SMS.ABORT
SMS.APPLICATION
SMS.ID
SPOOL.BRK.FLD
STATIC.FIELDS
TARGET.APPLICATION
TARGET.FIELD
TOOL.ID
TOOL.ITEM
TOOL.TEXT
TOOLBAR
TOTAL.FIELDS
TYPE
USE.FIELD.NUMBERS
T24 Common HelpText Fields
ACCOUNT.NO.FLD
Indicates the defined field which contains the value of the account number, to be
used for purposes of spooling.

When enquiry is used to produce a report from the ENQUIRY.REPORT module, the value
in the nominated field will be passed to the Report Control system for each spooled
record. The report control system will then be able to determine whether output for
the report and the specified account is to be spooled or held.

In order for the full definition of DE.PRODUCT records for Held Customer output to
be utilised, a CUSTOMER.FLD.NO should be defined with this field.

Note that the field nominated should not be extracted on a page break, as the
previous value may be used.

Validation Rules:
Up to 18 'A' alphanumeric characters. (Optional input)

Must be defined as a FIELD NAME.

ACTIVITY
Field that contains the ID of a PW.ACTIVITY record. It may be an existing record.
If the record is not present, then upon authorising the ENQUIRY, a new record is
created.

The ID of the new PW.ACTIVITY record created through the ENQUIRY will have prefix
'WS.'

Validation Rules:

1. Length of 35 alphanumeric characters

2. If EXPOSE is set to 'YES', then this field is mandatory

3. No-input if EXPOSE is not set to 'YES'

The following validations/processing is done based on the fields SERVICE and

ACTIVITY.

If both SERVICE and ACTIVITY do not exist, then a new activity is created in
PW.ACTIVITY, with the TARGET field mapped to the Enquiry and a new record is
created in EB.SERVICE with the activity added to it.

If the SERVICE is existing EB.SERVICE and ACTIVITY does not exist in PW.ACTIVITY,a
new activity is created in PW.ACTIVITY and the same is appended to the EB.SERVICE
record.

If SERVICE does not exist and ACTIVITY exists, a check is done to ensure that the
activity relates to this Enquiry, i.e. the TARGET field in PW.ACTIVITY is mapped
correctly, otherwise an error message is thrown. Then, a new EB.SERVICE record is
created with the activity added to it.

If both SERVICE and ACTIVITY exists and the activity relates to the Enquiry, a
check is done to ensure that the EB.SERVICE does not contain the ACTIVITY.ID
already.Otherwise an error message is thrown. Finally,EB.SERVICE is updated with
the activity appended to it.

ATTRIBS
Specify attributes of the column, the following are defined:

HIDDEN: The column will be collapsible, have an icon to show / hide the column.

ATTRIBUTES
Attributes that determine the behavior of the entire enquiry are held in this
field.

These attributes are only processed within the Graphical User Interface.

The following attributes are currently used:

REMOVE - Where a pick operation is performed on an enquiry grid, this flag will
remove the item from the display.

ALLDATA - Forces the retrieval of all data before the enquiry is displayed.
APPLICATION.ENQUIRY - Browser only. Allows an enquiry to edit a record. Similar to
fastpath enquiries but operates on a single record only rather than a list of
records. Uses fields TARGET.APPLICATION and TARGET.FIELD.

INCREMENTAL - For Browser only. Indicates that the enquiry should show all pages
from page 1 up to the current page, as opposed to the the current page + the
previous page.

Validation Rules:

Input may only be REMOVE or ALL DATA. No duplicates are permitted. Nulls only
permitted if no multi values have been expanded.

REALTIME enables the enquiry to be user by a Real-time enquiry user, must be

followed by a multi valued ATTRIBUTE field with ZERORECORDSDISPLAYED flagged.

Input can also be ZERORECORDSDISPLAY.

NO.BREADCRUMBS - this will remove the list of previously viewed enquiry navigation
links from the top of the screen. This option is only used for enquiries that have
been drilled down to.

NO.SELECTION - the selection/criteria below the enquiry data will not be available
to the user.

NO.TOOLBAR - this will remove the toolbar from the top. Paging toolbar will be
retained.

STATIC.PAGING.TOOL - place the paging toolbar inside the enquiry header and top
left of the enquiry page.

DRILLDOWNS.AS.HYPERLINKS - Drilldowns appear as hyperlinks in the enquiry data

column.

SELECTION.HORIZONTAL - Selection criteria is displayed horizontally along the

screen

NO.COLUMN.HEADER - Displays enquiry without headers for the selected columns.

NO.MORE.OPTIONS - To remove the 'More Options' function from enquiry selection

screen.

NO.CLEAR.SELECTION - To remove the 'Clear selection' function from enquiry

selection screen.

SINGLE.BACKGROUND.COLOUR - Header section and all fetched rows will be of same

background colour.

DISABLE.NO.SORT.OPTIONS - The NO.SORT.OPTION field when enabled performs normal

SELECT rather than sorted select(SSELECT).To disable this field from enquiry
selection screen, this attribute can be used.

NO.ENQUIRY.FAVOURITES - This option disables the favourites function for the

enquiry

SHOW.ALL.SELECTION - Displays all selection fields along with the enquiry data
displayed.
UNDERLINE.HEADER.ROW - Thick line will be displayed below the header

UNDERLINE.ALL.ROWS - All the rows which are fetched will be underlined

SELECTION.ABOVE.DATA - Selection criteria is displayed above data.

FASTPATH - This attribute is used to authorize, delete, reverse, edit and see bulk
of records for the underlying application.

NO.HEADER.STYLE - Headers appear in the exact column position as defined in enquiry

instead of using any auto adjustment

NO.FOOTER.STYLE - Footers appear in the exact column position as defined in enquiry

instead of using any auto adjustment

VIEWLIST - DESKTOP only, Converts grid enquiries to display records in list format
as per windows standard.

VIEWLARGEICONS -DESKTOP only, Converts grid enquiries to display records as large

Icons as per windows standard.

VIEWSMALLICONS - DESKTOP only, Converts grid enquiries to display records as small

Icons as per windows standard.

PAGE - Desktop only. Displays enquiry output in page format.

MULTI.DOWNLOAD - To indicate that the enquiry is to be used for a multi-select

secure document download function.

HORIZONTAL.DRILLDOWNS - Displays the drilldowns in a horizontal line rather than

using a combo box.

UNDERLINE.DRILL.ROWS - Horizontal line appears in enquiries under drill rows.

ENQ.HEADERS.ON.EACH.PAGE - Enquiry headers and footers are displayed on each page

CV.TRANSLATE - The session specific !CURRENT variables are changed to enquiry

specific variables. When this attribute is set,the enquiry output details are
stored in the T24 server with the current variable values and also based on the
window name. And on clicking the back to window or refresh , system retrieves the
same data stored in the T24 server.

ADD.ACTION.TOOLS - To add the ENQUIRY.ACTION toolbar along with the custom toolbar

ZERORECORDDISPLAY - If an Enquiry selection criteria does not return any records a

message will be shown to report this.With this attribute set,the message is
suppressed and a blank page is displayed.

SHOWTREE - Shows an explorer tree for multi values and sub values.

UNDERLINE.TREE.ROWS - To add a horizontal rule row in the enquiry response if the

attribute is set.

USE.SAMPLE.SIZE - This attribute if defined will enable the enquiry for Sample
Selection.

This will work in conjunction with the SPF>ENQ.SAMPLE.SIZE definition.

The attribute will be applicable only for requests processed via Browser(Legacy and
UXP), OFS and Iris.

The usage of SAMPLE.SIZE is not applicable when called from any service framework
including COB.

Desktop and Classic mode calls are excluded from this functionality and will not
support this functionality of sample size.

If all the above conditions match, then the common system variable !SAMPLE.ONLY
will be set with a value of ENQ.SAMPLE.SIZE if the underlying select returns the
number of records greater than or equal to the ENQ.SAMPLE.SIZE. Else it will be set
to Zero.

For NOFILE enquiries, the !SAMPLE.ONLY will need to be set by the routine and the
core will not setup this variable separately for the NOFILE routine based enquiry.

This facility is not supported for ENQUIRY.REPORT and is meant for only ENQUIRY
executions.

The attribute USE.SAMPLE.SIZE will override the attribute ALL.DATA. These two
attributes are mutually exclusive in nature and if both are defined,
USE.SAMPLE.SIZE will supersede the definition. There will be no validation of any
sort for this and is purely a runtime override in functionality in such cases of
definitions.

NORMALISE - Allows normalisation of data(Value and subvalue markers will not be

converted)

SELECTION.SORTONLY - Selection sort only criteria is displayed.

NO.FIXED.SAMPLE - This attribute is to override the FIXED.SAMPLE attribute

specified in OFS.SOURCE record.This will not include the SAMPLE clause in select
statement. So no limit is applied for displaying number of records

INCLUDE.DL.YES - If this attribute is set in the enquiry, the enquiry runtime will
consider the value of INCLUDE.DL as YES by default. This can be overridden by the
user at the time of selection and will be the priority for enquiry runtime

AUTO.CONVERSION
Flag to indicate if the enquiry is to be automatically converted if fields are
added to or deleted from a file used by this ENQUIRY.

This field will be used to determine if field numbers in this enquiry will be
automatically incremented or decremented if fields are added to or deleted from the
file in the FILE.NAME field.

Validation Rules:

Can be either Y or NO (Optional Input)

BREAK.FIELDS
Internal field used for processing of the enquiry.

Validation Rules:

Internal field.

BUILD.ROUTINE
Specify either a jBC routine name or an EB.API record of type METHOD which
implements an interface defined in the EB.API record ENQUIRY.BUILD.ROUTINE.HOOK.

No '@' prefix is expected in this field.

Enables programmatic manipulation of the selection criteria after the user has
provided their input.

Note that any filtering resulting from the BUILD.ROUTINE is applied after the
FIXED.SELECTION and operates on that subset of records.

See the EB.API record ENQUIRY.BUILD.ROUTINE.HOOK for the full list of supported
interfaces, initially EB.EnquiryHook.setFilterCriteria().

An implementing jBC routine must have one INOUT passed parameter with the following
structure:

<1> = Name of the enquiry.

<2,x> = Selection field names (eg CUSTOMER).

<3,x> = Associated operands (eg LK).

<4,x> = Associated selection values (eg 1...).

The routine is expected to update the parameter. Errors should be reported in the
ENQ.ERROR common variable.

Validation Rules:

1-32 type A (alphanumeric) characters.

CLOSE.BRACKET
The selection conditions can be grouped using the fields OPEN.BRACKET and
CLOSE.BRACKET. Conditions enclosed in brackets are evaluated before those outside
of the brackets.

Validation Rules:

Optional input

Options YES or NO, Multi value, associated field

Input not allowed if the corresponding SELECTION.FIELD is not entered.

COL.WIDTH
This field only applies to T24 Browser.

Users can specify a number of pixels wide that an ENQUIRY column should be.

Note this 'width' is not an absolute fixed width, it is more like a minimum width
with restrictions. These restrictions are as follows:

a) Column widths will grow to accomodate the widest 'word' or image in the column.
A 'word' is any sequence of characters that doesn't contain a space, for example
'SELF-EMPLOYED', 'NEW.CUSTOMER' are all considered as single words by the browser.

b) Columns with 'left over' space created by larger than required COL.WIDTH values
will shrink if there is not enough space in the window, frame or fragment to
display all columns. However columns will never shrink so much that the first
restriction is violated.

Validation Rules:

Up to 3 Integer characters. Note it is possible that some enquiries can define

several fields as belonging to the same COLUMN, for example a field could be in '1'
and another in COLUMN '1,+1'. These fields should be given the same COL.WIDTH
values. If they are different, only the last specified value will count.

COLUMN
Specifies the screen co-ordinates to display the enquiry field.

Defines the exact or relative screen position to display the field value. The
following formats are accepted:

Column Action

'' Null - field will not be displayed.

CC Field will be displayed at column CC on the current line.

CC,LL Field will be displayed in column CC on line LL. (exact positioning, normally
used for variable heading data).

cc,+nn Field will be displayed in column cc on the current line + nn lines (also
supports -nn). Note that when a multi/sub value field is displayed. Each item will
be displayed +nn lines from the last.

cc,+nnM Field will be displayed in column cc on the current line + nn lines (also
supports -nn). When a multi/sub value field is displayed ONLY the first item will
be displayed +nn lines, each subsequent item will be displayed on the next line.

P Used only in conjunction with break instructions - performs page 'throw' when
break condition met.

Validation Rules:

5 type A (alphanumeric) characters.

COMMENTS
Describes the associated field and processing.

Validation Rules:

Up to 50 alphanumeric characters (Optional input)

COMP.FOR.ENQ
Help Text for this field is unavailable. Please refer to the T24 User Guides for
further information.

COMPANY.SELECT
This field is used in a multi branch system to control enquiry access to financial
level data.

Multi branch indicates that the MB product is installed, the term Multi Book can
also be used.

This product basically allows financial level data to be stored in the same
database table for all companies, as opposed to Multi Company where the data is
stored in a separate table for each company.

If this field is set to ALL then records will be selected for all companies, with
the current SMS restrictions being applied to what the user can actually access.

If this field is left blank then the data selected will be restricted to the
current company.

Validation Rules:

Optional input of ALL in a system with the MB product installed

CONVERSION
Allows data to be converted prior to display.

The conversion operation allows the manipulation of the result of an enquiry

operation. The result of the conversion is then stored in the enquiry field. The
following conversions are supported:

Conversion Action
FIELD X,N1,N2 Extract from the data, delimited by X, the N1th field to the N2th
DECRYPT Field.Name DECRYPT is a standard text to inform T24 that this field is
sensitive and the routine attached to the field ENQ.DECRYPT.RTN in EB.ENC.PARAMETER
parameter table is to be called either for decrypting or masking the data
Field.Name must be a valid field name in the enquiry
EXTRACT N1,N2 Extract from the data starting at position N1 for N2 bytes
SUBSTITUTE X,Y If the data equals X then replace it with Y.
CONVERT X,Y Replace every occurrence of the character X with Y.
VALUE X,Y Extract value X, sub-value Y from the data.
JULIAN Convert the data from YYYYMMDD format to system internal format.
OCONV XXX Convert data using Basic OCONV instruction XXX. See Basic manual
ICONV XXX Convert data using Basic ICONV instruction XXX. See Basic manual.
LINK XXX,YYY Read file XXX using the current data as the key and return field
name YYY as defined in the STANDARD.SELECTION record for XXX. Do not specify F. or
company mnemonic in file name. Field Name YYY may be a data field or an I or J
descriptor defined in the Standard Selection record of file XXX Note that if a
multi or sub valued item is returned from a LINK conversion, the multi and sub
values are converted to spaces, so the result cannot be displayed in separate
lines.
UTIL FIXEQU,ccy field Returns the equivalent value of an amount in a currency
contained in the field ccy field. The rate used is the FIXED.RATE defined in the
CURRENCY record. If no FIXED.RATE is specified a null value is returned.
UTIL FIXRTE,ccy field Returns the rate used to convert an amount to the Fixed
currency specified in the CURRENCY held in the field ccy field. If no FIXED.CCY is
defined, a null value is returned.
UTIL FIXCCY,ccy field Returns the equivalent currency linked to the currency
defined in the field ccy field. If there is no FIXED.CCY defined, no value is
returned.
UTIL ABS Return the Absolute value of an amount.
UTIL MATCHFIELD XXX YYY Perform Basic MATCHFIELD function on XXX and YYY. See Basic
manual
@ XXX Specify either a jBC subroutine name or an EB.API id with a source type of
METHOD which implements an interface defined in the EB.API record
ENQUIRY.CONVERSION.HOOK. See the EB.API record ENQUIRY.CONVERSION.HOOK for the full
list of supported interfaces, initially EB.EnquiryHook.setValue() and
EB.EnquiryHook.setRecord(). For jBC subroutines, the routine has no passed
parameters and is expected up update either O.DATA or R.RECORD (depending on
context) from I_ENQUIRY.COMMON. Errors should be reported in ENQ.ERROR.
$ XXX Call user subroutine XXX at selection stage only. Allows manipulation of user
selection criteria.
REPEAT Repeat previous data if current data is null - but only for the second
and subsequent multi and subvalues - note: If the field you are displaying is
subvalued then you will get repitition of mvalue=2 and svalue=1 (providing the data
is null) because the mvalue is greater than one. If you do not want this then use
REPEAT SUB
REPEAT SUB Repeat previous data if current data is null - only if the subvalue
number is greater than one
REPEAT EVERY Repeat previous data if current data is null - regardless of
multi/subvalue number
Validation Rules:

32 type A (alphanumeric) characters.

Must be a valid conversion as defined above.

CUSTOMER.NO.FLD
Indicates the defined field which contains the value of the customer number, to be
used for purposes of spooling.

When the Enquiry is used to produce a report from the ENQUIRY.REPORT module, the
value in the nominated field will be passed to the Report Control system for each
spooled record. The report Control System will then be able to determine whether
the report generated is to be spooled or held for the customer.

Note that the field nominated should not be extracted on a page break as the
previous value may be extracted.

Validation Rules:

Up to 18 'A' alphanumeric characters. (Optional Input)

The field must be defines as a FIELD NAME.

DESCRIPT
Description of purpose and function of enquiry.

Validation Rules:

Optional Field.

A maximum of 50 characters may be entered.

Should be completed where possible.

DISPLAY.BREAK
Defines enquiry field to be processed only when a break condition is met.

This field will only be processed when the break condition has been met. In the
case of total fields, the total will be displayed (providing Column has been
specified) and the current total cleared.

Never specify a record field extract (0-999) to be processed on a break. This will
extract the field from the data record which caused the break and not the previous
record. Always use the FIELD XXX instruction instead.

Standard break names are provided for certain conditions. They are:

ONCE Only processed once at the beginning of the enquiry END Only processed at the
end of the enquiry NEWPAGE Processed at the start of every new page NONE Only
processed if no records matched the selection criteria.

be used to process

Validation Rules:

15 type A (alphanumeric) characters. The name of the enquiry field which defines
the break or one of the standard names.

ENQUIRY
This is the name by which the enquiry can be identified.

This identifier is used when invoking the on-line enquiry, hence it should be made
as meaningful as possible.

If the ID is in the format %application, %application.P or %application$HIS then

this enquiry will be used to list the application file, print it or list the
application history file respectively. Note: The ID can also refer to the VERSION
name hence %CUSTOMER,OPEN would be invoked when the user lists the cutomer file
while running under the version ,OPEN.

If the ID begins CURRENT.XXX then the first selection criteria entered is stored by
the enquiry system and can be used in subsequent enquiries (by entering !
CURRENT.XXX) see the user guide for more details.

Validation Rules:

32 type A (alphanumeric) characters. (Mandatory input)

ENQUIRY.GRAPH.ID
Help Text for this field is unavailable. Please refer to the T24 User Guides for
further information.

ENQUIRY.NAME
Defines the next enquiry or application to be invoked when descending enquiry
levels.

To envoke another enquiry the name of the enquiry should be entered.

The next enquiry invoked will be XXXX.FUNCTION where FUNCTION has been entered by
the user, eq S, P V etc. If this does not exist then XXXX will be invoked.

To invoke an application (in See mode) you must specify the name of the application
(or version), 'S' and the id of the application file, e.g.

MM.MONEY.MARKET SEE ID

If any of the 'words' match the name of an enquiry field, then the field content is
substituted in place of the 'word'. This mechanism allows variable data to
determine the next level down. If the second 'word' is not 'S' or 'SEE' then the
next level is determined to be an enquiry and not an application.

To view a text record, such as a report the option VIEW should be specified. This
needs to specify the file from which the text record is to be read, and the id of
the record, separated by a ">" character.

For example, to view a report from HOLD.CONTROL the option

VIEW &HOLD&>987654321

Should be specified, where 987654321 is the id of the report in the file &HOLD&.
The file and id need not be specified explicitly but can be assigned in the same
way as any field in enquiry.

CONTEXT BASED WORKFLOW ----------------------

When defining next level enquiries for usage within the GUI driven Context Based
Workflow, you should ensure that these are inserted after the default next level
enquiry. This will ensure that the "Classic" version T24 enquiries continue to
function as before. Only when enquiries are run under the GUI version of T24 can
multiple enquiries be offered as the next level down.

Validation Rules:

Either an Enquiry Name, Application Name, or the option to display text, such as a
report. See Enquiry field: NEXT.ENQUIRY or APPLICATION SEE XXX or VIEW file>ID (E.g
&HOLD&>9911223322)

EXPOSE
Field that specifies whether the ENQUIRY should be exposed or not

Validation Rules:

1. Length of 3 characters

2. Options are 'YES', 'NO', ''

3. No-input if 'PW' is not installed in the COMPANY

EXPOSE.DESC
Description of the exposed ENQUIRY.This would be updated in the DESCRIPTION fields
of both PW.ACTIVITY and EB.SERVICE,when they are newly created from the ENQUIRY

Validation Rules:

1. Length of 35 alphanumeric characters

2. If EXPOSE is set to 'YES', then this field is mandatory

3. No-input if EXPOSE is not set to 'YES'

FIELD
Defines the enquiry instruction or 'field'.

The following instructions are supported:

Instruction Action

0 Extract ID of record.

1 - 999 Extract field nnn from record.

FIELD XXX Extract current value of enquiry field XXX.

TOTAL XXX Total enquiry field XXX.

BREAK CHANGE XXX Break on change of enquiry field XXX.

BREAK LINE NN Break when line NN has been exceeded.

CALC XXX + YYY Add enquiry field XXX and YYY. CALC XXX / YYY Divide enquiry field
XXX by enquiry field YYY.

CALC XXX * YYY Multiply two enquiry fields.

CALC XXX - YYY Subtract two enquiry fields.

CALC XXX : YYY Concatenate two enquiry fields.

Instruction Action

IF AA GT BB XXX YYY Decision process. If enquiry field AA is greater than enquiry

field BB then process enquiry field XXX or process enquiry field YYY and return the
value to this enquiry field. The valid operands are EQ, NE, GT, LT, GE, LE, RG, NR,
LK, UL.

"zzzzz" Use the constant contained in quotes.

!USER Extract current user id. !TODAY Extract todays date. !SYSTEM.DATE Extract
system date. !COMPANY Extract current company id. !LANGUAGE Extract user's language
code. !LOCAL.CCY Extract local currency code.

!LAST.WORKING.DAY Extract last working day. !NEXT.WORKING.DAY Extract next working

day.

The result of the instruction is always stored in the enquiry field. The use of
spaces in the syntax of the instruction must be strictly adhered to, although the
instructions themselves can be abbreviated to a single character. eg 'BREAK CHANGE
XXX' can be specified as 'B C XXX'

Important note: Never reference a record field (0-999) during the processing of a
break. Always reference enquiry fields (FIELD XXX).

Validation Rules:

32 characters (full character set). Mandatory.

FIELD.DISP.TYPE
The format of the field can be passed to external systems, for example via the Open
Financial Service (OFS). Valid options are:

DATE, NUMERIC, ALPHANUMERIC, AMOUNT and HIDDEN

Using these values may assist in the formatting or totalling of data in external
systems. The exact interpretation depends on the external system being used and is
outside the control of T24.

NO-EDIT: Applies to APPLICATION.ENQUIRY enquiries with the TARGET.FIELD set. By

default such fields will be editable. Use the NO-EDIT property to override the
default behaviour and make the field not-editable.

This can also take values from EB.ATTRIBUTES. By this, we can specify the
formatting for fields with special rules as defined in EB.ATTRIBUTES

FIELD.LABEL
The text that will appear in the column heading for the data field defined in
FIELD.NAME.

This is use for grid style enquiries (refer to the ENQUIRY chapter of the System
Administration Guide for further details) and also the export of enquiry data via
the Open Financial Service (OFS).

FIELD.LBL
This is a language field. It accepts only text.The text specified here is displayed
as the field label. This field is associated with the fields from FIELD.NAME to
SINGLE.MULTI.

Where a field label is not required "" can be entered.

Validation Rules:

Up to 20 type A (alphanumeric) characters.

Blank field labels should be entered as "".

FIELD.NAME
Defines a name for the enquiry 'field' and is used as a reference for the current
value by other enquiry instructions.

The field name allows you identify a enquiry instruction so that its current value
can be referenced by another instruction, e.g. a break or total field. Other than
this, it is provided only for the sake of clarity.

If the name is equal to one of the field names on the FILE.NAME's Standard
Selection record then the OPERATION field is defaulted to the name of that field.

Validation Rules:

18 type A (alphanumeric) characters. (Mandatory)

FILE.NAME
This is the main file to be accessed/displayed by the enquiry system.

This specifies the main file to be processed.

The file must be a valid entry on F.FILE.CONTROL and should not contain the 'F.' or
'FXXX.' prefix.

Validation Rules:

35 type A (alphanumeric) characters. (Mandatory input)

FILE.PRODUCT
Help Text for this field is unavailable. Please refer to the T24 User Guides for
further information.

FILE.VERSION
Field to specify option of which file of the application, the enquiry can run

Can enquire on unauthorised, live, history or simulation file

Validation Rules:

Must be NAU,HIS,LIV,SIM
Must be present in suffixes of FILE.CONTROL of the application specified in
FILE.NAME

Allows LIV though not present in suffix of FILE.CONTROL

FIXED.SELECTION
Identifies the fixed selection criteria for the enquiry.

This specifies the primary selection to be performed when the enquiry is invoked.
The general format of this field is: Field.name<space>operand<space>value.

The value of the field can contain the use of a system variable (e.g. TODAY,
COMPANY, etc.).

The value of the field can contain the use of a user-defined variable (e.g.
CURRENT.CUSTOMER, CURRENT.ACCOUNT, etc.).

In order to use the value of a variable an "!" character must be used preceding the
variable name. For example, a field can be defaulted to today's date by using "!
TODAY" or the value of a user-defined variable containing a customer number by
using "!CURRENT.CUSTOMER".

For example :

3.1 FIXED.SELECTION APPLICATION.ID EQ LD

3.2 FIXED.SELECTION TRANSACTION.TYPE UL O...
3.3 FIXED.SELECTION DATE EQ !TODAY
3.4 FIXED.SELECTION DATE EQ !SYSTEM.DATE
Multiple fixed selections can be specified. The fixed selections are always
executed first, before the selection criteria entered by the user.

Validation Rules:

0 to 50 type A (alphanumeric) characters.

FIXED.SORT
Specifies the fixed sort field names.

This specifies the dictionary field names for the primary sort which will be
performed with the users selection criteria. A descending sort can be specified by
entering 'DSND' after the sort fieldname.

Examples: CUSTOMER - Ascending sort by customer.

ACCOUNT DSND - Descending sort by Account number.

Validation Rules:

1-23 type A (alphanumeric) characters.

HEADER
Static header details to be displayed at the start of the enquiry.

The static text is displayed at the start of the enquiry (not every page) and is
used for column headings, titles, etc.

Text can be specified in the format:

@(C,L)AAAA @(C,L)XXXX etc...

Multiple headings should be specified as sub-values of HEADER not multi-values.
Multi-values are used for headings in a foreign language.

Validation Rules:

42 Type A (alphanumeric) characters. The format is @(C,L)AAAA..... where @(C,L) is

the screen column and line position and AAAA is the text to be displayed.

K.TYPE
Allows further formatting of the data based on the type of field.

This formatting is performed immediately prior to display (i.e. after conversion)

CCY XXX Y Amount format using currency held in enquiry field XXX and the negative
amount format specified in Y. Current valid formats are:

E formats a -ve number as <123,456.12> M formats a -ve number as 123,456.12- B

formats a -ve number as 123,456.12db N formats a -ve number as 123,456.12 null
formats a -ve number as -123456.12 e.g. CCY CURRENCY E

TRANSLATE Translate data using 'dynamic text' mechanism.

LANGUAGE Extracts correct language value (based on users language code) from the
multi-valued field.

DATE Formats T24 internal date format (YYYYMMDD) to DD Mmm YYYY.

Validation Rules:

The valid types are: CCY XXX TRANSLATE LANGUAGE DATE

LABEL.FIELD
Specifies the enquiry field name to be numbered when a next level enquiry can be
invoked.

In order to invoke the next level enquiry the user must be able to select an item
from the enquiry screen. This entry simply specifies the enquiry field which, every
time it is displayed, will cause an incrementing number to be output. The number is
restarted for every page.

The number is displayed in column 0 on the same line as the specified enquiry
field. It occupies two characters so the first available position for data is
column 3.

Validation Rules:

11 type A. Must be a valid enquiry field name.

LENGTH.MASK
Defines output length or mask for display.

Any valid FMT operation is accepted (see INFO-BASIC manual for more detail on the
FMT instruction).

Standard formats are 30L, 19R etc. (30 bytes left justified with space padding and
19 bytes right justified).

Additional display options may be appended to the length or mask to utilise the
screen display attributes in classic T24. Options are:

^RV Use the REVERSE video attribute ^UL Use the UNDERLINE attribute ^HI Use the
HALF.INTENSITY attribute ^BL Use the BLINK attribute ^DING Sound warning beep

If no length/mask is specified then the data is output as it stands. Always specify

a length/mask when displaying data outside the enquiry page as this area is not
cleared when moving between pages.

Validation Rules:

40 type A (alphanumeric) characters.

LIAB.LC
This is a new ENQUIRY and is basically the same as the standard enquiry LIAB except
for the fact that this enquiry allows the user to include by means of a separate
Selection Parameter LC.BENEFICIARY, all the Letter of Credit transactions (both
Export and Import) where the Liability Customer is the Beneficiary Customer of the
LC (BENEFICIARY.CUSTNO).

As a general rule, the amount that will be displayed from this Enquiry will be
calculated as: LC Original Amount + (Positive) Tolerance - Drawings Amount

converted into the Local Currency.

However, if the Drawings under any LC are of the AC or the DP type and they have
not been discounted, they will still be taken into account and included in the
total balance that is displayed.

LINES.O.SIDE.PAGE
Internal field used for processing of the enquiry.

Validation Rules:

Internal field.

LINES.OSIDE.PAGE
Standard T24 numeric field.

Validation Rules:

A maximum of 10 characters may be entered.

This is a NOINPUT field.

LL.DESCRIPT
This is a multi valued field.

Validation Rules:

A maximum of 50 characters may be entered.

MULTI.FIELDS
Internal field used for processing of the enquiry.

Validation Rules:

Internal field.
NEXT.LEVEL.FIELDS
Internal field used for processing of the enquiry.

Validation Rules:

Internal field.

NEXT.LVL.FLDS
Standard T24 numeric field.

Validation Rules:

A maximum of 20 characters may be entered.

This is a NOINPUT field.

NO.MANDATORY.SELECTION
An optional field.

Allows to input values in either REQUIRED.SEL or NO.MANDATORY.SELECTION

While designing an enquiry, if the field NO.MANDATORY.SELECTION is input with a

value, then the field REQUIRED.SEL values should be removed.

If the value is not input in the field SELECTION.FLDS then the system disallows to
input in the field NO.MANDATORY.SELECTION

Validations:

Optional field

Numeric field

NUMBER.OF.FIELDS
Internal field used for processing of the enquiry.

Validation Rules:

Internal field.

NXT.DESC
This is a language field. It accepts only text.The text specified here is displayed
as the next level description. This field is associated with the fields from
ENQUIRY.NAME to NXT.DESC.

Validation Rules:

Up to 35 type A (alphanumeric) characters.

NXT.LVL.DESC
This field is a multi language field. Fields ENQUIRY.NAME to NXT.LVL.DESC form a
related multi value set. Standard T24 alphanumeric field. This field accepts only
text .The text specified here is displayed as the next level description.

Validation Rules:

A maximum of 35 characters may be entered.

OPEN.BRACKET
The selection conditions can be grouped using the fields OPEN.BRACKET and
CLOSE.BRACKET. Conditions enclosed in brackets are evaluated before those outside
of the brackets.

Validation Rules:

Optional input

Options YES or NO, Multi value, associated field

Input not allowed if the corresponding SELECTION.FIELD is not entered.

OPERATION
Defines the enquiry instruction or 'field'.

The field is defaulted if the FIELD.NAME field is populated with a field name that
is found on the FILE.NAME's Standard Selection record.

The following instructions are supported:

FIELD.NAME Dynamically locates the field reference by using FILE.NAME's

STANDARD.SELECTION record.
FIELD.NO Field reference in Numeric format. (0 - ID) (Not recommended only use
in cases where the (1-999) record is built by a routine and does not follow the
layout of the file used - see USE.FIELD.NUMBERS)
IDESC XXX Execute the I-descriptor defined in the STANDARD.SELECTION record of
the FILE, as a Type I or J item, with the FIELD.NAME XXX. The result is returned in
the same way as if the field was extracted from the record.
SELECTION XXX Return the value of the SELECTION.FIELD XXX entered in the
selection criteria.
FIELD XXX Extract current value of enquiry field XXX.
TOTAL XXX Total enquiry field XXX.
BREAK CHANGE XXX Break on change of enquiry field XXX.
BREAK LINE NN Break when line NN has been exceeded.
CALC XXX + YYY Add enquiry field XXX and YYY.
CALC XXX / YYY Divide enquiry field XXX by enquiry field YYY.
CALC XXX * YYY Multiply two enquiry fields.
CALC XXX - YYY Subtract two enquiry fields.
CALC XXX : YYY Concatenate two enquiry fields.
IF AA GT BB XXX YYY Decision process. If enquiry field AA is greater than
enquiry field BB then process enquiry field XXX or process enquiry field YYY and
return the value to this enquiry field. The valid operands are EQ, NE, GT, LT, GE,
LE, RG, NR, LK, UL. Field is Subvalued to allow the decision criteria to span more
than a single line for clarity.
"zzzzz" Use the constant contained in quotes.
!USER Extract current user id.
!TODAY Extract todays date.
!SYSTEM.DATE Extract system date.
!COMPANY Extract current company id.
!LANGUAGE Extract user's language code.
!LOCAL.CCY Extract local currency code.
!LAST.WORKING.DAY Extract last working day.
!NEXT.WORKING.DAY Extract next working day.
The result of the instruction is always stored in the enquiry field. The use of
spaces in the syntax of the instruction must be strictly adhered to, although the
instructions themselves can be abbreviated to a single character. eg 'BREAK CHANGE
XXX' can be specified as 'B C XXX'

Important note: Never reference a record field (XXX or 0-999) during the processing
of a break. Always reference enquiry fields (FIELD XXX).

Validation Rules:

Mandatory input. 32 characters (full character set).

PAGE.FIELDS
Internal field used for processing of the enquiry.

Validation Rules:

Internal field.

PAGE.SIZE
Standard T24 alphanumeric field.

Validation Rules:

Mandatory input.

A maximum of 5 characters may be entered.

These co-ordinates define the screen page which will be used by the enquiry.

These co-ordinates represent the variable portion of the screen used to display the
enquiry pages. Hence it is cleared prior to output of a page.

It does not restrict the enquiry from addressing other areas of the screen, but it
should be noted that these areas are not refreshed automatically by moving from one
page to the next.

Typically the page is used for line details leaving the remainder of the screen
available for headings etc.

Validation Rules:

XX,YY where XX defines the first line of the page and YY the last. Must be numeric,
in the range 0 - 999, and be separated by a ','. (Mandatory input)

POPUP.DROPDOWN.FLD
Specify which fields should popup a new window for dropdowns,to allow the display
of all records instead of the default of 200 records. Used for Enquiry Selection
Screen.

PROCESS.BREAKS
Internal field used for processing of the enquiry.

Validation Rules:

Internal field.

PRODUCT
Defines the Application / Product to which this Enquiry belongs eg: FX, MM etc.

Validation Rules:

Standard T24 alphanumeric field.

A maximum of 5 characters may be entered.

Must be the key to a valid entry on the EB.PRODUCT file.

REAL.TIME.FILES
This will hold the name of the files that will trigger Real Time Enquiry processing
via JOURNAL.UPDATE

Validation Rules:

A maximum of 50 characters may be entered.

Multi-value field.

REL.NEXT.FIELD
This field can be set to AND or OR and the selection conditions are grouped using
these relational operators. If the field is left blank then AND will be used as
operator. It can be used in conjunction with the OPEN.BRACKET and CLOSE.BRACKET.

Validation Rules:

Optional input

Options AND or OR, if left blank defaults to AND, Multi value, associated

Input not allowed if the next multi value set is not present

Input not allowed if the corresponding SELECTION.FIELD is not entered.

REQUIRED.SEL
Specifies for the associated SELECTION.FLDS whether selection criteria are
mandatory for the enquiry.

Certain Enquiries may require a specific selection field to be specified. This may
be in cases where the selection field calls a routine or uses concat file
processing to improve the performance of the enquiry, or simply to limit the scope
of the enquiry.

Validation Rules:

Y (Optional input)

RESERVED.1
This field is reserved for future expansion.

Validation Rules:

This is a NOINPUT field.

RESERVED.2
This field is reserved for future expansion.

Validation Rules:

This is a NOINPUT field.

RESERVED.3
Reserved for future use.

RESERVED.4
Reserved for future use.

SECTION
Where enquiry data is exported via OFS, this field is used to determine in which
area of the enquiry the data belongs.

This information is not currently used elsewhere.

SEL.CRIT
Selection criteria for the next (drill down) enquiry to be invoked. This fields
defines additional selections to be applied to the ENQUIRY for the drop-down list.

Fields ENQUIRY.NAME to NXT.LVL.DESC form a related multi value set.

Valid only when invoking another enquiry on the next level (not used when calling
an application).

If any of the 'words' correspond to an enquiry field name then the contents of the
field are used instead of the literal. Normally the 'value' corresponds to an
enquiry field but the same applies to the selection name and operand.

The value of the field can contain the use of a system variable (e.g. TODAY,
COMPANY, etc.). For example, "DATE EQ !TODAY"

The value of the field can contain the use of a user-defined variable (e.g.
CURRENT.CUSTOMER, CURRENT.ACCOUNT, etc.). For example, "DATE EQ !CURRENT.DATE"

The value of the field can be used to set a user-defined variable (e.g.
CURRENT.CUSTOMER, CURRENT.ACCOUNT, etc.). For example, "CURRENT.DATE>DATE" where
DATE is a field on the enquiry, or using a literal as the value as in
"CURRENT.DATE>20070101"

In order to use the value of a variable an "!" character must be used preceding the
variable name. For example, a field can be defaulted to today's date by using "!
TODAY" or the value of a user-defined variable containing a customer number by
using "!CURRENT.CUSTOMER".

In order to set the value of a user-defined variable a ">" character must be used
between the variable name and the variable value. For example, "CURRENT.DATE>DATE",
or "CURRENT.DATE>20070101".

To set a list of values for a user-defined variable each value must be surrounded
by "[]" characters. For example, "CURRENT.ACCOUNTS>[10010][100011][100012]"

Validation Rules:

Standard T24 alphanumeric field.

A maximum of 50 characters may be entered.

Must contain a SELECTION.FLD as defined on the related ENQUIRY record.

A valid SELECTION FLD followed by - a valid OPERATOR followed by - data in quotes.

The valid operands are EQ, NE, GT, LT, GE, LE, RG, NR, LK, UL.

Example setting : CUSTOMER EQ CUST.ID VALUE.DATE EQ V.DATE

SEL.FLD.OPER
Defines for the associated SELECTION.FLDS, which operands are allowed for the
enquiry.

This field allows the selection operands to be limited for a particular enquiry.
This may be required where the enquiry is based on one particular selection value,
for example an enquiry based on Account movements may wish to restrict the
BOOKING.DATE selection to RG or EQ.

Validation Rules:

Null, EQ, NE, GT, GE, LT, LE, RG, NR, CT, NC, BW, EW, LK, DNBW or DNEW or any
combination separated by a space. (Optional input)

SEL.LABEL
This is a language field and accepts a description. The text in this field is
displayed in the selection window. This field forms a related multi value set with
the fields from SELECTION.FLDS to REQUIRED.SEL.

Validation Rules:

Up to 20 type A (alphanumeric) characters.

SELECTION.FLDS
Specifies the selection fields to be displayed in the ENQUIRY.SELECT application.

Specify here the selection field names to be displayed in the ENQUIRY.SELECT

application. If this field is left blank then all the selection field names (from
STANDARD.SELECTION) will be displayed.

The value entered by the user in the selection fields text box should not contain
any unmatched or unpaired paranthesis(eg "(XYZ" or "XYZ)" .A matched or paired
paranathesis is acceptable for eg "(XYZ)".

Validation Rules:

1-18 type A (Alphanumeric) characters.

SERVICE
Field that contains the ID of an EB.SERVICE record. It may be an existing record.
If the record is not present, then upon authorising the ENQUIRY, a new record is
created.

Validation Rules:

1. Length of 35 alphanumeric characters

2. If EXPOSE is set to 'YES', then this field is mandatory

3. No-input if EXPOSE is not set to 'YES'

The following validations/processing is done based on the fields SERVICE and

ACTIVITY.

If both SERVICE and ACTIVITY do not exist, then a new activity is created in
PW.ACTIVITY, with the TARGET field mapped to the Enquiry and a new record is
created in EB.SERVICE with the activity added to it.

If the SERVICE is existing EB.SERVICE and ACTIVITY does not exist in PW.ACTIVITY,a
new activity is created in PW.ACTIVITY and the same is appended to the EB.SERVICE
record.
If SERVICE does not exist and ACTIVITY exists, a check is done to ensure that the
activity relates to this Enquiry, i.e. the TARGET field in PW.ACTIVITY is mapped
correctly, otherwise an error message is thrown. Then, a new EB.SERVICE record is
created with the activity added to it.

If both SERVICE and ACTIVITY exists and the activity relates to the Enquiry, a
check is done to ensure that the EB.SERVICE does not contain the ACTIVITY.ID
already.Otherwise an error message is thrown. Finally,EB.SERVICE is updated with
the activity appended to it.

SHORT.DESC
A short description for an Enquiry to make more meaningful. This description
appears in the title bar of an enquiry screen.

Validation Rules:

Standard T24 alphanumeric field.

A maximum of 35 characters may be entered.

SINGLE.MULTI
Specifies that the instruction should be processed for every multi/ sub-value
occurrence.

If 'M' is specified the instruction will be processed for every multi-value and
sub-value occurrence within the data record. All multi-value/sub-value fields are
taken to be associated and aligned accordingly on the screen.

Validation Rules:

Either S or M (single or multi). If null is specified then S is used as the

default.

SMS.ABORT
Flag to indicate if the enquiry is to be aborted when the first SMS violation is
recorded.

The enquiry system will read and SMS verify all records it selects. This can be
very time consuming if all the records fail the SMS checks. Consequently this flag
enables the enquiry to abort at the first SMS violation encountered.

Validation Rules:

Can be either Y or No. (Optional Input).

SMS.APPLICATION
Defines the name of the application to be used for SMS verification.

If an enquiry is based on a "NOFILE" application the only SMS verification which

can take place is based on 'linked' data defined in the conversion field. In order
to supplement these checks you can define, here, the name of the application whose
SMS rules should be also be used.

Validation Rules:

Up to 24 type A (alphanumeric) characters. (Optional Input).

The name entered must be the key to a record on FILE.CONTROL.

SMS.ID
The enquiry field which holds the id of the record to be read from SMS.APPLICATION.

Each time this enquiry field is processed then the record from SMS.APPLICATION will
be read and subsequently verified for SMS. If it does not pass the SMS check then
the current record will not be displayed.

Validation Rules:

Up to 18 type A (alphanumeric) characters. (Optional input).

SPOOL.BRK.FLD
Specifies fields which on change of value between pages, will cause a new spool
record to be generated for reports.

When enquiries are used to produce reports (via ENQUIRY REPORT application), the
enquiry will be produced as a single report.

Certain reports may be required to produce output for particular Customers and
Accounts, where it would be advantageous to create a separate report for each
Customer or Account. By specifying the relevant field name here, if the value
changes between pages, a new spool record will be created.

This will primarily be used to allow Enquiries to be produced for a Customer so

that the output can be Held if required, in the same way as output from the
delivery system.

Validation Rules:

Up to 18 'A' alphanumeric characters. (Optional input)

Must be defined previously on the Enquiry as a FIELD NAME.

STATIC.FIELDS
Internal field used for processing of the enquiry.

Validation Rules:

Internal field.

TARGET.APPLICATION
Applies to application enquiries (see ATTRIBUTES/APPLICATION.ENQUIRY). Specifies
the application to be operated on by the enquiry.

TARGET.FIELD
Applies to application enquiries (see ATTRIBUTES/APPLICATION.ENQUIRY). Specifies
the field name on the TARGET.APPLICATION that the field should map to.

TOOL.ID
The ID of a BROWSER.TOOL record which will be displayed on the enquiry window in
the toolbar.

Validation Rules:

Must be a record in BROWSER.TOOLS.

TOOL.ITEM
The item (command) to be run when the Browser tool on the toolbar is selected.
If this is not specified then the ITEM defined in the BROWSER.TOOL record which
will be used.

If a JavaScript function is not supplied then the 'docommand' JavaScript function

will be used.

Validation Rules:

Up to 35 'A' alphanumeric characters. (Optional input)

TOOL.TEXT
The text to be displayed on the Browser tool on the toolbar.

If this is not specified then the TEXT defined in the BROWSER.TOOL record which
will be used.

Validation Rules:

Up to 35 'A' alphanumeric characters. (Optional input)

TOOLBAR
Allows a custom toolbar to be displayed when enquiry results are displayed.

This toolbar takes precedence over defined tool items.

Validation Rules:

Must be a valid BROWSER.TOOLBAR record.

TOTAL.FIELDS
Internal field used for processing of the enquiry.

Validation Rules:

Internal field.

TYPE
Allows further formatting of the data based on the type of field.

This formatting is performed immediately prior to display (i.e. after conversion)

CCY XXX Y Amount format using currency held in enquiry field XXX and the negative
amount format specified in Y. Current valid formats are:

E formats a -ve number as <123,456.12> M formats a -ve number as 123,456.12- B

formats a -ve number as 123,456.12db N formats a -ve number as 123,456.12 null
formats a -ve number as -123456.12 e.g. CCY CURRENCY E

TRANSLATE Translate data using 'dynamic text' mechanism.

LANGUAGE Extracts correct language value (based on users language code) from the
multi-valued field.

DATE Formats T24 internal date format (YYYYMMDD) to DD Mmm YYYY.

Validation Rules:

The valid types are: CCY XXX TRANSLATE LANGUAGE DATE

USE.FIELD.NUMBERS
Specifies whether field numbers entered in the OPERATION field should not be
converted to the relevant field name.

Some enquiries may use a specified FILE.NAME for selection purposes, however a work
record is constructed using a conversion routine in the body of the enquiry.
Enquiry will usually attampt to convert a field number entered in the OPERATION
field to the correct field name for the FILE.NAME, so that the enquiry is
compatible with future file layout changes. However where the conversion routine
builds a work record, this layout is fixed and should not be converted to the field
name, as the layout may be entirely different.

In order to suppress the conversion of the number entered in OPERATION to a name, a

value of Y should be entered in this field. This will leave the field OPERATION as
entered. Null and NO are treated in the same way.

Validation Rules:

Optional Field. May be Y or NO.

T24 Common HelpText Fields