100% found this document useful (1 vote)
273 views43 pages

Image Management - User Guide: Release: R18 AMR

QAW

Uploaded by

Zakaria Almamari
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
100% found this document useful (1 vote)
273 views43 pages

Image Management - User Guide: Release: R18 AMR

QAW

Uploaded by

Zakaria Almamari
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 43

Image Management - User Guide

Release: R18 AMR


April 2018

©2018 Temenos Headquarters SA - All rights reserved.


Warning: This document is protected by copyright law and international treaties. Unauthorised reproduction of this document, or any portion of it, may result in severe
and criminal penalties, and will be prosecuted to the maximum extent possible under law.
Table of Contents
Table of Contents 2
Introduction 3
Purpose of this Guide 3
Intended Audience 3
Module Overview 4
Setup 5
Web Browser Configuration 5
T24 IM applications 7
IM.DOC.IMAGE.PARAMETER 8
IM.IMAGE.TYPE 8
IM.DOCUMENT.IMAGE 10
Static Processing 12
IM.DOCUMENT.UPLOAD 12
Enquiry 29
Launching images from ENQUIRY 29
Cloud-based Image Management 32
Overview 32
Configuring the Cloud Service 33
Cloud-based Image Management - User Guide 35

Image Management - R18 AMR - Page 2 of 43


Introduction
Purpose of this Guide
The purpose of this guide is to describe the configuration required to deploy the Image Management mod-
ule and the functionality present in the product.

Intended Audience
The intended audience for this guide are all levels of business users, in general and specifically, who are
responsible for managing images and other files associated with the module.

Image Management - R18 AMR - Page 3 of 43


Module Overview
The Image Management (IM) module in T24 allows the display of images, opening of document files,
media files and other files by their associated applications.
IM benefits the user by providing immediate access to digital copies of essential data such as signatures,
loan documentation, birth certificates or passports. There is no need to access the physical document itself
- indeed this may not be possible with items such as passports, or if the item itself is stored somewhere for
safekeeping.
Images can be displayed within the browser interface itself, whilst other file types are shown as hyperlinks
which can be used to open an associated application to display the file. In this way various files such as
Acrobat PDF, Word documents, spreadsheets can be made available to the end user.
l Setup
l Static Processing
l Enquiry
l Cloud-based Image Management

Image Management - R18 AMR - Page 4 of 43


Setup
Web Browser Configuration
Since the Image management process involves writing and reading files from your local or network file sys-
tem, permission must be given before Internet Explorer or Firefox is able to do this.

Internet Explorer 7
To ensure that the T24 Browser site has been given a ‘Trusted’ status open the ‘Security’ Tab under the
‘Internet Options’ dialog.

Security settings tab


To add T24 Browser as a ‘Trusted Site’ click the ‘Sites’ button. In the resulting dialog a list of all added sites
will be shown. Ensure that the webserver that is running the T24 Browser application is specified:

Image Management - R18 AMR - Page 5 of 43


Trusted sites
In the example above the URL to access the T24 Browser application is:
http://localhost:8080/BrowserWeb/servlet/BrowserServlet
To ensure that the T24 Browser site has been successfully added as a ‘Trusted Site’ the IE status bar should
display a ‘tick’ when accessing the T24 Browser application.

Image Management - R18 AMR - Page 6 of 43


Internet Explorer indicating trusted site

Firefox 2.0
For security purposes, Mozilla applications block links to local files (and directories) from remote files. This
includes linking to files on your hard drive, on mapped network drives, and accessible via Uniform Naming
Convention (UNC) paths. This prevents a number of unpleasant possibilities, including:
l Allowing sites to detect your operating system by checking default installation paths
l Allowing sites to exploit system vulnerabilities (e.g., C:\con\con in Windows 95/98)
l Allowing sites to detect browser preferences or read sensitive data
So that the Image Management process can function when using Firefox, the security check must be disable
when running T24 Browser.
The following instructions are for Firefox 2.0. If a different version is being used then refer to the Mozilla
documentation for instructions on how the security check can be disabled. For further information and
guides on how to configure the Firefox web browser at an administrative level please see:
http://kb.mozillazine.org/Links_to_local_pages_don%27t_work
Ensure that ALL instances of the Firefox web browser have been shut and none are running.
Locate the ‘prefs.js’ file under the Firefox profile settings typically found in the following directory:
C:\Documents and Settings\<user>\Application Data\Mozilla\Firefox\Profiles

