Delux Database Enabled Loading and Updating

This paper by Steven Rowland, Interior BIM Manager in a hospital in Stockholm, Sweden, describes a novel method to extend database functionality for a "smart" loading and updating process in very large Revit projects.

The method is designed solve a somewhat unique problem, but the resulting solution has interesting possibilities for other projects of all sizes. Here it is:

Database Enabled Loading & Updating eXperiment – DELUX Copy/Paste

By Steven Rowland and Fredrik Sjödén.

This short paper describes a novel method to extend database functionality for a "smart" loading and updating process in a very large Revit project. It builds upon the white paper on database integration by Miroslav Schonauer of Autodesk.

Summary Description

The DELUX copy/paste method uses an external database definition to duplicate floor plans, in whole or in part, to multiple Revit models or floor plans, with the ability to update changes as required. This includes walls, doors, windows, generic models, detail groups, etc., as well as associated annotation. The resulting duplicated floor plans can be updated or refreshed from the database definition as changes occur in the source file. All Revit content in the copied floor plans is live, i.e. nothing is grouped or in links.

Project Description

It is important to understand the kind of project that this was developed for, because we had special circumstances that pushed us towards finding the kind of crazy solution that we developed. We have a very large hospital project, with over 300,000 sq. meters of new construction. The project was divided into 17 main Revit model files, and several more supporting model files. Each of the main Revit files hover between 300-800 megabytes.

In addition, the project is a "fully loaded" project, meaning that all equipment, furnishings, and building elements are loaded into every room (11,000+ rooms). In addition, various other data types are fully implemented into the BIM model. We are required by contract to not use typical floor plans, even where floor plans are repetitive. Also, it is good to understand that this is a live model, which is actively being used for construction and coordination during the design process over several years of continuous design and construction. Eventually the fully loaded BIM model will be handed off to facilities management.

The Problem

The problem we had was this: we have numerous (14) floor plans that are identical or nearly identical with minor differences. These repetitive floor plans are spread across multiple Revit models (4 models). Because of the "fully load" requirements I described above, we were required to fully document each plan completely. On normal projects, this would be accomplished by using Revit Groups or Links. However, both of those methods were unavailable to us, because we have extensive database connections and collaboration methods (IFC, Navis) that do not cooperate with the limitations of Revit Groups or Links. We needed a method that would allow us to have "live" Revit content on multiple plans (no groups or links), and manage the repetitive floor plans in a time efficient way. We wanted to quickly and accurately duplicate entire floor plans and manage change during the design process in an efficient BIM way. We don't like to do the same thing more than twice, and 14 times over is simply too inefficient.

DELUX Copy/Paste

Step one – Mark elements for the database definition – On a Source Plan, we marked each model element with a DELUX parameter to identify that it was a member of the database definition. We included all doors, windows, walls, openings, generic models, furniture, casework, equipment, etc. (Note: ceilings were not included because of API limitations. Also note that room objects are not included.)

Step two – Create a relative coordinate system – We added a simple annotation object to mark a base point that we would measure x,y coordinates from. We could have used the project basepoint, however we felt that a relative coordinate system would offer more flexibility.

Step three – Export to a database –We programmed an add-in that would identify all the members of the DELUX group, and use the relative base point to measure x,y coordinates. The add-in exports all information associated with the model elements, including x,y coordinates, all parameter values, sizes, shapes, rotations, checkboxes, worksets, and everything else we could find through the API. The exported information is formatted as binary code. We had a database available that we use for other purposes, so we put the DELUX information there also. The add-in also adds another parameter to all of the source model elements – UniqueID. We will use this UniqueID parameter later for the updating process. (Note that all annotation for any given model element is exported from all views, and not just the active view. Also note that we are not exporting dimensions yet, but we are looking to explore those possibilities also.)

Step four – Target Plan – We prepare the target plan by placing a target annotation family to mark the relative coordinate. In our project we used a stairwell as the common base point. Any model elements that we wish to replace with the database definition are then marked with the same DELUX parameter that was used in the source file.

Step five – Initialize and precheck – The DELUX add-in does two things when it starts. First it checks for and then adds any missing shared parameters to the target Revit file. Second it performs a precheck to ensure that all required families are present in the target file. We have systems that can automatically load most types of families, however the precheck generates a pop-up and text file that lists the missing families, if any. At this point the user can either proceed with insertion or cancel out of the function and manually load the missing families into the target Revit file.

