Browser Enquiries
Browser Enquiries
Browser Enquiries
User Guide
No part of this document may be reproduced or transmitted in any form or by any means,
electronic or mechanical, for any purpose, without the express written permission of TEMENOS Holdings NV.
Table of Contents
Overview.................................................................................................................................................. 4
Accessing Enquiries............................................................................................................................. 4
ENQUIRY selection screen .............................................................................................................. 4
ENQUIRY Command Buttons .......................................................................................................... 7
Enquiries.................................................................................................................................................. 7
ENQUIRY Functionality ....................................................................................................................... 7
Drilldown Facilities............................................................................................................................ 7
!CURRENT.XXXX variables ........................................................................................................... 11
Favorite Enquiries .............................................................................................................................. 15
Adding user favourites.................................................................................................................... 17
Enquiry wild card ............................................................................................................................ 20
Context Sensitive Enquiries ............................................................................................................... 21
Auto-launching Context Enquiries .................................................................................................. 22
Drop down list boxes.......................................................................................................................... 23
Fast Path ENQUIRY .......................................................................................................................... 24
Example ......................................................................................................................................... 29
Secure Document Download ............................................................................................................. 32
Pre requisites ................................................................................................................................. 33
Enquiry Drill Down Configuration ................................................................................................... 34
Browser Web Server Configuration:............................................................................................... 36
channels.xml .................................................................................................................................. 37
TC Server Configuration................................................................................................................. 38
Custom Java Class ........................................................................................................................ 39
PDF Document Merging ................................................................................................................. 40
Pre requisites .............................................................................................................................. 40
Enquiry Setup ............................................................................................................................. 40
ARC-IB set up ......................................................................................................................... 41
PDF Merging Software ............................................................................................................... 43
Installing PDFBox ....................................................................................................................... 43
Sample FileInputStreamProvider................................................................................................ 43
PDF Merge Functionality ............................................................................................................ 46
Hyperlinks .......................................................................................................................................... 48
Reports .................................................................................................................................................. 53
Report Enquiry ................................................................................................................................... 53
Viewing XML generated ENQUIRY.REPORTS in Browser............................................................... 60
Architecture/Design ............................................................................................................................... 62
Creating and Modifying Enquiries ...................................................................................................... 62
The ENQUIRY Designer ................................................................................................................ 62
Data Selection .................................................................................................................................... 64
File Name ....................................................................................................................................... 64
Predefined Selection/Sort .............................................................................................................. 64
Limiting the Selection fields ............................................................................................................ 65
Modifying Fields and Data ................................................................................................................. 66
Field Names ................................................................................................................................... 66
Heading .......................................................................................................................................... 67
Operation ........................................................................................................................................ 67
ENQUIRY Display .............................................................................................................................. 68
Field Display Types ........................................................................................................................ 68
Using Value and Progress bars ..................................................................................................... 69
Legends .......................................................................................................................................... 70
Using Images with the Image Management module ...................................................................... 71
Using Graphs ................................................................................................................................. 77
Enquiry Attributes ........................................................................................................................... 93
Browser Tool Bar............................................................................................................................ 95
Popup Dropdown - Allow Paging of Browser Dropdown Results .................................................. 97
Collapsible ENQUIRY Columns ..................................................................................................... 99
Display Sections .............................................................................................................................. 106
Footers ......................................................................................................................................... 106
Caption ......................................................................................................................................... 106
Security Management System ......................................................................................................... 107
ENQUIRY Access ........................................................................................................................ 107
Data Access ................................................................................................................................. 108
Other ENQUIRY SMS Settings .................................................................................................... 108
Formatting Existing enquiries for Browser ....................................................................................... 109
Original Desktop ........................................................................................................................... 109
Browser ........................................................................................................................................ 110
Total Section in GLOBUS Desktop .............................................................................................. 111
Unmodified section in Browser ..................................................................................................... 111
Overview
Enquiries are the means of interrogating the information held in the T24 database, by means of
statements that extract the database records according to specified criteria. These statements are
extremely versatile, and can be used to access and manipulate data, or can be expanded and
combined to create a flexible and powerful data presentation in the form of either a screen or report.
Accessing Enquiries
ENQUIRY processing in the T24 Browser invokes an ENQUIRY selection screen to run in a separate
window; multiple enquiries may be displayed simultaneously in different Browser windows.
• Command Line
• Context ENQUIRY
• Drilldown from another ENQUIRY
• Dropdown from a contract
• T24 Menu
Selection criteria for an ENQUIRY is entered via the ENQUIRY Selection screen. Once invoked, the
selection criteria will appear in a separate window.
Modify the selection criteria as required, or accept the default list that comprises of the entire file. T24
remembers the last previously used selection.
Each selection is composed of a field (that must be defined as a selection field on the ENQUIRY and
hence displayed in the list of fields), an operand, the selection data and sort criteria.
ENQUIRY results can be exported in a number of different formats for use with third-party reporting
products such as Crystal Reports and Excel. The formats supported are Comma Separate Value
(CSV), HTML, XML.
Once the selection criteria has been entered and the ENQUIRY launched, both the selection criteria
(only the fields that were filled in) and the ENQUIRY result are displayed in the same window. If no
selection criteria is specified, then the criteria section will not appear at the bottom of the ENQUIRY
result screen.
The ‘hide options’ gives the facility to sort the data by additional criteria. The ‘clear selection’ will
remove any already specified data.
The data to be retuned to the user can be manipulated by selecting the drop down operands next to
any field selection.
Below is the conversion table for the display operand and the command operator. For "Equal to" you
can use the operand "EQ" and so on.
To view the entire list ENQUIRY selection fields, select the “View Full Selection” button.
To refresh the results click on the double arrow icon to the left of the “Previous Page” button. This will
re-run the ENQUIRY. To automatically refresh the ENQUIRY, enter the number of seconds for the
auto-refresh in the box at the top of the page and press the start auto-refresh button ( ). The
seconds will then count down before the ENQUIRY is refreshed.
To print the results click on the “Print View” button. This will use the standard Browser print
functionality to print the contents of the page.
The Auto Refresh field can be set to a number of seconds that you would like the ENQUIRY to be
refreshed automatically. The field then counts down before refreshing the display.
Enquiries
ENQUIRY Functionality
Drilldown Facilities
Once an ENQUIRY result has been displayed the user may be able to access more details on each
row of the results by selecting a further Drill down option. This will run a further ENQUIRY based on
the contents of the row.
More Details
In the example above the user is presented with the four drilldown options set up in the ENQUIRY
record. In this instance the record is SC.PORT.HOLD.SUM; the drilldown options are as follows:
Images specified in the Next Description field of the ENQUIRY record must be placed on the web
server in the directory: -
BrowserWeb/plaf/images/<skin>/ENQUIRY/drilldown
On selecting one of the drilldowns, e.g. “List of trades”, a further ENQUIRY is run against the user
information found in that row of the results. The ENQUIRY that will be run, and the actual fields used
from the row of data, is set up in the ENQUIRY record. In this instance the option “List of trades” runs
the ENQUIRY “SC.POS.DET2” using the selection criteria “REF.NO EQ @ID”. To return to the
previous drilldown screen press the ENQUIRY name link at the top of the page.
A default drill down option in the shape of a spyglass will also be available to the user. When present,
the spyglass icon will be found to the left of each row of data.
On clicking the spyglass, the ENQUIRY will then take a specific ID, from the row in question, and
invoke the record linked to that ID in separate window.
!CURRENT.XXXX variables
In addition to the system common variables that can be used in ENQUIRY and VERSION there is a
feature where users can populate a variable of their own and use it later. There are also a series of
new system variables and a much wider option for users to create and use their own.
CURRENT.XXXX where XXXX can be any value that you feel is applicable, the important part for the
system to recognise them is the 'CURRENT.' prefix. The same use is made of these in ENQUIRY &
VERSION. Setting them is done by using them without the ! prefix and reading the content by using
the ! prefix. The variables can be set with values from an existing Enquiry field or with a literal value
Example:
TEST.DATE EQ !TODAY
TEST.NAME EQ !CURRENT.NAME
TEST.TEXT EQ !CURRENT.TEXT
TEST.CCYS EQ !CURRENT.CCYS
Creation of a !CURRENT.TEST1
Creating a second enquiry. When this enquiry is run, the system will search for !CURRENT.TEST1
variable, (highlighted) set by the running of the first enquiry, and display the results.
AUTOM.FIELD.NO = DEBIT.THEIR.REF
AUT.NEW.CONTENT = !CURRENT.TEXT
Above shows how the VERSION record fields should be populated using the new variable data.
Note: You can set the Enquiry to drill down to both another Enquiry and a Version on the one screen.
CURRENT.CATEG>POST.CODE
ACCOUNT,TEST3 I F3
To view the content of any CURRENT.xxxx variables there is an ENQUIRY called USER.VARIABLES
which displays the current content.
Note: The values of user set variables are empty at initial login and cleared on exit so this Enquiry will
only display values set during the current login session.
Favorite Enquiries
The application EB.SELECTION.FAVOURITES can be utilized by the user and system
administrators to save specific enquiry’s based on selection criteria in the form of a Favourite
ENQUIRY.
Depending on the structure of the record ID these saved records can be system wild (available to
everyone) or USER specific.
Only when this user is logged onto the system can these favourite enquiries be available under the
headings CATEG 1001 USD and CATEG 5001 GBP as shown below.
A system wide favourite can be created with the following ID ACCT.BAL.TODAY as shown below.
When the same USER logs in the system wide favourite is show.
However, in this case an X is not displayed next to the name so cannot be removed.
Once an ENQUIRY has been launched the USER can create Favourite specific enquiries.
If the favourites function is not required in a specific Enquiry, this can be disabled by setting the
ATTRIBUTES field in ENQUIRY to NO.ENQUIRY.FAVOURITES. See below example of where this
attribute has been set.
In the application BROWSER.PREFERENCES an alternative wild card can be specified in the field
ENQ.WILDCARD.
The option to specify either a value of % or * gives an alternative to the standard ‘…’ when used in an
ENQUIRY as seen below.
Context sensitive enquiries run T24 enquiries. They supply the ENQUIRY with context sensitive data
obtained from the contract currently being edited, replacing the need to specify ENQUIRY selection
criteria via the ENQUIRY selection screen.
If a Context-sensitive ENQUIRY is linked to a file, it appears in the drop-down ‘ENQUIRY’ menu and
can be selected from there.
When launched, the results of the ENQUIRY will be displayed in a separate window.
Some context-enquiries are set up to auto-launch another ENQUIRY, application or version when
triggered. These Context-Enquiries may be triggered in a number of ways: by opening a particular
application, version or ENQUIRY, by entering information on a particular field, or by committing a
contract. In the above example, when information is entered on the Mnemonic field, this tells the
system the Customer’s ID number, so the system can then find out information about all that
customer’s accounts with the bank, as well as listing all the share portfolios linked to that customer.
This information is entered into an ENQUIRY which appears on the screen. When a Context-
ENQUIRY is auto-launched, the ENQUIRY result will be displayed in a new window.
A pop up list is available on any field that has a related file (see STANDARD.SELECTION),
indicated by a down arrow icon ( ). Clicking this button will launch the list in a new window.
Selection may be carried out where the drop down list has been initiated when editing the field. The
selection is based on the first selection field of the ENQUIRY (which is usually the key to the related
file, but may be based on the mnemonic). The selection uses the LK option found in ENQUIRY. By
default the processing appends “…” to the end of the selection if the “…” characters have not been
defined.
Technical Note
The fields to be shown in the drop down list are defined as an ENQUIRY, whose key is
APPLICATION,VERSION-LIST, e.g. CUSTOMER,CLIENT-LIST. If this ENQUIRY is not found, the
ENQUIRY whose key is APPLICATION-LIST, e.g. CUSTOMER-LIST is used. If neither of these is
found, the default ENQUIRY for the live file is used, i.e. %APPLICATION.
The ACCOUNT and CUSTOMER lists that are released with T24 require a selection to be defined,
and this selection is based on the mnemonic. Duplicate this requirement by making the selection field
mandatory when defining your ENQUIRY.
A check box and a status icon are presented against each row, with fast path actions displayed in a
combo box with a Go pushbutton. As well as selecting individual items from a displayed list, there is a
"select all" and "de-select all" items checkbox. Selecting multiple rows and clicking on the appropriate
fast path action will run the function against each row. The result of the fast path action is indicated on
the status icon of each row showing whether it is successful or not. The actual result text of the fast
path action is displayed as tooltip. To view, place the mouse over the fast path status icon .
In order to use the Fast Path ENQUIRY function, the user needs to specify the ATTRIBUTES field in
the ENQUIRY record as ‘FASTPATH’.
The options in the combo box are defined as Drilldown options. See the Drilldown Facilities section
above how to set up drilldown options.
Here is an example of how to set up two drilldown options (See and Authorise) in the ENQUIRY
record for SECTOR.
This is to allow a user to edit fields on the ENQUIRY selection result. A User is able to edit fields on
various records on an ENQUIRY, and by selecting ‘Edit this record’ on the combo box and click on
the Go button; it performs the “Edit” function of all the selected items consecutively.
In order to use the Editable ENQUIRY function, you need to setup the following:
• make sure Fast Path ENQUIRY function is enabled (see Fast Path ENQUIRY section).
• specify the FIELD.DISPLAY.TYPE field in the ENQUIRY record to be ‘EDIT’ for all the all the
fields to be editable.
You can only edit a file which is fully authorised. If you attempt to edit a file using this method which
has a record in an unauthorised state then the system will return the error code EB-
EDIT.ENQ.ID.ON.NAU.
Example
This example demonstrates how the Editable ENQUIRY works. It will edit the Description field on the
SECTOR-LIST ENQUIRY and Authorise it.
Select the record’s checkbox and select ‘Edit this record’ in the combo box and click the Go
pushbutton.
Once it is completed, log out and login as a different user in order to Authorise it.
Load up ENQ SECTOR-LIST; notice that the Description field is still displayed as Agriculture1. This is
because the ENQUIRY is displaying only live records.
Now Authorise the record by clicking on the record’s checkbox, select ‘Authorise’ combo option and
click the Go pushbutton.
After the record is authorised, load up ENQ SECTOR-LIST and you will see the Description has
changed.
Pre requisites
The Secure Document Download facility is dependent on three main components of the T24
architecture. The following table shows the MINIMUM release levels that must be available before the
Secure Document Download feature can be used:
Setup Overview
Before a successful Download can be made via Browser the following components must be
configured correctly:
TC Server Configuration
The document download listener must be defined and the custom stream provider (java class).
The ENQUIRY application can allow the user to download documents kept on the document
repository by using a simple syntax beginning with the keyword “DOC” which will identify this as a
secure document download in the ENQUIRY.NAME field. This is then followed by the Document ID,
and the document location within the repository.
In the above example the ENQUIRY.NAME field knows that the download function has been specified,
that the document to be downloaded is called ‘testing.pdf’, and is kept in a sub-location called ‘pdf’,
and that DEBUG error handing is active.
The sub-location can be used to help organise documents in logical patterns e.g. docs, pdfs, images
etc
To help with any problem investigation the command “DEBUG” can be used at the end of the syntax,
this is optional in the syntax. This command should be used during implementation so if the document
cannot be found/downloaded then the resulting window will contain important information that will help
with the resolution.
The following are examples of valid document down load drill-down definitions:
DOC myID docs DEBUG
DOC myID docs
DOC myID DEBUG
DOC myID
When defining the download drill-down it may be desirable not the explicitly set the name and sub-
directory of the document. To avoid this, standard drill-down notation can be used to specify column
data. For Example; if the enquiry data contains a defined column that holds the Document ID (COLID)
and another defined column that holds the sub-location (COLSUB). Then the following download drill-
down definitions can be specified:
DOC COLID COLSUB DEBUG
DOC COLID COLSUB
DOC COLID DEBUG
DOC COLID
To enforce security the COLID and COLSUB enquiry columns can be hidden from the user using
standard column hiding techniques provided by the ENQUIRY system.
For multiple downloads the ENQUIRY.NAME field can be expanded, when more than two options are
nominated a dropdown list is provided, with less than two option hyperlinks are provided to activate
the secure downloads.
Below is an enquiry with three different types of document in three different directories all of which
have been launched from the dropdown list from the ENQUIRY results page.
channels.xml
In channels.xml file ensure that the Document Service Channels that was specified in
browserParameters.xml has been defined, an active port and IP/host name has been assigned.
TC Server Configuration
In tcserver.xml file in the conf directory, create a listener service with a port number matching the
nominated port in the web server channels.xml file.
A download path has been created and points to the location of the document repository.
And that the Stream Provider has a relevant java class in the TCServer ext directory, in this case that
java class is called FileInputStreamProvider.
An upload path can also be nominated but currently the upload functionality does not exist for
BROWSER.
AbstractInputStreamProvider
com.temenos.tocf.tcs.API.AbstractInputStreamProvider
The downloadPath is the value specified in the <DOWNLOAD_PATH> of the defined listener in
tcserver.xml.
The Param1 is the value that is defined as the sub-location of the drill-down definition
The Param2 is the value that is defined as the document ID of the drill-down definition.
Sample FileInputStreamProvider
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import com.temenos.tocf.tcs.API.AbstractInputStreamProvider;
}
}
Pre requisites
The following table shows the MINIMUM release levels that must be available before the Multi-Select
PDF Merging Secure Document Download feature can be used:
Enquiry Setup
To be able to use PDF merging the previous set up for Secure Document Download must be followed
and the ENQUIRY being used for PDF merge must have the MULTI.DOWNLOAD in the
Attributes field set.
ARC-IB set up
ARC-IB automatically strips any ENQUIRY toolbars, so in order to execute the merge download a
BROWSER.TOOLS record will need to be included in the ENQUIRY in the field Toolbar.
Below is the default record (customizable) of a BROWSER.TOOLS record required to trigger the
download functionality.
Here BROWSER.TOOLS record has been attached to the ENQUIRY in the Toolbar field.
Here in ARC-IB the Download button is displayed and is used to trigger the merge download
functionality when records have been selected via the check boxes.
The Download button is available in ARC-IB with striped toolbars functionality still active.
PDF merging software is not developed or distributed by TEMENOS. Third party software should be
installed as required. The following working example uses PDF merging libraries provided by
‘PDFBox’. PDFBox can be obtained from:
http://www.pdfbox.org/
NOTE: Temenos is not responsible or does not provide support for third party software used
for PDF merging.
Installing PDFBox
NOTE: the above command is ONE LINE; do not split over two lines.
Sample FileInputStreamProvider
The merge logic should be added in the FileInputStreamProvider that is installed in to the tcserver/ext
directory, below is an example of java code that will support the merge and single document download
functionality.
Please note that this is a simplistic example any error handling and customised changes should be
implemented as required. It should be noted that the code below should not be used on a multi-user
environment. Appropriate logic must be added to create unique file name for the merged PDF. Also
these should be deleted after they have been downloaded.
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import com.temenos.tocf.tcs.API.AbstractInputStreamProvider;
import org.pdfbox.exceptions.COSVisitorException;
import org.pdfbox.util.PDFMergerUtility;
public class FileInputStreamProvider extends AbstractInputStreamProvider
{
// Variable to hold the download location
private String ivDownloadPath = "";
// Delimiter character used for parsing multi-download items
{
bMultiDownload = true;
}
return bMultiDownload;
}
private File mergeMultiDownloadPDFs(String subDir, String docID)
{
File f = null;
String mergedDocName = "Merged.pdf"; // Unique File NAME MUST be created
String[] docIDitems = docID.split( ID_DELIMITER );
String[] subDiritems = subDir.split( ID_DELIMITER );
// Create the PDF Merger Utility
PDFMergerUtility PDFMU = new PDFMergerUtility();
// Set the destination file name
PDFMU.setDestinationFileName(ivDownloadPath + "/" + mergedDocName);
// Begin at index 1 to ignore the [[_MULTI_DOWNLOAD_]] flag
for ( int i = 1; i < docIDitems.length; i++ )
{
File fi = null;
String basePath = ivDownloadPath;
if (!subDiritems[i].equals("n-a"))
{
fi = new File(ivDownloadPath, subDiritems[i]);
basePath = fi.getAbsolutePath();
}
String sDocId = (String) docIDitems[i];
fi = new File(basePath, sDocId);
if ( ! fi.exists() )
{
System.out.println( "Unable to find File to Merge List: " +
fi.getAbsolutePath());
PDFMU.addSource(fi);
}
else
{
System.out.println( "Added File to Merge List: " +
fi.getAbsolutePath());
PDFMU.addSource(fi);
}
}
try
{
// DO the Merge
PDFMU.mergeDocuments();
// Now read this single file and return it
f = readDocFile("", mergedDocName);
}
catch(IOException x)
{
// Handle exception
System.out.println( "IOException : " + f );
System.out.println( "IOException : " + x.getMessage() );
}
catch(COSVisitorException COSx)
{
// Handle exception
System.out.println( "COSVisitorException" );
}
return f;
}
}
The following ENQUIRY screen shows an example of multi-download enquiry that can be used to
select, merge and download PDF documents. In this case the Legal.Doc.Name field in the
CUSTOMER application contains the name of the PDF document. An enquiry drill down has been
defined to reference it (see Enquiry Drill Down Configuration above).
Here the ENQUIRY displays a number of tick boxes which can be used to determine which PDF
documents are to be merged, the top tick box will trigger a ‘select all’ or ‘remove all’ behaviour.
Once selections have been made, the documents can be downloaded by clicking the Download icon
or the BROWSER.TOOL icon if you are using ARC-IB. Selected files will be download as a
single file in a separate window.
If the User just wants to down load a single document the normal hyperlink option can be used.
Hyperlinks
This section describes an example setup for applying hyperlinks to enquiries. In this example the
hyperlink is added to a local reference field in order that the hyperlink content is meaningful.
LOCAL.TABLE
Create a LOCAL.REF.TABLE for the application in which to apply the local table
Results from the above enquiry displaying hyperlinks in the Hyperlink column
Reports
Report Enquiry
Enquiries can be defined as a report and printed on-line or during the end of day. When defining the
ENQUIRY (report) the PAGE.SIZE in ENQUIRY should be set to the size of the report page.
Tip:
• There is no restriction on width or depth of report. All other aspects of the definition are the same.
To run the report a record must be entered in the application ENQUIRY.REPORT. This will define
any selection criteria, the REPORT.CONTROL id for printer routing, the default header definitions
etc. See ENQUIRY.REPORT for more details. To run the report during the end of day the id of the
ENQUIRY.REPORT record should be entered in the DATA field of the BATCH record for the job
EB.PRIN preceded by ENQ.
Set up,
Step 1
This example set up will take the ENQUIRY record ACCOUNT-LIST as an example.
No changes are necessary to the ENQUIRY record in order to allow XML reporting.
Enquiry Record
Step 2
Create two files in the account .run directory.
First XML.LOCAL (you can name the file anything you like)
And in that file create another file TRANSLATE.xls you can name the file anything you like but it
should be an .xls type file)
These files will be used to store an error messages that occur in any XML reporting.
Step 3
Create a record in the REPORT.TRANSFORM application, here we have called ours
XML.TRANSFORM, this will later be added a REPORT.CONTROL record.
Note that the fields Trans.Path, Transname.1, Report.Dest.1, Error.Dest.1 require the files created in
Step 2.
XML.TRANSFORM record.
Step 4.
The REPORT.CONTROL record indicates which DE.FORM.TYPE to use (See FORM.NAME field in
step 5 screen shot.
The corresponding DE.FORM.TYPE record must have the PRINTER.ID field set to HOLD or else if
it is left blank the PRINTER.ID attached to the USER will be used (and if that is set up incorrectly
Browser will produce a “Unable to write banner “ FATAL.ERROR)
The FORM.DEPTH field must be set high to avoid hidden characters in the XML report (or page breaks
shown as hidden characters are automatically inserted according to the form depth set here).
The OPTIONS field in DE.FORM.TYPE must also be set to NHEAD for XML reports, this will suppress
the header in the XML record.
DE.FORM.TYPE record.
Step 5.
For this example we create a new record in the REPORT.CONTROL application called ACCOUNT-
LIST.
Here the DE.FORM.TYPE record XML is used in the field FORM. NAME
Step 6.
A new record in ENQUIRY.REPORT application called ACCOUNT-LIST is created detailing the
Enquiry record to access, what Reporting rules are going to be applied to it and its Output format.
Once this record is completed and authorised, an XML report can be produced form this record by
using the Verify function.
Opening the new file in the &HOLD& file with Word pad displays the Enquiry in XML format.
Multi-values are supported in the generated XML (but not sub-values) and are indicated in the field
definitions, as in the above example, by the repeatable label being set to TRUE. The actual fields will
then be repeated in the data.
Important Note:
In order to use the new functionality the application the Application the Enquiry Report is based on has
to have their STANDARD.SELECTION record rebuilt.
To rebuild a STANDARD.SELECTION record open the relevant record and populate the
Rebuild.Sys.Flds field with Y then authorise the record.
The ENQUIRY.REPORT for the related record will need the following set up:
The field ADDITIONAL.DATA will require the path location of the style sheet; note that the
BrowserWeb is considered to be the top-level directory thus the shorter entry.
The field OUTPUT.FORMAT will need to be XML
In order to view the XML report simply verify the record in Browser, an XML record will be created in
the &HOLD& file automatically and the style sheet will be populated and launched.
Architecture/Design
Creating and Modifying Enquiries
There are two ways of creating enquiries:
The ENQUIRY Wizard – This is a toolbox plug in (see T24 Toolbox User Guide) that assists in the
creation of simple list enquiries
The ENQUIRY file holds the definition of the ENQUIRY, the file to be selected, the fixed
selection/sort criteria, the header details, the data to be displayed and the next ENQUIRY to link to (if
required). When the application ENQUIRY,DESIGNER is activated, it auto-launches the Designer
Form where all settings will take place.
ENQUIRY fields
Data Selection
File Name
The ENQUIRY system is designed for single file access with related data being extracted via data
from the main file. Simply, this means a main file is read 'sequentially' and data presented from the
source record and/or associated check-files.
Predefined Selection/Sort
The user may want the ENQUIRY to run with pre-set conditions. This section helps to specify default
records selection and sorting mode. The ENQUIRY designed in the screenshot below will select
accounts that:
The result:
• “Op” column is to specify the operators that may be entered by the user.
• “Mandatory” column specifies whether the field selection will be mandatory.
By selecting the fields at design time, the selection criteria presented to users is modified.
Field Names
The 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 an 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 FIELD.NAME is equal to one of the field names on the FILE.NAMES Standard Selection record,
the OPERATION field is defaulted to the name of that field.
Heading
Define the text that you want to use as the column heading here.
Operation
The OPERATION defines the ENQUIRY instruction or ‘field’, and covers four broad areas:
ENQUIRY Display
Field Display Types
There are various options for the FIELD.DISPLAY.TYPE for ENQUIRY fields:
IMAGE To Display images This display type accepts three forms
of data as its argument:
1) An image path
i.e. c:\images\quote.gif
2) An IM.DOCUMENT.IMAGE
reference, i.e.
IM0312300089
3) A key to a table, i.e. 100057
BAR Displays numeric values as a Simply set the display type of the field
self scaling bar. Negative to BAR.
values are supported
CLASS-POSNEG
The following example illustrates the display of bars with positive and negative values.
Auto scaling is a configurable value that can be anything not just percentages. A Tool tip for each bar
displays the values when the mouse is moved any where on the associated bar: -
Legends
The field display type LEGEND allows the display of a legend in the form of a coloured icon square.
The following example illustrates the field FIELD.NAME set to BOX, and FIELD.DISP.TYPE set to
LEGEND. These represent icon squares in the bar chart and a cycling palette of colours based on the
Style Sheet for each bar.
The field GB FIELD.LABEL sets the header definition. Here client labelling is set with open and close
brackets
LEGEND
The following example displays the legend in the left hand column: -
Legend display
Setting the display type of an item to IMAGE allows direct interaction between Browser, ENQUIRY
and Image Management. There are two uses of the image management module with browser and
ENQUIRY.
Specifying a key to IM.DOCUMENT.IMAGE when the display type is IMAGE will include the image
in that column of the ENQUIRY.
More flexible is the ability to define the display type of IMAGE for any data – the cross reference tables
in the IM module are used to attempt to retrieve an image – where multiple images are found, only the
first is shown. E.g. simply use an ENQUIRY field of customer number and set the display type to be
IMAGE – THE ENQUIRY processing will attempt to find any images for that customer number.
In order for the images to be correctly displayed in the browser, it is vital that the full path specified is
accessible by the client PC, or where a relative path is used, that the path is accessible from the web
server.
Here, an ENQUIRY has been modified to show an icon in place of text for the Info column. Here, a
relative path is created as a text manipulation, and the final ENQUIRY field set to a display type of
IMAGE, e.g. a relative path used could be:
plaf/tec/warning.gif
As for image management images being used in ENQUIRY, the relative path must be accessible to
the web server. If in doubt, experiment with static html pages first.
The PIELABEL and PIE display types are used to define the text labels for the items and the values of
the item. The Browser will adjust the display based on the percentage of the overall total. Any negative
values added to the pie chart display are ignored. As an example we take a simple balance
ENQUIRY that displays only 2 columns, defined as:
Drilldowns function by clicking on the segment – the drilldown option may be modified using the
combo box.
For Bar charts the set-up is exactly the same as for pie charts – currently the default display type of a
chart is pie chart, and the user may modify the display at run time. New default display types will be
added in future releases.
NB - the default setting in browserParameters.xml is to display pie charts, bar graphs and graphs in
SVG (Structured Vector Graphics) format. You will need to install a SVG viewer for your browser in
order to view these items.
It is also possible to display charts and graphs in PNG format which negates the need to have a SVG
viewer installed. This is configured in browserParameters.xml and web.xml – please refer to the
Browser Installation and Configuration User Guide for further information
With both display types, please ensure that numeric values returned from enquiries are not ‘masked’
with currency information or thousand separators. In the event that numbers are masked they will not
be understood correctly and an error displayed.
It should be noted that SVG offers richer functionality, and that not all of the features available in SVG
are available with .png images e.g. multipie charts, drilldowns and other interactive features available
in SVG.
In addition to the above functional differences between the two formats, there are slight differences in
the look and feel. These include the following: -
• Colour of different bars in the same series doesn’t vary in .png images
• Cannot specify Margin widths plus Legend and Title locations in .png format
• Grid lines are dashed and more numerous in .png
• Pie chart segments labelled with a text box attached by a string in .png images
Using Graphs
To display a graph, at least one GRAPHX and GRAPHY display type is required. The graph display
handles multiple series display, and where only a single GRAPHX item is used, each series will use
the first graph x series.
Using Graphs
Using Graphs
Using Graphs
Here 3 series of data are defined (AVG.BALANCE, CR.AVG.BAL and DR.AVG.BAL) all using the
same X series data. This ENQUIRY produces the following:
Using Graphs
EB.ENQUIRY.GRAPH
The application EB.ENQUIRY.GRAPH allows the user to create a various types of graphs.
To create a graph using the application EB.ENQUIRY.GRAPH the following procedure needs to be
used:
Search under the option enquiry SEARCH LIVE FILE
Set ATTRIBUTES to equal to ALLDATA, ensure the enquiry to be used has the required fields set to
ALLDATA, to enable the graph to select all the data required to build the graph accurately. The
example below is based on the enquiry account.
Open the application EB.ENQUIRY.GRAPH
Select the desired enquiry that a graph is required for display.
Set axis and any legends to display the required data
Run the enquiry.
The enquiry account has had the field set to ALLDATA in the field ATTRIBUTES, to ensure all the data
is selected in the building of the GRAPH.
We can see from the above drop down that the enquiry account has been included in the selection of
ALLDATA based enquires.
If we now look at the application EB.ENQUIRY.GRAPH and use the above enquiry account to build
a graph based on the selection criteria.
The above shows the setting we have chosen in regards to the format and layout
If we now run the enquiry account the details will be displayed as a graph based on the selection
chosen as shown below:
The above selection shows we are looking for all customers with the range like 50030…
The above LINE.ORDINAL graph has been produced based on the selection in
EB.ENQUIRY.GRAPH
The further graph options of BAR.ORDINAL, BAR.LINE.ORDINAL and PIE.CHART are shown in the
following examples.
The option is available to use a current pie enquire like AM.VAL.MULTIPIE, and map this to the
application EB.GRAPH.TYPE, this will then allow amendments to the lay out of the graph.
Enquiry Attributes
ALLDATA - Forces the retrieval of all data before the ENQUIRY is displayed.
APPLICATION.ENQUIRY - Application Enquiries are a way of displaying an enquiry screen in editable
mode which when committed turns itself in to a record for a specific application. This functionality
allows the data entered on the editable enquiry screen to be committed in to an application record. If
any errors are raised during processing of the record, the user will be presented with a contract screen.
Each row on the enquiry normally becomes a multi-value on the application record.
FASTPATH - This is to allow a user to select various records on an ENQUIRY and by pressing a
single button, it performs the “authorise” or “delete” or “verify” or “reverse” function of all the selected
items consecutively.
INCREMENTAL - For Browser only. Indicates that the enquiry should show all pages from page 1 up
to the current page, as opposed to the current page + the previous page.
NO.ENQUIRY.FAVOURITE – This option disables the favourites function in an ENQUIRY from being
viewed.
MULTI.DOWNLOAD - This attribute to be set where multiple PDF documents are to be merged into
one before it is downloaded.
NO.BRADCRUMBS –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.MOREOPTIONS – This option removes the ’More Options’ function from being used in an
ENQUIRY.
STATIC.PAGING.TOOL - place the paging toolbar inside the enquiry header and top left of the
enquiry page.
NO.COLUMN.HEADER - Displays enquiry without displaying a header for selected column.
NO.SELECTION - This option will hide the selection criteria found at the bottom of BROWSER fields,
BROWSER attribute only.
NO.TOOLBAR - This option will hide the tool bar at the top of a BROWSER ENQUIRY, this attribute is
only available to BROWSER.
NORMALISE – DESKTOP reserved for future use.
PAGE – Not Available in BROWSER
REALTIME - Not Available in BROWSER
REMOVE - Where a pick operation is performed on an ENQUIRY grid, this flag will remove
the item from the display DESKTOP only.
SELECTION.ABOVE.DATA – Selection criteria is displayed above data.
SELECTION.HORIZONTAL – Selection criteria is displayed horizontally along screen
SELECTION.SORT.ONLY – Selection sort only criteria is displayed.
SHOWTREE – DESKTOP only, when an enquiry has multiple entries for one field (expanded multi
values) the ENQUIRY launches showing the first value only, at the far left will be a “+” button which
expands to show all the values if required.
VIEWLARGEICONS - DESKTOP only, convert’s grid ENQUIRYS to display records as large Icons
as per windows standard.
VIEWLIST - DESKTOP only, convert’s grid ENQUIRYS to display records in list format as per
windows standard.
VIEWSMALLICONS - DESKTOP only, converts grid ENQUIRYS to display records as small Icons as
per windows standard.
ZERORECORDDISPLAY - DESKTOP only, If an ENQUIRY selection criteria does not return any
records usually a DESKTOP message pops up to report this. With ZERORECORDISPLAY active the
message pop up is suppressed and the ENQUIRY is launched blank.
In the dropdown field called Toolbar the selected setting will replace the default ENQUIRY toolbar
with a preset Toolbar configuration, the Tool id’s are also displayed in the default dropdown list.
The default selection of toolbar configurations displayed by the dropdown field Toolbar.
The Toolbar configuration is set in the application BROWSER.TOOL where various Tool Id’s can
be arranged.
The result is a pre set configuration being applied to an ENQUIRY record that can be easily be
reused.
To set up the Popup list of all records, in ENQUIRY enter the field name in the POPUP.DROPDOWN
field.
An ENQUIRY record where the Popup Dropdown is set for two fields.
Note: The dropdown arrow has changed and displaying a popup indicator.
A column of displayed data can be set to be collapsible by assigning the field ATTRIBS in ENQUIRY
to be “HIDDEN”. See the screenshot below:
An ENQUIRY record
This will result in the column having an icon for collapsing the column.
In the screen shot below all of the columns have been set to be collapsible, except for the id field:
Each of the collapsible fields has an additional arrow icon as part of the column header, indicating that
the field is collapsible. When clicked, this will result in the collapse of the column. See screen shot
below:
On collapse, the icon on the column header will reverse indicating that the column is hidden.
Hovering over the collapsed column header icon, with the mouse, will reveal a tool tip of the column
name.
The expand and collapse buttons in Browser Composite Screens are universal as illustrated in the
following screens where the buttons appear in the top left hand corner:
The screen below indicates the setup for a Composite to enable this functionality:
EB.COMPOSITE.SCREEN
Note the TOOLBAR setup in attribute 2 of the record and that the ATTRIBUTES field is set to
‘NO.FRAMES’, in addition to the named underlying Enquiries.
With the use of the COL.WIDTH field in the ENQUIRY application it is possible to line up and word
wrap screens that are used in Composite Enquiries.
The ENQUIRY screen below is utilised in the following Composites showing the word wrapping
effect when the COL.WIDTH field is used:
The ENQUIRY field COL.WIDTH will only have an effect in Enquiries in Browser and enables a user
to specify the number of pixels wide that an ENQUIRY column can be. The width is not absolutely
fixed, but is a minimum width (if there is enough space) with the following restrictions:
Column widths will grow to accommodate the widest word or image in the column; a word being any
sequence of characters not containing a space.
Columns with left over space created by larger than required values in the COL.WIDTH field will shrink
if there is not enough space in the window, frame or fragment to display all columns.
Fields defined as being in the same column will be restricted to having the same COL.WIDTH.
NOTE: As yet this functionality is not fully operational with editable enquiries.
Display Sections
Footers
A new SECTION has been added to ENQUIRY to allow totals, etc. to be placed in a separate footer
table:
Footers
Caption
Setting an ENQUIRY field to have a SECTION of caption will add the data to the title of the
ENQUIRY. This means that the title of the window will reflect this data, such that the window title can
read “Account Balances for Richard Branson” instead of “Account Balances”. Note that the window
position information is not saved by caption.
ENQUIRY Access
This is controlled in the USER profile by defining use/restriction of an ENQUIRY ID under the application
ENQUIRY.SELECT (ENQ is an ABBREVIATION of this application). A typical example would be:
This entry in the SMS portion of the USER profile would enable the user to only access the
ACCOUNT.STATEMENT ENQUIRY.
Tip:
• ENQUIRY access SMS is only invoked when requesting the ENQUIRY. Navigation into lower
levels is not subject to ENQUIRY access SMS
Data Access
The use/restriction of displayed data is controlled, again, by the USER profile. Any application data
specified under function S will be examined by the ENQUIRY system whenever a file record is read. If it
does not pass the SMS validation it will not be made available for page building. This does not only apply
to the main record; any link files will also come under SMS scrutiny.
Any security violation on the main file or link file(s) results in the main record being ignored for display
purposes (Note data access SMS is applied at all levels).
Couple these SMS details with the ENQUIRY restriction above and the user will only be allowed to run
the ACCOUNT balances ENQUIRY viewing only current accounts (CATEGORY 1001).
“Application” in the advanced tab (SMS.APPLICATION) defines the name of the application to be
used for SMS verification.
SMS.ID
“Field which holds ID” in the Advanced tab (SMS.ID) specifies the ID of the record to be read for
SMS check from SMS.APPLICATION.
SMS.Abort
“Abort on violation” in the Advanced tab (SMS.ABORT) is a flag indicating whether the ENQUIRY is
to be aborted when the first SMS violation is recorded.
Original Desktop
Browser
Browser ENQUIRY
There are two main problems:
To solve the first problem we remove any HEADER fields that are acting as column headers. These
are usually defined in row 2. The browser sets its column headings to the contents of the FIELD.LBL
field for the column, which defaults to the ENQUIRY field name. Once this has been done, the
ENQUIRY looks thus:
This is caused by the totals section of the ENQUIRY. Here a number of columns are defined in the
ENQUIRY which are only processed at the end of the ENQUIRY. Unfortunately for us they have
been defined as having different columns to the normal data.