Search 1.9 billion lines of Odoo code on GitHub
fieldservice
<h1 class="title">Field Service</h1>
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/field-service/tree/14.0/fieldservice"><img alt="OCA/field-service" src="https://img.shields.io/badge/github-OCA%2Ffield--service-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/field-service-14-0/field-service-14-0-fieldservice"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/264/14.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>This module is the base of the Field Service application in Odoo.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#configuration" id="id1">Configuration</a><ul>
<li><a class="reference internal" href="#order-stages" id="id2">Order Stages</a></li>
<li><a class="reference internal" href="#field-service-areas" id="id3">Field Service Areas</a><ul>
<li><a class="reference internal" href="#setup-a-territory" id="id4">Setup a Territory</a></li>
<li><a class="reference internal" href="#setup-branches-districts-and-regions" id="id5">Setup Branches, Districts, and Regions</a></li>
</ul>
</li>
<li><a class="reference internal" href="#advanced-configurations" id="id6">Advanced Configurations</a><ul>
<li><a class="reference internal" href="#manage-teams" id="id7">Manage Teams</a></li>
<li><a class="reference internal" href="#manage-categories" id="id8">Manage Categories</a></li>
<li><a class="reference internal" href="#manage-tags" id="id9">Manage Tags</a></li>
<li><a class="reference internal" href="#manage-order-templates" id="id10">Manage Order Templates</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#usage" id="id11">Usage</a><ul>
<li><a class="reference internal" href="#add-field-service-locations" id="id12">Add Field Service Locations</a></li>
<li><a class="reference internal" href="#add-field-service-workers" id="id13">Add Field Service Workers</a></li>
<li><a class="reference internal" href="#process-orders" id="id14">Process Orders</a></li>
</ul>
</li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id15">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id16">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id17">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id18">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id19">Contributors</a></li>
<li><a class="reference internal" href="#other-credits" id="id20">Other credits</a></li>
<li><a class="reference internal" href="#maintainers" id="id21">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<a name="configuration"></a>
<h2><a class="toc-backref" href="#id1">Configuration</a></h2>
<p>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.</p>
<a name="order-stages"></a>
<h3><a class="toc-backref" href="#id2">Order Stages</a></h3>
<p>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.</p>
<ol class="arabic simple">
<li>Go to <em>Field Service > Configuration > Stages</em></li>
<li>Create or edit a stage</li>
<li>Set the name for the stage.</li>
<li>Set the sequence order for the stage.</li>
<li>Select <em>Order</em> type to apply this stage to your orders.</li>
<li>Additonally, you can set a color for the stage.</li>
</ol>
<a name="field-service-areas"></a>
<h3><a class="toc-backref" href="#id3">Field Service Areas</a></h3>
<p>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.</p>
<a name="setup-a-territory"></a>
<h4><a class="toc-backref" href="#id4">Setup a Territory</a></h4>
<ol class="arabic simple">
<li>Go to Settings > Users & Companies > Territories*</li>
<li>Create or select a territory</li>
<li>Set the territory Name and description</li>
<li>Select or create a branch which this territory serves</li>
<li>Choose a type of zip, country whichs defines the boundary used</li>
<li>Input a list of zip codes, countries based on your desired
configuration</li>
</ol>
<a name="setup-branches-districts-and-regions"></a>
<h4><a class="toc-backref" href="#id5">Setup Branches, Districts, and Regions</a></h4>
<p>If your business requires, define your Branches, Districts, and Regions.
These are found under <em>Field Service > Configuration > Locations</em></p>
<a name="advanced-configurations"></a>
<h3><a class="toc-backref" href="#id6">Advanced Configurations</a></h3>
<p>Additional features, automations, and GeoEngine features can be enabled in
the General Settings panel for Field Service.</p>
<ol class="arabic simple">
<li>Go to <em>Field Service > Configuration > Settings</em></li>
<li>Enable additional options</li>
<li>Configure new options</li>
</ol>
<a name="manage-teams"></a>
<h4><a class="toc-backref" href="#id7">Manage Teams</a></h4>
<p>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.</p>
<ol class="arabic simple">
<li>Go to <em>Field Service > Configuration > Workers > Teams</em></li>
<li>Create or select a team</li>
<li>Set the team name, description, and sequence</li>
</ol>
<p>You can now define custom stages for each team processing orders.</p>
<ol class="arabic simple">
<li>Go to <em>Field Service > Configuration > Stages</em></li>
<li>Create or edit a stage</li>
<li>Select the teams for which this stage should be used</li>
</ol>
<a name="manage-categories"></a>
<h4><a class="toc-backref" href="#id8">Manage Categories</a></h4>
<p>Categories are used to group workers and the type of orders a worker can do.</p>
<ol class="arabic simple">
<li>Go to <em>Field Service > Configuration > Workers > Categories</em></li>
<li>Create or select a category</li>
<li>Set the name and description of category</li>
<li>Additionally, you can select a parent category if required</li>
</ol>
<a name="manage-tags"></a>
<h4><a class="toc-backref" href="#id9">Manage Tags</a></h4>
<p>Tags can be used to filter and report on field service orders</p>
<ol class="arabic simple">
<li>Go to <em>Field Service > Configuration > Orders > Tags</em></li>
<li>Create or select a tag</li>
<li>Set the tag name</li>
<li>Set a color index for the tag</li>
</ol>
<a name="manage-order-templates"></a>
<h4><a class="toc-backref" href="#id10">Manage Order Templates</a></h4>
<p>Order templates allow you to create standard templates for your orders.</p>
<ol class="arabic simple">
<li>Go to <em>Field Service > Master Data > Templates</em></li>
<li>Create or select a template</li>
<li>Set the name</li>
<li>Set the standard order instructions</li>
</ol>
<a name="usage"></a>
<h2><a class="toc-backref" href="#id11">Usage</a></h2>
<p>To use this module, you need to:</p>
<a name="add-field-service-locations"></a>
<h3><a class="toc-backref" href="#id12">Add Field Service Locations</a></h3>
<p>Locations are the specific places where a field service order is performed.</p>
<ol class="arabic simple">
<li>Go to <em>Field Service > Master Data > Locations</em></li>
<li>Create a location</li>
</ol>
<a name="add-field-service-workers"></a>
<h3><a class="toc-backref" href="#id13">Add Field Service Workers</a></h3>
<p>Workers are the people responsible for performing a field service order.
These workers may be subcontractors or a company's own employees.</p>
<ol class="arabic simple">
<li>Go to <em>Field Service > Master Data > Workers</em></li>
<li>Create a worker</li>
</ol>
<a name="process-orders"></a>
<h3><a class="toc-backref" href="#id14">Process Orders</a></h3>
<p>Once you have established your data, you can begin processing field service
orders.</p>
<ol class="arabic simple">
<li>Go to <em>Field Service > Dashboard > Orders</em></li>
<li>Create or select an order</li>
<li>Enter relevant details for the order</li>
<li>Process order through each stage as defined by your business requirements</li>
</ol>
<a name="known-issues-roadmap"></a>
<h2><a class="toc-backref" href="#id15">Known issues / Roadmap</a></h2>
<p>The roadmap of the Field Service application is documented on
<a class="reference external" href="https://github.com/OCA/field-service/issues/1">Github</a>.</p>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id16">Bug Tracker</a></h2>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/field-service/issues">GitHub Issues</a>.
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
<a class="reference external" href="https://github.com/OCA/field-service/issues/new?body=module:%20fieldservice%0Aversion:%2014.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
<a name="credits"></a>
<h2><a class="toc-backref" href="#id17">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id18">Authors</a></h3>
<ul class="simple">
<li>Open Source Integrators</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id19">Contributors</a></h3>
<ul class="simple">
<li>Wolfgang Hall <<a class="reference external" href="mailto:whall@opensourceintegrators.com">whall@opensourceintegrators.com</a>></li>
<li>Maxime Chambreuil <<a class="reference external" href="mailto:mchambreuil@opensourceintegrators.com">mchambreuil@opensourceintegrators.com</a>></li>
<li>Steve Campbell <<a class="reference external" href="mailto:scampbell@opensourceintegrators.com">scampbell@opensourceintegrators.com</a>></li>
<li>Bhavesh Odedra <<a class="reference external" href="mailto:bodedra@opensourceintegrators.com">bodedra@opensourceintegrators.com</a>></li>
<li>Michael Allen <<a class="reference external" href="mailto:mallen@opensourceintegrators.com">mallen@opensourceintegrators.com</a>></li>
<li>Sandip Mangukiya <<a class="reference external" href="mailto:smangukiya@opensourceintegrators.com">smangukiya@opensourceintegrators.com</a>></li>
<li>Serpent Consulting Services Pvt. Ltd. <<a class="reference external" href="mailto:support@serpentcs.com">support@serpentcs.com</a>></li>
<li>Brian McMaster <<a class="reference external" href="mailto:brian@mcmpest.com">brian@mcmpest.com</a>></li>
<li>Raphaël Reverdy <<a class="reference external" href="mailto:raphael.reverdy@akretion.com">raphael.reverdy@akretion.com</a>></li>
</ul>
<a name="other-credits"></a>
<h3><a class="toc-backref" href="#id20">Other credits</a></h3>
<p>The development of this module has been financially supported by:</p>
<ul class="simple">
<li>Open Source Integrators <<a class="reference external" href="https://opensourceintegrators.com">https://opensourceintegrators.com</a>></li>
</ul>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id21">Maintainers</a></h3>
<p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>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.</p>
<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainers</a>:</p>
<p><a class="reference external" href="https://github.com/wolfhall"><img alt="wolfhall" src="https://github.com/wolfhall.png?size=40px" /></a> <a class="reference external" href="https://github.com/max3903"><img alt="max3903" src="https://github.com/max3903.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/field-service/tree/14.0/fieldservice">OCA/field-service</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>