Changeset 3485450
- Timestamp:
- 03/18/2026 09:18:09 AM (2 weeks ago)
- File:
-
- 1 edited
-
sigma-importx-engine/tags/1.0/readme.txt (modified) (3 diffs)
Legend:
- Unmodified
- Added
- Removed
-
sigma-importx-engine/tags/1.0/readme.txt
r3485435 r3485450 13 13 == Description == 14 14 15 **Sigma ImportX Engine** is a comprehensive data import solution for WordPress that makes importing large datasets quick and easy.16 17 Transform your data migration and bulk content management with an enterprise-grade import solution built specifically for WordPress.15 **Sigma ImportX Engine** is a professional data import plugin for WordPress. Whether you're migrating from another CMS, importing a product catalog, or doing a bulk content upload, Sigma ImportX handles it reliably through an intuitive step-by-step wizard. 16 17 Upload your file, map your columns to WordPress fields, configure your settings, and import — all without writing a single line of code. Every import is logged and can be rolled back instantly if something goes wrong. 18 18 19 19 = Key Features = 20 20 21 * **Multi-Format Support** - Import CSV, XLSX, XML, and TXT files with automatic format detection 22 * **Drag & Drop Upload** - Intuitive file upload interface with instant preview and validation 23 * **Smart Field Mapping** - Visual field mapper with intelligent auto-detection and suggestions 24 * **Template System** - Save and reuse field mapping configurations for repeated imports 25 * **Progress Tracking** - Real-time import progress with detailed logs and status updates 26 * **Import History** - Complete audit trail with rollback capability for any import 27 * **Dashboard Analytics** - Beautiful visual statistics and import summaries 28 * **Custom Post Types** - Full support for any post type, built-in or custom 29 * **Bulk Operations** - Create, update, or upsert thousands of records efficiently 30 * **Data Validation** - Pre-import validation to catch errors before processing 31 * **Background Processing** - Handle large files without timeout issues 32 * **Rollback Feature** - Undo any import with one click from import history 33 * **Secure by Design** - Nonce verification, capability checks, and sanitization throughout 34 * **Translation Ready** - Fully internationalized and ready for translation 35 36 = Perfect For = 37 38 * **Content Managers** - Importing large content libraries and managing bulk updates 39 * **E-commerce Stores** - Migrating product catalogs from other platforms 40 * **Developers** - Building data-driven WordPress sites with custom post types 41 * **Agencies** - Managing multiple client data migrations efficiently 42 * **Membership Sites** - Importing user databases and member information 43 * **Publishers** - Bulk importing articles, posts, and media content 44 * **Data Analysts** - Moving data from spreadsheets to WordPress 45 46 = Why Choose Sigma ImportX? = 47 48 Unlike other import plugins, Sigma ImportX is built from the ground up with: 49 50 * **Clean Code** - Following WordPress coding standards and best practices 51 * **Security First** - Comprehensive nonce verification, capability checks, and data sanitization 52 * **Performance** - Optimized for large datasets with background processing and chunking 53 * **Extensibility** - Developer-friendly with hooks, filters, and well-documented code 54 * **Active Development** - Regular updates and feature additions based on user feedback 55 * **Professional Support** - Dedicated support team ready to help 56 57 = Technical Highlights = 58 59 * Object-oriented architecture with namespacing 60 * PSR-4 autoloading for clean dependency management 61 * Singleton pattern for optimal resource usage 62 * Custom database tables for import tracking 63 * AJAX-based processing for better UX 64 * Responsive admin interface 65 * No external dependencies or paid add-ons required 66 67 = Use Cases = 68 69 1. **Website Migration** - Moving from another CMS to WordPress 70 2. **Product Catalogs** - Importing products from suppliers or other systems 71 3. **Content Publishing** - Bulk importing articles from writers or content teams 72 4. **Data Integration** - Syncing data from external databases or APIs 73 5. **Client Projects** - Importing existing client data into new WordPress sites 74 6. **Testing & Development** - Quickly populating development sites with test data 21 * **Multi-Format Support** — Import CSV, XLSX, XML, and TXT files with automatic delimiter and encoding detection 22 * **Drag & Drop Upload** — Upload files instantly with in-browser preview and validation before processing 23 * **Smart Field Mapping** — Visual mapper with auto-detection; add custom post meta fields on the fly 24 * **Template System** — Save and reuse field mapping configurations across multiple imports 25 * **Three Import Modes** — Create new records, update existing ones, or upsert (create or update automatically) 26 * **Real-Time Progress** — Live progress bar and detailed per-row log during import 27 * **Import History** — Full audit trail of every import run with timestamps and row counts 28 * **One-Click Rollback** — Revert any import completely from the Import History screen 29 * **Background Processing** — Large files are chunked and processed without hitting PHP timeouts 30 * **Data Validation** — Catch formatting errors and missing required fields before the import runs 31 * **Custom Post Types** — Works with any registered post type, including those added by themes or plugins 32 * **Dashboard Overview** — Visual summary of import statistics and recent activity 33 * **No External Dependencies** — No paid add-ons, no third-party services, no data leaves your server 34 * **Translation Ready** — Fully internationalized with standard WordPress i18n 35 36 = Who Is This For? = 37 38 * **Content Managers** — Bulk import or update large content libraries without developer help 39 * **Developers & Agencies** — Migrate client data into new WordPress sites cleanly and repeatably 40 * **E-commerce Operators** — Import product catalogs including custom fields and metadata 41 * **Site Builders** — Quickly seed development or staging environments with real data 42 43 = How It Works = 44 45 The 5-step import wizard guides you through the entire process: 46 47 1. **Upload** — Drag and drop or browse to select your CSV, XLSX, XML, or TXT file 48 2. **Preview** — Review a sample of your data and confirm it was parsed correctly 49 3. **Map Fields** — Assign each column to a WordPress field or custom meta key 50 4. **Configure** — Choose post type, import mode, and post status 51 5. **Import** — Watch the progress in real time and review the detailed results log 52 53 When the import is done, it is recorded in Import History. If anything looks wrong, roll it back with one click. 75 54 76 55 == Installation == 77 56 78 = From WordPress Dashboard (When Available) = 79 80 1. Navigate to Plugins > Add New 81 2. Search for "Sigma ImportX Engine" 82 3. Click "Install Now" and then "Activate" 83 4. Go to CSV Importer in your admin menu 84 5. Start your first import! 57 = From the WordPress Plugin Directory = 58 59 1. Go to **Plugins > Add New** in your WordPress admin 60 2. Search for **Sigma ImportX Engine** 61 3. Click **Install Now**, then **Activate** 62 4. Navigate to **CSV Importer** in the admin sidebar to get started 85 63 86 64 = Manual Installation = 87 65 88 66 1. Download the plugin ZIP file 89 2. Log in to your WordPress admin panel 90 3. Navigate to Plugins > Add New > Upload Plugin 91 4. Choose the ZIP file and click "Install Now" 92 5. Activate the plugin 93 6. Access via CSV Importer menu item in the admin sidebar 94 95 = After Activation = 96 97 1. Go to **CSV Importer > Dashboard** to see the overview 98 2. Click **New Import** to start your first import 99 3. Follow the intuitive 5-step wizard: 100 - Step 1: Upload your file 101 - Step 2: Preview and validate data 102 - Step 3: Map fields to WordPress fields 103 - Step 4: Configure import settings 104 - Step 5: Run import and monitor progress 105 4. Review the import summary and detailed logs 106 5. Check **Import History** to see all past imports 107 108 = Recommended Server Settings = 109 110 For optimal performance with large files: 111 112 * `upload_max_filesize`: 64M or higher 113 * `post_max_size`: 64M or higher 114 * `max_execution_time`: 300 seconds or higher 115 * `memory_limit`: 256M or higher 67 2. Go to **Plugins > Add New > Upload Plugin** 68 3. Select the ZIP file and click **Install Now** 69 4. Activate the plugin 70 5. Navigate to **CSV Importer** in the admin sidebar 71 72 = Recommended Server Configuration = 73 74 For best performance with large files, your server should be configured with: 75 76 * `upload_max_filesize` — 64M or higher 77 * `post_max_size` — 64M or higher 78 * `max_execution_time` — 300 seconds or higher 79 * `memory_limit` — 256M or higher 80 81 Contact your hosting provider if you need help adjusting these values. 116 82 117 83 == Frequently Asked Questions == … … 119 85 = What file formats are supported? = 120 86 121 C urrently supported: CSV (Comma-Separated Values), XLSX (Excel), XML, and TXT files. We automatically detect delimiters, encodings, and file structures. Support for more formats is planned for future releases.122 123 = What's the maximum file size I can import? =124 125 File size limits depend on your server's PHP settings (`upload_max_filesize` and `post_max_size`). We recommend files under 50MB for optimal performance. For larger datasets, consider splitting them into multiple files or contact your hosting provider to increase limits.126 127 = Can I import custom post types? =128 129 Yes ! Sigma ImportX supports ALL registered post types, including custom post types created by themes or other plugins. Simply select your desired post type duringthe import configuration step.87 CSV, XLSX (Excel), XML, and TXT. Delimiters and encodings are detected automatically — no manual configuration needed in most cases. 88 89 = Is there a file size limit? = 90 91 There is no hard limit imposed by the plugin. Your server's `upload_max_filesize` and `post_max_size` PHP settings determine the maximum. Files under 50MB are recommended for smooth performance. For very large datasets, split them into multiple files. 92 93 = Can I import into custom post types? = 94 95 Yes. Sigma ImportX works with any registered post type — custom post types created by your theme or other plugins are listed automatically in the import configuration step. 130 96 131 97 = Does it work with WooCommerce? = 132 98 133 Basic WooCommerce product import functionality works now. You can import simple products with standard fields. 134 135 = Can I undo an import if something goes wrong? = 136 137 Absolutely! Every import has a rollback feature accessible from the Import History page. You can revert any import with one click, restoring your site to its pre-import state. We keep detailed records of all changes made. 138 139 = Does it support custom fields and meta data? = 140 141 Yes! You can map CSV columns to any custom field or post meta. During field mapping, you can add custom fields manually. 142 143 = Will it update existing posts or only create new ones? = 144 145 You have three import modes: 146 * **Create New** - Always creates new posts/records 147 * **Update Existing** - Updates posts that match (by ID, slug, or title) 148 * **Upsert** - Creates if doesn't exist, updates if it does 149 150 Choose the mode that fits your needs during import configuration. 151 152 = Is it compatible with WordPress multisite? = 153 154 Currently, Sigma ImportX is designed and tested for single-site WordPress installations. Multisite network support is on our roadmap for a future release. If you need multisite support urgently, please contact us. 155 156 = Can I schedule automatic imports? = 157 158 Scheduled imports and automated functionality are features we're considering for future development. Stay tuned for updates! 159 160 = How do I handle images and media files? = 161 162 Basic featured image import by URL is supported. Current version focuses on textual data and meta fields. 163 164 = Does it work with my theme? = 165 166 Yes! Sigma ImportX is theme-independent and works with any properly-coded WordPress theme. We've tested with Twenty Twenty-Three, Astra, GeneratePress, and other popular themes. 167 168 = What about SEO plugins like Yoast? = 169 170 You can import custom fields that Yoast uses for SEO data. 171 172 = Is my data safe and private? = 173 174 Absolutely. Sigma ImportX: 175 * Does NOT send any data to external servers 176 * Does NOT collect or track user information 177 * Does NOT use cookies or external analytics 178 * Processes everything locally on your WordPress installation 179 * All import data stays on your server 180 181 = Where can I get support? = 182 183 For support, feature requests, or bug reports: 184 * Use the WordPress.org support forum for this plugin 185 * Email us at mahipatsinh.r@sigmainfo.net 186 * Check our documentation (coming soon) 187 188 We typically respond within 24-48 hours during business days. 189 190 = Can I contribute or request features? = 191 192 Yes! We actively welcome: 193 * Feature requests and suggestions 194 * Bug reports with details 195 * Code contributions (coming soon via GitHub) 196 * Translations in your language 197 * Reviews and feedback 198 199 Contact us through the support forum or email. 99 Basic WooCommerce product import is supported in this release. You can import simple products with standard fields. More WooCommerce-specific field support is planned. 100 101 = Can I undo an import after it runs? = 102 103 Yes. Every import is stored in the Import History screen. Click Rollback next to any import to reverse it completely and restore your site to its prior state. 104 105 = Can I map columns to custom fields and post meta? = 106 107 Yes. The field mapper lets you assign any CSV column to any registered post meta key. You can also type in a custom meta key manually if it does not already exist. 108 109 = What import modes are available? = 110 111 Three modes are supported: 112 113 * **Create** — Always inserts new records 114 * **Update** — Finds existing posts by ID, slug, or title and updates them 115 * **Upsert** — Updates if a match is found; creates a new record if not 116 117 = Is WordPress multisite supported? = 118 119 Not in the current release. Multisite support is planned for a future version. 120 121 = Can I schedule or automate imports? = 122 123 Scheduled and automated imports are on the roadmap. The current release is wizard-driven. 124 125 = How are images and media handled? = 126 127 Featured images can be imported by providing a public URL in your data file. Full media library management is planned for a future release. 128 129 = Does it work with Yoast SEO or other SEO plugins? = 130 131 Yes. You can map columns to any custom field, including the meta fields used by Yoast SEO, Rank Math, or other SEO plugins. 132 133 = Is my data kept private? = 134 135 All processing happens locally on your server. The plugin does not send any data to external servers, does not use external analytics, and does not phone home for any reason. 136 137 = Where do I get support? = 138 139 * **Support Forum:** https://wordpress.org/support/plugin/sigma-importx-engine/ 140 * **Email:** mahipatsinh.r@sigmainfo.net 141 142 When contacting support, please include your WordPress version, PHP version, plugin version, and a description of the issue. We respond within 24-48 hours on business days. 200 143 201 144 == Screenshots == 202 145 203 1. **Dashboard** - Import statistics, recent imports, and quick actions at a glance204 2. ** Upload Interface** - Drag and drop file upload with instant validation and preview205 3. **Field Mapping** - Visual field mapper with auto-detection and custom fieldsupport206 4. **Import Progress** - Real-time progress tracking with detailed status and logs207 5. **Import History** - Complete audit trail with rollback capability for all imports208 6. **Template Manage ment** - Save and reuse field mapping templates for efficiency146 1. **Dashboard** — Import statistics, recent activity, and quick-start actions 147 2. **File Upload** — Drag and drop interface with instant preview and validation 148 3. **Field Mapping** — Visual column-to-field mapper with custom meta support 149 4. **Import Progress** — Live progress bar with per-row status log 150 5. **Import History** — Full audit trail with one-click rollback for every import 151 6. **Template Manager** — Save and reuse field mapping configurations 209 152 210 153 == Changelog == 211 154 212 = 1.0.0 (2026-02-04) = 213 **Initial Release** 214 215 * Core plugin architecture with namespace and autoloading 216 * Multi-format file support: CSV, XLSX, XML, TXT 217 * Drag and drop file upload interface 218 * Automatic delimiter and encoding detection 219 * File validation (size, type, content) 220 * Multi-step import wizard (5 intuitive steps) 221 * Visual field mapping with auto-detection 222 * Template system for saving field mappings 155 = 1.0.0 - 2026-03-18 = 156 Initial release. 157 158 * 5-step import wizard (upload, preview, map, configure, run) 159 * Multi-format support: CSV, XLSX, XML, TXT with auto-detection 160 * Visual field mapper with auto-suggestions and custom meta support 161 * Template system for saving and reusing field mappings 223 162 * Three import modes: Create, Update, Upsert 224 * Real-time progress tracking with AJAX 225 * Dashboard with statistics and analytics 226 * Import history with detailed logs 227 * Rollback functionality for any import 228 * Custom database tables for tracking 229 * Background processing for large datasets 230 * Security: Nonce verification and capability checks 231 * Sanitization and escaping throughout 232 * Internationalization ready with text domain 233 * Responsive admin interface 234 * WordPress coding standards compliance 235 * Comprehensive error handling and logging 163 * Real-time AJAX progress tracking with detailed per-row logs 164 * Import history with full rollback capability 165 * Background chunked processing for large datasets 166 * Pre-import data validation 167 * Dashboard with import statistics 168 * Custom database tables: imports, logs, templates 169 * Nonce verification, capability checks, and full data sanitization 170 * WordPress coding standards compliant 171 * Translation-ready with text domain 236 172 237 173 == Upgrade Notice == 238 174 239 175 = 1.0.0 = 240 Welcome to Sigma ImportX Engine! This is the initial release. Install and start importing your data with ease.176 Initial release. No upgrade steps required. 241 177 242 178 == Additional Information == … … 244 180 = System Requirements = 245 181 246 **Minimum:** 247 * WordPress: 5.8 or higher 248 * PHP: 7.4 or higher 249 * MySQL: 5.6+ or MariaDB 10.0+ 250 251 **Recommended:** 252 * WordPress: 6.0 or higher 253 * PHP: 8.0 or higher 254 * MySQL: 5.7+ or MariaDB 10.3+ 255 * PHP Memory Limit: 256MB or higher 256 * Max Execution Time: 300 seconds or higher 257 * Upload Max Filesize: 64MB or higher 258 259 = Developer Information = 260 261 Sigma ImportX is built with developers in mind: 262 263 **Architecture:** 264 * Clean OOP design with PSR-4 autoloading 265 * Singleton pattern for core classes 266 * Namespace: `SigmaImportX` 267 * Extensible with hooks and filters 268 * Well-documented code with DocBlocks 269 * Custom database schema for scalability 270 271 **Hooks & Filters:** 272 * `sie_before_import` - Action before import starts 273 * `sie_after_import` - Action after import completes 274 * `sie_import_row` - Filter for processing each row 275 * `sie_field_mapping` - Filter for custom field mapping 276 * More hooks coming in future releases 277 278 **Custom Tables:** 279 * `{prefix}_sie_imports` - Import history 280 * `{prefix}_sie_import_logs` - Detailed logs 281 * `{prefix}_sie_templates` - Field mapping templates 282 283 **Contributing:** 284 We welcome code contributions! GitHub repository coming soon. 285 286 = Privacy & Data Policy = 287 288 **Sigma ImportX Engine respects your privacy:** 289 290 This plugin does NOT: 291 * Collect any user data or analytics 292 * Send data to external servers or APIs 293 * Use cookies or tracking mechanisms 294 * Store sensitive information externally 295 * Phone home or check licenses 296 * Display external advertisements 297 298 All data processing happens locally on your WordPress installation. 299 300 **Data Storage:** 301 * Import files are stored temporarily in WordPress uploads directory 302 * Files are automatically cleaned up after import 303 * Import history is stored in your WordPress database 304 * No data leaves your server 305 306 = Credits = 307 308 **Developed by:** Sigma Development Team 309 **Plugin Architecture:** Designed for scalability, security, and maintainability 310 **Inspired by:** The WordPress community's need for better import solutions 311 312 **Third-Party Libraries:** 313 * None currently (all native WordPress functionality) 314 315 = Translations = 316 317 Sigma ImportX is translation-ready! 318 319 **Available Languages:** 320 * English (default) 321 322 **Translating:** 323 We welcome translations in your language. The plugin uses standard WordPress i18n functions. Translation files can be submitted via: 324 * WordPress.org translation platform 325 * Email to mahipatsinh.r@sigmainfo.net 326 327 = Support & Documentation = 328 329 **Support Channels:** 330 * WordPress.org Support Forum: https://wordpress.org/support/plugin/sigma-importx-engine/ 331 * Email: mahipatsinh.r@sigmainfo.net 332 * Documentation: Coming soon at https://docs.sigmainfo.net/ 333 334 **Before Requesting Support:** 335 1. Check the FAQ section above 336 2. Search the support forum 337 3. Check WordPress and PHP versions meet requirements 338 4. Disable other plugins to check for conflicts 339 5. Try with a default WordPress theme 340 341 **When Requesting Support:** 342 Please provide: 343 * WordPress version 344 * PHP version 345 * Plugin version 346 * Steps to reproduce the issue 347 * Screenshots if applicable 348 * Any error messages 349 350 We typically respond within 24-48 hours during business days. 351 352 = Feedback & Reviews = 353 354 If you find Sigma ImportX Engine helpful, please: 355 * Leave a review on WordPress.org 356 * Rate the plugin (5 stars appreciated!) 357 * Share with others who might benefit 358 * Suggest new features 359 * Report any bugs you find 360 361 Your feedback helps us improve and helps others discover the plugin. 362 363 **Thank you for using Sigma ImportX Engine!** 🚀 182 **Minimum** 183 * WordPress 5.8 184 * PHP 7.4 185 * MySQL 5.6 or MariaDB 10.0 186 187 **Recommended** 188 * WordPress 6.0 or higher 189 * PHP 8.0 or higher 190 * MySQL 5.7 or MariaDB 10.3 191 * 256MB PHP memory limit 192 * 300 second max execution time 193 * 64MB upload max filesize 194 195 = Developer Reference = 196 197 **Namespace:** `SigmaImportX` 198 199 **Available Hooks:** 200 201 * `sie_before_import` — Fires before an import run begins 202 * `sie_after_import` — Fires after an import run completes 203 * `sie_import_row` — Filter applied to each row during processing 204 * `sie_field_mapping` — Filter applied to the field mapping configuration 205 206 **Custom Database Tables:** 207 208 * `{prefix}_sie_imports` — Import run history and metadata 209 * `{prefix}_sie_import_logs` — Per-row import log entries 210 * `{prefix}_sie_templates` — Saved field mapping templates 211 212 **Architecture:** Object-oriented with PSR-4 autoloading. No external library dependencies. 213 214 = Privacy = 215 216 Sigma ImportX Engine does not collect, transmit, or store any user data outside your own WordPress database. It does not use cookies, external analytics, or remote license checks. Uploaded import files are stored temporarily in the WordPress uploads directory and removed automatically after processing.
Note: See TracChangeset
for help on using the changeset viewer.