Chapter 2. Project deployment in Business Central

Procedure

1. In your Red Hat Process Automation Manager installation directory, navigate to the standalone-full.xml file. For example, if you use a Red Hat JBoss EAP installation for Red Hat Process Automation Manager, go to $EAP_HOME/standalone/configuration/standalone-full.xml.

2. Open the standalone-full.xml file and under the <system-properties> tag, set the following JVM properties:

   Table 2.1. JVM Properties for the KIE Server instance

   Property	Value	Note
   org.kie.server.id	default-kie-server	The KIE Server ID.
   org.kie.server.controller	http://localhost:8080/business-central/rest/controller	The location of Business Central. The URL for connecting to the API of Business Central.
   org.kie.server.controller.user	controllerUser	The user name with the role rest-all who can log in to the Business Central.
   org.kie.server.controller.pwd	controllerUser1234;	The password of the user who can log in to the Business Central.
   org.kie.server.location	http://localhost:8080/kie-server/services/rest/server	The location of KIE Server. The URL for connecting to the API of KIE Server.

   Table 2.2. JVM Properties for the Business Central instance

   Property	Value	Note
   org.kie.server.user	controllerUser	The user name with the role kie-server.
   org.kie.server.pwd	controllerUser1234;	The password of the user.

   The following example shows how to configure a KIE Server instance:

   <property name="org.kie.server.id" value="default-kie-server"/>
   <property name="org.kie.server.controller" value="http://localhost:8080/business-central/rest/controller"/>
   <property name="org.kie.server.controller.user" value="controllerUser"/>
   <property name="org.kie.server.controller.pwd" value="controllerUser1234;"/>
   <property name="org.kie.server.location" value="http://localhost:8080/kie-server/services/rest/server"/>

   The following example shows how to configure a for Business Central instance:

   <property name="org.kie.server.user" value="controllerUser"/>
   <property name="org.kie.server.pwd" value="controllerUser1234;"/>

3. To verify that KIE Server starts successfully, send a GET request to http://SERVER:PORT/kie-server/services/rest/server/ when KIE Server is running. For more information about running Red Hat Process Automation Manager on KIE Server, see Running Red Hat Process Automation Manager.

   After successful authentication, you receive an XML response similar to the following example:

   <response type="SUCCESS" msg="Kie Server info">
       <kie-server-info>
           <capabilities>KieServer</capabilities>
           <capabilities>BRM</capabilities>
           <capabilities>BPM</capabilities>
           <capabilities>CaseMgmt</capabilities>
           <capabilities>BPM-UI</capabilities>
           <capabilities>BRP</capabilities>
           <capabilities>DMN</capabilities>
           <capabilities>Swagger</capabilities>
           <location>http://localhost:8230/kie-server/services/rest/server</location>
           <messages>
               <content>Server KieServerInfo{serverId='first-kie-server', version='7.5.1.Final-redhat-1', location='http://localhost:8230/kie-server/services/rest/server', capabilities=[KieServer, BRM, BPM, CaseMgmt, BPM-UI, BRP, DMN, Swagger]}started successfully at Mon Feb 05 15:44:35 AEST 2018</content>
               <severity>INFO</severity>
               <timestamp>2018-02-05T15:44:35.355+10:00</timestamp>
           </messages>
           <name>first-kie-server</name>
           <id>first-kie-server</id>
           <version>7.5.1.Final-redhat-1</version>
       </kie-server-info>
   </response>

4. Verify successful registration:

   1. Log in to Business Central.

   2. Click Menu Deploy Execution Servers.

      If registration is successful, you will see the registered server ID.

Procedure

1. To configure the KIE Server environment mode, set the org.kie.server.mode system property to org.kie.server.mode=development or org.kie.server.mode=production.

2. To configure the deployment behavior for a project in Business Central, go to project Settings General Settings Version and toggle the Development Mode option.

   Note

   By default, KIE Server and all new projects in Business Central are in development mode.

   You cannot deploy a project with Development Mode turned on or with a manually added SNAPSHOT version suffix to a KIE Server that is in production mode.

Procedure

