Create a work plan

  • Release version: Xanadu
  • Updated August 1, 2024
  • 3 minutes to read
  • Create a work plan to specify how and when the work should be performed for any activity.

    Before you begin

    Role required: sn_fsm_planned_wm.planned_work_admin and model_manager

    About this task

    A work plan consists of the effective start and end date that determines the period for which the plan can be scheduled for execution. The plan won’t work beyond the specified end date.
    Each work plan must have at least one or more records associated with it for which you want to apply the work plan. You can identify the records that require work by applying the filtering criteria to the selected table in the plan. For example, you can filter the matching records (containing apple computers) for a work plan by applying a filtering criteria to the table containing the records of computer that starts with "apple."
    Note:
    The filtered assets or activities that require work are called matching records in the work plan.

    You can also create a work plan through the Planned Work Management Workspace. Navigate to All > Planned Work Management > Workspace, and then select the List icon (List icon).

    Procedure

    1. Navigate to All > Planned Work Management > Plans.
    2. Select New.
    3. On the form, fill in the fields.
      Table 1. Work Plan
      Field Description
      Number Unique number for the work plan.

      This field is automatically set.

      Active Option to determine if this work plan is available to use.
      Effective start Effective start date from when the work plan is active.
      Effective end Effective end date until when the work plan is active.
      Forecast work orders Option to specify if this work plan is applicable to estimate and generate the upcoming work orders.
      Name Name of the work plan.
      Short description A short description of the work plan.
      Conditions
      Type Type of trigger that determines when work should be performed.
      • Model based: Base the work plan on a specified model of a CI.
      • General: Base the work plan on a table and filter.
      • Install base: Base the work plan on specified models of install base items
      Note:
      • Model-based plans apply only to hardware models, specifically ones that have at least one model category defined.
      • Install base plan type is available only if the Customer Service Install Base Management (com.snc.install_base) plugin is activated.
      Model Select one or more Product catalog items to identify the CIs or Install base that requires maintenance. When you select a model, the associated table appears in the Table field. For example, if you select a specific model of PC, the Table field displays Computer [cmdb_ci_computer]. This field appears if you selected either Model basedor Install base type. For Install base type, The Table field automatically populates an appropriate table based on the selected model.
      Table Table you want to associate with the work plan.

      If you have selected Model Based in the Type field, this field displays the lowest level table that contains all the selected CIs. If you have selected Install base in the Type field, this field displays the install base tables.

      Filter conditions Filter conditions to locate the specific assets that you want to work. Only records in the selected table that match the filtering criteria require work.
      Category Determine whether the work plan is applicable for either category original equipment scheduling (OEM) or alternative equipment scheduling (AEM).
      Apply to new matching records Option to ensure that the schedules defined for this work plan are applied to all records that have been added to the specified table since the last time the plan was executed, also meet the conditions specified in the Filter conditions.
      Task creation policy Specify what to do when a work plan runs based on a schedule occurrence that is already in progress.
      • Leave alone: Don’t allow the creation of new tasks or the deletion of existing ones.
      • Cancel existing: Allow the deletion of existing tasks associated with the plan and the creation of new tasks to replace them.
      • Add to existing: Allow new tasks to replace the existing active tasks for the specific schedule occurrence of a plan.

    Result

    • The work plan is created successfully.
    • Specific activities that require work are identified from the selected table based on the filtering conditions.

    What to do next

    After creating a work plan, configure a schedule to the work plan. For more information, see Configure a work schedule