Skip to content

Commit

Permalink
Merge PR #148 into 18.0
Browse files Browse the repository at this point in the history
Signed-off-by max3903
  • Loading branch information
OCA-git-bot committed Oct 23, 2024
2 parents 7aacca7 + ed45689 commit e1c46cc
Show file tree
Hide file tree
Showing 60 changed files with 7,190 additions and 0 deletions.
227 changes: 227 additions & 0 deletions tms/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,227 @@
=========
Transport
=========

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:b2144995fbc4816a0cf4cd0a224ae48f0ea6da9c795b3f9592dd407235dcf7f8
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
:target: https://odoo-community.org/page/development-status
:alt: Alpha
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fstock--logistics--transport-lightgray.png?logo=github
:target: https://github.com/OCA/stock-logistics-transport/tree/18.0/tms
:alt: OCA/stock-logistics-transport
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/stock-logistics-transport-18-0/stock-logistics-transport-18-0-tms
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/stock-logistics-transport&target_branch=18.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

The Transport Management Systems (TMS) module manages the workflow of
creating transport operations within Odoo. This module provides features
such as creating teams, stages, crews, routes, and vehicles, allowing
businesses to efficiently handle various aspects of their transport
operations.

.. IMPORTANT::
This is an alpha version, the data model and design can change at any time without warning.
Only for development or testing purpose, do not use in production.
`More details on development status <https://odoo-community.org/page/development-status>`_

**Table of contents**

.. contents::
:local:

Configuration
=============

TMS module can be used with advanced configuration that enable extra
features complementing the base module.

Units of Measure
----------------

In the base module units of measure (UoM) aren't considered. They have
to be manually enabled in the settings.

1. Go to TMS > Configuration > Settings > Units
2. Activate the "Units of measure" checkbox and save the changes
3. Now UoM appear in the module in the distance, length, weight and time
fields with a default unit that is computed.
4. To change the default UoM of an specific magnitude, select the
default UoM in its corresponding measurement in the settings.

Manage teams and crews
----------------------

Team management is an advanced feature that can be configured in the TMS
module. They are a predefined group of employees that have predefined
drivers and vehicles. "Mexican Transportation Company", i.e., has the
"Mexico City Team" and "Querétaro Team" with their own vehicles and
drivers.

1. Go to TMS > Configuration > Settings > Drivers
2. Activate the "Manage Teams" checkbox and save the changes
3. Go to TMS > Configuration > Drivers > Teams
4. A default team is created. Edit this team or create a new one
5. Write the team's name, select the drivers and the vehicles
6. If it's configured, you can also select crews for this team
7. When a trip is created, you can assign the trip to an specific team.

Crew management is an advanced feature that can be configured in the TMS
module. They are a predefined group of drivers and employees in a
vehicle. An airplane, i.e., has its pilots and crew members that attend
the passengers.

1. Go to TMS > Configuration > Settings > Drivers
2. Activate the "Manage Crews" checkbox and save the changes
3. Go to TMS > Configuration > Drivers > Crews
4. Create a new crew and assign it a name
5. Select the drivers, the personnel, and a default vehicle that the
crew uses
6. When a trip is created, you can assign the trip to an specific crew

Routes and stop locations
-------------------------

Routes can be used to establish predetermined trips from one location to
another.

1. Go to TMS > Configuration > Settings > Trips
2. Activate the "Routes" checkbox and save the changes
3. Go to Master Data > Routes and create a new route
4. Write the route's name, select the origin location and select the
origin destination
5. Create a new trip and enable the "Use a predefined route" checkbox
6. Select the route you have created for the trip

When activating routes in the settings, the option for creating stop
locations in routes is enabled.

1. Go to TMS > Configuration > Settings > Trips
2. Activate the "Stops" checkbox and save the changes
3. Go to Master Data > Routes and create a new route or select and
existing one
4. Enable the "Stop locations" checkbox
5. Write the locations in the "Stop locations" page

Usage
=====

