@optimajet/workflow-designer-react

WorkflowEngine Designer NPM Package for React

Introduction

WorkflowEngine Designer for React is a library developed to facilitate the use of this component. It provides a convenient way to interact and create the Workflow Designer on your web page using React.

Prerequisites

To run the example below, you should create the WorkflowEngine backend capable of handling requests from the Workflow Designer.

Installation

npm install @optimajet/workflow-designer-react

Basic Usage

import React from 'react'
import './App.css';
import WorkflowDesigner from '@optimajet/workflow-designer-react';

function App() {
  // ---------- Parameters for Workflow Designer ---------------
  const schemeCode = '<YOUR_SCHEME_CODE_VALUE>';
  const processId = undefined;
  const designerConfig = {
    renderTo: 'wfdesigner',
    apiurl: '<YOUR_API_URL_VALUE>',
    templatefolder: '/templates/',
    widthDiff: 0,
    heightDiff: 0
  };

  return (
    <WorkflowDesigner
      schemeCode={schemeCode}
      processId={processId}
      designerConfig={designerConfig}
    />
  );
}

export default App;

If you need a version without automatic styles import, use the strict entry point and connect CSS separately:

import WorkflowDesigner from '@optimajet/workflow-designer-react/strict';
import '@optimajet/workflow-designer-react/css';

In this section:

• schemeCode - is the code for the Workflow diagram to be displayed in the Workflow Designer.
• processId - is the identifier of the WorkflowEngine process.
• designerConfig - are the direct settings for the Designer indicating all the necessary parameters, namely: the HTTP address of the WorkflowAPI for interacting with the server side of the application (apiurl), the difference between the total page width and the width available for the WorkflowDesigner (widthDiff), and the difference between the total page height and the height available for the WorkflowDesigner (heightDiff) to display the WorkflowDesigner window. For a more detailed list of the parameters, see the Designer section of the documentation page about the WorkflowEngine.

NOTE: Be careful with the case of the characters when specifying the parameters. For example: apiUrl and apiurl are two completely different values.

If you want to display the Workflow scheme in the Workflow Designer interface, set the required value to the schemecode variable, and assign the undefined value to the processId. In case you want to display the Workflow process, assign the undefined value to the schemecode, and the required value to the processId variable of the WorkflowEngine process identifier.

How to Call WorkflowDesigner Functions inside React Component

The workflow-designer-react component is a wrapper over the usual WorklfowDesigner. Some of the most commonly used methods are wrapped in the workflow-designer-react component for convenience. To use them, do the following:

• In the constructor of your component, create a class variable (for example, this.workflowDesigner) and assign the React.createRef() value to it; in the render() method of your component, in the WorkflowDesigner component, assign the value of the created variable to the ref parameter:

  import WorkflowDesigner from '@optimajet/workflow-designer-react';
  import React from 'react';
  
  export default class YourComponent extends React.Component {
     constructor(props) {
         super(props);
         this.workflowDesigner = React.createRef();
     }
     
     render() {
         // ---------- Parameters for Workflow Designer ---------------
         const schemeCode = '<YOUR_SCHEME_CODE_VALUE>';
         const processId = undefined;
         const designerConfig = {
             renderTo: 'wfdesigner',
             apiurl: '<YOUR_API_URL_VALUE>',
             templatefolder: '<TEMPLATE_FOLDER_PATH>',
             widthDiff: 0,
             heightDiff: 0
         };
         
         return (
            <WorkflowDesigner
              schemeCode={schemeCode}
              processId={processId}
              designerConfig={designerConfig}
              ref={this.workflowDesigner}
            />
         );
     }
  }
  

• Now you can use the methods of the WorkflowDesigner component directly in your component:

  yourFunction() {
      this.workflowDesigner.current.methodName();
  }
  

A complete list of the methods available for use from the WorkflowDesigner component is given below:

Method Name	Description
clearScheme()	Clears the designer, equivalent of creating empty scheme design
getDesignerErrors()	Get Workflow Designer Errors Returns Errors in Workflow Designer
save(successCallback, errorCallback)	Save Workflow scheme successCallback Function which will be executed if save was successful errorCallback Function which will be executed if save operation failed
downloadScheme()	Download XML file with Workflow Scheme description
downloadBpmn()	Download BPMN file with BPM description of the scheme.
upload(uploadType, callback)	Upload BPMN or XML file. uploadType Upload type, can be 'scheme' or 'bpmn' callback Function that will be executed after uploading file
isSchemeExist()	Check for scheme existence by the scheme code from props. Returns {boolean} If scheme exists true, otherwise, false
isProcessExist()	Check for process existence by scheme code and process id given in props. Returns {boolean} If process exists true, otherwise, false
refresh()	Refresh data in WorkflowDesigner

In case you want some methods that are not presented in this table, use the WorkflowDesigner and call its methods directly without wrappers, for example:

this.workflowDesigner.current.innerDesigner.methodName();