Search 1.9 billion lines of Odoo code on GitHub
fieldservice_recurring
<h1 class="title">Field Service Recurring Work Orders</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/15.0/fieldservice_recurring"><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-15-0/field-service-15-0-fieldservice_recurring"><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/15.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>This module allows you to manage your recurring field service work orders</p>
<p>Recurring settings are configured via the FSM Frequency model. Multiple
FSM Frequency can be combined on a FSM Frequency Rule Set which enables
highly configurable recurring rules calculated using the dateutil rrule
python library.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#installation" id="id1">Installation</a></li>
<li><a class="reference internal" href="#configuration" id="id2">Configuration</a></li>
<li><a class="reference internal" href="#usage" id="id3">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id4">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id5">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id6">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id7">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id8">Contributors</a></li>
<li><a class="reference internal" href="#other-credits" id="id9">Other credits</a></li>
<li><a class="reference internal" href="#maintainers" id="id10">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<a name="installation"></a>
<h2><a class="toc-backref" href="#id1">Installation</a></h2>
<p>To install Field Service and have the mapping features, you need to install GeoEngine.</p>
<p>Please refer to the installation instructions available at:
<a class="reference external" href="https://github.com/OCA/geospatial/tree/12.0/base_geoengine">https://github.com/OCA/geospatial/tree/12.0/base_geoengine</a></p>
<a name="configuration"></a>
<h2><a class="toc-backref" href="#id2">Configuration</a></h2>
<p>To configure this module, you need to:</p>
<ul class="simple">
<li>Setup your Frequencies to establish recurring rules</li>
</ul>
<ol class="arabic simple">
<li>In fieldservice app go to Menu > Configuration > Orders > Frequencies</li>
<li>Create a Frequency</li>
<li>Setup your Frequency by giving it a descriptive name, set your interval
and the interval type. Use the additional settings to build a recurring rule
based on python's dateutil rrule parameters.</li>
</ol>
<ul class="simple">
<li>Setup your Frequency Rule Sets used to calculate recurring order dates</li>
</ul>
<ol class="arabic simple">
<li>In fieldservice app go to Menu > Configuration > Orders > Frequency Rule Set</li>
<li>Create a Frequency Rule Set</li>
<li>Setup your Frequency Rule by first giving it a descriptive name. Complete
the form by entering the number of days ahead this rule will schedule work.</li>
<li>Finally, choose which Frequencies this rule will use to compute the dates
used for scheduling.</li>
</ol>
<ul class="simple">
<li>Setup your recurring order templates to define standard recurring orders</li>
</ul>
<ol class="arabic simple">
<li>In fieldservice app go to Menu > Configuration > Orders > Recurring Templates</li>
<li>Name the template and set fields to define which order template is repeated
and what Frequency Rule Set will be used</li>
</ol>
<a name="usage"></a>
<h2><a class="toc-backref" href="#id3">Usage</a></h2>
<p>To use this module, you need to:</p>
<ul class="simple">
<li>In fieldservice app go to Menu > Operations > Recurring Orders</li>
<li>Create a new Recurring Order model</li>
<li>Select a Recurring Template and modify as needed.</li>
<li>Set other fields for fsm location, etc</li>
<li>Confirm the recurrence to create first order</li>
<li>Future orders will be created via cron task</li>
</ul>
<a name="known-issues-roadmap"></a>
<h2><a class="toc-backref" href="#id4">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="#id5">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_recurring%0Aversion:%2015.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="#id6">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id7">Authors</a></h3>
<ul class="simple">
<li>Brian McMaster</li>
<li>Open Source Integrators</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id8">Contributors</a></h3>
<ul class="simple">
<li>Brian McMaster <<a class="reference external" href="mailto:brian@mcmpest.com">brian@mcmpest.com</a>></li>
<li>Kitti Upariphutthiphone <<a class="reference external" href="mailto:kittiu@ecosoft.co.th">kittiu@ecosoft.co.th</a>></li>
<li>Raphaël Reverdy <<a class="reference external" href="mailto:raphael.reverdy@akretion.com">raphael.reverdy@akretion.com</a>></li>
<li>Freni Patel <<a class="reference external" href="mailto:fpatel@opensourceintegrators.com">fpatel@opensourceintegrators.com</a>></li>
</ul>
<a name="other-credits"></a>
<h3><a class="toc-backref" href="#id9">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="#id10">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> <a class="reference external" href="https://github.com/brian10048"><img alt="brian10048" src="https://github.com/brian10048.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/field-service/tree/15.0/fieldservice_recurring">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>