Atlas project concept

Integr8r-rebase

Provide a rebase of Integr8r with consistent config-loading and reporting conventions for vendor integrations. Load PowerShell config files and module settings. Run vendor-specific scripts that transform data and call downstream systems. Generate optional HTML email reports from templates in Reports/TEMPLATE.

Type
Component
Lifecycle
Active
Last touched
2025-09-15
Visibility
Public

Purpose

Provide a rebase of Integr8r with consistent config-loading and reporting conventions for vendor integrations.

Current state

Last touched: 2025-09-15. Functionality and completeness: Modules exist; centralized documentation is limited.

Next step

Add baseline automated tests to cover critical flows; Add CI pipeline for build/test/lint; Document deployment/runtime environment (or add Dockerfile); Document interfaces (CLI flags, API endpoints, file formats); Add structured logging and basic health checks.

Interfaces

Inputs
  • Config .ps1 files, SQL queries, CSVs, vendor API credentials
  • CSV files
Outputs
  • CSV exports, email reports, vendor sync actions
  • Query results (reports/extracts)
  • CSV files
  • Rendered HTML output

Reality to Action trace

Reality Ingestion

Contributes in this stage.

Canonical Storage

Contributes in this stage.

Automation Engines

Not in scope.

Human Interfaces

Contributes in this stage.

Operational Adoption

Contributes in this stage.

Core workflow

TBD. Document the 5-10 steps that define the core workflow.

Artifacts

  • Module-specific CSV schemas and API payloads

Operational notes

Constraints and scars

  • Large surface area and many dependencies; module maintenance requires vendor-specific knowledge.

Reliability posture

Failure modes and safe behavior: Varies per module; errors surfaced in logs or report emails. Idempotency / retries / batching behavior: Varies per module; no centralized retry system.

Observability

  • Logs: Script output and report artifacts; module-specific logging
  • Metrics/health checks: None documented
  • Logs: Script output and report artifacts; logging varies by module.

Security and privacy

Config and report data can include PII and credentials; keep config files local and restrict access to report outputs.

Dependencies

Upstream
  • Multiple vendor systems (module-specific)

Ownership

Owners

Josh Barton

Users

Josh Barton (owner)

Integr8r-rebase

Architecture & Major Components

  • High-level diagram (text):

    • Config (.ps1) -> vendor module scripts -> data transforms -> vendor API/files -> reports
  • Entry points: Module scripts in vendor folders

  • Top-level folders: Config, Reports, Templates, Modules, vendor-specific directories

  • Key abstractions: Config loader (PSConfigModule), vendor modules, report template system

Setup / Build / Run

  • Build system(s): None (PowerShell scripts).
  • Configure module settings under Config/ and run module scripts from a PowerShell host.