OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
openproject/docs/user-guide/project-overview/README.md

222 lines
9.4 KiB

---
sidebar_navigation:
5 years ago
title: Project overview
priority: 900
description: Learn how to configure a project overview page
robots: index, follow
keywords: project overview page
---
# Project overview
Expanding documentation (#9091) * changed screenshots for projects chapter * changed screenshots in gantt chart chapter * moved "aggregation by project" from work packages to Gantt chart chapter * changed some links * move reference to Excel sync out of Gantt chart chapter * small changes * add initial setup section for administrators to documentation Idea and main content from @ivangriggs Co-Authored-By: ivangriggs <77022874+ivangriggs@users.noreply.github.com> * smaller improvements to docs * improve documentation of manual and automatic scheduling mode * small improvements in docs * small changes * adding section for search options in OpenProject * move section about hourly rate defintion to system admin guide * formatting changes * explaining assignee filter options * change section header to make it detectable when searching for "projects overview" * clean up table of contents, make titles consistent, remove excessive space characters, etc. * update screenshots * changes to project overview docs * add screenshot for search bar * make info about aggregation of changes in activity and notifications easier detectable * small improvements * add info about non member and anonymous role * changes/additions * small changes * add additional options to access context menu * add sum feature for work package list to docs and change screenshot * add/improve info about email notifications * link fixes (necessary due to structural changes in documentation) * working in review comments * changes for time tracking activities * change screen shots for wiki - more functions section * change screenshots and improve description for meetings * improve detectability of mention feature * move FAQ in authentication * add how to reset password * improve explanation on how to un-archive projects * mention Mattermost integration * small correction
4 years ago
The **Project overview** page is a dashboard with important information about the respective project. You can display relevant information for your team, such as members, news, project description, work package reports, or a project status.
| Topic | Content |
5 years ago
| ------------------------------------------------------------ | ------------------------------------------------------- |
| [What is the project overview?](#what-is-the-project-overview) | What can I do with the project overview page? |
| [Add a widget to the project overview](#add-a-widget-to-the-project-overview) | How can I add a new widget to the project overview? |
| [Project status](#project-status) | Set your project status |
| [Available project overview widgets](#available-project-overview-widgets) | What kind of widgets can I add to the project overview? |
| [Re-size and re-order widgets](#re-size-and-re-order-widgets) | How can I re-order or re-size the widgets? |
| [Remove widget](#remove-widget-from-project-overview-page) | How can I remove widget from project overview page? |
5 years ago
## What is the project overview?
The project overview is a single dashboard page where all important information of the selected project can be displayed. The idea is to have it centrally available for the whole project team.
5 years ago
You can add project information as widgets to the dashboard and not only order but also re-size the widgets according to your needs.
5 years ago
Furthermore, you can add text widgets, custom texts, links and other information to your overview page.
5 years ago
5 years ago
Open the project overview by navigating to **Overview** in the project menu on the left.
5 years ago
![project overview](image-20191112132919003.png)
## Add a widget to the project overview
5 years ago
1. Choose the place where to add the new widget.
To add a widget to the project overview, click on the **+ button** on the top right of the page. Select the place where to add the widget, by clicking on a plus that appears on the top right corner of the page.
![Overview-add-widget](Overview-add-widget-1573564870548.png)
2. Choose which kind of widget you want to add.
Choose one of the possible widgets to add from the list.
![add widget](image-20191112142303373.png)
## Project status
On the project overview page, you can set your project status and give a detailed description. The project status is a widget that you add to your project overview. Find the description [below](#project-status-widget).
## Available project overview widgets
You can add various widgets to your project overview.
### Calendar widget
Expanding documentation (#9091) * changed screenshots for projects chapter * changed screenshots in gantt chart chapter * moved "aggregation by project" from work packages to Gantt chart chapter * changed some links * move reference to Excel sync out of Gantt chart chapter * small changes * add initial setup section for administrators to documentation Idea and main content from @ivangriggs Co-Authored-By: ivangriggs <77022874+ivangriggs@users.noreply.github.com> * smaller improvements to docs * improve documentation of manual and automatic scheduling mode * small improvements in docs * small changes * adding section for search options in OpenProject * move section about hourly rate defintion to system admin guide * formatting changes * explaining assignee filter options * change section header to make it detectable when searching for "projects overview" * clean up table of contents, make titles consistent, remove excessive space characters, etc. * update screenshots * changes to project overview docs * add screenshot for search bar * make info about aggregation of changes in activity and notifications easier detectable * small improvements * add info about non member and anonymous role * changes/additions * small changes * add additional options to access context menu * add sum feature for work package list to docs and change screenshot * add/improve info about email notifications * link fixes (necessary due to structural changes in documentation) * working in review comments * changes for time tracking activities * change screen shots for wiki - more functions section * change screenshots and improve description for meetings * improve detectability of mention feature * move FAQ in authentication * add how to reset password * improve explanation on how to un-archive projects * mention Mattermost integration * small correction
4 years ago
The calendar widget displays your current work packages in a calendar. It shows work packages that are being worked on at the current date. The maximum number of displayable work packages is 100.
![calendar](image-20191112142555628.png)
### Custom text widget
Within the custom text widget you can add any project information which you want to share with your team, e.g. links to important project resources or work packages, filters, specifications.
You can also add files to be displayed or attached to your project overview.
![custom text widget](image-20191112143117119.png)
### Project members widget
You can add a widget which displays all project members and their corresponding role for this project at the project overview page. This includes groups and placeholder users.
![project members](image-20191112134827557.png)
With the green button you can [add members to your project](/getting-started/invite-members/).
The View all members button brings you to the list of project members.
### News widget
Display the latest project news in the news widget on the project overview page.
![news-widget](news-widget-1376304.png)
### Project description
The project description widgets adds the project description to your project overview.
The description can be added or changed in the [project settings](../projects/project-settings).
![project description widget](image-20191112143652698.png)
### Project details widget
The project details widget displays all custom fields for projects, e.g. project owner, project due date, project number, or any other custom field for this project.
The custom fields can be adapted in the [project settings](../projects/project-settings/). As a system administrator you can [create new custom fields for projects](../../system-admin-guide/custom-fields/custom-fields-projects/).
![project details widget](image-20191112144557906.png)
New custom fields for projects can be created in the [system administration](../../system-admin-guide/).
5 years ago
### Project status widget
Add your project status as a widget to display at a glance whether your project is on track, off track or at risk.
5 years ago
First, select your project status from the drop-down. You can choose between:
ON TRACK (green)
5 years ago
OFF TRACK (red)
AT RISK (yellow)
NOT SET (grey)
![project status](image-20191112134438710.png)
Add a **project status description** and further important information, such as project owner, milestones and other important links or status information.
![project status description](image-20191112134630392.png)
### Spent time widget
5 years ago
The spent time widget lists the **spent time in this project for the last 7 days**.
5 years ago
![spent time widget](image-20191112145040462.png)
Time entries link to the respective work package and can be edited or deleted. To have a detailed view on all spent time and costs, go to the [Cost reporting](#TODO) module.
### Subprojects
The subprojects widget lists all subproject of the respective project on the overview. You can directly open a subproject via this link.
![subproject widget](image-20191112145420888.png)
The widget only links the first subproject hierarchy and not the children of a subproject.
To edit the project hierarchy, go to the [project settings](../projects/).
### Work package graph widgets (Premium feature)
The work package graph widgets displays information about the work packages within a project. They can be displayed in different graph views, such as a bar graph or a pie chart.
![work package graph widget](image-20191112150530814.png)
**Configure the work package graph**
You can filter the work packages to be displayed in the graph according to the [work packages table configuration](../work-packages/work-package-table-configuration/).
To configure the work package graph, click on the three dots in the top right corner and select **Configure view...**
![configure-view-widgets](configure-view-widgets.png)
Select the **Axis criteria** which shall be displayed on the axis of the graph, e.g. Accountable, Priority, Status, Type.
![axis criteria widget](image-20191112151252153.png)
Next, select the **Chart type** how the work package information shall be displayed, e.g. as a bar graph, a line, a pie chart.
![chart type widget](image-20191112151204029.png)
**Filter** the work packages for your chart.
Click on the Filter tab in order to configure the work packages which shall be displayed, e.g. only work packages with high priority.
![filter work package graph widget](image-20191112151535247.png)
Click the blue **Apply** button to save your changes.
If you want to build exactly the widgets shown in the screen-shot above:
- For the "Assignees" graph please choose the widget "work packages overview" and change to "assignees".
- For the Work packages status graph please select "work package graph", click on the three dots in the upper right corner of the widget, choose "configure view", then choose "status" as axis criteria and "pie chart" as chart type.
- For the Work package progress graph please select "work package graph", click on the three dots in the upper right corner of the widget, choose "configure view", then choose "progress (%)" as axis criteria and "line" as chart type.
### Work package overview widget
The work package over widget displays all work packages in a project differentiated by a certain criteria.
![work package overview](image-20191112151729016.png)
You can display the graph according to the following criteria:
* Type
* Status
* Priority
* Author
* Assignee
![criteria work package overview widget](image-20191112151821619.png)
The widget lists all **open** and all **closed** work packages according to this criteria.
### Work package table widget
The work package table widget includes a work package table to the project overview. The work package table can be filtered, grouped, sorted according to the [work package table configuration](../work-packages/work-package-table-configuration/), e.g. to display only work packages with the priority "High".
![work package table widget](image-20191112152119523.png)
## Re-size and re-order widgets
To **re-order** a widget, click on the dots icon on the upper left hand corner and drag the widget with the mouse to the new position.
To **re-size** a widget, click on the grey icon in the lower right hand corner of the widget and drag the corner to the right or left. The widget will re-size accordingly.
![re-size-widgets](re-size-widgets.gif)
## Remove widget from project overview page
To remove a widget from the project overview page, click on the three dots at the top right corner of the widget and select **Remove widget**.
5 years ago
![remove-widget](remove-widget.png)