> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.kodelabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Work order integration

> Configure automatic work order generation from FDD events and track work order status through the Work Order View.

FDD can automatically generate work orders in your CMMS system when fault events are triggered. You configure work order integration through the External Data Source section in the FDD configuration page, and track all generated work orders from the Work Order View.

## Work Order View

Select `Work Order View` in the FDD sidebar to access the Generated Work Orders page. This page lists every work order that FDD has created across all routines.

<Frame caption="The Generated Work Orders page lists all work orders with sortable columns and filters">
  <img src="https://mintcdn.com/kodelabs/i9tCc_I6OZNqDXAw/images/kode-os/fdd/kode-os-fdd-work-orders-list.png?fit=max&auto=format&n=i9tCc_I6OZNqDXAw&q=85&s=6c6f8830fd8f9c9833c5cba119c29447" alt="Generated Work Orders page showing a table of work orders with columns for Title, Description, Priority, Read Back Status, Assignee, Source, Work Order Link, Work Order Type, Created At, Due Date, and Last Comment" width="1024" height="401" data-path="images/kode-os/fdd/kode-os-fdd-work-orders-list.png" />
</Frame>

The table includes the following columns:

| Column             | Description                                                                |
| ------------------ | -------------------------------------------------------------------------- |
| `Title`            | Name of the work order generated from the routine                          |
| `Description`      | Routine description associated with the work order                         |
| `Priority`         | Priority level assigned to the work order                                  |
| `Read Back Status` | Current status returned from the CMMS system (for example, Problem Solved) |
| `Assignee`         | Person or team assigned to the work order                                  |
| `Source`           | Links to the originating event                                             |
| `Work Order Link`  | Direct link to the work order in the CMMS system                           |
| `Work Order Type`  | Category of the work order (for example, Smart Device - Leak Detection)    |
| `Created At`       | Timestamp when the work order was created                                  |
| `Due Date`         | Target completion date                                                     |
| `Last Comment`     | Most recent comment on the work order                                      |

Use the search bar and `Filters` button to narrow results by any column value.

### Work order details

Select a work order row to open the details panel on the right side. The panel displays all metadata for the selected work order.

<Frame caption="Select a work order to view its full details in the side panel">
  <img src="https://mintcdn.com/kodelabs/i9tCc_I6OZNqDXAw/images/kode-os/fdd/kode-os-fdd-work-order-details.png?fit=max&auto=format&n=i9tCc_I6OZNqDXAw&q=85&s=4dc91a83e1defe560343af33824691cf" alt="Work Order View with a selected row showing the details panel with Priority, Notify Status, Read Back Status, Work Order Type, Created and Updated timestamps, Due Date, Routine, Source link to the event, Device, Area, Work Order Link, and Last Comment fields" width="1024" height="784" data-path="images/kode-os/fdd/kode-os-fdd-work-order-details.png" />
</Frame>

The details panel shows:

| Field                          | Description                                               |
| ------------------------------ | --------------------------------------------------------- |
| `Priority`                     | Priority level from the CMMS configuration                |
| `Notify Status`                | Whether the work order notification was sent successfully |
| `Read Back Status`             | Status update received from the CMMS system               |
| `Work Order Type`              | The configured work order category                        |
| `Created` / `Updated At`       | Creation and last update timestamps                       |
| `Due Date` / `Completion Time` | Target and actual completion dates                        |
| `Routine`                      | The FDD routine that generated the work order             |
| `Source`                       | Link to the originating event report                      |
| `Device` / `Area`              | The device and area associated with the fault             |

## Work orders in event reports

When you open an event report, the Work Order panel on the right side shows all work orders generated for that event. Each work order card displays its creation time, notify status, last update, sub status, and the full CMMS field mapping.

<Frame caption="The event report displays work order details alongside the fault timeline">
  <img src="https://mintcdn.com/kodelabs/SxbaONoYYoMWCQfA/images/kode-os/fdd/kode-os-fdd-event-work-order.png?fit=max&auto=format&n=SxbaONoYYoMWCQfA&q=85&s=3e937b461529d47cbe328dddafeee0e3" alt="Event report for Leak Detection showing a timeline chart with Normal and Alarm states, and a Work Order panel on the right listing Created At, Notify Status, Last Update, Sub Status, Work Order Url, Work Order Type, Data Source, Entity, Action, Title, Description, Category, Subcategory ID, and Location fields" width="1024" height="539" data-path="images/kode-os/fdd/kode-os-fdd-event-work-order.png" />
</Frame>

### Generate a work order from an event

You can manually generate a work order directly from an event report. This is useful when an event does not have a pre-configured external source or when you need to create an additional work order.