Vehicles
--------

1. Go to TMS application.
2. Go to Master Data > Vehicles in the menu.
3. Create a new vehicle with the desired model (required).
4. In the TMS page select the operation type (Cargo/Passenger).
5. Type the capacity of the vehicle.

Drivers
-------

1. Go to TMS application.
2. Go to Master Data > Drivers in the menu.
3. Create a new driver.

Locations
---------

1. Go to TMS application.
2. Go to Master Data > Locations in the menu.
3. Create a new location.

Orders
------

1. Go to TMS application.
2. Create a new trip from the dashboard.
3. Select a driver, a vehicle, an origin location and a destination
location.
4. In the planning page select the start date, the duration and the
scheduled end.
5. Once confirmed, click 'START' button to start the trip.
6. Once the trip is completed, click 'END' button to end the trip.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/stock-logistics-transport/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/stock-logistics-transport/issues/new?body=module:%20tms%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
-------

* Open Source Integrators

Contributors
------------

- Santiago Rodriguez srodriguez@opensourceintegrators.com
- Edgar Martinez emartinez@opensourceintegrators.com
- Maxime Chambreuil mchambreuil@opensourceintegrators.com
- Israel Cruz israel.cruz@argil.mx
- Alan Ramos alan.ramos@jarsa.com.mx
- Luis Triana luis.triana@jarsa.com.mx
- Sarai Osorio sarai.osorio@jarsa.com.mx
- Oscar Garza oscar.garza@jarsa.com.mx
- Hector Camacho hector.camacho@jarsa.com.mx
- Luis Miguel Guzmán miguel.ruiz@jarsa.com.mx
- Isabel Ávila isabel.esparza@jarsa.com.mx
- Erick Reza alexis.reza.s@gmail.com
- Tecnativa: \* Sergio Teruel \* Carlos Dauden

Other credits
-------------

- Open Source Integrators https://opensourceintegrators.com

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

.. |maintainer-max3903| image:: https://github.com/max3903.png?size=40px
:target: https://github.com/max3903
:alt: max3903
.. |maintainer-santiagordz| image:: https://github.com/santiagordz.png?size=40px
:target: https://github.com/santiagordz
:alt: santiagordz
.. |maintainer-EdgarRetes| image:: https://github.com/EdgarRetes.png?size=40px
:target: https://github.com/EdgarRetes
:alt: EdgarRetes

Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-max3903| |maintainer-santiagordz| |maintainer-EdgarRetes|

