Module ProductExpiryIO: Difference between revisions
Jump to navigation
Jump to search
Mikrosha2000 (talk | contribs) (Create ProductExpiryIO module documentation page) Tag: 2017 source edit |
Mikrosha2000 (talk | contribs) |
||
| Line 1: | Line 1: | ||
= Module ProductExpiryIO = | =Module ProductExpiryIO= | ||
[[Category:Complementary modules]] | [[Category:Complementary modules]] | ||
== Introduction == | ==Introduction== | ||
'''ProductExpiryIO''' is an external Dolibarr module designed to manage important product fields in bulk using CSV import/export. | '''ProductExpiryIO''' is an external Dolibarr module designed to manage important product fields in bulk using CSV import/export. | ||
| Line 11: | Line 11: | ||
ProductExpiryIO supports simulation mode, automatic backups, backup restore, import logs, administrative audit, simulation reports and log archives. | ProductExpiryIO supports simulation mode, automatic backups, backup restore, import logs, administrative audit, simulation reports and log archives. | ||
== Main features == | ==Main features== | ||
* Export products to CSV | *Export products to CSV | ||
* Import products from CSV | *Import products from CSV | ||
* Download CSV import template | *Download CSV import template | ||
* Simulation mode before modifying product data | *Simulation mode before modifying product data | ||
* Detected changes table during simulation | *Detected changes table during simulation | ||
* Downloadable simulation report CSV | *Downloadable simulation report CSV | ||
* Automatic backup before every real import | *Automatic backup before every real import | ||
* Restore products from backup | *Restore products from backup | ||
* Automatic backup before restore | *Automatic backup before restore | ||
* Import log | *Import log | ||
* Administrative audit | *Administrative audit | ||
* Log archive system | *Log archive system | ||
* Simulation reports management | *Simulation reports management | ||
* Dashboard with module statistics | *Dashboard with module statistics | ||
* Separate user permissions | *Separate user permissions | ||
* Dolibarr menu integration | *Dolibarr menu integration | ||
== Supported product fields == | ==Supported product fields== | ||
ProductExpiryIO supports the following product fields: | ProductExpiryIO supports the following product fields: | ||
* Product code | *Product code | ||
* Product label | *Product label | ||
* Sale status | *Sale status | ||
* Purchase status | *Purchase status | ||
* Batch / serial number management | *Batch / serial number management | ||
* Mandatory sell-by / expiry date setting | *Mandatory sell-by / expiry date setting | ||
* Stock management | *Stock management | ||
* Default warehouse | *Default warehouse | ||
* Product nature | *Product nature | ||
== CSV columns == | ==CSV columns== | ||
The module uses the following CSV columns: | The module uses the following CSV columns: | ||
{| class="wikitable" | {| class="wikitable" | ||
! CSV column | !CSV column | ||
! Description | !Description | ||
|- | |- | ||
| Code | |Code | ||
| Dolibarr product reference | |Dolibarr product reference | ||
|- | |- | ||
| Label | |Label | ||
| Product label | |Product label | ||
|- | |- | ||
| Sell | |Sell | ||
| Product available for sale | |Product available for sale | ||
|- | |- | ||
| Buy | |Buy | ||
| Product available for purchase | |Product available for purchase | ||
|- | |- | ||
| BatchMode | |BatchMode | ||
| Batch or serial number management | |Batch or serial number management | ||
|- | |- | ||
| MandatoryExpiry | |MandatoryExpiry | ||
| Mandatory sell-by / expiry date setting | |Mandatory sell-by / expiry date setting | ||
|- | |- | ||
| StockManagement | |StockManagement | ||
| Product managed in stock | |Product managed in stock | ||
|- | |- | ||
| Warehouse | |Warehouse | ||
| Default warehouse code | |Default warehouse code | ||
|- | |- | ||
| Nature | |Nature | ||
| Product nature | |Product nature | ||
|} | |} | ||
== Accepted values == | ==Accepted values== | ||
{| class="wikitable" | {| class="wikitable" | ||
! Field | !Field | ||
! Accepted values | !Accepted values | ||
|- | |- | ||
| Sell / Buy / StockManagement | |Sell / Buy / StockManagement | ||
| Yes, No, 1, 0 | |Yes, No, 1, 0 | ||
|- | |- | ||
| BatchMode | |BatchMode | ||
| No, Batch, Serial, 0, 1, 2 | |No, Batch, Serial, 0, 1, 2 | ||
|- | |- | ||
| MandatoryExpiry | |MandatoryExpiry | ||
| None, SellByDate, ExpiryDate, Both, 0, 1, 2, 3 | |None, SellByDate, ExpiryDate, Both, 0, 1, 2, 3 | ||
|- | |- | ||
| Nature | |Nature | ||
| RawMaterial, FinishedProduct, Packaging, IntermediateProduct, 0, 1, 2, 3 | |RawMaterial, FinishedProduct, Packaging, IntermediateProduct, 0, 1, 2, 3 | ||
|} | |} | ||
== Recommended workflow == | ==Recommended workflow== | ||
# Export products to CSV. | #Export products to CSV. | ||
# Edit the CSV file in Excel or LibreOffice. | #Edit the CSV file in Excel or LibreOffice. | ||
# Run import in simulation mode. | #Run import in simulation mode. | ||
# Review detected changes. | #Review detected changes. | ||
# Run the real import. | #Run the real import. | ||
# Check the automatic backup and import log. | #Check the automatic backup and import log. | ||
== Backups and restore == | ==Backups and restore== | ||
Before every real import, ProductExpiryIO automatically creates a CSV backup of the previous product values. | Before every real import, ProductExpiryIO automatically creates a CSV backup of the previous product values. | ||
| Line 116: | Line 116: | ||
When restoring a backup, the module automatically creates a new backup before applying the restore. | When restoring a backup, the module automatically creates a new backup before applying the restore. | ||
== Simulation reports == | ==Simulation reports== | ||
After an import simulation with detected changes, ProductExpiryIO can create a downloadable CSV report. | After an import simulation with detected changes, ProductExpiryIO can create a downloadable CSV report. | ||
| Line 122: | Line 122: | ||
Simulation reports can be managed from the module interface. | Simulation reports can be managed from the module interface. | ||
== Import log and audit == | ==Import log and audit== | ||
The module records simulations, real imports, backup restores and administrative actions in an import log. | The module records simulations, real imports, backup restores and administrative actions in an import log. | ||
| Line 128: | Line 128: | ||
Administrative actions such as backup deletion, report deletion and log archive deletion are also recorded. | Administrative actions such as backup deletion, report deletion and log archive deletion are also recorded. | ||
== Compatibility == | ==Compatibility== | ||
{| class="wikitable" | {| class="wikitable" | ||
! Item | !Item | ||
! Value | !Value | ||
|- | |- | ||
| Dolibarr version | |Dolibarr version | ||
| V23 | |V23 | ||
|- | |- | ||
| PHP version | |PHP version | ||
| 7.2+ | |7.2+ | ||
|- | |- | ||
| Module version | |Module version | ||
| 3.18.0 | |3.18.0 | ||
|- | |- | ||
| License | |License | ||
| GPL-v3-or-later | |GPL-v3-or-later | ||
|} | |} | ||
== Installation == | ==Installation== | ||
The module can be installed from DoliStore using the Dolibarr external module deployment feature: | The module can be installed from DoliStore using the Dolibarr external module deployment feature: | ||
# Download the ZIP package from DoliStore. | #Download the ZIP package from DoliStore. | ||
# In Dolibarr, go to '''Home → Setup → Modules → Deploy an external module'''. | #In Dolibarr, go to '''Home → Setup → Modules → Deploy an external module'''. | ||
# Upload the ZIP package. | #Upload the ZIP package. | ||
# Enable the module from the module list. | #Enable the module from the module list. | ||
# Assign the required user permissions. | #Assign the required user permissions. | ||
== Permissions == | ==Permissions== | ||
ProductExpiryIO uses separate permissions: | ProductExpiryIO uses separate permissions: | ||
{| class="wikitable" | {| class="wikitable" | ||
! Permission | !Permission | ||
! Purpose | !Purpose | ||
|- | |- | ||
| View Product Expiry IO | |View Product Expiry IO | ||
| Access dashboard and export | |Access dashboard and export | ||
|- | |- | ||
| Import products Product Expiry IO | |Import products Product Expiry IO | ||
| Import, simulation and simulation reports | |Import, simulation and simulation reports | ||
|- | |- | ||
| Manage backups and logs Product Expiry IO | |Manage backups and logs Product Expiry IO | ||
| Backups, logs, archives and administrative actions | |Backups, logs, archives and administrative actions | ||
|} | |} | ||
== DoliStore == | ==DoliStore== | ||
The module is available on DoliStore: | The module is available on DoliStore: | ||
| Line 181: | Line 181: | ||
ProductExpiryIO - Product Expiry Import/Export Module for Dolibarr | ProductExpiryIO - Product Expiry Import/Export Module for Dolibarr | ||
== Author == | ==Author== | ||
Vasile Panciuc | Vasile Panciuc | ||
== Support == | ==Support== | ||
Support by email: | Support by email: mikrosha2000@gmail.com | ||
When requesting support, please include: | When requesting support, please include: | ||
* Dolibarr version | *Dolibarr version | ||
* PHP version | *PHP version | ||
* ProductExpiryIO version | *ProductExpiryIO version | ||
* Screenshots | *Screenshots | ||
* Steps to reproduce the issue | *Steps to reproduce the issue | ||
Revision as of 14:19, 5 July 2026
Module ProductExpiryIO
Introduction
ProductExpiryIO is an external Dolibarr module designed to manage important product fields in bulk using CSV import/export.
The module is useful for companies that manage many products and need a safer way to update product settings without editing every product manually.
ProductExpiryIO supports simulation mode, automatic backups, backup restore, import logs, administrative audit, simulation reports and log archives.
Main features
- Export products to CSV
- Import products from CSV
- Download CSV import template
- Simulation mode before modifying product data
- Detected changes table during simulation
- Downloadable simulation report CSV
- Automatic backup before every real import
- Restore products from backup
- Automatic backup before restore
- Import log
- Administrative audit
- Log archive system
- Simulation reports management
- Dashboard with module statistics
- Separate user permissions
- Dolibarr menu integration
Supported product fields
ProductExpiryIO supports the following product fields:
- Product code
- Product label
- Sale status
- Purchase status
- Batch / serial number management
- Mandatory sell-by / expiry date setting
- Stock management
- Default warehouse
- Product nature
CSV columns
The module uses the following CSV columns:
| CSV column | Description |
|---|---|
| Code | Dolibarr product reference |
| Label | Product label |
| Sell | Product available for sale |
| Buy | Product available for purchase |
| BatchMode | Batch or serial number management |
| MandatoryExpiry | Mandatory sell-by / expiry date setting |
| StockManagement | Product managed in stock |
| Warehouse | Default warehouse code |
| Nature | Product nature |
Accepted values
| Field | Accepted values |
|---|---|
| Sell / Buy / StockManagement | Yes, No, 1, 0 |
| BatchMode | No, Batch, Serial, 0, 1, 2 |
| MandatoryExpiry | None, SellByDate, ExpiryDate, Both, 0, 1, 2, 3 |
| Nature | RawMaterial, FinishedProduct, Packaging, IntermediateProduct, 0, 1, 2, 3 |
Recommended workflow
- Export products to CSV.
- Edit the CSV file in Excel or LibreOffice.
- Run import in simulation mode.
- Review detected changes.
- Run the real import.
- Check the automatic backup and import log.
Backups and restore
Before every real import, ProductExpiryIO automatically creates a CSV backup of the previous product values.
Backups can be downloaded, restored or deleted from the module interface.
When restoring a backup, the module automatically creates a new backup before applying the restore.
Simulation reports
After an import simulation with detected changes, ProductExpiryIO can create a downloadable CSV report.
Simulation reports can be managed from the module interface.
Import log and audit
The module records simulations, real imports, backup restores and administrative actions in an import log.
Administrative actions such as backup deletion, report deletion and log archive deletion are also recorded.
Compatibility
| Item | Value |
|---|---|
| Dolibarr version | V23 |
| PHP version | 7.2+ |
| Module version | 3.18.0 |
| License | GPL-v3-or-later |
Installation
The module can be installed from DoliStore using the Dolibarr external module deployment feature:
- Download the ZIP package from DoliStore.
- In Dolibarr, go to Home → Setup → Modules → Deploy an external module.
- Upload the ZIP package.
- Enable the module from the module list.
- Assign the required user permissions.
Permissions
ProductExpiryIO uses separate permissions:
| Permission | Purpose |
|---|---|
| View Product Expiry IO | Access dashboard and export |
| Import products Product Expiry IO | Import, simulation and simulation reports |
| Manage backups and logs Product Expiry IO | Backups, logs, archives and administrative actions |
DoliStore
The module is available on DoliStore:
ProductExpiryIO - Product Expiry Import/Export Module for Dolibarr
Author
Vasile Panciuc
Support
Support by email: mikrosha2000@gmail.com
When requesting support, please include:
- Dolibarr version
- PHP version
- ProductExpiryIO version
- Screenshots
- Steps to reproduce the issue