IBM Business Automation Manager Open Editions

https://www.ibm.com/docs/en/ibamoe/9.3.0
Admin
IBM Business Automation Manager Open Editions is a platform for developing, deploying, and managing...
Tokens:91,661
Snippets:586
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### BAMOE 9 Quarkus application.properties Example

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=projects-upgrading-client-server

Provides an example configuration for application.properties in a BAMOE 9 Quarkus-based application. It covers server settings, data source, messaging, OpenAPI, tracing, and monitoring configurations. No external dependencies are explicitly mentioned, but it implies the presence of Quarkus and Kafka.

```properties
# Server configuration
quarkus.http.port=8080
quarkus.log.level=INFO

# Data source configuration (PostgreSQL)
quarkus.datasource.db-kind=postgresql
quarkus.datasource.username=kogito_user
quarkus.datasource.password=kogito_pass
quarkus.datasource.jdbc.url=jdbc:postgresql://localhost:5432/kogito_db
quarkus.hibernate-orm.database.generation=update

# Kogito persistence
kogito.persistence.type=jdbc

# Enable Kafka messaging
mp.messaging.incoming.kogito_in.connector=smallrye-kafka
mp.messaging.incoming.kogito_in.topic=kogito-events
mp.messaging.incoming.kogito_in.value.deserializer=org.apache.kafka.common.serialization.StringDeserializer

mp.messaging.outgoing.kogito_out.connector=smallrye-kafka
mp.messaging.outgoing.kogito_out.topic=kogito-responses
mp.messaging.outgoing.kogito_out.value.serializer=org.apache.kafka.common.serialization.StringSerializer

# Enable OpenAPI and Swagger UI
quarkus.swagger-ui.always-include=true
quarkus.smallrye-openapi.path=/q/openapi

# Tracing and monitoring
quarkus.opentelemetry.enabled=true
quarkus.opentelemetry.tracer.exporter.otlp.endpoint=http://localhost:4317
quarkus.micrometer.export.prometheus.enabled=true
quarkus.micrometer.export.prometheus.path=/metrics

# Kogito add-ons
kogito.addons.tracing.decision.enabled=true
kogito.addons.monitoring.prometheus.enabled=true
```

--------------------------------

### Running Quarkus Server Command

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=started-orchestrating-decisions-rules-workflows-in-15-minutes

Command to start the Quarkus server in development mode from the project root directory.

```bash
mvn quarkus:dev
```

--------------------------------

### BAMOE 9 Spring Boot application.properties Example

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=projects-upgrading-client-server

Provides an example configuration for application.properties in a BAMOE 9 Spring Boot-based application. It includes server settings, data source, Kafka messaging, OpenAPI, and monitoring configurations. This assumes the presence of Spring Boot and Kafka dependencies.

```properties
# Server configuration
server.port=8080
logging.level.root=INFO

# Data source configuration (PostgreSQL)
spring.datasource.url=jdbc:postgresql://localhost:5432/kogito_db
spring.datasource.username=kogito_user
spring.datasource.password=kogito_pass
spring.jpa.hibernate.ddl-auto=update

# Kogito persistence
kogito.persistence.type=jdbc

# Kafka configuration
spring.kafka.bootstrap-servers=localhost:9092
spring.kafka.consumer.group-id=kogito-group
spring.kafka.consumer.auto-offset-reset=earliest
spring.kafka.consumer.key-deserializer=org.apache.kafka.common.serialization.StringDeserializer
spring.kafka.consumer.value-deserializer=org.apache.kafka.common.serialization.StringDeserializer
spring.kafka.producer.key-serializer=org.apache.kafka.common.serialization.StringSerializer
spring.kafka.producer.value-serializer=org.apache.kafka.common.serialization.StringSerializer

# Kogito Kafka topics
kogito.events.incoming=kogito-events
kogito.events.outgoing=kogito-responses

# OpenAPI and Swagger
springdoc.api-docs.path=/v3/api-docs
springdoc.swagger-ui.path=/swagger-ui.html

# Tracing and monitoring
management.endpoints.web.exposure.include=*
management.endpoint.prometheus.enabled=true
management.metrics.export.prometheus.enabled=true

#kogito.addons.tracing.decision.enabled=true
kogito.addons.monitoring.prometheus.enabled=true
```

--------------------------------

### KIE_SANDBOX_ACCELERATORS Environment Variable Configuration

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=installing-bamoe-canvas

An example of the KIE_SANDBOX_ACCELERATORS environment variable, which is an array of Accelerator configurations. This example includes default configurations for Quarkus and Spring Boot accelerators with both DMN and full project options.

