How to use Mapping and Samples Documentation
Each record subtype documentation contains sections Samples (optional), Virtual fields and Mappings.
The section Samples lists all available samples for this record subtype and their short descriptions. You can click on the name of a sample to get more details about it. On the Sample Details page, a description for the sample and the fields fetched by this sample are listed.
The section Virtual fields lists all virtual fields used by IBM® SMF Explorer for the current subtype. For each virtual field, the origin fields that it is based on and its short description are given. You can click on the virtual field or its origin to get more details.
The section Mappings lists all the mappings available for the current subtype. For each mapping, a description and the list of all IBM SMF Explorer fields used in this mapping are given. Each field is listed together with its origin (column Based on), a short description, and its type or format.
The following tags denote the characteristics of the fields:
| Tag | Meaning |
|---|---|
| virtual | This is a virtual field. A virtual field is based on other IBM SMF Explorer fields, which themselves can also be virtual. |
| processed | This field is postprocessed, e.g. with numerical scaling or mapping. |
| flag | This field has several derived flag fields of type Boolean. Each derived field corresponds to a bit position of this field. |
| array | This field is interpreted as an array. It has several fields derived from it, each corresponds to an array position. |
| alias | This field is an unchanged copy of the field it is based on. |
If a field is not virtual
, the column Based on displays the name of the source field (SMF) that this field is based on. Otherwise, the name of the IBM SMF Explorer fields that this field is derived from is given.
If a field is tagged as array or flag , then the indented subsequential fields are its subfields, for example:
| Name | Based on | Description | Type/Format |
|---|---|---|---|
| flg flag | SMF70FLG | SYSTEM INDICATOR FLAGS | string |
| bfy | flg | SYSTEM RUNNING IN PR/SM MODE | |
| os | flg | OPERATING SYSTEM IS OS/VS2 |
Field, Sample and Map names in this documentation are often hyperlinks that point to more detailed information.
Each SMF field is provided with a field detail page. This page specifies the field description, the map that this field belongs to, and the source field that this field is based on (or other IBM SMF Explorer fields in the case of a virtual field)
If the field is postprocessed, for example being scaled, aggregated or mapped, there is a section Postprocessed that describes how this is done.
Additionally, the pages for array fields also provide information about the length of the arrays and the derived alias fields. An alias field is a field that corresponds to an element of an array field.