Getting started with Red Hat Decision Manager

Procedure

1. In Business Central, go to Menu → Design → Projects. If there are existing projects, you can access the samples by clicking the MySpace default space and selecting Try Samples from the Add Project drop-down menu. If there are no existing projects, click Try samples.
2. Review the descriptions for each sample project to determine which project you want to explore. Each sample project is designed differently to demonstrate decision management or business optimization assets and logic in Red Hat Decision Manager.
3. Select one or more sample projects and click Ok to add the projects to your space.
4. In the Projects page of your space, select one of the sample projects to view the assets for that project.

5. Select each asset to explore how the project is designed to achieve the specified goal or workflow. Some of the sample projects contain more than one page of assets. Click the left or right arrows in the upper-right corner to view the full asset list.

   Figure 1.1. Asset page selection

   

6. In the upper-right corner of the project Assets page, click Build to build the sample project or Deploy to build the project and then deploy it to KIE Server.

   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, toggle the Development Mode option, and click Save. 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.

   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 your VS Code IDE, select the Extensions menu option and search for Red Hat Business Automation Bundle for DMN, BPMN, and test scenario file support.

   For DMN or BPMN file support only, you can also search for the individual DMN Editor or BPMN Editor extensions.

2. When the Red Hat Business Automation Bundle extension appears in VS Code, select it and click Install.
3. For optimal VS Code editor behavior, after the extension installation is complete, reload or close and re-launch your instance of VS Code.

Procedure

1. Install the standalone editors using one of the following methods:

   Download each JavaScript file manually: For this method, follow these steps:

   1. Download the JavaScript files.
   2. Add the downloaded Javascript files to your hosted application.

   3. Add the following <script> tag to your HTML page:

      Script tag for your HTML page for the DMN editor

      <script src="https://<YOUR_PAGE>/dmn/index.js"></script>

      Script tag for your HTML page for the BPMN editor

      <script src="https://<YOUR_PAGE>/bpmn/index.js"></script>

   Use the NPM package: For this method, follow these steps:

   1. Add the NPM package to your package.json file:

      Adding the NPM package

      npm install @kie-tools/kie-editors-standalone

   2. Import each editor library to your TypeScript file:

      Importing each editor

      import * as DmnEditor from "@kie-tools/kie-editors-standalone/dist/dmn"
      import * as BpmnEditor from "@kie-tools/kie-editors-standalone/dist/bpmn"

2. After you install the standalone editors, open the required editor by using the provided editor API, as shown in the following example for opening a DMN editor. The API is the same for each editor.

   Opening the DMN standalone editor

   const editor = DmnEditor.open({
     container: document.getElementById("dmn-editor-container"),
     initialContent: Promise.resolve(""),
     readOnly: false,
     origin: "",
     resources: new Map([
       [
         "MyIncludedModel.dmn",
         {
           contentType: "text",
           content: Promise.resolve("")
         }
       ]
     ])
   });

   Use the following parameters with the editor API:

   Table 2.1. Example parameters

   Parameter	Description
   container	HTML element in which the editor is appended.
   initialContent	Promise to a DMN model content. This parameter can be empty, as shown in the following examples: Promise.resolve("") Promise.resolve("<DIAGRAM_CONTENT_DIRECTLY_HERE>") fetch("MyDmnModel.dmn").then(content ⇒ content.text())
   readOnly (Optional)	Enables you to allow changes in the editor. Set to false (default) to allow content editing and true for read-only mode in editor.
   origin (Optional)	Origin of the repository. The default value is window.location.origin.
   resources (Optional)	Map of resources for the editor. For example, this parameter is used to provide included models for the DMN editor or work item definitions for the BPMN editor. Each entry in the map contains a resource name and an object that consists of content-type (text or binary) and content (similar to the initialContent parameter).

   The returned object contains the methods that are required to manipulate the editor.

   Table 2.2. Returned object methods

   Method	Description
   getContent(): Promise<string>	Returns a promise containing the editor content.
   setContent(path: string, content: string): void	Sets the content of the editor.
   getPreview(): Promise<string>	Returns a promise containing an SVG string of the current diagram.
   subscribeToContentChanges(callback: (isDirty: boolean) ⇒ void): (isDirty: boolean) ⇒ void	Sets a callback to be called when the content changes in the editor and returns the same callback to be used for unsubscription.
   unsubscribeToContentChanges(callback: (isDirty: boolean) ⇒ void): void	Unsubscribes the passed callback when the content changes in the editor.
   markAsSaved(): void	Resets the editor state that indicates that the content in the editor is saved. Also, it activates the subscribed callbacks related to content change.
   undo(): void	Undoes the last change in the editor. Also, it activates the subscribed callbacks related to content change.
   redo(): void	Redoes the last undone change in the editor. Also, it activates the subscribed callbacks related to content change.
   close(): void	Closes the editor.
   getElementPosition(selector: string): Promise<Rect>	Provides an alternative to extend the standard query selector when an element lives inside a canvas or a video component. The selector parameter must follow the <PROVIDER>:::<SELECT> format, such as Canvas:::MySquare or Video:::PresenterHand. This method returns a Rect representing the element position.
   envelopeApi: MessageBusClientApi<KogitoEditorEnvelopeApi>	This is an advanced editor API. For more information about advanced editor API, see MessageBusClientApi and KogitoEditorEnvelopeApi.

Procedure

1. On the traffic-violation project’s home page, click Add Asset.

2. On the Add Asset page, click DMN. The Create new DMN window is opened.

   1. In the Create new DMN window, enter Traffic Violation in the DMN name field.
   2. From the Package list, select com.myspace.traffic_violation.
   3. Click Ok. The DMN asset in the DMN designer is opened.

3. In the DMN designer canvas, drag two DMN Input Data input nodes onto the canvas.

   Figure 5.2. DMN Input Data nodes

   
4. In the upper-right corner, click the icon.
5. Double-click the input nodes and rename one to Driver and the other to Violation.
6. Drag a DMN Decision decision node onto the canvas.
7. Double-click the decision node and rename it to Fine.

8. Click the Violation input node, select the Create DMN Information Requirement icon and click the Fine decision node to link the two nodes.

   Figure 5.3. Create DMN Information Requirement icon

   
9. Drag a DMN Decision decision node onto the canvas.
10. Double-click the decision node and rename it to Should the driver be suspended?.
11. Click the Driver input node, select the Create DMN Information Requirement icon and click the Should the driver be suspended? decision node to link the two nodes.
12. Click the Fine decision node, select the Create DMN Information Requirement icon, and select the Should the driver be suspended? decision node.

13. Click Save.

    Note

    As you periodically save a DRD, the DMN designer performs a static validation of the DMN model and might produce error messages until the model is defined completely. After you finish defining the DMN model completely, if any errors remain, troubleshoot the specified problems accordingly.