1. Create a Maven settings.xml file with connection and access details for your external repository. For details about the settings.xml file, see the Maven Settings Reference.
2. Save the file in a known location, for example, /opt/custom-config/settings.xml.
3. In your Red Hat Process Automation Manager installation directory, navigate to the standalone-full.xml file. For example, if you use a Red Hat JBoss EAP installation for Red Hat Process Automation Manager, go to $EAP_HOME/standalone/configuration/standalone-full.xml.

4. Open standalone-full.xml and under the <system-properties> tag, set the kie.maven.settings.custom property to the full path name of the settings.xml file.

   For example:

   <property name="kie.maven.settings.custom" value="/opt/custom-config/settings.xml"/>

5. Start or restart Business Central and KIE Server.

Procedure

1. In Business Central, go to Menu Design Projects, click the project name, and select any asset in the project.
2. In the Project Explorer menu on the left side of the screen, click the Customize View gear icon and select Repository View pom.xml.

3. Add the following settings at the end of the project pom.xml file (before the </project> closing tag). The values must correspond to the settings that you defined in your settings.xml file.

   <distributionManagement>
   <repository>
   <id>${maven-repo-id}</id>
   <url>${maven-repo-url}</url>
   <layout>default</layout>
   </repository>
   </distributionManagement>

4. Click Save to save the pom.xml file changes.

Procedure

1. In Business Central, go to Menu Design Projects and click the project name.

2. In the upper-right corner, click Deploy to build the project and deploy it to a KIE Server. To compile the project without deploying it to KIE Server, click Build.

   Note

   You can also select the Build & Install option to build the project and publish the KJAR file to the configured Maven repository without deploying to a KIE Server. In a development environment, you can click Deploy to deploy the built KJAR file to a KIE Server without stopping any running instances (if applicable), or click Redeploy to deploy the built KJAR file and replace all instances. The next time you deploy or redeploy the built KJAR, the previous deployment unit (KIE container) is automatically updated in the same target KIE Server. In a production environment, the Redeploy option is disabled and you can click Deploy only to deploy the built KJAR file to a new deployment unit (KIE container) on a KIE Server.

   To configure the KIE Server environment mode, set the org.kie.server.mode system property to org.kie.server.mode=development or org.kie.server.mode=production. To configure the deployment behavior for a corresponding project in Business Central, go to project Settings General Settings Version and toggle the Development Mode option. By default, KIE Server and all new projects in Business Central are in development mode. You cannot deploy a project with Development Mode turned on or with a manually added SNAPSHOT version suffix to a KIE Server that is in production mode.

   If only one KIE Server is connected to Business Central, or if all connected KIE Servers are in the same server configuration, the services in the project are started automatically in a deployment unit (KIE container).

   If multiple server configurations are available, a deployment dialog is displayed in Business Central, prompting you to specify server and deployment details.

3. If the deployment dialog appears, verify or set the following values:

   • Deployment Unit Id / Deployment Unit Alias: Verify the name and alias of the deployment unit (KIE container) running the service within KIE Server. You normally do not need to change these settings. For more information about KIE container aliases, see Section 2.6.3, “KIE container aliases”.
   • Server Configuration: Select the server configuration for deploying this project. You can later deploy it to other configured servers without rebuilding the project.
   • Start Deployment Unit?: Verify that this box is selected to start the deployment unit (KIE container). If you clear this box, the service is deployed onto the server but not started.

   To review project deployment details, click View deployment details in the deployment banner at the top of the screen or in the Deploy drop-down menu. This option directs you to the Menu Deploy Execution Servers page.

Procedure

1. In Business Central, go to Menu Design Projects and click the project name.
2. Click the project Settings tab.

3. In General Settings, modify the Group ID, Artifact ID, or Version fields as necessary. If you have deployed the project and are developing a new version, usually you need to increase the version number.

   Note

   For development purposes only, you can toggle the Development Mode option in project Settings General Settings Version to add the SNAPSHOT suffix in the project version. This suffix instructs Maven to get a new snapshot update according to the Maven policy. Do not use Development Mode or manually add the SNAPSHOT version suffix for a production environment.

4. Click Save to finish.