Skip to content

Commit

Permalink
Merge PR #1223 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 25, 2024
2 parents c0808bf + 95fe2f3 commit 61bc596
Show file tree
Hide file tree
Showing 84 changed files with 49,141 additions and 0 deletions.
257 changes: 257 additions & 0 deletions fieldservice/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,257 @@
=============
Field Service
=============

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:6dab6445b1c6fcb5d5db979501fefb12597c270a914d89918eb91f895168776c
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
:target: https://odoo-community.org/page/development-status
:alt: Production/Stable
.. |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%2Ffield--service-lightgray.png?logo=github
:target: https://github.com/OCA/field-service/tree/18.0/fieldservice
:alt: OCA/field-service
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/field-service-18-0/field-service-18-0-fieldservice
: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/field-service&target_branch=18.0
:alt: Try me on Runboat

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

This module is the base of the Field Service application in Odoo.

**Table of contents**

.. contents::
:local:

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

The base Field Service module can be used with minimal initial
configuration. It also allows for many advanced features, which require
a more in-depth configuration.

Order Stages
------------

The stage of an order is used to monitor its progress. Stages can be
configured based on your company's specific business needs. A basic set
of order stages comes pre-configured for use.

1. Go to *Field Service > Configuration > Stages*
2. Create or edit a stage
3. Set the name for the stage.
4. Set the sequence order for the stage.
5. Select *Order* type to apply this stage to your orders.
6. Additonally, you can set a color for the stage.

Field Service Areas
-------------------

You can manage designated areas or locales for your field service
workers, salesmen, and other resources. For example, salesmen may serve
a particular Territory. There may be multiple Territories served by a
single Branch office location. Multiple Branches are managed within a
District and these Districts are managed under an encompassing Region.

Setup a Territory
~~~~~~~~~~~~~~~~~

1. Go to Settings > Users & Companies > Territories\*
2. Create or select a territory
3. Set the territory Name and description
4. Select or create a branch which this territory serves
5. Choose a type of zip, country whichs defines the boundary used
6. Input a list of zip codes, countries based on your desired
configuration

Setup Branches, Districts, and Regions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If your business requires, define your Branches, Districts, and Regions.
These are found under *Field Service > Configuration > Locations*

Advanced Configurations
-----------------------

Additional features, automations, and GeoEngine features can be enabled
in the General Settings panel for Field Service.

1. Go to *Field Service > Configuration > Settings*
2. Enable additional options
3. Configure new options

Manage Teams
~~~~~~~~~~~~

Teams can be used to organize the processing of field service orders
into groups. Different teams may have different workflows that a field
service order needs to follow.

1. Go to *Field Service > Configuration > Workers > Teams*
2. Create or select a team
3. Set the team name, description, and sequence

You can now define custom stages for each team processing orders.

1. Go to *Field Service > Configuration > Stages*
2. Create or edit a stage
3. Select the teams for which this stage should be used

Manage Categories
~~~~~~~~~~~~~~~~~

Categories are used to group workers and the type of orders a worker can
do.

1. Go to *Field Service > Configuration > Workers > Categories*
2. Create or select a category
3. Set the name and description of category
4. Additionally, you can select a parent category if required

Manage Tags
~~~~~~~~~~~

Tags can be used to filter and report on field service orders

1. Go to *Field Service > Configuration > Orders > Tags*
2. Create or select a tag
3. Set the tag name
4. Set a color index for the tag

Manage Order Templates
~~~~~~~~~~~~~~~~~~~~~~

Order templates allow you to create standard templates for your orders.

1. Go to *Field Service > Master Data > Templates*
2. Create or select a template
3. Set the name
4. Set the standard order instructions

Usage
=====

To use this module, you need to:

Add Field Service Locations
---------------------------

Locations are the specific places where a field service order is
performed.

1. Go to *Field Service > Master Data > Locations*
2. Create a location

Add Field Service Workers
-------------------------

Workers are the people responsible for performing a field service order.
These workers may be subcontractors or a company's own employees.

1. Go to *Field Service > Master Data > Workers*
2. Create a worker

Process Orders
--------------

Once you have established your data, you can begin processing field
service orders.

1. Go to *Field Service > Dashboard > Orders*
2. Create or select an order
3. Enter relevant details for the order
4. Process order through each stage as defined by your business
requirements

Known issues / Roadmap
======================

The roadmap of the Field Service application is documented on
`Github <https://github.com/OCA/field-service/issues/1>`__.

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

