revit family creation standards

bimstore bible 1

Revit family creation standards

V1.0-Revit US Edition

44 bimstore bible

The purpose of this guide is to define bimstore guidelines and standards for model content creation in Revit Architecture, Revit MEP, and Revit Structure. Model content refers to the two-dimensional and three-dimensional standard component families that are used to create elements that represent manufactured or generic content (for example, windows, doors, furniture, and plumbing fixtures).

By following the guidelines and standards in this document, content creators will ensure the portability and performance of their content in a BIM process. This will meet the baseline standard to be hosted on bimstore, because we ensure that our components shall:

Display uniformly regardless of context Be a standard, complete, consistent, accurate and uniform representation of the components. Be compatible with recognised industry standards Ensure the component is usable throughout the BIM process, from early conceptual design through

to Facilities Management and operation of the building

2 bimstore.us bible (v1.0-Revit)

When creating a Revit family, the intended use of the family in a project environment determines the extent to which it is designed. You can design all families to include a number of representations for use in different project views and project phases.

The type and size of the project that a family is intended for use in is a critical point to consider when deciding which representations should be included in the family and which level of detail each representation should have. The more detailed a family is, the larger its file size will be. The larger the file size, the slower the performance, loading, and regeneration time of the family will be. When considering the design intent of a family, use the following guidelines:

2.1. Determining the template to use

For objects typically hosted by other components, such as a window or light fixture, start with a host-based template. For example, for a window or door, use a wall-based template, such as Window.rft or Door.rft. How the family is hosted (or what it does or does not attach to) determines which template should be used to create the family. It is important to understand that you cannot easily swap between a hosted and generic template so being considerate of this decision early on will prevent against unnecessary remodelling. In general, the choice of a template is driven by the host of the object, with the following exceptions:

Floor-based objects typically use a level-based template unless they are required to cut the floor. For example, furniture objects are created with a level-based template.

For objects that are designed to be used in more than one discipline, such as plumbing or lighting fixtures, use a host based template that allows the greatest flexibility for all disciplines. For example, a lighting fixture used exclusively in an architectural discipline could be created with a ceiling or wall-based template, but for an engineering environment, a face-based template is required for the model linking workflow. Therefore, for a lighting fixture that will be used in both disciplines, use a face-based template


2.2. Determine the family’s use

Before you even open Revit, grab a piece of paper and plan your family. Although it may be tempting to jump straight in and start building your family, this can cause you problems later.

Some of the questions you will need to establish are:

Is the family a generic family or a family based upon manufacturer-specific content? – This is a fundamental question to establish early on. Generally, a manufacturer’s content will be created with fewer parameters than generic content. For example, if a manufacturer only makes one table size, then why add a parameter to change its length?

Which parameters does the family need? – Think about which parameters are required. Adding additional unnecessary parameters will increase model size and decrease its performance. A simple rule of thumb is to think about which parameters may require scheduling and ensure those are added to the family. It is easier to add other schedulable parameters further down the road so work in stages as the family is being built to cut down on unnecessary bloat.

What template should you use? – See section 2.1. This is a critical decision that will affect how the family behaves, displays, and schedules within your model. Taking the extra time when starting a new family will save valuable time spent using the wrong template down the road.

Family Intent & Purpose – Establish what the family is going to be used for and model appropriately for its intended use. Is the family an all purpose family that can be used from concept to construction or is it more targeted at a specific phase i.e. construction?

Level of Detail – This is an important concept covered in section 2.3. Decide early on what the family representations will be at the different levels of detail (Coarse, Medium and Fine).

Use the family planning checklist in appendix 01 to assist you in this process.


2.3. Level of Detail

Detail levels determine which pieces of family geometry and linework display within the different types of project views. When a Revit element is created with a family and added to a project view, the current detail level of the view (Coarse, Medium, or Fine) displays the appropriate family geometry.

Families that include intricate levels of detail can impede performance if not managed properly. For optimal family performance, only the necessary family geometry should be modelled and the use of highly detailed representations should be assigned to an appropriate detail level.

When deciding which level of detail should be shown, use the following recommendations:

Do not model geometry that will not be visible when the family is added to a building model. For example, for a table family that includes a drawer, model the face only, not the entire drawer and its contents

Do not duplicate geometry that can be used for different levels of detail

Depending on the type of family, use the following guidelines when modelling geometry:

If the geometry is... Set detail level to...

Smaller than 1” Fine

1” – 2” Medium

Larger than 1.5” Coarse

Level of detail must be utilised on all families, regardless of type, using common sense to what is shown at each detail level.


2.4. Element visibility

Typically, the geometry of an element created in a family will change depending on the current project view. The visibility settings of the family determine in which project views elements created with the family will display.

In a plan view, you may want to see a 2D representation of the element. In a 3D or elevation view, you may want to display a fully detailed 3D representation of the element. In other views, you may want to hide the element. Limiting the visibility of highly detailed family geometry to only certain views can improve project performance.

For some object types you will need a means of displaying a graphical NCS Version 6. The level of detail and convention shall be appropriate to the construction product and scale. The NCS Version 6 conventions should be followed and shall be a representation, a simplified representation or a symbol.

IMPORTANT: Please contact bimstore content team if you are unsure if your object type has a symbolic object requirement as depending on object type the symbolic representation may be required across detail levels as per section 2.3


2.5. Nesting Families

A nested family is one that has been loaded into another family. In some cases, it can be convenient to represent parts of the nested family separately from the main family model. For example, you could create a door handle ironmongery family and load this into the door family. This allows you to build upon previous work while creating families suited to your needs.

Nesting family recommendations:

Instead of nesting, consider creating all of the necessary geometry in the family. Use reference lines and labels to lock geometry in place

Limit nesting to two levels - the deeper that families are nested, the longer they take to update in the project file

Only nest high-value content that may be used in several different families, such as a door handle

Be careful when changing a nested component that is shared by more than one family. When you reload the component into the project file it will update all of the families in the file sharing the same nested family. You can stop this behaviour by un-ticking the “shared” button in the “category and parameters” dialogues

No more than six nested families should be nested into a single family

