Image Enquiry

Image Enquiry

The Image Enquiry function is used to return images to a T24 screen. This is predominantly used to return a customer’s photo and signature to the Single Customer View. The images (customer photo and signature) are securely stored in the Autoform DM archive and referenced by a unique key.

Overview

The data servlet integration files are held in autoform-dataservlet-4.*-bin.zip. The servlet details will need to be added to the relevant web.xml file, and the data servlet jar will be placed in the correct folder.

In order to use the data servlet to display images in the T24 browser, T24 Enquiries need to be created, these can then be used in the SCV to view the customer photo and signature. Details on creating these Enquiries can be found in the following sections of this guide.

Configuration and Integration

1. Copy efs-dataservlet-4.*.jar to BrowserWeb.war/WEB-INF/lib.

2. Update BrowserWeb.war/WEB-INF/web.xml with the basic configuration found in web.xml in the interface distribution.

3. Consult web-full.xml for an example that includes all configurable parameters for the interface, along with explanations for each. For instance, copy web/error.jpg to BrowserWeb.war/WEB-INF/ folder and set as init-parameter.

Logging

Debugging is configured in BrowserWeb.war\WEB-INF\classes\log4j.properties (or jboss-specific log config file) by setting the com.efstech category to DEBUG.

Password Encryption

• Use CLI to encrypt passwords.

The DM password for all integrations can be encrypted using the CLI for our crypto-utils library by following these steps:

1. Obtain the CLI jar from the interfaces release package. It should be named crypto-utils-1.0.0-cli.jar or similar.

2. Run the jar file as java -jar crypto-utils-1.0.0-cli.jar encrypt, for example to use the key MyKey to encrypt the DM password DM_PASS, you would run it as: java -jar crypto-utils-1.0.0-cli.jar encrypt DM_PASS MyKey.

3. The output from this command is the encrypted DM password. This should be surrounded with ENC() and placed in the relevant properties file (for example, NoFileEnquiry.properties) for the interfaces release jar. For instance, dm.password=ENC(AX23DKJCL2LKJDLKJ436).

4. The encryption key (MyKey in this example) must be set as an environmental variable with the name EFS_T24_INTERFACES_KEY.

• Change the encryption profile.

Both the CLI and the interfaces enable an alternative encryption profile to be selected if there is a perceived need to use something other than the default.

To do so, the name of the desired encryption profile should be passed to the CLI and the interface - if configured, these must match otherwise, password decryption will fail.

For the CLI, the profile name can be selected by adding -c to the end of the command. For the Interfaces, it is passed as the EncryptionConfig parameter.

The possible profiles are the following:

• pbkdf2hmacsha1withaes128cbc - the default profile, used if nothing is explicitly set.

• pbkdf2hmacsha1withaes256cbc - provides higher bit strength AES.

The second profile provides higher strength AES, but this requires the environment to support this. A standard JDK will not support anything above 128bit without either the unlimited-strength JCE profile enabled or a third-party library such as BouncyCastle. As such, it should only be used if required and with the understanding that additional work must be done to ensure the environment supports it.

Usage

Customer Photo

Create a new T24 Enquiry called AUTOFORM.PHOTO using the command ENQUIRY, AUTOFORM.PHOTO.

Several Browser tools, such as the AUTOFORM.PHOTO browser, enhance the Formpipe interfaces. For details on how to configure this tool, navigate to the Browser Tools section.

Customer Signature

Like the Customer Photo, the Customer Signature is securely stored as an image in the Autoform DM Archive. Create a T24 Enquiry AUTOFORM.SIGNATURE using ENQUIRY, AUTOFORM.SIGNATURE to retrieve this using the Data servlet.

Optional Parameters for Image Enquiries

The size of the image returned from the DM server can be re-sized by the servlet. These are query parameters that can added to the end of the HTTP request.

Note

Be aware that there is limit of characters in this field on R16, so you might use workaround for it. (for instance, with static CUK C SERVLETADD : “CUK=201” : “&img-width=300” or use two fields and merge it.)

For example, for Customer Photo:

Operation.3.1: C SERVLETADD : “CUK=Photo” : CUSTOMER : “&img-width=100&img-height=100”

For Customer Signature:

Operation.3.1: C SERVLETADD : “CUK=SIG” : CUSTOMER : “&img-width=300&img-height=100” |

Document Download Usage

The Document Download interface extends the native T24 Download function, which is triggered from a drill-down that we add to the T24 Enquiry, which is used to return the list of documents. This drill-down is displayed as a View link.

The drill-down is added to the Enquiry field of the T24 Enquiry. The format of this in the example used for the AUTOFORM.DOCS Enquiry is as follows:

The DOWNLOADID has the following format (this is also configured in the T24 Enquiry): CALC “DOCID=” : document.id : “|.pdf”.

To make the document extension dynamic, follow these steps: 

1. Add a document.file.extension field.

2. Add an extension field with the Operation: CALC "|." : document.file.extension.

3. Update the DOWNLOADID field to concatenate the two parts: CALC "DOCID=" : document.id : extension.