shared-parameters

Shared Parameters — Create, Bind & Manage

Manage shared parameters for:

"$ARGUMENTS"

Before writing code

Ask (one question if ambiguous):

1. Do you have an existing shared parameter file (.txt), or do you need a new one created?
2. Which parameters do you want to add, and to which categories?
3. Instance or Type parameter? (Instance = per-element, Type = per-family type)

---

Script 1: Inspect what shared parameters are already bound (read-only)

import clr
clr.AddReference('RevitServices')
from RevitServices.Persistence import DocumentManager
clr.AddReference('RevitAPI')
from Autodesk.Revit.DB import *

doc = DocumentManager.Instance.CurrentDBDocument

try:
    binding_map = doc.ParameterBindings
    it = binding_map.ForwardIterator()
    results = []

    while it.MoveNext():
        defn    = it.Key
        binding = it.Current
        cats    = []
        try:
            for cat in binding.Categories:
                cats.append(cat.Name)
        except Exception:
            pass

        results.append({
            "Name":       defn.Name,
            "Type":       "Instance" if isinstance(binding, InstanceBinding) else "Type",
            "Categories": ", ".join(sorted(cats))
        })

    results.sort(key=lambda x: x["Name"])
    OUT = results if results else "No shared or project parameters found."

except Exception as e:
    import traceback
    OUT = "ERROR: " + str(e) + "\n" + traceback.format_exc()

---

Script 2: Load shared parameter file and bind parameters to categories

import clr
clr.AddReference('RevitServices')
from RevitServices.Persistence import DocumentManager
from RevitServices.Transactions import TransactionManager
clr.AddReference('RevitAPI')
from Autodesk.Revit.DB import *

doc = DocumentManager.Instance.CurrentDBDocument
app = doc.Application

# ── Configuration ────────────────────────────────────────────────────────────
SHARED_PARAM_FILE = r"C:\BIM\SharedParameters\ProjectSharedParams.txt"

# Parameters to bind: (group_name_in_file, param_name, is_instance, categories_list)
PARAMS_TO_BIND = [
    ("COBie",    "COBie.Type.AssetType",    False,  [BuiltInCategory.OST_Doors,
                                                     BuiltInCategory.OST_Windows,
                                                     BuiltInCategory.OST_MechanicalEquipment]),
    ("COBie",    "COBie.Component.TagNumber", True, [BuiltInCategory.OST_Doors,
                                                     BuiltInCategory.OST_MechanicalEquipment]),
    ("BIM Data", "BIM_Status",              True,   [BuiltInCategory.OST_Walls,
                                                     BuiltInCategory.OST_Floors,
                                                     BuiltInCategory.OST_Rooms]),
    ("BIM Data", "BIM_ResponsibleParty",    True,   [BuiltInCategory.OST_Rooms]),
]
# ─────────────────────────────────────────────────────────────────────────────

def get_or_open_sp_file(app, path):
    """Set the shared parameter file and return it."""
    app.SharedParametersFilename = path
    return app.OpenSharedParameterFile()

try:
    import os
    if not os.path.exists(SHARED_PARAM_FILE):
        OUT = ("ERROR: Shared parameter file not found: " + SHARED_PARAM_FILE +
               "\nCreate the file first or check the path.")
    else:
        sp_file = get_or_open_sp_file(app, SHARED_PARAM_FILE)
        if not sp_file:
            OUT = "ERROR: Could not open shared parameter file."
        else:
            bound_params = []
            skipped = []

            TransactionManager.Instance.EnsureInTransaction(doc)

            for group_name, param_name, is_instance, cat_list in PARAMS_TO_BIND:

                # Find the group
                group = sp_file.Groups.get_Item(group_name)
                if not group:
                    skipped.append(param_name + " (group '" + group_name + "' not found in file)")
                    continue

                # Find the definition in the group
                defn = group.Definitions.get_Item(param_name)
                if not defn:
                    skipped.append(param_name + " (not found in group '" + group_name + "')")
                    continue

                # Check if already bound
                existing = doc.ParameterBindings.get_Item(defn)
                if existing:
                    skipped.append(param_name + " (already bound)")
                    continue

                # Build category set
                cat_set = app.Create.NewCategorySet()
                for bic in cat_list:
                    cat = doc.Settings.Categories.get_Item(bic)
                    if cat and cat.AllowsBoundParameters:
                        cat_set.Insert(cat)

                # Create binding
                if is_instance:
                    binding = app.Create.NewInstanceBinding(cat_set)
                else:
                    binding = app.Create.NewTypeBinding(cat_set)

                # Insert into document
                group_defn = BuiltInParameterGroup.PG_DATA  # show under "Data" in Properties
                doc.ParameterBindings.Insert(defn, binding, group_defn)
                bound_params.append(param_name)

            TransactionManager.Instance.TransactionTaskDone()
            OUT = {"Bound": bound_params, "Skipped": skipped}

except Exception as e:
    TransactionManager.Instance.ForceCloseTransaction()
    import traceback
    OUT = "ERROR: " + str(e) + "\n" + traceback.format_exc()