Git Product home page Git Product logo

bamoe-docs's Introduction

IBM Business Automation Manager Open Edition (BAMOE) Documentation

Documentation for the IBM Business Automation Manager Open Edition product lives here. It is a combination of Asciidoc files and possibly links to other repositories within the KIE Community.

Installing asciidoctor

Building

Using either the native asciidoctor, asciidoctor.js, or asciidoctor in Docker, execute the following command to build the documentation from the cloned repository:

asciidoctor -vw -R . -D output \**/*.adoc

This will build all the files as HTML, show you any warnings, and output into the output directory, which is ignored by git.

Authoring

We recommend using the VS Code extension for authoring and previewing.

Writing Conventions

  • One sentence per line.

  • Tables one column per line, rows seperated by an empty line.

  • TBD

Repository Layout

The root of the repository contains a nav.adoc file, which closely resembles an Antora navigation file. This is used in building the Table of Contents (TOC) for the documentation.

Each main section in the navigation file corresponds to a directory. Each secondary section of the navigation has its own file.

Images are kept at the root level.

All attributes are in the partials/attributes.adoc file and included at the top of every file.

bamoe-docs's People

Contributors

blulas avatar elguardian avatar ibm-open-source-bot avatar jomarko avatar josephblt avatar jstastny-cz avatar kbowers-ibm avatar kmacedovarela avatar lightguard avatar ljmotta avatar martinweiler avatar porcelli avatar rishirajanand avatar thiagoelg avatar tiagobento avatar yajiey avatar yesamer avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

bamoe-docs's Issues

Elaboration on Known limitation in BAMOE 9.x release notes for stateful process support & usage.

In the release notes for 9.0.0 and 9.0.1:

9.0.0 release note has this section: https://www.ibm.com/docs/en/ibamoe/9.0.x?topic=notes-bamoe-release-version-900

Unsupported capabilities on 9.0
-Stateful Processes

This needs to be more elaborative.

======================

9.0.1 release note has a 'Known limitation section' section: https://www.ibm.com/docs/en/ibamoe/9.0.x?topic=notes-bamoe-release-version-901

 Known limitations
-To review the most current known limitations in detail, see Known limitations in IBM Business Automation Manager Open Editions 9.0.1 fix releases. The issues that arise will be reported through this source.

But in this known limitation, it doesn't mention it although stateful processes have not been released yet. Therefore it needs to be clearer in this as well.

======================

This limitation/unsupported capability should be documented in all the upcoming release notes until it is released.

We can add something as below:

Stateful Processes: Please note that as of BAMOE version 9.0.x, only decisions are supported, and stateful process use cases are not yet supported (BPMN files can be used - but only STP focused on rules orchestration). This means that workflows and stateful processes may not function as expected in your current 9.x environment if you try using a community approach in your current implementation/design phase.

Clarity on BAMOE migration directly from v7 to v9

The migration guidelines of BAMOE, https://www.ibm.com/docs/en/ibamoe/9.0.x?topic=migration-guide provides information to migrate from v6 > v7, v7 > v8 and v8 > v9. Customers are enquiring about direct migration from v7 to v9.

From recent discussion in the release call, 7 > 8 and then 8 > 9 is the recommended migration path and should be followed by the customer. The documentation however does not state it clearly.

According to discussion with Documentation team, there is an appropriate statement available, formulated in a way that would clarify the doubts. The statement should be added to the official migration guidelines.

Fixes needed in 9.0.1 documentation, in the "7 to 8 migration" tab

  • It reads "The following tools are required in order to migrate to BAMOE v9.0.0", but this section is not about version 9.
  • The table #2 detailing the versions mapping is missing the latest 8 version i.e. 8.0.5. This seems fixed in the 9.1.0 documentation (ibmdoc-test).
  • Why is table #2 duplicated in table #3?
  • In Step 3 "Update Tooling & Runtime", the Smart Router is missing in the list of components. If nothing needs to be done as part of the 7 to 8 migration, it should say it.
  • In the "Procedure" paragraph, Step 6, typo: "IIBM" instead of "IBM"
  • In the "Procedure" paragraph, Step 6, it mentions an older 8.0.3 version. It should either say 8.0.5 or 8.0.x.
  • In the "Procedure" paragraph, Step 8, it says "Start IBM BAMOE and KIE Server" where it should read "Start Business/Decision Central and KIE Server"
  • In the "Step 3: Update Persistence" paragraph, in the Note section, typo: "migraet" instead of "migrate"
  • I would think there should also be a section for clients using RHPAM/BAMOE in a SpringBoot context and what they need to do as part of their migration vs. what is currently listed in a JBoss deployment context.
  • In the "Update to use the Maven Bill of Materials (BOM)" section, typo: "depenency" should read "dependency"

Placeholder not replaced with actual Maven link in the RHPAM 7 to BAMOE 8 document for migration.

In the RHPAM 7 to BAMOE 8 migration doc - https://www.ibm.com/docs/en/ibamoe/9.0.x?topic=guide-red-hat-v7-bamoe-v8

There looks to be a typo in the following sections:

Step 2: Update Maven Configuration
MAVEN_SITE_URL_BASE}[Apache Maven] is a software project management and comprehension tool. Based on the concept of a project object model (POM), Maven can manage a project’s build, reporting and documentation from a central piece of information. IBM Business Automation Manager Open Editions relies on Maven in order to build various types of deployable artifacts, such as decision service applications. For a quick start see the Maven Quick Start Guide.

The MAVEN_SITE_URL_BASE} looks to be a placeholder which likely was intended to be replaced with the actual URL base for Maven's documentation or website. But for some reason placeholder was not properly replaced with the actual URL.

Incorrect version identifier for BAMOE 8.0.5 (0007 instead of 00017)

Problem Description:
Incorrect jar file path mentioned below in the procedure of BAMOE v8 document hosted by RH-

https://access.redhat.com/documentation/en-us/ibm_business_automation_manager_open_editions/8.0/html-single/integrating_ibm_business_automation_manager_open_editions_with_other_products_and_components/index#kieserver-kafka-emit-proc_integrating-amq-streams

Procedure

_To send Kafka messages automatically, complete one of the following tasks:

  • If you deployed KIE Server on Red Hat JBoss EAP or another application server, complete the following steps:
  1. Download the bamoe-8.0.5-maven-repository.zip product deliverable file from the Software Downloads page of the Red Hat Customer Portal.
  2. Extract the contents of the file.
    3. Copy the maven-repository/org/jbpm/jbpm-event-emitters-kafka/7.67.2.Final-redhat-0007/jbpm-event-emitters-kafka-7.67.2.Final-redhat-0007.jar file into the deployments/kie-server.war/WEB-INF/lib subdirectory of the application server.
    _

Improvement Proposal:
There is no 7.67.2.Final-redhat-0007 associated to any BAMOE version.
Rather it should be 7.67.2.Final-redhat-0017 (If we are trying to frame the procedure in this document as per 8.0.5 version)

Problem found:
https://access.redhat.com/documentation/en-us/ibm_business_automation_manager_open_editions/8.0/html-single/integrating_ibm_business_automation_manager_open_editions_with_other_products_and_components/index#kieserver-kafka-emit-proc_integrating-amq-streams

Support cases and customers affected: TS016313577

Technical contacts: -

Need BAMOE v8 Doc update for WAR filename changed from rhpam-case-mgmt-showcase to bamoe-case-mgmt-showcase

The following document is incorrect because the WAR name was changed for BAMOE. The value for rhpam-case-mgmt-showcase should be bamoe-case-mgmt-showcase instead. JBoss defaults the context-root to the base name of the WAR file.
WAR:
..\IBAMOE-8.0-AO\bamoe-8.0.0-case-mgmt-showcase-eap7-deployable\jboss-eap-7.4\standalone\deployments\bamoe-case-mgmt-showcase.war

The document has 3 references that should be updated.
Doc: https://access.redhat.com/documentation/en-us/ibm_business_automation_manager_open_editions/8.0/html-single/developing_process_services_in_ibm_business_automation_manager_open_editions/

  1. Open the Showcase application by either clicking the Apps launcher (if it is installed), or go to http://localhost:8080/rhpam-case-mgmt-showcase/jbpm-cm.html.

  2. Add the following system property to your deployment’s jboss-eap-7.4/standalone/configuration/standalone-full.xml file:

  1. With the IT_Orders_New project deployed and running in KIE Server, in a web browser, navigate to the Showcase login page http://localhost:8080/rhpam-case-mgmt-showcase/.

Grammatical Update to Red Hat -> IBM Migration Guide

Description:
Changing "blacklist.txt" to "protectedlist.txt."

Text in a paragraph:
'When a file is listed in the protectedlist.txt file, the update script does not replace the file with the new version but instead leaves the file in place and in the same location adds the new version with a .new suffix'.

Comment:
In the above sentence, retain only 'but' and remove instead.

Document integration of Kafka with the BPM engine

Client is exploring the intgration of kafka with the BPM engine,Product Version : 8.0.0 they are trying sending messages to start, intermediates and end events messages, and everything is working well.
The problem comes when they have more than one process instance and they want to notify only one. It should be possible to trigger only specific instances using correlation properties, but this is not documented.
I found a link regarding the kafka integration but not sure how to do it.
https://github.com/kiegroup/jbpm/blob/main/jbpm-bpmn2/src/main/java/org/jbpm/bpmn2/handler/SendSignalAction.java#L59-L72

Incorrect version mention for patch upgrade in BAMOE 9.0.1 release note.

Problem Description:

In the release notes of 9.0.1 - https://www.ibm.com/docs/en/ibamoe/9.0.x?topic=notes-bamoe-release-version-901

Under New in this release, the following point is mentioned incorrectly-

Documented instructions for patch update from 9.0.1 to 9.0.1

Improvement Proposal:
Expected sentence should be as follows- Documented instructions for patch update from 9.0.0 to 9.0.1

Problem found:
https://www.ibm.com/docs/en/ibamoe/9.0.x?topic=notes-bamoe-release-version-901

Support cases and customers affected: -

Technical contacts: Nikolai K.

Documentation version

We proper versioning for the documentation and that should be visible on the webpage, throughout al sections. We need it to be able to use as reference as we move forward and start having more frequent releases of it.

Examples in the 15-minute series link to old KIE repo and are 404ing

When doing the 15-minute examples, several are 404-ing with the move to the Apache-incubator repository. This can be seen in https://www.ibm.com/docs/en/ibamoe/9.0.x?topic=started-orchestrating-decisions-rules-in-15-minutes which points to https://github.com/kiegroup/kogito-examples/tree/stable/kogito-quarkus-examples/process-business-rules-quarkus but this will return a 404 on the particular identified project. This should be at https://github.com/apache/incubator-kie-kogito-examples/tree/stable/kogito-quarkus-examples/process-business-rules-quarkus

The linked project should probably also be to a particular branch that uses the IBM build of Kogito for said example versus the stable branch using most current.

[Critical] Variable name showing up on migration documentation

https://www.ibm.com/docs/en/ibamoe/9.0.x?topic=guide-red-hat-v7-bamoe-v8

Instead of the version, note that since the very first paragraph of the 7 -> 8 documentation currently shows a variable name with an "OLD" suffix (which makes it even worse).

Suggested action items:

  1. Can we fix the variable references so that the version is properly displayed;
  2. Considering this occurrence, future code readers and contributors, would it be possible to rename this variable suffix?
Screenshot 2023-11-29 at 4 56 39 PM

PAMOE 9.2 documentation: add a DB schema diagram

In PAMOE 9.2, a database schema diagram would be very useful to have to represent all the DB tables that are being used by business process instances at runtime.
There was a similar diagram in older jBPM documentation.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.