Archetypes - vi-technologies/vi-operate-console GitHub Wiki

Archetypes

The Archetypes section of the VI Operate Console provides template-based patterns for quickly implementing common operational workflows and configurations.

Overview

Archetypes serve as pre-configured templates that encapsulate best practices for different operational scenarios. They allow users to quickly deploy standardized workflows, reports, and dashboards tailored to specific operational needs.

Structure

The Archetypes module is organized as follows:

/console/archetypes
├── components/    # Reusable archetype UI components
├── hooks/         # Custom hooks for archetype management
└── types/         # Type definitions for archetype entities

Key Components

Archetype UI Components

The interface includes several specialized components:

  • ArchetypeCard: Visual representation of available archetypes
  • ArchetypeBanner: Promotional banners for featured archetypes
  • ArchetypeList: Browsable list of available archetypes

Component Examples

export function ArchetypeCard({
  title,
  description,
  icon,
  category,
  complexity,
  onSelect,
  className = ''
}: ArchetypeCardProps) {
  // Card implementation for displaying archetype options
}

Archetype Categories

The system offers several categories of archetypes:

  1. Operational Templates: Standard operational configurations for common scenarios
  2. Dashboard Templates: Pre-configured dashboard layouts for specific needs
  3. Report Templates: Standard report configurations
  4. Workflow Templates: Common automation patterns

Usage Examples

Implementing an Archetype

  1. Navigate to the Archetypes section
  2. Browse or search for the appropriate archetype
  3. Select the archetype to view details
  4. Click "Implement" to start the configuration wizard
  5. Customize parameters as needed
  6. Complete the implementation

Customizing an Archetype

After implementing an archetype:

  1. Navigate to the implemented component (dashboard, report, etc.)
  2. Use standard editing tools to customize as needed
  3. Save the customized version

Creating Custom Archetypes

For advanced users, the system allows:

  1. Creating custom configurations
  2. Saving them as reusable archetypes
  3. Sharing archetypes with other users or teams
  4. Versioning archetypes for tracking changes

Benefits

  • Standardization: Ensures consistent implementation of operational best practices
  • Efficiency: Reduces time to implement common patterns
  • Quality: Pre-tested configurations minimize errors
  • Knowledge Sharing: Encapsulates operational expertise in reusable templates