In this tab, you specify the content of the Volume. A Volume
can contain titles on various hierarchical levels for clarity purposes.
It can also contain instance descriptions such as the -D
Lines, -CE Lines, -G
Lines, or Keywords. You can call
the instances and the descriptions explicitly in the Volume. You can
also specify a request with selection criteria to dynamically retrieve
the elements that constitute the Volume.
This tab is constituted of three parts:
- A non-editable table that contains the titles, the instances,
and the requests that constitute the Volume. You must use the associated
buttons to complete this table. A contextual menu contains choices
to undo or redo the actions since the last save, copy or paste calls,
or revert to the state of the instance after the last save.
- Buttons that you use to add, remove, or move the calls in the
Volume. You can then call the elements that constitute the Volume
by clicking Add title, Add call,
or Add request.
- Sections that open depending on your selection in the table or
on the line you want to create. These sections contain fields in which
you select or enter the values. When you save, these values are then
moved to the table.
Title line
If you generate the Volume in
an HTML format, the specified title lines are
automatically included in the table of contents, at the beginning
of the generated file. They are also inserted in the Volume body for
an easier reading.
When you click Add title,
the following two fields are available:
- Level
- The title level is mandatory. It structures the Volume into nested
hierarchical levels.
- Text
- The title text is optional. However, entering it is recommended
because the table of contents is automatically generated from the
titles if the Volume is generated with an HTML format.
Call line
In the Volume, you can call existing
instances and specify the descriptions to be included.
When
you click Add call, a selection wizard opens
and displays the instances that can be called. Select one of them
and click OK. The selected instance is then
displayed in the tab as an active link that points to its editor.
You can click Change to select another instance.
By default, all the descriptions and fields of the instance are included
in the Volume.
However, you can use two levels of selection
to filter the descriptions and fields of the instance in the Volume:
- The Filter button can be used to include
or exclude elements that correspond to the structure of the entity
of the called instance. When you click Filter,
a two-page wizard opens. It displays the descriptions and the fields
of the entity, according to their names in the MAF model (Model Access
Facilities). By default, all the descriptions and fields and selected.
You can clear some of them, click OK and save
the Volume. They will not be included in the Volume.
- The Select criterion panel can be used
to refine the selection. You can filter the content according to the
value of some fields. To do so, expand the list in the Description column
and select a description. The Name column then
displays the fields for which you can enter a value. Click the appropriate
line in the Value column and enter a value.
Save the Report. The Report will then include a description only if
contains the entered value.
For example, you can call a Text section
in a Volume. To do so, call a Text instance. In the Description column,
select Sections. The Name column
then displays a Code line. Click the line in
the Value column and enter the section code.
Save the Report.
Request line
When you indicate a request,
you specify select criteria to dynamically call instances in the Volume.
Then, the content of the Volume automatically evolves when new instances
meet the criteria or when old instances no longer meet them.
You
can combine the following select criteria:
- One or more entity types. To do so, select the appropriate entity
types in the Search for field.
- A search string. The * character represents
any strings and the ? character represents
any characters. In the Limit to field, you
can specify whether the string must be searched for in the name, the
label, or the keywords of the instance. You can also indicate whether
the search must be case-sensitive.
- The context of the instances. To do so, select a project in the Context field
and click one of the buttons that represent a hierarchic view of the
projects in the design build path. Context only is
selected by default. It means that only the instances that are found
in the selected project will be included in the Volume. However, you
can select another hierarchy (upper, lower,
or whole). Then, the Volume will include the
instances that are found in the selected project and in the projects
that are hierarchically higher or lower, or in all the projects of
the hierarchy.
- A filter on the descriptions to be included for each selected
entity type. To do so, click Filter. A two-page
wizard opens It displays the descriptions and the fields of the entity,
according to their names in the MAF model (Model Access Facilities).
By default, all the descriptions and fields and selected. You can
clear some of them and click OK. They will
not be included in the Volume.