Introduction

BIM Pars is a Revit extension developed using Python within the pyRevit environment, functioning as an app designed to simplify complex workflows by automating tasks. This tool is primarily focused on BIM and data processing within a Revit model, but can be beneficial for various other users, including planners and anyone who works with Revit. BIM Pars is an open-source application, offering users an enhanced, customizable experience.

Key Features

1. Automatic Report Generation

BIM Pars generates reports in the form of data grids, which include the necessary data and modifications based on the tools executed within the app.

2. Data Grid Modifications

Users can search, add, remove columns and rows, filter data, and apply color coding to better identify specific data points. The reports can be exported to formats such as HTML, XLSX, or CSV.

3. Output and Printing

Reports can be printed in the pyRevit output window, with an optional user-defined logo at the report header. The output can then be saved as PDF or HTML.

4. HTML Importing

BIM Pars can import and display any HTML file in the pyRevit output window, making it easy to view previous reports stored in HTML format.

5. Selection Management

Users can manage selections without altering the Revit model. Actions like filter, store, import, export, and load selections are available without changing the model itself.

6. Custom Scripts

BIM Pars supports custom Python scripts, enabling users to add, delete, and run scripts directly within the app. Custom documentation and resources such as video links and GitHub references can also be integrated.

7. Multi-language Support

BIM Pars supports seven languages, allowing users to switch the app interface and report generation language as needed.

Installation

Prerequisites:

• pyRevit must be installed to run BIM Pars app, as it is developed within the pyRevit environment.

Installation Steps:

1. Install pyRevit. (Ignore this step if pyRevit is already installed.)
2. Install Extension.

License Key

To use BIM Pars, a license key is required. This key can be obtained by:

1. Creating a free account – After registering, the key will be sent via email.
2. Logging into your account – Once logged in, you can access and copy your key.

Activating BIM Pars:

1. Open the BIM Pars app.
2. When prompted, select Yes to enter your key.
3. Paste the copied key into the provided textbox and click Save.




4. If the key is valid, the app will open successfully.

The key is Free of charge , and you can always access it from the Settings window.

Mode

The Mode feature allows you to change the appearance and theme of the BIM Pars app.

Changing the Mode:

1. Open the Settings window of the app.
2. From the Mode dropdown, select your preferred mode.




3. Close the Settings window to apply the changes.

Note: As of BIM Pars V1.0, the Mode functionality is not available. The default mode is set to Standard Mode.

Language

BIM Pars supports seven languages for its user interface and report generation. Changing the language of the app does not affect Revit's language settings.

Supported Languages:

• English
• Deutsch
• Farsi
• Russian
• Spanish
• Chinese
• Korean

Changing the Language:

1. Open the Settings window.
2. From the Language dropdown, select the desired language.




3. Close the Settings window.
4. Restart the app for the language change to take effect.

Default Language: English

Logo

One of BIM Pars’ unique features is the ability to customize the logo that appears in reports. By default, reports generated in BIM Pars will include the BIM Pars heading logo. However, users can replace this with their own logo.

Changing the Logo:

1. Open the Settings window.
2. Navigate to the Logo section and click New.




3. Select the logo you want to use and click Open.
4. Close the Settings window to apply the change.

Resetting to Default:

If you wish to revert to the default settings, including the logo, click Default in the Settings window.

Default Settings

The default configuration for BIM Pars upon installation is as follows:

• Mode: Standard
• Language: English
• Logo: BIM Pars Logo

These default settings can be customized as needed through the Settings window

Interface

Tabs

BIM Pars V1.0 consists of two main tabs: ToolBox Tab and Report Tab.

• ToolBox Tab: This tab provides access to all tools and actions within the app. It remains active until a tool that generates a report is executed.
Report Tab: This tab only appears when you activate a tool that generates a report. It is a temporary tab, and while active, the ToolBox Tab is deactivated. This design prevents the accidental initiation of another tool while a report is still being processed. To return to the ToolBox Tab, click the Back Button, located on the top toolstrip of the Report Tab.

Important:

• Once you close the Report Tab, it cannot be reopened.
• The action associated with the report will remain active, so make sure to Export or Print the report before closing the tab if you need it later.

Toolstrips

BIM Pars features two key toolstrips:

1. Top Toolstrip (Tab-Specific):
   
   
   • Located below the tab ribbon, the top toolstrip is specific to each tab. It contains tools and actions relevant to the active tab, such as starting tools, managing reports, and executing functions.
   
   
2. Right Edge Toolstrip (Universal):
   
   
   • Positioned at the right edge of the window, this toolstrip is accessible across all tabs. It contains several shortcut actions that apply universally to elements within the Revit model. The available actions include:
   • Select/Deselect: Select or deselect elements in the model.
   • Isolate/Revoking Isolation: Isolate elements or revoke isolation.
   • Color/Revoking Color: Apply or remove color overrides on elements.
   • Pin/Remove Pin: Pin or remove pins on selected elements.
   
   

Information Bar

The Information Bar is located at the bottom edge of the main window and is always visible. It contains several key pieces of information:

• BIM Pars and pyRevit logos: Clicking on these logos redirects you to their official websites.
• Process Bar: Displays the progress of actions being performed in the app.
• User Validity& Connection Status: Shows the status of the current user session.
• Number of Selected Elements: Displays the count of elements in the current selection.
• Settings Button: Opens the settings window to configure app preferences.

Toolbox

The ToolBox Tab contains two main groupboxes: Left Groupbox and Right Groupbox .

• Left Groupbox: Displays a tree structure that organizes the different tool groups. Tools are displayed with their names written in Blue color. Each group corresponds to a category of tools, and you can expand or collapse these groups using the associated toolstrip.
  
  
  • When you select a group, the tools for that group are displayed in the Right Groupbox.
  • The left groupbox toolstrip contains actions specific to managing the tree structure (e.g., expand/collapse, references, etc.).
  
  
  


• Right Groupbox: Contains the tools for the selected group. Each tool in this group has its own action that will execute when clicked.
  
  
  • In addition, the Toolstrip at the bottom of the left groupbox contains buttons for documentation, YouTube videos, GitHub repositories, and reporting bugs related to the selected tool.
  
  
  

Script Node Tree Structure

The Script Node Tree Structure: is user-based, meaning it contains custom scripts that the user has added through the Script Manager. These scripts are organized into groups and sub-groups, allowing for easy navigation and execution. Each script in the tree can be configured with:

• Documentation
• YouTube Video Link
• GitHub Repository Link

To configure script node, a JSON file must be used. If the JSON file is not created, all user-added scripts will be listed under the Script Node with inactive documentation, YouTube, and repository buttons. Report Bug is only active for BIM Pars tools.

Creating JSON for Scripts: See the Collection section for details.

Memory

The Memory Tool allows users to store selections of elements without affecting the Revit model. This feature is helpful when managing selections across different projects.

• Save in Memory
• Load and Select Elements
• Load and Reduce Selected Elements

Save in Memory

You can add multiple selections to memory, which will combine into one selection for the project. These selections are stored locally within BIM Pars and will remain in the app even if you close Revit.

Steps:

1. Select some elements.
2. Click the Save in Memory button in the Top Toolstrip of the ToolBox Tab.
3. A notification will appear showing the model path, model name, and user who saved the selection, confirming the memory save.

Load and Select Elements

When you load selections from memory, the current selection will be replaced with the memory selection. If you have elements already selected, they will be deselected when loading memory.

Steps:

1. Click the Load from Memorydropdown in the ToolBox Tab.
2. Select Load and Select Elements.
3. Decide if you want to empty the memory or keep the selection in memory.

Load and Reduce Selected Elements

This option removes elements in the current selection that are also in memory, retaining the rest of the elements in the current selection.

Steps:

1. Click the Load from Memory dropdown in the ToolBox Tab.
2. Select Load and Reduce Selected Elements.
3. Decide if you want to empty the memory or keep the selection in memory.

Save/Load

You can also save selections individually within the ToolBox Tab, similar to how memory functions but with the ability to assign custom names and notes.

• Save
• Load

Save

Steps:

1. Select some elements.
2. Click the Save button in the Top Toolstrip.
3. Provide a Name (required) and an optional Note.




4. The selection will be saved as: Name by User_Project Name.

Load

Steps:

1. Click the Load button in the Top Toolstrip.
2. Select the desired saved selection from the list.




3. You will be asked if you wish to keep or remove the current selection from list of saved selections.

Import

BIM Pars allows you to import selections and reports using various formats, including HTML and XML.

• Import HTML
• Import Selection from XML

Import HTML

You can import any HTML file into the Output Window. This can include previous reports saved in HTML format.

Steps:

1. Click the Import dropdownin the ToolBox Tab.
2. Select Import HTMLoption.
3. Select your HTML file from its location.

