Working with Hubuum¶

The Atlas example dataset supplies the shared Service, Server, Location, and Context classes used in the guides. Load it once to explore the same objects and relationships throughout the documentation.

Use this guide to model inventory and carry out everyday data workflows. The examples describe the server's behavior across the web interface, CLI, and API. Interface-specific controls are documented with the clients and frontend.

Build a useful model¶

1. Learn the core concepts.
2. Plan collections around ownership and access.
3. Grant groups the required permissions.
4. Define classes and evolve their validation schemas.
5. Link objects with relationships and derive useful values with computed fields.

Find and update information¶

• Querying: filters, ordering, JSON fields, and cursor pagination.
• Search: discover resources or construct structured searches.
• Name addressing: use known class and object names.
• JSON Patch: change part of an object's raw data atomically.
• Resource revisions: prevent lost updates.
• Temporal history: inspect past state and provenance.

Automate recurring work¶

Use imports for graph data and exports for extraction and reports. Export templates produce text, HTML, or CSV from the export context.

Track background tasks through completion, including individual results and output expiry. Remote targets run configured outbound actions; events support audit and subscribed delivery. Set up chat and notification webhooks to send selected events to Slack, Mattermost, Discord, or a notification bridge. An import/export workflow is distinct from a full-system backup and restore.