references/openproject
1
0
Fork 0
mirror of https://github.com/opf/openproject.git synced 2026-06-14 03:30:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

[#50983] technical review and small changes

Browse Source 
- using one-drive in web links instead of onedrive
- corrected some technical wrongs
This commit is contained in:
Eric Schubert
2023-12-05 15:35:08 +01:00
parent 9728b0e2a1
commit e45f64c991
30 changed files with 403 additions and 292 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/system-admin-guide/file-storages/README.md
+19 -11
View File
@@ -5,30 +5,38 @@ sidebar_navigation:
description: File storages in OpenProject.
keywords: file storages, nextcloud setup, nextcloud integration, onedrive setup, sharepoint setup, onedrive, sharepoint
---
# File storages
You can connect your OpenProject installation to Nextcloud or OneDrive/SharePoint. To do that navigate to **Administration** -> **Settings** -> **File storages** and select the respective option.
You can connect your OpenProject installation to Nextcloud or OneDrive/SharePoint. To do that navigate to
**Administration** -> **Settings** -> **File storages** and select the respective option.
You need to have administrator rights to be able to setup the integration.
UPDATE SCREENSHOT FROM Admin-> Settings-> File storages. to show the setup once the **+Storage** button is deprecated.
You need to have administrator rights to be able to setup the integration.
![Files storages in OpenProject administration](openproject_admin_guide_file_storages.png)
## Nextcloud integration setup guide
For detailed guide on the initial setup, please consult [Nextcloud integration setup guide](../integrations/nextcloud/).
For detailed guide on the initial setup, please consult [Nextcloud integration setup guide](../integrations/nextcloud/).
Please also remember to activate the **File storages** module under [project settings in a respective project](../../user-guide/projects/project-settings/file-storages/).
Please also remember to activate the **File storages** module
under [project settings in a respective project](../../user-guide/projects/project-settings/file-storages/).
For instructions on using the integration after the setup has been complete please refer to [Nextcloud integration user guide](../../user-guide/file-management/nextcloud-integration/).
For instructions on using the integration after the setup has been complete please refer
to [Nextcloud integration user guide](../../user-guide/file-management/nextcloud-integration/).
## OneDrive/SharePoint integration (Enterprise add-on) setup guide
> **Note**: OneDrive/SharePoint integration is an Enterprise add-on and can only be used with [Enterprise cloud](../../enterprise-guide/enterprise-cloud-guide/) or [Enterprise on-premises](../../enterprise-guide/enterprise-on-premises-guide/). An upgrade from the free Community edition is easy and helps support OpenProject.
> **Note**: OneDrive/SharePoint integration is an Enterprise add-on and can only be used
> with [Enterprise cloud](../../enterprise-guide/enterprise-cloud-guide/)
> or [Enterprise on-premises](../../enterprise-guide/enterprise-on-premises-guide/). An upgrade from the free Community
> edition is easy and helps support OpenProject.
For detailed guide on the initial setup, please consult [OneDrive/SharePoint integration setup guide](../integrations/onedrive/).
For detailed guide on the initial setup, please
consult [OneDrive/SharePoint integration setup guide](../integrations/one-drive/).
Please also remember to activate the **File storages** module under [project settings in a respective project](../../user-guide/projects/project-settings/file-storages/).
Please also remember to activate the **File storages** module
under [project settings in a respective project](../../user-guide/projects/project-settings/file-storages/).
For instructions on using the integration after the setup has been complete please refer to [SharePoint/OneDrive integration user guide](../../user-guide/file-management/one-drive-integration/).
For instructions on using the integration after the setup has been complete please refer
to [SharePoint/OneDrive integration user guide](../../user-guide/file-management/one-drive-integration/).
docs/system-admin-guide/file-storages/openproject_admin_guide_file_storages.png
BIN
View File
Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 100 KiB

After

Width:  |  Height:  |  Size: 131 KiB

docs/system-admin-guide/integrations/README.md
+8 -3
View File
@@ -45,11 +45,16 @@ To synchronize tasks from MS Project to OpenProject, you can export your MS Proj
OpenProject offers integration with Nextcloud for file storage and collaboration. You can find more information about [setting up the integration with Nextcloud](./nextcloud) and [using the integration](../../user-guide/nextcloud-integration/).
## OneDrive/Sharepoint (Enterprise add-on)
## OneDrive/SharePoint (Enterprise add-on)
OpenProject offers integration with OneDrive/Sharepoint for file storage and collaboration. You can find more information about [setting up the integration with OneDrive/Sharepoint](../onedrive) and [using the integration](../../user-guide/file-management/onedrive-integration/).
OpenProject offers an integration with OneDrive/Sharepoint for file storage and collaboration. You can find more
information about [setting up the integration with OneDrive/SharePoint](./one-drive)
and [using the integration](../../user-guide/file-management/one-drive-integration/).
> **Note**: OneDrive/SharePoint integration is an Enterprise add-on and can only be used with [Enterprise cloud](../../enterprise-guide/enterprise-cloud-guide/) or [Enterprise on-premises](../../enterprise-guide/enterprise-on-premises-guide/). An upgrade from the free Community edition is easy and helps support OpenProject.
> **Note**: OneDrive/SharePoint integration is an Enterprise add-on and can only be used
> with [Enterprise cloud](../../enterprise-guide/enterprise-cloud-guide/)
> or [Enterprise on-premises](../../enterprise-guide/enterprise-on-premises-guide/). An upgrade from the free Community
> edition is easy and helps support OpenProject.
## Slack
docs/system-admin-guide/integrations/one-drive/README.md
+113
View File
@@ -0,0 +1,113 @@
---
sidebar_navigation:
title: OneDrive/SharePoint integration setup
priority: 601
description: Set up One Drive as a file storage in your OpenProject instance
keywords: One Drive, SharePoint, file storage, integration
---
# OneDrive/SharePoint (Enterprise add-on) integration setup
| Topic | Description |
|-----------------------------------------------------------------------------------------|:--------------------------------------------------------------------------|
| [Minimum requirements](#minimum-requirements) | Minimum version requirements to enable the integration |
| [Set up the integration](#set-up-the-integration) | Connect OpenProject and OneDrive/SharePoint instances as an administrator |
| [Drive ID guide](./drive-id-guide) | How to obtain a drive ID |
| [Using the integration](#using-the-integration) | How to use the OneDrive/SharePoint integration |
| | Edit a OneDrive/SharePoint file storage |
| [Delete an OneDrive/SharePoint file storage](#delete-a-onedrivesharepoint-file-storage) | Delete a OneDrive/SharePoint file storage |
> **Note**: OneDrive/SharePoint integration is an Enterprise add-on and can only be used
> with [Enterprise cloud](../../../enterprise-guide/enterprise-cloud-guide/)
> or [Enterprise on-premises](../../../enterprise-guide/enterprise-on-premises-guide/). An upgrade from the free Community
> edition is easy and helps support OpenProject.
OpenProject offers an integration with OneDrive/SharePoint to allow users to:
- Link files and folders stored in OneDrive/SharePoint with OpenProject work packages
- View, open and download files and folder linked to a work package via the Files tab
> Note: This guide only covers the integration setup. Please go to
> our [OneDrive/SharePoint integration user guide](../../../user-guide/file-management/nextcloud-integration/) to learn
> more about how to work with the OneDrive/SharePoint integration.
## Minimum requirements
Please note these minimum version requirements for the integration to work with a minimal feature set:
- OpenProject version 13.1 (or above)
- Access to OneDrive/SharePoint
We recommend using the latest versions of both OneDrive/SharePoint and OpenProject to be able to use the latest
features.
## Set up the integration
> **Important**: You need administrator privileges in the Azure portal for your Microsoft Entra ID and in your
> OpenProject instance to set up this integration.
Navigate to **System administration -> File storages**. You will see the list of all storages that have already been set
up. If no files storages have been set up yet, a banner will tell you that there are no storages yet set up.
Click the green **+Storage** button and select the OneDrive/SharePoint option.
![Add a new OneDrive/SharePoint storage to OpenProject](openproject_system_guide_new_onedrive_storage.png)
A screen will open, in which you will need to add the following details for your new OneDrive/SharePoint storage. Please
consult your Azure administrator and the [Drive ID guide](./drive-id-guide) to obtain respective information.
// TODO: Replace screenshots once display texts are updated.
![Setting up a new OneDrive/SharePoint](openproject_system_guide_new_onedrive_storage_details.png)
## Using the integration
Once the [file storage is added and enabled for projects](../../../user-guide/projects/project-settings/file-storages),
your users are able to take full advantage of the integration between OneDrive/SharePoint and OpenProject. For more
information on how to link SharePoint files to work packages in OpenProject, please refer to
the [OneDrive/SharePoint integration user guide](../../../user-guide/file-management/one-drive-integration).
## Edit a OneDrive/SharePoint file storage
To edit an existing OneDrive/SharePoint file storage hover over the name of the storage you want to edit and click it.
![Select OneDrive/SharePoint file storage in OpenProject system administration](openproject_system_guide_select_onedrive_storage.png)
To update the general storage information, click the **Edit** icon next to the storage provider. To replace the Azure
authentication information, click on the **Sync** icon next to the OAuth application.
![Edit OneDrive/SharePoint in OpenProject](openproject_system_guide_edit_icon_onedrive_storage.png)
Here you will be able to edit all of the information you have specified when creating the OneDrive/SharePoint connection initially.
## Delete a OneDrive/SharePoint file storage
You can delete a OneDrive/SharePoint file storage either at a project level or at an instance-level.
Deleting a file storage at a project level simply makes it unavailable to that particular project, without affecting the
integration for other projects. Project admins can do so by navigating to **Project settings -> File storages** and
clicking the **Delete** icon next to the file storage you would like to remove.
![Delete a OneDrive/SharePoint storage from an OpenProject project](openproject_system_guide_delete_onedrive_storage_in_a_project.png)
Deleting a file storage at an instance level deletes the OneDrive/SharePoint integration completely, making it
inaccessible to all projects in that instance. Should an instance administrator nevertheless want to do so, they can
navigate to **Administration -> File storages**, hover over the name of the file storage they want to remove and click
it to enter the next page. Then they need to click the **Delete** button in the top right corner.
![Delete icon for SharePoint integration in OpenProject system settings](openproject_system_guide_delete_icon_onedrive_storage.png)
You will be asked to confirm the exact file storage name.
![Delete a SharePoint integration from OpenProject system settings](openproject_system_guide_delete_onedrive_storage.png)
> **Important:** Deleting a file storage as an instance administrator will also delete all settings and links between
> work packages and OneDrive/SharePoint files/folders. This means that should you want to reconnect your
> OneDrive/SharePoint instance with OpenProject, you will need complete the entire setup process once again.
## Getting support
If you run into any issues or you cannot setup your integration yourself please use
our [Support Installation & Updates forum](https://community.openproject.org/projects/openproject/forums/9) or if you
have an Enterprise subscription, please contact us at Enterprise Support.
docs/system-admin-guide/integrations/onedrive/drive-id-guide/README.md → docs/system-admin-guide/integrations/one-drive/drive-id-guide/README.md
+38 -22
View File
@@ -6,44 +6,53 @@ description: Drive ID guide for OneDrive/SharePoint integration setup in OpenPro
keywords: OneDrive/SharePoint file storage integration, OneDrive, SharePoint, DriveID, Azure, Drive ID
---
# Drive ID Guide
## How to obtain a drive ID
To configure a OneDrive/SharePoint storage you will need the drive ID of the drive you want to connect to OpenProject. Usually this will be a drive within a SharePoint site or a group.
To configure a OneDrive/SharePoint storage you will need the drive ID of the drive you want to connect to OpenProject.
Usually this will be a drive within a SharePoint site or a group.
The easiest way to get this ID is by using the Microsoft GRAPH API.
### Authentication and permission
To communicate with the GRAPH API you need to authenticate against it. This is done through an Azure application defined in the [Azure portal](https://portal.azure.com/) for your Microsoft Entra ID. In addition, the Azure application needs some API permissions. In general those permissions are given either of the `Delegated` type (in a user context) or of the `Application` type (for the whole application). To achieve the task of getting the desired drive ID, you will need an access token with the permission `Sites.Read.All`.
To communicate with the GRAPH API you need to authenticate against it. This is done through an Azure application defined
in the [Azure portal](https://portal.azure.com/) for your Microsoft Entra ID. In addition, the Azure application needs
some API permissions. In general those permissions are given either of the `Delegated` type (in a user context) or of
the `Application` type (for the whole application). To achieve the task of getting the desired drive ID, you will need
an access token with the permission `Sites.Read.All`.
### API endpoints
Once you have an access token with the correct permission, you need to fetch the site ID or the group ID, where your drive is listed in. For a SharePoint site, this can be done with the following endpoint:
Once you have an access token with the correct permission, you need to fetch the site ID or the group ID, where your
drive is listed in. For a SharePoint site, this can be done with the following endpoint:
```shell
GET https://graph.microsoft.com/v1.0/sites/<HOSTNAME>:/<RELATIVE_PATH_TO_SITE>
```
This will result in a JSON response. The `ID` usually is a triple, of which the 2nd value is the site ID you need to continue. With this site ID you can fetch the following endpoint:
This will result in a JSON response. The `ID` usually is a triple, of which the 2nd value is the site ID you need to
continue. With this site ID you can fetch the following endpoint:
```shell
GET https://graph.microsoft.com/v1.0/sites/<SITE_ID>/drives
```
This will result in a list of drives. You can select the correct drive by its `name` and take the value of the `ID`. With this value you can fully configure the OneDrive/SharePoint integration in OpenProject.
This will result in a list of drives. You can select the correct drive by its `name` and take the value of the `ID`.
With this value you can fully configure the OneDrive/SharePoint integration in OpenProject.
## Step-by-step guide with examples
In this section we provide a few examples, in which we demonstrate how to go through the steps mentioned above with a specific toolset.
>Note: following examples are explicitly written for this toolset and other mentioned preconditions, hence deviating from the preconditions will cause the example to deviate.
In this section we provide a few examples, in which we demonstrate how to go through the steps mentioned above with a
specific toolset.
> Note: following examples are explicitly written for this toolset and other mentioned preconditions, hence deviating
> from the preconditions will cause the example to deviate.
### Example 1: Microsoft GRAPH explorer
Microsoft provides a web application, which can browse the GRAPH API. This tool can be found [here](https://developer.microsoft.com/en-us/graph/graph-explorer).
Microsoft provides a web application, which can browse the GRAPH API. This tool can be
found [here](https://developer.microsoft.com/en-us/graph/graph-explorer).
#### Preconditions
@@ -54,11 +63,12 @@ Microsoft provides a web application, which can browse the GRAPH API. This tool
- Click on the `Sign in` button in the top right corner.
- Log in with your Microsoft account.
- Make sure to select the correct organisation to log in, as the graph explorer will try to specifically log into the associated tenant.
- After a successful login, the resolved tenant will be displayed for a sanity check.
- Make sure to select the correct organisation to log in, as the graph explorer will try to specifically log into the
associated tenant.
- After a successful login, the resolved tenant will be displayed for a sanity check.
- Fetch the hostname of the tenant (e.g. `example.sharepoint.com`)
- Go to the SharePoint website, where the drive you want to connect can be found.
- Fetch the relative path from the browser's URL field (e.g. `/sites/mysharepointsite`)
- Fetch the relative path from the browser's URL field (e.g. `/sites/mysharepointsite`)
- Copy the following endpoint to the GRAPH explorers query input field:
```shell
@@ -85,7 +95,8 @@ https://graph.microsoft.com/v1.0/sites/<HOSTNAME>:/<RELATIVE_PATH_TO_SITE>
}
```
- Fetch the value from the `ID` property and copy the second value. In this example, it would be `1b4b6576-906d-4d94-8f19-6d00a2507f50`.
- Fetch the value from the `ID` property and copy the second value. In this example, it would
be `1b4b6576-906d-4d94-8f19-6d00a2507f50`.
- Copy the following endpoint to the GRAPH explorers query input field:
```shell
@@ -148,19 +159,22 @@ There is a way to get all necessary information by executing the web requests fr
- Azure application has the API permission `Sites.Read.All` of type `Application`
- `curl`
- `jq` (You do not have to use this tool, but if you don't, you will have to take the information from the JSON HTTP responses by hand.)
- `jq` (You do not have to use this tool, but if you don't, you will have to take the information from the JSON HTTP
responses by hand.)
>**IMPORTANT, please read**: Setting the API permission `Sites.Read.All` to the `Application` level imposes an undeniable security risk.
> **IMPORTANT, please read**: Setting the API permission `Sites.Read.All` to the `Application` level imposes an
> undeniable security risk.
If the client credentials would get leaked, any client can read sites and their content by just using those credentials. It is highly recommended to remove that API permission after using this method to get the drive ID.
If the client credentials would get leaked, any client can read sites and their content by just using those credentials.
It is highly recommended to remove that API permission after using this method to get the drive ID.
#### How to
- Navigate to `Overview` of the Azure application at [https://portal.azure.com/](https://portal.azure.com/).
- Copy the values of the `Directory (tenant) ID`, the `Application (client) ID`, and one valid client secret.
- Those are the same values needed for configuring the OneDrive/SharePoint integration in OpenProject.
- If the value of an already existing, valid secret is unknown, Azure allows to create multiple secrets for an
application. Every secret value within Azure portal is only visible right after creation.
- Those are the same values needed for configuring the OneDrive/SharePoint integration in OpenProject.
- If the value of an already existing, valid secret is unknown, Azure allows to create multiple secrets for an
application. Every secret value within Azure portal is only visible right after creation.
- Use the values to replace the placeholders in the following command:
```shell
@@ -172,7 +186,7 @@ curl -H "Content-Type: application/x-www-form-urlencoded" \
- The result is a valid access that is needed in the following requests.
- Fetch the hostname of the tenant (e.g. `example.sharepoint.com`).
- Go to the SharePoint website, where the drive you want to connect can be found.
- Fetch the relative path from the browser's URL field (e.g. `/sites/mysharepointsite`).
- Fetch the relative path from the browser's URL field (e.g. `/sites/mysharepointsite`).
- Use the values to replace the placeholders in the following command:
```shell
@@ -180,7 +194,9 @@ curl -H "Authorization: Bearer <ACCESS_TOKEN>" \
'https://graph.microsoft.com/v1.0/sites/<HOSTNAME>:/<RELATIVE_PATH_TO_SITE>' | jq .id
```
- The result will be something like `example.sharepoint.com,1b4b6576-906d-4d94-8f19-6d00a2507f50,72fb59f8-8eed-4745-920a-8b36abb0d8e0`. The site ID needed is the second value of the triple, in the example case it would be `1b4b6576-906d-4d94-8f19-6d00a2507f50`.
- The result will be something
like `example.sharepoint.com,1b4b6576-906d-4d94-8f19-6d00a2507f50,72fb59f8-8eed-4745-920a-8b36abb0d8e0`. The site ID
needed is the second value of the triple, in the example case it would be `1b4b6576-906d-4d94-8f19-6d00a2507f50`.
- Use the values to replace the placeholders in the following command
```shell
docs/system-admin-guide/integrations/onedrive/openproject_system_guide_delete_icon_onedrive_storage.png → docs/system-admin-guide/integrations/one-drive/openproject_system_guide_delete_icon_onedrive_storage.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 58 KiB

After

Width:  |  Height:  |  Size: 58 KiB

docs/system-admin-guide/integrations/onedrive/openproject_system_guide_delete_onedrive_storage.png → docs/system-admin-guide/integrations/one-drive/openproject_system_guide_delete_onedrive_storage.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 77 KiB

After

Width:  |  Height:  |  Size: 77 KiB

docs/system-admin-guide/integrations/onedrive/openproject_system_guide_delete_onedrive_storage_in_a_project.png → docs/system-admin-guide/integrations/one-drive/openproject_system_guide_delete_onedrive_storage_in_a_project.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 75 KiB

After

Width:  |  Height:  |  Size: 75 KiB

docs/system-admin-guide/integrations/onedrive/openproject_system_guide_edit_icon_onedrive_storage.png → docs/system-admin-guide/integrations/one-drive/openproject_system_guide_edit_icon_onedrive_storage.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 46 KiB

After

Width:  |  Height:  |  Size: 46 KiB

docs/system-admin-guide/integrations/onedrive/openproject_system_guide_new_onedrive_storage.png → docs/system-admin-guide/integrations/one-drive/openproject_system_guide_new_onedrive_storage.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 36 KiB

docs/system-admin-guide/integrations/onedrive/openproject_system_guide_new_onedrive_storage_details.png → docs/system-admin-guide/integrations/one-drive/openproject_system_guide_new_onedrive_storage_details.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 111 KiB

After

Width:  |  Height:  |  Size: 111 KiB

docs/system-admin-guide/integrations/onedrive/openproject_system_guide_select_onedrive_storage.png → docs/system-admin-guide/integrations/one-drive/openproject_system_guide_select_onedrive_storage.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 46 KiB

After

Width:  |  Height:  |  Size: 46 KiB

docs/system-admin-guide/integrations/onedrive/README.md
-94
View File
@@ -1,94 +0,0 @@
---
sidebar_navigation:
title: OneDrive/Sharepoint integration setup
priority: 601
description: Set up One Drive as a file storage in your OpenProject instance
keywords: One Drive, Sharepoint, file storage, integration
---
# OneDrive/Sharepoint (Enterprise add-on) integration setup
| Topic | Description |
| ----------------------------------- | :----------------------------------------------------------- |
| [Minimum requirements](#minimum-requirements) | Minimum version requirements to enable the integration |
| [Set up the integration](#set-up-the-integration) | Connect OpenPRoject and OneDrive/Sharepoint instances as an administrator |
| [Drive ID guide](/drive-id-guide) | How to obtain a drive ID |
| [Using the integration](#using-the-integration) | How to use the OneDrive/SharePoint integration |
| | Edit a OneDrive/SharePoint file storage |
| [Delete an OneDrive/SharePoint file storage](#delete-a-onedrivesharepoint-file-storage) | Delete a OneDrive/SharePoint file storage |
> **Note**: OneDrive/SharePoint integration is an Enterprise add-on and can only be used with [Enterprise cloud](../../../enterprise-guide/enterprise-cloud-guide/) or [Enterprise on-premises](../../../enterprise-guide/enterprise-on-premises-guide/). An upgrade from the free Community edition is easy and helps support OpenProject.
OpenProject offers an integration with OneDrive/Sharepoint to allow users to:
- Link files and folders stored in OneDrive/Sharepoint with OpenProject work packages
- View, open and download files and folder linked to a work package via the Files tab
- View all work packages linked to a file (IS THIS TRUE ?)
> Note: This guide only covers the integration setup. Please go to our [OneDrive/Sharepoint integration user guide](../../../user-guide/nextcloud-integration/) to learn more about how to work with the OneDrive/Sharepoint integration.
## Minimum requirements
Please note these minimum version requirements for the integration to work with a minimal feature set:
- OpenProject version 13.1 (or above)
- Access to OneDrive/SharePoint
We recommend using the latest versions of both OneDrive/Sharepoint and OpenProject to be able to use the latest features.
## Set up the integration
> **Important**: You need to have administrator privileges in both your OneDrive/SharePoint and OpenProject instances to set up this integration.
Navigate to **System administration -> File storages**. You will the list of all storages that have already been set up. If no files storages have been set up yet, this list will be empty.
Click the green **+Storage** button and select the OneDrive/SharePoint option.
![Add a new OneDrive/SharePoint storage to OpenProject](openproject_system_guide_new_onedrive_storage.png)
A screen will open, in which you will need to add the following details for your new OneDrive storage. Please consult your Azure administrator and the [Drive ID guide](/drive-id-guide) to obtain respective information.
![Setting up a new OneDrive/SharePoint](openproject_system_guide_new_onedrive_storage_details.png)
PLEASE ADD THE PART AFTER "SAVE AND CONTINUE " BUTTON HAS BEEN CLICKED HERE
## Using the integration
Once the [file storage is added and enabled for projects](../../../user-guide/projects/project-settings/file-storages), your users are able to take full advantage of the integration between OneDrive/SharePoint and OpenProject. For more information on how to link SharePoint files to work packages in OpenProject and access linked work packages in OneDrive/SharePoint, please refer to the [OneDrive/SharePoint integration user guide](../../../user-guide/file-management/onedrive-integration).
## Edit a OneDrive/SharePoint file storage
To edit an existing OneDrive/SharePoint file storage hover over the name of the storage you want to edit and click it.
![Select OneDrive/SharePoint file storage in OpenProject system administration](openproject_system_guide_select_onedrive_storage.png)
Click the **Edit** icon next to the storage provider.
![Edit OneDrive/SharePoint in OpenProject](openproject_system_guide_edit_icon_onedrive_storage.png)
Here you will be able to edit all of the information you have specified when creating the OneDrive/SharePoint connection initially.
## Delete a OneDrive/SharePoint file storage
You can delete a OneDrive/SharePoint file storage either at a project level or at an instance-level.
Deleting a file storage at a project level simply makes it unavailable to that particular project, without affecting the integration for other projects. Project admins can do so by navigating to *Project settings → File storages* and clicking the **delete** icon next to the file storage you would like to remove.
![Delete a OneDrive/SharePoint storage from an OpenProject project](openproject_system_guide_delete_onedrive_storage_in_a_project.png)
Deleting a file storage at an instance level deletes the SharePoint integration completely and make it unaccessible to all projects in that instance. Should an instance administrator nevertheless want to do so, they can navigate to *Administration → File storages*, hover over the name of the file storage they want to remove, then click the **delete** icon in the detailed view which will be opened.
![Delete icon for SharePoint integration in OpenProject system settings](openproject_system_guide_delete_icon_onedrive_storage.png)
You will be asked to confirm the exact file storage name.
![Delete a SharePoint integration from OpenProject system settings](openproject_system_guide_delete_onedrive_storage.png)
> **Important:** Deleting a file storage as an instance administrator will also delete all settings and links between work packages and OneDrive/SharePoint files/folders. This means that should you want to reconnect your OneDrive/SharePoint instance with OpenProject, will need complete the entire setup process once again.
## Getting support
If you run into any new issues or you cannot solve your integration please use our [Support Installation & Updates forum](https://community.openproject.org/projects/openproject/forums/9) or if you have an Enterprise subscription, please contact us at Enterprise Support.
docs/user-guide/documents/README.md
+2 -1
View File
@@ -10,7 +10,8 @@ keywords: documents
This module allows uploading documents directly to the project under project menu item *Documents* and categorizing documents.
> Please note that this module only allows to manually upload documents directly into projects. For more advanced functionalities, please take a look at the [file storages integrations](../file-management).
> Please note that this module only allows to manually upload documents directly into projects. For more advanced
> functionalities, please take a look at the [file storages integrations](../file-management).
## Add a new document to the project
docs/user-guide/file-management/README.md
+24 -14
View File
@@ -8,35 +8,45 @@ keywords: files, attachment, Nextcloud, OneDrive, Sharepoint
# File Management
| Topic | Content |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| [Manual upload](#manual-upload) | How to manually upload files to work packages in OpenProject. |
| [Nextcloud integration](#nextcloud-integration) | How to manage files using Nextcloud integration in OpenProject. |
| Topic | Content |
|---------------------------------------------------------------------------------------|---------------------------------------------------------------------------|
| [Manual upload](#manual-upload) | How to manually upload files to work packages in OpenProject. |
| [Nextcloud integration](#nextcloud-integration) | How to manage files using Nextcloud integration in OpenProject. |
| [OneDrive/SharePoint integration](#onedrive/sharepoint-integration-enterprise-add-on) | How to manage files using OneDrive/Sharepoint integration in OpenProject. |
There are several ways of adding or linking files to work packages in OpenProject. You can manually attach files directly to work packages or use one of the integrations with file management systems.
There are several ways of adding or linking files to work packages in OpenProject. You can manually attach files
directly to work packages or use one of the integrations with file management systems.
> Note: in order to use Nextcloud or OneDrive/SharePoint integrations you first need to activate the [File storages module](../projects/project-settings/file-storages/) in your project settings.
> Note: in order to use Nextcloud or OneDrive/SharePoint integrations you first need to activate
> the [File storages module](../projects/project-settings/file-storages/) in your project settings.
## Manual upload
For the manual upload please refer to documentation on [attaching files to work packages](../work-packages/edit-work-package/attach-files-to-work-packages).
For the manual upload please refer to documentation on [attaching files to work packages](../work-packages/create-work-package/#add-attachments-to-work-packages).
## Nextcloud integration
You can use Nextcloud as an integrated file storage in OpenProject, allowing you to link files and folders stored in Nextcloud directly with work packages in OpenProject.
You can use Nextcloud as an integrated file storage in OpenProject, allowing you to link files and folders stored in
Nextcloud directly with work packages in OpenProject.
Please refer to [Nextcloud integration user guide](/nextcloud-integration) for further instructions on using the integration.
Please refer to [Nextcloud integration user guide](./nextcloud-integration) for further instructions on using the
integration.
For the initial setup please refer to the [Nextcloud integration setup guide](../..//system-admin-guide/integrations/nextcloud/).
For the initial setup please refer to the [Nextcloud integration setup guide](../../system-admin-guide/integrations/nextcloud/).
## OneDrive/SharePoint integration (Enterprise add-on)
You can also use OneDrive/SharePoint integration to link OpenProject work packages directly to the files stored in your OneDrive/SharePoint repository.
You can also use OneDrive/SharePoint integration to link OpenProject work packages directly to the files stored in your
OneDrive/SharePoint repository.
> **Note**: OneDrive/SharePoint integration is an Enterprise add-on and can only be used with [Enterprise cloud](../../enterprise-guide/enterprise-cloud-guide/) or [Enterprise on-premises](../../enterprise-guide/enterprise-on-premises-guide/). An upgrade from the free community edition is easy and helps support OpenProject.
> **Note**: OneDrive/SharePoint integration is an Enterprise add-on and can only be used
with [Enterprise cloud](../../enterprise-guide/enterprise-cloud-guide/)
or [Enterprise on-premises](../../enterprise-guide/enterprise-on-premises-guide/). An upgrade from the free community
edition is easy and helps support OpenProject.
Please refer to [OneDrive/SharePoint integration user guide](/onedrive-integration) for further instructions on using the integration.
Please refer to [OneDrive/SharePoint integration user guide](./one-drive-integration) for further instructions on using
the integration.
For the initial setup please refer to the [OneDrive/SharePoint integration setup guide](../..//system-admin-guide/integrations/onedrive/).
For the initial setup please refer to
the [OneDrive/SharePoint integration setup guide](../../system-admin-guide/integrations/one-drive/).
docs/user-guide/file-management/nextcloud-integration/README.md
+1 -1
View File
@@ -17,7 +17,7 @@ This integration makes it possible for you to:
- View all work packages linked to a file
- View OpenProject notifications via the Nextcloud dashboard
It is also possible to automatically create dedicated [project folders](../projects/project-settings/file-storages/#project-folders), which makes documentation structure clearer and makes navigation more intuitive.
It is also possible to automatically create dedicated [project folders](../../projects/project-settings/file-storages/#project-folders), which makes documentation structure clearer and makes navigation more intuitive.
> **Important note**: To be able to use Nextcloud as a file storage in your project, the administrator of your instance should first have completed the [Nextcloud integration setup](../../system-admin-guide/integrations/nextcloud). Then a project administrator can activate Nextcloud in the [**File storages**](../projects/project-settings/file-storages/) for a project.
docs/user-guide/file-management/one-drive-integration/README.md
+135
View File
@@ -0,0 +1,135 @@
---
sidebar_navigation:
title: One Drive integration
priority: 800
description: Using the OneDrive/Sharepoint integration to link/unlink files and folders to work packages, viewing and downloading files and troubleshooting common errors
keywords: integration, apps, OneDrive, Sharepoint, user
---
# OneDrive integration (Enterprise add-on)
You can use **OneDrive/SharePoint** as an integrated file storage in OpenProject.
> **Note**: OneDrive/SharePoint integration is an Enterprise add-on and can only be used
> with [Enterprise cloud](../../../enterprise-guide/enterprise-cloud-guide/)
> or [Enterprise on-premises](../../../enterprise-guide/enterprise-on-premises-guide/). An upgrade from the free Community
> edition is easy and helps support OpenProject.
This integration makes it possible for you to:
- Link files and folders stored in OneDrive/SharePoint with work packages in OpenProject
- View, open and download files and folders linked to a work package via the **Files** tab
- View all work packages linked to a file IS THIS TRUE FOR ONEDRIVE?
> **Important note**: To be able to use OneDrive/SharePoint as a file storage in your project, the administrator of your
> instance should first have completed
> the [OneDrive/SharePoint integration setup](../../../system-admin-guide/integrations/one-drive). Then a project
> administrator can activate the integrated storage in
> the [**File storages**](../../projects/project-settings/file-storages/) for a project.
| Topic | Description |
|---------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------|
| [Connect OpenProject to OneDrive/SharePoint](#connect-your-openproject-and-onedrivesharepoint-accounts) | How to connect your OpenProject project and OneDrive/SharePoint |
| [Link files and folders to work packages](#link-files-and-folders-to-work-packages) | How to link your files and folders to work packages in OpenProject |
| [Upload files from OpenProject](#upload-files-from-openproject) | How to upload files to OneDrive/SharePoint from OpenProject |
| [Download, open folders and remove links](#download-open-folders-and-remove-links) | How to download and open files and folders and remove links |
| [Permissions and access control](#permissions-and-access-control) | Permissions and access control in OneDrive(SharePoint file storage) |
## Connect your OpenProject and OneDrive/SharePoint accounts
To begin using this integration, you will need to first connect your OpenProject and Microsoft accounts. To do this,
open any work package in a project where a OneDrive/SharePoint file storage has been added and enabled by an
administrator and follow these steps:
1. Select any work package. Go to the **Files tab** and, within the correct file storage section, click on **Storage
login** button.
![Login to Sharepoint storage from an OpenProject work package](openproject_onedrive_login_to_storage.png)
2. You will see a Microsoft login prompt asking you to log in. Enter your credentials and log in.
3. Once you have logged in, you will automatically return to the work package in OpenProject and see that you can now
start uploading and linking files.
![OneDrive storage is available in an OpenProject work package](openproject_onedrive_available.png)
## Link files and folders to work packages
In addition to listing files directly attached to a work package, the **Files** tab shows the OneDrive/Sharepoint files
that are linked to the current work package. Hovering on any linked file with your mouse will give you options to open
or download the file, show the containing folder in SharePoint or remove the link.
To link a SharePoint file to the current work package, you can either:
- select a local file, which will be uploaded to OneDrive/SharePoint storage and linked to this work package
- select an existing file in OneDrive/SharePoint to link to
![Link existing files to OneDrive/SharePoint from an OpenProject work package](openproject_onedrive_link_existing_files_link.png)
> **Info**: The default location that opens in the file picker is the file root of the configured OneDrive/SharePoint
> drive.
![Select a SharePoint file or folder to link to an OpenProject work package](openproject_onedrive_link_files.png)
## Upload files from OpenProject
If the file you want to link has not yet been uploaded to SharePoint, you can do so by clicking on the **Upload files**
link.
![Upload file link in an OpenProject work package](openproject_onedrive_upload_file_link.png)
You will then be prompted to select a file (or multiple files) on your computer that you want to upload to
OneDrive/SharePoint.
![Choosing a file to upload to SharePoint in an OpenProject work package](openproject_onedrive_select_file.png)
Alternatively, you can also simply drag a file or folder from your computer to the drag zone that will appear under the
name of your OneDrive/SharePoint file storage.
Once you have selected or dropped the files you would like to upload, you will need to select the location on
OneDrive/SharePoint to which they should be stored.
> **Info**: The default location that opens in the file picker is the file root of the configured OneDrive/SharePoint
> drive.
![Selection a Sharepoint location to upload a file from OpenProject](openproject_onedrive_select_location.png)
You can click on folders you see to navigate to them. Helpful breadcrumbs show you where you are in the folder
hierarchy.
To navigate one level up or to go back to the root, simply click on the relevant parent in the breadcrumbs.
> **Info**: If you have navigated particularly deep (over 4 levels), intermediate levels might be collapsed to save
> space, but you’ll always be able to navigate back to the immediate parent or the root to go backwards.
To save the files you uploaded to the currently open folder, click on the **Choose location** button.
The selected file is uploaded to your OneDrive/SharePoint instance and linked to the current work package. It appears
under the name of the file storage.
![File successfully uploaded to Sharepoint storage](openproject_onedrive_file_uploaded.png)
## Download, open folders and remove links
If you wish to unlink any linked file or folder, hover it in the list of linked files and click on the **Unlink**
icon.
![Unlink a linked Sharepoint file from an OpenProject work package](openproject_onedrive_download_file.png)
Respectively in order to download a file, click on the **Download icon** in the context menu of the file link in the
list of the linked files.
If you click the **Folder icon**, the OneDrive/SharePoint folder containing this file will open in a separate tab.
## Permissions and access control
When a file or folder from OneDrive/SharePoint is linked to a work package, an OpenProject user who has access to that
work package will be able to:
- See the name of the linked file or folder
- See when it was last modified (or created, if it has not yet been modified)
- See who last modified it (or who created it, if it has not yet been modified)
However, all available actions depend on permissions the OpenProject user (or more precisely, the OneDrive/SharePoint
account tied to that user) has in OneDrive/SharePoint. In other words, a user who does not have the permission to
access the file in OneDrive/SharePoint will also *not* be able to open, download, or modify the file in
OpenProject.
docs/user-guide/file-management/onedrive-integration/openproject_onedrive_available.png → docs/user-guide/file-management/one-drive-integration/openproject_onedrive_available.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 101 KiB

After

Width:  |  Height:  |  Size: 101 KiB

docs/user-guide/file-management/onedrive-integration/openproject_onedrive_download_file.png → docs/user-guide/file-management/one-drive-integration/openproject_onedrive_download_file.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 83 KiB

After

Width:  |  Height:  |  Size: 83 KiB

docs/user-guide/file-management/onedrive-integration/openproject_onedrive_file_uploaded.png → docs/user-guide/file-management/one-drive-integration/openproject_onedrive_file_uploaded.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 78 KiB

After

Width:  |  Height:  |  Size: 78 KiB

docs/user-guide/file-management/onedrive-integration/openproject_onedrive_link_existing_files_link.png → docs/user-guide/file-management/one-drive-integration/openproject_onedrive_link_existing_files_link.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 79 KiB

After

Width:  |  Height:  |  Size: 79 KiB

docs/user-guide/file-management/onedrive-integration/openproject_onedrive_link_files.png → docs/user-guide/file-management/one-drive-integration/openproject_onedrive_link_files.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 78 KiB

After

Width:  |  Height:  |  Size: 78 KiB

docs/user-guide/file-management/onedrive-integration/openproject_onedrive_login_to_storage.png → docs/user-guide/file-management/one-drive-integration/openproject_onedrive_login_to_storage.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 105 KiB

After

Width:  |  Height:  |  Size: 105 KiB

docs/user-guide/file-management/onedrive-integration/openproject_onedrive_select_file.png → docs/user-guide/file-management/one-drive-integration/openproject_onedrive_select_file.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 135 KiB

After

Width:  |  Height:  |  Size: 135 KiB

docs/user-guide/file-management/onedrive-integration/openproject_onedrive_select_location.png → docs/user-guide/file-management/one-drive-integration/openproject_onedrive_select_location.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 78 KiB

After

Width:  |  Height:  |  Size: 78 KiB

docs/user-guide/file-management/onedrive-integration/openproject_onedrive_upload_file_link.png → docs/user-guide/file-management/one-drive-integration/openproject_onedrive_upload_file_link.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 82 KiB

After

Width:  |  Height:  |  Size: 82 KiB

docs/user-guide/file-management/onedrive-integration/README.md
-114
View File
@@ -1,114 +0,0 @@
---
sidebar_navigation:
title: One Drive integration
priority: 800
description: Using the OneDrive/Sharepoint integration to link/unlink files and folders to work packages, viewing and downloading files and troubleshooting common errors
keywords: integration, apps, OneDrive, Sharepoint, user
---
# OneDrive integration (Enterprise add-on)
You can use **OneDrive/SharePoint** as an integrated file storage in OpenProject.
> **Note**: OneDrive/SharePoint integration is an Enterprise add-on and can only be used with [Enterprise cloud](../../enterprise-guide/enterprise-cloud-guide/) or [Enterprise on-premises](../../enterprise-guide/enterprise-on-premises-guide/). An upgrade from the free Community edition is easy and helps support OpenProject.
This integration makes it possible for you to:
- Link files and folders stored in OneDrive/SharePoint with work packages in OpenProject
- View, open and download files and folders linked to a work package via the **Files** tab
- View all work packages linked to a file IS THIS TRUE FOR ONEDRIVE?
> **Important note**: To be able to use OneDrive/SharePoint as a file storage in your project, the administrator of your instance should first have completed the [OneDrive/SharePoint integration setup](../../../system-admin-guide/integrations/onedrive). Then a project administrator can activate Nextcloud in the [**File storages**](../../projects/project-settings/file-storages/) for a project.
| Topic | Description |
| ------------------------------------------------------------ | :----------------------------------------------------------- |
| [Connect OpenProject to OneDrive/SharePoint](#connect-your-openproject-and-onedrivesharepoint-accounts) | How to connect your OpenProject project and OneDrive/SharePoint |
| [Link files and folders to work packages](#link-files-and-folders-to-work-packages) | How to link your files and folders to work packages in OpenProject |
| [Upload files from OpenProject](#upload-files-from-openproject) | How to upload files to OneDrive/SharePoint from OpenProject |
| [Download, open folders and remove links](#download-open-folders-and-remove-links) | How to download and open files and folders and remove links |
| [Permissions and access control](#permissions-and-access-control) | Permissions and access control in OneDrive(SharePoint file storage) |
## Connect your OpenProject and OneDrive/SharePoint accounts
To begin using this integration, you will need to first connect your OpenProject and OneDrive accounts. To do this, open any work package in a project where a OneDrive/SharePoint file storage has been added and enabled by an administrator and follow these steps:
1. Select any work package. Go to the **Files tab** and, under the “SharePoint” header, click on **Storage login** button.
![Login to Sharepoint storage from an OpenProject work package](openproject_onedrive_login_to_storage.png)
2. You will see a Microsoft OneDrive screen asking you to log in. Enter your credentials and log in.
3. Once you have logged in, you will automatically return to the work package in OpenProject and see that you can now start uploading and linking files.
![OneDrive storage is available in an OpenProject work package](openproject_onedrive_available.png)
## Link files and folders to work packages
In addition to listing files directly attached to a work package, the **Files** tab shows the OneDrive/Sharepoint files that are linked to the current work package. Hovering on any linked file with your mouse will give you options to open or download the file, show the containing folder in SharePoint or remove the link.
To link a SharePoint file to the current work package, you can either:
- select a local file, which will be uploaded to OneDrive/SharePoint storage and linked to this work package
- select an existing file in OneDrive/SharePoint to link to
![Link existing files to OneDrive/SharePoint from an OpenProject work package](openproject_onedrive_link_existing_files_link.png)
IS THE FOLLOWING STATEMENT TRUE?
**Info**: The default project that opens in the location picker is set by the project administrators in the [File storages settings](../../projects/project-settings/file-storages).
![Select a SharePoint file or folder to link to an OpenProject work package](openproject_onedrive_link_files.png)
## Upload files from OpenProject
If the file you want to link has not yet been uploaded to SharePoint, you can do so by clicking on the **Upload files** link.
![Upload file link in an OpenProject work package](openproject_onedrive_upload_file_link.png)
You will then be prompted to select a file (or multiple files) on your computer that you want to upload to SharePoint.
![Choosing a file to upload to SharePoint in an OpenProject work package](openproject_onedrive_select_file.png)
Alternatively, you can also simply drag a file or folder from your computer to the drag zone that will appear under the name of your OneDrive/SharePoint file storage.
Once you have selected or dropped the files you would like to upload, you will need to select the location on SharePoint to which they should be stored.
> **Info**: The default project that opens in the location picker is defined by the project administrators in the [File storages settings](../../projects/project-settings/file-storages).
![Selection a Sharepoint location to upload a file from OpenProjec](openproject_onedrive_select_location.png)
You can click on folders you see to navigate to them. A helpful breadcrumb shows you where you are in the folder hierarchy.
To navigate one level up or to go back to the root, simply click on the relevant parent in the breadcrumb.
> **Info**: If you have navigated particularly deep (over 4 levels), intermediate levels might be collapsed to save space, but you’ll always be able to navigate back to the immediate parent or the root to go backwards.
To save the files you uploaded to the currently open folder, click on the **Choose location** button.
The selected file is uploaded to your OneDrive/SharePoint instance and linked to the current work package. It appears under the name of the file storage.
![File successfully uploaded to Sharepoint storage](openproject_onedrive_file_uploaded.png)
## Download, open folders and remove links
If you wish to unlink any linked file or folder, hover to it in the list of linked files and click on the **Unlink** icon.
![Unlink a linked Sharepoint file from an OpenProject work package](openproject_onedrive_download_file.png)
Respectively in order to download a file, hover over the **Download icon** in the list of the linked files.
If you click the **Folder icon**, the OneDrive/SharePoint folder containing this file will open in a separate tab.
## Permissions and access control
IS THIS TRUE FOR SHAREPOINT?
When a SharePoint file or folder is linked to a work package, an OpenProject user who has access to that work package will be able to:
- See the name of the linked file or folder
- See when it was last modified (or created, if it has not yet been modified)
- See who last modified it (or who created it, if it has not yet been modified)
However, all available actions depend on permissions the OpenProject user (or more precisely, the OneDrive/SharePoint account tied to that user) has in SharePoint. In other words, a user who does not have the permission to access the file in SharePoint will also *not* be able to open, download, modify or unlink the file in OpenProject.
docs/user-guide/projects/project-settings/file-storages/README.md
+52 -23
View File
@@ -7,18 +7,23 @@ keywords: file storages, project folder, storages
---
# File storages
>**Info**: Before a storage service can be added to a project, an administrator must first set up [Nextcloud integration](../../../../system-admin-guide/integrations/nextcloud/) or [OneDrive/SharePoint integration](../../../../system-admin-guide/integrations/onedrive/) with OpenProject.
> **Info**: Before a storage service can be added to a project, an administrator must first set
> up [Nextcloud integration](../../../../system-admin-guide/integrations/nextcloud/)
> or [OneDrive/SharePoint integration](../../../../system-admin-guide/integrations/one-drive/) with OpenProject.
| Topic | Description |
|-------------------------------------------------------------------|:------------------------------------|
| [Activate File Storages module](#activate-file-storages-module) | Activate File Storages module in a project |
|[Add Nextcloud storage](#add-nextcloud-storage-to-a-project) | Add your Nextcloud storage to a project |
| [Nextcloud and project folders](#nextcloud-and-project-folders) | Edit and delete an existing storage |
| [Edit and delete Nextcloud storage](#edit-and-delete-Nextcloud-storage) | Edit and delete an existing storage |
| [Add OneDrive/SharePoint storage to a project](#add-onedrive/sharepoint-storage-to-a-project) | Add your OneDrive/SharePoint storage to a project |
| Topic | Description |
|---------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------|
| [Activate File Storages module](#activate-file-storages-module) | Activate File Storages module in a project |
| [Add Nextcloud storage](#add-a-nextcloud-storage-to-a-project) | Add your Nextcloud storage to a project |
| [Nextcloud and project folders](#project-folders) | Edit and delete an existing storage |
| [Edit and delete Nextcloud storage](#edit-an-existing-Nextcloud-storage) | Edit and delete an existing storage |
| [Add OneDrive/SharePoint storage to a project](#add-a-onedrive/sharepoint-storage-to-a-project-(enterprise-add-on)) | Add your OneDrive/SharePoint storage to a project |
## Activate File Storages module
Once you are certain that an administrator has set up a file storage integration (Nextcloud or OneDrive/SharePoint), navigate to any existing project in your OpenProject instance and click on **Project settings** **→ Modules**. There, activate the **File Storages** module by clicking on the checkbox next to it and then clicking on **Save**.
Once you are certain that an administrator has set up a file storage integration (Nextcloud or OneDrive/SharePoint),
navigate to any existing project in your OpenProject instance and click on **Project settings -> Modules**. There,
activate the **File Storages** module by clicking on the checkbox next to it and then clicking on **Save**.
![List of modules activated for a project](project-modules.png)
@@ -26,34 +31,49 @@ A new menu item **Files storages** will appear on the left side menu.
## Add a new storage to a project
Click on this new **Files storages** menu entry. It will take you to a page titled **File storages available in this project**, which will initially be empty.
Click on this new **Files storages** menu entry. It will take you to a page titled **File storages available in this
project**, which will initially be empty.
Click on **+ Storage** or the **+** icon below the table.
![List of file storages available to a project, empty](file-storages-available-in-project.png)
In the page that follows, you will be able to select one of the file storages set up by your administrator. You can select Nextcloud or OneDrive storage from the drop-down menu. If you only have one file storage set up (which is the most likely scenario), it should already be selected by default. Once the storage is selected click on the **Continue** button to proceed.
In the page that follows, you will be able to select one of the file storages set up by your administrator. You can
select Nextcloud or OneDrive/SharePoint storages from the drop-down menu. If you only have one file storage set up (
which is the most likely scenario), it should already be selected by default. Once the storage is selected click on the
**Continue** button to proceed.
![Select the desired storage](storage-add-new.png)
## Add a OneDrive/SharePoint storage to a project (Enterprise add-on)
> **Note**: OneDrive/SharePoint integration is an Enterprise add-on and can only be used with [Enterprise cloud](../../../enterprise-guide/enterprise-cloud-guide/) or [Enterprise on-premises](../../../enterprise-guide/enterprise-on-premises-guide/). An upgrade from the free Community edition is easy and helps support OpenProject.
> **Note**: OneDrive/SharePoint integration is an Enterprise add-on and can only be used
> with [Enterprise cloud](../../../../enterprise-guide/enterprise-cloud-guide/)
> or [Enterprise on-premises](../../../../enterprise-guide/enterprise-on-premises-guide/). An upgrade from the free
> Community edition is easy and helps support OpenProject.
If you have selected the OneDrive/SharePoint option in the previous step, your OneDrive/SharePoint storage will be added to the project and you can start using it right away.
If you have selected the OneDrive/SharePoint option in the previous step, your OneDrive/SharePoint storage will be added
to the project and you can start using it right away.
Please refer to the [OneDrive/SharePoint user guide](../../../file-management/onedrive-integration) for further instructions.
## Add a Nextcloud storage to a project
If you have selected the Nextcloud option in the previous step of storage selection, you will now see the **Project folder** options.
If you have selected the Nextcloud option in the previous step of storage selection, you will now see the **Project
folder** options.
### Project folders
In the last step of the process, you will be able to choose which kind of project folder will be the default folder for file uploads for this project:
In the last step of the process, you will be able to choose which kind of project folder will be the default folder for
file uploads for this project:
1. **No specific folder**: By default, each user will start at their own home folder when they upload a file.
2. **New folder with automatically managed permissions**: This will automatically create a folder for this project and manage the access permissions for each project member. Each project member will automatically get read, write and share access permissions (according to defined [File storages permissions](../../../../system-admin-guide/users-permissions/roles-permissions/#permissions) in the project) to this folder. This option will only be available if the system administrator has [set up the storage with automatically managed folders](../../../../system-admin-guide/integrations/nextcloud/).
2. **New folder with automatically managed permissions**: This will automatically create a folder for this project and
manage the access permissions for each project member. Each project member will automatically get read, write and
share access permissions (according to
defined [File storages permissions](../../../../system-admin-guide/users-permissions/roles-permissions/#permissions)
in the project) to this folder. This option will only be available if the system administrator
has [set up the storage with automatically managed folders](../../../../system-admin-guide/integrations/nextcloud/).
3. **Existing folder with manually managed permissions**: Once you selected this option, you can designate an existing folder as the project folder for this project using the button **Select folder**. The permissions are however not automatically managed. The administrator needs to manually ensure relevant users have access. The selected folder can be used by multiple projects.
![Select the project folder type](storage-add-project-folder.png)
@@ -64,12 +84,15 @@ Click on **Add** to add your new Nextcloud file storage to this project.
The Nextcloud file storage is now available to all work packages in this project.
> **Note:** For information on how to use the file storage (link Nextcloud user accounts at a user level, link files to a work package, view and download linked files, unlink files), please read our [Nextcloud integration user guide](../../../nextcloud-integration/).
> **Note:** For information on how to use the file storage (link Nextcloud user accounts at a user level, link files to
> a work package, view and download linked files, unlink files), please read
> our [Nextcloud integration user guide](../../../file-management/nextcloud-integration/).
### Project folder member connection status
As a project administrator you can see which of the project members have access to the automatically managed folders for Nextcloud integration. To see the list of users click on the users icon on the right side of the list.
As a project administrator you can see which of the project members have access to the automatically managed folders for
Nextcloud integration. To see the list of users click on the users icon on the right side of the list.
![Open a list of project members](storage-list-members.png)
@@ -79,22 +102,28 @@ You will see which project members have have successfully connected and who may
### Edit an existing Nextcloud storage
To edit an existing Nextcloud storage, you can click on the edit icon on the right side of the list of project storages.
To edit an existing Nextcloud storage, you can click on the edit icon on the right side of the list of project storages.
![List of project storages, edit or delete](storage-list-edit-delete.png)
For the moment, you will only be able to edit which project folder type is used for that specific storage in this project. Don't forget to click the **Save** button to edit your storage.
For the moment, you will only be able to edit which project folder type is used for that specific storage in this
project. Don't forget to click the **Save** button to edit your storage.
![Edit the project folder type](storage-edit.png)
> **Note:** If the previously selected project folder type was **New folder with automatically managed permissions**, changing the project folder type will not delete the already created project folder.
> **Note:** If the previously selected project folder type was **New folder with automatically managed permissions**,
> changing the project folder type will not delete the already created project folder. Changing it back will try to
> reconnect the previously created and used project folder.
### Delete an existing file storage
### Delete an existing file storage
To edit an existing storage, you can click on the delete icon on the right side of the list of project storages.
![Delete an existing file storage in an OpenProject project](storage_delete_icon.png)
To be able to delete a storage from a project you will be asked to confirm the action by introducing the name of the storage. This action is irreversible and will remove all links from work packages of this project to files and folders of that storage. Also, in case this storage has an automatically managed project folder, it and its files will be deleted forever.
To be able to delete a storage from a project you will be asked to confirm the action by introducing the name of the
storage. This action is irreversible and will remove all links from work packages of this project to files and folders
of that storage. Also, in case this storage has an automatically managed project folder, it and its files will be
deleted forever.
![Delete a storage from a project](storage-delete.png)
docs/user-guide/work-packages/edit-work-package/README.md
+10 -8
View File
@@ -8,13 +8,13 @@ keywords: edit work packages
# Edit work packages
| Feature | Documentation for |
| ------------------------------------------------------------ | -------------------------------------------------- |
| [Update a work package](#update-a-work-package) | How to make a change to an existing work package. |
| Feature | Documentation for |
|-----------------------------------------------------------------|----------------------------------------------------|
| [Update a work package](#update-a-work-package) | How to make a change to an existing work package. |
| [Attach files to work packages](#attach-files-to-work-packages) | How to manually attach files to work packages. |
| [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. |
| [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
@@ -77,11 +77,13 @@ Starting with OpenProject 13.0 you can add emojis to all text editors. Type a co
## Attach files to work packages
You can manually upload files to work packages directly under the tab **Files** in the work package detailed view. You can either attach files by dragging and dropping or by using the **+Attach files** option.
You can manually upload files to work packages directly under the tab **Files** in the work package detailed view. You
can either attach files by dragging and dropping or by using the **+Attach files** option.
![Manual attachment upload in an OpenProject work package](openproject_user_guide_wp_file_upload.png)
Under the **Files** tab you will see the list of the all previously uploaded attachments, including file names, as well as which user uploaded an attachment and when. If no files were attached yet, the list will be empty.
Under the **Files** tab you will see the list of the all previously uploaded attachments, including file names, as well
as which user uploaded an attachment and when. If no files were attached yet, the list will be empty.
You can remove an attachment by hovering over it and clicking the **Delete** icon.
lib/open_project/static/links.rb
+1 -1
View File
@@ -263,7 +263,7 @@ module OpenProject
href: 'https://www.openproject.org/docs/system-admin-guide/integrations/nextcloud/'
},
one_drive_setup: {
href: 'https://www.openproject.org/docs/system-admin-guide/integrations/onedrive/'
href: 'https://www.openproject.org/docs/system-admin-guide/integrations/one-drive/'
},
nextcloud_oauth_application: {
href: 'https://apps.nextcloud.com/apps/integration_openproject'