Kogito

Kogito is the next generation of Business Automation platform focused on cloud-native development, deployment and execution.

Quick Links

Homepage: http://kogito.kie.org

Wiki: https://github.com/kiegroup/kogito-tooling/wiki

JIRA: https://issues.jboss.org/projects/KOGITO

jBPM: https://www.jbpm.org/

Drools: https://www.drools.org/

Getting Started

This module contains a number of examples that you can take a look at and try out yourself. Please take a look at the readme of each individual example for more details on how the example works and how to run it yourself (either locally or on Kubernetes):

• Process + Quarkus: README.md
• Process + Spring Boot: README.md
• Process + Rules + Quarkus: README.md - Onboarding example combining one process and two decision services
• Rules + Quarkus: README.md
• Rule Unit + Quarkus: README.md

Releases

In Kogito Tooling releases page you will find extensions and released tooling packages.

Build from source

NOTE: We recommend using Node 16 when developing this project. Our CI uses Node 16.2.0, Yarn 1.22.10, and Lerna 4.0.0.

1. Check out the source:

   git clone git@github.com:kiegroup/kogito-tooling.git
   

   If you don't have a GitHub account use this command instead:

   git clone https://github.com/kiegroup/kogito-tooling.git
   

2. Install NodeJs, Yarn and Lerna:

   For NodeJs follow any chosen way for your operating system https://nodejs.org/en/download/package-manager/ or download and install as guided at https://github.com/nodejs/help/wiki/Installation.

   Yarn installation command:

   npm install -g yarn
   

   Lerna installation command:

   npm install -g lerna@4.0.0
   

