{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":14967,"path":"field-service-management/planned-work-components.md","title":"Planned Work Management components","bundle":null,"doc_type":null,"release":"australia","body":"\n# Planned Work Management components\n\nSeveral types of components are installed with Planned Work Management, including tables, roles, script includes, and business rules.\n\n## Tables\n\nPlanned Work Management adds the following tables.\n\n\n
\n\nTable\n\n\n\nDescription\n\n
\n\nWork Plan\\[wm\\_planned\\_work\\_plan\\]\n\n\n\nStores the entities filtered for the work plan.\n\n
\n\nPlanned Work Schedule\\[wm\\_planned\\_work\\_schedule\\]\n\n\n\nStores the schedules configured for a work plan. A schedule can be duration, meter, condition, or script based.\n\n
\n\nPlanned Work Schedule Template\\[wm\\_m2m\\_schedule\\_template\\]\n\n\n\nStores the list of work order templates applied to planned work schedules.\n\n
\n\nPlanned Work Record\\[wm\\_m2m\\_work\\_plan\\_to\\_record\\]\n\n\n\nRelates a work plan schedule to a record in the system \\(from a document ID\\). Also contains information about the last time or value the schedule ran for the record and the next time or value when the schedule will run.\n\n
\n\nTemplate Attribute Mapping\\[wm\\_m2m\\_template\\_attribute\\_map\\]\n\n\n\nStores the attribute mapping for a work order template.\n\n
\n\nSchedule Occurrence\\[wm\\_plan\\_work\\_schedule\\_occurrence\\]\n\n\n\nStores the occurrences of the work schedule.\n\n
\n\nSchedule Suppression\\[wm\\_m2m\\_schedule\\_suppression\\]\n\n\n\nStores the occurences of suppressed work schedules.\n\n
## Roles\n\nPlanned Work Management adds the following roles.\n\n\n
\n\nRoles\n\n\n\nDescription\n\n
\n\nPlanned work admin \\[sn\\_fsm\\_planned\\_wm.planned\\_work\\_admin\\]\n\n\n\nCreate work plans, planned work schedules, link work order templates to the schedules, and generate work orders.\n\n
## Script Includes\n\nPlanned Work Management adds the following script includes.\n\n|Script Include|Description|\n|--------------|-----------|\n|PlannedWorkManagementExtensionPointImpl|Implements the Global.PlannedMaintenanceExtensionPoint extension point.|\n|PlannedWorkMgmtAjaxUtil|Utility function for client scripts in planned work management.|\n|PlannedWorkMgmtAPIHelperUtil|Utilities for wrapper function to invoke global scoped APIs from planned work management scope.|\n|FSMPWMUtil|Utility function for planned work management scoped application.|\n|PWMForecastWOUtil|Utility function to forecast work orders for the planned work.|\n|PlannedMaintenanceExtensionPointImpl|Default implementation for planned maintenance application.|\n|PlannedMaintenanceExtPointUtil|Utility in the planned maintenance application to retrieve extension points based on sys\\_class\\_name.|\n|PlannedWorkManagementHistoryUtil|Utility in the planned work maintenance application to fetch the maintenance cycles history for an asset or inventory.|\n|PlannedWorkManagementScheduleUtil|Maintains the processing logic for plan work record, schedule occurrences, work note comments etc.|\n|PlannedWorkMangementPlanUtil|Utility methods related to work plan.|\n|PlannedWorkManagementEffectivityUtil|Utility methods to determine and validate the effectivity of the schedule.|\n|PlannedWorkManagementScheduleExeUtil|Acts as switch between the implementations of thePlannedWorkManagementExeExtensionPoint extension point based on order type. The default value of order type is work order.|\n|PWMWorkOrderExeExtensionPointImpl|Implementation of the PlannedWorkManagementExeExtensionPoint extension point for the order type selected as work order.|\n|PlannedWorkManagementConstants|Holds the constants for plan work management.|\n|PWMScheduleSuppression|Maintains the processing logic of schedule suppression.|\n|PWMScheduleOccurrence|Maintains the processing logic of schedule occurrence.|\n|PWMScheduleOccurrenceDAO|Maintains the DAO methods of schedule occurrence.|\n|PWMWorkScheduleDAO|Maintains the DAO methods for work schedule.|\n|PWMPlanWorkRecordDAO|Maintains the DAO methods for plan record.|\n\n## Business rules\n\nPlanned Work Management adds the following business rules.\n\n\n
\n\nBusiness rule\n\n\n\nTable\n\n\n\nDescription\n\n
\n\ncross scope record creation\n\n\n\nWork Plan\\[wm\\_planned\\_work\\_plan\\]\n\n\n\nCreates the cross scope access record on the table on which Maintenance plan is created and must be run.\n\n
\n\ncancel WO when plan record inactive\n\n\n\nPlanned Work Record\\[wm\\_m2m\\_work\\_plan\\_to\\_record\\]\n\n\n\nCancels the work order for a plan record when that plan record is inactivated. The Plan record gets deactivated when the asset record is modified so that it doesn’t satisfies the filter condition at the plan level.\n\n
\n\nPlanned work schedule to maintenance plan\n\n\n\nPlanned Work Schedule \\[wm\\_planned\\_work\\_schedule\\]\n\n\n\nRestricts the creation of Planned work schedule for maintenance plan. Only allows when the Plan is of class Planned work.\n\n
\n\nRestrict model per schedule\n\n\n\nPlanned Work Schedule Template\\[wm\\_m2m\\_schedule\\_template\\]\n\n\n\nRestricts the creation of duplicate model schedule in the table.\n\n
\n\nRestrict table map for model\n\n\n\nTemplate Attribute Mapping\\[wm\\_m2m\\_template\\_attribute\\_map\\]\n\n\n\nRestricts the user to have single table map per a work order template\n\n
\n\nUpdate m2m schedule records new fields\n\n\n\nPlanned Work Schedule\\[wm\\_planned\\_work\\_schedule\\]\n\n\n\nUpdates the schedule record and recalculates the next value or next run time when meter or duration fields change.\n\n
\n\nValidate plan effective start, end\n\n\n\nWork Plan\\[wm\\_planned\\_work\\_plan\\]\n\n\n\nChecks if the effective start and end date of the work plan are valid.\n\n
\n\nWork schedule template to maint schedule\n\n\n\nPlanned Work Schedule Template\\[wm\\_m2m\\_schedule\\_template\\]\n\n\n\nRestricts the user to add maintenance schedule to planned work schedule template.\n\n
\n\nUpdate latest completion date in Work order\n\n\n\nWork Order Task\\[wm\\_Task\\]\n\n\n\nUpdates the latest completion date in work order for grace time SLA.\n\n
\n\nCompare schedule template tasks\n\n\n\nSchedule Suppression\\[wm\\_m2m\\_schedule\\_suppression\\]\n\n\n\n \n\n
\n\nValidate cyclic dependency\n\n\n\nSchedule Suppression\\[wm\\_m2m\\_schedule\\_suppression\\]\n\n\n\n \n\n
\n\nSuppress SO by schedule suppression\n\n\n\nSchedule Suppression\\[wm\\_m2m\\_schedule\\_suppression\\]\n\n\n\n \n\n
\n\nSuppress SO by schedule\n\n\n\nSchedule Occurrence \\[wm\\_plan\\_work\\_schedule\\_occurrence\\]\n\n\n\n \n\n
\n\nSuppress SO by suppressBy schedule\n\n\n\nSchedule Occurrence \\[wm\\_plan\\_work\\_schedule\\_occurrence\\]\n\n\n\n \n\n
\n\nCancel WO if SO inactive\n\n\n\nSchedule Occurrence \\[wm\\_plan\\_work\\_schedule\\_occurrence\\]\n\n\n\n \n\n
\n\nCheck effective start of SO\n\n\n\nSchedule Occurrence \\[wm\\_plan\\_work\\_schedule\\_occurrence\\]\n\n\n\n \n\n
\n\nChange WO fields on SO field changes\n\n\n\nSchedule Occurrence \\[wm\\_plan\\_work\\_schedule\\_occurrence\\]\n\n\n\n \n\n
- **[Planned Work Management system properties](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/field-service-management/planned_work_management_sys_properties.md)** \nPlanned Work Management uses the following system properties, which are located in the System Properties \\[sys\\_properties\\] table.\n\n**Parent Topic:**[Components installed with additional plugins for Field Service Management](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/field-service-management/components-inst-additional-plugin.md)\n\n**Related topics** \n\n\n[Extension points in Field Service Management](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/field-service-management/extension-points-field-service.md)\n\n"}}