Skip to content

Commit

Permalink
Update DMN related documentation on main-kogito (#4515)
Browse files Browse the repository at this point in the history
* Update DMN related documentation on main-kogito

This PRs brings DMN docs changes introduced on main in 1H2023
- https://github.com/kiegroup/kie-docs/pull/4464 (cherry-pick completely the same content)
- https://github.com/kiegroup/kie-docs/pull/4512 (cherry-pick was not possible, we remove 'Business Modeler hub' term in this PR)

* Update doc-content/kogito-docs/src/main/asciidoc/creating-running/chap-kogito-creating-running.adoc

Co-authored-by: Kalyani Desai <[email protected]>

* Update doc-content/kogito-docs/src/main/asciidoc/dmn/chap-kogito-using-dmn-models.adoc

Co-authored-by: Kalyani Desai <[email protected]>

* Update doc-content/kogito-docs/src/main/asciidoc/dmn/chap-kogito-using-dmn-models.adoc

Co-authored-by: Kalyani Desai <[email protected]>

---------

Co-authored-by: Kalyani Desai <[email protected]>
  • Loading branch information
jomarko and kaldesai authored Aug 29, 2023
1 parent a6af35b commit 812097a
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 70 deletions.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -420,70 +420,20 @@ In case some ports need to be changed, you can find the configuration of the con
[role="_abstract"]
{PRODUCT} provides the following extensions or applications that you can use to design Business Process Model and Notation (BPMN) process models and Decision Model and Notation (DMN) decision models for your {PRODUCT} services using graphical modelers.

For convenience, all {PRODUCT} BPMN and DMN modelers are available in the https://kiegroup.github.io/kogito-online/#/download[Business Modeler Hub] desktop application.

* *{PRODUCT} VSCode extension*: (Recommended) Enables you to view and design BPMN models, DMN models, and test scenario files in Visual Studio Code (VSCode). The VSCode extension in the {PRODUCT} Business Modeler Hub requires VSCode 1.46.0 or later.
* *{PRODUCT} VSCode extension*: (Recommended) Enables you to view and design BPMN models, DMN models, and test scenario files in Visual Studio Code (VSCode). The VSCode extension in the {PRODUCT} requires VSCode 1.46.0 or later.
+
To install the {PRODUCT} VSCode extension directly in VSCode without the {PRODUCT} Business Modeler Hub, select the *Extensions* menu option in VSCode and search for and install the *{PRODUCT} Bundle* extension.
To install the {PRODUCT} VSCode extension select the *Extensions* menu option in VSCode and search for and install the *{PRODUCT} Bundle* extension.
* *{PRODUCT} GitHub Chrome extension*: Enables you to view and design BPMN and DMN models in GitHub repositories in Google Chrome.
+
To install the {PRODUCT} GitHub Chrome extension without the {PRODUCT} Business Modeler Hub, you can download and extract the `chrome_extension_kogito_kie_editors___VERSION__.zip` file from the https://github.com/kiegroup/kogito-tooling/releases[`kogito-tooling`] releases page in GitHub, and then in the upper-right corner in Chrome, go to *Customize and control* -> *Settings* -> *Extensions* -> *Load unpacked* and open the extracted `dist` folder.
* *Business Modeler desktop application*: Enables you to view and design BPMN and DMN models locally.
+
To run the {PRODUCT} Business Modeler desktop application without the {PRODUCT} Business Modeler Hub, you can download and extract the `business_modeler_preview___RELEASE__.zip` file from the https://github.com/kiegroup/kogito-tooling/releases[`kogito-tooling`] releases page in GitHub, and then follow the instructions in the application `README` file to run the application on your specific operating system.
To install the {PRODUCT} GitHub Chrome extension download and extract the `chrome_extension_kogito_kie_editors___VERSION__.zip` file from the https://github.com/kiegroup/kogito-tooling/releases[`kogito-tooling`] release page in GitHub, and then in the upper-right corner in Chrome, go to *Customize and control* -> *Settings* -> *Extensions* -> *Load unpacked* and open the extracted `dist` folder.
* *Business Modeler online viewer*: Enables you to view and design BPMN and DMN models online at `https://kiegroup.github.io/kogito-online/`. The online modeler supports the `.new` format, so you can also enter `bpmn.new` or `dmn.new` in a web browser to start designing a new BPMN or DMN model in the online modeler.
* *Business Modeler standalone editors*: Enable you to view and design BPMN and DMN models embedded in your web applications. To download the necessary files, you can either use the NPM artifacts from the https://www.npmjs.com/package/@kogito-tooling/kie-editors-standalone[Kogito tooling repository] or download the JavaScript files directly for the DMN standalone editor library at `https://kiegroup.github.io/kogito-online/standalone/dmn/index.js` and for the BPMN standalone editor library at `https://kiegroup.github.io/kogito-online/standalone/bpmn/index.js`.


[id="proc-kogito-modelers_{context}"]
=== Installing and using the {PRODUCT} Business Modeler Hub

[role="_abstract"]
{PRODUCT} provides a https://kiegroup.github.io/kogito-online/#/download[Business Modeler Hub] desktop application with all {PRODUCT} extensions or applications for modeling Business Process Model and Notation (BPMN) process models and Decision Model and Notation (DMN) decision models in {PRODUCT} services. {PRODUCT} currently provides extensions for VSCode (recommended) and GitHub modelers, a desktop application for offline modeling, and an online modeler.

As you develop {PRODUCT} services, you can use the {PRODUCT} Business Modeler Hub to install, launch, or uninstall the available modeling extensions or applications as needed.

.Procedure
. In a web browser, go to the https://kiegroup.github.io/kogito-online/#/download[Business Modeler Hub] download page, select the relevant *Operating System* option, and click *Download*.
. Extract the downloaded `business_modeler_hub_preview___RELEASE__` binary file to a local directory.
+
--
* On Linux: In a command terminal, navigate to the directory where you downloaded the `business_modeler_hub_preview___RELEASE__` binary file and enter the following command to extract the contents:
+
.Extract the {PRODUCT} Business Modeler Hub distribution
[source,subs="attributes+,+quotes"]
----
$ tar -xzpf business_modeler_hub_preview___RELEASE__.tar.gz
----

* On Windows or Mac: In your file browser, navigate to the directory where you downloaded the `business_modeler_hub_preview___RELEASE__` binary file and extract the ZIP file.
--
. In a command terminal, navigate to the extracted `business_modeler_hub_preview___RELEASE__` folder and enter the following command to run the application:
+
--
.Run the {PRODUCT} Business Modeler Hub application
[source,subs="attributes+,+quotes"]
----
$ cd __PATH_TO_MODELER_HUB__
$ ./Business\ Modeler\ Hub\ Preview-__RELEASE__/Business\ Modeler\ Hub\ Preview
----

The *Business Modeler Hub* opens in a new window:

.{PRODUCT} Business Modeler Hub window
image::kogito/creating-running/kogito-modeler-hub.png[Image of Business Modeler Hub]

NOTE: If the *Business Modeler Hub* window does not appear, review the `README` documentation in the Business Modeler Hub application folder for any details specific to your operating system.

Use the {PRODUCT} Business Modeler Hub to install, launch, or uninstall the available extensions or applications as needed.
--

[id="proc-kogito-vscode-extension_{context}"]
=== Installing the {PRODUCT} VSCode extension bundle without the {PRODUCT} Business Modeler Hub
=== Installing the {PRODUCT} VSCode extension

[role="_abstract"]
Although you can install and launch the {PRODUCT} Visual Studio Code (VSCode) extension from the https://kiegroup.github.io/kogito-online/#/download[Business Modeler Hub] desktop application, along with all other available {PRODUCT} modelers, you can also install {PRODUCT} VSCode extensions from Visual Studio Marketplace directly in VSCode.

VSCode is the preferred integrated development environment (IDE) for developing {PRODUCT} services. {PRODUCT} provides a *{PRODUCT} Bundle* VSCode extension that enables you to design Decision Model and Notation (DMN) decision models, Business Process Model and Notation (BPMN) 2.0 business processes, and test scenarios directly in VSCode. {PRODUCT} also provides individual *DMN Editor* and *BPMN Editor* VSCode extensions for DMN or BPMN support only, if needed.

.Prerequisites
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -583,6 +583,8 @@ The following decision table hit policies are supported in DMN:
** *Collect Min (C<):* Outputs the minimum value among the matches. The resulting values must be comparable, such as numbers, dates, or text (lexicographic order).
** *Collect Max (C>):* Outputs the maximum value among the matches. The resulting values must be comparable, such as numbers, dates or text (lexicographic order).
** *Collect Count (C#):* Outputs the number of matching rules.
** *Rule Order (R):* Collects output from multiple rules into a list ordered according to rules order. It is very similar to 'Collect' without any aggregation function, but with explicit consistent ordering in the final list as defined in the table.
** *Output Order (O):* Collects output from multiple rules into a list ordered using the same sorting mechanism as the 'Priority' hit policy.

[id="con-dmn-literal-expressions_{context}"]
==== Boxed literal expressions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,11 @@ For the complete list of new features, fixed issues, and known issues in {PRODUC

* Code generation based on the process models and decision models that developers create
* Local live (hot reload) coding on Quarkus for {PRODUCT} domain-specific services
* {PRODUCT} BPMN and DMN modelers offered through the {PRODUCT} Business Modeler Hub:
** {PRODUCT} VSCode extension (recommended) for modeling in Visual Studio Code
** {PRODUCT} GitHub Chrome extension for viewing graphical business models directly in GitHub, including model differences in GitHub pull requests
** Business Modeler desktop application for local modeling
** Business Modeler online viewer for online modeling
** {PRODUCT} DMN editor supports opening DMN 1.1, DMN 1.2, and DMN 1.3 models and saves any model as DMN 1.2
** {PRODUCT} standalone editors for embedding editors in your application
* {PRODUCT} VSCode extension (recommended) for modeling in Visual Studio Code
* {PRODUCT} GitHub Chrome extension for viewing graphical business models directly in GitHub, including model differences in GitHub pull requests
* Business Modeler online viewer for online modeling
* {PRODUCT} DMN editor supports opening DMN 1.1, DMN 1.2, and DMN 1.3 models and saves any model as DMN 1.2
* {PRODUCT} standalone editors for embedding editors in your application

[role="_additional-resources"]
.Additional resources
Expand Down Expand Up @@ -176,7 +174,6 @@ The following list describes some of the fixed issues in {PRODUCT} {PRODUCT_VERS
[role="_abstract"]
The following list describes some of the known issues in {PRODUCT} {PRODUCT_VERSION}. For more information about each known issue, select the Atlassian Jira link provided.

* In some cases on Windows, users cannot extract the downloaded {PRODUCT} Business Modeler Hub or Business Modeler desktop application ZIP files using the standard Windows unzip functionality. Users must extract the files using a file extractor, such as 7-Zip. [https://issues.redhat.com/browse/KOGITO-1897[KOGITO-1897]]
* In some cases, the names of task nodes in a BPMN process diagram cannot be edited. [https://issues.redhat.com/browse/KOGITO-1267[KOGITO-1267]]
* In a {PRODUCT} service where a DMN decision model is invoked in a BPMN process model, when a user interacts with the service through REST API requests, a `HashMap cannot be cast to __OBJECT__` error is returned in the error log. [https://issues.redhat.com/browse/KOGITO-1332[KOGITO-1332]]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,10 @@ For the complete list of new features, fixed issues, and known issues in {PRODUC

* Code generation based on the process models and decision models that developers create
* Local live (hot reload) coding on Quarkus for {PRODUCT} domain-specific services
* {PRODUCT} BPMN and DMN modelers offered through the {PRODUCT} Business Modeler Hub:
** {PRODUCT} VSCode extension (recommended) for modeling in Visual Studio Code
** {PRODUCT} GitHub Chrome extension for viewing graphical business models directly in GitHub, including model differences in GitHub pull requests
** Business Modeler desktop application for local modeling
** Business Modeler online viewer for online modeling
** {PRODUCT} DMN modeler editor supports opening DMN 1.1, DMN 1.2, and DMN 1.3 models and saves any model as DMN 1.2
* {PRODUCT} VSCode extension (recommended) for modeling in Visual Studio Code
* {PRODUCT} GitHub Chrome extension for viewing graphical business models directly in GitHub, including model differences in GitHub pull requests
* Business Modeler online viewer for online modeling
* {PRODUCT} DMN modeler editor supports opening DMN 1.1, DMN 1.2, and DMN 1.3 models and saves any model as DMN 1.2

[role="_additional-resources"]
.Additional resources
Expand Down Expand Up @@ -161,8 +159,6 @@ The following list describes some of the fixed issues in {PRODUCT} {PRODUCT_VERS
[role="_abstract"]
The following list describes some of the known issues in {PRODUCT} {PRODUCT_VERSION}. For more information about each known issue, select the Atlassian Jira link provided.

* In some cases on Windows, users cannot extract the downloaded {PRODUCT} Business Modeler Hub or Business Modeler desktop application ZIP files using the standard Windows unzip functionality. Users must extract the files using a file extractor, such as 7-Zip. [https://issues.redhat.com/browse/KOGITO-1897[KOGITO-1897]]
* In some cases on Windows, when users extract the downloaded {PRODUCT} Business Modeler Hub or Business Modeler desktop application ZIP files to a directory location with a long path, the application can fail to open or load indefinitely. Users must extract the files to a directory location with a shorter path. [https://issues.redhat.com/browse/KOGITO-1933[KOGITO-1933]]
* In some cases, when Infinispan is running in an OpenShift instance deployed on Amazon Web Services and a configured Data Index Service instance is restarted, the {PRODUCT} Data Index Service stops running and the PROTO files are removed. [https://issues.redhat.com/browse/KOGITO-1497[KOGITO-1497]]
* In the DMN boxed literal expression editor, when a user presses the *Tab* key within a FEEL expression, the FEEL auto-complete feature adds white space between characters instead of navigating out of the expression editor. [https://issues.redhat.com/browse/KOGITO-1581[KOGITO-1581]]
* In some cases, the names of task nodes in a BPMN process diagram cannot be edited. [https://issues.redhat.com/browse/KOGITO-1267[KOGITO-1267]]
Expand Down

0 comments on commit 812097a

Please sign in to comment.