Onify Flow Extensions
Api
-
extensions
: Flow extensions
-
extendFn
: extend function to pass to serializer
Examples
Bpmn engine example
const { Engine } = require('bpmn-engine');
const { extensions } = require('@onify/flow-extensions');
const FlowScripts = require('@onify/flow-extensions/dist/src/FlowScripts');
const source = `
<definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:camunda="http://camunda.org/schema/1.0/bpmn">
<process id="theProcess" isExecutable="true">
<serviceTask id="task1" camunda:expression="\${environment.services.serviceFn}" camunda:resultVariable="result" />
<sequenceFlow id="to-task2" sourceRef="task1" targetRef="task2" />
<scriptTask id="task2" camunda:resultVariable="out">
<script>
next(null, myContextFn());
</script>
</scriptTask>
</process>
</definitions>`;
const name = 'onify flow';
const engine = new Engine({
name,
source,
moddleOptions: {
camunda: require('camunda-bpmn-moddle/resources/camunda.json'),
},
services: {
serviceFn(scope, callback) {
callback(null, { data: 1 });
},
},
extensions: {
onify: extensions,
},
scripts: new FlowScripts(name, './script-resources', {
myContextFn() {
return 2;
},
}),
});
engine.execute((err, instance) => {
if (err) throw err;
console.log(instance.name, instance.environment.output);
});
Extract scripts with extend function
const { extendFn } = require('@onify/flow-extensions');
const BpmnModdle = require('bpmn-moddle');
const Elements = require('bpmn-elements');
const { default: Serializer, TypeResolver } = require('moddle-context-serializer');
const source = `
<definitions id="Def_0" xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL"
xmlns:camunda="http://camunda.org/schema/1.0/bpmn"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
targetNamespace="http://bpmn.io/schema/bpmn">
<process id="process-1" name="Onify Flow" isExecutable="true">
<serviceTask id="task1">
<extensionElements>
<camunda:connector>
<camunda:connectorId>onifyApiRequest</camunda:connectorId>
<camunda:inputOutput>
<camunda:inputParameter name="method">GET</camunda:inputParameter>
<camunda:inputParameter name="url">/my/items/workspace-1</camunda:inputParameter>
<camunda:outputParameter name="result">
<camunda:script scriptFormat="js">
next(null, {
id: content.id,
statuscode,
});
</camunda:script>
</camunda:outputParameter>
</camunda:inputOutput>
</camunda:connector>
<camunda:inputOutput>
<camunda:outputParameter name="result">\${content.output.result.statuscode}</camunda:outputParameter>
</camunda:inputOutput>
</extensionElements>
</serviceTask>
<sequenceFlow id="to-task2" sourceRef="task1" targetRef="task2" />
<scriptTask id="task2" camunda:resultVariable="out">
<script>
next(null, 2);
</script>
</scriptTask>
</process>
</definitions>`;
(async () => {
const moddle = await getModdleContext(source, {
camunda: require('camunda-bpmn-moddle/resources/camunda.json'),
});
const serialized = Serializer(moddle, TypeResolver(Elements), extendFn);
console.log(serialized.elements.scripts);
})();
function getModdleContext(source, options) {
const bpmnModdle = new BpmnModdle(options);
return bpmnModdle.fromXML(Buffer.isBuffer(source) ? source.toString() : source.trim());
}
Extend sequence flow with properties and take listeners
const { OnifySequenceFlow, extensions } = require('@onify/flow-extensions');
const FlowScripts = require('@onify/flow-extensions/dist/src/FlowScripts');
const { Engine } = require('bpmn-engine');
const Elements = require('bpmn-elements');
const source = `
<?xml version="1.0" encoding="UTF-8"?>
<definitions
id="Def_0"
xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL"
xmlns:camunda="http://camunda.org/schema/1.0/bpmn"
targetNamespace="http://bpmn.io/schema/bpmn">
<process id="Process_1kk79yr" isExecutable="true">
<startEvent id="start" />
<sequenceFlow id="to-script" sourceRef="start" targetRef="script">
<extensionElements>
<camunda:properties>
<camunda:property name="source" value="\${content.id}" />
</camunda:properties>
<camunda:executionListener event="take">
<camunda:script scriptFormat="js">environment.output.fields = listener.fields; next();</camunda:script>
<camunda:field name="taken">
<camunda:expression>\${true}</camunda:expression>
</camunda:field>
<camunda:field name="bar">
<camunda:string>baz</camunda:string>
</camunda:field>
</camunda:executionListener>
</extensionElements>
</sequenceFlow>
<sequenceFlow id="to-end" sourceRef="script" targetRef="end">
<extensionElements>
<camunda:properties>
<camunda:property name="foo" value="bar" />
</camunda:properties>
</extensionElements>
</sequenceFlow>
<scriptTask id="script" name="script" scriptFormat="js">
<script>next(null, { foo: environment.variables.required.input });</script>
</scriptTask>
<boundaryEvent id="catch-err" attachedToRef="script">
<errorEventDefinition />
</boundaryEvent>
<endEvent id="end-err">
<extensionElements>
<camunda:executionListener event="start">
<camunda:script scriptFormat="js">
environment.output.failedBy = content.inbound[0].properties.error;
if (next) next();
</camunda:script>
</camunda:executionListener>
</extensionElements>
</endEvent>
<sequenceFlow id="to-end-err" sourceRef="catch-err" targetRef="end-err">
<extensionElements>
<camunda:properties>
<camunda:property name="error" value="\${content.output}" />
</camunda:properties>
</extensionElements>
</sequenceFlow>
<endEvent id="end" />
</process>
</definitions>`;
const engine = new Engine({
name: 'sequence flow extension',
source,
moddleOptions: {
camunda: require('camunda-bpmn-moddle/resources/camunda.json'),
},
extensions: {
onify: extensions,
},
scripts: new FlowScripts('sequence flow extension'),
elements: {
...Elements,
SequenceFlow: OnifySequenceFlow,
},
});
engine.execute((err, instance) => {
if (err) throw err;
console.log(instance.name, instance.environment.output);
});