Bugs are tracked on `GitHub Issues <https://github.com/OCA/field-service/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/field-service/issues/new?body=module:%20fieldservice%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
------------

- Wolfgang Hall <whall@opensourceintegrators.com>
- Maxime Chambreuil <mchambreuil@opensourceintegrators.com>
- Steve Campbell <scampbell@opensourceintegrators.com>
- Bhavesh Odedra <bodedra@opensourceintegrators.com>
- Michael Allen <mallen@opensourceintegrators.com>
- Sandip Mangukiya <smangukiya@opensourceintegrators.com>
- Serpent Consulting Services Pvt. Ltd. <support@serpentcs.com>
- Brian McMaster <brian@mcmpest.com>
- Raphaël Reverdy <raphael.reverdy@akretion.com>
- Ammar Officewala <ammar.o.serpentcs@gmail.com>
- Yves Goldberg <yves@ygol.com>
- Freni Patel <fpatel@opensourceintegrators.com>
- `Tecnativa <https://www.tecnativa.com>`__:

- Víctor Martínez

- Nils Coenen <nils.coenen@nico-solutions.de>
- Alex Comba <alex.comba@agilebg.com>

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

The development of this module has been financially supported by:

- 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-brian10048| image:: https://github.com/brian10048.png?size=40px
:target: https://github.com/brian10048
:alt: brian10048

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

|maintainer-max3903| |maintainer-brian10048|

This module is part of the `OCA/field-service <https://github.com/OCA/field-service/tree/18.0/fieldservice>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
4 changes: 4 additions & 0 deletions fieldservice/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).

from . import models
from . import wizard
53 changes: 53 additions & 0 deletions fieldservice/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Copyright (C) 2018 Open Source Integrators
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
{
"name": "Field Service",
"summary": "Manage Field Service Locations, Workers and Orders",
"version": "18.0.1.0.0",
"license": "AGPL-3",
"category": "Field Service",
"author": "Open Source Integrators, Odoo Community Association (OCA)",
"website": "https://github.com/OCA/field-service",
"depends": ["base_territory", "base_geolocalize", "resource", "contacts"],
"data": [
"data/ir_sequence.xml",
"data/mail_message_subtype.xml",
"data/module_category.xml",
"data/fsm_stage.xml",
"data/fsm_team.xml",
"security/res_groups.xml",
"security/ir.model.access.csv",
"security/ir_rule.xml",
"report/fsm_order_report_template.xml",
"views/res_config_settings.xml",
"views/res_territory.xml",
"views/fsm_stage.xml",
"views/fsm_tag.xml",
"views/res_partner.xml",
"views/fsm_location.xml",
"views/fsm_location_person.xml",
"views/fsm_person.xml",
"views/fsm_order.xml",
"views/fsm_order_type.xml",
"views/fsm_category.xml",
"views/fsm_equipment.xml",
"views/fsm_template.xml",
"views/fsm_team.xml",
"views/menu.xml",
"wizard/fsm_wizard.xml",
],
"demo": [
"demo/fsm_demo.xml",
"demo/fsm_equipment.xml",
"demo/fsm_location.xml",
"demo/fsm_person.xml",
],
"application": True,
"development_status": "Production/Stable",
"maintainers": ["max3903", "brian10048"],
"assets": {
"web.assets_backend": [
"fieldservice/static/src/scss/team_dashboard.scss",
]
},
}
26 changes: 26 additions & 0 deletions fieldservice/data/fsm_stage.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<odoo noupdate="1">
<record id="fsm_stage_new" model="fsm.stage">
<field name="name">New</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="fsm_stage_completed" model="fsm.stage">
<field name="name">Completed</field>
<field name="sequence">80</field>
<field name="stage_type">order</field>
<field name="is_closed">True</field>
<field name="is_default">True</field>
<field name="custom_color">#7F8C8D</field>
</record>
<record id="fsm_stage_cancelled" model="fsm.stage">
<field name="name">Cancelled</field>
<field name="sequence">100</field>
<field name="fold">True</field>
<field name="stage_type">order</field>
<field name="is_closed">True</field>
<field name="is_default">True</field>
<field name="custom_color">#1C2833</field>
</record>
</odoo>
5 changes: 5 additions & 0 deletions fieldservice/data/fsm_team.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<odoo noupdate="1">
<record id="fsm_team_default" model="fsm.team">
<field name="name">Default Team</field>
</record>
</odoo>
10 changes: 10 additions & 0 deletions fieldservice/data/ir_sequence.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<odoo noupdate="1">
<!-- Sequence for fsm.order -->
<record id="seq_fsm_order" model="ir.sequence">
<field name="name">FSM Order</field>
<field name="code">fsm.order</field>
<field name="prefix">FO</field>
<field name="padding">3</field>
<field name="company_id" eval="False" />
</record>
</odoo>
Loading

0 comments on commit 61bc596

Please sign in to comment.