Import Selection from XML

Import selections stored in XML files, which contain element IDs and optional notes. Ensure that the imported XML file follows the correct BIM Pars structure, or the import will fail.

Steps:

1. Click the Import dropdownin the ToolBox Tab.
2. Select Import Selection from XMLoption.
3. Select your XML file from its location.

Export

Export selected elements as XML or CSV files.

• Export Selection to XML
• Export Selection to CSV

Export Selection to XML

Export elements with a note for future import.

Steps:

1. Ensure that some elements are selected before proceeding with the export.
2. Click the Export dropdownin the ToolBox Tab.
3. Select Export Selection to XMLoption.
4. Provide a Name (required) and an optional Note.




5. Select a location to save the XML file.

Export Selection to CSV

Lists element IDs in a column (cannot be re-imported directly into BIM Pars).

1. Ensure that some elements are selected before proceeding with the export.
2. Click the Export dropdownin the ToolBox Tab.
3. Select Export Selection to CSVoption.
4. Provide a Name (required).




5. Select a location to save the CSV file.

Script

BIM Pars allows you to execute custom Python scripts and manage them through the Script Manager. Also you can assign relevant documentation, videos, and GitHub repositories via JSON files.

• Script Manager
• Run Directory
• Collection

Script Manager

Enables users to set a directory for scripts and execute them directly from within BIM Pars. Users can also add or remove scripts from the list.

Steps:

1. Click the Script Manager button in the Top Toolstrip .
2. Set or reset the directory in the Directory groupbox.
3. My Script groupbox allows you to create and manage a list of scripts by using the Add and Delete buttons. Execute your desired script from the list using the PickRun button.
4. AI Assist groupbox redirects you to sources that can help you with scripting.

Run Directory

Executes all scripts from the specified directory. If more than one script is in the directory, you will be prompted to choose which script to run.

Steps:

1. Click the Run Directory button in the Top Toolstrip.
2. Select desired script in from the list in case more than one script in directory exist.

Collection

BIM Pars app uses exec() function for execution of scripts.

Steps:

1. Go to this location: bimpars.extension\BIM-Pars.tab\data\pylist.
2. Open the script_metadata.json file and configure the script node.

Download JSON Template

Toolbar Ribon

The Right Edge Toolstrip also contains tools for element selection:

• Select Elements
• Deselect Elements
• Isolate Elements
• Revoke Isolation
• Color Elements
• Revoke Color
• Pin Elements
• Remove Pin

Note: These actions are only applicable if there are elements selected in the model. Buttons will be deactivated if no elements are selected.

Select/Deselect Elements

Select Elements: Selects elements in the model view based on the IDs provided in the report.

Steps:

1. Select desired IDs from the datagrid in the Report Tab.
2. Click the Select button in the Right Edge Toolstrip.

Deselect Elements: Deselects all currently selected elements.

Steps:

1. Click the Deselect button in the Right Edge Toolstrip.

Isolate/Revoke Isolation

Isolate Elements: Isolates the selected elements, hiding all others.

Steps:

1. Ensure that elements are selected.
2. Click the Isolate button in the Right Edge Toolstrip.

Revoke Isolation: Restores visibility to all elements.

Steps:

1. Click the Revoke Isolation button in the Right Edge Toolstrip.

Color/Revoke Color

Color Elements: Changes the appearance of selected elements by applying a color override.

Steps:

1. Ensure that elements are selected.
2. Click the Color Elements button in the Right Edge Toolstrip.

Revoke Color: Resets the color of selected elements to their default appearance.

Steps:

1. Ensure that elements are selected.
2. Click the Revoke Color button in the Right Edge Toolstrip.

Pin/Remove Pin

Pin Elements: Pins the selected elements by plcing a pointer DirectShape, pointing center point of each selected element.

Steps:

1. Ensure that elements are selected.
2. Click the Pin bitton in the Right Edge Toolstrip.

Remove Pin: Removes pins from the selected elements.

Steps:

1. Ensure that elements are selected.
2. Click the Remove Pin button in the Right Edge Toolstrip.

BIM Pars Tools

BIM Pars contains a variety of tools designed to perform a wide range of actions. These tools are categorized into different groups, and some of these groups have subgroups organized in a tree structure. The tree structure can be found on the left side of the Toolbox tab, which helps users organize and access the tools more efficiently. There are three main nodes in the tree structure: BIM Pars tools, Scripts, and Package. All tools developed by BIM Pars are listed under BIM Pars tools, while custom scripts developed or collected by users are found under the Scripts node.

Categorization of BIM Pars Tools

The BIM Pars tools are categorized based on three primary contexts:

1. Info – Tools related to gathering information from elements or models.
2. Element Self – Tools that interact with or analyze the element itself.
3. Element Parameter – Tools dealing with the parameters of elements.

Each of these contexts contains a set of specific tools, ensuring that users can easily find the right tool for their needs.

Tree Structure and Toolstrip

The tree structure comes with a toolstrip that contains six options:

1. Expand – Expands the tree structure.
2. Collapse – Collapses the tree structure.
3. Documentation – Redirects to the tool’s documentation.
4. YouTube Video Guide – Redirects to a relevant YouTube tutorial.
5. GitHub Repository – Redirects to the GitHub repository for the tool.
6. Report Bug – Allows users to report any issues with the tool.

To start a tool, users simply need to select a group from the tree structure, and the available tools for that group will appear in the right box of the ToolBox Tab. Clicking on a tool will activate it.

Information Tools

The Info group in the ToolBox Tab is for information tools designed to gather specific information about elements or the model, without making any changes or modifications. Here are the tools available under the Info group:

• Element ID
• Creator Finder
• Information
• Active View

Element ID

Purpose: Obtains the Element ID of selected elements.

How to Use:

1. Select at least one element. If no element is selected, the button will be deactivated.
2. After ensuring that you have selected an element, click on the tool.
3. The Element ID tool will obtain the Element ID, Name, and Category of each selected element.
4. The results will appear in the Report Tab.

Creator Finder

Purpose: Designed for workshared models to find out the creator and owner of an element.

How to Use:

1. Your model must be workshared for this tool to work.
2. Ensure that at least one element is selected. If no element is selected, the button will be deactivated.
3. If the model is not workshared, you will be notified.
4. Once the conditions are met, click the Creator Finder tool button to run the tool.
5. These results will be shown in a data grid in the Report Tab.
6. The displayed information will include:


• Element ID
• Creator of the element
• Current Owner of the element
• Last user who modified the element

Information

Purpose: Gathers various types of information about the model. It offers seven different options to choose from:

• Model Information: Displays Model Path, Model Name, and Current User.
• Category Element Counts (Current View): Displays Category Name, Category ID, and Element Count for the current view.
• Family Tree: Displays Category Name, Category ID, Family Name, Family ID, Family Type, and Family Type ID for elements in the current view.
• Project Information: Displays project parameters and their corresponding values.
• Project Information/Print Manager Settings: Displays print settings.
• All Categories in Model: Displays Category ID, Category Name, and Element Count for every category in the entire model.
• All Categories and Relevant Views: Displays View Name, Category Name, Category ID, and Element Count, including the views that contain those categories.

How to Use:

1. Click on the Information tool button.
2. Select the desired option in the opened window.
3. Click on the Print button.
4. The results will be displayed in the Report Tab in a data grid.

Active View

Purpose: Obtains information about the currently active view.

How to Use:

1. Click the Active View tool button.
2. The result will appear in the Report Tab.
3. The displayed information will include:


• Active View ID
• Name of the active view
• Creator of the active view
• Last user who modified the view

Selection Tools

Selection Tools are designed to select elements based on different logics and methods. This group contains 4 subgroups:

• Select by Filters: Allows selection of elements based on specified filters.
• Select by Parameter: Enables selection of elements based on specific parameters.
• Select all elements based on the same characteristic: Selects all elements sharing a common characteristic.
• Select using Excel: Facilitates selection of elements through Excel integration.

All tools under the Selection group and its 4 subgroups perform no transactions or modifications; they only select elements based on their respective logic. Once elements are selected, modifications or transactions can be performed, but the tools themselves only select.

Filters

To select elements using filters, there are 3 available filters in BIM Pars app, each with its own logic. These filters can be used to select elements.

• Hierarchy
• DUDUL
• Type

Hierarchy

Purpose: This filter operates on a hierarchical logic aimed at maximizing the number of elements in the selection initially, followed by a reduction in each subsequent step. The process consists of a maximum of 10 steps based on hierarchical logic to filter elements, but you are not required to complete all 10 steps.

How to Use:

1. Ensure that no elements are selected.
2. Click on the Hierarchy tool button.
3. Click on the Filter button after selecting your options in each step.
4. Once finished, click OK, and the filtered elements will appear in the Report Tab with their Element ID, Name, and Category.

