---
title: "Field Service"
description: "Jobs on site. Schedule on-site jobs for customers: who does the work, where, when, which parts were used and whether the customer must sign off."
canonical: "https://obop-platform.sliplane.app/apps/field-service/"
lang: "en"
---

# Field Service

## What it is for

Schedule on-site jobs for customers: who does the work, where, when, which parts were used and whether the customer must sign off. Site addresses and contacts are personal data and treated as such.

## What the package does and does not do

On-site jobs for customers, done by a technician: scheduled, en route, in progress, done or cancelled. A job records the customer, the site, the technician, the planned day and start (minutes since midnight), the parts used and whether the customer must sign off. Site address and contact details are personal data. Needs the Human Resources and Products packages.

## Models

### `field_service_job`

An on-site job for a customer

Read group: `field_service.user`. Write group: `field_service.user`.

| Field | Kind | Data class | Personal data | Group | Agents see | Description |
|---|---|---|---|---|---|---|
| `name` | text | `none` | no | `field_service.user` | in clear | Short title of the job, for example Replace boiler pump |
| `customer_id` | ref → party | `none` | no | `field_service.user` | in clear | The customer the job is for |
| `site_name` | text | `none` | no | `field_service.user` | in clear | Name of the site, for example Main warehouse |
| `site_address` | longtext | `internal` | yes | `field_service.user` | masked | Street address where the work is done; often a person's home |
| `site_city` | text | `internal` | yes | `field_service.user` | masked | City of the site |
| `site_postcode` | text | `internal` | yes | `field_service.user` | masked | Postcode of the site |
| `site_country` | text | `none` | no | `field_service.user` | in clear | Country of the site |
| `site_contact_name` | text | `internal` | yes | `field_service.user` | masked | Name of the person to meet on site |
| `site_contact_phone` | text | `internal` | yes | `field_service.user` | masked | Phone number of the person to meet on site |
| `technician_id` | ref → hr_employee | `internal` | yes | `field_service.user` | masked | Technician assigned to the job |
| `priority` | select (low, normal, high, urgent) | `none` | no | `field_service.user` | in clear | How urgent the job is: low, normal, high, urgent |
| `description` | longtext | `none` | no | `field_service.user` | in clear | What has to be done and what the customer reported |
| `scheduled_on` | date | `none` | no | `field_service.user` | in clear | Planned day of the visit (YYYY-MM-DD) |
| `scheduled_start_minute` | number | `none` | no | `field_service.user` | in clear | Planned start in minutes since midnight (540 is 09:00) |
| `planned_minutes` | number | `none` | no | `field_service.user` | in clear | Planned duration in minutes |
| `signature_required` | bool | `none` | no | `field_service.user` | in clear | Whether the customer has to sign off the work before it counts as done |
| `signed_by` | text | `internal` | yes | `field_service.user` | masked | Name of the person who signed off the work |
| `signed_on` | date | `none` | no | `field_service.user` | in clear | Day the customer signed off (YYYY-MM-DD) |
| `work_report` | longtext | `none` | no | `field_service.user` | in clear | What was done, written by the technician |
| `state` | select (scheduled, en_route, in_progress, done, cancelled) | `none` | no | `field_service.user` | in clear | Job status: scheduled, en_route, in_progress, done, cancelled |

### `field_service_part`

A part or product used on a job

Read group: `field_service.user`. Write group: `field_service.user`.

| Field | Kind | Data class | Personal data | Group | Agents see | Description |
|---|---|---|---|---|---|---|
| `job_id` | ref → field_service_job | `none` | no | `field_service.user` | in clear | The job the part was used on |
| `product_id` | ref → product | `none` | no | `field_service.user` | in clear | The product that was used |
| `quantity` | number | `none` | no | `field_service.user` | in clear | How many units were used |
| `unit_price` | money | `none` | no | `field_service.user` | in clear | Price per unit charged to the customer (minor currency units, e.g. cents) |
| `note` | text | `none` | no | `field_service.user` | in clear | Remark about the part, for example serial number |

## Workflows

### `field_service_job`

| Action | Moves | Who may run it | Approval |
|---|---|---|---|
| `field_service_job.depart` | state: scheduled → en_route | `field_service.user` | no |
| `field_service_job.start` | state: en_route → in_progress | `field_service.user` | no |
| `field_service_job.complete` | state: in_progress → done | `field_service.user` | no |
| `field_service_job.cancel` | state: scheduled → cancelled | `field_service.manager` | no |

## Permission groups

Groups used by this app:

- `field_service.manager`
- `field_service.user`

## Approval steps

No step in this app needs an approval, apart from deleting records.

## What agents can and cannot do

An agent can read, search, create and update records of this app, and run the actions that need no approval, within the permission groups of its token.

It can only propose these steps, and a person must approve them: `field_service_job.delete`, `field_service_part.delete`.

Personal data is masked as placeholder tokens: `field_service_job.site_address`, `field_service_job.site_city`, `field_service_job.site_postcode`, `field_service_job.site_contact_name`, `field_service_job.site_contact_phone`, `field_service_job.technician_id`, `field_service_job.signed_by`.

## Dependencies

- `base`
- `product`
- `hr`

## Install

Install it from the Customize app (Marketplace), or from the command line:

```bash
obop modules install-from field_service
```

Needs a database and administrator rights.

## Build your own

[The module guide shows how apps like this one are written](/docs/reference/module-manifest/)