You easily can start a new BIM trial on our [OpenProject BIM website](https://www.openproject.org/bim-project-management/). The have a look at the full description of how to start a new trial installation just follow the Link: [Create trial installation](../enterprise-guide/enterprise-cloud-guide/create-cloud-trial/).
## How to enable the BCF module?
## How to enable the BCF module
The BCF Module and the included IFC viewer can be enabled for every single project. Here you can find the description how to [enable a module](../user-guide/projects/project-settings/modules/) within your ***project settings***.
@ -123,7 +123,7 @@ Yes, we want to develop some other integrations to stay interoparable with other
### How to enable the BCF module?
### How to enable the BCF module
The BCF Module and the included IFC viewer can be enabled or disabled for every single project. Here you can find the description how to [enable a module](../user-guide/projects/project-settings/modules/) within the project settings.
@ -71,7 +71,7 @@ If there already exist a model in project, you don't have to open the "model man
## How to rotate the building model?
## How to rotate the building model
To rotate the IFC model you either left-click on the building viewer and ***rotate the building model by panning*** your cursor **or** use the ***View Cube*** in the right bottom corner for navigation.
@ -135,7 +135,7 @@ The first person perspective changes the way you ineract with the building model
## How to slice the building model?
## How to slice the building model
![Slice Building Model](slice-building-model.png)
@ -145,7 +145,7 @@ To have a deeper look within the building model you are able to slice the whole
## How to clear slices?
## How to clear slices
You are able to clear all slices by using the ***dropdown*** menu next to the "***scissors symbol***" within the ***IFC-Viewer-Toolbar***.
@ -159,7 +159,7 @@ You are able to clear all slices by using the ***dropdown*** menu next to the "*
## How to select elements?
## How to select elements
To select elements within the building model, you have to activate the selection mode by clicking on the highlighted toggle button placed in the ***IFC-Viewer toolbar***. After activating the selection mode you are able to select a single or multiple elements within the viewer by left click. Your individual selection won't be reset after leaving the selection mode. You are able to reset your current selection with the context menu (right click).
@ -29,7 +29,7 @@ If you can answer all questions with "yes" you are ready to start using our Revi
## How to install?
## How to install
@ -84,15 +84,15 @@ After you have downloaded the file, please run it to start the installation proc
## How to update from an earlier version?
## How to update from an earlier version
If you already have an earlier version installed, simply follow the same steps as for a new installation ([How to install?](#how-to-install)). The existing **OpenProject Revit AddIn** will be updated.
If you already have an earlier version installed, simply follow the same steps as for a new installation ([How to install](#how-to-install)). The existing **OpenProject Revit AddIn** will be updated.
## How to login?
## How to login
After Installing the OpenProject BIM AddIn you can find a new tab within the Revit taskbar named "OpenProject". To login you have to open the **settings** first.
@ -180,7 +180,7 @@ OpenProject BIM and Revit automatically synchronize all BIM work packages. You d
## How to uninstall the OpenProject Revit add-in?
## How to uninstall the OpenProject Revit add-in
To remove the **OpenProject Revit AddIn** remove the AddIn like any other AddIn from Revit. First close any running instance of Revit. Then you'll have to enter the directory `C:\ProgramData\Autodesk\Revit\Addins\<REVIT_VERSION>`. There you must delete the file `OpenProject.Revit.addin` and the folder `OpenProject.Revit`. After a restart of Revit, the **OpenProject Revit AddIn** is no longer available.
1. Login to or register at the [OpenProject community platform](https://community.openproject.org/login). It's fast and free.
2. Use the search bar in the header navigation on top to look for similar feature requests. If there's one, please leave a comment or add additional information. Otherwise:
| [Enterprise on-premises trial](./enterprise-on-premises-guide/enterprise-on-premises-trial/) | Can I test the Enterprise on-premises edition for free? |
| [Enterprise on-premises trial](./enterprise-on-premises-guide/enterprise-on-premises-trial/) | Can I test the Enterprise on-premises edition for free? |
| [Activate Enterprise on-premises](./enterprise-on-premises-guide/activate-enterprise-on-premises) | How can I upgrade my Community edition to an Enterprise on-premises edition? |
| [Support](./enterprise-on-premises-guide/support) | How can I get support or installation support? |
| [Support](./enterprise-on-premises-guide/support) | How can I get support or installation support? |
| [Create free trial](./create-cloud-trial) | Learn more about how to create a free trial for the Enterprise cloud instance. |
| [Sign in](./sign-in/) | Sign in to your OpenProject Enterprise cloud edition. |
| [Create quote](./create-quote-cloud) | How to create a quote within your Enterprise cloud instance? |
| [Invoices and billing history](./invoices-and-billing-history) | How to see your payment history and download invoices? |
| [Upgrade, downgrade or cancel subscription](./manage-cloud-subscription/#upgrade-or-downgrade-subscription) | How to upgrade your plan, downgrade or cancel your subscription for the Enterprise cloud edition? |
| [Manage your subscription](./manage-cloud-subscription) | How to change billing address and add or edit credit card details? |
| [Subscribe](./book-cloud) | How to book Enterprise cloud? |
| [Backups](./backups) | How do backups work in the cloud? |
| [Support](./support) | How to get support as Enterprise cloud user? |
| [GDPR and DPA](./gdpr-compliance) | Review and sign a Data Processing Agreement (DPA). |
| [Create free trial](./create-cloud-trial) | Learn more about how to create a free trial for the Enterprise cloud instance. |
| [Sign in](./sign-in/) | Sign in to your OpenProject Enterprise cloud edition. |
| [Create quote](./create-quote-cloud) | How to create a quote within your Enterprise cloud instance. |
| [Invoices and billing history](./invoices-and-billing-history) | How to see your payment history and download invoices. |
| [Upgrade, downgrade or cancel subscription](./manage-cloud-subscription/#upgrade-or-downgrade-subscription) | How to upgrade your plan, downgrade or cancel your subscription for the Enterprise cloud edition. |
| [Manage your subscription](./manage-cloud-subscription) | How to change billing address and add or edit credit card details. |
| [Subscribe](./book-cloud) | How to book Enterprise cloud. |
| [Backups](./backups) | How do backups work in the cloud? |
| [Support](./support) | How to get support as Enterprise cloud user. |
| [GDPR and DPA](./gdpr-compliance) | Review and sign a Data Processing Agreement (DPA). |
The OpenProject Enterprise cloud edition contains all OpenProject Community features plus the additional OpenProject premium features, as well as professional support.
| [Learn more about OpenProject](#learn-more-about-openproject) | General questions about OpenProject, security, setup and much more |
| [How to ... in OpenProject?](#how-to--in-openproject) | Questions about how to achieve certain outcomes in OpenProject that do not fit elsewhere |
| [FAQ regarding features](#faq-regarding-features) | Information about frequent feature requests |
| [FAQ regarding OpenProject BIM edition](#faq-regarding-openproject-bim-edition) | Questions concerning the additional BCF module for OpenProject and the BIM edition |
| [Migration](#migration) | Questions regarding migrating to OpenProject from e.g. Bitnami or from other OpenProject versions |
| [Other](#other) | Additional questions, e.g. about contribution, training, support |
| [Topic-specific FAQ](#topic-specific-faq) | Links to other FAQ sections |
| [Learn more about OpenProject](#learn-more-about-openproject) | General questions about OpenProject, security, setup and much more |
| [How to ... in OpenProject](#how-to--in-openproject) | Questions about how to achieve certain outcomes in OpenProject that do not fit elsewhere |
| [FAQ regarding features](#faq-regarding-features) | Information about frequent feature requests |
| [FAQ regarding OpenProject BIM edition](#faq-regarding-openproject-bim-edition) | Questions concerning the additional BCF module for OpenProject and the BIM edition |
| [Migration](#migration) | Questions regarding migrating to OpenProject from e.g. Bitnami or from other OpenProject versions |
| [Other](#other) | Additional questions, e.g. about contribution, training, support |
| [Topic-specific FAQ](#topic-specific-faq) | Links to other FAQ sections |
## Learn more about OpenProject
@ -40,7 +40,7 @@ The system requirements can be found [here](../installation-and-operations/syste
Apart from using OpenProject in the cloud (OpenProject Enterprise cloud) OpenProject can be installed in two different ways: The packaged installation of OpenProject is the recommended way to install and maintain OpenProject using DEB or RPM packages. There's also a Docker based installation option.
### How can I learn more about OpenProject and how to use it?
### How can I learn more about OpenProject?
Here are resources to get to know OpenProject:
@ -85,7 +85,7 @@ However, if you're still using an old OpenProject subscription there may be limi
In the Community Edition and in the Enterprise on-premises edition you can use the standard LDAP authentication. However, the Enterprise on-premises edition also includes LDAP group synchronization. This allows you to synchronize group members from LDAP with groups in OpenProject. The respective documentation can be found [here](../system-admin-guide/authentication/ldap-authentication/ldap-group-synchronization/#synchronize-ldap-and-openproject-groups-premium-feature).
## How to ... in OpenProject?
## How to ... in OpenProject
Most of this kind of questions will be answered in the respective sections for each topic (see links below). However, there may be some FAQ that do not really fit elsewhere:
@ -11,10 +11,10 @@ keywords: my page, personal overview page, dashboard
The My Page is your **personal dashboard** with important overarching project information, such as work package reports, news, spent time, or a calendar. It can be configured to your specific needs.
@ -13,14 +13,14 @@ Here you will get an overview how to sign in and register to an existing OpenPro
> **Note**: If you do not have an OpenProject installation yet, please visit our site on [how to create an OpenProject trial installation](../../enterprise-guide/enterprise-cloud-guide/create-cloud-trial/).
@ -52,7 +52,7 @@ A closer look at the available branches:
* [release/11.0](https://packager.io/gh/opf/openproject/refs/release/10.0): Regular (usually daily) release builds for the current next patch release (or for the first release in this version, such as 11.0.0). This will contain early bugfixes before they are being release into stable. **Do not use in production**. But, for upgrading to the next major version, this can be regarded as a _release candidate channel_ that you can use to test your upgrade on a copy of your production environment.
* [dev](https://packager.io/gh/opf/openproject/refs/dev): Daily builds of the current development build of OpenProject. While we try to keep this operable, this may result in broken code and/or migrations from time to time. Use when you're interested what the next release of OpenProject will look like. **Do not use in production!**
## How to backup and restore my OpenProject installation?
## How can I backup and restore my OpenProject installation?
Please refer to the [backup documentation](../backing-up) for the packaged installation.
| [Users and permissions](./users-permissions) | How to manage users, groups and permissions in OpenProject? |
| [Work packages](./manage-work-packages) | How to configure work packages, types, status and workflows? |
| [Users and permissions](./users-permissions) | How to manage users, groups and permissions in OpenProject. |
| [Work packages](./manage-work-packages) | How to configure work packages, types, status and workflows. |
| [Custom fields](./custom-fields) | Set custom fields for work packages, Spent time, projects, versions, users, groups and more. |
| [Attribute help texts](./attribute-help-texts) | Add help texts to explain attributes (including custom fields) in projects and work packages. |
| [Enumerations](./enumerations) | Set enumerations, e.g. work package priorities, time tracking activities, document categories, and more. |
| [System settings](./system-settings) | Configure your system settings, e.g. a welcome text block on the landing page, display settings, repositories, and more. |
| [Incoming emails](./../installation-and-operations/configuration/incoming-emails) | Configure email settings in OpenProject. How to set up incoming email? |
| [Outbound emails](./../installation-and-operations/configuration/outbound-emails) | Configure email settings in OpenProject. How to configure email notifications and your email provider? |
| [Incoming emails](./../installation-and-operations/configuration/incoming-emails) | Configure email settings in OpenProject: How to set up incoming email. |
| [Outbound emails](./../installation-and-operations/configuration/outbound-emails) | Configure email settings in OpenProject: How to configure email notifications and your email provider. |
| [Authentication](./authentication) | Configure authentication methods in OpenProject, e.g. OAuth, OpenID, Two-factor-authentication, LDAP, and more. |
| [Announcement](./announcement) | How to create a system announcement? |
| [Announcement](./announcement) | How to create a system announcement. |
| [Design](./design) | Create your own design and make it compliant to your company's Corporate Identity, upload logo and customize colors. |
| [Colors](./colors) | Configure colors used in the system, e.g. status colors, work package types, priorities and more. |
| [Time and costs](./time-and-costs) | Configure your currency and create cost types in OpenProject. |
| [Authentication settings](authentication-settings) | Configure general authentication settings, such as registration, passwords, and more. |
| [OAuth applications](oauth-applications) | How to configure OAuth applications in OpenProject? |
| [OpenID providers](openid-providers) | How to configure OpenID providers in OpenProject? |
| [Two-factor authentication](two-factor-authentication) | Set up and manage two-factor authentication (2FA) in OpenProject. |
| [reCAPTCHA](recaptcha) | How to activate reCAPTCHA in OpenProject? |
| [LDAP authentication](ldap-authentication) | How to set up LDAP authentication in OpenProject? |
| [LDAP group synchronization](ldap-authentication/ldap-group-synchronization) | How to configure LDAP group synchronization in OpenProject (Premium feature)? |
| [Authentication settings](authentication-settings) | Configure general authentication settings, such as registration, passwords, and more. |
| [OAuth applications](oauth-applications) | How to configure OAuth applications in OpenProject. |
| [OpenID providers](openid-providers) | How to configure OpenID providers in OpenProject. |
| [Two-factor authentication](two-factor-authentication) | Set up and manage two-factor authentication (2FA) in OpenProject. |
| [reCAPTCHA](recaptcha) | How to activate reCAPTCHA in OpenProject. |
| [LDAP authentication](ldap-authentication) | How to set up LDAP authentication in OpenProject. |
| [LDAP group synchronization](ldap-authentication/ldap-group-synchronization) | How to configure LDAP group synchronization in OpenProject. (Premium feature) |
| [General settings](general-settings) | How to configure general system settings, e.g. a welcome text block on the application landing page, attachment size, and much more? |
| [Display settings](display-settings) | How to configure languages, date and time formats, week start, and more? |
| [Project settings](project-system-settings) | Settings for new projects. |
| [Attachments](attachments) | Settings for attachments. |
| [API](api-settings) | API settings (enable docs and CORS). |
| [Repositories](repositories) | How to integrate SVN or GIT repositories? |
| [General settings](general-settings) | How to configure general system settings, e.g. a welcome text block on the application landing page, attachment size, and much more. |
| [Display settings](display-settings) | How to configure languages, date and time formats, week start, and more. |
| [Project settings](project-system-settings) | Settings for new projects. |
| [Attachments](attachments) | Settings for attachments. |
| [API](api-settings) | API settings (enable docs and CORS). |
| [Repositories](repositories) | How to integrate SVN or GIT repositories. |
@ -18,10 +18,10 @@ A **backlog** is defined as a plugin that allows to use the backlogs feature in
Please note that this user guide does not represent an introduction into scrum methodology, but merely explains the scrum-related functionalities and user instructions in OpenProject.
@ -12,16 +12,16 @@ The starting point for effective work in Scrum teams is a well-maintained and pr
Moreover, please note that the backlogs module is not available in the accessibility mode, since it uses drag&drop functionalities which are not accessible. If you use the accessibility mode you can however perform the same actions (like viewing and editing work packages such as user stories and epics) from the work package list view.
@ -14,14 +14,14 @@ You can add planned **unit costs** as well as **labor costs** for the project.
Then, you will assign work packages to a budgets. If you log time or costs to this work package the costs will booked to this budget and show the percentage spent for a project budget.
@ -14,16 +14,16 @@ In the forum in OpenProject you can discuss topics in a project with the team: p
**Forum** is defined as a module used to display forums and forum entries. The module has to be activated in the project settings and a forum has to be created in the forums tab in the project settings to be displayed in the side navigation.
The **Gantt chart** in OpenProject displays the work packages in a timeline. You can collaboratively create and manage your project plan. Have your project timelines available for all team members and share up-to-date information with stakeholders. You can add start and finish dates and adapt it with drag and drop in the Gantt chart. Also, you can add dependencies, predecessor or follower within the Gantt chart.
| [Activate the Gantt chart](#activate-the-gantt-chart) | How to activate the Gantt chart in OpenProject? |
| [Create a new element](#create-a-new-element-in-the-gantt-chart) | How to add a new item to the Gantt chart? |
| [Relations in the Gantt chart](#relations-in-the-gantt-chart) | Create and display dependencies in the Gantt chart. |
| [Understanding the colors and lines in the Gantt chart](#understanding-the-colors-and-lines-in-the-gantt-chart) | What do the clamps, lines and symbols in the Gantt chart mean? |
| [Gantt chart configuration](#gantt-chart-configuration) | How to configure the view of your Gantt chart, e.g. add labels? |
| [Gantt chart views](#gantt-chart-views) | How to zoom in and out and activate the Zen mode? |
| [Activate the Gantt chart](#activate-the-gantt-chart) | How to activate the Gantt chart in OpenProject. |
| [Create a new element](#create-a-new-element-in-the-gantt-chart) | How to add a new item to the Gantt chart. |
| [Relations in the Gantt chart](#relations-in-the-gantt-chart) | Create and display dependencies in the Gantt chart. |
| [Understanding the colors and lines in the Gantt chart](#understanding-the-colors-and-lines-in-the-gantt-chart) | What do the clamps, lines and symbols in the Gantt chart mean? |
| [Gantt chart configuration](#gantt-chart-configuration) | How to configure the view of your Gantt chart, e.g. add labels. |
| [Gantt chart views](#gantt-chart-views) | How to zoom in and out and activate the Zen mode. |
### How to change the duration of an element in the Gantt chart?
### How to change the duration of an element in the Gantt chart
To change the duration of a work package in the Gantt chart view, hover over the work package in the Gantt chart and use the little arrows on its ends to adjust the start date or finish date. This will shorten or prolong its duration.
To move a work package on the time line just click on it and drag and drop it to the desired point of time. This will change its start and finish date.
@ -95,7 +95,7 @@ Click the **Apply** button to save your changes.
@ -30,36 +30,47 @@ The integration enables you to perform multiple actions in both Nextcloud and Op
As a user of both Nextcloud and OpenProject, you can benefit from this integration in both platforms:
- **In OpenProject:**
In addition to listing files attached to a work package, the Files tab now also shows you Nextcloud files that are linked to the current work package. Secondary actions on each file allow you to directly **open or download the file, show the containing folder in Nextcloud or remove the link**.
In addition to listing files attached to a work package, the _Files_ tab now also shows you Nextcloud files that are linked to the current work package. Secondary actions on each file allow you to directly **open or download the file, show the containing folder in Nextcloud or remove the link**.
> **Note:** In this version of the integration, you can only link files to work packages on Nextcloud; adding a new link to a Nextcloud file via the OpenProject interface is not yet possible, but will be possible in the near future.
- **In Nextcloud:**
You will be able to access the OpenProject tab in Nextcloud by accessing the details split screen of any file. In this tab, you will be able to search for the work package to which you would like to add a link. Once a work package is linked to a file, you can always unlink it by clicking on the **unlink** icon.
On the file or folder that you want to link to a work package click on the three dots and then click on _Details_.
In the _Details_ side panel, click on the the _OpenProject_ tab. This tab lets you link work packages in OpenProject to the current file, and will list all linked work packages. When nothing is yet linked, the list will be empty. To link the file to work package for the first time, use the search bar to search for the work packages in your OpenProject instance, and click on one to link it.
![NC_empty_status](NC_0_00-FileNoRelation.png)
![NC_search_WP](NC_0_01-FileRelationSearch.png)
![NC_search_WP](0_0_00-File_Relation_Search.png)
This linked file will then appear underneath the search bar, and will appear on the Files tab of the work package in OpenProject.
![NC_linked_WP](0_1_01-File_WP_Actions.png)
![NC_WP_relation](NC_1_00-FileWPRelation.png)
In addition to actions related to the file itself, you can also display the OpenProject widget on your Nextcloud dashboard in order to keep an eye on the the latest changes and updates to linked work packages:
Once a work package is linked to a file, you can always unlink it by clicking on the **unlink** icon.
![NC_unlink_WP](NC_1_01-FileWPActions.png)
In addition to actions related to individual files, can also choose to display the OpenProject widget on your Nextcloud dashboard in order to keep an eye on the the latest changes and updates to linked work packages:
![add_NC_widget](Add_OpenProject_widget.png)
![added_NC_widget](Nextcloud_dashboard.png)
Additionally, there are find three additional features related to the integration that you can enable in Nextcloud. In your personal settings page, under *Connected accounts* you will find these options:
Additionally, there are three additional features related to the integration that you can enable in Nextcloud. In your personal settings page, under *Connected accounts*, you will find these options:
- **Enable navigation link** displays a link to your OpenProject instance in the Nextcloud header
- **Enable unified search for tickets** allows you to access OpenProject work packages via the universal search bar
- **Enable notifications for activity in my work packages** sends you notifications when there are updates to linked OpenProject work packages
@ -69,16 +80,16 @@ Further integration efforts are under way. In the near future, you will be able
## Possible errors and troubleshooting
- **OpenProject - No permissions to see the file:** If you are unable to to see the details of a file or are unable to open some of the linked files due to issues with permissions, you will be able to see the name, time of last modification and the name of the modifier but you will not be able to perform any further actions. To open or access these files, you will need to contact your Nextcloud administrator or the creator of the file so that they can grant you the necessary permissions.
- **OpenProject - No permissions to see the file:** If you are unable to see the details of a file or are unable to open some of the linked files due to issues with permissions, you will be able to see the name, time of last modification and the name of the modifier but you will not be able to perform any further actions. To open or access these files, you will need to contact your Nextcloud administrator or the creator of the file so that they can grant you the necessary permissions.
- **OpenProject - User not logged in to Nextcloud:** You might see this error if you are not logged in to Nextcloud. You will still be able to see the list of linked files, but not perform any actions. Simply log in to your Nextcloud account to restore full functionality.
- **OpenProject - User not logged in to Nextcloud:** You might see this error if you are not logged in to Nextcloud. You will still be able to see the list of linked files, but not perform any actions. To remedy this, simply log in to your Nextcloud account to restore full functionality.
![OP_login_error](1_0_01-Log_in_error.png)
- **OpenProject - Connection error:** You will see this error when your OpenProject instance is unable to connect to your Nextcloud instance. In this case, you should contact the instance administrator to identify and to resolve the issue.
- **OpenProject - Connection error:** You will see this error when your OpenProject instance is unable to connect to your Nextcloud instance for any number of reasons. Your best course of action is to get in touch with the administrator of your OpenProject and Nextcloud instances to identify and to resolve the issue.
- **OpenProject - File fetching error:** In rare ocassions, it is possible for the integration to not be able to fetch all the details of all linked files linked. A simple page refresh should solve the issue, but should the error persist, please contact your instance administrator.
- **OpenProject - File fetching error:** In rare ocassions, it is possible for the integration to not be able to fetch all the details of all linked files. A simple page refresh should solve the issue, but should the error persist, please contact administrator of your OpenProject and Nextcloud instances.
@ -11,23 +11,23 @@ In OpenProject you can create projects to collaborate with your team members, tr
Your projects can be available publicly or internally. OpenProject does not limit the number of projects, neither in the Community Edition nor in the Enterprise cloud or in Enterprise on-premises edition.
| [Select a project](../../getting-started/projects/) | Open a project which you want to work at. |
| [Create a new project](../../getting-started/projects/#create-a-new-project) | Find out how to create a new project in OpenProject. |
| [Create a subproject](#create-a-subproject) | Create a subproject of an existing project. |
| [Project structure](#project-structure) | Find out how to set up a project structure. |
| [Project settings](#project-settings) | Configure further settings for your projects, such as description, project hierarchy structure, or setting it to public. |
| [Change the project hierarchy](#change-the-project-hierarchy) | You can change the hierarchy by selecting the parent project ("subproject of"). |
| [Set a project to public](#set-a-project-to-public) | Make a project accessible for (at least) all users within your instance. |
| [Create a project template](./project-templates/#create-a-project-template) | Configure a project and set it as template to copy it for future projects. |
| [Use a project template](./project-templates/#use-a-project-template) | Create a new project based on an existing template project. |
| [Copy a project](#copy-a-project) | Copy an existing project. |
| [Archive a project](#archive-a-project) | Find out how to archive completed projects. |
| [Delete a project](#delete-a-project) | How to delete a project? |
| [Projects list](#projects-list) | Get an overview of all your projects in the projects list. |
| [Export project list](#export-projects) | You can export the project list to XLS or CSV. |
| [Project overarching reports](#project-overarching-reports) | How to create project overarching reports across multiple projects? |
| [Select a project](../../getting-started/projects/) | Open a project which you want to work at. |
| [Create a new project](../../getting-started/projects/#create-a-new-project) | Find out how to create a new project in OpenProject. |
| [Create a subproject](#create-a-subproject) | Create a subproject of an existing project. |
| [Project structure](#project-structure) | Find out how to set up a project structure. |
| [Project settings](#project-settings) | Configure further settings for your projects, such as description, project hierarchy structure, or setting it to public. |
| [Change the project hierarchy](#change-the-project-hierarchy) | You can change the hierarchy by selecting the parent project ("subproject of"). |
| [Set a project to public](#set-a-project-to-public) | Make a project accessible for (at least) all users within your instance. |
| [Create a project template](./project-templates/#create-a-project-template) | Configure a project and set it as template to copy it for future projects. |
| [Use a project template](./project-templates/#use-a-project-template) | Create a new project based on an existing template project. |
| [Copy a project](#copy-a-project) | Copy an existing project. |
| [Archive a project](#archive-a-project) | Find out how to archive completed projects. |
| [Delete a project](#delete-a-project) | How to delete a project. |
| [Projects list](#projects-list) | Get an overview of all your projects in the projects list. |
| [Export project list](#export-projects) | You can export the project list to XLS or CSV. |
| [Project overarching reports](#project-overarching-reports) | How to create project overarching reports across multiple projects. |
![Overview of the planning calendar basics](planning-calendar-basics.png)
How to navigate the team planner? - The numbers below correspond with the above image:
How to navigate the team planner - the numbers below correspond with the above image:
1. The top header: Click on the top header (where it says **Team planner** in the picture above) to edit the name of your new team planning calendar. The top header is in edit mode by default, so you can just click right on the text. This is where you can give the new team planning calendar its new name. Your new name gets saved automatically by exiting the top header (by clicking somewhere else, for example).
2. Use the **+ add existing** button to add an existing work package to your view. Note: You cannot create new work packages from the team planner module. Create new work packages in the work package module, then select them in the team planner.
| [Manual progress tracking](#manual-progress-tracking) | How to track progress manually per work package? |
| [Progress tracking in the work package hierarchy](#progress-tracking-in-the-work-package-hierarchy) | How to track progress for multiple work packages? |
| [Status based progress tracking](#status-based-progress-tracking) | How to track progress use work package status? |
| [Manual progress tracking](#manual-progress-tracking) | How to track progress manually per work package. |
| [Progress tracking in the work package hierarchy](#progress-tracking-in-the-work-package-hierarchy) | How to track progress for multiple work packages. |
| [Status based progress tracking](#status-based-progress-tracking) | How to track progress use work package status. |
@ -13,14 +13,14 @@ You can easily report spent time and costs in OpenProject and filter, group and
> **Note**: To use the time tracking functionality, the **Time and costs module** needs to be activated in the [project settings](../../projects/project-settings/modules/).
| [Time and costs report](#time-and-costs-reports) | How to open time and costs reports in OpenProject? |
| [Change time and costs reports](#change-time-and-costs-reports) | How to change the view of the reports, e.g. to filter, group by and select units to be displayed? |
| [Filter cost reports](#filter-cost-reports) | How to filter time and cost reports? |
| [Group by criteria for cost reports](#group-by-criteria-for-cost-reports) | How to group time and cost reports? |
| [Select units to display](#select-units-to-display) | How to choose the unit to be displayed in a report? |
| [Export time and cost reports](#export-time-and-cost-reports) | How to export time and cost reports to Excel? |
| [Time and costs report](#time-and-costs-reports) | How to open time and costs reports in OpenProject. |
| [Change time and costs reports](#change-time-and-costs-reports) | How to change the view of the reports, e.g. to filter, group by and select units to be displayed. |
| [Filter cost reports](#filter-cost-reports) | How to filter time and cost reports. |
| [Group by criteria for cost reports](#group-by-criteria-for-cost-reports) | How to group time and cost reports. |
| [Select units to display](#select-units-to-display) | How to choose the unit to be displayed in a report. |
| [Export time and cost reports](#export-time-and-cost-reports) | How to export time and cost reports to Excel. |
@ -13,15 +13,15 @@ Users can book their time or units spent on an activity within a project directl
> **Note**: To use the time tracking functionality, the **Time and costs module** needs to be activated in the [project settings](../../projects/project-settings/modules/).
| [Logging time](#logging-time-in-the-work-package-view) | How to log time to work packages
| [Logging time via commit message](#logging-time-via-commit-message) | How to log time via a commit message to a work package? |
| [Edit logged time](#edit-logged-time) | How to edit logged time on a work package |
| [Delete time entries](#delete-time-entries) | How to delete time entries logged to a work package |
| [Logging and editing time for other users](#logging-and-editing-time-for-other-users) | How to log time to work packages |
| [Spent time widget on the My Page](#spent-time-widget-on-the-my-page) | How to easily track and display spent time in the spent time widget on the MyPage? |
| [Track time with Toggl](./toggl-integration) | How to track spent time with Toggl integration |
| [Logging time](#logging-time-in-the-work-package-view) | How to log time to work packages. |
| [Logging time via commit message](#logging-time-via-commit-message) | How to log time via a commit message to a work package. |
| [Edit logged time](#edit-logged-time) | How to edit logged time on a work package. |
| [Delete time entries](#delete-time-entries) | How to delete time entries logged to a work package. |
| [Logging and editing time for other users](#logging-and-editing-time-for-other-users) | How to log time to work packages. |
| [Spent time widget on the My Page](#spent-time-widget-on-the-my-page) | How to easily track and display spent time in the spent time widget on the MyPage. |
| [Track time with Toggl](./toggl-integration) | How to track spent time with Toggl integration. |
## Logging time in the work package view
@ -124,4 +124,4 @@ Here, you can click the **Edit button** on the top right corner of the user prof
Alternatively, you can navigate to *Administration -> Users and permissions -> Users* and click on the respective user name.
Click on the **Rate history** tab. Find out [here](../../../system-admin-guide/users-permissions/users/#rate-history) how to continue.
Click on the **Rate history** tab. Find out [here](../../../system-admin-guide/users-permissions/users/#rate-history) how to continue.
@ -28,7 +28,7 @@ The option configure menu item was designed to ease the handling of page structu
After the initial creation of the page you can select the function. If you select Do not show this wikipage in project navigation the page will be excluded from the menu.
Otherwise the page will appear in the project navigation and you can select, whether it shall be a subitem of an existing wikipage.
### I created a wiki-page but cannot find it anywhere in the menu - how to access it?
### I created a wiki-page but cannot find it anywhere in the menu - how can I access it?
After saving a wiki-page, you can create a referencing link for the page to easily access it - either by making it a wiki menu item (s.a.) or by referencing it with a link on the main wiki-page. If this chance was missed you can reaccess the page at any time, by typing in the page’s URL in the browser:
The example URL would be: openproject.org/projects/your-projects-name/wiki/your-wiki-page’s-name
@ -48,6 +48,6 @@ Next to the field to enter the page content, some of the basic formatting comman
Above you see the commands for text styles, headline options and lists, as well as the command to include an image.
On the right, there is also a help link which displays all commands which can be used for formatting.
### How to create a table of content?
### How to create a table of content
The macro to create a table of content is {{toc}}.
| [Update a work package](#update-a-work-package) | How to make a change to an existing work package. |
| [Watchers](#watchers) | How to add or remove watchers from a work package. |
| [Export work packages](#export-work-packages) | How to export work packages. |
| [Bulk edit work packages](#bulk-edit-work-packages) | How to edit several work packages as once. |
## Update a work package
@ -36,7 +36,7 @@ All changes of a work package are documented in the work package [Activity](../.
> **Note**: There is no possibility to undo changes to work packages (Ctrl+Z).
### How to assign a team member to a work package?
### How to assign a team member to a work package
When you assign a team member to a work package, you can distinguish between **assignee** and **accountable**. Accountable per definition would be the one accountable for the delivery of the work package. The assignee is the person currently assigned and working on the work package.
Choose the respective team member from the drop down for assignee or accountable. If you are looking to add a team member that is not coming up in the drop down, this team member might not yet be a member of the project and needs to be [invited](../../members/#add-members).
@ -45,7 +45,7 @@ Choose the respective team member from the drop down for assignee or accountable
### How to update the status of a work package?
### How to update the status of a work package
To update the status of a work package, click on the current status in the work package details and select the new status in the drop-down list.
@ -53,7 +53,7 @@ To update the status of a work package, click on the current status in the work
Please note, the status may differ from work package type. They can be configured in the [system administration](../../../system-admin-guide).
### How to add comments to a work package?
### How to add comments to a work package
To add a comment to a work package, open the [details view](../../work-packages/work-package-views/#work-package-full-screen-view) or the [split screen view](../../work-packages/work-package-views/#work-package-split-screen-view) of a work package. On the tab [Activity](../../../getting-started/work-packages-introduction/#activity-of-work-packages) tab you have a comment field at the bottom (or on top depending on your [My account settings](../../../getting-started/my-account/)).
@ -71,7 +71,7 @@ You can mention and notify team members via [@notification](../../notifications/
## Watchers
### How to add watchers to a work package?
### How to add watchers to a work package
<divclass="glossary">
**Watchers** can be added to a work package in order to notify members about changes. They will receive notifications according to their notification settings if changes are made to the respective work package.
@ -83,7 +83,7 @@ It is also possible to add oneself as watcher (if you have sufficient permission
![watchers](watchers.png)
### How to remove watchers from a work package?
### How to remove watchers from a work package
To remove watchers, navigate to the work package [details view](../../work-packages/work-package-views/#work-package-full-screen-view) and select the tab Watchers. Click the cross icon next to a watcher to remove the watcher from a work package.
The user will no longer get notifications in OpenProject about changes to this work package according to their notification settings. However, if he/she is the author, assignee or accountable of the work package there still might be notifications. Read [here](../../../getting-started/my-account/#notifications-settings) for more information.
| [Add or remove columns](#add-or-remove-columns-in-the-work-package-table) | How to add or remove columns in the work package table? |
| [Filter work packages](#filter-work-packages) | How to filter in the work package table? |
| [Sort the work package list](#sort-the-work-package-list) | How to sort within the work package table? |
| [Display settings](#flat-list-hierarchy-mode-and-group-by) | Get to know the flat list, the hierarchy mode, the group by and the sum feature. |
| [Attribute highlighting (Premium Feature)](#attribute-highlighting-premium-feature) | How to highlight certain attributes in the work package table? |
| [Save work package views](#save-work-package-views) | How to save a new work package view and how to change existing ones? |
| [Add or remove columns](#add-or-remove-columns-in-the-work-package-table) | How to add or remove columns in the work package table. |
| [Filter work packages](#filter-work-packages) | How to filter in the work package table. |
| [Sort the work package list](#sort-the-work-package-list) | How to sort within the work package table. |
| [Display settings](#flat-list-hierarchy-mode-and-group-by) | Get to know the flat list, the hierarchy mode, the group by and the sum feature. |
| [Attribute highlighting (Premium Feature)](#attribute-highlighting-premium-feature) | How to highlight certain attributes in the work package table. |
| [Save work package views](#save-work-package-views) | How to save a new work package view and how to change existing ones. |
You can configure the work package table view in OpenProject to display the information that you need in the list.
| [Basic formatting](#basic-formatting) | Basic formatting elements in the WYSIWYG editor |
| [Image handling](#image-handling) | How to add images in the WYSIWYG editor? |
| [Macros](#macros) | Available macros in the WYSIWYG editor |
| [Links to OpenProject resources](#links-to-openproject-resources) | How to link to resources like wikis, projects, meetings? |
| [Embedding of work package attributes and project attributes](#embedding-of-work-package-attributes-and-project-attributes) | How to embed attributes and attribute help texts? |
| [Basic formatting](#basic-formatting) | Basic formatting elements in the WYSIWYG editor |
| [Image handling](#image-handling) | How to add images in the WYSIWYG editor. |
| [Macros](#macros) | Available macros in the WYSIWYG editor |
| [Links to OpenProject resources](#links-to-openproject-resources) | How to link to resources like wikis, projects, meetings. |
| [Embedding of work package attributes and project attributes](#embedding-of-work-package-attributes-and-project-attributes) | How to embed attributes and attribute help texts. |