Data Hierarchy Modifier Builder

Data Hierarchy Modifier Builder

In this topic ...

How do I...
Specifying Inputs
Related Topics ...

Overview: Creating Forms
Page Automation Templates

Use this builder to group data fields generated by a Data Page builder (or one of the many builders that rely on Data Page such as Domino View and Form). By grouping fields we can control the displayed presentation of data fields on the page.
For example, you might have a Data Entry or a Details page with more fields than you are willing to show in a flat list. You can separate the fields into logical groups. This builder lets you create groups and then use drag-and-drop to put the fields into the groups.
This is especially useful when you have defined a Page Automation HTML template so that the Page Automation tools (Data Page and all its associated builders) can construct the entire page to look exactly the way that you want.
By splitting the fields into groups, we can cause the Page Automation system to use the Display Group or Data Entry Group HTML constructs when displaying the data, even though the data is not logically grouped in the schema.
The builder constructs new "Container" elements within the Page Automation contents, in internal representation of the data as it maps to the page. These new containers have a property that they are "Data Transparent" which means that they do not affect the read or write access to the data. However, they are treated as normal containers for the purposes of rendering the page.
The Data Hierarchy Modifier does not affect the structure or layout of the data in the XML variable, bean, or wherever the data source is. Access to the data, both for reading out and for writing back, is unaffected by this builder.

How Do I...?

Visually Group Data Entry or Display Fields?

Assuming you are using the Page Automation builders (Data Page and related builders) to create the form, you can achieve the grouping effect while allowing the Page Automation system to generate the page completely, by using the Data Hierarchy Modifier.
First, create a Data Hierarchy Modifier and select the Container which is the parent of your large list of fields. You should see the fields appear in the table below. Next enter the names of the groups in the "New Group Names" field. Names must be separated by commas and contain only valid alphanumeric characters. (You ll have a chance later to enter labels for the display of the group names.) When you tab off of this field, you should see start and end group tags inserted into the table.
Next, use drag and drop to re-order the fields by placing fields into the groups. We can also hide and show fields, as well as change their labels. In this step, we can also change the labels for the groups, if the "alphanumeric characters" restriction was too limiting.
When you accept this Builder Call, the representation of the data will be changed to include these new groups. If you are using HTML Templates in your Data Page builder, then the new hierarchy will be used to create visual groups when the page is constructed.

Specifying Inputs

The Button builder takes the inputs described in the table below. For help on inputs common to many or all builders such as those in the Properties and HTML Attributes input groups, see "Using the Builder Call Editor."

Input Name Description
Name Enter a name for this builder call. The Designer displays this name in the Builder Call List.
Field Selector Choose the way you want to select the fields that you will place in groups. We can select fields based on:

Name - Fields are listed by label in the table below.
Type - String, Integer, etc. Fields are listed by type in the table below.
Both techniques - Fields are listed by Name and Type in the table below

Fields (Names and/or Types) Use the chooser to select the element that you want to modify with this Data Field Hierarchy builder call. To specify more than one element, make multiple element selections.
Template File Select the HTML Template file you want to use to for the basis of the displayed page.
We can override the template file that will be used for all of the new groups that are created.
It will not affect the selected containers chosen in the Fields and/or Field Types input.
Click here for information about using HTML Page Automation templates.
New Group Names Enter a comma-separated list of the new groups that you would like to create as sub-groups in the selected containers. When you enter these, they will appear in the table, as well, denoted as groups.
New Groups are denoted by leading asterisks.
Don t use spaces in group names. We can change the label for the group name to have spaces, but the actual group name must be a valid Java identifier (only alphanumeric and underscores).
Column Table Use this table to hide or show elements, to change their labels, and to group elements.

Status - Select the display status of an item to Hide, Show or Do Not Change (from status set with other page automation builders such as Data Field Modifier.
Label - Enter an optional label to be displayed for the item

Group Elements - The order of table rows determines what elements will be put in which groups. Every item that follows a group name, (comma delimited list enter above) up to the next group name, will be moved to that group. Group names are preceded by three asterisks (***) in the table.
Only the elements that listed before the first group name will remain in the original container.
Use drag-and-drop to move items among table rows and groups.
Advanced
Unrepresented Fields In some cases the data returned by a bean or SQL Query might change, and additional data fields will be returned. This input allows you to control how those additional fields are handled by the Builder. We can choose:

Fields not represented in the table should be left at the top level - To add new fields above the table groups
Fields not represented in the table should be hidden - To add a new group call but mark it as hidden, and put new fields there
Fields not represented in the table should be added to one of the newly created groups - Choose an existing group and place new fields in it.

Group Field Displayed when you choose to add new fields to an existing group above.
Select the Group to which the new fields will be added.

Input Name	Description
Name	Enter a name for this builder call. The Designer displays this name in the Builder Call List.
Field Selector	Choose the way you want to select the fields that you will place in groups. We can select fields based on: Name - Fields are listed by label in the table below. Type - String, Integer, etc. Fields are listed by type in the table below. Both techniques - Fields are listed by Name and Type in the table below
Fields (Names and/or Types)	Use the chooser to select the element that you want to modify with this Data Field Hierarchy builder call. To specify more than one element, make multiple element selections.
Template File	Select the HTML Template file you want to use to for the basis of the displayed page. We can override the template file that will be used for all of the new groups that are created. It will not affect the selected containers chosen in the Fields and/or Field Types input. Click here for information about using HTML Page Automation templates.
New Group Names	Enter a comma-separated list of the new groups that you would like to create as sub-groups in the selected containers. When you enter these, they will appear in the table, as well, denoted as groups. New Groups are denoted by leading asterisks. Don t use spaces in group names. We can change the label for the group name to have spaces, but the actual group name must be a valid Java identifier (only alphanumeric and underscores).
Column Table	Use this table to hide or show elements, to change their labels, and to group elements. Status - Select the display status of an item to Hide, Show or Do Not Change (from status set with other page automation builders such as Data Field Modifier. Label - Enter an optional label to be displayed for the item Group Elements - The order of table rows determines what elements will be put in which groups. Every item that follows a group name, (comma delimited list enter above) up to the next group name, will be moved to that group. Group names are preceded by three asterisks (***) in the table. Only the elements that listed before the first group name will remain in the original container. Use drag-and-drop to move items among table rows and groups.
Advanced
Unrepresented Fields	In some cases the data returned by a bean or SQL Query might change, and additional data fields will be returned. This input allows you to control how those additional fields are handled by the Builder. We can choose: Fields not represented in the table should be left at the top level - To add new fields above the table groups Fields not represented in the table should be hidden - To add a new group call but mark it as hidden, and put new fields there Fields not represented in the table should be added to one of the newly created groups - Choose an existing group and place new fields in it.
Group Field	Displayed when you choose to add new fields to an existing group above. Select the Group to which the new fields will be added.