Procedure

1. To create the tDriver custom data type, click Add a custom Data Type on the Data Types tab, enter tDriver in the Name field, and select Structure from the Type list.

2. Click the check mark to the right of the new data type to save your changes.

   Figure 5.5. The tDriver custom data type

   

3. Add each of the following nested data types to the tDriver structured data type by clicking the plus sign next to tDriver for each new nested data type. Click the check mark to the right of each new data type to save your changes.

   • Name (string)
   • Age (number)
   • State (string)
   • City (string)
   • Points (number)
4. To create the tViolation custom data type, click New Data Type, enter tViolation in the Name field, and select Structure from the Type list.

5. Click the check mark to the right of the new data type to save your changes.

   Figure 5.6. The tViolation custom data type

   

6. Add each of the following nested data types to the tViolation structured data type by clicking the plus sign next to tViolation for each new nested data type. Click the check mark to the right of each new data type to save your changes.

   • Code (string)
   • Date (date)
   • Type (string)
   • Speed Limit (number)
   • Actual Speed (number)

7. To add the following constraints to the Type nested data type, click the edit icon, click Add Constraints, and select Enumeration from the Select constraint type drop-down menu.

   • speed
   • parking
   • driving under the influence
8. Click OK, then click the check mark to the right of the Type data type to save your changes.

9. To create the tFine custom data type, click New Data Type, enter tFine in the Name field, select Structure from the Type list, and click Save.

   Figure 5.7. The tFine custom data type

   

10. Add each of the following nested data types to the tFine structured data type by clicking the plus sign next to tFine for each new nested data type. Click the check mark to the right of each new data type to save your changes.

    • Amount (number)
    • Points (number)
11. Click Save.

Procedure

1. Click the Model tab on the DMN designer and click the Properties icon in the upper-right corner of the DMN designer to expose the DRD properties.
2. In the DRD, select the Driver input data node and in the Properties panel, select tDriver from the Data type drop-down menu.
3. Select the Violation input data node and select tViolation from the Data type drop-down menu.
4. Select the Fine decision node and select tFine from the Data type drop-down menu.

5. Select the Should the driver be suspended? decision node and set the following properties:

   • Data type: string
   • Question: Should the driver be suspended due to points on his driver license?
   • Allowed Answers: Yes,No
6. Click Save.

Procedure

1. To calculate the fine, in the DMN designer canvas, select the Fine decision node and click the Edit icon to open the DMN boxed expression designer.

   Figure 5.10. Decision node edit icon

   

2. Click Select expression → Decision Table.

   Figure 5.11. Select Decisiong Table logic type

   
3. For the Violation.Date, Violation.Code, and Violation.Speed Limit columns, right-click and select Delete for each field.
4. Click the Violation.Actual Speed column header and enter the expression Violation.Actual Speed - Violation.Speed Limit in the Expression field."

5. Enter the following values in the first row of the decision table:

   • Violation.Type: "speed"
   • Violation.Actual Speed - Violation.Speed Limit: [10..30)
   • Amount: 500

   • Points: 3

     Right-click the first row and select Insert below to add another row.

6. Enter the following values in the second row of the decision table:

   • Violation.Type: "speed"
   • Violation.Actual Speed - Violation.Speed Limit: >= 30
   • Amount: 1000

   • Points: 7

     Right-click the second row and select Insert below to add another row.

7. Enter the following values in the third row of the decision table:

   • Violation.Type: "parking"
   • Violation.Actual Speed - Violation.Speed Limit: -
   • Amount: 100

   • Points: 1

     Right-click the third row and select Insert below to add another row.

8. Enter the following values in the fourth row of the decision table:

   • Violation.Type: "driving under the influence"
   • Violation.Actual Speed - Violation.Speed Limit: -
   • Amount: 1000
   • Points: 5
9. Click Save.
10. To define the driver suspension rule, return to the DMN designer canvas, select the Should the driver be suspended? decision node, and click the Edit icon to open the DMN boxed expression designer.
11. Click Select expression → Context.
12. Click ContextEntry-1, enter Total Points as the Name, and select number from the Data Type drop-down menu.
13. Click the cell next to Total Points, select Literal expression from the context menu, and enter Driver.Points + Fine.Points as the expression.
14. In the cell below Driver.Points + Fine.Points, select Literal Expression from the context menu, and enter if Total Points >= 20 then "Yes" else "No".

15. Click Save.

    You have defined how to calculate the fine and the context for deciding when to suspend the driver. You can navigate to the traffic-violation project page and click Build to build the example project and address any errors noted in the Alerts panel.

Procedure

1. On the traffic-violation project’s home screen, click Add Asset to open the Add Asset screen.

2. Click Test Scenario to open the Create new Test Scenario dialog.

   1. Enter Violation Scenarios in the Test Scenario field.
   2. From the Package list, select com.myspace.traffic_violation.
   3. Select DMN as the Source type.
   4. From the Choose a DMN asset list, select the path to the DMN asset.
   5. Click Ok to open the Violation Scenarios test scenario in the Test Scenarios designer.
3. Under Driver column sub-header, right-click the State, City, Age, and Name value cells and select Delete column from the context menu options to remove them.
4. Under Violation column sub-header, right-click the Date and Code value cells and select Delete column to remove them.

5. Enter the following information in the first row of the test scenarios:

   • Scenario description: Above speed limit: 10km/h and 30 km/h
   • Points (under Given column header): 10
   • Type: "speed"
   • Speed Limit: 100
   • Actual Speed: 120
   • Points: 3
   • Amount: 500

   • Should the driver be suspended?: "No"

     Right-click the first row and select Insert row below to add another row.

6. Enter the following information in the second row of the test scenarios:

   • Scenario description: Above speed limit: more than 30 km/h
   • Points (under Given column header): 10
   • Type: "speed"
   • Speed Limit: 100
   • Actual Speed: 150
   • Points: 7
   • Amount: 1000

   • Should the driver be suspended?: "No"

     Right-click the second row and select Insert row below to add another row.

7. Enter the following information in the third row of the test scenarios:

   • Scenario description: Parking violation
   • Points (under Given column header): 10
   • Type: "parking"
   • Speed Limit: leave blank
   • Actual Speed: leave blank
   • Points: 1
   • Amount: 100

   • Should the driver be suspended?: "No"

     Right-click the third row and select Insert row below to add another row.

8. Enter the following information in the fourth row of the test scenarios:

   • Scenario description: DUI violation
   • Points (under Given column header): 10
   • Type: "driving under the influence"
   • Speed Limit: leave blank
   • Actual Speed: leave blank
   • Points: 5
   • Amount: 1000

   • Should the driver be suspended?: "No"

     Right-click the fourth row and select Insert row below to add another row.

