Getting Started

This document presents an overview of odi test manager and explains how users can get started with it.

Installation Requirements

Software Requirements

Software Requirements

Hardware Requirements

The following show minimum hardware requirements to run odi test manager

CPU : Minimum 4 Core
Memory : Minimum 8GB RAM
HDD : Minimum 5GB (depends on data capacity used)

Download

The odi test manager can be downloaded from the link below:

Resources

Installation

The downloaded file, on which should be located where execution permission for all users is allowed, can be uncompressed.

The below show its structure:

	Folder Name	Description
1	bin	files related with execution and termination can be found
2	conf	configuration files can be found
3	database	h2 database automatically created once odi test manager runs
4	logs	log files can be found here
5	uploads	attachment files

Configuration

As an example, "application.properties" under "conf" directory can be modified for configuration purpose

The following show an example of "application.properties"

# Set endpoint HTTP port 
server.port = 8080

# Whether to enable the console
spring.h2.console.enabled=true
# Path at which the console is available
spring.h2.console.path=/h2-console

#--------------------------------------------------------------------------------------------------
# DATABASE
#
# IMPORTANT:
# - The embedded H2 database is used by default. It is recommended for tests but not for
# production use. Supported databases are MySQL, PostgreSQL.
#--------------------------------------------------------------------------------------------------

#----- Embedded Database (default)
# JDBC URL of the database.
spring.datasource.url=jdbc:h2:file:./database/h2
# Login username & password of the database.
spring.datasource.username=sa
spring.datasource.password=
# Fully qualified name of the JDBC driver.
spring.datasource.driver-class-name=org.h2.Driver

# DDL mode. This is actually a shortcut for the "hibernate.hbm2ddl.auto" property.
spring.jpa.hibernate.ddl-auto = update
# Fully qualified name of the physical naming strategy.
spring.jpa.hibernate.naming.physical-strategy=org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl
# Additional native properties to set on the JPA provider.
spring.jpa.properties.hibernate.show_sql=false
spring.jpa.properties.hibernate.use_sql_comments=false
spring.jpa.properties.hibernate.format_sql=true

#----- MySQL >=5.6
# Only InnoDB storage engine is supported (not myISAM).

#spring.datasource.type=org.apache.tomcat.jdbc.pool.DataSource
#spring.datasource.url=jdbc:mysql://localhost:3306/odidb?autoReconnect=true&useUnicode=true&characterEncoding=utf-8
#spring.datasource.url=jdbc:mysql://localhost:3306/odidb?useUnicode=yes&characterEncoding=UTF-8
#spring.datasource.username=odiuser
#spring.datasource.password=odiuser
#spring.datasource.driver-class-name=com.mysql.jdbc.Driver
#
# Whether to initialize the schema on startup.
#spring.jpa.generate-ddl=true
# Whether to enable logging of SQL statements.
#spring.jpa.show-sql=true
#spring.jpa.database=mysql
#spring.jpa.database-platform=org.hibernate.dialect.MySQL5InnoDBDialect
#
#spring.jpa.hibernate.ddl-auto=update
#spring.jpa.hibernate.naming.strategy=org.hibernate.cfg.ImprovedNamingStrategy
#spring.jpa.hibernate.naming.physical-strategy=org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl
#spring.jpa.properties.hibernate.format_sql=true
#spring.jpa.properties.hibernate.enable_lazy_load_no_trans=true
#
# Whether to enable support of multipart uploads.
##spring.servlet.multipart.enabled=true

#Enable shutdown endpoint
management.endpoints.web.exposure.include=*
management.endpoint.shutdown.enabled=true

#No auth protected
management.security.enabled=false

#upload file size and path settings
upload.filesize=20MB
upload.path=uploads/

Note:

upload.filesize

It cannot exceed some mega bytes. ie, if the upload file size 1GB, it could result in abnormal behavior of the system. it is not allowed to change its unit, for instance, to KB or GB.
if this property is not present in conf/application.properties, a default maximum upload file size is 20MB

Run odi test manager

odi test manager can be started with the following commands:

Windows

bin\start-odi.bat

Linux

./bin/start-odi.sh

Shutdown odi test manager

odi test manager can be shutdown with the following commands:

Windows

bin\stop-odi.bat

Linux

./bin/stop-odi.sh