[ADD] Fleet: new models doc

closes odoo/documentation#9942

Signed-off-by: Lara Martini (larm) <larm@odoo.com>
This commit is contained in:
Lara Martini (larm) 2024-06-24 17:22:02 -04:00
parent 35500f8035
commit 0752255be8
5 changed files with 211 additions and 197 deletions

View File

@ -4,18 +4,17 @@
Fleet
=====
This document outlines all of the configurations and settings for the *Fleet* application, including
:ref:`settings <fleet/settings>`, :ref:`manufacturers <fleet/manufacturers>`, :ref:`vehicle models
<fleet/models>`, and :ref:`model categories <fleet/categories>`.
This document outlines the configurations and settings for the *Fleet* application, for both
:ref:`settings <fleet/settings>` and :ref:`manufacturers <fleet/manufacturers>`.
.. _fleet/settings:
Settings
========
To access the settings menu, go to :menuselection:`Fleet application --> Configuration -->
Settings`. There are only two settings that need configuration, the vehicle contract end date alert
delay, and a new vehicle request limit.
To access the settings menu, go to :menuselection:`Fleet app --> Configuration --> Settings`. Only
two settings need configuration: :guilabel:`End Date Contract Alert` and :guilabel:`New Vehicle
Request`.
.. image:: fleet/fleet-settings.png
:align: center
@ -24,9 +23,9 @@ delay, and a new vehicle request limit.
End Date Contract Alert
-----------------------
The :guilabel:`End Date Contract Alert` field defines an alert delay for the persons responsible for
vehicle contracts. The responsible person(s) will receive an email informing them a vehicle contract
is about to expire in the number of days defined in this field.
The :guilabel:`End Date Contract Alert` field how many days before the end of a vehicle contract an
alert should be sent. The responsible people receive an email informing them a vehicle contract is
about to expire in the number of days defined in this field.
.. note::
To determine who the responsible person is for a contract, open an individual contract. The
@ -65,10 +64,10 @@ Odoo *Fleet* comes pre-configured with sixty-six commonly used car and bicycle m
database, along with their logos. To view the pre-loaded manufacturers, go to :menuselection:`Fleet
app --> Configuration --> Manufacturers`.
The manufacturers appear in a list view in alphabetical order. Each manufacturer's card lists how
many specific models are configured for each particular manufacturer. Odoo comes with forty six
pre-configured :ref:`models <fleet/models>` from four major auto manufacturers and one
major bicycle manufacturer: Audi, BMW, Mercedes, Opel (cars), and Eddy Merckx (bicycle).
The manufacturers appear in an alphabetical list. Each manufacturer's card lists how many specific
models are configured for each particular manufacturer. Odoo comes with forty-six preconfigured
:doc:`models <fleet/models>` from four major auto manufacturers, and one major bicycle manufacturer:
Audi, BMW, Mercedes, Opel (cars), and Eddy Merckx (bicycle).
.. image:: fleet/manufacturer.png
:align: center
@ -82,196 +81,14 @@ Only two pieces of information are needed, the :guilabel:`Name` of the manufactu
Type the name of the manufacturer in the name field, and select an image to upload for the logo.
When the information is entered, click :guilabel:`Save`.
.. _fleet/models:
Vehicle Models
==============
Many manufacturers have a variety of models that they produce. When adding a vehicle to the fleet,
it is important to specify the vehicle model being added. Odoo comes with pre-configured car models
from four major auto manufacturers, and one pre-configured bicycle model from one bicycle
manufacturer: Audi, BMW, Mercedes, Opel (cars), and Eddy Merckx (bicycle). If a vehicle *other* than
the pre-configured models from these manufacturers are part of a fleet, the model (and/or
manufacturer) needs to be added to the database.
Preconfigured Models
--------------------
The following models are pre-loaded in Odoo and do not need to be added to the database:
+-------+--------------+-------------+-----------+---------------+
| AUDI | BMW | Eddy Merckx | Mercedes | Opel |
+=======+==============+=============+===========+===============+
| A1 | Serie 1 | SanRemo76 | Class A | Agilia |
+-------+--------------+-------------+-----------+---------------+
| A3 | Serie 3 | | Class B | Ampera |
+-------+--------------+-------------+-----------+---------------+
| A4 | Serie 5 | | Class C | Antara |
+-------+--------------+-------------+-----------+---------------+
| A5 | Serie 6 | | Class CL | Astra |
+-------+--------------+-------------+-----------+---------------+
| A6 | Serie 7 | | Class CLS | AstraGTC |
+-------+--------------+-------------+-----------+---------------+
| A7 | Serie Hybrid | | Class E | Combo Tour |
+-------+--------------+-------------+-----------+---------------+
| A8 | Serie M | | Class GL | Corsa |
+-------+--------------+-------------+-----------+---------------+
| Q3 | Serie X | | Class GLK | Insignia |
+-------+--------------+-------------+-----------+---------------+
| Q5 | Serie Z4 | | Class M | Meriva |
+-------+--------------+-------------+-----------+---------------+
| Q7 | | | Class R | Mokka |
+-------+--------------+-------------+-----------+---------------+
| TT | | | Class S | Zafira |
+-------+--------------+-------------+-----------+---------------+
| | | | Class SLK | Zafira Tourer |
+-------+--------------+-------------+-----------+---------------+
| | | | Class SLS | |
+-------+--------------+-------------+-----------+---------------+
.. _fleet/add-model:
Add a new model
---------------
New vehicle models can easily be added to the database. To add a new model, navigate to
:menuselection:`Fleet app --> Configuration --> Vehicle Models`. Click :guilabel:`Create` and a
vehicle model form will load. Enter the following information on the form, then click
:guilabel:`Save`. Be advised, some fields are specific to Belgian based companies, so not all fields
or sections may be visible depending on the location of the company.
- :guilabel:`Model name`: enter the model name in the field.
- :guilabel:`Manufacturer`: select the manufacturer from the drop-down menu. If the manufacturer is
not configured, type in the manufacturer and then click :guilabel:`Create` or :guilabel:`Create &
Edit`.
- :guilabel:`Vehicle Type`: select one of two preconfigured vehicle types, either :guilabel:`Car` or
:guilabel:`Bike`, from the drop-down menu. The vehicle types are hardcoded in Odoo and are
integrated with the *Payroll* application since vehicles can be part of an employee's benefits.
Adding additional vehicle types is not possible as it will affect payroll.
- :guilabel:`Category`: select the category the vehicle is categorized under from the drop-down
menu. To create a new category, type in the category and then click :guilabel:`Create (new
category)`.
.. note::
When the manufacturer is selected, the logo for the manufacturer will automatically load in the
image box in the top right corner.
Information tab
~~~~~~~~~~~~~~~
Model
*****
- :guilabel:`Seats Number`: enter how many passengers the vehicle can accommodate.
- :guilabel:`Doors Number`: enter the number of doors the vehicle has.
- :guilabel:`Color`: enter the color of the vehicle.
- :guilabel:`Model Year`: enter the year the vehicle was manufactured.
- :guilabel:`Trailer Hitch`: check this box if the vehicle has a trailer hitch installed.
Salary
******
.. note::
The :guilabel:`Salary` section only appears for Belgian-based companies, and only if the company
has their localization setting set to Belgium. The cost values are all **monthly** with the
exception of the :guilabel:`Catalog Value (VAT Incl.)`.
- :guilabel:`Can be requested`: check this box if employees can request this model vehicle.
- :guilabel:`Catalog Value (VAT Incl.)`: enter the :abbr:`MSRP (Manufacturer's Suggested Retail
Price)` for the vehicle at the time of purchase or lease.
- :guilabel:`C02 fee`: this value is automatically calculated based on Belgian laws and regulations,
and cannot be modified. The value is based on the value entered in the :guilabel:`CO2 Emissions`
field in the :guilabel:`Engine` section of the vehicle form.
.. important::
Modifying the :guilabel:`CO2 Emissions` field will adjust the value in the :guilabel:`CO2 fee`
field.
- :guilabel:`Cost (Depreciated)`: enter the monthly cost for the vehicle, which appears in the
salary configurator that is available to a future employee when they are offered a job position.
This value impacts the gross and net salary of the employee who is assigned to the vehicle. This
figure is depreciated over time according to local tax laws. The :guilabel:`Cost (Depreciated)`
does not depreciate automatically on the *vehicle model*, it only depreciates based on the
*contract* linked to a specific vehicle and not on the general model.
- :guilabel:`Total Cost (Depreciated)`: this value is the :guilabel:`Cost (Depreciated)` and the
:guilabel:`C02 fee` fields combined, and also is depreciated over time.
Engine
******
- :guilabel:`Fuel Type`: select the type of fuel the vehicle uses form the drop-down menu. The
options are :guilabel:`Diesel`, :guilabel:`Gasoline`, :guilabel:`Hybrid Diesel`, :guilabel:`Hybrid
Gasoline`, :guilabel:`Plug-in Hybrid Diesel`, :guilabel:`Plug-in Hybrid Gasoline`,
:guilabel:`CNG`, :guilabel:`LPG`, :guilabel:`Hydrogen`, or :guilabel:`Electric`.
- :guilabel:`CO2 Emissions`: enter the average carbon dioxide emissions the vehicle produces in
grams per kilometer (g/km). This information is provided by the car manufacturer.
- :guilabel:`CO2 Standard`: enter the standard amount of carbon dioxide in grams per kilometer
(g/km) for a similar sized vehicle.
- :guilabel:`Transmission`: select the transmission type from the drop-down menu, either
:guilabel:`Manual` or :guilabel:`Automatic`.
- :guilabel:`Power`: if the vehicle is electric or hybrid, enter the power the vehicle uses in
kilowatts (kW).
- :guilabel:`Horsepower`: enter the vehicle's horsepower in this field.
- :guilabel:`Horsepower Taxation`: enter the amount that is taxed based on the size of the vehicle's
engine. This is determined by local taxes and regulations, and varies depending on the location.
It is recommended to check with the accounting department to ensure this value is correct.
- :guilabel:`Tax Deduction`: this field auto-populates according to the engine specifications, and
cannot be modified. The percentage is based on the localization settings and local tax laws.
Vendors tab
~~~~~~~~~~~
Vehicle specific vendors, such as car dealerships, are not listed separately from other vendors. The
vendors that a vehicle can be purchased from also appear in the list of vendors used by the
*Purchase* app.
The vendor(s) the vehicle can be purchased from may be added in this tab. To add a vendor, click
:guilabel:`Add`, and a pop-up loads with a list of all the vendors currently in the database. Select
the vendor to add by clicking the checkbox next to the vendor name, then click :guilabel:`Select`.
There is no limit to the number of vendors that can be added to this list.
If a vendor is not in the database, add a vendor by clicking :guilabel:`Create`. A vendor form will
load. Enter the information in the vendor tab, then click :guilabel:`Save & Close` to add the vendor
and close the window, or :guilabel:`Save & New` to add the current vendor and create another new
vendor.
.. image:: fleet/vendor.png
:align: center
:alt: Vendor form to fill out when adding a new vendor.
.. _fleet/categories:
Model Category
==============
To best organize a fleet, it is recommended to have vehicle models housed under a specific category,
to more easily see what kinds of vehicles are in the fleet. Model categories are set on the
:ref:`vehicle model form <fleet/add-model>`.
To view all the models currently set up, navigate to :menuselection:`Fleet application -->
Configuration --> Model Category`. All models are displayed in a list view.
Add a new model category
------------------------
To add a new category, click :guilabel:`Create`. A new entry line appears at the bottom of the list.
Type in the new category, then click :guilabel:`Save` to save the entry.
To reorganize how the categories appear in the list, click on the up and down arrows to the left of
the category to be moved, and drag the line to the desired position. The order of the list does not
affect the database in any way. However, it may be preferable to view the vehicle categories in a
specific order, for example, by size, or the numbers of passengers the vehicle can carry.
.. image:: fleet/models.png
:align: center
:alt: List view of the models in the fleet.
.. seealso::
- :doc:`fleet/models`
- :doc:`fleet/new_vehicle`
- :doc:`fleet/service`
.. toctree::
:titlesonly:
fleet/models
fleet/new_vehicle
fleet/service

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

