icingaweb2-module-businessprocess/doc/02-Getting-Started.md

<a id="Getting-Started"></a>Getting Started
===========================================

Once you enable the *Business Process* module, it will pop up in your menu.
When you click on it, it will show you a new Dashboard:

![Empty Dashboard](screenshot/02_getting-started/201_empty-dashboard.png)

A new Business Process configuration
-------------------------------------------

From here we choose to create a new *Business Process configuration*:

![New Business Process](screenshot/02_getting-started/202_create-new-configuration.png)

Let's have a look at the single fields:

### Configuration name

![Configuration name](screenshot/02_getting-started/203_create-new_name.png)

The Business Process definition will be stored with this name. This is going to
be used when referencing this process in URLs and in Check Commands. You might
optionally want to provide an additional title. In that case the title is shown
in the GUI, while the name is still used as a reference. The title will default
to the name.

### Description

![Description](screenshot/02_getting-started/204_create-new_description.png)

Provide a short description explaining within 100-150 character what this
configuration provides. This will be shown on the Dashboard.

### Backend

![Backend](screenshot/02_getting-started/205_create-new_backend.png)

**Hint:** *Usually this should not be changed*

Icinga Web 2 currently uses only one Monitoring Backend, but in theory you
could configure multiple ones. They won't be usable in a meaningful way at the
time of this writing. Still, you might want to use a different backend as a data
provider for your Business Process.

### State Type

![State Type](screenshot/02_getting-started/206_create-new_state-type.png)

You can decide whether `SOFT` or `HARD` states should be the used as a base when
calculating the state of a Business Process definition.

### Add to menu

Business Process configurations can be linked to the Icinga Web 2 menu. Only the
first five configurations a user is allowed to see will be shown there:

![Add to menu](screenshot/02_getting-started/207_create-new_add-to-menu.png)

That's all for now, click `Add` to store your new (still empty) Business Process
configuration.

Empty configuration
===================

You are redirected to your newly created Business Process configuration:

![Empty configuration](screenshot/02_getting-started/208_new-empty-configuration.png)

From here we can now add as many deeply nested Business Processes as we want.
But let's first have a look at our Dashboard once again:

![New on Dashboard](screenshot/02_getting-started/209_new-on-dashboard.png)

Now let's move on and create some Nodes.