DUDUL

Purpose: Includes 12 methods of filtering, with 2 methods that may increase your selection and 10 that will reduce your selection.

Methods:

• View Method: Can be used even if no element is selected. It will bring all elements from a specific view into the selection.
• Level Method : Requires elements to be selected as referece. This method displays the levels of the elements in the selection and selects all elements of a selected level.
• Category: Filters selection to a specific category.
• Family: Filters selection to a specific family.
• Type: Filters selection to a specific type.
• Existence of Parameters: Filters selection to elements that have a specific parameter.
• Parameter Value: Filters selection based on a specific parameter value.
• String in Parameter Value: Filters selection based on a string value in any of the element parameters.
• Number in Parameter Value: Filters selection based on a numeric value in any of the element parameters.
• Ownership: Filters selection to elements owned by a specific user (workshared models only).
• Modified by: Filters selection to elements last modified by a specific user (workshared models only).
• Creator: Filters selection to elements created by a specific user (workshared models only).

How to Use:

1. Click on the DUDUL tool button from the ToolBox Tab.
2. Select a filtering method.
3. Click on the Filter button.
4. Enter the required specifications for the selected method.
5. The filtered elements will be selected.
6. The Report Tab will display their ID, Name, and Category.

Type

Purpose: This filter is based on the characteristics and location of elements, including View, Level, Category, Family, and Type.

How to Use:

1. Click the Type tool button.
2. Choose if you want to filter elements in the Current View or any other view, and decide if you want to include Levels in your filtering process.




3. Afterward, specify criteria such as view name, level name, category name, family name, and type name in the opened window.
4. After applying the specifications, the filtered elements will be selected, and their Element ID, Name, View, Category, Family, Type, and Level will be displayed in the Report Tab.

Parent Tool:

Delete Elements by Type Filter

Select by Parameter Tools

The tools in this group use the parameters of elements as a reference to apply logic and select elements.

• Select by Search for Value of Instance Parameters
• Search based on Existence of Parameters Value

Select by Search for Value of Instance Parameters

Purpose: Allows selecting elements whose specific instance parameter has a specific value.

How to Use:

1. Click on the Select by Search for Value of Instance Parameters tool button from the ToolBox Tab.
2. Enter the name of the target parameter and its target value, then click OK.




3. The selected elements will appear in the Report Tab with their ID, Name, Parameter, and Value.
4. For boolean parameters, use the appropriate language values (e.g., Yes/No for English or Ja/Nein for German).

Parent Tools:

Reduce Selection by Searching Value of Instance Parameters
Search Value of Instance Parameters

Search based on Existence of Parameters Value

Purpose: Applies three different logic options to select elements based on their parameters. These logic options are:

• Select both with value and with no value
• Select only with value
• Select only with no value

How to Use:

1. Click the Search based on Existence of Parameters Value tool button from the ToolBox Tab and select one of the logic options.
2. Enter the parameter name in the opened window and press OK.




3. You can optionally specify categories by selecting specific categories to narrow down the search or clicking on Check All button to include all the categories.




4. After applying, the Report Tab will show the selected elements with their ID, Name, Parameter, and Value.

Parent Tools:

Reduce Selection by Existence of Parameters Values
Check Existence of Parameters Values

All Elements Tools

The tools in this group are designed to select all elements that share a common characteristic or property.

• All Elements in Selected Categories
• All Elements in Selected Views
• All Elements on Selected Levels
• Ownership of Elements
• Unbound Rooms
• Mirrored Doors

All Elements in Selected Categories

Purpose: This tool selects all elements within specified categories.

How to Use:

1. Click on the All Elements in Selected Categories tool button from the ToolBox Tab.
2. In the opened list, select the target categories.




3. After selection, all elements belonging to the selected categories will be selected.
4. The Report Tab will display their ID, Name, and Category.

Parent Tools:

Reduce Selection by OST Categories
Delete All Elements of OST Category

All Elements in Selected Views

Purpose: This tool selects all elements within specified views.

How to Use:

1. Click on the All Elements in Selected Views tool button from the ToolBox Tab.
2. In the opened list, select the target views.




3. After selection, all elements within the selected views will be selected.
4. The Report Tab will display their ID, Name, Category, and View name.

All Elements on Selected Levels

Purpose: This tool selects all elements on a specific level within the current or another view.

How to Use:

1. Click on the All Elements on Selected Levels tool button from the ToolBox Tab.
2. In the opened window, specify whether the level is in the Current View or Other Views.




3. If you choose the Current View, all levels of the current view will be listed, and you can select one or more levels.
4. If you choose Other Views, first select the views, then the levels of those views will appear.




5. After making the selections, the Report Tab will display their ID, Name, Level, View, and Category.

Ownership of Elements

Purpose: This tool selects all elements owned by specific users.

How to Use:

1. Click on the Ownership of Elements tool button from the ToolBox Tab.
2. In the opened window, you can choose to select all elements owned by you or choose a user from the list.




3. If you are the owner, selecting the second option will display a list of users from which you can select.
4. If you are the owner of all the elements, the list of users will not be displayed.
5. The Report Tab will show ID, Name, Category, and Owner.

Unbound Rooms

Purpose: This tool selects all unbound rooms.

How to Use:

1. Click on the Unbound Rooms tool button from the ToolBox Tab.
2. The Report Tab will display the ID and Name of all unbound rooms.

Mirrored Doors

Purpose: This tool selects all mirrored doors.

How to Use:

1. Click on the Mirrored Doors tool button from the ToolBox Tab.
2. The Report Tab will display the ID and Name of the Mirrored doors.

Excel

The tools in this group use Excel files and element IDs to find and select elements, especially when you have IDs but are unsure of their locations.

• IDs from Excel

IDs from Excel

Purpose: This tool selects elements using IDs from an Excel file.

How to Use:

1. Click on the IDs from Excel tool button from the ToolBox Tab.
2. In the opened window, choose the method for the Excel file format:


• Method 1: IDs in different columns.
• Method 2: IDs in one column.
• Method 3: IDs in one row.






3. After selecting the method, click on the Import button to load the Excel file.
4. If the file imports correctly, the Red light will turn Green.
5. Specify the row, column, or both based on your method.
6. Click OK, and the tool will select elements corresponding to the valid IDs.
7. If any invalid IDs are found, an alert window will display their cell address. The Report Tab will show the ID, Name, and Category of only the valid elements, excluding the invalid ones.

Parent Tool:

Delete Elements by IDs from Excel

Reduce Selection Tools

The tools in this group are designed to reduce your current selection based on different criteria. In order to use these tools, you must have some elements already selected; otherwise, the tools will be deactivated. These tools only reduce the selection without making any modifications or transactions.

• Reduce Selection by ID
• Reduce Selection by OST Categories
• Reduce Selection by Searching Value of Instance Parameters
• Reduce Selection by Existence of Parameters Values

Reduce Selection by ID

Purpose: This tool excludes elements from the selection by their ID.

How to Use:

1. Ensure that you have some elements selected.
2. Click on the Reduce Selection by ID tool button from the ToolBox Tab.
3. In the opened window, enter the integer IDs of the elements you want to exclude. You can enter multiple IDs, separated by commas.




4. Click OK.
5. The elements with the entered IDs will be excluded from your selection.
6. The Report Tab will display the ID, Name, and Category of the remaining elements in your selection.

Parent Tool:

Delete Elements by ID

Reduce Selection by OST Categories

Purpose: This tool reduces the selection by excluding elements from specific categories.

How to Use:

1. Ensure that you have some elements selected.
2. Click on the Reduce Selection by OST Categories tool button from the ToolBox Tab.
3. In the opened window, select the categories you want to exclude.




4. The elements from the selected categories will be excluded from your selection.
5. The Report Tab will display the ID, Name, and Category of the remaining elements in your selection.

Parent Tools:

All Elements in Selected Categories
Delete All Elements of OST Category

Reduce Selection by Searching Value of Instance Parameters

Purpose: This tool reduces the selection by excluding elements with a specific parameter and value.

How to Use:

1. Ensure that you have some elements selected.
2. Click on the Reduce Selection by Searching Value of Instance Parameters tool button from the ToolBox Tab.
3. In the opened window, enter the target parameter and value.




4. Click OK.
5. If any elements match the specified parameter and value, they will be excluded from your selection.
6. The Report Tab will display the ID, Name, and Category of the remaining elements in your selection.
7. If no elements remain in the selection, you will be notified, and no results will appear in the Report Tab.

Note: For boolean parameters, enter Yes or No, depending on your Revit language (e.g., Ja/Nein for German, Yes/No for English).

Parent Tools:

Select by Search for Value of Instance Parameters
Search Value of Instance Parameters

Reduce Selection by Existence of Parameters Values

