# ibm/ibm-z-zos architecture

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

- Interactive diagram: https://gitdiagram.com/ibm/ibm-z-zos
- Repository: https://github.com/ibm/ibm-z-zos

## Overview

This repository is a collection of z/OS community samples, not one integrated application. The clearest end-to-end product workflow in the supplied source is SMF record parsing and WebSphere-specific CSV export; a separate z/OSMF client demonstrates dataset REST operations. Other sampled tools are independent. Connections below are limited to relationships visible in excerpts or SOURCE INDEX references; unsampled wiring is not inferred.

Main entry points: [`SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfRecord.java`](https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfRecord.java) (SMF Record), [`SMF-Tools/SMF_CORE/src/com/ibm/smf/format/DefaultFilter.java`](https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_CORE/src/com/ibm/smf/format/DefaultFilter.java) (Default Filter), [`SMF-Tools/SMF_WAS/src/com/ibm/smf/twas/request/RequestActivitySmfRecord.java`](https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_WAS/src/com/ibm/smf/twas/request/RequestActivitySmfRecord.java) (Request Record), [`SMF-Tools/SMF_WAS_PLUGINS/src/com/ibm/smf/was/plugins/CSVExport.java`](https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_WAS_PLUGINS/src/com/ibm/smf/was/plugins/CSVExport.java) (CSV Export)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_smfcore["SMF Core"]
  node_smf_input["SMF Input<br/>[ISmfFile.java]"]
  node_stream["Binary Stream<br/>[SmfStream.java]"]
  node_record["SMF Record<br/>[SmfRecord.java]"]
  node_entity["Versioned Entity<br/>[SmfEntity.java]"]
  node_triplet["Triplet Index<br/>[Triplet.java]"]
  node_conversion["Conversions"]
  node_format_util["SMF Utilities<br/>[SmfUtil.java]"]
  node_print["Print Stream"]
  node_filter["Default Filter<br/>[DefaultFilter.java]"]
  node_unsupported["Version Error"]
end

subgraph group_was["WebSphere SMF"]
  node_was_record["Request Record"]
  node_was_sections["Request Sections"]
  node_was_server["Server Sections"]
end

subgraph group_plugins["SMF Plugins"]
  node_csv["CSV Export<br/>[CSVExport.java]"]
end

subgraph group_independent["Independent Samples"]
  node_fmt84["SMF 84 Formatter<br/>[smf84fmt.c]"]
  node_fmt84_header["Formatter Definitions<br/>[smf84fmt.h]"]
  node_smfreal["SMF Real Tool<br/>[smfreal.c]"]
  node_rest_file["Dataset REST Client"]
  node_rest_connection["REST Connection"]
end

node_zosmf(("z/OSMF REST API"))

node_record -->|"reads bytes"| node_stream
node_record -->|"extends"| node_entity
node_record -->|"uses"| node_triplet
node_record -->|"converts values"| node_conversion
node_record -->|"uses"| node_format_util
node_entity -->|"throws"| node_unsupported
node_filter -->|"filters"| node_record
node_filter -->|"initializes"| node_print
node_was_record -.->|"decodes sections"| node_was_sections
node_was_record -.->|"uses server data"| node_was_server
node_csv -->|"parses through"| node_filter
node_csv -->|"exports fields"| node_was_record
node_fmt84 -->|"uses definitions"| node_fmt84_header
node_rest_file -->|"invokes"| node_rest_connection
node_rest_file -->|"GET / PUT"| node_zosmf

