Guides
R24 AMR | Min(s) read

e-Cheque Acceptance & Lodgement Installation Guide

This document aims at explaining the installation procedures required to install the packages for ECHQUE inward and outward file process interface adapter.

System Requirements

The following are the pre-requisites for installing this package:

  • Jdk 11.
  • Temenos Transact area configured with the Temenos Transact components.
  • Microservices components installed.

Configuration for the Outward File Generation

In order to generate the outward file, the user will need to perform the following configurations.

  1. Configure the directory path in the records below.

  2. Run the HKECHQ.GENERATE.PRESENTMENT.RETURN service and check if the file is extracted in the configured directory.

  3. Two files are generated in above configured location and the same will be processed for the outward file generation.

  1. Open the OutwardFileRecordGrouping.xsl to configure the local fields position from the STANDARD SELECTION record of the TELLER application.

  2. Open the standard selection record to view the local field position.

General Considerations

The general configurations for incoming and outgoing processing file are provided below.

  1. Extract the .zip file.
  2. In the Log4j2.properties file, configure the log directory in the logger.path property.

  3. In the start.cmd file, set the following details:
    • JAVA_HOME variable: Points to the java jdk location, for example, C:\java\jdk11\jre.
    • PROVIDER variable: Contains the queue broker name. It accepts the following values: jboss, ibmmq, activemq, amazonmq, weblogic.
    • PORT variable: Can be any available port number to be used by the package.
  4. If the above values are not set, then the following values will be defaulted:
    • PROVIDER=jboss.
    • PORT=auto picked.
  5. A sample configuration of the application.properties file is provided below.

  6. To configure the password encryption for the queue servers, encrypt the password using the jasypt jar available in the <package>/lib/jasypt folder using the following command: java -cp jasypt-1.9.3.jar org.jasypt.intf.cli.JasyptPBEStringEncryptionCLI input=admin password=password algorithm=PBEWithMD5AndDES.

  7. Add the environment variable for the master password which is used for encryption.

  8. Configure the application.properties as per below.

  9. Configure the encrypted password in the corresponding queue server properties file in the ENC (encrypted_password) format.

  10. Open the respective application properties for the queue broker type and set the JNDI values, for example, if the queue broker is jboss, open the application-jboss.properties and set the values.
  1. Extract the .zip file.
  2. In the Log4j2.properties file, configure the log directory in the logger.path property.

  3. In the start.cmd file, set the following details:
    • JAVA_HOME variable: Points to the java jdk location, for example, C:\java\jdk11\jre.
    • PROVIDER variable: Contains the queue broker name. It accepts the following values: jboss, ibmmq, activemq, amazonmq, weblogic.
    • PORT variable: Can be any available port number to be used by the package.
  4. If the above values are not set, then the following values will be defaulted.
    • PROVIDER=jboss.
    • PORT=auto picked.
  5. A sample configuration of the application.properties file is provided below.

  6. To configure the password encryption for queue servers, encrypt the password using jasypt jar available in the <package>/lib/jasypt folder using the following command: java -cp jasypt-1.9.3.jar org.jasypt.intf.cli.JasyptPBEStringEncryptionCLI input=admin password=password algorithm=PBEWithMD5AndDES.

  7. Add the environment variable for the master password which is used for encryption.

  8. Configure the application.properties as per below.

  9. Configure the encrypted password in the corresponding queue server properties file in the ENC (encrypted_password) format.

  10. Open the respective application properties for the queue broker type and set the JNDI values, for example, if the queue broker is jboss, open the application-jboss.properties and set the values.

Contents of the Package

The package contains the following.

The HKECHQ_FileProcessingIncoming component contains the following items in the Xsl folder:

  • InwardFileNameEntry.xsl.
  • InwardFileValidation.xsl.
  • InwardFileValidationLog.xsl.
  • InwardFileExistLog.xsl.
  • InwardFileValidRecOfs.xsl.
  • invoiceDetails.xsl.

These are the xslts available for each message types.

The HKECHQ_FileProcessingOutgoing component contains the following items in the Xsl folder:

  • OutwardFileRecordGrouping.xsl.
  • OutwardFileGeneration.xsl.
  • OutwardExceptionHandling.xsl.

These are the xslts available for each message types.

Steps for Deploying the Package File

The steps for deploying the package file are provided below.

The following steps are common for both packages.

  1. Open a command window in the extracted package location, and execute the command start.cmd.
    • Syntax: start.cmd [ -p provider ] [ -po port ]
    • Example: Start.cmd –p jboss –po 8080.
  2. The logs will generated in the log folder configured in the log4j2 properties file for monitoring purposes.

  3. To stop the service, open a command window in the extracted package location, and execute the command stop.cmd.

The steps are common for both packages.

  1. Open a terminal in the extracted package location, and execute the command start.sh.
    • Syntax: sh start.sh [ -p provider ] [ -po port ].
    • Example: sh start.sh –p jboss –po 8080
  2. The logs will be generated in the log folder configured in the log4j2 properties file for monitoring purposes.

  3. To stop the service, open a terminal in the extracted package location, and execute the command sh stop.sh.

Special Instructions

In case of Linux environment, kindly ensure that the start.sh and stop.sh has LF as line separator.

Copyright © 2020- Temenos Headquarters SA

Contact Us

knowledge@temenos.com

Published on :
Thursday, May 30, 2024 11:34:04 AM IST