Purpose: This tool reduces the selection based on the existence of a parameter’s value. You have three options for how to reduce the selection:

• Exclude elements that have a specific parameter, regardless of whether it has a value or not.
• Exclude elements where a specific parameter has a value.
• Exclude elements where a specific parameter does not have a value.

How to Use:

1. Ensure that you have some elements selected.
2. Click on the Reduce Selection by Existence of Parameters Values tool button from the ToolBox Tab.
3. In the opened window, select your desired option for excluding elements:


• Exclude elements with or without a value for a specific parameter.
• Exclude elements where the parameter has a value or does not have a value.






4. Enter the target parameter name.




5. Click OK.
6. You can optionally specify categories to apply this action only to specific categories or click Check All to include all categories.




7. The elements that meet the specified criteria will be excluded from your selection.
8. The Report Tab will display the ID, Name, and Category of the remaining elements in your selection.

Parent Tools:

Search based on Existence of Parameters Value
Check Existence of Parameters Values

Delete Element Tools

The tools in this group are designed to delete elements in the model using various methods. These tools perform the deletion transaction, and it's important to ensure no elements are selected before starting any of these tools. If elements are selected, you will be notified to deselect them first. Additionally, some elements may be dependent on others, which can prevent their deletion. In such cases, even though the tools will display results in the Report Tab, the deletion will not be executed due to the dependencies.

• Delete Elements by ID
• Delete Elements by IDs from Excel
• Delete Elements by Type Filter
• Delete All DirectShape Elements
• Delete All Elements of OST Category

Delete Elements by ID

Purpose: This tool deletes elements based on their element ID.

How to Use:

1. Make sure no elements are selected.
2. Click on the Delete Elements by ID tool button from the ToolBox Tab.
3. In the opened window, enter the element IDs of the elements you want to delete, separated by commas.




4. Click the Search button to validate the entered IDs.
5. The window will extend to display the validation results.




6. Click OK to delete the valid elements. Invalid IDs will be ignored.
7. After the deletion, you will be notified of the result. The Report Tab will display the ID and Status of the deleted elements.
8. The last row in the data grid will show the total number of deleted elements.

Parent Tool:

Reduce Selection by ID

Delete Elements by IDs from Excel

Purpose: This tool deletes elements based on IDs provided in an Excel file.

How to Use:

1. Make sure no elements are selected.
2. Click on the Delete Elements by IDs from Excel tool button from the ToolBox Tab.
3. In the opened window, select the method for the ID format (IDs in different columns, one column, or one row).




4. Click Import button to upload the Excel file. Once successfully imported, the Red light will turn Green.
5. Depending on the format, specify the row/column location of the IDs and click Search button to validate the IDs.
6. The window will extend to show validation results and highlight any invalid IDs.




7. Click OK to delete only the valid elements, ignoring the invalid ones.
8. After the deletion, you will be notified of the result, and the Report Tab will display the ID and Status of the deleted elements.
9. The last row in the data grid will show the total number of deleted elements.

Parent Tool:

IDs from Excel

Delete Elements by Type Filter

Purpose: This tool deletes elements based on a Type filter that includes characteristics such as view, level, category, family, and type.

How to Use:

1. Make sure no elements are selected.
2. Click on the Delete Elements by Type Filter tool button from the ToolBox Tab.
3. Decide if you want to filter by the current view or another view. You can also choose to include levels in the filtering process.




4. Click Submit to start filtering.
5. In each step of the process, specify the view name, level name, category, family, and type of element you want to filter.
6. The filtered elements will be selected, and you will be asked if you are sure you want to delete them.
7. The number of filtered elements will be displayed, and if you click OK, the elements will be deleted.




8. The Report Tab will display the Element ID and Status of the deleted elements.
9. The last row in the data grid will show the total number of deleted elements.

Parent Tool:

Type

Delete All DirectShape Elements

Purpose: This tool automatically finds and deletes all DirectShape elements in the model.

How to Use:

1. Make sure no elements are selected.
2. Click on the Delete All DirectShape Elements tool button from the ToolBox Tab.
3. If any DirectShape elements exist in the model, they will be selected automatically.
4. You will be asked if you are sure you want to delete these elements. The number of DirectShape elements will be displayed.




5. Click OK to delete the elements.
6. The Report Tab will display the ID and Status of the deleted elements.
7. The last row in the data grid will show the total number of deleted elements.

Note: This tool can also delete Pins that point to elements, as these use DirectShape elements.

Delete All Elements of OST Category

Purpose: This tool deletes all elements from specific categories.

How to Use:

1. Make sure no elements are selected.
2. Click on the Delete All Elements of OST Category tool button from the ToolBox Tab.
3. In the opened list, select the categories whose elements you want to delete.




4. The number of elements in the selected categories will be displayed.
5. You will be asked if you are sure you want to delete the elements.




6. Click OK to delete the selected elements.
7. The Report Tab will display the ID and Status of the deleted elements.
8. The last row in the data grid will show the total number of deleted elements.

Parent Tools:

All Elements in Selected Categories
Reduce Selection by OST Categories

Parameter Tools

The tools in this group are focused on parameters themselves, rather than the values they hold. These tools are divided into three subgroups: Search, Check, and Delete. The Search and Check tools provide insights into parameter data without modifying the model, while the Delete tools are designed to delete parameters and perform transactions in the model.

• Search Parameter Tools
• Check Parameter Tools
• Delete Parameter Tools

Search Parameter Tools

The tools in this subgroup focus on searching for and investigating parameter values without making changes to the model. These tools help you find and analyze parameter data based on specific filters and conditions.

• Search Value of Parameter by Filter
• Search Value of Parameter for Family Document
• Snipe Parameter Value
• Snipe Parameter Value for Family Document
• Dictionary

Search Value of Parameter by Filter

Purpose: Filters elements and allows you to investigate the parameters and their values for the filtered elements.

How to Use:

1. Click the Search Value of Parameter by Filter tool button from the ToolBox Tab.
2. Specify a category from the list of categories.
3. Select a family from the list of families under the selected category. You can select All families, which includes all elements of the selected category. If you choose a specific family, you will be able to select a type.
4. After selecting the family/type, choose the parameters you want to investigate.




5. The data grid in the Report Tab will display the ID, Name, Parameter, and Value of the filtered elements.

Note: If a category or family does not have parameters, you will be notified.

Parent Tool:

Search Value of Parameter for Family Document

Search Value of Parameter for Family Document

Purpose: Similar to the previous tool but specifically for investigating parameters within a family document. Useful for nested family parameter investigation.

How to Use:

1. Click the Search Value of Parameter for Family Document tool button from the ToolBox Tab in a family document.
2. Select a category and family from the list.
3. Choose whether to investigate All families or a specific family.
4. If a specific family is selected, you can further specify a type.
5. Choose the parameters you want to investigate, and the ID, Name, Parameter, and Value will appear in the Report Tab.

Note: The parameter list includes labels to show if the parameter is Built-in, Type, or Used as Label. If no parameters are available for a selected family or category, you will be notified.

Parent Tool:

Search Value of Parameter by Filter

Snipe Parameter Value

Purpose: Investigates parameters for a single element.

How to Use:

1. Ensure exactly one element is selected. The tool will be deactivated if more than one element is selected.
2. Click the Snipe Parameter Value tool button from the ToolBox Tab.
3. Select the target parameters you want to investigate from the list. The parameters are labeled by type (e.g., Instance, Type).




4. The Report Tab will display the ID, Name, Parameter, and Value of the selected element.

Parent Tool:

Snipe Parameter Value for Family Document

Snipe Parameter Value for Family Document

Purpose: Investigates parameters of a single element in a family document. Useful for nested families.

How to Use:

1. Ensure exactly one element is selected in a family document. The tool will be deactivated if more than one element is selected.
2. Click the Snipe Parameter Value for Family Document tool button from the ToolBox Tab.
3. Select the target parameters you want to investigate.




4. The Report Tab will display the ID, Name, Parameter, and Value.

Note: The parameter list includes labels showing whether the parameter is Built-in, Type, or Used as Label.

Parent Tool:

Snipe Parameter Value

Dictionary

Purpose: Obtains the parameter dictionary of a single element, including detailed information about the parameter type, name, storage type, and value.

How to Use:

1. Ensure exactly one element is selected.
2. Click the Dictionary tool button from the ToolBox Tab.
3. The Report Tab will display the Type of parameter (Instance or Type), Parameter Name, Storage Type, whether the parameter has a value, and the value of each parameter.

Check Parameter Tools

The tools in this subgroup perform checks based on parameter values. These checks are designed to help you analyze and organize parameter data. The results of these tools will be displayed in a Check Result format.

• Check Existence of Parameters Values
• Check Parameters Against Category

Check Existence of Parameters Values

Purpose: Checks if specific parameters exist for elements, with three logic options:

