ZE-AuditProcessor Deployment

Starting October 11, 2024 (Zephyr Enterprise 8.2), the Zephyr Enterprise documentation moved from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise documentation page. Please see: https://support.smartbear.com/zephyr-enterprise/docs/en/zephyr-enterprise/zephyr-installation-and-upgrade-guides/zephyr-on-premise-production-installation/zephyr-enterprise-services/ze-auditprocessor-deployment.html

1 Prerequisite
2 AuditProcessor Deployment (Jar)
- 2.1 MsSQL:
- 2.2 MySQL:
- 2.3 Oracle:
- 2.4 MySQL
- 2.5 MSSQL
- 2.6 Oracle
3 AuditProcessor Deployment (Docker)
- 3.1 MySQL
- 3.2 MSSQL
- 3.3 Oracle

Prerequisite

Install Java 17.
Ensure your Zephyr and Rabbit MQ application is set up and running, For RabbitMQ Setup follow the instructions on the following page: https://smartbear.atlassian.net/wiki/spaces/PD/pages/3852992664/RabbitMQ+-+Deployment+Ubuntu
By launching the application in the browser:
- Launch Zephyr with your respective host/domain. Ex: https://test.yourzephyr.com
- Launch RabbitMq with the host and configured port. Ex: http://localhost:15672]
Launch RabbitMq Management in the browser with the host and port (Ex: http://localhost:15672).

AuditProcessor Deployment (Jar)

Create a directory under folder opt “zephyrservice”

mkdir zephyrservice

Download the ze-audit-processor.jar and copy it under zephyrservice
Create a ze-audit-processor config file Named “zeAuditProcessor.properties" under folder zephyrservice

vi zeAuditProcessor.properties

Add the below line in the file zeAuditProcessor.properties.

server.port=8084
zephyr.queue.name=ze_audit_queue
zephyr.queue.exchange=ze_audit_exchange
zephyr.queue.routing.key=ze_audit_routing_key

# hostname should point to continer name if in case you are running webhook on docker
spring.rabbitmq.host=<rabbitmq_hostname>
spring.rabbitmq.port=<rabbitmq_port>
spring.rabbitmq.username=<rabbitmq_username>
spring.rabbitmq.password=<rabbitmq_password>

spring.devtools.restart.enabled=false

Append the below database-specific properties based on the Zephyr database you are using.

MsSQL:

MySQL:

Oracle:

Your sample zeAuditProcessor.properties should look like below:

MySQL

MSSQL

Oracle

Start the AuditProcessor with the following command:

Example command:

AuditProcessor started snapshot for reference: -

The Logs folder will be created where your jars are deployed. Separate log files will be created for each jar.
--- at the starting and ending of db configuration is necessary. Follow the same mentioned.

AuditProcessor Deployment (Docker)

Install Docker in the System
Create a directory under folder opt “zephyrservice”

Download the Docker compose and copy it under zephyrservice

Create a ze-audit-processor config file Named “zeAuditProcessor.properties" under folder zephyrservice

Add the below line in the file zeAuditProcessor.properties.

Append the below database-specific properties based on the Zephyr database you are using.

MySQL:

MsSQL:

Oracle:

Your sample zeAuditProcessor.properties should look like below:

MySQL

MSSQL

Oracle

Make sure port 8084 is available.
zeAuditProcessor should be able to connect with RabbitMQ.
zeAuditProcessor should be able to connect to the Database of Zephyr.

Start the ze-jira-webhook with docker with the following command:

Navigate to zephyrservice and run the below command:

Verification in the browser:

Verify webhook application status by using http://<hostname>:8084/actuator/health.