workset-manager

Workset Manager — Audit & Fix

Audit and manage worksets for:

"$ARGUMENTS"

Before writing code

Ask (one question if ambiguous):

1. Audit or fix? Just report which elements are on wrong worksets, or also move them?
2. What are the workset rules? (e.g. Walls/Floors/Roofs → Architecture, Ducts/Pipes → MEP)
3. Scope? Entire model, or one level/phase?

Always run the audit script first, then the move script if needed.

Script 1: Workset audit report (read-only)

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

import csv, os

doc = DocumentManager.Instance.CurrentDBDocument

try:
    if not doc.IsWorkshared:
        OUT = "This model is not workshared — worksets are not applicable."
    else:
        # Get all user worksets
        worksets = {ws.Id: ws.Name for ws in
                    FilteredWorksetCollector(doc)
                    .OfKind(WorksetKind.UserWorkset)
                    .ToWorksets()}

        # Categories to audit and their expected workset (partial match OK)
        EXPECTED_WORKSETS = {
            "Walls":                  "Architecture",
            "Floors":                 "Architecture",
            "Roofs":                  "Architecture",
            "Ceilings":               "Architecture",
            "Stairs":                 "Architecture",
            "Railings":               "Architecture",
            "Curtain Panels":         "Architecture",
            "Structural Columns":     "Structure",
            "Structural Framing":     "Structure",
            "Structural Foundations": "Structure",
            "Duct Curves":            "MEP",
            "Pipe Curves":            "MEP",
            "Conduits":               "MEP",
            "Cable Trays":            "MEP",
            "Mechanical Equipment":   "MEP",
            "Plumbing Fixtures":      "MEP",
            "Lighting Fixtures":      "MEP",
        }

        BIC_MAP = {
            "Walls":                  BuiltInCategory.OST_Walls,
            "Floors":                 BuiltInCategory.OST_Floors,
            "Roofs":                  BuiltInCategory.OST_Roofs,
            "Ceilings":               BuiltInCategory.OST_Ceilings,
            "Stairs":                 BuiltInCategory.OST_Stairs,
            "Railings":               BuiltInCategory.OST_StairsRailing,
            "Curtain Panels":         BuiltInCategory.OST_CurtainWallPanels,
            "Structural Columns":     BuiltInCategory.OST_StructuralColumns,
            "Structural Framing":     BuiltInCategory.OST_StructuralFraming,
            "Structural Foundations": BuiltInCategory.OST_StructuralFoundation,
            "Duct Curves":            BuiltInCategory.OST_DuctCurves,
            "Pipe Curves":            BuiltInCategory.OST_PipeCurves,
            "Conduits":               BuiltInCategory.OST_Conduit,
            "Cable Trays":            BuiltInCategory.OST_CableTray,
            "Mechanical Equipment":   BuiltInCategory.OST_MechanicalEquipment,
            "Plumbing Fixtures":      BuiltInCategory.OST_PlumbingFixtures,
            "Lighting Fixtures":      BuiltInCategory.OST_LightingFixtures,
        }

        misplaced = []
        summary   = {}

        for cat_name, bic in BIC_MAP.items():
            expected_partial = EXPECTED_WORKSETS.get(cat_name, "")
            elements = list(FilteredElementCollector(doc)
                            .OfCategory(bic)
                            .WhereElementIsNotElementType()
                            .ToElements())
            wrong = 0
            for el in elements:
                ws_param = el.get_Parameter(BuiltInParameter.ELEM_PARTITION_PARAM)
                if not ws_param:
                    continue
                ws_id   = WorksetId(ws_param.AsInteger())
                ws_name = worksets.get(ws_id, "Unknown")
                if expected_partial and expected_partial.lower() not in ws_name.lower():
                    misplaced.append({
                        "Category":        cat_name,
                        "ElementId":       str(el.Id.IntegerValue),
                        "Current Workset": ws_name,
                        "Expected":        expected_partial,
                    })
                    wrong += 1

            summary[cat_name] = {
                "Total":     len(elements),
                "Misplaced": wrong,
                "Expected":  expected_partial,
            }

        OUT = {
            "Summary":          summary,
            "Misplaced count":  len(misplaced),
            "Misplaced (first 50)": misplaced[:50],
            "Available worksets": list(worksets.values()),
        }

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