• Check if a parameter exists, regardless of whether it has a value.
• Check if a parameter exists and has a value.
• Check if a parameter exists and has no value.

How to Use:

1. Click the Check Existence of Parameters Values tool button from the ToolBox Tab.
2. Select the desired logic option.




3. Enter the parameter name in the opened window and press OK.




4. Optionally, reduce the search to specific categories. Click Check All to include all categories.




5. The Report Tab will display the ID, Name, Category, Target Parameter, Storage Type, and Value for the checked elements.

Parent Tools:

Search based on Existence of Parameters Value
Reduce Selection by Existence of Parameters Values

Check Parameters Against Category

Purpose: Checks if specific parameters are assigned to specific categories using an Excel file.

How to Use:

1. Click the Check Parameters Against Category tool button from the ToolBox Tab.
2. In the opened window, click Import button to upload the Excel file.
3. The Excel file should have parameters in the first column and categories in the subsequent columns. Each row will correspond to one check.
4. Select the category in the data grid and click Select to select all of its elements.
5. Use the Filter button to filter the data grid or delete rows by selecting and clicking Delete Row.
6. Click OK to perform the check. The cells in the grid will be colored:
   • Green for passed checks.
   • Red for failed checks.
   • Orange for invalid entries.




7. Modify any incorrect entries, click Refresht to reset the colors, and then click OK to perform the check again.
8. Optionally, save the results, including the colors, to an Excel file by clicking the Save button.
9. The result will be summarized in the Report Tab, showing the Missing Parameters for each Category.

Download Check Parameters Against Category Template

Delete Parameter Tools

The tools in this group are designed to completely delete a parameter from the model. These tools provide different methods to identify and delete parameters, ensuring that once deleted, the parameter is removed from all instances in the model.

• Delete Parameter Completely from Model

Delete Parameter Completely from Model

Purpose: This tool allows you to delete a parameter entirely from the model using three different methods.

How to Use:

1. Click the Delete Parameter Completely from Model button in the ToolBox Tab.
2. In the opened window, choose the method you want to use to find the parameter. The three options are:
   
   
   
   
   
   • Option 1: Insert Parameter Name
     Enter the name(s) of the parameter(s) you want to delete. You can input multiple parameter names separated by commas.
   
   
   
   
   
   • Option 2: Select Category
     Choose a category that you know contains the target parameter(s). After selecting the category, choose the parameter(s) from the list of parameters for that category. You can select multiple parameters.
   
   
   
   
   
   • Option 3: Select Element
     Choose exactly one element that you are sure contains the parameter(s). After selecting the element, you will be able to select the parameters you want to delete from that element's list of parameters.
   
   
   
   
   
   
3. Once the deletion is executed, you will receive a result with the parameter name and the deletion status in the Report Tab.

Notes:

• Regardless of the method used, the parameter will be deleted from all categories and instances in the model.
• This tool does not allow deletion of a parameter for a single specific category or element —it removes the parameter entirely from the model.
• Deleting a parameter is permanent, and it will be completely removed from the model, affecting all instances of that parameter.

Parameter Value

The tools in this group focus on modifying and managing the value of a parameter. The tools are divided into five subgroups: Search, Comparison Check, Setting Value, Edit Value, and Delete Value. While the tools in the Search and Comparison Check subgroups only display information and do not alter the model, the other subgroups actively perform transactions that modify the values of parameters.

• Search Parameter Value Tools
• Comparison Checks
• Set Parameter Value Tools
• Edit Parameter Value Tools
• Delete Parameter Value Tools

Search Parameter Value Tools

The tools in this subgroup are used for searching specific values of parameters without making any changes to the model.

• Search Value of Instance Parameters
• Search for Any Value

Search Value of Instance Parameters

Purpose: This tool allows you to find elements that have a specific value for a given instance parameter.

How to Use:

1. Click the Search Value of Instance Parameters tool button in the ToolBox Tab.
2. Enter the name of the target parameter and the specific value you're searching for.




3. Click OK.
4. The results, including the ID, Name, Parameter, and Value of the elements, will be displayed in the data grid of the Report Tab.

Note: For boolean parameters, enter Yes or No, depending on your Revit language (e.g., Ja/Nein for German, Yes/No for English).

Parent Tools:

Select by Search for Value of Instance Parameters
Reduce Selection by Searching Value of Instance Parameters

Search for Any Value

Purpose: This tool finds elements that have specific values for parameters within the selected elements.

How to Use:

1. Select the elements you want to search.
2. Click the Search for Any Value button in the ToolBox Tab.
3. A list of all the parameters for the selected elements will be displayed.
4. Select any of these parameters or select all of them using Check All button.




5. Enter the target value for the search and click OK.




6. The results, including the ID, Parameter, and Value of the elements, will be shown in the data grid of the Report Tab.

Comparison Checks

The tools in this subgroup perform comparison checks, comparing parameters across elements or views to check for matching values.

• Pair Comparer
• Comparer of Multiple Elements

Pair Comparer

Purpose: Compares two items (views or elements) based on their parameters to check if their values are identical.

How to Use:

1. Click the Pair Comparer tool button in the ToolBox Tab.
2. Choose whether to compare two views or two elements and click Compare button.




3. For views, select two views from the list.
4. For elements, select two elements.
5. The comparison will begin, and you will get the following results in the data grid of the Report Tab:


• Type of parameter (instance, type, or unique)
• Name of the parameter
• Values of the first item
• Values of the second item
• Status of the check (passed or failed)

Note: If there are unique parameters (i.e., parameters that are not common to both items), they will be identified and displayed as Unique parameters.

Comparer of Multiple Elements

Purpose: Compares multiple elements based on the values of their parameters to check if they are exactly the same.

How to Use:

1. Select multiple elements to compare. The button will be disabled if no elements are selected.
2. Click the Comparer of Multiple Elements tool button in the ToolBox Tab.
3. The data grid in the Report Tab will show the following results for each parameter:


• Name of the parameter
• Value of the parameter for each element
• Status of the check (passed or failed)

Set Parameter Value Tools

The tools in this group are designed to set values for parameters in the model. These tools allow you to assign or change parameter values for multiple selected elements, copy values between parameters, and import a list of values from an external file.

• Same Value for All Selected Elements
• Copy from One Parameter to Another Parameter
• List Makers of Values from Excel
• Batch Parameter Set Using Dataset
• ID Generator

Same Value for All Selected Elements

Purpose: This tool allows you to set the same value for a parameter across all selected elements.

How to Use:

1. Select the elements you want to modify. The button will be inactive if no elements are selected.
2. Click the Same Value for All Selected Elements tool button in the ToolBox Tab.
3. In the opened window, enter the parameter name in the first textbox.




4. Click the Eye button to validate the parameter and check its storage type.




5. Once validated, enter the new value in the second textbox. For Boolean parameters, you will see options for True or False instead of the value textbox.
6. Click OK to apply the value.
7. The data grid in the Report Tab will display:
   
   
   • ID
   • Name
   • Target Parameter
   • Storage Type
   • Previous Value
   • New Value

Notes:

• For Text storage type, both numbers and strings can be set, even if the value consists only of numbers. It will be treated as a string.
• For Number storage type, only integers are allowed as values (no characters). The value will be set as an integer.

Copy from One Parameter to Another Parameter

Purpose: This tool allows you to copy the value of one parameter and set it as the value for another parameter on the same element.

How to Use:

1. Select the elements you want to modify.
2. Click the Copy from One Parameter to Another Parameter button in the ToolBox Tab.
3. In the opened window, enter the name of the source parameter (the parameter you want to copy from) and the target parameter (the parameter you want to set the value to).




4. After entering the source parameter, the window will display information about the storage types allowed for copying values.
5. Click OK.




6. The data grid in the Report Tab will display:
   
   
   • ID
   • Name
   • Source Parameter
   • Source Parameter Storage Type
   • Source Parameter Value
   • Target Parameter
   • Target Parameter Storage Type
   • Target Parameter Previous Value
   • Target Parameter New Value

Notes:

• Boolean Type: Identified as integers. 1 becomes Checked, 0 becomes Unchecked, and any other number becomes Gray. A gray Boolean parameter can only be copied to numeric type parameters.
• String Type: Any string-based parameter can be copied, except for the gray Boolean values.
• Numeric Type: Numeric values from both string and numeric types can be copied, except when the value is a string. Gray Boolean can be copied to numeric types only.

List Makers of Values from Excel

Purpose: This tool allows you to create a list of repetitive values in an Excel file and use that list to set the value for selected elements.

How to Use:

1. Ensure some elements are selected; the button will be inactive otherwise.
2. Click the List Makers of Values from Excel tool button in the ToolBox Tab.
3. In the window that opens, if you already have a list imported, the list name will appear next to 'File'. If no list is imported, click Import button to bring in your Excel list.