Edit the ‘user.js’ using notepad and add the following entries to it:
user_pref("capability.policy.localfilelinks.checkloaduri.enabled", "allAccess"); user_pref("cap-
ability.policy.localfilelinks.sites", "http://localhost:8080"); user_pref("cap-
ability.policy.policynames", "localfilelinks");

Replace the http://localhost:8080 entry with the required site name of the Browser web application. If
more than one site name is required then they can be added and separated by a space e.g.
user_pref("capability.policy.localfilelinks.sites", "http://localhost:8080 http://10.1.2.3:8080
http://10.4.5.6");

Note that any site name listed should not include the final / or anything else from the path part of the URL.
Save the 'user.js' file and start Firefox. Firefox will no be able to resolve resources on the local file system
and network as required by Image Management.

T24 IM applications
The standard applications used by Image Management are:

Application Usage
IM.DOC.IMAGE.PARAMETER Image parameter settings (not currently used)
IM.IMAGE.TYPE A categorisation and location of type of images/files

Image Management - R18 AMR - Page 7 of 43


IM.DOCUMENT.IMAGE The details of the record and link reference
IM.DOCUMENT.LOAD Uploads images to storage or links to non image files

IM applications

IM.DOC.IMAGE.PARAMETER
This application contains just one record called system and is reserved for future use.

IM.IMAGE.TYPE
The first settings to be made are to define the types or categories of files and images. The IM.IMAGE.TYPE
record is used to record the location of the files and allows the categorisation of the files by types which
makes the storage and retrieval to be setup in a logical fashion.
In a simple setup there could be just one record but this location would then contain all the images, doc-
uments, pdf’s and other files in the one directory.
So a typical usage would be to place similar types together in special directories, so records such as PHOTO,
PASSPORT, SECURITY, SIGNATURE, VIDEO, FORMS would each have their own unique sub-directory.
The storage location can be set either using:
l Standard drive letter and path
l Full path
l Relative path to the web server (browser) root for Unix.

Mapped Drive
Typically in Windows environments drives are accessed by mapping directories to a familiar drive letter.

Image Management - R18 AMR - Page 8 of 43


Drive letter based location
The above record is based on the storage location being accessible using a mapped drive reference ‘U:’ and
the directory ‘/im.images/photos/’.
The ‘V:’ mapping could be pointing to a nested directory whose full path would be way too long for prac-
tical use. So in fact the path shown above is in reality based on the starting position in the directory struc-
ture signified by ‘U:’.
In a sense mapped paths can be thought of as being relative paths as the location is relative to the mapped
directory level.
The path should be prefixed with a ‘/’ and terminate with a ‘/’; these can be entered either in Windows or
Unix format (/ or \) as T24 will convert where required.
It is unlikely that images or links would be stored on the C: (or other local drives) but if required they can be
used as long as they are made shared - this is a security feature of most web browsers and not a T24
requirement. If a link or image does not work as expected check that the location is accessible.

Full Path
When not using the DEFAULT.DRIVE field to indicate a mapped drive the full path can be used. The browser
used will evaluate the path and based on standard web criteria ascertain if the path can be reached and the
file displayed or linked to.

Image Management - R18 AMR - Page 9 of 43


Location based on full network path
The browser will evaluate this full path just as if it were prefixed with a default drive letter.

Relative Paths
Precede path with one or two dots
If the path in the record is entered as either “.\secure\T24\images\acrobat\” or “..\se-
cure\T24\images\acrobat\” then this indicates that it is a path relative to the BrowserWeb root location.
Note: Storing images or other related files in directories relative to the Browser is not recommended as a
full replacement of the Browser files is usually preceded by removal of the entire directory – this would res-
ult in the loss of the image files as well.

File Access Permissions


When setting up the image system and secure file locations it should be noted that there are certain per-
missions needed to allow the files to be uploaded/viewed by the user and/or web server.
The user uploading a file of course needs access to the file. However, the web server will be writing the file
to the secure storage location for the file type, when the user then needs to view the image the web server
will only provide a link to the secure location – the user needs to have access rights to view files from this
location as well.

IM.DOCUMENT.IMAGE

Image Management - R18 AMR - Page 10 of 43


The IM.DOCUMENT.IMAGE application is where the individual file (or image) details are entered and
where we bring together key information.
The id of these records is a standard julian date type key; but it could just as well be any unique reference
as in itself it is not too useful. So the internal fields are more involved in deciding the usage of the record
and how to access it.

Steps
l It is assumed that an IM.DOCUMENT.IMAGE record is created.
l Associate the record with the IM.MAGE.TYPEand this categorises the file type and more importantly
links to where the file will be stored.
l The image is associated with the application CUSTOMER, and that the image reference to store the
link is generated.
l Other fields are informational, such as the description and the type of media.
Note:It is not necessary to link the file with an application – the important feature is the image reference.
This becomes the retrieval key and a system file will be built which details all the images using this ref-
erence. So we could have several image files associated with the same CUSTOMER record. Alternatively we
could have one or more records just accessible by the reference ‘BANKRULES’  so users could retrieve them
without concern about them being associated with any specific application.

Image Management - R18 AMR - Page 11 of 43


Static Processing
IM.DOCUMENT.UPLOAD
So far we have entered records which relate to where files are stored and how we plan to link to them but
we have yet to actually load a file or link to one.
The IM.DOCUMENT.UPLOAD application is used to load an image file from an import directory and store it
with a unique id, or for certain file type simply specify the name of the file required.
In the following example an image is uploaded and retrieved.

Uploading
l It is assumed that a record in IM.DOCUMENT.UPLOAD is created.
l Open the IM.DOCUMENT.UPLOAD application.
l Enter the IM.DOCUMENT.IMAGE reference in the UPLOAD.ID field.
l Click the file upload icon, to open the ‘file upload’ dialog box.

Image Management - R18 AMR - Page 12 of 43


l Click the ‘Browse’ button, to select the file to be uploaded.

Image Management - R18 AMR - Page 13 of 43


l After selecting the file, click the icon to upload the file.

Image Management - R18 AMR - Page 14 of 43


l After uploading the file, a completion message is displayed.

Image Management - R18 AMR - Page 15 of 43


Retrieving an Image File
l Open the ENQ.IMAGE.VIEW enquiry and enter the reference ID pertaining to the file to be down-
loaded.

Image Management - R18 AMR - Page 16 of 43


l The requested image is displayed.

Let’s load the signature we need to store.

Image Management - R18 AMR - Page 17 of 43


IM.DOCUMENT.UPLOAD to import image

Image Management - R18 AMR - Page 18 of 43


File Upload box and Standard Windows browse box to find/select a file.
1. Enter the location manually
2. Use the Browse option
If the Browse option is used the eventual selection (file name) is copied into the file selection field.
Once happy you have the correct file click on the import icon, illustrated below.

Using the import icon


Next we will be returned to the IM.DOCUMENT.UPLOAD record, and if we have a valid image record it will
also be displayed so we have a visual confirmation that it is the correct record and is viewable.

Image Management - R18 AMR - Page 19 of 43


IM.DOCUMENT.UPLOAD record
Note the new reference in the field FILE.UPLOAD differs from the image file name we imported.
The image file is now called and is located in the directory specified in the IM.IMAGE.TYPE used on the
IM.DOCUMENT.IMAGE record we selected.

Image Management - R18 AMR - Page 20 of 43


Image Management - R18 AMR - Page 21 of 43
Hyperlinks
To retrieve files other than the Image files:
l Open the ENQ.IMAGE.VIEW enquiry and enter the reference ID pertaining to the file to be down-
loaded.
l A hyperlink is displayed and clicking the hyperlink opens the download dialog (see below).

Image Management - R18 AMR - Page 22 of 43


Note: User could open the files directly but it depends on the applications installed. (for
example, to directly open a Word document, Microsoft Office should be installed in user's sys-
tem.

Hyperlinks
To set up a link to a record (other than an image file) we need to consider the following:
l Where are these files to be stored?
l How are they categorised?
l Can they be opened with a PC application by the user?
l Where to reference them?
First we setup an appropriate IM.IMAGE.TYPE

Image Management - R18 AMR - Page 23 of 43


Hyperlink image type
Next we enter the IM.DOCUMENT.IMAGE record which acts as the linkage.

PDF Image record


We now need to link the actual PDF to this record.

Image Management - R18 AMR - Page 24 of 43


Hyperlink item name

IM.DOCUMENT.IMAGE location has been updated


We can use the ENQUIRY to find the hyperlink image based on the IMAGE.TYPE we entered.

Image Management - R18 AMR - Page 25 of 43


Using Enquiry to find hyperlink

ENQUIRY shows one result – with option button

Image Management - R18 AMR - Page 26 of 43


Hyperlink is displayed instead of an actual image

Image Management - R18 AMR - Page 27 of 43


PDF displayed in browser window.

It should be possible to link to Word documents; Excel files; media files such as video and audio
as long as the file extension is associated correctly with an installed application. For example a
file called sample.txt may be associated with Notepad for one user but Word for others. Where
appropriate the file will be loaded into a browser version of the application (Acrobat PDF
viewer, Word viewer etc) just as would happen when you open a linked file from the Internet.

Image Management - R18 AMR - Page 28 of 43


Enquiry
Launching images from ENQUIRY
It should be noted that the ENQUIRY application has a special setting to allow an image or hyperlink to be
displayed.
The field FIELD.DISP.TYPE needs to be set as IMAGE, as this instructs the system to display the link as either
an image in a browser window for picture files; or to create a hyperlink for other file types (which can be
clicked on and hopefully load the file into the associated application).
In the example below the ENQUIRY is using the file IM.DOCUMENT.IMAGE but the actual images are not
on that file. The link is created using the KEY (or @ID) and the system knows to locate the image based on
the IMAGE setting in the ENQUIRY and resolving the filename and path.

FIELD.DISP.TYPE set as IMAGE


You can of course have a front-end ENQUIRY to filter the results down since any ENQUIRY listing that con-
tains a large amount of images would take a while to open them all up for display and fill up the screen.

Image Management - R18 AMR - Page 29 of 43


If not already present in your system, or in the format you require the ENQUIRY IMAGE.LIST may need
inputting/amending to link to your new display ENQUIRY.

Sample IMAGE.LIST ENQUIRY

Part 1 of 2 IMAGE.LIST ENQUIRY

Image Management - R18 AMR - Page 30 of 43


Part 2 of 2 of IMAGE.LIST ENQUIRY
In the above screen the fields used to link to the DISP.IMAGE ENQUIRY are highlighted.

Image Management - R18 AMR - Page 31 of 43


Cloud-based Image Management
Overview
Cloud computing offer users access to vast storage, processing power and computer applications installed
on a remote network which can be accessed from any location across the world. Cloud storage is designed
as a highly fault tolerant platform with durability and consistency.
T24 Image Management supports cloud storage through Windows Azure environment. The uploaded
images are stores the images with the application (T24) so the user can retrieve the record at any time in
the future. Cloud-storage accepts all types of files; however, T24 Browser directly displays the images and
opens other file types using an associated application. In this way, various file types such as Images, audio
files, video files, Acrobat PDF, Word documents, spread sheets can be made available to the user through
cloud-storage.
l To know how to configure, refer the topic 'Configuring the Cloud Service'
l For other user-related operations, refer 'Cloud-based Image Management - User Guide'

Image Management - R18 AMR - Page 32 of 43


Configuring the Cloud Service
Image Management supports cloud computing through the Windows Azure Platform. Windows Azure cre-
dentials and other related parameters could be configured in the browserParameters.xml file.

The above screenshot shows the set of parameters in the browserParameters.xml file that could be con-
figured to manage images in cloud storage. They are as follows:
l enableCloud - The cloud storage feature can be enabled or disabled using the parameter
‘enableCloud’ in browserParameters.xml file. The options are ‘YES’ (to enable) or ‘NO’ (to disable). By
default, the value of this parameter is kept as ‘NO’. If set to ‘YES’, it enables the cloud storage feature
and if set to ‘NO’, images are uploaded to the path specified on a local drive or to a path specified
within the work directory of the Browser application in the application server.
l azureAccountName - a valid Azure account name is provided for this parameter. Providing incorrect
account name results in error during uploads. Refer Error messages section for related errors during
upload and content retrieval.
l azureAccountKey –a valid Azure Account key is provided for this parameter. Providing incorrect key
results in error during uploads. Refer Error messages section for related errors during upload and
content retrieval.
l imageContainer – This parameter holds the name of the container that stores the files on the cloud.

Configuring the Error messages


In the Cloud-based Image management, error messages are displayed when an unexpected condition
occurs, usually during uploading and downloading the files. This section of the guide describes the action
involved in configuring the error messages to be displayed during the occurrence of such errors. Error mes-
sages are stored in ‘cloudError.properties’ file which can be found in the WEB-INF/classes folder.
Following is the list of errors for which the error messages can be customized by the user. Highlighted in
the screenshot are the default error messages available within the ‘cloudError.properties’ file.

Image Management - R18 AMR - Page 33 of 43


l Error to be displayed for incorrect cloud account configuration and network proxy problems occurred
while downloading a file
l Error on any exception thrown at the time of download process
l Error to be displayed for incorrect cloud account configuration and network proxy problems occurred
while uploading a file
l Errors for requests posted after the session expires

Image Management - R18 AMR - Page 34 of 43


Cloud-based Image Management - User Guide
Uploading a file to the Cloud
To upload a file to the cloud storage:
1. Open the IM.DOCUMENT.UPLOAD application.
2. Click the file upload icon, to open the ‘file upload’ dialog box.

3. Click the ‘Browse’ button, to select the file to be uploaded.

Image Management - R18 AMR - Page 35 of 43


4. After selecting the file, click the icon to upload the file.

Image Management - R18 AMR - Page 36 of 43


5. After uploading the file, a completion message is displayed.

Image Management - R18 AMR - Page 37 of 43


Downloading a file from the Cloud
1. Open the ENQ.IMAGE.VIEW enquiry and enter the reference ID pertaining to the file to be down-
loaded.

Image Management - R18 AMR - Page 38 of 43


2. The requested image is displayed.

Note: Users could open other type of files directly but it depends on the applications installed
on their PC (for example, to directly open a Word document, Microsoft Office application should
be installed in user's system.

Image Management - R18 AMR - Page 39 of 43


Errors and Error Messages
In the Cloud-based Image management, errors occur while downloading and uploading:
l If invalid Azure Account Name, Azure Account Key or Container Name are configured in the browser-
Parameters.xml.
l If Network proxy configuration that make the cloud storage is not reachable
l If the path is changed or reconfigured in IM.IMAGE.TYPE

Note: Users are advised to contact Temenos Support in case of errors during upload and down-
load.

To configure these error messages, refer the section: Configuring the Error Messages
Following are the error messages that are displayed when the error occurs during the upload, download,
etc.
l If the Windows Azure credentials are incorrect, an error message is displayed. (This error does not
invalidate the browser session.)

l If the requested image file is not available, an error message is displayed. (This error message could
be configured.)

Image Management - R18 AMR - Page 40 of 43


l An error message is displayed, if a file other than an image file is not available.

Image Management - R18 AMR - Page 41 of 43


l If the Windows Azure credentials are invalid (for files other than an image file), an error message is
displayed.

l If user tries to upload a file type which is not configured in the application, an error message is dis-
played. (This error message could be configured.)

Image Management - R18 AMR - Page 42 of 43


l If user tries to upload a file that is beyond the allowed file size, an error message is displayed. (This
error message could be configured.)

Image Management - R18 AMR - Page 43 of 43

You might also like