Rational Programming Patterns

-GE Lines in Segments

You use these lines to complement the automatic error messages with documentation messages, or to replace the automatic error messages on the Data Elements that are called on the -CE Lines of a Segment.

These error messages are related to errors that are detected by the controls on the Data Element calls. You can modify or complement them on the -GE Lines assigned to the Data Element calls ( -CE Lines). Click the -GE Lines subtab to display the table with the Type, Description, and Link fields.

The values to enter in the Type and Description fields depend on the task you want to perform. The Link field must be used when a Text is called. It must contain the Text instance.

Error
This column displays a dot on all the existing description lines that are not empty.

Moreover, if this line is not correct, this column also displays an error or warning symbol, depending on the severity of the error. A hover help indicates the source of the error.

Type
Select one of the following values:
Table 1. Available line types
Values Comments
* Line not generated for the insertion of a comment or an override
D Declaration of a documentation message
S Replacement of an automatic error message

An automatic message can be replaced with a specific message such as: THE ORDER NUMBER IS REQUIRED Specific messages are indicated on S-type lines assigned to Data Element call lines (-CE Lines tab) in the Segments.

T Call of a Text
Description
You can modify the automatic error messages that are generated for the current instance and generate documentation messages in the same format.
Table 2. Specification of the description field
Line type Content of the Description field
D To complete the error report with extra documentation, enter the following values:

Position 1:

  • 0: Message before a Data Element description
  • 1: Message after a Data Element description
  • 2–5: Message after an error message of type 2 - 5:
    • 2 for an invalid absence of the Data Element
    • 3 for an invalid presence of the Data Element
    • 4 for an erroneous class of the Data Element
    • 5 for an erroneous value of the Data Element

Position 2: blank

Position 3:
  • blank = help message
  • T = call of a Text

Position 4: blank

Position 5: Beginning of the help message or codes of the called Text and paragraph. Two asterisks (**) for the paragraph code call all the paragraphs of the Text.

S To override a message, enter the following values:

Position 1: error type (2, 3, 4, or 5)

Position 2: blank

Position 3: severity of the error (E, C, or W)

Position 4: blank

Position 5: documentation message, or Text and paragraph codes

Link
You use this field when you call a Text (T type line). Click the icon in this field to display a selection wizard.

The selected instance is then automatically displayed in the Description field.

The Description field can be modified for a Text call, in order to indicate generic codes.

Notes:

The Text calls for the documentation are aligned according to a standard print layout.

All the Text calls are aligned (except if the non-alignment $$ parameter was used). The $n print windows that are indicated in the Text are respected. If they are not specified, the default print window ($0) is used.

All the text processing options are functional (underlining, negative indentation...).

Line skips are specified in the Text, but limited to a three-line skip (line skips greater than three become three-line skips); page skips become three-line skips. By default, the skips are one line, except for print windows $0 and $1, where they are two lines.

After you specify your error messages, you must generate them.


Terms of use | Feedback

This information center is powered by Eclipse technology. (http://www.eclipse.org)