4. After importing, specify the row and column addresses for the list you want to use (this allows you to select different columns from the same file).







5. In the Value dropdown, select the target value, and in the Parameter textbox, enter the name of the parameter you want to set the value for.
6. Click OK.




7. The system will check if the selected value matches the storage type of the parameter. If it matches, click Continue.
8. The data grid in the Report Tab will display:
   
   
   • ID
   • Name
   • Parameter
   • Storage Type
   • Previous Value
   • New Value

Note: The imported list stays in the memory of the tool until you import a new list or click the Refresh button, at which point the list will be cleared.

Download List Maker Template

Batch Parameter Set Using Dataset

Purpose: This tool allows you to set values for parameters in bulk based on datasets in Excel, CSV, or text files, either by element or category.

How to Use:

• Element ID List Method:
  
  
  1. Ensure some elements are selected; the button will be inactive otherwise.
  2. Click the Batch Parameter Set Using Dataset tool button in the ToolBox Tab.
  3. In the main window, you will see three tabs: Element ID List, Category List, and Data Converter.
  4. Select Element ID List:
     
     
     • Click Import button to load your dataset (Excel, CSV, or text file).
     • Ensure your dataset has at least three columns: Element ID, Parameter Name, and Value.
     • The last column, Storage Type, is automatically populated and cannot be edited.
     • After importing, the dataset will be displayed in the grid. If any row has an issue (shown in Orange), use Edit(Double Click on Cell) and Delete Row button to modify it.
     • Select the IDs in the data grid and click Select to select corresponding elements.
     • Use Filter to refine your dataset for easier investigation.
     • Once the dataset is ready, click OK to start the batch process.
     • The tool will process the dataset and display the results: successful sets in Green and failures in Red.
     • You can save the result using Save button, which will include the success/failure colors, as an Excel file.
     
     
  
  
  
  


• Category List Method:
  
  
  1. Ensure some elements are selected; the button will be inactive otherwise.
  2. Click the Batch Parameter Set Using Dataset tool button in the ToolBox Tab.
  3. In the main window, you will see three tabs: Element ID List, Category List, and Data Converter.
  4. Select Category List:
     
     
     • Click Import button to load your dataset, which should have Category Name, Parameter Name, and Value.
     • The tool will automatically display the number of elements per category and their Storage Type.
     • After importing, the dataset will be displayed in the grid. If any row has an issue (shown in Orange), use Edit(Double Click on Cell) and Delete Row button to modify it.
     • Use Filter to refine your dataset for easier investigation.
     • Once the dataset is ready, click OK to start the batch process.
     • The tool will process the dataset and display the results: successful sets in Green and failures in Red.
     • You can save the result using Save button, which will include the success/failure colors, as an Excel file.
     
     
  
  
  
  


• Data Converter:
  
  
  • To avoid encoding issues with Excel or CSV files, use the Data Converter section.
    1. Choose one of the following options based on your file type:
       
       
       • Convert Excel to Text for Element ID List
       • Convert Excel to Text for Category List
       • Convert CSV to Text for Element ID List
       • Convert CSV to Text for Category List
       
       
    2. Select your target file and enter the name for the new text file.
    3. After clicking OK, the tool will generate the text file in the same location as your target file.
    
    
    
    
    4. The tool will notify you of the success or failure of the conversion.


• Final Results:
  • After processing, the results, including ID, Name, Category, Parameter, Storage Type, Previous Value, and New Value, will be available in the Report Tab.
  
  
  
  

Notes:

• If you need to import a new list, clicking the Refresht button will clear the previously imported data.
• The Storage Type column is automatically filled by the tool based on the dataset but cannot be edited.
• If any row is marked in Orange, it indicates an issue that needs to be resolved before proceeding.

Download Templates

ID Generator

Purpose: This tool generates unique IDs using different methods and then sets these generated IDs as values for a specific parameter of selected elements.

How to Use:

1. Ensure Selection:
   
   
   • Ensure that some elements are selected; the tool will be inactive if no elements are selected.
   • Click the ID Generator tool button in the ToolBox Tab.
   
   
2. Main Options for Generating Unique IDs: The tool provides 10 different methods to generate a unique ID. Each option will use a different logic for ID generation and setting values.
   
   
   
   
   
   • Option 1:
     
     
     • Logic: This method counts the elements in the selection and sets the count number as the unique ID for a specific parameter. The counting can start from 0 or 1.
     • Steps:
       1. Select this option and click the Submit button.
       2. Choose whether to start the count from 0 or 1.
       3. Enter the target parameter name.
       4. Click OK to start the process.
       
       
       
       
       5. After the operation, you'll be notified of the success or failure. The data grid in the Report Tab will display the following details:
          
          
          • ID
          • Name
          • Category
          • Target parameter
          • Storage type of the target parameter
          • Method of generating ID
          • Previous value
          • New value

       Example: ID = (...n)

       
       
       
       
   
   
   • Option 2:
     
     
     • Logic: This method counts the elements in the selection, starts from 0 or 1, and adds this count before the actual element ID, optionally with a separator.
     • Steps:
       1. Select this option and click the Submit button.
       2. Choose whether to start the count from 0 or 1.
       3. Decide whether to include a separator. If yes, enter your desired separator.
       4. Enter the target parameter name.
       5. Click OK to start the process.
       
       
       
       
       6. After the operation, you'll be notified of the success or failure. The data grid in the Report Tab will display the following details:
          
          
          • ID
          • Name
          • Category
          • Target parameter
          • Storage type of the target parameter
          • Method of generating ID
          • Previous value
          • New value

       Example: ID = (...n)ElementId

       
       
       
       
   
   
   • Option 3:
     
     
     • Logic: Similar to Option 2 but places the count after the actual element ID.
     • Steps:
       1. Select this option and click the Submit button.
       2. Choose whether to start the count from 0 or 1.
       3. Decide whether to include a separator. If yes, enter your desired separator.
       4. Enter the target parameter name.
       5. Click OK to start the process.
       
       
       
       
       6. After the operation, you'll be notified of the success or failure. The data grid in the Report Tab will display the following details:
          
          
          • ID
          • Name
          • Category
          • Target parameter
          • Storage type of the target parameter
          • Method of generating ID
          • Previous value
          • New value

       Example: ID = ElementId (...n)

       
       
       
       
   
   
   • Option 4:
     
     
     • Logic: This method uses the unique integer ID of each element and performs a mathematical operation on the ID to generate a new unique ID.
     • Steps:
       1. Select this option and click the Submit button.
       2. Enter the target parameter name.
       3. Enter the desired math operation (e.g., +n, -n, *n, /n).
       4. Click OK to start the process.
       
       
       
       
       5. After the operation, you'll be notified of the success or failure. The data grid in the Report Tab will display the following details:
          
          
          • ID
          • Name
          • Category
          • Target parameter
          • Storage type of the target parameter
          • Method of generating ID
          • Previous value
          • New value

       Example: ID = ElementId (+-*/)n

       
       
       
       
   
   
   • Option 5:
     
     
     • Logic: This option creates a random integer as a unique ID for the selected element. The random integer can have 3 to 16 digits, depending on your choice.
     • Steps:
       1. Select this option and click the Submit button.
       2. Enter the target parameter name.
       3. From the dropdown, select the number of digits you want for the random integer (3 to 16).
       4. Click OK to start the process.
       
       
       
       
       5. After the operation, you'll be notified of the success or failure. The data grid in the Report Tab will display the following details:
          
          
          • ID
          • Name
          • Category
          • Target parameter
          • Storage type of the target parameter
          • Method of generating ID
          • Previous value
          • New value

       Example: ID = Random integer

       
       
       
       
   
   
   • Option 6:
     
     
     • Logic: This option creates a random string as a unique ID. The random string can have 2 to 16 characters, depending on your choice.
     • Steps:
       1. Select this option and click the Submit button.
       2. Enter the target parameter name.
       3. From the dropdown, select the number of characters for the random string (2 to 16).
       4. Click OK to start the process.
       
       
       
       
       5. After the operation, you'll be notified of the success or failure. The data grid in the Report Tab will display the following details:
          
          
          • ID
          • Name
          • Category
          • Target parameter
          • Storage type of the target parameter
          • Method of generating ID
          • Previous value
          • New value

       Example: ID = Random string

       
       
       
       

       Note: The random string can include numbers or be entirely numeric in some cases.

   
   
   • Option 7:
     
     
     • Logic: This option generates a random integer, adds it after the actual element ID, and optionally includes a separator.
     • Steps:
       1. Select this option and click the Submit button.
       2. Enter the target parameter name.
       3. Decide if you want to include a separator. If yes, enter your desired separator.
       4. From the dropdown, select the number of digits for the random integer (3 to 16).
       5. Click OK to start the process.
       
       
       
       
       6. After the operation, you'll be notified of the success or failure. The data grid in the Report Tab will display the following details:
          
          
          • ID
          • Name
          • Category
          • Target parameter
          • Storage type of the target parameter
          • Method of generating ID
          • Previous value
          • New value

       Example: ID = ElementId(Random integer)

       
       
       
       
   
   
   • Option 8:
     
     
     • Logic: This option generates a random integer, adds it before the actual element ID, and optionally includes a separator.
     • Steps:
       1. Select this option and click the Submit button.
       2. Enter the target parameter name.
       3. Decide if you want to include a separator. If yes, enter your desired separator.
       4. From the dropdown, select the number of digits for the random integer (3 to 16).
       5. Click OK to start the process.
       
       
       
       
       6. After the operation, you'll be notified of the success or failure. The data grid in the Report Tab will display the following details:
          
          
          • ID
          • Name
          • Category
          • Target parameter
          • Storage type of the target parameter
          • Method of generating ID
          • Previous value
          • New value

       Example: ID = (Random integer)ElementId

       
       
       
       
   
   
   • Option 9:
     
     
     • Logic: This option generates a random string, adds it after the actual element ID, and optionally includes a separator.
     • Steps:
       1. Select this option and click the Submit button.
       2. Enter the target parameter name.
       3. Decide if you want to include a separator. If yes, enter your desired separator.
       4. From the dropdown, select the number of characters for the random string (2 to 16).
       5. Click OK to start the process.
       
       
       
       
       6. After the operation, you'll be notified of the success or failure. The data grid in the Report Tab will display the following details:
          
          
          • ID
          • Name
          • Category
          • Target parameter
          • Storage type of the target parameter
          • Method of generating ID
          • Previous value
          • New value

       Example: ID = ElementId(Random string)

       
       
       
       

       Note: The random string can include numbers or be entirely numeric in some cases.

   
   
   • Option 10:
     
     
     • Logic: This option generates a random string, adds it before the actual element ID, and optionally includes a separator.
     • Steps:
       1. Select this option and click the Submit button.
       2. Enter the target parameter name.
       3. Decide if you want to include a separator. If yes, enter your desired separator.
       4. From the dropdown, select the number of characters for the random string (2 to 16).
       5. Click OK to start the process.
       
       
       
       
       6. After the operation, you'll be notified of the success or failure. The data grid in the Report Tab will display the following details:
          
          
          • ID
          • Name
          • Category
          • Target parameter
          • Storage type of the target parameter
          • Method of generating ID
          • Previous value
          • New value

       Example: ID = (Random string)ElementId

       
       
       
       

       Note: The random string can include numbers or be entirely numeric in some cases.

