Setting up model configuration
The Setup section covers model configuration tasks that must be performed before the model is integrated with IBM® Maximo® Real Estate and Facilities. Most of these are independent of the Maximo Real Estate and Facilities server.
Defining project settings
About this task
Procedure
Sample naming rules
This table provides guidelines for the naming rules that can be used as a reasonable start to developing the naming policy of your organization.
| Naming | Value |
|---|---|
| Model | <Model file name> |
| Building | <Building name> |
| Floor | <Name> |
| Room | <Level>-<Name>-<Number> |
| Area | <Area Scheme>-<Level>-<Name>-<Number> |
| Space | <Level>-<Name>-Number> |
| Type | <Category>-<Type name> |
| Component | <Category>-<Type name>-<Element Id> |
| Barcode | <Element Id> |
- All models in a linked set have unique model names.
- If Maximo Real Estate and Facilities Spaces are to be created directly from Areas, the area name must not be the same as any Room name. Since similar rules are shown above, the Area must be disambiguated from the Room. For example, in the table, the Area Scheme name is used. Alternatively, a simple constant prefix such as “A” can be used.
- Element ID is only useful for the barcode for prototyping. Real barcode should be entered in the model and used to match the existing assets or to create new assets.
Populate parameters
| Option | Description |
|---|---|
| Blank | Only update the value if it is blank. This implies that either Populate Parameters has never been run, or the element has been added since the last time it was run. |
| Always | Overwrite any existing value. |
| Never | Do not populate. |
Usually, it is necessary to run Populate Parameters before the initial integration and before newly added elements are integrated. Blank option works well for this. If one of the forms report errors, it may be necessary to use Always option to overwrite the values with corrections.
After an element is linked to Maximo Real Estate and Facilities or if it is integrated with an existing Maximo Real Estate and Facilities record, the name value is retrieved from Maximo Real Estate and Facilities. If Project Information - IBM.InService.Date is blank, it is populated from the Project Information Issue Date parameter.
Reserve
Schedules
Populate Parameters creates schedules that show values of the IBM parameters added to each type. It may create:
- Levels Schedule
- Rooms Schedule
- Spaces Schedule
- Areas Schedule for each Area Schema
Schedules are only created if there is at least one instance of the schedule element type in the model. Each schedule is filtered for the IsTRIRIGA parameter having a value of true.
Space use class
Space Use Class is a split button that can display either a property sheet for setting Space Use Class on individual elements, or a bulk tool for setting Space Use Class on groups of elements. The button shows the last tools used.
Maximo Real Estate and Facilities requires all spaces to have a Space Use Classification specified. Therefore, to create Maximo Real Estate and Facilities spaces for Revit Rooms, Spaces, or Areas, a Use Classification needs to be provided.
The Space Use Class List is retrieved from the Maximo Real Estate and Facilities server on login and stored in the model. If a list is already stored in the model, the new list is compared to the old and a warning is issued if any entries in the old list are not in the new list. This happens whenever a model is opened and the connector is already logged into Maximo Real Estate and Facilities, or when the connector logs into Maximo Real Estate and Facilities with a model open.
Use Classification can be assigned individually or in bulk to Revit Rooms and Spaces. They are stored in the IBM.UseClassification parameter and the human-readable label is stored in the IBM.UseClassification.Name parameter. These values are used when Maximo Real Estate and Facilities spaces are created from the Revit objects. After a Revit Room or Space is integrated with a Maximo Real Estate and Facilities space, Maximo Real Estate and Facilities is the master for Use Classification, so the updates here have no effect and are overwritten by a Sync operation.
The Space Use Class List may be imported and exported as an XML file. This allows the Connector to be used to configure Space Use Classes without access to a Maximo Real Estate and Facilities server.
Property sheet
If the current selection contains at least one element that supports Space Use Class: a Room, Space, or Area, the Space Use Class tree is displayed, and the name of the element is shown in the property sheet title bar. If the selection set has exactly one element that supports Space Use Class, the currently assigned Space Use Class is selected in the tree.
Apply: The Space Use Class of all the elements in the selection set that supports Space Use Class can be updated by selecting a Space Use Class in the tree and pressing the Apply button. If any of the selected elements are Areas, and the selected Space Use Class has a BOMA type specified, the Area Type of the Area is updated.
Bulk
| Fields | Description |
|---|---|
| Level | The drop-down lists all Revit levels. The selected level sets the context for the Revit Rooms, Revit Spaces, and Revit Areas tabs. |
| Revit Rooms | Lists all the Rooms on the selected Level that do not have Use Classifications assigned. |
| Revit Spaces | Lists all the Spaces on the selected Level that do not have Use Classifications assigned and are not linked to a room either by Revit, or by the Connector Spaces tool. If Rooms and Spaces are defined in the same model, and a Room and Space share the same boundary, then Revit links them. |
| Revit Areas | Lists all the Areas for any Area Schema on the selected Level that do not have Use
Classifications assigned. Tip: Use Classification is only used for Spaces if a
Maximo Real Estate and
Facilities Space is directly created from the
Revit Space. This is rare as Revit Spaces are typically linked to
Maximo Real Estate and
Facilities Spaces created from Rooms. You can
bulk assign a Use Classification to spaces and then individually edit any of them that will be
directly integrated.
|
| Revit Shafts | All the Shafts associated with the selected Level that do not have Shaft Types assigned. Shafts use a subset of the Space Use Class hierarchy. When the Shaft tab is selected, the Space Use Class tree is filtered to show only the valid Shaft types. |
| Revit Rooms with Maximo Real Estate and Facilities Space Use Class | Lists the current rooms and spaces that have the Use Classifications assigned, and their
assigned value. When the form is initially opened, this displays the current state of the
model. Entries that have Space Use Classes and are not in the list of Space Use Classes stored in the model are shown in red. This can happen if the connector logs into a server with a different set of Space Use Classes that were used when the assignments were made. If the Revit Area Type does not match the BOMA type of the Space Use classes, the Area Type is shown in red. This may happen if the Area Type is set by some method other than the IBM Maximo Real Estate and Facilities Connector for BIM, or models configured with older versions of the connector. |
| Update Area Type | If this option is selected, when the form is accepted, all Areas that have Space Use Classes assigned have their Area Type updated to match the BOMA type of the Space Use Class. |
| Assign | When a Use Classification is selected, and at least one Room or Space is selected, this button is active. Pressing it assigns the Use Classification to all selected Rooms and Spaces, removes the Rooms and Spaces from their respective list, and adds them to the assigned table. |
| Maximo Real Estate and Facilities Space Use Class | The Space Use classification hierarchy from the server to which the Connector is logged into. This is retrieved at the time of login. |
| Assign All | Assigns the selected Use Classification to all Rooms and Spaces on all levels. Any previously assigned values are overwritten. All Rooms and Spaces are moved to the assigned table with the new value. |
| Assign Blank | Assigns the selected Use Classification to all Rooms and Spaces on all levels that do not currently have a value. All Rooms and Spaces are moved to the assigned table with the new value. |
| Remove | Removes all selected rows from the assigned table, clears the Use Classification value and returns them to their respective lists. |
| Update | Values in the assigned table can be directly updated. This is useful for updating assignments
when the server list has changed. To update:
|
| Export | Saves the current Use Classification list to a local file. |
| Import | This button is only active when the Connector is not logged into
Maximo Real Estate and
Facilities. It imports a Use Class list
previously created by export and saves it in the model. This allows the Space Use Class to be used
when a
Maximo Real Estate and
Facilities server is not available. Note:
|
Areas from rooms
Revit uses Area Plans to support space planning. Area plans are used to calculate space and floor area.
- Gross Building: Only one is allowed.
- Rentable: Area is calculated according to the BOMA 98 standards. A model may define any number.
- The area boundaries match the room boundaries.
- A room is comprised of exactly n areas. That is, none of the Area boundaries for areas within
the room cross the Room boundary, and there is more than one Area within the Room.
- An Area is encompassing exactly n Rooms. That is, none of the room boundaries for Rooms within
the Area cross the area boundaries, and there is more than one Room within the Area, and the Area is
completely filled by Rooms.
- Areas are arbitrary. Area and room boundaries cross.
The Connector can use Area Plans to calculate Maximo Real Estate and Facilities floor area and Areas to calculate Maximo Real Estate and Facilities Space area. Since there is only one Gross Area Plan allowed, if it exists, it is used to calculate gross floor area. The Rentable Area Plan must be specified. Areas can be linked to Rooms assuming Areas are specified as described in case 1 or 2 above. When one or more Areas are linked to a Room, the Revit Room area is replaced by the sum of the area from the linked Areas.
- Creating an Area Plan from the selected Area scheme and level if one does not exist.
- Creating Area separator lines by cloning the Room separator lines.
- Cloning an Area from each Room and placing it within the cloned separator lines.
- Assigning Area name and number from the name and number of the cloned Room.
- Creating and placing Area Tags.
- Associating the new Area with the Room from which it was derived.
- Setting Area Type.
Creating areas from rooms
About this task
| Field/Drop-down | Action | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Area Schema | Select an Area Schema: Gross Building Area, Rentable Area, or a Custom Schema. To use this tool, the Area Schema must already exist in the model. Area Schema can be created with the “Area Plan” tool found on the Architecture tab. | ||||||||||||||||||||
| Create Area Plan for Level | Select a level. | ||||||||||||||||||||
| Area Plan Name | Select an existing Area Plan to reuse, or click New to create a new Area Plan. If New is selected, the New Area Plan field is enabled. | ||||||||||||||||||||
| Create Areas boundaries and Areas | If this option is not selected, and an existing Area Plan is selected, existing Areas are deleted, but no new Areas are created. That is, it clears the Area Plan. | ||||||||||||||||||||
| Link Area to Room | When selected, the steps that are manually performed in the Map Areas to Rooms tool are automatically performed as part of Area creation. | ||||||||||||||||||||
| Copy Area Type from Maximo Real Estate and Facilities Space Use Class | If a Room has a
Maximo Real Estate and
Facilities
Space Use Class assigned, the Area Type parameter of the Area created from the room is initialized
from the BOMA class of the Space Use Class using the following mapping:
|
||||||||||||||||||||
If Areas already exist for the selected Area Schema/Level combination, you are prompted to delete the existing Areas. It is not required that existing Areas be deleted. However, if they are not, Revit issues a warning whenever an existing Area and an Area created by this tool overlap, and the new Area may not be placed properly. These warnings must be manually resolved.
If existing Areas are deleted, all information in the existing Areas is lost. New Areas are created solely from the Rooms. In addition, the new Areas have different IDs from the deleted Areas even if they occupy essentially the same space. Any references to the Area by ID will be broken. When existing Areas are deleted, links between Level and Area Plan, and Room and Area created by the Map Areas to Rooms tool are automatically removed.
Room filter
The tool is primarily intended for a one-time generation of Areas after all rooms have been added to the model. However, it can also be used to generate Areas for a selected set of Rooms, either initially or after the model has been changed. Areas are only created for Rooms that are checked in the room filter.
When the form is initially displayed, Rooms in the filter are checked if they do not have an Area mapped to them, which presumes that no Area has been created for the Room. Running the tool “fills in” the missing Area. If Rooms already have Areas occupying some or all their area, a Revit error will result.
Map areas to rooms tool
The Map Areas to Rooms tool manages the association of Area Plans to Levels and Areas to Rooms. The function of this tool overlaps with the Areas tool. The Connector uses Revit Area Plans and Area for Maximo Real Estate and Facilities Floor and Space Area calculation.
| Field | Description |
|---|---|
| Level | Select Area Plans for each Revit Level. For each
Maximo Real Estate and
Facilities Floor, three area plans are used to
calculate area:
For Gross Area and Gross Measured Area, the floor area reported to Maximo Real Estate and Facilities is the sum of all the Areas in the selected Area Plan. Typically, this is a single area. I many cases Revit can automatically create the Area boundary when the Area Plan is created. The Gross Area Plan must be a Revit Gross Area Plan. Currently Revit only allows a single Gross Area Plan. The Gross Measured Area Plan and Rentable Area Plan are Revit Rentable Area Plans. In addition, the selected Level controls which Rooms and Areas are displayed in the next section. |
| Revit Rooms | This displays the list of Rooms on the Level not linked to an Area in the selected Area Schema. Each Area Schema has its own set of Rooms. |
| Revit Areas | For the Gross Area Schema, this displays the list of Areas defined for the Area Schema. For Rentable Area Schemas, the Area Schema must be selected. The list of areas displayed is for the selected Area Schema. The selected Area Schema also controls the set of linked areas displayed in the linked table. Links are shown for the Gross Area Schema and the selected Rentable Area Schema. |
| Link | When an entry is selected in the Rooms list and one or more entries are selected in the Areas list, pressing Link associates them, removes them from their respective lists and adds them to the Linked Rooms and Areas table in the correct section. |
| Auto Match | Auto match performs an exact name match of each room against the displayed area list. Each matching pair is linked as above. |
| Suggest | If the Suggest option is selected, the Area list is filtered by the selected room to only show Areas that have their insertion point within the bounding box of the selected room. |
| Show Linked Rooms | When this is not selected (the default), the Rooms list behaves as described above. Any Room that is linked to at least one Area is not displayed in the list. This makes it easy to see which Rooms still need to be linked. However, if additional Areas need to be added to a Room, then the Room must be displayed in the Revit Rooms list to create the new linkage. Selecting this option displays all Rooms. |
| Revit Rooms linked to Revit Areas | The table displays the Room to Area linkage that will be applied to the model if the form is accepted. Pay attention to the Rentable Area section as it changes based on the selected Rentable Area Plan. |
| Remove | Removes the highlighted row(s) from the linkage table returning the Rooms and Areas to their respective lists. |
| Copy Space Use Class to Area | If this option is selected when the form is accepted, each Area that is mapped to a Room will have its Space Use Class update to match the Room’s value if the Room has a value set. |
- Even if you do not map rentable Areas to Rooms, select a Gross Measured Area Plan for use in calculating floor rentable area.
- If you have worked with more than one Rentable Area Plan, be sure that the correct one is selected when you accept the form. Only the mappings for the selected Area Plan are saved and used.
Validate tool
The Validate tool tests and validates the IBM parameter values for all element types. It is the same validation performed individually by the tools in the Integrate section, but it does not require a Maximo Real Estate and Facilities login, or any elements to be integrated. It is a dockable property panel.
- Refresh: Reruns the validation.
- Double click an error entry: Uses the standard Revit mechanism to display
and select the element referenced by the error. For Types, it selects the elements but does not
display the first component of the referenced type, and then opens the Type editor.Tip: When correcting errors for IBM parameters whose values are generated from other parameters by a naming rule, it is generally best to correct the source parameters and rerun Populate Parameters with the required parameter type(s) set to always update.
| Test | Result |
|---|---|
| Project Information |
|
| Levels |
|
| Shafts |
|
| Rooms |
|
| Spaces |
|
| Areas |
|
| Types |
|
| Family Instance/Component |
|