How You Create a Work Requirement

In the edit mode of a maintenance program, you can manage the work requirements on the Work Requirements tab. Here you can create, view, edit, and delete the work requirements associated with the maintenance program. Each work requirement row will include a reference to the asset or item that's affected, along with indicators about the forecast methods being used. You can edit, but not delete an existing work requirement after the first work order is created for the work requirement. Optionally, you can end date a requirement to stop forecasting.

The page includes a Query-by-example (QBE) search option. When you click the QBE icon, it reveals a search bar where you can search the list of requirements by certain columns. Optionally, you can also click on certain columns to sort the results rows ascending or descending by value.

For Each Asset Region

In the For Each Asset region, you can define the work requirement details and related attributes.

Field	Description
Name	Name of the work requirement. The name must be unique across all maintenance programs, regardless of maintenance organization.
Requirement Reference	Optional reference for a work requirement. For example, an OEM repair manual reference or a subscription line unique identifier.
Type	Type of the work requirement. The valid values are: Asset and Item.
Asset or Item	Name of asset or item that defines the one or many affected assets for the work requirement. By default, the type is set to Asset. Therefore, you can search for and select an asset that's operating in the contextual organization. If you change the type to Item, the field changes from an asset picker to an item picker, allowing you to search for and select an item that's setup for the organization. Note: The forecast and resulting preventative maintenance work orders is always for the selected asset and doesn’t apply to any parent or child assets in a physical hierarchy
Description	Description of the asset or item that's selected. This is a read-only description of the asset or item that's selected.
Include Assets	This drop-down list appears only when the type you select is Item. The options are: Automatically include assets (default): The default option Automatically include assets considers all the assets for the item as included in the forecast. You can then individually exclude them from the forecast in the Affected Assets page. Manually include assets: If you select the option to Manually include assets, then no assets for the item are considered by the forecast. You can then individually include them in the forecast in the Affected Assets page.
Status	Status of the work requirement that's used to indicate if adequate attributes are defined for the work requirement to generate a forecast. The values are: Draft Active Upon creation, the status is set to Draft. After you have defined and the header, forecast method, and work definitions, it moves to a status of Active and is ready to be forecasted upon saving. If you provide all the attributes for the work requirement to generate a forecast then it will set directly to Active. Note: When the end date of a requirement is reached, it won't be considered by the preventive maintenance forecast scheduled process. However, the status of the work requirement will remain as Active. Note: It's recommended to create work requirements using the REST API by passing a complete payload of the required parent and child resources, as shown in the Use Case examples. This practice ensures that the system can validate the necessary definitions required to set the work requirement status to Active, allowing it to be forecasted.
Start Date	Date on which the work requirement becomes active. Forecasted due dates begin on this date and into the future. The Start Date is used to determine when a work requirement is considered by the forecast program and will begin calculating from this date into the future. This date can be in the past, present or in the future and will control the first due date in the forecast, as well as its sequence of due dates into the future within the forecast horizon number of days window. If set to a date in the past or present, then the forecast will be calculated from this point in time based on the forecast method. For a cycle of intervals, this provides the ability to control the first due interval in a cycle in the present or future. For a past date, it will calculate the forecast sequence starting on the past date; however, it will only reflect the next due dates starting from the application date into the future. The forecast will never produce due dates less than the application date. If set to a date in the future, then the work requirement will not be considered by the forecast program until this date. As of this date, or the next time in the future in which the forecast is regenerated, the due dates will be created within the horizon timeframe into the future. During setup and confirmation of your work requirement model, you can adjust the start date and regenerate the forecast. This will provide the ability to confirm the forecast method and most importantly confirm the first due date in the future in which you expect a work order to be created. When the first work order is created based off these dates, if you adjust the start date to another date in the past will not have any impact on your future forecast. The forecast will always stay on its original sequence based of the original Start Date. If you adjust the start date to a future value, then the work requirement will no longer be considered by the forecast. If you are using a cycle of intervals, then intervals that are due from the present to the future will be skipped when the forecast is regenerated. Therefore, it is generally recommended to End Date a requirement and create a new requirement to start again in the future. Note: When using a calendar pattern and cycle of intervals, if the Start Date falls on the first iteration in the future of the calendar pattern, then it's considered as interval 1 of the cycle. However, for a day or meter-based forecast, interval 1 is calculated as due from the start date.
End Date	Date on which the work requirement becomes inactive. The work requirement will no longer be considered by the forecast program.
Work Orders Created	Indicator showing whether work orders have been created based on the forecast of the work requirement.
Affected Assets	Clicking the icon navigates you to the Affected Assets page for both an asset and item-based requirement. The page displays the list of assets applicable for the work requirement

