Canonical names
A system where the same data record is referred to by a consistent name across different platforms, simplifying cross-platform operations.
Learn
When to use it
Use canonical names when handling data that spans multiple platforms and systems, where each may have its own naming conventions. Canonical names provide a unified reference point, making cross-platform operations more efficient and reducing errors in tasks like data synchronization and API integration.
Quick example
In the Aclif Framework, an AI agent needs to access and manipulate datasets across several SaaS platforms with different naming conventions. By implementing a canonical naming system within Aclif, the framework ensures that each dataset is referred to by the same name across all platforms, streamlining operations. Here, Aclif's canonical naming system acts as the unifying layer that standardizes these interactions.
platform A → canonical names → platform B
Ecosystem
Canonical names fit into the broader ecosystem of data management and integration, often working alongside APIs and data transformation tools.
┌─ APIs ──┐
data →│ canonical names │→ integration
└─ transformation ─┘
Misconceptions
| Misconception | Rebuttal |
|---|---|
| It's only for databases | It applies to any cross-platform data |
| It changes data formats | It standardizes naming, not formats |
| It's just a naming convention | It facilitates cross-platform consistency |
Trade-offs
- Consistency — requires initial setup across platforms
- Simplified integration — potential for naming conflicts
- Error reduction — can complicate local naming systems