IMPORTANT: It is important to understand that nesting families increases the file size and affects performance, specifically the regeneration process of the family views. Remember to purge your nested families as well as your main host family before packaging for issue.


2.6. Family Size

Although not as important as it was prior to Revit 2010, many large components can affect the performance of a Building Information Model.

It is recommended to keep components’ file sizes as small as possible. This must be considered carefully however, as one very large parametric family (that can be configured to almost any configuration) will be loaded into a project only once. The alternative would be many smaller individual families, but these combined can be larger (and just as cumbersome) as a single large flexible component.

It is recommended that a typical family be no larger than around 700kb, however every family and its functionality is unique so this can vary.

We recommend the following to keep your family as small as possible:

Purge and audit your family prior to upload (Be careful not to remove any material types you may have added!)

Keep nesting to a minimum, and ensure the nested objects are also purged and audited, including removing any unused types!

Limit the use of custom materials and bitmaps whenever possible. With large material libraries, it is best practise to have a material/finishes download to accompany the family instead of embedding each material/finish into the family file

Only model what is required to an appropriate level of detail. You will excite no one with your threads on screws!

Remove any CAD or images used while building your component, and purge to make double sure they’ve been removed!

Never explode CAD into your family

IMPORTANT: It is crucial to understand that nesting families increases the file size and affects performance, specifically the regeneration process of the family views. Remember to purge your unused nested families as well as your main host family before packaging for issue.


2.7. Space data and clearance zones

The BIM object may include 2D and 3D space zones to assist the specifier in placing or specifying the object:

Minimum operation space

Access and Maintenance spaces

Placement and transportation space

Installation space

Detection zone space

Clearance zones

When space zones are used in an object their visibility must be controlled by a yes/no parameter and a clearly labelled subcategory per the type of space and should be set not to display by default.

Example of clearance zone around a boiler

Example of a swing zone on a valve leaver


2.8. Areas to avoid for optimal performance

Below are some of the common mistakes that are made when creating content for Autodesk Revit. After planning your family review this table to prevent you making the same mistakes.

Common mistakes when creating families Recommended approach

Lack of planning prior to family creation Before creating a family, use the guidelines outlined in 2.0 Planning a Revit Model Family

Unnecessary parametric relationships Before adding geometry to a family: 1) Plan the parametric relationships and create a

reference plane skeleton that features the main parametric relationships

2) Build only the parametric family behaviour that you need to avoid over-constraining the model

High levels of geometric detail and underuse of visibility settings

Use the guidelines in the Level of Detail and Element Visibility sections of this guide to avoid unnecessarily large family files

Use of geometry instead of symbolic lines in plan views In plan view representations, geometry usually can be represented with symbolic lines, rather than (solid) geometry. Using geometry instead of symbolic lines will create an unnecessarily large family

Overuse of voids, formulas, and arrays Extensive use of voids, formulas, and arrays will add to the overall family size and affect its performance in projects

Use of too many nested families (families imported into other families)

Nest families to create geometry in other families only when necessary. Only use nested content to share objects among multiple families, for example, door hardware, muntin patterns, and so on

Large families with many types that do not include type catalogues

The more types (particularly unused) the heavier the family. Create type catalogues for families that contain eight or more types

Inadequate family testing See section 13.0 General Family Testing Guidelines


Before you create a model family, review the standards in this section, and then use the best practice workflow below to create your content.

This workflow helps to ensure that your content is created in the most efficient and least error prone manner.

Create a new family file (.rfa) with the appropriate bimstore family template.

Define subcategories for the family to help control the visibility of the family geometry. Keep

the naming conventions consistent across each family.

Create the family skeleton, or framework, usually using reference planes or reference lines;

Define the origin (the insertion point) of the family. In most families the template will

already have this defined. The insertion point should reflect the part of the family that will

be most used when placing into a project (i.e. a wall hosted light fixtures origin will be the

face of the wall.) The insertion point is the point around which the geometry will rotate

around using the space bar on placement or during a generic rotation, so think about how

the family will be used before hand.

Lay out reference planes to snap to when you sketch component geometry.

Add dimensions to specify parametric relationships.

Label dimensions to create type or instance parameters or 2D representation.

Test, or flex, the skeleton. This is the best time to get the bugs out. Once geometry is

added other areas can be affected so ensure the “skeleton” is working perfectly before

moving on to the next step.

Define family type variations by specifying different parameters.

Add a single level of geometry in solids and voids, and constrain the geometry to reference

planes.

Flex the new model (types and its hosts) to verify correct component behaviour.

Repeat previous steps until the family geometry is complete.

Specify 2D and 3D geometry display characteristics with subcategory and entity visibility

settings

Save the family, and perform a final test.

Load into a Revit project and perform a copy, rotate, mirror and array, and ensure the family

behaves as built based on visibility setting as well.

For large families that include many types (over 8), create a type catalogue to accompy the .rfa

during download.


3.1. Areas to avoid for optimal performance

If you need to create a number of similar families, plan and create a “prototype family”. Test the prototype family (section 13) in the family editor and in a project environment to identify any problem areas and inconsistencies.

Correct any errors and inconsistencies and retest the family to ensure it works properly before creating any additional families. This prototype family can now be stripped and used as a template and a benchmark for the additional families.

3.2. Conversion from fabrication/digital prototyping software

We understand that many product manufacturers and content creators may already have digital models of their products in platforms such as Autodesk Inventor, Solidworks, Catia and Siemens NX etc.

Models produced in these platforms are generally created for digital prototyping and fabrication purposes and as such are not suitable for consumption by a parametric BIM platform such as Autodesk Revit.

IMPORTANT: If you have digital content available please contact us to discuss how this content may or may not be used in the creation of your BIM content.

3.2.1 Autodesk Exchange Format

Starting in the 2010 release of Autodesk products, the Autodesk Exchange format (.ADSK) provides a method for manufacturers to leverage Digital Prototypes to produce Revit Families in the Autodesk Exchange Format (.ADSK). In Revit 2015 onwards the tool was further improved to convert Autodesk Inventor geometry to native Revit geometry, however this rarely works on anything but the most basic content.