Affected Assets Page

This page lists all the assets applicable for the work requirement. For an asset-based requirement, there's a single row. For an item-based requirement, there's a list of every asset based on that item for an organization that's maintainable. The page will include a Query-by-example (QBE) search option. When the QBE icon is clicked, it reveals a search bar where you can search the list of assets by certain columns. Optionally, you can also click on certain columns to sort the results rows ascending or descending by value.

For each asset, this page lists:

Asset details, including ability to create work orders
Indicator if work orders have been created by this work requirement
Work Order Creation option: defaults from the work requirement but you can update it for each asset.
Historical completion, interval and start date definition fields
Forecast details, including last completion and next due dates with intervals

For an item-based requirement, if the Include Assets attribute is set to Automatically include assets, then rendering the Affected Assets page shows each asset as implicitly included in the forecast with a status shown as a green check mark. Alternatively, if you select the option Manually include assets, then each asset is displayed with a gray check mark, indicating they are implicitly excluded in the forecast. It’s important to set this option during the initial creation of the requirement and before assets are explicitly included or excluded, and before Historical completion, interval, and start date values are entered for the asset. If you change the option, any explicit exclusion or inclusion of assets ais reversed and you must regenerate the forecast. We recommend you don’t change this option after work orders are created.

The Automatically include assets option should be used when you expect most or all the assets for an item to be forecasted in the same work requirement. This also means that any new asset that's created is also implicitly included and considered by the forecast. You can then explicitly exclude only certain assets from the affected list of assets. The Exclude All option is available but should be used with caution. The Include All option is also available and is typically used to reverse all the previously explicitly excluded assets. This means the assets will return to being implicitly included. If you want to exclude all the assets and start from scratch by explicitly including only certain assets, it's a better practice to change the Include Assets option to Manually include assets.

The Manually include assets option should be used if you want to explicitly define which assets are included in the forecast. This means that the work requirement doesn't consider any of the assets based on that item by default, as they're each implicitly excluded. You can see the list of assets on the affected items page and each asset has a status set as a gray check mark, indicating they aren't included in the forecast. You can explicitly include the assets that you want to forecast by selecting one or more rows and clicking the Include action button. The status icon will change to a green check mark, indicating they're considered by the forecast. For assets that were previously included, you can choose to exclude them by clicking the Exclude action button, and their status turns gray again. This means the asset returns to being implicitly excluded. You can also use the Include All and Exclude All action buttons. If you want to include all the assets and start from scratch by explicitly excluding only certain assets, it's a better practice to change the Include Assets option to Automatically include assets.

After you have decided which assets will be forecasted, you can define how the first due date will be calculated for each asset. You can do so for both asset and item-based work requirements and is helpful during initial implementation of a work requirement as well as the introduction of new affected assets in the future.

For each asset row that has a green checkmark, these fields are editable if work orders aren't created yet for an asset in this work requirement:

Historical Last Completed Date: You can optionally enter in the last time similar maintenance was accomplished from an external application. This date is considered by the forecast and works in coordination with the start date to calculate the first due for an asset. You can only enter a value that's less than the application date and you must enter a date if the Last Interval is defined.
Historical Last Interval: Only applicable if the work requirement is cycle-based with intervals. This is the interval at which you last completed maintenance as of the Last Completed Date. You must enter an interval if the Last Completed Date is defined for a cycle-based requirement.
Forecast Start Date: You can optionally define a Start Date that's before, equal to or later than the work requirement start date. If defined, it supersedes the work requirement start date. Remember that the start date determines when the forecast begins calculating and if the date is in the future, the forecast doesn't have any due dates before that date. If the Start date is defined along with the Last Completed Date, then the Last Completed date takes precedence and is used to anchor the start of the forecast and begin its calculations.

