ZE - Audit Service Deployment (Artemis)

Prerequisites

Install Java 17.
Ensure your Zephyr Enterprise and Artemis is set up and running, by launching the application in the browser:
- Launch Zephyr with your respective host/domain. Example: https://test.yourzephyr.com/flex
- Once Artemis is running, launch the management console with the IP and port. Example: http://localhost:6093/actuator/hawtio

Audit Service Deployment (Jar)

Create a directory under folder opt zephyrservice.
```
mkdir zephyrservice
```
Download the ze-audit-service.jar and copy it under zephyrservice.
Create a ze-audit-service config file named zeAuditService.properties under folder zephyrservice.
```
vi zeAuditService.properties
```

Add the below line in the file zeAuditService.properties.

#Audit Service port
server.port=8083

#Artemis Configuration
artemis.queue.name=ze_audit_queue
artemis.queue.host.broker.ip=localhost
artemis.queue.host.broker.port=61616
spring.artemis.mode=native

# Activate Profile {dbType} = mysql/mssql/oracle, {queueType} = artemis/rabbitmq
spring.profiles.active={dbType},{queueType}
spring.autoconfigure.exclude= org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration, org.springframework.boot.autoconfigure.jms.artemis.ArtemisAutoConfiguration

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

# Data source configurations applied for mssql
---
---
spring.config.activate.on-profile=mssql
spring.datasource.url=jdbc:sqlserver://<database_ipaddress>:<database_port>;database=itcc;encrypt=true;trustServerCertificate=true
spring.datasource.username=<datbase_username>
spring.datasource.password=<database_password>
spring.datasource.driver-class-name=com.microsoft.sqlserver.jdbc.SQLServerDriver
spring.jpa.hibernate.ddl-auto=none
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.SQLServer2012Dialect

# Data source configurations applied for mysql
---
---
spring.config.activate.on-profile=mysql
spring.datasource.url=jdbc:mysql://<database_ipaddress>:<database_port>/itcc?useUnicode=true&characterEncoding=utf-8&useSSL=false
spring.datasource.username=<datbase_username>
spring.datasource.password=<database_password>
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.jpa.hibernate.ddl-auto=none
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQLDialect

# Data source configurations applied for oracle
---
---
spring.config.activate.on-profile=oracle
spring.datasource.url=jdbc:oracle:thin:@<hostname>:<port>:orcl
spring.datasource.username=<datbase_username>
spring.datasource.password=<database_password>
spring.datasource.driver-class-name=oracle.jdbc.OracleDriver
spring.jpa.properties.hibernate.default_schema=itcc
spring.jpa.hibernate.ddl-auto=none
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.OracleDialect

An example of zeAuditService.properties for MySQL DB would look like the below:

#Audit Service port
server.port=8083

#Artemis Configuration
artemis.queue.name=ze_audit_queue
artemis.queue.host.broker.ip=localhost
artemis.queue.host.broker.port=61616
spring.artemis.mode=native

# Activate Profile {dbType} = mysql/mssql/oracle, {queueType} = artemis/rabbitmq
spring.profiles.active=mysql,artemis
spring.autoconfigure.exclude= org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration, org.springframework.boot.autoconfigure.jms.artemis.ArtemisAutoConfiguration


# Data source configurations applied for mysql
---
spring.config.activate.on-profile=mysql
spring.datasource.url=jdbc:mysql://localhost:3306/itcc?useUnicode=true&characterEncoding=utf-8&useSSL=false
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.jpa.hibernate.ddl-auto=none
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQLDialect

Open the “Terminal” or “Command Prompt”
Navigate to folder /opt/zephyrservice
Type the below command

Start the ze-audit-service with the following command:

sudo nohup java -jar -Dspring.profiles.active=DB,queue_name -DzeAuditConfigPath="<config file path till root folder>" ze-audit-service-main.jar &

Example command:

sudo nohup java -jar -Dspring.profiles.active=mysql,artemis -DzeAuditConfigPath="/opt/zephyrservice" ze-audit-service-main.jar &

Note

The Logs folder will be created where your jars are deployed. Separate log files will be created for each jar. In the above example, it will be in /opt/zephyrservice.

In this section:

ZE - Audit Service Deployment (Artemis)

Prerequisites

Audit Service Deployment (Jar)

Note

Search results