Manage Maintenance Forecast for an Asset Using a REST Service

Maintenance programs define and generate a preventive maintenance forecast for one or more affected assets in a maintenance-enabled organization. The forecast is then used as the basis for creating preventative maintenance work orders, thus reducing the workload for maintenance planners and allowing them to focus on maintenance program auditing, optimization, and exception-based events.

Customers with assets, such as vehicles that travel to different locations and across operating and maintenance organizations, requested the ability to forecast asset maintenance programs across all organizations and decide when and where a specific asset will be maintained based on its expected location as of the maintenance due date. For assets that are only maintained in their same operating organization, customers requested flexibility on adjusting the date when the asset will be maintained.

Previously, using the GET action of the Maintenance Forecasts REST resource, you were able to retrieve forecasted due date details. In this update, you can now perform the following actions using the REST API:

  • Define a requested due date that's the same or different than the forecasted due date. The due date must be after the last due date and before the next due date in the forecast for an asset.
  • Define a requested work order location that's the same or different than the forecasted location. This is only available if the due date was created from a program that's enabled for assets across organizations. The requested location must also be enabled for maintenance and have matching work definitions defined. Additionally, to create work orders for assets across organizations you must either define organizational relationships between maintenance organizations or enable a new parameter that wouldn't require relationships.
  • Skip a due date in the past, present, or future where there isn't an active work order. Skipping a due date will suppress the creation of a work order for the due date by the scheduled process.
  • Unskip a due date in the past, present, or future. Unskipping a due date enables the creation of a work order for the due date manually or by the scheduled process. If the due date is in the past, you can manually create a work order.
  • Use a special action to manually create a work order for a due date in the past, present, or future. This can be for any due date, regardless if it's set to automatically or manually create a work order. This action launches a concurrent process request to create the work order.
  • Use a special action to cancel a work order for a due date in the past, present, or future. You can cancel an existing work order, and then manually create a new work order on a different date and location. A work order can only be canceled if there haven't been any transactions recorded. Examples are operation completion, material issues, and resource reporting.

In this update, the REST API is also used by the Manage Forecasts page.

Examples of REST API payloads using PATCH:

fscmRestApi/resources/latest/maintenanceForecasts

  • Define a requested due date and location that is the same or different than the forecasted due date:

{"RequestedWoStartDate": "2023-08-10",

"RequestedWoOrganizationCode": "Organization A"

}

  • Skip or Unskip a due date

{    "SkipDueDateFlag": true or false}

Examples of REST API payloads using POST and a special action:

fscmRestApi/resources/latest/maintenanceForecasts

  • Create a work order for a due date based on the unique forecast id:

{"name": "manageForecastWorkOrders","parameters": [    {    "forecastId": 123456789    },    {    "workOrderActionCode": "ORA_CREATE"    }]}

  • Cancel a work order for a due date based on the unique forecast id:

{"name": "manageForecastWorkOrders","parameters": [    {    "forecastId":123456789    },    {    "workOrderActionCode": "ORA_CANCEL"    }]}

You can effectively manage the preventative maintenance on assets that operate both within and across organizations over time using the REST API and by using the new actions on the Manage Forecast page.

Steps to Enable

Review the REST service definition in the REST API guides to leverage (available from the Oracle Help Center > your apps service area of interest > APIs & Schema). If you are new to Oracle's REST services you may want to begin with the Quick Start section.

Review the REST service definition in the REST API guides to leverage (available from the Oracle Help Center > your apps service area of interest > APIs & Schema). If you are new to Oracle's REST services you may want to begin with the Quick Start section.

Tips And Considerations

If you want to define a requested start date or location, you must enable your maintenance programs to allow assets across organizations. Otherwise, you wouldn't be able to define a requested work order location for a due date.

Defining a requested start date and location will freeze the forecasted due date, and all previous due dates in history that don't have work orders. Generating the forecast for the program will only update and refresh due dates from the last frozen date in history. Therefore, care is taken when defining a requested start date or location for due dates into the future.

To create work orders for assets across organizations you must either define organizational relationships between maintenance organizations or enable a new parameter that wouldn't require relationships. For additional information on managing work orders across organizations, refer to Set Up Maintenance Organization Relationships section in the Implementing Manufacturing and Supply Chain Materials Management guide.

If you want to fully control the creation of work orders for an asset due date, then you must define the work orders creation option as manual in the work requirement. Else, you should leave the option set to automatic and use the scheduled process to generate work orders for due dates.

Key Resources

Access Requirements

Users who are assigned a configured job role that contains these privileges can access this feature:

  • Get Maintenance Forecasts by Service (MNT_GET_MAINTENANCE_FORECASTS_BY_SERVICE)
  • Manage Maintenance Forecasts by Service (MNT_MANAGE_MAINTENANCE_FORECASTS_BY_SERVICE)

These privileges are new in this update.