process-reporting-ts v2.4.4

Process Report Starter

Dependency management is a critical aspects of any complex project. And doing this manually is less than ideal; the more time you spent on it the less time you have on the other important aspects of the project. Process report Starter were built to address exactly this problem. You get a one-stop-shop for all the functionality that you need to audit your process flow.

Requirements

• NPM package

    npm install process-reporting-ts

• @BpmnElement on method

    import {BpmnElement} from "process-reporting-ts";
  
    @BpmnElement(id = "Event_1anjljr", startEvent = true, keyExpression = "{{ event.PO_NUMBER }}")
    public execute(PurchaseOrderEvent event) {
  
        return ...;
    }
  
    ----
  
    @BpmnElement(id = "Activity_194xhhj")
    public execute(PurchaseOrder data) {
  
        return ...;
    }
  
    ---
  
    @BpmnElement(id = "Event_0byexdn", endEvent = true)
    public execute(ProcurementOrder procurementOrder, boolean purchaseOrderExists) {
  
        return ...;
    }

• AOP on function

import {interceptHandler} from "process-reporting-ts";

function execute(PurchaseOrderEvent data) {

   return ...
}

const aopHandler = interceptHandler(execute, {
    startEvent: true,
    instanceIdExpression: '{{ headers.TX_ID }}',
    keyExpression: '{{ data.PO_NUMBER }}'
})

• .env

  REPORTING_PROCESS_ID: Process_0e2hw2v
  REPORTING_PROCESS_SERVER: http://localhost:9090/reporting-service/rest
  REPORTING_PROCESS_VERSION: 1.0

• BPMN process-flow.bpmn
  • 

Testing

Unit Test

npm test

API

REST Report API

@POST ${reporting.server}/api/report

@BODY {
    ...@ReportEvent
}

REST Process API

@POST ${reporting.server}/api/process

@BODY {
    ...@ProcessEvent
}

REST Heart Beat API

@POST ${reporting.server}/api/definition/heart-beat

@BODY {
    ...@HeartBeatEvent
}

REST Process Definition API

@POST ${reporting.server}/api/definition

@BODY {
    ...@RegisterEvent
}

Reporting Properties

BaseReportEvent

ProcessEvent extends BaseReportEvent

ReportEvent extends BaseReportEvent

HeartBeatEvent

RegisterEvent

ReportStatus

Technology Stack

• Nodejs v16.20.2
• Third Party Libraries
  • jest 29.5.8
  • model-converter (MIT License)
  • mustache 4.2.5
  • typescript 5.2.2
  • axios-observable 2.0.0
• Code-Analyses
  • Sonar
  • jest coverage

License

MIT (unless noted otherwise)