Commit changes to Sys Admin guide.

pull/7998/head
birthe 5 years ago
parent 1fa1805cb8
commit 79d6461181
  1. 45
      help/system-admin-guide/backlogs/README.md
  2. BIN
      help/system-admin-guide/backlogs/Sys-admin-backlogs-1579854523349.png
  3. BIN
      help/system-admin-guide/backlogs/Sys-admin-backlogs-export-story-card-config.png
  4. BIN
      help/system-admin-guide/backlogs/Sys-admin-backlogs.png
  5. BIN
      help/system-admin-guide/backlogs/image-20200124093824243.png
  6. BIN
      help/system-admin-guide/backlogs/image-20200124094308506.png
  7. 43
      help/system-admin-guide/budgets/README.md
  8. BIN
      help/system-admin-guide/budgets/Sys-admin-budgets-cost-types-list-1579853898118.png
  9. BIN
      help/system-admin-guide/budgets/Sys-admin-budgets-cost-types-list.png
  10. BIN
      help/system-admin-guide/budgets/Sys-admin-budgets-cost-types.png
  11. BIN
      help/system-admin-guide/budgets/Sys-admin-budgets-create-cost-types.png
  12. 47
      help/system-admin-guide/information/README.md
  13. BIN
      help/system-admin-guide/information/Sys-admin-information.png
  14. BIN
      help/system-admin-guide/information/image-20200124104116665.png
  15. BIN
      help/system-admin-guide/information/image-20200124104411677.png
  16. BIN
      help/system-admin-guide/information/image-20200124104803476.png
  17. 17
      help/system-admin-guide/plugins/README.md
  18. BIN
      help/system-admin-guide/plugins/image-20200124100220714.png
  19. 36
      help/system-admin-guide/webhooks/README.md
  20. BIN
      help/system-admin-guide/webhooks/Sys-admin-webhooks-configuration.png
  21. BIN
      help/system-admin-guide/webhooks/Sys-admin-webhooks.png

