Getting Started¶

This guide will help you navigate and make the most of the SAP Data Profiles documentation.

📚 What is This?¶

This documentation site is a knowledge base for SAP source tables and their relationships in the ABAP-to-dbt migration project. It follows Foam principles:

• Wiki-links: Click table names to navigate between profiles
• Backlinks: See what references each table
• Non-hierarchical: Multiple paths to explore the same information
• Discoverable: Find related information through relationships

🗺️ Navigation Paths¶

There are multiple ways to explore the documentation:

1. By Table Name¶

• Go to Source Profiles or Marts
• Browse alphabetically or filter by completeness
• Click any table to see its detailed profile

2. By Relationship¶

• Start at Relationships
• Explore how tables connect to each other
• View entity-relationship diagrams

3. By Data Quality¶

• Go to Data Quality
• Find columns with high null percentages
• Analyze row counts and volumes

4. By Domain¶

• Browse Domains
• See tables grouped by business domain:
• Customer data
• Equipment data
• Financial data
• Configuration tables

5. By Search¶

• Use the search bar at the top
• Search for table names, column names, or concepts
• Results include context and highlighting

🔗 Using Wiki-Links¶

Throughout the documentation, you'll see clickable table names like ADRC or KNA1.

These are wiki-links that let you: - Navigate directly to table profiles - Explore relationships by clicking referenced tables - Build a mental map of data connections

📖 Understanding Profiles¶

Each table profile contains:

Header¶

• Table name and schema
• Total rows and columns
• Generation timestamp

Source Files¶

• CSV files that were profiled
• File sizes and row counts

Column Summary¶

• Column name, type, PostgreSQL type
• Nullable flag and null percentage
• Unique value count

Column Details¶

• Value distributions
• Sample values
• Data quality notes

🎨 Visual Elements¶

Tables¶

Sortable tables for easy filtering and comparison

Code Blocks¶

-- SQL examples and schema definitions

Mermaid Diagrams¶

erDiagram
    EQUI ||--o{ EUITRANS : has
    EQUI ||--o{ ILOA : has

Admonitions¶

💡 Tips & Tricks¶

1. Use Browser Search¶

• Press Ctrl+F (or Cmd+F on Mac)
• Search within current page

2. Bookmark Frequently Used Tables¶

• Add common tables to browser bookmarks
• Create collections for related tables

3. Open Links in New Tab¶

• Right-click wiki-links
• Open in new tab to compare profiles

4. Check Relationships First¶

• When exploring a new table
• Check its relationships to understand context
• Follow foreign keys to related tables

5. Filter by Quality¶

• Use quality reports to identify problematic tables
• Focus on high-volume tables for critical logic

🔄 How Documentation is Generated¶

This documentation is automatically generated from artifacts produced by the ABAP_exec_data_extract project:

Generator → Artifacts → This Documentation

1. Generator (B) profiles tables and detects relationships
2. Artifacts (A) are saved as JSON and Markdown files
3. This Site (C) reads artifacts and transforms them to HTML

The documentation is always in sync with the latest artifacts.

📊 Metrics Explained¶

Null Percentage¶

Percentage of NULL values in a specific column. - 0%: No nulls (required field) - <20%: Mostly populated - >80%: Rarely populated

Row Count¶

Total number of rows in the table.

🆘 Need Help?¶

Documentation Issues¶

If you find errors or have suggestions for this documentation site: - Contact the MZperX Data Team - Check the source repo: /home/imre/code/MZperX/dbt_creator_doc_artifacts_001

Data Issues¶

If you find issues with the source data or profiles: - Contact the data engineering team - Reference the generator repo: /home/imre/Temp/ABAP_exec_data_extract

🚀 Next Steps¶

Ready to explore? Try these:

1. Browse all source profiles
2. View the relationship network
3. Check data quality reports
4. Explore domains

Happy exploring! 🎉