GenerateReport command options
The GenerateReport command creates report design files (.4rp) based on a predefined template and schema.
Option | Description |
---|---|
-help or
-h |
Displays a usage text and then exits. |
-schemaFileName Important: Mandatory
option.
|
Specifies an XML schema file (.xsd) describing the data source of the report. |
-rootElementName Important: Mandatory option.
|
Specifies the expected document root in the XML schema file. For example, if
the schema specifies the elements "invoice" and "invoice-batch", then
|
-triggerMapping Important: Mandatory
option.
|
Specifies the mapping between the element names in the XML schema file and the
trigger names in the design template. The map syntax is as
follows:
As
an example, consider a report template designed against the schema defined by
SimpleListTEmplate.rsd.
Note: Report template schema definition
(.rsd) files are located in
GREDIR/templates.
The
schema defines the mappable triggers "
outerGroups ",
"innerGroups " and "rows ", where each is a
descendant of its predecessor. If the input schema defines the elements
"ProductGroups ", "Areas ",
"Orders " and "Items ", then the following are
valid
maps:
The
following example mappings are invalid because they violate the
ancestry:
|
-placeholderMapping |
Specifies the mapping between fields names in the design template and expressions
of the same type that may be composed using fields from the XML schema file.
Specifying this value is mandatory if the template contains references to
fields. Note: All placeholder values in placeholderMapping can either be constant
values or RTL expressions enclosed in curly braces.
The map syntax is as
follows:
This
means that encoders need to perform the following operations on all characters in
the input strings:
As an example, consider a report template that contains:
In this example, the placeholder mapping would be: -placeholderMapping {groupTitle,"{{\"Customer: \"+orderline.orders.user_id}}"}, {reportTitle,"Customer list"},{optionalSubtitle,} This
assigns the RTL expression ' Note: For clarity, no quoting
was done to protect the string against shell expansion.
|
-templateFileName |
Specifies the name of the template (a '.4rp' or
'.4rt' file) used as the base. If this parameter is not
specified, then a default list template is used. The default template is designed
against the schema of the SimpleListTemplate.rsd .Note: Report template schema definition
(.rsd) files are located in
GREDIR/templates.
|
-fieldNamePatterns |
Specifies a selection of fields from the XML schema file that are to be used in
the resulting report. The expected syntax is a comma-separated list of field name
patterns, which may contain the wildcard characters " As an example, consider a report that has
the field triggers "
|
-outputFileName Important: Mandatory
option.
|
Specifies the name of the resulting .4rp file. |
-debuglevel
level |
Sets the debug level to the specified integer level. The debug level controls the level of verbosity of GRE components during execution. Higher values increase verbosity. By default, the value is set to 0 (no debugging output). |
-stdin |
Instructs the program to read the command line arguments from stdin. The list of arguments needs to be terminated by an empty line. In this case, all other regular command line arguments are ignored. |