---
version: "V0"
language: "en"
---
# dRofus Help \& Learning
## Guidelines
*
### [Get Started](https://help.drofus.com/en/English/Learning/get-started.md)
* [dRofus Data model](https://help.drofus.com/en/English/Learning/drofus-data-model.md)
* [Open in dRofus Web](https://help.drofus.com/en/English/Learning/open-in-drofus-web.md)
* [Find your data](https://help.drofus.com/en/English/Learning/find-data.md)
* [Quick tips](https://help.drofus.com/en/English/Learning/quick-tips.md)
* [General information on utilisation of the program](https://help.drofus.com/en/English/Learning/get-up-and-running.md)
* [1 more pages](https://help.drofus.com/en/English/Learning/get-started.md)
*
### [Learn about dRofus](https://help.drofus.com/en/English/Learning/learn-about-drofus.md)
* [Demonar](https://help.drofus.com/en/English/Learning/demonar.md)
* [Workflows](https://help.drofus.com/en/English/Learning/workflows.md)
* [dRofus and TFM (Norwegian standard)](https://help.drofus.com/en/English/Learning/drofus-and-tfm-norwegian-standard.md)
* [Trial Package (Australia)](https://help.drofus.com/en/English/Learning/trial-package.md)
*
### [What's New](https://help.drofus.com/en/English/Learning/what-s-new.md)
* [Release Notes](https://help.drofus.com/en/English/Learning/release-notes.md)
* [dRofus End of Life Features](https://help.drofus.com/en/English/Learning/drofus-end-of-life-policy.md)
*
### [dRofus Modules](https://help.drofus.com/en/English/Learning/drofus-modules.md)
* [Room and Room Templates Module](https://help.drofus.com/en/English/Learning/room-and-room-templates-module.md)
* [Items Module](https://help.drofus.com/en/English/Learning/items-module.md)
* [Systems Module](https://help.drofus.com/en/English/Learning/systems-module.md)
* [Document Module](https://help.drofus.com/en/English/Learning/document-module.md)
* [ReqHub](https://help.drofus.com/en/English/Learning/reqhub.md)
* [5 more pages](https://help.drofus.com/en/English/Learning/drofus-modules.md)
*
### [dRofus WEB](https://help.drofus.com/en/English/Learning/drofus-web.md)
* [WEB introduction video](https://help.drofus.com/en/English/Learning/drofus-web-introduction.md)
* [WEB Access](https://help.drofus.com/en/English/Learning/web-access.md)
* [WEB - Usage](https://help.drofus.com/en/English/Learning/web-usage.md)
* [dRofus AEC Data Sync](https://help.drofus.com/en/English/Learning/drofus-aec-data-sync.md)
* [Account App](https://help.drofus.com/en/English/Learning/account-app.md)
*
### [dRofus Integrations](https://help.drofus.com/en/English/Learning/3d-models-and-drofus.md)
* [Revit Add-On](https://help.drofus.com/en/English/Learning/02-revit-add-on.md)
* [ArchiCAD Add-On](https://help.drofus.com/en/English/Learning/archicad-add-on.md)
* [Solibri Extension](https://help.drofus.com/en/English/Learning/solibri-extension.md)
* [IFC and BIM](https://help.drofus.com/en/English/Learning/ifc-and-bim.md)
*
### [Data - Import, validation, Export and Exchange](https://help.drofus.com/en/English/Learning/data-import-validation-export-and-exchange.md)
* [Export and Exchange data](https://help.drofus.com/en/English/Learning/export-and-exchange-data.md)
* [Documentation and Images](https://help.drofus.com/en/English/Learning/documentation-and-images.md)
* [Import and Update Data](https://help.drofus.com/en/English/Learning/import-and-update-data.md)
* [Logs](https://help.drofus.com/en/English/Learning/logs.md)
* [Validation](https://help.drofus.com/en/English/Learning/validation.md)
*
### [Administration](https://help.drofus.com/en/English/Learning/administration.md)
* [Introduction to Administration](https://help.drofus.com/en/English/Learning/introduction-to-administration.md)
* [Administration Settings](https://help.drofus.com/en/English/Learning/administration-settings-desktop-application.md)
* [Administration System](https://help.drofus.com/en/English/Learning/web-administration-system.md)
* [Admin Settings Revit Add-On](https://help.drofus.com/en/English/Learning/admin-settings-revit-add-on.md)
* [Technical Architecture and Installation of dRofus Server](https://help.drofus.com/en/English/Learning/technical-architecture-and-installation-of-drofus-.md)
*
### [API](https://help.drofus.com/en/English/Learning/api.md)
* [Admin system REST API](https://help.drofus.com/en/English/Learning/admin-system-rest-api.md)
* [dRofus REST API](https://help.drofus.com/en/English/Learning/drofus-rest-api.md)
* [Integrate web property panel in your application](https://help.drofus.com/en/English/Learning/integrate-web-property-panel-in-your-application.md)
*
### [User support](https://help.drofus.com/en/English/Learning/user-support.md)
* [FAQs](https://help.drofus.com/en/English/Learning/faqs.md)
* [dRofus desktop Help Menu](https://help.drofus.com/en/English/Learning/help-menu.md)
* [Troubleshoot](https://help.drofus.com/en/English/Learning/troubleshoot.md)
---
version: "V0"
language: "en"
---
# Revit Add-On
Revit Add-On allows for the integration of program data with designs, enabling the validation of building requirements and bidirectional synchronization between dRofus and project models.
[Welcome Series BIM - Lesson 3.mp4](https://help.drofus.com/__attachments/a_94d77c0a4f4905088237996aea95a6b4cbd13bee84c8c59f12648b7389d2ddca/Welcome%2520Series%2520BIM%2520-%2520Lesson%25203.mp4.md)
Read more:
* [Revit Add-On - Get Started](https://help.drofus.com/en/English/Learning/revit-add-on-get-started.md)
* [Revit Attribute Configurations](https://help.drofus.com/en/English/Learning/revit-attribute-configurations.md)
* [Rooms, Spaces, Room Templates and Areas](https://help.drofus.com/en/English/Learning/rooms-spaces-room-templates-and-areas.md)
* [Revit Family types and dRofus Items](https://help.drofus.com/en/English/Learning/copy-items-and-revit-families.md)
* [Revit Room Finishes and Materials with Finishes Items](https://help.drofus.com/en/English/Learning/revit-room-finishes-and-materials-with-finishes-it.md)
* [Revit and Systems](https://help.drofus.com/en/English/Learning/relationship-between-revit-family-and-drofus-item.md)
* [Export IFC Model from Revit](https://help.drofus.com/en/English/Learning/export-ifc-model-from-revit.md)
* [Troubleshoot - Revit](https://help.drofus.com/en/English/Learning/troubleshoot-revit.md)
* [Workflow Revit: Link dRofus and Revit model.](https://help.drofus.com/en/English/Learning/workflow-revit-link-drofus-and-revit-model.md)
---
version: "V0"
language: "en"
---
# Add or edit Tabs
A tab is the top level in the User Interface Editor. Depending on where they are used, tabs will have slightly different appearances in the user interface. Room Data and Item Data appear at the top as clickable dividers of the content. See the highlighted area in yellow below.
Tabs in Room Data and Item Data panel
In other locations, such as Occurrence and Systems, the tabs will appear as headers in the property panels.
Tabs in the occurrence property panel.
## Create new tab
1. Select "New Tab" from the top menu. The new tab will appear below the previously selected tab.
2. Enter Tab Properties. see details below.
## Tab Properties
The following properties are linked to tabs:
|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Property** | **Explanation** |
| ID | Database unique Tab ID |
| Label | The name to be displayed in the user interface and in the reports |
| Report layout | Define how many columns to use for the Room data section in PDF reports. This can also be managed at group level (see [Add or edit Groups](https://help.drofus.com/en/English/Learning/2-add-or-edit-groups.md) ) |
ID can be helpful for custom report editors and is auto generated.
## Copy tab
When coping a tab all levels below will also be copied.
1. Select the tab intended to be copied
2. Right-click on the tab
3. Select "Copy" to copy once or select "Create Multiple Copies" to create more copies at once
4. Edit the copied tabs properties and the levels below
## Move tab
Tabs location can be changed with a click \& drag. Select the tab and drag it to desired location. Four small red dots will indicate where the tab can be moved. Your selected tab will be placed *after*the tab that are marked with the red dots.
To move several tabs in one action, press CTRL while selecting more tabs, then perform move by click \& drag.
## Delete tabs
Select one or more tabs and delete using the "Delete" option in the ribbon menu or Right click → Delete.
When deleting tabs, groups, elements, or fields in a project where the field is in use with data, users in the user interface editor will get this warning message:
Warning when deleting fields
This warning message ensures that the user interface editor is aware that the changes they make will delete data from the project.
---
version: "V0"
language: "en"
---
# Add or edit Groups
Groups are the level below tabs used to organize the location of fields within a tab in the User Interface Editor. They can contain several elements and are an important visual divider of fields in the user interface. In Room Data and Item Data, groups appear with blue headers and can have borders that visually group the elements together. See highlighted group labels below.
Groups in Room Data and Item Data panel
Group labels and borders will not be shown in the Occurrence or Systems data properties panel
## Create new group
1. Select the tab where the new group should be added to.
2. Select "New Group" in the top menu or right-click and select "New Group"
3. Enter properties. See details on additional options below.
## Properties
The following properties are linked to groups:
|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Property** | **Explanation** |
| ID | Database unique Group ID |
| Label | The name to be displayed in the user interface and in reports |
| Row position | Horizontal (row) position to the other groups |
| Column position | Vertical (column) position to the other groups. The groups are drawn by column. In other words, all the groups in column 1 are shown before those in column 2. |
| Border | Displays a frame that surrounds the underlying elements with the Group Label as a blue heading. |
| Report layout | The format the group will have in PDF reports, See format types below. |
### Report layout
The appearance of the PDF report is managed via the *Report Layout* option. The following options can be selected:
|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
| **Type** | **Explanation** |
| group | Designed to show all fields in an element in the same row. Fields will be displayed continuously after each other for space efficiency. |
| flow-group | Same as *group* |
| value-spec | Same as *group* |
| description-group | Used by groups which comprise one large multi-line text field. The name of the **group** will be displayed in bold above the text in the fields. |
| two-column | The elements are distributed between two columns. |
| three-column | The elements are distributed between three columns. Typical for elements where there is only one field. |
| four-column | The elements are distributed between four columns. Typical for elements where there is only one field. |
| five-column | The elements are distributed between five columns. Typical for elements where there is only one field. |
| value-spec-two-column | Same as *value-spec* but in two columns. |
## Copy group
When coping a group all levels below will also be copied.
1. Select group to copy
2. Right-click
3. Select "Copy" to copy once or select "Create multiple Copies" to create more copies at once.
## Move groups
Groups can be moved to another tab using the drag and drop method. To change order of groups within a tab, use the properties "Row position" and "Column position".
To move one or many groups between tabs select the group(s) and drag them to another tab. Four small red dots will indicate where you are moving the group.
## Delete groups
Select one or more groups and delete using the "Delete" option in the top menu or Right click → Delete.
When deleting tabs, groups, elements, or fields in a project where the field is in use with data, users in the user interface editor will get this warning message:
Warning when deleting fields
This warning message ensures that the user interface editor is aware that the changes they make will delete data from the project.
---
version: "V0"
language: "en"
---
# Add or edit Elements
Elements can also be referred to as rows in the User Interface Editor. An element can contain one or more fields, which are placed after each other in a row within the same element. Elements are important for naming as they often hold a requirement's name, not the field itself.
An example row is highlighted in yellow below.
Example of the element "Protection" with three fields.
## Create new element
1. Select the group where the new element should be added
2. Select "New Element" in the top menu or right-click and select "New Element"
3. Enter Properties. See more info below.
### Properties
The following properties are linked to elements:
|--------------|----------------------------------------------------------------------------------------------------------------------------------------|
| **Property** | **Explanation** |
| ID | Database unique Element ID |
| Label | The text to be used in front of the element. |
| Help text | Help text for the field. When the user fills in the field on the Room Data screen, this will be displayed at the bottom of the screen. |
### Copy elements
When coping elements, all fields will also be copied.
1. Select element
2. Right-click
3. Select "Copy" to copy once or select "Create multiple Copies" to create more copies at once.
## Move elements
Elements can be moved between groups by using the "drag and drop" method in the tree. It is also possible to change the sequence in this way (position), and move elements from one group to another.
### Delete elements
Select one or more elements and delete using the "Delete" option in the top menu or Right click → Delete.
When deleting tabs, groups, elements, or fields in a project where the field is in use with data, users in the user interface editor will get this warning message:
Warning when deleting fields
This warning message ensures that the user interface editor is aware that the changes they make will delete data from the project.
---
version: "V0"
language: "en"
---
# dRofus Integrations
* [Revit Add-On](https://help.drofus.com/en/English/Learning/02-revit-add-on.md)
* [ArchiCAD Add-On](https://help.drofus.com/en/English/Learning/archicad-add-on.md)
* [Solibri Extension](https://help.drofus.com/en/English/Learning/solibri-extension.md)
* [IFC and BIM](https://help.drofus.com/en/English/Learning/ifc-and-bim.md)
---
version: "V0"
language: "en"
---
# Add or edit Fields
Fields are the lowest level in the User Interface Editor hierarchical structure. This is where users will contribute to data within the database. Fields can only be added to an element, not directly to a group or tab.
When adding a field, admins can choose from 8 field types. See [Field Types](https://help.drofus.com/en/English/Learning/4-add-or-edit-fields.md#Field-types) below. The field types have some common characteristics and some are unique special conditions.
An element with three fields; Yes/No, Text, and Numeric - working together
## Create new field
1. Select the element where the new fields should be added.
2. Select "New field" in the top menu and choose the desired field type from the drop-down menu, or right-click an element and select "New field → "
3. Enter properties. Read more details below.
Example of properties for a "Text" field
### Field types
Fields may be of different types and also have different properties according to type.
|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Field type** | **Explanation** |
| Multi line text | A text field that covers several lines is designed for fields that potentially will contain paragraphs of text. The size of the area of the box is defined by both height and width  |
| Formatted Text | It has the same usage as multi-line text but allows for formatting (e.g., Bold, Italic, colored text, etc. Formatted text fields ***cannot*** *be used for excel import/export workflows and* ***cannot*** *be added as columns to lists.* |
| Yes/No | Yes/No field (checkbox). Can be used alone or together with other field types. e.g. as an enabler of other fields.  |
| Numeric | Field for numerical values. Define the total number of digits allowed, and number of decimals. Data type must match when syncing with external data sources.  |
| Multiple choice | Fields offering users to choose between several predefined options (text). Can be presented as a drop-down menu (combo-box) or radio groups.   combo box (left) radio group (right) |
| Text | One-line text field  |
| Date | Field for setting date.  |
| Fixed text | Field for fixed text which cannot be edited. Fixed text fields ***cannot*** *be used for excel import/export workflows and* ***cannot*** *be added as columns to lists. They only show in the User Interface.*  |
### Properties
Some properties are common to all field types, and others are specific to certain field types. The last column in the table (Field type) will inform which field type the property is available for:
|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------|
| **Property** | **Explanation** | Field type |
| ID | Database unique ID for the field | All |
| Label | Optional label to be placed either before or after the field. Use the associated dropdown to define where to show the label. | All |
| Tooltip | Help text that will appear as users hover over the field in the user interface | All |
| Enabled/Disabled by | If you want the selected field to be enabled/activated by a Yes/No field. Use the associated dropdown list to select a yes/no field available within the tab. A field can not be enabled by a Yes/No field placed in another tab. | All |
| Read-only | Set to read-only to lock values. Setting this option will not prevent changes from all sources. The field is still editable via Excel, Revit/Archicad. | All, except Fixed text |
| Height | Option to overwrite default height. By default, the field will span to use available space. It's recommended to use default behavior, but overwrite if you have special needs. Insert height in rows vertically. | Multi line text, Formatted text |
| Width | Option to overwrite the default with of the field. By default, the field will span to use available space. It's recommended to use default behavior, but overwrite if you have special needs. Insert width in pixels horizontally. | Text, Multi line text, Formatted text, Numeric, Multiple choice, Fixed text |
| Text | Only available for Fixed text. This property contain the text value you want to show in the user interface. | Fixed text |
| Underline \& Center | Only available for Fixed text. Controls underline of the text value and if text value should be center aligned or not. Default behavior is left aligned | Fixed text |
| Show label above | This option will place the element label, if used, above Formatted text or Multi line text fields. Making the field use more available space in the user interface and in PDF reports | Multi line text. Formatted text |
| Data type | Option to specify data type for numeric fields. If left blank the field will have default data type which is whole numbers | Numeric |
| Total number of digits | Define how many digits should be allowed in the numeric field. If left blank the default value of 7 will be used. | Numeric |
| Number of decimals | Define how many of the allowed digits to be decimals. If left blank the default value of 2 will be used. | Numeric |
| Style | Specifies the appearance of Multiple choice fields * *Combo box, not editable*, provides a drop-down menu which cannot be edited directly, but where you have to select one of the predefined options. * *Combo-box, editable*, provides a drop-down menu where you can enter text freely or select one of the predefined options. * *Radio group.* Positions radio buttons on top of each other per option * *Radio group* *horizontal.* Positions radio buttons one after the other in a horizontal line and not on top of each other as above. | Multiple choice |
| Dropdown values | In Multiple choice fields, each value represent an option in the multiple choice list. If you wish to add a blank option, make sure to select "Add empty value" (see below). The dropdown values will be sorted by their input position. | Multiple choice |
| Add empty value | In Multiple choice fields, this option will add an empty value so users can clear the field if needed. | Multiple choice |
| Days rollback | Define how many days to roll back as default. If left blank the current date will be set as default. | |
### Copy fields
1. Select field
2. Right-click
3. Select "Copy"
4. Select the element to paste into
5. Right click element and select "Paste"
Fields can also be copied when elements, groups or tabs, containing fields, are copied.
### Delete fields
Select one or more fields and delete using the "Delete" option in the top menu or Right click → Delete.
Fields will also be deleted when elements, groups or tabs, containing fields, are deleted.
When deleting tabs, groups, elements, or fields in a project where the field is in use with data, users in the user interface editor will get this warning message:
Warning when deleting fields
This warning message ensures that the user interface editor is aware that the changes they make will delete data from the project.
---
version: "V0"
language: "en"
---
# Account App
Your Account App is where you can:
* Update your profile information
* Change your language preferences
* See all organizations and projects you belong to
* Join projects you have been invited to
* Leave projects you no longer need access to
* Launch dRofus desktop or web for a selected project
You can access your Account app from the web by selecting Account in the top right corner. See WEB Access---dRofus Wiki---dRofus Wiki to learn how to access dRofus Web.
Once you log in, you will see your account app profile.
Select Edit to change your profile.
Select "See My Organizations and Projects" to view the Organization you have joined and the projects you have access to.
Organizations and Projects
You can launch the project admin page from here if you have admin rights.
See [Project Administrator](https://help.drofus.com/en/English/Learning/project-administrator.md) to make changes to a project as a project admin.
This is also where you can join a project
See [Invitation to Create or Join](https://help.drofus.com/en/English/Learning/invitation-to-create-or-join.md) to learn more.
If you want to remove yourself from a project, select Leave project. You will no longer be able to log in to that project.
Select **Open in Desktop app** or **Open in Web app** to open the project directly from the Account App.
If you already have an active dRofus session (desktop or web), the project will open without asking you to log in again. If your session has expired or you are not logged in, you may be prompted to sign in first.
The Account App uses the same login method as dRofus. If your organization uses SSO, sign in with your usual company credentials. Otherwise, use your normal dRofus username and password.
---
version: "V0"
language: "en"
---
# Add Priorities to Items Occurrences
## Priorities introduction:
Before you start the procurement, you might not know how much you are able to buy. For instance: Some of the Items you:
* Must have
* Might buy if the budget allows
dRofus gives you the option to sort Items into Priorites, that makes it easier to sort out which Item to add to the tender. Priorities are project-specific and must be added by an admin user. [Add new Priorite](https://drofus.atlassian.net/wiki/display/DV/Add+new+Priorite)
Example: Priorities Groups
## Add Priorities to Item Occurrences
1. Go to the Item module
2. Select the Item you would like to add priorities to
3. Select one or multiple select several Occurrences
4. Go to the Properties pane and select Priority.
You are not able to change the priorities if the occurrence is:
* In a locked tender
* Connected to a standard item list. Then you have to change the priorities for the occurrence in the standard list.
## Use Priorities to add Items to a tender
When creating a tender you can select which priorities you would like to add Items from.
Priorities you would like to:
* Purchase Items from: Select "Buy".
* Collect price on Items from: Select "Option".
* Not add Items from: Select "Not included"
The quantity of the Items that you are purchasing and that you har collecting price from will appear in the overview.
## Move Occurrences for Purchasing to Option
1. Select Item
2. Select Item Occurrence
3. Right click and select "CHange between option and procurement"
You will see that the number of occurrence will move to the other option. In the example above "Quantity" will change to 0 and Quantity option will change to 1"
---
version: "V0"
language: "en"
---
# Add Component to a System
We recommend reading [Systems Module - Definition](https://help.drofus.com/en/English/Learning/definition-and-hierarchy.md) before moving forward.
A System connects two or more physical Components together.
## Step 1: Create System Component.
Read more: [Create System Components in dRofus](https://help.drofus.com/en/English/Learning/copy-create-system-components.md).
## Step 2: Add Component as a member to a System
* [Add New Component/ Occurrence to a System](https://help.drofus.com/en/English/Learning/create-components-in-a-system-in-drofus.md)
* [Add existing Occurrence as a Component in a System to the selected System Component](https://help.drofus.com/en/English/Learning/copy-connect-systems-and-components-across-domains.md)
* [Add existing Component to another System](https://help.drofus.com/en/English/Learning/add-existing-component-to-another-system.md)
* [Add or remove the selected Component or System Component as a member of a System](https://help.drofus.com/en/English/Learning/add-or-remove-the-selected-component-or-system-com.md)
---
version: "V0"
language: "en"
---
# Modify Sub Items
## Create Sub Items
1. Select Item
2. Select "Add Sub Items" within the Ribbon menu or in the right-click menu. Window will appear:
3. Select Item(s): Navigate or search for the Item you would add as a Sub Item. Double click on the Item or use the narrow \[\>\] to add the Item.
4. Select Ok
The selected Items in step 3 are now added as a Sub Item to the Item selected in step 1.
## Copy Sub Items for another Item
1. Select Item
2. Select "Copy From" within the ribbon menu
Select Item with Subs, then Copy From feature from the ribbon.
A window will appear.
Pick the item to copy subs from
3. Select the item from which you would like to copy the sub-items.
4. Select "ok"
The Sub Items to the Item selected in step 3 is now copied to Item selected in step 1.
## Delete Sub Items
1. Open the Sub-Items panel [Display Sub Items](https://help.drofus.com/en/English/Learning/display-sub-items.md)
2. Select Item
3. Select Sub Items within the Sub-Items panel
4. Select "Delete Sub Items" within the ribbon menu
The item is not deleted as a sub-item of the selected item but has not been deleted from the database.
## Swap Sub Item
To swap sub-item occurrences, select the item with subs first, then the sub item, then right and select Swap sub item.
Then search for the item you want to replace
---
version: "V0"
language: "en"
---
# Add data to offered Items
## Add data to offered Items
Display the offered Item data window by either:
Double click or Right click on an Item and select "Open"
The window below will appear
**1.Register the supplier's Item information**
**2. Add the supplier's Item Unit price.** An admin user can add Currancy option or update currency value. For more information look at [Setup for Procurement Module](https://help.drofus.com/en/English/Learning/setup-for-procuremen-module.md)
**3. Add Price correction:** Is used to add any corrections which will affect the price
Right click and:
a) "Add" to register . Add "-" to make a negative correction.
b) "Delete"
c) "Properties" edit existing price correction
The corrected price is an evaluation tool and will not have an impact on the unit price for the items during later stages of the process.
**4. Lifecycle costs:** A net present value will be calculated on the basis of the registered lifecycle costs.
Right click and select "Generate lifecycle cost" and the window below will appear
* Enter the correct number of years
* Click "Ok"
* Reopen the "Offered Item" Date window
And a list over the years will appear. See picture below
* Dobbel click on the year you would like to add cost and fill in any default value. The values are project specific. An admin user can add/ edit/ delete values. For more information look at [Setup for Procurement Module](https://help.drofus.com/en/English/Learning/setup-for-procuremen-module.md)
The Lifecycle cost is an evaluation tool and will not have an impact on the unit price for the items during later stages of the process.
**5. Add Sub-components:** Registrate Sub-component from the tendered Item that you wants to process as independent Items at a later date. Sub-component are automatically included when an Item is included in an agreement. New sub-component are also automatically included in agreements and tenders under which the item is already incorporated.
Sub-component prices can either be:
* Included in the main item. This will allow for comparison betwwen tenders
* Added individually to the sub-components when an agreement has been created and items are transferred.
**6. Click "Save"**
You can click "Next" to add data to the next Item in the list
---
version: "V0"
language: "en"
---
# Add existing Component to another System
System Component can be a member in another Systems as a Component.
Read more [Systems Module - Definition](https://help.drofus.com/en/English/Learning/definition-and-hierarchy.md)
1. Select the System Component or Component that should be connected as a component to another system
2. Select "Add to System"
3. Search for an existing Component or System Component that will be or is owner of the System.
1. Show Suggestions: Will base the search on previous used and classification
2. Search All Component: Will search for both Component and System Components
3. Search System Component: Will search for only System Components
4. Select Component or System Component that will be or is owner of the System.
5. Select System
1. Create new System
2. Use existing System (only available if you have selected a System Component that is owner of a system)
6. Select "Ok" and the Component has been added to the system.
if a Component is selected in step 4, the component has become a System Component in the overview. It will remain a component in the system it was already part of, but the properties will say that it is a System Component
---
version: "V0"
language: "en"
---
# Add fields to the Procurement module
Fields created in the Procurement editor will not be connected to specific items or occurrences. The fields created in the procurement editor can be connected to either a tender group, tender, offer, agreement, order or a delivery. The image below shows the User interface Editor for the ***Procurement module.***
The procurement module is organized in different stages of the procurement process. Inside the procurement module these stages will be represented with a three-structure. When creating tabs in the procurement GUI you need to determine the stage you want the tabs and associated datafields to appear. The location is determined by the name you insert to the *Placement*property on the tabs you create.
In the image above we have created a tab 'Delivery details' in which we want to appear in the *Agreement*stage in the procurement module. We have then chosen the value 'agreement' from the "Placement" dropdown menu, which will make the flag appear as a tab in the agreement stage. The result in the agreement can be seen in the image below.
Use the following placement options to determine location of tabs in the procurement module:
|--------------------|------------------------------------------------|
| **Placement** | **Location in procurement module** |
| tendergroup | Tender groups |
| tender | Tender level |
| offer | Offer level |
| agreement | Agreement level |
| order | Order level |
| consignation_order | Both in order level and in the delivery module |
For more information regarding how to modify the GUI refer [Editing forms](https://help.drofus.com/en/English/Learning/editing-forms.md).
---
version: "V0"
language: "en"
---
# Product: Add Images or Documents
## **Add Images:**
Adds selectable image(s) to the selected product.
## **Add documents:**
Upload a Document relevant to the Product.
## **Link to documents** :
If the Documents are already uploaded via the Documents Module the document can associate selected uploaded Documents to the Product. This can help to reduce the duplication of documents stored in the database.
---
version: "V0"
language: "en"
---
# Add information to the Occurrences / individual in delivery
## Generate individual
You can split Occurrences into indiviuals units, that gives you the opportunity to register delivery information for the individual occurrence, where there are several in the same room. This process allocates a unique number and bar code for the individual which is used during delivery.
You can generate and remove individuals in the Procurement module. Read more: [Generate Individuals of Items](https://help.drofus.com/en/English/Learning/prepare-items-for-delivery.md) or in the delivery module:
1. Select order
2. Select the "Items/Occurrences" tab
3. Select the Item
4. Right click
5. Select "Generate Individuals" or "Remove Individuals"
## Add Information
You can only register delivery information on the Occurrences /individual if it has a status. If the individual does not have a status, the dialogue box will automatically select the first status in the drop-down menu.
You can register information:
1.Select the Item or occurrence/individuale
2. Open the "Edit" window by either:
a) Select "Enter" on your keyboard
b) Double click
c) Select "Edit" from the right click menu
---
version: "V0"
language: "en"
---
# Add Items to a Tender
## Add Items to a Tender
1. Click on the "Tender"
2. Click on the "Items" tab
3. Right click in the empty Item list
If the option *Add Occurrences from Tender Group* is unavailable (grey) there are two possible issues;
* You only have read access to the procurement module
* The Tender is locked for edits. To un-lock the Tender go to the Tender tab and deactivate the 'Locked' checkbox and save your changes
4. Click on " Add Occurrences From Tender Group" and the window below will appear
5. Select the Priorities group for the Items you would like to include in the tender and decide if you are going to buy the Item or obtain Item cost. Read more about Priorities: [Step 1: Add Items to Procurement module](https://help.drofus.com/en/English/Learning/step-1-set-purchasing-priority-to-items.md)
6. Click on the "Item" and the Occurrence of the Item will appear.
* Remove the selection of an item to exclude the Item and all occurrences of the Item.
7. Select Occurrence you would like to add to the tender:
* Remove the selection of the occurrence to exclude individual occurrences of the Item.
* Right click "Change between option and procurement" if individual Occurrences have different status then what you have set in step 5.
8. Click ok
You can still delete and enter new occurrences until the tender is locked for editing.
The picture below shows how the Tender would look like
---
version: "V0"
language: "en"
---
# Add Items to the Agreement
## Add Items to the Agreement
1. Select the "Items / Occurrences" tab
2. Right Click on the empty Item list
3. Click on "Add Occurrences from Tender". A list of items offered by the supplier will appear.
4. Select items and thee occurrence you you would like to include in the Agreement
5. Click "OK"
The Items and the Occurrence of the Items are added til the agreement
---
version: "V0"
language: "en"
---
# Add new Company
1. Go to the Company module
2. Click on "New Company" and the window below will appear
3. Enter Company Information.
4. Click "Ok"
---
version: "V0"
language: "en"
---
# Add New Occurrence of the agreed Item
## Add New Occurrence of the Item
1. Select the "Items/Occurrences" Tab
2. Right Click on the Item you would like to add Occurrence and select "New Occurrence
3. Enter "Quantity"
4. Click on "Select Room"
5. Select Room
6. Select "Ok"
7. Select "Ok"
New Occurrence is added.
### Display your new Occurrence in Item module
1. Go to the "Items" module
2. Select Item
3. Display "Occurrences"
4. New occurrences are displayed with the text "New Agreement" in the status field so that you know which occurrences have been added since the tender.
### Display your new Occurrence in Room module
The New Occurrence will not be listet in any equipment list in the Room. To display the new occurrence:
1. Go to the "Rooms" moduel
2. Select Item
3. Display "Items in room"
4. New occurrences are displayed with the text "New Agreement" in the status field so that you know which occurrences have been added since the tender.
---
version: "V0"
language: "en"
---
# Add new Priority
## Add new Priority
Priorities are project-specific and must be added by an admin user.
1. Go to "Settings"
2. Click on "Settings" under Project and Database Administration
3. Click on "Items"
4. Click on "Priority"
5. Click on "Add" and the window below will appear
a) Enter the the number of priority
b) Enter the name to priority
c) Click "ok"
6. Click "Save" and the new priority has been added.
---
version: "V0"
language: "en"
---
# Add New Users
## Steps to Adding Users to a Project
### Select Projects
Start by selecting one or many projects to add users to, then use the quick bottom menu and select Add users.
### Add Users
Populate the Users list with emails of those who must be added to the Projects. If, as an Admin, you see the user while searching, select them to add them to the project. If they do not appear in the user list, add their first and last names to the email to populate those fields when creating new users. The format is Bob Builder \< bob@construction.co\>. When adding a new user to the list, select them after you have populated this format. Select Next once all users who share the same permissions have been added.
### Review Options
Review details, keep "Send a welcome email" checked (on by default), and add any custom message (optional). Populate the Project Role. If you are adding new users, set their Login Options. These settings do not apply to users who already have accounts.
### Define Permissions
Set the user group to define permissions or manually define permissions. Select Next to complete permissions for all the same users.
### Review Summary
Last step before adding or updating users to a project. Check the project list, users, login options (for new users), and whether the welcome email is enabled.
Users added to the project will show with the status "Added". Users invited to join the project or create an account will show with the status "Invited".
Next to the invited status is a copy feature that can be used to copy the URL from the invited email.
## User Permission Levels
User rights define access to the project and control of a user's editing rights within the different dRofus modules. Hold the mouse cursor over the information icons to view help text explaining the various permissions. See [Permissions](https://help.drofus.com/en/English/Learning/permissions.md)
**Full**means the User has full editing permissions.
**Limited**means the User has some room data permissions only. Only applies to Room Templates and Rooms.
**Read**means the User will have read-only access and non-editing permission.
**None**means the User will have no permissions; in most cases, the module will not appear.
### Model server
Users need full permission to upload or replace IFC files on the dRofus web.
### Administration Levels
*BIM Administrators* can edit Attribute configurations in Revit, Archicad and IFC (Desktop) and update the Revit or Archicad settings.
*Administrators* can change settings and preferences in dRofus.
*User Administrators*provides access to the admin system, where users can change project details and edit user permissions.
## Options for Adding New Users
As a project admin in dRofus, there are a few different ways to add users to your project. The method you use depends on whether the user already has an account and whether their account is visible to you as an admin.
### Adding users visible to the admin
When you search for a user while adding them to a project, if their name appears in the search results, it means:
* The user already has a dRofus account.
* Their account is visible to you as an admin.
**How to add:**
* Select the user from the search results and add them directly to the project.
* By default, the "Send welcome email" option is checked, so the user will receive a notification email.
* In the [Summary Review](https://help.drofus.com/en/English/Learning/add-new-users.md#Results-Summary), these users will show with the status **"Added"**.
### Invite users Who Are Not Visible to the Admin (Sending Invitation Emails)
If the user does not appear in the search results, it means:
* The user does not have a dRofus account, or
* The user has an account, but it is not visible to you as an admin.
**How to invite:**
* Enter the user's email address to send them an invitation.
* The "Send welcome email" option is checked by default, so an invitation email is sent automatically.
* The user's status in the [Summary Review](https://help.drofus.com/en/English/Learning/add-new-users.md#Results-Summary) will be **"Invited"**.
**What happens next:**
* If the user already has an account, they will be prompted to accept the project invitation via the Account App.
* If the user does not have an account, they will be prompted to create one and then accept the invitation via the Account App.
### What does an Invitation look like for the user?
See [Invitation to Create or Join](https://help.drofus.com/en/English/Learning/invitation-to-create-or-join.md)
---
version: "V0"
language: "en"
---
# Add Occurrences to the Order
## Add Occurrences to the Order
Register the occurrences from an agreement to include in an order:
1. Select the "*Items/Occurrences"* tab
2. Right click on the list
3. Select "*Add occurrences from agreement"*.
4. Select which occurrences you want to include per item or occurrences in a room.
---
version: "V0"
language: "en"
---
# Add, Open or Delete individual Existing Items
## Add Existing Items:
1. Select Item
2. Select "add" in the ribbon menu
3. Enter Name and information
4. Select "Ok"
## Open or delete Existing Item
1. Open the existing Item panel. Read more [Existing Items Overview](https://help.drofus.com/en/English/Learning/existing-items-overview.md)
2. Select Existing Item
3. Right click or navigate to the ribbon menu and select "open" or "delete"
---
version: "V0"
language: "en"
---
# Add or change System Component
To add or select the owner (System Component) of the System
1. Select System
2. Select \[...\] beside the System Component in the properties pane
3. Select the "Item Occurrence" that should be the ovner of the System
4. Select "Ok"
---
version: "V0"
language: "en"
---
# Add or Move Items to a Tender Group:
## Add or Move Items to a Tender Group:
### Add Items to Tender Group
1. Go to the "Item" Modul
2. Select Item or multiple select several Items.
3. Click on \[...\] to Add " Tender Group".
If several Items are selected, a checkbox will appear and needs to be checked to be able to select a Tender Group
If you can't see the Items in the procurement module- you can try:
* F5
* Log in and out of dRofus
### Move Item to another Tender Group
You can move Item by either:
1. Go to the Item and change the "Tender Group" in the Properties pane.
2. Drag and drop in the Procurement module:
a) Go to the Tender Group
b) Select the tab "Items in the Tender Group"
c) Select one or several items to be moved
d) Left-click, hold and drag these Items to the Tender group you would like to move it to
---
version: "V0"
language: "en"
---
# Add or remove the selected Component or System Component as a member of a System
Component and System Component can be added to an existing system. When adding a Component or System Component to a system, both will be member of the system as a Component. The System Component will continue to be named as System Component. In the properties pane the systems that the System component only is a member of, is found in the section " Is member of Systems"
1. Select the Component or System Component that would be added or removed as a member of a system
2. Select "System Membership". Window will appear.
3. Select the System that the Component or System Component should be a member of
4. Select \[\>\]
5. Select the System that the Component or System Component no longer should be a member of
6. Select \[\<\]
7. Select "ok"
The selected Component or System Component is now added or removed as a member of a system.
---
version: "V0"
language: "en"
---
# Add Owners to Items Occurrences
Owners can be added to Occurrences to be able to divide Occurrences between two or more owners in the project.
Use case example:
* Company 1 owns the building
* Company 2 owns equipment
* Company 3 owns furniture
## Add Owners to Occurrences
1. Go to the "Items" module
2. Select Item
3. Select Occurrence
4. Use the dropdown meny to select owner
5. Select save
---
version: "V0"
language: "en"
---
# Add Room
Select to "Add Room" or "Add Room from template"
## Add new Room
Rooms can only be created in the lowest levels in the Room Function Structure.
1. Select the Room Function that should be the location to the Room
2. Select "Add Room" in the Ribbon menu. Window below will appear:
3 Enter Properties information such as:
* *Name*(mandatory)
* *Room Name Description*
* *Name on Drawing*
* *Programmed area.*
These values can be edited and filled later in the *Properties panel.* All other functions available for a room can be found by right-clicking on the room.
4. Select "Ok"
The new room is now created.
## Add room from template
1. Select the Room Function that should be the location to the Room
2. Select "Add Room from template" in the Ribbon menu. Window below will appear:
3. Select Room Template from the Room template list
4. Click "Select"
The new room will inherit all values from the selected Room Template:
* Room name
* Programmed area
* Room Data
* Equipment and finishes status.
---
version: "V0"
language: "en"
---
# Add Status to Room
Items, occurrences, products, systems, or rooms can be assigned pre-defined Status values to track their work process. These Status values provide an overview of the progress for each item.
For instance, if there is a need to record the specification process for the Room, it can be helpful to have an indicator for:
* Rooms that are still undergoing specification.
* Rooms that are done but are yet to be verified.
* Rooms that are accepted as complete by the building end users.
Read more about how to setup status for Room: [Status Setup](https://help.drofus.com/en/English/Learning/status-setup.md)
---
version: "V0"
language: "en"
---
# Adding a Responsibility to Items from the Item Group
A Responsibility can be applied to an Item at the Item Group Level.
If the Responsibility is applied to the Item Group, only the Items created after the Responsibility has been applied will receive the Responsibility.
---
version: "V0"
language: "en"
---
# Admin Settings Revit Add-On
## Attribute configurations
Attribute configurations is an essential concept within the dRofus Revit Add-On.
To learn more about the functionality of Attribute Configurations, visit [Revit Attribute Configurations](https://drofus.atlassian.net/wiki/spaces/WA/pages/1318359547/Revit+Attribute+Configurations).
## Create new or edit a Configuration
In order to create a new, or edit an existing, attribute configuration, click on "Attribute configurations" (highlighted below)*:*
To learn more about the management of attribute configurations, visit [Create New or Edit Revit Attribute Configuration](https://drofus.atlassian.net/wiki/spaces/WA/pages/1318359551/Create+New+or+Edit+Revit+Attribute+Configuration).
## Options
Options can be accessed by clicking on "Options" within the dRofus Menu / Ribbon as shown:
There are several settings that can be adjusted within "Options".
To learn more about the "Options" in the Revit Add-On, visit [Revit Options](http://db.nosyko.no/wiki/display/DV/Revit+Options).
---
version: "V0"
language: "en"
---
# Admin system REST API
This document documents the possibility of interfacing with the admin system using REST calls (GET, POST, PUT, PATCH, DELETE), allowing the automation of tasks like creating projects and users.
All examples are produced using the [curl](https://en.wikipedia.org/wiki/CURL) utility.
## General
### Authentication
The system uses BASIC AUTH authentication. Logging in simply needs an admin system user, and you can log in with the same username and password combination you use for regular WEB access.
### Data formats and URLs
All resources can be accessed using HTML, XML, or JSON formats.
This is a separate API from the normal REST API, and the base URL should be the same as the admin system (e.g., ) you are trying to access.
For the link, [http://\[admin-url\]/projects](#)give the regular HTML project listing while [http://\[admin-url\]/projects](#).json gives the list with project and project users in JSON format(
Some resources (notable users) have dots (.) in their resource names, so the .json can not be used. Be sure to send "Accept: application/json" in the header instead so (This applies to all types of clients(e.g., postman, etc.). ,
**Setting the Accept header to "application/JSON" is the recommended way of getting responses in JSON format. .json should only be used when testing**
curl -H "Accept: application/json" -s -u testadmin:testpw http://[admin-url]/users/hakonhc
will give the same as
curl -s -u testadmin:testpw http://[admin-url]/users/hakonhc.json
## Resources:
| **Resource** | **Description** |
|----------------|-------------------------------------------------|
| /projects | Lists and manipulation of projects |
| /owners | Listing of project owners |
| /users | Listing and manipulation of users on the server |
| /database | Listing and manipulation of databases |
| /project_users | Listing and manipulation of users in projects |
Most resources responds to both GET, PATCH, and DELETE
In addition, we have some unique endpoints for:
| **Resource** | **METHOD** | **Description** |
|-----------------------------------------------------------------------------|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| /node/logins | GET | Get login statistics for projects over the last five years, grouped by type of client used(Revit, dRofus, etc.). |
| /node/logins?from_date=2018-01-01\&to_date=2019-12-31 | GET | Get login statistics for projects for the given period, grouped by type of client used(Revit, dRofus, etc.) |
| /node/unique_users | GET | Gets the number of unique users for each project for the last 5 years |
| /node/unique_users?from_date=2018-01-01\&to_date=2019-12-31 | GET | Gets the number of unique users for each project for the given time period. |
| /project_data?from_date=2018-01-01\&to_date=2019-12-31 | GET | Get statistics values on projects, to_date and from_date are optional limits on date |
| /password/request_reset | GET | A post request with a valid username will trigger a password reset email |
| /password/reset | GET | Use this with a token to change the password with the API |
| /owners/\[id\]/tasks/\[TaskName\]/run?source=\[sourcedb\]\©_ids=\[ids\] | POST | Run a given task against all databases for a given owner. *TaskName*is one of the following * *CopyOverwriteExcelExportsTask:*Copy given Excel export identified by *IDs* from *sourcedb* to all other dbs * *CopySharedRdlReports:* Copy given RDL reports identified by *IDs* from *sourcedb* to all other dbs |
### GET Resources: Listings
| **Resource** | **Description** | **Parameters** |
|-----------------------------------|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| /projects | List all projects | *?query=xx*will list all projects containing xx in the name ?show_all=1 to also include inactive projects |
| /projects/1 | List project with id 1 | |
| /owners | List all owners | |
| /owners/1 | List owner with ID 1 | |
| /users | List of all users | ?query=xx to search ?disabled=1 to include disabled users (e.g. /users.json?disabled=1) ?invited=1 to include invited users ?disabled=1\&invited=1 to include disabled and invited users |
| /users/username | List user with username | |
| /database | List databases | |
| /project_users/username,projectid | Show project user | |
Example
$ curl -s -u testadmin:testpw http://[admin-url]/projects.json?query=template|json_reformat
[
{
"project": {
"active": true,
"contact": null,
"created_at": "2016-11-01T09:39:14Z",
"created_by": null,
"database_id": "akl-test",
"description": null,
"gross_area": null,
"id": 399,
"name": "dRofus dev template",
"no": "01",
"owner_id": 5,
"status": null,
"updated": null,
"updated_by": null,
"unit_type": "SM" #SM for square meters or SF for square feet
}
},
.....
## POST Resources: Creating objects
### Example
This creates an owner with the name "Test," and from the return, we can see that it has been assigned with ID 11
$ curl -H "Accept: application/json" -H "Content-type: application/json" -X POST -u testadmin:testpw -d '{"owner":{"name":"Test"}}' http://[admin-url]/owners
{"owner":{"address":null,"billing_address":null,"contact":null,"id":11,"image":null,"name":"Test","network":null,"note":null,"tech_contact":null}}
### Creating a new project ( POST /projects)
Creating a new project requires some special parameters. This would be the minimal data to provide when creating a new project
| **Parameter** | **Description** |
|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ***new_db*** | 1 to create a new database or 0 to add a project to an existing database |
| ***new_db_template*** | If creating a new database, provide the database name that would be used as a template |
| ***new_db_name*** | If creating a new database, provide the name of the new database |
| ***existing_db_name*** | If NOT creating a new database (*new_db* set to *0*), provide the name of the existing database to add the new project to |
| ***name*** | Name of the project |
| ***constructor*** | Name of the constructor/firm of the new project |
| ***description*** | Description of the project |
| ***owner_id*** | The ID of the owner |
| **project_type_id** | Type of project. Use one of the following values. id │ name ─┼──────────────────── 1 │ Active Project 2 │ Deprecated Project 3 │ Demo 4 │ Copy / Backup 5 │ Template 6 │ Sandbox / Test 7 │ Training 8 │ Trial |
All the parameters are mandatory.
Example
{
"project": {
"new_db": "1",
"new_db_template": "dev-template",
"new_db_name": "rest_test",
"project_type_id": 1,
"name": "REST TEST",
"owner_id": 5,
"description": "TEST CREATE FROM REST",
"constructor" : "dRofus AS"
}
}
### Creating a new project user (POST /project_users)
$ curl -H "Accept: application/json" -H "Content-type: application/json; charset=UTF-8" -X POST -u testadmin:testpw -d @data.json http://[admin-url]/project_users
{"project_user":{"created_at":"2016-11-28T12:22:35Z","project_id":408,"role":null,"superuser":null,"user_role_id":null,"username":"hakonhc"}}
Where data.json contains
{
"project_user": { "project_id": 408,"room_rights":1,"send_email": "0"},
"user": {"username": "hakonhc", "first_name":"Håkon","last_name":"Clausen","email":"hhc@drofus.com"}
}
OR
{
"project_user": { "project_id": 408, "room_rights": 1, "send_email": "0" },
"users": {
"hakonhc": {
"username": "hakonhc",
"first_name": "Håkon",
"last_name": "Clausen",
"email": "hhc@drofus.com"
},
"jdoe": {
"username": "jdoe",
"first_name": "John",
"last_name": "Doe",
"email": "jdoe@example.com"
}
}
}
| **Parameter** | **Description** |
|-------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ***project_user*** | project_id: ID of the project to add to room_rights: room permission level equipment_rights tender_rights consignation_rights system_rights modelstore_rights superuser: Project Administrator addon_admin: BIM admin web_admin_access: if a user is a superuser, this grants access to the web admin can_see_price: true or false should the user see prices send_email: "0" or "1" |
| **either: user** Single user to be added **or: users** A hash of users to add keyed by username See example above | username: Username of the user to add first_name: First name of the user to add last_name: Last name of the user to add email: Email of the user to add *If the user exists, make sure that the information given is equal to the information registered on the server* |
## GET Resources: Object manipulation and more
### Databases
| **Resource** | |
|-------------------------------------|-----------------------------------------------------------------|
| /database/\[dbname\]/disableall | Disables all project users in the database with the name dbname |
| /database/\[dbname\]/enableall | Enables all project users in the database with the name dbname |
| /database/\[dbname\]/kickall | Logs out all users in the database with name dbname |
| /database/\[dbname\]/get_backup_now | Downloads a backup of the database |
#### Users
| **Resource** | |
|-----------------------------|-----------------------------------------------------|
| /users/\[username\]/disable | Disables users so they can not log into any project |
| /users/\[username\]/enable | Enables a user |
| /users/\[username\]/kick | Logs out all users in database xxx |
## POST Resources: Toggles and other changes
### Users
| **Resource** | |
|-------------------------------------------------|---------------------------------------------------------------------------------------|
| /users/\[username\]/toggle_otp | Toggles whether the user has to login using Multi-Factor Authentication |
| /users/\[username\]/toggle_force_weblogin | Toggles whether the user has to login using Modern Login/SSO |
| /users/\[username\]/toggle_local_authentication | Toggles whether the user can use local or have to use external authentication (Entra) |
| /users/\[username\]/toggle_enable | Toggles enabling and disabling the user |
| /users/\[username\]/merge?to=\[to_username\] | Merge user into another user |
## PUT/PATCH Resources: Updates
| **Resource** | |
|-----------------------------------|---------------------|
| /projects/\[id\] | Update project |
| /project_users/username,projectid | Update project user |
Example 1: Update project
$ curl -H "Accept: application/json" -H "Content-type: application/json; charset=UTF-8" -X PATCH -u testadmin:testpw -d @data.json http://[admin-url]/projects/1
Where data.json contains
{
"project": {
"name": "REST TEST",
"description": "TEST UPDATE FROM REST",
"active":true
}
}
Example 2: Update project user
$ curl -H "Accept: application/json" -H "Content-type: application/json; charset=UTF-8" -X PATCH -u testadmin:testpw -d @data.json http://[admin-url]/project_user/testuser,1
Where data.json contains
{
"project_user":{
"username":"test",
"project_id":647,
"room_rights":1,
"equipment_rights":3,
"tender_rights":4,
"room_surface_treatment_rights":4
}
}
Example 2.1: Update Project User
Where data.json contains
{
"project_user":{
"username":"test1",
"project_id":647,
"role": "Architect",
"usergroups":["usergroup_2","usergroup_5"]
}
}
## DELETE Resources
You also use the DELETE operation to delete most objects.
This example will delete a user in a project
curl -H "Accept: application/json" -s -u http://[admin-url]/project_users/[username],[project_id] -X DELETE
## Resetting Password
Posting a JSON request to "/password/request_reset" with this body and a correct username will start the reset password process. The user will get a password reset request via email with a token:
JavaScript
// Post to {server}/password/request_reset
{
"username": "user"
}
To change the password use the following JSON with the token from the email:
// Post to {server}/password/reset
{
"token": "5f2pi2zW7wO3nodwWznmDQ",
"password": "pass",
"password_confirm": "pass"
}
## Project Statistics
| **Resource** | **Comment** |
|----------------------|-------------------------------------------------------------|
| /project_data | Gives project statistics over time |
| /project_data/latest | It gives you the latest project statistics for each project |
### Filters
| | |
|--------------------|---------------------------------------------------------------------------------|
| from_date=\[date\] | Only for /project_data gives you data where time is greater than the given date |
| field=\[field\] | Only for specific field |
| owner=\[owner_id\] | Only for specific owner ID |
| | |
### Example output
{
"field": "sum_programmed_area",
"project_id": 1262,
"time": "2019-12-16T10:56:46.848+01:00",
"value": "1233.0"
},
{
"field": "sum_designed_area",
"project_id": 1262,
"time": "2019-12-16T10:56:46.848+01:00",
"value": "1176.0"
},
---
version: "V0"
language: "en"
---
# Administration
Access to the functionality described in Administration is assigned dedicated people per project or owner.
NOTE: A number of the processes available in the administration section of the program may result in loss of data. Users do not always receive a message warning of loss of data. If you are unsure, contact dRofus before making any changes.
As a user with administrator rights, you can access additional functions unavailable to normal users. You will receive access to:
1. Web-based administration service. Read more: [Administration System](https://help.drofus.com/en/English/Learning/web-administration-system.md)
2. Additional options in the dRofus client ***Settings*** . Read more: [Administration Settings](https://help.drofus.com/en/English/Learning/administration-settings-desktop-application.md)
3. Set options and Attribute Configuration in Revit and Archicad. Read more: [Admin Settings Revit Add-On](https://help.drofus.com/en/English/Learning/admin-settings-revit-add-on.md) \& [ArchiCAD Attribute Configurations](https://help.drofus.com/en/English/Learning/archicad-attribute-configurations.md)
---
version: "V0"
language: "en"
---
# Administration Settings
As an administrator, you can change how dRofus behaves regarding room and item numbering and many other aspects of the database. This is done in the *Settings* available from Home→ Settings.
If you, as admin, make changes to project settings like [Dynamic Forms - GUI](https://help.drofus.com/en/English/Learning/dynamic-forms-gui) or [Project and Database Administration](https://help.drofus.com/en/English/Learning/project-and-database-administration-settings) be sure to select the **API/Web/Reports Server: Clear cache** to ensure your changes are pushed to all our services.
---
version: "V0"
language: "en"
---
# Advanced Configuration
The Advanced configuration is an advanced way build more advanced Excel spreadsheets. This type of Excel Export allows users to export data to separate Excel sheets and upload a multi sheet Excel file as a template. This opens the possibility to create more complex reports like [COBie Compliant Export](https://help.drofus.com/en/English/Learning/cobie-compliant-export.md) and Seps2BIM.
Users can find the *Advanced configuration* by going to [Reports and Exports Module](https://help.drofus.com/en/English/Learning/reports-and-exports-module.md) and [Excel exports](https://help.drofus.com/en/English/Learning/excel-exports.md) Module → Right click on *Excel exports → Project reports* and select *Advanced Configuration* . Alternatively, select a existing project export and select *Advanced configuration* in the upper right side menu of the Project export detail window.
In the Excel Export Configuration Module users can build new complex Excel exports. If there already exist exports, users will see them in the list of exports on the left when they are shared. To create a new excel export select **Excel Exports →**New. Give the export a name and hit 'Save'.
Follow the ribbon across the top to then create a Sheet in your Excel export. Select **Sheet →**New and give the sheet a name and specify the column and row the data will start in the Sheet.
When creating multiple sheets in the same workbook the sheet names need to have unique names.
Follow the ribbon across the top to then create a Data Source. Select **Data Sources** → New Data sources.
First select from the drop down menu next to **Target type** to select the data source to export (Room, Item, Occurrence, Product etc.). Users can overwrite the target type name by changing the text in the Name field just below the target type selected. After selecting the data source users can add fields to export as columns in the Excel export. Select **Add** and navigate through the attribute selector to include a field. Include fields by double clicking on them to move them from the left side of options to the right side of fields to include, or use the arrow icons in the middle separation bar to include a field to the right side of fields to include. User can re-arrange the order of the fields by using the Up/Down buttons. The order of fields will determine the columns order in the excel export. Click 'Ok' when done selecting fields.
If users want to add columns with a fixed, predefined text, select the option **Add fixed value** and specify the text/value in the text field on the right side of the window;
In the Excel Export Configuration Module users can also concatenate two or more fields from dRofus into a single shared cell in the Excel export. For example, if a users wanted to combine 'Room number' and 'Room name' into a single shared column they would use **Add complex value**. Select the fields they want to concatenate and click 'Ok'. They then need to specify the order of the fields using the help text and insert an optional separator between the fields in the 'Format template'; In the example below {0} represents the first field and {1} represents the second field.
In the example above the 'Room number' first (written like {0}) and then 'Room name' (written like {1}), with a comma and space as separators. A preview of the fields being concatenated will show below the attribute change section on the right. Select **Save** each time a complex value is formed. To make a change to the attributes being used select **Change**.
To export from the Excel Export Configuration Module select **Excel to Excel**with the name of the excel export selected intended to be exported.
All exports created in the Excel Export Configuration Module when shared will also be available under 'Excel project exports" in Reports and Exports.
To copy a completed export, select 'Save as' in the Excel exports ribbon.
---
version: "V0"
language: "en"
---
# 2. Search and advanced search
If you need to do more complex searches by e.g. combine search conditions you can use the *Search* (2) option
The *Search*dialogue box is divided in two tabs:
* *Search*
* *Advanced search*
## 2.1 Search
What you can search for will be determined by which module you are opening the search dialogue from. If you e.g. open a search from the Item module, all Item properties and specifications will show in the attribute list.
In the*Search* tab, you can search in all properties by:
1. Select Properties from the drop-down menu
2. Select search method. This menu will adjust depending on attribute.
3.Select search value
Search will find all Items with the selected responsibility "ARC"
You can add more conditions by selecting the + icon. If you want to remove a condition, select:
If you have more than one search condition, you can use the option in the top where you can decide whether you want all criteria to *Match all of the following* or *Match any of the following*;
* *Match all of the following: Search result need to fulfill all conditions*
* *Match any of the following: Search result must fulfill at least one of the conditions*
There are two types of criteria for text search which require detailed explanation:
**Pattern:** The pattern option allows you to create a more precise search function where you can use the ? and \* characters as wildcards to represent a random character or several random characters. You use the \| character to denote or group expressions with brackets. The search code S1??(N\|M)\* will provide all results which start with S1 and have either N or M as 5 characters. *Not pattern* means everything with the exception of search results. For example, \*BA will return all which do *not* end in BA.
**Regular expression:** Using regular expressions, you can create extremely advanced search expression using pattern in text.
Documentation of this is available: [here](http://www.postgresql.org/docs/8.1/interactive/functions-matching.html#FUNCTIONS-POSIX-REGEXP)
### Save search
You can save a search by:
* Selecting "Save".
* Give the saved search a name
* Define whether you want to share the search with other users or if it's only should be visible for you.
You can find all the saved searches using the drop-down in the quick search field;
You can also edit or delete saved searches from the ribbon menu by selecting "Edit search" or "Delete search";
## 2.2 Advanced search
In the *Advanced search,* you can set one or several top conditions and build an even more advanced search. This can be useful if you e.g. want to search within a certain selection of items or rooms.
Example: Find all items that are set "To be modeled" and have Responsibility groups ARC (Architect) and/or ID (Interior Designer).
To accomplish this, we need to create two top conditions:
* Condition 1: Find all items with the responsibility ARC or ID
* Condition 2: Find out which of the items from condition 1 is set to be modeled.
The search will look like this using advanced search;
* Selected *'And'* to combine the two conditions, and the result would only show Items that were connected to both responsibility groups (which is not allowed in dRofus so the search would return blank).
Then we created a new top condition (*Condition 2* ). Here we want to find all items within *Condition 1* that are set *To be modeled*. Select "Add root condition" and find "To be modeled" as the search criteria shown in the image above.
We now have two conditions (1 and 2). What's left to do is to determine how these two conditions shall be combined. We have selected "And" in this case because we want our search results to fulfill both conditions;
Condition 1: (Items must have responsibility ARC *or* ID) *And...*Condition 2 (Items must be set to be modeled)
Searches created in complex filters can be saved, edited, and deleted similar to searches created in simple filters.
---
version: "V0"
language: "en"
---
# Advanced Settings
Collapse all
[Expand all](#) [Collapse all](#)
---
version: "V0"
language: "en"
---
# Advice when registering in the delivery module
## Multiple select Items and Occurrences/ individuals
You can change several Occurrences/individuals by hold down *Ctrl* or *Shift* keys while marking the occurrences/individuals you want to change.
When you have selectet several Items or Occurrences of Items a selection box will appear in front of each field in the "Edit" window. Use the checkbox to specify which fields you want to edit for all the selected Items/ occurrences. Select the fields you want to use and their value then click OK.
## Efficient registration
Register as much information as possible at the highest possible level. If you want to register delivery of an entire order, but with a few exceptions. Instead of registering this information for each individual item:
1. Select all the items which are complete, or the entire order,
2. Register that everything has been received
3. Remove the registration for those items which did not apply,
The efficient use of shortcut key combinations and shortcut keys will also make registration work much more simple
---
version: "V0"
language: "en"
---
# API
We support three different ways you can extend and automate your use of dRofus:
## [Admin system REST API](https://help.drofus.com/en/English/Learning/admin-system-rest-api.md)
This allows you to automate task related to creation and managing your projects. E.g. create new project, add/remove users etc.
## [Database REST API](https://help.drofus.com/en/English/Learning/drofus-rest-api.md)
This allows you to connect directly to your database/project and automate tasks and/or extract data to create your own reports/dashboard.
## [dRofus Embedded Property Pane](https://help.drofus.com/en/English/Learning/integrate-web-property-panel-in-your-application.md)
This allows you to add a live "window" into your dRofus data from another application. We handle everything with formatting and presentation and your integration only have to tell e.g. "Show properties for room X" based on a shared key (id, room number or other).
---
version: "V0"
language: "en"
---
# Apply Template to Rooms
The Apply Template option is available for all Rooms regardless of what the Status of the Room was set to previously. When you apply a Template to a Room it will set all statuses (Room Data, Item lists, Finishes) to the selected template.
1. Selecting the Room(s) within the Rooms List
2. Selecting "Apply Template" within the Ribbon. Window bellow will appear displaying the list of templates:
3. Select template
4. Select "ok" and window will appear:
5. Select which part(s) of the Room Template you would like to apply to the Room(s).
6. Select "ok"
The template has been added to the room
When using *Apply Template*to a room previous Room Data status and Room Data will be deleted and replaced with the ones from the selected Template. This is also communicated through a warning in the dRofus client
---
version: "V0"
language: "en"
---
# Approve Offer and Supplier
## Approve offer and supplier
You should approve both offer and supplier before you continue the registration process.
1. Follow the steps above to register New offer
2. Go to the first tab in the offer called "Offer"
3. Approve "Supplier" and "Offer" by clicking on the checkbox shown in the picture below
4. Click "Save"
---
version: "V0"
language: "en"
---
# ArchiCAD Add-On
Archicad Add-On allows for the integration of program data with designs, enabling the validation of building requirements and bidirectional synchronization between dRofus and project models.
* [Archicad Add-On Installation](https://help.drofus.com/en/English/Learning/archicad-add-on-installation.md)
* [dRofus in Archicad](https://help.drofus.com/en/English/Learning/drofus-panel-and-ribbon.md)
* [ArchiCAD Attribute Configurations](https://help.drofus.com/en/English/Learning/archicad-attribute-configurations.md)
* [ArchiCAD Zones](https://help.drofus.com/en/English/Learning/archicad-zones.md)
* [Room Filter in ArchiCAD](https://help.drofus.com/en/English/Learning/room-filter-in-archicad.md)
* [ArchiCAD Objects](https://help.drofus.com/en/English/Learning/archicad-objects.md)
* [Logging to Change List from ArchiCAD](https://help.drofus.com/en/English/Learning/logging-to-change-list-from-archicad.md)
---
version: "V0"
language: "en"
---
# Archicad Add-On Installation
## Standard installation
As soon as you install the latest version of dRofus and run it, you will be notified about the installation of the latest Archicad Add-On, if the Archicad Add-On was either not previously installed on your PC, or is out of date.
The dialog shown below will pop up:
All Archicad sessions will need to be closed at the time when you install / update or uninstall the Archicad Add-On.
If the Archicad Add-On has been uninstalled, then the next time you run an Archicad session, you will get the following message with options:
If the Archicad Add-On has already been installed, then the next time you run an Archicad session, a new menu called "dRofus" will appear as follows:
On the other hand - if you do not already have dRofus running, and you only run Archicad and attempt to Log in to the dRofus Add-On, if the version is out of date, you will get the following message:
## Manual installation
The other option is to install or update the Archicad Add-On manually.
In order to install or update the Archicad Add-On manually, you will have to open the dRofus and then carry out the following:
Once installed, you can also uninstall the Archicad Add-On by carrying out the following:
---
version: "V0"
language: "en"
---
# ArchiCAD Attribute Configurations
ArchiCAD Attribute Configurations is an essential concept within the dRofus Addon. This is where the *Key attribute used for comparing* is defined and where you specify what data should flow from ArchiCAD to dRofus and / or vice versa during synchronization.
In order to create, edit or delete ArchiCAD Attribute Configurations, we use the following selections within the *dRofus Menu*:
---
version: "V0"
language: "en"
---
# Archicad IFC GUIDs for all occurrences
## IFC GUIDs from Archicad to dRofus Occurrences
dRofus automatically adds the IFC GUID from every instance in Archicad to all corresponding occurrences in dRofus. The IFC GUID (Globally Unique Identifier) is critical for keeping each element distinct and traceable across different software platforms and project stages. This underpins reliable data exchange, robust change management, and seamless collaboration in BIM workflows.
**Why IFC GUIDs Matter**
* **Interoperability:** The IFC GUID acts as a universal key, allowing dRofus to match and synchronize data between Archicad and dRofus, as well as with other BIM tools that support the IFC standard. This ensures consistent information, even when models are exchanged or updated across systems.
* **Data Integrity \& Change Tracking:** Storing the IFC GUID for each occurrence lets dRofus track changes, manage versions, and avoid duplication-essential for large, collaborative projects.
* **Error Reduction:** Using the IFC GUID as a common key minimizes mismatches or data loss during import, export, or synchronization. This ensures updates propagate correctly throughout the project lifecycle.
* **Seamless Visualization \& Coordination:** IFC GUIDs enable dRofus to link 3D model elements directly to their associated data, supporting features like highlighting, selection, and data-driven navigation.
These IFC GUIDs are added to the background without being defined in the configurations.
Using Items in Room when occurrences are split, each row will show the IFC GUIDs
**How to Check IFC GUIDs in dRofus**
* *Has IFC GUIDs* column: Shows if any planned occurrences match modeled instances.
* *IFC GUIDs (text)* column: Displays the specific GUIDs extracted from Archicad.
Using Occurrences in the Item Module shows planned occurrences vs modeled instances.
**Example:**
If a room has a planned quantity of six and six IFC GUIDs are listed, all planned items are modeled. If a room has ten planned occurrences but only one IFC GUID, nine more instances need to be modeled to meet the plan.
## When Are IFC GUIDs Added to Occurrences?
| Precondition | Action in Archicad | Expected Result in dRofus | IFC Guids transferred to dRofus occurrences? |
|------------------------------------------------------------------------|---------------------------------------------------|---------------------------------------------------------------------|----------------------------------------------|
| Instance not linked to dRofus Item/Occurrence | dRofus Model Equipment panel → "Create in dRofus" | Item created and occurrence created with correct quantity and GUIDs | Yes |
| Instance linked to dRofus Item, no occurrence in dRofus exists | dRofus Model Equipment panel → "Add to dRofus" | Occurrence created, quantity and GUIDs match Archicad | Yes |
| Instance linked to dRofus Item, occurrence exists but quantity differs | dRofus Model Equipment panel → "Update in dRofus" | Occurrence updated, quantity and GUIDs match Archicad | Yes |
| Item linked, quantities differs | Synchronize Item occurrences | Occurrence updated, quantity and GUIDs match Archicad | Yes |
IFC GUIDs are always kept in sync to ensure every occurrence in dRofus accurately reflects the modeled instances in Archicad.
---
version: "V0"
language: "en"
---
# ArchiCAD Object to Item Configuration
To access the Object to Item Configuration panel, select the following highlighted within the *dRofus Menu*:
The *Object \<-\> Item Configuration Editor* dialog panel will then open as follows:
The main difference between the *Zone \<-\> Room Configuration Editor* and the *Object \<-\> Item Configuration Editor* dialogsis that (unlike *Zones)* , *Objects* do not have a common set of parameters. This is why the list of available ArchiCAD parameters within the *Object \<-\> Item Configuration Editor* dialog contains parameters only pertaining to the currently selected *Object* (or the default *Library Part* if there are no *Objects* selected, or only the common parameters if multiple-selected Objects have different sets of parameters).
Info
Of importance is the *Object* currently selected (or set as default) when you open the *Object \<-\> Item Configuration Editor* dialog.
Only parameters from the *Library Part* of the currently selected *Object* will be available within the dialog. Additionally, IFC properties will not appear within the *Object \<-\> Item Configuration Editor* dialog, unless you select at least one *Object* prior to opening the dialog. This also applies prior to carrying out the *Sync Objects with dRofus* command.
This means that you may want to create different configurations for parameters based on different groups of *Objects*. An example of such a configuration is shown below:
When you create a configuration for one type of *Object* (e.g. Chairs) and then switch to another type (e.g. Beds) and then open the *Object \<-\> Item Configuration Editor* dialog again, you will note that some ArchiCAD parameters defined in the configuration will be marked as "Missing parameters". It means that the currently selected *Object* type does not contain these parameters. However, this configuration can still be used for linking and synchronizing *Object* s. It just means that writing in to or from those missing parameters will be skipped for those *Objects* that don't contain these parameters, but will be updated for the other *Objects* at the time of synchronization.
It is also not necessary for the values within the *Key attribute used for comparing* to be common for all *Object* types in the Project. Those *Objects* that don't have the parameter will not be linked when such a configuration is used.
## Top Section:
* **Chose Configuration:** Drop down list of pre-defined configurations.
* **New:** Create a new configuration.
* **Copy:** Makes a copy of the active configuration.
* **Delete:** Deletes the active configuration.
* **Available to users**: If this is checked all Users can see / use this configuration. If not checked then only those who have BIM Administration access can use the configuration.
* **Is Default Configuration** : The User with BIM Administration access can set a configuration as default by checking this box. This will set the configuration as the default configuration used in all related dialogs (i.e., for synchronizing *Items* , linking *Items* etc.) for all Users.
Info
The configuration set as default will be used by all Users in the project. Please take care when changing configuration settings as it will affect the entire Project. As an alternative to changing the default configuration, you can select which configuration to use at a time when carrying out the linking or synchronization of *Objects* or when viewing the *Zone* (s)' *Model's Equipment* dialog.
The dRofus Addon always has a configuration called "Default" for *Object \<-\> Item Configurations* . This "Default" configuration cannot be edited, but you can copy it and then make modifications to the copied configuration. If you set another configuration as *default* , the configuration called "Default" will actually no longer be the *default* configuration.
## 'Attributes not linked' Section:
* **dRofus attribute** (left-hand side)**:** This is a list of all the available dRofus attributes which you can synchronize data to / from that are not already in the current configuration.
* **ArchiCAD parameter** (right-hand side)**:** This is a list of all the available ArchiCAD parameters which you can synchronize data to / from that are not already in the current configuration. This list will be based on either the *Library Part* of the currently selected *Object* , or only the common parameters (if multiple-selected Objects have different sets of parameters), or the default *Library Part* (if there are no *Objects* selected).
If any of the attributes or parameters are in grey tone, it means that it is a read-only attribute / parameter, and therefore you can only synchronize data **from** this attribute / parameter and not **to**.
## 'Linked Attributes' Section:
**Select a Key Attribute to be used for matching:** *S*elect a dRofus Attribute and an ArchiCAD Parameter, then click on "Link ==".
Every configuration is required to have only one mapping as the *Key attribute used for comparing* . For Item configurations, it is recommended that the dRofus *Item ID* or the *Item Number* attribute is used as the *Key attribute used for comparing* as they are guaranteed to be unique (at least within dRofus) so it will be easy to spot deviations in Items if changes happen in either ArchiCAD or dRofus.
When linking *Objects* to *Items* , the key value is read from dRofus and then written in to ArchiCAD (unless the ArchiCAD parameter is read-only or the dRofus parameter is empty - in which case the key value is read from ArchiCAD and then written in to dRofus). The following is an example of an *Object \<-\> Item Configuration* where the *Item ID* is used as the key, and the values against the *Item ID* attribute in dRofus gets injected in to a parameter called *Object ID* under *Object* in ArchiCAD, after which the link between the dRofus *Items* and ArchiCAD *Objects* will then be maintained:
**Write data to Model:** Select a dRofus attribute, then select an ArchiCAD parameter and then click on "Link --\>". Next time the configuration is used for linking or synchronizing, the data flow direction will be from dRofus to ArchiCAD - i.e., values from the *Items* ' selected dRofus attribute will be written in to the *Objects*' selected ArchiCAD parameter.
**Write data to dRofus:** Select a dRofus Attribute, then select an ArchiCAD parameter and then click on "Link \<--". Next time the configuration is used for linking or synchronizing, the data flow direction will be from ArchiCAD to dRofus - i.e., values from the *Objects* ' selected ArchiCAD parameter will be written in to the *Items*' selected dRofus attribute.
**Unlink:**Select an existing mapping within the list of linked attributes / parameters and then click on "Unlink".
---
version: "V0"
language: "en"
---
# ArchiCAD Object to Item Occurrence Configuration
To access the Object to Item Occurrence Configuration panel, select the following within the *dRofus Menu*:
The *Object \<-\> Item Occurrence Configuration Editor* dialog will then open as follows:
The main difference between the *Zone \<-\> Room Configuration Editor* and the *Object \<-\> Item Occurrence Configuration Editor* dialog panelsis that (unlike *Zones)* , *Objects* do not have a common set of parameters. This is why the list of available ArchiCAD parameters within the *Object \<-\> Item Occurrence Configuration Editor* dialog contains parameters only pertaining to the currently selected *Object* (or the default *Library Part* if there are no *Objects* selected, or only the common parameters if multiple-selected Objects have different sets of parameters).
Info
The choice of selected *Object* (or set as default) is important when the *Object \<-\> Item Occurrence Configuration Editor* dialog panel is opened. Only parameters from the *Library Part* of the currently selected *Object* will be available within the dialog.
In addition, IFC properties will not appear within the *Object \<-\> Item Occurrence Configuration Editor* dialog, unless you select at least one *Object* prior to opening the dialog. This also applies prior to carrying out the *Sync Instance Data with dRofus* command.
This means that you may want to create different configurations for parameters based on different groups of *Objects*. An example of such a configuration is shown below:
When you create a configuration for one type of *Object* (e.g. Chairs) and then switch to another type (e.g. Beds) and re-open the *Object \<-\> Item Occurrence Configuration Editor* dialog, you will note that some ArchiCAD parameters defined in the configuration will be marked as "Missing parameters". It means that the currently selected *Object* type does not contain these parameters. However, this configuration can still be used for linking and synchronizing *Object Instance* s. It just means that writing in to or from those missing parameters will be skipped for those *Object Instances* that don't contain these parameters, but will be updated for the other *Object Instances* at the time of synchronization.
It is also not necessary for the values within the *Key attribute used for comparing* to be common for all *Object* types in the Project. Those *Objects* that don't have the parameter will not be linked when such a configuration is used.
## Top Section:
* **Chose Configuration:** Drop down list of pre-defined configurations.
* **New:** Create a new configuration.
* **Copy:** Makes a copy of the active configuration.
* **Delete:** Deletes the active configuration.
* **Available to users**: If this is checked all Users can see / use this configuration. If not checked then only those who have BIM Administration access can use the configuration.
* **Is Default Configuration** : The User with BIM Administration access can mark one of the configurations as default by checking this. This will set the configuration as the default configuration used in all related dialogs (i.e., for synchronizing *Item Occurrences* , linking *Item Occurrences* etc.) for all Users.
Info
The configuration set as default will be used by all Users in the project. Please take care when changing configuration settings as it will affect the entire Project. As an alternative to changing the default configuration, you can select which configuration to use at a time when carrying out the linking or synchronization of *Object Instances* or when viewing the *Zone* (s)' *Model's Equipment* dialog.
The dRofus Addon always has a configuration called "Default" for *Object \<-\> Item Occurrence Configurations*. This "Default" configuration cannot be edited, but you can copy it and then make modifications to the copied configuration.
If you set another configuration as *default* , the configuration called "Default" will actually no longer be the *default* configuration.
## 'Attributes not linked' Section:
* **dRofus attribute** (left-hand side)**:** This is a list of all the available dRofus attributes which you can synchronize data to / from that are not already in the current configuration. Note that (in addition to dRofus *Items* ' Type-based attributes), there are also dRofus *Item Occurrences*' Instance-based attributes available.
* **ArchiCAD parameter** (right-hand side)**:** This is a list of all the available ArchiCAD parameters which you can synchronize data to / from that are not already in the current configuration. This list will be based on either the *Library Part* of the currently selected *Object* , or only the common parameters (if multiple-selected Objects have different sets of parameters), or the default *Library Part* (if there are no *Objects* selected).
If any of the attributes or parameters are in grey tone, it means that it is a read-only attribute / parameter, and therefore you can only synchronize data **from** this attribute / parameter and not **to**.
## 'Linked Attributes' Section:
**Select a Key Attribute to be used for matching:** *S* elect a dRofus Attribute and an ArchiCAD Parameter, then click on "Link ==". Every configuration is required to have only one mapping as the *Key attribute used for comparing* . For Item Occurrence configurations, it is recommended that the dRofus *ID* is used as the *Key attribute used for comparing* as it is guaranteed to be unique (at least within dRofus) so it will be easy to spot deviations in Item Occurrences if changes happen in either ArchiCAD or dRofus. When linking *Object Instances* to *Item Occurrences* , the key value is read from dRofus and then written in to ArchiCAD (unless the ArchiCAD parameter is read-only or the dRofus parameter is empty - in which case the key value is read from ArchiCAD and then written in to dRofus). The following is an example of an *Object \<-\> Item Occurrence Configuration* where the*ID* is used as the key, and the values against the *ID* attribute in dRofus gets injected in to a parameter called *A* under *Object* in ArchiCAD, after which the link between the dRofus *Item Occurrences* and ArchiCAD *Object Instances* will then be maintained:
**Write data to Model:** Select a dRofus attribute, then select an ArchiCAD parameter and then click on "Link --\>". Next time the configuration is used for linking or synchronizing, the data flow direction will be from dRofus to ArchiCAD - i.e., values from the *Item Occurrences* ' selected dRofus attribute will be written in to the *Object Instances*' selected ArchiCAD parameter.
**Write data to dRofus:** Select a dRofus Attribute, then select an ArchiCAD parameter and then click on "Link \<--". Next time the configuration is used for linking or synchronizing, the data flow direction will be from ArchiCAD to dRofus - i.e., values from the *Object Instances* ' selected ArchiCAD parameter will be written in to the *Item Occurrences*' selected dRofus attribute.
**Unlink:**Select an existing mapping within the list of linked attributes / parameters and then click on "Unlink".
---
version: "V0"
language: "en"
---
# ArchiCAD Objects
The ArchiCAD Add-On enables you to synchronize information between ArchiCAD *Objects* and dRofus *Items* as well as maintain synced *Item Lists* for ArchiCAD Zones with dRofus *Rooms*.
To use this functionality ArchiCAD *Zones* must be linked with the corresponding dRofus *Rooms*.
The ArchiCAD *Objects* must also be linked with the corresponding dRofus *Items* . dRofus *Items* can be linked with ArchiCAD *Objects* of many element types, including *Doors, Windows, Walls, Curtain Walls, Slabs, Electrical Equipment, Lighting Fixtures, Columns, Beams, Roofs, Morphs, Shells, Skylights, Railings* and *Stairs*.
This chapter describes the processes for linking and synchronizing *Item* *Types* , *Item Occurrences* , as well as comparing and managing dRofus' *Items in Rooms* vs ArchiCAD's *Objects in Zones*.
---
version: "V0"
language: "en"
---
# ArchiCAD Zone to Room Configuration
To access the Zone to Room Configuration panel, select the following within the *dRofus Menu*:
The *Zone \<-\> Room Configuration Editor* dialog will then open as follows:
## Top Section:
* **Chose Configuration:** Provides a drop down list of pre-defined configurations.
* **New:** Create a new configuration.
* **Copy:** Makes a copy of the active configuration.
* **Delete:** Deletes the active configuration.
* **Available to users**: If this is checked all Users can see/use this configuration. If not checked then only those who have BIM Administration access can use the configuration.
* **Is Default Configuration** : The User with BIM Administration access can mark one of the configurations as default by checking this item. This will set the configuration as the default configuration used in all related dialog panels (i.e., for synchronizing *Rooms* , linking *Rooms* , place-linking *Rooms* etc.) for all Users.
Info
The configuration set as default will be used by all Users in the project. Please take care when changing configuration settings as it will affect the entire Project. As an alternative to changing the default configuration, you can select which configuration to use at a time when carrying out the linking or synchronization of *Zones* or when viewing the *Zone* (s)' *Model's Equipment* dialog.
IFC properties will not appear within the *Zone \<-\> Room Configuration Editor* dialog, unless you select at least one *Zone* prior to opening the dialog. This also applies prior to carrying out the *Sync Zones with dRofus* command.
The dRofus Addon always has a configuration called "Default" for *Zone \<-\> Room Configurations* . This "Default" configuration cannot be edited, but you can copy it and then make modifications to the copied configuration. If you set another configuration as *default* , the configuration called "Default" will actually no longer be the *default* configuration.
## 'Attributes not linked' Section:
* **dRofus attribute** (left-hand side)**:** This is a list of all the available dRofus attributes which you can synchronize data to / from that are not already in the current configuration.
* **ArchiCAD parameter** (right-hand side)**:** This is a list of all the available ArchiCAD parameters which you can synchronize data to / from that are not already in the current configuration. This list is based on the available parameters in *Zone Stamps* currently in use by the *Zone Category*.
If any of the attributes or parameters are in grey tone, it means that it is a read-only attribute / parameter, and therefore you can only synchronize data **from** this attribute / parameter and not **to**.
## 'Linked Attributes' Section:
**Select a Key Attribute to be used for matching:** *S* elect a dRofus Attribute and an ArchiCAD Parameter, then click on "Link ==". Every configuration is required to have only one mapping as the *Key attribute used for comparing*.
For Room configurations, it is recommended that the dRofus *Room ID* or the *Room Function Number* attribute is used as the *Key attribute used for comparing* as they are guaranteed to be unique (at least within dRofus) so it will be easy to spot deviations in Rooms if changes happen in either ArchiCAD or dRofus.
When linking *Zones* to *Rooms* , the key value is read from dRofus and then written in to ArchiCAD (unless the ArchiCAD parameter is read-only or the dRofus parameter is empty - in which case the key value is read from ArchiCAD and then written in to dRofus). The following is an example of a *Zone \<-\> Room Configuration* where the *Room ID* is used as the key, and the values against the *Room ID* attribute in dRofus gets injected in to a parameter called *UserData* under *InternalData* in ArchiCAD, after which the link between the dRofus *Rooms* and ArchiCAD *Zones* will then be maintained:
**Write data to Model:** Select a dRofus attribute, then select an ArchiCAD parameter and then click on "Link --\>". Next time the configuration is used for linking or synchronizing, the data flow direction will be from dRofus to ArchiCAD - i.e., values from the *Rooms* ' selected dRofus attribute will be written in to the *Zones*' selected ArchiCAD parameter.
**Write data to dRofus:** Select a dRofus Attribute, then select an ArchiCAD parameter and then click on "Link \<--". Next time the configuration is used for linking or synchronizing, the data flow direction will be from ArchiCAD to dRofus - i.e., values from the *Zones* ' selected ArchiCAD parameter will be written in to the *Rooms*' selected dRofus attribute.
**Unlink:**Select an existing mapping within the list of linked attributes / parameters and then click on "Unlink".
[Next Page](https://help.drofus.com/llms-full.txt/1)