9. Enter the following information in the fifth row of the test scenarios:

   • Scenario description: Driver suspended
   • Points (under Given column header): 15
   • Type: "speed"
   • Speed Limit: 100
   • Actual Speed: 140
   • Points: 7
   • Amount: 1000
   • Should the driver be suspended?: "Yes"
10. Click Save.

11. Click the Play icon to check whether the test scenarios pass or fail.

    Figure 6.2. Test scenario execution result for the traffic violations example

    

    In case of failure, correct the errors and run the test scenarios again.

Procedure

1. Determine the base URL for accessing the KIE Server REST API endpoints. This requires knowing the following values (with the default local deployment values as an example):

   • Host (localhost)
   • Port (8080)
   • Root context (kie-server)
   • Base REST path (services/rest/)

   Example base URL in local deployment for the traffic violations project:

   http://localhost:8080/kie-server/services/rest/server/containers/traffic-violation_1.0.0-SNAPSHOT

2. Determine user authentication requirements.

   When users are defined directly in the KIE Server configuration, HTTP Basic authentication is used and requires the user name and password. Successful requests require that the user have the kie-server role.

   The following example demonstrates how to add credentials to a curl request:

   curl -u username:password <request>

   If KIE Server is configured with Red Hat Single Sign-On, the request must include a bearer token:

   curl -H "Authorization: bearer $TOKEN" <request>

3. Specify the format of the request and response. The REST API endpoints work with both JSON and XML formats and are set using request headers:

   JSON

   curl -H "accept: application/json" -H "content-type: application/json"

   XML

   curl -H "accept: application/xml" -H "content-type: application/xml"

