Service Garage Workshop Repair

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search


ServiceGarage

Overview

ServiceGarage is a Dolibarr module dedicated to automotive and two-wheel repair workshops. It extends Dolibarr with repair orders, workshop planning, technician management, VIN decoding, customer signature workflows, photo capture pages, vehicle-oriented PDF outputs, and synchronization tools with standard Dolibarr business documents.

Item Value
Module name ServiceGarage
Current documented version 2.1.6
Family CRM / Workshop / After-sales service
Editor K.S.I (K.Trc)
Editor website https://garage-atelier.serveur2ksi30.fr/
Compatibility Dolibarr 19.0 or higher
PHP requirement PHP 7.4 or higher
License GNU GPLv3

Official links


Main purpose of the module

The module is designed to let a workshop manage the full service flow around a vehicle or equipment case:

  • create and manage repair orders
  • store vehicle data such as plate number, VIN, make, model, version, mileage and first registration date
  • assign a technician and a planning slot
  • manage workshop availability and technician blocking periods
  • synchronize vehicle information into proposals, customer orders, invoices and interventions
  • collect customer signatures from a public page
  • publish terms and conditions and photo upload pages
  • manage RAN files, equipment, equipment users and materials
  • search repair orders by reference, plate number, VIN, make or model

Installation

Requirements

  • A working Dolibarr installation
  • Dolibarr 19.0+
  • PHP 7.4+
  • Write permissions on the `documents/servicegarage/` storage area

Installation steps

  1. Unzip the package so that a single `servicegarage/` directory is available at the root of the archive.
  2. Copy the directory into `htdocs/custom/` of your Dolibarr installation.
  3. Check filesystem permissions for the module document directories.
  4. Go to Home -> Setup -> Modules/Applications.
  5. Enable the module ServiceGarage.

Created storage directories

The module creates and uses dedicated data folders under Dolibarr data root:

  • `servicegarage/`
  • `servicegarage/documents/`
  • `servicegarage/documents/temp/`

Upgrade

To upgrade the module safely:

  1. Back up the database.
  2. Back up the `documents/servicegarage/` directory.
  3. Replace the files in `htdocs/custom/servicegarage/`.
  4. In Dolibarr, disable then re-enable the module so schema checks and migrations can run.

User rights and permissions

The module declares dedicated rights for:

  • reading, creating, modifying and deleting repair orders
  • workshop planning access
  • technician configuration
  • module configuration access
  • RAN reading, writing and deletion
  • equipment reading, writing and deletion
  • equipment user reading, writing and deletion
  • material reading, writing and deletion
  • mass creation tools

In practice, administrators usually grant at least:

  • repair order read/write
  • planning
  • configuration for workshop managers
  • document module rights for proposals, orders, invoices and interventions when synchronization is needed

Menus added by the module

The module adds a top menu and several left menus:

  • Repair order list
  • New repair order
  • Planning
  • RAN list and new RAN
  • Equipment list
  • Equipment users
  • Material list
  • Vehicle list by customer
  • Customer repair orders
  • Signature tracking
  • Technician list
  • Technician administration
  • Technician availability
  • Configuration
  • Vehicle categories
  • Dictionaries
  • Signature logs
  • Technical documents

It also exposes shortcuts toward native Dolibarr areas for:

  • proposals
  • customer orders
  • invoices
  • interventions

Detailed functional scope

1. Repair orders

Repair orders are the central object of the module. A repair order can store workshop and vehicle information such as:

  • repair order reference
  • third party
  • registration number
  • VIN / serial number
  • vehicle make, model, version and type
  • mileage
  • opening date
  • planned start and end dates
  • assigned technician
  • status
  • linked business documents

The repair order is the source record used to feed vehicle data into other Dolibarr documents.

2. Workshop planning

The planning screen gives a calendar view of scheduled repair orders. It is used to:

  • create a repair order from a selected time range
  • move a job in the calendar
  • unschedule an appointment
  • filter by status or technician
  • visualize customer background, technician color and blocked periods
  • detect technician conflicts and unavailable time slots
  • suggest alternative slots or other available technicians

3. Technician management

The module contains dedicated technician management tools:

  • technician directory
  • technician creation and update
  • technician availability blocks
  • conflict prevention in planning
  • optional Google calendar synchronization settings per technician

4. Document synchronization

One of the most useful features is the vehicle-information synchronization from a repair order to native Dolibarr objects.

