Payments Integration with EQUENS Admin Messages Installation Guide

The pre-deployment steps for Cloud and On-Prem deployments are the following.

1. Unzip the package NLINCT_AdminMessageProcessing.zip and place it in the required folder. The contents of the package will be as in the below snapshot.

   

2. Edit the system environment variables and click on Environment Variables button.

   

3. Click on the New button to add a new system variable.

   

4. Set the JAVA_HOME in system variables as per below.

   

5. The queues configured in the variables below have to be created in the environment.
   • ADMIN_MESSAGE_INPUT_QUEUE
   • EQUENS_ACTIVEMQ_DESTINATION_QUEUE
6. For ActiveMQ, the queues can be created from the ActiveMQ Console.

The On-Prem deployment configurations are described below.

Application.properties File Configurations

The application.properties file available in the package will be configured as per the instructions provided below.

1. application.properties: Stores details regarding the External MQ broker connection, keystore and certificates to form and verify the signature.
2. Path inside the .zip: NLINCT_ AdminMessageProcessing /application.properties. These properties have been externalized. So kindly set the values in the start.cmd script if running it as a standalone application or set it up in the .yaml file in case of docker implementation.

Application.properties file is displayed below.

Please do not change the values in this file. The values can be set in the start.cmd script.

Start.cmd script is displayed below.

Log Configurations

The log configurations are the following.

1. log4j2.xml : Stored logger related details.
2. Path inside .zip: NLINCT_ AdminMessageProcessing /log4j2.xml.
3. Ensure the timestamp is given in the format below.

   <Property name="commonPattern">%d{yyy-MM-dd HH:mm:ss,SSS} %-5p [%t] %c{1} - %msg%n</Property>

   

The Cloud Deployment configurations are described below.

Values.yaml File Configurations

1. Configure the required configurations in values.yaml file as displayed below.

   

Other Configurations

1. Update the values.yaml file for increasing the instance count (by default it is one).

   

2. Mention the range of memory and cores.

   

3. Update the templates / adminmessages-deployment.yaml with the image name as required in the sample below.

   

4. Update the templates / adminmessages-deployment.yaml file to configure the container instance of mount location.

   

Application Port Configurations

1. The application port is 8060 and is configured in the values.yaml files. The ports and IP configuration provided in the values.yaml file is referred in the network-policy.yaml, service.yaml and deployment.yaml.
2. Load balancer source IP range is referred from sourceIP_ranges in the values.yaml files.

   

1. Unzip the zip package into a folder NLINCT_ AdminMessageProcessing.
2. Configure the java home path in NLINCT_ AdminMessageProcessing /start.cmd.
3. Run the adapter by double clicking the start.cmd or use a console to run the following command.

   start.cmd -p <application_server> -po <port>

   

4. Terminate the adapter by double clicking the stop.cmd or run the following command: stop.cmd

1. Download the zip file and provided and extract it in a folder in destination system.
2. Check if any images are existing (using docker images command) in the destination system. If so remove them using:
   • docker images,
   • docker rm <image id> command.
3. Locate the Dockerfile folder and open command prompt to execute the following command. This will load the images into docker.

   Load Images
   Syntax: docker build -t <repository>:<tag> Eg:docker build -t nn-adminmessages:dev

   

4. For docker deployment only: Start a local docker registry server using docker image that will be used as a container registry hosting all the images deployment.

   Start Local Registry
   Eg:docker run -d -p 5000:5000 --restart=always --name registry registry:2

   

5. Once registry is started, you need to tag and push the images that were loaded earlier. Syntax and samples for tag and push is mentioned below.

   Docker tag images
   Syntax: docker tag <Repository> <local registry host>:<local registry port>/<repository>:<tag> where, Repository – nn-adminmessages local registry host – localhost local registry port – 5000 tag – dev Eg: docker tag nn-adminmessages:dev localhost:5000 nn-adminmessages:dev

   

   Docker push images
   Syntax: docker push <local registry port>/<repository>:<tag> Eg: docker push localhost:5000/ nn-adminmessages:dev

   

6. Navigate to helm folder and start nn-adminmessages services using below command.

   Start nn-adminmessages services
   Syntax: helm install -name <<image name>> . -n <<image namespace>> --create- namespace Eg: helm install -name nn-adminmessages -n nn-adminmessages --create-namespace

   

7. Check if the services are up using the command below.

   Get pods
   Syntax: Kubectl describe pods -n <<image namespace name>> Eg: kubectl describe pods -n nn-adminmessages

8. If the application is running, POD log will be generated with the keyword 'ACCEPTING_TRAFFIC'.
9. To uninstall the afb service use the below command:

   helm uninstall <<image name>> -n <<namespace name>>

   Eg: helm uninstall nn-adminmessages -n nn-adminmessages