4. Optional: Query the container for a list of deployed decision models:

   [GET] server/containers/{containerId}/dmn

   Example curl request:

   curl -u wbadmin:wbadmin -H "accept: application/xml" -X GET "http://localhost:8080/kie-server/services/rest/server/containers/traffic-violation_1.0.0-SNAPSHOT/dmn"

   Sample XML output:

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <response type="SUCCESS" msg="Ok models successfully retrieved from container 'traffic-violation_1.0.0-SNAPSHOT'">
       <dmn-model-info-list>
           <model>
               <model-namespace>https://kiegroup.org/dmn/_60b01f4d-e407-43f7-848e-258723b5fac8</model-namespace>
               <model-name>Traffic Violation</model-name>
               <model-id>_2CD7D1AA-BD84-4B43-AD21-B0342ADE655A</model-id>
               <decisions>
                   <dmn-decision-info>
                       <decision-id>_23428EE8-DC8B-4067-8E67-9D7C53EC975F</decision-id>
                       <decision-name>Fine</decision-name>
                   </dmn-decision-info>
                   <dmn-decision-info>
                       <decision-id>_B5EEE2B1-915C-44DC-BE43-C244DC066FD8</decision-id>
                       <decision-name>Should the driver be suspended?</decision-name>
                   </dmn-decision-info>
               </decisions>
               <inputs>
                   <dmn-inputdata-info>
                       <inputdata-id>_CEB959CD-3638-4A87-93BA-03CD0FB63AE3</inputdata-id>
                       <inputdata-name>Violation</inputdata-name>
                       <inputdata-typeref>
                           <namespace-uri>https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8</namespace-uri>
                           <local-part>tViolation</local-part>
                           <prefix></prefix>
                       </inputdata-typeref>
                   </dmn-inputdata-info>
                   <dmn-inputdata-info>
                       <inputdata-id>_B0E810E6-7596-430A-B5CF-67CE16863B6C</inputdata-id>
                       <inputdata-name>Driver</inputdata-name>
                       <inputdata-typeref>
                           <namespace-uri>https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8</namespace-uri>
                           <local-part>tDriver</local-part>
                           <prefix></prefix>
                       </inputdata-typeref>
                   </dmn-inputdata-info>
               </inputs>
               <itemdefinitions>
                   <dmn-itemdefinition-info>
                       <itemdefinition-id>_9C758F4A-7D72-4D0F-B63F-2F5B8405980E</itemdefinition-id>
                       <itemdefinition-name>tViolation</itemdefinition-name>
                       <itemdefinition-itemcomponent>
                           <dmn-itemdefinition-info>
                               <itemdefinition-id>_0B6FF1E2-ACE9-4FB3-876B-5BB30B88009B</itemdefinition-id>
                               <itemdefinition-name>Code</itemdefinition-name>
                               <itemdefinition-typeref>
                                   <namespace-uri>https://kiegroup.org/dmn/_60b01f4d-e407-43f7-848e-258723b5fac8</namespace-uri>
                                   <local-part>string</local-part>
                                   <prefix></prefix>
                               </itemdefinition-typeref>
                               <itemdefinition-itemcomponent/>
                               <itemdefinition-iscollection>false</itemdefinition-iscollection>
                           </dmn-itemdefinition-info>
                           <dmn-itemdefinition-info>
                               <itemdefinition-id>_27A5DA18-3CA7-4C06-81B7-CF7F2F050E29</itemdefinition-id>
                               <itemdefinition-name>date</itemdefinition-name>
                               <itemdefinition-typeref>
                                   <namespace-uri>https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8</namespace-uri>
                                   <local-part>date</local-part>
                                   <prefix></prefix>
                               </itemdefinition-typeref>
                               <itemdefinition-itemcomponent/>
                               <itemdefinition-iscollection>false</itemdefinition-iscollection>
                           </dmn-itemdefinition-info>
                           <dmn-itemdefinition-info>
                               <itemdefinition-id>_8961969A-8A80-4F12-B568-346920C0F038</itemdefinition-id>
                               <itemdefinition-name>type</itemdefinition-name>
                               <itemdefinition-typeref>
                                   <namespace-uri>https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8</namespace-uri>
                                   <local-part>string</local-part>
                                   <prefix></prefix>
                               </itemdefinition-typeref>
                               <itemdefinition-itemcomponent/>
                               <itemdefinition-iscollection>false</itemdefinition-iscollection>
                           </dmn-itemdefinition-info>
                           <dmn-itemdefinition-info>
                               <itemdefinition-id>_7450F12A-3E95-4D5E-8DCE-2CB1FAC2BDD4</itemdefinition-id>
                               <itemdefinition-name>speed limit</itemdefinition-name>
                               <itemdefinition-typeref>
                                   <namespace-uri>https://kiegroup.org/dmn/_60b01f4d-e407-43f7-848e-258723b5fac8</namespace-uri>
                                   <local-part>number</local-part>
                                   <prefix></prefix>
                               </itemdefinition-typeref>
                               <itemdefinition-itemcomponent/>
                               <itemdefinition-iscollection>false</itemdefinition-iscollection>
                           </dmn-itemdefinition-info>
                           <dmn-itemdefinition-info>
                               <itemdefinition-id>_0A9A6F26-6C14-414D-A9BF-765E5850429A</itemdefinition-id>
                               <itemdefinition-name>Actual Speed</itemdefinition-name>
                               <itemdefinition-typeref>
                                   <namespace-uri>https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8</namespace-uri>
                                   <local-part>number</local-part>
                                   <prefix></prefix>
                               </itemdefinition-typeref>
                               <itemdefinition-itemcomponent/>
                               <itemdefinition-iscollection>false</itemdefinition-iscollection>
                           </dmn-itemdefinition-info>
                       </itemdefinition-itemcomponent>
                       <itemdefinition-iscollection>false</itemdefinition-iscollection>
                   </dmn-itemdefinition-info>
                   <dmn-itemdefinition-info>
                       <itemdefinition-id>_13C7EFD8-B85C-43BF-94D3-14FABE39A4A0</itemdefinition-id>
                       <itemdefinition-name>tDriver</itemdefinition-name>
                       <itemdefinition-itemcomponent>
                           <dmn-itemdefinition-info>
                               <itemdefinition-id>_EC11744C-4160-4549-9610-2C757F40DFE8</itemdefinition-id>
                               <itemdefinition-name>Name</itemdefinition-name>
                               <itemdefinition-typeref>
                                   <namespace-uri>https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8</namespace-uri>
                                   <local-part>string</local-part>
                                   <prefix></prefix>
                               </itemdefinition-typeref>
                               <itemdefinition-itemcomponent/>
                               <itemdefinition-iscollection>false</itemdefinition-iscollection>
                           </dmn-itemdefinition-info>
                           <dmn-itemdefinition-info>
                               <itemdefinition-id>_E95BE3DB-4A51-4658-A166-02493EAAC9D2</itemdefinition-id>
                               <itemdefinition-name>Age</itemdefinition-name>
                               <itemdefinition-typeref>
                                   <namespace-uri>https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8</namespace-uri>
                                   <local-part>number</local-part>
                                   <prefix></prefix>
                               </itemdefinition-typeref>
                               <itemdefinition-itemcomponent/>
                               <itemdefinition-iscollection>false</itemdefinition-iscollection>
                           </dmn-itemdefinition-info>
                           <dmn-itemdefinition-info>
                               <itemdefinition-id>_7B3023E2-BC44-4BF3-BF7E-773C240FB9AD</itemdefinition-id>
                               <itemdefinition-name>State</itemdefinition-name>
                               <itemdefinition-typeref>
                                   <namespace-uri>https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8</namespace-uri>
                                   <local-part>string</local-part>
                                   <prefix></prefix>
                               </itemdefinition-typeref>
                               <itemdefinition-itemcomponent/>
                               <itemdefinition-iscollection>false</itemdefinition-iscollection>
                           </dmn-itemdefinition-info>
                           <dmn-itemdefinition-info>
                               <itemdefinition-id>_3D4B49DD-700C-4925-99A7-3B2B873F7800</itemdefinition-id>
                               <itemdefinition-name>city</itemdefinition-name>
                               <itemdefinition-typeref>
                                   <namespace-uri>https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8</namespace-uri>
                                   <local-part>string</local-part>
                                   <prefix></prefix>
                               </itemdefinition-typeref>
                               <itemdefinition-itemcomponent/>
                               <itemdefinition-iscollection>false</itemdefinition-iscollection>
                           </dmn-itemdefinition-info>
                           <dmn-itemdefinition-info>
                               <itemdefinition-id>_B37C49E8-B0D9-4B20-9DC6-D655BB1CA7B1</itemdefinition-id>
                               <itemdefinition-name>Points</itemdefinition-name>
                               <itemdefinition-typeref>
                                   <namespace-uri>https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8</namespace-uri>
                                   <local-part>number</local-part>
                                   <prefix></prefix>
                               </itemdefinition-typeref>
                               <itemdefinition-itemcomponent/>
                               <itemdefinition-iscollection>false</itemdefinition-iscollection>
                           </dmn-itemdefinition-info>
                       </itemdefinition-itemcomponent>
                       <itemdefinition-iscollection>false</itemdefinition-iscollection>
                   </dmn-itemdefinition-info>
                   <dmn-itemdefinition-info>
                       <itemdefinition-id>_A4077C7E-B57A-4DEE-9C65-7769636316F3</itemdefinition-id>
                       <itemdefinition-name>tFine</itemdefinition-name>
                       <itemdefinition-itemcomponent>
                           <dmn-itemdefinition-info>
                               <itemdefinition-id>_79B152A8-DE83-4001-B88B-52DFF0D73B2D</itemdefinition-id>
                               <itemdefinition-name>Amount</itemdefinition-name>
                               <itemdefinition-typeref>
                                   <namespace-uri>https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8</namespace-uri>
                                   <local-part>number</local-part>
                                   <prefix></prefix>
                               </itemdefinition-typeref>
                               <itemdefinition-itemcomponent/>
                               <itemdefinition-iscollection>false</itemdefinition-iscollection>
                           </dmn-itemdefinition-info>
                           <dmn-itemdefinition-info>
                               <itemdefinition-id>_D7CB5F9C-9D55-48C2-83EE-D47045EC90D0</itemdefinition-id>
                               <itemdefinition-name>Points</itemdefinition-name>
                               <itemdefinition-typeref>
                                   <namespace-uri>https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8</namespace-uri>
                                   <local-part>number</local-part>
                                   <prefix></prefix>
                               </itemdefinition-typeref>
                               <itemdefinition-itemcomponent/>
                               <itemdefinition-iscollection>false</itemdefinition-iscollection>
                           </dmn-itemdefinition-info>
                       </itemdefinition-itemcomponent>
                       <itemdefinition-iscollection>false</itemdefinition-iscollection>
                   </dmn-itemdefinition-info>
               </itemdefinitions>
               <decisionservices/>
           </model>
       </dmn-model-info-list>
   </response>

   Sample JSON output:

   {
     "type" : "SUCCESS",
     "msg" : "OK models successfully retrieved from container 'Traffic-Violation_1.0.0-SNAPSHOT'",
     "result" : {
       "dmn-model-info-list" : {
         "models" : [ {
           "model-namespace" : "https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8",
           "model-name" : "Traffic Violation",
           "model-id" : "_2CD7D1AA-BD84-4B43-AD21-B0342ADE655A",
           "decisions" : [ {
             "decision-id" : "_23428EE8-DC8B-4067-8E67-9D7C53EC975F",
             "decision-name" : "Fine"
           }, {
             "decision-id" : "_B5EEE2B1-915C-44DC-BE43-C244DC066FD8",
             "decision-name" : "Should the driver be suspended?"
           } ],
           "inputs" : [ {
             "inputdata-id" : "_CEB959CD-3638-4A87-93BA-03CD0FB63AE3",
             "inputdata-name" : "Violation",
             "inputdata-typeRef" : {
               "namespace-uri" : "https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8",
               "local-part" : "tViolation",
               "prefix" : ""
             }
           }, {
             "inputdata-id" : "_B0E810E6-7596-430A-B5CF-67CE16863B6C",
             "inputdata-name" : "Driver",
             "inputdata-typeRef" : {
               "namespace-uri" : "https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8",
               "local-part" : "tDriver",
               "prefix" : ""
             }
           } ],
           "itemDefinitions" : [ {
             "itemdefinition-id" : "_13C7EFD8-B85C-43BF-94D3-14FABE39A4A0",
             "itemdefinition-name" : "tDriver",
             "itemdefinition-typeRef" : null,
             "itemdefinition-itemComponent" : [ {
               "itemdefinition-id" : "_EC11744C-4160-4549-9610-2C757F40DFE8",
               "itemdefinition-name" : "Name",
               "itemdefinition-typeRef" : {
                 "namespace-uri" : "https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8",
                 "local-part" : "string",
                 "prefix" : ""
               },
               "itemdefinition-itemComponent" : [ ],
               "itemdefinition-isCollection" : false
             }, {
               "itemdefinition-id" : "_E95BE3DB-4A51-4658-A166-02493EAAC9D2",
               "itemdefinition-name" : "Age",
               "itemdefinition-typeRef" : {
                 "namespace-uri" : "https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8",
                 "local-part" : "number",
                 "prefix" : ""
               },
               "itemdefinition-itemComponent" : [ ],
               "itemdefinition-isCollection" : false
             }, {
               "itemdefinition-id" : "_7B3023E2-BC44-4BF3-BF7E-773C240FB9AD",
               "itemdefinition-name" : "State",
               "itemdefinition-typeRef" : {
                 "namespace-uri" : "https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8",
                 "local-part" : "string",
                 "prefix" : ""
               },
               "itemdefinition-itemComponent" : [ ],
               "itemdefinition-isCollection" : false
             }, {
               "itemdefinition-id" : "_3D4B49DD-700C-4925-99A7-3B2B873F7800",
               "itemdefinition-name" : "City",
               "itemdefinition-typeRef" : {
                 "namespace-uri" : "https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8",
                 "local-part" : "string",
                 "prefix" : ""
               },
               "itemdefinition-itemComponent" : [ ],
               "itemdefinition-isCollection" : false
             }, {
               "itemdefinition-id" : "_B37C49E8-B0D9-4B20-9DC6-D655BB1CA7B1",
               "itemdefinition-name" : "Points",
               "itemdefinition-typeRef" : {
                 "namespace-uri" : "https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8",
                 "local-part" : "number",
                 "prefix" : ""
               },
               "itemdefinition-itemComponent" : [ ],
               "itemdefinition-isCollection" : false
             } ],
             "itemdefinition-isCollection" : false
           }, {
             "itemdefinition-id" : "_A4077C7E-B57A-4DEE-9C65-7769636316F3",
             "itemdefinition-name" : "tFine",
             "itemdefinition-typeRef" : null,
             "itemdefinition-itemComponent" : [ {
               "itemdefinition-id" : "_79B152A8-DE83-4001-B88B-52DFF0D73B2D",
               "itemdefinition-name" : "Amount",
               "itemdefinition-typeRef" : {
                 "namespace-uri" : "https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8",
                 "local-part" : "number",
                 "prefix" : ""
               },
               "itemdefinition-itemComponent" : [ ],
               "itemdefinition-isCollection" : false
             }, {
               "itemdefinition-id" : "_D7CB5F9C-9D55-48C2-83EE-D47045EC90D0",
               "itemdefinition-name" : "Points",
               "itemdefinition-typeRef" : {
                 "namespace-uri" : "https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8",
                 "local-part" : "number",
                 "prefix" : ""
               },
               "itemdefinition-itemComponent" : [ ],
               "itemdefinition-isCollection" : false
             } ],
             "itemdefinition-isCollection" : false
           }, {
             "itemdefinition-id" : "_9C758F4A-7D72-4D0F-B63F-2F5B8405980E",
             "itemdefinition-name" : "tViolation",
             "itemdefinition-typeRef" : null,
             "itemdefinition-itemComponent" : [ {
               "itemdefinition-id" : "_0B6FF1E2-ACE9-4FB3-876B-5BB30B88009B",
               "itemdefinition-name" : "Code",
               "itemdefinition-typeRef" : {
                 "namespace-uri" : "https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8",
                 "local-part" : "string",
                 "prefix" : ""
               },
               "itemdefinition-itemComponent" : [ ],
               "itemdefinition-isCollection" : false
             }, {
               "itemdefinition-id" : "_27A5DA18-3CA7-4C06-81B7-CF7F2F050E29",
               "itemdefinition-name" : "Date",
               "itemdefinition-typeRef" : {
                 "namespace-uri" : "https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8",
                 "local-part" : "date",
                 "prefix" : ""
               },
               "itemdefinition-itemComponent" : [ ],
               "itemdefinition-isCollection" : false
             }, {
               "itemdefinition-id" : "_8961969A-8A80-4F12-B568-346920C0F038",
               "itemdefinition-name" : "Type",
               "itemdefinition-typeRef" : {
                 "namespace-uri" : "https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8",
                 "local-part" : "string",
                 "prefix" : ""
               },
               "itemdefinition-itemComponent" : [ ],
               "itemdefinition-isCollection" : false
             }, {
               "itemdefinition-id" : "_7450F12A-3E95-4D5E-8DCE-2CB1FAC2BDD4",
               "itemdefinition-name" : "Speed Limit",
               "itemdefinition-typeRef" : {
                 "namespace-uri" : "https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8",
                 "local-part" : "number",
                 "prefix" : ""
               },
               "itemdefinition-itemComponent" : [ ],
               "itemdefinition-isCollection" : false
             }, {
               "itemdefinition-id" : "_0A9A6F26-6C14-414D-A9BF-765E5850429A",
               "itemdefinition-name" : "Actual Speed",
               "itemdefinition-typeRef" : {
                 "namespace-uri" : "https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8",
                 "local-part" : "number",
                 "prefix" : ""
               },
               "itemdefinition-itemComponent" : [ ],
               "itemdefinition-isCollection" : false
             } ],
             "itemdefinition-isCollection" : false
           } ],
           "decisionServices" : [ ]
         } ]
       }
     }
   }