bimstore only accept native Revit geometry, and currently do not accept the .ADSK exchange format for content due to known limitations around LOD, .SAT import issues and limited functionality as highlighted below:

As a result of the model simplification process in Inventor and differences between the Inventor and AEC product’s parametric geometry handling, the geometry that is currently produced for AEC applications through the AEC Exchange Environment is static, and cannot be edited directly by the Revit user. It will appear as imported geometry (.SAT format).


ADSK files do not currently contain visual appearance information, and there is no way within Revit products to manually modify their appearance.

ADSK files do not currently support Revit Hosting behaviour, and therefore the content cannot be placed on Faces of Building Elements, or have holes cut in them. Integrating the content into a Revit family (.rfa) file can help remove this limitation.

Light Source Definitions cannot currently be defined in ADSK files, and thus must be manually added in the Revit environment if needed. Integrating them into a Revit family (.rfa) file can help remove this limitation.


All content created by bimstore US must be created in Imperial units. This is established at template selection. If your content is intended for international distribution this can be changed fairly easily to suit local standards.

Although families can be created as unit-specific (imperial or metric), Revit software stores all coordinates in universal units and displays specific units according to user preference. This means that:

Units can be set to display as necessary for a target audience (i.e., display as decimal units for a civil engineering drawing or fractional units for an architectural drawing).

Families created in imperial units may be loaded into and used in metric projects and vice versa.

Although reverse engineering someone else’s family can cause unforeseen problems, sometimes it is necessary. When reverse engineering a family, it may be necessary to change the units of the family to aid the reverse engineering process. For more information on how to do this refer to the Revit Help Documentation.


Family names are the primary means of identifying families in the Revit software. The naming conventions include descriptions that allow the user to search for families by element, by manufacturer, and/or base units.

5.1. Family (component) naming

Guidelines

Create unique names for each family. For example, a fixed window family and a fixed door family cannot share the same name

Use natural language to name a family. The family name should describe how the family is identified in the real world (i.e, in catalogues, by manufacturer, etc)

If possible, do not include the family category in the family name, unless the functional type is the same as the category (eg. Window)

Use ‘Title Casing’ (as with the title of a book) for family names, as they are case sensitive. Keep file names as short as possible. Family names must display in dialogues and in the Type

Selector When adding optional descriptions to family file names, consider the order in which the descriptions

are listed to ensure that the family files display in the Project Browser in the most logical and intuitive order

Do not use spaces between words in filenames. The naming fields shall use the underscore character (_) as a delimiter and the dash character (-) within phrases. Information within each field is to be CamelCase (capitalized first letters to words and no spaces). No spaces or other punctuation shall be used

If a hyphen (-) is used to include a performance range, enclose the range in parentheses, for example, (230-250_Ton)

If a type catalogue is to be used with a family, name the type catalogue (txt.file) with the same name as the family. See section 10.0 for additional information

If the content is from an external source and not named in accordance with this guide then, the family must be renamed in accordance with this guide

Format

All families created for bimstore must be named in the following format:

<FunctionType> _ <Subtype> _ <Manufacturer> _ <Descriptor1> _ <2D if necessary>

An example family for an internal flush face door made by a company called Laidlaw would be for example: “Door_Internal_Laidlaw_Flush-Face”

A thermally broken aluminium Casement window made by a company called Acme would be: “WindowCasement_Acme_Thermally-Broken-Aluminium”


Field/Component Required or Optional Description

<Functional Type> Required Names the element that the family created (for example, Door or Window)

<Subtype> As needed Names the part type, for example, for a window the subtype could be Casement. In a door it would be external or internal

<Manufacturer> Required Manufacturer name, generic families may substitute the Manufacturer name with “Generic”.

<Descriptor> Required Brief plain-English description of the component.

<2D> As needed Use only 2D families

Further examples:

Window_Double-Hung_Acme_Tilting-Sash.rfa Fountain_Drinking_Acme_Polished-Chrome.rfa Chiller_Air-Cooled_Acme_Low-Profile.rfa Window_Double-Hung_Generic-Wood.rfa


5.2. Type naming conventions

All families must include one predefined type. For families that represent real-world objects that are available in standard sizes, predefined types should be generated. Unless they represent nominal sizes, type names should include units or capacity, and include a unit indicator.

When naming a family type, use the format and rules below:

Guidelines

Do not include the family name or category in the type name Type names should mirror actual usage Type names should indicate the key differences between types (size, count, material) and,

when applicable, reflect standard sizes. In some cases, you may base names on size difference, but use common terms rather than numbers

When types are named by size, use dimensions only. Avoid the use of characters or words. (h, w, d, or height, width, depth)

Type names should include units of capacity and a unit indicator, unless they represent nominal sizes

Metric types should reflect the local unit standard, unless the types are intended to be generic

Keep type names as short as possible. Type names must display in dialogues and in the Type Selector

Format

Unless there is a market-specific reason to do otherwise, use the following general order in type names:

For doors and windows: <width> x <height>

For casework and furniture: <width> x <depth> x <height>

For other element types: <width> x <depth>

Further examples for an imperial window:

1200mm x 600mm 1500mm x 600mm 1800mm x 600mm


All families, including generic families, must be assigned to appropriate categories and subcategories. When a family is created, it is assigned a category. The category defines its top level of identification (for example, Door, Window, or Casework) within the project environment. When the family is used in a project, the family can be located in the Project Browser under its category, and elements created by the family types will schedule by its category. The line weight, line color, line pattern, and material assignment of the family geometry can also be assigned by category.

To display different line weights, line colors, line patterns, and material assignments for different geometric components of the family (for example, the frame, sash, mullions, and glass that comprise a window), the components can be assigned to subcategories within the family category.

Categories are predefined in Revit software and cannot be created or changed by the user. Subcategories are predefined in some families, but other subcategories can be created in families as needed.

For the most part, the subcategories required will be automatically defined in the family

template. Refrain from overcomplicating the subcategory names. Keep them simple, consistent, and straightforward.


Families contain parameters that not only create the family geometry, but identify or classify the elements that are created by the family. All families have predefined parameters that you assign values or data to, but you can add parameters that are not predefined in Revit software.