```json
[
   {
      "name": "Quarkus (DMN)",
      "iconUrl": "images/quarkus-logo.png",
      "gitRepositoryUrl": "https://github.com/IBM/bamoe-canvas-quarkus-accelerator",
      "gitRepositoryGitRef": "9.3.0-ibm-0007-quarkus-dmn",
      "dmnDestinationFolder": "src/main/resources/dmn",
      "bpmnDestinationFolder": "src/main/resources/bpmn",
      "otherFilesDestinationFolder": "src/main/resources/others",
      "scesimDestinationFolder": "src/test/resources/scesim"
    },

  {
      "name": "Quarkus (Full)",
      "iconUrl": "images/quarkus-logo.png",
      "gitRepositoryUrl": "https://github.com/IBM/bamoe-canvas-quarkus-accelerator",
      "gitRepositoryGitRef": "9.3.0-ibm-0007-quarkus-full",
      "dmnDestinationFolder": "src/main/resources/dmn",
      "bpmnDestinationFolder": "src/main/resources/bpmn",
      "otherFilesDestinationFolder": "src/main/resources/others",
      "scesimDestinationFolder": "src/test/resources/scesim"
    },

  {
      "name": "Spring Boot (DMN)",
      "iconUrl": "images/springboot-logo.png",
      "gitRepositoryUrl": "https://github.com/IBM/bamoe-canvas-quarkus-accelerator",
      "gitRepositoryGitRef": "9.3.0-ibm-0007-spring-boot-dmn",
      "dmnDestinationFolder": "src/main/resources/dmn",
      "bpmnDestinationFolder": "src/main/resources/bpmn",
      "otherFilesDestinationFolder": "src/main/resources/others",
      "scesimDestinationFolder": "src/test/resources/scesim"
    },

  {
      "name": "Spring Boot (Full)",
      "iconUrl": "images/springboot-logo.png",
      "gitRepositoryUrl": "https://github.com/IBM/bamoe-canvas-quarkus-accelerator",
      "gitRepositoryGitRef": "9.3.0-ibm-0007-spring-boot-full",
      "dmnDestinationFolder": "src/main/resources/dmn",
      "bpmnDestinationFolder": "src/main/resources/bpmn",
      "otherFilesDestinationFolder": "src/main/resources/others",
      "scesimDestinationFolder": "src/test/resources/scesim"
    }
]
```

--------------------------------

### Build and Run Quarkus Project Locally

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=projects-upgrading-client-server

Commands to build and start a Maven Quarkus project in development mode. This is a prerequisite for validating the upgrade by accessing REST endpoints.

```bash
mvn clean package
mvn clean quarkus:dev
```

--------------------------------

### BPMN and DMN Editors (classic) Installation and Usage

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=features-bpmn-dmn-editors-standalone-javascript-libraries

Instructions on how to install and initialize the BPMN and DMN Editors (classic) within a project, including configuration options.

```APIDOC
## BPMN and DMN Editors (classic) - Installation and Initialization

### Description
This section details the installation process and provides examples for initializing both the BPMN and DMN Editors (classic) using their respective libraries.

### Installation
1. Add the library to your `package.json`:
```bash
npm install @ibm/bamoe-standalone-bpmn-and-dmn-editors-classic@9.3.0-ibm-0007
```

### Initialization
1. Import the Editors:
```javascript
import * as BpmnEditor from "@ibm/bamoe-standalone-bpmn-and-dmn-editors-classic/dist/bpmn"
import * as DmnEditor from "@ibm/bamoe-standalone-bpmn-and-dmn-editors-classic/dist/dmn"
```

2. Add container elements in your HTML:
```html
<div id="bpmn-editor-container"/>
<div id="dmn-editor-container"/>
```

3. Load the Editors with configuration:
```javascript
const bpmnEditorClassic = BpmnEditor.open({
  container: document.getElementById("bpmn-editor-container"),
  initialContent: Promise.resolve(""),
  readOnly: false,
  origin: "*",
  onError: () => {},
  resources: new Map([])
});

const dmnEditorClassic = DmnEditor.open({
  container: document.getElementById("dmn-editor-container"),
  initialContent: Promise.resolve(""),
  readOnly: false,
  origin: "*",
  onError: () => {},
  resources: new Map([])
});
```

### Parameters for `open()` method

#### `container`
- **Type**: HTMLElement
- **Description**: Specifies the HTML element that the Editor is appended to.
- **Required**: Mandatory

#### `initialContent`
- **Type**: `Promise<string>`
- **Description**: Accepts a Promise that resolves to the initial content of the editor (BPMN or DMN). Can be an empty string.
- **Required**: Mandatory
- **Examples**: 
  - `Promise.resolve("")`
  - `Promise.resolve("<BPMN_OR_DMN_CONTENT_DIRECTLY_HERE>")`
  - `fetch("MyBpmnFile.bpmn").then(content => content.text())`

#### `readOnly`
- **Type**: `boolean`
- **Description**: Set to `false` for editable mode, `true` for read-only mode. Defaults to `true`.
- **Required**: Optional

#### `origin`
- **Type**: `string`
- **Description**: The origin for the editor. Defaults to `*` for `file://` protocol, otherwise `window.location.origin`.
- **Required**: Optional

#### `onError`
- **Type**: `function`
- **Description**: A callback function invoked when the Editor encounters an error. Defaults to `() => {}`.
- **Required**: Optional

#### `resources`
- **Type**: `Map<string, { contentType: 'text' | 'binary', content: Promise<string> }>`
- **Description**: A map of resources to be provided to the Editor. Useful for DMN included models or BPMN Work Item Definitions.
- **Required**: Optional
- **Examples**: 
  - `new Map([["myWid.wid", { contentType: "text", content: Promise.resolve("<WID_CONTENTS_HERE>")}]])`
  - `new Map([["types.dmn", { contentType: "text", content: Promise.resolve("<DMN_CONTENTS_HERE>")}]])`

### Editor Instance Methods

The returned objects (`bpmnEditor`, `dmnEditor`) expose the following methods:

#### `getContent(): Promise<string>`
- **Description**: Returns a Promise that resolves to the editor's current content (BPMN or DMN).

#### `setContent(normalizedPosixPathRelativeToTheWorkspaceRoot: string, content: string): Promise<void>`
- **Description**: Sets the content of the editor. Rejects the Promise if setting content fails.

#### `getPreview(): Promise<string>`
- **Description**: Returns a Promise that resolves to the SVG string of the current diagram.

