Getting started

This page allows you to know how to start developing an application with Ontimize Boot in a simple way. This project includes an HSQLDB database already prepared to start the application. It can be replaced.

Create application from archetype

Open a console and type the next command:

mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate -DgroupId=YOUR_GROUP_ID -DartifactId=YOUR_ARTIFACT_ID -Dversion=YOUR_VERSION -Dpackage=YOUR.GROUPID.ARTIFACTID -DarchetypeGroupId=com.ontimize -DarchetypeArtifactId=ontimize-boot-archetype -DarchetypeVersion=1.0.0 -DinteractiveMode=false -DarchetypeCatalog=https://artifactory.imatia.com/public-artifactory/ontimize-archetypes/archetype-catalog.xml

Command explanation

Argument Meaning
mvn Maven CLI
org.apache.maven.plugins:maven-archetype-plugin:2.4:generate Use the Maven Archetype Plugin (v2.4) for create a new project from an archetype
-DgroupId=YOUR_GROUP_ID Your project groupId
-DartifactId=YOUR_ARTIFACT_ID Your project artifactId
-Dversion=YOUR_VERSION Your project version
-Dpackage=YOUR.GROUPID.ARTIFACTID Sets the package on which the project will be based (e.g.: In our examples, this will be com.ontimize.projectwiki)
-DarchetypeGroupId=com.ontimize groupId of the Ontimize Boot archetype
-DarchetypeArtifactId=ontimize-boot-archetype artifactId of the Ontimize Boot archetype
-DarchetypeVersion=1.0.0 version of the Ontimize Boot archetype
-DinteractiveMode=false Forced to skip interactive mode and use the paramaters in the command
-DarchetypeCatalog=https://artifactory.imatia.com/public-artifactory/ontimize-archetypes/archetype-catalog.xml URL where you can find the archetype catalog

Start the project

To start the project, it is necessary to start both the database and the server. The first thing to do is to execute the mvn install command inside the project’s root folder

$ cd app
/app$ mvn install

Start the database

Next, we navigate to the model folder to start the HSQLDB database

/app$ cd model
/app/model$ mvn exec:java -Prun_database

Start the server

To start the server, open a new console in the root folder of the project, navigate to boot folder and type the following command

/app$ cd boot
/app/boot$ mvn spring-boot:run

Test the application

You can check if the application is working by making a request, for example, to the following address:

http://localhost:33333/users/user?columns=USER_

Through applications such as Postman or from the browser

In both cases, the access must be done with a user and password example:

    User: demo
Password: demouser