5. Execute the model:

   [POST] server/containers/{containerId}/dmn

   Note

   The attribute model-namespace is automatically generated and is different for every user. Ensure that the model-namespace and model-name attributes that you use match those of the deployed model.

   Example curl request:

   curl -u wbadmin:wbadmin -H "accept: application/json" -H "content-type: application/json" -X POST "http://localhost:8080/kie-server/services/rest/server/containers/traffic-violation_1.0.0-SNAPSHOT/dmn" -d "{ \"model-namespace\" : \"https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8\", \"model-name\" : \"Traffic Violation\", \"dmn-context\" : {\"Driver\" : {\"Points\" : 15}, \"Violation\" : {\"Type\" : \"speed\", \"Actual Speed\" : 135, \"Speed Limit\" : 100}}}"

   Example JSON request:

   {
     "model-namespace" : "https://kiegroup.org/dmn/_60B01F4D-E407-43F7-848E-258723B5FAC8",
     "model-name" : "Traffic Violation",
     "dmn-context" :
     {
       "Driver" :
       {
     	   "Points" : 15
       },
     	"Violation" :
       {
     		"Type" : "speed",
     		"Actual Speed" : 135,
     		"Speed Limit" : 100
     	}
     }
   }

   Example XML request (JAXB format):

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <dmn-evaluation-context>
       <dmn-context xsi:type="jaxbListWrapper" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
           <type>MAP</type>
           <element xsi:type="jaxbStringObjectPair" key="Violation">
               <value xsi:type="jaxbListWrapper">
                   <type>MAP</type>
                   <element xsi:type="jaxbStringObjectPair" key="Type">
                       <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">speed</value>
                   </element>
                   <element xsi:type="jaxbStringObjectPair" key="Speed Limit">
                       <value xsi:type="xs:decimal" xmlns:xs="http://www.w3.org/2001/XMLSchema">100</value>
                   </element>
                   <element xsi:type="jaxbStringObjectPair" key="Actual Speed">
                       <value xsi:type="xs:decimal" xmlns:xs="http://www.w3.org/2001/XMLSchema">135</value>
                   </element>
               </value>
           </element>
           <element xsi:type="jaxbStringObjectPair" key="Driver">
               <value xsi:type="jaxbListWrapper">
                   <type>MAP</type>
                   <element xsi:type="jaxbStringObjectPair" key="Points">
                       <value xsi:type="xs:decimal" xmlns:xs="http://www.w3.org/2001/XMLSchema">15</value>
                   </element>
               </value>
           </element>
       </dmn-context>
   </dmn-evaluation-context>

   Note

   Regardless of the request format, the request requires the following elements:

   • Model namespace
   • Model name
   • Context object containing input values

   Example JSON response:

   {
     "type": "SUCCESS",
     "msg": "OK from container 'Traffic-Violation_1.0.0-SNAPSHOT'",
     "result": {
         "dmn-evaluation-result": {
             "messages": [],
             "model-namespace": "https://kiegroup.org/dmn/_7D8116DE-ADF5-4560-A116-FE1A2EAFFF48",
             "model-name": "Traffic Violation",
             "decision-name": [],
             "dmn-context": {
                 "Violation": {
                   "Type": "speed",
                   "Speed Limit": 100,
                   "Actual Speed": 135
                 },
                 "Should Driver be Suspended?": "Yes",
                   "Driver": {
                     "Points": 15
                   },
                   "Fine": {
                     "Points": 7,
                     "Amount": 1000
                   }
               },
         "decision-results": {
             "_E1AF5AC2-E259-455C-96E4-596E30D3BC86": {
                 "messages": [],
                 "decision-id": "_E1AF5AC2-E259-455C-96E4-596E30D3BC86",
                 "decision-name": "Should the Driver be Suspended?",
                 "result": "Yes",
                 "status": "SUCCEEDED"
               },
             "_D7F02CE0-AF50-4505-AB80-C7D6DE257920": {
                 "messages": [],
                 "decision-id": "_D7F02CE0-AF50-4505-AB80-C7D6DE257920",
                 "decision-name": "Fine",
                 "result": {
                   "Points": 7,
                   "Amount": 1000
                 },
             "status": "SUCCEEDED"
           }
         }
       }
     }
   }

   Example XML (JAXB format) response:

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <response type="SUCCESS" msg="OK from container 'Traffic_1.0.0-SNAPSHOT'">
       <dmn-evaluation-result>
           <model-namespace>https://kiegroup.org/dmn/_A4BCA8B8-CF08-433F-93B2-A2598F19ECFF</model-namespace>
           <model-name>Traffic Violation</model-name>
           <dmn-context xsi:type="jaxbListWrapper" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
               <type>MAP</type>
               <element xsi:type="jaxbStringObjectPair" key="Violation">
                   <value xsi:type="jaxbListWrapper">
                       <type>MAP</type>
                       <element xsi:type="jaxbStringObjectPair" key="Type">
                           <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">speed</value>
                       </element>
                       <element xsi:type="jaxbStringObjectPair" key="Speed Limit">
                           <value xsi:type="xs:decimal" xmlns:xs="http://www.w3.org/2001/XMLSchema">100</value>
                       </element>
                       <element xsi:type="jaxbStringObjectPair" key="Actual Speed">
                           <value xsi:type="xs:decimal" xmlns:xs="http://www.w3.org/2001/XMLSchema">135</value>
                       </element>
                   </value>
               </element>
               <element xsi:type="jaxbStringObjectPair" key="Driver">
                   <value xsi:type="jaxbListWrapper">
                       <type>MAP</type>
                       <element xsi:type="jaxbStringObjectPair" key="Points">
                           <value xsi:type="xs:decimal" xmlns:xs="http://www.w3.org/2001/XMLSchema">15</value>
                       </element>
                   </value>
               </element>
               <element xsi:type="jaxbStringObjectPair" key="Fine">
                   <value xsi:type="jaxbListWrapper">
                       <type>MAP</type>
                       <element xsi:type="jaxbStringObjectPair" key="Points">
                           <value xsi:type="xs:decimal" xmlns:xs="http://www.w3.org/2001/XMLSchema">7</value>
                       </element>
                       <element xsi:type="jaxbStringObjectPair" key="Amount">
                           <value xsi:type="xs:decimal" xmlns:xs="http://www.w3.org/2001/XMLSchema">1000</value>
                       </element>
                   </value>
               </element>
               <element xsi:type="jaxbStringObjectPair" key="Should the driver be suspended?">
                   <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Yes</value>
               </element>
           </dmn-context>
           <messages/>
           <decisionResults>
               <entry>
                   <key>_4055D956-1C47-479C-B3F4-BAEB61F1C929</key>
                   <value>
                       <decision-id>_4055D956-1C47-479C-B3F4-BAEB61F1C929</decision-id>
                       <decision-name>Fine</decision-name>
                       <result xsi:type="jaxbListWrapper" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                           <type>MAP</type>
                           <element xsi:type="jaxbStringObjectPair" key="Points">
                               <value xsi:type="xs:decimal" xmlns:xs="http://www.w3.org/2001/XMLSchema">7</value>
                           </element>
                           <element xsi:type="jaxbStringObjectPair" key="Amount">
                               <value xsi:type="xs:decimal" xmlns:xs="http://www.w3.org/2001/XMLSchema">1000</value>
                           </element>
                       </result>
                       <messages/>
                       <status>SUCCEEDED</status>
                   </value>
               </entry>
               <entry>
                   <key>_8A408366-D8E9-4626-ABF3-5F69AA01F880</key>
                   <value>
                       <decision-id>_8A408366-D8E9-4626-ABF3-5F69AA01F880</decision-id>
                       <decision-name>Should the driver be suspended?</decision-name>
                       <result xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Yes</result>
                       <messages/>
                       <status>SUCCEEDED</status>
                   </value>
               </entry>
           </decisionResults>
       </dmn-evaluation-result>
   </response>

