Predefined Diagnostic Task Object Class
The Predefined Diagnostic Task object class (PDiagTask) identifies the tasks supported by diagnostics and provides additional information needed to execute the task.
The PDiagTask object class structure is:
class PDiagTask {
long TaskId;
long SetId;
long MsgId;
long Multisession;
short Order;
long ResourceFlag;
long DiagEnvironment;
short Builtin;
vchar Action[255];
vchar Catalog[255];
vchar KernExt[255];
short DescriptionSetId;
short DescriptionMsgId;
char PkgBlock[5];
};
Parameter | Description |
---|---|
TaskId | Unique number identifying the task. |
SetId | Catalog set number in either Dctrl.cat for the 'built-in' tasks, or in the catalog file specified for this task. The Setid and Msgid are used to display the task description on the Task Selection Menu. |
MsgId | Catalog message number in either Dctrl.cat for the 'built-in' tasks, or in the catalog file specified for this task. The Setid and Msgid are used to display the task description on the Task Selection Menu. |
Multisession | Flag indicating whether multiple instances of this task can
be run simultaneously. While not currently used, this is a reserved
field, and should be left blank.
|
Order | Order to display the tasks in the Task Selection Menu. Value of 0 implies no order required, and the task will be placed at the end. An order value greater than 900 implies that Task is a subtask. |
ResourceFlag | Flag indicating whether the Resource Selection menu should
be presented after the task has been selected. If a resource is selected,
then the task will be called with the resource name as a command-line
argument to the task. If this value is 0, then the task is invoked
directly.
|
DiagEnvironment | Bit mask indicating various test mode environments this task
is capable of running in.
|
Builtin | Built-in task (part of the Controller). |
Action | Basename of the program for this task. If no path given, then
the default path of /usr/lpp/diagnostics/bin is used. If a
complete path is given, then that path is used. When you are creating
a task that displays a subtask list, the action should include a %name,comma-separated
list of TaskIds of each subtask. In cases where task and subtask have
the same TaskId, a %name can be used. The following is an example
of a task and a subtask that have the same TaskId:
|
Catalog | Catalog file for this task. Catalog files containing default message text are assumed to be located in /usr/lpp/diagnostics/catalog/default directory. Translated files are assumed to be in /usr/lib/nls/msg/$LANG directories. |
KernExt | ',' separated list of kernel extensions to load for this task. |
DescriptionSetId | Catalog set number of the help message text in either Dctrl.cat for the 'built-in' tasks, or in the catalog file specified for this task. The DescriptionSetId and DescriptionMsgId are used to display the help task description on the Task Selection Menu. |
DescriptionMsgId | Catalog message number of the help message text in either Dctrl.cat for the 'built-in' tasks, or in the catalog file specified for this task. The DescriptionSetId and DescriptionMsgId are used to display the help task description on the Task Selection Menu. |
PkgBlock | Block number that includes the task on the Removable Media Diagnostic package. This value should be an "S" if the task is on a Supplemental Media. |