This module is part of the `OCA/stock-logistics-transport <https://github.com/OCA/stock-logistics-transport/tree/18.0/tms>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
1 change: 1 addition & 0 deletions tms/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import models
45 changes: 45 additions & 0 deletions tms/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Copyright (C) 2018 Open Source Integrators
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
{
"name": "Transport",
"summary": "Manage Vehicles, Drivers, Routes and Trips",
"version": "18.0.1.0.0",
"license": "AGPL-3",
"category": "TMS",
"author": "Open Source Integrators, Odoo Community Association (OCA)",
"website": "https://github.com/OCA/stock-logistics-transport",
"depends": ["base", "uom", "fleet", "base_geolocalize"],
"data": [
"data/ir_sequence_data.xml",
"data/module_category.xml",
"data/tms_stage.xml",
"data/tms_team.xml",
"data/uom_category.xml",
"security/res_groups.xml",
"security/ir.model.access.csv",
"security/ir_rule.xml",
"views/res_config_settings.xml",
"views/tms_driver.xml",
"views/res_partner.xml",
"views/fleet_vehicle.xml",
"views/tms_stage.xml",
"views/tms_order.xml",
"views/tms_team.xml",
"views/tms_crew.xml",
"views/tms_insurance.xml",
"views/tms_route.xml",
"views/menu.xml",
"views/fleet_menu.xml",
],
"demo": [
"demo/res_partner.xml",
"demo/tms_driver.xml",
"demo/tms_route.xml",
"demo/tms_order.xml",
"demo/tms_crew.xml",
"demo/tms_team.xml",
],
"application": True,
"development_status": "Alpha",
"maintainers": ["max3903", "santiagordz", "EdgarRetes"],
}
9 changes: 9 additions & 0 deletions tms/data/ir_sequence_data.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<odoo>
<record id="seq_tms_order" model="ir.sequence">
<field name="name">TMS Order</field>
<field name="code">tms.order</field>
<field name="prefix">TMS/</field>
<field name="padding">5</field>
<field name="company_id" eval="False" />
</record>
</odoo>
6 changes: 6 additions & 0 deletions tms/data/module_category.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<odoo noupdate="1">
<record id="tms" model="ir.module.category">
<field name="name">Transport Management System</field>
<field name="sequence">20</field>
</record>
</odoo>
59 changes: 59 additions & 0 deletions tms/data/tms_stage.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
<odoo noupdate="1">
<!-- TMS Default Order Stages -->
<record id="tms_stage_order_draft" model="tms.stage">
<field name="name">Draft</field>
<field name="sequence">10</field>
<field name="is_default">True</field>
<field name="stage_type">order</field>
<field name="custom_color">#ECF0F1</field>
</record>

<record id="tms_stage_order_confirmed" model="tms.stage">
<field name="name">Confirmed</field>
<field name="sequence">20</field>
<field name="is_default">True</field>
<field name="stage_type">order</field>
<field name="custom_color">#ECF0F1</field>
</record>

<record id="tms_stage_order_completed" model="tms.stage">
<field name="name">Completed</field>
<field name="sequence">30</field>
<field name="is_completed">True</field>
<field name="stage_type">order</field>
<field name="is_default">True</field>
<field name="custom_color">#1C2833</field>
</record>

<record id="tms_stage_order_cancelled" model="tms.stage">
<field name="name">Cancelled</field>
<field name="sequence">40</field>
<field name="fold">True</field>
<field name="stage_type">order</field>
<field name="is_default">True</field>
<field name="custom_color">#1C2833</field>
</record>

<!-- TMS Default Driver Stages -->
<record id="tms_stage_driver_in_base" model="tms.stage">
<field name="name">In Base</field>
<field name="sequence">10</field>
<field name="stage_type">driver</field>
<field name="is_default">True</field>
<field name="custom_color">#1C2833</field>
</record>

<record id="tms_stage_driver_in_trip" model="tms.stage">
<field name="name">In Trip</field>
<field name="sequence">20</field>
<field name="stage_type">driver</field>
<field name="custom_color">#1C2833</field>
</record>

<record id="tms_stage_driver_not_available" model="tms.stage">
<field name="name">Not Available</field>
<field name="sequence">30</field>
<field name="stage_type">driver</field>
<field name="custom_color">#1C2833</field>
</record>
</odoo>
5 changes: 5 additions & 0 deletions tms/data/tms_team.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<odoo noupdate="1">
<record id="tms_team_default" model="tms.team">
<field name="name">Default Team</field>
</record>
</odoo>
23 changes: 23 additions & 0 deletions tms/data/uom_category.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<odoo noupdate="1">
<record id="uom_category_speed" model="uom.category">
<field name="name">Speed</field>
</record>

<!-- UoM for kilometers per hour (km/h) -->
<record id="uom_kmh" model="uom.uom">
<field name="name">km/h</field>
<field name="category_id" ref="uom_category_speed" />
<field name="uom_type">reference</field>
<field name="factor">1</field>
<field name="rounding">0.01000</field>
</record>

<!-- UoM for miles per hour (mph) -->
<record id="uom_mph" model="uom.uom">
<field name="name">mph</field>
<field name="uom_type">bigger</field>
<field name="category_id" ref="uom_category_speed" />
<field name="factor">1.60934</field>
<field name="rounding">0.01000</field>
</record>
</odoo>
Loading

0 comments on commit e1c46cc

Please sign in to comment.