@ -6,21 +6,38 @@ description: Configure backlogs in OpenProject.
robots: index, follow
keywords: configure backlogs
---
# Backlogs
# Backlogs configuration
Coming soon!
Configure your backlogs settings in OpenProject.
## Overview
Navigate to -> *Administration* -> *Backlogs* -> *Settings* to set up your backlogs.
| Popular Topics | Description |
| -------------- | :---------- |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
You can configure the following in the backlogs settings.
1. Set the work package types which should be used as **story types**. Press Ctrl. to choose several types. The story types will appear in the Backlogs view (product backlog, wish list, sprint) and can be created, prioritized directly in the Backlogs view, e.g. EPIC, FEATURE, BUG.
2. Set the **task type**. The task type will appear in the task board to manage in your daily stand ups.
3. Define to **show burn-down or burn-up** chart.
4. Set a template for **sprint wiki page**. If you create a wiki page with this name, e.g. sprintwiki, you will set up a new wiki page based on this template if you open it via the sprint drop-down menu in the backlogs view. This way, you can easily create templates for sprint review meetings or retrospectives.
5. Press the blue **apply** button to save your changes.
![Sys-admin-backlogs](Sys-admin-backlogs-1579854523349.png)
## Configure story cards to export
Some Scrum teams also want to export their story cards to put them on a physical board. You can export your story cards and set a certain format for this export.
Navigate to -> *Administration* -> *Backlogs* -> *Export Card Configs* in order to set a new story card configuration.
Press the green **+ Export Card Config** button to create a new story card export configuration.
![story card export configuration](image-20200124093824243.png)
1. Give a **name** for your story card export configuration.
2. You can add a **description**.
3. Define how many work packages (as defined as story types in the above settings, e.g. user stories) should be **printed per page**.
4. Set the **page size**.
5. Choose **landscape** or **portrait** for printing option.
6. **Set rows configuration**. See the help icon with the question mark for further information regarding the row formatting.
7. Press the blue **Create** button to save your changes.
![Sys-admin-backlogs-export-story-card-config](Sys-admin-backlogs-export-story-card-config.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 96 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 154 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

@ -8,16 +8,53 @@ keywords: budgets
---
# Budgets
You can configure costs in OpenProject and can create cost types.
You can configure costs in OpenProject and create cost types to track unit costs.
Navigate to -> *Administration* -> *Budgets*.
## Settings
Define settings for OpenProject costs.
Navigate to -> *Administration* -> *Budgets* -> *Settings* to define settings for OpenProject costs.
1. Configure the **currency used in the system, e.g. EUR**.
2. **Specify the format of the currency**, if the number should be before or after the currency, e.g. 10 EUR, or $ 10.
3. Press the blue **Apply** button to save your changes.
![Sys-admin-configure-costs](Sys-admin-configure-costs.png)
![Sys-admin-configure-costs](Sys-admin-configure-costs.png)
## Create and manage cost types
You can create and manage **cost types** to [book unit costs to work packages in OpenProject](../../user-guide/time-and-costs/cost-tracking/).
Navigate to -> *Administration* -> *Budgets* -> *Cost types* to create and manage unit costs types.
Click the green **+ Cost type** button to create a new cost type.
![Sys-admin-budgets-create-cost-types](Sys-admin-budgets-create-cost-types.png)
You can set the following options:
1. Give the cost type a **name**.
2. Define the **unit name** for this cost type, e.g. Euro, piece, day, etc.
3. Set the **pluralized unit name**, e.g. Euros, pieces, days, etc.
4. Choose if the cost type should be the **default cost type** when booking new unit costs.
5. Define the Rate history and **set a date** from which this cost type should be valid and **set a rate** (in the specified unit) for this date.
6. With the + icon you can add **additional rates for other dates**.
7. The delete icon will **remove a rate** for a certain date.
8. Do not forget to **save** your changes.
![Sys-admin-budgets-cost-types](Sys-admin-budgets-cost-types.png)
In the overview list of all rates you can define the following.
1. **Filter for cost types at a certain fixed date** in the list, 2. choose whether also locked cost types should be displayed and 3. press the blue apply button: This way you will get the cost types with the rate (at the chosen fixed date) displayed in the list below.
4. Click on the name of a cost type to **edit an existing cost type**.
5. **Set a current rate** (for the current valid from period) and press the save icon to apply it.
6. **Lock** a cost type.
![Sys-admin-budgets-cost-types-list](Sys-admin-budgets-cost-types-list-1579853898118.png)
<div class="alert alert-info" role="alert">
**Note**: With cost types you can also book any kind of units to work packages, e.g. vacation days, leaves, travel days, etc.. Just choose 1 as a unit. This way, you could e.g. track vacation days against a vacation budget and evaluate the days in the [cost reporting](../../user-guide/time-and-costs/reporting/).
</div>

Binary file not shown.

After

Width:  |  Height:  |  Size: 108 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 109 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 113 KiB

@ -8,19 +8,36 @@ keywords: system information
---
# System information
Coming soon!
## Overview
| Popular Topics | Description |
| -------------- | :---------- |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
You get an overview about current system status and more information. Navigate to -> *Administration* -> *Information*.
1. Displays the **product version** (OpenProject configuration).
2. Displays the core version of your OpenProject installation.
![Sys-admin-information](Sys-admin-information.png)
## Security badge
The **Security badge** shows the current status of your OpenProject installation. It will inform administrators of an OpenProject installation on whether new releases or security updates are available for your platform.
If enabled, this option will display a badge with your installation status at Administration > Information right next to the release version, and on the home screen. It is only displayed to administrators.
The badge will match your current OpenProject version against the official OpenProject release database to alert you of any updates or known vulnerabilities. To ensure the newest available update can be returned, the check will include your installation type, current version, database type, enterprise status and an anonymous unique ID of the instance. To localize the badge, the user's locale is sent. No personal information of your installation or any user within is transmitted, processed, or stored.
To disable rendering the badge, uncheck the setting at *Administration* > *System settings* > *General* or pass the configuration flag `security_badge_displayed: false` .
## Additional system information
There are a few automatic checks from the system to ensure the safety and correct set up of your configuration if you navigate to -> *Administration* -> *Information*.
If one point is not fulfilled, e.g. changing the default administrator account, you will get a warning message in the form of a bug icon.
![system information](image-20200124104411677.png)
## Storage information
You will get information about the storage filesystem in your OpenProject application if you navigate to -> *Administration* -> *Information*.
You will see the remaining disk space as well as used disk space in your OpenProject installation.
![storage filestystem information](image-20200124104803476.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 98 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

@ -8,19 +8,10 @@ keywords: plugins
---
# Plugins
Coming soon!
The OpenProject configurations contains a certain amount of plugins which are listed under -> *Administration* -> *Plugins*.
## Overview
We recommend to use the plugins as suggested in our deployement packages. You will get more detailed information (about current changes, author, etc.) if you follow the links.
| Popular Topics | Description |
| -------------- | :---------- |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
![OpenProject plugins](image-20200124100220714.png)
If you want to write your own plugin, please follow our [development guide](../../development/create-openproject-plugin).

Binary file not shown.

After

Width:  |  Height:  |  Size: 288 KiB

@ -8,19 +8,25 @@ keywords: webhooks
---
# Webhooks
Coming soon!
## Overview
| Popular Topics | Description |
| -------------- | :---------- |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
You can set up webhooks for OpenProject in order to integrate OpenProject with other applications. A scenario is for example to signal the creation of a time log in OpenProject to a billing application.
Navigate to -> *Administration* -> *Webhooks* to set up your webhooks in OpenProject.
Press the green **+ Webhook** button to add a new webhook to OpenProject.
![Sys-admin-webhooks](Sys-admin-webhooks.png)
You can configure the following options for webhooks:
1. Choose a **name** identifying the webhook.
2. **Payload URL** defines the endpoint, called when the webhook is triggered.
3. Freely choose an additonal **description** to further identify the intent of the respective webhook.
4. By defining a **Siganture secret** you guarantee that the sender of the payload request is actually OpenProject. The client will then check this signature secret.
5. Enable if the webhook should be active.
6. Set the events for which the webhook should be activate, i.e. webhook for updating or creating work packages, or for creating time entries.
7. **Select for which projects the webhook should be active**. You can choose all projects or only specific projects. For example if you select the project "System admin guide", an event (ie. create a new time entry) will be fired via the webhook. This will only happen if a user logs time within the selected projects.
8. Press the blue **Create** button to save your changes.
![Sys-admin-webhooks-configuration](Sys-admin-webhooks-configuration.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 209 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 139 KiB

Loading…
Cancel
Save