This table holds context help text which is intended to be maintained during the lifetime of the application.
The context help for a given field is searched within this table and depending on the search result, one or more text parts are put together to
make up the context helptext to be displayed.
| Name | Description | Data Type | Len | Dec. | View lines | View type | Inst. | Visible | Codetable |
|---|---|---|---|---|---|---|---|---|---|
| INR | Internal Unique ID of Contexthelp | Text | 8 | 1 | Edit | Yes | Public | ||
| KEY1 | Unique Key 1/Project | Text | 6 | 1 | Edit | Yes | Public | HLPPRJ | |
| KEY2 | Unique Key 2/Type | Text | 6 | 1 | Edit | Yes | Public | Embedded | |
| KEY3 | Unique Key 3/Table or Transaction\Modulpath | Text | 80 | 1 | Edit | Yes | Public | ||
| KEY4 | Unique Key 4/Field | Text | 20 | 4 | Edit | Yes | Public | ||
| KEY5 | Unique Key 5/Empty | Text | 20 | 1 | Edit | Yes | Public | ||
| UIL | Language Code | Text | 2 | 1 | Edit | Yes | Public | UILTXT | |
| LEV | Level Code | Text | 1 | 1 | Edit | Yes | Public | Embedded | |
| NAM | Field Description | Text | 80 | 1 | Edit | Yes | Public | ||
| TXT | Help Text Content | Block | 60 | 32 | 17 | Block | Yes | Public | |
| USR | User ID of Last Modification | Text | 8 | 1 | Edit | Yes | Public | ||
| DAT | Date of Last Modification | Date | 12 | 0 | Date | Yes | Public | ||
| VER | Version Counter | Text | 4 | 1 | Edit | Yes | Public |
| Name | Fields | Properties |
|---|---|---|
| HLP_INR | INR | Unique |
| HLP_KEY | KEY1, KEY2, KEY3, KEY4, KEY5, UIL, LEV | Unique |
| HLP_NAM | NAM |
/
INR
Unique internal ID of a record within the table. The INR is a text field, which is created by retrieving the next valid entry from the counter HLP. The field INR is used to maintain links from other tables into this table.
Unique internal ID of a record within the table. The INR is a text field, which is created by retrieving the next valid entry from the counter of this table. The field INR is used to enable links from other tables to this table.
For contractdata the INR also links the two tables xxD and xxT as associated entries hold the same INR.
This main key is intended to be able to differentiate different projects within one technical installation. Within DOKA this field has always the fixed value DOK.
This main key is intended to differentiate between different projects in a single technical installation. In the application, this field always has a set value 'DOK'.
To be able to differentiate different logical sources, this second level is used. Entries which are associated to database fields are marked with 'DBF'. Entries which are associated to transactions or modules are marked with 'TRN'.
This second level is used to differentiate between different logical sources. Entries associated to database fields are marked 'DBF'. Entries associated to transactions or modules are marked 'TRN'.
| Code | Text |
|---|---|
| DBF | Database |
| TRN | Transaction |
| DOC | Documentation |
Depending on KEY2, this field has different contents. When KEY2 holds 'DBF', the content specifies the table where the field is located in. When KEY2 holds 'TRN', the content is the transaction name directly followed by the module path of the field within the transaction. If the module path includes a reference to a multiple module instance (grid), the brackets and the index are removed from the path. Thus, the context help text for every line within the grid is the same.
The content of this field varies depending on KEY2. If KEY2 is 'DBF', the field specifies where the database field is located. If KEY2 is 'TRN', the field shows the name of the transaction followed by the module path of the field in the transaction. If the module path includes a reference to a multiple module (grid), the brackets and the index are removed from the path. Thus, the context help text for each line within the grid is the same.
For both currently used types of context help this field always holds the field identifyer of the respective field.
For both types of context help currently used, this field always holds the field identifier for the respective field.
This field is currently not used, as no subtypes are currently required.
This field is currently not used as no subtypes are currently required.
This is the language code this entry is written in. The user is prompted with the context help in his personal user interface language.
This is the language code this entry is written in. The user can have the context help in their personalized user language.
This field is intended to be able to differentiate context help text for more or less experienced users. This is currently not used in the application and should always be set to '0'.
This field is used to differentiate between types of context help text for more, or less, experienced users. This is currently not used in the application and should always be set to '0'.
| Code | Text |
|---|---|
| 0 | User Level |
This field contains a descriptive heading of the help text.
In the 'Display Helptext' transaction, the 'Search Key' field can be used to search for texts somewhere in this heading.
The shown help text is made up beginning with this heading followed by an empty line and the the content of the help text content of the field TXT.
This field contains a descriptive name of the helptext.
In the 'Display Helptext' transaction, the 'Search Key' field can be used to search for the name.
This field holds a piece of HTML text, which is used to make up the context help text which is shown to the user when he requests the context help.
In the 'Display Helptext' transaction, the 'Search Key' field can be used to search for texts somewhere in this text block.
The shown help text is made up beginning with the heading taken from field NAM followed by an empty line and the content of the help text content of this field.
This field comprises a short HTML text shown to the user when he/she requests the context help.
This is the user ID of the user who has last changed this database entry. This is a replicated copy of the associated SLG entry.
This is the ID of the user who has last changed this entry. This is a copy of the associated SLG entry.
This is the date when the last change to the database entry has taken place. This is a replicated copy of the associated SLG entry.
This specifies when the database entry was last updated. This is a copy of the related SLG entry.
This field holds the version counter to keep track of the version history of an HLP entry. The individual versions are controlled by entries in the SLG table.
This field holds the version counter used to keep track of the history of an entry of this table. The individual versions are managed by entries in the SLG table.