Dolibarr ERP CRM Wiki

Label Designer

Label Designer User Guide

Module version: 1.0.0
Declared compatibility: Dolibarr 15.0+, PHP 7.1+
Last documentation review: 2026-09-30

Demo video:

Demo site: Open the demo site

Publisher website: 01consulting.eu

This guide describes, step by step, how to install, configure, and use Label Designer 1.0.0 for Dolibarr.

1. Module overview

Label Designer lets you visually create label templates and generate PDF files using data stored in Dolibarr.

The module supports four object types:

  • products and services;
  • product batches;
  • warehouses;
  • third parties (customers and suppliers).

One template is created for each object type and reused automatically. You do not need a separate label for every product, batch, warehouse, or third party. When a PDF is generated, template variables are replaced with the current object's data.

2. Requirements

Before installation, check that:

  • Dolibarr 15 or later is installed;
  • PHP 7.1 or later is available;
  • Dolibarr's Barcodes module is available;
  • the web server can write to the Dolibarr documents directory.

3. Installation and activation

  1. Copy the labeldesigner directory to htdocs/custom/.
  2. Sign in to Dolibarr with an administrator account.
  3. Go to Home > Setup > Modules/Applications.
  4. Find Label Designer.
  5. Enable the module.
  6. Make sure the Barcodes module is also enabled.

When activated, Label Designer prepares its storage directory in Dolibarr documents and enables barcode use for products and third parties.

4. Configure user permissions

  1. Open the relevant user or group record.
  2. Open the Permissions tab.
  3. Grant the required Label Designer permissions:
    • read labels;
    • create and modify templates and PDFs.
  4. Make sure the user can also view the relevant object: product, batch, warehouse, or third party.

Without permission to view the object, some data or variables may not be available.

After an update that adds or changes module permissions, disable and re-enable Label Designer so Dolibarr registers the new permissions. You can then grant Read labels and Create labels separately to users and groups.

5. Open a label

  1. Open a product, batch, warehouse, or third-party record.
  2. Click the Label tab provided by Label Designer.
  3. The page displays:
    • label settings;
    • the Card Designer button;
    • the Reset settings button;
    • the generated PDF files area;
    • the Generate button.

If another module also adds a tab named Label, identify the Label Designer tab by its URL or content.

6. Set label parameters

Settings are stored separately for each object type.

SettingPurpose
Document widthFinal label width, in millimeters
Document heightFinal label height, in millimeters
Barcode widthBarcode width in the template and PDF
Barcode heightBarcode height in the template and PDF
Bar widthVisual bar thickness, from 0.2 to 1.0 mm
Pixel sizeQR code image resolution, from 32 to 2048 pixels; default: 250
Show barcode valueShows or hides the text below the barcode
Labels horizontallyNumber of copies placed horizontally in the final PDF
Labels verticallyNumber of copies placed vertically in the final PDF

To change a value:

  1. Click the pencil icon.
  2. Enter the new value.
  3. Confirm the change.

Barcode and QR code dimensions are synchronized with the Card Designer template. Changing them in the settings updates the template; changing their size in Card Designer also updates the related settings.

The Reset settings button restores the defaults for the displayed object type.

7. Create a template in Card Designer

The supplied templates are empty so that users can create their own labels.

  1. On the Label tab, set the document width and height first.
  2. Click Card Designer.
  3. Use the toolbar to add the elements you need:
    • Shapes to add graphical shapes;
    • Text to add free text;
    • Variables to add dynamic Dolibarr data;
    • Photos to use an uploaded image;
    • Stickers to add a decorative element;
    • Color to change an element's color;
    • Align to position elements;
    • Delete to remove the selected element.
  4. Move and resize each element directly on the canvas.
  5. Click Save.
  6. Confirm the save.

Saving creates only the JSON template; it does not generate a PDF. After confirmation, Card Designer returns to the object record.

8. Add dynamic variables

In Card Designer, click Product variables, Batch variables, Warehouse variables, or Third-party variables, depending on the open object. Then click a variable to add it to the template.

8.1. Product variables

The main available variables are:

  • reference;
  • label;
  • description;
  • price excluding tax;
  • price including tax;
  • VAT rate;
  • category;
  • barcode;
  • QR code;
  • product extra fields.

Prices and the VAT rate are formatted with two decimal places.

8.2. Batch variables

The main available variables are:

  • batch reference;
  • linked product reference;
  • product label;
  • product description;
  • use-by date (DLC);
  • best-before date (DMD/DLUO);
  • barcode generated from the batch reference;
  • QR code generated from the batch reference;
  • batch extra fields.

8.3. Warehouse variables

The main available variables are:

  • reference;
  • label;
  • description;
  • location and address;
  • postal code and city;
  • linked project, project reference and title;
  • categories or tags;
  • barcode generated from the warehouse reference;
  • QR code generated from the warehouse reference;
  • warehouse extra fields.

