Skip to content

Commit 9e110f0

Browse files
committed
Create and Manage Processes page
1 parent b53ef07 commit 9e110f0

File tree

14 files changed

+107
-83
lines changed

14 files changed

+107
-83
lines changed

content/reference/script-task-api.mdx

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -579,6 +579,27 @@ TODO
579579
**Example Code**
580580
581581
```js
582+
console.info("Server öffnen");
583+
584+
/* let { req, res } = networkServer.getAsync('hallo-test');
585+
console.info(JSON.stringify(req, null, 2));
586+
console.info(JSON.stringify(res, null, 2));
587+
res.send('Hello KAAAAAIIII');
588+
console.info("Request beantwortet");
589+
*/
590+
591+
console.info(networkServer.getProcessInstanceListeningPath());
592+
console.info(networkServer.path())
593+
594+
networkServer.getAsync('hallo-test').then(({ req, res }) => {
595+
console.info("Server geöffnet in Then()");
596+
console.info(JSON.stringify(req, null, 2));
597+
console.info(JSON.stringify(res, null, 2));
598+
res.send('Hello PROCEED User');
599+
});
600+
601+
console.info("Server geöffnet");
602+
582603
```
583604
584605
### Trigger Events

content/user-guide/process-editor/_meta.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
import type { MetaRecord } from 'nextra';
22

