Most rule forms and data instance forms contain a Short Description field, also known as its label. Internally, the Short Description field corresponds to the@baseclass.pyLabel property. On the Class form, Property form, and Operator ID form, the field for the @baseclass.pyLabel property has the label Description rather than Short Description.
Take a few seconds to choose the text you enter in this field as you save each rule. Your choice can enhance your personal productivity, the productivity of your development team, and affect the usability of your application.
Short Description text is used as follows:
While most Short Description text is less than 30 characters long, enter more than 30 characters when necessary. (The limit is 64 characters.)
In important special cases, Short Description text is visible to application users. Choose text meaningful to such users:
Single Value
property rules, the Short
Description text appears in certain Report Wizard lists.If a standard flow action, flow, or class rule meets your application needs except for its Short Description text, you can override only the Short Description with the Localized Label field in a field value rule.
Changes you make to the Short Description text of a checked-out rule may become visible REALLY? only after you check in the rule. B-19483 RejectedREMOVED You cannot create Short Description text that starts with one of the reserved prefixes "px", "py", or "pz."REMOVED B-16002
For Short Descriptions on other rule types, enter a sentence or phrase that describes how you expect the rule to be used. You need not enter your name, the RuleSet, any key part, or the date, as these facts are present (and searchable) elsewhere in the rule.
The value you enter appears on reports, lists, and SmartPrompt ToolTips. Choose a value that helps you or others select a rule of interest from a possibly long list.
The text in the Description field of an application rule appears as the current application on the Designer Studio Application menu. The name also appears in the Switch Application menu list. Enter a unique, meaningful name. Include a version number if users have access to multiple versions using the same description.
Choose Short Description text that support searches. Longer, specific words (such as Mortgage) are more useful when searching than common short words. To search for a rule based on its Short Description:
Enter
.
For class rules, if you set the
Explorer preference Display Type as Label
,
the Description of each class appears in the
Explorer tree displays. To do this, select Preferences from the Designer Studio profile menu and the select the View item. Change the Display Type to Label
and click
Save . This mode is
most useful for custom work types — the concrete
Work-classes in your application.
B-12483 Short Description or Description text appears as a ToolTip on SmartPrompt displays, when the developer holds a pointer on a row of the selection list. (SmartPrompt displays are primarily accessed by developers, not by application users.)
In some cases, after you update the Short Description or Description of a rule, an internal cache that supports SmartPrompt may become stale; the ToolTip display presents the prior value. To remedy this, delete the on-disk cache using the System Management application:
lookup list, private RuleSet | |
Choosing rule and data instance names |