Building and deploying the solution

Building the Project

Set up Artifactory access

You can download all Maven dependencies from Artifactory by setting up your Maven settings file:

<settings>
    <profiles>
        <profile>
            <id>default</id>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>

            <repositories>
                <repository>
                    <id>ActiveViamMvn</id>
                    <name>ActiveViam Maven Repository</name>
                    <url>https://activeviam.jfrog.io/artifactory/mvn/</url>
                </repository>
                <repository>
                    <id>ActiveViamGeneric</id>
                    <name>ActiveViam Generic Repository</name>
                    <url>https://activeviam.jfrog.io/artifactory/generic/</url>
                </repository>
            </repositories>
        </profile>
    </profiles>

    <servers>
        <server>
            <id>ActiveViamMvn</id>
            <username>username</username>
            <password>password</password>
        </server>
        <server>
            <id>ActiveViamGeneric</id>
            <username>username</username>
            <password>password</password>
        </server>
    </servers>
</settings>

To download the dependencies for the UI, you need to set up access to Artifactory via npm:

npm login --scope @activeviam --registry https://activeviam.jfrog.io/artifactory/npm/

The result is the following message:

Logged in as username to scope @activeviam on https://activeviam.jfrog.io/artifactory/npm/.

If the scope isn’t mentioned in the message, change the command to the following:

npm login --scope=@activeviam --registry=https://activeviam.jfrog.io/artifactory/npm/

Source

Download and unzip the source zip from the Artifactory page.

Build

To compile the source code using Maven, you must set your MAVEN_OPTS environment variable, to pass Java options, like so: MAVEN_OPTS="-Xss8m".

You may need to change the stack size with this option. Here are some useful parameters:

-Xms<size>        set initial Java heap size
-Xmx<size>        set maximum Java heap size
-Xss<size>        set java thread stack size

Once you have added all the maven repositories and extracted the source code, run mvn install on the parent pom file to build the entire project. This will build the executable JAR files for Atoti Server (frtb-starter/target/frtb-starter-exec.jar).
When the build is complete, you must deploy it. See Deployment.
Build the standalone UI application using npm or yarn.
Deploy the UI application.

Configuration

See Project configuration.

Deployment

Atoti Server

The frtb-starter is a Spring Boot application that builds to an executable JAR. To deploy the executable JAR file, simply use the following command:

java --add-opens java.base/java.util.concurrent=ALL-UNNAMED -jar frtb-starter-exec.jar

Note that the executable JAR will publish the application on a specific port. The default port for frtb-starter is 8080. Atoti Server will be available at: http://<your hostname>:8080/frtb-starter/ You can change the port by either of the following:

Use the argument server.port. For example:

java --add-opens java.base/java.util.concurrent=ALL-UNNAMED -jar frtb-starter-exec.jar --server.port=<port>

Externalize the properties files (see Externalizing Properties Files )

Atoti UI

Atoti UI is a static website that can be deployed in any way you see fit. All the necessary files are to be found in the ./build folder of the standalone application after the project has been built. As an example, the UI can be deployed on Tomcat using the following instructions:

Build the standalone application:
1. Use maven to build the project. You can use the command mvn clean install on the parent pom - This will build all the necessary modules including the JavaScript UI
Place the deployment in the webapps folder of your Tomcat
1. Find where the webapps folder is for your Tomcat
2. Create a folder called frtb-activeui in the Tomcat webapps folder
3. Copy the contents from the build folder into your new folder webapps/frtb-activeui/
Start the Tomcat server. You can now access the UI on the address http://<your hostname>:<port>/frtb-activeui/.

Externalizing Properties Files

In the default implementation, all the necessary properties are within the project. A number of properties files have been externalized and can be overridden with an external file using JVM variables. You may wish to use this functionality if you are running the project in different environments. Below is a list of the files together with their respective variable names: There are three options to override default properties:

OPTION 1: Command line arguments, e.g. --csv-source.dataset=/path/to/folder.

Note:
Here we use “--” when providing the option after calling the jar.
If the option was called first, then “-D” is used.
OPTION 2: Create a properties file (e.g. application.properties) and add the property overrides. Then pass it to the main using the command line argument --spring.config.additional-location=/<path> application.properties
OPTION 3: Change the path to the default properties file using the appropriate variable specified below:

File	Variable Name
application.properties	app.env.properties.file.path
hibernate.properties	hibernate.env.properties.file.path

If any of the above variables are not set, the default properties files will be used. Example values for these properties files include:

classpath:<filename>;
file:/home/etc/<filename>; - Unix Environment
file:///C:/Users/john/config/<filename>; - Windows environment

For more details, see the Spring Boot documentation.

Options 1 and 2 are recommended because they only override the properties you specify and use the defaults for other ones. Additionally, they can be used to override any property.Option 3 only works for specific properties files (i.e. the ones specified in the table above), and replaces the default file completely, meaning you need to make a copy of the default file and have all properties in your external custom file even if they have the same value as the default file.

​Building the Project

​Set up Artifactory access

​Source

​Build

​Configuration

​Deployment

​Atoti Server

​Atoti UI

​Externalizing Properties Files

Building the Project

Set up Artifactory access

Source

Build

Configuration

Deployment

Atoti Server

Atoti UI

Externalizing Properties Files