☰
Navigation :

Building and deploying the Accelerator

Building the Project

Maven Repositories

  • From the ActiveViam share page, download the maven repository for the version of ActivePivot the Sign-Off Module is based on (will be specified in the release notes of the Sign-Off Module you are deploying). The zip file containing the maven repository will be called maven-repository-<version number>.zip.

  • From the Sign-Off Module Release Notes page, follow the directions to the Distribution Files section and download the maven repository for the Sign-Off Module (contains all dependencies required to build the Sign-Off Module that aren’t included in the ActivePivot download). A zip file containing the maven repository will be called signoff-<version number>-maven-repository.zip.

Add these repositories to your existing maven repository.

Source

Download and unzip the source package from the Artifactory page.

Build

  1. 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 ActivePivot executable JAR file (signoff-tool/signoff-starter/target/sign-off-exec.jar)

  2. When the build is complete, you must deploy it. See Deployment

  3. Build the standalone UI application using npm or yarn.

  4. Deploy the UI application.

Configuration

See Project configuration.

Deployment

ActivePivot

The Sign-Off Module is a Spring Boot application that builds to an executable JAR. To deploy the executable JAR files, simply use the following command:

java -jar signoff-exec.jar

Note the executable JAR will publish the application on a specific port. To configure the port and context path, two properties are used:server.portand server.servlet.context-path. The default values are in resources/application.yaml, the standard configuration file for Spring Boot applications.

For example:

java -jar signoff-starter-exec.jar --server.port=<port>

This can also be changed by externalising the properties files (see Externalising Properties Files ).

The Sign-offf server will be available at: http://<your hostname>:9090/

ActiveUI

ActiveUI 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 after the project has been built.

As an example, the UI can be deployed on Tomcat using the following instructions:

  1. Build the standalone application:

    a. 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

  2. Place the deployment in the webapps folder of your Tomcat.

    a. Find where the webapps folder is for your Tomcat

    b. Create a folder called signoff-activeui in the Tomcat webapps folder

    c. Copy the contents from the build folder into your new folder webapps/signoff-activeui/

  3. Start the Tomcat server. You can then access the UI at the address http://<your hostname>:<port>/signoff-activeui/.

Externalising Properties Files

In the default implementation, all the necessary properties are within the project. A number of properties files have been externalised 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 two options to override default properties:

  • OPTION 1: Command line arguments, e.g.--csvSource.dataset=/path/to/folder . Note we are using “--”, instead of “-D” to set properties with Spring Boot.

  • OPTION 2: Create a properties file (e.g. application.properties and add your property overrides. Then pass it to the main using the command line argument --spring.config.additional-location=/<path>/application.properties