Skip to content

Commit

Permalink
BXMSDOC-8536-blue Changed kogito-tooling to kie-tools (#4297)
Browse files Browse the repository at this point in the history
* Merge pull request #374 from emmurphy1/BXMSDOC-8536-main

BXMSDOC-8536 changed kogito-tooling to kie-tools

* BXMSDOC-8536-blue VS Code, cherrypick

* BXMSDOC=8536-blue updated bundle name

Co-authored-by: Emily Murphy <[email protected]>
  • Loading branch information
emmurphy1 and Emily Murphy authored Jul 19, 2022
1 parent 5a19631 commit 1d59ff0
Show file tree
Hide file tree
Showing 19 changed files with 28 additions and 28 deletions.
2 changes: 1 addition & 1 deletion assemblies/assembly-business-optimizer-springboot.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Mathematically speaking, school timetabling is an _NP-hard_ problem. That means

* Apache Maven {OPTAPLANNER_MAVEN_VERSION} or higher is installed. Maven is available from the https://maven.apache.org/[Apache Maven Project] website.

* An IDE, such as IntelliJ IDEA, VSCode, Eclipse, or NetBeans is available.
* An IDE, such as IntelliJ IDEA, VS Code, Eclipse, or NetBeans is available.

include::{enterprise-dir}/optimizer/spring-boot-ref-download-proc.adoc[leveloffset=+1]
//include::{enterprise-dir}/optimizer/intializr-proc.adoc[leveloffset=+1]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ ifdef::context[:parent-context: {context}]
:context: custom-tasks

// Purpose statement for the assembly
As a business rules developer, you can create custom tasks and work item handlers to execute custom code within your process flows and extend the operations available for use in {PRODUCT}. You can use custom tasks to develop operations that {PRODUCT} does not directly provide and include them in process diagrams. Custom tasks and work item handlers support {CENTRAL}, standalone editors, and Visual Studio Code (VSCode). This chapter describes how to use {CENTRAL} to create, manage, and deploy custom tasks and work item handlers.
As a business rules developer, you can create custom tasks and work item handlers to execute custom code within your process flows and extend the operations available for use in {PRODUCT}. You can use custom tasks to develop operations that {PRODUCT} does not directly provide and include them in process diagrams. Custom tasks and work item handlers support {CENTRAL}, standalone editors, and Visual Studio Code (VS Code). This chapter describes how to use {CENTRAL} to create, manage, and deploy custom tasks and work item handlers.

In {CENTRAL}, each task in a process diagram has a `WorkItemDefinition` Java class with an associated `WorkItemHandler` Java class. You can define a `WorkItemDefinition` using an MVFLEX Expression Language (MVEL) map as part of a MVEL list in a `.wid` file. Place the `.wid` file in the `global` directory under the project root or in the directory of the BPMN file. The work item handler contains Java code registered with {CENTRAL} and implements `org.kie.api.runtime.process.WorkItemHandler`.

Expand Down
2 changes: 1 addition & 1 deletion assemblies/assembly-designing-business-processes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ As a business processes developer, you can use {CENTRAL} in {PRODUCT} or the {PR
include::{jbpm-dir}/BPMN2/business-process-overview-con.adoc[leveloffset=+1]

include::{shared-dir}/Install/con-BPMN-DMN-modelers.adoc[leveloffset=+1]
//include::{shared-dir}/Install/proc-vscode-extension.adoc[leveloffset=+2]
include::{shared-dir}/Install/proc-vscode-extension.adoc[leveloffset=+2]
include::{shared-dir}/Install/proc-standalone-editors.adoc[leveloffset=+2]

include::{shared-dir}/Install/proc-dmn-bpmn-maven-create.adoc[leveloffset=+1]
Expand Down
2 changes: 1 addition & 1 deletion assemblies/assembly-dmn-models.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ For a step-by-step tutorial with an example DMN decision service, see {URL_GETTI
include::{shared-dir}/KIE/Overview/decision-authoring-assets-ref.adoc[leveloffset=+1]

include::{shared-dir}/Install/con-BPMN-DMN-modelers.adoc[leveloffset=+1]
//include::{shared-dir}/Install/proc-vscode-extension.adoc[leveloffset=+2]
include::{shared-dir}/Install/proc-vscode-extension.adoc[leveloffset=+2]
include::{shared-dir}/Install/proc-standalone-editors.adoc[leveloffset=+2]

include::{shared-dir}/Install/proc-dmn-bpmn-maven-create.adoc[leveloffset=+1]
Expand Down
2 changes: 1 addition & 1 deletion assemblies/assembly-getting-started-decision-services.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ include::{drools-dir}/Examples/decision-examples-central-con.adoc[leveloffset=+1
include::{drools-dir}/Examples/decision-examples-central-proc.adoc[leveloffset=+2]

include::{shared-dir}/Install/con-BPMN-DMN-modelers.adoc[leveloffset=+1]
//include::{shared-dir}/Install/proc-vscode-extension.adoc[leveloffset=+2]
include::{shared-dir}/Install/proc-vscode-extension.adoc[leveloffset=+2]
include::{shared-dir}/Install/proc-standalone-editors.adoc[leveloffset=+2]

include::{shared-dir}/Install/proc-dmn-bpmn-maven-create.adoc[leveloffset=+1]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ include::{enterprise-dir}/getting-started-kogito/con-kogito-microservices-quarku

include::{enterprise-dir}/getting-started-kogito/con-kogito-modelers.adoc[leveloffset=+1]
//include::{enterprise-dir}/getting-started-kogito/proc-kogito-modelers-install.adoc[leveloffset=+2]
//include::{shared-dir}/Install/proc-vscode-extension.adoc[leveloffset=+2]
include::{shared-dir}/Install/proc-vscode-extension.adoc[leveloffset=+2]
include::{shared-dir}/Install/proc-standalone-editors.adoc[leveloffset=+2]

include::{enterprise-dir}/getting-started-kogito/proc-kogito-creating-maven-project.adoc[leveloffset=+1]
Expand Down
2 changes: 1 addition & 1 deletion assemblies/assembly-getting-started-process-services.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ include::{drools-dir}/Examples/decision-examples-central-proc.adoc[leveloffset=+

include::{shared-dir}/Install/con-BPMN-DMN-modelers.adoc[leveloffset=+1]

//include::{shared-dir}/Install/proc-vscode-extension.adoc[leveloffset=+2]
include::{shared-dir}/Install/proc-vscode-extension.adoc[leveloffset=+2]

include::{shared-dir}/Install/proc-standalone-editors.adoc[leveloffset=+2]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ that deliver a near-optimal solution in a reasonable amount of time. What is con

* Apache Maven {OPTAPLANNER_MAVEN_VERSION} or higher is installed. Maven is available from the https://maven.apache.org/[Apache Maven Project] website.

* An IDE, such as IntelliJ IDEA, VSCode, Eclipse, or NetBeans is available.
* An IDE, such as IntelliJ IDEA, VS Code, Eclipse, or NetBeans is available.

include::{enterprise-dir}/optimizer/quarkus-creating-proj-proc.adoc[leveloffset=+1]
include::{enterprise-dir}/optimizer/business-optimizr-domain-objects-proc.adoc[leveloffset=+1]
Expand Down
2 changes: 1 addition & 1 deletion assemblies/assembly-optaplanner-vaccination.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You can use the OptaPlanner vaccination appointment scheduler quick start to dev

* Apache Maven {OPTAPLANNER_MAVEN_VERSION} or higher is installed. Maven is available from the https://maven.apache.org/[Apache Maven Project] website.

* An IDE, such as IntelliJ IDEA, VSCode, Eclipse, or NetBeans is available.
* An IDE, such as IntelliJ IDEA, VS Code, Eclipse, or NetBeans is available.

* You have created a Quakus OptaPlanner project as described in xref:optaplanner-quarkus-con_getting-started-optaplanner[].

Expand Down
2 changes: 1 addition & 1 deletion assemblies/assembly-planner-java.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ that deliver a near-optimal solution in a reasonable amount of time.

* OpenJDK (JDK) {VRP-JDK-VERSION} is installed. Red Hat build of Open JDK is available from the https://access.redhat.com/jbossnetwork/restricted/listSoftware.html[Software Downloads] page in the Red Hat Customer Portal (login required).
* Apache Maven {VRP-MAVEN-VERSION} or higher is installed. Maven is available from the https://maven.apache.org/[Apache Maven Project] website.
* An IDE, such as https://www.jetbrains.com/idea[IntelliJ IDEA], VSCode or Eclipse
* An IDE, such as https://www.jetbrains.com/idea[IntelliJ IDEA], VS Code or Eclipse

////
== Solution source code
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ A DMN conformance level 2 implementation includes the requirements in conformanc
Conformance level 3::
A DMN conformance level 3 implementation includes the requirements in conformance levels 1 and 2, and supports Friendly Enough Expression Language (FEEL) expressions, the full set of boxed expressions, and fully executable decision models.

{PRODUCT} provides runtime support for DMN 1.1, 1.2, 1.3, and 1.4 models at conformance level 3, and design support for DMN 1.2 models at conformance level 3. You can design your DMN models directly in {CENTRAL} or with the {PRODUCT} DMN modeler in VSCode, or import existing DMN models into your {PRODUCT} projects for deployment and execution. Any DMN 1.1 and 1.3 models (do not contain DMN 1.3 features) that you import into {CENTRAL}, open in the DMN designer, and save are converted to DMN 1.2 models.
{PRODUCT} provides runtime support for DMN 1.1, 1.2, 1.3, and 1.4 models at conformance level 3, and design support for DMN 1.2 models at conformance level 3. You can design your DMN models directly in {CENTRAL} or with the {PRODUCT} DMN modeler in VS Code, or import existing DMN models into your {PRODUCT} projects for deployment and execution. Any DMN 1.1 and 1.3 models (do not contain DMN 1.3 features) that you import into {CENTRAL}, open in the DMN designer, and save are converted to DMN 1.2 models.
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ The following DMN modelers are supported:

* *VS Code extension*: Enables you to view and design DMN models in Visual Studio Code (VS Code). The VS Code extension requires VS Code 1.46.0 or later.
+
To install the VSCode extension directly in VS Code, select the *Extensions* menu option in VS Code and search for and install the *IBM Business Automation Bundle* extension.
To install the VS Code extension directly in VS Code, select the *Extensions* menu option in VS Code and search for and install the *KIE Business Automation Bundle* extension.

* *Business Modeler standalone editors*: Enable you to view and design 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`.
* *Business Modeler standalone editors*: Enable you to view and design 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/@kie-tools/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`.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ For more information about BPMN2 support in {PRODUCT}, see {URL_DEVELOPING_PROCE

.Prerequisites
* https://code.visualstudio.com/[VS Code] 1.46.0 or later is installed.
* The *IBM Business Automation Bundle* VS Code extension is installed and enabled in your VS Code IDE. For information about enabling the VS Code extension, see {URL_GETTING_STARTED_KOGITO_MICROSERVICES}#proc-vscode-extension_getting-started-kogito-microservices[_Installing the {PRODUCT} VSCode extension bundle_].
* The *KIE Business Automation Bundle* VS Code extension is installed and enabled in your VS Code IDE. For information about enabling the VS Code extension, see {URL_GETTING_STARTED_KOGITO_MICROSERVICES}#proc-vscode-extension_getting-started-kogito-microservices[_Installing the {PRODUCT} VS Code extension bundle_].
* You have created a project and have included any Java objects required for your {KOGITO} microservice. For information about creating a project, see {URL_GETTING_STARTED_KOGITO_MICROSERVICES}#proc-kogito-creating-maven-project_getting-started-kogito-microservices[_Creating a Maven project for a {KOGITO} microservice_].

.Procedure
Expand All @@ -21,7 +21,7 @@ NOTE: For a new BPMN file, you can also enter `bpmn.new` in a web browser to des
. Open the new or imported BPMN file to view the process diagram in the BPMN modeler.
+
--
If the process diagram does not open in the BPMN modeler, ensure that you have installed and enabled the *IBM Business Automation Bundle* VS Code extension.
If the process diagram does not open in the BPMN modeler, ensure that you have installed and enabled the *KIE Business Automation Bundle* VS Code extension.

If the BPMN modeler opens only the XML source of the BPMN file and displays an error message, review the reported errors and the BPMN model file to ensure that all BPMN elements are correctly defined.
--
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ image::KogitoMicroservices/kogito-dmn-example-person-data-types.png[Image of Per

This example DMN model consists of a basic DMN input node and a decision node defined by a DMN decision table with a custom structured data type.

In VSCode, you can add the *IBM Business Automation Bundle* VSCode extension to design the decision requirements diagram (DRD), boxed expression, and data types with the DMN modeler.
In VS Code, you can add the *KIE Business Automation Bundle* VS Code extension to design the decision requirements diagram (DRD), boxed expression, and data types with the DMN modeler.

To create this example DMN model quickly, you can copy the following `PersonDecisions.dmn` file content:

Expand Down Expand Up @@ -168,7 +168,7 @@ To create this example DMN model quickly, you can copy the following `PersonDeci
</dmn:definitions>
----

To create this example DMN model in VSCode using the DMN modeler, follow these steps:
To create this example DMN model in VS Code using the DMN modeler, follow these steps:

.. Open the empty `PersonDecisions.dmn` file, click the *Properties* icon in the upper-right corner of the DMN modeler, and confirm that the DMN model *Name* is set to `PersonDecisions`.
.. In the left palette, select *DMN Input Data*, drag the node to the canvas, and double-click the node to name it `Person`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ endif::PAM[]

== DMN Designer

=== Ability to use an external data objects as DMN data types on VSCode
=== Ability to use an external data objects as DMN data types on VS Code

=== Drools DMN Engine support for DMN Specification v1.4

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ To use {CENTRAL}, you can set up a development environment containing a {CENTRAL

* *{PRODUCT} VS Code extension*: Enables you to view and design BPMN models, DMN models, and test scenario files in Visual Studio Code (VS Code). The VS Code extension requires VS Code 1.46.0 or later.
+
To install the {PRODUCT} VS Code extension, select the *Extensions* menu option in VS Code and search for and install the *IBM Business Automation Bundle* extension.
To install the {PRODUCT} VS Code extension, select the *Extensions* menu option in VS Code and search for and install the *KIE Business Automation Bundle* extension.

* *Standalone BPMN and DMN 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[NPM registry] or download the JavaScript files directly for the DMN standalone editor library at `\https://<YOUR_PAGE>/dmn/index.js` and for the BPMN standalone editor library at `\https://<YOUR_PAGE>/bpmn/index.js`.
* *Standalone BPMN and DMN 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/@kie-tools/kie-editors-standalone[NPM registry] or download the JavaScript files directly for the DMN standalone editor library at `\https://<YOUR_PAGE>/dmn/index.js` and for the BPMN standalone editor library at `\https://<YOUR_PAGE>/bpmn/index.js`.
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,15 @@ endif::[]
.Adding the NPM package
[source]
----
npm install @kogito-tooling/kie-editors-standalone
npm install @kie-tools/kie-editors-standalone
----
.. Import each editor library to your `TypeScript` file:
+
.Importing each editor
[source]
----
import * as DmnEditor from "@kogito-tooling/kie-editors-standalone/dist/dmn"
import * as BpmnEditor from "@kogito-tooling/kie-editors-standalone/dist/bpmn"
import * as DmnEditor from "@kie-tools/kie-editors-standalone/dist/dmn"
import * as BpmnEditor from "@kie-tools/kie-editors-standalone/dist/bpmn"
----
--
. 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.
Expand Down Expand Up @@ -152,6 +152,6 @@ The returned object contains the methods that are required to manipulate the edi
|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 https://github.com/kiegroup/kogito-tooling/blob/master/packages/envelope-bus/src/api/index.ts#L43-L56[MessageBusClientApi] and https://github.com/kiegroup/kogito-tooling/blob/master/packages/editor/src/api/KogitoEditorEnvelopeApi.ts#L34-L41[KogitoEditorEnvelopeApi].
|This is an advanced editor API. For more information about advanced editor API, see https://github.com/kiegroup/kie-tools/blob/master/packages/envelope-bus/src/api/index.ts#L43-L56[MessageBusClientApi] and https://github.com/kiegroup/kie-tools/blob/master/packages/editor/src/api/KogitoEditorEnvelopeApi.ts#L34-L41[KogitoEditorEnvelopeApi].
|===
--
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
[id="proc-vscode-extension_{context}"]
= Installing the {PRODUCT} VS Code extension bundle

{PRODUCT} provides a *IBM Business Automation Bundle* VS Code 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 VS Code. VS Code is the preferred integrated development environment (IDE) for developing new business applications. {PRODUCT} also provides individual *DMN Editor* and *BPMN Editor* VS Code extensions for DMN or BPMN support only, if needed.
{PRODUCT} provides a *KIE Business Automation Bundle* VS Code 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 VS Code. VS Code is the preferred integrated development environment (IDE) for developing new business applications. {PRODUCT} also provides individual *DMN Editor* and *BPMN Editor* VS Code extensions for DMN or BPMN support only, if needed.

IMPORTANT: The editors in the VS Code are partially compatible with the editors in the {CENTRAL}, and several {CENTRAL} features are not supported in the VS Code.

.Prerequisites
* The latest stable version of https://code.visualstudio.com/[VS Code] is installed.

.Procedure
. In your VS Code IDE, select the *Extensions* menu option and search for *IBM Business Automation Bundle* for DMN, BPMN, and test scenario file support.
. In your VS Code IDE, select the *Extensions* menu option and search for *KIE 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.
. When the *IBM Business Automation Bundle* extension appears in VS Code, select it and click *Install*.
. When the *KIE Business Automation Bundle* extension appears in VS Code, select it and click *Install*.
. For optimal VS Code editor behavior, after the extension installation is complete, reload or close and re-launch your instance of VS Code.

After you install the VS Code extension bundle, any `.dmn`, `.bpmn`, or `.bpmn2` files that you open or create in VS Code are automatically displayed as graphical models. Additionally, any `.scesim` files that you open or create are automatically displayed as tabular test scenario models for testing the functionality of your business decisions.
Expand Down
Loading

0 comments on commit 1d59ff0

Please sign in to comment.