Procedure

1. To run the examples, in the rhpam-7.13.5-planner-engine/examples directory enter one of the following commands:

   Linux or Mac:

   $ ./runExamples.sh

   Windows:

   $ runExamples.bat

   The OptaPlanner Examples window opens.

2. Select an example to run that example.

Procedure

1. Open the OptaPlanner examples as a new project:

   1. For IntelliJ or Netbeans, open examples/sources/pom.xml as the new project. The Maven integration guides you through the rest of the installation. Skip the rest of the steps in this procedure.
   2. For Eclipse, open a new project for the /examples/binaries directory, located under the rhpam-7.13.5-planner-engine directory.
2. Add all the JAR files that are in the binaries directory to the classpath, except for the examples/binaries/optaplanner-examples-7.67.0.Final-redhat-00024.jar file.
3. Add the Java source directory src/main/java and the Java resources directory src/main/resources, located under the rhpam-7.13.5-planner-engine/examples/sources/ directory.

4. Create a run configuration:

   • Main class: org.optaplanner.examples.app.OptaPlannerExamplesApp
   • VM parameters (optional): -Xmx512M -server -Dorg.optaplanner.examples.dataDir=examples/sources/data
   • Working directory: examples/sources
5. Run the run configuration.

Procedure

1. In Business Central, click Menu → Design → Projects.
2. In the preconfigured MySpace space, click Try Samples.
3. Select employee-rostering from the list of sample projects and click Ok in the upper-right corner to import the project.
4. After the asset list has complied, click Build & Deploy to deploy the employee rostering example.

