Short Description

The Short Description field is an unedited text field available on most rule and data forms. Developers can enter a brief text description that helps them recognize the object when it is later presented on a list.

Internally, the Short Description field corresponds to the @baseclass.pyLabel property. Short description text is sometimes called the "label" of the object. For work items, this field is conventionally called the "subject". (On some forms, the field for the @baseclass.pyLabel property has the label Description rather than Short Description.)

In several cases, the Short Description (or Description) text is visible to application users as well as to developers. For these cases, it is important to choose wording of the text to be meaningful to users in the context of their work. For example:

• The Description text of an Operator ID data instance appears as the name of the operator on the My Group area of the Process Work workspaces.
• The Description text of certain class rules becomes a work pool name, visible on the WorkUser and WorkManager portals.
• The Short Description text of starter flows appears in a list for entering new work items.
• The Description text for properties appears when using the Report wizard.
• The Short Description text for portal rules appears in the Portal Layout area of the Profile. This feature affects only those users — typically developers — who can access multiple portal layouts.

When an application is localized to support users with multiple languages or locales, the Short Description text that is visible to users can be converted through field value rules to a locale-specific equivalent.

The standard activity @baseclass.StandardValidate requires that property pyLabel have a non-blank value.

	Full Description, locale, starter flow rule, subject, work pool name
	Choosing good Descriptions and Short Descriptions

Definitions — S