When the first forecast is run, you see values in the Forecast Next Due (date) and Interval columns. This helps validate if the forecast method and definition is meeting the expected due date for each asset. You can then adjust the Work Requirement start date, Last Completed Date, Last Interval and Forecast Start (date) values as needed to refine the forecast before the first work order is created for an asset in the work requirement. Once this even occurs, you can no longer adjust these fields and adjust the forecast of the first due date. In the future, once work orders are completed, you see values in the Forecast Last Completed and Forecast Last interval columns, providing asset level forecast details.

You can also change methods from Automatically include assets to Manually include assets. When changing methods, you're presented a click-through validation message. If you click yes, then any changes you have made in the Affected Assets page is lost and you reset all the included and excluded assets actions and any historical data entry values when you click save. If you click no, or don't save the changes, then the changes aren't committed.

Generate a Forecast Region

In the Generate a Forecast region, you can define a forecast for the work requirement.

Field	Description
Forecast using a cycle	Option to define whether the work requirement is to be forecasted based on the intervals in a cycle, Forecast Start (Date) - you can optionally define a Start Date that's before, equal to or later than the work requirement start date. If defined, it supersedes the work requirement start date. Remember that the start date determines when the forecast begins calculating and if the date is in the future, the forecast won't have any due dates before that date. If the Start date is defined along with the Last Completed Date, then the Last Completed date takes precedence and is used to anchor the start of the forecast and begin its calculations.
Number of Intervals per Cycle	Number of intervals that occur during each cycle. This field is editable only if the Forecast using a cycle check box is selected. You can use intervals to define which work definitions fall on an interval and if they merge or suppress when more than one definition falls on the same interval. You can only set a value greater than 1 to forecast using a cycle of intervals. To have a single repeating interval, deselect the Forecast using a cycle check box.
Next work order only	Check box that controls the behavior of the creation of work orders from the forecast. By default, this check box is deselected. This means that work orders are created for forecasted due dates within the work order creation window that's defined for the organization. When you select the check box, work orders are only created for the next due date in the forecast. When the open work order is completed, a new work order is created for the next forecasted due date. We recommend you schedule the Generate Maintenance Work Orders scheduled process on a daily basis to create new work orders. We recommend that if Day or Meter Intervals are used as the forecast method, you select the Next work order only check box. This includes setting the Method to Calculate Next Due to Last Completion. This allows a dynamic adjustment of future due dates within the forecast horizon based on previous work order completion and meter reading entry. Else, the forecast may not dynamically forecast taking into consideration the last completion of a work order for a maintenance program.
Basis for Next Forecast Due Date	Method for generating a forecast. You can select from the following methods: Calendar pattern: Option to indicate whether a forecast is to be created based on a calendar pattern for both cycle and non-cycle based work requirements. Day Interval: Option to indicate whether a forecast is to be created based on a number of days interval for both cycle and non-cycle based work requirements. Meter interval: Option to indicate whether a forecast is to be created based on a meter interval for both cycle and non-cycle based work requirements. Condition event: Option to indicate if work orders can be created based on a condition event for non-cycle based work requirements. This check box is displayed only if the Forecast using a cycle check box is deselected. Condition event-only work requirements aren't forecasted. Note: You can select either a calendar pattern or day interval, but not both options, or you'll get an error.
Forecast Window in Days	Optional value that represents the number of days into the future the maintenance forecast is created for each asset in this work requirement. If not defined, then either the number of days value at the program header or the organization parameter will be used. The lowest level of definition takes precedence. It is generally recommended to only define a number of days value if the work requirement requires a forecast window that is longer in duration than the program header. Optionally, you can define for a shorter forecast window. For example, you may have a program header that is defined to forecast out 90 days, but you have work requirement that is due every 180 days. Therefore, setting a value at the requirement level of at least 180 days is helpful to view the due dates in the forecast for planning visibility.
Work Order Window in Days	Optional value that represents the number of days into the future that work orders for maintenance forecast are created for each asset in this work requirement. If not defined, then either the number of days value at the program header or the organization parameter is used. The lowest level of definition takes precedence. It is generally recommended to only define a number of days value if the work requirement requires a work order window that is longer in duration than the program header. Optionally, you can define for a shorter work order window. For example, you may have a program header that is defined to create work orders out 45 days, but you have work requirement that is due every 180 days. Therefore, setting a value at the requirement level of at least 180 days is helpful to create work orders out into the future to support planning.
Concurrent Requirements	Displays the option defined at program level for forecast to handle the concurrent work requirements. The Merge and Suppress options default to each work requirement. You can choose to override the option at the requirement level. Note: For calendar based work requirements, if you don’t want to consider merge and suppress option across work requirements, your administrator can set the parameter, Allow Suppress and Merge Across Work Requirements in a Maintenance Program to No on the Manage Asset Maintenance Parameters page in the Setup and Maintenance work area.
Override for this requirement	Option to define whether the concurrent requirements option defined at program level is to be overridden and defined only within the work requirement. If selected, the work requirement is forecasted independently of other work requirements. Additionally, the selected suppress or merge option is applied to each work definition, as indicated by the Forecast To column in the To Perform This Work region In previous versions, we recommended that you use Override option when using Calendar pattern-only work requirements if the same asset is defined across multiple work requirements in the same maintenance program. This prevents cross-requirement merge suppression of work definitions when their respective intervals intersect. In this version, you can decide if merge and suppress across work definitions is enabled by setting a parameter value. We recommend setting this parameter = no, thereby disabling this capability unless you have an established business requirement and fully understand its capability and limitations. Merge and suppress options, that support multiple work definitions across intervals in a cycle, are best modeled and forecasted within a single work requirement.
Create Work Orders Option	Option that controls if work orders are created Automatically (default) or Manually for a forecasted due date. Work Orders are automatically created for a forecasted due date. However, if you wish to manually create work orders for each due date using the Maintenance Forecast page or REST API, then you can set this option to Manually. If set to Manually, the Generate Maintenance Work Orders scheduled process ignores the forecasted due dates and work orders aren't created. Note: It is recommended to leave the option at the default value of Automatically unless your business process uses the Maintenance Forecast page or REST API exclusively to create work orders for these due dates.
Work Order Status	Option that controls the status of the work orders created for a due date. You can select from the predefined values: Unreleased (default), Released, or On-hold. You can also select customer-defined values that are created based on these predefined values.
Firm Work Orders	Option that controls if the work orders created for a due date are set as Yes (default) or No for Firm, which controls if they're scheduled or not respectively.
Work Order Priority	Optional field that sets the priority of the work orders created for a due date. Valid values are positive whole numbers.