Procedure

1. In a command terminal, enter the following command to verify that Maven is using JDK 11 and that the Maven version is 3.6 or higher:

   mvn --version

2. If the preceding command does not return JDK 11, add the path to JDK 11 to the PATH environment variable and enter the preceding command again.

3. To generate a Quarkus OptaPlanner quickstart project, enter the following command:

   mvn com.redhat.quarkus.platform:quarkus-maven-plugin:2.13.Final-redhat-00006:create \
       -DprojectGroupId=com.example \
       -DprojectArtifactId=optaplanner-quickstart  \
       -Dextensions="resteasy,resteasy-jackson,optaplanner-quarkus,optaplanner-quarkus-jackson" \
       -DplatformGroupId=com.redhat.quarkus.platform
       -DplatformVersion=2.13.Final-redhat-00006 \
       -DnoExamples

   This command create the following elements in the ./optaplanner-quickstart directory:

   • The Maven structure
   • Example Dockerfile file in src/main/docker

   • The application configuration file

     Table 12.1. Properties used in the mvn io.quarkus:quarkus-maven-plugin:2.13.Final-redhat-00006:create command

     Property	Description
     projectGroupId	The group ID of the project.
     projectArtifactId	The artifact ID of the project.
     extensions	A comma-separated list of Quarkus extensions to use with this project. For a full list of Quarkus extensions, enter mvn quarkus:list-extensions on the command line.
     noExamples	Creates a project with the project structure but without tests or classes.

     The values of the projectGroupID and the projectArtifactID properties are used to generate the project version. The default project version is 1.0.0-SNAPSHOT.

4. To view your OptaPlanner project, change directory to the OptaPlanner Quickstarts directory:

   cd optaplanner-quickstart

5. Review the pom.xml file. The content should be similar to the following example:

   <dependencyManagement>
     <dependencies>
       <dependency>
         <groupId>io.quarkus.platform</groupId>
         <artifactId>quarkus-bom</artifactId>
         <version>2.13.Final-redhat-00006</version>
         <type>pom</type>
         <scope>import</scope>
       </dependency>
       <dependency>
         <groupId>io.quarkus.platform</groupId>
         <artifactId>quarkus-optaplanner-bom</artifactId>
         <version>2.13.Final-redhat-00006</version>
         <type>pom</type>
         <scope>import</scope>
       </dependency>
     </dependencies>
   </dependencyManagement>
   <dependencies>
     <dependency>
       <groupId>io.quarkus</groupId>
       <artifactId>quarkus-resteasy</artifactId>
     </dependency>
     <dependency>
       <groupId>io.quarkus</groupId>
       <artifactId>quarkus-resteasy-jackson</artifactId>
     </dependency>
     <dependency>
       <groupId>org.optaplanner</groupId>
       <artifactId>optaplanner-quarkus</artifactId>
     </dependency>
     <dependency>
       <groupId>org.optaplanner</groupId>
       <artifactId>optaplanner-quarkus-jackson</artifactId>
     </dependency>
     <dependency>
       <groupId>io.quarkus</groupId>
       <artifactId>quarkus-junit5</artifactId>
       <scope>test</scope>
     </dependency>
   </dependencies>

Procedure

1. Open https://code.quarkus.redhat.com in your web browser:
2. Specify details about your project:
3. Enter a group name for your project. The format of the name follows the Java package naming convention, for example, com.example.
4. Enter a name that you want to use for Maven artifacts generated from your project, for example code-with-quarkus.

5. Select Build Tool > Maven to specify that you want to create a Maven project. The build tool that you choose determines the items:

   • The directory structure of your generated project
   • The format of configuration files used in your generated project

   • The custom build script and command for compiling and starting your application that code.quarkus.redhat.com displays for you after you generate your project

     Note

     Red Hat provides support for using code.quarkus.redhat.com to create OptaPlanner Maven projects only. Generating Gradle projects is not supported by Red Hat.

6. Enter a version to be used in artifacts generated from your project. The default value of this field is 1.0.0-SNAPSHOT. Using semantic versioning is recommended, but you can use a different type of versioning if you prefer.

7. Enter the package name of artifacts that the build tool generates when you package your project.

   According to the Java package naming conventions the package name should match the group name that you use for your project, but you can specify a different name.

   Note

   The code.quarkus.redhat.com website automatically uses the latest release of OptaPlanner. You can manually change the BOM version in the pom.xml file after you generate your project.