3. Build with Yarn:

   cd kogito-tooling
   yarn bootstrap
   
   #prod
   yarn build:prod
   
   # dev
   yarn build:dev

   NOTE: It's necessary to have the Git tags fetched when building with build:prod.

   Final artifacts will be on packages/*/dist directories.

Develop

NOTE: We recommend using Node 16 when developing this project. Our CI uses Node 16.2.0, Yarn 1.22.10, and Lerna 4.0.0.

NOTE: This repository contains several packages each with its own custom configurations. Here's a list of every environment variables you can use to customize the build.

• KOGITO_TOOLING_BUILD_test: Runs or skips the unit tests on all packages. Runs the tests if empty. Can be "true" or "false".
• KOGITO_TOOLING_BUILD_lint: Runs or skips ESLint on all projects. Runs the linter if empty. Can be "true" or "false".
• WEBPACK_TS_LOADER_transpileOnly: Configures ts-loader with its value. See default
• WEBPACK_minimize: Configures Webpack to minimize the bundles or not. See default
• DOWNLOAD_HUB_linuxUrl: Used in packages/online-editor. Configures the URL to download the Linux Hub on the Online Editor. See default -
• DOWNLOAD_HUB_macOsUrl: Used in packages/online-editor. Configures the URL to download the macOS Hub on the Online Editor. See default -
• DOWNLOAD_HUB_windowsUrl: Used in packages/online-editor. Configures the URL to download the Windows Hub on the Online Editor. See default -
• ROUTER_targetOrigin: Used in packages/chrome-extension-pack-kogito-kie-editors. Configures the origin from which the Editor envelopes will be fetched. See default
• ROUTER_relativePath: Used in packages/chrome-extension-pack-kogito-kie-editors. Configures the URI from which the Editor envelopes will be fetched. See default
• ONLINEEDITOR_url: Used in packages/chrome-extension-pack-kogito-kie-editors. Configures the URL of the Online Editor to be used on the "Open in ..." button. See default
• EXTERNAL_RESOURCE_PATH__bpmnEditor: Used in several packages. Configures the local path from which the BPMN Editor files will be copied. See default
• EXTERNAL_RESOURCE_PATH__dmnEditor: Used in several packages. Configures the local path from which the DMN Editor files will be copied. See default
• EXTERNAL_RESOURCE_PATH__scesimEditor: Used in several packages. Configures the local path from which the SceSim Editor files will be copied. See default
• EXTERNAL_RESOURCE_PATH__quarkusRunner: Used in packages/vscode-extension-backend. Configures the local path from which the Quarkus Runner files will be copied. See default
• KIE_TOOLING_EXTENDED_SERVICES__linuxDownloadUrl: Used in packages/online-editor. Configures the URL to download the Linux KIE Tooling Extended Services on the Online Editor. See default
• KIE_TOOLING_EXTENDED_SERVICES__macOsDownloadUrl: Used in packages/online-editor. Configures the URL to download the macOS KIE Tooling Extended Services on the Online Editor. See default
• KIE_TOOLING_EXTENDED_SERVICES__windowsDownloadUrl: Used in packages/online-editor. Configures the URL to download the Windows KIE Tooling Extended Services on the Online Editor. See default
• KIE_TOOLING_EXTENDED_SERVICES__compatibleVersion: Used in packages/online-editor. Configures the version of the KIE Tooling Extended Services on the Online Editor. See default

Example:

$ export EXTERNAL_RESOURCE_PATH__bpmnEditor=/Users/tiago/redhat/kie-wb-common/kie-wb-common-stunner/kie-wb-common-stunner-sets/kie-wb-common-stunner-bpmn/kie-wb-common-stunner-bpmn-kogito-runtime/target/kie-wb-common-stunner-bpmn-kogito-runtime/

$ export EXTERNAL_RESOURCE_PATH__dmnEditor=/Users/tiago/redhat/kie-wb-common/kie-wb-common-dmn/kie-wb-common-dmn-webapp-kogito-runtime/target/kie-wb-common-dmn-webapp-kogito-runtime/

$ yarn bootstrap && yarn build:prod

This is only necessary for these GWT-based Editors.

VS Code Extension

1. After you've successfully built the project following the instructions above, open the packages/vscode-extension-pack-kogito-kie-editors folder on VS Code. Use a new VS Code window so that the packages/vscode-extension-pack-kogito-kie-editors folder shows up as root in the VS Code explorer.
2. From there, you can Run the extension or the integration tests by using the Debug menu/section. You can also use the respective shortcuts (F5 to start debugging, for instance).
3. NOTE: To run the VS Code extension in development mode, you need webpack and webpack-cli to be globally installed on NPM. Normally you can do that with npm install -g webpack@4.41.2 webpack-cli@3.3.10, but sudo may be required depending on your installation.
4. Remember! If you make changes to packages other than packages/vscode-extension-pack-kogito-kie-editors, you have to manually rebuild them before relaunching the extension on VS Code.

Chrome Extension

1. After you've successfully built the project following the instructions above, open the packages/chrome-extension-pack-kogito-kie-editors folder on your favourite IDE. You can import the entire repo as well if you want to make changes to other packages.
2. Run yarn build:dev on packages/chrome-extension-pack-kogito-kie-editors. This will create a version of the Chrome Extension that fetches the envelope locally.
3. Open a terminal and run yarn run serve-envelope on packages/chrome-extension-pack-kogito-kie-editors. This will start a webpack serve instance with the editors and their envelope. We use that because we don't pack the Chrome Extension bundle with the editors inside. Instead, we fetch them from GitHub pages.
4. You also have to enable invalid certificates for resources loaded from localhost in your browser. To do that, go to chrome://flags/#allow-insecure-localhost in your Chrome browser and enable this flag. Alternativelly, you can go to https://localhost:9001 and add an exception.
5. Open Chrome and go to chrome://extensions. Enable "Developer mode" in the top-right corner and click on "Load unpacked". Choose the packages/chrome-extension-pack-kogito-kie-editors/dist folder.
6. From now on you can use the development version of the extension. Remember! After each change, you have to rebuild the changed modules and hit the "Refresh" button of the extension card.

Online Editor

1. After you've successfully built the project following the instructions above, go to packages/online-editor.
2. Open a terminal and run yarn start. This will start a webpack serve instance with the Online Editor resources.
3. From now on you can use the development version of the Online Editor by accessing https://localhost:9001.

Desktop and Hub

1. After you've successfully built the project following the instructions above, go to packages/desktop or packages/hub. They work exactly the same.
2. To start the application in development mode, you can run yarn start. If you make changes and want to reload the app, run yarn run build:dev && yarn start. This will recompile the module and restart the Electron app. Remember: if you make changes to other modules, you have to build them too!
3. To build and package the application for production (i.e. generating an executable), you can run yarn run build:prod. This will pack the application for the current OS. If you want to pack the application for a different OS, run yarn run pack:linux, for example. See package.json for more details.

Standalone Editors

1. After you've successfully built the project following the instructions above, go to packages/kie-editors-standalone.
2. Open a terminal and run yarn start. This will start a webpack serve instance with the Standalone Editors test page.
3. From now on you can use the development version of the Standalone DMN Editor by accessing https://localhost:9001/resources/dmn and the Standalone BPMN Editor by accessing https://localhost:9001/resources/bpmn.

Contribute

• When opening PRs, please make sure to provide a detailed description of the issue along with the JIRA, if there's one.
• If you are a member of kiegroup and want to test a change you made in our tooling, you can go to our Run FDB issue and make a comment following the format Build: {github-username}/{branch-name}. This will trigger a job that will fetch the forks (1) of {github-username}, merge {branch-name} into main, and build them. In a few seconds you should see a new comment on the same issue, saying that a new build was triggered for you. The GitHub Actions bot will also provide a link so you can follow the build logs and download artifacts, and another link to access an Online Editor instance (2) containing your changes, once it's finished running.
• Please use Prettier to format the code before submitting a PR.

(1) This process considers the following repositories: droolsjbpm-build-bootstrap, kie-soup, appformer, kie-wb-common, drools-wb and kogito-tooling.

(2) The Online Editor instance will be accessible for 30 days.

Contributing to Kogito

All contributions are welcome! Before you start please read the Developing Drools and jBPM guide.

Guides

Here are some of the most notable ones for quick reference:

• Quarkus - Using Kogito to add business automation capabilities to an application - This guide demonstrates how your Quarkus application can use Kogito to add business automation to power it up with business processes and rules.
• Quarkus - Getting Started - Quarkus Getting Started guide