KIE Serverless Workflow Editor

Apache KIE™ Serverless Workflow Editor

Create and edit Serverless Workflow definition files (*.sw.json, *.sw.yaml, *.sw.yml).

Features

Create and edit CNCF Serverless Workflow v0.8 definition files
Real-time diagram preview rendering
Editor code-lens to assist the authoring of your workflow
Contextual auto-complete
Open API auto-completion to your functions
Integration with Red Hat Hybrid Console Authentication
Red Hat Service Catalog Integration
Automatically export diagram to SVG (see below for Settings)

Editing a new Serverless Workflow file

alt

Settings

Setting	Description	Default value
`kogito.swf.runOnSave`	Execute a command on each save operation of the SW file	`extension.kogito.swf.silentlyGenerateSvg`
`kogito.swf.svgFilenameTemplate`	Filename template to be used when generating SVG files	`${fileBasenameNoExtension}.svg`
`kogito.swf.svgFilePath`	Where to save generated SVG files	`${fileDirname}`
`kogito.swf.specsStoragePath`	Directory where spec files are stored (defaults to a 'specs' directory in the same path as the Serverless Workflow file).	`${fileDirname}/specs`
`kogito.swf.serviceRegistries`	List of Service Registries to fetch artifacts that improve the functions autocompletion mechanism.	`(empty)`
`kogito.swf.shouldReferenceServiceRegistryFunctionsWithUrls`	When adding a function coming from a Service Registry, use its URL to reference it, instead of downloading the file.	`false`
`kogito.swf.automaticallyOpenDiagramEditorAlongsideTextEditor`	When opening Serverless Workflow files, decide whether or not to open the Diagram Editor alongside the text editor. Regardless of the configured option, you can always open the Serverless Workflow Diagram Editor using the 'Open as Diagram' button.	`Ask next time` (possible: `Open automatically`, `Do not open`, `Ask next time`)

The kogito.swf.svgFilenameTemplate, kogito.swf.svgFilePath, and kogito.swf.specsStoragePath settings accept the following variables as tokens:

Variable	Example
${workspaceFolder}	`/home/your-username/your-project`
${fileDirname}	`/home/your-username/your-project/folder`
${fileExtname}	`.ext`
${fileBasename}	`file.ext`
${fileBasenameNoExtension}	`file`

The Service Registries configured in the kogito.swf.serviceRegistries setting expects a value following the following schema:

{
  "type": "object",
  "properties": {
    "registries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": { "type": "string" },
          "url": {
            "type": "string",
            "format": "uri",
            "pattern": "^https?://?[-A-Za-z0-9+&@#/%?=_!:.]+[-A-Za-z0-9+&@#/%=~_|]"
          },
          "authProvider": {
            "type": "string",
            "enum": ["none", "red-hat-account"],
            "default": "none"
          }
        },
        "required": ["name", "url", "authProvider"]
      }
    }
  }
}

Thank you

Some Open Source projects were vital for the development of this extension, and we would like to thank all of them, with highlights to:

CNCF Serverless Workflow SDK Typescript: for workflow parsing;
Mermaid: for workflow rendering and visualization;
Apicurio: for our service catalog integration;

You can also checkout the CNCF Serverless Workflow VS Code extension at VS Code Marketplace.

Apache KIE (incubating) is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the name of Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Some of the incubating project’s releases may not be fully compliant with ASF policy. For example, releases may have incomplete or un-reviewed licensing conditions. What follows is a list of known issues the project is currently aware of (note that this list, by definition, is likely to be incomplete):

Hibernate, an LGPL project, is being used. Hibernate is in the process of relicensing to ASL v2
Some files, particularly test files, and those not supporting comments, may be missing the ASF Licensing Header
Hibernate, an LGPL project, is being used. Hibernate is in the process of relicensing to ASL v2
Some files, particularly test files, and those not supporting comments, may be missing the ASF Licensing Header

If you are planning to incorporate this work into your product/project, please be aware that you will need to conduct a thorough licensing review to determine the overall implications of including this work. For the current status of this project through the Apache Incubator visit: https://incubator.apache.org/projects/kie.html

Apache KIE™ (incubating)

Apache KIE™ Serverless Workflow Editor

Features

Editing a new Serverless Workflow file

Settings

Thank you