Maintenance Plan Fields
Maintenance plans, maintenance assets, and maintenance work rules have the following fields. Sometimes you can't see or edit certain fields because of your page layout and field-level security settings.
Required Editions
| Available in: both Salesforce Classic (not available in all orgs) and Lightning Experience |
| The Agentforce Field Service and Operations core features, managed package, and mobile app are available in Enterprise, Unlimited, and Developer Editions. |
Maintenance Plan
Maintenance plans let you define how often maintenance visits occur and mass-generate work orders for future visits. Maintenance plans can be associated with accounts, work types, assets (creating records known as maintenance assets), locations, and service contracts.
The Frequency and Frequency Type fields began their phased retirement in Summer ‘22. To prepare for this retirement and take advantage of updated features, migrate your frequency and frequency type data to maintenance work rules. The retired frequency fields impact work order generation. Complete migration as soon as possible to avoid being impacted by this change.
| Field Name | Description |
|---|---|
| Account | The associated account, which typically represents the customer receiving the maintenance service. |
| Auto-generate work orders | Turns on auto-generation of work order batches for a maintenance plan and prohibits the manual generation of work orders via the Generate Work Orders action. If this option is selected, a new batch of work orders is generated for the maintenance plan on the next suggested maintenance date* listed on each maintenance asset, or on the maintenance plan if no assets are included. If a Generation Horizon is specified, the date of generation is that many days earlier. |
| Contact | The associated contact. |
| Date of the first work order in the next batch | The suggested date of service for the first work order, not the date the work order is created. This date corresponds to the work order’s Suggested Maintenance Date. You can use this field to enforce a delay before the first maintenance visit, for example, where you want monthly maintenance to begin one year after the purchase date. For example, if you want the first maintenance visit to take place on May 1, enter May 1. When you generate work orders, the earliest work order lists a Suggested Maintenance Date of May 1. And the dates on the later work orders are based on the Generation Timeframe and Frequency settings.  Note Maintenance assets also list a date of the first work
order in the next batch, which is initially inherited from the maintenance plan. If the
plan has maintenance assets, this date auto-updates on the maintenance assets after each
batch is generated. However, it doesn’t update on the maintenance plan itself because batch
timing is calculated at the maintenance asset level. If the plan doesn’t have maintenance
assets, this date auto-updates on the maintenance plan after each batch is
generated. |
| Description | A brief description of the plan. |
| End Date | The last day the maintenance plan is valid. |
| Frequency | (Optional) Amount of time between the plan’s work orders. The unit is specified in the Frequency Type field. |
| Frequency Type | (Optional) The unit of frequency:
For example, to perform monthly maintenance visits you need a work order for each visit, so enter 1 in Frequency and select Months. |
| Generate new batch upon completion | If this option is selected, a new batch of work orders isn’t generated until the last work order generated from the maintenance plan is completed. A work order is considered completed when its status falls into one of the following status categories: Cannot Complete, Canceled, Completed, or Closed. If a maintenance plan covers multiple assets, work orders are generated per asset. If a maintenance asset’s final work order is completed late, its work order generation is delayed, which causes a staggered generation schedule between maintenance assets. |
| Generation Horizon (Days) | The next batch of work orders is generated this number of days before the maintenance plan’s Date of the first work order in the next batch. A generation horizon of 5 means that the new batch of work orders is generated 5 days before the maintenance asset’s or maintenance plan’s next suggested maintenance date*. If there are no assets, the new batch is generated on the next suggested maintenance date*. The generation horizon must be a whole number. |
| Generation Timeframe | (Required) How far in advance work orders are generated in each batch. The unit is specified in the Generation Timeframe Type field. |
| Generation Timeframe Type | (Required) The generation timeframe unit:
For example, to generate 3 months’ worth of work orders at a time, enter 3 in Generation Timeframe and select Months. |
| Location | Where the service takes place. |
| Maintenance Plan Number | (Read Only) An auto-assigned number that identifies the maintenance plan. |
| Maintenance Plan Title | A name for the maintenance plan. |
| Maintenance Window End (Days) | Days after the suggested service date on the work order that its service appointment can be scheduled. |
| Maintenance Window Start (Days) | Days before the suggested service date on the work order that its service appointment can be scheduled. The maintenance window start and end fields affect the Earliest Start Permitted and Due Date fields on the maintenance plan’s work orders’ service appointments. For example, if you enter 3 for both the maintenance window start and end, the Earliest Start Permitted and the Due Date is 3 days before and 3 days after the Suggested Maintenance Date on each work order. If the maintenance window fields are left blank, the service appointment date fields list their work order’s suggested maintenance date. |
| Owner | Maintenance plan owner. |
| Service Appointment Generation Method | How service appointments are generated when more than one asset is associated with the maintenance plan and work order generation method is One work order line item per asset. Choices are one service appointment for the parent work order or one service appointment for each work order line item. |
| Service Contract | The service contract associated with the maintenance plan. If any child maintenance asset is associated with a contract line item from the service contract, the service contract can’t be updated. |
| Start Date | The first day the maintenance plan is valid. |
| Work Order Generation Method | How work orders are generated when more than one asset is associated with the maintenance plan. Choices are one work order for each asset or one parent work order and work order line items for each asset. |
| Work Order Generation Status | (Read Only) Indicates whether work order generation is:
You can generate only one batch at a time. |
| Work Type | The associated work type. Work orders generated from the maintenance plan inherit its work type’s duration, required skills and products, and linked articles. Maintenance assets covered by the plan use the same work type, though you can update them to use a different one. |
Maintenance Asset
A maintenance asset is a part or product covered by the maintenance plan. The Assets related list on the maintenance plan lists all covered assets. An asset can be covered by multiple maintenance plans.
| Field Name | Description |
|---|---|
| Asset | Asset associated with the maintenance plan. |
| Contract Line Item | Contract line item associated with the maintenance asset. This field can only list a contract line item that is associated with the asset, and whose parent service contract is associated with the parent maintenance plan. |
| Date of the first work order in the next batch | The suggested date of service for the first work order, not the date the work order is created. This date corresponds to the work order’s Suggested Maintenance Date. If left blank when the maintenance asset is created, this field inherits its initial value from the related maintenance plan. It auto-updates after each batch is generated. |
| Maintenance Asset Number | (Read Only) An auto-assigned number that identifies the maintenance asset. |
| Maintenance Plan | Maintenance plan associated with the maintenance asset. |
| Work Type | Work type associated with the maintenance asset. Work orders generated from the maintenance plan inherit its work type’s duration, required skills and products, and linked articles. Maintenance assets covered by the plan use the same work type, though you can update them to use a different one. |
Maintenance Work Rule
A maintenance work rule is associated with a maintenance plan or maintenance asset and defines the frequency at which a maintenance task is performed on the asset. An asset can have multiple maintenance work rules.
| Field Name | Description |
|---|---|
| Date of the first work order in the next batch | The suggested date of service for the first work order, not the date the work order is created. This date corresponds to the work order’s Suggested Maintenance Date. If left blank when the maintenance rule is created, this field inherits its initial value from the related maintenance asset. It auto-updates after each batch is generated. |
| Maintenance Asset | The asset associated with the maintenance plan. |
| Maintenance Work Rule Name | (Read Only) A name assigned to this maintenance work rule in the format MWR-nnnn. |
| Maintenance Plan | Maintenance plan associated with the maintenance asset. |
| Maintenance Work Rule Title | The title of this work order rule. |
| Maintenance Work Rule Type | The type of maintenance work rule:
|
| Generate on a Floating Schedule | Generates work orders based on a floating, not fixed, cadence. Note To display this
field, from Setup enter Field Service Settings and select Update the work order
generation based on the completion date of the previous work
order. |
| Owner | The maintenance work rule owner. |
| Parent Maintenance Plan Record | The maintenance plan this work rule applies to. |
| Parent Maintenance Record | The maintenance asset this work rule applies to. |
| Recordset Filter Criteria Name | The recordset filter criteria associated with this maintenance work rule. |
| Recurrence Pattern | For calendar-based rules, how frequently the event occurs during the selected time period. Recurrence pattern is defined on Maintenance Work Rules. |
| Sort Order | The sort order that applies to this work order rule. |
| Work Type | Work type associated with the maintenance work rule. Work orders generated from the maintenance work rule inherit its work type’s duration, required skills and products, and linked articles. |
* The field label for the next suggested maintenance date on maintenance plans and maintenance assets is Date of the first work order in the next batch.