To create one work order for each of several events from the Events list, see [Create work orders per event](/products/fdd/events#create-work-orders-per-event).

<Steps>
  <Step title="Open the event report">
    Navigate to the event and open its report. The Work Order panel appears on the right side.

    <Frame>
      <img src="https://mintcdn.com/kodelabs/SxbaONoYYoMWCQfA/images/kode-os/fdd/kode-os-fdd-event-work-order-panel.png?fit=max&auto=format&n=SxbaONoYYoMWCQfA&q=85&s=ba7d0518c658d8e9cc03d24596c404b1" alt="Event report showing the Work Order panel on the right with an existing work order card and a plus button in the panel header" width="1024" height="430" data-path="images/kode-os/fdd/kode-os-fdd-event-work-order-panel.png" />
    </Frame>
  </Step>

  <Step title="Add a work order">
    Select the `+` button in the Work Order panel header. The Add Work Order dialog opens with fields for your CMMS integration.

    <Frame>
      <img src="https://mintcdn.com/kodelabs/njejy12QoNdTJ3U4/images/kode-os/fdd/kode-os-fdd-add-work-order-event.png?fit=max&auto=format&n=njejy12QoNdTJ3U4&q=85&s=4e1fd75cfbdcee75e508a32a7c511e5e" alt="Add Work Order dialog showing fields for Name, Data Source, Entity, Action, Title, Description, Category, Subcategory ID, Location, and Device Link, with dynamic variable tokens listed at the bottom" width="1024" height="647" data-path="images/kode-os/fdd/kode-os-fdd-add-work-order-event.png" />
    </Frame>

    Fill in the required fields:

    * `Name` -- a descriptive name for the work order
    * `Data Source` -- your CMMS system (for example, QR Connect API)
    * `Entity` -- the entity type (for example, WorkOrder)
    * `Action` -- the action to perform (for example, Create Work Order)
    * `Title` and `Description` -- the work order title and description
    * `Category` and `Subcategory ID` -- classification fields for your CMMS
    * `Location` and `Device Link` -- location and device reference

    Use the dynamic variable tokens at the bottom of the dialog to populate fields automatically. Select a token to insert it into the active field.
  </Step>

  <Step title="Save the work order">
    Select `Save` to generate the work order. The new work order appears in the Work Order panel and is sent to your CMMS system.
  </Step>
</Steps>

## Create work orders per event

From the [Events list](/products/fdd/events#events-list), select multiple events and use `Create Work Order` to create **one individual work order per event**. You can submit the batch as-is or step through each form before sending.

Batch-created work orders appear in the [Work Order View](#work-order-view) alongside work orders created from a single event report. For the full multi-select flow, readiness statuses (`To Be Completed`, `Ready`, `Sent`, `Not Sent`), Send Work Orders versus Review Each, and retry of incomplete items, see [Create work orders per event](/products/fdd/events#create-work-orders-per-event).

## Configure work order integration

Work order integration is configured through the External Data Source section in the FDD [configuration page](/products/fdd/configuration). You can also set an external data source on a [notification policy](/products/fdd/notification-policies). A policy-level source applies to all configurations that use that policy. A configuration-level source overrides the policy for that configuration only.

You add an external source to a routine's configuration folder, and FDD automatically generates work orders whenever that routine triggers an event.

<Steps>
  <Step title="Open the routine configuration">
    Navigate to `FDD` > `Configs` and select the routine you want to configure. You can search for the routine name in the Batch Configuration list.

    <Frame>
      <img src="https://mintcdn.com/kodelabs/SxbaONoYYoMWCQfA/images/kode-os/fdd/kode-os-fdd-config-batch-work-order.png?fit=max&auto=format&n=SxbaONoYYoMWCQfA&q=85&s=c2f692c72f95c1d1bcac52a7ffcd1c5d" alt="Batch Configuration page showing a Leak Detection routine with Enabled event status, Not Configured fault status, Critical priority, and Local source" width="1024" height="477" data-path="images/kode-os/fdd/kode-os-fdd-config-batch-work-order.png" />
    </Frame>
  </Step>

  <Step title="Navigate to External Data Source">
    Select the routine name to open the detailed configuration page. In the right panel, locate the `External Data Source` section. Select `+ Add External Source` to open the configuration dialog.

    <Frame>
      <img src="https://mintcdn.com/kodelabs/SxbaONoYYoMWCQfA/images/kode-os/fdd/kode-os-fdd-config-external-source.png?fit=max&auto=format&n=SxbaONoYYoMWCQfA&q=85&s=b5e2023485268f65f66ca7d293ff6616" alt="Configuration detail page showing Folder 1 with a device listed, and the External Data Source section in the right panel with an Add External Source button" width="1024" height="479" data-path="images/kode-os/fdd/kode-os-fdd-config-external-source.png" />
    </Frame>
  </Step>

  <Step title="Configure the external source">
    Fill in the required fields in the Add External Source dialog. Each field maps to a corresponding field in your CMMS system.

    <Frame>
      <img src="https://mintcdn.com/kodelabs/njejy12QoNdTJ3U4/images/kode-os/fdd/kode-os-fdd-add-external-source.png?fit=max&auto=format&n=njejy12QoNdTJ3U4&q=85&s=952059857dd6d082f2171fe3f851b7bf" alt="Add External Source dialog showing fields for Name, Data Source, Entity, Action, Notification, Title, Description, Category, Subcategory ID, Location, Device Link, and Priority, with dynamic variable tokens listed at the bottom" width="503" height="675" data-path="images/kode-os/fdd/kode-os-fdd-add-external-source.png" />
    </Frame>

    <ParamField path="Name" type="Field">
      A descriptive name for the external source configuration.
    </ParamField>

    <ParamField path="Data Source" type="Dropdown">
      The CMMS system to send work orders to (for example, QR Connect API).
    </ParamField>

    <ParamField path="Entity" type="Dropdown">
      The entity type in the CMMS system (for example, WorkOrder).
    </ParamField>

    <ParamField path="Action" type="Dropdown">
      The action to perform when an event triggers (for example, Create Work Order).
    </ParamField>

    <ParamField path="Notification" type="Dropdown">
      The notification type to send to the CMMS system (for example, CREATE).
    </ParamField>

    <ParamField path="Title" type="Field">
      The work order title. Use dynamic variables like `{{routines.name}}` to populate automatically.
    </ParamField>

    <ParamField path="Description" type="Field">
      A description of the work order.
    </ParamField>

    <ParamField path="Category" type="Dropdown">
      The work order category in the CMMS system (for example, Smart Device).
    </ParamField>

    <ParamField path="Subcategory ID" type="Dropdown">
      The subcategory identifier (for example, Leak Detection).
    </ParamField>

    <ParamField path="Location" type="Field">
      The location for the work order. Use `{{location}}` to populate dynamically.
    </ParamField>

    <ParamField path="Device Link" type="Field">
      A link to the device in Cloud BMS. Use `{{URL}}` to populate dynamically.
    </ParamField>

    <ParamField path="Priority" type="Field">
      The priority level for the work order in the CMMS system.
    </ParamField>

    The dialog provides dynamic variable tokens you can insert into text fields. Select any token to add it to the active field:

    | Variable                 | Description                           |
    | ------------------------ | ------------------------------------- |
    | `Routine Name`           | Name of the FDD routine               |
    | `Building`               | Building where the fault occurred     |
    | `Start Time`             | Timestamp when the event started      |
    | `View Event Link`        | Link to the event report in Cloud BMS |
    | `Priority`               | Priority level of the event           |
    | `Next Escalation`        | Next escalation step                  |
    | `Location`               | Location of the device                |
    | `Device Name`            | Name of the affected device           |
    | `Floor`                  | Floor where the device is located     |
    | `Priority Level`         | Numeric priority level                |
    | `Routine Description`    | Description of the routine            |
    | `Client Name`            | Client name                           |
    | `Point Value`            | Current value of the point            |
    | `Point Name`             | Name of the monitored point           |
    | `Acknowledge Event Link` | Link to acknowledge the event         |
    | `Event Status`           | Current status of the event           |

    Select `Save` to create the external source.
  </Step>

  <Step title="Save the configuration">
    Select `Save Folder` to save the configuration.
  </Step>
</Steps>

### Manage external sources

After creating an external source, it appears in the External Data Source section with a status indicator. Select the three-dot menu on an existing source to edit or delete it.

<Frame caption="Select the three-dot menu on an external source to edit or delete it">
  <img src="https://mintcdn.com/kodelabs/SxbaONoYYoMWCQfA/images/kode-os/fdd/kode-os-fdd-external-source-menu.png?fit=max&auto=format&n=SxbaONoYYoMWCQfA&q=85&s=0c8d11e8c9ee226654a068fc6c5d2a75" alt="External Data Source panel showing an existing source with a dropdown menu offering Edit and Delete options" width="324" height="215" data-path="images/kode-os/fdd/kode-os-fdd-external-source-menu.png" />
</Frame>

<Note>
  **Automatic vs. manual work orders** -- If you add an external source to the routine configuration, FDD automatically creates a work order every time an event is generated and closes it when the event is closed in Cloud BMS. If you create a work order from the event details after the event already exists, the work order is pushed manually at that moment. Adding an on-close action to a manually created work order closes it when that specific event is closed.
</Note>

## Next steps

<CardGroup cols={2}>
  <Card title="Events" icon="triangle-alert" href="/products/fdd/events" arrow={true}>
    Monitor and investigate real-time fault events across your building equipment.
  </Card>

  <Card title="FDD configuration" icon="cog" href="/products/fdd/configuration" arrow={true}>
    Configure routines, set thresholds, and assign priorities for your site.
  </Card>

  <Card title="Notification policies" icon="bell" href="/products/fdd/notification-policies" arrow={true}>
    Control how FDD delivers alerts through email, SMS, push, and phone calls.
  </Card>
</CardGroup>