33
const meta: MetaRecord = {
4-
'process-editor-manage': 'Create, Manage, Delete',
5-
'process-export-import': 'Import and Export',
4+
'process-editor-manage': 'Create and Manage Processes',
65
'process-editor': 'Process Editor',
76
'process-property-panel': 'Property Panel',
87
'process-subprocesses': 'Subprocesses',

content/user-guide/process-editor/index.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
asIndexPage: true
33
---
44

5-
- The _Process Editor_ view in PROCEED allows to create, manage, delete and release processes.
6-
- The usage is similar to the _Process List_ (TODO Link) and documented there. Some more options exist for editing processes
7-
- TODO: Show screenshot of Process List with some processes and folders
5+
# Creating Processes in the Process Editor
6+
7+
The _Process Editor_ view in PROCEED allows you to create, manage, delete, and release business processes.
8+
It is intended for process owners and designers.
9+
In contrast, the read-only [_Process List_](process-list) view is intended for regular employees who need to understand, interact with, or execute existing business processes.
10+
11+
![Process Editor Overview with one BPMN process](/images/user-guide/process-editor/process-editor-overview.png)
Lines changed: 29 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,39 @@
1-
Basically, there are 2 possible ways to create a process.
2-
The user can _add_ a new process or [_import_ an existing process](process-export-import).
1+
# Create, Manage, and Delete Processes
32

4-
## Add a new Process
3+
When opening the _Process Editor_ view, you see an table. Here, you can create Folders and Process for your company space. The following screenshot shows the available menu options if you select, hover, or right-click a table row:
54

6-
By clicking on the _Add_ button at the top right in the "Process Overview" page a creation window will be opened.
7-
There, a process name is required.
8-
You can choose every name for your process up to a maximum of 50 characters.
9-
Optionally, you can add a description to the process or link multiple departments with the process.
10-
After adding a name it will be possible to press the _Add Process_ button to create a new process.
5+
![Process Editor table: overview with all options](/images/user-guide/process-editor/editor-table-overview.png)
116

12-
![Process-Creation](/images/user-guide/process-creation/AddProcessModal.png?width=700px&classes=border)
7+
## Add a new Process or Folder
138

14-
## Organize the Processes in a List
9+
By right-clicking in the table or by clicking on the _Create Process_ button at the top left, you can add a new process and a window will open.
10+
There, a process _Name_ is required.
11+
Optionally, you can add a _ID_ and _Description_.
12+
After adding a Name it will be possible to press the _Create_ button to create a new process.
1513

16-
The "Process Overview" page gives you two ways to view the existing processes.
17-
You can decide which one you prefer.
18-
By clicking on the _list_ icon at the top left next to 'Processes', the datatable view will open.
14+
![Process Editor table: window for creating a new process](/images/user-guide/process-editor/editor-table-creation-modal.png)
1915

20-
There, you are able to star your favorite process, search for processes with the search bar, mark one or multiple processes and select actions, like export or delete.
21-
Furthermore, you can sort the processes by column attributes, like favorites or name, just by clicking on the table header columns.
22-
By clicking on a process in the table view the process will expand and show some more detailed information about the process, like a preview, some meta information and action buttons.
23-
By hovering and clicking over the preview you can open the process in the editor.
16+
This is similar to adding new Folders: you can either right-click or use the three dot drop-down button in the top left.
2417

25-
![DataTable-View](/images/user-guide/process-creation/Process-DataTable-View.png?width=1000px&classes=border)
18+
## Importing existing Processes
2619

27-
## Organize the Processes in a Card View
20+
You can also import existing processes from your local hard drive by right-clicking or with the _Import_ button.
21+
After selecting the process file, a window shows the process meta information that can be changed for import.
2822

29-
By clicking on the _card_ icon at the top (next to the list icon), the process card view will open.
30-
Here, you have the same options as in the datatable view.
31-
You can star, search, mark processes, select actions, and expand the process to open it or get further information.
32-
Moreover, by clicking on the favorite button under the search bar, the favorite processes are shown.
23+
![Process Editor table: window for importing an existing process](/images/user-guide/process-editor/editor-table-import-modal.png)
3324

34-
![ProcessCard-View](/images/user-guide/process-creation/Process-Card-View.png?width=1000px&classes=border)
25+
## Organize Processes
26+
27+
Like the _Process List_ view, the _Process Editor_ page gives you two ways to view your folders and processes: as a table with rows or as cards.
28+
This can be changed by clicking on the two icons at the top right.
29+
30+
![Process Editor table: window for importing an existing process](/images/user-guide/process-editor/editor-table-card-view.png)
31+
32+
The table view is more versatile.
33+
There, you can mark your favorite processes with a star, filter processes using the search bar, or sort processes by columns.
34+
You can also select one or more processes in the left column, right-click or hover your mouse over a row.
35+
New icons will then appear at the top and right of the row, which you can use to _View the Process Documentation, Open the Process Editor, Change the Meta Data, Move, Release, Download_ and _Share_ processes.
36+
37+
Clicking on a row opens the Folder or the Process Editor to design and change a process.
38+
39+
![Process Editor table: overview with all options](/images/user-guide/process-editor/editor-table-overview.png)

content/user-guide/process-editor/process-export-import.mdx

Lines changed: 0 additions & 44 deletions
This file was deleted.
Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,34 @@
1-
- Overview of using share and download (inside process table view and BPMN View)
1+
# Download and Share created Business Processes
2+
3+
PROCEED's Management System can import and export processes.
4+
Importing is useful to transfer a BPMN process into the MS.
5+
With the Export you are able to backup the process, create pictures or generate PDFs out of it.
6+
7+
## Download of Processes
8+
9+
Exporting BPMN processes can be done in many formats: PDF, PNG, SVG and BPMN.
10+
Some additional options can be configured:
11+
12+
- For PDF, you can export an image of the BPMN process along with or without the title.
13+
- For PNG, you can export the image with a default resolution or you change the resolution.
14+
- For BPMN, you can export only the BPMN file or you can select to also export the associated HTML files for user tasks and the referenced processes from a call activity (this creates a zip file).
15+
- For SVG, there are no additional options.
16+
17+
You can export either one process or multiple processes at once.
18+
19+
### Single Download
20+
21+
Single export can be initiated by clicking the export button for one process inside the datatable view, the card view, or inside the BPMN editor.
22+
A popup will appear and the desired output format can be selected.
23+
After clicking on the blue _Export_ button at the bottom, a popup will appear to store the file at the desired location.
24+
25+
![Export-Single](/images/user-guide/process-import-export/ExportProcess_Single.png?width=1000px&classes=border)
26+
27+
### Multiple Downloads
28+
29+
Multiple exports can be initiated by selecting multiple processes in the datatable view (via the check-boxes) or by selecting all processes in card view (with the _Select All_ button).
30+
At the top, the _Select Action_ button will be enabled.
31+
By clicking on it, you can export all selected processes.
32+
A ZIP file will be created containing all processes.
33+
34+
![Export-Multiple](/images/user-guide/process-import-export/ExportProcess_multiple.png?width=1000px&classes=border)

public/images/user-guide/process-creation/AddProcessModal.png

Lines changed: 0 additions & 3 deletions
This file was deleted.

public/images/user-guide/process-creation/Process-Card-View.png

Lines changed: 0 additions & 3 deletions
This file was deleted.

public/images/user-guide/process-creation/Process-DataTable-View.png

Lines changed: 0 additions & 3 deletions
This file was deleted.
Lines changed: 3 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)