SAP <-> Salesforce Account Data Reconciliation Utility
Project description
SAP ↔ Salesforce Account Data Reconciliation Utility
Reconcile SAP and Salesforce Account master data at bulk scale (300K–400K records). Produces a 10-tab Excel workbook and an HTML dashboard with KPIs, field-level diffs, fuzzy match candidates, and a prioritised action plan.
Quick Start
# Install from PyPI
pip install phani-data-recon
# Verify installed version
py -m pip show phani-data-recon
# Verify the CLI is available
reconcile-accounts --help
# Run with explicit input files
reconcile-accounts --sap input/sap_accounts.csv --sf input/sf_accounts.csv
# Validate headers and config only
reconcile-accounts --sap input/sap_accounts.csv --sf input/sf_accounts.csv --dry-run
# Run with config-defined input/output paths
reconcile-accounts --config config/rules.yaml
Platform-specific path examples:
Windows:
reconcile-accounts --sap .\input\sap_accounts.csv --sf .\input\sf_accounts.csv
py -m phani_data_recon.cli --config .\config\rules.yaml --dry-run
# macOS
reconcile-accounts --sap ./input/sap_accounts.csv --sf ./input/sf_accounts.csv
python3 -m phani_data_recon.cli --config ./config/rules.yaml --dry-run
If Windows cmd does not recognize reconcile-accounts, add your Python Scripts directory to PATH and reopen cmd:
setx PATH "%PATH%;C:\Users\SeshaphaniBysani\AppData\Local\Python\pythoncore-3.14-64\Scripts"
Then verify:
where reconcile-accounts
reconcile-accounts --help
For local development in this repository, editable install still works:
pip install -e .
Package Usage
# Explicit input files
reconcile-accounts --sap input/sap_accounts.csv --sf input/sf_accounts.csv
# Config-driven execution
reconcile-accounts --config config/rules.yaml
# Override only the output directory
reconcile-accounts --config config/rules.yaml --output-dir output/run_2026_05_11
# Generate only HTML output
reconcile-accounts --sap input/sap_accounts.csv --sf input/sf_accounts.csv --formats html
If the console script is not available on your PATH, use:
py -m phani_data_recon.cli --dry-run
Production verification on Windows cmd:
py -m pip show phani-data-recon
where reconcile-accounts
py -m phani_data_recon.cli --sap input/sap_accounts.csv --sf input/sf_accounts.csv --dry-run
Expected state:
- Installed version should be
1.0.1. - If
where reconcile-accountsis empty but module execution works, only PATH needs to be fixed.
Python API
Run reconciliation from another Python application:
from phani_data_recon.api import run_reconciliation
exit_code = run_reconciliation(
sap="input/sap_accounts.csv",
sf="input/sf_accounts.csv",
config="config/rules.yaml",
output_dir="output/api_run",
formats=["excel", "html"],
dry_run=False,
no_fuzzy=False,
verbose=True,
)
print(exit_code)
The API mirrors the CLI behavior and returns a process-style exit code.
Options
--sap Path to SAP accounts CSV (optional if config input.sap is set)
--sf Path to Salesforce accounts CSV (optional if config input.sf is set)
--config Path to rules YAML (default: ./config/rules.yaml, then packaged default)
--output-dir Output directory (default: from config)
--formats excel html (default: both)
--dry-run Validate config + headers only; no report written
--no-fuzzy Skip fuzzy matching (faster for large files)
--verbose Verbose logging
Path resolution precedence:
- If
--sap/--sfare passed, CLI values are used. - If not passed, values are resolved from
config/rules.yamlunderinput.sapandinput.sf. - If
--configis not passed, the CLI tries localconfig/rules.yamlfirst and then the packaged default config. - If
--output-diris passed, it overridesoutput.report.directory. - If neither CLI nor config provides paths, the run exits with an input path error.
Configuration
Edit config/rules.yaml to change:
- Default input files via
input.sapandinput.sf(directory+file_name) - Join key columns (SAP ↔ SF linking fields)
- Fallback-key matching toggle via
join.fallback.enabled(default:false= primary-key-only matching) - Field comparison rules, severity levels, and normalize modes
- Deduplication strategy (
keep_first/keep_last/flag_all) - Fuzzy match threshold and fields
- Output formats and directory
- Output report location/name via
output.report.directory+output.report.file_name
When using the package outside this repository, pass your own config file with --config if you do not want to rely on the packaged defaults.
Output Report Configuration
Use the output.report block in config/rules.yaml to control where reports are written and what base filename is used.
output:
formats: ["excel", "html"]
report:
directory: "output/month_end"
file_name: "customer_reconciliation"
This writes reports under output/month_end/ using customer_reconciliation as the base name, for example:
output/month_end/customer_reconciliation_<run_id>.htmloutput/month_end/customer_reconciliation_<run_id>.xlsx
Rules:
--output-diroverridesoutput.report.directoryoutput.report.file_namesets the report filename prefixoutput.formatsselects Excel, HTML, or both
Example commands:
# Use output settings from config
reconcile-accounts --config config/rules.yaml
# Override only the output directory at runtime
reconcile-accounts --config config/rules.yaml --output-dir output/ad_hoc_run
Config Reference (Input + Join)
input:
sap:
directory: "input"
file_name: "sap_accounts.csv"
sf:
directory: "input"
file_name: "sf_accounts.csv"
join:
primary:
sap_col: "SAP_Unique_ID"
sf_col: "BP_PowerCerv_Account_Id__c"
fallback:
enabled: false
sap_col: "SAP_Unique_ID"
sf_col: "WC_SAP_Identification__c"
output:
formats: ["excel", "html"]
report:
directory: "output"
file_name: "reconciliation_report"
Notes:
- Set
join.fallback.enabled: falsefor strict primary-key-only matching (default). - Set
join.fallback.enabled: trueonly when you explicitly want fallback-key matching.
Report Tabs
| Tab | Content |
|---|---|
| Summary | KPI counts, match rate, exception rate |
| Exact_Matches | Records found in both systems |
| Field_Mismatches | Field-level diffs (CRITICAL / HIGH / INFO) |
| SAP_Only | SAP records missing from Salesforce |
| SF_Only | Salesforce records missing from SAP |
| SAP_Duplicates | Duplicate SAP rows before dedup |
| SF_Duplicates | Duplicate SF rows before dedup |
| Fuzzy_Match_Candidates | Likely-same accounts not linked by ID |
| Data_Quality_Issues | Null IDs, bad formats, validation failures |
| Action_Plan | P1–P4 prioritised remediation table |
Run Tests
pip install pytest
python -m pytest tests/ -v
Distribution (Business Rollout)
# Build wheel + source distribution
python -m build
# Install locally from wheel
pip install dist/phani_data_recon-1.0.1-py3-none-any.whl
If reconcile-accounts is not on PATH, run:
python -m phani_data_recon.cli --dry-run
Published package:
pip install --upgrade phani-data-recon
Legacy script usage inside this repository still works:
python run_reconciliation.py --dry-run
CI Publishing (GitHub Actions)
This repository includes .github/workflows/publish-pypi.yml to publish new releases to PyPI without storing a PyPI API token in GitHub.
One-time PyPI setup:
- In PyPI, open the
phani-data-reconproject settings. - Add a Trusted Publisher for this GitHub repository.
- Set the workflow name to
publish-pypi.yml. - Set the environment name to
pypi.
Release flow:
- Bump the version in
pyproject.toml. - Create a GitHub release or run the workflow manually from the Actions tab.
- The workflow builds
dist/artifacts and publishes them with PyPI trusted publishing.
Notes:
- This workflow uses GitHub OIDC via
id-token: write, so noTWINE_PASSWORDsecret is required in GitHub. - Keep local
twineusage only for manual emergency releases.
Project Structure
reconciliation_project/
├── input/ ← Place source CSVs here
├── config/ ← rules.yaml + schema
├── src/ ← All Python modules
├── templates/ ← Jinja2 HTML template
├── tests/ ← pytest test suite
├── output/ ← Reports generated here
└── run_reconciliation.py
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file phani_data_recon-1.0.2.tar.gz.
File metadata
- Download URL: phani_data_recon-1.0.2.tar.gz
- Upload date:
- Size: 36.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
49d873eeb44d019ffc37bb0231c3783bfb17238955a613638bd37bcc2078cd53
|
|
| MD5 |
571cb6c09c42e9459e2742048206af79
|
|
| BLAKE2b-256 |
56f4b46af2473b322988a65aa5fcd50944eb733c067658ab693b2c584e695ab2
|
File details
Details for the file phani_data_recon-1.0.2-py3-none-any.whl.
File metadata
- Download URL: phani_data_recon-1.0.2-py3-none-any.whl
- Upload date:
- Size: 33.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
45ee252bd23b578c59ee95d5090b9762df9a964b70e93dd05050df5a11ca33ab
|
|
| MD5 |
c26315b3008305fdc42693c537e80260
|
|
| BLAKE2b-256 |
80afc7d5f597cf7127ccda81a2f4733f211b7905bdf9777ac2757e807d53eb99
|