Based on a Recurring Pattern by Date Region

In the Based on a Recurring Pattern by Date region, define the details of method selected for generating a forecast.

When you select Calendar pattern in the Basis for Next Forecast Due Date field, you can select an existing calendar pattern or create a new calendar pattern in this region. When creating a calendar pattern, you can define the frequency based on which the work requirements are scheduled by as:

Repeat Daily: you can select if a forecast is due every day of the week, 7 days a week. Additionally, if you select the Every Weekday check box, then the application validates if there's shift defined for each day. If there's no shift defined, then the day isn't considered in the forecast and skipped.
Repeat Weekly: you can select one or more individual days of the week. For example, every Monday or Monday, Wednesday and Friday.
Repeat Monthly: you can select a specific date of each month, such as the 15th. Or you can select a certain day during each month, such as the First Monday of the month.
Repeat Yearly: you can select a specific date during a year, such as June 15th. Or you can select a certain day with a specific month, such as the First Monday of June.

The forecast then uses the calendar pattern and the organization's facility schedule to create future due dates. The forecast initially creates due dates even on days in which a facility isn't operating, per is calendar. However, when the forecast is converted to a work order date, the calendar and shifts by resource are taken into consideration, which may pull or push the work order date as required.

Note: The calendar pattern names must be unique within a maintenance program and can't be used across different maintenance programs.

When you select Day interval in the Basis for Next Forecast Due Date field, the Base Interval in Days field and Method to Calculate Next Due drop-down list options are displayed in this region. The value defined in the Base Interval in Days field is used as the interval duration between due dates in the maintenance forecast for this requirement. The forecast calculates the first due date as: Start Date + Base Interval in Days. Then each successive due date is calculated as: Previous Due Date + Base Interval in Days. For example, if the Start Date is on a Monday, then Day 1 is Tuesday, Day 2 is Wednesday, and then Day 7 is on the next Monday. Therefore, with this method you can more easily model intervals that could represent many different periods of time in days. You can then use a cycle of intervals to define when your work definitions are due on each interval in the cycle.

