🚀 Salesforce Data Extractor

> A powerful Node.js CLI tool that extracts Salesforce data based on a load plan and generates beautiful, interactive HTML reports with dark theme.

✨ Features

- 📊 Extract data from multiple Salesforce objects using SOQL queries
- 🎨 Beautiful dark-themed HTML report with Tailwind CSS
- 📦 Optional ZIP archive of all CSV files
- 🔍 Searchable object list and data tables
- 📈 Column sorting and filtering
- 💾 CSV export functionality
- 🌳 Support for nested field names (e.g., Parent.Name, Product2.StockKeepingUnit)
- ⚡ Real-time progress tracking
- 📱 Responsive design

🎨 Screenshots

- !sf-data-extract

Security check load plan

- Load Plan Security

📋 Prerequisites

- Node.js >= 14.0.0
- Salesforce CLI (sf) installed and authenticated
- Valid Salesforce org access

🔧 Installation

$3

``bash
npm install -g sf-data-extractor
`




📖 Usage

$3

`bash
sf-data-extractor -o -l
`

$3

`bash
sf-data-extractor -o myorg@example.com -l load-plan.json -d ./my-reports
`

$3

`bash


Create a ZIP file containing all CSV files

sf-data-extractor -o myorg@example.com -l load-plan.json -z

Combine with custom output directory

sf-data-extractor -o myorg@example.com -l load-plan.json -d ./my-reports -z
`

$3

| Option | Alias | Description | Required |
|--------|-------|-------------|----------|
| --org | -o | Salesforce org username or alias | ✅ Yes |
| --load-plan | -l | Path to load-plan.json file | ✅ Yes |
| --output-dir | -d | Output directory for results | ❌ No (default: ./sf-extract-output) |
| --zip | -z | Create a ZIP file containing all CSV files | ❌ No |

📄 Load Plan Format

Create a load-plan.json file with the following structure:

`json

[
{
"object": "Account",
"compositeKeys": [
"Id"
],
"query": "SELECT Name, Industry FROM Account",
"fieldMappings": {
"Name": "Name",
"Industry": "Industry",
"Id": "Id"
}
},


{
"object": "Opportunity",
"compositeKeys": [
"Id"
],
"query": "SELECT Name, Amount FROM Opportunity",
"fieldMappings": {
"Name": "Name",
"Id": "Id",
"Amount": "Amount"
}
}
]

`

$3

`json
[
{
"object": "AttributeCategory",
"compositeKeys": ["Code"],
"query": "SELECT Name, Description, Code FROM AttributeCategory WHERE Code != null",
"fieldMappings": {
"Name": "Name",
"Code": "Code",
"Description": "Description"
}
},
{
"object": "Product2",
"compositeKeys": ["StockKeepingUnit"],
"query": "SELECT StockKeepingUnit, Name, ProductCode, Description FROM Product2",
"fieldMappings": {
"StockKeepingUnit": "StockKeepingUnit",
"Name": "Name",
"ProductCode": "ProductCode"
}
}
]
`

$3

- object (required): Salesforce object API name
- compositeKeys (optional): Keys used for identifying records
- query (required): SOQL query to extract data
- fieldMappings (optional): Field mappings for data transformation

🎯 Example

`bash


Extract data from your org

sf-data-extractor -o myorg@example.com -l config/load-plan.json

Extract and create ZIP archive

sf-data-extractor -o myorg@example.com -l config/load-plan.json -z

Output:

🚀 Starting Salesforce Data Extraction...

📄 Reading load plan from: config/load-plan.json

[1/5] Processing AttributeCategory...

⏳ Executing query...

✅ Extracted 25 records

...

📊 Generating HTML report...

✅ HTML report generated

📦 Creating ZIP archive...

📄 Adding 5 CSV files to archive...

📊 Total size: 2.34 MB

✅ ZIP file created: ./sf-extract-output/data-export.zip

✨ Extraction complete!

📁 Output directory: ./sf-extract-output

🌐 Open report: ./sf-extract-output/report.html

📦 ZIP archive: ./sf-extract-output/data-export.zip

`

📊 HTML Report Features

$3

- 📋 List of all extracted objects
- 🔍 Search functionality
- 🟢/🔴 Status indicators
- 📊 Record counts
- 📈 Summary statistics

$3

- 📝 SOQL query display
- 📊 Interactive data table
- 🔄 Column sorting (click headers)
- 🔍 Table search/filter
- 💾 Export to CSV
- 🎨 Nested field support

$3

- Dark theme optimized for readability
- Responsive design for all screen sizes
- Smooth transitions and hover effects
- Professional data presentation

📝 Notes

- The tool uses the Salesforce CLI (sf data query) command
- All queries are executed in CSV format for efficient processing
- Large datasets are processed efficiently with streaming
- ZIP archive includes all CSV files organized in a csv/ folder with maximum compression
- ZIP archive filename is always data-export.zip in the output directory

🐛 Troubleshooting




$3


`bash

Verify SF CLI is installed

sf --version

Check org authentication

sf org list
``

📄 License

MIT License - (c) Mohan Chinnappan

---

Made with ❤️ for Salesforce developers