bimstore does not use product templates to create your families, instead we supply a ‘shared parameter’ file that can be used to add the parameters to your own templates. The shared parameter file contains the minimum parameters required to meet these family creation guidelines and industry standards. Should you wish to add additional parameters, then ensure that these are created as ‘shared parameters’. These should be defined in a shared parameter .txt file that is independent of family and project files.

If you add a shared parameter which you think would be useful for future families you can request that the parameter is added to the bimstore standard shared parameter file via our contact form. If you are adding shared parameters to system files, you must ensure that the file is included within the upload to bimstore as a txt file.

Family Parameters should only be used in place of shared parameters in situations where the

data is not required to appear in schedules or tags, or where used formula prevents shared parameter use.


7.1. Parameter naming convention

Consistent parameter naming enables easier and more comprehensive parametric searching. Create parameters only when variation creates meaningfully differentiated types that represent real-world possibilities.

Guidelines

Use standard approved parameter names when available Keep parameter names as short as possible Avoid abbreviation and truncation when possible Use ‘Title Casing’ (as with the title of a book) for parameter names, as they are case

sensitive (e.g., Coefficient of Performance; Point of Shipment; High and Low Pressure Gas Connection Diameter)

Do not change label names provided by the bimstore shared parameter file Parameter names that you reuse to create equalities should be carefully checked for name

coherence Use the most common descriptor for a group of parameters as the first part of the name

so that the parameters sort logically (e.g., Filter Face Area; Filter Efficiency) Avoid using symbols in parameter names, including: + - / \ * ( ) “ ‘ < > | ^ $ { } [ ] Do not include units in the name of a parameter (e.g., Supply Air Flow CFM) Using the terms Actual or Design:

o Actual – describes the actual value the system definition requires. “Actual” parameters are linked to connectors and are often used for parameters that define flow rates, for example, Actual Supply Air Flow; Actual Chilled Water Flow

o Design – describes what the product is designed to do, for example, Design Ventilation Air Flow; Design Return Air Flow

Name Yes/No parameters so they imply that they return a Yes/No value, for example: o Has Handle o Is Energy Efficient o Show Hoods


7.2. Correct use of bimstore parameters

By default you will notice three parameters under the Other category of the template. Both these parameters MUST be completed before the family is uploaded to bimstore or used in a ‘live’ project environment.

Parameter name Description Type of parameter

_current revision Current bimstore revision of the current family. This is numerical and should begin at 1.

System (Integer)

_created by This should read “www.bimstore.us” or your own URL if created in house.

System (URL)

_distributed by This should read “www.bimstore.us” System (URL)

_author The authors name, i.e. your name System (Text)

_bimspec_guid Leave this field blank, this will be completed by the bimstore team

System (Integer)

“_current revision” – This parameter should be maintained when editing and updating families. This should start at 1 and progress per family revision

“_created by” – This parameter should always reference the bimstore website

“_author” – This should by the name of the person who made the original family and not changed when the family is revised. You may use a URL in this field to link to a company website if appropriate.

“_bimspec_guid” - this is used by bimstore to identify this component and link it with property dimensions in bimstore and other future software packages.


7.3. COBie Parameters to BS1192:4

All bimstore content must have the correct COBie parameters. These parameters are used to create COBie Data Drops (a standard format Excel file) that can be utilised by third party software and organizations.

COBie (BS1192:4) is quickly becoming the standard information schema in the UK and many organizations - including the UK Government - are now asking for a completed COBie file as a deliverable upon occupancy of a building.

It is important that all bimstore content is compatible with COBie (Defined in BS1192:4), and that when a COBie file is created from the building information model the data is transferred in the correct schema.

Not all COBie fields require a value, for example “WarrantyStartDate” will be entered by the contractor or client upon handover of COBie. However it is important that this parameter exists when it is exported.

The component shall have completed COBie values where known and shall not include unset or undefined values. Where the information is unknown, not applicable or not available a default value ‘n/a’ shall be used. If the datatype restricts the use of an alphanumeric value, the appropriate value to that property shall be used e.g ‘0’.

All COBie parameters must be saved in the ‘Other’ category in Autodesk Revit and where there is duplication between hard coded Revit parameters and COBie parameters, the data should be mapped between fields. e.g. ‘Fire Rating’ (hard coded) should be mapped to the IFC property ‘FireRating’.

The minimum mandatory COBie parameters for all bimstore content are:

Type or

instance

Parameter name Example Value Value

Type

Value

Required

System Name Furniture-Desk_Height_Table-Round-Steelcase-MediaScape

Text Default

System Description Mediascape is a unique solution answering the triple challenge companies’ face in making their workplaces work better -making teams more productive and creative, optimising m² of collaborative space and providing seamless and instant access to technology and information.

Text Default

System TypeName 2000mmx2000mmx900mm Square Top Text Default

Type AssetType Fixed Text Required

Type CreatedBy [email protected] Text Required

Type CreatedOn ‘July 2014’ Text Required

Type Manufacturer Acme Inc Text Default


Type Model MediaScape MV Text Default

Type ModelNumber 9383 Text Required

Instance AssetIdentifier AT002-323-232T Text Blank

Instance BarCode 392324411002 Text Blank

Type AccessibilityPerformance n/a Text Optional

Type CodePerformance n/a Text Optional

Type Consitituents MediaScape Media Screen, MediaScape Adjustable Desk Unit

Text Optional

Type DocumentationTechnical http://acme.com/literature/Technicalguide.pdf URL Optional

Type DocumentationCertificates http://acme.com/certificates/Certificates.pdf URL Optional

Type DocumentationLiterature http://acme.com/literature/Salesbrochure.pdf URL Required

Type DocumentationInstallationGuide http://acme.com/literature/Installationguide.pdf

URL Optional

Type WarrantyGuarantorParts [email protected] Text Required

Type WarrantyGuarantorLabour [email protected] Text Optional

Type WarrantyDurationLabour 20 Integer Optional

Type WarrantyDurationParts 20 Integer Required