The Day Interval method also supports a Method to Calculate Next Due option, like the Meter Interval. The default value is Base Interval, which keeps the forecast as being due based on the original start date of the work requirement, regardless of when the work order was accomplished. For example, you have a forecast in which each due date is due every 7 days into the future for the next 100 days. If you complete the first work order 1 day early and you have the option set to Base Interval, then the forecast doesn't adjust based on the work order completion. The next due date remains on its original date, which is 8 days after your previous work order accomplishment date. You can still enable the Next Work Order Only check box, however, the forecast doesn't adjust the future due dates based on the last completion.

If the value is set to Last completion, the next due work order can be calculated based on the previous work order's actual completion date. In order to use this option, you must enable the Next Work Order Only check box, else the forecasted next due date doesn't dynamically adjust. For example, you have a forecast in which each due date is due every 7 days into the future for the next 100 days. If you complete the first work order 1 day early and you have the option set to Last completion, then the entire forecast pulls forward by 1 day. The next work order is due in 7 days from the actual completion of the previous work order. If you complete the next work order 1 day later and you have the option set to Last completion, then the entire forecast pushes back by 1 day. The next work order is due in 7 days from the actual completion of the previous work order.

Day Intervals are most useful in that their Start Date, defined at the Work Requirement header or for each asset in the Affected Assets page, gives you the ability to determine exactly when the first due date occurs. The start date can be in the past, present or future. Additionally, the Day Interval allows for intervals that can’t be efficiently modeled using a Calendar Pattern. Examples are every 15 days, every 90 days, etc.

Day Intervals can also be selected to compete with one or more Meter Intervals. In this case, the first due date among each method is the winner. A Day Interval can't be defined against a Calendar Pattern. If both methods are selected, you'll get an error.

When you select Meter interval in the Basis for Next Forecast Due Date field, the meter interval table is displayed in this region. Click the Add button to add a new meter interval for the work requirement. In the newly added row, select from or enter values in the following fields.

Field	Description
Meter Name	Name of the meter to be added for the work requirement.
Description	Description of the meter.
Meter Entry	Displays whether the meter reading entry is mandatory.
History	Icon to display the meter reading history.
Daily Rate	Daily utilization rate for the asset meter.
UOM	Unit of Measure of the meter.
Base Interval	Base utilization interval for calculating the due date for the work requirement.
Estimated Daily Interval	Number of days in which the requirement repeats.
Method to Calculate Next Due	Method to be used by the forecast for calculating the date on which the work requirement is due next in the forecast. The valid values are: Base Interval Last Completion Note: If Last Completion is selected, it's important to select the Next Work Order only check box as well to allow for dynamic forecasting of future due dates based on the last work order completion.
Disable	Icon to disable or delete the meter. If there are no work orders generated for the work requirement, then you can use the icon to delete the meter from the work requirement. If any work order has already been generated for the work requirement, then you can use the icon to disable the meter for the work requirement.

When you select Condition event in the Basis for Next Forecast Due Date field, the condition event table is displayed in this region. Click the Add button to add a condition event for the work requirement. In the newly added row, search and select the code of the condition event. The name, type, and description are automatically displayed as per the selected code. Conditions Codes are only defined if the work requirement is used to automatically create work orders by the IoT Asset Monitoring application.

To Perform This Work Region

In the To Perform This Work region, you can define work definition for the work requirement. Click the Add button and select from or enter values in the following fields.

Field	Description
Work Definition	Name of the work definition to be added for the work requirement.
Description	Description of the work definition.
Due at Cycle Interval	Interval in the cycle at which a work order is created. The default value is 1. This value must be greater or equal to 1 and lesser or equal to the total number of intervals defined within the cycle. This field is editable only if the Forecast using a cycle check box is selected.
Repeats in Cycle	Option to indicate that work definition repeats on each iteration of the cycle interval over the life of the cycle. This field is editable only if the Forecast using a cycle check box is selected.
Forecasted To	Summary that describes at which intervals the work definition is due in the cycle. If more than one work definition is due on the same interval in a cycle, then the selected suppress or merge option is applied. Work definitions always merge for a forecast that doesn't use a cycle.
Disable	Icon to disable or delete the work definition. If there are no work orders generated for the work requirement, you can use the icon to delete the work definition for the work requirement. If any work order has already been generated for the work requirement, you can use the icon to disable the work definition for the work requirement.