Chapter 9. Maven settings and repositories for Red Hat Process Automation Manager

Procedure

1. Generate a Maven project. A pom.xml file is automatically generated when you create a Maven project.

2. Edit the pom.xml file to add more dependencies and new repositories.

   Maven downloads all of the JAR files and the dependent JAR files from the Maven repository when you compile and package your project.

Procedure

1. In the settings.xml file, declare the repositories that your Red Hat Process Automation Manager projects use. Usually, this is either the online Red Hat Process Automation Manager Maven repository or the Red Hat Process Automation Manager Maven repository that you download from the Red Hat Customer Portal and any repositories for custom artifacts that you want to use.

2. Ensure that Business Central or Process Server is configured to use the settings.xml file. For example, specify the kie.maven.settings.custom=<SETTINGS_FILE_PATH> property where <SETTINGS_FILE_PATH> is the path to the settings.xml file.

   On Red Hat JBoss Web Server, for Process Server add -Dkie.maven.settings.custom=<SETTINGS_FILE_PATH> to the CATALINA_OPTS section of the setenv.sh (Linux) or setenv.bat (Windows) file. For standalone Business Central, enter the following command:

   java -jar rhpam-7.6.0-business-central-standalone.jar -s application-config.yaml -Dkie.maven.settings.custom=<SETTINGS_FILE_PATH>

Procedure

1. Declare the Red Hat Business Automation BOM in the pom.xml file:

   <dependencyManagement>
    <dependencies>
     <dependency>
      <groupId>com.redhat.ba</groupId>
      <artifactId>ba-platform-bom</artifactId>
      <version>7.6.0.redhat-00004</version>
      <type>pom</type>
      <scope>import</scope>
     </dependency>
    </dependencies>
   </dependencyManagement>
   <dependencies>
   <!-- Your dependencies -->
   </dependencies>

2. Declare dependencies required for your project in the <dependencies> tag. After you import the product BOM into your project, the versions of the user-facing product dependencies are defined so you do not need to specify the <version> sub-element of these <dependency> elements. However, you must use the <dependency> element to declare dependencies which you want to use in your project.

3. For standalone projects that are not authored in Business Central, specify all dependencies required for your projects. In projects that you author in Business Central, the basic decision engine and process engine dependencies are provided automatically by Business Central.

   • For a basic Red Hat Process Automation Manager project, declare the following dependencies, depending on the features that you want to use:

     Embedded process engine dependencies

     <!-- Public KIE API -->
     <dependency>
       <groupId>org.kie</groupId>
       <artifactId>kie-api</artifactId>
     </dependency>
     
     <!-- Core dependencies for process engine -->
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-flow</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-flow-builder</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-bpmn2</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-runtime-manager</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-persistence-jpa</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-query-jpa</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-audit</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-kie-services</artifactId>
     </dependency>
     
     <!-- Dependency needed for default WorkItemHandler implementations. -->
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-workitems-core</artifactId>
     </dependency>
     
     <!-- Logging dependency. You can use any logging framework compatible with slf4j. -->
     <dependency>
       <groupId>ch.qos.logback</groupId>
       <artifactId>logback-classic</artifactId>
       <version>${logback.version}</version>
     </dependency>

   • For a Red Hat Process Automation Manager project that uses CDI, you typically declare the following dependencies:

     CDI-enabled process engine dependencies

     <dependency>
       <groupId>org.kie</groupId>
       <artifactId>kie-api</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-kie-services</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-services-cdi</artifactId>
     </dependency>

   • For a basic Red Hat Process Automation Manager project, declare the following dependencies:

     Embedded decision engine dependencies

     <dependency>
       <groupId>org.drools</groupId>
       <artifactId>drools-compiler</artifactId>
     </dependency>
     
     <!-- Dependency for persistence support. -->
     <dependency>
       <groupId>org.drools</groupId>
       <artifactId>drools-persistence-jpa</artifactId>
     </dependency>
     
     <!-- Dependencies for decision tables, templates, and scorecards.
     For other assets, declare org.drools:business-central-models-* dependencies. -->
     <dependency>
       <groupId>org.drools</groupId>
       <artifactId>drools-decisiontables</artifactId>
     </dependency>
     <dependency>
       <groupId>org.drools</groupId>
       <artifactId>drools-templates</artifactId>
     </dependency>
     <dependency>
       <groupId>org.drools</groupId>
       <artifactId>drools-scorecards</artifactId>
     </dependency>
     
     <!-- Dependency for loading KJARs from a Maven repository using KieScanner. -->
     <dependency>
       <groupId>org.kie</groupId>
       <artifactId>kie-ci</artifactId>
     </dependency>

   • To use the Process Server, declare the following dependencies:

     Client application Process Server dependencies

     <dependency>
       <groupId>org.kie.server</groupId>
       <artifactId>kie-server-client</artifactId>
     </dependency>

   • To create a remote client for Red Hat Process Automation Manager, declare the following dependency:

     Client dependency

     <dependency>
       <groupId>org.uberfire</groupId>
       <artifactId>uberfire-rest-client</artifactId>
     </dependency>

   • When creating a JAR file that includes assets, such as rules and process definitions, specify the packaging type for your Maven project as kjar and use org.kie:kie-maven-plugin to process the kjar packaging type located under the <project> element. In the following example, ${kie.version} is the Maven library version listed in What is the mapping between Red Hat Process Automation Manager and the Maven library version?:

     <packaging>kjar</packaging>
     <build>
      <plugins>
       <plugin>
        <groupId>org.kie</groupId>
        <artifactId>kie-maven-plugin</artifactId>
        <version>${kie.version}</version>
        <extensions>true</extensions>
       </plugin>
      </plugins>
     </build>

