BIM User Guide - BCF Management & IFC Viewer (#10009)

[#40273] Create BIM documentation

https://community.openproject.org/work_packages/40273

* BIM User Guide - BCF Management & IFC Viewer

* Update README.md

* Changes BIM documentation

* Überarbeitung Doku (v.a. Aufgaben für Valenting)

* BIM Doku - Revit Addin

* Update BIM Documentation

* Deleting overview tables

* Small updates to the BIM guide

Co-authored-by: bpetraus <bernd.petraus@tmm-group.de>
Co-authored-by: birthe <b.lindenthal@openproject.com>

docs/bim-guide/README.md

@@ -0,0 +1,150 @@
+---
+sidebar_navigation:
+  title: BIM Guide
+  priority: 975
+description: User guide for the OpenProject BIM Edition.
+robots: index, follow
+keywords: BIM user guide
+---
+# BIM user guide
+
+Welcome to the OpenProject user guide for Building Information Modeling (BIM) with OpenProject.
+
+On top of the general project management functionalities, OpenProject BIM enables construction teams to better plan, communicate and collaborate in their building projects. OpenProject BIM includes a 3D model viewer (IFC viewer), support of the BIM collaboration format (BCF) for BIM issue management, and much more powerful features, e.g. a [Revit integration](/revit-add-in).
+
+<div class="alert alert-info" role="alert">
+**Note**: This guide only covers the specific [BIM features and functionalities of OpenProject](../../bim-project-management/). To learn more about the core features for project management of OpenProject (which are included in the BIM Edition as well), please visit our [User Guide](/.../user-guide/).
+</div>
+
+![BIM Project Management](demo_project_teaser_bim.jpg)
+
+
+
+## Overview of all topics regarding the OpenProject BIM Edition
+
+OpenProject BIM Edition provides powerful features particular designed for the needs of construction industry. Please choose the topic you want to learn more about.
+
+## IFC Viewer
+
+Upload your IFC building models and show them directly in the internet browser, without any additional software.
+
+Details: [IFC-Viewer](ifc-viewer)
+
+
+
+## BIM Issue Management
+
+Create tasks directly connected to your building model, import tasks or export tasks from any other BIM application.
+
+Deails: [BIM Issue Management](bim-issue-management)
+
+
+
+## Revit Addin
+
+Stay always connected to OpenProject in realtime, show and create tasks while you're working in the Revit, using the Revit Addin.
+
+Details: [Revit Add-in](revit-add-in)
+
+
+
+## How to get a free trial?
+
+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?
+
+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 ***poject settings***.
+
+
+
+## Reporting bugs
+
+You found a bug? Please [report it](https://docs.openproject.org/development/report-a-bug) to our [OpenProject community](https://community.openproject.com/projects/revit-add-in). Thank you!
+
+
+
+## BIM FAQs
+
+
+
+### Can OpenProject features be used within the OpenProject BIM Edition?
+
+Yes, you are able to use all known features. Within our BIM Edition you get the full functionality and additionaly some features only for the building industry.
+
+
+
+### Is it possible to switch my existing OpenProject Installation to the BIM Edition?
+
+Yes, an existing OpenProject on-premises (self-hosted) installation can easily be switched to the BIM Edition without loosing your settings and projects.
+
+In our [Installation & Upgrade Guide](/.../installation-and-operations/changing-to-bim-edition) you can find a description how to switch.
+
+
+
+### Is OpenProject BIM compatible to other BIM Software?
+
+Yes of course. We are of the opinion that the full potential of the BIM method only works through collaboration and the exchange of information (openBIM). For this reason we support the open BCF XML Standard. You are able to import and export all created BCF and stay interoparable with any other BCF software.
+
+
+
+### Why do I need a Revit Add-In?
+
+You don't need it, but it makes your BIM Issue Management much easier. The *OpenProject Revit Add-In* allows you to use the open source project management software *OpenProject BIM* directly within your Autodesk Revit environment. It lets you create, inspect and manage issues right in the moment when you can also solve them - when you have your Revit application fired up and the relevant BIM models open. Issues get stored as BIM Issues centrally and are available to every team member in real time - thanks to our browser based IFC viewer even to those team members without expensive Revit licenses. No BCF XML import/export is needed. However, you still can import and export BCF XML as you like and stay interoparable with any other BCF software.
+
+
+
+### Are there any System Requirements for the Revit Add-In?
+
+The OpenProject Revit Add-In does not have any special system requirements. Only a supported [version of Autodesk Revit](#which-versions-of-Revit-are-supported?) must be installed. 
+
+
+
+### Which versions of Revit are supported?
+
+The OpenProject BIM Addin for Revit supports the following versions:
+
+- REVIT 2019 
+- REVIT 2020 
+- REVIT 2021
+
+
+
+### Is it possible to use OpenProject BIM without REVIT?
+
+Yes! The Revit Add-In is just additional to the OpenProject BIM core functionality. It's still possible to import and export BCF XML as you like and stay interoparable with any other Software for BIM Issue Management.
+
+
+
+### Are integrations with other BIM software planned?
+
+Yes, we want to develop some other integrations to stay interoparable with other BIM software and make BIM Issue Management with OpenProject BIM much easier.
+
+
+
+### 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. 
+
+*The BCF Module is an OpenProject BIM Premium function. Please make sure, that you are already using the OpenProject BIM Edition ([switch to the BIM Edition](/.../installation-and-operations/changing-to-bim-edition))*
+
+ 
+
+### Why can't I see a building model?
+
+There are many potential reasons why you can't see your building model. Please check out the most common reasons and their solution:
+
+- BCF Module could be disabled ([How to enable a module](/.../user-guide/projects/project-settings/modules/))
+- Building model is hidden in Model hierarchy (check within the [IFC Model Tree](/ifc-viewer/#show-or-hide-elements-or-models))
+- Building model is completely sliced ([clear all slices](/ifc-viewer/#slice) within the model viewer toolbar)
+- IFC file isn't uploaded yet or is invalid (please check the status of the uploaded file within the [IFC Model management area](.../ifc-viewer/#import-and-export-ifc-models)).
+- IFC file does not have any geometry (please check if your IFC file has some geometry)
+
+
+
+### Where to find the Version of my Revit AddIn?
+
+To see which version of the Revit AddIn you are currently using, navigate to the OpenProject tab in the Revit taskbar and open the settings. Here you can see which version you are currently using.
+

docs/bim-guide/bim-issue-management/README.md

@@ -0,0 +1,249 @@
+---
+sidebar_navigation:
+  title: BIM Issue Management
+  priority: 200
+description: How to use OpenProject BIM Issue Management.
+robots: index, follow
+keywords: BIM, BCF, IFC, BIM Issue Management, BCF-Management
+---
+
+# BIM Issue - Management (BIM feature)
+
+Within the *BCF-Module* you are able to manage *BIM Issues (BCF)*. All BIM Iccues get stored as BCFs centrally and are available to every team member in real time. Below you find the most important features how to use the BCF Module to create, inspect and manage issues. 
+
+
+
+## What is a BIM Issue?
+
+A BIM Issue is a special kind of work package to communicate directly within the building model. It supports you to solve problems and coordinate the planning phase in a building project.
+
+The BIM Issue is not only a description of a problem, the view of the building model is stored within the issue as well. This includes the current selection, view , rotation & zoom of the model.
+
+OpenProject BIM supports the standard of the ***BIM Collaboration Format (BCF)***. All BIM Issues which are created within another *Open BIM* Software can be imported to work with this issue within our project management solution. 
+
+
+
+## Create a BIM Issue
+
+To create a BIM Issue you don't have to configure a new type of work package. Every work package (e.g. Task, Issue, Milestone, ... ) can become a BIM Issue only by adding a viewpoint to the work package. 
+
+There are two ways to create new BIM Issue:
+
+- [Create a new BIM Issue](#create-a-new-bim-issue) within the building model
+- Add a viewpoint to an existing work package (doesn't matter which type)
+
+BIM-Issues always belong to a project and a building model. Therefore, you first need to [select a project](https://www.openproject.org/docs/getting-started/projects/#open-an-existing-project) and upload an IFC file to see the building .
+
+Then, navigate to the BCF module in the project navigation.
+
+
+
+![BCF-Module](OpenProject_BCF_Module.png)
+
+
+
+### Create a new BIM Issue
+
+To create new BIM Issues, you have to open the Model - Viewer first and create the view you want to save within the BIM Issue (e.g. zoom, [rotate](...\ifc-viewer\#how-to-rotate-the-building-model?), [slice](...\ifc-viewer\#how-to-slice-the-building-model?), [select](...\ifc-viewer\#how-to-select-elements?), [hide](...\ifc-viewer\#show-or-hide-elements-or-models), ... ). 
+
+Click on the **+ Create new work package** and select the type of workpackage you want. 
+
+![Create a new BIM Issue](create-a-new-BIM-issue.png)
+
+
+
+Now you can see a detail view of the new Issue. Describe all necessary information to work on that task and add a viewpoint by clicking on the **"+ Viewpoint"**-Button. Now the current Viewpoint of the Building Model is added to the Issue. After saveing your new BIM issue is created.
+
+*Within the viewpoint the current status of your building model is saved. So please check the view before - is there everything shown within the model viewer?*
+
+![Create a viewpoint](Create-a-viewpoint.png)
+
+
+
+You also have the option of adding multiple viewpoints to a work package. Rotation, selection and visibility can be changed for every viewpoint to get a better model based communication.
+
+![Adding multiple viewpoints](adding-multiple-viewpoints.png)
+
+
+
+### Add a viewpoint to an existing work package
+
+The workflow of adding a viewpoint to an existing work package is similar to creating a new BIM Issue. To switch an existing work package to a BIM Issue just follow the steps:
+
+Open the **BCF-Module** to see the building model.
+ ![BCF Module](bcf_module.png)
+
+
+
+Make sure the "Model Viewer & Maps" - View or "Model Viewer & Table" - View is selected within the **OpenProject-Toolbar**.
+
+![Model and workpackage view](model_maps_view.png)
+
+
+
+Now open the **work package Details** by double click on the work package ("my first work-package"). Now you are able to add a viewpoint like it is described above.
+
+
+
+
+## BIM Issue Handling (Details View)
+
+The handling of BIM Issues is similar to the handling of work packages (including configuration of the attribute). To jump to a viewpoint of an existing BIM Issue the model viewer has to be activated (visible in the center of your screen) or you have to open the detail view of the work package.
+
+
+
+
+### Jump to a Viewpoint with the Details View
+
+If the Model viewer isn't shown yet, open the Detail - view of the BIM Issue and follow the Cube symol of the preview. Now the model viewer opens and the viewpoint of the BIM Issue will be displayed.
+
+![Display BIM Issue](display_bim_issue.png)
+
+
+
+
+
+### Switch between different Viewpoints
+
+After creating multiple BIM Issues you are able to jump between different viewpoints easily. The "Viewer and Cards" - Mode shows all of your BIM Issues. With a single click at the preview of the BIM Issue, the model viewer changes immediately. 
+
+
+
+![Switch_Viewpoints](Switch_Viewpoints.gif)
+
+
+
+### Configuration of BIM Issues
+
+To create BIM Issues you don't have to configure additional work package types. Every existing work package can become a BIM Issue by adding a viewpoint. Before you can add a viewpoint to a work package, this work package must be enabled for viewpoints in the system administration.
+
+
+
+
+## View and Find BIM Issues (Cards and List View)
+
+### Overview
+
+You can switch between different View modes within the OpenProject toolbar. Just open the dropdown menu and select the view which fits best to your situation.
+
+ ![Swicht_View_Mode](Swicht_View_Mode.gif)
+
+
+
+
+### Viewer and Cards
+
+![Viewer and Cards](Viewer_and_Cards.png)
+
+
+
+The detail view of every work package can be shown by different user actions. To open the viewpoint and see the description in the details view, just double click at the BIM Issue in the card view. After double click your current viewpoint in the model viewer will be reset and the viewpoint of the BIM Issue including all details will be displayed.  
+
+To view only the detail view of the BIM issue without resetting the current view of the model, you can click on the work package number ("#...") or the "information icon" on the card.
+
+
+
+### Cards Mode
+
+Within the cards view you are not able to jump directly to a viewpoint. First you have to open the details view by using the "information icon" or the work package number ("#...") at the card. There you can find the "Cube" which leads you to the viewpoint within the appearing model viewer.  
+
+![Cards Mode](Cards-mode.png)
+
+
+
+
+
+
+### Viewer and Table
+
+To open the BIM Issue in this mode just click at the work package in the table. By double click at the BIM Issue the viewpoint will be shown and the details will appear. The details of each work package can be shown without changing the current view of the model by single click at the work package ID.
+
+![Viewer and Table](viewer-and-table.png)
+
+
+
+
+
+### Table
+
+Within the table view you are not able to jump directly to a viewpoint. First you have to open the details view by using the "information icon" or the work package number ("#...") or double click at the work package. At the details view you can find the "Cube" which leads you to the viewpoint within the appearing model viewer.  
+
+![Table](table.png)
+
+
+
+
+
+
+## Filter BIM Issues
+
+You are able to filter BIM Issues by using the filter button in the **OpenProject toolbar**. The filter is usable in every view.
+
+![OpenProject Toolbar](OpenProject-toolbar.png)
+
+
+
+![Filter BIM Issue](Filter-BIM-Issue.png)
+
+
+
+
+## BIM Issues in Workpackage Module
+
+BIM Issues are also listed in the workpackage module. This supports you to manage your building project in the best way and get an overview of all issues. To separate work packages and BIM Issues we created a new filter which enables you to filter BIM Issues.
+
+![BIM Issues and work packages](bim-issues-and-work-packages.png)
+
+
+
+
+
+
+## Import and Export BCF Issues using BCF
+
+Within the BCF module you are able to upload BIM Issues which are created within other software and download already existing files to manage them within other BIM project management solutions. Just Click on the ***"Import"-Button*** or ***"Export"-Button*** within the OpenProject Toolbar. 
+
+
+
+### Import of Attributes
+
+After importing a BCF Issue (or multiple Issues at the same time) from another software, OpenProject will match existing attributes and types of the work package. 
+
+If attributes of the imported BCF Issue can't be matched automatically (because they are not available within your project configuration), you are able to synchronize the values manually.
+
+![Import BCF](import-bcf.png)
+
+
+
+**Currently the following attributes can be synchronized and matched:**
+
+- Title & Description
+- Priority
+- Type (e.g. Clash)
+- Status
+- Viewpoint
+- Creation Date
+- Creation Author
+- Modified Date
+- Modified Author
+- Assignee
+- Due Date
+- Comments
+
+
+
+After a successful matching of the attributes the topics will be displayed in OpenProject. 
+
+![Successfull BCF Import](successfull-bcf-import.png) 
+
+
+
+![Imported BCF Issues](imported-bcf-issues.png)
+
+
+
+### Outdated BCF Issues
+
+If there are more recent changes to the work package in OpenProject than in the imported BCF ("ModifiedDate"), the import will be rejected.     
+
+![Outdated BCF Issues](outdated-bcf-issues.png)

docs/bim-guide/ifc-viewer/README.md

@@ -0,0 +1,260 @@
+---
+sidebar_navigation:
+  title: Revit Add-in
+  priority: 300
+description: How to use the OpenProject IFC-Viewer.
+robots: index, follow
+keywords: BIM, BCF, IFC, Viewer
+---
+
+# IFC-Viewer (BIM feature)
+
+OpenProject BIM includes a very powerful IFC viewer to show and interact with building models in 2D & 3D.
+
+IFC-Files can be uploaded and shown directly within your Web-Browser without installing any additional software on your computer. 
+
+## Basics
+
+The BCF Module has included a very powerful IFC viewer. Here is a short overview of available user actions:
+
+![IFC Viewer Overview](ifc-viewer-overview.png)
+
+
+
+1. **IFC Model Viewer** to have a look at the building model directly within OpenProject BIM.
+2. **IFC Model Tree** to see the IFC Model Structure and show / hide elements.
+3. The **OpenProject toolbar** shows the most important user actions like createing new (BIM) issues, Import & Export BCF files, Change OpenProject View and upload & download IFC-Models 
+4. The **View Cube** to rotate the building model.
+5. The **IFC-Viewer toolbar** to interact with the building model (e.g. change perspective, hide/ show elements, select elements & slice the building model)
+
+
+
+## Import and Export IFC Models
+
+Within the BCF module you are able to manage your IFC files. You are able to upload new building models and download already existing files. Just Click on the ***"IFC-Models"-Button*** within the OpenProject Toolbar. 
+
+
+
+![Import and Export IFC Models](import-and-export-ifc-models.png)
+
+
+
+To upload your first IFC model click on the green "+ IFC Model" - Button. A new explorer Window will be opened. Just navigate to the folder where your latest building model is saved.
+
+![Import IFC Model](import-ifc-model.png)
+
+
+
+Select the file you want and confirm your upload. You also the choice to set the new model as "Default model". All default models (multiple models can be set as default) are initially shown if you relaod the BCF module. You are able to change this setting later as well.
+
+![Set Model as Default](set-model-as-default.png)
+
+
+
+After uploading a building model you get an overview of all models within the "model management". There you are able to see their current upload status, rename the model, delete or download the existing models.
+
+![BIM Model Management](bim-model-management.png)
+
+
+
+If there already exist a model in project, you don't have to open the "model manager" to upload other models. You are able to add more models by clicking the "Add-Button" in the IFC Model Tree.  
+
+![Add a new IFC Model](add-a-new-ifc-model.png)
+
+
+
+**Remember:** If there are multiple models you are able to hide the whole model or single elements by using the checkbox within model tree.  
+
+![Hide_Model](Hide_Model.gif)
+
+
+
+
+
+
+## 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.
+
+![Model_Rotation](Model_Rotation.gif)
+
+
+
+
+
+## IFC-Viewer toolbar
+
+The IFC-Viewer toolbar has many functions which are described below. The user actions all relate to the viewer and can be startet by clicking on the button.
+
+### Reset-View
+
+![Reset View](reset-view.png)
+
+If your building model (or objects within the model) is rotated, zoomed or cut and you want to reset your current view this function will help you. All you have to do is press the button once and your your view will be reset to the default.     
+
+![Reset_view_button](Reset_view_button.gif)
+
+
+
+### 2D / 3D View
+
+![2D View](2-d-view.png)
+
+If your building model can easily be shown in 2D or 3D. This function is very popular to have a deeper look into the building (e.g. to see the floorplan). To use this function in the best way, you are able to combine the 2D view with hiding elements (like it is shown below).
+
+![2D_3D](2D_3D.gif)
+
+
+
+### Orthographic View
+
+![Orthographic Button](orthographic-button.png)
+
+The default behavior of the OpenProject BIM Model Viewer is a perspective view. The perspective camera gives you more information about depth. Distant objects are smaller than nerby ones. This function changes from perspective view to orthographic view.  The orthographic view is widely used in engineering. All objects appear at the same scale and parallel lines remain parallel. Also a unit length appears the same length anywhere on the sceen. This makes it easier to assess the relative sizes. 
+
+![Orthographic View](orthographic-view.png)
+
+### Fit View
+
+![Fit View Button](fit-view-button.png)
+
+This function allows you to reset the current zoom level and the position of the building model. The button resets the zoom and position of the building model so that the entire model is visible and centered.
+
+![Fit View](Fit View.gif)
+
+
+
+### First Person Perspective
+
+![First Person Button](first-person-button.png)
+
+The first person perspective changes the way you ineract with the building model. The user no longer rotates the entire building model around an axis. Now he has the option of changing their own perspective. After activating the first person perspective, the viewer behaves similar to the real world and the camera moves in a manner comparable to a head movement.
+
+![First_Person_Perspective](First_Person_Perspective.gif)
+
+
+
+
+
+## How to slice the building model?
+
+![Slice Building Model](slice-building-model.png)
+
+To have a deeper look within the building model you are able to slice the whole building. To start slicing click on the "***scissors symbol***" within the ***IFC-Viewer toolbar*** and left-click on an element which has the same angle you want to slice (you can edit this angle later as well). Now there are shown some arrows. Grab one and slice the model by dragging the arrow to the location you want. 
+
+![Slice building model](Slice_building.gif)
+
+
+
+## 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***.
+
+![slice-building-model](slice-building-model.png)
+
+
+
+![Clear slices](clear_slices.png)
+
+
+
+
+
+## How to select elements?
+
+To select elements within the building model, you have to activate the selection mode by clicking on the highlighted toogle 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).
+
+![Select Elements Button](select-elements-button.png)
+
+
+
+![Select Elements](Select_elements.png)
+
+
+
+## Show Properties
+
+You are able to see the basic properties of each element (e.g. the UUID) within OpenProject BIM. After using the "information" buttion a new tab named "Properties" will appear. 
+
+![Show Properties Button](show-properties-button.png)
+
+![Show Properties](show-properties.png)
+
+
+
+In order to inspect the information for individual objects, you have to use the context menu and simply select the "Inspect Properties" Menu item. All properties of the object will appear in the new tab.
+
+![Inspect Properties](inspect-properties.png)
+
+
+
+**But be careful!** The properties of the element you just clicked on are displayed. So make sure that there are no unwanted objects (e.g. window panes) in front of your desired object.   
+
+
+
+![Element Properties](element-properties.png)
+
+
+
+
+
+## Show or Hide elements via viewer
+
+There are two options to hide elements via viewer. The **first possibility** is to use the ***IFC-viewer toolbar***. Within the toolbar you will find the **"hide-button"** 
+
+![Hide Elements Button](hide-elements-button.png)
+
+After the "Hide-Mode" has been activated, each element you click (left click) on will be hidden.
+
+![Hide_elements_Viewer_rubber](Hide_elements_Viewer_rubber.gif)
+
+
+
+
+
+The **second possibility** to hide single elements via viewer is to use the context menu. Here you can find the function to hide single elements.
+
+![Hide Elements Context Menu](hide-elements-context-menu.png)
+
+
+
+You are always able to show hidden elements by using the **"Reset-View" Button** in the Viewer toolbar or use the **"Show All"** **Button** in the IFC Model tree. 
+
+Sometimes it is helpful to see elements in context to other elements but a good view can be disturbed by individual elements. For this case our viewer is able to show your building model in an "X-Ray"-Mode. The mode can be activated via the context menu and enables disturbing elements to be displayed in the context of other elements without covering them. 
+
+![XRay](XRay.gif)
+
+
+
+## Show Elements in Model Tree
+
+To be sure if you hide or select the element you want you are able to jump to this element in the IFC Model tree.
+
+All you have to do is open the context menu on the desired element and select the "Show in Explorer" function. Now the Model tree folds out to the desired element.
+
+
+
+![Show in Explorer](show-in-explorer.png)
+
+ 
+
+## Show or Hide models or elements via model tree
+
+If you have uploaded several IFC models of one building (e.g. one for each discipline - Architecture, Structural & MEP) and want to have a look at a single model or just want to hide specific elements, you are able to hide them by changing the status of the ***checkbox within the model tree.***
+
+The model tree can represent the structure of the building model in different ways. This means that entire models, storeys or even similar components can be hidden with a single click. 
+
+
+
+![Hide_Model](Hide_Model.gif)
+
+
+
+![Hide_building_storey](Hide_building_storey.gif)
+
+
+
+After switching to the "Classes" tab in the model tree, you can see the grouping of all elements by IFC classification. Whole groups can be hidden as well. In the example, all elements of the type "IFCWall" will be hidden.  
+
+![Hide_IFC_classes](Hide_IFC_classes.gif)
+

docs/bim-guide/revit-add-in/README.md

@@ -0,0 +1,218 @@
+---
+sidebar_navigation:
+  title: Revit Add-in
+  priority: 100
+description: How to use the OpenProject BIM - Revit AddIn.
+robots: index, follow
+keywords: BIM, BCF, IFC, Viewer
+---
+
+# Revit Add-In (BIM feature)
+
+The *OpenProject Revit Add-In* allows you to use the open source project management software *OpenProject BIM* directly within your Autodesk Revit environment. It lets you create, inspect and manage issues right in the moment when you can also solve them - when you have your Revit application fired up and the relevant BIM models open. Issues get stored as BIM Issues centrally and are available to every team member in real time - thanks to our browser based IFC viewer even to those team members without expensive Revit licenses. No BCF XML import/export is needed. However, you still can import and export BCF XML as you like and stay interoparable with any other software for BIM Issue Management.
+
+To download the latest version (v2.2.3) of our OpenProject Revit AddIn click here: [DOWNLOAD](https://github.com/opf/openproject-revit-add-in/releases/download/v2.3.3/OpenProject.Revit.exe)
+
+
+
+<div class="alert alert-info" role="alert">
+**Note**: OpenProject BIM Issue Management is a Premium Feature 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 easily possible.
+</div>
+
+
+## Before Usage
+
+Please check the following steps before useing the OpenProject BIM Edition.
+
+1. Does OpenProject BIM support your [Version of Revit](#system-requirements)?
+2. Did you already install the latest Version of our OpenProject BIM Addin?
+3. Is the latest IFC Model uploaded to your Project in OpenProject BIM?
+
+If you can answer all questions with "yes" you are ready to start using our Revit Addin.
+
+
+
+## How to install?
+
+
+
+### System Requirements
+
+The **OpenProject Revit AddIn** does not have any special system requirements. Autodesk Revit must be installed. The following versions of Revit are supported:
+
+- 2019
+- 2020
+- 2021
+
+
+
+### Download the Installer
+
+To download the setup application for the **OpenProject Revit AddIn**, click here: [DOWNLOAD](https://github.com/opf/openproject-revit-add-in/releases/download/v2.3.3/OpenProject.Revit.exe)
+
+You can find the latest version of our AddIn on [Github](https://github.com/opf/openproject-revit-add-in/releases/latest) as well.
+
+
+
+### Installation 
+
+After you have downloaded the file, please run it to start the installation process.
+
+1. **Start Installation process**
+   In the first screen, click *Next* to continue: 
+
+<img src="https://github.com/opf/openproject-revit-add-in/raw/master/docs/images/installation-step-01.png" alt="Installation Step 01" style="zoom:80%;" />
+
+
+
+2. **Select Revit Version**
+
+   Next, select the Revit version you have installed locally and click *Next* to continue. You can select multiple versions:
+
+![Installation Step 02](https://github.com/opf/openproject-revit-add-in/raw/master/docs/images/installation-step-02.png)
+
+
+
+3. **Start Installation**
+
+   Verify the installation steps are correct in the next screen and click on *Install* to install the **OpenProject Revit AddIn**:
+
+![Installation Step 03](https://github.com/opf/openproject-revit-add-in/raw/master/docs/images/installation-step-03.png)
+
+
+
+4. **Ready to use**
+
+   Please wait a few moments for the installation to complete and then click *Finish* to finish the installation.
+
+
+
+## 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.
+
+
+
+
+
+## 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.
+
+![Revit AddIn Settings](RevitAddIn_Settings.png)
+
+
+
+The settings will appear in a new tab. Within this tab you have to insert your own ***OpenProject BIM URL*** and confirm with "Go". Your OpenProject account is now linked to your Revit application and you can close the tab.
+
+![OpenProject BIM Login](OpenProject_BIM_Login.png)
+
+
+
+
+
+
+
+## How to select a Project
+
+After connecting your OpenProject BIM instance you are able to start working with your BCF Tasks within Revit. Firstly you have to open the **OpenProject Tab** in the taskbar and start the application. 
+
+![Start OpenProject BIM Addin](OpenProject_BIM_Start.png)
+
+
+
+After starting the application a new tab will be created and you are able to select the Project you want to work in.  
+
+![OpenProject BIM - Select a Project](OpenProject_BIM_Projects.png)
+
+
+
+## Working with BIM Issues
+
+To work with BIM Issues, please open our AddIn and navigate to our BCF Module. 
+
+![OpenProject BIM - BCF Module](OpenProject_BIM_BCF_Module.png)
+
+
+
+Within this module all existing work packages are displayed. Within this demo project doen't exist any work package yet. To create a new one, click on the "add new workpackage"-Button.  
+
+![OpenProject BIM - Create BCF](OpenProject_BIM_Create_BCF.png)
+
+
+
+An empty form for new work packages is now displayed. After adding a title and detailed information describing your issue, you have to add a viewpoint. This viewpoint saves your current view & selection of the building model (so check the rotation, selection and zoom of the model before). 
+
+And the most important thing: **don't forget to save** the work package.
+
+![OpenProject BIM - Add Viewpoint](OpenProject_BIM_Add_Viewpoint.png)
+
+
+
+
+
+To open a BIM Issue and restore the viewpoint you have to navigate to the BCF Module and just click on the BIM Issue you want to open. The behavior of working with the issues is almost the same like in OpenProject.
+
+![OpenProject BIM - Issues](OpenProject_BIM_Issues.png)
+
+
+
+The handling of BIM Issues within Revit is similar to OpenProject BIM. There are only a few changes to the browser based version:
+
+- **Model Viewer**: To show a BIM Issue OpenProject BIM will use your Revit Model instead of the OpenProject BIM Model Viewer.
+- **Reduced View**: OpenProject BIM is now used in a smaller window. That's why you are currently using a reduced view.
+- **Missing Browser Toolbar**: The Browser Toolbar is missing, so you might miss some common user actions (e.g. jump to previous page) 
+
+
+
+
+
+## Synchronize Tasks between Revit and OpenProject
+
+OpenProject BIM and Revit automatically synchronize all BIM work packages. You don't have to pay attention to anything else and you can manage your entire project directly in OpenProject. Whatever you do, users of OpenProject BIM Edition will see any changes in the browser as well.  
+
+
+
+![OpenProject BIM - Synchronization](OpenProject_BIM_Synchronization.png)
+
+
+
+
+
+
+
+
+
+## How to uninstall the OpenProject Revit AddIn?
+
+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.
+
+
+
+## Troubleshooting
+
+### 'Your computer was protected by Windows' Error Message
+
+This is an internal Windows defense mechanism called *Windows SmartScreen*. When you run the installer, you might see a message similar to this:
+
+<img src="https://github.com/opf/openproject-revit-add-in/raw/master/docs/images/installer-smart-screen-01.png" alt="Installer Windows SmartScreen 01" style="zoom:80%;" />
+
+
+
+This can happen when a new release was not yet installed by many users, so internal Microsoft services do not yet know about the trustworthiness of the **OpenProject Revit AddIn** version.
+
+To continue, please click on the highlighted part labeled *Additional Information*, then you should see a screen like the following:
+
+<img src="https://github.com/opf/openproject-revit-add-in/raw/master/docs/images/installer-smart-screen-02.png" alt="Installer Windows SmartScreen 02" style="zoom:80%;" />
+
+
+
+Ensure that publisher says *OpenProject GmbH*. That means the installer was correctly signed by OpenProject and is safe to use.
+
+To proceed with the installation, click on *Run Anyway* and the installation will start.
+
+
+
+## Reporting bugs
+
+You found a bug? Please [report it](https://docs.openproject.org/development/report-a-bug) to our [OpenProject community](https://community.openproject.com/projects/revit-add-in). Thank you!