Supported targets include:

  • proposals
  • customer orders
  • invoices
  • interventions

The module can:

  • show an import selector with recent repair orders for the same third party
  • inject vehicle extrafields into supported document cards
  • keep snapshots of synchronized data
  • update linked information when links change
  • reuse repair order data without retyping vehicle metadata manually

5. Public signature workflow

The module provides a public signature page that can be sent to the customer without requiring a Dolibarr login.

This workflow includes:

  • a secure signature link
  • a QR code to open the page on a mobile device
  • repair-order summary
  • signer name capture
  • acceptance of terms and conditions
  • finger or mouse signature pad
  • signature logs with IP, device type and timestamp
  • a completed confirmation page after signature

6. Public photo capture

The module also provides a public photo page for a case. This allows workshop staff or customers to:

  • open a dedicated public page
  • take or upload several images from a phone or tablet
  • transfer photos into the customer case folder
  • review a simple gallery linked to the case

7. VIN decoding

The VIN configuration tab allows the workshop to configure a VIN decoding provider.

Supported providers in the current code base:

  • VPIC
  • carVertical
  • Autorigin

The module can store provider URLs and API keys and offers a VIN test form in the setup page.

8. RAN management

The module contains a dedicated RAN domain. In the current implementation, a RAN acts as a unique third-party file centralizing related after-sales items.

Main points:

  • one RAN per third party
  • customer and supplier use cases
  • status history
  • linked SAV / repair-order relationships
  • deduplication tools
  • synchronization tools
  • orphan-link cleanup and diagnostics

9. Equipment, equipment users and materials

Beyond vehicle repair orders, the module also manages:

  • equipment records
  • equipment users
  • materials

This broadens the module scope toward workshop fleet or asset follow-up workflows.

Configuration pages

General tab

The general tab includes configuration for:

  • CDN usage fallback for planning assets
  • enabling or disabling the repair-order import selector
  • default planning delay in days
  • document status synchronization rules
  • menu repair tools
  • database diagnostic shortcut
  • RAN deduplication and synchronization tools

Categories tab

This tab manages vehicle categories visible in repair orders.

Dictionaries page

The dictionaries page is used to manage:

  • makes
  • models
  • versions
  • types
  • categories
  • default templates

VIN tab

This tab manages:

  • selected VIN provider
  • provider API URL
  • provider API key when needed
  • live VIN lookup test

Signature tab

This tab manages:

  • signature feature activation
  • mandatory second-step validation
  • signer role
  • access to signature logs
  • access to signature tracking

Extrafields tab

This tab is dedicated to the vehicle extrafields propagated to Dolibarr documents. It allows administrators to:

  • disable vehicle extrafields on cards
  • disable vehicle extrafields on PDFs
  • configure which fields appear on each supported document type

Voice tab

The setup code also contains voice-transcription options. Current settings include:

  • browser speech mode
  • Google speech configuration
  • OpenAI transcription configuration
  • language and prompt parameters
  • test actions in setup

Search integration

The module registers a search engine entry for repair orders. Searchable fields include:

  • repair order reference
  • registration number
  • VIN / serial number
  • make
  • model

Technical and integration notes

The current module code registers:

  • hooks across commercial document cards and list contexts
  • a dedicated trigger interface
  • CSS and JavaScript assets
  • SQL schema installation and upgrade helpers
  • snapshot storage tables for synchronized document payloads

Typical workflow

  1. Create a repair order for a customer vehicle.
  2. Fill in vehicle data and workshop notes.
  3. Assign a technician and planning slot.
  4. Generate or link related business documents.
  5. Import vehicle information into proposals, orders, invoices or interventions when needed.
  6. Send the customer signature link or QR code.
  7. Optionally collect case photos.
  8. Track signatures and linked data from administration screens.

Troubleshooting

If something does not work as expected, check the following:

  • the module is enabled
  • the user has the correct ServiceGarage rights
  • document modules such as proposals, orders, invoices or interventions are also enabled when synchronization is expected
  • Dolibarr data directories are writable
  • FullCalendar assets are available locally or via the configured fallback
  • public signature and photo pages have been deployed correctly

For administrative maintenance, the setup area also exposes:

  • menu repair
  • database diagnostics
  • RAN deduplication preview
  • RAN synchronization
  • signature logs

Support

For support, updates and related modules, refer to: