Spaces:
Build error
Build error
Upload README.md with huggingface_hub
Browse files
README.md
CHANGED
@@ -1,13 +1,160 @@
|
|
1 |
---
|
2 |
-
title:
|
3 |
-
emoji:
|
4 |
-
colorFrom:
|
5 |
colorTo: purple
|
6 |
sdk: gradio
|
7 |
-
sdk_version:
|
8 |
app_file: app.py
|
9 |
pinned: false
|
10 |
license: mit
|
11 |
---
|
12 |
|
13 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
---
|
2 |
+
title: Salesforce Data Loader
|
3 |
+
emoji: π
|
4 |
+
colorFrom: blue
|
5 |
colorTo: purple
|
6 |
sdk: gradio
|
7 |
+
sdk_version: 4.44.0
|
8 |
app_file: app.py
|
9 |
pinned: false
|
10 |
license: mit
|
11 |
---
|
12 |
|
13 |
+
# π Salesforce Data Loader
|
14 |
+
|
15 |
+
A powerful, user-friendly web application for uploading and downloading data from Salesforce. Built with Gradio and designed for easy bulk data operations.
|
16 |
+
|
17 |
+
## β¨ Features
|
18 |
+
|
19 |
+
### π Secure Authentication
|
20 |
+
- Connect to Salesforce production or sandbox environments
|
21 |
+
- Secure credential handling with username, password, and security token
|
22 |
+
- Real-time connection status feedback
|
23 |
+
|
24 |
+
### π€ Data Upload
|
25 |
+
- **File Support**: Upload CSV and Excel files (.csv, .xlsx, .xls)
|
26 |
+
- **Bulk Operations**:
|
27 |
+
- **Insert**: Add new records
|
28 |
+
- **Update**: Modify existing records
|
29 |
+
- **Upsert**: Insert or update based on external ID
|
30 |
+
- **Object Support**: Works with common Salesforce objects (Account, Contact, Lead, Opportunity, Case, etc.)
|
31 |
+
- **Field Mapping**: Automatic field detection and validation
|
32 |
+
- **Results Tracking**: Download detailed results with success/error reports
|
33 |
+
|
34 |
+
### π₯ Data Export
|
35 |
+
- Export data from any accessible Salesforce object
|
36 |
+
- Select specific fields to export
|
37 |
+
- Configurable record limits (100-10,000 records)
|
38 |
+
- Download as CSV format
|
39 |
+
- SOQL query generation
|
40 |
+
|
41 |
+
### π‘οΈ Error Handling
|
42 |
+
- Comprehensive error reporting
|
43 |
+
- Field validation and type checking
|
44 |
+
- Bulk operation result tracking
|
45 |
+
- Detailed logging for debugging
|
46 |
+
|
47 |
+
## π How to Use
|
48 |
+
|
49 |
+
### 1. Connect to Salesforce
|
50 |
+
1. Navigate to the **π Connection** tab
|
51 |
+
2. Enter your Salesforce credentials:
|
52 |
+
- **Username**: Your Salesforce email
|
53 |
+
- **Password**: Your Salesforce password
|
54 |
+
- **Security Token**: Get this from Salesforce Setup β Personal Information β Reset Security Token
|
55 |
+
3. Check "Sandbox Environment" if connecting to a sandbox
|
56 |
+
4. Click "π Connect to Salesforce"
|
57 |
+
|
58 |
+
### 2. Upload Data
|
59 |
+
1. Go to the **π€ Upload Data** tab (appears after successful connection)
|
60 |
+
2. Upload your CSV or Excel file
|
61 |
+
3. Select the target Salesforce object
|
62 |
+
4. Choose operation type:
|
63 |
+
- **Insert**: For new records
|
64 |
+
- **Update**: For existing records (requires record IDs)
|
65 |
+
- **Upsert**: For insert/update based on external ID
|
66 |
+
5. Click "π€ Upload Data"
|
67 |
+
6. Download the results file to see detailed operation results
|
68 |
+
|
69 |
+
### 3. Export Data
|
70 |
+
1. Go to the **π₯ Export Data** tab
|
71 |
+
2. Select the Salesforce object to export
|
72 |
+
3. Choose specific fields or leave empty for default fields
|
73 |
+
4. Set the record limit (max 10,000)
|
74 |
+
5. Click "π₯ Export Data"
|
75 |
+
6. Download the exported CSV file
|
76 |
+
|
77 |
+
## π Supported Salesforce Objects
|
78 |
+
|
79 |
+
- **Account** - Companies and organizations
|
80 |
+
- **Contact** - Individual people
|
81 |
+
- **Lead** - Potential customers
|
82 |
+
- **Opportunity** - Sales deals
|
83 |
+
- **Case** - Customer service cases
|
84 |
+
- **Campaign** - Marketing campaigns
|
85 |
+
- **User** - Salesforce users
|
86 |
+
- **Product2** - Products and services
|
87 |
+
|
88 |
+
*Note: The application automatically detects which objects you have access to based on your Salesforce permissions.*
|
89 |
+
|
90 |
+
## π§ Technical Requirements
|
91 |
+
|
92 |
+
### For Users
|
93 |
+
- Valid Salesforce credentials (username, password, security token)
|
94 |
+
- CSV or Excel files for data upload
|
95 |
+
- Modern web browser
|
96 |
+
|
97 |
+
### For Developers
|
98 |
+
- Python 3.8+
|
99 |
+
- Required packages (see requirements.txt):
|
100 |
+
- gradio==4.44.0
|
101 |
+
- simple-salesforce==1.12.6
|
102 |
+
- pandas==2.1.4
|
103 |
+
- openpyxl==3.1.2
|
104 |
+
- xlsxwriter==3.1.9
|
105 |
+
- python-dotenv==1.0.0
|
106 |
+
- requests==2.31.0
|
107 |
+
- numpy==1.24.3
|
108 |
+
|
109 |
+
## π Security & Privacy
|
110 |
+
|
111 |
+
- **No Data Storage**: Your Salesforce credentials and data are not stored on our servers
|
112 |
+
- **Secure Connections**: All API calls use HTTPS encryption
|
113 |
+
- **Session-Based**: Connections are only maintained during your browser session
|
114 |
+
- **Local Processing**: File processing happens in real-time without permanent storage
|
115 |
+
|
116 |
+
## π¨ Important Notes
|
117 |
+
|
118 |
+
1. **Security Token**: If you've never used the security token, reset it in Salesforce Setup
|
119 |
+
2. **API Limits**: Be mindful of your Salesforce API call limits
|
120 |
+
3. **Field Mapping**: Ensure your CSV/Excel column names match Salesforce field names
|
121 |
+
4. **Required Fields**: Make sure all required Salesforce fields are included in your data
|
122 |
+
5. **Data Validation**: Review your data before upload to avoid errors
|
123 |
+
|
124 |
+
## π οΈ Local Development
|
125 |
+
|
126 |
+
To run this application locally:
|
127 |
+
|
128 |
+
```bash
|
129 |
+
# Clone the repository
|
130 |
+
git clone <your-repo-url>
|
131 |
+
cd salesforce-data-loader
|
132 |
+
|
133 |
+
# Install dependencies
|
134 |
+
pip install -r requirements.txt
|
135 |
+
|
136 |
+
# Run the application
|
137 |
+
python app.py
|
138 |
+
```
|
139 |
+
|
140 |
+
The application will be available at `http://localhost:7860`
|
141 |
+
|
142 |
+
## π€ Contributing
|
143 |
+
|
144 |
+
Contributions are welcome! Please feel free to submit a Pull Request.
|
145 |
+
|
146 |
+
## π License
|
147 |
+
|
148 |
+
This project is licensed under the MIT License - see the LICENSE file for details.
|
149 |
+
|
150 |
+
## π Support
|
151 |
+
|
152 |
+
If you encounter any issues:
|
153 |
+
1. Check your Salesforce credentials and permissions
|
154 |
+
2. Verify your security token is current
|
155 |
+
3. Ensure your data format matches Salesforce field requirements
|
156 |
+
4. Review the error messages in the results download
|
157 |
+
|
158 |
+
---
|
159 |
+
|
160 |
+
**Built with β€οΈ using Gradio and Simple-Salesforce**
|