Home

PROCEED Project Internal Wiki for Development

PROCEED is an open-source process documentation, analysis and automation tool. It is designed as a fully comprehensive process management system and offers special features for internal Business Process organisation, Industry 4.0, Smart Home and Supply Chains.

The PROCEED system basically consists of two software packages: the Management System (MS) and the Engine. These systems in turn consist of several components.

This wiki documents important information about the internal structures and implementations that are necessary for the further development of the PROCEED software. For easy, immediate start of development, follow the instructions for local execution in the README and additionally our recommendations for setting up the development environment. Also, you should read the Contribution Guidelines page and must sign the Contributor Agreement before we can accept any pull request from you.

General Documentation

• Download, Installation and Configuration for Development
• Contribution Guidelines for Development
• Debugging
• JSDoc commenting and documentation
• E2E Testing the GUI with Playwright
  • E2E Tests: Not implemented Edge-Cases
• Error Handling and Crashing

---

• Git Repository Organisation
• CI/CD: Environments, Servers, MS Systems and Deployment Pipeline
• BPMN process serialization to XML: Working with XML and XSD files
• Working with BPMN in PROCEED: bpmn‐js, diagram‐js, bpmn‐moddle
• How the processes are versioned

---

• Origin and History of the PROCEED System
• Meeting Notes from our Weekly Meetings
• Research Projects, Experiments, First Tests for new Features

Documentation concerning MS and Engine

• Functional Architecture: Components of the PROCEED System
• API/Interface: REST, GraphQL, MQTT and WebSocket Interfaces in Engine and MS
• API/Interface (Only Engine): Process Execution Modification at Runtime (Instance Data)
• API/Interface: Interface and Structure of the Process File and its related Artifacts
• API/Interface: Common Functionality on Engine and MS (Config, Logging, Machine, Evaluation)
• Configuration Files of the MS and Engine -- not in config_default.json

PROCEED Management System

• Code Structure and Software Libs
• Database: Prisma Guide
• Configuration Values
• Responsive Design in PROCEED

MS Core and Components

• HTML Editor: generated HTML Code
• Identity & Access Management: Architecture
• Identity & Access Management: Authorization
• Scheduler: Triggering Actions after a Defined Timeout

PROCEED Engine

• Platform Independence
• Component Overview
• Engine usage, import and build structures
• NodeJS Native Part Module System
• PROCEED Engine Installation and Setup

Engine Modules:

• Process Distribution Module
  • Engine Network Discovery
  • Network Abstraction: Communication and Procotol Abstraction
• Process (Instance) Manager Module
  • Process Instance and Tokens and REST Endpoints (API/Interface)
  • Decider, Constraints and Examples
  • Script execution environment for ScriptTasks and making services for it
• Machine Module
  • Logging and Log Levels
  • Engine Machine Configuration Keys and Internal Keys
  • Environment and User Profiles
  • Machine Information
• Capability Module
  • Android Capabilities
• UI Module

Backup

This section is mainly for backup purposes. It usually links to descriptions of certain aspects of previous versions of the MS or the Engine.

• Distributed Versioning in the dPMS
• MSv1: Distributed Monitoring in a dPMS
• MSv1: Architecture of the Server and the Desktop Application
• MSv1: MS-Server: main Communication Components, Network Ports and Endpoints
• MSv1: MS-Server: Development, Ports and Build
• MSv1: Code Structure, Components and Software Libs
• MSv1: Architecture of the ProcessForm Components
• MSv1: Storage Structure and Paths
• MSv1: BPMN Editor: Generated BPMN, serialized Properties and processes.json
• MSv1: Collaborative Editing
• MSv1: Source Code Editor: generated JS Code
• MSv1: Identity & Access Management: Auth0 Setup
• MSv1: 5thIndustry Applications