8. Select the following extensions to include as dependencies:

   • RESTEasy JAX-RS (quarkus-resteasy)
   • RESTEasy Jackson (quarkus-resteasy-jackson)
   • OptaPlanner AI constraint solver(optaplanner-quarkus)

   • OptaPlanner Jackson (optaplanner-quarkus-jackson)

     Red Hat provides different levels of support for individual extensions on the list, which are indicated by labels next to the name of each extension:

     • SUPPORTED extensions are fully supported by Red Hat for use in enterprise applications in production environments.
     • TECH-PREVIEW extensions are subject to limited support by Red Hat in production environments under the Technology Preview Features Support Scope.
     • DEV-SUPPORT extensions are not supported by Red Hat for use in production environments, but the core functionalities that they provide are supported by Red Hat developers for use in developing new applications.

     • DEPRECATED extension are planned to be replaced with a newer technology or implementation that provides the same functionality.

       Unlabeled extensions are not supported by Red Hat for use in production environments.

9. Select Generate your application to confirm your choices and display the overlay screen with the download link for the archive that contains your generated project. The overlay screen also shows the custom command that you can use to compile and start your application.
10. Select Download the ZIP to save the archive with the generated project files to your system.
11. Extract the contents of the archive.

12. Navigate to the directory that contains your extracted project files:

    cd <directory_name>

13. Compile and start your application in development mode:

    ./mvnw compile quarkus:dev

Procedure

1. Create a Quarkus application:

   quarkus create app -P io.quarkus:quarkus-bom:2.13.Final-redhat-00006

2. To view the available extensions, enter the following command:

   quarkus ext -i

   This command returns the following extensions:

   optaplanner-quarkus
   optaplanner-quarkus-benchmark
   optaplanner-quarkus-jackson
   optaplanner-quarkus-jsonb

3. Enter the following command to add extensions to the project’s pom.xml file:

   quarkus ext add resteasy-jackson
   quarkus ext add optaplanner-quarkus
   quarkus ext add optaplanner-quarkus-jackson

4. Open the pom.xml file in a text editor. The contents of the file should look similar to the following example:

   <?xml version="1.0"?>
   <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
   	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <modelVersion>4.0.0</modelVersion>
     <groupId>org.acme</groupId>
     <artifactId>code-with-quarkus-optaplanner</artifactId>
     <version>1.0.0-SNAPSHOT</version>
     <properties>
   	<compiler-plugin.version>3.8.1</compiler-plugin.version>
   	<maven.compiler.parameters>true</maven.compiler.parameters>
   	<maven.compiler.source>11</maven.compiler.source>
   	<maven.compiler.target>11</maven.compiler.target>
   	<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
   	<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
   	<quarkus.platform.artifact-id>quarkus-bom</quarkus.platform.artifact-id>
   	<quarkus.platform.group-id>io.quarkus</quarkus.platform.group-id>
   	<quarkus.platform.version>2.13.Final-redhat-00006</quarkus.platform.version>
   	<surefire-plugin.version>3.0.0-M5</surefire-plugin.version>
     </properties>
     <dependencyManagement>
   	<dependencies>
     	<dependency>
       	<groupId>${quarkus.platform.group-id}</groupId>
       	<artifactId>${quarkus.platform.artifact-id}</artifactId>
       	<version>${quarkus.platform.version}</version>
       	<type>pom</type>
       	<scope>import</scope>
     	</dependency>
     	<dependency>
       	<groupId>io.quarkus.platform</groupId>
       	<artifactId>optaplanner-quarkus</artifactId>
       	<version>2.2.2.Final</version>
       	<type>pom</type>
       	<scope>import</scope>
     	</dependency>
   	</dependencies>
     </dependencyManagement>
     <dependencies>
   	<dependency>
     	<groupId>io.quarkus</groupId>
     	<artifactId>quarkus-arc</artifactId>
   	</dependency>
   	<dependency>
     	<groupId>io.quarkus</groupId>
     	<artifactId>quarkus-resteasy</artifactId>
   	</dependency>
   	<dependency>
     	<groupId>org.optaplanner</groupId>
     	<artifactId>optaplanner-quarkus</artifactId>
   	</dependency>
   	<dependency>
     	<groupId>org.optaplanner</groupId>
     	<artifactId>optaplanner-quarkus-jackson</artifactId>
   	</dependency>
   	<dependency>
     	<groupId>io.quarkus</groupId>
     	<artifactId>quarkus-resteasy-jackson</artifactId>
   	</dependency>
   	<dependency>
     	<groupId>io.quarkus</groupId>
     	<artifactId>quarkus-junit5</artifactId>
     	<scope>test</scope>
   	</dependency>
   	<dependency>
     	<groupId>io.rest-assured</groupId>
     	<artifactId>rest-assured</artifactId>
     	<scope>test</scope>
   	</dependency>
     </dependencies>
     <build>
   	<plugins>
     	<plugin>
       	<groupId>${quarkus.platform.group-id}</groupId>
       	<artifactId>quarkus-maven-plugin</artifactId>
       	<version>${quarkus.platform.version}</version>
       	<extensions>true</extensions>
       	<executions>
         	<execution>
           	<goals>
             	<goal>build</goal>
             	<goal>generate-code</goal>
             	<goal>generate-code-tests</goal>
           	</goals>
         	</execution>
       	</executions>
     	</plugin>
     	<plugin>
       	<artifactId>maven-compiler-plugin</artifactId>
       	<version>${compiler-plugin.version}</version>
       	<configuration>
         	<parameters>${maven.compiler.parameters}</parameters>
       	</configuration>
     	</plugin>
     	<plugin>
       	<artifactId>maven-surefire-plugin</artifactId>
       	<version>${surefire-plugin.version}</version>
       	<configuration>
         	<systemPropertyVariables>
           	<java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
           	<maven.home>${maven.home}</maven.home>
         	</systemPropertyVariables>
       	</configuration>
     	</plugin>
   	</plugins>
     </build>
     <profiles>
   	<profile>
     	<id>native</id>
     	<activation>
       	<property>
         	<name>native</name>
       	</property>
     	</activation>
     	<build>
       	<plugins>
         	<plugin>
           	<artifactId>maven-failsafe-plugin</artifactId>
           	<version>${surefire-plugin.version}</version>
           	<executions>
             	<execution>
               	<goals>
                 	<goal>integration-test</goal>
                 	<goal>verify</goal>
               	</goals>
               	<configuration>
                 	<systemPropertyVariables>
                   	<native.image.path>${project.build.directory}/${project.build.finalName}-runner</native.image.path>
                   	<java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
                   	<maven.home>${maven.home}</maven.home>
                 	</systemPropertyVariables>
               	</configuration>
             	</execution>
           	</executions>
         	</plugin>
       	</plugins>
     	</build>
     	<properties>
       	<quarkus.package.type>native</quarkus.package.type>
     	</properties>
   	</profile>
     </profiles>
   </project>