Autodesk Revit Format Attributes (Feature Representation)
Revit represents building models with three types of elements, known as
- Model elements,
- Datum elements, and
- View-specific elements.
Please see the Autodesk Revit documentation for additional details.
Quick Links
Metadata Features |
---|
SitePoints Features |
---|
SitePoints |
Categories |
---|
Supported Revit Categories |
Floor-Plan-Only Supported Revit Categories |
Special Feature Types
Metadata Features
The Metadata.FamilyInformation feature type will output one feature for each family in the target Revit file. These features will have attributes about the family they represent.
The following attributes apply to Metadata.FamilyInformation features:
Attribute/Trait Name |
Contents |
---|---|
Shared |
Indicates whether the family is shared. |
User Created |
Indicates whether the family is user-created. |
Name |
The name of the family. |
Is Model Family |
Indicates whether the family is a model family. Not set on System Families. |
Is Host Based |
Indicates whether the family is host-based. Not set on System Families. |
Has Instances |
Indicates whether the family has instances. Not set on System Families. |
Path |
If applicable, this contains the path to the folder where the family is located. Not set on System Families. |
Loadable |
Indicates whether this family is loadable. |
Type Names{} |
This list attribute contains one entry for each type within the family. Each entry holds the name of the type in question. |
The first feature output by the reader has the feature type Metadata.FileInformation. This feature has no geometry, and contains attributes with file-level information.
Attribute/Trait Name |
Contents |
---|---|
DocVer |
The version of this Revit file. |
DocUpdate |
The last time this file was updated. |
AuthorUsername |
The username of the Revit user who last saved the file. |
CreatedBy |
The program used to author the file. |
IsCentralModel |
Whether or not this file is a central model. |
IsCreatedLocally |
Whether or not this file was created locally. |
CentralModelPath |
The file path to this file's central model, if applicable. |
DocSize |
The size of the file in bytes. |
Additionally, the Metadata.FileInformation feature contains attributes identifying the elevation of each level in the file. These attributes have the form LevelElevationInfo.<Level Name>.
The Metadata.FileInformation feature also has attributes identifying the UniqueID of each level in the file. These attributes have the form LevelUniqueIds.<Level Name>.
The Metadata.FileLinks feature type holds information about the linked Revit models and CAD drawings in the file. Each feature represents one link, with attributes relating to that link. These attributes differ between Revit Links and CAD links. The geometry of each feature is set to the insertion point of the link.
Revit Links
The following attributes apply to Revit links:
Attribute/Trait Name |
Contents |
---|---|
IsRelativePath |
Whether the file is referenced via a relative path. If false, it is referenced by an absolute path. |
ReferenceType |
The type of reference. This can be either Attachment or Overlay. |
LinkedFilePath |
The path to the linked file. Depending on the value of IsRelativePath, this will either be an absolute path or a relative path. |
FileType |
Notes whether this link is a Revit file or a CAD file. For Revit Link features, this value will be set to “Revit”. |
CAD Links
The following attributes apply to CAD links:
Attribute/Trait Name |
Contents |
---|---|
LinkType |
Indicates whether the file is Linked or Imported. CAD files that are linked have more information available and therefore have more attributes. This attribute will have the value Link for linked files, and Import for imported files. |
IsRelativePath |
Linked files only. This attribute indicates whether the file is referenced via a relative path. If false, it is referenced by an absolute path. |
Name |
The name of the referenced file. |
LinkedFilePath |
Linked files only. The path to the linked file. Depending on the value of IsRelativePath, this will either be an absolute path or a relative path. |
FileType |
Notes whether this link is a Revit file or a CAD file. For CAD Link features, this value will be set to “CAD”. |
The Metadata.LevelInformation feature type will output one feature for each level in the target Revit file. This feature will have attributes about the level it represents:
-
level is Structural
-
level is BuildingStory
-
Elevation Base is Base Point or Survey Point
Any supported level parameters set on levels read by this feature type will also be set as attributes on features.
The Metadata.MaterialInformation feature type will output one feature for each Material in the target Revit file. This feature will have attributes about the material it represents.
The following attributes apply to Metadata.MaterialInformation features:
Attribute/Trait Name |
Comments |
---|---|
IdentityData |
Information contained in the Identity tab of the Revit Material Browser (that is, Class, Comments, Cost, Description, Keynote, Keywords, Manufacturer, Mark, Model, URL). |
Use Render Appearance |
Indicates whether the render appearance will be used. |
Shading Color |
Color of shading. |
Shading Transparency |
Transparency of shading. |
Surface Foreground Pattern |
Selected Foreground Pattern for Surfaces. |
Surface Foreground Color |
Color for the Surface Foreground Pattern. |
Surface Background Pattern |
Selected Background Pattern for Surfaces. |
Surface Background Color |
Color for the Surface Background Pattern. |
Cut Foreground Pattern |
Selected Foreground Pattern for Cuts. |
Cut Foreground Color |
Color for the Cut Foreground Pattern. |
Cut Background Pattern |
Selected Background Pattern for Cuts. |
Cut Background Color |
Color for the Cut Background Pattern. |
Appearance Name |
Name of associated Appearance. |
Physical Name |
Name of associated Physical Properties. |
Thermal Name |
Name of associated Thermal Properties. |
The Metadata.ProjectPhases feature type will output one feature for each Project Phase in the target Revit file.
The following attributes apply to Metadata.ProjectPhases features:
Attribute/Trait Name |
Comments |
---|---|
Name |
Name of the Phase. |
Description |
Description of the Phase. |
SequenceNumber |
Position in the order of Phases. |
The Metadata.PhaseFilters feature type will output one feature for each Phase Filter in the target Revit file.
The following attributes apply to Metadata.PhaseFilters features:
Attribute/Trait Name |
Comments |
---|---|
FilterName |
Name of the Phase Filter. |
New |
Method with which to display New elements. |
Existing |
Method with which to display Existing elements. |
Demolished |
Method with which to display Demolished elements. |
Temporary |
Method with which to display Temporary elements. |
Metadata.PhaseGraphicOverrides
The Metadata.PhaseGraphicOverrides feature type will output four features (one for each phase status):
- New
- Existing
- Demolished
- Temporary
The following attributes apply to Metadata.PhaseGraphicOverrides features:
Attribute/Trait Name |
Comments |
---|---|
PhaseStatus |
Phase Status for which graphic overrides are applied. |
Halftone |
Indicates whether the halftone mode is on. |
Material |
Name of associated Material. |
ProjectionSurface.Lines.Pattern |
Overrides Line Pattern of Projection/Surface. |
ProjectionSurface.Lines.Color |
Overrides Line Color of Projection/Surface. |
ProjectionSurface.Lines.Weight |
Overrides Line Weight of Projection/Surface. |
ProjectionSurface.Patterns.ForegroundVisible |
Overrides whether Foreground Pattern of Projection/Surface is visible. |
ProjectionSurface.Patterns.ForegroundPattern |
Overrides Foreground Pattern of Projection/Surface. |
ProjectionSurface.Patterns.ForegroundColor |
Overrides Foreground Pattern Color of Projection/Surface. |
ProjectionSurface.Patterns.BackgroundVisible |
Overrides whether Background Pattern of Projection/Surface is visible. |
ProjectionSurface.Patterns.BackgroundPattern |
Overrides Background Pattern of Projection/Surface. |
ProjectionSurface.Patterns.BackgroundColor |
Overrides Background Pattern Color of Projection/Surface. |
Cut.Lines.Pattern |
Overrides Line Pattern of Cuts. |
Cut.Lines.Color |
Overrides Line Color of Cuts. |
Cut.Lines.Weight |
Overrides Line Weight of Cuts. |
Cut.Patterns.ForegroundVisible |
Overrides whether Foreground Pattern of Cuts is visible. |
Cut.Patterns.ForegroundPattern |
Overrides Foreground Pattern of Cuts. |
Cut.Patterns.ForegroundColor |
Overrides Foreground Pattern Color of Cuts. |
Cut.Patterns.BackgroundVisible |
Overrides whether Background Pattern of Cuts is visible. |
Cut.Patterns.BackgroundPattern |
Overrides Background Pattern of Cuts. |
Cut.Patterns.BackgroundColor |
Overrides Background Pattern Color of Cuts. |
The Metadata.StyleInformation feature type will output features holding information about several style-related parts of the file. These features include the:
-
Model Line Weight table
-
Perspective Line Weight table
-
Annotation Line Weight table
-
Fill patterns
-
Line Patterns
The following attribute applies to all Metadata.StyleInformation features:
Attribute/Trait Name |
Contents |
---|---|
Type |
Indicates the Type of style information this feature represents. This can be set to any of the types listed above. |
Line Weight tables
The Line Weight table features will contain several list attributes, each representing a column in their corresponding table. For the Model Line Weights table feature, these list attributes will be named after the scale of the corresponding column (for example a column with scale 1” = 1’0” will have an attribute 1:12). The values of these attributes are the entries in the corresponding table. Using our example from before, 1:12{0} will be set to the value in the first row in the 1” = 1’0” column, 1:12{1} will be the second, and so on.
Since there is only one column in both the Perspective Line Weight table and the Annotation Line Weight table, the features representing them will only have one list attribute named Line Weights.
Fill Patterns
The fill pattern feature has the Fill Pattern{}.Name and Fill Pattern{}.Type attributes. Each entry in Fill Pattern{}.Name represents the name of a fill pattern found in the file, and the corresponding Fill Pattern{}.Type entry indicates whether this fill pattern is a Model or Drafting pattern.
Line Patterns
The line pattern feature has the Line Pattern{}.Name attribute. Each entry in LinePattern{}.Name represents the name of a line pattern found in the file.
Line Styles
The line style feature has the Line Style{}.Name, Line Style{}.Line Color, Line Style{}.Line Pattern, and Line Style{}.Line Weight Projection attributes. Each entry in the Line Style{} list attribute represents one row in the line style table in the file.
After the Metadata.FileInformation feature, the reader will output Metadata.ViewInformation features. These features have no geometry, and each will have view-level information corresponding to one view in the file.
Attribute/Trait Name |
Contents |
---|---|
Name |
The name of the view. |
DetailLevel |
The detail level of the view. |
Scale |
The view scale value, in the form 1 : <scale>. |
Discipline |
The discipline setting of the view |
Template |
The name of the view template. If the view has no template, this is set to “None”. |
Type |
The type of the view, such as Floor Plan or 3D view. |
Orientation |
Plan views only. The orientation value of the view (Project North or True North). |
IsTemplate |
Indicates whether or not the view is a template view. |
ViewRangeCutPlane.Level |
Plan views only. The level associated with the cut plane in the view range. |
ViewRangeCutPlane.Offset |
Plan views only. The offset associated with the cut plane in the view range. |
ViewRangeTop.Level |
Plan views only. The level associated with the top of the view range. |
ViewRangeTop.Offset |
Plan views only. The offset associated with the top of the view range. |
ViewRangeBottom.Level |
Plan views only. The level associated with the bottom of the view range. |
ViewRangeBottom.Offset |
Plan views only. The offset associated with the bottom of the view range. |
ViewDepth.Level |
Plan views only. The level associated with the view depth in the view range. |
ViewDepth.Offset |
Plan views only. The offset associated with the view depth in the view range. |
HasHiddenElements |
Indicates whether the view contains elements that are hidden. |
The Metadata.Warnings feature type will output one feature for each warning in the file. The feature will have identifying information about the warning it represents:
Attribute/Trait Name |
Contents |
---|---|
WarningType |
Indicates the type of warning, such as “ElemsOverlapWarning” or “DuplicateValueWarning”. |
AssociatedElements{}.Id |
The AssociatedElements{} list attribute holds information about the elements associated with the warning. The Id portion holds the ID of the element in question (which is the same as the ObjectId attribute). |
AssociatedElements{}.Label |
The AssociatedElements{} list attribute holds information about the elements associated with the warning. The Label portion holds the label that is displayed in the Revit Warnings menu. |
The Metadata.Worksets feature type will output one feature for each Workset in the target Revit file. The following attributes apply to Metadata.Worksets features:
Attribute/Trait Name |
Contents |
---|---|
Name |
The name of the Workset. |
Type |
The type of Workset:
|
The SitePoints feature type will contain two points: one representing the Survey Point in the file, and one representing the Project Base Point. This feature type will have the following attributes on features:
Attribute/Trait Name |
Contents |
---|---|
Type |
Indicates the type of the feature. This will hold two possible values: Survey Point or Project Base Point. |
N/S |
The N/S value for the point. |
E/W |
The E/W value for the point. |
Elev |
The Elev value for the point. |
Angle to True North |
Project base point only. The Angle to True North value for the point. |
Categories
Supported Revit Categories
The following categories are supported by FME in all view types and will be read as features if their visibility is set to “on” in the selected view.
Revit Category | Feature Type |
---|---|
Casework |
Architectural.Casework |
Ceilings |
Architectural.Ceilings |
Columns |
Architectural.Columns |
Curtain Panels |
Architectural.CurtainPanels |
Curtain Wall Mullions |
Architectural.CurtainWallMullions |
Doors |
Architectural.Doors |
Entourage |
Architectural.Entourage |
Floors |
Architectural.Floors |
Furniture |
Architectural.Furniture |
Furniture Systems |
Architectural.FurnitureSystems |
Generic Models |
Architectural.GenericModels |
Mass |
Architectural.Mass |
Parking |
Architectural.Parking |
Planting |
Architectural.Planting |
Plumbing Fixtures |
Architectural.PlumbingFixtures |
Railings |
Architectural.Railings |
Ramps |
Architectural.Ramps |
Fascias |
Architectural.Roofs |
Gutters |
Architectural.Roofs |
Roof Soffits |
Architectural.Roofs |
Roofs |
Architectural.Roofs |
Rooms |
Architectural.Rooms |
Site |
Architectural.Site |
Specialty Equipment |
Architectural.SpecialtyEquipment |
Stairs |
Architectural.Stairs |
Stair Landings |
Architectural.Landings |
Stair Runs |
Architectural.Runs |
Topography |
Architectural.Topography |
Top Rails |
Architectural.TopRails |
Walls |
Architectural.Walls |
Wall Sweeps |
Architectural.Walls |
Windows |
Architectural.Windows |
Communication Devices |
Electrical.CommunicationDevices |
Data Devices |
Electrical.DataDevices |
Cable Trays |
Electrical.CableTrays |
Cable Tray Fittings |
Electrical.CableTrayFittings |
Electrical Equipment |
Electrical.ElectricalEquipment |
Electrical Fixtures |
Electrical.ElectricalFixtures |
Fire Alarm Devices |
Electrical.FireAlarmDevices |
Lighting Devices |
Electrical.LightingDevices |
LightingFixtures |
Electrical.LightingFixtures |
Nurse Call Devices |
Electrical.NurseCallDevices |
Security Devices |
Electrical.SecurityDevices |
Telephone Devices |
Electrical.TelephoneDevices |
Air Terminals |
Mechanical.AirTerminals |
Duct Accessories |
Mechanical.DuctAccessories |
Duct Fittings |
Mechanical.DuctFittings |
Ducts |
Mechanical.Ducts |
Flex Ducts |
Mechanical.FlexDucts |
Mechanical Equipment |
Mechanical.MechanicalEquipment |
Flex Pipes |
Piping.FlexPipes |
Pipe Accessories |
Piping.PipeAccessories |
Pipe Fittings |
Piping.PipeFittings |
Pipes |
Piping.Pipes |
Pipe Segments |
Piping.PipeSegments |
Sprinklers |
Piping.Sprinklers |
Structural Columns |
Structural.StructuralColumns |
Structural Connections |
Structural.StructuralConnections |
Structural Foundations |
Structural.StructuralFoundations |
Structural Framing |
Structural.StructuralFraming |
Area-Plan-Only Supported Revit Categories
The following category is supported by FME, but is unique to area-plan reading.
Revit Category |
Feature Type |
---|---|
Areas |
Architectural.Areas |
Floor-Plan-Only Supported Revit Categories
The following categories are supported by FME, but are unique to floor-plan reading.
Revit Category |
Feature Type |
---|---|
Cable Tray Tags |
Architectural.CableTrayTags |
Cable Tray Fitting Tags |
Architectural.CableTrayFittingTags |
Color Fill Legends |
Architectural.ColorFillLegends |
Detail Groups |
Architectural.DetailGroups |
Dimensions |
Architectural.Dimensions |
Elevations |
Architectural.Elevations |
Generic Annotations |
Architectural.GenericAnnotations |
Grids |
Architectural.Grids |
Lines |
Architectural.Lines |
Planting Tags |
Architectural.PlantingTags |
Property Lines |
Architectural.Site |
Room Tags |
Architectural.RoomTags |
Text Notes |
Architectural.TextNotes |
Sections |
Architectural.Views |
Window Tags |
Architectural.WindowTags |
Attributes
Common Attributes
Attribute/Trait Name |
Contents |
---|---|
BaseCategory |
The base category to which the feature belongs. The base category is more general than the Category (for example, the Roof Soffit category has a base category of Roofs). |
Category |
The category to which the feature belongs. |
CreatedPhase |
The phase of construction that the feature’s creation takes place. |
DemolishedPhase |
The phase of demolition that the feature’s destruction takes place. |
Discipline |
The Revit discipline to which the features belong. The set of disciplines includes Architectural, Structural, Electrical, Mechanical, and Piping. |
ElementType |
The type of element that this feature represents. |
Family |
The family to which the feature belongs. |
FamilyType |
The type of the family to which the feature belongs. |
Function |
The function of the feature. Possible values include Interior, Exterior, Foundation, Retaining, Soffit, and CoreShaft. |
Group |
If the element is part of a group, this attribute will be set with the name of the group that the element belongs to. |
InExteriorShell |
Whether the feature is part of the exterior shell of the model. |
ObjectId |
The object ID of the feature. |
ParentComponentId |
If the element is a sub-component, this attribute will be set with the ObjectId of its parent component. |
UniqueId |
The unique ID of the feature. This ID is consistent for the lifetime of the element, even across multiple file sync operations. |
WorksetName |
If the element belongs to a workset, this attribute will be set to the name of the workset that the element belongs to. |
BUILDING_LEVEL Field Attributes
These attributes contain information relating to the level of a building on which the feature is found. Stair (and some other) elements have two sets of these attributes: one for the level at their bottom (BaseLevel), and one for the level at their top (TopLevel).
Attribute/Trait Name |
Contents |
---|---|
BuildingLevel |
The level of the building that the feature is located on. |
BuildingLevelElevation |
The elevation of the feature’s building level. |
BuildingLevelIsStory |
The level that the feature is on is a building story. |
BuildingLevelRoomOffset |
The room offset of the feature. |
Hosted Element Attributes
Elements that are hosted inside of other elements, such as doors, will have these additional attributes on their features.
Attribute/Trait Name |
Contents |
---|---|
HostId |
The ObjectId of a feature’s host element. |
HostFeatureType |
The feature type of a feature’s host element. |
HostObjectFunction |
The function of a feature’s host element. |
Additional Parameters as Attributes
Additional built-in parameters will be read as attributes on features if they have been set on the corresponding Revit elements. These attributes are prefixed by their parameter set name, if applicable.
Attribute/Trait Name |
Contents |
---|---|
Elevation |
The elevation of this instance of the feature. |
PointElevation |
The elevation point of this feature. |
Additional Parameters as Attributes for Piping Discipline Features
These parameters can be found on features from the piping discipline only.
Attribute/Trait Name |
Contents |
---|---|
CalculatedSize |
The calculated size of the feature. |
Drain |
The drain for this feature. |
SupplyFitting |
Whether this feature is a supply fitting. |
SupplyPipe |
Whether this feature is a supply pipe. |
Trap |
The trap for this feature. |
WidthDiameter |
The diameter of the feature. |
Sub-attributes for Features with Connectors
Duct, electrical, pipe, cable tray and conduit elements have connectors to other elements of the same kind. These connectors are displayed as a list with several sub-attributes.
Attribute/Trait Name |
Contents |
---|---|
DomainType |
Which domain this connector falls under. |
FlowDirectionType |
The flow direction of this connector on the feature. |
IsConnected |
Whether this connector is connected to another connector logically. |
IsPhysicalConnector |
Whether this connector is connected to another connector and is visible in Revit. |
Type |
The type of connector on the feature. |
User-Defined Parameters as Attributes
Family, Project, and Shared Parameters
FME will read family, project, and shared parameters from Revit elements as attributes on features if they belong to a supported parameter set. These parameter sets include:
- Text
- Title
- Identity Data
- Data
- General
- IFC
- Phasing
- Dimensions
- Graphics
- Analytical Properties
- Electrical
- Mechanical
- Structural
- Plumbing
- Construction
- Green Building
- Constraints
- Other
The parameters will be prefixed with the name of their set, similar to built-in parameters.
Schedule Parameters
FME will read schedule values as attributes on features. If an element belongs to a schedule, FME will attempt to read each column in that schedule and set attributes of the form <schedulename>.<columnname>. Note that not all column types are supported at this time.
For more information on linking a DWG file to your Revit dataset, please refer to the Autodesk help page: Link a DWG File and Use Shared Coordinates.