Add BuildVu as a Maven dependency

Table of contents

1. Adding the jar manually
2. Using our remote Maven repository
   1. 1. Add the repository
   2. 2. Add the dependency
      1. Customer artifact IDs
      2. Trial artifact IDs
      3. Daily builds

In order to use BuildVu in a Maven project, you will need to add the jar to the project as a dependency. You can either add the jar manually or use our remote Maven repository.

Adding the jar manually

1. Download the BuildVu jar from here
2. Install the jar into your local Maven repository

   mvn install:install-file -Dfile=<path-to-BuildVu-jar> -DgroupId=com.idrsolutions -Dpackaging=jar -DartifactId=buildvu -Dversion=1.0  
   

3. Once installed, add the following to the dependencies in your pom.xml:

   <dependencies>
       <dependency>
           <groupId>com.idrsolutions</groupId>
           <artifactId>buildvu</artifactId>
           <version>1.0</version>
       </dependency>
   </dependencies>
   

   The example above uses the values from step 2; if you used custom values, you will need to update these. The version (1.0) is arbitrary for a local install — it just needs to match between the install:install-file command and the dependency above; it is unrelated to the YYYY.MM release versions used for the remote repository below.

Using our remote Maven repository

1. Add the repository

Using our remote repository involves two parts: the repository is declared in your project’s pom.xml, and your login information goes in your user settings.xml.

First, in your project’s pom.xml, add our remote repository:

<repositories>
   <repository>
       <id>IDRsolutions</id>
       <name>IDR Solutions</name>
       <url>https://maven.idrsolutions.com</url>
   </repository>
</repositories>

Then add your login information to your user settings.xml, which can be found in your .m2 directory (usually in %userprofile%\.m2\ for windows, and ~/.m2/ for linux/mac). If settings.xml does not already exist, you can create it yourself (a reference for the file can be found here).

Add the following to your servers:

<servers>
    <server>
        <id>IDRsolutions</id>
        <username>{Customer Username or Trial Token}</username>
        <password>{Customer Password or Trial Token}</password>
    </server>
</servers>

For the trial, set both the username and password to your trial token.

2. Add the dependency

Finally, add BuildVu as a dependency in your pom.xml:

<dependencies>
    <dependency>
        <groupId>com.idrsolutions</groupId>
        <artifactId>{artifactId}</artifactId>
        <version>{version}</version>
    </dependency>
</dependencies>

Customer artifact IDs

• buildvu-html where version is in the format YYYY.MM

• buildvu-svg where version is in the format YYYY.MM

Only versions after 2021.11 are available, and we only support the most recent version of BuildVu.

Trial artifact IDs

• buildvu-html-trial where version is in the format YYYY.MM

• buildvu-svg-trial where version is in the format YYYY.MM

Daily builds

Customers may access daily builds with the following artifact IDs.

The Maven repository only stores the most recent daily build.

• buildvu-html-daily where version is in the format YYYY.MM.DD

• buildvu-svg-daily where version is in the format YYYY.MM.DD