You must enable javascript in order to view this page or you can go
here
to view the webhelp.
Genero Report Writer User Guide 5.00
Content
Search Results
Index
Loading, please wait ...
Genero Report Writer
User Guide
GRW
5.00 new features
What is
Genero Report Writer
(
GRW
)?
Genero Report Writer
overview
GRW runtime architecture
Get Started with Reports
Steps to a report
Set the Report Writer environment
Quick Start: Create a report
Run the Report
The
Reports
demo
Using the
Reports
demo
Factur-X demo
Run the
Reports
demo
Reports
demo outputs
Genero Report Viewer
Genero Report Viewer for HTML5
Configure printers
The printerinfo command
Configure fonts
Font troubleshooting
The fontinfo command
Fonts in PDF output
The fontinfopdf command
Tips for installing fonts
Adding private characters
Options for data operations
Compatibility reports
Running a compatibility report
Fonts in compatibility reports
MonospaceTest.java
Create a report program
Runtime architecture
BDL programs
Writing the report program
Overview
Tips
Creating a simple report
Fetching report data
From a database using SQL
From a data file
From an XML file
From a Web Service
Output options
Generate a data schema
Allowing the user to select output options
Creating a report with dummy data
Sub reports
When to use sub reports
Coding for sub reports
Creating linked reports
Creating inline reports
Labels
Report Data Wizard
Using the Report Data Wizard
Example Wizard code
Use the example code
Modifying the output
Change report output options
Paper settings and output format
Support for custom paper sources
Print a report
From the server
Without a driver
From the client
Preview a report
View report in the GRV
View report in a browser
Create an HTML report
Create an Excel report
Excel report output
Output a single-sheet document
Create a Microsoft™ RTF report
Create a PDF report
Create an Image report
Create a process-level XML data file
Create non-process-level XML files
Create multi-page ISO reports
Using localized strings with a Genero report application
Finding the translated string
Change localization settings at runtime
gremkstr
Split a report into smaller files
Run multiple reports from data
Optimize the rendering process
GRW BDL reference
Reporting API Functions
Mandatory functions
fgl_report_loadCurrentSettings
fgl_report_commitCurrentSettings
fgl_report_loadAndCommit
Usage: load and commit
Functions to change reporting options
Using report output functions
Output-specific function list
fgl_report_configureAutoformatOutput
fgl_report_configureCompatibilityOutput
fgl_report_configureDistributedEnvironment
fgl_report_configureDistributedProcessing
fgl_report_configureDistributedURLPrefix
fgl_report_configureImageDevice
fgl_report_configureLabelOutput
fgl_report_configureLocalization
fgl_report_configureHTMLDevice
fgl_report_configureMultipageOutput
fgl_report_configureOORTFDevice
fgl_report_configurePageSize
fgl_report_configurePDFDevice
fgl_report_configurePDFFontEmbedding
fgl_report_configureRTFDevice
fgl_report_configureSVGDevice
fgl_report_configureSVGPreview
fgl_report_configureTXTDevice
fgl_report_configureXLSDevice
fgl_report_configureXLSXDevice
fgl_report_setXLSXPageGroupingMode
fgl_report_setXLSPageGroupingMode
fgl_report_createProcessLevelDataFile
fgl_report_findResourcePath
fgl_report_getBrowserURL
fgl_report_getTotalNumberOfPages
fgl_report_runReportFromProcessLevelDataFile
fgl_report_runFromXML
fgl_report_selectDevice
fgl_report_setEnvironment
fgl_report_selectLogicalPageMapping
fgl_report_selectPreview
fgl_report_setAutoformatType
fgl_report_setBrowserDocumentDirectory
fgl_report_setBrowserDocumentDirectoryURL
fgl_report_setBrowserFontDirectory
fgl_report_setBrowserFontDirectoryURL
fgl_report_setCallbackLocalization
fgl_report_setDistributedRequestingUserName
fgl_report_setImageShrinkImagesToPageContent
fgl_report_setImageUsePageNamesAsFileNames
fgl_report_setOutputFileName
fgl_report_setPageMargins
fgl_report_setPaperMargins
fgl_report_setPageSwappingThreshold
fgl_report_setPDFJPEGImageEncoding
fgl_report_setPDFImageResolution
fgl_report_setPDFAttachDocumentModelXML
fgl_report_setPrinterChromaticity
fgl_report_setPrinterCopies
fgl_report_setPrinterDestinationUrl
fgl_report_setPrinterFidelity
fgl_report_setPrinterJobImpressions
fgl_report_setPrinterJobMediaSheets
fgl_report_setPrinterJobName
fgl_report_setPrinterJobPriority
fgl_report_setPrinterJobSheets
fgl_report_setPrinterMediaName
fgl_report_setPrinterMediaSizeName
fgl_report_setPrinterMediaTray
fgl_report_setPrinterName
fgl_report_setPrinterNumberUp
fgl_report_setPrinterOrientationRequested
fgl_report_setPrinterPageRanges
fgl_report_setPrinterPJLVariables
fgl_report_setPrinterPrintQuality
fgl_report_setPrinterRequestingUserName
fgl_report_setPrinterResolution
fgl_report_setPrinterSheetCollate
fgl_report_setPrinterSides
fgl_report_setPrinterWriteToFile
fgl_report_setProcessLevelDataFile
fgl_report_setRenderingHints
fgl_report_setRTFMemoryThreshold
fgl_report_setSharePortWithGDC
fgl_report_setSVGCompression
fgl_report_setSVGCopies
fgl_report_setSVGOrientationRequested
fgl_report_setSVGPageRange
fgl_report_setSVGPaperSource
fgl_report_setSVGPrinterName
fgl_report_setSVGSheetCollate
fgl_report_setXLSHandleBorders
fgl_report_setXLSXHandleBorders
fgl_report_setXLSMergeCells
fgl_report_setXLSXMergeCells
fgl_report_stopGraphicalCompatibilityMode
fgl_report_addPDFAttachment
fgl_report_setPDFFacturXAttachment
Functions to set report metadata
Functions to introspect reports at runtime (librdd)
rdd_getEveryRowFields
rdd_loadRddAndGetReportInfos
rdd_debugReportInfos
Types used in librdd
Functions to get error details
fgl_report_getErrorStatus
fgl_report_getErrorString
Overloadable functions
Pivot table library
Types defined in the pivot library
Pivot library API
pivot_debugPivotTables
pivot_getLastErrorString
pivot_load4rpAndGetPivotTables
Create the data schema
Generate a data schema
Report schema transformations
Options for data operations
Create a report schema transformation
Duplicate data
Create a report design document
Overview of Genero Report Designer
Genero reports
The Report Design window
The Report output
The work area
The Tool Box view
Designing a Report
Launch the Report Designer
Data view
Adding fields from the Data View
Support for arbitrary XML data sources
Placing elements on the report
Absolute or relative positioning
Drag-and-drop objects
Choose containers
Choose report elements
Set up lists in table format
Modify the sizing policy of containers
Modify an object's borders, margins, or padding
Size expressions for bordered boxes
Align and format numbers
Center elements
Position elements at the bottom right
Report Structure view
The tree structure
Triggers
How triggers work
Place a trigger within the report structure
Add headers and footers
Switch child and parent nodes
Example report structure
Properties view
Report Design Document metadata
Using page numbers
Setting the length of a page number
Using a page number string
Display an invoice page number
Group and report totals
Define report totals (Genero BDL)
Display totals on a report
Print totals at the beginning
Specify different pages
Add different first and last pages
Specify a different reverse side page
Start on an odd or even page
Rotating PDF report pages
Design labels
Design address labels
Specify paper settings
Configure the output
Other Report Designer tasks
Change the type of a report element
Design for pre-printed forms
Print a value from the previous page
Show or hide a report element
Use hyperlinks
Hide repeated values
Alternate colors of rows
Compare legacy and graphical reports
Working with tables
Add a table to a report
Assign content to a column
Set the triggers
Merge cells
Add rows or columns
Add headers or footers
Change the width of a table
Change the width of a column
Working with business graphs
Types of business graph
Map charts
Category charts
XY charts
Creating a graph
Create a map chart
Create a category chart
Create an XY chart
Custom keys
Coloring a map chart
Specifying classic or default style
Modify report structure
Output charts as tables
Working with pivot tables
What is a pivot table?
Runtime configurability
Performance considerations
Data types
Sample pivot table reports
Create a pivot table
Organizing pivot table elements
Expressions in properties
RTL expressions overview
Using the expression language
Using RTL classes
Defining PXML expressions
PXML variables
PXML functions
Including RTL variables
Expression examples
Check a field for a value
Change the display based on a condition
Display an image based on a variable
Size a column based on data
Format a number within a string
Debugging your Report Design Document
Report Designer Reference
Report Design Elements (The Toolbox)
Simple Containers
Propagating Containers
Mini Pages
Break
Composed Containers
Table
Paragraph and Text
Drawables
Word and Word Wrap Boxes
PDF Box
Decimal Format Box
Date Format Box
Page Number
Image Box
Configuring XMP metadata
Business Graphs
Map Chart
Map Chart Item
Category Chart
Category Chart Item
XY Chart
XY Chart Item
Pivot Table
Pivot Table Hierarchy Value
Pivot Table Fact
Pivot Table Measure
References
Reference Box
Info Node
Bar Code Boxes
Other Markup
HTML Box
Rich Text Box
CSS support
Supported HTML elements
Report Element Properties
General Properties
Alignment (alignment)
Alignment (align)
Anchor X (anchorX)
Anchor Y (anchorY)
Background Color (bgColor)
Baseline Type (baselineType)
Bold (fontBold)
Class (class)
Clip (clip)
Color (color)
Comment (comment)
Default (referenceDefault)
Field Name (fieldName)
Fill (fill)
Floating Behavior (floatingBehavior)
Format (format)
Format (pageNoFormat)
Hang (hang)
Hide Page Footer On Last Page (hidePageFooterOnLastPage)
Hide Page Header On Last Page (hidePageHeaderOnLastPage)
href (href)
id (id)
Indent (indent)
InfoNode Name (referenceName)
Intended Resolution (intendedResolution)
Italic (fontItalic)
Layout Direction (layoutDirection)
Localize Text (localizeText)
Location (location)
Name (name)
Name (fontName)
Name (pageName)
Offset (pageNoOffset)
Page Ranges (pageRanges)
Parent Group (suppressionInitializer)
Password (password)
Rich Text (richText)
Role (fieldRole)
Scale X (scaleX)
Scale Y (scaleY)
Section (section)
Show On New Page (showFirstRepetitionOnPage)
Size (fontSize)
Split Oversized Items (splitOversizedItem)
Strikethrough (strikethrough)
Suppress (suppressRepetitions)
Swap X (swapX)
Text (text)
Text Alignment (textAlignment)
Text Expression (textExpression)
Text Fidelity (fidelity)
Transform transparently (transformTransparently)
Trim Text (trimText)
Type (objectType)
Type (richTextType)
Underline (underline)
URL (subReportUrl)
Value (value)
Visibility Condition (condition)
X (x)
X-Size (X-Size)
X-Size Adjustment (X-Size Adjustment)
Y (y)
Y-Size (Y-Size)
Y-Size Adjustment (Y-Size Adjustment)
Properties specific to charts
Category Key (categoryKey)
Categories Title (categoryTitle)
Color (chartColor)
Compute aggregates on the innermost dimension (computeAggregatesInnermostDimension)
Compute Average (computeAverage)
Compute Count (computeCount)
Compute Distinct Count (computeDistinctCount)
Compute Maximum (computeMaximum)
Compute Minimum (computeMinimum)
Compute Totals (computeTotal)
Display Fact Rows (displayFactRows)
Display Recurring Dimension Values (displayRecurringDimensions)
Display Selection (displaySelection)
Domain Lower Bound (domainLowerBound)
Domain Upper Bound (domainUpperBound)
Draw As (drawAs)
Draw Labels (drawLabels)
Draw Legend (drawLegend)
Enum Values (enumValues)
Hierarchies input order (hierarchiesInputOrder)
Key (key)
Keys Title (keysTitle)
Numeric Column (isNumeric)
Output Order (outputOrder)
Range Lower Bound (rangeLowerBound)
Range Upper Bound (rangeUpperBound)
Series Title (seriesTitle)
Sort Ascending (sortAscending)
Sort By (sortBy)
Title (title)
Top N (topN)
Values Title (valuesTitle)
X (x)
xAxisTitle (xAxisTitle)
Y (y)
yAxisTitle (yAxisTitle)
Properties specific to tables
Border (border)
Border Color (tableBorderColor)
Bottom Border (bBorder)
Column Span (colspan)
Fix Width (fWidth)
Horizontal Alignment (hAlign)
Horizontal Padding (hPadding)
Horizontal Rule (hRule)
Left Border (lBorder)
Padding (padding)
Proportional Width (pWidth)
Right Border (rBorder)
Rule (rule)
Rule Color (ruleColor)
Top Border (tBorder)
Type (tableHFType)
Vertical Alignment (vAlign)
Vertical Rule (vRule)
Vertical Padding (vPadding)
Properties specific to bar codes
Check (check)
Code Type (codeType)
Code Value (codeValue)
Code Value Expression (codeValueExpression)
Control Characters (controlCharacters)
Data Symbols per Line (dataSymbolsPerLine)
Encoding (encoding)
Error Correction Degree (errorCorrectionDegree)
Hide Text (noText)
Number Check Digits (noCheckDigits)
Number Digits (noDigits)
Prefer Rectangular Symbols (preferRectangularSymbols)
Raw Code Value (rawCodeValue)
Smart Parse (smartParse)
Symbol Height (symbolHeight)
Symbol Specification Table (symbolSpecificationTable)
Thin To Gap Relation (thinToGapRelation)
Thin To Thick Relation (thinToThickRelation)
X Dimension (xDimension)
Properties related to margins and borders
Margin width properties
Width (marginWidth)
Top Width (marginTopWidth)
Right Width (marginRightWidth)
Bottom Width (marginBottomWidth)
Left Width (marginLeftWidth)
Border width properties
Width (borderWidth)
Top Width (borderTopWidth)
Right Width (borderRightWidth)
Bottom Width (borderBottomWidth)
Left Width (borderLeftWidth)
Border style properties
Rounded Corners (roundedCorners)
Style (borderStyle)
Top Style (borderTopStyle)
Right Style (borderRightStyle)
Bottom Style (borderBottomStyle)
Left Style (borderLeftStyle)
Border color properties
Color (borderColor)
Top Color (borderTopColor)
Right Color (borderRightColor)
Bottom Color (borderBottomColor)
Left Color (borderLeftColor)
Padding width properties
Width (paddingWidth)
Top Width (paddingTopWidth)
Right Width (paddingRightWidth)
Bottom Width (paddingBottomWidth)
Left Width (paddingLeftWidth)
PDF cropping width properties
Crop Top Width (cropTopWidth)
Crop Right Width (cropRightWidth)
Crop Bottom Width (cropBottomWidth)
Crop Left Width (cropLeftWidth)
Properties for report metadata
Bar Codes
Bar Code type listing
Bar Code type details
codabar-2
codabar-18
code-11-matrix
code-128
code-2-5-datalogic
code-2-5-IATA
code-2-5-industrial
code-2-5-interleaved
code-2-5-inverted
code-2-5-matrix
code-BCD-matrix
code-32
code-39
code-39-extended
code-93
code-93-extended
data-matrix
ean-8
ean-13
ean-code-128
ean-data-matrix
ean-supplemental-2
ean-supplemental-5
gs1-8
gs1-13
gs1-code-128
gs1-data-matrix
gs1-qr-code
gs1-supplemental-2
gs1-supplemental-5
intelligent-mail
OMR
pdf-417
qr-code
upc-a
upc-e
upc-supplemental-2
upc-supplemental-5
RTL Class Reference
RTL Classes Overview
The Boolean Class
The Calendar Class
compareTo()
fromDate()
toDate()
addYear()
addMonth()
addWeekOfYear()
addDayOfMonth()
addHourOfDay()
addMinute()
addSecond()
getActualYearMaximum()
getActualYearMinimum()
getActualMonthMaximum()
getActualMonthMinimum()
getActualWeekOfYearMaximum()
getActualWeekOfYearMinimum()
getActualDayOfMonthMaximum()
getActualDayOfMonthMinimum()
getActualHourOfDayMaximum()
getActualHourOfDayMinimum()
getActualMinuteMaximum()
getActualMinuteMinimum()
getActualSecondMaximum()
getActualSecondMinimum()
getYear()
getMonth()
getWeekOfYear()
getWeekYear()
getDayOfMonth()
getWeeksInWeekYear()
getFirstDayOfWeek()
getMinimalDaysInFirstWeek()
getHourOfDay()
getMinute()
getSecond()
getInstance()
rollYear()
rollMonth()
rollWeekOfYear()
rollDayOfMonth()
rollHourOfDay()
rollMinute()
rollSecond()
setActualYearMaximum()
setActualYearMinimum()
setActualMonthMaximum()
setActualMonthMinimum()
setActualWeekOfYearMaximum()
setActualWeekOfYearMinimum()
setActualDayOfMonthMaximum()
setActualDayOfMonthMinimum()
setActualHourOfDayMaximum()
setActualHourOfDayMinimum()
setActualMinuteMaximum()
setActualMinuteMinimum()
setActualSecondMaximum()
setActualSecondMinimum()
setYear()
setMonth()
setWeekOfYear()
setDayOfMonth()
setFirstDayOfWeek()
setMinimalDaysInFirstWeek()
setHourOfDay()
setMinute()
setSecond()
setLocale()
setTimeZone()
The Color Class
fromHSBA()
fromRGBA()
brighter()
darker()
getAlpha()
getBlue()
getBrightness()
getGreen()
getHue()
getRed()
getRGBA()
getSaturation()
toCharSequence()
The Context Class
getAncestorRepeatingRegion
getRepeatingRegion
The Date Class
format()
fromIsoValue()
fromString()
parseString()
today()
toString()
The Enum Classes
The Alignment Class
The BaselineType Class
The BorderStyles Classes
The CategoryChartDrawAs Class
The CodeType Class
The FloatingBehavior Class
The LayoutDirection Class
The MapChartDrawAs Class
The PageNoFormat Class
The Section Class
The SortBy Class
The TextAlignment Class
The TrimText Class
The X-SizeAdjustment Class
The XYChartDrawAs Class
The Y-SizeAdjustment Class
The FGLNumericVariable Class
The FGLStringVariable Class
The Numeric Class
abs()
atan2()
byteValue()
cbrt()
ceil()
cos()
cosh()
exp()
floor()
format()
getExponent()
intValue()
isInfinite()
isNaN()
isNull()
log()
log10()
max()
min()
rint()
round()
signum()
sin()
sinh()
sqrt()
tan()
tanh()
toBoolean()
toChar()
toColor()
toDegrees()
toRadians()
toString()
getPhysicalPageNumber()
getTotalNumberOfPhysicalPages()
getPageNumber()
getTotalNumberOfPages()
The RepeatingRegion Class
getLocalIndex
getGlobalIndex
getName()
The Runtime Class
getDebugLevel()
getEnvironmentVariable()
getOutputDeviceName()
getPrinterMediaName()
getPrinterMediaSizeName()
getPrinterMediaTray()
getPrinterName()
getSVGPaperSource()
getSVGPrinterName()
inDesigner()
producingBrowserOutput()
producingExcelOutput()
producingHLPXMLOutput()
producingHTMLOutput()
producingImageOutput()
producingOORTFOutput()
producingPDFOutput()
producingPostscriptOutput()
producingPrinterOutput()
producingPXMLOutput()
producingRTFOutput()
producingSVGOutput()
producingXLSOutput()
producingXLSXOutput()
producingForPreview()
xlsPagesAreMerged()
The String Class
charAt()
contains()
endsWith()
equals()
equalsIgnoreCase()
format()
indexOf()
isEmpty()
isNull()
lastIndexOf()
length()
matches()
replace()
replaceAll()
replaceFirst()
startsWith()
substring()
toLowerCase()
toNumeric()
toString()
toUpperCase()
translate()
trim()
trimCompress()
trimLeft()
trimRight()
urlEncode()
The Util Class
fileIsReadable()
urlIsReadable()
Dimensions
Unit Names
Paper Format Abbreviations
Report Writer preferences
File extensions
Create and manage report templates
Create a report from an existing template
Template filters
Schema Association page
Add Fields page
Variables page
Create a new report template
Report template schema definition file (.rsd)
Report template (.4rt) file design features
Template field triggers
Template fields
Customize template appearance
Create a report template from an existing report
Modify an existing report template
Generic reports
Simple list or form list
Other template types
Set the report template directory
GenerateReport command options
Example 1: Placeholders
Create the report template files
Use the template to create the report
Example 2: Data groups and repetitions
Create the report template files
Use the template to create the report
Example 3: Dynamic list
Create the report template files
Use the template to create the report
Deployment and customization
Deployment architecture
Non-distributed mode
Local distributed mode
Architecture
Setting up
Remote distributed mode
Architecture
Setting up
Start the Web server service
Capabilities to manage a Windows® service
Genero Report Viewer for HTML5
GRE
environment variables
GREDIR
GREOUTPUTDIR
GRE_MAX_CONCURRENT_JOBS
GREDEBUG
GRE_DEFAULT_IMAGE_URL
GRESERVER
GREDATAFILE
DBMONEY and DBFORMAT
Troubleshooting
Report Writer error messages
Genero Report Engine
error messages
Redirect
GRE
log messages to a file
Report an issue to support
Upgrading
New Features
GRW
5.00 new features
GRW
4.01 new features
GRW
4.00 new features
GRW
3.21 new features
GRW
3.20 new features
GRW
3.10 new features
GRW
3.00 new features
GRW
2.51 new features
GRW
2.50 new features
GRW
2.41 new features
GRW
2.40 new features
Upgrade Guides
GRW
5.00 upgrade guide
GRW
4.01 upgrade guide
GRW
4.00 upgrade guide
GRW
3.21 upgrade guide
GRW
3.20 upgrade guide
GRW
3.10 upgrade guide
GRW
3.00 upgrade guide
GRW
2.50 upgrade guide
GRW
2.41 upgrade guide
GRW
2.40 upgrade guide
GRW
2.30 upgrade guide
GRW
2.20 upgrade guide
Update report design documents
File types and extensions
Legal Notices
Copyrights and Trademarks
Your browser does not support iframes.