# guponnus/ouaf-config-manager architecture

> Architecture diagram of the GitHub repository guponnus/ouaf-config-manager, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/guponnus/ouaf-config-manager
- Repository: https://github.com/guponnus/ouaf-config-manager

## Overview

OUAF Configuration Manager is a VS Code extension for browsing and maintaining OUAF service-script configuration across environments. Users configure and connect an environment, browse and filter scripts, inspect or check out Steps and Schema, edit XML or compare copies, then check in local copies; check-in archives and removes local files rather than publishing them. The map includes the documented OUAF adapter and Oracle-backed Data Area lookup. Source excerpts are partial, so some feature relationships rely on README evidence rather than sampled implementation details.

Main entry points: [`src/extension.ts`](https://github.com/guponnus/ouaf-config-manager/blob/master/src/extension.ts) (Extension commands), [`src/ouaf.ts`](https://github.com/guponnus/ouaf-config-manager/blob/master/src/ouaf.ts) (OUAF client), [`ouaf_package/CmScriptAsTextViewer.java`](https://github.com/guponnus/ouaf-config-manager/blob/master/ouaf_package/CmScriptAsTextViewer.java) (Text viewer service), [`ouaf_package/CmOuafDevelopmentExtension_v1.sql`](https://github.com/guponnus/ouaf-config-manager/blob/master/ouaf_package/CmOuafDevelopmentExtension_v1.sql) (Service configuration)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_vscode["VS Code workflow"]
  node_extension["Extension commands<br/>[extension.ts]"]
  node_explorer["Script explorer<br/>[extension.ts]"]
  node_schema["Schema editor<br/>[extension.ts]"]
  node_comparison["Diff workflows<br/>[extension.ts]"]
end

subgraph group_local["Local configuration"]
  node_profiles[("Environment profiles<br/>[ouaf.ts]")]
  node_checkout["Checkout and check-in<br/>[extension.ts]"]
  node_localcopies[("Local copies")]
end

subgraph group_integration["OUAF integration"]
  node_client["OUAF client<br/>[ouaf.ts]"]
  node_scriptdata["Script Data Area lookup<br/>[ouaf.ts]"]
  node_api{{"OUAF API"}}
  node_oracle[("Oracle database")]
end

subgraph group_deployment["OUAF deployment"]
  node_adapter["Text viewer service"]
  node_adapterconfig["Service configuration"]
end

node_engineer(("Engineer"))

node_engineer -->|"uses"| node_extension
node_extension -->|"manages"| node_profiles
node_extension -->|"provides"| node_explorer
node_explorer -->|"loads scripts"| node_client
node_client -->|"requests script data"| node_api
node_extension -->|"offers checkout"| node_checkout
node_checkout -->|"retrieves Steps and Schema"| node_client
node_checkout -->|"writes copies"| node_localcopies
node_extension -->|"opens editor"| node_schema
node_schema -->|"saves edits"| node_localcopies
node_extension -->|"offers comparisons"| node_comparison
node_comparison -->|"retrieves server copies"| node_client
node_comparison -->|"compares local copies"| node_localcopies
node_extension -->|"constructs client"| node_client
node_client -->|"queries areas"| node_scriptdata
node_scriptdata -->|"reads metadata"| node_oracle
node_client -->|"calls service"| node_adapter
node_adapter -->|"uses configured service"| node_adapterconfig
node_adapterconfig -->|"configures metadata"| node_oracle
node_adapter -->|"serves script content"| node_api
node_checkout -->|"archives and removes on check-in"| node_localcopies

click node_extension "https://github.com/guponnus/ouaf-config-manager/blob/master/src/extension.ts"
click node_explorer "https://github.com/guponnus/ouaf-config-manager/blob/master/src/extension.ts"
click node_schema "https://github.com/guponnus/ouaf-config-manager/blob/master/src/extension.ts"
click node_comparison "https://github.com/guponnus/ouaf-config-manager/blob/master/src/extension.ts"
click node_profiles "https://github.com/guponnus/ouaf-config-manager/blob/master/src/ouaf.ts"
click node_checkout "https://github.com/guponnus/ouaf-config-manager/blob/master/src/extension.ts"
click node_client "https://github.com/guponnus/ouaf-config-manager/blob/master/src/ouaf.ts"
click node_scriptdata "https://github.com/guponnus/ouaf-config-manager/blob/master/src/ouaf.ts"
click node_adapter "https://github.com/guponnus/ouaf-config-manager/blob/master/ouaf_package/CmScriptAsTextViewer.java"
click node_adapterconfig "https://github.com/guponnus/ouaf-config-manager/blob/master/ouaf_package/CmOuafDevelopmentExtension_v1.sql"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_extension,node_explorer,node_schema,node_comparison toneBlue
class node_profiles,node_checkout,node_localcopies toneAmber
class node_client,node_scriptdata,node_api,node_oracle toneMint
class node_adapter,node_adapterconfig toneRose
class node_engineer toneIndigo
```

## Components

### VS Code workflow

- [Extension commands](https://github.com/guponnus/ouaf-config-manager/blob/master/src/extension.ts): `src/extension.ts`
- [Script explorer](https://github.com/guponnus/ouaf-config-manager/blob/master/src/extension.ts): `src/extension.ts`
- [Schema editor](https://github.com/guponnus/ouaf-config-manager/blob/master/src/extension.ts): `src/extension.ts`
- [Diff workflows](https://github.com/guponnus/ouaf-config-manager/blob/master/src/extension.ts): `src/extension.ts`

### Local configuration

- [Environment profiles](https://github.com/guponnus/ouaf-config-manager/blob/master/src/ouaf.ts): `src/ouaf.ts`
- [Checkout and check-in](https://github.com/guponnus/ouaf-config-manager/blob/master/src/extension.ts): `src/extension.ts`
- **Local copies**

### OUAF integration

- [OUAF client](https://github.com/guponnus/ouaf-config-manager/blob/master/src/ouaf.ts): `src/ouaf.ts`
- [Script Data Area lookup](https://github.com/guponnus/ouaf-config-manager/blob/master/src/ouaf.ts): `src/ouaf.ts`
- **OUAF API**
- **Oracle database**

### OUAF deployment

- [Text viewer service](https://github.com/guponnus/ouaf-config-manager/blob/master/ouaf_package/CmScriptAsTextViewer.java): `ouaf_package/CmScriptAsTextViewer.java`
- [Service configuration](https://github.com/guponnus/ouaf-config-manager/blob/master/ouaf_package/CmOuafDevelopmentExtension_v1.sql): `ouaf_package/CmOuafDevelopmentExtension_v1.sql`

### Other components

- **Engineer**

## Connections

- Engineer → Extension commands: uses (evidence: `README.md`)
- Extension commands → Environment profiles: manages (evidence: `src/extension.ts`)
- Extension commands → Script explorer: provides (evidence: `README.md`)
- Script explorer → OUAF client: loads scripts (evidence: `README.md`)
- OUAF client → OUAF API: requests script data (evidence: `src/ouaf.ts`)
- Extension commands → Checkout and check-in: offers checkout (evidence: `README.md`)
- Checkout and check-in → OUAF client: retrieves Steps and Schema (evidence: `README.md`)
- Checkout and check-in → Local copies: writes copies (evidence: `README.md`)
- Extension commands → Schema editor: opens editor (evidence: `README.md`)
- Schema editor → Local copies: saves edits (evidence: `README.md`)
- Extension commands → Diff workflows: offers comparisons (evidence: `README.md`)
- Diff workflows → OUAF client: retrieves server copies (evidence: `README.md`)
- Diff workflows → Local copies: compares local copies (evidence: `README.md`)
- Extension commands → OUAF client: constructs client (evidence: `src/extension.ts`)
- OUAF client → Script Data Area lookup: queries areas (evidence: `src/ouaf.ts`)
- Script Data Area lookup → Oracle database: reads metadata (evidence: `src/ouaf.ts`)
- OUAF client → Text viewer service: calls service (evidence: `src/ouaf.ts`)
- Text viewer service → Service configuration: uses configured service (evidence: `README.md`)
- Service configuration → Oracle database: configures metadata (evidence: `README.md`)
- Text viewer service → OUAF API: serves script content (evidence: `README.md`)
- Checkout and check-in → Local copies: archives and removes on check-in (evidence: `README.md`)