Step six – Press the shiny button – Now we can tell the add-in to begin inserting the database definition. We begin with the walls, and the function uses the API to insert them according to the relative coordinates we provided. Then it proceeds with doors, windows, and openings. After that all other Revit families are added. All content is inserted in the correct location, orientation, workset, etc., with all parameters and options preserved from the source file. (Note: walls are inserted relatively slowly on the first insertion. This can depend upon the size and complexity of the model, and is constrained by Revit calculating room bounding. We have tried to find various ways around this constraint, and, while there are possibilities, the walls are the slowest to populate from the database definition. In our experience on large model files (500+mb) the insertion rate is about 20 walls per minute. This is accelerated substantially when updating, as I will discuss later.)

Step seven – Annotate – We have a second add-in for inserting annotation. Upon initializing, the user chooses the DELUX group, and the interface shows which annotation views are available from the source file. The user then chooses an active view to receive annotation and presses the shiny button. All annotation from the selected source view is inserted in the correct position and orientation. This can be repeated multiple times for as many source/target pairs as are required.

Step eight – Update – As previously noted, each source model element receives a UniqueID parameter. The same UniqueID parameter from the source is written to each model element in the target plans. By using this parameter we are able to evaluate and match the source and target elements. The update process is similar to the insertion process. If we make changes to the source plans, we export the DELUX group again to the database. In the target file, we run the insertion function same as before; however this time the function uses the UniqueID parameter to compare each element to the new database definition. If the element has not changed, then it is ignored for updating. If the element has changed then it is removed and a new element is inserted in its place. It continues until the floor plan is refreshed. This process is much faster than the initial insertion process.


That is the entire function, with a few more features that I have not described here. It is still under development, so we have hope for expanding and refining it in various ways. The beauty of this system is that it allows us to manage multiple identical target plans from one source plan, and be certain that any changes are reproduced accurately across multiple Revit files without using Revit Groups or Links. Extending this to annotation opens the possibility of substantially reducing the time required to prepare documentation. This can all be updated over time, and doesn't interfere with our collaboration methods, or other database linkages; in fact we have found ways of using it to reduce work in other areas by leveraging the matched-up UniqueID of source/target. All of this is accomplished through the use of external database connections, and some very clever coding ;)

So what do you think? In some ways we are reinventing the wheel – however we had special needs that led us to this solution. I'd love to hear your opinion, if you have time.

Addendum: I continue to imagine more ways of extending the method. There are, of course, some limitations with our current approach. The biggest one is that the update process is currently a “remove-and-replace” approach, meaning that the new updated content has a new GUID, which can cause problems. The source GUID is written to a parameter on each target element, thus providing the source/target pairing. In the future I would like to provide the option to update parameters or x,y location only, without removing and replacing the content. This will require us to make some changes in how we store information in the database, but could work.

Now, let's return to a couple of other interesting items...

Autodesk University 2012 Classes Now Available

The Autodesk University 2012 classes are now available, both from the live Las Vegas and the AU Virtual conferences.

They are provided at no cost via the class catalogue on the AU website, available to anyone with an AU account.

If you don't have an account, you can sign up for free at any time.

Here are all the details.

Setting a Structural Framing Tag Leader Arrowhead

In a recent AEC DevBlog article, Saikat Bhattacharya demonstrates how to set the leader arrowhead for a structural framing tag.

His sample code first retrieves all arrowhead definitions, which are ElementType instances whose family name is "Arrowhead". They are obtained using a filtered element collector and a parameter filter testing the built-in parameter ALL_MODEL_FAMILY_NAME for that value. Once the desired arrowhead is found, the IndependentTag built-in parameter LEADER_ARROWHEAD is set to its element id.

Using DMU to Track Changes to a Custom Project Parameter

Another of Saikat's articles discusses the implementation of a dynamic model updater for project parameters. It checks whether a specific shared parameter has been attached to the door category. If so, a dynamic model updater is created and set up to be triggered by changes to that specific parameter on door instances.

Thank you for these two nice posts, Saikat!

The Useful Log4Net Logging Tool

Sometimes you need to obtain information about what you add-in is actually doing, possibly even from a customer, e.g. if something unexpected happens.

For this purpose, Rudolf Honke recommends using log4net. It comes equipped with a very helpful tutorial as well.