| Property Name
|
Description
|
| Shown In Wizard |
Determines if the Report is displayed in the Wizard. |
title
|
title
for the Report shown in the Wizard.
|
| Overridable |
Determines if the Report Configuration can be overridden
by the User at runtime. |
| Custom Renderer Package |
Name of the Java package where the custom renderers are
defined. |
| Content Selection Criteria |
Determines whether the Report is based on Categories or
SDCs. |
| Category Option |
Defines Category options. Choose from a list of Categories
that determine the list of SDCs/SDIs included in the Report.
| Property Name | Description | | Category List | List of Categories that determine the list of SDCs/SDIs
included in the Report. | | Excluded SDCs | List of SDCs to be excluded from the Report identified
by the Category list. |
|
| SDC Options |
Options for individually including SDCs.
| Property Name | Description | | SDC | Identifier of the SDC. | | Show | Determines if the chapter is included in the Report. | | Templates Only | Determines if the Report includes only SDI Templates. | | SDI Selection | Determines the selection criteria for including SDIs
in the Chapter.
| Value | Selection Criteria | | Categories | Include by the "List of Categories"
below. | | Where Clause | Include by the "Where Clause " below. | | SDIs | Include by the "SDI List" below. | | All | Inlcude all SDIs. |
| | List of Categories | List of Categories used to determine SDIs to include
with the Chapter. | | Where Clause | Where Clause to filter the list of SDIs to be included
in the Report. | | SDI List | KeyIds of SDIs to be included in the Report.
| Property Name | Value | | SDI | KeyId 1 | | KeyId 2 | | KeyId 3 |
|
|
| Additional Content Options |
In addition to the SDCs and SDIs chosen in "SDC Options",
these determine if additional Chapters/Sections are included.
| Property Name | Includes: | | Include Menu System | Chapter describing the Menu System. | | Include Menu Driven Page/Button Role Matrix | Section showing the Role matrix for all Pages and
Buttons accessible from all Menus. | | Include System Configuration | Chapter describing the System Configuration. | | Include Web Page Role/Button Role Matrix | Section in the WebPage Chapter showing the Role matrix
for all Pages in the Chapter. | | Include SDI Role Matrix | Section in the WebPage Chapter showing the Role matrix
for SDIs. |
|
| Chapter Renderer Options |
Options supported by the renderers. Default values for
the OOB renderers are preconfigured in the relevant Product Nodes.
| OOB Product Node | OOB Preconfigured
Chapters | Data Model
Sitemap Report
System Configuration
SAPPHIREConfig | These Chapters are preconfigured OOB:
| • | Others | | • | SystemConfiguration | | • | WebPage | | • | LVTaskDef |
| | Data Model Document | These Chapters are preconfigured OOB:
| • | Others | | • | LVTaskDef | | • | WebPage | | • | SDC | | • | SystemConfiguration | | | |
|
| Property Name | Description | | Chapter | Chapter to be rendered in the Report. | | Options | Determines what is rendered in the Chapter. The preconfigured
OOB renderers are below.
| | OOB Preconfigured
Options | Chapter | Include
Special
Content | Include
Raw
Tables | Include
Templates
Only | Include
Categories | Include
Raw
Content | Include
Advanced
Propertries | Screen
Shots
Folder | Include
Hidden
Columns | Display
All
Properties | Include
SDC Relationship
Model Only | | Others | x | x | x | x | | | | | | | | WebPage | x | | | x | x | x | x | x | | | | System Configuration | | | | | | | | | x | | | LV_TaskDef | x | x | x | x | | | | | | | | SDC | x | x | x | x | | | | | | x |
For "Option Id", choose the desired rendering option.
For the "Value", choose "Yes" to enable the
option. | | Ignore Differences | Specifies primary and detail table columns that are
not to be marked as changed, regardless of whether or not their values
have changed.
This feature is useful when a new column is added to SDCs and you
do not want the Report to show that all of its SDIs have changed. | Property Name | Description | | Primary Columns | Defines the affected primary table columns.
| Property
Name | Description | | Column Id | Identifier of the primary column. | | Column Label | Label of the column in the Report. |
| | Detail Table Columns | Defines the affected detail table columns.
| Property
Name | Description | | Detail Table | Identifier of the detail table. | | Row/Column | Determines whether the Row or Column is
affected. | | Column Id | Identifier of the detail table column. | | Column Label | Label of the column in the Report. |
|
|
|
| TOC Renderer Options |
Options to render the Table of Contents.
| Property Name | Description | | Chapter Rendering | Determines whether the TOC Chapters are organized
by Categories ("CategoryList") or SDCs ("SDCList"). | | Category List | Choose the options for which you want to define values.
| Property Name | Description | | Category | If "Chapter Rendering" is "Category
List", these are the Categories rendered. | | Category Description | Textual description of the Category to be rendered
in the Report. |
These Categories do not drive the inclusion/exclusion of SDIs in
the Report. They simply guide the generation of the TOC. The TOC shows the Category list sorted alphabetically as the list
of Chapters. For each selected Category (Chapter), the "Sections"
frame shows the list of SDIs belonging to that Category. If a Category contains a heterogenous list of SDIs, all are listed
under the Category under Sections if the Report includes multiple
SDCs. For example, if a Report includes SDCs and Queries, the "CAPA"
Category would show a heterogeneous list of sections that includes
both SDCs and Queries. Under "Sections", all CAPA SDCs
would be shown, followed by all CAPA Queries. | | Hide Subsections | Determines if Subsections within Sections are rendered.
In this case, the Report is generated without a "Summary"
frame. This is useful for dealing with empty Summaries. |
|