Viewing: Creating Domains > Using the Domain Designer > The Properties Panel

The Properties Panel

Table of Properties on the Display Tab of the Domain Designer

In the Properties panel of the Display tab, you can view, edit, and save the properties of a set or item. You select an item in the Sets and Items panel, and click the Edit button. For example, open the Simple Domain example in the repository for editing. On the Display tab, select the Opportunities: Amount item, then click the Edit button in Properties. Set the Data Format and Summary Function, as shown in the previous figure. Click the Save button. The property settings determine how sets and items appear to users of the Domain.

The following table shows the properties and possible actions you can perform on them, depending on what you select in the other panels. For example, if you select the ID of a table in the Resources panel, you can view and edit the ID.

Panel

Selection

Properties

Possible actions

Resources

(Table List view)

Table

ID of the table
Name of the data source
Name of the table in the data source
View and edit
View only
View only

Resources

(Table List view)

Field (column)

ID of the field
Name of the data source
Name of the field’s table in the data source
Java datatype of the field
View only
View only
View only
View only

Resources

(Join Tree view)

Table, field, or join tree

None

None

Sets and Items

Set

Label of the set
ID of the set
Description of the set
Internationalization keys for the set
View and edit
View and edit
View and edit
View and edit

Sets and Item

Item

Label of the item
ID of the item
Description of the item
Internationalization keys for the item
Source, table.field
Data format
Default summary function
Field or measure
View and edit
View and edit
View and edit
View and edit
View only
View and edit
View and edit
View and edit

Labels and descriptions are visible to users of the Domain. Descriptions of sets and items appear as tooltips in the Ad Hoc Editor to help report creators understand their purpose. The internationalization keys are the property names of strings in locale bundles. Selecting an item in Sets and Items displays the internationalization keys, if any, for the item under Bundle Keys.

After defining the list of sets, subsets and items, refine the Domain's appearance by renaming and providing descriptions for sets, subsets, and items. Click Edit in the Properties panel to modify properties. The following table describes each of the properties in detail:

Property

Appears On

Description

ID

Table, Field
Set, Item

An identifier used within the Domain. Default table and field IDs are based on the names in the data source, but you can change the ID of a table as long as it remains unique. Set and item IDs are a separate namespace in which each ID must be unique, although based on table and field IDs by default. The ID property value must be alphanumeric and cannot start with a digit.

You should not change IDs for a Domain that has been used to create Topics and reports. See Maintaining Referential Integrity.

Data Source

Table, Field

Alias of the data source for the selected field or table.

Source Table

Table, Field

Name of the selected table, or of the field’s table, in the data source. Does not change when the ID property of a table is modified.

Datatype

Field

Java datatype of the selected field.

Label

Set, Item

User-friendly name displayed in the Data Chooser and the Ad Hoc Editor.

Description

Set, Item

User-friendly description displayed as tooltip on the label in the Ad Hoc Editor. The description helps the report creator understand the data represented by this set or item.

Label Key
Description Key

Set, Item

Internationalization keys for the label and description properties; locale bundles associate this key with the localized text for the label or description. Keys may use only characters from the ISO Latin-1 set, digits, and underscores (_).

Source

Item

References the Domain names of the table and field associated with this item; the syntax is Domain_jointree.Domain_table.datasource_field.

Data Format

Item

Default numerical format (such as number of decimal places) for the item when used in a report.

Summary Function

Item

Default summary function of the item when used in a report. The available functions depend on the field's data type (Boolean, date, numeric, or text). See Summary Calculations for more information.

Field or Measure

Item

Designates the item as either a qualitative value (field) or quantitative value (measure). By default, all numeric types are assumed to be measures, and all non-numeric items are plain fields. Use this setting to override the default. For more information, see Terminology.

You can use the Export menu to export the design or locale bundle, as described in the next section.