#### `subscribeToContentChanges(callback: (isDirty: boolean) => void): (isDirty: boolean) => void`
- **Description**: Sets up a callback function that is called on content changes. Returns the same function for unsubscription.

#### `unsubscribeToContentChanges(callback: (isDirty: boolean) => void): void`
- **Description**: Unsubscribes the provided callback function from content change notifications.

#### `markAsSaved(): void`
- **Description**: Resets the editor state to indicate content is saved and fires content change callbacks.

#### `undo(): void`
- **Description**: Undoes the last change and fires content change callbacks.

#### `redo(): void`
- **Description**: Redoes the last undone change and fires content change callbacks.

#### `close(): void`
- **Description**: Closes the editor.

#### `envelopeApi: MessageBusClientApi<KogitoEditorEnvelopeApi>`
- **Description**: Provides access to an advanced editor API.

#### `canvas`
- **Description**: API for manipulating the diagram.
  - `getNodeIds(): Promise<string[]>`: Returns a Promise with the ID attributes of all nodes in the diagram.
  - `getBackgroundColor(uuid: string): Promise<string>`: Returns a Promise with the background color of a node identified by its UUID.
```

--------------------------------

### Maven Build Commands

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=projects-upgrading-standalone

Standard Maven commands to clean, package, verify, and install a BAMOE project. These commands are used after making necessary code updates in the standalone mode examples.

```bash
mvn clean package

```

```bash
mvn clean verify

```

```bash
mvn clean install

```

--------------------------------

### Run BAMOE Canvas with Docker Compose

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=installing-bamoe-canvas

This command starts BAMOE Canvas and its related services using Docker Compose. Ensure you have extracted the `bamoe-9.3.0-canvas-docker-compose.zip` file and navigated to its directory before running.

```shell
docker compose up
```

--------------------------------

### Install classic BPMN and DMN Editors

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=features-bpmn-dmn-editors-standalone-javascript-libraries

Installs the standalone classic BPMN and DMN editors package using npm. This is the first step in integrating the editors into your project.

```bash
npm install @ibm/bamoe-standalone-bpmn-and-dmn-editors-classic@9.3.0-ibm-0007
```

--------------------------------

### BPMN Editor Initialization and Usage

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=features-bpmn-dmn-editors-standalone-javascript-libraries

This section details how to install the BPMN Editor library, import it into your project, set up the HTML container, and initialize the editor with various configuration options. It also describes the methods available for manipulating the editor's content and state.

```APIDOC
## BPMN Editor Initialization and Usage

### Description
Instructions on how to install, import, and initialize the BPMN Editor, along with descriptions of its methods.

### Method
JavaScript (Client-side)

### Endpoint
N/A (This is a client-side library)

### Parameters
#### Initialization Parameters
- **container** (HTMLElement) - Mandatory - Specifies the HTML element that the Editor is appended to.
- **initialContent** (Promise<string>) - Mandatory - Accepts a Promise that resolves to the contents of a .dmn file. It can be an empty string or contain DMN content.
- **initialFileNormalizedPosixPathRelativeToTheWorkspaceRoot** (string) - Mandatory - Specifies the POSIX path relative to the workspace root, including the file name. Useful for locating the file in the workspace.
- **readOnly** (boolean) - Optional - `false` for content edition, `true` for read-only mode. Defaults to `false`.
- **origin** (string) - Optional - Defaults to `*` if accessing via `file://` protocol, otherwise `window.location.origin`.
- **onError** (function) - Optional - Accepts a function that is called when the Editor encounters an error. Defaults to `() => {}`.
- **resources** (Map<string, { contentType: string, content: Promise<string> }>) - Optional - A map of resources provided for the Editor. Keys are POSIX paths, and values contain `contentType` and `content`.

### Request Example (Initialization)
```javascript
import * as BpmnEditor from "@ibm/bamoe-standalone-bpmn-editor/dist";

const bpmnEditor = BpmnEditor.open({
  container: document.getElementById("bpmn-editor-container"),
  initialContent: Promise.resolve(""),
  initialFileNormalizedPosixPathRelativeToTheWorkspaceRoot: "model.bpmn",
  readOnly: false,
  origin: "*",
  onError: () => { console.error("An error occurred!"); },
  resources: new Map([
    [
      "MyDecision.dmn",
      {
        contentType: "text",
        content: Promise.resolve("<DMN_CONTENT_HERE>")
      }
    ]
  ])
});
```

### Methods for Manipulating the Editor
- **getContent(): Promise<string>**
    Returns a Promise that contains the Editor’s content.

- **setContent(normalizedPosixPathRelativeToTheWorkspaceRoot: string, content: string): Promise<void>**
    Sets the content of the editor. The returning Promise will be rejected if setting the content fails.

- **getPreview(): Promise<string>**
    Returns a Promise that resolves to the SVG string of the current diagram.

- **subscribeToContentChanges(callback: (isDirty: boolean) => void): (isDirty: boolean) => void**
    Setup a callback function that is automatically called on every content change in the Editor. Returns the same function that needs to be used for unsubscription.

- **unsubscribeToContentChanges(callback: (isDirty: boolean) => void): void**
    Unsubscribes the callback function from being called when the content changes.

- **markAsSaved(): void**
    Resets the editor state by signaling that the content is saved. It also fires the subscribed callbacks for content changes.

- **undo(): void**
    Undo the last change in the Editor. It will also fire the subscribed callbacks of content changes.

- **redo(): void**
    Redo the last undone change in the Editor.

### Response Example (General)
N/A (This is a client-side library; responses are handled by JavaScript methods)

