Template Keywords

Template keywords appear once for each template in this repository input file. If a template keyword is specified more than once, the last occurrence of the keyword will be used.

<action> (optional)

Action that will be performed against this template entry. This keyword prefixes the Template_number keyword. If omitted, "ADD" will be the action taken. Valid actions are:

ADD

Add this template to the specified repository.
COMMENT
Treat this entry as a comment only and do not change the specified repository.
Template_number (required)
The unique number that is to be associated with this template. MKTMPF will validate the number for uniqueness. This number is required for each template in the input file, and it cannot be 0.

Note: This signifies the start of a template entry. The end of a template is detected by another Template_number entry or the end of file.

Comment (optional)
A 40-character (including ") user comment to be included with this template that might help the user identify what the template is used for. A sample comment would be:

"I/O error on printer LPT2," which identifies that this template is to be used by FFSTProbes that detect I/O errors on LPT2.

Message_number (required)
The main message number for this error. The message will be found in the message file specified by Message_pathname or Default_message_pathname. This number is required for each template in the input file. A message number equal to 0 will be considered an error, because this could indicate a missing message number.
Log_Class (optional)
The type (Log_Class) of this error; H = Hardware, S = Software (default).
Message_pathname (optional)
Name of the message file that contains the main message for this template (Message = xxx).

Note: If this parameter is not provided, the Default_message_pathname information will be used.

Causes_pathname (optional)
Name of the message file containing messages that provide cause information.

Note: If this parameter is not provided, the Default_causes_pathname information will be used.

Actions_pathname (optional)
Name of the message file containing messages that provide specific information about actions that might correct this error.

Note: If this parameter is not provided, the Default_actions_pathname information will be used.

Details_pathname (optional)
Name of the message file containing heading information for detail data formatting.

Note: If this parameter is not provided, the Default_details_pathname information will be used.

Fail_causes (optional)
Up to four message numbers, separated by commas, that can be found in the Causes message file. These messages will provide information relating to the failure or error that occurred.
Fail_actions (optional)
Up to four message numbers, separated by commas, that can be found in the Actions message file. These messages will provide information relating to the actions that should be taken to either correct or gather more information about the error.
Install_causes (optional)
Up to four message numbers, separated by commas, that can be found in the Causes message file. These messages will provide information relating to possible installation causes of the failure or error that occurred.
Install_actions (optional)
Up to four message numbers, separated by commas, that can be found in the Actions message file. These messages will provide information relating to the actions that should be taken to either correct or gather more information about the error.
User_causes (optional)
Up to four message numbers, separated by commas, that can be found in the Causes message file. These messages will provide additional user information relating to the failure or error that occurred.
User_actions (optional)
Up to four message numbers, separated by commas, that can be found in the Actions message file. These messages will provide information relating to the actions that should be taken to either correct or gather more information about the error.
Detail_data (optional)
Entries used to format the user_data portion of template records. There can be multiple entries. Each entry contains four pieces of information separated by commas. The information must be in the following order:
• length
  The length of data formatted by this instruction.
  2. offset
  The offset into the user_data area where this formatting record is to start. The first byte of user_data is position 0.
  3. heading
  The message number of the details file that is to be displayed before this data. A blank specifies that no heading will be displayed.
  4. type
  The type of formatting that is to be done:
  • The data is not to be used.
    
  • The data conforms to ISO 8859.1 and is to be displayed in ASCII characters.
    
  • The data is in binary format and should be converted to decimal before it is displayed.
    
  • Display the data in hexadecimal.
    
  • The data is Unicode and is to be displayed in ASCII characters.

  The following table shows which entries are required for the specific actions of MKTMPF. If an entry is marked as "Optional," neither the entry type nor its value is required. You can enter the entry type with no value if you desire to have a placeholder.

  ┌─────────────────────────┬───────────────┬───────────────┐│Entry Type               │Add            │Comment        │
  ├─────────────────────────┼───────────────┼───────────────┤
  │Repository_pathname      │Required       │Required       │
  ├─────────────────────────┼───────────────┼───────────────┤
  │Default_Message_Pathname │Optional*      │Optional*      │
  ├─────────────────────────┼───────────────┼───────────────┤
  │Default_Causes_Pathname  │Optional*      │Optional*      │
  ├─────────────────────────┼───────────────┼───────────────┤
  │Default_Actions_Pathname │Optional*      │Optional*      │
  ├─────────────────────────┼───────────────┼───────────────┤
  │Default_Details_Pathname │Optional*      │Optional       │
  ├─────────────────────────┼───────────────┼───────────────┤
  │<action>                 │Optional       │Required       │
  ├─────────────────────────┼───────────────┼───────────────┤
  │Template_number          │Required       │Optional       │
  ├─────────────────────────┼───────────────┼───────────────┤
  │Comment                  │Optional       │Optional       │
  ├─────────────────────────┼───────────────┼───────────────┤
  │Message_number           │Required       │Optional       │
  ├─────────────────────────┼───────────────┼───────────────┤
  │Log_Class                │Optional       │Optional       │
  ├─────────────────────────┼───────────────┼───────────────┤
  │Message_pathname         │Optional*      │Optional       │
  ├─────────────────────────┼───────────────┼───────────────┤
  │Causes_pathname          │Optional*      │Optional       │
  ├─────────────────────────┼───────────────┼───────────────┤
  │Actions_pathname         │Optional*      │Optional       │
  ├─────────────────────────┼───────────────┼───────────────┤
  │Details_pathname         │Optional*      │Optional       │
  ├─────────────────────────┼───────────────┼───────────────┤
  │Fail_causes              │Optional       │Optional       │
  ├─────────────────────────┼───────────────┼───────────────┤
  │Fail_actions             │Optional       │Optional       │
  ├─────────────────────────┼───────────────┼───────────────┤
  │Install_causes           │Optional       │Optional       │
  ├─────────────────────────┼───────────────┼───────────────┤
  │Install_actions          │Optional       │Optional       │
  ├─────────────────────────┼───────────────┼───────────────┤
  │User_causes              │Optional       │Optional       │
  ├─────────────────────────┼───────────────┼───────────────┤
  │User_actions             │Optional       │Optional       │
  ├─────────────────────────┼───────────────┼───────────────┤
  │Detail_data              │Optional       │Optional       │
  ├─────────────────────────┼───────────────┼───────────────┤
  │                         │               │               │
  ├─────────────────────────┼───────────────┼───────────────┤
  │* Either the default path│               │               │
  │name or the path name in │               │               │
  │each template is required│               │               │
  │if the template is using │               │               │
  │messages. For examples,  │               │               │
  │see the following table. │               │               │
  ├─────────────────────────┼───────────────┼───────────────┤
  │                         │               │               │
  └─────────────────────────┴───────────────┴───────────────┘
  

  ┌──────────────────────────────┬──────────────────────────────┐
  │Required                      │When Required                 │
  ├──────────────────────────────┼──────────────────────────────┤
  │Default_message_pathname or   │Always                        │
  │Message_pathname              │                              │
  ├──────────────────────────────┼──────────────────────────────┤
  │                              │                              │
  ├──────────────────────────────┼──────────────────────────────┤
  │Default_causes_pathname or    │When providing cause          │
  │Causes_pathname               │information                   │
  ├──────────────────────────────┼──────────────────────────────┤
  │                              │                              │
  ├──────────────────────────────┼──────────────────────────────┤
  │Default_actions_pathname or   │When providing action         │
  │Actions_pathname              │information                   │
  ├──────────────────────────────┼──────────────────────────────┤
  │                              │                              │
  ├──────────────────────────────┼──────────────────────────────┤
  │Default_details_pathname or   │When providing detail data    │
  │Details_pathname              │information                   │
  ├──────────────────────────────┼──────────────────────────────┤
  │                              │                              │
  └──────────────────────────────┴──────────────────────────────┘
  

  ---

  [Back: Repository Keywords]
  [Next: Output File and Error Reporting]