8.4. Third-party variables

The main available variables are:

  • third-party name;
  • customer code;
  • supplier code;
  • address, postal code, and city;
  • email address and phone number;
  • barcode;
  • QR code;
  • third-party extra fields.

8.5. Extra fields

Extra fields configured in Dolibarr are automatically added to the variables for that object. Their technical names are associated with readable labels in Card Designer.

If an extra field is empty for the current object, its placeholder may still appear in Card Designer, but no value is printed in the PDF.

9. Use barcodes and QR codes

Products and third parties

The barcode and QR code are available only when:

  • the Barcodes module is enabled;
  • barcode use is enabled for the relevant object type in Dolibarr setup;
  • the object has a barcode value.

If a product or third party has no barcode, Card Designer may show the variable name as a placeholder, but no fictitious code is printed in the PDF.

Batches and warehouses

The barcode and QR code use the batch or warehouse reference. If the reference is empty, the corresponding area in the PDF is blank.

QR code pixel size

Pixel size controls the resolution of the generated QR code image. A higher value improves sharpness when enlarged but increases the data size. The default value of 250 is suitable for most labels.

10. Upload and use photos

  1. In Card Designer, click Photos.
  2. An upload QR code appears.
  3. Scan it with a phone or open the upload page directly.
  4. Select PNG, JPG, or JPEG images to upload.
  5. Confirm the upload.
  6. Return to Card Designer and reopen the Photos library if needed.
  7. Click the photo to insert it into the label.
  8. Move and resize the image, then save the template.

The upload page only sends files. Photo layout is done afterward in Card Designer.

11. Generate the PDF

  1. Open the record to print.
  2. Go to its Label tab.
  3. Check the settings and object data.
  4. Click Generate.
  5. The module loads the template for that object type.
  6. Variables are replaced with the current object's data.
  7. The PDF is generated with Fabric.js and jsPDF.
  8. The file appears in the Attached files area.
  9. Click the PDF name or preview icon to view it.

The same template can generate labels for multiple objects in succession. The horizontal and vertical label counts apply only to the final PDF, repeating the label without changing the Card Designer template.

12. Modify an existing template

  1. Open any object of the relevant type.
  2. Go to its Label tab.
  3. Click Card Designer.
  4. Edit the template.
  5. Click Save and confirm.
  6. Generate the PDF again.

The change applies to future labels of the same type. Previously generated PDFs are not updated automatically.

13. Configure Bluetooth printing

The Home > Setup > Modules/Applications > Label Designer page has two options:

  • Labeldesigner on Bluetooth printer: enables the features intended for Bluetooth printing;
  • Replace accented characters on Bluetooth printers: replaces characters that some printers cannot print correctly.

Bluetooth printing is disabled by default. The second option is useful only when the first is enabled and the printer has trouble with accented characters.

14. Design tips

  • Set the document dimensions before starting the layout.
  • Leave a margin around the label to avoid print cutoffs.
  • Do not stretch a barcode or QR code excessively.
  • Print a test and check that scanners can read the codes.
  • Use clear images without unnecessarily high resolution.
  • Leave enough room for variables whose length changes between objects.
  • Save the template before leaving Card Designer.

15. Troubleshooting

The Save button returns an HTTP 500 error

Check that the web server can write to the Dolibarr documents directory, especially the folder reserved for Label Designer templates. Disabling and re-enabling the module may recreate the required folder. Also check the PHP or web server log for the exact message.

The PDF is blank

Check that a template containing elements has been saved for this object type. Templates installed by default are intentionally empty.

A variable appears in Card Designer but is missing from the PDF

Check that the field is populated on the object used to generate the PDF. An empty variable is not replaced with a fictitious value.

Extra fields are not visible

Check that extra fields are enabled for the correct object type and that the user has the required permissions. Reload Card Designer after adding a new field.

The barcode or QR code is unavailable

For a product or third party, check that the Barcodes module is enabled, barcode use is enabled for that object type, and the record has a value. For a batch or warehouse, check that its reference is not empty.

A size change does not seem to apply

Save the value, reload Card Designer if it was already open, then generate a new PDF. Make sure you are viewing the latest file.

The page shows an old version

Hard-refresh the browser page. If needed, clear the Dolibarr and browser caches.

16. Storage and backups

Card Designer templates are stored as JSON files in the module's directory under Dolibarr documents. Generated PDFs are stored with the documents associated with each object.

To back up the module configuration, include the following in your backup plan:

  • the Dolibarr database;
  • the Dolibarr documents directory;
  • the Label Designer module directory.

Do not manually edit JSON files while a user is working in Card Designer.

17. Support

When requesting help, provide the module and Dolibarr versions, the steps to reproduce the issue, and the error message with sensitive data removed. Contact support at contact@01consulting.eu. Publisher website: 01consulting.eu.

Retrieved from "https://wiki.dolibarr.org/index.php?title=Label_Designer&oldid=67552"