What are AF hierarchy design best practices?

A well-designed AF hierarchy is the foundation of a scalable PI System deployment. Poor design leads to maintenance headaches and performance issues.

Design Principles

1. Model the Physical World

Structure your hierarchy to match your physical plant:

Enterprise
  └── Site
      └── Area
          └── Unit
              └── Equipment

2. Use Templates for Everything

• Create element templates for each equipment type (Pump, Motor, Valve, etc.).
• Include all standard attributes in the template.
• Use derived templates for specializations (CentrifugalPump inherits from Pump).

3. Keep It Flat-ish

• Avoid deeply nested hierarchies (> 6-7 levels).
• Deep nesting makes navigation slow and expressions complex.
• If you need more levels, consider using AF references instead.

4. Naming Conventions

• Use consistent, meaningful names: Pump-101A, not P101A or pump_101_a.
• Include the equipment type in the name for clarity.
• Document your naming convention and enforce it.

Common Anti-Patterns

• Flat dump: putting all elements at the root level with no structure.
• Over-nesting: creating levels just for organizational grouping with no data.
• Duplicate hierarchies: maintaining separate hierarchies for operations and engineering.
• Hardcoded references: using absolute paths instead of relative substitution parameters.

Performance Tips

• Limit elements per parent to < 5,000 for smooth PI System Explorer performance.
• Use AF references (weak references) to show an element in multiple places without duplicating it.
• Index attributes you frequently search or filter on.
• Keep the number of attributes per element reasonable (< 50 for typical equipment).