Before Width: | Height: | Size: 81 KiB After Width: | Height: | Size: 81 KiB |
Before Width: | Height: | Size: 112 KiB After Width: | Height: | Size: 112 KiB |
Before Width: | Height: | Size: 184 KiB After Width: | Height: | Size: 184 KiB |
Before Width: | Height: | Size: 123 KiB After Width: | Height: | Size: 123 KiB |
Before Width: | Height: | Size: 140 KiB After Width: | Height: | Size: 140 KiB |
Before Width: | Height: | Size: 282 KiB After Width: | Height: | Size: 282 KiB |
Before Width: | Height: | Size: 62 KiB After Width: | Height: | Size: 62 KiB |
Before Width: | Height: | Size: 33 KiB After Width: | Height: | Size: 33 KiB |
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 51 KiB |
@ -0,0 +1,26 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: Announcement |
||||
priority: 760 |
||||
description: Announcements in OpenProject. |
||||
robots: index, follow |
||||
keywords: announcement |
||||
--- |
||||
# Announcement |
||||
|
||||
Coming soon! |
||||
|
||||
## Overview |
||||
|
||||
| Popular Topics | Description | |
||||
| -------------- | :---------- | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
|
@ -0,0 +1,26 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: Backlogs |
||||
priority: 670 |
||||
description: Configure backlogs in OpenProject. |
||||
robots: index, follow |
||||
keywords: configure backlogs |
||||
--- |
||||
# Backlogs |
||||
|
||||
Coming soon! |
||||
|
||||
## Overview |
||||
|
||||
| Popular Topics | Description | |
||||
| -------------- | :---------- | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
|
@ -0,0 +1,26 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: Budget |
||||
priority: 680 |
||||
description: Define budgets in OpenProject. |
||||
robots: index, follow |
||||
keywords: budgets |
||||
--- |
||||
# Budgets |
||||
|
||||
Coming soon! |
||||
|
||||
## Overview |
||||
|
||||
| Popular Topics | Description | |
||||
| -------------- | :---------- | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
|
@ -0,0 +1,26 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: Colors |
||||
priority: 690 |
||||
description: Set colors in OpenProject. |
||||
robots: index, follow |
||||
keywords: colors |
||||
--- |
||||
# Colors |
||||
|
||||
Coming soon! |
||||
|
||||
## Overview |
||||
|
||||
| Popular Topics | Description | |
||||
| -------------- | :---------- | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
|
@ -0,0 +1,24 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: Custom fields |
||||
priority: 800 |
||||
description: Manage custom fields in OpenProject. |
||||
robots: index, follow |
||||
keywords: manage custom fields |
||||
--- |
||||
# Manage custom fields |
||||
|
||||
Coming soon! |
||||
|
||||
## Overview |
||||
|
||||
| Popular Topics | Description | |
||||
| --------------------------- | :---------- | |
||||
| Work packages custom fields | | |
||||
| Spent time custom fields | | |
||||
| Projects custom fields | | |
||||
| Versions custom fields | | |
||||
| Users custom fields | | |
||||
| Groups custom fields | | |
||||
| Document categories | | |
||||
|
@ -0,0 +1,42 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: Custom fields for projects |
||||
priority: 700 |
||||
description: Custom fields for projects. |
||||
robots: index, follow |
||||
keywords: custom fields for projects |
||||
--- |
||||
# Display custom fields in the project list |
||||
|
||||
As a user of the OpenProject Enterprise Edition you can customize the work package list and show additional project information by adding custom fields to the project list. |
||||
With this option you can for example display a project’s status, responsible or progress. |
||||
|
||||
In order to display custom fields in the project list, first make sure that you have an [activated Enterprise Edition](https://www.openproject.org/activate-the-enterprise-edition/) or use the Cloud Edition. |
||||
|
||||
## Creating a project custom field |
||||
|
||||
Next, as an OpenProject admin navigate to the administration to create a new custom field. To do this, click on your user name in the upper right corner (1), select *Administration* from the dropdown menu (2) and select *Custom fields* from the side menu (3). |
||||
Select the tab *Projects* (4) and click on the link *Create a new custom field* (5) to create a project custom field. |
||||
|
||||
![Create project custom fields](https://1t1rycb9er64f1pgy2iuseow-wpengine.netdna-ssl.com/wp-content/uploads/2018/05/Create-project-custom-fields-1-1024x372.png) |
||||
|
||||
In the newly opened create form provide a name to display in the project list (e.g. Project status) (6), a format (e.g. List) (7) and enter the values which can be selected (8). |
||||
Optionally, define if the custom field should be required and searchable (9). |
||||
Click *Save* to create the custom field. |
||||
|
||||
![Custom fields create form](https://1t1rycb9er64f1pgy2iuseow-wpengine.netdna-ssl.com/wp-content/uploads/2018/05/Custom-fields-1024x610.png) |
||||
|
||||
## Setting and displaying a project custom field |
||||
|
||||
Once you created the custom field you can set it in a project’s settings. |
||||
To do this navigate to a project and select *Project settings* from the side menu (1). The project custom field is visible in the pre-selected *Information* tab. As a project manager you can set the project custom field to communicate the status (2). |
||||
|
||||
![Set project custom field](https://1t1rycb9er64f1pgy2iuseow-wpengine.netdna-ssl.com/wp-content/uploads/2018/05/Set-project-custom-field.png) |
||||
|
||||
Next, navigate to the project list by selecting *View all projects* from the project selection menu in the top left side. |
||||
|
||||
You will see the project custom field displayed as a column in the project list. Therefore, you can easily communicate project information across multiple projects. |
||||
|
||||
![View all projects with custom field](https://1t1rycb9er64f1pgy2iuseow-wpengine.netdna-ssl.com/wp-content/uploads/2018/05/View-all-projects-with-custom-field.png) |
||||
|
||||
|
@ -0,0 +1,87 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: Design |
||||
priority: 700 |
||||
description: Custom color, theme and logo. |
||||
robots: index, follow |
||||
keywords: custom color, theme and logo |
||||
--- |
||||
# Set custom color theme and logo (Premium feature) |
||||
|
||||
As an OpenProject premium feature you can replace the default OpenProject logo with your own logo. In addition, you can define your own color theme which allows you to implement your corporate identity in OpenProject. |
||||
|
||||
(1) Click on your user avatar in the upper right corner. |
||||
|
||||
(2) Select *Administration* from the dropdown menu. |
||||
|
||||
(3) Choose **Design** from the menu. |
||||
|
||||
The design page provides several options to customize your OpenProject Enterprise Edition: |
||||
|
||||
(4) Upload your own **custom logo** to replace the default OpenProject logo. |
||||
|
||||
(5) Set a custom **favicon** which is shown as an icon in your browser window/tab. |
||||
|
||||
(6) Upload a custom **touch icon** which is shown on your smartphone or tablet when you bookmark OpenProject on your home screen. |
||||
|
||||
(7) Set **custom colors** to adjust nearly any aspect of OpenProject, such as the color of the header and side menu, the link color and the hover color. |
||||
|
||||
![Sys-admin-design](Sys-admin-design.png) |
||||
|
||||
## Upload a custom logo |
||||
|
||||
To replace the default OpenProject logo with your own logo, make sure that your logo has the dimensions 460 by 60 pixels. Select the *Choose File* button and select the file from your hard drive to upload it (1). |
||||
|
||||
Click the *Upload* button to confirm and upload your logo (2). |
||||
|
||||
![Sys-admin-design-upload-logo](Sys-admin-design-upload-logo.png) |
||||
|
||||
![upload logo](image-20200121143402479.png) |
||||
|
||||
## Set a custom favicon |
||||
|
||||
To set a custom favicon to be shown in your browser’s tab, make sure you have a PNG file with the dimensions 32 by 32 pixels. Select the *Choose File* button and select the file from your hard drive to upload it (1). |
||||
|
||||
Click the *Upload* button to confirm and upload your favicon (2). |
||||
|
||||
![Sys-admin-design-favicon](Sys-admin-design-favicon-1579613889024.png) |
||||
|
||||
## Set a custom touch icon |
||||
|
||||
To set a custom touch icon that appears on your smartphone’s or tablet’s homescreen when you bookmark a page, make sure you have a PNG file with the dimensions 180 by 180 pixels. Select the *Choose File* button and select the file from your hard drive to upload it. |
||||
|
||||
Click the *Upload* button to confirm and upload your custom touch icon. |
||||
|
||||
When you bookmark your OpenProject environment’s URL, you will see that the uploaded icon is used as a custom touch icon. |
||||
|
||||
## Specify custom colors |
||||
|
||||
Aside from uploading logos and icons, you can also customize the colors used within your OpenProject environment. |
||||
|
||||
To do this change the color values (entered as color hex code) in the *Custom Colors* section. In order to find the right hex code for a color, you can use a website, such as [color-hex.com](http://www.color-hex.com/). |
||||
You can see the selected color in the preview area next to the color hex code. Therefore, it is possible to see the selected color before saving the changes. |
||||
|
||||
![Sys-admin-design-custom-colors](Sys-admin-design-custom-colors.png) |
||||
|
||||
You can set the following custom colors: |
||||
|
||||
1. **Primary color**: The primary color changes the color of many parts of the application, including the color of the header and the edit buttons. Along with the alternative color, the primary color defines the majority of your OpenProject’s color theme. |
||||
2. **Primary color dark**: This color is used for hover effects. When you hover over links in the header navigation or select edit buttons (whose color is set by the primary color), the primary color dark is applied. |
||||
3. **Alternative color**: The most important buttons (e.g. the work package or wiki create button) use the color defined here. |
||||
4. **Header background color**: By default, the header background color is set through the primary color. However, you can set a separate header background color which leaves the button colors defined by the primary color unaffected. |
||||
5. **Header item font color**: You can separately control the font color of the links shown in the header navigation. If you define e.g. a white header background color you should choose a darker header item font color in order to still see the links shown in the header navigation. |
||||
6. **Header item font hover color**: With this setting you can change the item font color shown when hovering with the mouse over entries in the header navigation. |
||||
7. **Header item background hover colo**r: This color setting controls the background color for the entries in the header navigation when hovering over them with your mouse. |
||||
8. **Header border bottom color**: You can show a line right below the header navigation. This makes sense e.g. if you are using a white header but want a clear separation to the rest of the application. Set the color you want to use for the line below the header. Leave this setting empty if you don’t want to display a line below the header. |
||||
9. **Content link color**: Adjust this setting in order to change the link color (e.g. for the selected menu in the side navigation of a project or the administration or the breadcrumb color). |
||||
10. **Main menu background color**: This setting allows you to change the background color of the side menu displayed on the left side. |
||||
11. **Main menu font color**: This defines the font color in the main navigation menu. |
||||
12. **Main menu background selected background**: This color is set as background when a menu item is selected. |
||||
13. **Main menu selected font color**: The color of the font of a selected menu item. |
||||
14. **Main menu background hover background**: This is the color of the background when hovering in the menu items. |
||||
15. **Main menu hover font color**: This is the font color when hovering in the menu items. |
||||
16. **Main menu border color**: Is is the border color of the main menu. |
||||
|
||||
As soon as you press the **Save** button your changes are applied and the colors of your OpenProject environment are adjusted accordingly. |
||||
|
||||
|
After Width: | Height: | Size: 160 KiB |
After Width: | Height: | Size: 213 KiB |
After Width: | Height: | Size: 212 KiB |
After Width: | Height: | Size: 83 KiB |
After Width: | Height: | Size: 344 KiB |
After Width: | Height: | Size: 69 KiB |
@ -0,0 +1,24 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: Enumerations |
||||
priority: 790 |
||||
description: Manage enumerations in OpenProject. |
||||
robots: index, follow |
||||
keywords: enumerations |
||||
--- |
||||
# Enumerations |
||||
|
||||
Coming soon! |
||||
|
||||
## Overview |
||||
|
||||
| Popular Topics | Description | |
||||
| -------------- | :---------- | |
||||
| Activities | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
|
@ -0,0 +1,26 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: Information |
||||
priority: 500 |
||||
description: System information in OpenProject. |
||||
robots: index, follow |
||||
keywords: system information |
||||
--- |
||||
# System information |
||||
|
||||
Coming soon! |
||||
|
||||
## Overview |
||||
|
||||
| Popular Topics | Description | |
||||
| -------------- | :---------- | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
|
@ -0,0 +1,47 @@ |
||||
--- |
||||
|
||||
sidebar_navigation: |
||||
title: Custom actions |
||||
priority: 960 |
||||
description: Intelligent workflows with custom actions. |
||||
robots: index, follow |
||||
keywords: custom actions |
||||
--- |
||||
|
||||
# Intelligent workflows with custom actions (Premium feature) |
||||
|
||||
Intelligent workflows with custom actions support you to easily update several work package attributes at once with a single click on one button. |
||||
|
||||
You can use custom actions to standardize your workflows, avoid errors and reduce manual work for updates. |
||||
|
||||
The intelligent workflows with custom actions are a premium feature and only available for [Enterprise Edition](https://www.openproject.org/enterprise-edition/) and [Cloud Edition](https://www.openproject.org/hosting/) customers. |
||||
|
||||
## Create custom actions |
||||
|
||||
Navigate to the -> *Administration* -> *Work packages* -> *Custom actions*. |
||||
|
||||
To create a new custom action button press the green **+ Custom action button**. |
||||
|
||||
![Create custom action](image-20200121161925611.png) |
||||
|
||||
You can now configure the **Conditions** and **Actions** for the custom action button. |
||||
|
||||
1. Enter a **name** for the custom action button. This name will then appear on the button on the work package. |
||||
2. Set a **description** (i.e. what are the conditions and actions). |
||||
3. Set the **conditions** for which the custom action button should apply, e.g. in which status, for which role, what type or in which project should the custom action button appear. |
||||
4. Set the **actions** what should happen after pressing the custom action button, e.g. status transitions, and changes to any other attribute. |
||||
5. **Save** your changes. |
||||
|
||||
![Sys-admin-custom-actions](Sys-admin-custom-actions.png) |
||||
|
||||
If a work package is then in the defined condition, the button will appear on top of a work package and will apply the actions and changing the attributes of a work package as defined in the configuration when clicking on the button. |
||||
|
||||
![Sys-admin-custom-action-button](Sys-admin-custom-action-button.png) |
||||
|
||||
## Update, sort or delete custom actions |
||||
|
||||
1. Click on the name of a custom action in order to update the attributes. |
||||
2. Click the up or down arrow in order to sort the order of the custom action button on the work packages. |
||||
3. Delete a custom action. |
||||
|
||||
![Sys-admin-update-custom-actions](Sys-admin-update-custom-actions.png) |
After Width: | Height: | Size: 190 KiB |
After Width: | Height: | Size: 136 KiB |
After Width: | Height: | Size: 52 KiB |
After Width: | Height: | Size: 76 KiB |
@ -0,0 +1,44 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: Status |
||||
priority: 970 |
||||
description: Manage work package status. |
||||
robots: index, follow |
||||
keywords: work package status |
||||
--- |
||||
|
||||
# Manage work package status |
||||
|
||||
Work packages can have various status depending on their types, e.g. tasks can have the status new, in progress, done, on hold, rejected, closed. Or any other status which you would need. |
||||
|
||||
The status can be configured under *Administration ->* *Work packages* -> *Status*. You will see the list of all the existing work package status in the system. You can add new status or change the name and order of existing status. |
||||
|
||||
## Create a new work package status |
||||
|
||||
To create a new work package status click the green ***+ New Status*** icon. |
||||
|
||||
![Sys-admin-work-packages-new-status](Sys-admin-work-packages-new-status.png) |
||||
|
||||
A new window will open, where you will be able to specify the following: |
||||
|
||||
1. Name the new work package status. |
||||
2. Define if the new work package status closes a work package (e.g. relevant when filtering for closed for packages), e.g. a work package status "rejected" will set a work package technically on closed and it will not appear in the default work package list with Open Work packages. |
||||
3. Define if this status is set as default value when creating new work packages. |
||||
4. Check if this status sets a **work package in read-only mode**. This means no work package attributes can be changed except the status. |
||||
5. Set a **color** for the work package status. The color appears in the status button of the work packages or in the work package table. |
||||
6. Save the new status by clicking **Create**. |
||||
|
||||
![Sys-admin-work-package-new-status](Sys-admin-work-package-new-status.png) |
||||
|
||||
## Edit, re-order or remove a work package status |
||||
|
||||
1. To **edit** an existing work package type click on the work package name. |
||||
2. To **sort** the status, e.g. in the status drop-down list of the work packages, click on the arrows to move the status up or down in the list. |
||||
3. To **delete** the work package type click on the delete icon. |
||||
|
||||
![Sys-admin-edit-work-package-status](Sys-admin-edit-work-package-status.png) |
||||
|
||||
<div class="alert alert-info" role="alert"> |
||||
**Note**: A new status needs to be activated in the [work package workflows](./work-package-workflows) in order to appear in the status drop down of a work package. |
||||
</div> |
||||
|
After Width: | Height: | Size: 83 KiB |
After Width: | Height: | Size: 292 KiB |
After Width: | Height: | Size: 166 KiB |
@ -0,0 +1,57 @@ |
||||
--- |
||||
|
||||
sidebar_navigation: |
||||
title: Workflows |
||||
priority: 970 |
||||
description: Manage work package workflows. |
||||
robots: index, follow |
||||
keywords: work package workflows |
||||
--- |
||||
|
||||
# Manage work package workflows |
||||
|
||||
A **workflow** in OpenProject is defined as the allowed transitions between status for a role and a type, i.e. which status changes can a certain role implement depending on the work package type. |
||||
|
||||
This means, a certain type of work package, e.g. a Task, can have the following workflows: News -> In Progress -> Closed -> On Hold -> Rejected -> Closed. This workflow can be different depending on the [role in a project](././users-permissions/roles-permissions). |
||||
|
||||
## Edit workflows |
||||
|
||||
To edit a workflow: |
||||
|
||||
1. Select the **role** from the dropdown menu for which you want to edit the workflow. |
||||
2. Select the **work package type** from the dropdown menu for which you want to edit the workflow. |
||||
3. Check if you **only want the statuses that are used by this type** to be displayed (this option is selected automatically, but you can always uncheck it). |
||||
<div> |
||||
**Note**: If you have created a [new status](./work-package-status) and want to add it to a workflow of a certain work package type, you need to deselect this option. Only this way also status that are not (yet) used by this type will appear in the list and can be added to a workflow. |
||||
</div> |
||||
|
||||
4. Click the **Edit** button. |
||||
|
||||
![Sys-admin-edit-workflow](Sys-admin-edit-workflow-1579617694505.png) |
||||
|
||||
You will be able to adapt the following: |
||||
|
||||
1. Adapt which **status changes** are allowed by the selected role for the selected work package type. Read the transitions from the Rows (Current status) to the columns (New status allowed), e.g. a status transition from NEW to IN PROGRESS and back would be allowed. Make sure to allow the "way back" in most cases, e.g. back from IN PROGRESS to NEW, to make sure you will be able to correct mistakes. |
||||
2. In addition, you can specify if this role is allowed to make specific status changes if the user who has been assigned this role also is the **author of the work package**. |
||||
3. Also you can set additional status transitions allowed if the user is the **assignee to a work package**. |
||||
4. Don’t forget to save your changes. |
||||
|
||||
![Sys-admin-edit-workflow-details](Sys-admin-edit-workflow-details.png) |
||||
|
||||
## Copy an existing workflow |
||||
|
||||
You can copy an existing workflow by clicking **Copy** in the workflow overview. |
||||
|
||||
![Sys-admin-copy-workflow](Sys-admin-copy-workflow.png) |
||||
|
||||
You will then be able to determine which existing workflow should be copied to which other workflow. |
||||
|
||||
## View the workflow summary |
||||
|
||||
You can get a summary of the allowed status transitions of a work package type for a role by clicking on **Summary** in the workflow overview. |
||||
|
||||
![Sys-admin-workflow-summary](Sys-admin-workflow-summary.png) |
||||
|
||||
You will then view a summary of all the workflows. The number of possible status transitions for each type and role are shown in a matrix. |
||||
|
||||
![workflow summary overview](image-20200121155553061.png) |
After Width: | Height: | Size: 51 KiB |
After Width: | Height: | Size: 90 KiB |
After Width: | Height: | Size: 177 KiB |
After Width: | Height: | Size: 90 KiB |
After Width: | Height: | Size: 51 KiB |
After Width: | Height: | Size: 73 KiB |
@ -0,0 +1,26 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: Plugins |
||||
priority: 660 |
||||
description: Configure plugins in OpenProject. |
||||
robots: index, follow |
||||
keywords: plugins |
||||
--- |
||||
# Plugins |
||||
|
||||
Coming soon! |
||||
|
||||
## Overview |
||||
|
||||
| Popular Topics | Description | |
||||
| -------------- | :---------- | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
|
@ -0,0 +1,24 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: System settings |
||||
priority: 780 |
||||
description: System settings in OpenProject. |
||||
robots: index, follow |
||||
keywords: system settings |
||||
--- |
||||
# System settings |
||||
|
||||
Coming soon! |
||||
|
||||
## Overview |
||||
|
||||
| Popular Topics | Description | |
||||
| -------------- | :---------- | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
|
@ -0,0 +1,26 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: Webhooks |
||||
priority: 600 |
||||
description: Configure webhooks in OpenProject. |
||||
robots: index, follow |
||||
keywords: webhooks |
||||
--- |
||||
# Webhooks |
||||
|
||||
Coming soon! |
||||
|
||||
## Overview |
||||
|
||||
| Popular Topics | Description | |
||||
| -------------- | :---------- | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
| | | |
||||
|