Property Structures
A property structure displays properties of a resource (folder, document, or link) in a fixed order.
A property structure can be displayed in the following places in the system:
- In the Details dialog box for a document or folder under Settings → Properties.
- When creating or editing a document or folder, using the link Show Properties.
The graphic below shows how a property structure can be structured. A property structure contains properties and property groups. A property group can contain properties and other property groups.
Properties and property groups are ordered in descending order by default. If you activate the parameter Single Focus, properties and property groups are displayed on tabs ordered from left to right.
You can specify properties and groups in the configuration of property structures that you created using the property metadata service.
Property Structures
You can create various display modes and resource types for different property structures. The current property structure is displayed on the user interface depending on the current display mode and resource type.
Resource types are normally provided by applications. Therefore, the option of creating your own resource types is primarily directed at developers.
Parameters of a Property Structure
| Parameter | Required | Description |
|---|---|---|
|
Name |
Yes |
Name of the property structure. |
|
Description |
No |
Description of the property structure. |
|
Single Focus |
No |
Activate this parameter if you want the elements specified in the parameter Structure Items to be displayed as tab pages. |
|
Display Modes |
Yes |
Display modes for which the property structure is to be used. create: Used to display a property structure when creating a document. display: Used to display a property structure to users who only have read access. edit: Used to display a property structure to users who have read and write access. |
|
Resource Types |
No |
Comma-separated specifications of resource types for which the property structure is to be used. Enter ** if you want the property structure to be valid for all resource types for which no other property structure has yet been created. You can use wildcards to specify multiple resource types (for example, http://com.sap.km/coll/**). The system analyzes the wildcards and path levels and uses the property structure that most closely matches the specification. |
|
Structure Items |
No |
Elements contained in the property structure. The elements are displayed on the user interface in the order specified. You can specify predefined properties defined using the property metadata service or property groups (see below). Enter the property ID and its namespace, or the name of the property group, into the input field. The following input formats are permitted: namespace_alias:Property ID or {namespace}Property ID Separate multiple elements with commas. Examples: default:displayname,default:description, all_groups or {http://sapportals.com/xmlns/cm}displayname, {http://sapportals.com/xmlns/cm}description, all_groups |
Property Groups
Property groups can contain properties created using the property metadata service as well as other property groups.
You then specify the property groups in the configuration of a property structure. The elements of a property group are displayed on the user interface in the order specified in the configuration.
Parameters of a Property Group
| Parameter | Required | Description |
|---|---|---|
|
Name |
Yes |
Name of the property group. |
|
Bundle File |
No |
Bundle file. |
|
Key for Label |
No |
Specifies the corresponding key for the displayed label (tab page title). The key and label are stored in the bundle file. |
|
Description |
No |
Description of the property group. |
|
Single Focus |
No |
Activate this parameter if you want the elements of the property group that were specified in the parameter Group Items to be displayed as tab pages. This parameter is only effective in combination with the group renderers standard and unmodeled. |
|
Group Items |
No |
Comma-separated specifications of elements in the group. You can specify predefined properties defined using the property metadata service or other property groups. Enter the property ID and its namespace, or the name of the property group, into the input field. For information about input format, see the parameter Structure Items). The elements are displayed in the order specified. You can use the parameter Property Metadata Group if the elements can be displayed in any order. |
|
Group Renderer |
Yes |
Specifies the group renderer to be used to display the property group. |
|
Property Metadata Group |
No |
Group created using the property metadata service. The display in the Details dialog box is not ordered. If you do not specify a bundle file, the label assigned to this group is used. The parameter is valid for the group renderers standard and unmodeled. |
Group Renderers
Group renderers that are based on Java classes are used to depict property groups on the user interface.
The configuration of a group renderer includes the following parameters:
Parameters of a Group Renderer
| Parameter | Required | Description |
|---|---|---|
|
Name |
Yes |
Name of the group renderer. |
|
Description |
No |
Description of the group renderer. |
|
Group Renderer Class |
Yes |
Java class that implements the group renderer. |
The following group renderers are contained in the standard delivery:
- standard
Displays properties and property groups in a simple layout.
- unmodeled
Displays unmodeled properties (properties that were not created with the property metadata service) that are not defined in the namespace cust ( http://sapportals.com/xmlns/cm/custom ).
Note the following for the group renderers standard and unmodeled: If you have made specifications in a property group in the parameters Group Items and Property Metadata Group , only the corresponding label of the group created using the property metadata service is displayed. The elements (properties) of the group will not be displayed.
- custom
Displays the pushbutton Add next to the properties. This button allows you to create additional properties within the property structure.
If you do not enter a namespace in the input field Name when creating an additional property in the default property structure on the tab page Custom, the property is automatically assigned to the namespace cust and displayed on this tab page. However, if you specify a namespace that was defined in the configuration, the property is displayed on the tab page Miscellaneous. For more information on the possible input format of the namespace, see the parameter Structure Items.
SAP recommends that you only use the group renderers unmodeled and custom once each within a property structure - each in a different group.
To create a property structure, choose Content Management → Global Services → Property Structures → Property Structure.
To create a property group, choose Content Management → Global Services → Property Structures → Property Groups.
To create a group renderer, choose Content Management → Global Services → Property Structures → Group Renderer.
You have to update the elements of the property group all_groups so that the new property groups that you have created are displayed in the Details dialog box. The property group all_groups is used by the property structure DefaultPropertiesStructure, which is used by default for the display of the properties in the Details dialog box.
Open the property group all_groups and enter the new property group in the parameter Group Items in addition to the existing entries.