Skip to content

Commit

Permalink
Merge PR #513 into 13.0
Browse files Browse the repository at this point in the history
Signed-off-by max3903
  • Loading branch information
OCA-git-bot committed Jun 15, 2020
2 parents 44d8fba + 59b58b6 commit 032c174
Show file tree
Hide file tree
Showing 76 changed files with 27,360 additions and 0 deletions.
242 changes: 242 additions & 0 deletions fieldservice/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,242 @@
=============
Field Service
=============

.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |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/13.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-13-0/field-service-13-0-fieldservice
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/264/13.0
:alt: Try me on Runbot

|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.

#. Go to *Field Service > Configuration > Stages*
#. Create or edit a stage
#. Set the name for the stage.
#. Set the sequence order for the stage.
#. Select *Order* type to apply this stage to your orders.
#. 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
-----------------

#. Go to Settings > Users & Companies > Territories*
#. Create or select a territory
#. Set the territory Name and description
#. Select or create a branch which this territory serves
#. Choose a type of zip, country whichs defines the boundary used
#. 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.

#. Go to *Field Service > Configuration > Settings*
#. Enable additional options
#. 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.

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

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

#. Go to *Field Service > Configuration > Stages*
#. Create or edit a stage
#. 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.

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

Manage Tags
-----------

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

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

Manage Order Templates
----------------------

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

#. Go to *Field Service > Master Data > Templates*
#. Create or select a template
#. Set the name
#. 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.

#. Go to *Field Service > Master Data > Locations*
#. 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.

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

Process Orders
~~~~~~~~~~~~~~

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

#. Go to *Field Service > Dashboard > Orders*
#. Create or select an order
#. Enter relevant details for the order
#. 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 smashing it by providing a detailed and welcomed
`feedback <https://github.com/OCA/field-service/issues/new?body=module:%20fieldservice%0Aversion:%2013.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 <[email protected]>
* Maxime Chambreuil <[email protected]>
* Steve Campbell <[email protected]>
* Bhavesh Odedra <[email protected]>
* Michael Allen <[email protected]>
* Sandip Mangukiya <[email protected]>
* Serpent Consulting Services Pvt. Ltd. <[email protected]>
* Brian McMaster <[email protected]>
* Raphaël Reverdy <[email protected]>

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

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

|maintainer-wolfhall| |maintainer-max3903|

This module is part of the `OCA/field-service <https://github.com/OCA/field-service/tree/13.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
56 changes: 56 additions & 0 deletions fieldservice/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Copyright (C) 2018 - TODAY, 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": "13.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",
"partner_fax",
],
"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/fsm_order_type.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": "Beta",
"maintainers": ["wolfhall", "max3903"],
}
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 032c174

Please sign in to comment.