Content
View differences
Updated by Niels Lindenthal over 4 years ago
**As a** Nextcloud user
**I want to** see all work packages on OpenProject that are linked to a file
**so that** I
* can know the status of the file in workflows (work package status, (needs clarification))
* know which work packages refer to the file, so I know where/how it is used
* can easier locate and navigate to connected information in OpenProject
## Example use cases
* I have a labour contract in a writing app that stores the file in Nextcloud and I want to know if the manager has approved the conditions.
* There is a new security guideline that is relevant to the specification of a new feature and I want to know where this guideline is used so that I can estimate the impact on the project.
* I have updated a file and want to update the status of the related work package to communicate the current progress; the link helps me easily and confidently find the correct work package quickly.
## Implementation considerations
* The implementation on the OpenProject end is described in epic #40228 ("In OpenProject: A Nextcloud split-screen tab that shows files related to a work package").
* On the Nextcloud end, the details split-screen will have a new "OpenProject" tab that shows linked work packages and allows the user to search for new work packages to link
## The OpenProject tab
The OpenProject tab is added systematically to the right-side details pane, after "Versions".
By default, when no links have been established with work packages, this pane contains just a search bar and an empty-state message, "No OpenProject links yet. To add a link, use the search bar above to find the desired work package."
**Adding a link to a work package**
To link the current file to a work package in OpenProject, the user has to first simply locate the correct work package via the search bar.
A drop-down displays a list of work packages corresponding to the search term. Each search result item will contain:
* Project name
* Work package type
* Status
* Author
* Title/subject
**Open question**: would displaying the work package #ID be important to add to the list of attributes displayed in the search result?
Clicking on a work package dismisses the drop-down and adds that work package to the work package list (where the empty-state message was). A user may add links to additional work packages in the same manner.
**Actions on existing links**
The user may interact with existing links to work packages in a limited manner. They may:
* Click on the work package to open it in a new tab
* Right click on it and, in the context menu that appears:
* _Open in OpenProject_ (which does the same thing as clicking on the work package)
* _Delete link_, which simply removes the link with the selected work package
## Link symmetry
Adding a link to a work package on NextCloud automatically also adds one on the OpenProject end. Doing the same on OpenProject will also automatically add a link here. This symmtery is always maintained.
For details on how a link should appear on OpenProject, refer to epic #40228.
## Out of scope
* Creation of OpenProject work packages from inside Nextcloud
* Automatically manage permissions by actions in OpenProject. All permissions in Nextcloud are set manually.
## Visuals
_An "empty" OpenProject tab in Nextcloud_
<figure class="image op-uc-figure"><div class="op-uc-figure--content"><img class="op-uc-image" src="/api/v3/attachments/24009/content"></div></figure>
_Searching for a work package to link to_
<figure class="image op-uc-figure"><div class="op-uc-figure--content"><img class="op-uc-image" src="/api/v3/attachments/24010/content"></div></figure>
_Displaying work packages linked to the selected file_
<figure class="image op-uc-figure"><div class="op-uc-figure--content"><img class="op-uc-image" src="/api/v3/attachments/24011/content"></div></figure>
## Figma prototype
[https://www.figma.com/file/gtLQfPe09X7XugAH8L7dTy/?node-id=24%3A3374](https://www.figma.com/file/gtLQfPe09X7XugAH8L7dTy/?node-id=24%3A3374)
**I want to** see all work packages on OpenProject that are linked to a file
**so that** I
* can know the status of the file in workflows
* know which work packages refer to the file, so I know where/how it is used
* can easier locate and navigate to connected information in OpenProject
## Example use cases
* I have a labour contract in a writing app that stores the file in Nextcloud and I want to know if the manager has approved the conditions.
* There is a new security guideline that is relevant to the specification of a new feature and I want to know where this guideline is used so that I can estimate the impact on the project.
* I have updated a file and want to update the status of the related work package to communicate the current progress; the link helps me easily and confidently find the correct work package quickly.
## Implementation considerations
* The implementation on the OpenProject end is described in epic #40228 ("In OpenProject: A Nextcloud split-screen tab that shows files related to a work package").
* On the Nextcloud end, the details split-screen will have a new "OpenProject" tab that shows linked work packages and allows the user to search for new work packages to link
## The OpenProject tab
The OpenProject tab is added systematically to the right-side details pane, after "Versions".
By default, when no links have been established with work packages, this pane contains just a search bar and an empty-state message, "No OpenProject links yet. To add a link, use the search bar above to find the desired work package."
**Adding a link to a work package**
To link the current file to a work package in OpenProject, the user has to first simply locate the correct work package via the search bar.
A drop-down displays a list of work packages corresponding to the search term. Each search result item will contain:
* Project name
* Work package type
* Status
* Author
* Title/subject
**Open question**: would displaying the work package #ID be important to add to the list of attributes displayed in the search result?
Clicking on a work package dismisses the drop-down and adds that work package to the work package list (where the empty-state message was). A user may add links to additional work packages in the same manner.
**Actions on existing links**
The user may interact with existing links to work packages in a limited manner. They may:
* Click on the work package to open it in a new tab
* Right click on it and, in the context menu that appears:
* _Open in OpenProject_ (which does the same thing as clicking on the work package)
* _Delete link_, which simply removes the link with the selected work package
## Link symmetry
Adding a link to a work package on NextCloud automatically also adds one on the OpenProject end. Doing the same on OpenProject will also automatically add a link here. This symmtery is always maintained.
For details on how a link should appear on OpenProject, refer to epic #40228.
## Out of scope
* Creation of OpenProject work packages from inside Nextcloud
* Automatically manage permissions by actions in OpenProject. All permissions in Nextcloud are set manually.
## Visuals
_An "empty" OpenProject tab in Nextcloud_
<figure class="image op-uc-figure"><div class="op-uc-figure--content"><img class="op-uc-image" src="/api/v3/attachments/24009/content"></div></figure>
<figure class="image op-uc-figure"><div class="op-uc-figure--content"><img class="op-uc-image" src="/api/v3/attachments/24010/content"></div></figure>
<figure class="image op-uc-figure"><div class="op-uc-figure--content"><img class="op-uc-image" src="/api/v3/attachments/24011/content"></div></figure>
## Figma prototype
[https://www.figma.com/file/gtLQfPe09X7XugAH8L7dTy/?node-id=24%3A3374](https://www.figma.com/file/gtLQfPe09X7XugAH8L7dTy/?node-id=24%3A3374)