Difference between revisions of "MicroMVDs for exchange requirements/Project setup MicroMVD"

From Wiki.OSArch
(Created page with "The following MicroMVD vocabulary can be used to ensure basic project metadata is set, as a minimum requirement for all BIM proje...")
 
 
(20 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
{{Template:MVD_Documentation}}
 
The following [[Using MicroMVDs for exchange requirements|MicroMVD]] vocabulary can be used to ensure basic project metadata is set, as a minimum requirement for all BIM projects.
 
The following [[Using MicroMVDs for exchange requirements|MicroMVD]] vocabulary can be used to ensure basic project metadata is set, as a minimum requirement for all BIM projects.
 +
 +
<pre>
 +
Feature: Project setup
 +
 +
In order to ensure quality of the digital built environment
 +
As a responsible digital citizen
 +
We expect compliant OpenBIM deliverables
 +
 +
Scenario: Receiving a file
 +
* IFC data must use the "{schema}" schema
 +
 +
Scenario: Exempt files
 +
* The IFC file "{file}" is exempt from being provided
 +
* No further requirements are specified because "{reason}"
 +
 +
Scenario: Project metadata is organised and correct
 +
* The project must have an identifier of "{guid}"
 +
* The project name, code, or short identifier must be "{name}"
 +
* The project must have a longer form name of "{long_name}"
 +
* The project must be described as "{description}"
 +
* The project must be categorised under "{object_type}"
 +
* The project must contain information about the "{phase}" phase
 +
 +
Scenario: Project geometry is stored
 +
* The project must contain 3D geometry representing the shape of objects
 +
</pre>
 +
 +
You can fill out the variables using the guide below.
  
 
{| class="wikitable"
 
{| class="wikitable"
−
! Test definition
+
! Variable
−
! Justification
+
! Example
 +
! Description
 +
|-
 +
| <code>{file}</code>
 +
| project.ifc
 +
| The filename or path to any IFC file.
 +
|-
 +
| <code>{schema}</code>
 +
| IFC4
 +
| The schema version. At the moment, these are likely to be either IFC4 or IFC2X3.
 
|-
 
|-
−
| <code>Given the IFC file "{file}"</code>
+
| <code>{reason}</code>
−
| An IFC-SPF file is the expected format for a project.
+
| we don't need it
 +
| You can write anything here to describe any reason.
 
|-
 
|-
−
| <code>Then the file should be an {schema} file</code>
+
| <code>{guid}</code>
−
| Project data must conform to a client-nominated schema. The <code>{schema}</code> may be IFC2X3 or IFC4 in general.
+
| 28q3AgmxP5cepIweO5Of$o
 +
| This is a 22 character GlobalId for a particular IFC element.
 
|-
 
|-
−
| <code>Then the project has a Name attribute with a value of "{value}"</code>
+
| <code>{name}</code>
−
| A project must have a name given to it.
+
| 123FOO
 +
| A short project code or name used to uniquely identify the project, either specified by the client or the BIM author
 
|-
 
|-
−
| <code>Then the project has a LongName attribute with a value of "{value}"</code>
+
| <code>{long_name}</code>
−
| A project generally also has a longer name associated with it.
+
| 123 Foo Street, Tower B Redevelopment
 +
| The full project name used to uniquely identify the project, either specified by the client or the BIM author
 
|-
 
|-
−
| <code>Then the project should have geolocation data</code>
+
| <code>{description}</code>
−
| This checks for geolocation according to the buildingSMART recommendation in IFC2X3 and the native elements in IFC4.
+
| Redesign of southwest atrium of Tower B to a two-storey space with new interior fitout
 +
| A description of what the project is about, to help clarify the project scope
 
|-
 
|-
−
| <code>Given there is at least one IfcSite element</code>
+
| <code>{object_type}</code>
−
| Most projects have a site.
+
| Commercial
 +
| If the project is categorised as a particular arbitrary type, it may be described here. Example categories could be "Residential", "Retail", "Commercial", "Health" and "Defence". Alternatively, it could be categorised as "Civic", "Infrastructure".
 
|-
 
|-
−
| <code>Then there is an IfcSite element with a Name attribute with a value of "{value}"</code>
+
| <code>{phase}</code>
−
| If a site exists, it typically has a name.
+
| A
 +
| If the project is phased or staged, the phase or stage name may be placed here.
 +
|}
 +
 
 +
=Software guides=
 +
 
 +
{| class="wikitable"
 +
!rowspan="2"|Icon
 +
!rowspan="2"|Software
 +
!colspan="2"|Certified Version
 +
!rowspan="2"|Notes
 +
!rowspan="2"|Guides
 
|-
 
|-
−
| <code>Given there is at least one IfcBuilding element</code>
+
! Import
−
| Most projects have a building.
+
! Export
 
|-
 
|-
−
| <code>Then there is an IfcBuilding element with a Name attribute with a value of "{value}"</code>
+
| [[File:Icon ArchiCAD.jpg|64x64px]]
−
| If a building exists, it typically has a name.
+
| [[ArchiCAD]]
 +
| style="background-color: #b6cca1;" | ArchiCAD 23
 +
| style="background-color: #ffd37f;" | ArchiCAD 23
 +
| <code>GlobalId</code> cannot be overridden during export
 +
| [[ArchiCAD project setup]] describes how to set these project attributes
 +
|-
 +
| [[File:BlenderBIM_Addon_logo.png|64x64px]]
 +
| [[BlenderBIM Add-on]]
 +
| style="background-color: #b6cca1;" | v0.0.200722
 +
| style="background-color: #b6cca1;" | v0.0.200722
 +
|
 +
|
 +
|-
 +
| [[File:icon_FreeCAD.png]]
 +
| [[FreeCAD]]
 +
| style="background-color: #ffd37f;" | 0.19pre
 +
| style="background-color: #ffd37f;" | 0.19pre
 +
| <code>GlobalId</code> cannot be overridden during export. The project <code>Name</code> is not maintained during import.
 +
|
 +
|-
 +
| [[File:Icon Revit.png|64x64px]]
 +
| [[Autodesk Revit|Revit]]
 +
| style="background-color: #fbb4a8;" | Revit 2019.2 IFC 8/5/2020
 +
| style="background-color: #b6cca1;" | Revit 2019.2 IFC 8/5/2020
 +
| During import, the project <code>GlobalId</code> is maintained, but all other metadata is lost.
 +
| [[Revit project metadata]] describes how to set these project attributes
 +
|-
 +
| [[File:Tekla-logo.png|64x64px]]
 +
| [[Tekla]]
 +
|
 +
|
 +
|
 +
|
 
|}
 
|}
 +
 +
[[Category:Model View Definitions (MVD)]] [[Category:Autodesk Revit]] [[Category:BIMTester]] [[Category:MicroMVD]]

Latest revision as of 07:22, 28 July 2022


BuildingSMART-Logo 64x64.png This page is about MVD - Model View Definitions. Full documentation is available at the buildingSMART site. All articles in the OSArch wiki related to Model View Definitions (MVD) can be seen in the Model View Definitions (MVD) Category

The following MicroMVD vocabulary can be used to ensure basic project metadata is set, as a minimum requirement for all BIM projects. 

Feature: Project setup

In order to ensure quality of the digital built environment
As a responsible digital citizen
We expect compliant OpenBIM deliverables

Scenario: Receiving a file
 * IFC data must use the "{schema}" schema

Scenario: Exempt files
 * The IFC file "{file}" is exempt from being provided
 * No further requirements are specified because "{reason}"

Scenario: Project metadata is organised and correct
 * The project must have an identifier of "{guid}"
 * The project name, code, or short identifier must be "{name}"
 * The project must have a longer form name of "{long_name}"
 * The project must be described as "{description}"
 * The project must be categorised under "{object_type}"
 * The project must contain information about the "{phase}" phase

Scenario: Project geometry is stored
 * The project must contain 3D geometry representing the shape of objects

You can fill out the variables using the guide below.

Variable Example Description
{file} project.ifc The filename or path to any IFC file.
{schema} IFC4 The schema version. At the moment, these are likely to be either IFC4 or IFC2X3.
{reason} we don't need it You can write anything here to describe any reason.
{guid} 28q3AgmxP5cepIweO5Of$o This is a 22 character GlobalId for a particular IFC element.
{name} 123FOO A short project code or name used to uniquely identify the project, either specified by the client or the BIM author
{long_name} 123 Foo Street, Tower B Redevelopment The full project name used to uniquely identify the project, either specified by the client or the BIM author
{description} Redesign of southwest atrium of Tower B to a two-storey space with new interior fitout A description of what the project is about, to help clarify the project scope
{object_type} Commercial If the project is categorised as a particular arbitrary type, it may be described here. Example categories could be "Residential", "Retail", "Commercial", "Health" and "Defence". Alternatively, it could be categorised as "Civic", "Infrastructure".
{phase} A If the project is phased or staged, the phase or stage name may be placed here.

Software guides[edit]

Icon Software Certified Version Notes Guides
Import Export
Icon ArchiCAD.jpg ArchiCAD ArchiCAD 23 ArchiCAD 23 GlobalId cannot be overridden during export ArchiCAD project setup describes how to set these project attributes
BlenderBIM Addon logo.png BlenderBIM Add-on v0.0.200722 v0.0.200722
Icon FreeCAD.png FreeCAD 0.19pre 0.19pre GlobalId cannot be overridden during export. The project Name is not maintained during import.
Icon Revit.png Revit Revit 2019.2 IFC 8/5/2020 Revit 2019.2 IFC 8/5/2020 During import, the project GlobalId is maintained, but all other metadata is lost. Revit project metadata describes how to set these project attributes
Tekla-logo.png Tekla
Retrieved from "https://wiki.osarch.org/index.php?title=MicroMVDs_for_exchange_requirements/Project_setup_MicroMVD&oldid=5179"