Type WarrantyDurationUnit Years Text Required

Type WarrantyDescription 20 year labour and part warranty. Warranty excludes hinges

Text Required

Type Cost 545 Number Optional

Type ReplacementCost 545 Number Optional

Type ExpectedLife 30 Integer Required

Type DurationUnit Years Text Required

Type Shape Rectangle Text Optional

Type Size 2000x2000 Text Optional

Type Color White Text Optional

Type Finish Matt Text Optional

Type Grade n/a Text Optional

Type Material MDF Text Required

Type Features Extendable table top, power assisted height adjustment

Text Optional


Type SpareParts Hinge Cover(23232), USB Port (22844), Spring Kit(34311)

Text Optional

Type ProductionYear 2013 Text Optional

Type ReferencedStandard EU9231 Text Optional

Instance WarrantyStartDate 2013-12-12T13:29:45 Date Blank

Instance InstallationDate 2013-12-12T13:29:45 Date Blank

Instance SerialNumber 65536578767464678 Integer Blank

bimstore can provide a shared parameter file for the above COBie parameters. This will keep

GUID’s aligned with industry guidance GUIDs. Email [email protected]

mailto:[email protected]�


7.4. IFC Parameters

By adding IFC parameters you will increase the overall effectiveness of the ‘Revit to IFC’ export process. Revit handles the minimum IFC parameters, requirements upon export to IFC and if you have the minimum COBie perimeters your content will meet the bimstore requirements. However it is worth referring to BuildingSmart website at for more detailed breakdown of the IFC 2x3 TC1 fields by product type and adding any additional information that you feel may be beneficial to your product.

http://buildingsmart-tech.org

7.5. Assigning the Assembly code and Keynote Data

Even though your objects do not have to include a classification code, Revit requires that the Keynote and Assembly Code be assigned to each family type so that it understands the object type and how it should display and behave in a project.

1) Open the Family Types dialogues for the family 2) Under Identity Data, for Keynote, enter the ICC IBC reference appropriate for the family

content. Refer to the IBC website for a list of classification codes 3) Under Identity Data, for Assembly Code, click in the Value field, and click the browse button to

select the appropriate Assembly Code from the dialogues 4) Repeat the procedure for each type in the family

http://buildingsmart-tech.org/�


7.6. Assigning the Masterformat and Uniformat classification

The OmniClass 1.0 code is assigned to the family. You do not need to assign it to each family type.

1) In Revit, Open the Family Category and Parameters dialogues.

2) Under Family Parameters, for OmniClass Number, click in the field, and click the browse button to select the appropriate OmniClass code from the dialogues.

Notice that the OmniClass Title value is added automatically.


7.7. Protecting your content with Digital DNA

All bimstore created content is watermarked with a proprietary technology called Digital DNA that allows content to be digitally marked with owner and creator information at binary level. This means that your content is protected from theft and any suspect content can be checked at a later date to establish if it originated from your content.

Does not increase file size Does not a�ect operation of the object The DNA is invisible and the object behaves just like a normal object 256 bit Encrypted Cannot be removed (apart from by bimstore) All content is signed and sent to our cloud server for future validation purposes.

Although Digital DNA is an internal tool used by the bimstore content creation team on all

bimstore created content, bimstore o�er injecting DNA into your own authored content on request ([email protected])


All bimstore created families must contain accurate, realistic finishes. This means that finish materials must be assigned to the family geometry. Finish material naming conventions organize the material by manufacturer, and from general description to more specific description. Depending on the type of material, a finish material name may include a color, code, finish type, or identification number.

It is important when creating materials within a family to give them a manufacturer prefix- for example “Acme-Chrome”. This prevents the material from been overridden by other materials contained in the project when inserted.

8.1. Material Naming

Guidelines

When creating materials for use in bimstore families, it is important that the following guidelines are observed.

Finish names should indicate the key differences between materials (manufacturer, type, color, finish) and, when applicable, reflect standard sizes. In some cases, you may base names on size difference, but use common terms rather than numbers.

Finish names should reflect the local unit standard, unless the materials are intended to be generic.

Keep finish names as short as possible. Where possible the standard Revit materials should be used when applying materials in

families. A standard material should be duplicated and renamed in accordance with the guidelines set out in this section.

To optimize the file size for families with a large number of available materials, provide only

the most common materials in the family, and provide the remaining materials in a separate finish library. See the finishes part type guide for more information.

Name format for individual finish materials

<Finish Type> - <Manufacturer> - <Code> - <Descriptor>

Paint - Acme Paint - AC 440 - Vintage Brown Matte Glass - Acme Glazing - Series 1205 – Clear Aluminium - Acme Metal - AC120 -Anodized (Clear) Fabric - Acme Fabrics - AC F820 - Hounds Tooth - Black/White Stain - Acme Windows - Natural Wood Finish


8.2. Material ‘image’ naming

If a standard material cannot be modified to suit, then a custom material may be made. These materials can consist of a number of images, bump, cut-out maps, etc.

These guidelines must be followed for the creation and naming of these images:

Create unique names for each unique material image. Capitalize the leading letters in each portion of the material name. Do not use spaces between words in file names. To separate words within a syntax

element (e.g., Manufacturer or Descriptor), use the underscore character (_). Acceptable file formats for material images include: bmp, jpg, jpeg and png. Provide a readme file to describe where the image files must be located and how to map

Revit to the “Revit Manufacturer Library“ folder in the Rendering Options dialogues. This file must be included in the .zip file when it is uploaded to bimstore.

Examples:

Image File:

Paint-Acme_Paint-AC_440-Vintage_Brown_Matte.jpg Stain-Acme_Windows-Natural_Wood_Finish.jpg

Bump Image File:

-bump.jpg

Cutouts/Perforations:

cutout.jpg Aluminum-Acme_Fencing-AC120-Anodized-cutout.jpg

8.3. Custom Materials

Wherever possible it is recommended that any custom materials that you create within your family use the standard Revit bitmaps with adjustment to the material settings. If your material requires a custom image file/bitmap ensure that the image and any associated bump-map or cut-out image files are copied to and loaded from the following local directory (Replace XXUNIQUE-ID with your company name).

