Creating an Instruction

Using the Instructions application you can create five types of instructions - planned maintenance, breakdown, installation, operations, and disposal. You can also specify useful key information such as activity type, failure mode, frequency, document, safety rule, preconditions, steps, and post checks for an instruction.

Prerequisites

  • Your user ID either belongs to the group ORG_ADMIN or ORG_DATA_EXPERT, or has the roles INSTRUCTION_DELETE or INSTRUCTION _EDIT assigned.

    For more information, see Roles for SAP Cloud Platform - Neo Environment.

  • You have identified the subclass that you want to use for your instruction.

  • If you want to assign a model to an instruction, you must ensure that models already exist in SAP Asset Strategy and Performance Management.

Context

For simplicity, we only describe the planned maintenance instruction and a breakdown instruction procedure. In addition, you can assign a model to the instruction so that the operator using the model can use the instruction information for equipment maintenance.

Procedure

  1. Open the Instructions app.
  2. On the Instructions screen, choose New.
  3. In the New Instruction pop-up, perform the following tasks:
    1. In the Instruction Type field, enter Planned Maintenance to create a planned maintenance instruction, or a Breakdown instruction to create an unplanned instruction.
    2. In the Subclass field, enter a subclass to which you want to assign an instruction.
    3. Choose Create.
  4. In the Planned Maintenance Instruction screen, perform the following tasks:
    1. In the Header section, enter the following information:

      Field

      Description

      Short Description

      Enter the short description for the instruction.

      Expected Duration

      Enter the total time required to execute the instruction and also the unit of time.

      Criticality

      Specify the importance of the instruction.
    2. In the Information section, enter the following information:

      Field

      Description

      Activity(*)

      Select an activity type.

      Failure Mode Category(*)

      For a breakdown instruction, select an appropriate value from the drop down. The list below describes what each failure mode means

      • Fail to function: equipment does not function.

      • Fail to open: equipment does not open.
      • Fail to close: equipment does not close,
      • Operation delay: equipment operation is delayed..
      • Output is high: output of the equipment is high.
      • Output is low: output of the equipment is low.

      Long Description(*)

      Enter a description for the instruction.
      Frequency(*)

      For a planned maintenance instruction, enter the recurring time interval at which the instruction must be executed. In the adjacent drop-down, specify the unit of time

      Primary Document

      An unstructured document that provides more information about the instruction.

      To add a new document, follow the steps below:

      1. Choose New.

      2. In the Add Document dialog box, browse for a file name.

      3. In the Phase drop down, specify a phase.

      4. In the Category drop down, choose a category that corresponds to a phase.

      5. In the Description field, enter a description.

      6. Choose Upload.

      To assign an existing document, follow the steps below:

      1. In the Assign Documents to Instruction window, search for a document using the filters Phase, or Category.

      2. Select a document from the search results list.

      3. Choose Assign.

      To view the list of supported MIME types, see the Supported MIME Types table under the Documents documentation.

      To add a hotspot to an image, see Creating Hotspots.

      3D Visual

      Add either a new 3D visual file, or assign an existing 3D visual file. You can refer to the steps mentioned for the Primary Document to upload a new 3D visual file, or to assign an existing 3D visual file.

      Relevant to Warranty

      Specify if the instruction is relevant for warranty.
  5. On the Safety Rules screen area, choose Add to add a new safety rule and perform the following tasks:
    1. In the Safety Rules dialog box, select a safety rule and choose OK.

      For example, if you want the user to wear safety boots while performing the step in the instruction, choose Safety boots must be worn.

  6. In the Models screen area, choose Assign to assign an existing model to the instruction and perform the following tasks:
    1. In the Select Models dialog box, search for an appropriate model using the search filters Class or Manufacturer.
    2. From the Models search list, select an appropriate model.
    3. Choose Assign.
  7. In the Equipment screen area, to assign an equipment, choose Assign and perform the following tasks:
    1. In the Select Equipment, select the appropriate equipment.
    2. Choose Assign.
  8. In the Preconditions screen area, choose Add to add an activity that must be performed before executing the instruction.
  9. In the Steps screen area, to add individual instructions to the overall instruction, choose Add.
  10. In the Post Checks screen area, to add an activity that needs to be performed after the instruction execution, choose Add and enter values in the Post Checks field.
  11. Save the instruction, or Save and Publish the instruction.
  12. To add the instruction to a group, go to the instruction detail page and navigate to GROUPS → Add.
  13. To create a new revision, and to switch between published and revision states, see Creating Revisions and Switching Between Revisions and Published State.