click node_smf_input "https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_CORE/src/com/ibm/smf/format/ISmfFile.java"
click node_stream "https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfStream.java"
click node_record "https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfRecord.java"
click node_entity "https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfEntity.java"
click node_triplet "https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_CORE/src/com/ibm/smf/format/Triplet.java"
click node_conversion "https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_CORE/src/com/ibm/smf/utilities/ConversionUtilities.java"
click node_format_util "https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfUtil.java"
click node_print "https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfPrintStream.java"
click node_filter "https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_CORE/src/com/ibm/smf/format/DefaultFilter.java"
click node_unsupported "https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_CORE/src/com/ibm/smf/format/UnsupportedVersionException.java"
click node_was_record "https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_WAS/src/com/ibm/smf/twas/request/RequestActivitySmfRecord.java"
click node_was_sections "https://github.com/ibm/ibm-z-zos/tree/main/SMF-Tools/SMF_WAS/src/com/ibm/smf/twas/request"
click node_was_server "https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_WAS/src/com/ibm/smf/was/common/ZosServerInfoSection.java"
click node_csv "https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_WAS_PLUGINS/src/com/ibm/smf/was/plugins/CSVExport.java"
click node_fmt84 "https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF84Formatter/smf84fmt.c"
click node_fmt84_header "https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF84Formatter/smf84fmt.h"
click node_smfreal "https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMFReal/smfreal.c"
click node_rest_file "https://github.com/ibm/ibm-z-zos/blob/main/zOSMF/ZosmfRESTClient/src/com/ibm/zosmf/restclient/client/RestFileClient.java"
click node_rest_connection "https://github.com/ibm/ibm-z-zos/blob/main/zOSMF/ZosmfRESTClient/src/com/ibm/zosmf/restclient/basic/RestConnection.java"

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_smf_input,node_stream,node_record,node_entity,node_triplet,node_conversion,node_format_util,node_print,node_filter,node_unsupported toneBlue
class node_was_record,node_was_sections,node_was_server toneAmber
class node_csv,node_zosmf toneMint
class node_fmt84,node_fmt84_header,node_smfreal,node_rest_file,node_rest_connection toneRose
```

## Components

### SMF Core

- [SMF Input](https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_CORE/src/com/ibm/smf/format/ISmfFile.java): `SMF-Tools/SMF_CORE/src/com/ibm/smf/format/ISmfFile.java`
- [Binary Stream](https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfStream.java): `SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfStream.java`
- [SMF Record](https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfRecord.java): `SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfRecord.java`
- [Versioned Entity](https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfEntity.java): `SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfEntity.java`
- [Triplet Index](https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_CORE/src/com/ibm/smf/format/Triplet.java): `SMF-Tools/SMF_CORE/src/com/ibm/smf/format/Triplet.java`
- [Conversions](https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_CORE/src/com/ibm/smf/utilities/ConversionUtilities.java): `SMF-Tools/SMF_CORE/src/com/ibm/smf/utilities/ConversionUtilities.java`
- [SMF Utilities](https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfUtil.java): `SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfUtil.java`
- [Print Stream](https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfPrintStream.java): `SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfPrintStream.java`
- [Default Filter](https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_CORE/src/com/ibm/smf/format/DefaultFilter.java): `SMF-Tools/SMF_CORE/src/com/ibm/smf/format/DefaultFilter.java`
- [Version Error](https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_CORE/src/com/ibm/smf/format/UnsupportedVersionException.java): `SMF-Tools/SMF_CORE/src/com/ibm/smf/format/UnsupportedVersionException.java`

### WebSphere SMF

- [Request Record](https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_WAS/src/com/ibm/smf/twas/request/RequestActivitySmfRecord.java): `SMF-Tools/SMF_WAS/src/com/ibm/smf/twas/request/RequestActivitySmfRecord.java`
- [Request Sections](https://github.com/ibm/ibm-z-zos/tree/main/SMF-Tools/SMF_WAS/src/com/ibm/smf/twas/request): `SMF-Tools/SMF_WAS/src/com/ibm/smf/twas/request`
- [Server Sections](https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_WAS/src/com/ibm/smf/was/common/ZosServerInfoSection.java): `SMF-Tools/SMF_WAS/src/com/ibm/smf/was/common/ZosServerInfoSection.java`

### SMF Plugins

- [CSV Export](https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF_WAS_PLUGINS/src/com/ibm/smf/was/plugins/CSVExport.java): `SMF-Tools/SMF_WAS_PLUGINS/src/com/ibm/smf/was/plugins/CSVExport.java`

### Independent Samples

- [SMF 84 Formatter](https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF84Formatter/smf84fmt.c): `SMF-Tools/SMF84Formatter/smf84fmt.c`
- [Formatter Definitions](https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMF84Formatter/smf84fmt.h): `SMF-Tools/SMF84Formatter/smf84fmt.h`
- [SMF Real Tool](https://github.com/ibm/ibm-z-zos/blob/main/SMF-Tools/SMFReal/smfreal.c): `SMF-Tools/SMFReal/smfreal.c`
- [Dataset REST Client](https://github.com/ibm/ibm-z-zos/blob/main/zOSMF/ZosmfRESTClient/src/com/ibm/zosmf/restclient/client/RestFileClient.java): `zOSMF/ZosmfRESTClient/src/com/ibm/zosmf/restclient/client/RestFileClient.java`
- [REST Connection](https://github.com/ibm/ibm-z-zos/blob/main/zOSMF/ZosmfRESTClient/src/com/ibm/zosmf/restclient/basic/RestConnection.java): `zOSMF/ZosmfRESTClient/src/com/ibm/zosmf/restclient/basic/RestConnection.java`

### Other components

- **z/OSMF REST API**

## Connections

- SMF Record → Binary Stream: reads bytes (evidence: `SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfRecord.java`)
- SMF Record → Versioned Entity: extends (evidence: `SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfRecord.java`)
- SMF Record → Triplet Index: uses (evidence: `SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfRecord.java`)
- SMF Record → Conversions: converts values (evidence: `SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfRecord.java`)
- SMF Record → SMF Utilities: uses (evidence: `SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfRecord.java`)
- Versioned Entity → Version Error: throws (evidence: `SMF-Tools/SMF_CORE/src/com/ibm/smf/format/SmfEntity.java`)
- Default Filter → SMF Record: filters (evidence: `SMF-Tools/SMF_CORE/src/com/ibm/smf/format/DefaultFilter.java`)
- Default Filter → Print Stream: initializes (evidence: `SMF-Tools/SMF_CORE/src/com/ibm/smf/format/DefaultFilter.java`)
- Request Record → Request Sections: decodes sections
- Request Record → Server Sections: uses server data
- CSV Export → Default Filter: parses through (evidence: `SMF-Tools/SMF_WAS_PLUGINS/src/com/ibm/smf/was/plugins/CSVExport.java`)
- CSV Export → Request Record: exports fields (evidence: `SMF-Tools/SMF_WAS_PLUGINS/src/com/ibm/smf/was/plugins/CSVExport.java`)
- SMF 84 Formatter → Formatter Definitions: uses definitions (evidence: `SMF-Tools/SMF84Formatter/smf84fmt.c`)
- Dataset REST Client → REST Connection: invokes (evidence: `zOSMF/ZosmfRESTClient/src/com/ibm/zosmf/restclient/client/RestFileClient.java`)
- Dataset REST Client → z/OSMF REST API: GET / PUT (evidence: `zOSMF/ZosmfRESTClient/src/com/ibm/zosmf/restclient/client/RestFileClient.java`)