C:\LocalRVT\Bimstore\Materials\XX-UNIQUE-ID-XX

All custom material image maps used in your family must be included in the Zip file upload in a folder called “Materials” as shown here.


A family preview image is a reduced thumbnail image of a 2D or 3D family view that graphically identifies a family before it is downloaded or opened. Preview images display in:

Thumbnails view in Microsoft® Windows Explorer Autodesk Seek search results The Preview window in Revit Open and Load Family dialogues when a family is selected

By creating preview images that adhere to bimstore standards, users can view consistent previews across families, ensuring a consistent user experience both in the Revit software and third party libraries such as bimstore, Autodesk Seek etc.

To create a preview image, begin by creating a family view to use exclusively for the preview image. Although you can save any family view as the preview image view, the best practice is to create a view that can be set to consistently display as is required for the preview image.

After you create the view, set Autodesk standard graphic controls in the preview image view to ensure visual consistency with the preview images of other Revit families. Different graphic standards exist for the following types of family preview images:

Detail component and annotation families Hosted model component families

IMPORTANT: When modifications to the preview image view are complete, save the view

and set the family to use the current view as the preview image. Each time you save and close the family, you must ensure that the preview image view is the active (open) view so it will display as the preview image.


9.1. How to create a detail component preview image

For an easily identifiable detail component preview, set the preview image to display the 2D view that features only the component line work and filled regions. To do this you must:

If necessary, open the detail component family for which you want to create a preview image.

Turn off dimensions, ref planes and parameter labels etc.

o Click View menu o In the Visibility/Graphic Overrides

dialogues, click the Annotation Categories tab.

o Under Visibility, clear Dimensions, Levels, Reference Lines, and Reference Planes.

o Click OK. On the View Control Bar:

o Click the current view scale, and depending on the family units, click 1:10, 1:5. o Click Detail Level, and click Fine. o Click Model Graphics Style, and click Wireframe.

Click Save

If you are creating a preview for a host-based family, set the host visibility: o For family previews in which the host should not display, such as doors and

windows, select all host categories. Click OK Set standard view controls in the Preview view

o On the View Control Bar: o Click the current view scale, and depending on the family units, click 1:10 or 1:5. o Click Detail Level, and click Fine. o Click Model Graphics Style, and click Shading with Edges.

Set the preview image to display the current view On the View Control Bar:

o Click File menu - Save As. o In the Save As dialogues, in the lower-right corner, click Options. o In the File Save Options dialogues, under Preview, for Source, select “3D View:

Preview”, then select “Regenerate if view/sheet is not up-to-date”. Click OK. Click Save.


9.2. How to create a model component image

Follow the following steps to set up your own preview image for model families, such as doors, windows and furniture etc.

Create a view to use as the preview image

If necessary, open the family for which you want to create a preview image.

In the Project Browser, select a view of the family that you want to use:

o For a door or window family, select an elevation view (preferably front).

o or other model component families, select a 3D view.

Right-click the view name, and click Duplicate View-Duplicate.

Rename the duplicate view:

o In the Project Browser, right-click the view name, and click Rename.

o Type Preview and click OK.

o Click No to rename the names of corresponding views and levels

If necessary, open the view.

Depending on the type of component that you are creating, set the view orientation:

o For a door or window family in an elevation view, on the View Cube, click Top Corner.

o For other families that display in a 3D view, on the View Cube, click to set a southeast orientation, right-click, and click Set Current View as Home.

Turn off visibility of dimensions and reference planes/lines and if necessary set host visibility

Click View menu- Visibility/Graphics.

In the Visibility/Graphic Overrides dialogues, click the Annotation Categories tab.

Under Visibility, clear Dimensions, Levels, Reference Lines, and Reference Planes.


A type catalogue is a comma-delimited .txt file which, when placed in the same directory as a family, displays a list of family types before the family is loaded into a project. You can select and load only the family types that the current project requires, avoiding an unnecessary increase in project size from unused types and a long list of types in the Type Selector. The type catalogue also provides an external means of editing the family, as you can remove and add parameters and types in the catalogue file (.txt).

Only use ‘Type Catalogues’ when your family contains more than 8 pre configured family

types.

10.1. How to create a type catalogue

Use the following standards when creating type catalogues:

Use any text editor to create type catalogues.

Create type catalogues ONLY for families that contain eight or more types.

Name a type catalogue file (.txt) with the same name as the family file (.rfa) that it supports.

Ensure that parameters in type catalogues are test loaded by the family for which you create the type catalogue. If the parameters are not used, the family will not load.

When uploading families to bimstore, ensure that the type catalogue is included in the .zip upload.

For information on creating a type catalogue, see “Creating Type Catalogues” in the Revit

Help and Families Guide.


Materials can be applied to families to depict the real world display of elements created with the family in shaded and rendered views.

Depending on how you apply materials to a family’s geometry, you can control the user’s ability to modify the materials of elements that they create with the family. Use these guidelines to apply materials to family geometry:

If you want to... Then...

Use materials that will not need to be changed

Apply the material directly to the family geometry by assigning it to the Material parameter (Option 1)

Change the material for the family category and/or for subsets of geometric components in the family

Apply a material to the family category Create subcategories, assign materials to each subcategory, and assign subcategories to geometry (Option 2)

Change the material for a geometric component in a family by instance or type

Create an instance or type material parameter and assign it to the appropriate family geometry (Option 3) NOTE: This is the most flexible and preferred method of material assignment

If possible, use the materials that are available in the Revit software when assigning materials to family geometry. If you need to create a material, make sure that the material name conforms to the naming conventions described in the Material Naming Conventions topic (Section 7.2).

IMPORTANT: When applying materials to a family, remember that materials increase the

family size, which in turn decreases its performance when it is loaded and used in projects.


11.1. Option 1 – Applying materials with the material parameter

You can apply materials directly to some or all of the family geometry in the Family Editor. Each piece of family geometry has a default Material parameter to which you can assign materials.

Use this method when

The material of the family geometry is unlikely to change, such as for a manufactured component that is supplied with a single standard material.

Result

