Problem Templates

Problem templates are building blocks of text that simplify the entry of the four text fields associated with documenting a problem:

  • Description
  • Cause
  • Consequences
  • Repair Procedure


You choose a template from the drop-down list accessed by the arrow on the right side of the text block.  The idea behind a template is to create a starting block of text that is general enough to apply to many problems, but specific enough so that you don't have to spend a lot of time customizing the text to thoroughly describe the narrative.  Let's take for example an overheating breaker.  These are the four text fields we would like to have once the problem has been documented:


  • Description: "Overheating on circuit breaker #30"
  • Cause: "Possible loose connection at terminal block"
  • Consequences: "Loss of circuit 30, resulting in loss of lighting on the south side of floor 5"
  • Repair Procedure: "Inspect and conduct appropriate repairs"


So some ideal templates for a problem like this would be:


  • Description: "Overheating on circuit breaker #"
  • Cause: "Possible loose connection at"
  • Consequences: "Loss of circuit #, resulting in loss of"
  • Repair Procedure: "Inspect and conduct appropriate repairs"

For the description, we can just choose the template and fill in "30" at the end to make it specific to this problem.  However, that template can be used for any circuit breaker number in any future problems we have.  For the cause, we just need to fill in where the connection was loose.  In this case, that's the terminal block.  But that template could also be used for a loose lug on a transformer.  For the consequences, we need to fill in two pieces of information: the circuit number and what can be lost if it fails.  For the repair procedure, we can just use the entire template because it's an excellent catch-all directive to tell the engineer responsible for fixing the problem to decide what is wrong and take care of it.  Using these templates results in less time needed to type up all four text fields.

Creating a Problem Template

There are two ways to create a problem template:

    1. Using the Global Library Editor
    2. Creating the template while entering problem documentation detail

To create a problem template while entering the data in the problem documentation detail, the process works differently than other global library items.  For something like a manufacturer, you would decide that you need a new manufacturer, choose Add New from the drop-down list, enter the new manufacturer, and the new manufacturer would become the chosen item.  For problem templates, you enter the text first and then add it to the library:

    1. Create the template text you want in any of the problem documentation text fields.
    2. Open the drop-down list with the arrow on the right side of the text box.
    3. Choose Add To Library.

Note that this means that when documenting a new problem where you want to add a template, you first need to write the template, add it to the library, and then continue customizing the text for that specific problem.  Templates are entirely optional.  If you want, you can write the problem text from scratch each time.  Templates are not a necessity, but are rather intended to be a time saver.