Skip to content

Commit

Permalink
New Structure
Browse files Browse the repository at this point in the history
  • Loading branch information
iaktern committed Feb 3, 2025
1 parent b38bf66 commit bd0bb6d
Show file tree
Hide file tree
Showing 81 changed files with 159 additions and 2,687 deletions.
1 change: 1 addition & 0 deletions next.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ const withNextra = require('nextra')({
themeConfig: './theme.config.tsx',
defaultShowCopyCode: true,
staticImage: true,
showHiddenPages: true,
});

module.exports = withNextra({
Expand Down
23 changes: 7 additions & 16 deletions pages/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"href": "https://www.proceed-labs.org/"
},
"about": { "title": "About", "type": "page" },
"ms-api": { "title": "MS Api", "type": "page", "href": "/msapi.html" },
"ms-api": { "title": "MS API", "type": "page", "href": "/msapi.html" },
"more": {
"title": "More",
"type": "menu",
Expand All @@ -20,22 +20,13 @@
}
}
},

"index": "Introduction",
"quick-start": "Quick Start Tutorial",
"downloads": "Downloads",
"user-guide": "User Guide",
"features": { "type": "separator", "title": "Features" },
"deployment": "Deployment and Execution",
"capability-description": "Capability Description",
"versioning": "Versioning",
"collaborative-editing": "Collaborative Editing",
"monitoring": "Process Monitoring",
"bpmn": "BPMN Adaptions",
"offline-execution": { "display": "hidden" },
"user-mgmt": { "display": "hidden" },
"general": { "type": "separator", "title": "General" },
"vision": "Vision",
"project": "Project Information",
"glossary": "Glossary",
"showcase": { "display": "hidden" }
"developer": "Developer Information",

"features": { "type": "separator", "title": "Advanced Features", "display": "hidden" },
"adv-process-deployment": { "title": "Process Deployment Methods", "display": "hidden" },
"adv-capability-description": { "title": "Capability Descriptions", "display": "hidden" }
}
File renamed without changes.
16 changes: 16 additions & 0 deletions pages/deployment.mdx → pages/adv-process-deployment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,19 @@ location or workload. This means one process literally _jumps_ from machine to
machine, and thereby can even travel above network boundaries, if it is
transported with a portable device. This is done until every process instance
reaches its ends.

## Offline Execution

Distributed Processes Engines don't need any active connections to other engines, systems or coordinators. The process execution can happen completely independently.

If a process needs the capabilities of another system or device for fulfulling the next process steps (which is the usual case), the engine waits until such system is available.

If the process engine is working to its capacity, it rejects new incoming processes or execution requests

Open questions:

- Should there be a configuration option for a wait maximum?
- Do waiting processes have influence on system performance?
- How to prevent infinite process execution? Do we need to prevent that?
- How to design the software components for waiting/listing?
- Esp. for IoT devices: how to prevent new processes or execution requests? Maybe include a waiting queue?
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
5 changes: 0 additions & 5 deletions pages/bpmn.mdx

This file was deleted.

23 changes: 0 additions & 23 deletions pages/bpmn/bpmn-supported.mdx

This file was deleted.

1 change: 0 additions & 1 deletion pages/bpmn/bpmn-versioning.mdx

This file was deleted.

164 changes: 0 additions & 164 deletions pages/collaborative-editing.mdx

This file was deleted.

4 changes: 4 additions & 0 deletions pages/developer.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Developer Information

The following sites contain information for developers how to use PROCEED externally.
For example, here we document the APIs or additions to the BPMN XML file.
3 changes: 3 additions & 0 deletions pages/developer/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"bpmn": "BPMN Serialization"
}
3 changes: 1 addition & 2 deletions pages/bpmn/_meta.json → pages/developer/bpmn/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,12 @@
"bpmn-supported": "Supported Elements",
"bpmn-general-serialization": "General Serialization",
"bpmn-data-types": "Process Variables and Types",
"bpmn-script-task": "Script Task",
"bpmn-script-task": "Script Task & API",
"bpmn-user-tasks": "User Tasks",
"bpmn-subprocesses": "Subprocesses",
"bpmn-gateways": "Gateways",
"bpmn-error-escalation": "Error & Escalation Events",
"bpmn-timer": "Timer Events",
"bpmn-constraints": "Process and Task Constraints",
"bpmn-versioning": { "display": "hidden" },
"bpmn-capabilities": { "display": "hidden" }
}
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Catching is only possible with a boundary event.

