Nucleus properties files use several special properties that are indicated by a leading $ character:
| The component’s Java class. |
| The scope of the component (global, session, or request). The default value is global. See the Component Scopes section in this chapter. |
A brief description of the component, for display in the ATG Control Center Components task areas. |
You can set the $scope
and $description
properties in the Basics tab of the ATG Control Center Component Editor.
$description
Given a large number of components in a typical Nucleus application, it can be helpful to document what each component does. You can document your components using the $description
property. For instance, you might describe a Person
component like this:
$description=Holds name and age traits of users
Setting $description in the ATG Control Center
You can set a component’s $description
property in the Basics tab of the Component Editor, by entering the description in the Description field. The Components window displays the value of the $description
property of the active component in the info window, along with the component’s path, class name, and scope.