Skip to content

Commit 0825cdf

Browse files
authored
Update DOKU.md
1 parent 8136b07 commit 0825cdf

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

DOKU.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,45 @@
1-
## Documentation
1+
# Documentation
22

3+
## General
4+
5+
### Terms
6+
7+
- Element
8+
- A logical, independent unit of executable code
9+
- Visualized on the GUI
10+
- Can be connected with other elements
11+
- Configuration Data
12+
- Element parameters passed over the GUI by the user
13+
- Input Data
14+
- Data which is forwarded from other elements (left connection)
15+
- Output Data
16+
- Data which is forwarded to other elements (right connection)
17+
18+
### Logging
19+
20+
The execution of elements is logged in a file that changes daily.
21+
The log files are archived under `~/Pythonic/log (Linux)` or `%HOMEPATH%\Pythonic\log` (Windows).
22+
Pythonic's web service provides an overview of available log files at **http://<address-info>:7000/log**.
23+
24+
- INFO
25+
- Ordinary debug trace messages
26+
- Can be switched on or off by the user (checkbox in element configuration)
27+
- Implementation in own code is optional
28+
- WARNING
29+
- Signalize a failed execution
30+
- Can be switched on or off by the user (checkbox in element configuration)
31+
- A log entry of this type is created when the element returns data of type PythonicError
32+
- Implementation in own code is optional
33+
- Critical (Unhandled exception):
34+
- Is signalized in the GUI an (,,Exception occured, open log for details)
35+
- Log entry (type ERROR) is made
36+
- Is always active (implementation not optional)
37+
38+
### Exception handling
39+
40+
41+
42+
## Elements
343

444
### Basic Elements
545

0 commit comments

Comments
 (0)