When you create elements in a project with the family, you cannot:

change the element materials without editing the family

change the material for instances or types of the family

change the materials by assigning a material to the element category

11.2. Option 2 – Apply materials to a family geometry by category and subcategory

You can apply materials to all or select pieces of family geometry by subcategory. Subcategories are categories that exist within the family category. You can assign different pieces of family geometry to each subcategory, and then apply a different material to each subcategory. To apply material to geometry that is not assigned to a subcategory, you can apply materials by the family category.


You want to be able to apply different materials to different family components by category or subcategory.

Result

When you create an element in a project with the family:

You can change the materials assigned to each subcategory or category.

11.3. Option 3 – Apply materials to a family geometry by category and subcategory

You can create and assign a custom instance or type material parameter to family geometry. This is the most flexible option to use when applying materials to your family geometry.


To allow the user to change family materials by instance or by type.

By setting the material parameter to this option can also allow the elements to be updated by subcategory or category.

Result

When you create an element with the family in a project, the parameter gives you the option to change a material for an instance of the element or for each type of element that you create.


In Revit MEP, the connector connects the single family component with other components to create MEP systems. Without a connector, a family would just be a static placeholder.

If you are creating any electrical, plumbing or mechanical content then you must include the relevant MEP connectors. Even if you are unsure of the exact parameter fields, the connector must still be added, to comply with the bimstore standards.

Unless you are creating a Revit MEP component, it may be possible to skip this section.

12.1. Adding a connector

1) Click the tool for the connector you wish to add (Electrical Connector, Duct Connector, or Pipe Connector).

2) Click to place the connector in the drawing area.

MEP provides two ways to place the connector, placing it on a face or on a work plane. If you select the Place on Face option, the connector is automatically added to the centre of the face of the geometry and moves with the face. If the geometry is deleted, the connector is also deleted.

BEST PRACTICE: Place connectors on a face rather than on a work plane


12.2. Connector Direction

For duct/pipe connectors, an arrow, perpendicular to the surface, displays. The direction that the arrow is pointing is also the direction in which the connecting duct/pipe will be drawn. As the picture shows, vertical duct can be drawn from an up connector in an air terminal.

NOTE: The arrow does not represent the flow direction.

12.3. Primary Connector

By default, the first connector in each domain is assigned as the primary connector. In the following image, you can easily identify the primary connector (connector 1) by the cross symbol. The Re-assign Primary tool allows you to reassign the primary connector, as required.

The primary connector of pipe and duct fittings should be located at coordinates (-1, 0, 0). In the following image of the plan view of a P-Trap, connector 1 is the primary connector. For other family types, the location of the primary connector is not important.


12.4. Linking connector

When there are more than one pipe/duct connectors, there is a choice for linking connectors.

Linked connectors only have an effect when the system type is set to global for equipment or fitting.

Linking connectors on equipment makes it possible to propagate engineering data, allowing you to use equipment as an inline component in a system.

Linking connectors on fittings should include the primary connector.


Perform general testing on a family when it is:

open in the Family Editor

loaded into a project

Use the criteria in the checklists below to test families in each of the above environments. When testing families in projects, it is strongly recommended that you:

Test families in projects that match the design intent of the family. For example, test a window family that is designed to be placed in a large commercial building in a large commercial project.

Content that is designed to work in more than one Revit discipline must be tested in all applicable disciplines. For example, for a lighting fixture, test the connectors in Revit MEP, and verify that the fixture casts light as expected when rendering in Revit Architecture.

13.1. Family editor testing criteria

Test all family parameters to ensure that the geometry flexes/adjusts correctly when the family parameters are modified.

Test all family types – change the type, apply it, and inspect the geometry to verify that the dimensions and relationships are maintained.

In a host-based family, verify that the host flexes as expected. Change the host thickness and ensure that the family geometry adjusts appropriately. Adjust the host beyond what is considered normal to ensure the family does not break when outside of what is considered to be normal usage. This will future proof the object to a certain degree.

Verify that the family preview image is using the Preview view.

Check all views to ensure that the family displays appropriately in different detail levels and when different Model Graphics styles are applied.

Test constraints:

o Test the handles on the edge of the geometry and make sure that all geometry is constrained to either a reference plane or a reference line.

o Test the dimension parameter to make sure that the reference plane or line is being adjusted by the parameter and not the actual geometry.


13.2. Project testing criteria for Revit Architecture

These are items to be checked in families created for primary use in Revit Architecture.

For all families:

Inspect the family appearance in all views (plan, reflected ceiling plan, elevation, Section, 3D) at all detail levels (Coarse, Medium, Fine).

Inspect the family appearance in different Model Graphics Styles: Wireframe, Hidden Line, Shading, and Shading with Edges.

Test all family types – change the type, apply it, and inspect the geometry to verify that the dimensions and relationships are maintained.

Create new types and modify all parameters, checking all views for anomalies.

Modify all material assignments to verify that materials are associated to the geometry correctly. TIP: To better inspect family geometry, modify all material type parameters to glass. Also, if any of the family geometry does not display as glass, then a material parameter is assigned incorrectly.

Modify category and subcategory materials to verify the family is not using material type parameters.

For hosted families:

Place hosted families into the provided host thicknesses and confirm families work in all hosts appropriate to the families use, including in-place walls and mass elements.

Modify the host thickness by 25% - 400% and check for unconnected geometry and/or plan representations that may be disconnected from the geometry.

Re-inspect the family appearance in all views to ensure that the geometry displays as expected.

Dimension to all references and snap all references to walls.

Create a test rendering.

Test the following commands on geometry created in the family:

Copy/Paste

Rotate (Before placement with space key and after with normal command)

Mirror

Array


13.3. Family specific testing guidelines

Depending on the type of family being tested, there may be specific criteria to test in addition to the general testing that should be performed on all families.

Use this table to determine if a family requires any specific testing:

Family Type Example Test

Freely-Placed Furniture, entourage

Test in a relevant project context. For example, place furniture or casework elements on a floor with a texture to ensure that the elements mask the floor

Hosted Window, door Ensure that the family interacts properly with a host and adjusts to different host thicknesses