The following shows a BPMN diagram with a Script Task having two catching, interrupting error events and two catching escalation events.

![BPMN Process](/docs/images/bpmn/BPMN_Error_Escalation_Boundary_Events.png?width=350px)
![BPMN Process](/images/bpmn/BPMN_Error_Escalation_Boundary_Events.png?width=350px)

If you create this diagram in PROCEED's Management System, the following elements/attributes are automatically added for execution:

Expand Down Expand Up @@ -53,7 +53,7 @@ If you create this diagram in PROCEED's Management System, the following element

## Subprocesses and Throwing/Catching Error and Escalation Events

![BPMN Process](/docs/images/bpmn/BPMN_Subprocess_error_and_escalation.png?width=550px)
![BPMN Process](/images/bpmn/BPMN_Subprocess_error_and_escalation.png?width=550px)

For throwing escalation and error events inside a subprocess, nearly the same rules apply as for catching boundary events:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## AND Gateway

![BPMN Process](/docs/images/bpmn/BPMN_AND_GW.png?width=400)
![BPMN Process](/images/bpmn/BPMN_AND_GW.png?width=400)

The AND split enables multiple parallel process flows that run concurrently by creating a new (sub-)token for every outgoing sequence flow.

Expand All @@ -19,7 +19,7 @@ It goes on if all tokens have arrived.

## XOR and OR Splitting Gateways

![BPMN Process](/docs/images/bpmn/BPMN_In-Ex-clusive_Split.png?width=600)
![BPMN Process](/images/bpmn/BPMN_In-Ex-clusive_Split.png?width=600)

The exclusive (XOR) and inclusive (OR) gateways for splitting a process flow are supported.

Expand Down Expand Up @@ -55,7 +55,7 @@ An outgoing sequence flow is only allowed to have _no_ condition, if the `defaul

## XOR Joining Gateways

![BPMN Process](/docs/images/bpmn/BPMN_XOR_Join.png?width=200)
![BPMN Process](/images/bpmn/BPMN_XOR_Join.png?width=200)

In the case of the XOR join, the gateway waits until one token arrives at an incoming sequence flow.
Then it fowards the token to the outgoing sequence flow.
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ triggered because of an unusual high amount of ordered products, the customer
will be informed of a late shipment. If there occurs an error while processing,
the customer is informed that the order got canceled.

![BPMN Order Process](/docs/images/bpmn/BPMN_Boundary_Process.png)
![BPMN Order Process](/images/bpmn/BPMN_Boundary_Process.png)

#### Example Script Code

Expand Down Expand Up @@ -327,4 +327,4 @@ log.info('Photo taken');
return { photo: image };
```

![BPMN Network Test Process](/docs/images/bpmn/BPMN_script-task-network.png)
![BPMN Network Test Process](/images/bpmn/BPMN_script-task-network.png)
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ The former are usual processes enclosed inside the parent process and don't live
Embedded subprocesses are mainly used to reduce the visual complexity of a process.
Therefore, they can be in an expanded and in a collapsed (with a plus symbol) state.

![BPMN Process](/docs/images/bpmn/BPMN_embedded_subprocesses.png?width=700px)
![BPMN Process](/images/bpmn/BPMN_embedded_subprocesses.png?width=700px)

A call activity references another process, so that a process can be reused in multiple processes.
For instance, a billing process is a typical example of a reusable process.
The Call Activity is marked with a thick border and requires the referenced process to have at least one non-typed start event.

![BPMN Process](/docs/images/bpmn/callactivity.png?width=400px)
![BPMN Process](/images/bpmn/callactivity.png?width=400px)

## Embedded expanded or collapsed Subprocess

Expand Down
Loading

0 comments on commit bd0bb6d

Please sign in to comment.