3. Final Steps:
   1. After selecting the desired ID generation method, click Submit.
   2. The process will run, and the results (ID, Name, Category, Target Parameter, etc.) will be displayed in the Report Tab.
   3. You can review the results, which include the Method of Generating ID, Previous Value, and New Value.

Notes:

• Ensure that you have selected some elements before using this tool.
• The Report Tab will display the results after each operation, including the unique ID generated.

Edit Parameter Value Tools

The tools in this group are designed for editing the values of parameters. In order to use the tools in this group, you need to have some elements selected; otherwise, the buttons for the tools will be inactive.

• Parameter Value Editor
• Parameter Value Editor for Special Characters

Parameter Value Editor

This tool allows you to edit the value of parameters. You will have 4 options to edit the value of a specific parameter for the selected elements.

Option 1: Replacing Characters in Value

This option allows you to replace any character in the value with another character except comma. If you wish to replace a character other than a comma, use the Parameter Value Editor for Special Characters tool.

Steps:

1. Select the option from the main window of the tool and click on the Submit button.
2. In the opened window, enter the target parameter name in the first text box.
3. Enter the character to replace and the character you want to replace it with in the format A|B, where:
   
   
   • A is the character to be replaced.
   • | is the separator used by the tool.
   • B is the character to replace A.
   • A and B can contain more than one character (i.e., a word).
   
   
4. Click OK to start the process.




5. After completion, you will be notified of the success or failure. The result will be displayed in the Report Tab data grid, showing the following columns: ID, Name, Target Parameter, Storage Type of Target Parameter, Previous Value, and New Value.

Note: This option is only for parameters with a Text storage type.

Option 2: Add Prefix to Parameter Value

This option allows you to add a prefix to the value of a specific parameter for all selected elements.

Steps:

1. Select the option from the main window of the tool and click on the Submit button.
2. In the opened window, enter the target parameter name in the first text box and the desired prefix in the second text box.
3. If you wish to include a separator with the prefix, simply enter the separator along with the prefix.
4. Click OK to start the process.




5. After completion, you will be notified of the success or failure. The result will be displayed in the Report Tab data grid, showing the following columns: ID, Name, Target Parameter, Storage Type of Target Parameter, Previous Value, and New Value.

Note: This option is only for parameters with a Text storage type.

Option 3: Add Suffix to Parameter Value

This option allows you to add a suffix to the value of a specific parameter for all selected elements.

Steps:

1. Select the option from the main window of the tool and click on the Submit button.
2. In the opened window, enter the target parameter name in the first text box and the desired suffix in the second text box.
3. If you wish to include a separator with the suffix, simply enter the separator along with the suffix.
4. Click OK to start the process.




5. After completion, you will be notified of the success or failure. The result will be displayed in the Report Tab data grid, showing the following columns: ID, Name, Target Parameter, Storage Type of Target Parameter, Previous Value, and New Value.

Note: This option is only for parameters with a Text storage type.

Option 4: Perform Math Operation on Numeric Parameter

This option allows you to perform a math operation on the value of numeric parameters.

Steps:

1. Select the option from the main window of the tool and click on the Submit button.
2. In the opened window, enter the target parameter name in the first text box and the desired math operation in the second text box (e.g., +, -, *, /).
3. Click OK to start the process.




4. After completion, you will be notified of the success or failure. The result will be displayed in the Report Tab data grid, showing the following columns: ID, Name, Target Parameter, Applied Math Operation, Previous Value, and New Value.

Note: This option is only for parameters with a Number storage type.

How to Use:

1. Ensure that you have elements selected.
2. From the ToolBox Tab, click on the Parameter Value Editor tool button.
3. In the opened window, select the method and click on the Submit button.
4. Follow the steps of each method until you get the final result in the data grid of the Report Tab.

Parameter Value Editor for Special Characters

This tool is designed to replace predefined characters with new characters in the value of a specific parameter for all selected elements. You have two options in this tool:

Option 1: Replace Comma

This option replaces commas in the values of parameters with your desired character.

Steps:

1. Select the option from the main window of the tool and click on the Submit button.
2. In the opened window, enter the target parameter name in the first text box.
3. Enter the character you want to replace the commas with in the second text box.
4. Click OK to start the process.




5. After completion, you will be notified of the success or failure. The result will be displayed in the Report Tab data grid, showing the following columns: ID, Name, Target Parameter, Previous Value, and New Value.

Option 2: Replace Umlaut Characters

This option automatically replaces German umlaut characters in the value of parameters with standard alphabet letters:

• Ä' is replaced with Ae
• ä is replaced with ae
• Ü is replaced with Ue
• ü is replaced with ue
• Ö' is replaced with Oe
• ö is replaced with oe
• ß is replaced with ss

Steps:

1. Select the option from the main window of the tool and click on the Submit button.
2. In the opened window, enter the target parameter name.
3. Click OK to start the process.




4. After completion, you will be notified of the success or failure. The result will be displayed in the Report Tab data grid, showing the following columns: ID, Name, Target Parameter, Previous Value, and New Value.

How to Use:

1. Ensure that you have elements selected.
2. From the ToolBox Tab, click on the Parameter Value Editor for Special Characters tool button.
3. In the opened window, select the method and click on the Submit button.
4. Follow the steps of each method until you get the final result in the data grid of the Report Tab.

Delete Parameter Value Tools

The tools in this group either delete the value of a parameter or remove characters inside the value of parameters. All these tools require a selection, so ensure you have elements selected before using these tools.

• Value of Parameter for Selected Elements
• Desired Character in Value of Parameter for Selected Elements

Value of Parameter for Selected Elements

This tool deletes the value of a specific parameter for all selected elements.

Steps:

1. Ensure that you have elements selected.
2. From the ToolBox Tab, click on the Value of Parameter for Selected Elements tool button.
3. In the opened window, enter the target parameter name.
4. Click OK to start the process.




5. After completion, you will see the following in the Report Tab data grid:


• Element ID
• Name
• Parameter Name
• Previous Value
• New Value

Desired Character in Value of Parameter for Selected Elements

This tool deletes specific characters from the value of a parameter for all selected elements.