Face-Based Light fixture Ensure that the family attaches properly to faces and doesn’t improperly embed in, or project away from, the face of the object to which it is attached

Detail Component Detail component Ensure that the family snaps to other geometry correctly and that it masks any geometry on which it is placed


In order to distribute your content using the bimstore.us portal, it must meet the standard outlined in this document. When you are satisfied that it does, you can make your submission to bimstore for verification, following which it will be uploaded to the site and will appear in the listings and search results.

Once you are ready to submit your content, please contact [email protected] and we will walk you through the submission process.

Our main goal at bimstore is to distribute high-quality, manufacturer-specific content to the construction industry. We trust that you understand that these processes reinforce that commitment and safeguard the integrity of this site as an industry leader in the distribution of BIM components.

14.1. bimstore Ecosystem

By submitting your objects for hosting on the bimstore platform you are also making your objects available through the various ecosystem products and partners.

bimstore.us content library

The US’ BIM content library. All content and downloads on bimstore are free to download. The content is made in conjunction with manufacturers, ensuring accuracy and quality. We call the bimstore portal the iTunes of BIM objects.


bimstore _Shelf

One of our biggest priorities is ensuring that our manufacturer’s content is accessed and used. A bimstore shelf puts the manufacturer content on their own website. This offers the manufacturer the ability to display their objects on their own website but allows information to be centrally tracked and analysed by bimstore.

bimstore Eye

Seeing a product in a brochure is no longer enough for the contemporary specifier. bimstore Eye brings components to life through Augmented reality. The app brings your products alive and specifiers are now able to view objects through their handheld device and position them directly in the building or environment.


Specifi

Specifiers still like the nice images and marketing information related to products however there is less need for glossy brochures. We have developed Specifi, the tech equivalent of a specifiers product library, to complement the digital models hosted on bimstore. Specifi is a free to use tablet application which allows specifiers to access PDF information linked to the model including product brochures, technical data sheets, installation guides and maintenance information. A major benefit to this is that manufacturers are able to ensure that both their bim objects and literature are linked and upto date - when models are used in operation, this is a particularly valuable aspect.

Barbour Product Selector

We can push your objects to your listing on Barbour Product Search. Your objects are automatically kept in sync with bimstore and all downloads are tracked.


Building Product Index (BPI)

We can push your objects to your listing on Building Product Index. Your objects are automatically kept in sync with bimstore and all downloads are tracked.

Desktop App

Using the bimstore plug-in for Revit (aka Desktop App) specifiers can access your content directly from within their design software.


DOT.bimstore - Client Portals

bimstore manages content management portals for many clients such as Space Architecture, Barratt Homes and Volula. If your content is hosted on bimstore these clients can select your objects for inclusion in their library. DOT.bimstore allows organisations to work in even closer partnership with their suppliers, enabling them to directly organize and monitor their supply chain whilst continuing to be part of the bimstore ecosystem.

14.2. International Distribution

bimstore is now international with bimstore portals in the Unites States and Australia with plans to expand further throughout the year.

If you have objects hosted on bimstore.us we can share these objects with our international sites at a click of a button, making your content available across the globe.

NOTE: Each bimstore country has its own regional standards (bimstore bible) for hosting

and your content must confirm to their standards. Your content may require translation or some regional specific data changes to be accepted.


14.3. Custom Distribution

Although we offer a wider range of hosting options, we can develop custom distribution channels for your content. The bimstore engine has a powerful REST API that allows almost unlimited possibilities. Contact us for more information.

14.4. Object user guides

All content on bimstore and its ecosystem must be accompanied by an appropriate user guide. The user guide must be written in plain language and saved in Adobe PDF format.

The user guide should cover (but not limited to) the following:

Loading the object into a project

Placing the object into the project or system

How to load or change materials

Any special features, options or selections

NOTE: Download an object from bimstore.us to view an example object user guide.

bimstore bible 39

content creation checklistbimstore bible

bimstore bible

Family editor testing criteria

Family Editor Revit Project

Test all family parameters to ensure that the geometry flexes/adjusts correctly when the family parameters are modified.

Test all family types – change the type, apply it, and inspect the geometry to verify that the dimensions and relationships

are maintained.

In a host-based family, verify that the host flexes as expected. Change the host thickness and ensure that the family

geometry adjusts appropriately.

Verify that the family preview image is using the Preview view.

Check all views to ensure that the family displays appropriately in different detail levels and when different Model

Graphics styles are applied.

Test constraints:

a) Test the handles on the edge of the geometry and make sure that all geometry is constrained to either a reference plane

or a reference line.

b) Test the dimension parameter to make sure that the reference plane or line is being adjusted by the parameter and not

the actual geometry.

Project testing criteria for Revit Architecture

These are items to be checked in families created for primary use in Revit Architecture.

Family Editor Revit Project For all families:

Inspect the family appearance in all views (plan, reflected ceiling plan, elevation, Section, 3D) at all detail levels (Coarse,

Medium, Fine).

Inspect the family appearance in different Model Graphics Styles: Wireframe, Hidden Line, Shading, and Shading

with Edges.

Test all family types – change the type, apply it, and inspect the geometry to verify that the dimensions and relationships

are maintained.

Create new types and modify all parameters, checking all views for anomalies.

Modify all material assignments to verify that materials are associated to the geometry correctly. TIP: To better inspect family

geometry, modify all material type parameters to glass. Also, if any of the family geometry does not display as glass, then a

material parameter is assigned incorrectly.

Modify category and subcategory materials to verify the family is not using material type parameters.

For hosted families:

Place hosted families into the provided host thicknesses and confirm families work in all hosts appropriate to the families use,

including in-place walls and mass elements.

Modify the host thickness by 25% - 400%, and check for unconnected geometry and/or plan representations that may be

disconnected from the geometry.

Re-inspect the family appearance in all views to ensure that the geometry displays as expected.

Dimension to all references and snap all references to walls.

Create a test rendering.

Test the following commands on geometry created in the family:

Copy/Paste

Rotate

Mirror

Checklist

44 bimstore bible

revit family creation standards

Documents