```

--------------------------------

### Install DMN Editor Library with npm

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=features-bpmn-dmn-editors-standalone-javascript-libraries

This command installs a specific version of the DMN Editor library from npm. Ensure you have Node.js and npm installed on your system. This is the first step to integrate the editor into your project.

```bash
npm install @ibm/bamoe-standalone-dmn-editor@9.3.0-ibm-0007
```

--------------------------------

### Override Helm Chart Environmental Variables

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=installing-bamoe-canvas

Installs BAMOE Canvas and overrides default environmental variables from the `values.yaml` file by passing them on the command line. This example sets the image repository. Refer to the BAMOE Canvas Helm Chart configuration reference for all available options.

```bash
helm install my-bamoe-canvas ./src --set image.repository=quay.io
```

--------------------------------

### Minikube Install using Helm

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=installing-bamoe-canvas

Installs BAMOE Canvas on a Minikube cluster using Helm. This method requires a running Minikube cluster and the Nginx Ingress installed. It involves pulling the Helm chart and installing it using a Minikube-specific values file.

```bash
helm pull oci://quay.io/bamoe/canvas-helm-chart --version={VERSION} --untar
helm install my-bamoe-canvas ./canvas-helm-chart --values ./canvas-helm-chart/values-minikube-nginx.yaml
```

--------------------------------

### Install BPMN Editor using npm

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=features-bpmn-dmn-editors-standalone-javascript-libraries

This command installs the specified version of the BAMOE standalone BPMN editor library into your project's dependencies. Ensure you have npm or a compatible package manager installed.

```bash
npm install @ibm/bamoe-standalone-bpmn-editor@9.3.0-ibm-0007
```

--------------------------------

### Generic Kubernetes Install using Helm

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=installing-bamoe-canvas

Installs BAMOE Canvas on a generic Kubernetes cluster using Helm. It requires pulling the Helm chart and then installing it with specific values for Kubernetes cluster domain and Ingress class. Replace `{VERSION}`, `<YOUR_KUBERNETES_CLUSTER_DOMAIN>`, and `<YOUR_KUBERNETES_INGRESS_CLASS>` with your specific values.

```bash
helm pull oci://quay.io/bamoe/canvas-helm-chart --version={VERSION} --untar
helm install my-bamoe-canvas ./canvas-helm-chart --values ./canvas-helm-chart/values-kubernetes.yaml --set global.kubernetesClusterDomain="<YOUR_KUBERNETES_CLUSTER_DOMAIN>" --set global.kubernetesIngressClass="<YOUR_KUBERNETES_INGRESS_CLASS>"
```

--------------------------------

### Interact with Hiring Process via REST API (cURL)

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=workflows-process-api

This example demonstrates how to interact with a 'hiring' process using cURL commands. It shows how to send GET and POST requests to specific endpoints, including starting a new process instance and retrieving its schema. The API is dynamically generated based on the Process Definitions within the application.

```curl
curl -X 'GET' \
'http://localhost:8080/{process_id}' \
-H 'accept: application/json'
```

```curl
curl -X 'POST' \
'http://localhost:8080/{process_id}?businessKey=value' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '{ "process_variable" : "json" }'
```

```curl
curl -X 'GET' \
'http://localhost:8080/{process_id}/schema' \
-H 'accept: application/json'
```

--------------------------------

### OpenShift Install: Get OpenShift Domain and Deploy BAMOE Management Console with Helm

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=installing-bamoe-management-console

This snippet shows how to retrieve the default OpenShift domain for routes and then install the BAMOE Management Console using a Helm chart. It requires the Helm CLI and assumes an OpenShift environment. The output is the domain name, and the input is the OpenShift cluster configuration.

```bash
oc get ingresses.config cluster --output jsonpath={.spec.domain}
```

```bash
helm pull oci://quay.io/bamoe/consoles-helm-chart --version=9.3.0-ibm-0007 --untar
helm install bamoe-management-console ./consoles-helm-chart \
 --values ./consoles-helm-chart/values-openshift.yaml \
  --set global.openshiftRouteDomain="<YOUR_OCP_ROUTE_DOMAIN>"
```

--------------------------------

### Get OpenShift BAMOE Canvas Route

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=installing-bamoe-canvas

Retrieves the URL for the deployed BAMOE Canvas instance on OpenShift. This command uses `oc get route` to output the host specification of the BAMOE Canvas route.

```bash
oc get route $APP_NAME_BAMOE_CANVAS --output jsonpath={.spec.host}
```

--------------------------------

### DMN Editor Methods for Manipulation

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=features-bpmn-dmn-editors-standalone-javascript-libraries

This section outlines essential methods provided by the DMN Editor instance for interacting with the editor's content and state. These methods include retrieving content, setting content, getting previews, subscribing to changes, and managing undo/redo functionality.

```javascript
// Returns a Promise that contains the Editor’s content.
dmnEditor.getContent(): Promise<string>

// Sets the content of the editor. The returning Promise will be rejected if setting the content fails.
dmnEditor.setContent(normalizedPosixPathRelativeToTheWorkspaceRoot: string, content: string): Promise<void>

// Returns a Promise that resolves to the SVG string of the current diagram.
dmnEditor.getPreview(): Promise<string>

// Setup a callback function that is automatically called on every content change in the Editor. It returns the same function that needs to be used for unsubscription.
dmnEditor.subscribeToContentChanges(callback: (isDirty: boolean) => void): (isDirty: boolean) => void

// Unsubscribes the callback function from being called when the content changes.
dmnEditor.unsubscribeToContentChanges(callback: (isDirty: boolean) => void): void

// Resets the editor state by signaling that the content is saved. It also fires the subscribed callbacks for content changes.
dmnEditor.markAsSaved(): void