Steps:

1. Ensure that you have elements selected.
2. From the ToolBox Tab, click on the Desired Character in Value of Parameter for Selected Elements tool button.
3. In the opened window, enter the target parameter name in the first text box and the character to be removed in the second text box.
4. Click OK to start the process.




5. After completion, you will be notified of the success or failure.
6. The result will be displayed in the Report Tab data grid with the following columns:


• Element ID
• Name
• Target Parameter
• Erased Character
• Previous Value
• New Value

Note: This tool is only for parameters with a Text storage type.

Report

The Report Tab contains a data grid that displays the results of any action or tool used. This tab is temporary and is opened each time a user utilizes a tool. The data grid in the Report Tab presents the information related to the executed action.

• Tool Strip: The data grid has a tool strip that offers various tools for processing the report and the data displayed in the grid. These tools allow you to filter, search, and manipulate the data for easier analysis.


• ToolBox Tab: :While the Report tab is open, the Toolbox tab is deactivated, and none of its tools can be used.

Back Button

The top tool strip contains a Back Button that closes the Report Tab. It's important to note that once the Report Tab is closed, it cannot be restored. Therefore, if you need the report later, ensure you export or print it before closing the tab. Also, closing the Report Tab has no effect on the action that was performed; the report simply reflects the outcome of that action.

Data

The Report Tab displays data based on the results of the tool or action performed. The information is automatically organized in a data grid for easier recognition and processing.

• Additional Information: Along with the core data of the action, additional information such as the element's name and other relevant characteristics will be automatically included in the report. This may vary depending on the specific tool or action.


• Non-Editable Data: The data generated by the tool is not editable, but you can add new columns and rows to the data grid. Any columns or rows added by the user are fully editable, allowing you to assign values to their cells as needed.

Tools for Data Processing

To help you manage and process the data in the Report Tab more efficiently, the tool strip includes several options:

• Filtering :You can filter the data in the grid to focus on specific elements or values.
• Searching :You can search the data grid for particular values or characteristics.
• Color Assignment :You can assign colors to cells based on specific criteria or simply paint cells in your desired color. This feature is useful for visually highlighting important data or for organizing the report logically.
• Delete Columns and Rows
• Edit Columns and Rows
• Clean Colors from Datagrid

These tools help ensure that the report is structured and presented in a way that suits your needs.

Filter

To filter data in the data grid, click on the Filter button from the data grid's toolstrip in the Report Tab. In the opened window:

1. Specify the column you want to filter from the Groups dropdown of the opened window.
2. Select the row values that you want to filter.
3. Click the Apply button.

The filter will then be applied to the data grid. It's important to note that the data not matching your filter will be hidden, but not deleted. If you print or export the data, the hidden data will still be included. To remove the hidden data from the report, use the Delete Hidden Cells option from the Delete dropdown in the data grid's toolstrip in the Report Tab.
Deleted cells cannot be recovered.

If you want to restore the hidden data, go back to the Filter window and click Check All for any column that has been filtered. This action will only work if you haven’t deleted the hidden data.

Search

To search for a specific value in the data grid, click the Search button from the data grid’s toolstrip in the Report Tab. In the opened window:

1. Enter the value you want to search for in the textbox.
2. Click OK.

Once the search is complete, you will be notified of how many cells were found, and the matching cells will be selected in the data grid.

Edit

There are five options to edit the data grid:

1. Add a Column:
   
   
   • To add a column to the right of a cell, select a cell or column as the reference, then click Add Column to Right from the Edit dropdown in the data grid’s toolstrip.
   • To add a column to the left, click Add Column to Left.
   • The new column will have a default heading of "New Column". You can double-click the heading to rename it. All cells in the added column are editable, and you can assign any value to them. You can add as many columns as you need.
   
   
2. Add a Row:
   
   
   • To add a row to the top or bottom, select a reference cell, then click Add Row to Top or Add Row to Bottom from the Edit dropdown.
   • The new row will be added based on your selection. All cells in the added row are editable, and you can assign any value. You can add as many rows as needed.
   
   
3. Assign Value to Editable Cells:
   
   
   • To assign a value to editable cells, select the cells (you can select multiple cells across different columns).
   • Click Assign Value from the Edit dropdown in the data grid’s toolstrip.
   • In the opened window, enter your desired value in the textbox and click OK. The value will be assigned to all selected cells.
   
   
   
   
   • Note that you cannot use the Assign Value option for editable cells in non-editable columns. In such cases, you must manually assign the value to each cell.
   
   

Delete

Deletion in the data grid applies to both editable and non-editable rows and cells. There are three options for deletion:

1. Delete Rows:
   
   
   • To delete a row, select the entire row (either manually or by selecting a cell in the first empty column of the row).
   • From the Delete dropdown in the data grid's toolstrip in the Report Tab in the data grid’s toolstrip, click Delete Selected Rows.
   • You will be notified that this action cannot be undone. If you confirm, the selected rows will be deleted.
   
   
2. Delete Columns:
   
   
   • To delete one or more columns, select at least one cell in the column(s) to be deleted.
   • From the Delete dropdown in the data grid's toolstrip in the Report Tab, click Delete Selected Columns.
   • You will be notified that this action cannot be undone. If you confirm, the selected columns will be deleted. Note that selecting a cell is sufficient; you don't need to select the entire column.
   
   
3. Delete Hidden Cells:
   
   
   • This option is used for filtered elements. Since the only tool that hides data in the data grid is the filter, hidden data will appear in prints or exports.
   • If you want to keep only the filtered data (i.e., visible data in the grid), use the Delete Hidden Cells option.
   • From the Delete dropdown in the data grid's toolstrip in the Report Tab, click Delete Hidden Cells and confirm. The hidden cells will be deleted, and only visible data will be exported or printed.
   
   

Color

When analyzing data in a data grid, especially with large datasets, visually highlighting cells with specific characteristics can be helpful. BIM Pars app provides four color assignment options for data grid cells:

1. Assign the Same Color to Cells with Same Value in One Column:
   
   
   • Select a cell in the column as the reference, then click Same Values Color from the Color dropdown in the data grid’s toolstrip.
   • All cells with the same value in that column will be assigned the same random color.
   
   
   
   
   
   
2. Assign the Same Color to Cells with Same Value in the Entire Data Grid:
   
   
   • Click Same Values Color (Full Sheet) from the Color dropdown.
   • This option does not require selecting a reference cell. All cells with the same value in the entire data grid will receive the same random color.
   
   
   
   
   
   
3. Assign Colors Based on Numeric Gradient:
   
   
   • Select a cell in a numeric column as the reference. Then click Numeric Gradient from the Color dropdown.
   • Cells will be colored using a blue gradient, where cells with smaller values are lighter and cells with larger values are darker. This option is only available for numeric columns, and all cells in the column must have values (empty cells should be removed).
   
   
   
   
   
   
4. Manually Assign a Color to Selected Cells:
   
   
   • Select the cells you want to color, then click Paint Selected Cells from the Color dropdown.
   • In the opened window, choose your desired color and click OK button. The selected color will be applied to all selected cells.
   
   
   
   
   
   

Note: Colors assigned in the data grid can be exported as HTML or XLSX files. However, when exporting to CSV or printing, only the data (not the colors) will be included.

Clean

This option resets all colors in the data grid. It will restore the default color (white) for all cells. To clear all colors:

1. Click Clean in the data grid’s toolstrip.
2. The color of all cells in the data grid will be reset to the Default (white).

Print

You can print the data grid to create a report.

• pyRevit Output Window
• BIM Pars Print (Soon)

pyRevit Output Window print

The generated report can be saved as PDF or HTML.

1. To print the data grid, click Print from the top toolstrip in the Report Tab, and then select pyRevit.
2. The data grid will be displayed in the output window, along with the date and time the report was generated and the user who generated it. The report will be displayed in a table format, and if there are any element IDs, they will be Linkifiedautomatically.
3. The table will include a title representing the action that generated the report. The output window can be expanded, opened in a browser, printed or saved as PDF, saved as HTML, or , copied to the clipboard.

Note: If the data grid contains colors, these will not appear in the pyRevit output window print.

BIM Pars Print

Not available in BIM Pars V1.0

Export

There are three options for exporting the data in the data grid: HTML, XLSX, and CSV.

HTML

Steps:

1. Click Export from the top toolstrip and select HTML.
2. Choose the location and file name, then click Save. If your data grid has colors, these will be exported along with the data.

XLSX

Steps:

1. Click Export from the top toolstrip and select XLSX.
2. Choose the location and file name, then click Save. Colors in the data grid will also be included in the exported file.

CSV

Steps:

1. Click Export from the top toolstrip and select CSV.
2. Choose the location and file name, then click Save. Note that colors will not be included in the export, only the raw data.