View File

@ -0,0 +1,197 @@
==============
Vehicle models
==============
When adding a vehicle to the fleet, specify the vehicle model to maintain updated records, which
keeps track of specific details, like maintenance schedules and parts compatibility.
Odoo comes with preconfigured car models from four major auto manufacturers: Audi, BMW, Mercedes,
and Opel.
If a new vehicle model joins the fleet, and it is not one of the preconfigured models from these
manufacturers, the model (and/or manufacturer) **must** be :ref:`added to the
database <fleet/add-model>`.
Preconfigured models
====================
The following models are preconfigured in Odoo, and do not need to be added to the database:
+-------+--------------+-----------+--------------+
| AUDI | BMW | Mercedes | Opel |
+=======+==============+===========+==============+
| A1 | Serie 1 | Class A | Agilia |
+-------+--------------+-----------+--------------+
| A3 | Serie 3 | Class B | Ampera |
+-------+--------------+-----------+--------------+
| A4 | Serie 5 | Class C | Antara |
+-------+--------------+-----------+--------------+
| A5 | Serie 6 |Class CL | Astra |
+-------+--------------+-----------+--------------+
| A6 | Serie 7 | Class CLS | AstraGTC |
+-------+--------------+-----------+--------------+
| A7 | Serie Hybrid | Class E | Combo Tour |
+-------+--------------+-----------+--------------+
| A8 | Serie M | Class GL | Corsa |
+-------+--------------+-----------+--------------+
| Q3 | Serie X | Class GLK | Insignia |
+-------+--------------+-----------+--------------+
| Q5 | Serie Z4 | Class M | Meriva |
+-------+--------------+-----------+--------------+
| Q7 | | Class R | Mokka |
+-------+--------------+-----------+--------------+
| TT | | Class S | Zafira |
+-------+--------------+-----------+--------------+
| | | Class SLK | Zafira Tourer|
+-------+--------------+-----------+--------------+
| | | Class SLS | |
+-------+--------------+-----------+--------------+
.. _fleet/add-model:
Add a new model
===============
To add a new vehicle model, navigate to :menuselection:`Fleet app --> Configuration --> Models:
Models`. Click :guilabel:`New`, and in a new vehicle model form, enter the following information on
the form.
.. note::
Be advised, some fields are specific to Belgian based companies, so not all fields or sections
may be visible depending on the location of the company.
- :guilabel:`Model name`: enter the model name in the field.
- :guilabel:`Manufacturer`: select the manufacturer from the drop-down menu. If the manufacturer is
not configured, type in the manufacturer, and click :guilabel:`Create` or :guilabel:`Create and
edit..`.
.. note::
When the manufacturer is selected, if it is one of the default manufacturers in *Odoo*, the
logo for the manufacturer automatically loads in the image box in the top-right corner.
- :guilabel:`Vehicle Type`: select one of two preconfigured vehicle types, either :guilabel:`Car` or
:guilabel:`Bike`, from the drop-down menu. The vehicle types are hardcoded in Odoo, and are
integrated with the *Payroll* application, since vehicles can be part of an employee's benefits.
Adding additional vehicle types is *not* possible as it affects payroll.
- :guilabel:`Category`: select a category for the vehicle from the drop-down menu. To create a new
category, type in the category and then click :guilabel:`Create (new category)`.
Information tab
---------------
In the :guilabel:`Information` tab, specify details about the car model, such as the car size,
passenger capacity, cost settings (applicable to the Belgium localization only), and engine
information.
Model section
~~~~~~~~~~~~~
- :guilabel:`Seats Number`: enter how many passengers the vehicle can accommodate.
- :guilabel:`Doors Number`: enter the number of doors the vehicle has.
- :guilabel:`Color`: enter the color of the vehicle.
- :guilabel:`Model Year`: enter the year the vehicle was manufactured.
- :guilabel:`Trailer Hitch`: tick this checkbox if the vehicle has a trailer hitch installed.
Salary section
~~~~~~~~~~~~~~
.. note::
The :guilabel:`Salary` section **only** appears for Belgian-based companies, and **only** if the
company has their localization setting set to Belgium. The cost values are all *monthly*, with
the exception of the :guilabel:`Catalog Value (VAT Incl.)`.
- :guilabel:`Can be requested`: tick this checkbox if employees can request this model vehicle, if a
vehicle is part of their employee contract.
- :guilabel:`Catalog Value (VAT Incl.)`: enter the :abbr:`MSRP (Manufacturer's Suggested Retail
Price)` for the vehicle at the time of purchase or lease.
- :guilabel:`C02 fee`: represents the carbon dioxide emission fee paid to the Belgian government.
This value is automatically calculated, based on Belgian laws and regulations, and **cannot** be
modified. The value is based on the figure entered in the :guilabel:`CO2 Emissions` field (in the
:guilabel:`Engine` section of the :guilabel:`Information` tab) on the vehicle form.
.. important::
Modifying the :guilabel:`CO2 Emissions` field adjusts the value in the :guilabel:`CO2 fee` field.
- :guilabel:`Cost (Depreciated)`: enter the monthly vehicle cost, which appears in the salary
configurator for future employees. This value impacts the gross and net salary of the employee
assigned to the vehicle. This figure is depreciated over time, according to local tax laws. The
:guilabel:`Cost (Depreciated)` does **not** depreciate automatically on the *vehicle model*, it
only depreciates based on the *contract* linked to a specific vehicle.
- :guilabel:`Total Cost (Depreciated)`: this value is the combination of the :guilabel:`Cost
(Depreciated)` and the :guilabel:`C02 fee` fields. It also depreciated over time.
Engine
~~~~~~
- :guilabel:`Fuel Type`: select the type of fuel the vehicle uses from the drop-down menu. The
options are :guilabel:`Diesel`, :guilabel:`Gasoline`, :guilabel:`Hybrid Diesel`, :guilabel:`Hybrid
Gasoline`, :guilabel:`Plug-in Hybrid Diesel`, :guilabel:`Plug-in Hybrid Gasoline`,
:guilabel:`CNG`, :guilabel:`LPG`, :guilabel:`Hydrogen`, or :guilabel:`Electric`.
- :guilabel:`CO2 Emissions`: enter the average carbon dioxide emissions the vehicle produces in
grams per kilometer (g/km). This information is provided by the car manufacturer.
- :guilabel:`CO2 Standard`: enter the standard amount of carbon dioxide in grams per kilometer
(g/km) for a similar-sized vehicle.
- :guilabel:`Transmission`: select :guilabel:`Manual` or :guilabel:`Automatic` transmission from the
drop-down menu.
- :guilabel:`Power`: if the vehicle is electric or hybrid, enter the power the vehicle uses in
kilowatts (kW).
- :guilabel:`Horsepower`: enter the vehicle's horsepower in this field.
- :guilabel:`Horsepower Taxation`: enter the amount that is taxed, based on the size of the
vehicle's engine. This is determined by local taxes and regulations, and varies depending on the
location. It is recommended to check with the accounting department to ensure this value is
correct.
- :guilabel:`Tax Deduction`: this field auto-populates, according to the engine specifications, and
**cannot** be modified. The percentage is based on the localization settings and local tax laws.
Vendors tab
-----------
Specify the vendors a vehicle can be purchased from in this tab. With proper setup, requests for
quotations for vehicles can be easily created through Odoo's *Purchase* app.
To add a vendor, click :guilabel:`Add`, which opens an :guilabel:`Add: Vendors` pop-up window, with
a list of all the vendors currently in the database. Add a vendor by ticking the checkbox next to
the vendor name, then click :guilabel:`Select`. There is no limit to the number of vendors that can
be added to this list.
If a vendor is not in the database, add a vendor by clicking :guilabel:`New` in the bottom-left of
the :guilabel:`Add: Vendors` pop-up window. In the :guilabel:`Create Vendors` form that appears,
enter the necessary information, then click :guilabel:`Save & Close` to add the vendor, or click
:guilabel:`Save & New` to add the current vendor and create another new vendor.
.. image:: models/vendor.png
:align: center
:alt: Vendor form to fill out when adding a new vendor.
.. _fleet/categories:
Model category
==============
To best organize a fleet, it is recommended to have vehicle models housed under a specific category,
to easily see what kinds of vehicles are in the fleet. Model categories are set on the :ref:`vehicle
model form <fleet/add-model>`.
Odoo does **not** come with any models preconfigured; all models **must** be added.
To view any models currently set up in the database, navigate to :menuselection:`Fleet app -->
Configuration --> Models: Categories`. All models are displayed in a list view.
Add a new model category
------------------------
To add a new category, click the :guilabel:`New` button in the top-left corner of the
:guilabel:`Categories` page. A new entry line appears at the bottom of the list. Type in the new
category, then either click :guilabel:`Save`, or click anywhere on the screen, to save the entry.
To reorganize how the categories appear in the list, click on the :icon:`oi-draggable`
:guilabel:`(draggable)` icon to the left of any desired category name, and drag the line to the
desired position.
The order of the list does not affect the database in any way. However, it may be preferable to view
the vehicle categories in a specific order, for example, by size, or the numbers of passengers the
vehicle can carry.
.. image:: models/categories.png
:align: center
:alt: List view of the models in the fleet.

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.0 KiB

View File

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 28 KiB