// Undo the last change in the Editor. It will also fire the subscribed callbacks of content changes.
dmnEditor.undo(): void

// Redo the last undone change in the Editor.
dmnEditor.redo(): void
```

--------------------------------

### Minikube Install: Deploy BAMOE Management Console with Helm

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=installing-bamoe-management-console

This snippet provides instructions for installing the BAMOE Management Console on a Minikube cluster using a Helm chart. It requires a running Minikube instance and the Nginx Ingress controller. The commands pull the chart and install it with Minikube-specific values.

```bash
helm pull oci://quay.io/bamoe/consoles-helm-chart --version=9.3.0-ibm-0007 --untar
helm install bamoe-management-console ./consoles-helm-chart \
 --values ./consoles-helm-chart/values-minikube-nginx.yaml
```

--------------------------------

### Generic Kubernetes Install: Deploy BAMOE Management Console with Helm

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=installing-bamoe-management-console

This snippet demonstrates how to install the BAMOE Management Console on a generic Kubernetes cluster using Helm. It requires obtaining the cluster domain and Ingress class, then executing Helm commands with specific configuration values. The input includes Kubernetes cluster details, and the output is the deployed console.

```bash
helm pull oci://quay.io/bamoe/consoles-helm-chart --version=9.3.0-ibm-0007 --untar
helm install bamoe-management-console ./consoles-helm-chart \
 --values ./consoles-helm-chart/values-kubernetes.yaml \
  --set global.kubernetesClusterDomain="<YOUR_KUBERNETES_CLUSTER_DOMAIN>" \
 --set global.kubernetesIngressClass="<YOUR_KUBERNETES_INGRESS_CLASS>"
```

--------------------------------

### Configure Git Auth Providers (JSON)

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=installing-bamoe-canvas

Example JSON configuration for the KIE_SANDBOX_AUTH_PROVIDERS environment variable. This structure allows you to define authentication settings for various Git providers like GitHub Enterprise Server, GitLab, and Bitbucket Data Center. Ensure the 'domain', 'supportedGitRemoteDomains', and 'type' fields accurately reflect your Git provider's details.

```json
[
  {
    "id": "unique identifier",
    "domain": "https://your-git-provider.com",
    "supportedGitRemoteDomains": ["your-git-provider.com"],
    "type": "gitlab | githubEnterprise | bitbucketDataCenter",
    "name": "readable name for displaying in the BAMOE UI",
    "enabled": true,
    "group": "git",
    "disableEncoding": true
  }
]
```

--------------------------------

### Install BAMOE Canvas Helm Chart (Default)

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=installing-bamoe-canvas

Installs the BAMOE Canvas using a default Helm chart configuration. This is the recommended method for deploying BAMOE Canvas in Kubernetes, OpenShift, and Minikube environments. Ensure you replace '{VERSION}' with the appropriate chart version.

```bash
helm install my-bamoe-canvas oci://quay.io/bamoe/canvas-helm-chart --version={VERSION}
```

--------------------------------

### Install Helm Chart with Custom Configuration

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=installing-bamoe-management-console

This snippet demonstrates how to install a Helm chart with custom configurations by overriding default values. It utilizes the `helm install` command with the `--set` flag to specify configuration parameters. This method is useful for quick adjustments or when modifying the `values.yaml` file is not feasible.

```bash
helm install bamoe-management-console ./consoles-helm-chart --set <my.configuration>="<value>"
```

--------------------------------

### Prometheus Metrics Response Example

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=services-monitoring-business

This is an example of the response received when querying the /metrics endpoint. The output follows the Prometheus exposition format, providing metrics related to process instances, work items, and Drools rule firings.

```text
# HELP kogito_process_instance_completed_total Completed Process Instances
# TYPE kogito_process_instance_completed_total counter
# HELP kogito_process_instance_started_total Started Process Instances
# TYPE kogito_process_instance_started_total counter
kogito_process_instance_started_total{app_id="acme-travels",process_id="travels",} 1.0
# HELP kogito_work_item_duration_seconds Work Items Duration
# TYPE kogito_work_item_duration_seconds summary
# HELP drl_match_fired_nanosecond Drools Firing Time
# TYPE drl_match_fired_nanosecond histogram
drl_match_fired_nanosecond_bucket{identifier="acme-travels",rule_name="Brazilian citizens require visa to Australia",le="1000000.0",} 1.0
drl_match_fired_nanosecond_bucket{identifier="acme-travels",rule_name="Brazilian citizens require visa to Australia",le="2000000.0",} 1.0
drl_match_fired_nanosecond_bucket{identifier="acme-travels",rule_name="Brazilian citizens require visa to Australia",le="3000000.0",} 1.0
drl_match_fired_nanosecond_bucket{identifier="acme-travels",rule_name="Brazilian citizens require visa to Australia",le="4000000.0",} 1.0
drl_match_fired_nanosecond_bucket{identifier="acme-travels",rule_name="Brazilian citizens require visa to Australia",le="5000000.0",} 1.0
drl_match_fired_nanosecond_bucket{identifier="acme-travels",rule_name="Brazilian citizens require visa to Australia",le="6000000.0",} 1.0
drl_match_fired_nanosecond_bucket{identifier="acme-travels",rule_name="Brazilian citizens require visa to Australia",le="7000000.0",} 1.0
drl_match_fired_nanosecond_bucket{identifier="acme-travels",rule_name="Brazilian citizens require visa to Australia",le="8000000.0",} 1.0
drl_match_fired_nanosecond_bucket{identifier="acme-travels",rule_name="Brazilian citizens require visa to Australia",le="9000000.0",} 1.0
drl_match_fired_nanosecond_bucket{identifier="acme-travels",rule_name="Brazilian citizens require visa to Australia",le="+Inf",} 1.0
drl_match_fired_nanosecond_count{identifier="acme-travels",rule_name="Brazilian citizens require visa to Australia",} 1.0
drl_match_fired_nanosecond_sum{identifier="acme-travels",rule_name="Brazilian citizens require visa to Australia",} 789941.0
# HELP kogito_process_instance_sla_violated_total Process Instances SLA Violated
# TYPE kogito_process_instance_sla_violated_total counter
# HELP kogito_process_instance_duration_seconds Process Instances Duration
# TYPE kogito_process_instance_duration_seconds summary
# HELP kogito_process_instance_running_total Running Process Instances

```

--------------------------------

### Verify Ollama Installation CLI

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=ai-using-gen-task-in-workflows

Checks if the Ollama command-line interface is installed and accessible. This is a crucial step after downloading and installing Ollama to ensure the runtime is ready for use.

```bash
ollama --version
```

--------------------------------

### DMN Editor Standalone API

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=features-bpmn-dmn-editors-standalone-javascript-libraries

This section details the API for initializing and interacting with the standalone DMN Editor.

```APIDOC
## DMN Editor Standalone API

### Description
This API allows for the installation and usage of the standalone DMN Editor within a web project.

### Installation

1. Add the library to the project’s `package.json`:
   ```bash
   npm install @ibm/bamoe-standalone-dmn-editor@9.3.0-ibm-0007
   ```

2. Import the editor library:
   ```javascript
   import * as DmnEditor from "@ibm/bamoe-standalone-dmn-editor/dist";
   ```

### Initialization

To load the Editor, add a 'div' element in your HTML and then use the `DmnEditor.open()` method:

HTML:
```html
<div id="new-dmn-editor-container"/>
```

JavaScript:
```javascript
const dmnEditor = DmnEditor.open({
  container: document.getElementById("new-dmn-editor-container"),
  initialFileNormalizedPosixPathRelativeToTheWorkspaceRoot: "model.dmn",
  initialContent: Promise.resolve(""),
  readOnly: false,
  origin: "*",
  onError: () => {},
  resources: new Map([
    [
      "MyDecision.dmn",
      {
        contentType: "text",
        content: Promise.resolve("")
      }
    ]
  ])
});
```

### Parameters

#### Initialization Parameters

- **`container`** (HTMLElement) - Specifies the HTML element that the Editor is appended to. (Mandatory)
- **`initialFileNormalizedPosixPathRelativeToTheWorkspaceRoot`** (string) - Specifies the POSIX path relative to the workspace root, including the file name. (Mandatory)
  - Examples: `model.dmn`, `myPath/model.dmn`, `parent/child/filename.dmn`
- **`initialContent`** (Promise<string>) - Accepts a Promise that resolves to the contents of a .dmn file. (Mandatory)
  - Examples: `Promise.resolve("")`, `Promise.resolve("<DMN_CONTENT_DIRECTLY_HERE>")`, `fetch("MyDecision.dmn").then(content => content.text())`
- **`readOnly`** (boolean) - Set to `true` for read-only mode, `false` for content edition. Defaults to `false`. (Optional)
- **`origin`** (string) - Defaults to `*` for `file://` protocol, otherwise `window.location.origin`. (Optional)
- **`onError`** (function) - A function called when the Editor encounters an error. Defaults to `() => {}`. (Optional)
- **`resources`** (Map<string, object>) - A Map of resources to be provided for the Editor. Defaults to an empty Map. (Optional)
  - Resource object: `{ contentType: "text" | "binary", content: Promise<string> }`
  - Example: `new Map([["types.dmn", { contentType: "text", content: Promise.resolve("<DMN_CONTENTS_HERE>")}]])`

### Editor Instance Methods

The returned `dmnEditor` object provides the following methods:

- **`getContent(): Promise<string>`**
  - Description: Returns a Promise that contains the Editor’s content.

- **`setContent(normalizedPosixPathRelativeToTheWorkspaceRoot: string, content: string): Promise<void>`**
  - Description: Sets the content of the editor. The Promise will be rejected if setting the content fails.

- **`getPreview(): Promise<string>`**
  - Description: Returns a Promise that resolves to the SVG string of the current diagram.

- **`subscribeToContentChanges(callback: (isDirty: boolean) => void): (isDirty: boolean) => void`**
  - Description: Setup a callback function that is automatically called on every content change. Returns the same function for unsubscription.

- **`unsubscribeToContentChanges(callback: (isDirty: boolean) => void): void`**
  - Description: Unsubscribes the callback function from content change notifications.

- **`markAsSaved(): void`**
  - Description: Resets the editor state by signaling that the content is saved. Fires subscribed callbacks for content changes.

- **`undo(): void`**
  - Description: Undoes the last change in the Editor. Fires subscribed callbacks for content changes.

- **`redo(): void`**
  - Description: Redoes the last undone change in the Editor. Fires subscribed callbacks for content changes.

```

--------------------------------

### Decisions Embedded Mode Example (Java)

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=projects-upgrading-standalone

Example Java class for running a Business Service project in standalone mode using the Decisions template. Requires updating namespace, modelName, and dmnContext. The `mvn clean package` command is used to build the project.

```java
package com.example;

import org.kie.api.KieServices;
import org.kie.api.runtime.KieContainer;
import org.kie.api.runtime.KieSession;
import org.kie.dmn.api.core.DMNRuntime;
import org.kie.dmn.api.core.DMNModel;
import org.kie.dmn.api.core.DMNContext;

public class DecisionsEmbeddedModeExample {

    public static void main(String[] args) {
        KieServices ks = KieServices.Factory.get();
        KieContainer kc = ks.getKieClasspathContainer();
        KieSession ksession = kc.newKieSession("your-business-services-session"); // Replace with your session name

        DMNRuntime dmnRuntime = ksession.getKieRuntime(DMNRuntime.class);

        // Replace with your model namespace and name
        String namespace = "https://kie.org/dmn/_C83DFD16-A42A-46BE-A843-370444580E0F"; 
        String modelName = "loan-application-age-limit"; 

        DMNModel dmnModel = dmnRuntime.getModel(namespace, modelName);
        DMNContext dmnContext = dmnRuntime.newContext();

        // Update dmnContext according to your model Input Data nodes
        // Example:
        // dmnContext.set("input1", "value1");
        // dmnContext.set("input2", 123);

        dmnRuntime.evaluateAll(dmnModel, dmnContext);

        // Process results if needed
        System.out.println("DMN evaluation completed.");

        ksession.dispose();
    }
}
```

--------------------------------

### Example Swidtag File Content (ISO/IEC 19770-2:2015)

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=usage-tracking-license-use-in-ilmt

This is an example of the XML content of a swidtag file generated by the BAMOE ILMT libraries, adhering to the ISO/IEC 19770-2:2015 specification. This file contains metadata about the software for license management purposes.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<SoftwareIdentity name="IBM Decision Manager Open Edition" tagId="ibm.com-3d9d28f19d0f45fda113c07fb481e3ea-9.0.0" version="9.0.0" versionScheme="multipartnumeric" xml:lang="en" xmlns="http://standards.iso.org/iso/19770/-2/2015/schema.xsd" xmlns:ds="http://www.w3.org/2000/09/xmldsig#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://standards.iso.org/iso/19770/-2/2015-current/schema.xsd schema.xsd">
    <Meta persistentId="3d9d28f19d0f45fda113c07fb481e3ea"/>
    <Meta generator="4-1-20210113"/>
    <Entity name="IBM" regid="ibm.com" role="licensor tagCreator softwareCreator"/>
</SoftwareIdentity>
```

--------------------------------

### Example ReteDumper Output

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=80x-performance-considerations

This is an example output from the ReteDumper utility, illustrating the structure of the Rete network. It shows different node types like EntryPointNode, ObjectTypeNode, JoinNode, AccumulateNode, EvalConditionNode, and RuleTerminalNode, along with their associations.

```text
[EntryPointNode(1) EntryPoint::DEFAULT ] on Partition(MAIN) 
[ObjectTypeNode(3)::EntryPoint::DEFAULT objectType=[ClassObjectType class=com.sample.Customer] expiration=-1ms ] on Partition(MAIN) 
[LeftInputAdapterNode(4)] on Partition(1) Ld 0 Li 0 
[JoinNode(6) - [ClassObjectType class=com.sample.Order]] on Partition(1) Ld 0 Li 0 Rd 22 Ri 22 
[JoinNode(7) - [ClassObjectType class=com.sample.Order]] $o1.id, price > $o1.price]> on Partition(1) Ld -1 Li -1 Rd 22 Ri 22 
[ AccumulateNode(8) ] on Partition(1) Ld -1 Li -1 Rd 18 Ri 18 
[EvalConditionNode(9)]: cond=com.sample.Rule_Collect_expensive_orders_combination930932360Eval1Invoker@ee2a6922] on Partition(1) Ld -1 Li -1 
[RuleTerminalNode(10): rule=Collect expensive orders combination] on Partition(1) d -1 i -1 
[ObjectTypeNode(5)::EntryPoint::DEFAULT objectType=[ClassObjectType class=com.sample.Order] expiration=-1ms ] on Partition(MAIN) 
[JoinNode(6) - [ClassObjectType class=com.sample.Order]] on Partition(1) Ld 0 Li 0 Rd 22 Ri 22 
[JoinNode(7) - [ClassObjectType class=com.sample.Order]] $o1.id, price > $o1.price]> on Partition(1) Ld -1 Li -1 Rd 22 Ri 22 
[ AccumulateNode(8) ] on Partition(1) Ld -1 Li -1 Rd 18 Ri 18 
[ObjectTypeNode(2)::EntryPoint::DEFAULT objectType=[ClassObjectType class=org.drools.core.reteoo.InitialFactImpl] expiration=-1ms ] on Partition(MAIN)
```

--------------------------------

### Apply Node State

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=features-bpmn-dmn-editors-standalone-javascript-libraries

Apply a specific visual state to a node.