Procedure

1. On the computer that has an outgoing connection to the public Internet, complete the following steps:

   1. Download the latest version of the Offliner tool.
   2. Download the rhpam-7.6.0-offliner.txt product deliverable file from the Software Downloads page of the Red Hat Customer Portal.

   3. Enter the following command to use the Offliner tool to download the required artifacts:

      java -jar offliner-<version>.jar -r https://maven.repository.redhat.com/ga/ -r https://repo1.maven.org/maven2/ -d /home/user/temp rhpam-7.6.0-offliner.txt

      Replace /home/user/temp with an empty temporary directory and <version> with the version of the Offliner tool that you downloaded. The download can take a significant amount of time.

2. If you developed services outside Business Central and they have additional dependencies, add the dependencies to the mirror repository. If you developed the services as Maven projects, you can use the following steps to prepare these dependencies automatically. Complete the steps on the computer that has an outgoing connection to the public Internet.

   1. Create a backup of the local Maven cache directory (~/.m2/repository) and then clear the directory.
   2. Build the source of your projects using the mvn clean install command.

   3. For every project, enter the following command to ensure that Maven downloads all runtime dependencies for all the artifacts generated by the project:

      mvn -e -DskipTests dependency:go-offline -f /path/to/project/pom.xml --batch-mode -Djava.net.preferIPv4Stack=true

      Replace /path/to/project/pom.xml with the correct path to the pom.xml file of the project.

   4. Copy the contents of the local Maven cache directory (~/.m2/repository) to the temporary directory that you are using.
3. Copy the contents of the temporary directory to a directory on the computer on which you deployed Red Hat Process Automation Manager. This directory becomes the offline Maven mirror repository.
4. Create and configure a settings.xml file for your Red Hat Process Automation Manager deployment, according to instructions in Section 9.2, “Modifying the Maven settings file”.

5. Make the following changes in the settings.xml file:

   • Under the <profile> tag, if a <repositories> or <pluginRepositores> tag is absent, add the tags as necessary.

   • Under <repositories> add the following sequence:

     <repository>
       <id>offline-repository</id>
       <url>file:///path/to/repo</url>
       <releases>
         <enabled>true</enabled>
       </releases>
       <snapshots>
         <enabled>false</enabled>
       </snapshots>
     </repository>

     Replace /path/to/repo with the full path to the local Maven mirror repository directory.

   • Under <pluginRepositories> add the following sequence:

     <repository>
       <id>offline-plugin-repository</id>
       <url>file:///path/to/repo</url>
       <releases>
         <enabled>true</enabled>
       </releases>
       <snapshots>
         <enabled>false</enabled>
       </snapshots>
     </repository>

     Replace /path/to/repo with the full path to the local Maven mirror repository directory.