Short Description

The Short Description field is an unedited text field available on most record 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".

In several cases, the Short 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, Short Description text:

• Applications appear as the current application in the Case Designer and the header on Case Manager portals.
• Classes appear as headers on Application Explorer workspace.
• Flows appear in a list for creating new cases.
• Properties appear when using the Report wizard.

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 Short Descriptions

Definitions