summaryrefslogtreecommitdiffstats
path: root/doc/04-Create-your-first-process-node.md
blob: f5b8b84872324dd50ad7b84e2d060d30eaea8e87 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
<a id="Create-your-first-process-node"></a>Create your first Business Process Node
==================================================================================

A *Business Process Node* consists of a *name*, *title*, an *operator* and one or
more child nodes. It can be a Root Node, child node of other Business Process
Nodes - or both.

![Empty Config](screenshot/04_first-root-node/0301_empty-config.png)

Configuring our first node
--------------------------

To create our first *Business Process Node* we click the *Add* button. This
leads to the related configuration form:

![Add new Node](screenshot/04_first-root-node/0302_add-new-node.png)

First setting is the *Node name*, an identifier that must be unique throughout
all Nodes that are going to be defined. This identifier will be used in every
link and also in *Check Commands* referring this node from an Icinga *Service
Check*.

### Set a title

As uniqueness sometimes leads to not-so-beautiful names, you are additionally
allowed to specify a title. This is what the frontend is going to show:

![Node Title](screenshot/04_first-root-node/0303_node-title.png)

### Choose an operator

Every Business Process requires an *Operator*. This operator defines it's
behaviour, this specifies how it's very own state is going to be calculated:

![Operator](screenshot/04_first-root-node/0304_operator.png)

### Specify where to display

The form suggests to create a *Toplevel Process*. It does so as we are about
to create a new *root node*. We could alternatively also create a sub process.
As we are currently not adding it to another Node, this would lead to an *Unbound
Node* that could be linked later on.

![Node Display](screenshot/04_first-root-node/0305_display.png)

### Provide an optional Info URL

One might also want to provide a link to additional information related to a
specific process. This could be instructions with more technical details or
hints telling what should happen if outage occurs. You might not want to do so
for every single Node, but it might come in handy for your most important (top
level?) nodes:

![Node Info Url](screenshot/04_first-root-node/0306_info-url.png)

That's it, your are ready to submit the form.

### First Business Process Node ready

You are now shown your first Business Process Node. A red bar reminds you that
your pending changes have not been stored yet:

![First Node created](screenshot/04_first-root-node/0307_first-node-created.png)

You could now *Store the Configuration* or move on with adding additional nodes
to complete your configuration.

**Hint**: the blue arrow makes part of a breadcrumb showing your current position.
 You might want to learn more about [breadcrumbs](12-Web-Components-Breadcrumb.md).