```APIDOC
## POST /nodes/{uuid}/state

### Description
Applies state to a node given the UUID. Possible states include [None, Selected, Highlight, Invalid].

### Method
POST

### Endpoint
`/nodes/{uuid}/state`

### Parameters
#### Path Parameters
- **uuid** (string) - Required - The unique identifier of the node.
#### Request Body
- **state** (string) - Required - The state to apply to the node (e.g., "Selected", "Highlight").

### Request Example
```json
{
  "state": "Selected"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates successful operation (e.g., "success").

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Rules Embedded Mode Example (Java)

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=projects-upgrading-standalone

Example Java class for running a Business Service project in standalone mode using the Rules template. Requires updating domain data objects within the CommandFactory. The `mvn clean package` command is used to build the project.

```java
package com.example;

import org.kie.api.KieServices;
import org.kie.api.runtime.KieContainer;
import org.kie.api.runtime.KieSession;
import org.kie.api.command.Command;
import org.kie.internal.command.CommandFactory;

// Assume Applicant is a domain data object defined elsewhere
// class Applicant {
//     String id;
//     int age;
//     public Applicant(String id, int age) { this.id = id; this.age = age; }
//     // getters and setters
// }

public class RulesEmbeddedModeExample {

    public static void main(String[] args) {
        KieServices ks = KieServices.Factory.get();
        KieContainer kc = ks.getKieClasspathContainer();
        KieSession ksession = kc.newKieSession("your-business-rules-session"); // Replace with your session name

        // Replace Applicant with your domain data object
        // CommandFactory.newInsert(new Applicant("#0001", 20), "applicant")
        Command<?> insertCommand = CommandFactory.newInsert(new Applicant("#0001", 20), "applicant");
        ksession.execute(insertCommand);

        ksession.fireAllRules();

        // Process results if needed
        System.out.println("Rules execution completed.");

        ksession.dispose();
    }
}
```

--------------------------------

### Install BAMOE Canvas Helm Chart (OpenShift)

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=installing-bamoe-canvas

Installs BAMOE Canvas in an OpenShift environment using a Helm chart. This process involves pulling the chart, untarring it, and then installing with custom values, specifically setting the OpenShift route domain. Replace '{VERSION}' and '<YOUR_OCP_ROUTE_DOMAIN>' with your specific values.

```bash
helm pull oci://quay.io/bamoe/canvas-helm-chart --version={VERSION} --untar
helm install my-bamoe-canvas ./canvas-helm-chart --values ./canvas-helm-chart/values-openshift.yaml --set global.openshiftRouteDomain="<YOUR_OCP_ROUTE_DOMAIN>"
```

--------------------------------

### Import classic BPMN and DMN Editors in JavaScript

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=features-bpmn-dmn-editors-standalone-javascript-libraries

Imports the BPMN and DMN editors from the installed package into a JavaScript file. These imports are necessary to use the editor functionalities.

```javascript
import * as BpmnEditor from "@ibm/bamoe-standalone-bpmn-and-dmn-editors-classic/dist/bpmn"
import * as DmnEditor from "@ibm/bamoe-standalone-bpmn-and-dmn-editors-classic/dist/dmn"
```

--------------------------------

### Prometheus Metric Example

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=services-monitoring-business

This snippet shows an example of a Prometheus gauge metric for running Kogito process instances. It includes labels for application ID and process ID. This metric can be scraped by Prometheus to monitor application health.

```prometheus
# TYPE kogito_process_instance_running_total gauge
kogito_process_instance_running_total{app_id="acme-travels",process_id="travels",} 1.0
```

--------------------------------

### Load classic BPMN and DMN Editors

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=features-bpmn-dmn-editors-standalone-javascript-libraries

Loads the classic BPMN and DMN editors by providing references to their respective HTML containers. This code snippet demonstrates the instantiation of both editors with essential configuration parameters.

```javascript
const bpmnEditorClassic = BpmnEditor.open({
  container: document.getElementById("bpmn-editor-container"),
  initialContent: Promise.resolve(""),
  readOnly: false,
  origin: "*",
  onError: () => {},
  resources: new Map([])
});

const dmnEditorClassic = DmnEditor.open({
  container: document.getElementById("dmn-editor-container"),
  initialContent: Promise.resolve(""),
  readOnly: false,
  origin: "*",
  onError: () => {},
  resources: new Map([])
});
```

--------------------------------

### Get OpenShift Route Domain

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=installing-bamoe-canvas

Retrieves the default OpenShift domain for your routes, which is necessary for configuring BAMOE Canvas installations in an OpenShift environment. This command helps determine the domain to be used in the Helm chart values.

```bash
oc get ingresses.config cluster --output jsonpath={.spec.domain}
```

--------------------------------

### Initialize BPMN Editor with Options

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=features-bpmn-dmn-editors-standalone-javascript-libraries

This JavaScript code initializes the BPMN Editor by providing a reference to its container element and configuring various options such as initial content, file path, read-only mode, origin, error handling, and additional resources. The `container` parameter is mandatory and specifies the HTML element for the editor.

```javascript
const bpmnEditor = BpmnEditor.open({
  container: document.getElementById("bpmn-editor-container"),
  initialContent: Promise.resolve(""),
  initialFileNormalizedPosixPathRelativeToTheWorkspaceRoot: "model.bpmn",
  readOnly: false,
  origin: "*",
  onError: () => {},
  resources: new Map([
    [
      "MyDecision.dmn",
      {
        contentType: "text",
        content: Promise.resolve("")
      }
    ]
  ])
});
```

--------------------------------

### Initialize and Load DMN Editor

Source: https://www.ibm.com/docs/en/ibamoe/9.3.0/index_topic=features-bpmn-dmn-editors-standalone-javascript-libraries

This JavaScript code demonstrates how to initialize and load the DMN Editor. It passes a reference to the HTML container and configures various aspects of the editor, such as initial content, read-only mode, and error handling. The `resources` parameter allows pre-loading of related DMN files.

```javascript
const dmnEditor = DmnEditor.open({
  container: document.getElementById("new-dmn-editor-container"),
  initialFileNormalizedPosixPathRelativeToTheWorkspaceRoot: "model.dmn",
  initialContent: Promise.resolve(""),
  readOnly: false,
  origin: "*",
  onError: () => {},
  resources: new Map([
    [
      "MyDecision.dmn",
      {
        contentType: "text",
        content: Promise.resolve("")
      }
    ]
  ])
});
```
Tokens:
Raw