Welcome to the JReport Server End User`s Guide

Welcome to the JReport Server End User`s Guide
Welcome to the JReport Server End User's
Guide
This User's Guide is written for report end users specifically. It describes JReport Server, which is a
100% Java report generation and management tool that can be deployed to any Java EE application
server. By leveraging its high performance report generation engine, JReport scales to meet the most
demanding requirements. Using the report scheduling, distributing and alerting capabilities of the
JReport Server, reporting can be integrated into the workflow of the application.
Other JReport documentation
This guide is one in the complete JReport documentation set. The documentation set includes the
following:
●
JReport Tutorial
●
JReport Server User's Guide
●
JReport Designer User's Guide
●
JReport Server Monitor User's Guide
●
JReport Desktop Viewer User's Guide
●
JReport API Javadoc
Basic Concepts
This chapter gives you some basic JReport Server concepts. You can first go through this chapter to gain a general
understanding about JReport Server before you use it. Also, while you are using JReport Server, if you do not understand any
of the basic concepts, you can refer to this chapter to get help.
Background tasks
JReport Server provides a background running system, which shows the status information of tasks submitted using the Run,
Advanced Run, or Background Run mode. Status information includes: report tab names, report path and name, catalog path
and name, running format, time when the task is started/completed, time elapsed since the task is performed, and the status
of the task. It allows you to view detailed information in a timely fashion.
The records saved in the background running system are cleared under the following conditions:
●
JReport Server is restarted.
●
The maximum time limit specified for the report result life has been reached. By default it is 86400 seconds (24 hours).
●
●
The maximum time limit specified for the interval between a user logout and login has been reached. By default it is 300
seconds.
If the number of records exceeds the number specified for the background task list (by default it is 100 records), the latest
100 records will be retained.
Interactive reporting
JReport Server provides you with interactive reporting of DHTML reports. DHTML allows you to control objects such as images,
buttons, text fields, checkboxes, radio buttons, and drop-down lists.
With interactive DHTML output, you can dynamically modify - filter, search, sort and drill - reports to obtain unique and
personal data views. The DHTML toolbar and interactive web objects can be embedded into reports or JSPs at design time,
enabling you to control, customize and navigate report views. JReport further extends interactive reporting by empowering
applications with ad hoc reporting. You can define report criteria and layout at runtime to generate interactive ad hoc reports.
Scheduling
JReport Server provides a scheduling system which you can customize to suit your requirements. You can submit a scheduled
task from web page and URL or by calling the Server and Client API methods. However, before you can do this, you must first
specify the report, catalog, task type and its launch type. In addition, you can also customize notification messages to notify
others of whether or not the task is executed successfully.
Resource
JReport Server provides a resource system for managing a group of archive versions that can be processed or organized.
What is a resource
Generally, a resource refers to report or dashboard related material. To be exact, a resource in the JReport Server reporting
system is a conceptual node. There are different types of resources, such as catalogs, reports, dashboards, library
components, and their results. A resource can only hold versions of the same type.
Resource tree
All the resources are organized in a folder-tree structure. JReport Server defines an XML file called admin.xml, and the
resource tree conforms to this file. This file is maintained automatically by JReport Server.
For example, your company has two departments - Support and Marketing. Each department has its reports on their own
machine. There are some report documents that are submitted by the departments located on the machine where JReport
Server runs. Now, suppose you are the administrator, and you would like to organize these files and folders into the Resource
Tree. The following diagram may help you to figure out the framework on which you should build the resource tree.
The resource tree consists of the following three layers:
●
●
●
Folder layer: Basic resource tree element that builds the main framework for the resource tree. There are two built-in
folders in the root of the resource tree -- Public Reports and My Reports. A folder can be mapped to a real file path.
Resource layer: An abstract layer, based on the Folder layer that hosts various types of archive versions and provides
user access to the versions.
Archive layer: A concrete layer, where the archive versions reside for executable reports, report catalogs, and report
results, which function as the leaves of the resource tree.
Public Reports and My Reports
There are two built-in folders in the resource tree root - Public Reports and My Reports. You can create your own folders in
either of them. The Public Reports folder and the My Reports folder cannot be deleted.
The Public Reports folder contains public report documents and executable reports, and can be accessed by everyone. All
folders except for the personal folders are public folders.
The My Reports folder is a personal folder. It contains personal report documents and executable reports. Each user has one
personal folder, specified by the administrator when the user account is created. The My Reports folder can only be accessed
by its owner, and the user has full control over his/her personal folder. This folder is the default output location for reports run
by the user.
Reports
There are two types of reports in JReport: page reports and web reports. A page report is a collection of report tabs and each
report tab can have multiple pages, while a web report has no report tabs and is always displayed as a web layout report with
just one page.
JReport Server supports viewing, advanced running, scheduling and managing of reports. The background run/scheduled/
active/completed record are based on report level.
When viewing a page report directly, if DHTML is set as the default report view format, the page report with all its report tabs
will be run. Otherwise, only the default selected report tab will be run.
When using Advanced Run to run a page report, you can only select one report tab in the page report to run.
When using scheduling to publish a page report to the versioning system or to disk, the DHTML and JReport Result formats
are based on the report level, that is, the report with all selected report tabs will be output to a single file. As for the other
formats, each selected report tab will be output to a separate file but you still have the convenience of scheduling all the
report tabs with a single schedule entry.
Public Components and My Components
Public Components and My Components are two built-in folders in the resource tree root for storing library components. Their
behaviors resemble the Public Reports and My Reports folders.
The Public Components folder contains public components and can be accessed by everyone. The My Components folder is a
personal folder that contains personal components for each dashboard user.
Library components
Library components are used to build dashboards. They are able to present data via intuitive components such as charts,
crosstabs, tables, and Google maps. Library components are created and edited using JReport Designer, and then are
published to the component library on JReport Server for use in dashboards.
Version
JReport Server provides a versioning system for controlling the resources contained in the resource tree. To understand what
the versioning system is, first you have to understand the resource mechanism in JReport Server. A resource in the JReport
reporting system is a conceptual node, which holds a group of archive versions that can be processed or organized in JReport
Server. Information of these versions is stored in the System DB database that JReport Server uses, while version files are
saved in the directory - <reporthome>\history.
What is a version
All the server resources in the resource tree are controlled by versions. A version is the fundamental unit of the resource tree,
and your resources might change over time. JReport Server uses a versioning system to create and manage resources that
have changed in content and properties owing to updates issued upon them.
All the resources in the resource tree have versions. A large portion of resource management tasks are done by managing
resource versions.
Different version types
The versions in JReport Server fall into the following major categories:
●
●
●
Catalog Version
The version of a catalog file.
Report Version
The version of a report file.
Result Version
The version of a report result file.
The report result can be generated and maintained in two places - the resource tree and the built-in version folder.
When you schedule a report to publish to the versioning system, you can choose an archive location to generate the report
result. You can generate the report result in the built-in version folder, the My Reports folder or the Public Reports folder in
the resource tree.
The report results generated in the resource tree are standalone results and can have their own versions, while those
generated in the built-in version folder can only be bound with their respective reports.
●
●
Dashboard Version
The version of a dashboard file.
Library Component Version
The version of a library component file.
Real path of versions
If you check the property of a version, you will find its real path. Remember that version information is stored to a database,
and version files are stored in the directory <reporthome>\history. For the report InvoiceReport.cls, the report version's real
path is <reporthome>\history\1\JReport_System_User894485281\InvoiceReport.cls, which is the actual report result
path on disk and stored in the server database. That is, when you click the InvoiceReport.cls report result resource on the
server interface, you are accessing it on the disk, only the path to it is stored in the database. And this works the same for the
other types of versions.
Archive policy
JReport Server uses an archive policy to control the resource versions. You can control whether or not to use multiple versions
for a specific resource. Also, you can define the maximum number of versions that can be listed in the version table.
The archive policy can be applied to a single resource individually, or to many resources in a folder as a whole.
Accessing JReport Server
You can access JReport Server through a web browser such as Internet Explorer, Netscape or Firefox.
Starting and logging onto JReport Server
To log onto JReport Server, first start the server via one of the following ways:
●
Double-click the JReport Server 11.1 shortcut on your desktop.
●
Click Start > All Programs > JReport 11.1 > Server > Start JReport Server.
●
Run the JRServer.bat/JRServer.sh file located in <install_root>\bin.
●
Run the startup file from a MS-DOS command prompt. For example, assume that JReport Server has
been installed in C:\JReport\Server, you can type the following commands:
C:\>cd JReport\Server\bin
C:\JReport\Server\bin>JRServer.bat
Then,
1. Click Start > All Programs > JReport 11.1 > Server > JReport Server Console, or open a
web browser and set the URL to http://ip_or_hostname:port (by default, the port for accessing
the JReport Console page is 8888).
2. On the Welcome page, type your user name and password as assigned by your administrator. For
first time users, the default user name and password are admin.
3. Click Login and the JReport Console page will be displayed.
Tip: If you don't know the IP address of the machine on which the server runs, and if it is the same
machine where you run your web browser, you can use localhost instead of the IP address. You can
also open a console window on the machine and type hostname, then the name of the host will be
displayed.
Fast launch pad for local users
Local users can also access JReport Server in a fast way with the launch pad, which is a convenient
entry to access the server without having to start it. The launch pad provides some key functions of
JReport Server by setting up the connections to corresponding JReport Server JSP's, which are:
●
Viewing the JReport sample reports
●
Creating ad hoc reports
●
Scheduling to run reports by time or event
●
Configuring server profiles to customize the server interface and functionality
●
Managing security principals
●
Visiting the JReport Demo Center
To access the launch pad, click Start > All Programs > JReport 11.1 > Server > JReport Server
Launch Pad.
Logging off and shutting down JReport Server
To log off JReport Server, click the Logout link on the upper right corner of the JReport Console page.
To shut down JReport Server normally:
●
●
In a standalone environment, click Start > All Programs > JReport 11.1 > Server > Stop
JReport Server.
In an integrated environment, shut down the application server according to the vendor's
instructions.
Also, JReport provides a feature for handling an abnormal system exit that enables the program to
close itself gracefully when the virtual machine is terminated in response to a user interrupt, such as
typing ^C, or a system-wide event such as user logoff or system shutdown.
Working with Reports
After successfully logging onto the JReport Console page using the user name and password assigned
by your administrator via a web browser, you can then perform tasks according to your requirements.
For example, you can view reports in different formats and schedule tasks for the reports.
Pick a task from the following:
●
Running reports
●
Scheduling reports
●
Using built-in functions to set date and time parameter values
Related topics:
●
Publishing Resources
●
Setting Resource and Folder Properties
●
Managing versions
●
Managing Tasks
Tip: You can customize the JReport Console > Resources page to suit your requirements by setting
your own preferences. To do this, click Tools > Preferences on the task bar of the Resources page,
then specify the settings in the Preferences dialog as required. For example, you can specify the default
viewing format when directly run a report from this page, set which columns will be shown in the
resource information table, and predefine the properties for each export format which will be applied
when you run or schedule a report on this page.
Running reports
If you know the default format for viewing reports and this format is what you expect, use directly
running. If you would like a different view format or to customize some other information such as
parameter values, the running priority, how to save the result, the expiration time, and so on, use
advanced running.
Directly running
Directly running reports is to use the default format setting to view the report result. For page reports (.
cls• the default format is DHTML and they will run in JReport Viewer. For web reports (.wls) they will be
opened in JReport Studio by default.
If the reports are created on JReport Server, the default format is controlled by the Default Format for
Viewing Report option in the Profile > Customize Server Preferences > General tab. When this option is
set to DHTML or Applet, web reports will run in JReport Studio by default.
If the reports are created using JReport Designer, the default format is controlled by the Default
Format for Viewing Report property in the Report Inspector. If this property is set to <Server Setting>,
the viewing format will be determined by the above setting on server. For page reports this property is
available to each report tab in the reports, while for web reports it is available to each report.
Since a page report can contain multiple report tabs and these report tabs may have different default
format settings, for example, report tab 1 is DHTML, tab 2 HTML and tab 3 Excel. In this case, there
will be different directly running results according to which report tab was the last-time focused tab in
the page report when the page report was saved at report design time. If it was report tab 1, all the
tabs in the page report will be opened in the DHTML format in JReport Viewer. If it was report tab 2 or
3, only tab 2 or 3 will be displayed, and this applies to all the other formats except DHTML.
To directly run a report, on the JReport Console > Resources page, browse to the report, then do one
of the following:
●
Click the name of the report in the Name column of the Resources page.
●
Select the report row and click Run > Run on the task bar of the Resources page.
●
Select the report row, right-click in the row and select Run from the shortcut menu.
●
Put the mouse pointer over the report row and click the Run button
on the floating toolbar.
Advanced running
1. On the JReport Console > Resources page, browse to the report you want to run.
2. Do either of the following:
❍
Select the report row, then on the task bar of the Resources page, click Run > Advanced Run.
❍
Select the report row, right-click in the row and select Advanced Run from the shortcut menu.
❍
Put the mouse pointer over the report row and click the Advanced Run button
floating toolbar.
on the
The Advanced Run dialog is then displayed.
3. In the General tab, for a page report, you need to select a report tab in the page report you want
to run (only one report tab in a page report can be run in Advanced mode at a time). If the report
has parameters, specify the parameter values as required (for details, see General tab Parameters). Then, specify the other options as required.
4. In the Format tab, choose a format to view the report result, and set the other settings.
5. In the Archive tab, archive the report result version according to your requirements.
6. If you want to limit the amount of time that the report is allowed to run, in the Duration tab,
specify a time duration for the task, and ask JReport Server to cancel the task or to notify you or
someone else of the task status via e-mail if the task has not yet finished running when the task
duration is up.
7. Click Finish to view the report in the format you specified.
When running a page report to DHTML, the report processing page will appear, on which you can
choose to cancel the running of the report, or to make the report run in background mode. Click
Cancel on this page if you decide to cancel, Background if you want the report to run in
background mode, or just wait for processing to complete.
See also Advanced Run dialog for details about options in the dialog.
Notes:
●
●
If you choose to view a page report in DHTML format, besides the selected report tab, all the other
tabs in the report will also be run.
By default, the Duration tab is not displayed in the Advanced Run dialog. To make it available, the
Enable Task Duration option on the JReport Administration page > Configuration > Advanced panel
must have been enabled by the administrator.
Running a DHTML report in background mode
When you run a report in DHTML format, if the report contains a large amount of data, you need to
wait several minutes before the report results are displayed, and during this period, you have to remain
on the report processing page, or choose to cancel the run. Now JReport enables you to switch running
reports to background mode.
To make a report running in DHTML to run in background mode, on the report processing page, click
the Background button.
You can also specify to run DHTML reports automatically in background mode after a specified time
period by setting preferences. To do this:
1. On the JReport Console page, click Profile on the system toolbar, then click Customize Profile on
the task bar of the Profile page.
2. Click the DHTML > Properties > Advanced tab.
3. Check Background Mode Timeout and specify the time allowed for a DHTML report to run in
foreground mode.
4. Save the settings, then when a report runs in DHTML format and the results have not yet been
generated after the specified time, it will be automatically switched to run in background mode.
Reports running in background mode are listed in the Background Tasks table of the My Tasks page,
which shows detailed running information of the reports, such as report path and name, catalog path
and name, running format, time when the task is started/completed, and so on. Also, you can control
the status of the reports running in background mode according to your requirements. For example,
you can choose to delete, stop, or restart tasks (for details, see Managing tasks in the task tables).
When a report completes running in background, you can open it from the Background Tasks table, and
once the report is opened, the task will automatically be removed from the table.
Scheduling reports
JReport Server can run reports at a specified time or periodically by scheduling tasks for reports. The
scheduled tasks will be recorded by the server according to their different executing status.
Pick a task from below:
●
Scheduling tasks for a report
●
Importing and exporting scheduled tasks
●
Viewing scheduled report results
●
Report bursting
Scheduling tasks for a report
1. On the JReport Console > Resources page, browse to the report you want to schedule to run.
2. Do either of the following:
❍
Select the report row, then on the task bar of the Resources page, click Run > Schedule.
❍
Select the report row, right-click in the row and select Schedule from the shortcut menu.
❍
Put the mouse pointer over the report row and click the Schedule button
toolbar.
on the floating
The Schedule dialog is then displayed.
3. In the General tab, for a page report, you need to select the report tabs you want to run from the
page report. You can choose multiple normal report tabs or one bursting report at a time (for
scheduling a bursting report, see Report bursting). If the report has parameters, specify the
parameter values as required (for details, see General tab - Parameters). Then, specify the other
options as required.
4. In the Publish tab, specify the type of the task.
Six task types are provided by JReport Server: publishing to version, publishing to disk, publishing
to e-mail, publishing to printer, publishing to fax and publishing to FTP. Choose the type you want
to publish, and then set the settings for the specified type.
See Schedule dialog for details about settings for each task type.
5. In the Conditions tab, specify the time for when the task is to be performed in the Time sub tab,
and select or create a trigger to bind with the task in the Trigger sub tab.
6. In the Notification tab, specify to notify someone via e-mail of when the task is finished and
whether it is successful or unsuccessful.
7. In the Duration tab, specify a time duration for the task, and ask JReport Server to cancel the task
or to notify you or someone else of the task status via e-mail if the task has not yet finished
running when the task duration is up.
8. Click Finish, and JReport Server will then perform the task.
Notes:
●
●
By default, the Duration tab is not displayed in the Schedule dialog. To make it available, the Enable
Task Duration option on the JReport Administration page > Configuration > Advanced panel must
have been enabled by the administrator.
When you schedule to publish a page report to DHTML format, if the report is linked to another
report, in the DHTML result, the link will no longer be supported, and if you schedule to publish the
report to several formats and DHTML format is included at the same time, the link will not be
available in the other format outputs either.
Importing and exporting scheduled tasks
In JReport Server, you can export a scheduled task to a script file which will then be saved on your own
disk as a script file. In addition, you can import a script file from the disk file to generate a scheduled
task.
To export a scheduled task to a script file and save it in the disk:
1. On the JReport Console page, click My Tasks on the system toolbar.
2. In the Scheduled tab, select the rows that one or more scheduled tasks are in.
3. Click Tools > Export to Script on the task bar of the My Tasks page (if only one task is selected,
you can also right-click in the task row and select Export to Script from the shortcut menu, or
put the mouse pointer over the task row and click the Export to Script button
toolbar), then modify the script text in the Edit Script box as required.
on the floating
4. Click OK to export the specified scheduled task to a script file.
5. Specify the directory and name for this script file in the File download dialog.
To import a script file from your disk:
1. On the JReport Console page, click My Tasks on the system toolbar, then select the Scheduled
tab.
2. Click New Schedule on the task bar of the My Tasks page.
3. In the New Schedule dialog, check the option Import Script to Create Schedule.
4. Click the Browse button to select a script file from your disk file, then click OK to import the
specified script file and modify the script text in the Edit Script box as required.
5. Click OK to generate a scheduled task.
Viewing scheduled report results
When a scheduling task is finished, you can view the results of the scheduled report as required. To
view the results, first of all you need to know the corresponding results' location. To get the location
information:
1. On the JReport Console page, click My Tasks on the system toolbar, then click the Completed
tab, where all the successfully scheduled tasks are recorded.
2. Locate the task in the tab and click the name of the task in the Schedule Name column.
3. In the Result Details table, the location information of the scheduled results are available in the
Details column.
Viewing results scheduled to version
One way to view results that are scheduled to version on the JReport Console page is via the scheduled
task records. To do this:
1. Click My Tasks on the system toolbar, then click the Completed tab.
2. In the tab, locate the right task and click the name of the task in the Schedule Name column.
3. In the Result Details table, the links to different result formats are available for viewing in the To
Version row.
And another way to achieve the same purpose is via the server resource tree which to some extent
varies with the archive location type specified in the Publish > To Version tab:
●
If the archive location has been set to Built-in Version Folder:
1. On the JReport Console > Resources page, browse to the row that the original report is in.
2. Do either of the following:
■
Select the report row and click Tools > Version on the task bar of the Resources page.
■
Select the report row, right-click in the row and select Version from the shortcut menu.
■
Put the mouse pointer over the report row and click the Version button
toolbar.
on the floating
3. In the Report Result Versions tab, the scheduled results of different format types are listed in
the Result column. Click the format links or action buttons to view the results.
●
If the archive location has been set to My Reports Folder or Public Reports Folder, which requires
providing a path and a name for the scheduled result in the server resource tree:
1. On the JReport Console > Resources page, browse to the row that the result is in.
2. Put the mouse pointer over the result row and click the Version button
on the floating
toolbar (or you can choose one of the other two methods shown in the above procedure to
display the version table).
3. In the Result Versions tab, the scheduled results of different format types are listed in the Result
column. Click the format links or action buttons to view the results.
Viewing results scheduled to disk
When scheduling a report to disk,
●
●
If you choose Publish to Server Disk Path, you are required to provide a disk file path and file name
with correct format type as the suffix for each report tab in the report. After scheduling succeeds,
you can find the corresponding result files available at the specified location on the computer where
JReport Server is installed.
If you choose Publish to Server Resource Tree, you are required to provide a path following the
server resource tree and file name with correct format type as the suffix for each report tab in the
report. For example,
❍
To follow the My Reports folder path, start with "/USERFOLDERPATH/admin/".
Example: /USERFOLDERPATH/admin/report1.pdf
❍
To follow the Public Reports folder, start with "/".
Example: /SampleReports/report2.html.
If the specified folder which is the parent folder of the result file has a real path, the generated result
file will be saved to the real path; if the folder doesn't have a real path, the generated result will be
saved to <server_install_root>/jreports/, which is the mapped disk path of the root node "/" in
the specified path.
Viewing results scheduled to e-mail/printer/fax/FTP
When a report is scheduled to e-mail, printer, fax, or FTP, you can view the scheduled results if the
specified addresses or locations are available to you.
Report bursting
In a large enterprise reporting deployment, it is important to handle both large amounts of data as well
as a large number of users. Report bursting enables running a report once and distributing the report
results to multiple recipients who each will receive a subset of the report results.
Bursting reports can be distributed to e-mail or FTP addresses, to disk, to the JReport versioning
system, or to the security system members such as users, groups, and roles.
End users can submit a schedule task which contains only one bursting report to JReport Server. When
a bursting task is activated, it will create a main bursting task and some sub bursting tasks. The
system will guarantee bursting tasks compete with normal tasks for system resources. The bursting
tasks can be given lower priority if desired (set queue.policy to 1).
●
●
Main bursting task: It is responsible for getting/splitting data and distributing work to the sub
tasks. There can be only one main bursting task for a sub bursting task.
Sub bursting task: It is responsible for generating the report result according to split data and
sending the result to the address of the bursting recipient.
On JReport Server, direct running and advanced running actions support normal reports but not
bursting reports. A report containing only bursting report tabs cannot be run directly, it must be
scheduled.
Scheduling supports both types of reports excluding the combination of the two types: for normal
reports, multiple report tabs can be scheduled at a time; however for bursting reports, only one can be
scheduled. For a scheduled bursting task, seven kinds of result file formats are supported: HTML, PDF,
Excel, Text, RTF, XML, and PostScript. In addition, when scheduling to run a bursting report, you can
make it generate not only the bursting result by applying bursting schemas but also the non-bursting
result based on whole data without data splitting.
Scheduling a bursting report to generate bursting result
Though a bursting report may have one or more bursting schemas, you need apply one or more of
them in order to get a bursting result. To do this, select a bursting report and schemas, and then
specify required parameter values in the General tab of the Schedule dialog. Then a tab named
Bursting Result is displayed in the Publish tab and only the corresponding sub tabs are available that
are defined in the selected bursting schemas' recipients in JReport Designer. For example, a bursting
report has three bursting schemas: Schema 1 defines recipient E-mail and Disk, Schema 2 defines
recipient FTP, and Schema 3 defines recipient JReport Server Version. If Schema 1 and Schema 3 are
selected, only To E-mail, To Disk, and To Version sub tabs will be shown in the Bursting Result tab of
the Publish tab for the bursting result.
The following list tells which tab will be displayed in the Publish > Bursting Result tab of the Schedule
dialog for which recipient address specified in bursting schema.
Recipient
Sub tab in the Publish tab
E-mail
To E-mail
FTP
To FTP
Disk
To Disk
JReport Server Version
To Version
JReport Server User/Group/Role - User E-mail To E-mail
JReport Server User/Group/Role - User
Private Folder
To Version
When scheduling a bursting report, specifying the destination is suppressed in the Publish tab since the
recipient addresses have been included in the bursting schema. However, you are allowed to give a file
name to the subset of report result instead of using the default name.
Default name for bursting result files
Sometimes you may not want to specify a file name for each bursting result when defining recipients.
The bursting system will give it a name as generated by the system.
The default name format is: ReportName + "_" + BurstingKey + suffix (result format type). When
there are multiple bursting key columns, connect each one by the character "_".
Converting to String
When a bursting key is of one of the following data types, it will be converted into String so as to make
a valid result file name:
●
●
●
Integer, Float, Character: Same as Java, these data types are transferred to string directly.
Date and Time: All data and time formats will be transferred to a date format: yyyy-MM-dd hh:mm:
ss.
Currency: Currency will be transferred to the number without the currency mark ($ or others).
Name length
In the JReport Server resource system, the resource name only supports up to 64-character length. If
a bursting result file name is longer than that, the system will trim it down automatically.
In order to avoid using the same name in the same path, an index will be appended to the result name,
for example: report1_USA_Maryland1.pdf, report1_USA_Maryland2.pdf.
Notes:
●
All bursting sub results will apply the security information of the bursting task submitter.
●
When running a page report containing both normal and bursting report tabs:
For direct running:
When running it to DHTML format, only the normal report tabs are opened.
When running it to other formats, if the default focused report tab is a normal report, it will be run
directly; otherwise if the default focused report tab is a bursting report which cannot be run, a
warning message will be displayed asking the end user to select a normal report tab to run using
advanced run.
For advanced running:
It is allowed to only choose among the normal report tabs.
Scheduling a bursting report to generate non-bursting result
Besides generating bursting result for a bursting report, you can also generate non-bursting result for
the report without applying any bursting definition, which is based on full data without data splitting.
To generate non-bursting result, select the Non-bursting result option in the General tab of the
Schedule dialog. Then a tab named Non-bursting Result appears in the Publish tab, and all these sub
tabs - To Version, To Disk, To E-mail, To Printer, To Fax, and To FTP - are available in this tab for the
non-bursting result.
Using built-in functions to set date and time parameter
values
For a parameter of the Date, DateTime, or Time type, you can customize a dynamic date and time value by
creating an expression using built-in formula functions.
To do this:
1. In the places where you are able to specify a value for the parameter, you may see the calendar
button
. Click this button and the Calendar dialog is displayed.
2. The Template drop-down list on the right provides some predefined expressions for you to use. You
can customize your own expression either based on an existing template or by directly editing the
contents in the Expression text box.
If you cannot see the Template label on the right, click >> on the bottom left corner.
3. JReport's built-in Date/Time formula functions are available for inserting into your expression. To
make use of them, click
to display the functions. Then click the required function to insert it
where the cursor is located in the expression.
4. The Preview box calculates the result of the current expression. If the expression is not correct, an
error message will be shown in the Preview box. Each time you modify the expression, you can click in
the Preview box to refresh the result.
5. When done, click OK to add the value.
See also Calendar dialog for additional help about the options in the dialog.
JReport Viewer - Interactive Reports
(Dynamic HTML Reports)
With JReport Server, you can obtain report results in different formats, such as HTML, PDF, and Excel.
For the HTML format, there are two viewing modes - pure HTML or Dynamic HTML. JReport Viewer
provides a dynamic report view at the client side. You can change options which enable the results to
be displayed to your requirements.
Interactive information empowers you to slice and dice your business data, to dynamically change your
view of data, and to analyze the data to glean useful business information. In short, interactive
information enables you to customize your view of business information. With JReport, any report can
be made interactive, extending the "life" of the report by allowing you to easily sort, navigate, and filter
data via JReport Viewer. This wide range of functionality, including the ability to drill down on data,
enables you to quickly derive value from your business intelligence data.
JReport Viewer provides support for many features, such as Filter, Sort, Drill-to, Drill-down, Drill-up,
Navigation (TOC), Search, and save the results. JReport Viewer also supports a web design feature,
allowing you to create reports using report oriented data structures, save your report, and even save
your custom modifications to existing reports.
This chapter covers the following topics to help you better understand how JReport Viewer makes
reports interactive and how you will benefit:
●
JReport Viewer window elements
●
General operations
●
Ad hoc reporting
●
DHTML based reporting
●
Analytic reporting
●
Applying a style
JReport Viewer window elements
The main page of JReport Viewer consists of the user information bar, menus, toolbar, page report bar,
Toolbox, Resource View panel, TOC Browser, and report area. The options for browsing or controlling a
DHTML report are as follows:
Toolbar/
Menu
File
Button
Tool Name
Description
New Page
Report Tab
Creates a new report tab to
the current page report
based on an existing
business/report cube.
New Page
Report
Creates a new page report
containing a report tab based
on an existing business/
report cube.
Open
Opens the Open Report Tabs
dialog for you to open/close
report tabs in current report.
Rename Report Opens the Rename Report
Tab
Tab dialog to give the open
report tab a new name.
Edit
Close Report
Tab
Closes the current report tab
if there is more than one
report tab open in the report;
or prompts you to close the
report if only one report tab
is open.
Delete Report
Tab
Deletes the current report
tab if there is more than one
report tab open in the report.
This command is disabled
when the last page of the
current report tab does not
display if Format Page on
Demand in the Profile >
Customize Profile > DHTML >
Properties > Advanced tab is
selected.
Save
Saves the report as a report
version.
Save As
Saves a copy of the report.
Export
Exports the report result to
disk or version in various
formats.
Page Setup
Shows the Page Properties
dialog for you to specify the
page layout settings for the
report result.
Printable
Version
Shows the Printable Version
dialog for you to print the
current report result to a PDF/
HTML file.
Exit
Closes the current report.
Undo
Undoes the last operation.
View
Redo
Reverses the operation of
Undo.
Search
Shows the Search dialog for
you to find specific text.
Toolbar
Shows or hides toolbars.
User
Shows or hides the User
Information Bar Information Bar, which
displays the user name,
catalog name and report
name.
Insert
Toolbox
Shows or hides the Toolbox
panel which allows you to
insert a component into the
report.
Resource View
Shows or hides the Resource
View panel, with which you
can add cube elements to
your report and create
dynamic resources to use
them in your report.
TOC Browser
Shows or hides the TOC
Browser, with which you can
navigate the report data.
Editing Marks
Shows or hides editing marks
(dashed outlines for objects
and report body). If the
option is unselected, the
editing mark will not be
shown when a report object
receives focus, and report
objects cannot be moved or
resized.
Turn To
Provides a submenu for you
to turn the report pages.
Refresh
Runs the report using
previously provided
parameters. The Refresh
operation fetches the data
again.
Zoom
Shows the Zoom dialog for
you to set a zoom ratio for
the report page.
Options
Shows the Options dialog for
you to set the skin and unit
for JReport Viewer, and to
customize toolbars.
Show Grids
Shows grids in the report
area.
Snap to Grids
Snaps an object to grids
when you move it by
dragging and dropping in the
report area. If this option is
enabled, aligning objects will
be made easier. To
temporarily override the
setting, press the ALT key as
you move an object.
Label
Inserts a label into the report.
Image
Inserts an image into the
report.
Report
Banded Object
Inserts a banded object into
the report.
Table
Inserts a table into the report.
Crosstab
Inserts a crosstab into the
report.
Chart
Inserts a chart into the
report.
Parameter
Control
Inserts a parameter control
into the report.
Parameter
Form Control
Inserts a parameter form
control into the report.
Filter Control
Inserts a filter control into
the report.
Navigation
Control
Inserts a navigation control
into the report.
Special Fields
Inserts special fields into the
report.
Query Filter
Applies a filter to the
business/report cube used by
certain component.
Filter
Filters the report records
according to the filter criteria
you specify.
Sort
Sorts the report records or
groups in ascending or
descending order on the
fields you select.
To Chart
Converts a crosstab into a
chart.
To Crosstab
Converts a chart into a
crosstab.
Rotate Table
Rotates a table to switch its
appearance between the
horizontal and vertical layout
modes.
Rotate Crosstab Rotates a crosstab to
exchange the columns and
rows in the crosstab in order
to create a different view of
the crosstab.
Merge
Merges selected tabular cells
into one.
Split
Splits a tabular cell into the
specified number of rows and
columns.
Max Records
Allows you to specify the
maximum number of records
retrieved by all components
in the report.
Use Dynamic
Formula in
Property
Allows you to apply dynamic
formulas to control object
properties.
Style
Allows you to apply a style to
the report.
Help
Standard
Toolbar
View Toolbar
Change
Parameters
Allows you to change the
parameter values in the
report.
User's Guide
Opens JReport Viewer User's
Guide.
Jinfonet
Software Home
Page
Connects to Jinfonet
Software Home Page.
Technical
Support
Accesses Jinfonet Technical
Support.
About JReport
Web
Shows product information
about JReport Web.
New Report
Tab
Creates a new report tab
based on an existing
business/report cube.
Open
Brings out the Open Report
Tabs dialog for you to open/
close report tabs in current
report.
Save
Saves the report as a report
version.
Save As
Saves a copy of the report.
Export
Exports the report result to
disk or version in various
formats.
Printable
Version
Shows the Printable Version
dialog for you to print the
current report result to a PDF/
HTML file.
Undo
Undoes the last operation.
Redo
Reverses the operation of
Undo.
Delete
Deletes the selected object.
Toolbox
Shows the Toolbox panel for
you to insert a component
into the report. Click it again
to hide the Toolbox.
Resource View
Shows the Resource View
panel, with which you can
add cube elements to your
report and create dynamic
resources to use them in
your report. Click it again to
hide the Resource View panel.
Filter
Shows the Filter dialog, with
which you can filter the
report records according to
the filter criteria you specify.
Sort
Shows the Sort dialog, with
which you can sort the report
records or groups in
ascending or descending
order on the fields you select.
Search
Shows the Search dialog for
you to find specific text.
Analysis
Toolbar
Font format
buttons
Page
navigation
buttons
Go To dropdown list
Zoom
Enables you to enlarge or
reduce the size of the report.
Rotate
Rotates a crosstab or rotates
a table.
Chart Type
Lists all available chart types
for you to change the type of
a selected chart.
Style
Allows you to apply a style to
the report.
Font Face, Font
Size
Changes the face and size of
the selected font. Available
only when a label or field is
selected.
Bold, Italic,
Underlined
Makes the selected font in
bold, italic or underlined
style. Available only when a
label or field is selected.
Left, Center,
Right
Makes the selected font left,
center or right aligned.
Available only when a label
or field is selected.
Max Records
Allows you to specify the
number of records retrieved
by all components in the
report.
Page Number
Displays the current page
number. You can also input a
page number in the page box
and press Enter on the
keyboard to go to that page.
First
Goes to the first page of the
current report.
Previous
Goes to the previous page.
Next
Goes to the next page.
End
Goes to the last page.
Go To
Goes to the selected report
tab or to the selected report
tab level.
If a report contains several
report tabs, you can use this
list to switch among the
report tabs. Or, after you
perform some going or
drilling actions on a report
tab, the structure of the
report tab will be displayed in
the list in a hierarchical view,
with which you can return to
any level of the report tab
easily.
More
Commands
Shortcut Menu
When the JReport Viewer
window is not maximized in
Interactive View mode, the
button will be displayed on
the toolbar, by clicking which
you can get all the other
toolbar commands the small
window hasn't enough space
for.
Filter
Provides submenu items for
filtering the data in a banded
object or removing the
filtering.
Sort
Provides submenu items for
sorting records on the
selected field in ascending/
descending order, or
removing the sorting.
Drill Down
Drills data to a lower
dimension according to
predefined hierarchies.
Drill To
Enables you to obtain a
different view of data by
switching among dimensions.
Drill to By Value Allows you to filter data
based on dimensions while
also obtaining a more
detailed view of the data.
Drill Up
Drills data to a higher
dimension according to
predefined hierarchies.
Go To
Goes to any group to show
its record information.
Go Up
Goes up one group level to
show the records of a higherlevel group.
Go Down
Goes down one group level
to show the records of a child
group.
Go to Detail
Goes to the details of a
group.
Conditional
Formatting
Enables you to add
conditional format to the
currently selected field.
Search
Shows the Search dialog for
you to search the report
result for some text.
Query Filter
Applies a filter to the
business/report cube used by
the specified data component.
Refresh
Re-fetches data of the
specified data component.
Properties
Shows a dialog for you to
define the object's properties.
Notes:
●
JReport Viewer has two view modes: Basic View and Interactive View, and the toolbar and menu
commands that are available in each mode vary. Administrators can specify the default mode that
will be applied when a report is opened in JReport Viewer in the Profile > Customize Server
Preferences > General tab, and you can switch between the two modes by clicking the Basic View or
Interactive View link on the JReport Viewer toolbar. However, you will not be able to switch the mode
if the Show Link of Basic/Interactive View option in the Profile > Customize Profile > DHTML >
Properties > Default tab is unchecked.
●
●
The options available on the JReport Viewer window are determined by the feature profile that is
selected as the default profile in the Profile > Configure Profile > DHTML > Features tab and the
property setting on the Profile > Configure Profile > DHTML > Properties tab (profile has the higher
priority). The default JReport Viewer profile provides full options.
The shortcut menu contents vary with the objects you right-click. The above table only lists some
typical shortcut menu items. The following sections will guide you to use the shortcut menu for any
object you may right-click.
General operations
After having opened a report in JReport Viewer, you can do the following general operations:
●
Managing reports
A page report can include one or more report tabs. The Go To drop-down list on the toolbar panel or
the tabs across the top of the report lists the display names of all the open report tabs in the current
report. Clicking the display name of an inactive report tab will make it active. You can manage report
tabs in a report easily as follows:
❍
Opening and closing a report tab
In a page report, a report tab can be shown or not. To close (hide) the active report tab, click
Menu > File > Close Report Tab . If there are one or more report tabs open other than the
active report tab, the close action will hide the active report tab; in the case that the active report
tab is the only report tab open, the close action will prompt you whether or not to close the report.
To open (show) a hidden report tab, click Menu > File > Open (or the Open button
on the
Standard toolbar) to display the Open Report Tabs dialog, in which the report tabs open in the
current report are marked with a check symbol. Check the report tabs you want to open, uncheck
the ones you want to close, and then click OK.
❍
❍
Renaming a report tab
To rename a report tab, first activate it, then click Menu > File > Rename Report Tab. In the
Rename Report Tab dialog, specify a new display name for the report tab.
Deleting a report tab
To delete a report tab, first activate it, then click Menu > File > Delete. The only report tab open
cannot be deleted.
Note: A JReport Live license for JReport Server is required in order to delete report tabs. If
you do not have a Live license please contact your Jinfonet Software account manager to
obtain a license.
Tip: If the administrator has specified to switch report tabs using tabs in the DHTML profile page, you
can easily activate a report tab in a report by clicking the tab representing the report tab on the report
tab bar, and closing, renaming and deleting a report tab can also be accomplished by right-clicking the
report tab and choosing the corresponding command from the shortcut menu.
●
Turning the report pages
a report tab includes more than one page, to turn between the report pages, you can
●
Click the First Page button
Page button
, Previous Page button
, Next Page button
, or Last
on the View toolbar.
●
Input a number into the page box
and press Enter to go to that page.
●
Click Menu > View > Turn To and then click the corresponding command on the submenu.
●
Use the scroll bar or mouse wheel to scroll up/down the report tab.
●
Refreshing the report result
fetch the data of the current report again, you can click Menu > View > Refresh.
●
Changing the report parameter values
here are parameters in the current report, you can change the parameter values at runtime. To do this:
1. Click Menu > Report > Change Parameters to display the Report Parameters dialog.
2. Specify the value for each parameter. For how to specify the value, refer to Report Parameters
dialog.
3. Click OK to run the report with the specified parameter values.
u can also use parameter web controls to dynamically change the parameter values of a report at
ntime. For details, see Applying web controls.
●
Undoing/redoing actions
u can undo or redo some actions by clicking Menu > Edit > Undo or Redo (or the Undo button
do button
or
on the Standard toolbar).
●
Configuring JReport Viewer features
e JReport Administration page provides default settings for you to use JReport Viewer features, and
ntrols whether the settings on the JReport Console page can be configured. A user playing the
dministrator" role may change the settings in the JReport Administration page so as to enable or disable
me features. Then you can configure JReport Viewer preferences on the JReport Console page, that is,
u can decide whether or not to enable the features which have been enabled on the JReport
ministration page. After you have made changes to JReport Viewer settings on the JReport Console page
d saved them, JReport Viewer features available for you will be consistent with your new settings on the
eport Console page. For details, see Customize Profile.
●
Setting JReport Viewer options
eport Viewer allows you to set the skin and customize toolbars. To do this:
1. Click Menu > View > Options (or right-click anywhere on the toolbar area and select Options
from the shortcut menu).
2. In the Option tab, set the skin of JReport Viewer user interface.
3. In the Customize tab,
❍
To modify a toolbar, select it in the Current Toolbar box, remove those unnecessary items from the
Selected Tools box, and add required tools from the Available Tools box. Click
order of the tools on the toolbar.
❍
❍
or
to adjust the
To add a toolbar, click
to show the New Toolbar Name dialog, then specify the toolbar name,
click OK to return to the Options dialog, and set the tools for the new toolbar.
To delete a toolbar, select it and click
.
4. To load the default settings, including the skin, and the three built-in toolbars, namely Standard,
View, and Analysis, click the Restore Defaults button.
5. Click OK to apply the settings.
Tip: To close a toolbar, right-click anywhere on the toolbar area, then on the shortcut menu, select the
item corresponding to the toolbar name. You can also do this to open an invisible toolbar, such as a
newly-created one. The open/close toolbar operation can also be achieved by clicking the
corresponding item on the Toolbar submenu of the View menu.
Showing/hiding user information
e User Information bar shows the current user name, catalog path and name, and report path and name.
u can click Menu > View > User Information Bar to show or hide the bar.
●
●
Showing/hiding editing marks
JReport Viewer, you can use editing marks (dashed outlines of objects) for purposes such as aligning,
ving and resizing. By default, the editing marks are shown only when you create a new blank report in
eport Viewer. You can click Menu > View > Editing Marks to switch the status of the editing marks as
quired.
●
Tuning report page magnification
on the View
u can zoom in or out the report page by selecting a magnification from the Zoom list
olbar. You can also click Menu > View > Zoom to show the Zoom dialog, and then specify the
gnification.
Asking for help
any time, you can click Menu > Help > User's Guide to open the index page of JReport Viewer User's
ide. Furthermore, you can click the Help button in any dialog to show the help about the dialog. You can
o use the Help menu to open the User's Guide and access Jinfonet Software website for more information.
●
Setting up the page
set up the report page, click Menu > File > Page Setup. In the Page Properties dialog, specify the page
pe, the orientation, and the margins as required.
●
●
Printing the report result
u can print the report result to a PDF/HTML file. To do this, click Menu > File > Printable Version (or
e Printable Version button
on the Standard toolbar). In the Printable Version dialog, specify the
tings as required and then click OK. The PDF/HTML result file will be opened in an associated program
h which you can print the result to a printer.
●
Exiting the report
you want to close the current report and release the resources, just click Menu > File > Exit (or the Exit
tton
which is always on the upper right corner of the JReport Viewer window, or the close button of
e browser window). Closing the only report tab open will also prompt you whether or not to close the
port. In case that you have modified the report without saving it, JReport Viewer will prompt you to save
e report. If you have changed the sort and/or filter criteria, you can check Sort and/or Filter in this dialog
save these changes with the report. Click Yes to save the report and close the report.
Ad hoc reporting
Ad hoc reporting allows a business analyst or end user to create a new report, add new objects to an
existing report, modify report objects, and save the report or report result. These tasks are performed
in the JReport Server environment and do not require use of JReport Designer.
This section describes the following ad hoc reporting tasks:
●
Creating a report tab
●
Adding report objects
●
Applying web controls
●
Making simple modifications to report objects
●
Saving the report
●
Exporting the report result
Creating a report tab
In JReport Viewer, you can create a new report tab based on a predefined business/report cube to the current page report.
You can also create a new page report containing one report tab and then add report tabs to it. However, the reports created
on business/report cubes in JReport Viewer cannot be edited in JReport Designer any further.
To create a report tab:
1. In a JReport Viewer window, click Menu > File > New Page Report Tab (or the button
to display the New Report Tab dialog.
on the Standard toolbar)
If you click Menu > File > New Page Report, the New Page Report dialog will appear for you to create a page report
with the first report tab in it.
2. Specify the title of the report tab as required in the Report Title text box.
3. In the Choose Report Layout box, select the required layout with which you want to create the report.
4. Click OK to create the report tab.
❍
If Blank is selected as the layout, a report tab which is blank will be created. You can then use the Toolbox and the
Resource View panels to add objects and cube elements to the report tab.
❍
If you select the layout as Banded, Table, Chart, or Crosstab, the corresponding report wizard will then be displayed.
Specify the settings according to your requirements.
Also, on the JReport Console > Resources page, you can directly create a new page report (containing a report tab) in a folder
into which one or more catalogs containing some business/report cubes have been published. To do this:
1. Open the folder and select the catalog for the new page report from the Catalog drop-down list.
2. On the task bar of the Resources page, click New Report > Report.
3. In the Select Report Type dialog, check the option Page Report and click Ok.
4. In the New Page Report dialog, create the page report containing a report tab as required.
The following shows in detail how to create a report tab from particular layouts:
Creating a banded report
A banded object is a kind of component that can present grouped data and detailed data, and is composed of several banded
panels with which you can easily organize data fields and other elements.
To create a banded report:
1. In the New Report Tab dialog, specify the title of the report tab in the Report Title text box, select Banded as the layout
and click OK to display the Banded Wizard.
2. In the Data screen, select the business/report cube in the current catalog, on which the banded object will be built.
3. In the Display screen, add the required fields from the Resources box to be displayed in the banded object. Modify the
display name of any added field if necessary.
4. In the Group screen, add the dimension objects
group in the Sort column.
as the grouping criteria, then specify the sorting direction of each
5. To add summaries, go to the Summary screen. Select the group to which the summary will be applied, then add a
measure object
as the summary field.
6. In the Query Filter screen, select an existing filter or create new filters you want to apply to the business/report cube.
7. In the Style screen, apply a style to the banded object.
8. Click Finish to create the report.
See also Banded Wizard for details about options in the wizard.
Creating a table report
Tables give you great control over how to present data, including placing fields, grouping them, and sorting them. A table is
composed of row and columns, and each contains several cells. With such a structure a table is a good way to show any twodimensional dataset.
To create a table report:
1. In the New Report Tab dialog, specify the title of the report tab in the Report Title text box, select the desired table type
in the Choose Report Layout box, then click OK to display the Table Wizard.
❍
❍
❍
❍
Table (Group Above)
Creates a table with group information above the detail panel.
Table (Group Left)
Creates a table with group information left to the detail panel.
Table (Group Left Above)
Creates a table with group information left above the detail panel.
Summary Table
Creates a table with only group and summary information.
2. In the Data screen, select the business/report cube in the current catalog, on which the table will be built.
3. In the Display screen, add the required fields from the Resources box to be displayed in the table. Modify the display
name of any added field if necessary.
4. In the Group screen, add the dimension objects
group in the Sort column.
as the grouping criteria, then specify the sorting direction of each
5. To add summaries, go to the Summary screen. Select the group to which the summary will be applied, then add a
measure object
as the summary field. For the Group Left table, you can use the Row and Column columns to control
the position of the summary field in the table.
6. In the Query Filter screen, select an existing filter or create new filters you want to apply to the business/report cube.
7. In the Style screen, apply a style to the table.
8. Click Finish to create the report.
See also Table Wizard for details about options in the wizard.
Creating a crosstab report
A crosstab summarizes data and presents the summaries in a compact row and column format.
To create a crosstab report:
1. In the New Report Tab dialog, specify the title of the report tab in the Report Title text box, select Crosstab as the
layout and click OK to display the Crosstab Wizard.
2. In the Data screen, select the business/report cube in the current catalog, on which the crosstab will be built.
and click
3. In the Display screen, select a dimension object
field. Select a measure object
more group/aggregate fields.
and click
or
to add it to the Columns or Rows box as a group
to add it to the Summaries box as an aggregate field. Repeat this to add
4. In the Display Name column, edit the display names of the added group fields or aggregate fields if required. These will
label the rows, columns and summaries when the report is displayed. By default these are blank and no labels will be
created.
5. In the Sort column, specify the sorting manner for the group fields.
6. If you want to remove any group/aggregate field, select it and click
fields, select a group/aggregate field and click
or
. To adjust the order of the group/aggregate
.
7. In the Query Filter screen, select an existing filter or create new filters you want to apply to the business/report cube.
8. In the Style screen, apply a style to the crosstab.
9. Click Finish to create the report.
See also Crosstab Wizard for details about options in the wizard.
Creating a chart report
A chart organizes and graphically presents data in a way that makes it easy for end users to see comparisons, trends, and
patterns in data. It represents the report data in a visually straightforward form. A chart is based on the chart platform. On
the platform, the chart paper, the legend, and labels make up the chart. You can create a chart that contains only simple
DBFields, or a complicated chart that contains DBFields, groups, summaries, and even formulas. Normally, DBFields,
summaries, and formulas in a report are represented in a chart using chart data markers, and groups are used to produce
category names and data series names. DBFields can also be used as category names.
To create a chart report:
1. In the New Report Tab dialog, specify the title of the report tab in the Report Title text box, select Chart as the layout
and click OK to display the Chart Wizard.
2. In the Data screen, select the business/report cube in the current catalog, on which the chart will be built.
3. In the Type screen, specify the chart type as required.
A default chart type exists in the Chart Type Groups box. To replace it with another one, select a chart type from the
Chart Type box. The thumbnails of the subtypes in this type will then be displayed in the Subtype box. Select the
required subtype to replace the default chart type.
If you want to create a combo chart, click <Add Combo Type> of Primary Axis or Secondary Axis in the Chart Type
Groups box, and an additional subtype will be added. To replace the additional subtype, select it, then specify the
required type and subtype respectively in the Chart Type and Sub Type boxes.
To add more subtypes, repeat the procedures. To remove a subtype, select it and click
.
4. In the Display screen, select a dimension object
in the Resources box and add it to the Category or Series box, the
data of which will be displayed on the corresponding axis. Select a subtype in the Show Values box, then add a measure
object
or additonal value
as the data of the subtype.
To add an additional value to a subtype:
a. Select the subtype in the Show Values box.
b. In the Resources box, expand the Additional Values node, then select Constant Value/Average Value.
c. Click
beside the Show Values box. The Edit Additional Value dialog appears.
d. In the Name text box, specify the display name for the constant/average value.
e. Input the constant value with numeric type in the Value text box, or select a field based on which the average value
will be calculated from the Based On drop-down list.
f. Click OK, and the defined constant/average value will be added to the subtype.
If you want to further modify a constant/average value, select the value in the Show Values box, then click
the Edit Additional Value dialog, edit the value as required.
. In
You can add more than one measure object or additional value to a subtype. Each added subtype shall have at least one
measure object or additional value.
5. If you want to define the sort order and Select N condition on the category/series axis of the chart, click the Order/
Select N button below the Category/Series box, then define the condition in the Order/Select N dialog.
To define a sort order and Select N condition on the category/series axis:
a. In the Order box of the Order/Select N dialog, specify in which order values on the category/series axis will be
sorted.
b. In the Select N box, specify the Select N condition to All, Top or Bottom. If All is selected, all category/series values
will be shown in the chart; if Top or Bottom is selected, the combo box next to it will be enabled and you can specify
an integer here, which means that the first or last N category/series values will be shown in the chart.
c. Check the Based On checkbox and specify values for the two drop-down lists that follow according to your
requirement.
If Based On is unchecked, the order for the top or bottom N values will be based on what you specify in the Order
box of the dialog; if you check it, the order will be based on the values of the summary field and the sort direction
you specify in the drop-down list next to the Based on checkbox.
d. If you have selected Top or Bottom from the Select N drop-down list, you can check the Other checkbox and the
type a character string in the next text box, so that the those category/series values beyond the first or last N range
will be merged into the group with the name as that character string.
e. Click OK to accept the settings.
6. In the Query Filter screen, select an existing filter or create new filters you want to apply to the business/report cube.
7. In the Style screen, apply a style to the chart.
8. Click Finish to create the report.
See also Chart Wizard for details about options in the wizard.
Notes:
●
●
●
A JReport Live license for JReport Server is required in order to use this feature. If you do not have a Live license please
contact your Jinfonet Software account manager to obtain a license.
Before you can create a report in JReport Viewer, you need to first make sure that the catalog corresponding to the current
report contains one or more business/report cubes and that the Pop-up Blocker is not enabled on your web browser.
In the report wizard, if there is only one cube in the current catalog, this cube will be used to create the report by default,
and the Data screen will be hidden from the wizard. This is the same case when there is only one style available to be
applied to the report.
Adding report objects
For a newly-created or an existing report, if the corresponding catalog contains business/report cubes,
then you can add labels, images, banded objects, tables, crosstabs, charts, special fields and web
controls to the report.
Object placement
Objects can be placed within banded objects, tables, tabulars, as well as onto an empty area of a
report. The following table lists the report areas that are valid targets for the various objects, listed on
the left.
Report Layout Area
Page
Header/
Footer
Report
Header/
Footer
Report
Body
Banded
Detail
Banded
Page
Header/
Footer
Banded
Header/
Footer
Banded
Group
Header/
Footer
Table
Cell
Tabular
Cell
Banded
object
Y
N
Y
Y
Y
Y
Y
N
Y
Chart
Y
Y
Y
Y
Y
Y
Y
N
Y
Crosstab
Y
Y
Y
Y
Y
Y
Y
N
Y
Table
Y
Y
Y
Y
Y
Y
Y
N
Y
Dimension
object
Y
Y
Y
Y
Y
Y
Y
Y
Y
Detail
information
object
Y
Y
Y
Y
Y
Y
Y
Y
Y
Measure
object
N
N
Y
N
N
Y
Y
N
N
Formula
Y
Y
Y
Y
Y
Y
Y
Y
Y
Label
Y
N
Y
Y
Y
Y
Y
Y
Y
Object
Special field
Y
N
Y
Y
Y
Y
Y
Y
Y
Image
Y
N
Y
Y
Y
Y
Y
Y
Y
Web control
Y
Y
Y
Y
Y
Y
Y
N
Y
To add an object into a report:
1. Click Menu > Insert, then click the command corresponding to the object you want to add.
2. Point to the destination where you want the object to be added, and then click the mouse button.
❍
❍
❍
❍
If you specify to add a label, a label will be inserted there. Edit the text of the label and format it
according to your requirements.
If you specify to add an image, the Insert Image dialog will be displayed. Specify the source of
the image as required (for details, see Insert Image dialog).
If you specify to add a banded object, table, crosstab, or chart, the corresponding report wizard
will be displayed. Specify the settings in the wizard according to your requirements (for details,
see the specific topic in Creating a report tab).
If you specify to add a special field, the special field will be inserted there.
❍
❍
If you specify to add a parameter control, parameter form control, or filter control, the
corresponding insert control dialog will be displayed. For how to specify the settings in the dialog
and the usage of the web control, see Applying web controls.
If you specify to add a navigation control, a navigation control will be inserted there. For the
usage of the navigation control, see Applying web controls.
Alternatively, you can also use the Toolbox panel to add objects other than special fields into a report
by dragging them from the panel to the destination. However, in order to use the Toolbox panel to add
components, you should make sure that this ad hoc feature is enabled in the specified DHTML feature
profile. This setting can only be made by administrators.
Note: A JReport Live license for JReport Server is required in order to use this feature. If you do not
have a Live license please contact your Jinfonet Software account manager to obtain a license.
Applying web controls
In JReport Viewer, these four types of web controls can be applied: parameter control, parameter form
control, filter control, and navigation control. This section describes each of the web controls and how
to use them.
Note: A JReport Live license for JReport Server is required in order to use this feature. If you do not
have a Live license please contact your Jinfonet Software account manager to obtain a license.
Using parameter control to specify a parameter to a report
A parameter control is a web control that is bound with a parameter used by the current report. By
specifying values to the parameter in a parameter control, you can pass the parameter values to
JReport and run the report with the specified values.
Parameter controls do not support inserting cascading parameters. If you want to do this, use
parameter form controls instead.
To insert a parameter control and use it to specify a parameter to a report:
1. Do either of the following:
❍
❍
Click Menu > Insert > Parameter Control, then point to the destination where you want to
add the parameter control and click the mouse button.
Drag Parameter Control from the Toolbox panel to the destination in the report.
The Insert Parameter Control dialog is displayed.
2. Select the parameter you would like to add to the parameter control, then click OK.
3. A parameter control will be added into the report. There are the following ways to specify
parameter values according to the appearance of the parameter control which varies with the type
and properties of the selected parameter:
❍
Typing in the parameter values if the text field is editable.
❍
Selecting a parameter value from a drop-down list.
❍
Using the calendar button
Time, or DateTime type.
to specify a value using the calendar if the parameter is of Date,
❍
Selecting or unselecting the checkbox to specify a Yes/No value.
❍
Using the button
to specify multiple values for the parameter in the Enter Values dialog.
4. Once the value in the parameter control changes, the report will rerun with the new parameter
value.
Note: If the specified parameter is no longer used in the report, the parameter control will become
invalid.
Using parameter form control to run reports
A parameter form control is a web control that is bound with the parameters used by the current report
or other reports. By specifying values to the parameters in a parameter form control, you can make the
reports run with the specified parameter values.
To insert a parameter form control and use it to run report:
1. Do either of the following:
❍
❍
Click Menu > Insert > Parameter Form Control, then point to the destination where you
want to add the parameter form control and click the mouse button.
Drag Parameter Form Control from the Toolbox panel to the destination in the report.
The Insert Parameter Form Control dialog is displayed.
2. Specify the target reports to run using the parameter form control.
❍
❍
To run the current report, select Current Report, then specify the parameters used to run the
report from the Select Parameters box.
To run other reports, select Others, then select the reports you want to run. If all the selected
reports contain no parameters, you cannot finish the dialog.
3. Specify whether to include the Submit button in the parameter form control. If Submit is included,
it is used to submit the parameter values you specified in the parameter form control. If Submit is
not included, once you change the values of a parameter in the parameter form control, the new
values will be applied automatically.
4. Click OK in the dialog to save the changes.
The parameter form control is now inserted in the report. It lists the selected parameters for the
current report or lists all parameters used by the specified reports.
5. In the parameter form control, specify values of the listed parameters.
6. Click the Submit button if present to run the current report or the specified reports. If there is no
Submit button, the change of values in the parameter form control will trigger report rerunning.
Note: If you save or publish a report containing a parameter form control to another directory, the
reports that you bind the parameter form control with will not be saved or published along with the
report.
Using filter control to filter report data
A filter control is used to filter one or more data components in a report, which refer to tables, banded
objects, charts, and crosstabs. For how a filter control works, see Filtering scenarios.
To insert a filter control and use it to filter report data:
1. Do either of the following:
❍
❍
Click Menu > Insert > Filter Control, then point to the destination where you want to add the
filter control and click the mouse button.
Drag Filter Control from the Toolbox panel to the destination in the report.
The Insert Filter Control dialog is displayed.
2. From the resource list, select the fields of the same data type to bind to the filter control.
To filter components created from the same data source, select a field in the data source.
To filter components created from different data sources, find a common field these data sources
contain, then select the field in each of the data sources.
3. The Apply To drop-down list provides the components involving the selected fields. Select the
components which you want to filter.
4. When done, click OK.
The filter control is inserted in the report. It lists all values of the specified fields. You can select
one or more values to apply.
After inserting filter controls in the report, you can also insert a navigation control for undoing/redoing
the value selection in the filter controls. For details about the usage of navigation control, see Using
navigation control to undo/redo value selection in filter controls.
Managing a filter control
After right-clicking the title bar of a filter control, these options are available for managing the filter
control.
●
●
Properties
Opens the Filter Control Properties dialog for editing the properties of the filter control.
Search
Displays the quick search toolbar right above the filter control which enables you to search values in
the filter control. You can also click the button
quick search toolbar.
on the title bar of the filter control to launch the
The following are details about the usage of the quick search toolbar:
❍
❍
❍
Text field
Type in the text you want to search for in the text field and the matched text will be highlighted
among the field values.
X
Closes the quick search toolbar. You can also click outside of the quick search toolbar to achieve
this.
Lists the advanced options.
■
■
Highlight All
Specifies whether to highlight all matched text.
Match Case
Specifies whether to search for text that meets the case of the typed text.
■
❍
❍
●
Match Whole Word
Specifies whether to search for text that matches a whole word and ignore partial word matches.
Highlights the next matched text.
Highlights the previous matched text.
Clear
Cancels the selection of values in the filter control. You can also use the button
cancel the selection. This operation can be undone/redone.
●
●
●
on the title bar to
Sort
Sorts the values in the filter control in the ascending or descending order.
Delete
Removes the filter control from the report and the filter you created with the filter control will be
removed from the report too. You can also use the close button on the title bar to remove the filter
control.
Hide
Hides the filter control.
Cascading relationship among filter controls
When there are filter controls that apply to the same data components, and when these controls' fields
have cascading relationship, the cascading relationship will be revealed when you select values in the
controls.
For example, there is a filter control based on the field Country, a filter control on City, and another on
State. The first two share one table while the third shares nothing with the other two. In this case,
Country and City values will show cascading relationship, but State values will not participate. You
select USA in the Country filter control, the values in the City filter control will change as follows if the
control has scrollbar: the cities belong to USA are displayed in the upper area of the filter control, and
the other cities are put in the lower area and grayed out. For the case that the City filter control has no
scrollbar: all the values remain their positions and the values not belonging to USA are grayed out. In
both cases all the values are selectable. But the State values remain as before, since the selection of
them will not affect the data components that the Country and City filter controls control.
Using navigation control to undo/redo value selection in filter controls
A navigation control can be considered as an accessorial control for filter controls and is used to deal
with the value selection operations in all the filter controls in the same report.
To insert a navigation control into a report, do either of the following:
●
●
Click Menu > Insert > Navigation Control, then point to the destination where you want to add
the navigation control and click the mouse button.
Drag Navigation Control from the Toolbox panel to the destination in the report.
A navigation control is a combination of three buttons:
●
●
●
Back
Goes back to the previous value selection status and refreshes the report data accordingly.
Clear
Removes all the value selection histories and all the filter conditions based on the selections, and
refreshes the report data accordingly.
Forward
Goes forward to the next value selection status and refreshes the report data accordingly.
Making simple modifications to report objects
By virtue of JReport Viewer's powerful ad hoc functions, you can make simple modifications to report
objects at runtime while viewing the report in DHTML.
Note: Except for showing/hiding objects, a JReport Live license for JReport Server is required in order
to use all the other features introduced in this article. If you do not have a Live license please contact
your Jinfonet Software account manager to obtain a license.
Moving an object
A table, banded object, chart, crosstab, tabular, or image, can be easily moved to a new position. What
you need to do is click anywhere in the object, then drag the icon
appearing at its upper left corner
to the destination. After JReport Viewer has finished processing, the object will be redrawn in the new
location.
For other objects, select it and move it to the new position.
Notes:
●
●
Before you can move any object in a report, you need to first make sure that the JReport Viewer
window is in the Interactive View mode.
For reports designed in JReport Designer, only the objects whose Position property value is absolute,
and the DBFields or labels which have been defined as a cube element can be moved in JReport
Viewer.
Resizing an object
To resize an object, click anywhere in the object, when the icon
appears at its upper left corner,
click the icon to select the object, then you will see that it is surrounded by a rectangle with three
resizing handles. Point to a handle, when the mouse pointer turns to a double-headed arrow, you can
drag the handle to resize the object.
To resize a panel in a banded object, select it and drag the resizing handle to the desired position.
To adjust the width/height of a column/row in a table, point to the right/lower boundary of the column/
row, when the mouse pointer becomes a horizontal/vertical double-headed arrow, drag the handle and
the width/height of the column/row will change. This will also resize all cells in the column or row.
For a crosstab, you can resize its rows and columns the same as you do with a table.
For a tabular, point to the boundary between two cells and the mouse pointer will become a doubleheaded arrow, you can then drag the boundary to adjust the size of the related cells.
To change the width and height of a field, click any value of this field to select it, then drag the right or
lower resizing handle on its borders to a new position, and the width or height of the field will change.
You can also do this for any label.
Notes:
●
When resizing table rows:
❍
❍
If you resize the table header, only the height of the header will be changed. However, when you
resize any row except the header, the height of all rows in the table will be changed at the same
time.
If there are some groups in a table and the height of one group row is changed, the other group
rows will not be resized.
When resizing crosstab columns/rows:
●
❍
If you resize the horizontal/vertical header of a crosstab, other rows/columns will not be affected.
❍
If you resize the total column/row of a crosstab, other columns/rows will not be affected.
Hiding/showing an object
To hide a table, banded object, chart, crosstab, or tabular, click on the object, when the icon
appears at its upper left corner, right-click on the icon and then select Hide from the shortcut menu.
For other objects such as text boxes, drop-down lists, fields, and labels, right-click it and then select
Hide to hide it.
To show a hidden object, right-click the object containing it, then on the shortcut menu, select the
object name from the Show submenu.
Splitting and merging cells in a tabular
Adjacent cells in a tabular which can form a rectangle may be merged into one cell.
To merge adjacent cells, select them one by one while holding the Ctrl key, then click Menu > Report
> Merge, and these cells will be merged into one cell.
To split a cell:
1. Select the cell and click Menu > Report > Split.
2. In the Split dialog, specify the number of rows and columns.
3. Click OK and the cell will be split.
Modifying object properties
JReport Viewer allows you to modify object properties with the corresponding properties dialog.
●
●
●
To format the properties of any object in a report, right-click on the object and select Properties
from the shortcut menu. If it is a table, crosstab, chart, banded object, or tabular, click anywhere on
it, when the icon
appears at its upper left corner, right-click on the icon and click Properties on
the shortcut menu. In the corresponding properties dialog, specify the settings as required. For a
table, you can also right-click any field or cell in it and select Table from the shortcut menu to show
the Table Properties dialog.
You can right-click a group header/footer panel in a banded object, and then select Group to show
the Group Properties dialog in order to define the group properties.
If you want to format the properties of the report, right-click the blank part of the report, select
Report from the shortcut menu, then in the Report Properties dialog, configure the properties as
required.
●
To set up report page properties, click Menu > File > Page Setup, then in the Page Properties
dialog, specify the settings according to your requirements.
Tip: If you just want to modify the text related properties for a field or label, for example, you want to
change the text alignment or make the text bold, you can achieve it by simply selecting the field or
label, then clicking the corresponding buttons on the toolbar.
For detailed explanation about options in the properties dialogs, refer to the specific topics in JReport
Viewer dialogs.
Deleting an object
An object can be removed from the report if it is no longer required. However, objects that are in a
subreport cannot be deleted.
●
●
To delete a table, banded object, chart, crosstab, tabular, or image, click on the object, when the
icon
appears at its upper left corner, right-click on the icon and select Delete from the shortcut
menu, or you can drag the icon outside the report page. Then, a message box will prompt, asking for
your confirmation. Click OK in the message box so as to remove the component.
For a field, you can drag any value of the field outside the report page to remove it. You can also
drag any label outside the report page to remove it. Right-clicking and then selecting Delete is
another way to achieve this.
Saving the report
You can save your report in a JReport Viewer window. To do this, click Menu > File > Save (or the
on the Standard toolbar). The Save Report Template dialog appears. The Sort and
Save button
Filter options in this dialog signify whether or not to include the sort and filter criteria when saving.
Specify the options as required, then click OK, and the report will be saved as a report version.
If the report is newly created and has not yet been saved, the Save As dialog will be displayed.
1. In the Report Name box, enter the name of the report as required. Select a file format from the
format drop-down list.
2. From the Folder drop-down list, specify where the report will be saved: Public Reports or My
Reports.
3. From the Directory drop-down list, further specify the directory in which the report will be saved.
4. Optionally, input some text in the Description box as a description for the report.
5. Click the Advanced button to set the advanced settings for the report if required.
a. From the Catalog drop-down list, select the catalog for the report.
b. Specify the relationship between the saved report and the catalog used to run it (activated
only when Select Catalog Linked Model has been enabled by the administrator in the Profile >
Customize Profile > DHTML > Properties > Advanced tab):
■
■
Set Original Catalog as Linked Catalog into Saved Page Report
If checked, the saved report will be linked with the catalog and the saved report will run
with the catalog no matter whether the two are in the same directory. If later the catalog is
updated, the saved report will run with the latest version of the catalog.
Set Catalog Copy to Public Reports/My Reports
If checked, the catalog will be copied to the directory where the report is saved and the
saved report will run with the copied catalog.
c. If you want to save the report together with the sort and filter criteria, check Save Sort
Criteria and Save Filter Criteria correspondingly. With the criteria saved, JReport Viewer
will automatically apply them to the report the next time it is opened.
6. Click OK to save the report.
To save a copy of a report, click Menu > File > Save As (or the Save As button
toolbar) to show the Save As dialog, and then do as above.
on the Standard
Notes:
●
●
●
You will not be able to save the report to some locations if you do not have the required permissions.
You need to have Write access to the directory.
If one of the report tabs in a report contains subreports, when you save the report, changes you
have made on the subreports will not be saved along with the primary report.
To find a newly saved report version, browse to select the row that the report is in on the JReport
Console > Resources page, click Tools > Version on the task bar, and then click the Report
Versions tab.
Exporting the report result
When you are satisfied with the result of the active report, you may want to export it as a result version or as a
local file to other format.
1. Click Menu > File > Export (or the Export button
dialog.
on the Standard toolbar) to display the Export
2. In the File Name field, specify the name of the exported result file.
3. Specify the destination of the result:
❍
❍
❍
Save to Version System: The result will be saved as a result version in JReport Server's versioning
system.
Save to File System: The web browser will prompt you to save the result file to a specified folder. If
selected, you need to provide a name for the result file in the File Name field.
View Report Result: The result will be directly opened in the web browser if the format is supported by
a plug-in of the web browser; otherwise it will prompt you to save the result file.
4. From the Select Format drop-down list, select the format in which to export the result: HTML, PDF, Excel,
Text, RTF, XML, PostScript, or DHTML Result.
5. To specify the additional setting of the selected format, click More Options.
6. From the Style Group drop-down list, select the style group you want to apply to the exported report
result. If No Style is selected, the style group property predefined for the specified export format in JReport
Designer will be applied to export the report result to that format.
7. Set the other properties for the selected format as required (for details about properties of each format,
see Export dialog).
8. Click OK to confirm.
Note: If the report you are going to export is linked to another report, in the exported results, the link will no
longer be available.
DHTML based reporting
JReport Viewer reporting enables enterprise-wide information delivery. With JReport Viewer,
organizations can harness the power of the Internet, giving users across the enterprise the ability to
access and generate reports from their own web browsers.
The DHTML based reporting function of JReport empowers you to perform the following operations:
●
Filtering report data
●
Sorting report data
●
Searching for text in a report
Filtering report data
In JReport Viewer, data is cached in a data buffer. You can set a series of conditions and apply them to a DHTML
server to filter the data buffer and reproduce the report result.
There are these methods you can use to set the filter conditions: using the Filter dialog, using filter controls,
using the shortcut menu, and using labels.
Using the Filter dialog
To set the filtering conditions using the Filter dialog:
1. Click Menu > Report > Filter, or the Filter button
on the Analysis toolbar to show the Filter dialog.
2. Select the component on which the filtering will be based from the Apply to drop-down list.
3. Define the filter as required.
There are the basic and advanced modes of the dialog for you to define either simple or complex filter
expressions.
❍
To define a filter using simple expressions:
a. Make sure the dialog is in the basic mode.
b. From the field drop-down list, select the field on which the filter will be based.
c. From the operator drop-down list, set the operator with which to compose the filter expression.
d. Type the values of how to filter the field in the value text box, or select one or more values from the
drop-down list.
e. If you want to add another condition line, from the logic operator drop-down list,
■
■
To add a condition line of the AND relationship with the current line, select AND, then define the
expression as required.
To add a condition line of the OR relationship with the current line, select OR, then define the
expression as required.
Repeat this to add more filter expressions if required. To delete a condition line, click
❍
on its left.
To define a filter using complex expressions:
a. Switch the dialog to the advanced mode.
b. From the field drop-down list, select the field on which the filter will be based.
c. From the operator drop-down list, set the operator with which to compose the filter expression.
d. Type the values of how to filter the field in the value text box, or select one or more values from the
drop-down list.
e. To add another condition line, click the Add Condition button and define the expression as required.
Then, click the logic button until you get the required logic to specify the relationship between the
two filter expressions. The logic can be AND, OR, AND NOT, or OR NOT.
f. Repeat the above steps to add more filter expressions if necessary.
To group some conditions, select them and click the Group button, then the selected conditions will
be added in one group and work as one line of filter expression. Conditions and groups together can
be further grouped. To take any condition or group in a group out, select it and click Ungroup. It is
the equivalent of adding parenthesis in a logic expression.
To adjust the priority of a condition line or a group, select it and click the Up or Down button.
To delete a condition line or a group, select it and click the Delete button.
4. Click OK to make the filter take effect and return to the report.
Using filter controls
A filter control is a web control used to filter one or more data containers, which refer to tables, banded objects,
charts, and crosstabs, in a report using the same data source. A filter control can do filtering based on one field.
For details, see Using filter control to filter report data.
Using the shortcut menu
You can also use filter-related commands on the shortcut menu to filter the data in a banded object or table. To
do this, point to any value of the field by which you want to filter data, then right-click to show the shortcut
menu. You will see the Filter item which provides a submenu containing the following commands:
●
●
Remove Filter
This command is enabled after you have applied filtering on the field to the banded object or table. Clicking this
item will remove all filters on this field.
Top N
Shows the Top N dialog with which you can filter data to display records that meet the Top N condition.
For example, if you input 3 in the Top N dialog for a certain field, then only the records with the field value
equal to one of the first three field values will be displayed.
●
Bottom N
Shows the Bottom N dialog with which you can filter data to display records that meet the Bottom N condition.
For example, if you input 3 in the Bottom N dialog for a certain field, then only the records with the field value
equal to one of the last three field values will be displayed.
●
●
Field values
"Field values" is not the name for a command on the Filter submenu, but represents some items which are the
values of the field you have right-clicked. Selecting any field value listed here will make the banded object or
table only display records with the field value equal to the selected one.
More
This command is enabled if the Filter submenu cannot list all field values. When it is enabled, clicking it will
show the Select Values dialog. You can select one value in this dialog and apply the setting, after which the
banded object or table will only display records with the field value equal to that value.
Using labels
You can also use a label to control the filter condition in a banded object or table. This feature needs to be
enabled at report design time.
1. In JReport Designer, select a label in a banded object/table, and then set its Filterable property to true.
2. Set the field by which you want to filter records as the value of the label's Bind Column property.
3. Save the report and publish it to JReport Server.
is beside the label. Click it to show the
4. Run the report in JReport Viewer, and you can find that a button
Filter list, which contains All, Top N, Bottom N, Custom Filter, the field values, and More (if there are too
many distinct values for the field), then click the corresponding item to filter the records.
After applying a filter on the field decided by the Bind Column property, the button
will be affixed with a
check mark, and you can still click it to show the Filter list, in which the All item can help you remove the
filters on the field.
Notes:
●
●
●
You can also filter records by using the shortcut menu for a label in the same way as for a field value, provided
you have set its Bind Column property value to a field.
When using the shortcut menu for a field value or label to filter, all the items (Remove Filter, Top N, Bottom N,
and More) will be showed by default. If you want to disable some of the items, you should set the field's Filter
Options property when designing the report in JReport Designer.
For filtering the data using shortcut menu or labels, you may notice that the corresponding filter expressions
will appear in the Filter dialog if you open this dialog.
Sorting report data
You can sort the records in a banded object or table, and the groups in a certain group level of the
banded object or table if you have defined one or more group levels. If you want the data of other
types of cube elements to be sorted, you should put the cube element into a banded object or table
and make the data of the cube element inherit from the banded object or table.
●
●
Sorting records: Changing the order of records in the whole banded object or table, or in each
group if there exists one or more group levels. The sorting scope is the whole banded object or table.
Sorting groups in a group level: Changing the order of groups in the group level, that is, the
groups will be sorted by the values of the first record in each group on the related fields. The sorting
scope is the group level.
You can achieve the above by using the Sort dialog, shortcut menu, or labels.
Using the Sort dialog
To set the sort conditions in the Sort dialog:
1. Click Menu > Report > Sort (or the Sort button
Sort dialog.
on the Analysis toolbar) to bring up the
2. From the Sort in Scope drop-down list, select a banded object/table or a group field on which the
sort condition will be based.
3. From the field drop-down list, select the name of the field on which to sort the data. Set the sort
order to Ascending or Descending.
4. If you select a banded object/table in Step 2, you can click
condition if required, click
and click
or
to add a new row of sorting
to move a row up or down so as to set the sorting priority,
To delete the corresponding sorting condition.
If what you select in the Sort in Scope drop-down list is a group field, then only one sort condition
can be composed.
To retrieve the opening status of this dialog, click the Reset button.
5. Click OK to accept the settings and to reload the result.
Using the shortcut menu
To sort data on a certain field using shortcut menu:
1. Point to any value of a detail field or group field by which to sort the data in the banded object/
table, and then right-click.
2. Choose the command Sort > Ascending or Sort > Descending from the shortcut menu.
If what you right-click in Step 1 is a detail field value, the sorting will affect the order of detail
records in the banded object or table; if it is a group field value, the order of groups in the group
level represented by the group field will be rearranged.
To remove the sort condition on a field, click Sort > No Sort.
Using labels
You can use a label to control the sorting order for a certain field. This feature needs to be enabled at
report design time.
1. In JReport Designer, select a label in a banded object/table, and then set the Sortable property of
the label to true.
2. Set the field by which you want to sort records as the value of the label's Bind Column property.
3. Save the report and publish it to JReport Server.
4. Run the report in JReport Viewer, and you can click
beside the label to sort the data. This
button will change after you have clicked it, and you can further click it to switch the sorting
direction among ascending, descending, and no sort.
Notes:
●
●
●
You cannot sort the data by a global type formula.
You can also conduct sorting by using the shortcut menu for a label in the same way as for a field
value, provided you have set its Bind Column property.
For sorting the data using shortcut menu or labels, you may notice that the corresponding sort
expressions will appear in the Sort dialog if you open this dialog.
●
●
If you use the shortcut menu to sort the report data by a field and then sort by another field, the
later sort condition will replace the former one.
You can right-click an object in a banded object to show a shortcut menu, and then select the Reset
item to reproduce the data of the banded object using the data cached in the data buffer. This will
clear all sort and filter conditions except for those predefined in JReport Designer.
Searching for text in a report
You can use the Search dialog to find text in the values of a certain field or in the whole report content.
on the Standard
To show this dialog, click Menu > Edit > Search, click the Search button
toolbar, or right-click a field value or label (or object such as text box) and click Search on the
shortcut menu.
●
To find text in the values of a particular field:
1. Make sure the Search in Whole Report option in the Search dialog is NOT checked.
2. Select the field from the Select Field drop-down list.
3. Set the range with which to search for the value from the Value Range drop-down list.
4. Select the field value you want to search for from the Value drop-down list.
Note: If All is selected in the Value Range drop-down list, the only item in the Value dropdown list will be All and you cannot change the value, in which case, when you submit the
search, JReport will search for all the values of the selected field.
●
Specify whether or not to match case, whether or not to match whole word, whether or not to
highlight all the matching values and the searching direction.
●
Click the Search button.
●
To find text in the report content:
1. In the Search dialog, check the Search in Whole Report checkbox.
2. Type the string you want to search for in the Value box.
3. Set the other options such as the searching direction.
4. Click the Search button.
Notes:
●
●
●
Finding text in the values of a particular field is not supported on crosstabs and charts.
If you check Highlight All in the Search dialog, to clear the highlighting in the search result, uncheck
the option and submit the search again, or refresh the report.
If you have not selected the Search in Whole Report option, you will not be able to search special
fields for strings.
Analytic reporting
JReport Viewer provides you with a convenient and powerful tool to analyze your business information.
By providing secure web access to business data and making the data interactive, JReport Viewer
facilitates data analysis.
JReport Viewer enhances the utility of production reports by making them interactive - allowing you to
define your view of data to make it more useful. Through a user-friendly web GUI, report contents can
be easily navigated, drilled, and viewed in detail.
JReport Viewer uses the Resource View panel to provide a business-oriented view of databases. This
view shields end users from having to understand database connectivity and SQL syntax while allowing
IT professionals to maintain control of business data and to ensure its integrity. Using the Resource
View panel, JReport Viewer dynamically builds SQL statements to retrieve data and automatically
generate multidimensional data cubes. These cubes contain the underlying data structure which makes
data analysis possible.
The following topics describe the analytic reporting features:
●
An introduction to business/report cubes
●
Applying filters to business/report cubes
●
Using cube elements
●
Using dynamic resources
●
Drilling through the report data
●
Manipulating data components
●
Adding conditional formats to fields
●
Converting between components
●
Navigating through the report data
Note: A component created in JReport Designer is based on a dataset, while that created in JReport
Viewer is based on a business/report cube. For the former, if you want to do analytic actions in JReport
Viewer, such as adding a cube element, or drilling it, JReport Viewer will need to convert its fields to
cube elements. When conversion conditions are fulfilled, when you perform analytic actions in JReport
Viewer, you will be prompted with the Convert Data Fields dialog to confirm the conversion. However, if
the report tab level property Automatic Cube Initialization has been set to true when the report is
designed in JReport Designer, the data fields will be automatically converted to cube elements when
the report is opened in JReport Viewer.
An introduction to business/report cubes
A business/report cube, which is needed for creating multidimensional data cubes, contains database
connections and relationships between cube elements. The business/report cube shields report end
users from having to understand the physical structure of a data source, and enables them to build
reports and analyze data based on a set of cube elements they can understand. It also enables IT
professionals to maintain control of the business data and ensure its integrity, while presenting end
users with an intuitive view of the underlying data structures.
A business/report cube may contain category objects and cube elements (dimension objects, measure
objects, and detail information objects). You can insert these cube elements or remove them to change
the report result when you view reports in DHTML format.
●
●
Category objects
Category objects contain a collection of cube elements. A business/report cube may contain more
than one category. In the Resource View panel, the icon
indicates that an object is a category.
Categories are only for categorizing cube elements, and they cannot be inserted into a report. The
category is often used for indicating the name of the underlying DBMS table.
Dimension objects
Dimension objects are cube elements that will become the basis for analysis in a report. They
characteristically return text or date values. In the Resource View panel, the icon
indicates that
an object is a dimension object. A dimension object can be inserted wherever a group field can be
inserted into. It can be inserted as a column or row field in a crosstab, or as a group field or detail
field in a banded object or a table, or displayed as category/series field in a chart.
●
Measure objects
Measure objects are numeric cube elements that are calculated dynamically at runtime. The icon
indicates that an object is a measure object. A measure object can be inserted wherever a summary
can be inserted. For instance, it can be inserted into the group header or footer panel in a table or
banded object, or into a crosstab as an aggregate field. A measure object can also be used as a
detail field in a banded object or table although it will display the same aggregate value for every
detail line. JReport Web will calculate the summary values based on the group level the measure
object has been inserted into.
●
Detail Information objects
indicates that an object is a
Detail Information objects provide additional information. The icon
detail information object. It can be inserted wherever a DBField can be inserted. For example, you
can insert a detail information object into a table or banded object as a detail field.
Applying filters to business/report cubes
When creating reports in JReport Viewer, you can choose to apply some filter to the specified business/
report cube to narrow down the data scope of the business/report cube. Filters for business/report
cubes are defined into two categories in JReport Viewer: predefined filters and user defined filters. As
the name suggests, predefined filters are defined on business/report cubes in advance in JReport
Designer, and user defined filters are created on business/report cubes while they are used in JReport
Viewer.
Filters can be applied to business/report cubes in JReport Viewer in the following ways:
Applying a filter to a business/report cube while creating a report
1. In a JReport Viewer window, click Menu > File > New Page Report to display the New Page
Report dialog.
2. Specify the title of the report as required in the Report Title text box.
3. In the Choose Report Layout box, select the layout as Banded, Crosstab, Table or Chart and
then click OK.
4. In the corresponding report wizard, select the required business/report cube for the report, and
the fields you want to display in the report.
5. Click the Query Filter screen.
All the predefined filters of the selected business/report cube are listed in the Query Filter dropdown list. Choose the one you want to apply. If you want to further edit the filter, click the Edit
button and then redefine the filter as required. The edited filter will then be saved as a user
defined filter to the business/report cube.
If you prefer to define a filter on your own, select User Defined from the Query Filter drop-down
list, then define the filter according to your requirements.
There are the basic and advanced modes of the screen for you to define either simple or complex
filter expressions. See Filtering report data for details about how to define a filter.
6. Click Finish in the report wizard and the specified filter will be applied to the business/report
cube, so that your report will get data that meets the filter condition only.
Applying a filter to a business/report cube while inserting a data component
1. In a JReport Viewer window, do either of the following:
❍
❍
Click Menu > Insert > Banded Object/Table/Crosstab/Chart, point to the destination, and
then click the mouse button.
Drag Banded Object, Table, Crosstab, or Chart from the Toolbox panel to the destination.
2. In the corresponding report wizard, select the required business/report cube for the component,
and the fields you want to display in the component.
3. In the Query Filter screen, specify the filter you want to apply to the business/report cube from
the Query Filter drop-down list, or define a filter according to your requirement.
4. Click Finish to create the component and the specified filter will be applied to the business/report
cube.
Applying a filter to a business/report cube after a report is built
1. Select the component in a report which was created on a business/report cube by clicking
anywhere in it, and then clicking the icon
at the upper left corner of the component.
2. Click Menu > Report > Query Filter, or right-click the component and select Query Filter from
the shortcut menu to display the Query Filter dialog.
3. From the Query Filter drop-down list, select the filter you want to apply to the business/report
cube used by the component, or define a filter according to your requirement.
4. Click OK to apply the filter to the business/report cube.
Notes:
●
●
●
A JReport Live license for JReport Server is required in order to use this feature. If you do not have a
Live license please contact your Jinfonet Software account manager to obtain a license.
Business/report cube filters are defined on the component level in JReport Viewer, which means each
time you create a component, you can apply a filter to the business/report cube it applies to and it
will not affect other components based on the same business/report cube.
In JReport Viewer, you cannot edit the predefined filters that have been created on a business/report
cube at the Designer side. You can just edit the condition based on a predefined filter and then the
edited filter will be saved as a user defined filter.
Using cube elements
After a report has been built and published to JReport Server, you can open it in JReport Viewer and use the Resource View panel to
analyze data of the report by dragging cube elements from the panel to the component (banded object, table or crosstab) in the
report, provided that the data objects used by the component can be converted to corresponding cube elements (see the note in
Analytic reporting for details).
Tip: To display the Resource View panel, click Menu > View > Resource View or the Resource View button
on the View
toolbar. You can use the search bar at the top of the panel to search for any desired resource in a fast and convenient way.
The following examples show how to analyze reports using cube elements. These examples are based on the WorldWideSalesRC
report cube in Data Source 1 of the SampleReports catalog. The report cube contains thirteen dimension objects (City, Country,
Customer Name, Region, State, Territory, Sales Month, Sales Quarter, Sales Year, Category, Product ID, Product Name, and Product
Type), eleven detail information objects (Address 1, Country, Customer Name, CustomerCityStateZip, Phone, Cost, Discount, Order
Date, Quantity, Total, and Unite Price), and three measure objects (Total Cost, Total Quantity, and Total Sales). Total calculates the
value of the formula ("Unit Price" * Quantity - "Unit Price" * Quantity * Discount/100), Total Sales defines an aggregate function
Sum on the formula Total, Total Cost is Sum on Cost, and Total Quantity is Sum on Quantity.
●
Example 1: Analyzing a banded report
●
Example 2: Analyzing a crosstab report
●
Example 3: Analyzing a table report
Example 1: Analyzing a banded report
1. In JReport Viewer, design a banded report titled Sales in China on WorldWideSalesRC, which shows the fields Product ID,
Country, Product Name, Unit Price, Quantity, and Discount, and applies the ClassicBlue style.
First, we will apply a filter to the banded object to narrow down data scope.
2. Click the Filter button
on the Analysis toolbar. In the Filter dialog, define the filter as COUNTRY = 'China'.
We want to further sort the banded object by Product Name ascending.
3. Right-click any of the Product Name values and select Sort > Ascending from the shortcut menu.
4. As the banded header panel holds no data, we can hide it by right-clicking it and selecting Hide from the shortcut menu.
Now the report shows as follows:
Next, we will add the Total field to the banded object and group by the City field.
5. Click the Resource View button
shown in the panel.
on the View toolbar, then resources of the report cube the banded object uses will be
6. From the Resource View panel, drag the detail information object Total in the Orders Detail category to the detail panel of the
banded object.
7. Drag the dimension object City in the Customers category to the banded page header panel, when a blue line appears, release
the mouse button.
8. Finally, drag the measure object Total Sales in the Orders Detail category to the group footer panel.
9. We can now analyze the data in various ways. For example, if we want to see the sales by category instead of city, right-click
on any of the City fields and select Drill To > Category from the shortcut menu, then we can see the same report with an
entirely different view of the data.
Example 2: Analyzing a crosstab report
1. Design a crosstab report on WorldWideSalesRC showing product sales information with Product Type (ascending) as the column
field, Category (ascending) as the row field, and Total Cost as the aggregate field. Apply the ClassicBlue style to the crosstab.
First, we want to replace the product type information with region information, and display the total sales of each product category
in each region.
2. Remove Product Type from the crosstab by pointing to the header Product Type (Decaf or Regular), then dragging it outside
the report page. A message box will prompt you whether or not to remove the field. Click OK to confirm, and we can see that
the crosstab no longer contains the Product Type information.
3. Click the Resource View button
in the panel.
on the View toolbar, then resources of the report cube the crosstab uses will be shown
4. Drag the dimension object Region in the Customers category from the Resource View panel to the crosstab until a blue line
appears indicating the group level of the dimension.
5. Drag the measure object Total Sales in the Orders Detail category to the aggregate area of the crosstab.
Now the total sales of each product category in each region is displayed.
6. Then we would like to see the territory information for the EMEA region. Click in the EMEA header and we will drill down to the
next lower level based on the hierarchy defined in the report cube which in this case is Territory.
Using the same way, we can further drill down to the country, then the city levels which have been defined in the hierarchy to
get detailed sales information in each city. For more details about drilling, refer to Automatic drilling.
Example 3: Analyzing a table report
For a table, you can analyze its data in the same way as for a banded object. Furthermore, JReport Viewer provides some analysis
methods specific for tables.
1. Design a table report on WorldWideSalesRC, which shows the fields Product Type, Country, Product Name, Unit Price, Quantity
and Discount, and applies the ClassicBlue style.
2. Add a filter COUNTRY = 'China' AND PRODUCT TYPE = 'Decaf' to the table (see Example 1 for details on filtering). The table
displays as follows:
For a table, we can insert a column (or row for horizontal table) at a specific position. So next, we will insert the dimension object
City into the table.
3. Click the Resource View button
the panel.
on the View toolbar, then resources of the report cube the table uses will be shown in
4. Drag City in the Customers category from the Resource View panel to the boundary between the first column (Product Type)
and the second column (Country) in the table until a blue line appears.
The report result will be regenerated.
Note: When you add a column to a table, if the width of the table exceeds the defined page size, you will be prompted
whether to allow JReport to adjust the page size automatically so as to place the column. Click Yes in the message box to
have the page size adjusted, or No to make the columns in the table compressed. Also, If you do not want to display the
message in future, check Don't prompt the message again in the message box, or uncheck Always Prompt Whether
to Adjust Page Size Automatically in the Profile > Customize Profile > DHTML > Properties > Default tab. If you
choose not to show the message box again, when the table width exceeds the defined page size, JReport will always
adjust the page size automatically.
Next, we want to show the total information and remove the product name information. This can be done with a single drag-anddrop.
5. Drag the detail information object Total in the Orders Detail category to the header Product Name until the label Product Name
is highlighted in a blue background.
Now, the total value for each record will be generated.
As a table column can contain more than one field, next, we will add the measure object Total Sales to the Total column.
6. Drag Total Sales from the Resource View panel to any value in the Total column.
The report result will be regenerated.
Here 182,298.76 is the sum of all total values. In this way, the title for the added field will not be automatically created.
At last, we want to change the order of the Total and Discount columns in the table.
7. Drag the label Total to the right of the Discount column, when a blue line appears along the right boundary of the Discount
column, release the mouse button.
We can see that order of the columns changes.
Notes:
●
●
●
A JReport Live license for JReport Server is required in order to use this feature. If you do not have a Live license please contact
your Jinfonet Software account manager to obtain a license.
When you are using a report cube, the records will be fetched based on the query which contains the report cube in JReport
Designer; while for a business cube, there is no predefined query and you will fetch records from the data source using dynamic
SQL.
To use the Resource View panel so as to add cube elements to the report, you should make sure that this ad hoc feature is
enabled in the specified DHTML feature profile. This setting can only be made by administrators.
Using dynamic resources
When you drag cube elements from the Resource View panel to analyze data of a report, sometimes you may find that the cube elements that
have been predefined in the business/report cube cannot meet your requirements, in which case, you can create some dynamic resources and use
them in the report to get the desired data. Then when you save the report, the dynamic resources will be saved along with the report as its
resources. Dynamic resources in JReport Viewer include formulas and measures.
Creating and using dynamic formulas
You should have some knowledge of the formula syntax before you can successfully compose a formula with no errors.
To create a dynamic formula:
1. In the Resource View panel, expand the Dynamic Resources > Formulas node, then click <Add Formula…> to display the Formula
Editor window.
2. Enter a name for the formula in Formula Name text field.
3. Compose the formula by selecting the required fields, functions and operators from the Fields, Functions and Operators panels. You can also
write the formula by yourself in the editing panel.
4. Click the Check button
to check whether or not the syntax of your formula is correct.
5. When done, click the OK button to create the formula.
Once a dynamic formula has been created, you can then drag it from the Resource View panel to the desired position in the report as a detail
information object for data analyzing. The formulas can also be used to control object properties if you are an advanced user and provided that
the Use Dynamic Formula in Property is checked on the Report menu.
Also, if you want to further edit an existing formula or remove any formula that is not required, right-click the formula and then click the
corresponding command on the shortcut menu. However, if the formula has been used in the report or referenced by another formula, it cannot
be deleted.
Creating and using dynamic measure objects
In JReport Viewer, you can also create dynamic measure objects by mapping them to the available resources which include dimension objects,
detail information objects in the current business/report cube and the dynamic formulas that have been created in the report.
To create a dynamic measure object:
1. In the Resource View panel, expand the Dynamic Resources > Measures node, then click <Add Measure…>. The Add Measure dialog is
then displayed.
2. In the Measure Name text field, specify the display name of the measure.
3. Click the chooser button
next to the Mapping Name text field to specify a field or a formula on which the measure object is based.
4. From the Aggregate Function drop-down list, specify the aggregate function for the measure object.
5. When done, click OK to create the measure object.
You can also create a dynamic measure object on a dynamic formula. To do this:
1. In the Resource View panel, right-click the formula in the Dynamic Resources > Formulas node, then select Create Measure from the
shortcut menu.
2. In the Add Measure dialog, specify the display name of the measure object and the aggregate function as required.
3. When done, click OK button.
Once a dynamic measure object has been created, you can then drag it from the Resource View panel to the desired position in the report so as
the get the desired data. And if you want to edit any dynamic measure object or delete it, right-click the measure object and click Edit or Delete
on the shortcut menu (a measure object that has been used in report cannot be deleted).
Notes:
●
●
●
A JReport Live license for JReport Server is required in order to use this feature. If you do not have a Live license please contact your Jinfonet
Software account manager to obtain a license.
Currently, global variables and User Defined Formulas (UDF) are not supported in dynamic formulas, and you can only save a dynamic formula
with no errors into a report.
When formulas reference display names or mapping names, the names should not contain any of below characters if the names are not quoted
by double-quotation marks "":
"~", "`", "!", "@", "#", "$", "%", "^", "&", "*", "(", ")", "-", "+", "=", "{", "}", "[", "]", "|", "\\", ":", ";", "\", " ' ", "<", ",", ">", ".", "?", "/"
Examples:
❍
Expression @Customer#; will cause a syntax error. But @"Customer#" is ok.
❍
If a field has the display name Category.Measure, when adding it to a formula, quote it as "Category.Measure" or "Category"."Measure".
●
●
Dynamic resources are report tab level resources, which means they are only available to the report tab for which they are created.
Now in JReport, the display names of objects in a category in a business/report cube cannot be duplicated. When you choose to create a
dynamic formula/measure object on an object which was created in a previous version and it has the same display name as another object, you
will be prompted with a message asking you to give a new name for the object in JReport Designer first.
Drilling through the report data
In a DHTML report, you can choose to show certain groups of records according to your requirements,
and switch among the groups to see the data you want. Moreover, you can define some methods to
view specific data.
This section presents three kinds of drilling in JReport Viewer. They are:
●
Automatic drilling
●
User defined drilling
●
Going
Automatic drilling
Automatic drilling enables you to switch from the current dimension to another dimension by using
system-defined commands on the shortcut menu, and it is divided into four kinds:
●
●
●
●
Drill-to
It enables you to obtain a different view of data by switching among dimensions.
Drill-to-by-value
It enables you to filter data based on a drill-to action so as to obtain a more detailed view of the data.
Drill-down
It enables you to drill data to lower dimensions according to predefined hierarchies.
Drill-up
It enables you to drill data to higher dimensions according to predefined hierarchies.
Drilling actions are performed on crosstabs, and grouped tables and banded objects, whose data are
based on business/report cube or if on query, data fields of which can be converted to corresponding
cube elements (see the note in Analytic reporting for details). After drilling, the new component can be
analyzed in the same way as the original one.
Assume you have created a crosstab report on the report cube WorldWideSalesRC in Data Source 1 of
the SampleReports catalog showing product sales information with Region as the column field, Sales
Year as the row field, and Total Sales as the summary field, and applied the default style to the
crosstab. The crosstab shows as follows:
We will now take the crosstab as an instance to illustrate the automatic drilling functions.
Drill-to
1. Right-click any value of Region, APAC for example, and choose Drill To from the shortcut menu.
The list of dimensions available for Drill To will appear on the submenu.
2. Click Product Type on the submenu, then in the regenerated result, we can see that Sales Year
remains the dimension for rows and Product Type becomes the dimension for columns.
3. Repeat Steps 1 and 2 to drill the data to other dimensions. Row field can also be drilled freely.
4. To go back to the original report, right-click any value of Product Type, choose Drill To > Region
from the shortcut menu.
Drill-to-by-value
1. Go back to the original report in the above example.
2. Right-click the value APAC of the Region dimension, and point to Drill to By Value on the
shortcut menu. A submenu for the command is displayed, which lists the same items as those of
Drill To.
3. Click Product Type too and the result will be regenerated.
We can see that the result is different from that of drill-to. This is because that, for the drill-to-byvalue action, the dimension of columns changes to Product Type by the Region value APAC. That
is, on the basis of the drill-to action, a filtering action where Region = APAC is further performed,
and thus the result of drill-to-by-value is generated.
In addition, when a drill-to-by-value action is performed, the Drill Filter panel will be displayed on
the left of the JReport Viewer window, which shows the dimension and the value the filter is based
on.
4. To go back to the original report, first delete the drill filter in the Drill Filter panel by clicking X
next to the dimension name, then right-click any value of Region and click Drill To > Region
from the shortcut menu.
Drill-down
Drill-down actions are based on predefined business/report cube hierarchies. The report cube
WorldWideSalesRC contains a hierarchy Geography, which allows you to drill a dimension
(corresponding to a high level) down to the one-level-lower dimension.
1. Go back to the original report in the above example, right-click the value APAC, on the shortcut
menu, point to Drill Down, and we can see that Territory is listed as the submenu item.
2. Click Territory to see the result. It displays the data about territories in the Asia Pacific region.
3. The one-level-lower dimension for Territory defined in the hierarchy is Country. Now click Asia
directly and JReport will also drill it down to Country.
After these two drill-down actions, we can see two filters are added in the Drill Filter panel, Region
= APAC and Territory = Asia.
This is because, when you perform a drill-down action, a filter will be created based on the value
you click on. In this example, we first click on the APAC region, so JReport drills this region onelevel down to display territories in APAC, and thus the filter Region = APAC is created. If you want
all data in the one-level-lower dimension to be displayed when you drill down a dimension, you
can remove the corresponding filter from the Drill Filter panel.
Drill-up
Drill-up actions allow you to drill a dimension (corresponding to a low level) up to the one-level-higher
dimension. For a crosstab, if a dimension can be drilled up to a higher level, a drill-up arrow will be
displayed on its right. You can click the arrow directly to perform the drill-up action.
1. Based on the report result after drill-down, right-click any value of Country, China for example, on
the shortcut menu, point to Drill Up, and we can see that Territory is listed as the submenu item.
2. Click Territory to see the result. The dimension is drilled one level up. Territory is now the
dimension for columns.
3. The one-level-higher dimension for Territory defined in the hierarchy is Region. Now click the drillup arrow of any territory directly and JReport will drill it up to Region.
Notes:
●
●
●
A JReport Live license for JReport Server is required in order to use this feature. If you do not have a
Live license please contact your Jinfonet Software account manager to obtain a license.
For banded object and table, you can right-click its group header/footer to show the shortcut menu
so as to use the automatic drilling functions, you can also right-click field values in the group header/
footer to achieve this.
For dimension objects that not used as group fields in a banded object or table, automatic drilling
doesn't take effect.
User defined drilling
Besides automatic drilling, JReport provides you with custom drilling functions including support for
linking to another report and for linking to a detail report, making the analysis of a report more diverse
and useful.
Linking to another report
A link to another report can be bound to a field, a lable, an image, or a shape map area in JReport
Designer. This is useful for viewing some information related to the current report, especially with
viewing a report for comparison.
To use a link in JReport Viewer:
1. Develop a page report in which a report tab contains an object which is linked to another report in
JReport Designer.
2. Publish the report to JReport Server.
3. Run the report in DHTML format with JReport Viewer.
4. Click the trigger object in the report, or right-click the object and then select Link Report from
the shortcut menu.
5. The linked report will then be shown.
Linking to a detail report
In most cases, your reports will be related to each other, instead of being isolated. Each report may
have a particular emphasis on one or more aspects. In some circumstances, you may want to set up
certain relationships among your reports so that you can browse from one report to another through
the relationship "channels" that you create.
Such an inter-report relationship network can be achieved by setting up "Anchor" and "Filter"
conditions between two reports. You can use one report to hold comprehensive report data, and
another to show detailed information on a specific topic.
JReport reports can be joined together to compose a master/detail report group. Normally, a master
report holds more comprehensive data, while detail reports hold related detail information. A detail
report can be the master report of another report. In this way, by setting up more and more pairs of
master/detail reports, many reports can be joined together, and a report chain is formed.
To use master/detail reports in JReport Viewer:
1. Develop the reports with master/detail relationship in JReport Designer.
2. Publish the reports to JReport Server.
3. Run the report which contains the master report in DHTML format on JReport Server.
4. Click the trigger object in the master report, or right-click the object and then select Detail
Report from the shortcut menu.
5. You may be prompted to provide encoding and DB security information before the report result is
produced. Click OK if you want to run a detail report using the same encoding and DB security
settings as that of the master report.
6. The detail report will show only the records in conformity to the anchor and filter conditions.
Notes:
●
●
To make the detail report show only the records related to a trigger field value in the master report,
you should specify the Target Frame option as Same Frame when you set up the master/detail
relationship in JReport Designer. If you select Server Setting, you should further make sure that the
Pop Up New Window for Links option has not been checked in the Profile > Customize Profile >
DHTML > Properties > Default tab. Otherwise, the detail report will be opened in a new web browser
window with no relationship to the master report.
A "link path", which tracks the linking (user defined drilling) actions, will be displayed in the Go To
drop-down list on the navigation bar after you have drilled to the link report or detail report if it is
opened in the current window. Clicking an item in the list will switch to the corresponding report.
Going
In a DHTML report, you can select to show certain groups of records in a banded object according to your requirements. You can also
switch among the groups to see the data you want. This action is called going, which divides into go-to, go-up, go-down, and go-todetail, as indicated in the diagram.
●
●
●
●
Go-to
The go-to action allows you to switch the data presented in a banded object from any group to any other group.
Go-up
Go-up means to jump up one group level to show the records of a particular group.
Go-down
Go-down means to jump down one group level to show the records of a particular group.
Go-to-detail
Go-to-detail allows you to concentrate on the details of a group.
Going actions are available only for banded objects that contain groups, and fields in which have not been converted to cube elements
of a report cube. Going actions do not apply to banded objects created in JReport Viewer. After a going action has been performed, the
data presented in the banded object will be re-loaded from the data buffer, showing only the records in the selected group, and the new
report created by going can also be viewed, printed, and exported to other format in the same way as the original report. In addition, a
"going path", which tracks the going action, will be displayed in the Go To drop-down list on the navigation bar, with which you can
easily return to the original report.
The following describes the use of the going actions based on Banded_Link.cls in the SampleReports folder of Public Reports, which
contains a banded report.
Go-to
1. Run Banded_Link.cls.
2. Point to the region APAC, right-click and select Go To > APAC > Vietnam from the shortcut menu.
Then only the data about Vietnam is displayed.
3. To return to the original status, right-click any value and then click Go To > ROOT on the shortcut menu; or from the Go To dropdown list on the navigation bar, select Product Sales by Country.
You may notice that the result is not dependent on what you right-clicked, in other words, you can right-click any field value in the
banded object or even the blank part of a group header/footer panel or detail panel, in order to perform a go-to action.
Go-up
For a go-up action, you need to right-click a group header/footer panel or any object in the panel, at the same time, you should make
sure that this group level is lower than some other group levels.
1. Undo the go-up action in the above example.
2. Point to any country, for example China, right-click and select Go Up > LATAM from the shortcut menu.
Then only the data about LATAM is displayed.
At Step 2, you may find that items listed on the Go Up submenu are regions of the Region group level which is one level higher than the
current group level - Country. That is, the go-up action allows you to focus your attention on the groups of a higher level than what you
right-click.
Go-down
For a go-down action, you need to right-click a group header/footer panel or any object in the panel, at the same time, you should
make sure that this group level is higher than some other group levels.
1. Undo the go-up action in the above example.
2. Point to APAC, right-click and select Go Down > Singapore from the shortcut menu.
Then data about Singapore is displayed.
At Step 2, you may find that items listed on the Go Down submenu are countries of the Region group level which is one level higher
than the group level of Country, and only countries in the Asia Pacific (APAC) region are displayed. That is, the go-down action allows
you to focus your attention on the groups of a lower level than what you right-click, and only those lower-level groups which are related
with the higher-level group value you right-click will be concerned.
Go-to-detail
If a banded object contains group information, then a field, label, image or shape map in a group header/footer panel of the banded
object can be used to obtain information of that group, and a chart in a banded object also has the similar function. The Go-to-detail
action should be predefined at report design time.
1. Undo the go-down action in the above example.
2. Point to LATAM, right-click and select Go to Detail from the shortcut menu.
Then only the data about this region is displayed.
Manipulating data components
You can manipulate data components, which refer to crosstabs, tables, banded objects, and charts, in
JReport Viewer as shown below. However, most of the manipulations require selecting the component
first. To select a component, click anywhere in the component, when the icon
appears at its upper
left corner, click the icon.
Note: When manipulating data components, a JReport Live license for JReport Server is required in
order to use the features involving report cube/business cube or changes of report template. If you do
not have a Live license please contact your Jinfonet Software account manager to obtain a license.
Setting the number of records retrieved by report components
You can set the number of records that can be retrieved by all components in a report. To do this,
select a value to your liking (All or first 50 to name a few) from the Max Records combo box
on the Analysis toolbar. You can also directly input a positive integer here and
press Enter to retrieve the corresponding records. Alternatively, you can click Menu > Report > Max
Records to show the Max Records dialog, and then achieve the same goal. If you are making a lot of
changes to the report, it may be faster to limit the number of records to 1 page while you make the
changes then change it back to All to view the final result.
Manipulating a crosstab
●
●
Changing the dimension index in a crosstab
The dimension index in a crosstab can be modified, namely, you can move a dimension to a higher or
lower level. This operation can be performed on crosstab's containing two or more dimensions. To do
this, you can simply drag a dimension object (row/column header) to the required destination till a
blue line appears. You can also drag a column header to a row level and vice versa.
Rotating a crosstab
Columns and rows in a crosstab can be exchanged. This operation is called rotating a crosstab.
To rotate a crosstab, first select it, and then do one of the following:
●
●
❍
Click Menu > Report > Rotate Crosstab.
❍
Click the Rotate button
❍
Right-click the icon
on the Analysis toolbar.
of the crosstab and select Rotate from the shortcut menu.
Expanding/Collapsing a crosstab
For a crosstab, if it has more than one row/column group level, you can specify whether or not to
enable the crosstab to be expanded in JReport Viewer, and set the default expanding/collapsing state
of groups in outer levels.
Adjusting the width of crosstab fields according to the contents
When the contents in the field of a crosstab need more space to completely display, you can adjust
the width of the field according to its contents. To achieve it, first select the field, then right-click on
it and select Autofit from the shortcut menu.
Manipulating a table
●
Adjusting order of columns in a table
The order of columns in a table can be easily adjusted. To do this, drag a column header to the left
or right boundary of another column header, when a blue line appears along the column boundary,
release the mouse button, and you will see the order change.
The above description is for a vertical table. With regard to a horizontal table, you can do the same
actions on its row headers.
●
●
●
●
●
●
●
Adjusting grouping order in a table
A table may contain several group levels. The order of the group levels can also be adjusted. To do
this, drag a group field value to the required position until a blue line appears.
Hiding/Deleting table columns
A table column (for a horizontal table, the "column" corresponds to a field row) can be hidden or
removed. To do this, select the cell of the column in the table header and right-click, then select
Hide Column or Remove Column from the shortcut menu, and the column will be hidden or
removed from the table.
Showing table columns
of the
You can specify which columns will be shown in a table. To do this, right-click the icon
table, then on the shortcut menu, check the names of the columns you want to show from the Show
Column submenu.
Adjusting the width of table columns according to contents
When the contents in cells of a table column need more space to completely display, you can adjust
the width of the table column according to the contents. To do this, right-click the cell of the column
in the table header, then select Autofit from the shortcut menu.
Changing group direction
You can make the group headers that are placed horizontally in a table to be displayed vertically. To
do this, right-click the group header row and select Vertical to Detail from the shortcut menu. In
addition, if the first column of a table is group column, you can specify to place the group column
horizontally in a table. To do this, right-click the cell of the group column in the table header, and
select Horizontal to Detail from the shortcut menu.
Rotating a table
You can rotate a table to switch its appearance between the horizontal and vertical layout modes by
doing one of the following:
❍
Click Menu> Report > Rotate Table.
❍
Click the Rotate button
❍
Right-click the icon
on the Analysis toolbar.
of the table and select Rotate from the shortcut menu.
Inserting table columns
You can insert a new column in a table and it could be a common column, detail column, summary
column, or group column.
❍
To insert a common column into a table:
1. Right-click any cell in the table header, or right-click the icon
of the table.
2. On the shortcut menu, click Insert > Common Column.
❍
To insert a detail or summary column into a table:
of the table, then select
1. Right-click any cell in the table header, or right-click the icon
Insert > Detail Column/Summary Column from the shortcut menu.
2. In the corresponding insert column dialog, specify the resource you want to use for the new
column, then click OK.
❍
To insert a group column into a table:
1. Right-click any cell in the table header, or right-click the icon
Insert > Group Column from the shortcut menu.
of the table, then select
2. In the Insert Group Column dialog, select the dimension object you want to use for the new
group column from the Resources panel and click
to add it as the group by field, then
specify the sorting direction of the group in the Sort column.
3. Specify the positions of the group by fields: Group Above, Group Left Above, or Group Left.
4. Repeat the above steps to add more groups if required.
5. Click OK to insert the columns.
The next time when you open the Insert Group Column dialog to add more group columns, all
the added group by fields will be listed in the dialog. You can choose to remove or edit them if
required.
Note: If you right-click any cell in the table header and use its shortcut menu to insert a
common, detail or summary column, the column will be inserted before the column in which the
cell you click on is, however, if you use the table shortcut menu to insert the column,
❍
❍
●
If it is a common column, the column will be inserted as the last column in the table.
If it is a detail/summary column, the column will be inserted after the last detail/summary
column, or as the last column in the table when there is no detail/summary column.
Converting table columns
You can convert a group column into a detail column, and vice versa.
❍
❍
To convert a group column into a detail column, select the cell of the group column in the table
header, right-click and select Convert to Detail from the shortcut menu, then the conversion is
done.
To convert a detail column into a group column:
1. Select the cell of the detail column you want to convert in the table header, right-click and
select Convert to Group from the shortcut menu.
2. In the Select Group Position dialog, specify the position for the newly converted group by field.
3. Click OK to save the changes.
●
Aggregating on a detail column
You can summarize the data in a detail column if required. To do this:
1. Select the cell of the detail column in the table header, right-click it and select Aggregate On
from the shortcut menu.
2. In the Aggregate On dialog, specify a function from the Function drop-down list to summarize
the data.
3. When done, click OK.
■
■
If the table has groups, you will find data in each group level and the whole table are
summarized respectively in the column.
If the table has no groups, the summary will be based on the whole table.
When you finish summarizing a detail column, you will find a dynamic measure object is created at
the same time which is given a default name Function_DetailFieldName in the Dynamic Resource >
Measures list in the Resources View panel and you can use it again in the current report if required.
Note: If a table is created in JReport Designer, you can add, convert columns in the table, or
aggregate on its detail columns in JReport Viewer only when data fields used by the table can be
converted to corresponding cube elements. See the note in Analytic reporting for details.
Manipulating a banded object
●
●
●
Hiding/Showing a panel in a banded object
of the banded
A panel in a banded object can be hidden or shown. To do this, right-click the icon
object, then on the shortcut menu, click the item which indicates the panel name from the Show
submenu. For a panel which is shown, the item is with a check mark, and vice versa. This operation
is also applicable for hiding/showing a row in a table.
Hiding/Showing DBFields and labels in a banded object
The DBFields and their corresponding labels in a banded object can also be hidden or shown. To do
this, right-click the icon
of the banded object, then on the shortcut menu, click the fields and
labels you want to show from the Show Field submenu. For a field or label that is shown, it will be
marked with a check mark, and vise verse.
Expanding/Collapsing a group panel in a banded object
Group panels in a banded object can also be expanded or collapsed.
Manipulating a chart
●
Modifying the definition of a chart
You can modify the definition of a chart, including the chart type, data display, and style. To do this:
1. Right-click the icon
of the chart or any part of the chart other than the legend and label to
show a shortcut menu, and then select Format Chart from the shortcut menu to display the
Chart Definition dialog.
Note: In the event that the chart is built in JReport Designer, the Format Chart command
will be available only when JReport Viewer can convert data fields used by the chart to
corresponding cube elements. See the note in Analytic reporting for details.
●
In the Chart Type tab of the Chart Definition dialog, specify the type for the chart.
●
In the Display tab, change the dimension and measure object used by the chart.
●
In the Style tab, modify the style for the chart as required. If there is only one style available, this
style will be applied to the chart by default and the Style tab will be hidden from the dialog.
Upon finishing, click OK to apply the modifications.
●
For details about how to modify the chart definition with the Chart Definition dialog, see
Creating a chart report.
In addition, if you only want to change the chart type, no matter whether the chart is originally
created in JReport Designer or JReport Viewer, you can achieve it by doing one of the following:
❍
❍
●
Right-click the chart and on the shortcut menu, select the required type from the Chart Type
submenu, which lists all the chart types and subtypes (the current one and the inapplicable
subtypes are grayed out).
Select the chart, click the Chat Type button
suitable subtype from the drop-down menu.
on the Analysis toolbar, and then select a
Formatting chart elements
The elements (platform, paper, legend and label) in a chart can be formatted to suit your
requirement.
❍
❍
To format the platform/paper of a chart, right-click the icon
or any part of the chart except for
the legend and label and select Format Platform/Format Paper from the shortcut menu. In the
displayed format dialog, specify the settings as required. For details about the settings, refer to
Format Platform dialog and Format Paper dialog.
To format the legend/label of a chart, right-click the legend/label and select Format Legend/
Format Label from the shortcut menu. In the displayed format dialog, set the properties
according to your requirement. For details about the properties, see Format Legend dialog and
Format Label dialog.
Going up/down on Google map group markers
●
●
For the group level that is higher than some other group levels in a Google map component, point to
its group marker, right-click it and select Go Down from the shortcut menu to jump one group level
down.
For the group level that is lower than some other group levels in a Google map component, point to
its group marker, right-click it and select Go Up from the shortcut menu to jump one group level up.
Adding conditional formats to fields
You can add some conditional formats to a field, which refer to the DBField, parameter field, formula field,
summary field, and the special field Page Number or User Name, then when the specified condition is fulfilled, the
defined format will be applied to the field values for highlighting.
To add conditional formats to a field:
1. Right-click the field and select Conditional Formatting from the shortcut menu to access the Conditional
Formatting dialog.
2. Click the button
to open the Edit Conditions dialog to define the condition as required.
There are the basic and advanced modes of the dialog for you to define either simple or complex condition
expressions. See Filtering report data for details about how to define a condition.
3. When done, click OK to save the condition.
The newly added condition will then be displayed and highlighted in the Condition box in the Conditional
Formatting dialog.
4. In the Format box, set the format which will be applied to values of the field when the specified condition is
fulfilled, for example, the font face, font size, font color, etc.
5. Repeat the above steps to add more conditions and define the format for each condition as required.
To edit a condition, select the condition in the Condition box, then click
edit the condition expressions as required.
. In the Edit Conditions dialog,
To remove a condition and the corresponding format, select the condition in the Condition box and click
.
To adjust the priority of a condition, select the condition in the Condition box and then click
or
6. Click OK to apply the conditional formats to the field.
See also Conditional Formatting dialog and Edit Conditions dialog for details about options in the dialogs.
.
Converting between components
Converting between components enables you to view and analyze data from different aspects with
different focuses. In JReport Viewer, you can convert a crosstab into a chart and vice versa, however, if
a crosstab/chart is designed in JReport Designer, to enable the conversion, you need to make sure that
data objects used by the crosstab/chart can be converted to corresponding cube elements (see the
note in Analytic reporting for details).
Note: A JReport Live license for JReport Server is required in order to use this feature. If you do not
have a Live license please contact your Jinfonet Software account manager to obtain a license.
Converting a crosstab into a chart
To convert a crosstab into a chart:
1. Click anywhere in the crosstab, when the icon
select the crosstab, then do any of following:
❍
Right-click the icon
❍
Click Menu > Report > To Chart.
appears at its upper left corner, click the icon to
and select To Chart from the shortcut menu.
2. The Convert Data Fields dialog may appear for your confirmation on converting data fields of the
crosstab to cube elements of a business/report cube. Click OK to confirm, and the To Chart dialog
will be displayed.
3. In the Chart Type tab, specify a suitable type for the chart. With a certain type specified, you can
further define the chart as a combo chart by clicking <Add Combo Type> in the Chart Type
Groups box.
4. In the Display tab, the Resources box lists all the cube elements used in the selected crosstab
including dimension and measure objects. The chart can only be defined based on the cube
elements listed. Add a dimension object
to the Series box, and measure objects
from the Resources box to the Category box, and so
to the Show Values box respectively.
5. In the Style tab, set the style for the chart as required.
If the crosstab is in a table or banded object, by default, the chart converted from the crosstab will
take on the style of the table or banded object. If you want to apply another style to the chart,
uncheck the Inherit Style option and choose the desired style in the Style box. However, when
there is only one style available, this style will be applied to the chart by default and the Style tab
will be hidden from the dialog.
6. Click the OK button to finish the conversion.
Converting a chart into a crosstab
To convert a chart into a crosstab:
1. Click anywhere in the chart, when the icon
appears at its upper left corner, click the icon to
select the chart, then do any of following:
❍
❍
Right-click the icon
or any part of the chart except for the legend and label, then click To
Crosstab on the shortcut menu.
Click Menu > Report > To Crosstab.
2. The Convert Data Fields dialog may appear for your confirmation on converting data fields of the
chart to cube elements of a business/report cube. Click OK to confirm, and the To Crosstab dialog
will be displayed.
3. In the Display tab, select a dimension object in the Resources box and click
to add it as a
to add it as an
group field to the Columns or Rows box; select a measure object and click
aggregate field to the Summaries box. Repeat these to add more aggregate fields.
In the Display Name column, you can edit the display name of a group field or aggregate field,
and the Sort columns allow you to specify a sorting manner on a group field.
If you want to remove any group/aggregate field, select it and click
.
To adjust the order of group/aggregate fields, select a group/aggregate field and click
or
.
4. In the Style tab, apply a style to the crosstab as required.
If the chart is in a table or banded object, by default, the crosstab converted from the chart will
take on the style of the table or banded object. If you want to apply another style to the crosstab,
uncheck the Inherit Style option and choose the desired style in the Style box. However, when
there is only one style available, this style will be applied to the crosstab by default and the Style
tab will be hidden from the dialog.
5. Click OK to finish the conversion.
Note: Additional values are supported only in chart. If you convert a chart with additional values into
crosstab, the additional values are not converted together with the chart.
Navigating through the report data
You can use the TOC Browser to navigate through a report. To show the TOC Browser, click Menu >
View > TOC Browser.
In the TOC Browser, expand the Report node, select a component or a node with the group value that
you want to browse to. The page that contains the component or the matching data will then be shown.
The table of contents on the TOC Browser is organized into a tree structure. The root node represents
the report tab that you are currently viewing. The component names indicate components in the report
tab. The group values show hierarchical groups.
TOC in JReport Designer
Just like a report, the format of the TOC is designed in JReport Designer. In the root node in the Report
Inspector of JReport Designer, there is an object named TOC. You can modify its properties to
customize your TOC style.
TOC Anchor
Besides the groups, you can also add your own nodes to the TOC Browser. Most components in JReport
Designer hold a property called TOC Anchor which holds a Boolean value. If the TOC Anchor property
value is true, a node for this object will then be added to the TOC tree. When you click such a node,
JReport Viewer will turn to the page that contains this component. Some objects, such as group panels,
summaries, subreports, and cube elements hold a true value for the TOC Anchor property by default,
which means that by default they will appear in the TOC Browser. Moreover, you can type a string or
even a formula as the Anchor Display Value property for a component holding a true TOC Anchor
property, so that your input for that object can be displayed in the TOC Browser instead of the default
value.
Applying a style
A style can be applied to a report in order to change its appearance and characteristics. You can create
and set up your own styles in JReport Designer. When you publish your reports to JReport Server, you
can include these custom styles with the published reports. When you run a report, the style feature
will be enabled and you can select a style to apply to the report. After applying a style, the banded
objects, crosstabs, charts, and tables in the report will take a uniform appearance.
By default, the style feature is enabled in JReport Viewer. In order to apply a style to a report, click
Menu > Report > Style and select the required one from the submenu, or select the style from the
style drop-down list
on the toolbar. You can also right-click a table,
crosstab, chart, or banded object and select Apply Style from the shortcut menu to select the required
style in the Apply Style dialog. However, if there is only one style available to the report, this style will
be applied to the report by default, in which case, you will find that all these style related commands
are hidden.
JReport Studio - Web Reports
JReport provides the web reporting solution for faster and simpler design and creation of reports using
a web browser.
Web reports are viewed using a new interactive viewer called JReport Studio. JReport Studio provides a
much nicer end user experience with many powerful features for interfacing with a report such as
changing parameters without re-running the report. In addition, JReport Studio still supports exporting
the report to all supported output formats.
The data sources that can be used to create web reports are business views that are resources built on
top of queries. Business views are created and managed in JReport Designer. In JReport Server, web
reports are created via the JReport Studio Wizard using a browser and are opened and edited via
JReport Studio.
Using JReport Studio Wizard, it is easy to create complex reports with multiple components in a tabular
style layout. Web reports also allow for company logo and titles to be placed on the top of the page for
more formal presentation.
A web report template contains only one report and uses .wls as the file suffix. Web reports are stored
in the JReport Server resource system and follow the server resource and version management rules
such as archive policy and permission setting.
JReport Designer supports creating, opening, and editing of web reports. JReport Designer also allows
for web reports created on JReport Server to be downloaded to Designer and further edited.
This chapter covers the following topics to help you better interact with web reports:
●
Why web reports and when to choose them
●
Components supported in web reports
●
JReport Studio window elements
●
Creating web reports via wizard
●
Editing web reports in JReport Studio
Notes:
●
●
A JReport Live license for JReport Server is required in order to use this feature. If you do not have a
Live license please contact your Jinfonet Software account manager to obtain a license.
JReport Studio Wizard and JReport Studio support Internet Explorer 8, Firefox 3.5, Google Chrome 5,
and higher versions.
Why web reports and when to choose them
JReport Studio displays web reports (which are also called web layout reports) that are aimed at easier
and faster report creation and design, faster report execution, easier customization, and better
presentation style using a newer Rich Internet Application (RIA) Web 2.0 interface. Web reports also
support agile development techniques such as continuous integration by allowing report templates to
be updated by both JReport Studio and JReport Designer.
●
●
●
●
●
●
●
Fewer functions
Web reports (.wls) support a subset of functions of JReport page reports (.cls). The basic and
essential functions not only guarantee a good report presentation, but also make the report design
experience easier for a new user of JReport.
Single report solution
Only one report in a web report speeds up the report running process as compared to a multiplereport page report.
Tabular style layout
The creation of a page report using the Standard Report Wizard can only create one data component
(table, crosstab, chart, or banded object) using the wizard. The JReport Studio Wizard provides a
tabular style layout in which you can place a table, crosstab or chart in each tabular cell so as to
achieve a holistic layout with multiple components from the very beginning.
Predefined report templates
Web reports allow you to choose a starting template so you can predefine the template to include
standard features such as company logo, company name, privacy notices or any standard items and
styles you want your users to start with.
Fast report rendering
At runtime, JReport Studio provides much higher performance when viewed from a browser
compared to viewing a report using JReport Viewer. Using JReport Viewer, all of the user action
requests must be sent to JReport Server which renders the new page on the server and updates the
browser view. Using JReport Studio, many of the actions which require only a change in rendering
the view are done locally on the client in the browser. By using JReport Studio, JReport Engine is
structured so that as much of the processing as possible is completed on the client side allowing
much higher salability for JReport Server allowing the server to handle more simultaneous users.
Oriented toward presentation rather than analysis
Unlike page reports, web reports do not support slicing and dicing data since the data source for web
reports has been designed with no hierarchical relationship between the data objects. Create web
reports if you do not want to analyze report data such as drilling down and drilling up, but look
forward to an excellent Web 2.0 presentation.
Creation and edition in both JReport Server and Designer
Web reports created using the JReport Studio Wizard can be downloaded from JReport Server and
edited in JReport Designer and web reports can be created in JReport Designer and published to
server just like .cls reports. However, page reports created using the Standard Report Wizard can
only be edited in the server. Designer can view these reports but not modify them and publish them.
Also, JReport Designer can be used to create web reports which can be run in JReport Studio on the
server and saved as a template to use in JReport Studio. JReport Designer cannot directly create the
temple but can create the report and then using JReport Studio, save the report as a template (.
wslt).
●
Standard banded objects not supported
Page reports support standard banded objects which are not supported by web reports.
Components supported in web reports
Components are the objects that you can place in a report. JReport provides a full set of components
that allow you to present and control the report data and presentation in a wide variety of ways.
Web reports support the following report components:
●
●
●
●
●
●
●
●
●
●
●
Labels
A label is an object that contains a string. It is typically a brief description used to identify a field or
other value nearby.
Images
An image is a digital representation of a picture. The following image types are suppported in web
reports: .gif, .jpg, and .png.
DBFields
DBFields, or database fields, are fields directly from columns in the database or other data source
such as XML or Java objects.
Formulas
Formulas are calculated from DBFields, other formulas, summaries, and parameters, so they can
present information which is not available directly from the database fields.
Summaries
A summary is a special kind of formula. A summary generates a count, average, sum, standard
deviation or other transformation of a set of data values. A summary applies to a defined group of
data. Summaries are required to provide the data values for charts as well as totals for table reports.
Parameters
A parameter in JReport is a variable whose value is determined at runtime. The runtime parameters
help you dynamically control your report results such as filtering data.
Special fields
Special fields are defined by JReport and allow you to easily obtain system information and reportrelated data and add it to your report. All special fields are supported to insert into web reports in
JReport Designer. However, due to the characteristics of JReport Studio, only these can be rendered
and edited in JReport Studio: User Name, Modified Date, Modified Time, Fetch Date, Fetch Time, Print
Date, and Print Time.
Web controls
Web controls are report components designed to be similar to the kinds of controls found on web
pages. Currently, the following four web controls are supported in web reports: parameter control,
parameter form control, filter control, and navigation control.
Multimedia objects
Multimedia objects include Flash, Real Media, and Windows Media objects.
Tabular
A tabular is a component designed to lay out other components. There is one and only one tabular in
a web report.
Tables
A table gives you great control over how to present data, including placing fields, grouping them, and
sorting them. It is composed of rows and columns, and each contains several cells. With such a
structure a table is a good way to show any two-dimensional dataset.
●
●
Crosstabs
A crosstab summarizes data and presents the summaries in a compact row and column format.
2-D Charts
A chart organizes and graphically presents data in a way that makes it easy for end users to see
comparisons, trends, and patterns in data. It represents the report data in a visually straightforward
form. A chart is based on the chart platform. On the platform, the chart paper, the legend, and labels
make up the chart. You can create a chart that contains only simple DBFields, or a complicated chart
that contains DBFields, groups, summaries, and even formulas. Normally, DBFields, summaries, and
formulas in a report are represented in a chart using chart data markers, and groups are used to
produce category names and data series names. DBFields can also be used as category names.
Tip: In JReport, the components that can be bound with a data source are also referred to as data
components. These components include tables, crosstabs and charts.
JReport Studio window elements
The main page of JReport Studio consists of the user information bar, menus, toolbar, left panels and
report area. The options for browsing or controlling a web report are as follows:
Toolbar/Menu
File
Edit
View
Insert
Button
Tool Name
Description
New Report
Creates a new web report based on an
existing business view.
Open
Opens a report.
Save
Saves the changes of the current web
report.
Save As
Saves a copy of the web report or the
report template in the current web
report to server resources.
Export
Exports the report result to disk or
version in various formats.
Page Setup
Configures the report page settings.
Print
Prints the report result to a PDF/HTML
file.
Exit
Closes the current web report and exits
JReport Studio releasing all of the
resources.
Undo
Undoes the last operation.
Redo
Reverses the operation of Undo.
Delete
Deletes the selected object.
Wizard
Opens the component wizard for you to
edit the selected table, crosstab or
chart.
Filter
Filters the report records according to
the filter criteria you specify.
To Chart
Converts a crosstab into a chart.
To Crosstab
Converts a chart into a crosstab.
Rotate Crosstab
Rotates a crosstab to exchange the
axes on the crosstab in order to create
a different view of the crosstab.
Report Body
Properties
Defines properties of the report body.
Unhide Components
Shows the hidden components you
specify.
Style
Applies a style to the selected
components or the whole report.
Editing Marks
Shows or hides editing marks (dashed
outlines for objects and report body). If
the option is unselected, the editing
mark will not be shown when a report
object receives focus, and report
objects cannot be moved or resized.
Refresh
Runs the report using previously
provided parameters. The Refresh
operation fetches the data again.
Table
Inserts a table into the report.
Format
Help
Standard Toolbar
Crosstab
Inserts a crosstab into the report.
Chart
Inserts a chart into the report.
Parameter Control
Inserts a parameter control into the
report.
Parameter Form
Control
Inserts a parameter form control into
the report.
Filter Control
Inserts a filter control into the report.
Navigation Control
Inserts a navigation control into the
report.
Label
Inserts a label into the report.
Image
Inserts an image into the report.
Multimedia Object
Inserts a multimedia object into the
report.
Special Fields
Inserts a special field into the report.
Font
Specifies the font format of the
selected text. Available only when a
label or field is selected.
Merge
Merges the selected tabular cells into
one.
Split
Splits the selected tabular cell into the
specified number of rows and columns.
User's Guide
Opens the JReport Studio User's Guide.
JReport Home Page
Connects to JReport Home Page.
Technical Support
Accesses Jinfonet Technical Support.
About JReport Web
Shows product information about
JReport Web.
New Report
Creates a new report based on an
existing business view.
Open
Opens a report.
Save
Saves the changes of the current web
report.
Save As
Saves a copy of the web report or the
report template in the current web
report to server resources.
Export
Exports the report result to disk or
version in various formats.
Page Setup
Configures the report page settings.
Print
Prints the current report result to a
PDF/HTML file.
Refresh
Runs the report using previously
provided parameters. The Refresh
operation fetches the data again.
Undo
Undoes the last operation.
Redo
Reverses the operation of Undo.
Filter
Filters the report records according to
the filter criteria you specify.
Delete
Deletes the selected object.
Quick Format
Toolbar
Context Toolbar for
Table
Rotate Crosstab
Rotates a crosstab to exchange the
axes on the crosstab in order to create
a different view of the crosstab.
Swap Chart Groups
Specifies whether to switch data
between the category and series axes,
or between the category and value
axes of a chart if there is no field on
the series axes.
Font
Specifies the font format of the
selected text. Available only when a
label or field is selected.
Background Color
Changes the background color of the
selected text. Available only when a
label or field is selected.
Align
Makes the selected text left, center or
right aligned. Available only when a
label or field is selected.
Merge
Merges the selected tabular cells into
one.
Split
Splits the selected tabular cell into the
specified number of rows and columns.
Table Wizard
Opens the Table Wizard for you to edit
the table.
Show/Hide Detail
Hides or shows the detail columns you
specify.
Add/Remove Group
Specifies whether to add or remove the
selected field as a group.
Show/Hide Summary Specifies whether to show or hide the
selected summary field.
Context Toolbar for
Crosstab
Context Toolbar for
Chart
Panel
Hide
Hides the selected column.
Aggregate On
Creates a new summary directly based
on the field bound with the table detail
column.
Crosstab Wizard
Opens the Crosstab Wizard for you to
edit the crosstab.
Rotate Crosstab
Rotates a crosstab to exchange the
axes on the crosstab in order to create
a different view of the crosstab.
Chart Wizard
Opens the Chart Wizard for you to edit
the chart.
Swap Chart Groups
Specifies whether to switch data
between the category and series axes,
or between the category and value
axes if there is no field on the series
axes.
Chart Type
Lists all available chart types for you to
change the type of the chart.
Chart Options
Lists more options for you to specify
the layout of the chart.
Parameters
Lists all the parameters used by the
current report. It is available when the
current report uses parameters.
Resources
Lists all the available resources.
Components
Lists all the available components that
can be inserted into reports.
Shortcut Menu
Filter
Specifies the criteria to filter the data
field. You can also remove or change
existing filters.
"Go To" Filter
After you perform the go-to-by-value
or go-down actions, the panel is
displayed showing the filter created by
the actions. You can also click in a
table, crosstab, or chart to show this
panel for the component.
Show
Shows the selected fields.
Apply Style
Applies a style to the selected
component.
Delete
Deletes the selected object.
Autofit
Adjusts the width of table and crosstab
fields according to the contents.
Hide
Hides the selected object.
Filter
Provides submenu items for filtering
the data in the selected component or
remove existing filters.
Sort
Provides submenu items for sorting
records on the selected field in
ascending/descending order, or remove
the sort.
Edit Detail Table
Edits the detail table to define the
detail fields of the summary.
Go to Detail
Goes to the detailed information of the
selected summary.
Link/Edit Link
Links the selected object to a report,
URL or E-mail.
Conditional
Formatting
Adds some conditional formatting to
the currently selected field.
Go Down
Goes from a group which is non-bottom
level in a predefined hierarchy to the
one-level-lower group while applying
the current selected value as a filter
condition. See Go-down for details.
Go Up
Jumps from a group which is non-top
level in a predefined hierarchy to the
one-level-higher group. See Go-up for
details.
Go To
Goes to any group to show its record
information.
Go to By Value
Goes to any group with the current
group value as a filter to show its
record information.
Properties
Defines properties of the selected
object.
Select
Make the corresponding object
selected.
Notes:
●
JReport Studio has two modes: View Mode and Edit Mode, and the toolbar and menu commands that
are available in each mode vary. Administrators can specify the default mode that will be applied
when a report is opened in JReport Studio in the Profile > Customize Server Preferences > General
tab, and you can switch between the two modes by clicking the View Mode or Edit Mode link on the
JReport Studio toolbar. However, you will not be able to switch the mode if the Show Link of View/
Edit Mode option in the Profile > Customize Profile > DHTML > Properties > Default tab is unchecked.
●
The shortcut menu contents vary with the objects you right-click. The above table only lists some
typical shortcut menu items. The following sections will guide you to use the shortcut menu for any
object you may right-click.
Creating web reports via wizard
On the JReport Console > Resources page, you can directly create a new web report in a folder into
which a catalog containing one or more business views has been published.
To create a web report:
1. Open the folder and select the catalog for the new web report from the Catalog drop-down list,
then click New Report on the task bar of the Resources page.
2. In the Select Report Type dialog, check the option Web Report and click OK. The JReport Studio
Wizard is then displayed.
3. In the Page screen, choose a template for the report. Template1 allows for your company logo and
report title to be added. Template2 allows for more such as company name and title and report
sub title. Use
to load your company logo. You can set the font properties for company titles
and report titles using
. Click the Page Setup link to set the page properties.
4. In the Layout screen, select the required layout with which you want to create the report. Then, in
the edit layout area, select a tabular cell and select the component you want to display in the cell.
Click the Align drop-down list to set the component to the left, center or right of the cell. Repeat
this to add component to the other cells.
If required, you can split the selected cell horizontally or vertically by clicking the Horizontal Split
or Vertical Split button, merge adjacent cells by selecting them and clicking Merge. You can also
resize the tabular cells by dragging the cell border.
5. In the Bind Data screen, define the specified components (for details about how to define a
component, refer to the specific topic in Inserting components). You can use the Back and Next
buttons to switch between the components.
6. In the Style screen, apply a style to the report.
7. Click Save to save the report to the server resource tree. For details, see Saving the report.
8. Click Run to open the report in JReport Studio.
See also JReport Studio Wizard for details about options in the wizard.
Editing web reports in JReport Studio
JReport Studio is the web oriented page where you view and edit web reports. When a report is opened
in JReport Studio, by default it is in the view mode which provides only viewing-oriented functions. If
you want to edit the report, click the Edit Mode link on the toolbar to enter the edit mode.
Pick a task from the following:
●
General operations in reports
●
Inserting components
●
Making simple modifications to components
●
Manipulating data components
●
Binding links to components
●
Using dynamic resources
●
Going through the report data
●
Applying filters
●
Using web controls
●
Adding conditional formats to fields
●
Applying parameters
●
Sorting report data
●
Applying CSS styles
●
Saving the report
●
Exporting/Printing the report result
General operations in reports
You can perform the following general operations in JReport Studio:
●
Opening another web report
Click Menu > File > Open (or the Open button
on the Standard toolbar) to display the Select a
Report dialog, in which the web reports in the same folder as the current open report are listed.
Select the web report you want to open from the default folder or from another folder, and then click
OK.
●
●
Exiting JReport Studio
If you want to close the current web report and release the resources, just click Menu > File > Exit
(or the button X on the far right of the toolbar). Do not use the close button on the browser window
as that may not release the resources used by the report.
Undoing/Redoing actions
You can undo or redo some actions. To do this, click Menu > Edit > Undo or Redo (or the Undo
button
●
●
●
●
or Redo button
on the Standard toolbar).
Navigating component data via scroll bar
For tables, crosstabs and charts, you can use the scroll bar to navigate their data if the tabular cell
can not display all data of the component.
Turning component pages
In JReport Studio, if a table or a crosstab contains more than one page, a navigation bar specific for
the component will be available right below the component. You can use the navigation bar to view
the desired pages: click the corresponding button to go to the first page, the previous page, the next
page, or the last page, or input a number in the text box to go to that page.
Showing/Hiding editing marks
You can use editing marks (dashed outlines of objects) for purposes such as aligning, moving and
resizing. The editing marks are shown by default. To switch the status of the editing marks, click
Menu > View > Editing Marks.
Asking for help
At any time, you can click Menu > Help > User's Guide to open the index page of JReport Studio
User's Guide. Furthermore, you can click the Help button in any dialog to show the help document
about the dialog. You can also use the Help menu to access Jinfonet Software website for more
information.
Inserting components
You can insert components into a web report via the Insert menu or via the Components panel on the left of the JReport
Studio window.
The following table lists the report areas that are valid targets for the various components.
Report Layout Area
Component
Page Header/
Footer
Report Body
Tabular Cell
Table Cell
Chart
Y
Y
Y
N
Crosstab
Y
Y
Y
N
Table
Y
Y
Y
N
Group object
Y
Y
Y
Y
Detail object
Y
Y
Y
Y
Aggregation object
N
Y
N
Y
Formula
Y
Y
Y
Y
Label
Y
Y
Y
Y
Image
Y
Y
Y
N
Multimedia object
Y
Y
Y
N
Web control
Y
Y
Y
N
The following shows inserting a specific component in detail:
Inserting a table
To insert a table into a web report:
1. Locate the place in the report where you want to insert the table.
2. Click Menu > Insert > Table, or drag Table from the Components panel to the destination. The Insert Table dialog
is displayed.
3. Specify a title for the table in the Table Title text field, and if required, click
title.
to set the font properties for the
4. From the Data Source drop-down list, select the business view in the current catalog, on which the table will be
built. If required, click the Filter button to add some filter conditions to the business view to narrow down data
displayed in the table.
5. Select the required table type: Group Above, Group Left, Group Left Above, or Summary Table.
6. In the Display tab, add the required fields from the Resources box to be displayed in the table. Specify the display
name of any added field in the Label column if necessary.
7. In the Group tab, add the group objects
as the grouping criteria, then specify the sorting manner of each group
in the Sort column. To adjust the order of the groups, select a group and click
or
.
8. To add summaries, go to the Summary tab. Select the group to which the summary will be applied, then add an
as the summary field. For the Group Left table, you can use the Row and Column columns to
aggregation object
control the position of the summary field in the table.
9. Click OK to insert the table.
See also Insert Table dialog for details about the options in the dialog.
Inserting a crosstab
To insert a crosstab into a web report:
1. Locate the place in the report where you want to insert the crosstab.
2. Click Menu > Insert > Crosstab, or drag Crosstab from the Components panel to the destination. The Insert
Crosstab dialog is displayed.
3. Specify a title for the crosstab in the Crosstab Title text field, and if required, click
for the title.
to set the font properties
4. From the Data Source drop-down list, select the business view in the current catalog, on which the crosstab will be
built. If required, click the Filter button to add some filter conditions to the business view to narrow down data
displayed in the crosstab.
and click
or
to add it to the Columns or Rows box as a
5. From the Resources box, select a group object
group field. Then, in the Label column, edit the display name of the group object if required. This will label the row/
column when the report is displayed. By default the Label column is blank and no label will be created for the row/
column. In the Sort column, specify the sorting manner for the group field.
6. Select an aggregation object
or a detail object
and click
to add it to the Summaries box as an aggregate
field. If a detail object is added, specify the aggregate function for it in the Aggregation column. In the Label
column, edit the display name of the aggregate field as required.
7. Repeat this to add more group/aggregate fields. If you want to remove any field, select it and click
order of the fields, select a field and click
or
. To adjust the
.
8. Click OK to insert the crosstab.
See also Insert Crosstab dialog for details about the options in the dialog.
Inserting a chart
Normally, a chart displays values in a static way and you cannot change the values on it once it is created. However,
JReport provides you with options to make the chart interactive and dynamic. For example, if your data source uses data
that changes quickly over time such as stock market values, you can create a real time chart, so that the chart will
update itself based on a defined interval by using the real time data from the data source. You can make a chart move at
runtime based on the value changes of a motion field by creating a motion chart. In a motion chart, the chart is playable.
You can start or stop the chart to play the dynamic trend of the motion field, control the moving speed of the chart, and
if you create a bubble motion chart, you can even use a trail control to make the chart move showing a bubble or line
trail.
In JReport Studio, when you create a chart, you can choose to make it a normal chart, a real time chart or a motion
chart.
To create a normal chart:
1. Locate the place in the report where you want to insert the chart.
2. Click Menu > Insert > Chart, or drag Chart from the Components panel to the destination. The Insert Chart dialog
is displayed.
3. Specify a title for the chart in the Chart Title text field, and if required, click
title.
to set the font properties for the
4. From the Data Source drop-down list, select the business view in the current catalog, on which the chart will be
built. If required, click the Filter button to add some filter conditions to the business view to narrow down data
displayed in the chart.
5. To create a single chart, in the Primary Axis box, select the required chart type from the chart type drop-down list.
above the Primary Axis box and an additional chart type will be added. You can
To create a combo chart, click
replace the additional chart type by selecting the required one from the chart type drop-down list. Repeat this to
add more chart types. Check the Secondary Axis checkbox if you want to have the secondary axis (Y2) and define
the chart types on the axis as required. To delete a type, select it and click
.
6. In the Primary Axis or Secondary Axis box, select a chart type and add an aggregation object
or an additional
as the data of the type. You can add more than one data field to a chart type. Each added chart type shall
value
have at least one data field.
If you select a bubble chart type, you need to specify the fields to be shown on the bubble X axis, Y axis and the
value you want to show as the bubble adius in the Show Values box. Note that when you specify a value for the
bubble X axis, this value will be displayed on the category axis instead of the one specified in the Category box.
However, the value defined in the Category box will also be included in data calculation.
To add an additional value to a chart type:
a. Select the chart type in the Show Values box.
b. In the Resources box, expand the Additional Values node, then select Constant Value/Average Value.
c. Click
beside the Show Values box. The Edit Additional Value dialog appears.
d. In the Name text box, specify the display name for the constant/average value.
e. Input the constant value with numeric type in the Value text box, or select a field based on which the average
value will be calculated from the Based On drop-down list.
f. Click OK, and the defined constant/average value will be added to the chart type.
To modify a constant/average value, select the value in the Show Values box, then click
Additional Value dialog, edit the value as required.
. In the Edit
in the Resources box and add it to the Category or Series box, the data of which will be
7. Select a group object
displayed on the corresponding axis.
8. If you want to define some sort order and Select N condition on the category or series field, click
Category or Series box, then define the order and condition in the Category/Series Options dialog.
above the
To define a sort order and Select N condition on the category/series field:
a. In the Category/Series Order box of the Category/Series Options dialog, specify in which order values of the
category/series field will be sorted.
b. In the Category/Series Selection box, specify the Select condition to All, Top N or Bottom N. If All is selected,
all category/series values will be shown in the chart; if Top N or Bottom N is selected, the text field next to it
will be enabled and you can specify an integer here, which means that the first or last N category/series values
will be shown in the chart.
c. Check the Based On checkbox and specify values for the two drop-down lists that follow according to your
requirement.
If Based On is unchecked, the order of the first or last N category/series values will be based on what you
specify in the Category/Series Order box of the dialog; if you check it, the order will be based on values of the
summary field and the sort direction you specify in the drop-down lists next to Based On.
d. If you have selected Top N or Bottom N from the Select drop-down list, you can check the Remaining
Categories/Series In checkbox and then type a character string in the text field, so that the category/series
values beyond the first or last N range will be merged into the group with the name as that character string.
e. If necessary, you can check Skip First, and then input a number M in the text field to the right, then the first
M category/series values will be skipped and the Select N condition will begin with M+1. The skipped values will
be merged into the Remaining Categories/Series group.
f. Click OK to accept the settings.
9. Click OK to insert the chart.
To create a real time chart:
Real time chart is supported on singe bar, bench, line, and area chart types.
1. Repeat the above steps 1 to 4 for creating a normal chart.
2. In the Primary Axis box, select a chart type of bar, bench, line, or area, then add the detail objects
objects
or group
of numeric type as the data of the type.
beside it, specify the refresh interval that the chart will get data and
3. Check the Real Time checkbox, click
refresh itself automatically, and the last N records to be kept for the real time data on the chart. Then click OK to
accept the settings.
4. By default, Use System Refresh Time will be displayed in the Category box, which means the time at which the chart
refreshes itself will be used as the category value. You can choose to add another group object
to be displayed
on the category axis. If you want to define some sort order and Select N condition on the category field you specify,
click
above the Category box, then define the order and condition in the Category Options dialog.
5. Click OK to insert the chart.
To create a motion chart:
Motion chart is supported on single chart of bar, bench and bubble types.
1. Repeat the above steps 1 to 4 for creating a normal chart.
2. In the Primary Axis box, select a chart type of bar, bench or bubble, then add the required aggregation objects
or additional values
as the data of the type.
If you select a bubble chart type, you need to specify the fields to be shown on the bubble X axis, Y axis and the
value you want to show as the bubble adius in the Show Values box. Note that when you specify a value for the
bubble X axis, this value will be displayed on the category axis instead of the one specified in the Category box.
However, the value defined in the Category box will also be included in data calculation.
in the Resources box and add it to the Category or Series box, the data of which will be
3. Select a group object
displayed on the corresponding axis.
4. If you want to define some sort order and Select N condition on the category or series field you specify, click
above the Category or Series box, then define the order and condition in the Category/Series Options dialog.
of Integer, Date or Time type as the motion field.
5. Check Motion Bar for Playable Chart, add a group object
When the element is of the Date data type, you can define some special function for it by clicking the Special
Function button.
6. Click OK to insert the chart.
When a motion chart is created, you can use the motion control section to make the chart move. Click the play button
and the chart will show its dynamic trend based on the value change of the motion field which is bound in the motion bar.
To stop it, click the button again. You can also control its moving speed by dragging the slider between Slow and Fast on
the speed control. For a bubble chart, you can control whether the chart will be moving in bubble or line trail.
See also Insert Chart dialog for additional information about options in the dialog.
Insert a label
To insert a label into a report, locate the place in the report where you want to insert the label, then click Menu > Insert
> Label, or drag Label from the Components panel to the destination. The label will then be inserted in the specified
location.
Inserting an image
1. Locate the place in the report where you want to insert the image.
2. Click Menu > Insert > Image, or drag Image from the Components panel to the destination. The Insert Image
dialog is displayed.
3. Specify the image you want to insert.
❍
❍
❍
To use an image in the local file system, select Local File, then click Browse to find the image.
To use an image on a website, select Web URL, then input the image URL or paste the URL in the Image URL text
field.
To use an image in the image library of the JReport Studio, select Library, then select the image in the My
Images box.
4. Click OK to insert the image.
Inserting a multimedia object
1. Locate the place in the report where you want to insert the multimedia object.
2. Click Menu > Insert > Multimedia Object, or drag Multimedia Object from the Components panel to the
destination. The Insert Multimedia dialog is displayed.
3. Choose from the three multimedia object types: Flash, Real Media file, or Windows Media File.
4. In the File Name/URL text field, specify the full path of the multimedia object you want to insert or use the Browse
button to find it if it is on your local disk. Or you can provide a URL for loading it from a website.
5. The Plug-in page text field provides a default URL from which to download the player to play the inserted multimedia
object on a web page.
6. In the Properties box, specify the properties for the multimedia object as required.
7. Click OK to insert the multimedia object.
See also Insert Multimedia dialog for details about the options in the dialog.
Inserting a web control
You can insert the following web controls into a web report: parameter control, parameter form control, filter control, and
navigation control. For details, see Using web controls.
Inserting a special field
To insert a special field into a web report, do either of the following:
●
●
On the Menu > Insert > Special Fields submenu, click the target special field, User Name for example, then point to
the destination where you want to add the special field and click the mouse button.
Drag the special field from the Components panel to the destination in the report.
Making simple modifications to components
This section introduces the general actions that you can perform on the report components.
Resizing a component and its elements
To resize a component, click anywhere in the component, then you will see it is surrounded by a
rectangle with resizing handles. Point to a handle, when the mouse pointer turns to a double-headed
arrow, you can drag the handle to resize the component.
To adjust the width of a column in a table, point to the right boundary of the column, when the mouse
pointer becomes a double-headed arrow, drag the handle to resize the column.
To adjust the row height in a table, point to the lower boundary of a row, when the mouse pointer
becomes a double-headed arrow, drag the handle to resize the row height. Then all the other rows of
the same role will be resized too. For example, if a detail row is resized, all rows in the detail area will
be resized. If a group row is resized, all rows of the group will be resized, while the other groups' rows
keep unchanged.
To resize the column or row in a crosstab, drag the right or lower boundary. Then all the columns or
rows of the same role will change too.
For a tabular, point to the boundary between two cells and the mouse pointer will become a doubleheaded arrow, you can then drag the boundary to adjust the size of the related cells.
Hiding/showing a component
To hide a component, right-click on the component, then use Hide on the shortcut menu.
For a row, a column, or a header/footer in a table, there are two ways to access the Hide option:
●
●
Right-click any cell within the object, go to the submenu of Table Row or Table Column, then select
Hide.
First select the object by right-clicking any cell within the object and selecting Select on the
submenu of Table Row or Table Column, then right-click the object and select Hide.
To show the hidden components, click Menu > Edit > Unhide Components and then select the
desired components to show from the drop-down list. Another way to show the component after hiding
is Undo.
Editing a component
●
●
●
To edit a label, click in the text and update the content. You can also use the Quick Formats toolbar
to format the font, border, alignment, and background color of a label.
To edit a table, crosstab, or chart, use the corresponding component wizard on the shortcut menu.
For details, see Manipulating data components.
To edit an image or a multimedia, click on the component, when the icon
appears at its upper left
corner, right-click on the icon and click Edit on the shortcut menu and then modify the settings in
the displayed dialog.
For a tabular, you can edit it as follows:
●
❍
Merging tabular cells
Adjacent cells in a tabular which form a rectangle can be merged into one cell.
To merge adjacent cells, select them one by one while holding the Ctrl key, then click Menu >
Format > Merge or click
❍
on the toolbar, and these cells will be merged into one cell.
Splitting a tabular cell
To split a tabular cell, select the cell and click Menu > Format > Split or click
on the
toolbar, then in the Split Cell dialog, specify the number of rows and columns and click OK.
Modifying component properties
JReport Studio allows you to modify object properties with the corresponding properties dialog.
●
To format the properties of an object in a report, right-click the object and then select Properties
from the shortcut menu. In the corresponding properties dialog, specify the settings as required.
For a table cell, the Properties option is available on the submenu of Table Cell after you right-click
the cell.
For a row, a column, or a header/footer in a table, there are two ways to access the Properties
option:
❍
❍
●
Right-click any cell within the object, go to the submenu of Table Row or Table Column, then select
Properties.
First select the object by right-clicking any cell within the object and selecting Select on the
submenu of Table Row or Table Column, then right-click the object and select Properties.
If you want to format the properties of the report, click Menu > Edit > Report Body, then in the
Report Body Properties dialog, configure the properties as required.
For detailed explanation about options in the properties dialogs, refer to the specific topics in JReport
Studio dialogs.
Deleting a component
A component can be removed from the report if it is no longer required. To delete a component, rightclick on the component, then use Delete on the shortcut menu. Then, a message will prompt, asking
for your confirmation. Click Yes in the message box so as to remove the component.
To delete a table column, take one of the following:
Right-click any cell within the column, go to the submenu of Table Column, then select Delete.
●
●
First select the column by right-clicking any cell within the column and selecting Select on the
submenu of Table Column, then do either of the following:
❍
Drag the column to the Resources panel.
❍
Right-click the column and select Delete.
Note: In a web report, there must be one and only one tabular, so you cannot either insert another
tabular or delete the current tabular.
Manipulating data components
You can manipulate data components, which refer to tables, crosstabs, charts and Google maps, in JReport Studio as
shown below. Note that, most of the manipulations require selecting the component first. To select a component, click
appears at its upper left corner, click the icon.
anywhere in the component, when the icon
Manipulating a table
●
●
●
Adjusting order of columns in a table
The order of columns in a table can be easily adjusted. To do this, first select a column by right-clicking any cell within
the column and clicking Select on the submenu of Table Column, then drag it to the left or right boundary of another
column, when a highlighted line appears along the column boundary, release the mouse button, and you will see the
order changes.
Adjusting the width of table columns according to contents
When the contents in cells of a table column need more space to completely display, you can adjust the width of the
table column according to the contents. To do this, right-click the column and select Table Column > Autofit from the
shortcut menu.
Changing the table definition
1. Select the table and do one of the following to display the Table Wizard.
■
Click Menu > Edit > Wizard.
■
Click the Table Wizard button
■
Right-click the icon
on the Context toolbar.
of the table and select Table Wizard from the shortcut menu.
2. In the Table Title text field, edit the title of the table. You can click
the title.
to customize the font, size, and style of
3. Click the Filter button to apply some filter conditions to narrow down data displayed in the table.
4. In the Display tab, add or change the fields displayed in the table.
5. In the Group tab, modify the grouping criteria of the table.
6. Upon finishing, click OK to apply the modifications.
For details about how to define a table, see Inserting a table.
●
Aggregating on a detail column
You can summarize the data in a detail column. To do this:
1. Right-click the detail field and select Aggregate On from the shortcut menu. Or you can first select the column by
right-clicking any cell within the column and clicking Select on the submenu of Table Column, then on the Context
toolbar, click the Aggregate On button
.
2. In the Aggregate On dialog, specify a function from the Function drop-down list to summarize the data.
3. When done, click OK.
■
■
If the table has groups, you will find data in each group level and the whole table are summarized respectively in
the column.
If the table has no groups, the summary will be based on the whole table.
When you finish summarizing a detail column, you will find a dynamic aggregation is created at the same time which is
given a default name Function_DetailFieldName in the Dynamic Resource > Aggregations list in the Resources panel and
you can use it again in the current report if required.
●
Adding/Removing groups in a table
You can add more groups into a table or remove the groups that are not required from a table.
❍
To add a group into a table:
Select the table, then on the Context toolbar, click the Add/Remove Group button
and you will get a dropdown list of fields in the business view that can be used as group by fields. From the list you can select the field you
would like to add into the table as a group. If there is no existing group in the table, the added group will be placed at
the left-above position. If the table already contains groups, the new group will be added as the highest level group
and follow the same position pattern as the closest existing group.
❍
To remove a group from a table:
Right-click a field of the group and select Delete from the shortcut menu, then click Yes in the message dialog to
confirm the removal. Or you can use the Add/Remove Group button
on the Context toolbar of the table: unselect
the group you want to remove from the drop-down list, then click Yes in the message dialog.
Showing/Hiding detail columns
●
To show/hide a detail column, select the table, then on the Context toolbar, click the Show/Hide Detail button
From the drop-down list, select/unselect the field name to show/hide its detail column.
.
You can also hide a detail column by one of the following:
❍
First select the column by right-clicking in the column and selecting Select on the submenu of Table Column, then do
either of the following:
❍
■
Click the Hide button
on the Context toolbar.
■
Right-click the column and select Hide.
Right-click in the column and select Table Column > Hide from the shortcut menu.
Showing/Hiding summaries
●
To show/hide a summary from a table, first select the table and then do either of the following:
❍
❍
On the Context toolbar, click the Show/Hide Summary button
summary field name to show/hide it.
. From the drop-down list, select/unselect the
Right-click the icon
of the table, then on the shortcut menu, select/unselect the summary field name from the Show
> Table Column submenu to show/hide it.
Manipulating a crosstab
●
Changing the crosstab definition
1. Select the crosstab and then do one of the following to display the Crosstab Wizard.
■
Click Menu > Edit > Wizard.
■
Click the Crosstab Wizard button
■
Right-click the icon
on the Context toolbar.
of the crosstab and select Crosstab Wizard from the shortcut menu.
2. In the Crosstab Title text field, edit the title of the crosstab. You can click
style of the title.
to customize the font, size, and
3. Click the Filter button to apply some filter conditions to narrow down data displayed in the crosstab.
4. Change the fields and summaries used by the crosstab.
5. Upon finishing, click OK to apply the modifications.
For details about how to define a crosstab, see Inserting a crosstab.
●
Converting a crosstab into a chart
1. Select the crosstab and then do either of the following to display the To Chart dialog.
■
Click Menu > Edit > To Chart.
■
Right-click the icon
of the crosstab and select To Chart from the shortcut menu.
2. In the Title text field, input a title for the chart. You can click
to customize the font, size, and style of the title.
3. The Resources box lists all the view elements used in the selected crosstab including group and aggregation objects.
The chart can only be defined based on the view elements listed. Select the required chart type from the chart type
drop-down list. Add a group object
from the Resources box to the Category box, and so to the Series box, and
to the Show Values box respectively.
aggregation objects
If you select a bubble chart type, you need to specify the fields to be shown on the bubble X axis, Y axis and the
value you want to show as the bubble radius in the Show Values box. Note that when you specify a value for the
bubble X axis, this value will be displayed on the category axis instead of the one specified in the Category box.
However, the value defined in the Category box will also be included in data calculation.
4. Click the OK button to finish the conversion.
For details about how to define a chart, see Inserting a chart.
●
Rotating a crosstab
Columns and rows in a crosstab can be exchanged. This operation is called rotating a crosstab.
To rotate a crosstab, first select it, and then do one of the following:
●
❍
Click Menu > Edit > Rotate Crosstab.
❍
Click the Rotate Crosstab button
❍
Right-click the icon
on the Context toolbar.
of the crosstab and select Rotate Crosstab from the shortcut menu.
Adjusting the width of crosstab fields according to the contents
When the contents in the field of a crosstab need more space to completely display, you can adjust the width of the field
according to its contents. To achieve it, right-click the field and select Autofit from the shortcut menu.
Manipulating a chart
●
Changing the chart definition
1. Select the chart and then do one of the following to display the Chart Wizard.
■
Click Menu > Edit > Wizard.
■
Click the Chart Wizard button
■
on the Context toolbar.
Right-click the icon
of the chart or any part of the chart other than the legend and label, then select Chart
Wizard from the shortcut menu.
2. In the Chart Title text field, edit the title of the chart. You can click
the title.
to customize the font, size, and style of
3. Click the Filter button to apply some filter conditions to narrow down data displayed in the chart.
4. Change the values displayed on the chart.
5. Upon finishing, click OK to apply the modifications.
For details about how to define a chart, see Inserting a chart.
●
Formatting chart elements
You can format the chart graph, platform, paper, legend, X and Y axes, wall, floor, and gridlines using the corresponding
format command on the shortcut menu of a chart. For details about the element properties, refer to the specific format
dialog in JReport Studio dialogs.
●
●
Sorting category/series labels
You can sort the labels on the category or series axes of a chart in either descending or ascending alphabetical order. To
do this, right-click the chart, then on the shortcut menu, select the required order from the Sort Category or Sort Series
submenu.
Swapping chart groups
You can switch data between the category and series axes, or between the category and value axes of a chart if no field
on the series axes.
To swap the chart groups, first select the chart, then do either of the following:
❍
❍
●
Click the Swap Chart Groups button
on the Context toolbar.
Right-click the icon
of the chart or any part of the chart other than the legend and label and select Swap Chart
Groups from the shortcut menu.
Converting a chart into a crosstab
1. Select the chart and then do either of the following to display the To Crosstab dialog.
■
■
Click Menu > Edit > To Crosstab.
Right-click the icon
of the chart or any part of the chart except for the legend and label and click To Crosstab
on the shortcut menu.
2. In the Title text field, input a title for the crosstab. You can click
title.
to customize the font, size, and style of the
3. Select a group object
in the Resources box and click
or
to add it as a group field to the Columns or
Rows box; select an aggregation object
or a detail object
and click
to add it as an aggregate field to the
Summaries box. If a detail object is added, specify the aggregate function for it in the Aggregation column. Repeat
this to add more group and aggregate fields.
In the Label column, you can edit the label of a group field or aggregate field, and the Sort column allows you to
specify a sorting manner on a group field.
If you want to remove any group/aggregate field, select it and click
.
To adjust the order of group/aggregate fields, select a group/aggregate field and click
or
.
4. Click OK to finish the conversion.
Note: Additional values are supported only in chart. If you convert a chart with additional values into crosstab, the
additional values are not converted together with the chart.
●
Changing chart type
Select the chart, then on the Context toolbar, click the Chart Type button
desired chart type and its subtype.
●
Changing legend position in a chart
Chart legend can be placed at the top, bottom, left or right position in a chart. To change the legend position, select the
chart, then on the Context toolbar, click the Chart Options button
submenu and select the desired position.
●
. From the drop-down menu, go to the Legend
Showing/Hiding labels on the X/Y axis
Select the chart, then on the Context toolbar, click the Chart Options button
the Label submenu, then select/unselect the desired labels to show/hide them.
●
. From the drop-down menu, select the
. From the drop-down menu, go to
Showing/Hiding X/Y gridlines
Select the chart, then on the Context toolbar, click the Chart Options button
. From the drop-down menu, go to
the Gridlines submenu, then select/unselect the desired gridlines to show/hide them.
When gridlines are shown, it is better to also have the wall shown so as to make the background gridlines more intuitive.
To show the wall, follow the steps above, then on the Gridlines submenu, select Wall.
Going up/down on Google map group markers
●
●
For the group level that is higher than some other group levels in a Google map component, point to its group marker,
right-click it and select Go Down from the shortcut menu to jump one group level down.
For the group level that is lower than some other group levels in a Google map component, point to its group marker,
right-click it and select Go Up from the shortcut menu to jump one group level up.
Binding links to components
You can bind links to labels, images, DBFields, formula fields, parameter fields, multimedia objects, and
special fields.
To bind a link to a component:
1. Right-click the component and select Link on the shortcut menu. The Insert Link dialog appears.
2. Specify the link type to which the component will be linked by selecting the desired type and then
set the related options for the type.
❍
❍
❍
Link to Report
If you create a link to a report, when viewing the result, you can view another report by clicking
the component.
Link to URL
Enter the URL in the Hyperlink box if you want to create a link to a web page, then specify the
window or frame in which to load the location specified by the URL.
Link to E-mail
Enter the e-mail address in the Hyperlink box.
3. When done, click OK to close this dialog.
See also Insert Link dialog for additional help about options in the dialog.
Once a link is added to an object, you can further edit it or remove it.
●
●
To edit a link, right-click the object and select Edit Link from the shortcut menu. In the Edit Link
dialog, edit the link according to your requirement.
To remove a link from an object, right-click the object and click Remove Link on the shortcut menu.
In the warning message dialog, click Yes to confirm the removal.
Linking a report to another report
A report can be linked to another report, after which the trigger object in the primary report can be
clicked in order to jump to the linked report to obtain information about the trigger object. In JReport
Studio, it is very simple to set up the link relationship between two reports.
1. Open the web report which will be used as the primary report.
2. In the report, select an object to be the trigger for loading the linked report. Usually you can use a
label, a field (DBField, summary, formula, parameter, or special field), or an image as a trigger
object.
3. Right-click the trigger object, click Link on the shortcut menu. The Insert Link dialog is displayed
and Link to Report is selected by default as the link type.
4. Click the Browse button beside the Report text field to specify the target web report you want as
the linked report.
5. Specifies the window or frame in which to load the linked report from the Target drop-down list.
6. Click the Advanced button to displays the advanced settings.
7. In the Conditions tab, click
above the Components box to specify which components in the
linked report will be interlinked with the primary report.
8. Select a component in the Components box, then specify the link relationship for the selected
target component in the Field Conditions box as follow:
a. Click the button
above the Field Conditions box, then a new condition row will be added.
b. Select a field from the drop-down list in the Fields(Primary) column.
c. Choose an operator from the drop-down list in the OP column. The operator can be "=",
"<>", "<", ">", "<=", ">=", or "IN".
d. Specify the field of the linked report from the drop-down list in the Fields(LinkedReport)
column. All fields in the linked report of the same value type as the selected primary report
field will be available.
and then
e. If necessary, you can specify more link conditions by clicking the button
specifying the primary report field, the operator, and the corresponding field in the linked
report. Note that the relationship among these link conditions is AND, which means that
JReport will fetch linked report data which meets all of the conditions.
f. Repeat the above steps to set link conditions for other target components.
9. From the Default Linked Component drop-down list, select which component in the linked report
will be linked with the primary report by default. Then, when the primary report is opened in
HTML, PDF or Excel format, or in JReport Studio, the page where the data that meet the
predefined condition in the specified component in the linked report will be displayed by default
after you click the link.
10. If the linked report uses parameters, go to the Parameters tab, the Target Report Parameters box
lists the parameters of the linked report. You can assign fields of the primary report to the
parameters. Then, when running the linked report from the link, the field values of the primary
report will be assigned to the parameters automatically.
11. Click OK to apply the settings.
Then, when the primary report is run in JReport Studio, or in HTML, PDF or Excel format with Run
Linked Report being selected, the link will be enabled, and when you click the trigger object in the
primary report, you will find that the linked report is displayed according to the specified link conditions.
If the linked report is opened in the same frame as the primary report in JReport Studio, you can click
on the toolbar to go back to the primary report. Click
next to
and you will get a drop-down
list which lists the original report and the linked targets you have just visited within the link chain. The
item checked on the drop-down list is the currently opened page. Select an unchecked item and you
will be directed to that target.
Notes:
●
●
When linking reports, you need to avoid link loops. For example, if you have linked report A to report
B, then you cannot link report B back to report A again.
The conditions specified in the Condition tab are used for setting up the searching criteria between
the two linked reports, which means after you click the trigger object in the primary report, the
pages containing the data that meet the conditions in the linked report will be displayed. However,
when running the primary report in JReport Studio or JDashboard, the conditions are used for
filtering, that is, only the data that meet the conditions in the linked report will be displayed.
Using dynamic resources
When you add fields to a report, sometimes you may find that the view elements that have been predefined in the business view cannot meet your
requirements, in which case, you can create some dynamic resources and use them in the report to get the desired data. Then when you save the report,
the dynamic resources will be saved along with the report as its resources.
Dynamic resources that can be used in web reports include formulas and aggregations.
Creating and using dynamic formulas
You should have some knowledge of the formula syntax before you can successfully compose a formula with no errors.
To create a dynamic formula:
1. In the Resources box of the report wizard, expand the Dynamic Resource > Formulas node, then click <Add Formula…> to display the Formula
Editor.
2. Enter a name for the formula in the Formula Name text field.
3. Compose the formula by selecting the required fields, functions and operators from the Fields, Functions and Operators panels. You can also write the
formula by yourself in the editing panel.
4. Click the Check button
to check whether or not the syntax of your formula is correct.
5. When done, click the OK button to create the formula. You can then use the formula in the report.
Notes:
●
You can only save a formula with no errors into a report.
●
Currently, global variables are not supported in dynamic formulas.
●
When formulas reference display names or mapping names, the names should not contain any of the following characters if the names are not quoted by
double-quotation marks "":
"~", "`", "!", "@", "#", "$", "%", "^", "&", "*", "(", ")", "-", "+", "=", "{", "}", "[", "]", "|", "\\", ":", ";", "\", " ' ", "<", ",", ">", ".", "?", "/"
Examples:
❍
Expression @Customer#; will cause a syntax error. But @"Customer#" is ok.
❍
If a field has the display name Category.Aggregation, when adding it to a formula, quote it as "Category.Aggregation" or "Category"."Aggregation".
Once a dynamic formula has been created, you can then drag it from the Resources panel to the desired position in the report as a detail object, or use it
when working with the report wizard.
Also, if you want to further edit an existing dynamic formula or remove any formula that is not required, right-click the formula and then click the
corresponding command on the shortcut menu.
Creating and using dynamic aggregations
In JReport Studio, you can also create dynamic aggregations by mapping them to the available resources such as group objects, detail objects in the current
business view and the dynamic formulas that have been created in the report.
To create a dynamic aggregation:
1. In the Resources box of the report wizard, expand the Dynamic Resource > Aggregations node, then click <Add Aggregation…>. The Add
Aggregation dialog is then displayed.
2. In the Aggregation Name text field, specify the display name of the dynamic aggregation.
3. Click the chooser button
next to the Resource Name text field to specify the field on which the dynamic aggregation is based.
4. From the Aggregate Function drop-down list, specify the aggregate function.
5. When done, click OK to create the dynamic aggregation. You can then use the aggregation in the report
Once a dynamic aggregation is created, you can then drag it from the Resources panel to the desired position in the report to see the desired data, or use it
when working with the report wizard. And if you want to edit any dynamic aggregation or delete it, right-click the aggregation and click Edit or Delete on
the shortcut menu.
Going through the report data
In a web report, you can choose to show certain groups of records according to your requirements, and switch among
the groups to see the data you want.
●
●
●
●
●
Go-to
Enables you to obtain a different view of data by switching among groups.
Go-to-by-value
Enables you to filter data based on a go-to action so as to obtain a more detailed view of the data.
Go-down
Enables you to drill data to a lower-level group according to predefined hierarchies.
Go-up
Enables you to drill data to a higher-level group according to predefined hierarchies.
Going to detail
Enables you to concentrate on the details of a group.
After a going action has been performed, the data presented in the component will be re-loaded from the data buffer,
showing only the records in the selected group, and the new report created by going can also be viewed, printed, and
exported to other format in the same way as the original report.
Assume you have created a crosstab report on the business view WorldWideSalesBV in Data Source 1 of the
SampleReports catalog showing product sales information with Sales Year (ascending) as the column field, Region
(ascending) as the row field, and Total Sales as the summary field, and applied the default style to the crosstab. The
crosstab shows as follows:
Also assume that the business view WorldWideSalesBV has defined the following hierarchical relationship: Region >
Territory > Country > State > City.
We will now take the crosstab as an instance to illustrate the going functions.
Go-to
The go-to action enables jumping to a different group by replacing the current. It is performed on crosstab column/row
headers and table groups.
1. Right-click any value of Region, APAC for example, and choose Go to from the shortcut menu. The list of groups
available for "Go to" will appear on the submenu.
2. Click Country on the submenu, then in the regenerated result, we can see that Country becomes the group for
rows and Sales Year remains the group for columns.
3. To return to the original status, click the Undo button
on the toolbar.
Go-to-by-value
The go-to-by-value action allows showing the information of another group while applying the current value being
clicked on as a filter condition. It is performed on crosstab column/row headers and table groups.
1. Go back to the original report in the above example.
2. Right-click the value APAC of the Region group, and point to Go to by value on the shortcut menu. A submenu
for the command is displayed, which lists the same items as those of Go To.
3. Click Country too and the result will be regenerated.
We can see that the result is different from that of go-to. This is because that, for the go-to-by-value action, the
group of rows changes to Country while being filtered by the Region value APAC. That is, on the basis of the go-to
action, a filtering action where Region = APAC is performed at the same time, and thus the result of go-to-byvalue is generated.
In addition, when a go-to-by-value action is performed, the "Go To" Filter panel will be displayed on the left of the
JReport Studio window, showing the group and the value that the filter is based on.
4. To go back to the original report, click the Undo button
on the toolbar.
Go-down
The go-down action is based on predefined hierarchies in business views. It allows going from a non-bottom level group
to the one-level-lower group while applying the current selected value as a filter condition. Go-down is performed on
table groups, crosstab column/row headers, and chart categories and series.
1. Go back to the original report in the above example, right-click the value APAC, on the shortcut menu, point to
Go down, and we can see that Territory is listed as the submenu item.
2. Click Territory to see the result. It displays the data about territories in the Asia Pacific region.
3. The one-level-lower group for Territory defined in the hierarchy is Country. Now click Asia directly and JReport will
go down to Country.
After these two go-down actions, we can see two filters are added in the "Go To" Filter panel, Region = APAC and
Territory = Asia.
This is because, when you perform a go-down action, a filter will be created based on the value you click on. In
this example, we first click on the APAC region, so JReport drills this region one-level down to display territories in
APAC, and thus the filter Region = APAC is created. If you want all data in the one-level-lower group to be
displayed when you drill down a group, you can remove the corresponding filter from the "Go To" Filter panel, by
clicking X beside the filter condition.
Go-up
The go-up action allows jumping from a group which is non-top level in a predefined hierarchy to the one-level-higher
group. It is performed on table groups, crosstab column/row headers, and chart categories and series.
1. Based on the report result after go-down, right-click any value of Country, China for example, on the shortcut
menu, point to Go up, and we can see that Territory is listed as the submenu item.
2. Click Territory to see the result. Territory is now the group for rows and the filter condition Territory = Asia is
removed from the "Go To" Filter panel.
3. The one-level-higher group for Territory defined in the hierarchy is Region. Now right-click any value of Territory,
South Pacific for example, on the shortcut menu, point to Go up and click Region, the crosstab restores to the
original state.
Going to detail
The go-to-detail action is performed on the summary of the tables, crosstabs and charts. First define a table and make
it contain the information you would like to view about the summary values. Suppose that the summary is total sales in
different countries. Then when you perform go-to-detail action on the value of total sales in France, you will get the
table displaying the fields you defined and having applied the filter condition Country=France. When you go to detail of
the total sales in another country, the table will display the data of that country.
To define the detail table for a summary and perform the go-to-detail action on it:
1. Right-click any summary value and select Edit Detail Table from the shortcut menu. The Edit Detail Table dialog
is displayed.
2. From the Resources box, add the fields you want to display in the detail table of the summary. To adjust the order
of the added fields, click
or
.
3. Click OK to finish defining the detail table.
4. Right-click a summary value of which you would like to view the detailed information, then click Go to Detail on
the shortcut menu. The detail table for the summary value will then be displayed, which shows the fields you have
defined.
5. To go back to the original report, click
on the toolbar.
Note: If the table type is Group Above, you can right-click its group header to show the shortcut menu so as to use the
going function. For other table types, you have to right-click the group name in group column to perform going.
Applying filters
You can apply filters to business views and data components such as tables, crosstabs and charts of a web
report so as to narrow down the data displayed in the web report.
Applying filters to business views
When creating web reports, you can choose to apply some filter to the specified business view to narrow down
the data scope of the data component using the business view.
In JReport Studio, filters for business views are defined into two categories: predefined filters and user defined
filters. As the name suggests, predefined filters are defined in advance when creating or editing the business
views in JReport Designer, and user defined filters are created on business views while they are used.
Filters can be applied to a business view in the report wizard or component wizards.
1. In the Bind Data page of the JReport Studio Wizard or in a component wizard, select the business view
that you are going to add filters to from the Data Source drop-down list, and then click the Filter button
on the right. The Query Filter dialog is displayed.
2. The dialog has the basic and advanced modes for you to define a filter using either simple expressions or
complex expressions.
When it is in the advanced mode, you can also choose to apply a predefined filter of the specified
business view from the Query Filter drop-down list. If you prefer to define a filter on your own, select
User Defined from the drop-down list, and then define the filter according to your requirements. You can
also edit a predefined filter if required and save it as a user defined filter to the business view.
❍
To define a filter using simple expressions:
a. Make sure the dialog is in the basic mode.
b. Select the field on which the filter will be based from the field drop-down list.
c. From the operator drop-down list, set the operator with which to compose the filter expression.
d. Type the values of how to filter the field in the value text box, or select one or more values from
the drop-down list.
e. If you want to add another condition line, from the logic operator drop-down list,
■
■
To add a condition line of the AND relationship with the current line, select AND, then define the
expression as required.
To add a condition line of the OR relationship with the current line, select OR, then define the
expression as required.
Repeat this to add more filter expressions if required. To delete a condition line, click
❍
on its left.
To define a filter using complex expressions:
a. Switch the dialog to the advanced mode.
b. Click the Add Condition button to add a condition line.
c. From the field drop-down list, select the field on which the filter will be based.
d. From the operator drop-down list, set the operator with which to compose the filter expression.
e. Type the values of how to filter the field in the value text box, or select one or more values from
the drop-down list.
f. To add another condition line, click the Add Condition button and define the expression as
required. Then click the logic button until you get the required logic to specify the relationship
between the two filter expressions. The logic can be AND, OR, AND NOT, or OR NOT.
g. Repeat the above steps to add more filter expressions if necessary.
To group some conditions, select them and click the Group button, then the selected conditions
will be added in one group and work as one line of filter expression. Conditions and groups
together can be further grouped. To take any condition or group in a group out, select it and click
Ungroup. It is the equivalent of adding parenthesis in a logic expression.
To adjust the priority of a condition line or a group, select it and click the Up or Down button.
To delete a condition line or a group, select it and click the Delete button.
3. After you finish the report wizard or component wizard, the specified filter will be applied to the business
view, so that your report will get data that meets the filter condition only.
Note: Query filters take effect on the component level, which means each time you create a component, you
can apply a filter to the business view the component uses and it will not affect other components based on
the same business view.
Filtering report data
There are the following ways you can take in order to filter components in a web report: using the Filter dialog,
using the Filter panel, using the Filter web control, or via shortcut menu.
Using the Filter dialog
When using the Filter dialog to filter report data, you can only make the filter applied to a specific data
component in the current web report.
To filter report data using the Filter dialog:
1. Click Menu > Edit > Filter, or the Filter button
displayed.
on the Standard toolbar. The Filter dialog is
2. From the Apply to drop-down list, select the component in the web report to which you want to apply the
filter.
3. Define the filter using either simple expressions or complex expressions.
4. When done, click OK to apply the filter.
The Filter dialog provides an entry to all the filters used in the current web report except query filters. You can
click the Inspector button to view the detailed filter information.
Using filter controls
You can also use the Filter web control to filter one or more data components that use the same data source in
a web report. A filter control can do filtering based on one field. For details, see Using filter control to filter
report data.
Using the Filter panel
The Filter panel on the left of JReport Studio is used to filter data components in the current report that are
using the same business view. To do this:
1. Add group and detail resources into the Filter panel by clicking + on the panel title bar. Each added group/
detail and its values are housed in a separate box. Group and detail objects can be selected from the
business views used by current report.
2. Select the values you would like to filter the report data. The selected values applies a filter condition to
all the data components in the current report that are using the same business view, regardless whether
the data components contain the fields holding those values.
You can make use of the Ctrl or Shift key to do multiple selection.
The value selection applies a filter condition and the logic is as follows:
●
For one value selection:
Selected_Field=Selected_Value
For example, Country=USA
●
For multiple selection:
(Selected_Field1=Selected_Value1 or Selected_Field1=Selected_Value2) and
(Selected_Field2=Selected_Value3 or Selected_Field2=Selected_Value4)...
For example, (Country=USA or Country=China) and (Year=2008 or Year=2009)
The following shows more about working with the Filter panel:
You can use the buttons on the bottom of the Filter panel to deal with the value selection in the panel.
●
❍
❍
❍
●
Back
Goes back to the previous value selection status and refreshes the report data accordingly.
Clear
Removes all the value selection histories and all the filter conditions based on the selections, and refreshes
the report data accordingly.
Forward
Goes forward to the next value selection status and refreshes the report data accordingly.
After right-clicking a group/detail name title bar, these options are available for managing the group/detail
object.
❍
Search
Displays the quick search toolbar right above the group/detail box which enables you to search values in
the group/detail object. You can also use the button
quick search toolbar.
on the group/detail name title bar to launch the
The following are details about the usage of the quick search toolbar:
■
■
■
Text field
Type in the text you want to search for in the text field and the matched text will be highlighted among
the group/detail values.
X
Closes the quick search toolbar.
Lists the advanced options.
■
■
■
■
■
❍
Highlight All
Specifies whether to highlight all matched text.
Match Case
Specifies whether to search for text that meets the case of the typed text.
Match Whole Word
Specifies whether to search for text that matches a whole word as the typed text.
Highlights the next matched text.
Highlights the previous matched text.
Clear
Cancels the selection of a value in the group/detail object. You can also use the button
detail name title bar to achieve this.
❍
❍
❍
on the group/
Clear All
Cancels the selection of all values in all the group and detail objects.
Sort
Sorts the values in the group/detail object in the ascending or descending order.
Delete
Removes the group/detail object from the Filter panel. You can also click X on the group/detail name title
bar to remove it.
Note: The filters created via the Filter panel cannot be seen when web reports are opened in JReport Designer.
Cascading relationship between filters
The Filter panel can be regarded as a collection of special filter controls which apply to all data components
using the same data source. While common filter controls can choose the data components they apply, still
under the circumstance of using the same data source.
When there are filter controls, including the special ones in the Filter panel, that apply to the same data
components, and when these controls' fields have cascading relationship, the cascading relationship will be
revealed when you select values in the controls.
For example, there is a filter control based on the field Country, a filter control on City, and another on State.
The first two share one table while the third shares nothing with the other two. In this case, Country and City
values will show cascading relationship, but State values will not participate. You select USA in the Country
filter control, the values in the City filter control will change as follows if the control has scrollbar: the cities
belong to USA are displayed in the upper area of the filter control, and the other cities are put in the lower
area and grayed out. For the case that the City filter control has no scrollbar: all the values remain their
positions and the values not belonging to USA are grayed out. In both cases all the values are selectable. But
the State values remain as before, since the selection of them will not affect the data components that the
Country and City filter controls control.
Using the shortcut menu
You can also use filter-related commands on the shortcut menu to filter the data in a table. To do this, point to
any value of the field by which you want to filter data, then right-click to show the shortcut menu. You will see
the Filter item which provides a submenu containing the following commands:
●
●
Remove Filter
This command is enabled after you have applied filtering on the field. Clicking this item will remove all filters
on this field.
First N
Shows the First N item with which you can filter data to display records that meet the First N condition. You
can select a number from the submenu or enter a positive integer into the text box on the submenu to
specify the First N condition.
For example, if you select 5 from the First N submenu for a certain field, then only the records with the field
value equal to one of the first five field values will be displayed.
●
Last N
Shows the Last N item with which you can filter data to display records that meet the Last N condition. You
can select a number from the submenu or enter a positive integer into the text box on the submenu to
specify the Last N condition.
For example, if you select 5 from the Last N submenu for a certain field, then only the records with the field
value equal to one of the last five field values will be displayed.
●
●
Field values
"Field values" is not the name for a command on the Filter submenu, but represents some items which are
the values of the field you have right-clicked. Selecting any field value listed here will make the table only
display records with the field value equal to the selected one.
More
This command is enabled if the Filter submenu cannot list all field values. When it is enabled, clicking it will
show the Select Values dialog. You can select one value in this dialog, then the table will only display records
with the field value equal to the selected one.
Using web controls
Web controls are report components designed to be similar to the kinds of controls found on web
pages. In JReport Studio, these four types of web controls can be applied: parameter control,
parameter form control, filter control, and navigation control.
This section describes each of the web controls and how to use them.
Using parameter control to specify a parameter to a report
A parameter control is a web control that is bound with a parameter used by the current report. By
specifying values to the parameter in a parameter control, you can pass the parameter values to
JReport and run the report with the specified values.
Parameter controls do not support inserting cascading parameters. If you want to do this, use
parameter form controls instead.
To insert a parameter control and use it to specify a parameter to a report:
1. Do either of the following:
❍
❍
Click Menu > Insert > Parameter Control, then point to the destination where you want to
add the parameter control and click the mouse button.
Drag Parameter Control from the Components panel to the destination in the report.
The Insert Parameter Control dialog is displayed.
2. Select the parameter you would like to add to the parameter control, then click OK.
3. A parameter control will be added into the report. There are the following ways to specify
parameter values according to the appearance of the parameter control which varies with the type
and properties of the selected parameter:
❍
Typing in the parameter values if the text field is editable.
❍
Selecting a parameter value from a drop-down list.
❍
Using the calendar button
Time, or DateTime type.
to specify a value using the calendar if the parameter is of Date,
❍
Selecting or unselecting the checkbox to specify a Yes/No value.
❍
Using the button
to specify multiple values for the parameter in the Enter Values dialog.
4. Once the value in the parameter control changes, the report will rerun with the new parameter
value.
Note: If the specified parameter is no longer used in the report, the parameter control will become
invalid.
Using parameter form control to run reports
A parameter form control is a web control that is bound with the parameters used by the current report
or other reports. By specifying values to the parameters in a parameter form control, you can make the
reports run with the specified parameter values.
To insert a parameter form control and use it to run reports:
1. Do either of the following:
❍
❍
Click Menu > Insert > Parameter Form Control, then point to the destination where you
want to add the parameter form control and click the mouse button.
Drag Parameter Form Control from the Components panel to the destination in the report.
The Insert Parameter Form Control dialog is displayed.
2. Specify the target reports to run using the parameter form control.
❍
To run the current report, select Current Report, then specify the parameters used to run the
report from the Select Parameters box.
❍
To run other reports, select Others, then select the reports you want to run. If all the selected
reports contain no parameters, you cannot finish the dialog.
3. Specify whether to include the Submit button in the parameter form control. If Submit is included,
it is used to submit the parameter values you specified in the parameter form control. If Submit is
not included, once you change the values of a parameter in the parameter form control, the new
values will be applied automatically.
4. Click OK in the dialog to save the changes.
The parameter form control is now inserted in the report. It lists the selected parameters for the
current report or lists all parameters used by the specified reports.
5. In the parameter form control, specify values of the listed parameters.
6. Click the Submit button if present to run the current report or the specified reports. If there is no
Submit button, the change of values in the parameter form control will trigger report rerunning.
Note: If you save or publish a report containing a parameter form control to another directory, the
reports that you bind the parameter form control with will not be saved or published along with the
report.
Using filter control to filter report data
A filter control is used to filter one or more data components in a report, which refer to tables, charts,
and crosstabs. For how a filter control works, see Filtering scenarios.
To insert a filter control and use it to filter report data:
1. Do either of the following:
❍
❍
Click Menu > Insert > Filter Control, then point to the destination where you want to add the
filter control and click the mouse button.
Drag Filter Control from the Components panel to the destination in the report.
The Insert Filter Control dialog is displayed.
2. From the resource list, select the fields of the same data type to bind to the filter control.
To filter components created from the same data source, select a field in the data source.
To filter components created from different data sources, find a common field these data sources
contain, then select the field in each of the data sources.
3. The Apply To drop-down list provides the components involving the selected fields. Select the
components which you want to filter.
4. When done, click OK.
The filter control is inserted in the report. It lists all values of the specified fields. You can select
one or more values to apply.
After inserting filter controls in the report, you can also insert a navigation control for undoing/redoing
the value selection in the filter controls. For details about the usage of navigation control, see Using
navigation control to undo/redo value selection in filter controls.
Managing a filter control
After right-clicking
at the upper left corner of a filter control, these options are available for
managing the filter control.
●
Search
Displays the quick search toolbar right above the filter control which enables you to search values in
the filter control. You can also click the button
quick search toolbar.
on the title bar of the filter control to launch the
The following are details about the usage of the quick search toolbar:
❍
❍
❍
Text field
Type in the text you want to search for in the text field and the matched text will be highlighted
among the field values.
X
Closes the quick search toolbar. You can also click outside of the quick search toolbar to achieve
this.
Lists the advanced options.
■
■
■
Highlight All
Specifies whether to highlight all matched text.
Match Case
Specifies whether to search for text that meets the case of the typed text.
Match Whole Word
Specifies whether to search for text that matches a whole word and ignore partial word matches.
❍
❍
●
Highlights the next matched text.
Highlights the previous matched text.
Clear
Cancels the selection of values in the filter control. You can also use the button
cancel the selection. This operation can be undone/redone.
●
●
●
●
on the title bar to
Sort
Sorts the values in the filter control in the ascending or descending order.
Hide
Hides the filter control.
Delete
Removes the filter control from the report and the filter you created with the filter control will be
removed from the report too. You can also use the X button on the title bar.
Properties
Opens the Filter Control Properties dialog for editing the properties of the filter control.
Cascading relationship between filter controls
When there are filter controls that apply to the same data components, and when these controls' fields
have cascading relationship, the cascading relationship will be revealed when you select values in the
controls.
For example, there is a filter control based on the field Country, a filter control on City, and another on
State. The first two share one table while the third shares nothing with the other two. In this case,
Country and City values will show cascading relationship, but State values will not participate. You
select USA in the Country filter control, the values in the City filter control will change as follows if the
control has scroll bar: the cities belong to USA are displayed in the upper area of the filter control, and
the other cities are put in the lower area and grayed out. For the case that the City filter control has no
scroll bar: all the values remain their positions and the values not belonging to USA are grayed out. In
both cases all the values are selectable. But the State values remain as before, since the selection of
them will not affect the data components that the Country and City filter controls control.
Using navigation control to undo/redo value selection in filter controls
A navigation control can be considered as an accessorial control for filter controls and used to deal with
the value selection operations in all the filter controls in the same report.
To insert a navigation control into a report, do either of the following:
●
●
Click Menu > Insert > Navigation Control, then point to the destination where you want to add
the navigation control and click the mouse button.
Drag Navigation Control from the Components panel to the destination in the report.
A navigation control is a combination of three buttons:
●
●
●
Back
Goes back to the previous value selection status and refreshes the report data accordingly.
Clear
Removes all the value selection histories and all the filter conditions based on the selections, and
refreshes the report data accordingly.
Forward
Goes forward to the next value selection status and refreshes the report data accordingly.
Adding conditional formats to fields
You can add some conditional formats to a field in tables or crosstabs, which refer to the DBField,
parameter field, formula field, and summary field, then when the specified condition is fulfilled, the
defined format will be applied to the field values for highlighting.
To add conditional formats to a field:
1. Right-click the field and select Conditional Formatting from the shortcut menu to access the
Conditional Formatting dialog.
2. Click the button
to open the Edit Conditions dialog to define a condition using either simple
expressions or complex expressions according to your requirements.
3. The newly added condition will then be displayed and highlighted in the Condition box in the
Conditional Formatting dialog.
4. In the Format box, set the format which will be applied to values of the field when the specified
condition is fulfilled, for example, the font face, font size, font color, etc.
5. Repeat the above steps to add more conditions and define the format for each condition as
required.
To edit a condition, select the condition in the Condition box, then click
dialog, edit the expressions as required.
. In the Edit Conditions
To remove a condition and the corresponding format, select the condition in the Condition box and
click
.
To adjust the priority of a condition, select the condition in the Condition box and then click
.
6. Click OK to apply the conditional formats to the field.
See also Conditional Formatting dialog and Edit Conditions dialog for details about options in the
dialogs.
or
Applying parameters
When running a web report with parameters, a dialog is displayed for you to specify parameter values.
After the report is opened in JReport Studio, you can change the parameter values using the following
ways.
Using the Parameters panel
The Parameters panel is available when the current web report uses parameters. It lists all the
parameters used by the current report. You can specify values to the parameters in the Parameter
panel and then click Apply to make the report run with the specified parameter values.
You may specify parameter values in these ways:
●
●
●
In the parameter value combo box, select the required one from the drop-down list or input the
value manually.
Click the chooser button
if it is available to specify multiple values in the Enter Values dialog.
Click the calendar button
if it is available to specify a date and time value using either calendar
or expression in the Calendar dialog.
Using parameter controls
You can insert a parameter control and bind it with a parameter used by the current report. By
specifying values to the parameter in the parameter control, you can pass the parameter values to
JReport and run the report with the specified values. For details, see Using parameter control to specify
a parameter to a report.
Using parameter form controls
You can insert a parameter form control, make it run the current report, bind it with one or more
parameters used by the report. By specifying values to the parameters in the parameter form control,
you can make the report run with the specified parameter values. For details, see Using parameter
form control to run reports.
Sorting report data
You can sort the records or groups at a certain group level in a table, crosstab or chart.
●
●
Sorting records: Changing the order of records in the whole table, crosstab or chart, or in each
group if there are.
Sorting groups at a group level: Changing the order of groups at the specified group level, that
is, the groups will be sorted by value of the group field.
To sort data on a certain field using shortcut menu:
1. Point to any value of a detail field or group field by which to sort the data in a table, crosstab or
chart, and then right-click.
2. Choose the command Sort > Ascending or Sort > Descending from the shortcut menu.
If what you right-click in Step 1 is a detail field value, the sorting will affect the order of detail
records in the table, crosstab or chart; if it is a group field value, the order of groups in the group
level represented by the group field will be rearranged.
To remove the sort condition on a field, click Sort > No Sort from the shortcut menu.
Note: If you use the shortcut menu to sort the report data by a field and then sort by another field, the
later sort condition will replace the former one.
Applying CSS styles
CSS styles can be applied to web reports formatting their appearance and characteristics. You can
create and set up your own CSS styles in JReport Designer or any other CSS editor. When you publish
your catalogs to JReport Server, you can include these custom styles with the catalogs.
Styles can be applied to a table, crosstab, or chart, or to the multiple selections of these components,
or to the whole report. The last style always takes effect when more than one style is applied to the
same object.
Applying a style to a report
When a style is applied to the whole report, all components in the report will take a uniform
appearance. You can apply a style in one of the following ways:
●
●
Specify a style in the Style page of JReport Studio Wizard.
In JReport Studio, click the blank area outside of the report field, then select a style from the Report
Style list on the Edit menu.
Applying a style to a component
You can apply a style to a table, crosstab, or chart by selecting the component in JReport Studio and
then doing one of the following:
●
Select a style from the Report Style list on the Edit menu.
●
Right-click and then select a style from the Apply Style list on the shortcut menu.
Applying a style to multiple components
You can apply a style to multiple selections of tables, crosstabs, and charts by selecting the
components and then selecting a style from the Report Style list on the Edit menu.
Saving the report
To save the changes you made to the current report, click Menu > File > Save (or the Save button
Standard toolbar).
on the
If the report is newly created and has not yet been saved, the Save As dialog will be displayed.
1. In the Save in section, browse to the folder where you want to save the web report in the server resource tree.
You can use the
button to return to the parent folder.
2. In the File Name box, enter the name of the report or use the default name. The default file type is web report.
3. Click the Advanced button to set the advanced settings for the report if required.
a. From the Status drop-down list, specify a status for the report.
b. From the Catalog drop-down list, select the catalog for the report.
c. Specify the relationship between the saved report and the catalog used to run it:
■
■
Set Original Catalog as Linked Catalog into Saved Report
If checked, the saved report will be linked with the catalog and will run with the catalog no matter
whether the two are in the same directory. If later the catalog is updated, the saved report will run with
the latest version of the catalog.
Set Catalog Copy to Target Folder
If checked, the catalog will be copied to the directory where the report is saved and the saved report
will run with the copied catalog.
d. Optionally, input comments in the Description box as a description for the report.
4. Click Save to save the report.
To save a copy of a report, click Menu > File > Save As (or the Save As button
show the Save As dialog, and then do as above.
on the Standard toolbar) to
To find a newly saved web report version, browse to select the row that the web report is in on the JReport Console
> Resources page, click Tools > Version on the task bar, and then click the Web Report Versions tab.
Note: You will not be able to save the report to some locations if you do not have the required permissions. You
need to have Write access to the directory.
Exporting/Printing the report result
When you finish editing a web report, you may want to export it to other formats or have it printed.
Exporting the report result
You can export the report result as a result version or as a local file in these formats: HTML, PDF, Text, Excel,
RTF, XML, and PostScript.
1. Click Menu > File > Export (or the Export button
dialog.
on the Standard toolbar) to display the Export
2. In the File Name field, specify the name of the exported result file.
3. Specify the destination of the result:
❍
❍
❍
View Report Result: The result will be directly opened in the web browser if the format is supported
by a plug-in of the web browser; otherwise it will prompt you to save the result file.
Save to File System: The web browser will prompt you to save the result file to a specified folder. If
selected, you need to provide a name for the result file in the File Name field.
Save to Version System: The result will be saved as a result version in JReport Server's versioning
system.
4. From the Select Format drop-down list, select the format in which to export the result.
5. Expand More Options to set the options for the selected format. For details about settings of each
format, see Export dialog.
6. Click OK to confirm.
Printing the report result
You can print the report result to a PDF/HTML file.
To print the result of a web report:
1. Click Menu > File > Print (or the Print button
on the Standard toolbar) to display the Print dialog.
2. In the General tab, specify the printer properties, the page range and copies you want to print.
3. In the Appearance tab, specify the appearance of the printed report as required.
4. Click OK. The PDF/HTML result file will be opened in an associated program with which you can print the
result to a printer.
See also Print dialog for additional information about options in the dialog.
JDashboard
JDashboard is a new way of information delivery, using a user portal user interface rather than a web
report or page report. Users can create, edit and browse dashboards from the JReport Console using
JDashboard. Library components are the basic members in dashboards for presenting data via intuitive
components such as charts, crosstabs, tables, and Google maps. Library components are created using
JReport Designer (for details, see Library Components in the JReport Designer User's Guide), and then
published to the component library on JReport Server for use when creating or modifying dashboards.
With pre-built library components, users can freely choose the objects they want to display in the
dashboard, without having to know how these objects were created, what data sources to use, what
styles to set, etc. A dashboard can hold multiple library components so that when browsing the
dashboard users are able to see multiple data aspects. Within a dashboard, library components are
able to communicate with each other via the message mechanism. This allows actions such as common
filters to be applied to all the components of a dashboard even when coming from different data
sources.
Since predefined containers are used for holding objects, it is easy to move objects around and resize
them in dashboards.
This chapter covers the following topics:
●
JDashboard basic concepts
●
JDashboard window elements
●
Creating dashboards
●
Inserting components
●
General operations in JDashboard
●
Manipulating data components
●
Filtering component data
●
Sharing parameters between library components
●
Saving dashboards
●
Exporting library components
●
Printing library components
●
Setting JDashboard as the server home page
●
Running and editing reports in JDashboard
Note: A JDashboard license is required in order to use JDashboard and all the related features. If you
do not have a JDashboard license please contact your Jinfonet Software account manager to obtain a
license.
JDashboard basic concepts
The following shows the main JDashboard concepts:
Library components
Library components are used to build dashboards. They are able to present data via intuitive
components such as charts, crosstabs, tables, and Google maps. Library components can be created
and edited using JReport Designer, and then published to JReport Server for use in dashboards. Library
components can also come from report components. JReport Designer provides a way to save a data
component in a web report to a library component. Or when a dashboard user inserts a web report
component into a dashboard, the report component will be converted to a library component and the
user can save the library component. Library components use .lc as the file suffix.
Component library
Component library contains one Public Components folder and many My Components folder for each
specific dashboard user.
Public Components and My Components are two built-in folders in the server resource tree root for
storing library components. The Public Components folder contains public components available to
everyone. The My Components folder holds personal components for each dashboard user.
Dashboard
A workspace window that can contain any number of library components.
●
●
●
Components from library
When inserting a library component from the component library into a dashboard, you are not
copying the component from the library, but instead referencing it from the library, in this sense, the
changes to the component in the library will be reflected in all of the dashboards referencing the
component. The contents of library references in dashboards cannot be edited since they are
referenced resources.
Report components
Data components such as tables, charts, crosstabs, and Google maps in reports can be inserted into
dashboards as library components.
Objects from the Toolbox
In addition to library components users can select objects from the Toolbox such as labels, images,
special fields, sliders, filter controls, third-party objects, and HTML objects.
Message
The information that one library component can send to another. The sending and receiving of
messages between library components are defined in JReport Designer.
JDashboard window elements
JDashboard is opened in a web browser. The full-featured JDashboard window is composed of three
sections: the dashboard title bar at the top, the side bar on the left providing options for working with
dashboards, and the dashboard editing area where you navigate and modify dashboards.
View mode and edit mode
JDashboard has two working modes: the edit mode presents full functionalities and the view mode just
serves for viewing purpose without any editing abilities. After JDashboard is open, you cannot switch
one mode to another. If you need to do this, reopen JDashboard using the appropriate way.
To enter the view mode:
●
Browse to locate an existing dashboard on the JReport Console page, then click the Run button
on the floating toolbar, or click Run > Run on the standard toolbar.
To enter the edit mode:
●
●
On the JReport Console page, click New Report > Dashboard.
Browse to locate an existing dashboard on the JReport Console page, then click the Edit button
on the floating toolbar, or click Run > Edit on the standard toolbar.
You can also directly click the name of a dashboard to enter the view mode if the dashboard is in the
My Reports folder, or either of the two modes if it is in the Public Reports folder, depending on the
permission you are granted on the dashboard:
●
●
●
When you have the Execute permission on the dashboard, you will be directed to the view mode.
When you have the Edit permission on the dashboard but do not have the Execute permission, you
will enter the edit mode.
When you have the both the Execute and Edit permissions on the dashboard, you will enter the view
mode.
The following introduces the full UI elements.
Dashboard title bar
The dashboard title bar at the top contains tabs labeling the names of the open dashboards.
Dashboard name tabs
Each tab represents an open dashboard and the dashboard name is shown on the tab.
The following are operations on the tabs:
●
Click a tab to activate the corresponding dashboard.
●
Rename a tab. Double-click a tab name to enter the editing mode. After typing a new name, press
Enter or click outside of the input field to save the name.
●
Move a tab. Drag a tab and drop it beside a different tab so as to change the tab order.
●
Click x beside a dashboard name to close the dashboard.
Adds a new blank dashboard in the current web browser.
Dashboard editing area
Dashboard view has header and body.
The dashboard header can contain labels, images, and special fields.
The dashboard body can contain report components, library components, filtering tools, third-party
objects, and HTML components. You can insert the same library component repeatedly to the same
dashboard body.
Library components inserted to dashboards are references of the library component in component
library. The changes to a library component in the library will be reflected in all of the dashboards
referencing the library component, such as removal of library components, version updated, permission
changed.
Side bar
The options available on the side bar are determined by the feature profile that is selected as the
default profile in the Profile > Configure Profile > JDashboard > Features tab and the property setting
on the Profile > Configure Profile > JDashboard > Properties tab (profile has the higher priority). The
default JDashboard profile provides full options.
The side bar on the left contains these buttons:
Shows or hides the Resources panel which includes these branches:
●
●
●
Component Library lists the library components created in and published from JReport Designer.
You can select a library component and drag it into the dashboard body.
Reports lists page reports and web reports. You can open a report from JDashboard or add report
data components into your dashboards.
Toolbox lists the objects that can be inserted in your dashboards such as labels, images, special
fields, filtering tools, third-party objects, and HTML components.
New
Creates a new blank dashboard with a new tab added.
Open
Displays the Open Dashboard dialog for you to specify a dashboard to open.
Save
Saves the changes made to the current dashboard.
Refresh
Refreshes the current dashboard.
Enter Parameter Values
Opens the Enter Parameter Values dialog which lists all the parameters used in the dashboard for
specifying their values.
Clear Filters
Removes all the filters from the current dashboard including those generated via sliders, filter controls,
messages, drilling and going actions and those designed using web browsers such as JReport Viewer
and JReport Studio, except query filters and others designed and taking effect in JReport Designer.
Export
Displays the Export dialog for exporting library components in the current dashboard.
Print
Displays the Print dialog for printing library components in the current dashboard.
Options
Displays the following options:
●
●
●
●
●
●
●
●
New
Creates a new blank dashboard.
Open
Displays the Open Dashboard dialog where you can specify a dashboard to open.
Save
Saves the changes made to the current dashboard.
Save As
Saves the dashboard with a different name or to a new location.
Export
Displays the Export dialog for exporting library components in the current dashboard.
Print
Displays the Print dialog for printing library components in the current dashboard.
Clear Filters
Removes all the filters from the current dashboard including those generated via sliders, filter
controls, messages, drilling and going actions and those designed using web browsers such as
JReport Viewer and JReport Studio, except query filters and others designed and taking effect in
JReport Designer.
Share Parameter
Opens the Share Parameters Setting dialog for sharing parameters between library components.
●
●
●
●
●
●
Set as Server Home
Sets the current JDashboard status as the home page after logging onto JReport Server. For details,
see Setting JDashboard as the server home page.
Component Title Bar
Customizes the way of showing component title bar and the icons on it.
Themes
Opens the Themes dialog for selecting a theme to apply to the current dashboard.
Show/Hide Dashboard Header
Changes the current status of the dashboard header from being shown to hidden or from being
hidden to shown.
Help
Displays the JDashboard help documents.
Exit
Exits JDashboard.
Creating dashboards
To create a dashboard:
1. On the JReport Console > Resources page, click New Report > Dashboard. A blank dashboard will be
created.
2. The upper section of the blank editing area is the dashboard header, where you can insert labels,
images, and special fields. The dashboard body is the section below the header. In the body you can
insert report components, library components, filtering tools, third-party objects, and HTML objects. For
details see Inserting components.
3. You can make the border between the header and body shown by pressing the Ctrl key on the keyboard
and resize the two by dragging the border line while pressing the Ctrl key.
After you have entered JDashboard, if you want to create more dashboards in the same web browser, see
here.
Inserting components
You can insert library components and report data components as well as labels, images, special fields,
filtering tools, third-party objects, and HTML components into dashboards via the Resources panel. To
access the panel, click Show Resources
on the side bar.
The following shows inserting a specific component in detail:
Inserting library component references
When inserting a library component from component library into a dashboard, you are not copying the
component from the library, but instead referencing it from the library, in this sense, the changes to
the component in the library will be reflected in all of the dashboards referencing the component. The
contents of library references in dashboards cannot be edited since they are referenced resources.
To reference a library component into the dashboard body:
1. Click Show Resources
on the side bar to display the Resources panel.
2. Expand the Component Library node, browse to find the library component you want to insert,
then drag it to the destination in the dashboard body.
Inserting report data components
Data components such as tables, crosstabs, charts, and Google maps in existing page reports or web
reports can be directly inserted into dashboards after being converted into library components
automatically.
Since both library components and web reports use business views as data sources, all data
components in web reports can be converted to library components successfully.
However, page reports use queries or report cubes or business cubes as data sources other than
business views, and business cubes are built on tables while report cubes and business views are
created on top of the same queries, therefore, only when data components in page reports use queries
or report cubes as data sources and the queries or report cubes have corresponding business views,
can the components be converted to library components and used in dashboards. So if you would like
your page report components to be added in dashboards, you need to make sure the components are
created on queries or report cubes and a business view is created for each of the report cubes.
Currently library components do not support some features of page report components, after the latter
are inserted into dashboards, those features will be removed. This may result in that the data
components in dashboards looks different from they are in page reports. For features that are not
supported in JDashboard, they will either be ignored, removed, or applied with the default values.
The following table lists how JDashboard deals with the unsupported page report features:
In Page Report Components
In Library Components
Display types like Barcode, Check box, etc
Ignored
Special fields
Removed
Dynamic resources
Changed to constant resources
Master/Detail reports
Ignored
Subreports
Removed
Nested data components that is one
contains another
The ownership is removed and the involved data
components are regarded as individual components.
Definition properties
Ignored
Formula-controlled properties
Default values are applied.
Other components
Removed
To insert a report data component into the dashboard body:
1. Click Show Resources
on the side bar to display the Resources panel.
2. From the Reports node, expand the report that contains the wanted data component and drag the
component into the dashboard body.
3. If the report component uses parameters, the default values will be applied. To change the
parameter values, after the component is loaded, click
on its title bar and select Edit Setting
from the drop-down list to display the configuration panel. Change the parameter values in the
panel and then click OK to apply the new values.
The inserted report data component runs with the report's catalog. It will not be able to run if the
catalog is removed or updated. The report component does not synchronize with the other library
components in the dashboard via messages and not controlled by the runtime sliders or filters.
After a report data component is inserted in a dashboard, you can save it as a library component. To
do this:
1. On the title bar of the inserted report data component, click
down list.
and select Save As from the drop-
2. In the Save As dialog, specify a location to save the component and a name for the component,
then click OK.
Inserting a label
Labels can be inserted in the dashboard header. To do this, click Show Resources
on the side bar
to display the Resources panel, then from the Toolbox node, drag Label to the destination in the
dashboard header.
Inserting a dashboard title
A dashboard title is a special label. It can be inserted in the dashboard header. To do this, click Show
Resources
on the side bar to display the Resources panel, then from the Toolbox node, drag
Dashboard Title to the destination in the dashboard header.
Inserting an image
Images can be inserted in the dashboard header.
1. Click Show Resources
on the side bar to display the Resources panel.
2. From the Toolbox node, drag Image to the destination in the dashboard header. The Insert Image
dialog is displayed.
3. Specify the image you want to insert.
❍
❍
❍
To use an image in the local file system, select Local File, then click Browse to find the image.
To use an image on a website, select Web URL, then input the image URL or paste the URL in
the File URL text field.
To use an image in the image library of JDashboard, select Library, then select the image in the
My Pictures box.
4. Click OK to insert the image.
Inserting a special field
You can insert these types of special fields in the dashboard header:
●
●
●
●
User Name
The User ID with which you log onto JReport Server.
Modified Date
The date when the dashboard was last modified.
Modified Time
The time when the dashboard was last modified.
Print Date
The date to run the dashboard.
●
Print Time
The time to run the dashboard.
To do this,
1. Click Show Resources
on the side bar to display the Resources panel.
2. From the Toolbox node, drag Special Field to the destination in the dashboard header. The Insert
Special Field dialog is displayed.
3. Choose the desired special field and click OK to insert it into the header.
Inserting a slider
Sliders can be inserted in the dashboard body. They are used to filter component data. For details, see
Using sliders.
Inserting a filter control
Filter controls can be inserted in the dashboard body. They are used to filter component data. For
details, see Using filter controls.
Inserting a third party gadget via URL
A web page can be inserted in dashboards. All you need to do is give its URL.
1. Click Show Resources
on the side bar to display the Resources panel.
2. From the Toolbox node, drag URL Frame into the dashboard body. The Insert URL Frame dialog
is displayed.
3. In the Title text field, give a title for the window that will display the contents of the web page.
4. In the URL text box, type in the URL of the web page. You should provide a complete URL address.
A URL without "http://", for example www.google.com, will not be automatically added "http://"
since it is regarded a relative path, which may lead to that the URL cannot be opened in some
browsers.
5. If you would like the specified web page to refresh periodically, select Auto Refresh, then specify
the interval to refresh.
6. Click OK. The specified web page will be inserted into the dashboard. You can then view the web
page from JDashboard.
When third party gadgets are saved with dashboards, the specified URLs are saved.
Inserting an HTML component
An HTML component allows for typing text, comments, and messages using a simple-featured text
editor. It can be inserted in the dashboard body.
1. Click Show Resources
on the side bar to display the Resources panel.
2. From the Toolbox node, drag HTML to the destination in the dashboard body. The Insert HTML
dialog is displayed.
3. Specify a title for the HTML component.
4. In the text box, type text directly. You can make use of the buttons above the text box to format
the text such as font face, size, style, color, and alignment, insert images, and create hyperlinks.
5. Click OK to insert the HTML component.
After an HTML component is inserted in a dashboard, you can modify its title and contents via the Edit
HTML dialog, which is displayed after you click
Edit Setting from the drop-down list.
on the title bar of the HTML component and select
See the Insert HTML dialog for details about the options in the dialog.
General operations in JDashboard
This section provides a general view of the operations you can perform in JDashboard.
Operations on dashboards
●
Creating a new blank dashboard in the current web browser
Choose a method from the following:
❍
Click + beside the right most dashboard name tab on the top bar.
❍
Click the New button
❍
Click the Options button
on the side bar.
on the side bar and select New from the option list.
A blank dashboard will be created in the browser. Then add components to customize the dashboard.
●
Opening another dashboard in the current web browser
on the side bar, or click the Options button
and select Open from the
Click the Open button
option list. In the Open Dashboard dialog, the dashboards in the same folder as the current open
dashboard are listed. Select the dashboard you want to open from the default folder or from another
folder, and then click OK.
●
Showing, hiding and resizing the dashboard header
To show or hide the dashboard header, click the Options button
Show/Hide Dashboard Header from the option list.
on the side bar and select
Even though the dashboard header is open, its border is unseen by default. However, when you drag
objects into the dashboard editing area, you will see the area is divided into two sections with the
activated section highlighted in grey: the upper section is the header and the lower the body. Or you
can simply press Ctrl on the keyboard to make the border between the header and body shown.
Then drag the border line vertically to adjust the size of the header and body.
●
Specifying dashboard parameter values
Click
on the side bar to display the Enter Parameter Values dialog which lists all the parameters
used in the current dashboard. You can specify the parameter values to rerun the dashboard.
To ease the work of specifying parameter values, you may want to share parameters between library
components.
●
Removing all filters from a dashboard
JDashboard provides the ability to remove all the filters from the current dashboard at a time
including those generated via sliders, filter controls, messages, drilling and going actions and those
designed using web browsers such as JReport Viewer and JReport Studio, except query filters and
others designed and taking effect in JReport Designer. To do this, click the Clear Filters button
on the side bar, or click the Options button
and then select Clear Filters from the option list.
●
Refreshing the current dashboard
Click the Refresh button
●
on the side bar to refresh the data of the current dashboard.
Applying a theme to the current dashboard
on the side bar and select Themes from the option list. In the Themes
Click the Options button
dialog, select a theme from the left panel and then click OK.
●
●
Closing a dashboard
For the current dashboard, click X on its name tab to close it. For the other open dashboards, hover
the cursor on a name tab until X appears, then click X to close that dashboard.
Exiting JDashboard
on the side
If you want to exit JDashboard and release the resources, click the Options button
bar and select Exit from the option list. Do not use the close button on the browser window as that
may not release the resources used by JDashboard.
●
Asking for help
on the side bar and select Help from the option
At any time, you can click the Options button
list to access the JDashboard help documents. Furthermore, you can click
in any dialog to show
the help document about the dialog.
Operations on objects in the dashboard header
●
Editing an object
To edit the text of a label or the dashboard title, double-click it to enter the edit mode. Use the
Backspace or Delete button on the keyboard to delete unwanted text and then input the desired text.
To edit an image, hover the cursor on the image and then click
that appears in the dotted
rectangle, and the Edit Image dialog will be displayed for you to select another image.
●
Modifying object properties
You can modify the properties of labels, the dashboard title, or special fields. To do this, hover the
cursor on the object and then click
that appears in the dotted rectangle, and a dialog will be
displayed for you to modify the properties of the object.
●
●
●
Moving an object
Place the cursor on the object until it becomes a four-arrow icon, then drag to the desired position.
Resizing an object
Place the cursor on the object until a dotted rectangle appears, next move the cursor on the right
border, bottom border, or the bottom right corner until the cursor becomes a two-arrow icon, then
drag to the desired position.
Deleting an object
Hover the cursor on the object and then click
that appears in the dotted rectangle.
Operations on components in the dashboard body
●
Moving a component
Place the cursor on the component title bar until it becomes a four-arrow icon, then drag to the
desired position.
●
●
●
●
●
Resizing a component
Place the cursor on the component's right border, bottom border, or the bottom right corner until the
cursor becomes a two-arrow icon, then drag to the desired position.
Navigating component data via scroll bar
For tables, crosstabs and charts, you can use the scroll bar to navigate their data if the container
cannot display all data of the component.
Turning component pages
If a table or a crosstab contains more than one page, a page navigation bar specific for the
component will be available right below the component. You can use the navigation bar to view the
desired pages:
❍
Click a number to go to that page.
❍
Input a number in the text field.
❍
Click Prev to go to the previous page.
❍
Click Next to go to the next page.
Going to links
Once an object in a library component has been linked to a report, a web page, or an e-mail address,
you will find the mouse cursor changes into a hand icon when hovering on the object, you can then
click the object to launch the linked target.
Sending messages
If an object in a library component has been defined to send a message, by triggering the event
defined for sending the message, the message will be sent out and the components defined for
receiving the message will do things as defined.
The sending and receiving of messages is defined in JReport Designer, see Delivering messages
between library components in the JReport Designer User's Guide.
●
Maximizing a component
Click
on the component title bar and the component will take up the whole dashboard body. By
clicking the button again the component will be restored to the original size.
●
Customizing the way of showing the component title bar and options on it
on the side bar and select Component Title Bar from the option list.
Click the Options button
In the Customize Component Title Bar dialog, specify the way of showing the component title bar and
the options on it, and then click OK.
●
Deleting a component
Click
●
on the component title bar and select Delete from the drop-down list.
Making use of the configuration panel
Each library component can be equipped with a configuration panel. The configuration panel can be
used to specify parameter values to its library component, to filter or sort the data of its library
component, or to change properties of objects in its library component. For how a configuration panel
is configured, see Using the configuration panel in the JReport Designer User's Guide.
Once a configuration panel has been defined for a library component, you can open it in JDashboard
and then perform actions as defined. To do this, on the title bar of the library component, click
and select Edit Setting from the drop-down list to display the configuration panel. After specifying
values in the panel, click OK to apply the values in the library component. The Cancel button is used
to close the configuration panel.
The Show Parameters Before Running option in the panel is used to control whether to show the
configuration panel before rendering the library component each time the dashboard is run or
refreshed. For example, if a library component uses parameters, and you would like to specify
parameter values before loading the component rather than first loading the component and then
changing the parameter values so as to run the component the second time to get the desired result,
you can check this option to have the panel displayed by default.
●
Showing component information
Information about a component such as a library component's ID, the author and his/her e-mail
address, and the description about the component are provided. To view the information, click
on
the component title bar and select About from the drop-down list. A panel will be displayed showing
the information. You can click the OK button in the panel to close the panel.
Manipulating data components
You can manipulate data components, which refer to crosstabs, tables, charts, and Google maps, in
dashboards as shown below.
Applying a style to a data component
Right-click in the component, then on the shortcut menu, select a style from the Apply Style submenu.
Going through the data of tables, crosstabs, and charts
Going actions enable you to switch among data groups freely for viewing different records without
having to create a new data component. Choose the proper one to meet your needs from the following:
●
●
●
●
Go-to
Jumps to a different group by replacing the current. It is performed on crosstab column/row headers
and table groups.
Go-to-by-value
Jumps to another group while applying the current value being clicked on as a filter condition. It is
performed on crosstab column/row headers and table groups.
Go-down
Goes from a group which is non-bottom level in a predefined hierarchy to the one-level-lower group
while applying the current selected value as a filter condition. Go-down is performed on table groups,
crosstab column/row headers, and chart categories and series.
Go-up
Jumps from a group which is non-top level in a predefined hierarchy to the one-level-higher group. It
is performed on table groups, crosstab column/row headers, and chart categories and series.
For example demonstration of them, refer to Going through the report data.
The go-to-by-value or go-down actions always happen along with the generation of a filter condition.
The filters are displayed as "FieldName:Value" at the bottom of the library components, in a row one by
one from left to right according to the time they are generated. When the row cannot hold all of the
filters, two buttons are displayed at the two ends of the row for scrolling through the filters to the left
and right. Each click on the button will show one hidden filter. To remove a filter condition, click X right
to it.
Removing component level filters from a data component
On the shortcut menu of data components, there is an option Remove Filters which is used to remove
filter conditions generated via the configuration panel and via message delivery from the data
components. These two kinds of filters are referred to as component-level filters.
In dashboards you can also use sliders and filter controls to do filtering, however filters created by
sliders or filter controls are not under the control of the removing component level filter action, because
they are regarded as dashboard-level filters.
Going up/down on Google map group markers
●
●
For the group level that is higher than some other group levels in a Google map component, point to
its group marker, right-click it and select Go Down from the shortcut menu to jump one group level
down.
For the group level that is lower than some other group levels in a Google map component, point to
its group marker, right-click it and select Go Up from the shortcut menu to jump one group level up.
Manipulating a table
●
●
Sorting on a field
To sort the values of a field, right-click on any value of the field, then on the shortcut menu, select
Ascend or Descend from the Sort submenu. To remove the sort condition, select No Sort.
Filtering a detail field
You can use filter-related commands on the shortcut menu to filter the data in a table. To do this,
right-click on any value of the field by which you want to filter data, then from the Filter submenu,
specify to show the first/last N values of the field or a specific value. To remove filter condition
created this way, use the Remove Filter option on the Filter submenu.
Manipulating a chart
●
Sorting category/series labels
You can sort the labels on the category or series axes of a chart in either descending or ascending
alphabetical order. To do this, right-click in the chart, then on the shortcut menu, select the required
order from the Sort Category or Sort Series submenu.
●
●
Swapping chart groups
You can switch data between the category and series axes, or between the category and value axes
of a chart if no field on the series axes. To do this, right-click in the chart, then on the shortcut
menu, click Swap Chart Groups.
Changing chart type
Right-click in the chart, then on the shortcut menu, locate the Chart Type. From the drop-down
menu, select the desired chart type and its subtype.
Filtering component data
When creating or editing dashboards, you can filter component data using two types of web controls:
sliders or filter controls.
Filter controls allow you to pick one or more random values from a list and are used with categorical or
nominal variables. You can choose one or more values from anywhere in the list and there is no mean
or median value calculation possible such as States and Countries.
Sliders allow you to pick one or more sequential values from a list and are used for interval variables
such as dates, times, quantity and currency variables where the slider represents the scale from lowest
to highest value and the middle represents the median value.
Think about what you need and choose the proper filtering tool.
Filtering scenarios
Both sliders and filter controls have the same filtering mechanism.
Filtering based on one field is a common usage. Bind a field to a slider or filter control, and then based
on the field to filter the data of the components created from the same data source as the field.
Another special usage is to filter components using different data sources. Choose a common field all
the data sources contain and then bind a slider or filter control with the common field in all the data
sources, that is, in the insertion dialog, select the common field under the nodes of all the data
sources.
For example, there are two components containing data from different data sources, and you want to
filter their data using one filter tool. The precondition is that both components have the field you want
to filter. For example, you would like the two components to show the data of a specific country. In
order to do this, insert a slider or a filter control according to your requirement into the dashboard
body, then in the insertion dialog, select both the country fields from the two data sources (different
data sources may use different names for the country field, for example, data source 1 uses "Country",
data source 2 uses "P_Country", in this case, you need to select both "Country" and "P_Country"), then
from the Apply To drop-down list, select the two components you want to filter. The filter tool will be
inserted in the dashboard body, and you can see it lists country names which come from the two data
sources. In the filter tool select one or more countries, then the two target components will be filtered
and only display the data of these selected countries.
When you bind a slider or filter control with multiple different fields, be sure the list of values in each
field match so that when you select a value, such as Country, P_Country and S_Country, it will match
the appropriate country field in each component. The logic is the values are OR that is
Field1=SelectedValue1 or Field2=SelectedValue1 or Field3=SelectedValue1. Therefore, when Field1,
Field2 and Field3 are used in different components you will see the records correctly in each
component.
When you bind a slider or filter control with multiple different fields which do not contain the same list
of values such as Country, Region and Territory, at runtime after you select values in the slider or filter
control, the filter condition will use OR logic to apply the selected values to all the fields of the slider or
filter control, for example, Field1=SelectedValue1 or Field2=SelectedValue1 or Field3=SelectedValue1.
In this case, when there are three fields but the list of values in each field do not match, the result will
have no matching records for two of the components and therefore become blank components. We
recommend that you use three different filter tools in cases like this.
Using sliders
To insert a slider to the dashboard body:
1. Click Show Resources
on the side bar to display the Resources panel.
2. From the Toolbox node, drag Slider to the destination in the dashboard body. The Insert Slider
dialog appears.
3. In the Title text field, input a title for the slider.
4. Choose whether the slider is used to specify a range of values or just a single value.
5. From the resource list, select the fields of the same data type to bind to the slider.
To filter components created from the same data source, select a field in the data source.
To filter components created from different data sources via one slider, find a common field these
data sources contain, then select the field in each of the data sources.
6. By default, all the values of the selected fields will be available for the slider, which may be too
many for a slider. However you can customize the values to show. To do this,
a. Click the Customize button to display the Customize Value dialog.
b. Uncheck the Select All option. You can then customize the values.
■
To specify values one by one, click
to add a value line, then in the line to type a value
or select a value from the drop-down list. Repeat the operation to add more values. To
remove a value, select its line and then click the
■
button.
To specify the value range, specify a value in the From and To text boxes respectively.
c. For Date/Time/DateTime type fields, you can also specify a special function.
d. Click OK to save the customized values. The customized values will be available on the slider
for choosing.
7. The Apply To drop-down list provides the components involving the selected fields. Select the
components which you want to filter.
8. Click OK. A slider bound with the specified fields will be inserted in the dashboard body. You can
then specify values in the slider to filter the specified components.
Later if you want to modify the slider, click
on the title bar of the slider and then select Edit
Setting. The Edit Slider dialog will be displayed for you to bind different fields or customize the
field values.
Using filter controls
To insert a filter control to the dashboard body:
1. Click Show Resources
on the side bar to display the Resources panel.
2. From the Toolbox node, drag Filter Control to the destination in the dashboard body. The Insert
Filter Control dialog appears.
3. In the Title text field, input a title for the filter control.
4. From the resource list, select the fields of the same data type to bind to the filter control.
To filter components created from the same data source, select a field in the data source.
To filter components created from different data sources via one filter control, find a common field
these data sources contain, then select the field in each of the data sources.
5. The Apply To drop-down list provides the components involving the selected fields. Select the
components which you want to filter.
6. Click OK. A filter control bound with the specified fields will be inserted in the dashboard body.
You can then specify values in the filter control to filter the specified components.
Later if you want to modify the filter control, click
on the title bar of the filter control and then
select Edit Setting. The Edit Filter Control dialog will be displayed for you to bind different fields.
Filter control provides a quick search toolbar for easily locating the values you want. Click
field name bar to launch the quick search toolbar. The button
cancel the selection of values in the filter control.
Usage of the quick search toolbar
on the
on the field name bar is used to
●
●
●
Text field
Type in the text you want to search for in the text field and the matched text will be highlighted
among the field values.
X
Closes the quick search toolbar.
Lists the advanced options.
❍
❍
❍
●
●
Highlight All
Specifies whether to highlight all matched text.
Match Case
Specifies whether to search for text that meets the case of the typed text.
Match Whole Word
Specifies whether to search for text that matches a whole word and ignore partial word matches.
Highlights the previous matched text.
Highlights the next matched text.
Sharing parameters between library components
A dashboard can have multiple library components and all these components are independent from each other.
When several components contain parameters which have the same name and come from the same catalog and at
the same time contain exactly the same values, by default these parameters are regarded as separate parameters
each connected to its own component. To submit a value to all these components you need to submit the value to
all of the parameters. However by sharing the parameters you only need to provide a value for one of them as a
representative of all the parameters. You need then only submit values to this parameter and all the components
will use the specified values.
What parameters can be shared
JDashboard supports sharing two types of parameters coming from different library components in the same
dashboard:
The same parameters
The parameters with the same name and coming from the same catalog.
For example, a parameter @Category comes from the catalog A.cat, and in a dashboard it is used by two library
components LC1 and LC2. So in the dashboard they are two parameters marked as [email protected] and LC2.
@Category. These two parameters are the same parameter and only require the user to specify one value for them.
The same meaning parameters
The parameters that are not the same parameters but have the same parameter type and value data type. For
cascading parameters they should have the same hierarchies and each hierarchy have the same parameter value
type, then they can be shared as parameters with the same meaning even though the names are different.
For example, there are two parameters @Province and @State which have the same parameter type and value type
so they can both have the same meaning. For the cascading parameters like (@Country, @Province) and
(@Country, @State) which have the same hierarchies and each hierarchy has the same parameter value type so
they also can have the same meaning.
The rule for merging the values of the shared parameters
Within a sharing group, if all the shared parameters allows for type-in values, the merged value result is the union
of the values of all the parameters. The merged value names are distinct. However if any of the shared parameters
does not allow type-in values, the merged value result is the intersection of all the values.
Unexpected results after sharing parameters
Sometimes there may be unexpected parameter sharing that does no harm to the report system and report data,
but the dashboard result may be unexpected.
After sharing parameters, their values will be merged. The merged values result may be bigger or smaller than the
value lists of some of the shared parameters, which might lead to some values cannot be supported by some
components or some values can never be available to some components.
For example in the case of @Province and @State, if the parameters are shared then the list of values will be all
states and provinces. However, one library component may use a query that limits the data to US only, thus if the
user selects a Canadian province from the list the component will have no data.
How to share parameters
1. Click the Options button
on the side bar and then select Share Parameters from the option list. The
Share Parameters Setting dialog is displayed.
2. In the Share Parameters Setting dialog, select the parameters you would like to share by holding the Ctrl key.
If the selected parameters support being shared, the Share button will be enabled. Click the button. The
parameters will be added into one sharing group.
To add another parameter into a sharing group, select any parameter in the group while holding Ctrl and then
select the parameter, then click Share.
To remove parameters from a sharing group, select the parameters and then click Cancel Share which
appears in the place of the Share button.
3. Click OK to finish.
Related topics:
●
Specifying dashboard parameter values
●
Making use of the configuration panel (for specifying parameter values)
Saving dashboards
To save the changes you made to the current dashboard, click the Save button
button
on the side bar, or click the Options
and select Save from the option list.
If the dashboard is newly created and has not yet been saved, the Save As dialog will be displayed.
1. In the Save In section, browse to the folder where you want to save the dashboard in the server resource tree. You
can use the button
to return to the parent folder.
2. In the File Name box, enter the name of the dashboard or use the default name.
3. Click OK to save the dashboard.
To save a copy of a dashboard, click
dialog, and then do as above.
on the side bar and select Save As from the option list to show the Save As
After saving your dashboard into the server resource tree, you can browse to its directory on the JReport Console >
Resources page and run it directly just like you run a report.
To find a newly saved dashboard version, browse to select the row that the dashboard is in on the JReport Console >
Resources page, click Tools > Version on the task bar, the Dashboard Version panel will be displayed showing the
versions.
Note: You will not be able to save the dashboard to some locations if you do not have Write permission.
Exporting library components
Library components visible in the page panel can be exported, for example, library components that were created using JReport Designer and inserted
into dashboards via the Resources panel.
When exporting library component in a dashboard, you can choose in which layout you want the library components to be exported, system layout or
customized layout. In the system layout, JReport will calculate the positions of the library components in the dashboard following certain rule. If you are
not satisfied with the system layout, you can customize the layout by yourself to determine the position of each library component and specify whether
to export all the data of a table/crosstab or just the current page of the table/crosstab displayed in the dashboard. The customized layout can be saved
for all users who can access the dashboard.
To export using system layout:
1. Click the Export button
dialog is displayed.
on the side bar, or click the Options button
on the side bar and select Export from the option list. The Export
2. Select System Layout from the Layout drop-down list. The preview of the layout is displayed in the preview panel on the right. Sometimes you
may find that the layout is a little different from what you see in the dashboard.
3. In the Resources box, select the library components you are going to export. By default all exportable library components are listed and selected.
4. The order of the library components in the Resources box determines the order in which they will be exported. Click
exporting order if necessary.
and
to adjust the
5. Click the page navigation buttons on the toolbar of the preview panel to browse the pages if you want.
6. Click
to do the last setting and then export.
a. From the Export File Format drop-down list, specify the format for exporting the library components. For a format other than XML, all the
selected library components will be exported into one single file. For XML, each library component will be exported to a separate XML file.
When the exported result contains more than one file, all the files will be zipped.
b. In the File Name text field, specify a name to the exported result, which could be either a single file or a zipped package name.
c. Check Run Linked Report if you need to include linked report in the exported result file.
d. Click OK to start exporting.
To export using customized layout:
1. Click the Export button
dialog is displayed.
on the side bar, or click the Options button
on the side bar and select Export from the option list. The Export
2. Select Customize Layout from the Layout drop-down list. You can also select an existing customized layout to modify it.
3. To set the page properties, click the Page Setup button, then in the Page Setup dialog, specify the settings according to your requirement.
4. In the Design tab, customize the layout of the library components by making use of the following operations. The library components are arranged
using a tabular with each cell holding one component.
❍
Split or merge cells using the toolbar options:
❍
Drag and drop a library component from the Resources box into a blank cell in the Design tab. A cell can hold only one library component.
❍
Delete a library component from a tabular cell, by using the shortcut menu option Remove.
❍
,
, and
.
For a table or crosstab, only its current view of data as displayed in the dashboard will be exported by default. If you want its full data to be
exported, right-click on the table or crosstab and select Filter from the drop-down list. Then in the Filter dialog, switch from Current View to All
and click OK.
5. Click the View tab to preview the layout. You can browse the pages and zoom in/out by clicking the corresponding toolbar buttons.
If you are satisfied with the layout and want to save it for future use, click
or
on the toolbar, then in the Save As dialog, provide a name for
the layout and click OK. The saved custom layouts will be available in the Layout drop-down list to all users who can access the dashboard. For
each of them, you can edit its name or delete it using the two buttons - Rename and Delete - appearing on the right when the mouse hovers over
the layout item on the drop-down list.
6. Click
, then in the Export dialog, do the last setting and start exporting.
See also Export dialog for details about the options in the dialog.
Tip: If you just want to export a single library component, there is a more convenient way.
1. Click
on the title bar of the library component and select Export from the drop-down list. The Export dialog is displayed.
2. In the Export dialog, choose the format to which you want to export the library component, then click OK.
However, using this way, if the library component is linked with other reports, you cannot control whether to generate the linked reports while exporting.
The linked reports will not be included in the exported result for all time.
Printing library components
Library components visible in the page panel can be printed, for example, library components that were created using JReport Designer and inserted
into dashboards via the Resources panel.
When printing in JDashboard, you can choose in which layout you want the library components to be printed, system layout or customized layout. In
the system layout, JReport will calculate the positions of the library components in the dashboard following certain rule. If you are not satisfied with
the system layout, you can customize the layout by yourself to determine the position of each library component and specify whether to print all the
data of a table/crosstab or just the current page of the table/crosstab displayed in the dashboard. The customized layout can be saved for all users
who can access the dashboard.
To print using system layout:
1. Click the Print button
Print dialog is displayed.
on the JDashboard side bar, or click the Options button
on the side bar and select Print from the option list. The
2. Select System Layout from the Layout drop-down list. The preview of the layout is displayed in the preview panel on the right. Sometimes you
may find that the layout is a little different from what you see in the dashboard.
3. In the Resources box, select the library components you are going to print. By default all printable library components are listed and selected.
4. The order of the library components in the Resources box determines the order in which they will be printed. Click
printing order if necessary.
and
to adjust the
5. Click the Printer Properties button. In the Printer Properties dialog, configure the printer properties as required.
6. Click the page navigation buttons on the toolbar of the preview panel to browse the pages if you want.
7. When done, click
on the toolbar to start printing.
To print using customized layout:
1. Click the Print button
Print dialog is displayed.
on the JDashboard side bar, or click the Options button
on the side bar and select Print from the option list. The
2. Select Customize Layout from the Layout drop-down list. You can also select an existing customized layout to modify it.
3. Click the Printer Properties button. In the Printer Properties dialog, configure the printer properties as required.
4. To set the page properties, click the Page Setup button, then in the Page Setup dialog, specify the settings according to your requirement.
5. In the Design tab, customize the layout of the library components, then preview it in the View tab. For how to customize the layout, refer to
Exporting using customized layout.
6. When done, click
on the toolbar to start printing.
See also Print dialog for details about the options in the dialog.
Setting JDashboard as the server home page
Setting JDashboard as the JReport Server user console home page allows for a faster and easier access
to frequently visited dashboards with their latest data. The feature saves JDashboard status as the
contents of the home page, such as which dashboards are open and which dashboard is active. Then
you will be able to easily access the JDashboard with the saved status by one of the following ways:
●
●
Log onto the JReport Console page and you will be directed to the Home tab right away which
displays the JDashboard. The Home tab is available after you have set JDashboard as the server
home page.
Click the Home tab on the system toolbar of the JReport Console page to switch to the JDashboard.
To set JDashboard as the server home page:
1. In the JReport Console > Profile > Customize Server Preferences > General tab, set the option
Use JDashboard as Server User Console Home Page to Yes to enable setting JDashboard as server
home page.
2. In JDashboard, open the dashboards that you are going to view a lot and make sure they have
been saved. Focus on the dashboard you would like to see first once the JDashboard is loaded,
then click
on the side bar and you will see Set as Server Home is enabled on the menu list.
Click the option to set the current JDashboard status as the server home page.
In the same JDashboard window, you can set the home page at any time you want. The last time you
do this before exiting JDashboard will take effect.
To cancel setting the home page, in the JReport Console > Profile > Customize Server Preferences >
General tab, uncheck Yes for the option Use JDashboard as Server User Console Home Page.
Running and editing reports in JDashboard
In addition to running reports from the JReport Server user console page, JDashboard also provides an
entry for displaying reports directly from your application. When using JDashboard, you do not have to
switch to the server user console page in order to open a report and edit it.
Viewing a report in JDashboard launches its fully functional editor together with the report in a tab in
JDashboard. The tab name is the report name. When it is a page report, the corresponding page report
editor will be available, and for a web report, the web report editor will be available. With the report
editor, reports can be edited directly in JDashboard.
To open a report in JDashboard, click Show Resources
on the side bar to open the Resources
panel. Then in the Reports node, browse to the target report and drag it to the editing area, the report
will be loaded. If the report uses parameters, you will be asked to specify the parameter values first
before the report is displayed.
For how to edit a page report (.cls), refer to JReport Viewer - Interactive Reports. For how to edit a
web report (.wls), refer to Editing web reports in JReport Studio.
To close an open report, click x on the report tab or on the toolbar in the tab.
Publishing Resources
Before you can perform any tasks on JReport Server, you first need to have your resources (catalogs, reports, library components, and
folders) published and organized.
The JReport Server resource tree contains four built-in folders: My Components and Public Components are used to store library
components with catalogs, while My Reports and Public Reports store reports with catalogs.
Publishing resources from a local computer
You can publish these types of resources from a local computer. They are reports, library components, catalogs, and folders.
1. On the JReport Console > Resources page, browse to the folder in which to publish the resources, then click Publish > To Local
Server on the task bar of the Resources page.
The Publish to Local Server dialog is then displayed.
2. Select a type from the Resource Type drop-down list. Make sure that the resources exist in the resource real path.
3. Specify properties for the to-be-published resources as required.
❍
If the Page Report or Web Report resource type is selected:
1. In the From File text field, specify the report you want to publish with its full path.
2. In the Resource Node Name field, specify a name for the report. This name is required and is used as the display name of
the resource node in the server resource tree.
3. Type a brief description to describe the report in the Resource Description field.
4. From the Status drop-down list, select the status of the report.
5. Specify values of the custom fields for the report if there are custom fields.
6. Click the Browse button to specify a font directory for the report.
7. Click the Browse button to specify a style directory for the report.
8. Click the Browse button to specify a geographic information directory for the report.
❍
If the Component resource type is selected,
1. In the From File text field, specify the catalog you want to publish with its full path.
2. In the Resource Node Name field, specify a name for the library component. This name is required and is used as the display
name of the resource node in the server resource tree.
3. Type a brief description to describe the library component in the Resource Description field.
4. To enable getting resources from a real path, check the Enable Resources from Real Paths option, and then type a path
in the Resource Real Path box.
5. Specify the maximum number of versions to keep in the library component by inputting a number in the text box.
6. Click the Browse button to specify a font directory for the library component.
7. Click the Browse button to specify a style directory for the library component.
8. Click the Browse button to specify a geographic information directory for the library component.
❍
If the Catalog resource type is selected:
1. In the From File text field, specify the catalog you want to publish with its full path.
2. In the Resource Node Name field, specify a name for the catalog. This name is required and is used as the display name of
the resource node in the server resource tree.
3. Type a brief description to describe the catalog in the Resource Description field.
4. Specify values of the custom fields for the catalog if there are custom fields.
❍
If the Folder resource type is selected:
1. In the Resource Node Name field, specify a name for the folder. This name is required and is used as the display name of
the resource node in the server resource tree.
2. Type a brief description to describe the folder in the Resource Description field.
3. To enable getting resources from a real path, check the Enable Resources from Real Paths option, and then type a path
in the Resource Real Path box.
4. Specify values of the custom fields for the folder if there are custom fields.
❍
If the Folder with Contents resource type is selected:
1. Click the Browse button next to the From Folder text field to specify the folder where the resources you want to publish are
saved.
2. In the Resource Node Name field, specify a name for the folder. This name is required and is used as the display name of
the resource node in the server resource tree.
3. Type a brief description to describe the folder in the Resource Description field.
4. To enable getting resources from a real path, check the Enable Resources from Real Paths option, and then type a path
in the Resource Real Path box.
5. Specify values of the custom fields for the folder if there are custom fields.
6. Click the Browse button to specify a font directory for the resources.
7. Click the Browse button to specify a style directory for the resources.
8. Click the Browse button to specify a geographic information directory for the resources.
9. If you want to use Advanced Publish, click the Advanced Publish button. All resources contained within the specified folder
will then be displayed. Check the resources you want to publish and specify the properties for each resource as required.
❍
If the Catalogs, Reports and Folders in Folder or Catalogs and Reports in Folder resource type is selected:
1. Click the Browse button next to the From Folder text field to specify the folder where the resources you want to publish are
saved.
2. Click the Browse button to specify a font directory for the resources.
3. Click the Browse button to specify a style directory for the resources.
4. Click the Browse button to specify a geographic information directory for the resources.
5. If you want to use Advanced Publish, click the Advanced Publish button. All resources contained within the specified folder
will then be displayed. Check the resources you want to publish and specify the properties for each resource as required.
4. If the resources you specify to publish contain reports created in earlier versions, check Automatically Convert Old Report
Schemas, the reports will then be automatically converted into current version JReport reports when publishing finishes.
5. To apply an archive policy to the resources that you are publishing, check the Apply Archive Policy option, then specify the
archive policy as required: Archive as New Version or Replace Old Version.
Note that a folder by itself does not have versions; the archive policy specified for a folder applies to the folder contents.
6. If the resources are to be published to the Public Reports folder, click the Set Permissions link to specify user permissions to them
according to your requirement.
7. Click OK to start publishing the resources.
Note: The option is displayed only when you have the privilege of publishing resources and has logged onto JReport Server from a local
browser.
Publishing resources from a remote computer
You can publish three types of resources from a remote computer. They are reports, library components, catalogs, and folders. Before
they can be published you must create a zip file or tar file containing the resources to publish. If you want to publish resources from a
remote machine to the server, use Publish to Remote Server.
To publish resources from a remote computer:
1. On the JReport Console > Resources page, browse to the folder in which to publish the resources, then click Publish > To Remote
Server on the task bar of the Resources page.
The Publish to Remote Server dialog is then displayed.
2. Click the Browse button to specify the zipped file which contains the resources to publish.
3. Specify where the resources will be published.
❍
❍
If you want to publish the resources directly to the current open folder, check the Publish files and folders in the zipped file
to /XXX checkbox.
If you want to create a new folder in the current open folder to locate the resources,
a. Make sure the Publish files and folders in the zipped file to /XXX checkbox is not selected.
b. In the Resource Node Name box, specify the name for the folder. The name will then be used as the display name of the
resource node in the server resource tree.
c. Type a brief description to describe the folder in the Resource Description box.
d. Specify values of the custom fields for the folder if there are custom fields.
e. To enable getting resources from a real path, check the Enable Resources from Real Paths option, and then type a path
in the Resource Real Path box.
f. If the to be published resources are library components, specify the maximum number of versions to keep in the library
component by inputting a number in the text box.
4. If the resources you specify to publish contain reports created in earlier versions, check Automatically Convert Old Report
Schemas, the reports will then be automatically converted into current version JReport reports when publishing finishes.
5. To apply an archive policy to the resources, check the Apply Archive Policy option, then specify the archive policy as required:
Archive as New Version or Replace Old Version.
6. If the resources are to be published to the Public Reports folder, click the Set Permissions link to specify user permissions to them
according to your requirement.
7. If you want to use Advanced Publish, click the Advanced Publish button. All resources contained within the zip file will then be
displayed. Check the resources you want to publish and specify the properties for each resource as required.
8. Click OK to start publishing the resources.
Note: When publishing resources from a remote computer, the process is similar to that for a local publish. However, there are
differences. They are:
●
●
Local Publish publishes resources from the machine where the server runs, while a Remote Publish publishes resources from a client
machine using a web browser to the machine where the server runs.
The resource type of Remote Publish can ONLY be a compressed file. You should compress the report and catalog files in advance.
There are two approaches to building a compressed file.
❍
You can compress the resources manually using a third-party tool, such as Winzip and gzip.
❍
You can use jar.exe that the JSDK provides to build a compressed jar file directly. Use the command as follows:
%JAVAHOME%\bin\jar.exe -cvfM %DEST_JAR_FILE% %SOURCE_RESOURCES%
Parameter
Description
%JAVAHOME%
The Java SDK install root.
%DEST_JAR_FILE%
The destination file path and file name. The .jar file will be generated to the path you specify here,
using the file name you provide.
%SOURCE_RESOURCES%
The source file path and file name. Note that specifying a path for this parameter will cause the
generated jar file to contain the same path information. For example, when you extract a jar file
compressed using myReports\*.* for this parameter, the files will be extracted to a folder called
myReports. JReport Server is not able to import a compressed file which contains the path
information, so do not specify a path for this parameter.
To generate a jar file containing no path information, switch to the source folder, and then carry out the compression. For example,
C:\myReports>C:\jdk1.6.0_17\bin\jar -cvfM c:\temp\aa.jar.
The jar file will be generated to c:\temp, as aa.jar, compressing all the files in c:\myReports, and containing no path information.
Always use this method if the folder you are compressing contains reports with Chinese, Korean, or Japanese names.
Setting Resource and Folder Properties
The properties of a resource/folder, such as its resource node name, archive policy and the user
permissions on it (if the resource/folder locates in the Public Reports folder that can be accessed by
everyone), can be set according to your requirements.
To set the properties for a resource/folder:
1. On the JReport Console > Resources page, browse to row that the resource/folder is in.
2. Do either of the following:
❍
❍
❍
Select the resource/folder row and click Tools > Properties on the task bar of the Resources
page.
Select the resource/folder row, right-click in the row and select Properties from the shortcut
menu.
Put the mouse pointer over the resource/folder row and click the Properties button
floating toolbar.
on the
3. In the Properties dialog, specify the settings as required.
4. When done, click OK to accept the changes.
For details about the property settings, refer to the corresponding documents in the Dialog Reference
chapter.
Assigning permissions
Permissions, associated with resources and folders, are the rules granted to users which control their
access to resources and folders. Permissions in JReport Server include:
Permission
Description
Visible
Allows or denies viewing object names in the resource tree or version table, such as
folders, resources, and archive versions.
Read
Allows or denies viewing object properties, versions, and, if it is a folder, folder
contents.
Write
Allows or denies publishing folders and resources, changing the properties (not
including permission settings) of the objects in the resource tree or version table, such
as folders, resources, and archive versions, and modifying version table settings.
Execute
Allows or denies running reports in normal and Advanced mode (for report type
resources only) or running dashboards in the view mode (for dashboard type resources
only).
Edit
Allows or denies running dashboards in the edit mode (for dashboard type resources
only).
Schedule
Allows or denies submitting resources to schedules. Applies to report type resources
only.
Delete
Allows or denies deleting objects in the resource tree or version table, such as folders,
resources, and archive versions.
Grant
Allows or denies granting permissions to other users, groups or roles. Users, groups or
roles that have obtained the Grant permission are also endowed with the other seven
permissions, and can grant these seven permissions except the Grant permission itself.
Update
Status
Allows or denies updating report status, and if it is a folder, the status of reports in the
folder.
After you have set permissions for a parent folder, any new resources and sub folders created in that
folder will inherit the same permissions. If you do not want them to inherit these permissions, you can
enable their user permissions and set their permissions separately. Resources and folders will inherit
permissions from their parent folder if their user permissions are not enabled.
To set, view, change, or remove resource/folder permissions, in the Permissions tab of the Properties
dialog,
●
●
To set up or change permissions for a role, user or group, first check Enable Setting Permissions,
then select the role/user/group in the Selected box and check or uncheck the required permissions. If
the role/user/group is not listed in the Selected box, select the corresponding radio button below the
Available box, add the role/user/group to the Selected box and then assign the permissions
accordingly.
To remove resource/folder permissions for all users, groups and roles, uncheck the Enable Setting
Permissions option.
Notes:
●
●
●
●
●
Security permissions do not apply to the built-in version folders, the My Reports folder, and their
contents.
To complete a task, you may require more than one permission. For example, to view the properties
of a report, you must have both the Visible and Read permissions.
Some permissions depend on other permissions in order to work, such as Write, Execute, and
Schedule. Allowing anyone of these will also allow the Read permission.
Only members in the administrator role can assign the Grant permission to other users or groups or
roles.
Users that are given the Grant permission can grant permissions to other users in the same group.
Managing Tasks
Usually, a task is a set of operations you perform on JReport Server to achieve a goal, such as
publishing a folder, deleting a resource, and viewing resource properties. However, the tasks that the
JReport Server manages are those associated with report-running issues, the report-running tasks.
JReport Server allows you to quickly view a report result (Run), view a report result using selected
options and parameters (Advanced Run), and schedule a report to run unattended at a specific time or
periodically (Schedule). These are the fundamental modes that JReport Server uses to perform its
report-running tasks.
You can view the status of these report-running tasks, such as scheduled tasks that are waiting to be
performed by JReport Server, the tasks that are currently being performed, and the tasks that have
already been performed.
This section describes the following:
●
Accessing the task information tables
●
Managing tasks in the task tables
Accessing the task information tables
JReport Server collects task information and manages it in a set of tables.
Tasks that are scheduled
●
❍
❍
❍
Scheduled table
Shows the status information of scheduled tasks that are waiting to be performed, such as task ID,
whether the task is enabled, previous running time, and next running time.
Running table
Shows the status information of tasks that are currently being performed, such as task ID, time
when the task was started, and engine status.
Completed table
Shows the status information of tasks that have already been performed, such as task ID, time
when the task was completed, whether or not the task was successfully performed, result files, and
error messages.
Tasks that are performed in the Run, Advanced Run or Background Run mode
●
❍
Background Tasks table
Shows the status information of the tasks submitted using the Run, Advanced Run, or Background
Run mode, such as report tab names, report path and name, catalog path and name, running
format, time when the task was started/completed, time elapsed since the task was performed,
and the status of the task.
To access a specific table, on the JReport Console page, click My Tasks on the system toolbar, then
click the corresponding tab. The following shows the columns that are displayed in each table in detail.
Tips:
●
●
Some columns in the tables are not shown by default. To have them displayed, switch to the table,
click Tools > Preferences on the task bar of the My Tasks page, check the corresponding items in
the Preferences dialog, then click OK to save the settings.
You can make the records in each of the tables sorted ascendingly or descendingly by any column
title. To do this, just click on the underlined column title on which you want the records to be sorted,
you will then find a sort icon appear right after the title, showing the sort direction.
Scheduled table
The Scheduled table consists of the following columns:
Column
Description
Schedule Name
The name of the scheduled task.
Task ID
The internal ID for this task, which is a unique time stamp.
Report
The report path and name.
Report Tabs
The names of the report tabs.
Next Run Time
The next scheduled time for when this task is to be performed.
Last Run Time
The last scheduled time this task was performed.
Task Type
The type of task, such as Versioning System, File System, E-mail, or Printer.
Is Enabled
Shows whether this task is enabled. Can be Enabled or Disabled.
Is Successful
Shows whether or not the last running of this task was successfully performed.
The value true means that the last running was performed successfully and
false means the task failed. If the column is empty, the task has not been run
before.
Catalog
The catalog path and name that the report belongs to.
Launch Type
The way in which this task is executed, such as Repeatedly or One Time.
Requester
The user who submitted this task.
Running table
The Running table consists of the following columns:
Column
Description
Schedule Name
The name of the scheduled task.
Task ID
The internal ID for this task (a unique time stamp).
Report
The report path and name.
Report Tabs
The names of the report tabs.
Start Time
The time when this task was started.
Task Type
The type of the task, such as Versioning System, File System, E-mail, or Printer.
Catalog
The catalog path and name that the report belongs to.
Launch Type
The way in which this task is executed, such as Repeatedly, One Time, or
Instant.
Requester
The user who submitted this task.
Parameter File
The parameter file names and provides links to the parameters.
Parameters
The parameters according to the size specified.
Engine Status
The current status of the JReport engine, such as record fetching, grouping,
memory paging, and engine initializing.
Completed table
The Completed table consists of the following columns:
Column
Description
Schedule Name
The name of the scheduled task.
Task ID
The internal ID for this task (a unique time stamp).
Is Successful
Shows whether this task was successfully performed. The value true means that
the task was performed successfully and false that the task failed.
Report
The report path and name.
Report Tabs
The names of the report tabs.
Completed Time
The time when this task was completed.
Task Type
The type of task, such as Versioning System, File System, E-mail, or Printer.
Catalog
The catalog path and name that the report belongs to.
Launch Type
The way in which this task is executed, such as Repeatedly, One Time, or
Instant.
Requester
The user who submitted this task.
Parameter File
The parameter file names and provides links to the parameters.
Parameters
The parameters according to the size specified.
Engine Status
The status of JReport Engine when the task was completed, such as record
fetching, grouping, memory paging, and engine initializing. When a task fails to
perform, here you can see the status of the engine at the time of the error.
Error Message
The error message for when the task failed to perform.
Result Files
The report result files and provides links to the report result files.
Background Tasks table
The Background Tasks table consists of the following columns:
Column
Description
Report Tabs
The names of the report tabs.
Result
The result in certain format in which the report ran.
Report
The report path and name.
Start Time
The time when this task was started.
Finish Time
The time when this task was completed.
Status
The status of the task.
Catalog
The path and name of the catalog that the report belongs to.
Elapse Time
The time elapsed since the start of this task.
Catalog Version
Number
The version number of the catalog that the report belongs to.
Report Version
Number
The version number of the report.
Parameters
The parameters of the report.
Cancelled
Show whether the task is cancelled or not.
Managing tasks in the task tables
You can manage tasks in the task tables acccording to your requirements. For example, you can run a
scheduled task at once, or stop a running task from running.
Performing common tasks
Some task management operations are common to the task tables.
If you want to
Then do
Select a task
Click in the row that the task is in.
Select multiple tasks
Select the rows that the tasks are in while holding the Ctrl button.
Remove a task
●
●
●
Select the row the task is in and click Edit > Delete on the task
bar of the My Tasks page.
Select the row the task is in, right-click in the row and select
Delete from the shortcut menu.
Put the mouse pointer over the row the task is in and click the
Delete button
on the floating toolbar.
Managing tasks in the Scheduled table
If you want to
Then do
Create a new scheduled task
Click New Schedule on the task bar of the My Tasks page, then in the
New Schedule dialog, specify how to create the task: by selecting a
report or by importing a script file.
Run a task at once
●
●
●
Select the row the task is in and click Run on the task bar of the
My Tasks page.
Select the row the task is in, right-click in the row and select Run
from the shortcut menu.
Put the mouse pointer over the row the task is in and click the
Run button
Duplicate a task
●
●
●
on the floating toolbar.
Select the row the task is in and click Edit > Copy on the task bar
of the My Tasks page.
Select the row the task is in, right-click in the row and select Copy
from the shortcut menu.
Put the mouse pointer over the row the task is in and click the
Copy button
on the floating toolbar.
Enable a task
●
●
●
Select the row the task is in and click Edit > Enable on the task
bar of the My Tasks page.
Select the row the task is in, right-click in the row and select
Enable from the shortcut menu.
Put the mouse pointer over the row that the task is in and click the
Enable button
Disable a task
●
●
●
on the floating toolbar.
Select the row the task is in and click Edit > Disable on the task
bar of the My Tasks page.
Select the row the task is in, right-click in the row and select
Disable from the shortcut menu.
Put the mouse pointer over the row the task is in and click the
Disable button
on the floating toolbar.
The disabled task will not be performed until you enable it again.
Export a scheduled task to a
script on disk
See Importing and exporting scheduled tasks for details.
Import a scheduled task from See Importing and exporting scheduled tasks for details.
a script saved on disk
Notes:
●
●
You can perform the Run action on a disabled scheduled task.
When copying a disabled scheduled task or exporting it to script, the disabled state will not be
included since it is not a property of the task.
Managing tasks in the Running table
If you want to
Stop a task from running
Then do
●
●
●
Select the row the task is in and click Stop on the task bar of the
My Tasks page.
Select the row the task is in, right-click in the row and select Stop
from the shortcut menu.
Put the mouse pointer over the row the task is in and click the
Stop button
on the floating toolbar.
Note: When you stop a bursting task from running, some sub tasks in
the bursting task may have already been finished, so some results
may have been sent to some recipients.
View parameter information
Refer to the Parameters column of the Running table.
Managing tasks in the Completed table
If you want to
Then do
View detailed task running
information
●
●
●
●
Click the schedule name of the task.
Select the row the task is in and click Edit > Details on the task
bar of the My Tasks page.
Select the row the task is in, right-click in the row and select
Details from the shortcut menu.
Put the mouse pointer over the row the task is in and click the
Details button
View parameter information
on the floating toolbar.
Refer to the Parameters column of the Completed table.
Managing tasks in the Background Tasks table
If you want to
Stop a task submitted using
Background Run mode from
running
Then do
●
●
●
Select the row the task is in and click Edit > Stop on the task bar
of the My Tasks page.
Select the row the task is in, right-click in the row and select Stop
from the shortcut menu.
Put the mouse pointer over the row the task is in and click the
Stop button
Restart a stopped task
●
●
●
Select the row the task is in and click Edit > Restart on the task
bar of the My Tasks page.
Select the row the task is in, right-click in the row and select
Restart from the shortcut menu.
Put the mouse pointer over the row the task is in and click the
Restart button
View parameter information
on the floating toolbar.
on the floating toolbar.
Refer to the Parameters column of the Background Tasks table.
Managing Versions
Your resources might change over time. JReport Server uses a versioning system to create and
manage resources that have changed in content and properties owing to updates made to them.
All the resources in the server resource tree: reports, report results, dashboards, library components,
and catalogs, are controlled by versions. A great proportion of resource management tasks are carried
out by managing resource versions.
In addition, JReport Server uses an archive policy to control the resource versions. You can control
whether or not to use multiple versions for a specific resource. Also, you can define the maximum
number of versions that can be listed in the version table. The archive policy can be applied to a single
resource individually, or to many resources in a folder as a whole.
Pick a task from following:
●
Creating versions
●
Browsing versions
●
Applying an archive policy
●
Deleting versions
Creating versions
Generally, report result versions are created when you runs a report in Advanced Run or Schedule
mode. However, to create a new version for a report or catalog, you have to publish a report or catalog
respectively from outside of JReport Server, and then make the old and the new share one common
resource node. Versions of a dashboard are generated by saving the dashboard, and each saving action
will create a version in the dashboard.
Creating report or catalog versions
The method for creating a new version to a report or catalog is by publishing a resource of the same
type with exactly the same name to the same location on JReport Server. For how to publish, see
Publishing resources.
If you are publishing resources using JReport Server, you need to apply an archive policy so as to make
the published resources saved into the existing resources as a new version.
Note: Catalogs are by default not displayed in the server resource tree on the JReport Console page.
In order to perform operations on catalogs published from outside of JReport Server on the JReport
Console page, you need to enable them to be displayed first by setting the web.page.option.
show_catalog property to true in the server.properties file.
Creating report result versions
A report result version can only be created by advanced running the report or by scheduling the report
to publish it to the versioning system on the JReport Console page.
●
When advanced running a report, in the Archive tab of the Advanced Run dialog,
1. Specify where to save the result version by setting the Archive Location option.
■
■
To generate the report result version in the built-in folder, select Built-in Version Folder.
To generate report result version in a standalone resource node in the resource tree, select
The My Reports folder or The Public Reports folder, and then provide the path and
resource name information in the corresponding box.
2. Apply an archive policy to the version as required and submit the task.
Then, when the report finishes running, a report result version will be generated to the location
specified.
●
When scheduling a report to publish it to the versioning system, in the Publish > To Version tab of
the Schedule dialog
1. Specify where to save the result version by setting the Archive Location option.
■
■
To generate the report result version in the built-in folder, select Built-in Version Folder.
To generate report result version in a standalone resource node in the resource tree, select
The My Reports folder or The Public Reports folder, and then provide the path and
resource name information in the corresponding box.
2. Apply an archive policy to the version as required and submit the task.
Then, when the schedule task is finished, a report result version will be generated to the location
specified.
Creating dashboard versions
After a dashboard is saved into the server resource tree, you may want to update or modify it, and
then save the changes, which will add a new version in the dashboard.
Notes:
●
●
●
●
The resource path and name refers to the resource path and name in the resource tree. For
instance, /foldername/filename.
For The Public Reports folder option, the first slash mark (/) refers to the Public Reports folder in the
resource tree, and the folder name (foldername) refers to an existing folder in the resource tree.
For The My Reports folder option, the first slash mark (/) refers to the My Reports folder in the
resource tree, and the folder name (foldername) refers to an existing folder in the resource tree.
When generating report result versions in an existing standalone resource node in the resource tree,
for example, creating a new version for a resource node, you should make sure to provide the path
and name of the existing resource for The Public Reports folder or The My Reports folder option.
Browsing versions
To view the version information of a resource, on the JReport Console > Resources page, browse to the
resource, then do either of the following:
●
Select the resource row and click Tools > Version on the task bar of the Resources page.
●
Select the resource row, right-click in the row and select Version from the shortcut menu.
●
Put the mouse pointer over the resource row and click the Version command button
floating toolbar.
on the
The versions that a resource hosts are organized in the version table.
Version table
Relevant information about the versions that a resource hosts, such as the version date, version
number, is collected and represented in a table, called the version table.
The version table is composed of the following columns:
●
●
●
●
Catalog Versions Table
Column
Description
Last Modified
Shows the date and time of when the version was generated.
Version Number
Shows the serial ID that identifies a version in the version table.
Report Versions Table
Column
Description
Last Modified
Shows the date and time of when the version was generated.
NLS Editor
Administrators can edit NLS for a specified report version by clicking the
corresponding link.
Version Number
Shows the serial ID that identifies a version in the version table.
Report Result Versions Table
Column
Description
Results
Shows the output file formats and provides links to the output files.
Last Modified
Shows the date and time of when the version was generated.
Parameters
Shows the parameter file names and provides links to the parameters.
Creator
Shows the ID of the user who created the version.
Version Number
Shows the serial ID that identifies a version in the version table.
Dashboard Versions Table
Column
Description
Version Date
The date and time of when the version was generated.
Version Number
The serial ID that identifies a version in the version table.
You can perform operations such as sorting/viewing properties, and output files/parameters in the
version table.
Tip: Some columns in the tables are not shown by default. To have them displayed, locate the table,
click Preferences on the task bar, check the corresponding items in the Preferences dialog, then click
OK to save the settings.
Applying an archive policy
JReport Server uses an archive policy to control resource versions. The archive policy can be applied to
a single resource individually or to many resources in a folder as a whole. It can also be applied when
you run (Advanced Mode) or schedule a report.
The archive policy includes settings for controlling the use of multiple versions for a specified resource,
and the maximum version amount that will be listed in the version table:
●
●
Archive as New Version
Specifies whether to use multiple versions for the specified resource. Available only for resources in
the resource tree.
Maximum Number of Versions
Specifies the maximum number of versions that will be listed in the version table of the resource. By
default the number of versions is unlimited.
If there is no archive policy specified for a resource, the resource will inherit the archive policy from its
parent object. If afterwards you then specify an archive policy for the resource, the new policy will
override the one inherited from the parent object.
Applying an archive policy to resources in the resource tree
To apply an archive policy to a resource in the resource tree, refer to the table below:
If you
want to
Apply
archive
policy to a
folder
Then do
1. Access the Properties dialog for the folder (for how to
access the dialog, see Setting Resource and Folder
Properties).
2. In the dialog, set the Apply Archive Policy option as
required, then click OK.
Apply
archive
policy to a
resource
1. Access the Properties dialog for the resource.
2. In the Properties dialog, set the Apply Archive Policy
option as required, then click OK.
Result
The archive policy will be
applied to all of the
folder content.
Note: This does not
include resources that
already have individually
applied archive policies.
The archive policy is
applied to the resource,
overriding its inherited
archive policy.
Note: If you leave the
Apply Archive Policy
option unchecked, the
resource will inherit the
archive policy from its
parent object, for
example, the folder it
resides in.
Apply
archive
policy when
running a
task in
Advanced
mode
Apply
archive
policy when
scheduling
a task
1. On the JReport Console > Resources page, browse to
the resource you want to run.
2. Put the mouse pointer over the resource row and click
The archive policy will be
applied to a result type
resource.
Note: If you leave the
on the floating toolbar. Apply Archive Policy
option unchecked, the
3. In the Archive tab, check the Auto Archive Properties resource will use its old
option.
archive policy or inherit
the archive policy from
4. Finish the other relevant information, making sure that
its parent object, for
Archive Location is set to the resource tree folder.
example, the folder it
resides in.
5. Set the Apply Archive Policy option as required, and
then click Finish.
the Advanced Run button
1. On the JReport Console > Resources page, browse to
the resource you want to schedule.
2. Put the mouse pointer over the resource row and click
the Schedule button
on the floating toolbar.
3. In the Publish tab, click the To Version sub tab, then
check the Publish to Versioning System option.
4. Finish the other relevant information, making sure that
Archive Location is set to the resource tree folder.
5. Set the Apply Archive Policy option as required, then
click Finish.
The archive policy is
applied to a result type
resource.
Note: If you leave the
Apply Archive Policy
option unchecked, the
resource will use its old
archive policy or inherit
the archive policy from
its parent object, for
example, the folder it
resides in.
Applying an archive policy to the built-in version table
The above table applies to the resource in the resource tree only. The versions in the built-in version
folder are controlled by its own archive policy.
To apply an archive policy to the built-in version table, refer to the table below:
If you
want to
Apply
archive
policy to a
built-in
version table
Apply
archive
policy when
running a
task in
Advanced
mode
Then do
1. Access the version table for the resource (report type) (for how to access the table,
see Browsing versions).
2. In the Report Result Versions tab, check the Maximum Number of Versions
option, specify the versions to be saved as required, then click OK.
1. On the JReport Console > Resources page, browse to the resource you want to run.
2. Put the mouse pointer over the resource row and click the Advanced Run button
on the floating toolbar.
3. In the Archive tab, check the Auto Archive Properties option.
4. Finish the other relevant information, making sure that Archive Location is set to
the Built-in Version Folder.
5. Set the Apply Archive Policy option as required, then click Finish.
Apply
archive
policy when
scheduling
a task
1. On the JReport Console > Resources page, browse to the resource you want to
schedule.
2. Put the mouse pointer over the resource row and click the Schedule button
on the floating toolbar.
3. In the Publish tab, click the To Version sub tab, then check the Publish to
Versioning System option.
4. Finish the other relevant information, making sure that Archive Location is set to
Built-in Version Folder.
5. Set the Apply Archive Policy option as required, then click Finish.
Deleting versions
After creating versions, periodically you may want to delete some expired or unused versions. You can
choose to remove these versions manually or configure JReport Server to delete them automatically.
When removing the versions using the user interface, the archive versions stored on disk are also
physically deleted.
Deleting manually
To delete some versions of a resource manually:
1. Open the version table of the resource (for how to access the table, see Browsing versions).
2. In the version table, find the version you want to remove.
3. Do either of the following:
❍
Select the version row and click Edit > Delete on the task bar.
❍
Select the version row, right-click in the row and click Delete on the shortcut menu.
❍
Put the mouse pointer over the version row and click the Delete button
.
Then, after receiving "The version has been deleted" message, view the version information again. You
will find that the version you selected has now been removed from the version table.
Deleting automatically
There are two approaches to automatically deleting versions:
●
Apply Archive Policy
The Apply Archive Policy controls the number of versions that will be recorded in the version table of
a resource.
When creating a resource version, you can specify the maximum number that will be saved. If the
number of versions exceeds the specified number, the oldest version will automatically be removed
from the version list.
For example, if you specify Maximum Number of Versions as 5, when the sixth version is created, the
first version will automatically be removed.
●
Result Auto-delete
Result Auto-delete controls the duration of versions. It is only applicable to report result versions.
When creating a report result version, you can specify a certain period of time to keep the version.
The version will automatically be removed from the version list after the number of days or the
specified date.
For example, if you specify "Result Expires in 30 days", it will be automatically removed 30 days after
its creation.
Cached Report Bursting
Security in a report is a kind of privileged control. JReport supports cached report bursting which
creates a security mechanism for controlling access to the report. By defining which groups of data are
available to which users, groups, or roles, report results are created for each user, role and group.
When a user accesses the report result, JReport checks the user, group and role of the user and
merges the groups of data in the report the user is authorized to see and displays it to the user.
Cached report bursting is implemented with these security properties on the group panel: Cascade,
Grant, Groups, and Roles. The feature enables different users to view different data groups according
to their access privileges. It also applies to nested groups.
This chapter focuses on how to view and schedule a report with cached report bursting with JReport
Server.
Viewing a report with cached report bursting
Since the control of report access is not possible without a user ID, the significance of this function is
only apparent after reports have been published to JReport Server and other users access it.
When a client views a report with cached report bursting in JReport Server, the corresponding groups
will be displayed according to the security identifier. You can also advanced run reports with cached
report bursting in different formats, including DHTML, HTML, PDF, TEXT, Excel, PS, XML and Rich Text
Format (this feature does not support the RST and Applet formats).
To view a report with cached report bursting in JReport Server, the report must first be published to
the server from JReport Designer. For example, if in JReport Designer, the security for a report that is
grouped by the Customer_Region field has been set as below:
●
The user ID admin has the privilege to view the CA and MN groups of the report.
●
The user ID jennifer has the privilege to view the BC group of the report.
Then,
1. Access the JReport Console page via a web browser with the user ID admin.
2. Browse to the report that you are going to view.
3. Click the report name, and you will then be able to view the CA and MN groups of the report.
4. If you log onto JReport Server with the user ID jennifer, you will then only be able to view the BC
group.
Note: When designing the report in JReport Designer, if the Cascade property is set to be false, the
specified group will only display its group header and footer.
Scheduling a report with cached report bursting
You can schedule a report with cached report bursting as a normal report. However, there are some
differences between the formats in which the report is to be published.
Scheduling to HTML/DHTML to version
When you schedule a task to publish a report with cached report bursting to the HTML and/or DHTML
formats to the versioning system, the scheduled result depends on the mode which is controlled by the
property server.enable.cachedreportbursting in server.properties in <install_root>\bin:
●
When server.enable.cachedreportbursting=true as default, the scheduled result includes full data.
Then when end users view the result, they will be displayed the data they are privileged to see
according to the cached report bursting setting in the report. They can perform interactive actions on
the scheduled DHTML result as on other DHTML result, and the formulas, summaries and other
similar data will be recalculated based on the privileged data.
Note: If the report is cached report bursting and RLS/CLS mixed, then when other users other
than the user who did the scheduling view the scheduled HTML or DHTML result, a blank page is
displayed.
●
When server.enable.cachedreportbursting=false, the scheduled result only contains the data that the
user who did the scheduling is allowed to see.
Scheduling to e-mail
When you schedule a report with cached report bursting to publish it to e-mail, there is a slight
difference. JReport Server supports the Multiple Mail feature which enables sending the data results
directly to each user who is authorized to view the report.
Assuming that the catalog and the report have been published to JReport Server, and two users admin
and jennifer both have the permission to view the report. The following procedure shows how to
schedule a task on a report with cached report bursting to be published to e-mail.
1. Access the JReport Console page with user ID admin or jennifer.
2. Select the row that the report is in, then right-click in the row and select Schedule from the
shortcut menu to set up the schedule.
3. In the General tab, select the report tab with cached report bursting.
4. In the Publish tab, switch to the To E-mail sub tab and then check This report has Cached
Report Bursting. E-mail the report to each specified user.
5. Type the subject and select the result format, then click Finish.
JReport Server will get the e-mail addresses from the user accounts, and then send the report result to
admin and jennifer, with the contents in accord with their access right to the report.
Note: Before publishing to e-mail, you need to first make sure that the administrator has input the email addresses of the users when he creates the users on the JReport Administration page.
Scheduling to other formats
When scheduling a report with cached report bursting to other formats, the scheduled result only
contains the data that the user who does the schedule is allowed to see.
National Language Support
JReport products implement a National Language Support (NLS) feature, with which you can run
JReport Server, JReport Viewer, JReport Studio, JDashboard, reports, or dashboards in different
language environments.
If the NLS feature is enabled for a report when it is designed in JReport Designer, it will also be
available after the corresponding report has been published to JReport Server. Then, when the report is
run in the client/server scenario, different clients can select different languages for the rendering of the
report.
The following topics show how to use the NLS feature in JReport Server:
Previewing NLS reports
To preview an NLS report in a specified language, follow the steps below:
1. Publish the NLS report to JReport Server.
2. Start JReport Server and access the JReport Console page.
3. Click Profile on the system toolbar, then click Customize Server Preferences on the task bar of
the Profile page.
4. Select the Advanced tab, check Specify Default Language and choose a language from the
Language drop-down list.
5. Click OK to save the changes.
6. Browse to the report you want to preview.
7. Click the name of the report and the result will be displayed in the language you have specified.
Running NLS reports in Advanced mode
To run an NLS report in the Advanced mode, follow the steps below:
1. Publish the NLS report to JReport Server.
2. Start JReport Server and access the JReport Console page.
3. Browse to the report, put the mouse pointer over the report row and click the Advanced Run
button
on the floating toolbar.
4. In the Format tab, select the Enable NLS checkbox, then choose the language and region from
the Using Language and Region drop-down list.
5. Select the corresponding encoding from the Encoding drop-down list.
6. Finish the other related options and click Finish to run the report. The report result will then be
run in the selected language.
Scheduling NLS reports
To schedule an NLS report, follow the steps below:
1. Publish the NLS report to JReport Server.
2. Start JReport Server and access the JReport Console page.
3. Browse to the report, put the mouse pointer over the report row and click the Schedule button
on the floating toolbar.
4. In the General tab, select the Enable NLS checkbox, then choose the language and region from
the Using Language and Region drop-down list.
5. Select the corresponding encoding from the Encoding drop-down list.
6. Finish the other related options and click Finish to perform the task. The report result will then be
run in the selected language.
Dialog Reference
This chapter covers the dialogs that you will come across when using JReport Server, providing
descriptions and explanations of the options available. By referencing this chapter, you will find JReport
Server much easier and more convenient to use.
In this chapter, the following types of dialogs are covered:
●
JReport Server dialogs
●
JReport Viewer dialogs
●
JReport Studio dialogs
●
JDashboard dialogs
JReport Server dialogs
There are two classes of dialog in JReport Server. They are distinguished by the types of users who can
gain access to them. The JReport Console page dialogs are available to general users, while the JReport
Administration page dialogs are only accessible to users who have been assigned the administrator's
role.
The following are dialogs of the JReport Server, which are listed in alphabetic order:
●
Advanced Run dialog
●
Calendar dialog
●
Catalog Properties dialog
●
Dashboard Properties dialog
●
Encrypt dialog
●
Enter Parameter Values dialog
●
Enter Values dialog
●
Folder Properties dialog
●
Library Component Properties dialog
●
New Schedule dialog
●
Profile dialog
●
Publish to Local Server dialog
●
Publish to Remote Server dialog
●
Report Properties dialog
●
Result Properties dialog
●
Schedule dialog
●
Select Another Catalog dialog
●
Select Report Type dialog
●
Set Permissions dialog
●
Sign dialog
●
Specify Catalog dialog
Advanced Run dialog
To access the Advanced Run dialog, on the JReport Console > Resources page, browse to the report
you want to run in Advanced mode, then do either of the following:
●
●
●
Select the row the report is in, then on the task bar of the Resources page, click Run > Advanced
Run.
Select the report row, right-click in the row and select Advanced Run from the shortcut menu.
Put the mouse pointer over the report row and click the Advanced Run button
toolbar.
on the floating
There are four tabs in this dialog, which are listed below. You can set the settings to your requirements
in each tab.
●
General tab
●
Format tab
●
Archive tab
●
Duration tab
Back
Goes back to the left tab.
Next
Goes to the right tab.
Finish
Applies the settings.
Cancel
Closes the dialog and discards any changes.
Help
Displays this help document.
General tab
This tab allows you to specify the general information about a report.
Enter Parameters
Specifies the parameter values if any to run the report. If you are running a page report, you need to
select a specific report tab to run.
Select Report Tab
Specifies the page report tab which you want to run. Bursting reports are not listed in the table.
Parameters
Specifies values of the parameters applied in the report. If no parameter is used, "No Parameter
Needed" will be displayed here.
You may specify parameter values in these ways:
●
In the parameter value combo box, input the value manually or select the required one from the
drop-down list.
●
Click the button
●
Click the calendar button
●
if it is available to specify multiple values in the Enter Values dialog.
if it is available to set a date and time value in the Calendar dialog.
Check the Use Saved Values checkbox and select a previously saved parameter value list to apply
to the report.
The Use Saved Values option is available when Enable Saving Parameter Values is enabled and
Manually is checked in the Profile > Customize Server Preferences > Advanced tab. When Use Saved
Values is checked, a drop-down list that contains the lists of previously saved parameter values will
be displayed for you to choose one to apply. The button
delete a saved list from the list library.
next to the drop-down list is used to
Save Values
This link is available when Use Saved Values is checked. When it is clicked, the currently displayed
parameter values set for the specified report will be saved as a whole marked as a list for reuse next
time, and you need to provide a name for the list in the prompted dialog as required.
The parameter value lists saved for the report are limited. The maximum number is controlled by the
option Maximum Number of Auto Complete Parameters List in the Profile > Customize Server
Preferences > Advanced tab. By default it is 3. When the number of the saved parameter value lists
reaches the maximum number, if you want to save another parameter list, it will overwrite the oldest
one.
Report Information
Specifies other report information.
Report
Lists the report information.
Catalog
Lists the catalog information.
Select Another Catalog
Click to specify another catalog for the report in the Select Another Catalog dialog.
Report Version
Specifies the report version.
Catalog Version
Specifies the catalog version.
Priority
Specifies a priority level to the report running task. The priority levels are from 1 to 10 in ascending
order of lowest priority to highest priority. This property is available to administrators. By default this
property is ignored unless server.properties is modified to set queue.policy not equal to 0.
Format tab
This tab allows you to specify the format in which you would like to generate the report and set its corresponding settings.
Select Format section
Specifies the format of the report result.
Select Format
Specifies the format in which the report result will be. It can be one of the following:
●
Web Report
●
DHTML
●
HTML
●
PDF
●
Excel
●
Text
●
RTF
●
XML
●
PostScript
●
Applet
Advanced section
Specifies some advanced format settings.
Enable Style Group
When this option is disabled as default, use the style group property of the page report tab or web report for this format that is
predefined in JReport Designer to run the page report tab or web report.
When this option is enabled, you are allowed to select a style group from the Style Group drop-down list to run the page report tab
or web report in the format.
Enable Converting Encoding
Specifies whether to enable the conversion of encoding. If checked, the Before Converting and After Converting options will be
activated. Select the encoding from the drop-down lists as required.
Enable NLS
Specifies whether to enable NLS for the report. If checked, the Using Language drop-down list will be displayed for you to choose a
language.
Notes:
●
●
The Enable NLS option is available only when the National Language Support option is checked in the Properties dialog of the
report on the JReport Administration page.
If there is no NLS resource defined for the report, you can only run the report using the default language.
Encoding
Specifies the encoding for the report.
Connect to [Data Source Name]
Specifies the DB user and password with which you want to connect to the data source the report uses.
●
●
Use the DB user and password defined in catalog
If checked, the DB user and password defined in the catalog will be used.
Use the DB User
If checked, specify another DB user and password instead of the one defined in the catalog.
Add TaskListener to be Invoked
Specifies whether to enable the user to call the Java application before/after viewing. Enabled only when the format is not specified
to DHTML.
Web Report
Runs a web report in JReport Studio.
Resolution
Specifies the resolution of the result to zoom in/out, in DPI. The default value is obtained from the operation system, which is the
resolution of your monitor, for example, 72 DPI on Unix or 96 on Windows. You can set higher/lower value to zoom in/out.
DHTML
This format allows you to run your report to a DHTML result that can be viewed in a JReport Viewer window. Some reports cannot
be published to version in a DHTML result format, such as self-contained (CLX) reports, multi-level nested master and subreports,
reports containing data objects, and reports developed from a dynamic query or hierarchical data source (HDS).
Resolution
Specifies the resolution of the DHTML result to zoom in/out, in DPI. The default value is obtained from the operation system, which
is the resolution of your monitor, for example, 72 DPI on Unix or 96 on Windows. You can set higher/lower value to zoom in/out.
Profile
Specifies the DHTML profile to be applied to run the report, which contains a set of JReport Viewer settings.
Background Mode Timeout
Specifies the time after when the report will run in background mode. When a DHTML report runs and the results have not yet been
generated after the specified time, it will be automatically be switched to run in background mode.
HTML
No Margin
Removes the margins you originally set while designing the report.
Multiple Files
Generates the report result to multiple HTML files. JReport designates a serial number for each HTML page. For example, if you
named a 3-page report as "sales", JReport will create three files called sales_1.html, sales_2.html, and sales_3.html.
●
Embedded CSS
Specifies to embed the cascading style sheet (CSS) in the generated HTML files; otherwise, the .css file will be generated
individually.
Single File
Generates the report result to a single HTML file.
●
●
No Hyperlink
If checked, there will be no hyperlinks for navigating previous and next pages on the navigation bar of the generated HTML file.
No Page Number
If checked, there will be no page number information showing the current page number and total page number on the navigation
bar of the generated HTML file.
Drilldown
Generates the report result into an HTML file with the Drilldown feature enabled. The Drilldown feature enables you to inspect
certain items for further detailed data.
Section 508 Compliant Output
If checked, the accessibility attributes defined for the report elements via the Report Inspector will be generated to the HTML
format report result which is Section 508 compliant.
When Section 508 Compliant Output is checked, the Use HTML Data Table and Relative Font Size options will be checked and
disabled. The output will be Section 508 compliant including HTML data table, accessible attributes, and relative font feature.
Use HTML Data Table
Specifies whether the table and crosstab components will be output as table objects in the HTML result.
Absolute Font Size
Generates the report result using an absolute font size, which means that the font size is fixed, and cannot be adjusted according
to the font size settings in the web browser.
Relative Font Size
Generates the report result using a relative font size. The font size can be adjusted according to the font size settings in the web
browser.
Use Chart
●
●
Applet Chart
Uses a Java applet to display the charts in an HTML result file.
Image Chart
If selected, charts will be displayed as images. You can specify the image type from the drop-down list. The options are:
❍
auto select
If selected, the image format will be detected to JPG or GIF by the JReport system automatically. If the image colors are less
than 256 colors, GIF will be applied; otherwise, it is JPG.
❍
❍
❍
GIF
If selected, the GIF format will be applied, which is a lossless compression technique and supports only 256 colors. GIF is
better than JPG for images with only a few distinct colors, such as line drawings, black and white images and small text that is
only a few pixels high.
JPG (JPEG)
If selected, the JPG (JPEG) format will be applied, which is supported on the Web. JPG is a lossy compression technique that is
designed to compress color and grayscale continuous-tone images. JPG images support 16 million colors and are best suited
for photographs and complex graphics.
PNG
If selected, the PNG format will be applied, which provides a portable, legally unencumbered, well-compressed (effectively 100
percent lossless compression), well-specified standard for lossless bitmapped image file. PNG supports indexed-color images of
up to 256 colors and shows a more interchangeable, flexible and robust function than GIF.
Resolution
Specifies the resolution of the HTML result to zoom in/out, in DPI. The default value is obtained from the operation system, which is
the resolution of your monitor, for example, 72 DPI on Unix or 96 on Windows. You can set higher/lower value to zoom in/out.
Web Browser
Specifies the web browser for which the HTML result adapts.
Text Overflow
Specifies whether the text overflow is visible or hidden.
Run Linked Report
If the report is linked with other reports, you can check whether or not to generate the linked reports in the HTML result. If you are
only interested in the primary report, leave this option unchecked. Generating linked reports at the same time, especially when the
linked reports contain a large amount of data, will cause performance issue.
PDF
No Margin
Removes the margins you originally set while designing the report.
Compress Image
Compresses the images in the report by the percentage you specify in the box.
Generate charts and barcodes using images (recommended)
When you run a report in PDF format, JReport will take the result of the whole report as a graphic to transform the report by the
method of simulated printer and generate the report result in PDF format.
Generate charts and barcodes using vector graphics
The result of using Generate charts and barcodes using vector graphics is the same as with using Generate charts and barcodes
using images (recommended). However, when you run a report in PDF format using Generate charts and barcodes using vector
graphics, JReport will take the result of the whole report as a dataset to transform the report by sequence and to generate the
report result in PDF format.
TOC
Generates the report result to PDF format with a Table of Contents. Not supported for web report.
Drilldown
Generates the report result to a PDF file with the Drilldown feature enabled. The Drilldown feature enables you to inspect certain
items for further detailed data.
Encrypt
Specifies whether to encrypt the PDF file. If checked, click the Settings button to configure the encrypt settings in the Encrypt
dialog.
Sign
Specifies whether to add the digital sign to the PDF file. If checked, click the Settings button to configure the sign settings in the
Sign dialog.
Run Linked Report
If the report is linked with other reports, you can check whether or not to generate the linked reports in the PDF result. If you are
only interested in the primary report, leave this option unchecked. Generating linked reports at the same time, especially when the
linked reports contain a large amount of data, will cause performance issue.
Excel
Excel Version
Specifies the Excel version to be used.
●
●
Excel 97-2003 Workbook (*.xls)
Runs the file as .xls format.
Excel Workbook (*.xlsx)
Runs the file as .xlsx format.
Format
Specifies the format of the Excel result.
●
●
●
Report Format
If checked, JReport will attempt to make the formatting of the report in Excel match the format as designed in the template.
Usually this format is recommended if you just want to view the report in Excel.
Column Format
If checked, the calculation method used for all components' row/column values in the report will be decided by the Columned
property value of the report specified at report design time when exporting.
Data Format
If checked, only the report data will be generated without format. This option is only available for the Excel version Excel 972003 Workbook (*.xls).
More/Less Options
Click to show/hide the additional settings for running the report to Excel. When Data Format is selected, only Word Wrap is
available here.
●
●
●
●
Include Shapes in Export
Specifies whether to include the drawing objects in the Excel result, such as line, oval, and box.
Print Page Header
Specifies the page header text for the printed file.
Print Page Footer
Specifies the page footer text for the printed file.
Word Wrap
Specifies the word-wrap settings.
❍
❍
❍
●
●
All Keep Existing
Keeps all the settings of each object's Word Wrap property originally specified in the report.
All Disabled
Disables the Word Wrap property for all objects. That is, the Word Wrap property is made false for all objects.
All Enabled
Enables the Word Wrap property for all objects. That is, the Word Wrap property is made true for all objects.
Print Gridlines
Specifies whether to include gridlines when printing the Excel result.
Run Linked Report
If the report is linked with other reports, you can check whether or not to generate the linked reports in the Excel result. If you
are only interested in the primary report, leave this option unchecked. Generating linked reports at the same time, especially
when the linked reports contain a large amount of data, will cause performance issue.
Text
Delimited Format
Generates the report result to a standard Text file, using a delimiter you specify to separate the fields.
●
Use Quote Mark
Specifies to use quote marks in the Text file.
●
●
●
●
Repeat Last Column Value If Null
If checked, when a cell in the generated CSV Text file has no value, value of the previous cell in the same column will be used.
Customize Delimited
Fields in the generated Text file will be separated by a user defined delimiter. You can type your own delimiter in the Delimiter
box.
Tab Delimited
Specifies to use a Tab delimiter to separate the fields.
CSV Format
Exports to CSV format Text file.
Horizontal Density
Specifies the value for each unit of the horizontal density between columns. The resulting density is a direct ratio of the value you
specify. That is, the greater the value, the smaller the width between columns. By default the density will be specified by JReport.
Vertical Density
Specifies the value for each unit of the vertical density between columns. The resulting density is a direct ratio of the value you
specify. That is, the greater the value, the smaller the height between columns. By default the density will be specified by JReport.
Notes:
●
When using user defined densities, if the densities are not set appropriately, the fields in the report may overlap each other, so
you are not recommended to use this way to run the report result to Text.
When setting the value of Horizontal/Vertical Density, you need to pay attention to the following:
●
❍
❍
❍
❍
❍
The value of Horizontal/Vertical Density must be greater than the character's width/height of the smallest field in the report
(smallest field is the field with the smallest font size), otherwise, the value you set will not be applied.
If the value of Vertical Density is greater than 0 and the value of Horizontal Density is less than 0, the value that you specify
for the Vertical Density will be applied and the value of Horizontal Density will be specified by JReport.
If the value of Vertical Density is less than 0 and the value of Horizontal Density is greater than 0, the value that you specify
for the Horizontal Density will be applied and the value of Vertical Density will be specified by JReport.
If the values of Vertical Density and Horizontal Density are both greater than 0 and the value of Horizontal Density is less than
11, the specified value of the two densities will be applied. Otherwise, they will be specified by JReport.
If the values of Vertical Density and Horizontal Density are both less than 1, these densities will be specified by JReport.
Compress
Specifies whether to generate the report result to Text format in a compressed size, that is to say, there will be no clearance
between the columns.
Header and Footer
If checked, the Text file will contain all headers and footers in the report, including Report Header/Footer, Page Header/Footer and
Group Header/Footer. Otherwise, the Text file will only contain data in Detail panel.
Windows End-of-line (CR-LF)
Specifies to use Windows end-of-line characters to indicate the start of a new line. If checked, two characters <cr> and <lf> will be
used at the end of the line.
Unix End-of-line (LF)
Specifies to use Unix End-of-line characters to indicate the start of a new line. If checked, only the Unix End-of-line character <lf>
will be used.
Run Linked Report
If the report is linked with other reports, you can check whether or not to generate the linked reports in the Text result. If you are
only interested in the primary report, leave this option unchecked. Generating linked reports at the same time, especially when the
linked reports contain a large amount of data, will cause performance issue.
RTF
Best Editing
Specifies whether to apply flow layout for the RTF result.
No Margin
Removes the margins you originally set while designing the report.
Run Linked Report
If the report is linked with other reports, you can check whether or not to generate the linked reports in the RTF result. If you are
only interested in the primary report, leave this option unchecked. Generating linked reports at the same time, especially when the
linked reports contain a large amount of data, will cause performance issue.
XML
Only Data
●
●
If checked, the generated XML file will only contain the database column information. The generated XML schema file will only
contain the structure information of the report.
If unchecked, the generated XML file will also contain elements controlled by formulas, and the generated XML schema file will
contain all the detailed information from the report, including all the property values of each report object.
Schema File Name
Specifies the directory and the name of an existing XML schema (.xsd) file. If you specify an existing XML schema file, the
generated XML file will be based on it. Otherwise, a new XML schema file will be generated to the directory where the XML file is
generated. The new XML schema file and the XML file will have the same name but with different extensions.
Run Linked Report
If the report is linked with other reports, you can check whether or not to generate the linked reports in the XML result. If you are
only interested in the primary report, leave this option unchecked. Generating linked reports at the same time, especially when the
linked reports contain a large amount of data, will cause performance issue.
PostScript
No Margin
Removes the margins you originally set while designing the report.
Run Linked Report
If the report is linked with other reports, you can check whether or not to generate the linked reports in the PostScript result. If
you are only interested in the primary report, leave this option unchecked. Generating linked reports at the same time, especially
when the linked reports contain a large amount of data, will cause performance issue.
Applet
Pop-up Window
Specifies to show an Applet window when viewing a report.
Zip Result
Specifies to compress the result and its size would be smaller.
Java Plug-In 1.2 for Windows
Directs applets to run using Sun's Java Runtime Environment (JRE).
Java Plug-In 1.3 for Windows
Directs applets to run using Sun's Java Runtime Environment (JRE).
Run Linked Report
If the report is linked with other reports, you can check whether or not to generate the linked reports in the Applet result. If you
are only interested in the primary report, leave this option unchecked. Generating linked reports at the same time, especially when
the linked reports contain a large amount of data, will cause performance issue.
Notes:
●
You'd better specify a file destination when running a report via Applet, such as D:\folder\filename.pdf in case you may not find
the result. By default when running a report via Applet on Internet Explorer, the generated result will be located on the Desktop,
and when on Firefox, it will be in its installation root.
If you do not have read or write permission to the default location or the location you specified, you will get an access denied
error. To handle this, add the required permission in jdk\jre\lib\security\java.policy that the applet uses:
For the default location "Desktop":
permission java.util.PropertyPermission "user.dir", "read";
permission java.io.FilePermission "${user.home}${/}Desktop${/}*", "read,write";
For user defined location:
permission java.io.FilePermission "D:${/}temp${/}*", "read,write";
●
When advanced running a report to Applet on Firefox, after you select File > Open Result File on the Report Viewer, you may get
the access to the Open dialog denied error as follows:
java.security.AccessControlException: access denied (java.io.FilePermission Open read)
To resolve this, add the required permission in java.policy that the applet uses:
permission java.io.FilePermission "Open", "read,write";
Archive tab
Options below are available only when the view format is NOT set as DHTML or Studio in the Format tab.
Auto Archive Properties
Specifies to archive the result version automatically after the report has finished running.
Archive Location
Specifies the location in which to archive the report result version.
●
●
●
Built-in Version Folder
Specifies to save the report result version to the built-in version folder.
My Reports Folder
Specifies to save the report result version to the My Reports folder.
Public Reports Folder
Specifies to save the report result version to the Public Reports folder.
Input archive destination and result name
Specifies the name and location with which to archive the result.
Apply Archive Policy
Applies an archive policy to the report result version.
●
●
Archive as New Version
Specifies whether to use multiple versions for the specified resource. Available only for the resources in the resource tree. The
Maximum Number of Versions option specifies the maximum version amount that will be listed in the version table. By default the
version amount is unlimited.
Replace Old Version
Specifies to replace the old version when a new version is generated.
Result Auto-delete
Specifies the deleted date of the report result version. You should make sure to set the result version as deleted automatically within
one hundred years. If the time you specified exceeds one hundred years, JReport Server will keep the result forever.
●
●
Result Expires in N Days
Specifies a period after which the report result version will be automatically deleted.
Result Expires After
Specifies a certain day on which the report result version will be automatically deleted.
Set Permissions
Available only when the Archive Location is specified to be Public Reports Folder. Click the link to set user permissions to the specified
report in the Set Permissions dialog.
Duration tab
This tab is available only when you have enabled the task-level timeout mechanism either by setting the task.duration.enable
property to true in the server.properties file or by checking the Enable Task Duration option on the JReport Administration page
> Configuration > Advanced panel.
In this tab, you can specify a time duration for a task, and ask JReport Server to cancel the task or to notify you or someone
else of the task status via e-mail if the task has not yet finished running when the task duration is up.
The following are the available options:
Timeout
Specifies the time duration for the task.
Notify by e-mail after the specified time
Sends an e-mail about the task information when the specified time is up.
●
Mail To
Specifies the e-mail address of the recipient.
Cancel the task after the specified time
Cancels the running task when the specified time is up.
Calendar dialog
The dialog is displayed when you click the calendar button
while specifying values to a Date,
DateTime, or Time parameter which allows for type-in values. It helps you to create a date and time
parameter value using either calendar or expression.
The dialog is divided into two sections: the left section is a calendar for selecting date and time, the
right section is for editing an expression by using built-in formula functions. The expression has higher
priority than the value specified in the calendar. If you cannot see the expression settings, click >> at
the bottom left corner.
Calendar
Specifies the month, year, day and time from the calendar. The time setting is available to DateTime or
Time format parameters.
Use Today() as Default
This option is used to set the default selected date in the calendar. When it is checked, the calendar
always shows the current date when it is accessed. When this option is unchecked, the default is the
same as the value shown in the value input box beside the calendar button.
>>/<<
Displays or hides the expression settings.
Template
You can choose an existing expression template and then either use it directly or edit your expression
based on it. The Template text field does not support typing in, if you would like to create an
expression all by yourself, select the first blank row from the drop-down list.
Expression
Displays the expression. You can edit the expression directly in the text box.
Lists the built-in Date/Time formula functions. Single click to select a function and insert it into the
Expression text box.
Preview
Displays the value result based on the specified expression, or gives error information if the expression
is not correct.
OK
Sets either the value selected in the calendar or the expression as the parameter value. Expression has
higher priority.
Cancel
Does not retain any changes and closes the dialog.
Related topics:
●
Using built-in functions to set date and time parameter values
Catalog Properties dialog
You can set the properties of a specified catalog in its Properties dialog according to your requirements.
The Properties dialog is divided into the following two tabs:
●
General
●
Permission
OK
Retains the settings and submits the task to the server.
Reset
Discards your modifications and restores the dialog to its default status.
Cancel
Cancels any settings and closes the dialog.
Help
Displays this help document.
General tab
Specifies the general properties of the catalog.
Resource Path
Shows the resource path.
Resource Node Name
Specifies the name for the catalog.
Resource Type
Shows the type of the resource.
Resource Description
Specifies the description of the catalog.
[Custom Field Name]
Specifies value of the custom field for the catalog. A custom field can be regarded as a resource property and is available
when it is enabled.
Apply Archive Policy
Applies an archive policy to the catalog versions.
●
Archive as New Version
Specifies whether to use multiple versions for the catalog. Available only for versions in the resource tree.
❍
●
Maximum Number of Versions
Specifies the maximum number of versions that will be listed in the version table. By default the number of versions
is unlimited (0).
Replace Old Version
Specifies to replace the old version when a new version is generated.
Permission tab
Specifies permissions of roles/users/groups on the catalog. This tab is available when the catalog is in the Public Reports
folder.
Enable Setting Permissions
Enables the setting of permissions.
Available
Lists the roles/users/groups to which you can assign permissions.
●
●
●
Role
If checked, all roles will be displayed in the Available box for you to assign permissions.
User
If checked, all users will be displayed in the Available box for you to assign permissions.
Group
If checked, all groups will be displayed in the Available box for you to assign permissions.
Adds the selected role, user or group to the Selected box.
Removes the selected role, user or group from the Selected box.
Selected
Select a role/user/group in the Selected box and then select the permissions you would like the role/user/group to have
on the catalog. For what each permission is used for, see Permission.
Dashboard Properties dialog
You can set the properties of a dashboard in its Properties dialog according to your requirements.
The Properties dialog is divided into the following two tabs:
●
General
●
Permission
Reset
Discards your modifications and restores the dialog to its default status.
OK
Retains the settings and submits the task to server.
Cancel
Cancels any settings and closes the dialog.
Help
Displays this help document.
General tab
Specifies the general properties of the dashboard.
Resource Path
Shows the resource path.
Resource Node Name
Specifies the name for the dashboard.
Resource Type
Shows the type of the resource.
Resource Description
Specifies the description for the dashboard.
Apply Archive Policy
Applies an archive policy to the dashboard versions.
●
Archive as New Version
Specifies whether to use multiple versions for the dashboard. Available only for versions in the resource tree.
❍
●
Maximum Number of Versions
Specifies the maximum version amount that will be listed in the version table. By default the version amount is
unlimited.
Replace Old Version
Specifies to replace the old version when a new version is generated.
Permission tab
Specifies permissions of roles/users/groups on the dashboard. This tab is available when the dashboard is in the Public
Reports folder.
Enable Setting Permissions
Enables the setting of permissions.
Available
Lists the roles/users/groups to which you can assign permissions.
●
Role
If checked, all roles will be displayed in the Available box for you to assign permissions.
●
●
User
If checked, all users will be displayed in the Available box for you to assign permissions.
Group
If checked, all groups will be displayed in the Available box for you to assign permissions.
Adds the selected role, user or group to the Selected box.
Removes the selected role, user or group from the Selected box.
Selected
Select a role/user/group in the Selected box and then select the permissions you would like the role/user/group to have
on the dashboard. For what each permission is used for, see Permission.
Encrypt dialog
This dialog is opened when you click the Setting button next to the Encrypt option while configuring
settings for advanced running/publishing a report in PDF format.
The following are details about the options in the dialog:
Compatibility
Specifies the encryption type from the two types that are provided here in order to encrypt a PDF
document. The option Acrobat 3.0 and later uses a low encryption level (40-bit RC4), while the other
option Acrobat 5.0 and later uses a high encryption level (128-bit RC4).
Encryption Level
Shows the level of the encryption compatibility that you specified in the Compatibility drop-down list.
Require a password to open the document
Specifies the Document Open Password to prevent others from opening the document without
authorization.
●
●
Document Open Password
Specifies the password to prevent others from opening the document without authorization.
Confirm Password
Confirms the password you have specified in the Document Open Password text box.
Use a password to restrict printing and editing of the document and its security settings
Specifies the Permission Password to prevent others from printing and editing the document. The
password you specify here cannot be the same as the one that you use to open the document.
●
●
●
●
Permissions Password
Specifies the password to prevent others from printing and editing.
Confirm Password
Confirms the password you have specified in the Permissions Password text box.
Printing Allowed
Specifies the printing quality for the PDF document.
Changes Allowed
Specifies the editing actions that are permitted in the PDF document.
Enable copying of text, images and other content
Allows others to select and copy the contents of the PDF document.
Enable text access for screen reader devices for the visually impaired
Allows visually impaired users to read the PDF document with window readers. This option is available
only if the Compatibility option is set to Acrobat 5.0 or later Acrobat version.
OK
Saves the settings and exits the dialog.
Cancel
Cancels the settings and closes the dialog.
Help
Displays this help document.
Enter Parameter Values dialog
This dialog appears when you run a report with parameters. It allows to specify the parameter values
to run the report.
You may specify parameter values in these ways:
●
●
●
In the parameter value combo box, select the required one from the drop-down list or input the
value manually.
Click the chooser button
if it is available to specify multiple values in the Enter Values dialog.
Click the calendar button
if it is available to specify a date and time value using either calendar
or expression in the Calendar dialog.
●
Check the Use Saved Values checkbox and select a previously saved parameter value list to apply
to the report.
The Use Saved Values option is available when Enable Saving Parameter Values is enabled and
Manually is checked in the Profile > Customize Server Preferences > Advanced tab. When Use Saved
Values is checked, a drop-down list that contains the lists of previously saved parameter values will
be displayed for you to choose one to apply. The button
delete a saved list from the list library.
next to the drop-down list is used to
Save Values
This link is available when Use Saved Values is checked. When it is clicked, the currently displayed
parameter values set for the specified report will be saved as a whole marked as a list for reuse next
time, and you need to provide a name for the list in the prompted dialog as required.
If there are multiple report tabs in the report, the parameter values specified for all of the report tabs
are saved as a list.
The parameter value lists saved for the selected report tabs are limited. The maximum number is
controlled by the option Maximum Number of Auto Complete Parameters List in the Profile > Customize
Server Preferences > Advanced tab. By default it is 3. When the number of the saved parameter value
lists reaches the maximum number, if you want to save another parameter list, it will overwrite the
oldest one.
Reset
Resets the values to that as when the dialog was opened.
Submit
Closes this dialog and applies the specified values to run the report.
Cancel
Cancels running the report and closes this dialog.
Note: You are recommended not to use blank as the thousands separator in Number-typed parameter
values under French locale, otherwise your input will not be correctly recognized because of a JVM bug.
For details, see http://bugs.sun.com/view_bug.do;jsessionid=c8cdaf911b20fffffffffd9fc6340b30d670?
bug_id=4510618.
Enter Values dialog
The dialog is displayed when you click the button
to specify multiple values for a parameter.
while specifying parameter values. It helps you
Available Values
Lists all predefined parameter values for selection. When the parameter is bound with a column, but
the Display Column is different from the Bind Column, values of the Display Column are listed here.
Selected Values
Lists the values selected. The selected values are case sensitive.
Adds the selected values from the Available Values box to the Selected Values box.
Removes the selected values from the Selected Values box.
Adds all the selected values from the Available Values box to the Selected Values box.
Removes all the selected values from the Selected Values box.
Enter Values
This option is available when the parameter's Allow Type-in of Value property is set to true in JReport
Designer.
Enter a value manually in the text box and then click the button next to add the value to the Selected
Values box. When the parameter is bound with a column, but the display column is different from the
bind column, make sure the value you enter is that of the bind column.
Opens the Calendar dialog to specify a date and time value. Available only for Date, DateTime, or Time
parameter which allows for type-in values and is not bound with any column.
All
If selected, it means that the parameter value result is all the values in the DBMS. This option is
available when the parameter's Enable the "All" Option property is set to true in JReport Designer. This
is translated in SQL to remove the parameter which may select more values than listed in the available
values list.
For example, when the parameter query is:
SELECT CUSTOMERS.CUSTOMERID,CUSTOMERS.CUSTOMERNAME FROM CUSTOMERS where
CUSTOMERS.CUSTOMERID>0 and CUSTOMERS.CUSTOMERID<4
When you click
SQL is:
to add 1, 2 and 3 as the parameter values, which are all the available values, the
(CUSTOMERS.CUSTOMERID IN ( 1,2,3))
Run the same report again and this time check the All checkbox in the Enter Values dialog, the query is
then:
( 1 = 1)
In this case, you will get more customers even though available values are only 1 – 3.
Note: When a multi-value parameter is inserted as a field into a report and All is selected as the value,
the field will show the string "All". If the parameter allows type-in values, "All" means all possible
values of the parameter data type; if the parameter does not, "All" represents all the values of the
parameter that come from the DBMS.
OK
Applies the selected values to the parameter and closes the dialog.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
Folder Properties dialog
You can set the properties of a selected folder in its Properties dialog according to your requirements.
The Properties dialog is divided into the following two tabs:
●
General
●
Permission
OK
Retains the settings and submits the task to server.
Reset
Discards your modifications and restores the dialog to its default status.
Cancel
Cancels any settings and closes the dialog.
Help
Displays this help document.
General tab
Specifies the general properties of the folder.
Resource Path
Shows the resource path.
Resource Node Name
Specifies the name for the folder.
Resource Type
Shows the type of the resource.
Resource Description
Specifies description of the folder.
Resource Real Path
Specifies the real path of the folder.
Enable Resources from Real Paths
Specifies whether or not to enable getting resources from the folder real path. Once checked, it is required that you specify a
real path in the Resource Real Path field.
Note: This option can only be checked when the Enable Resources from Real Paths option in the Configuration > Advanced
panel on the JReport Administration page has also been checked by the administrator.
[Custom Field Name]
Specifies value of the custom field for the resource. A custom field can be regarded as a resource property and is available
when it is enabled.
Enable Linked Catalog
Enables to link the folder with a catalog.
If you have specified a linked catalog for the folder, then the reports and sub folders resided in the folder can inherit the linked
catalog from the folder once their Enable Linked Catalog property is enabled.
If this option is unchecked, the reports and sub folders resided in the folder cannot inherit linked catalog.
●
Use Specified
Links the folder with a catalog in the server resource tree.
❍
●
Select Another Catalog
Specifies another catalog in the Select Another Catalog dialog.
Use Inherited
Links the folder with the linked catalog inherited from its parent folder or from the server level if the folder is My Reports or
Public Reports. Note that if the parent level does not enable linked catalog, you are not allowed to check this option.
Apply Archive Policy
Applies an archive policy to resource versions in the folder.
●
Archive as New Version
Specifies to use multiple versions for the resources. Available only for versions in the resource tree.
❍
●
Maximum Number of Versions
Specifies the maximum version amount that will be listed in the version table. By default the version amount is unlimited.
Replace Old Version
Specifies to replace the old version when a new version is generated.
Permission tab
Specifies permissions of roles/users/groups on the folder. This tab is available when the folder is in the Public Reports folder.
Enable Setting Permissions
Enables the setting of permissions.
Available
Lists the roles/users/groups to which you can assign permissions.
●
●
●
Role
If checked, all roles will be displayed in the Available box for you to assign permissions.
User
If checked, all users will be displayed in the Available box for you to assign permissions.
Group
If checked, all groups will be displayed in the Available box for you to assign permissions.
Adds the selected role, user or group to the Selected box.
Removes the selected role, user or group from the Selected box.
Selected
Select a role/user/group in the Selected box and then select the permissions you would like the role/user/group to have on the
folder. For what each permission is used for, see Permission.
Library Component Properties dialog
You can set the properties of a library component in its Properties dialog according to your requirements.
The Properties dialog is divided into the following two tabs:
●
General
●
Permission
Reset
Discards your modifications and restores the dialog to its default status.
OK
Closes this dialog and applies the properties to the library component.
Cancel
Cancels any settings and closes the dialog.
Help
Displays this help document.
General tab
Specifies the general properties of the library component.
Resource Path
Shows the resource path.
Resource Node Name
Specifies the name for the library component.
Resource Type
Shows the type of the resource.
Resource Description
Specifies description of the library component.
[Custom Field Name]
Specifies value of the custom field for the library component. A custom field can be regarded as a resource property and
is available when it is enabled.
Enable Linked Catalog
Enables to link the library component with a catalog in a folder within the component library. If you have linked a library
component with a catalog, then even if the library component and the catalog are not in the same directory, it also can
be run with the catalog.
●
Use Specified
Links the library component with a catalog in the component library.
❍
●
Select Another Catalog
Specifies another catalog in the Select Another Catalog dialog.
Use Inherited
Links the library component with the linked catalog inherited from its parent folder. Note that if the parent level does
not enable linked catalog, you are not allowed to check this option.
Maximum Number of Versions
Specifies the maximum version amount that will be listed in the version table. By default the version amount is
unlimited.
Permission tab
Specifies permissions of roles/users/groups on the library component. This tab is available when the library component
is in the Public Components folder.
Enable Setting Permissions
Enables the setting of permissions.
Available
Lists the roles/users/groups to which you can assign permissions.
●
●
●
Role
If checked, all roles will be displayed in the Available box for you to assign permissions.
User
If checked, all users will be displayed in the Available box for you to assign permissions.
Group
If checked, all groups will be displayed in the Available box for you to assign permissions.
Adds the selected role, user or group to the Selected box.
Removes the selected role, user or group from the Selected box.
Selected
Select a role/user/group in the Selected box and then select the permissions you would like the role/user/group to have
on the library component. For what each permission is used for, see Permission.
New Schedule dialog
This dialog is opened when you click New Schedule on the task bar of the My Tasks page on the JReport
Condole page. It helps you to create a new schedule task.
Select Report to Create Schedule
Specifies to create the schedule task on an existing report.
●
●
●
●
Report in
Displays the folder path.
Select a Folder
Specifies the folder in which the report is.
Select a Catalog
Specifies the catalog file in which the report is.
Select a Report
Specifies the report on which the schedule task will be created.
Import Script to Create Schedule
Specifies to create the schedule task on an imported script file.
●
Select Script File
Specifies the script file on which the schedule task will be created. Click the Browse button to select the
script file.
OK
Creates the schedule task.
●
●
If you specify to create the schedule task on an existing report, when you click OK, the Schedule dialog
will be displayed. Specify the settings according to your requirement to finish the task.
If the schedule task is created on a script file, when you click OK, the Edit Script dialog will be displayed
for you to further edit the task information imported from the script file.
Cancel
Cancels the operations.
Help
Displays this help document.
Profile dialog
To access this dialog, click Profile on the system toolbar. The dialog contains three subjects:
●
Change Password
●
Customize Server Preferences
●
Customize Profile
Reset
Resets the settings without refreshing the web pages.
Restore Defaults
Uses the default settings.
OK
Submits any changes to JReport Server to allow the customizing of your web pages.
Cancel
Cancels the settings.
Help
Displays this help document.
Change Password
This panel allows you to change the password used for logging onto JReport Server.
Logged In User's Password
Specifies the password of the currently logged in user.
User ID
Displays the ID of the current user.
New Password
Specifies the new password.
Confirm New Password
Confirms the new password by typing in it again.
Customize Server Preferences
This panel allows you to customize your JReport Server web pages. It contains the following three tabs:
●
General
●
Export Formats
●
Advanced
General
Lists the general options for customizing the JReport Server web pages.
Default Format for Viewing Report
Specifies the default format for viewing reports.
If the property Default Format for Viewing Report of a report tab or a web report has been set to a specific format when the report is designed in JReport
Designer, the value in Designer has higher priority than the one here.
Default View for DHTML
Specifies the default mode for viewing page reports in JReport Viewer. You can choose between Basic View and Interactive View.
Default Mode for Studio
Specifies the default mode for viewing web reports in JReport Studio. You can choose between View Mode and Edit Mode.
Default Mode for Dashboard
Specifies the default mode for viewing dashboards in JDashboard. You can choose between View Mode and Edit Mode.
Pop-up DHTML Window
Specifies whether to show a DHTML window when you view a report in DHTML format.
Only Display CSS Styles in Style List
Specifies whether to display only the CSS styles in the style list.
Display the Last Login Time
Specifies whether to display the last login time of a user on the top banner of JReport Server. If checked, the login time will be recorded in the login.
properties file in <install_root>\bin after JReport Server shuts down.
Display the Last Logout Time
Specifies whether to display the last logout time of a user on the top banner of JReport Server. If checked, the logout time will be recorded in the logout.
properties file in <install_root>\bin after JReport Server shuts down.
Keep Completed Tasks for
Specifies for how many days JReport Server will keep the completed tasks in the Completed list. If the value is set to 0, the server will keep the completed
tasks until you delete them from the Completed page.
Parameter Display Size
Specifies the display length in characters of the parameters that are to be applied to both the completed and active schedules.
Folder Selector Type
Specifies the type of the tool used for selecting folder paths from the file system. This option is available on the Internet Explorer browser and applied to local
publishment only.
There are three types of folder selectors:
●
●
●
JavaScript format
Folder selector is a dialog generated by JavaScript.
VBScript format
Folder selector is a dialog generated by VBScript.
JSP format
Folder selector is an HTML page generated by JSP. This format is available to administrators only.
Skin Format
Specifies the skin format applied to JReport Server and JReport Viewer UI. You can choose from Standard, Classical and Windows XP.
Columns Shown in _ List
Specifies which columns will be displayed as default in the following list when you log onto JReport Server: Resources, Scheduled, Running, Completed,
Background Tasks, Report Result Versions, Report Versions, Catalog Versions, and Result Versions.
Use JDashboard as Server User Console Home Page
Specifies whether to enable dashboard users to set JDashboard status as the server home page, this provides much convenience when dashboard users need
to visit some dashboards a lot. See Setting JDashboard as the server home page for details.
Export Formats
Customizes the export formats.
●
JReport Result
Exports a report to a result file. Once this option is checked, the following option is available:
❍
Zip Result
Specifies whether to compress the result and make its size smaller.
●
DHTML
●
HTML
●
PDF
●
Excel
●
Text
●
RTF
●
XML
●
PostScript
●
Applet
Advanced
Lists the advance options for customizing the JReport Server web pages.
Enable Waiting Page
Specifies whether to show the waiting pages. This option is available only when the Profile dialog is accessed on the JReport Administration page.
Specify Default Language
Specifies an environment language for JReport Server. All UI text and messages will be displayed in the specified language. The available languages come
from the qualified language packages defined in <server_install_root>\resources\server\languages.
●
Reset All Users' Preference
Checking this option will reset all users' default language to the one specified here.
Specify Default Time Zone
Specifies the default time zone for JReport Server. All date on the server UI will then be displayed according to the specified time zone.
Specify Date Time Format
Specifies the default date and time formats in which such values will be displayed on the JReport Server web pages, for example, the last modified time of a
report, the time when a schedule take is finished.
Identify Server Preference
Specifies whether a task can be performed on a manually specified clustered server when scheduling a report. This option is available only in cluster
environment.
Use Accessible Version
Sets the accessible version of JReport Server as the default portal instead of JReport Console page. In the accessible version, reports are displayed in the
HTML format with accessibility attributes, and table/crosstab components are output as HTML data table. With the help of reader agent end users can
navigate through the server resource to view the target report.
Enable Saving Parameter Values
Enables saving parameter values for reuse next time when specifying parameter values in order to run reports.
For a report that has multiple parameters, the values of all the parameters specified at a time will be saved together as a group for the report. This group will
be available on the value list of each of those parameters next time when the same user is asked to specify parameter values for the same report. Selecting
the group from any of the parameters' value lists will apply the saved group of values to all the parameters. The group on the value list is a one-row values'
set: it lists the values of the parameters in one row with blank to separate between parameters and the values are in an order same as the display order of
the parameters.
When the Yes checkbox is selected, the following options are available. When switching between Manually and Automatically and OK is clicked, all saved
parameter values for the current user will be cleared.
●
●
●
Manually
If checked, it is up to users to manually save the parameter values they are going to reuse frequently and manage the saved values. Then in some places
where users are asked to specify parameter values, such as advanced running and scheduled running, the options for using saved parameter values, saving
the specified values and deleting saved values will be provided.
Automatically
If checked, JReport saves user submitted parameter values on a user-report or user-dashboard basis.
Maximum Number of Auto Complete Parameters List
When specifying parameter values in order to run or schedule to run a report, the specified parameter values for the report can be saved as a list. This
option is used to control the maximum number of the saved parameter value lists for the report. When the saved lists exceed the maximum number or if
you change the current number to a smaller one, the oldest lists will be removed.
Customize Profile
This panel allows you to customize JReport Viewer, JReport Studio, and JDashboard features according to your requirement. It contains three
tabs:
●
Common
●
DHTML
●
JDashboard
Common
This tab allows you to define the default date and time formats in which such values will be displayed on the JReport Viewer, JReport Studio and
JDashboard web pages.
Specify Date Time Format
Specifies the default date and time formats in which such values will be displayed on the JReport Viewer, JReport Studio and JDashboard web
pages, for example, the last modified time or print time of a report, the date values displayed in the query filter value list.
●
●
●
Date Format
Specifies the default format for the date values.
Time Format
Specifies the default format for the time values.
Timestamp Format
Specifies the default format for the timestamp values
DHTML
This tab allows you to customize DHTML features according to your requirement. It contains two sub tabs:
●
Features
●
Properties
Features
Administrators can define more than one DHTML feature profile on the JReport Administration page, then end users can select one of the
profiles to apply for running reports in JReport Viewer.
Default Profile
Specifies the profile which will be used as the default profile to run reports in JReport Viewer. End users can only select a profile and view its
settings.
Profile list
Lists the DHTML profiles that have been created.
●
●
●
Name
Displays the names of the profiles.
Description
Displays the descriptions of the profiles.
Last Modified
Displays the time when the profiles were last modified.
Properties
This tab lists properties for configuring the JReport Viewer settings. The properties are classified in two categories: default properties and
advanced properties. Some properties are not available when the Profile dialog is accessed on the JReport Console page.
Default properties
Specifies to show or hide certain DHTML window elements. Check the element names to show/hide them. If disabled, the specified window
element will not be shown by default. To show it, click the relevant window buttons or menu commands in JReport Viewer.
●
●
●
●
●
●
User Information Bar
Specifies to show the User Information bar. This bar is on the top of the JReport Viewer window which shows information about the user,
catalog, and report.
Toolbar
Specifies to show a default toolbar.
Table of Contents
Specifies to show the TOC Browser by default.
Resource View
Specifies to show the Resource View panel.
Toolbox
Specifies to show the Toolbox panel.
Right-click Menu
Specifies to show a shortcut menu when you click the right mouse button.
●
●
●
●
●
●
Pop Up New Window for Links
Specifies whether to display a new web browser window for the link target, which can be a link report, a detail report, a URL, a chart
hyperlink, or the detailed information created from the go-to-detail function. When defining such links in JReport Designer, if you have
specified Server Setting as the target frame of the links, this option will decide where the corresponding link targets will be displayed.
Editing Marks
Specifies whether to show editing marks (dashed outlines for objects and report body). If the option is unselected, the editing mark will not be
shown when a report object receives focus, and report objects cannot be moved or resized.
Pop Up Save Criteria Dialog
Specifies whether to pop up the Save Report Template dialog when you exit a report which has been changed since it was first opened in
JReport Viewer. A change includes any action taken such as sort, filter and drill as well as actual changes to the template such as adding or
removing objects. By default, this option is checked so the dialog will always pop up. If you uncheck this option, the dialog will not pop up
when changes have been made and all changes will be discarded. The next time the report is opened, it will be the previous version which
was last saved explicitly or the original published version. A second way to skip the pop up Save Report Template dialog is to create a profile
which does not have the Save option checked and assign the profile to the user or to the report, then when the user closes the report the
dialog will not be displayed and the changes will be discarded.
Save Filter Criteria
Specifies to check the Save Filter Criteria option by default when saving a report to a report version or as a new report.
Save Sort Criteria
Specifies to check the Save Sort Criteria option by default when saving a report to a report version or as a new report.
Switch Reports with Tab
Specifies to switch among report tabs in a report using tabs.
By default, this option is unchecked, which means that when a report contains several report tabs, you can use the Go To drop-down list on
the toolbar to switch among the report tabs. In addition, when this option is unchecked, the path for tracing the master/detail report
navigation as well as the drilling and going actions will also be reflected in the Go To drop-down list.
●
●
●
●
●
●
●
●
●
●
Show Master Report
Specifies whether to show the master report in the same window when opening a detail report by default. If checked, end users can go back
to the master report by clicking the master report name link. If unchecked, the master report will be closed after the detail report is opened.
Tool Tips on Toolbars
Specifies to show the tool tips for toolbar commands.
Always Prompt Query Filter
Specifies to prompt the Query Filter dialog when inserting the first field from the Resource View panel into a blank component.
Always Prompt to Convert Data Fields
Specifies to prompt the Convert Data Fields dialog when performing data analytic actions on reports, which are created in JReport Designer, in
JReport Viewer.
Mouse Wheel Turn to Page
Specifies whether to allow using the mouse wheel to scroll up/down reports.
Always Prompt Whether to Adjust Page Size Automatically
Specifies whether to prompt with a message box when JReport is going to adjust the page size if the width of a table exceeds the defined
page size.
Zoom
Specifies the zoom ratio at which DHTML pages will be displayed.
Max Records
Specifies the maximum number of records that will be retrieved by components in the report.
Browser Page Title
Specifies the title for the DHTML window (displayed on the DHTML window title bar).
Filter Menu
Specifies which items will be shown on the Filter submenu.
❍
❍
❍
❍
●
Remove Filter
Specifies to show the Remove Filter item on the Filter submenu.
Top N
Specifies to show the Top N item on the Filter submenu.
Bottom N
Specifies to show the Bottom N item on the Filter submenu.
More
Specifies to show the More item on the Filter submenu.
Grid
Specifies the grid properties.
❍
Show Grids
Specifies to show grids in JReport Viewer report area.
❍
❍
❍
●
Snap to Grids
Specifies to snap an object to grids when you move it by dragging and dropping in JReport Viewer report area.
Grid Size
Specifies size of the grids. The default value is 0.07 inches.
Grid Color
Specifies color of the grids. The default value is #808080.
New Ad Hoc Report
Specifies properties for creating reports in JReport Viewer. This section is available only when a JReport Live license for JReport Server is
obtained.
❍
❍
Report Layout
Specifies the default report layout when creating a report in JReport Viewer.
Report Style Group
Specifies the default selected style for the four types of components when creating them via the report wizard in JReport Viewer: table,
crosstab, chart, and banded object. However, when inserting them into a table or banded object which can bind style, the default style type
will be Inherit Style instead of the value specified by this option.
All CSS styles in the <install_root>\style directory are available in the drop-down list.
❍
Customize Group Indent
Specifies to customize the indent of groups created via the report wizard. By default, the indent of the groups is 0 inch. You can also input a
value between 0 and 4 to customize the indent.
If this option is not checked, when you create groups in a report in the report wizard, the groups will be indented according to the width of
the group by fields.
❍
Align Summaries Vertically
Specifies whether to make summaries aligned vertically, which are created via the report wizard and have the same summary function.
Views in DHTML
●
❍
Show Link of Basic/Interactive View
If checked, you will be able to switch between the Basic View mode and the Interactive View mode when running page reports in JReport
Viewer. The Basic View mode provides just simple functions for mainly viewing reports, while the Interactive View mode contains editing
and analytic functions.
Views in Studio
●
❍
Show Link of View/Edit Mode
If checked, you will be able to switch between the View Mode and Edit Mode when running web reports in JReport Studio. The View Mode
provides just simple functions for mainly viewing reports, while the Edit Mode provides editing and analytic functions.
Advanced Properties
Specifies to show or hide some advanced DHTML properties. Click on the property names to switch them on/off.
●
Advanced User
Specifies to enable DHTML advanced features, such as editing group and report properties from the shortcut menu. In JReport Viewer, some
features are only available for advanced users, including the following:
❍
❍
❍
❍
●
●
●
Advanced users can use a formula to control the value of a property. If a Boolean type property in a report is set to be controlled by a
formula, it will be displayed as a checkbox, with mixed value. This means that this option is currently controlled by a formula.
Editing group and report properties (can be accessed by using the Group and Report command on the shortcut menu).
Modifying the properties of images, special fields, and parameters (can be accessed by using the Properties command on the shortcut
menu).
Further options are available for advanced users, such as the options on the Export and Other tab.
Auto Refresh
Specifies whether to enable the Auto Refresh feature, which automatically refreshes the DHTML window at certain intervals, so as to make the
server session never time out when any JReport Viewer window is open. The auto refresh time interval equals user session time out minus 16
seconds.
Show Group by Name
Specifies whether to show the groups by name in the TOC panel.
Report Rendering Mode
Specifies a way of running and laying out a report as the DHTML format. There are in all four rendering modes controlled by the combination
of the two options: View Incomplete Pages and Format Page on Demand.
❍
View Incomplete Pages
■
■
❍
●
●
●
●
●
●
If selected, fetch data for the required page and then format the page. The contents of the displayed pages may be incomplete for lack of
data integrity and will then be refreshed when their data is ready. The first page will be displayed more quickly.
If unselected, fetch all data before formatting report pages. The displayed pages are complete.
Format Page on Demand
■
If selected, format the required pages. The total number of pages will not be known and will show as a + sign.
■
If unselected, format all report pages. This shows the total number of pages but will take longer to show the first page.
Lock Screen Timeout
Specifies the idle time before the DHTML window is locked.
Report Tab Timeout
Each open DHTML report tab is cached in the buffer. If the server has not received a request for a period of time from one DHTML report tab,
it will then release its memory automatically. The default value for this option is 10800 seconds.
Page Report Timeout
Each open DHTML report is cached in the buffer. If the server has not received a request for a period of time from one DHTML report, it will
release its memory automatically. The default value for this option is 10800 seconds.
Background Mode Timeout
Specifies the time allowed for a DHTML report to run in foreground mode. After the Background Mode Timeout has expired, the DHTML report
will automatically be switched to run in background mode. You can view the DHTML report result by clicking the report name in
the Background Tasks table of the My Tasks page on the JReport Console page, and after the result is opened in a browser, the report task in
the table will be deleted.
Maximum Number of Open Reports
Specifies the maximum number of DHTML reports that can be opened at the same time.
Select Catalog Linked Model
If checked, ad hoc end users can decide the relationship between the saved report and the catalog used to run it when saving a report to a
different directory in JReport Viewer: either link the saved report with the catalog, or copy the catalog to the target directory where the report
is saved.
The two items As Linked Catalog and As Catalog Copy just predefine which corresponding option will be automatically checked in the Save As
dialog of JReport Viewer.
●
●
Show Splash Screen
Specifies whether or not to show the splash screen, which is the JReport logo and displays when you open a DHTML report.
Check DHTML Resource Path
Checks the existence of static resources defined in the file ResourcePath.jsp.
JDashboard
This tab allows you to customize JDashboard features according to your requirement. It contains two sub tabs:
●
Features
●
Properties
Features
Administrators can define more than one JDashboard feature profile on the JReport Administration page, then end users can select one of the
profiles to apply for running dashboards in JDashboard.
Default Profile
Specifies the profile which will be used as the default profile to run JDashboard. End users can only select a profile and view its settings.
Profile list
Lists the profiles that have been created.
●
●
●
Name
Displays the names of the profiles.
Description
Displays the descriptions of the profiles.
Last Modified
Displays the time when the profiles were last modified.
Properties
This tab lists the properties for configuring the JDashboard window elements. The properties are classified for two working modes of
JDashboard: Edit Mode and View Mode.
Edit Mode
Specifies to show or hide certain JDashboard window elements for the edit mode. Select/unselect the element names to show/hide them. If
unselected, the specified window element will not be shown by default.
●
●
Show Toolbar
Shows the toolbar which contains the menu options for working with dashboards. By default the toolbar is located on the left side of the
JDashboard window.
Toolbar Icons
Specifies which options will be shown on the toolbar. The following options are enabled when Show Toolbar is selected.
❍
Show Resource
Shows the button
which is the entry to the Resources panel that provides library components, report components, and some other
objects for adding into dashboards.
❍
New
Creates a new dashboard.
❍
❍
❍
❍
❍
❍
❍
❍
Open
Specifies a dashboard to open.
Save
Saves the changes made to the current dashboard.
Refresh
Refreshes the current dashboard.
Enter Parameter Value
Lists all the parameters used in the dashboard for specifying their values.
Export
Exports the components in the current dashboard.
Print
Prints the components in the current dashboard.
Clear Filter
Removes all the filters from the current dashboard including those generated via sliders, filter controls, messages, drilling and going actions,
and those designed using web browsers such as JReport Viewer and JReport Studio, except query filters and others designed and taking
effect in JReport Designer.
Options
Shows the button
for displaying the items selected in the Options Menu section below.
Options Menu
●
on the toolbar of JDashboard. The following options are enabled when Show
Specifies the options available on the menu after clicking
Toolbar is selected and Options in the Toolbar Icons section is selected.
❍
❍
❍
❍
❍
❍
❍
❍
❍
❍
❍
❍
❍
❍
New
Creates a new dashboard.
Open
Specifies a dashboard to open.
Save
Saves the changes made to the current dashboard.
Save As
Saves the current dashboard with a different name or to a new location.
Export
Exports the components in the current dashboard.
Print
Prints the components in the current dashboard.
Clear Filter
Removes all the filters from the current dashboard including those generated via sliders, filter controls, messages, drilling and going actions
and those designed using web browsers such as JReport Viewer and JReport Studio, except query filters and others designed and taking
effect in JReport Designer.
Set as Server Home
Sets the current JDashboard status as the home page after logging onto JReport Server.
Component Title Bar
Customizes the way of showing component title bar and the icons on it.
Share Parameter
Shares parameters between library components.
Theme
Specifies a theme to apply to the current dashboard.
Hide Dashboard Header
Changes the current status of the dashboard header from being shown to hidden or from being hidden to shown.
Help
Displays the JDashboard help documents.
Exit
Exits JDashboard.
Theme
●
❍
Default Theme
Specifies the default theme applied to dashboards. This option is enabled when Themes in the Options Menu section is selected.
View Mode
Specifies to show or hide certain JDashboard window elements for the view mode. Select/unselect the element names to show/hide them.
●
●
Show Toolbar
Shows the toolbar which contains the menu options for working with dashboards. By default the toolbar is located on the left side of the
JDashboard window.
Toolbar Icons
Specifies which options will be shown on the toolbar. The following options are enabled when Show Toolbar is selected.
❍
❍
❍
❍
❍
❍
Refresh
Refreshes the current dashboard.
Enter Parameter Value
Lists all the parameters used in the dashboard for specifying their values.
Export
Exports the components in the current dashboard.
Print
Prints the components in the current dashboard.
Clear Filter
Removes all the filters from the current dashboard including those generated via sliders, filter controls, messages, drilling and going actions,
and those designed using web browsers such as JReport Viewer and JReport Studio, except query filters and others designed and taking
effect in JReport Designer.
Options
Shows the button
for displaying the items selected in the Options Menu section below.
Options Menu
●
on the toolbar of JDashboard. The following options are enabled when Show
Specifies the options available on the menu after clicking
Toolbar is selected and Options in the Toolbar Icons section is selected.
❍
❍
❍
❍
❍
❍
❍
❍
❍
●
Export
Exports the components in the current dashboard.
Print
Prints the components in the current dashboard.
Clear Filter
Removes all the filters from the current dashboard including those generated via sliders, filter controls, messages, drilling and going actions
and those designed using web browsers such as JReport Viewer and JReport Studio, except query filters and others designed and taking
effect in JReport Designer.
Set as Server Home
Sets the current JDashboard status as the home page after logging onto JReport Server.
Component Title Bar
Customizes the way of showing component title bar and the icons on it.
Theme
Specifies a theme to apply to the current dashboard.
Hide Dashboard Header
Changes the current status of the dashboard header from being shown to hidden or from being hidden to shown.
Help
Displays the JDashboard help documents.
Exit
Exits JDashboard.
Theme
❍
Default Theme
Specifies the default theme applied to dashboards. This option is enabled when Themes in the Options Menu section is selected.
Publish to Local Server dialog
The Publish to Local Server dialog guides you through the process of publishing resources to JReport Server locally.
Publish Local Resource to
Shows where the resource will be published to.
Resource Type
Specifies the type of the resource.
From Folder/From File
Specifies where to get the resource. Click the Browse button to specify the location.
Resource Node Name
Specifies the name of the resource. This name is required and is used as the display name of the resource in the server resource
tree.
Resource Description
Specifies the description of the resource (if necessary).
Status
Specifies the status of the report. If not specified, the status will be Active by default. This option is available for report type only.
●
●
●
Active
The report can be run, advanced run and scheduled on JReport Server.
Inactive
The report cannot be run, advanced run or scheduled on JReport Server.
Incomplete
The report is not completely designed and cannot be run, advanced run or scheduled JReport Server.
Resource Real Path
Specifies the real path of the folder. This option is available for folder type only.
Enable Resources from Real Paths
Specifies whether or not to enable getting resources from the folder real paths. This option is available for folder type only. Once
checked, it is required that you specify a real path in the Resource Real Path field.
Note: This option can only be checked when the Enable Resources from Real Paths option in the Configuration > Advanced panel
on the JReport Administration page has also been checked by the administrator.
[Custom Field Name]
Specifies value of the custom field for the resource. A custom field can be regarded as a resource property and is available when it
is enabled.
Automatically Convert Old Report Schema
Specifies whether or not JReport Server converts JReport reports of earlier versions into current version JReport reports when
publishing the earlier version reports.
Apply Archive Policy
Applies an archive policy to the report result version.
●
Archive as New Version
Specifies whether to use multiple versions for the selected resource. Available only for the resources in the resource tree.
❍
●
Maximum Number of Versions
Specifies the maximum version amount that will be listed in the version table. By default the version amount is unlimited.
Replace Old Version
Specifies to replace the old version when the new version is generated.
Set Permission
Available only when the resources are to be published to the Public Reports folder. Click the link to set user permissions to the
resources in the Set Permissions dialog.
Font Directory
Specifies the font directory of the resource. Click the Browse button to specify the directory. Note that only the font used by the
specified resource can be published.
Style Directory
Specifies the style directory of the resource. Click the Browse button to specify the directory.
Geographic Information Directory
Specifies the geographic information of the resources with reports or library components contained that have geographic
information. Click the Browse button to specify the directory.
Advanced Publish
Specifies to publish resources in an advanced way.
●
●
●
●
Checkbox
Specifies the resources you want to publish.
File Name
Displays the file name of the resource.
Resource Name
Specifies the name of the resource. This name is required and is used as the display name of the resource node in the server
resource tree.
Description
Specifies the description of the resource (if necessary).
●
●
[Custom Field Name]
Specifies value of the custom field for the resource.
Advanced
Specifies the advanced properties for the resource, which include the archive policy of the resource, and the user permissions on
the resource if the resource is to be published to the Public Reports folder.
OK
Retains the settings and submits the task to server.
Cancel
Cancels the operations.
Help
Displays this help document.
Publish to Remote Server dialog
The Publish to Remote Server dialog guides you through publishing resources to JReport Server remotely.
Publish Remote Resource to
Shows where the resource will be published.
From Zipped File
Specifies where to get the resource. Click the Browse button to specify the location.
Publish files and folders in the zipped file to /XXX
Specifies whether to publish files and folders in the zipped file to /XXX directly.
When this option is not checked, the following options are available, which specify properties of the new folder you want to
create in /XXX to locate the resources in the zip file.
●
●
●
●
Resource Node Name
Specifies the name of the resource node. This name is required and is used as the display name of the resource node in
the server resource tree.
Resource Description
Specifies the description of the folder (if necessary).
Resource Real Path
Specifies the real path of the folder.
Enable Resources from Real Paths
Specifies whether or not to enable getting resources from the folder real paths. Once checked, it is required that you
specify a real path in the Resource Real Path field.
Note: This option can only be checked when the Enable Resources from Real Paths option in the Configuration >
Advanced panel on the JReport Administration page has also been checked by the administrator.
●
[Custom Field Name]
Specifies value of the custom field for the folder. A custom field can be regarded as a resource property and is available
when it is enabled.
Automatically Convert Old Report Schema
Specifies whether or not JReport Server converts JReport reports of earlier versions into current version JReport reports
when publishing the earlier version reports.
Apply Archive Policy
Applies an archive policy to the resource result version.
●
Archive as New Version
Specifies whether to use multiple versions for the selected resource. Available only for the resources in the resource
tree.
❍
●
Maximum Number of Versions
Specifies the maximum version amount that will be listed in the version table. By default the version amount is
unlimited.
Replace Old Version
Specifies to replace the old version when a new version is generated.
Set Permissions
Available only when the resources are to be published to the Public Reports folder. Click the link to set user permissions to
the resources in the Set Permissions dialog.
Advanced Publish
Specifies to publish resources in an advanced way.
●
●
●
●
●
●
Checkbox
Specifies which resources in the zip file you want to publish.
File Name
Displays the file name of the resource.
Resource Name
Specifies the name of the resource. This name is required and is used as the display name of the resource node in the
server resource tree.
Description
Specifies the description of the resource (if necessary).
[Custom Field Name]
Specifies value of the custom field for the resource.
Advanced
Specifies the advanced properties for the resource, which include the archive policy of the resource, and the user
permissions on the resource if the resource is to be published to the Public Reports folder.
OK
Retains the settings and submits the task to server.
Cancel
Cancels operations.
Help
Displays this help document.
Report Properties dialog
You can set the properties of a specified report in its Properties dialog according to your requirements.
The Properties dialog is divided into the following two tabs:
●
General
●
Permission
OK
Retains the settings and submits the task to server.
Reset
Discards your modifications and restores the dialog to its default status.
Cancel
Cancels any settings and closes the dialog.
Help
Displays this help document.
General tab
Specifies the general properties of the report.
Resource Path
Shows the resource path.
Resource Node Name
Specifies the name for the report.
Resource Type
Shows the type of the resource.
Resource Description
Specifies the description for the report.
Status
Specifies the status of the report. If not specified, the status will be Active by default.
●
●
●
Active
The report can be run, advanced run and scheduled.
Inactive
The report cannot be run, advanced run or scheduled.
Incomplete
The report is not completely designed and cannot be run, advanced run or scheduled.
[Custom Field Name]
Specifies value of the custom field for the resource. A custom field can be regarded as a resource property and is available
when it is enabled.
Enable Linked Catalog
Enables to link the report with a catalog. If you have linked a report with a catalog, then even if the report and the catalog are
not in the same directory, it also can be run with the catalog.
When you background run, advanced run or schedule the report, the linked catalog is applied instead of the catalog that is
resided in the parent folder and originally used to run the report. For Advanced Run and Schedule, you can change the catalog
to apply another one using the Select Another Catalog option in the General tab of the corresponding dialog.
●
Use Specified
Links the report with a catalog in the server resource tree.
❍
●
Select Another Catalog
Specifies another catalog in the Select Another Catalog dialog.
Use Inherited
Links the report with the linked catalog inherited from its parent folder. Note that if the parent folder does not enable linked
catalog, you are not allowed to check this option.
Apply Archive Policy
Applies an archive policy to the report versions.
●
Archive as New Version
Specifies whether to use multiple versions for the report. Available only for versions in the resource tree.
❍
●
Maximum Number of Versions
Specifies the maximum version amount that will be listed in the version table. By default the version amount is unlimited.
Replace Old Version
Specifies to replace the old version when a new version is generated.
Permission tab
Specifies permissions of roles/users/groups on the report. This tab is available when the report is in the Public Reports folder.
Enable Setting Permissions
Enables the setting of permissions.
Available
Lists the roles/users/groups to which you can assign permissions.
●
●
●
Role
If checked, all roles will be displayed in the Available box for you to assign permissions.
User
If checked, all users will be displayed in the Available box for you to assign permissions.
Group
If checked, all groups will be displayed in the Available box for you to assign permissions.
Adds the selected role, user or group to the Selected box.
Removes the selected role, user or group from the Selected box.
Selected
Select a role/user/group in the Selected box and then select the permissions you would like the role/user/group to have on the
report. For what each permission is used for, see Permission.
Result Properties dialog
You can set the properties of a specified result in its Properties dialog according to your requirements.
The Properties dialog is divided into the following two tabs:
●
General
●
Permission
OK
Retains the settings and submits the task to server.
Reset
Discards your modifications and restores the dialog to its default status.
Cancel
Cancels any settings and closes the dialog.
Help
Displays this help document.
General tab
Specifies the general properties of the result.
Resource Path
Shows the resource path.
Resource Node Name
Specifies the name for the result.
Resource Type
Shows the type of the resource.
Resource Description
Specifies the description of the result.
[Custom Field Name]
Specifies value of the custom field for the resource. A custom field can be regarded as a resource property and is
available when it is enabled.
Apply Archive Policy
Applies an archive policy to the result versions.
●
Archive as New Version
Specifies whether to use multiple versions for the result. Available only for versions in the resource tree.
❍
●
Maximum Number of Versions
Specifies the maximum number of versions that will be listed in the version table. By default the number of versions
is unlimited (0).
Replace Old Version
Specifies to replace the old version when a new version is generated.
Permission tab
Specifies permissions of roles/users/groups on the result. This tab is available when the result is in the Public Reports
folder.
Enable Setting Permissions
Enables the setting of permissions.
Available
Lists the roles/users/groups to which you can assign permissions.
●
●
●
Role
If checked, all roles will be displayed in the Available box for you to assign permissions.
User
If checked, all users will be displayed in the Available box for you to assign permissions.
Group
If checked, all groups will be displayed in the Available box for you to assign permissions.
Adds the selected role, user or group to the Selected box.
Removes the selected role, user or group from the Selected box.
Selected
Select a role/user/group in the Selected box and then select the permissions you would like the role/user/group to have
on the result. For what each permission is used for, see Permission.
Schedule dialog
JReport Server allows you to schedule a report to run at a specific time and publish the report result to
different formats.
To access the Schedule dialog, on the JReport Console > Resources page, browse to the desired report,
then do either of the following:
●
Select the row the report is in, then on the task bar of the Resources page, click Run > Schedule.
●
Select the report row, right-click in the row and select Schedule from the shortcut menu.
●
Put the mouse pointer over the report row and click the Schedule button
on the floating toolbar.
This dialog contains five tabs as listed below. Set the settings in each tab according to your
requirements.
●
General tab
●
Publish tab
●
Conditions tab
●
Notification tab
●
Duration tab
Back
Goes back to the left tab.
Next
Goes to the right tab.
Finish
Applies the settings.
Cancel
Closes the dialog and discards any changes.
Help
Displays this help document.
General tab
Before you can schedule a task, you first need to configure the settings in this tab.
Schedule Name
Specifies the name for the currently scheduled task.
Priority
Specifies a priority level to the report running task. The priority levels are from 1 to 10 in ascending order of lowest priority
to highest priority. This property is available to administrators. By default this property is ignored unless server.properties is
modified to set queue.policy not equal to 0.
Enter Parameters
Specifies the parameter values if any to run the report. If you are running a page report, you need to select specific report
tabs to run.
Select Report Tabs
Specifies the page report tabs you schedule to run.
Select Bursting Reports
This option is available when there are bursting reports in the current report. Select the bursting report you schedule to run.
You can select only one bursting report at a time.
Once you choose to schedule to run a bursting report, you should at least either complete Bursting Configuration for the
report or select Non-bursting result in order to submit the task.
Bursting Configuration
●
Select Schema
Specifies the schema you want to apply to the selected bursting report. You can select multiple schemas to apply to the
report.
Non-bursting Result
If checked, the bursting definition will be removed from the report and the result will be generated based on whole data
without data splitting.
Parameters
Specifies values of the parameters applied in the report. If no parameter is used, "No Parameter Needed" will be displayed
here.
You may specify parameter values in the following ways:
●
In the parameter value combo box, input the value manually or select the required one from the drop-down list.
●
Click the button
●
Click the calendar button
●
Check the Use Saved Values checkbox and select a previously saved parameter value list to apply to the report.
if it is available to specify multiple values in the Enter Values dialog.
if it is available to set a date and time value in the Calendar dialog.
The Use Saved Values option is available when Enable Saving Parameter Values is enabled and Manually is checked in the
Profile > Customize Server Preferences > Advanced tab. When Use Saved Values is checked, a drop-down list that
contains the lists of previously saved parameter values will be displayed for you to choose one to apply. The button
next to the drop-down list is used to delete a saved list from the list library.
Save Values
This link is available when Use Saved Values is checked. When it is clicked, the currently displayed parameter values set for
the specified report will be saved as a whole marked as a list for reuse next time, and you need to provide a name for the
list in the prompted dialog as required.
If multiple report tabs are selected in this schedule task, the parameter values specified for all of the report tabs are saved
as a list. The next time only when these very report tabs are selected, can the list be available for apply after you select the
Use Saved Values checkbox.
The parameter value lists saved for the selected report tabs are limited. The maximum number is controlled by the option
Maximum Number of Auto Complete Parameters List in the Profile > Customize Server Preferences > Advanced tab. By
default it is 3. When the number of the saved parameter value lists reaches the maximum number, if you want to save
another parameter list, it will overwrite the oldest one.
Report Information
Specifies the report information.
Report
Lists information about the report.
Catalog
Lists the catalog information.
Select Another Catalog
Specifies another catalog for the report in the Select Another Catalog dialog.
Report Version
Specifies the report version when you schedule a task. The default version is always the latest version.
Catalog Version
Specifies the catalog version when you schedule a task. The default version is always the latest version.
Advanced
Configures some advanced settings.
Enable Style Group
When this option is disabled as default, use the style group properties of the selected report tabs or web report for
corresponding export formats that are predefined in JReport Designer to do the schedule. These predefined style group
properties take effect when publishing to version/disk/e-mail/FTP.
When this option is enabled, you are allowed to select a style group from the Style Group drop-down list to apply it to all the
selected report tabs or web report for all export formats. This setting will cancel all the style group properties of the selected
report tabs or web report for all export formats that are predefined in JReport Designer and replace them all with the value
specified here.
Enable Converting Encoding
Specifies to enable the conversion of encoding. From the Before Converting and After Converting drop-down lists, select
encodings as required.
Enable NLS
Specifies whether to enable NLS for the report. If checked, the Using Language drop-down list will be displayed for you to
choose a language.
Notes:
●
●
The Enable NLS option is available only when the National Language Support option is checked by the administrator in
the Properties dialog of the report on the JReport Administration page.
If there is no NLS resource defined for the report you can only run the report using the default language.
Encoding
Specifies the encoding of the report from the drop-down list.
Connect to [Data Source Name]
Specifies the DB user and password with which you want to connect to the data source the report uses.
●
●
Use the DB user and password defined in catalog
If checked, the DB user and password defined in the catalog will be used.
Use the DB User
If checked, specify another DB user and password instead of the one defined in the catalog.
Add TaskListener to be Invoked
Enables you to call the Java application before/after viewing or when scheduling the report.
Specify a preferred server to run the task
Enables you to directly specify a server in a cluster to perform the schedule task instead of using load balancing. This option
is available only when there are more than one active server in a cluster and when the Identify Server Preference option in
the Profile > Customize Server Preferences > Advanced tab is selected.
Enable Auto Recover Task
Specifies to enable the task to be auto recovered.
●
●
●
Maximum Retry Times
Specifies the maximum number of times in which to retry running the task in order to recover it.
Retry Interval
Specifies the interval between retries.
Recreate All Results
Specifies whether to recreate all or just the failed results when you published the task to multiple formats.
Publish tab
The Publish tab allows you to specify the type of the task. There are two main tasks to publish your
reports: Default Task and User Task. By default, Default task is used to publish the reports. To use the
User Task, click the User Task link in the Default Task page.
Default Task
If you select Default Task to publish your reports with, when specifying your task type, you can choose
from the following six sub tasks:
●
●
●
●
●
●
To Version
Publishes the report result to the versioning system.
To Disk
Publishes the report result to the file system.
To E-mail
Publishes the report result to e-mail.
To Printer
Publishes the report result to a printer.
To Fax
Publishes the report result to fax.
To FTP
Publishes the report result to an FTP site.
Note: If you are scheduling a bursting report, the Publish tab will change according to the bursting
setting made in the General tab of the Schedule dialog. For details about the change, see Report
bursting.
User Task
If you select User Task to publish your reports, you can implement a customized task with schedule
properties.
●
●
●
●
●
User Task Class Name
Specifies the class name for the user task.
Display Name
Specifies the display name for the user task.
User Task Properties
Specifies user task properties to define tasks.
Import User Task Properties from file
Imports a user task from a properties file.
Upload Properties
Uploads the properties to JReport Server. The properties will be listed in the User Task Properties
area.
To Version
This tab is for you to specify settings for publishing report results to the versioning system.
Publish to Versioning System
Specifies to publish the report result to the versioning system. You can publish the result to the following formats:
●
JReport Result
Publishes the report to a JReport result file.
❍
Zip Result
Specifies to compress the result to reduce the disk size and I/O; however, it uses more CPU resources.
❍
❍
●
Run Linked Report
If the report is linked with other reports, you can check whether or not to generate the linked reports in the JReport
result file. If you are only interested in the primary report, leave this option unchecked. Generating linked reports at
the same time, especially when the linked reports contain a large amount of data, will cause performance issue.
Precision Level
Specifies the precision level with which to publish the report result. Note that changing the default value may cause
abnormalities in report layout.
DHTML
Publishes the report to a DHTML result file (RSD file) that can be viewed in a JReport Viewer window. Some reports
cannot be published to version in the DHTML Result format, such as self-contained (CLX) reports, multi-level nested
master and subreports, reports containing data objects, and reports developed from a dynamic query or hierarchical
data source (HDS).
An RSD file is a middle result for DHTML that can preserve data and the working status of the DHTML report and can be
shared with others. Based on the RSD file, you can rebuild a DHTML report to analyze data and to export to other
formats. An RSD file is a standalone working file so all the useful information is added into it, such as catalog, report
template, NLS, data, parameters and security. The security information of an RSD file is the user of the generator that
creates it. When different users open the same RSD, they will get the same result based on the same security
configuration. You cannot refresh a report viewed from an RSD file to refetch data from the database. When the system
rebuilds a report according to the RSD file, it will only load data from the RSD file. When opening a report RSD, you
cannot go back to the actions which the RSD generator took before generating the RSD file but can take actions based
on the current RSD resources.
❍
❍
●
❍
❍
●
●
●
●
●
●
Precision Level
Specifies the precision level with which to publish the report result. Note that changing the default value may cause
abnormalities in report layout.
Web Report Result
Publishes the web report to a static web report result file (WST file). WST files can be exported to HTML, PDF, Text,
Excel, XML, RTF, and Postscript formats.
❍
●
Zip Result
Specifies to compress the result. The compressed file's suffix will still be .rsd, it's size will be smaller which reduces IO
and disk usage; however, it uses more CPU resources.
Zip Result
Specifies to compress the result to reduce the disk size and I/O; however, it uses more CPU resources.
Run Linked Report
If the report is linked with other reports, you can check whether or not to generate the linked reports in the WST file.
If you are only interested in the primary report, leave this option unchecked. Generating linked reports at the same
time, especially when the linked reports contain a large amount of data, will cause performance issue.
Precision Level
Specifies the precision level with which to publish the web report result. Note that changing the default value may
cause abnormalities in report layout.
HTML
Publishes the report result to the versioning system in HTML format.
PDF
Publishes the report result to the versioning system in PDF format.
Excel
Publishes the report result to the versioning system in Excel format.
Text
Publishes the report result to the versioning system in Text format.
RTF
Publishes the report result to the versioning system in RTF format.
XML
Publishes the report result to the versioning system in XML format.
PostScript
Publishes the report result to the versioning system in PostScript format.
Archive Location
Specifies the location for the saved report result version.
●
●
●
Built-in Version Folder
Specifies to save the report result version to the built-in version folder.
My Reports Folder
Specifies to save the report result version to the My Reports folder.
Public Reports Folder
Specifies to save the report result version to the Public Reports folder.
Apply Archive Policy
Applies an archive policy to the report result version.
●
●
Archive as New Version
Specifies whether to use multiple versions for the specified resource. Available only for resources in the resource tree.
The Maximum Number of Versions option specifies the maximum version number that will be listed in the version table.
By default number of versions is unlimited. When the number of versions is reached, the new version will replace the
oldest version in the resource tree.
Replace Old Version
Specifies to replace the old version when a new version is generated.
Result Auto-delete
Specifies the deleted date of the result. Set the result to be automatically deleted within one hundred years. If the time
you specify exceeds one hundred years, JReport Server will keep the report result forever.
●
●
Result Expires in N Days
Specifies a period after which the report result will be automatically deleted.
Result Expires After
Specifies a certain day on which the report result will be automatically deleted.
Set Permissions
Available only when the Archive Location is specified to be Public Reports Folder. Click the link to set user permissions to
the specified report tabs or web report in the Set Permissions dialog.
To Disk
This tab is for you to specify settings for publishing report results to the file system.
Publish to Disk
Specifies to publish the report result to the file system.
You can publish the report result to the following formats. For each format, you can decide whether to publish the
results to the server resource tree or to the server disk path. Then you need to type in the blank location field root
of the resource tree or disk path as shown in the examples below:
Example for server resource tree: /SampleReports/report1.rst
Example for server disk path: C:\temp\report1.rst
●
●
●
JReport Result
Publishes the report to a JReport result file (RST file).
DHTML
Publishes the report to a DHTML result file (RSD file) that can be viewed in a JReport Viewer window.
Web Report Result
Publishes the web report to a static web report result file (WST file).
●
●
●
●
●
●
●
HTML
Publishes the report result to the file system in HTML format.
PDF
Publishes the report result to the file system in PDF format.
Excel
Publishes the report result to the file system in Excel format.
Text
Publishes the report result to the file system in Text format.
RTF
Publishes the report result to the file system in RTF format.
XML
Publishes the report result to the file system in XML format.
PostScript
Publishes the report result to the file system in PostScript format.
Notes:
●
●
For the JReport Result and DHTML formats, you need only provide one file path because all selected report tabs
will be output into one file. For other formats, you need specify a file path for each selected report tab.
The files with the extension of .rsd should be opened with JReport Viewer (DHTML) and those with the extension
of .rst should be opened by JReport Server Viewer or Applet.
To E-mail
This tab is for you to specify settings for publishing the report results to e-mail.
Mail To
Lists the e-mail addresses you have sent mail to.
New
Creates a new e-mail.
●
From
Specifies your e-mail address.
Note:If you do not specify the address, the e-mail address specified by the administrator in the
Export > E-mail tab of the Configuration dialog on the JReport Administration page will be used as
the default address.
●
●
●
●
●
●
●
●
To
Specifies the address you want to send the e-mail to.
Cc
Specifies the address you want to copy to.
Bcc
Specifies the address you want to secretly copy to.
Subject
Specifies the subject of the e-mail.
Comments
Specifies the contents of the e-mail or comments to the contents.
Encoding
Specifies the encoding of the e-mail.
Compress Attachment as Java Archive
Specifies whether to compress the mail attachment as Java Archive.
SMTP Logon Information
Specifies the SMTP logon information.
❍
❍
❍
Account Name
Specifies the account name.
Password
Specifies the password of the account.
E-mail Address
Specifies the e-mail address of the account.
●
Note: This option can be enabled only when the option Server Requires Authentication is checked
by the administrator in the Export > E-mail tab of the Configuration dialog on the JReport
Administration page.
●
E-mail Result in HTML E-mail Format
Sends the report result via e-mail to the specified address in HTML format. The report result will be
shown in HTML format in the mail body.
❍
●
Run Linked Report
If the report is linked with other reports, you can check whether or not to generate the linked reports
in the HTML result. If you are only interested in the primary report, leave this option unchecked.
Generating linked reports at the same time, especially when the linked reports contain a large amount
of data, will cause performance issue.
E-mail Result in Plain Text E-mail Format
Sends the report result via e-mail to the specified address in plain text format. The report result will be
shown in plain text format in the mail body with no other information such as color, images and so on.
Notes:
❍
❍
The two formats, E-mail Result in HTML E-mail Format and E-mail Result in Plain Text Format,
cannot be support concurrently.
If you choose to send the mail in E-mail Result in HTML E-mail Format, the comments that you
input for the mail will be overwritten by the report result.
When you select one of the following formats, that is you want to send the report result as an attachment
file, you can specify a file name for the file by setting the File Name option.
●
●
●
●
●
●
●
●
●
●
●
Attachment in JReport Result Format
Sends the report result via e-mail to the specified address with a JReport result file as attachment.
Attachment in Web Report Result Format
Sends the web report result via e-mail to the specified address with a WST file as attachment.
Attachment in HTML Format
Sends the report result via e-mail to the specified address with an HTML file as attachment.
Attachment in PDF Format
Sends the report result via e-mail to the specified address with a PDF file as attachment.
Attachment in Excel Format
Sends the report result via e-mail to the specified address with an Excel file as attachment.
Attachment in Text Format
Sends the report result via e-mail to the specified address with a Text file as attachment.
Attachment in RTF Format
Sends the report result via e-mail to the specified address with a RTF file as attachment.
Attachment in XML Format
Sends the report result via e-mail to the specified address with an XML file as attachment.
Attachment in PostScript Format
Sends the report result via e-mail to the specified address with a PostScript file as attachment.
OK
Retains the settings and adds the e-mail address into the Mail To list.
Cancel
Cancels operations.
Edit
Edits the specified e-mail in the Mail To list.
Delete
Deletes the specified e-mail in the Mail To list.
To Printer
This tab is for you to specify settings for publishing report results to a printer.
Publish to Printer
Specifies to publish the report result to a printer.
Select Print Method
Specifies the printing method to print the report result.
Printer
Specifies the name with the path of the printer. You can type it in the box or select it from the drop-down list.
When JDK1.4 is selected in the Select Print Method option, the following options will be available.
Paper Size
Specifies the paper size.
Print Range
Specifies the pages to be printed.
Copies
Specifies the number of copies you want to print. The number of copies will be applied to all specified pages.
Print to File
Prints the document to a file instead of a printer. This kind of files can only be opened and printed by serial port printer
on Windows via DOS command.
●
File Name
Specifies the name of the file to which you print. If no path is provided in the file name, the file will be saved to the
working directory of the server.
Job Attributes
Specifies the properties of the print task.
●
●
●
Priority
Specifies the print priority for this task.
Job Name
Specifies the name of the print task.
User Name
Specifies the name of the user.
Orientation
Specifies the orientation for the printed reports.
●
●
●
●
Landscape
Prints your reports in a Landscape orientation.
Portrait
Prints your reports in a Standard letter orientation.
Reverse Landscape
Prints your reports in a Reverse Landscape orientation.
Reverse Portrait
Prints your reports in a Reverse Portrait orientation.
Color Appearance
Specifies to print the reports in Monochrome or in Color.
Print Quality
Specifies the print quality. It can be Draft, Normal, or High.
Print Sides
Specifies the print sides for the printed reports.
●
●
●
One Side
Imposes each consecutive print-stream page upon the same side of consecutive media sheets.
Duplex
Imposes each consecutive pair of print-stream pages upon the front and back sides of consecutive media sheets, such
that the orientation of each pair of print-stream pages on the medium is correct for the reader as if for binding on the
long edge.
Tumble
Imposes each consecutive pair of print-stream pages upon front and back sides of consecutive media sheets, such
that the orientation of each pair of print-stream pages on the medium is correct for the reader as if for binding on the
short edge.
Sheet collate
Specifies the printing order for printing multiple-page reports.
●
Collated
If selected, when you print two copies of a three-page report, the page order is 1, 2, 3; 1, 2, 3.
●
Uncollated
If selected, when you print two copies of a three-page report, the page order is 1, 1; 2, 2; 3, 3.
Margins
Specifies the paper margins for the printed reports (MM or Inch).
Media Tray
First select a printer, and then from the drop-down list, specify the media tray.
Note: JReport Server cannot obtain information on which options are supported and which are not from your printer
and reflect it on this tab. You should configure the setting according to your printer carefully.
To Fax
This tab is for you to specify settings for publishing report results to fax.
Note that before you can fax the report result, you must have your modem configured, otherwise a warning message will
be displayed.
Publish to Fax
Specifies to publish the report result to fax.
Quality
Specifies the quality of the fax: Best, Normal, and Fast.
Include Cover Sheet
Specifies to send a cover sheet with the fax.
The following items are displayed on the fax cover sheet.
To
Specifies the name of the recipient.
From
Specifies the name of the sender.
Company
Specifies the name of the company.
Date
Specifies the date on which the fax is to be sent. You can specify the date by clicking the calendar button
.
Fax Number
Specifies the fax number of the recipient.
Phone Number
Specifies the phone number of the sender.
Re
Specifies the subject of the fax.
Comments
Specifies the comments of the fax.
Urgent
Specifies whether the fax is urgent or not.
For Review
Specifies that the recipient only needs to view the fax.
Please Comment
Specifies that the recipient is required to comment on the content of the fax.
Please Reply
Indicates that a reply is required for the fax.
To FTP
This tab is for you to specify settings for sending report results to an FTP site.
FTP To
Lists the FTP sites you send report results to.
New
Creates a new FTP site.
●
●
FTP Site Name
A user-defined name of the FTP site. It is optional.
Host Address
The domain name or IP address of the FTP site. It cannot be null.
●
●
●
●
●
●
●
Port
The port of the FTP server. It is optional, and by default 21 is used for Standard FTP and Explicit FTPS, 22 SCP and SFTP,
and 990 for Implicit FTPS.
User Name
The user name is valid to the authentication of the FTP server that can access the FTP site. If not specified, "anonymous"
will be used as the user name by default.
Password
The password is valid to the authentication of the FTP server that enables the user name to access the FTP site.
Account
The account of the FTP user if there exists.
Folder Location
The location where to put the report result files on the FTP server. If not specified, the root path "/" of the FTP server will
be used by default.
Handler Class
A customized FTP-client handler class can be used instead of the one provided in JReport. You should specify a fullyqualified class name that is package name plus class name, for example, test.DemoJakartaFTPHandler.
Protocol Type
Specifies the protocol type used for publising the report results to FTP.
❍
❍
❍
❍
❍
●
FTP (Standard File Transfer Protocol)
Files are transferred in a non-secure (plain text) style.
SFTP using SSH2 (Secure Shell)
SFTP (Secure FTP) is a component of Secure Shell and is supported by most Unix servers running SSH2. Ask your
server administrator about availability.
SCP (Secure Copy)
This is a means of securely transferring computer files between a local and a remote host or between two remote
hosts, using the Secure Shell (SSH) protocol. If this type is selected, you will not be able to create folder to the FTP
server.
FTP with TLS/SSL (Explicit)
Explicit connection type of FTP security with TLS/SSL.
FTP with TLS/SSL (Implicit)
Implicit connection type of TP security with TLS/SSL.
Formats
Specifies in which formats to send the report result file to the FTP site. You can specify one or more formats. For each
format, you need to specify a name for the result file.
❍
❍
❍
❍
❍
❍
❍
❍
JReport Result
Sends the report result in a JReport result file to the specified FTP site.
Web Report Result
Sends the web report result in a WST file to the specified FTP site.
HTML
Sends the report result in an HTML file to the specified FTP site.
PDF
Sends the report result in a PDF file to the specified FTP site.
Excel
Sends the report result in an Excel file to the specified FTP site.
Text
Sends the report result in a Text file to the specified FTP site.
RTF
Sends the report result in a RTF file to the specified FTP site.
XML
Sends the report result in an XML file to the specified FTP site.
❍
●
●
●
PostScript
Sends the report result in a PostScript file to the specified FTP site.
Check Connection
Checks whether to be able to connect to the specified FTP location with the specified user account.
OK
Retains the settings and adds the FTP site into the FTP To list.
Cancel
Cancels the creation of the new FTP site.
Edit
Edits the specified FTP site in the FTP To list.
Delete
Deletes the specified FTP site from the FTP To list.
Conditions tab
The Conditions tab allows you to specify the conditions for the publishing tasks. It contains the following
two sub tabs:
●
Time tab
●
Trigger tab
Time tab
The Time tab allows you to set settings for specifying the time for when a task is to be performed.
Time Zone
Specifies the time zone.
Time Type
Specifies the time type of the task.
●
Run this task immediately
Performs the task as soon as you submit it.
●
Run this task at
Specifies the time for when the task is to be performed.
❍
Date
Specifies the date for when the task will be run. You can specify the date by clicking the calendar
button
❍
❍
●
.
Time
Specifies the time for when the task will be run.
Run missed task upon Server restart
Specifies to run missed tasks when you restart the server.
Run this task periodically
Specifies the time for when the task is to be performed on a repeated basis.
❍
Duration
■
■
❍
■
■
Daily
Performs the task every one day, two days, etc., or every weekday (from Monday to Friday).
Weekly
Performs the task every one week, two weeks, etc., and on Sunday, Monday, Tuesday, etc.
Monthly
Performs the task every one month, two months, etc., on the first day, second day, etc., or on the
first Sunday, Monday, etc., of the specified month.
Time
Specifies the exact time for when a task is to be performed on a selected day.
■
■
■
❍
Run until
Specifies the end date and time of the period during which the task is to be performed on a
repeated basis.
Date
■
❍
Run after
Specifies the start date and time of the period during which the task is to be performed on a
repeated basis.
At
Specifies a certain time for when to perform a task on a selected day.
Hourly
Performs the task every one hour, two hours, etc., at a certain minute on a selected day.
Minutely
Performs the task every one minute, two minutes, etc.
Run missed task upon server restart
Specifies to run missed tasks when you restart the server.
Trigger tab
The Trigger tab allows you to set settings for specifying a trigger for the publishing task.
Select a trigger to bind
Specifies the trigger from the drop-down list for the task.
Create New
Creates a new trigger.
●
●
●
●
●
Trigger Name
Specifies the name of the trigger.
Conflict Check
Checks if the name has been used for another trigger.
Description
Specifies the description of the trigger (if required).
OK
Creates the trigger with the specified information.
Cancel
Cancels the trigger creating process.
Logic with time condition
Specifies the logic between time condition and trigger condition.
●
●
Trigger Only
Performs the task only when the trigger fires.
Trigger and Time Condition
Performs the task when both time condition and trigger condition are ready.
Notes:
❍
No matter which condition is ready, the task can only be performed when its counterpart is ready.
❍
●
●
If you specify the task to be performed at a specific time, you must check the checkbox Run
missed task upon Server restart, otherwise the task will be regarded as expired and will be
deleted when the time condition is ready before the trigger condition.
Time Condition after Trigger
Performs a task when both the time condition and the trigger condition are ready. The trigger condition
must be ready before the time condition. If the time condition is ready before the trigger condition, the
task will be regarded as expired and will be deleted.
Time Condition or Trigger
Performs the task when either the time condition or the trigger condition is ready.
Notification tab
The Notification tab allows you to notify someone by e-mail when a task has finished running, regardless of
whether it was successful or unsuccessful.
When task is successful
Specifies to send an e-mail when the task is successful.
When task fails
Specifies to send an e-mail when the task is unsuccessful.
To
Specifies the address you want to send the e-mail to.
Cc
Specifies the address you want to copy to.
Bcc
Specifies the address you want to secretly copy to.
Subject
Specifies the subject of the e-mail.
Comments
Specifies the contents of the mail or comments to the contents.
Duration tab
This tab is available only when the task-level timeout mechanism has been enabled. To enable this, the
administrator must have set the task.duration.enable property to true in the server.properties file or checked
the Enable Task Duration option on the JReport Administration page > Configuration > Advanced panel.
In this tab, you can specify a time duration for a task, and ask JReport Server to cancel the task or to notify
you or someone else of the task status via e-mail if the task has not yet finished running when the task
duration is up.
The following are the available options:
Timeout
Specifies the time duration for the task.
Notify by e-mail after the specified time
Sends an e-mail about the task information when the specified time is up.
●
Mail To
Specifies the e-mail address of the recipient.
Cancel the task after the specified time
Cancels the running task when the specified time is up.
Select Another Catalog dialog
The Select Another Catalog dialog helps you to specify another catalog for the current report or folder.
Catalogs in
Specifies the root of the catalog, My Reports or Public Reports.
Select a Folder
Specifies the directory of the catalog.
Select a Catalog
Specifies the catalog from the drop-down list.
OK
Applies the settings.
Cancel
Cancels the settings.
Help
Displays this help document.
Select Report Type dialog
This dialog appears when you click New Report > Report on the task bar of the Resources page. It helps
you to choose a type for the report.
Web Report
Specifies to create a web report based on a business view.
●
Available Business View Data Sources
Displays all the available business views in the current catalog.
Page Report
Specifies to create an analysis report based on a business/report cube.
●
Available Report Cube Data Sources
Displays all the available business/report cubes in the current catalog.
OK
●
●
If Web Report is selected, when you click OK, the JReport Studio Wizard will be displayed for you to
create a web report.
If Page Report is selected, when you click OK, the New Page Report dialog will be displayed for you to
create an analysis report.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
Set Permissions dialog
This dialog helps you to assign permissions to roles, users, groups on specific resources or folders.
Enable Setting Permissions
Enables the setting of permissions.
Available
Lists the roles/users/groups to which you can assign permissions.
●
●
●
Role
If checked, all roles will be displayed in the Available box for you to assign permissions.
User
If checked, all users will be displayed in the Available box for you to assign permissions.
Group
If checked, all groups will be displayed in the Available box for you to assign permissions.
Adds the selected role, user or group to the Selected box.
Removes the selected role, user or group from the Selected box.
Selected
Select a role/user/group in the Selected box and then select the permissions you would like the role/user/group to have on the specific
resource or folder. For what each permission is used for, see Permission.
OK
Accepts the settings and closes the dialog.
Cancel
Cancel the settings.
Help
Displays this help document.
Sign dialog
This dialog is opened when you click the Setting button next to the Sign option while configuring settings for
advanced running/publishing a report in PDF format.
Method
Specifies the signing digital signature method from the three methods provided by Adobe Acrobat software.
Digital ID File
Specifies whether to use a digital ID file from a specified directory.
User Password
Specifies the password for this digital ID file.
Reason for Signing Document
Specifies the reason for signing the document.
Or Other Reason
Edits the reason for signing the document.
Location
Edits your location accordingly.
Your Contact Information
Edits your contact information accordingly.
OK
Saves the settings and exits the dialog.
Cancel
Cancels the settings and closes the dialog.
Help
Displays this help document.
Specify Catalog dialog
This dialog is displayed when you click Create Report on the JReport Server launch pad. It helps you to
specify the catalog which will be used to create the report.
Catalogs in
Specifies the resource directory in which the catalogs are located, My Reports or Public Reports.
Select a Folder
Specifies the folder in the selected resource directory that contains catalogs you can use to create an
ad hoc report.
Select a Catalog
Specifies the catalog you want to use to create the report.
OK
Applies the settings and opens the Select Report Type dialog.
Cancel
Cancels the settings and exits the dialog.
Help
Displays this help document.
JReport Viewer dialogs
While using JReport Viewer, you will go through the following dialogs. This section introduces each of
these dialogs in alphabetical order. You can go into the links for details.
●
Add Measure dialog
●
Aggregate On dialog
●
Apply Style dialog
●
Banded Object Properties dialog
●
Banded Panel Properties dialog
●
Banded Wizard
●
Bottom N dialog
●
Button Properties dialog
●
Chart Definition dialog
●
Chart Wizard
●
Conditional Formatting dialog
●
Convert Data Fields dialog
●
Crosstab Properties dialog
●
Crosstab Wizard
●
Customized Page dialog
●
Data Field Properties dialog
●
Edit Additional Value dialog
●
Edit Conditions dialog
●
Edit Measure dialog
●
Encoding dialog
●
Enter Values dialog
●
Export dialog
●
Filter Control Properties dialog
●
Filter dialog
●
Format Category(X) Axis dialog
●
Format Label dialog
●
Format Legend dialog
●
Format Paper dialog
●
Format Platform dialog
●
Format Value(Y) Axis dialog
●
Format Value(Y2) Axis dialog
●
Formula Editor dialog
●
Group Properties dialog
●
Image Properties dialog
●
Insert Detail Column dialog
●
Insert Filter Control dialog
●
Insert Group Column dialog
●
Insert Image dialog
●
Insert Parameter Control dialog
●
Insert Parameter Form Control dialog
●
Insert Summary Column dialog
●
Label Properties dialog
●
Max Records dialog
●
Multivalue Container Properties dialog
●
Navigation Control Properties dialog
●
New Page Report dialog
●
New Report Tab dialog
●
New Toolbar Name dialog
●
Open Report Tabs dialog
●
Options dialog
●
Order/Select N dialog
●
Page Properties dialog
●
Parameter Control Properties dialog
●
Parameter Field Properties dialog
●
Parameter Form Control Properties dialog
●
PDF Encrypt Option dialog
●
PDF Sign Option dialog
●
Printable Version dialog
●
Query Filter dialog
●
Rename Report Tab dialog
●
Report Body Properties dialog
●
Report Parameters dialog
●
Report Properties dialog
●
Save As dialog
●
Save Report Template dialog
●
Search dialog
●
Select Color dialog
●
Select Field dialog
●
Select Group Position dialog
●
Select Resource dialog
●
Select Values dialog
●
Sort dialog
●
Special Field Properties dialog
●
Split dialog
●
Table Cell Properties dialog
●
Table Properties dialog
●
Table Row Properties dialog
●
Table Wizard
●
Tabular Cell Properties dialog
●
Tabular Properties dialog
●
Text Box Properties dialog
●
Top N dialog
●
To Chart dialog
●
To Crosstab dialog
●
Turn to Page dialog
●
Zoom dialog
Note: The properties dialogs in JReport Viewer may be different for an advanced user and for a
common user. An advanced user can modify some properties that a common user cannot, and can use
formulas to control properties. The documents for properties dialogs here are based on advanced user.
If you want to become an advanced user, ask your administrator to enable the feature for you.
Add Measure dialog
This dialog helps you to create a dynamic measure object in a report.
Measure Name
Specifies the display name of the measure object.
Mapping Name
Click
to select a field or a formula on which the measure object is based in the Select Resource
dialog. Then the field with its parent nodes path will be displayed.
Aggregate Function
Specifies the aggregate function of the measure object. The function will be applied to the group where
the measure is placed or the entire report if the measure is placed in the report header or footer.
●
●
●
●
Count
This function computes the number of values referred to by the argument.
Sum
This function computes the sum of all the values referred to by the argument.
Average
The function is used to get the average value of the values referred to by the argument.
Maximum
This function returns the highest value referred to by the argument.
●
●
●
●
●
Minimum
This function returns the lowest value referred to by the argument.
DistinctCount
This function computes the number of distinct values referred to by the argument.
PopulationVariance
This function computes the population variance of the values referred to by the argument.
StdDev
This function computes the standard deviation of the values referred to by the argument.
Variance
This function computes the variance of all the values referred to by the argument.
OK
Creates the measure object and closes the dialog.
Cancel
Cancels the operation and closes the dialog.
Help
Displays this help document.
Aggregate On dialog
The dialog helps you to summarize data in the selected table detail column.
Aggregate On
Displays the field bound with the detail column. This field is also the one on which the summary is
based.
Function
Specifies the function to summarize the field in the detail column.
OK
Summarizes the detail column data with the specified function and closes the dialog.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
Apply Style dialog
This dialog helps you to set a style to the selected data component.
Style
Lists the styles applicable to the component.
●
Custom
There is no style information in this style and it is only used to handle reports created with previous
versions which did not bind any style or the bound style cannot be found in the style list.
Preview
Displays a diagram illustrating the effect of the selected style on the component.
Inherit Style
Specifies to take the style of the parent component. The option is available only when the banded
object, table, crosstab, or chart is contained in a banded object (for a chart, in a table also).
OK
Accepts all changes and closes the dialog.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
Banded Object Properties dialog
This dialog helps you to edit the properties of a banded object. It contains the following tabs:
●
General tab
●
Border tab
●
Others tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the banded object.
Name
Specifies the display name of the banded object, which will be shown on the shortcut menu of the
banded object.
Position
Displays the position mode of the banded object. If the banded object is directly contained in the report
body, a tabular cell, or a text box, its position mode can be modified.
●
●
Absolute: The banded object's position will be decided by its X and Y property values.
Static: The banded object will be positioned at the default location in its container. If selected, the X,
Y and other position-related properties will be hidden or disabled.
X
Specifies the X coordinate of the banded object, in inches.
Y
Specifies the Y coordinate of the banded object, in inches.
Width
Specifies the width of the banded object, in inches.
Height
Specifies the height of the banded object, in inches.
Background
Specifies the background color of the banded object.
To change the color, click the color indicator to access the Select Color dialog and then specify a new
color, or input a color string in the format #RRGGBB. If you want to make the background transparent,
input Transparent in the text box.
Border tab
This tab shows information about borders of the banded object.
Color
Specifies the border color. To change the color, click the color indicator to access the Select Color dialog
and then specify a new color, or input a color string in the format #RRGGBB.
Width
Specifies the border width in inches.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Others tab
You can use this tab to view and configure some miscellaneous settings.
TOC Anchor
Specifies whether or not to add the node that represents the banded object to the TOC tree that is
displayed in the TOC Browser.
Suppress When No Records
If true and no records are returned to the banded object, the banded object will not be displayed.
Export to XLS
If true, the banded object will be exported when you save the report result as an XLS file (make sure to
check Data Format in the Export dialog).
Export to CSV
If true, the banded object will be exported when you save the report result as a TXT file with Delimited
Format selected.
Banded Panel Properties dialog
This dialog helps you to edit the properties of a banded panel. It contains the following tabs:
●
General tab
●
Border tab
●
Others tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the banded panel.
Name
Specifies the display name of the panel, which will be shown on the shortcut menu of the panel.
Width
Specifies the width of the panel in inches.
Height
Specifies the height of the panel in inches.
Background
Specifies the background color of the panel.
To change the color, click the color indicator to access the Select Color dialog and then specify a new
color, or input a color string in the format #RRGGBB. If you want to make the background transparent,
input Transparent in the text box.
Border tab
This tab shows information about borders of the banded panel.
Color
Specifies the border color. To change the color, click the color indicator to access the Select Color dialog
and then specify a new color, or input a color string in the format #RRGGBB.
Width
Specifies the border width in inches.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Others tab
You can use this tab to view and configure some miscellaneous settings.
Bottom Line
Specifies whether or not to show the bottom line of the panel.
Cross Page
When the current page cannot hold the whole panel, the panel will cross into the next page if the
property is set to true, or else the whole panel will be displayed in the next page.
Suppress When No Records
If true and no records are returned to the panel, the panel will not be displayed.
Export to XLS
If true, the panel will be exported when you save the report result as an XLS file (make sure to check
Data Format in the Export dialog).
Export to CSV
If true, the panel will be exported when you save the report result as a TXT file with Delimited Format
selected.
Banded Wizard
This wizard guides you through the process of creating a banded object. It contains the following screens:
●
Data screen
●
Display screen
●
Group screen
●
Summary screen
●
Query Filter screen
●
Style screen
Back
Returns to the previous screen.
Next
Goes to the next screen.
Finish
Creates the banded object and closes the wizard.
Cancel
Closes the wizard without creating a banded object.
Help
Displays this help document.
Data screen
Specifies the business/report cube to use to create the banded object. This screen is hidden when there is only
one cube in the current catalog.
Available Data Resources
Lists all the available business/report cubes in the current catalog, with which you can create the banded object.
Display screen
Specifies the fields to be displayed in the banded object.
Resources
Displays all the cube elements in the selected business/report cube. To add a cube element to display in the
banded object, select it and then click
.
Display Fields
Lists the cube elements you have selected to display in the banded object. For an added cube element which
you do not want, select it and then click
.
Display Name
Specifies the display names of the added cube elements.
The downward order of the added elements determines the order of them displayed in the banded object from
left to right. You can use the following two arrows to adjust the order.
Moves the selected cube element one step up.
Moves the selected cube element one step down.
Group screen
Specifies the fields to group the data in the banded object.
Resources
Displays all the available dimension objects
you can use to group the data in the banded object. To add a
dimension object as a group field, select it and then click
.
Group By
Lists all the dimension objects that have been added as the group fields. To cancel a dimension from being a
group field, select it and then click
.
Sort
Specifies the sort order for each group: Ascend, Descend, or No Sort.
The downward order of the added group fields determines the order of the groups in the banded object from
first to last. You can use the following two arrows to adjust the order.
Moves the selected group one step up.
Moves the selected group one step down.
Summary screen
Specifies summary fields that calculate data based on a group or on the whole banded object.
Resources
that can be used as summary fields. Summary fields can be
Displays all the available measure objects
added into a group or for the whole banded object. To add into a group, first select the group field in the right
panel, then select the desired measure object in the left panel and click
. To add for the whole banded
object, first make sure no group field is selected, then select the desired measure and click
.
Summarized Fields
Lists the groups that have been created in the banded object and the measure objects you have added to
summarize data in the groups and for the whole banded object.
To cancel a measure object from being added as a summary field, select it in the right panel and click
Display Name
Specifies the display names of the measure objects.
Moves the selected measure object one step up.
Moves the selected measure object one step down.
Query Filter screen
Specifies the filter which you want to apply to the selected business/report cube.
.
In this screen, all the predefined filters of the business/report cube are listed in the Query Filter drop-down list.
You can choose one of them to apply. If you prefer to define a filter on your own, select User Defined from the
drop-down list, and then define it according to your requirements.
For details about options in the screen, refer to Query Filter dialog.
Style screen
Specifies the style of the banded object. This screen is hidden when there is only one style available to be
applied to the banded object.
Style
Lists all the available styles for you to select from.
Inherit Style
Specifies to take the style of the parent component. The option is available only when you specify to insert the
banded object into another banded object.
Preview
Shows a preview of the banded object in the selected style.
Bottom N dialog
This dialog helps you to filter data to display records that meet the Bottom N condition.
Value
Enter a positive integer number N here so that records with the field value equal to one of the bottom
N field values will be displayed.
OK
Applies the settings and closes the dialog.
Cancel
Closes the dialog and discards any changes.
Help
Displays this help document.
Button Properties dialog
This dialog helps you to modify the properties of a button in a navigation control.
Button Type
●
●
Button
The button is displayed as a normal button.
Image Button
The button is displayed as an image.
Button
When Button is selected as the button type, the following options are available.
Button Label
Specifies the properties of the button label.
●
●
●
●
●
●
Text
Specifies the text of the label.
Font
Specifies the font face of the text.
Font Style
Specifies the font style of the text.
Font Size
Specifies the font size of the text.
Align
Specifies the alignment way of the label in the button.
Font Color
Specifies the font color of the text.
Border
Specifies the properties of the button border.
●
●
●
●
●
●
Color
Specifies the border color.
Thickness
Specifies the border width in inches.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Button Body
Specifies the properties of the button body.
●
Background
Specifies the background color of the button body.
To change the color, click the color indicator to access the Select Color dialog and then specify a new color,
or input a color string in the format #RRGGBB. If you want to make the background transparent, input
Transparent in the text box.
●
●
●
Width
Specifies the width of the button in inches.
Height
Specifies the height of the button in inches.
Position
Displays the position mode of the button. If the button is directly contained in the report body, a tabular
cell, or a text box, its position mode can be modified.
❍
❍
●
●
Absolute: The button's position will be decided by its X and Y property values.
Static: The button will be positioned at the default location in its container. If selected, the X, Y and
other position-related properties will be hidden or disabled.
X
Specifies the X coordinate of the button, in inches.
Y
Specifies the Y coordinate of the button, in inches.
Preview
Displays a preview of the button according to the button properties.
Image Button
When Button Image is selected as the button type, the following options are available.
Image From
Specifies the source of the image file.
●
Local File
Specifies to use an image from the local file system. The types and size of the images that can be used are
defined by the administrator on the JReport Administration page > Configuration > Upload panel.
❍
●
File Name
Specifies the path and name of the image file. You can click the Browse button to locate the image file.
Web URL
Specifies to use an image via URL.
❍
Image URL
Specifies the URL of the image file. JReport will record the latest 10 entered URLs in the drop-down list.
Note: If your JReport Server is in an intranet, to successfully access the image via URL, you need to
add the parameters -Dhttp.proxyHost=XXX -Dhttp.proxyPort=XX to the server's startup file
JRServer.bat, which locates in <install_root>\bin.
●
Library
Specifies to use an existing image.
❍
❍
My Images
The My Images folder is a virtual location where JReport Server stores the images that have once been
inserted into reports. Select the one you want to use.
Preview
Displays a preview of the selected image.
OK
Applies the button properties and closes this dialog.
Cancel
Cancels the changes and closes this dialog.
Help
Displays this help document.
Chart Definition dialog
The dialog helps you to modify the definition of a chart. It contains the following tabs:
●
Chart Type tab
●
Display tab
●
Style tab
OK
Applies the settings and closes the dialog.
Cancel
Cancels the settings and closes the dialog.
Help
Displays this help document.
Chart Type tab
This tab allows you to set the type of the chart.
Chart Type
Lists all the chart types.
Subtype
Shows subtypes of the selected chart type in thumbnail form.
Chart Type Groups
Lists the subtypes defined for the chart.
To replace a chart type with another one, first select it, then select the wanted chart type and a sub
type.
If you want to create a combo chart, click <Add Combo Type> of Primary Axis or Secondary Axis in
the Chart Type Groups box, and an additional subtype will be added. To replace the additional subtype,
select it, then specify the required type and subtype respectively. To add more subtypes, repeat the
procedures.
Removes the selected subtype. At least one type should remains for the Primary Axis so as to create
the chart.
Display tab
This tab allows you to set the fields that will be displayed in the chart.
Resources
Displays all the dimension objects and measure objects used in the chart.
Adds the selected cube element to the chart.
Removes the selected cube element.
Category
Lists the dimension object
that will be displayed on the category axis of the chart.
Series
Lists the dimension object
that will be displayed on the series axis of the chart.
Show Values
Lists the measure objects
chart.
●
and additional values
that will be displayed on the value axis of the
Opens the Edit Additional Value dialog to edit an additional value. Available only when an additional
value is selected in the Show Values box.
Order/Select N
Opens the Order/Select N dialog to define the sort order and Select N condition in the chart.
Style tab
This tab allows you to select a style for the chart. It is hidden when there is only one style available.
Style
Lists the available styles.
●
Custom
There is no style information in this style and it is only used to support reports built with previous
versions which did not bind any style or the bound style cannot be found in the style list.
Preview
Displays a diagram illustrating the effect of the selected style on the chart.
Chart Wizard
This wizard guides you through the process of creating a chart. It contains the following screens:
●
Data screen
●
Type screen
●
Display screen
●
Query Filter screen
●
Style screen
Back
Returns to the previous screen.
Next
Goes to the next screen.
Finish
Creates the chart and closes the wizard.
Cancel
Closes the wizard without creating a chart.
Help
Displays this help document.
Data screen
Specifies the business/report cube to use to create the chart. This screen is hidden when there is only one cube
in the current catalog.
Available Data Resources
Lists all the available business/report cubes in the current catalog, with which you can create the chart.
Type screen
Specifies the type of the chart.
Chart Type
Lists all the chart types.
Subtype
Shows subtypes of the selected chart type in thumbnail form.
Chart Type Groups
Lists the subtypes defined for the chart.
A default chart type exists in the Chart Type Groups box. To replace it with another one, first select it, then
select the wanted chart type and a sub type.
If you want to create a combo chart, click <Add Combo Type> of Primary Axis or Secondary Axis in the Chart
Type Groups box, and an additional subtype will be added. To replace the additional subtype, select it, then
specify the required type and subtype respectively. To add more subtypes, repeat the procedures.
Removes the selected subtype. At least one type should remain for the Primary Axis so as to create the chart.
Display screen
Specifies the fields to be displayed in the chart.
Resources
Displays the cube elements in the selected business/report cube. Select one non-folder resource each time and
then click
beside the Category, Series, or Show Values box to add it into the corresponding box.
Category
Lists the dimension object
that will be displayed on the category axis of the chart. If you don't want the
current resource, select it and click
on the left to remove it.
Series
Lists the dimension object
resource, select it and click
that will be displayed on the series axis of the chart. If you don't want the current
on the left to remove it.
Show Values
Lists the measure objects
or additional values
that will be displayed on the value axis of the chart. For a
combo chart, specify resources for each chart type. To add a resource to a chart type, first select the resource
and the chart type separately, then click
.
To remove a resource from the box, select it and click
●
on the left.
Opens the Edit Additional Value dialog to edit an additional value. Available only when an additional value is
selected in the Show Values box.
Order/Select N
Opens the Order/Select N dialog to define the sort order and Select N condition in the chart.
Query Filter screen
Specifies the filter which you want to apply to the selected business/report cube.
In this screen, all the predefined filters of the business/report cube are listed in the Query Filter drop-down list.
You can choose one of them to apply. If you prefer to define a filter on your own, select User Defined from the
drop-down list, and then define it according to your requirements.
For details about options in the screen, refer to Query Filter dialog.
Style screen
Specifies the style of the chart. This screen is hidden when there is only one style available to be applied to the
chart.
Style
Lists all the available styles for you to select from.
Inherit Style
Specifies to take the style of the parent component. The option is available only when you specify to insert the
chart into a banded object or table.
Preview
Shows a preview of the selected style.
Conditional Formatting dialog
This dialog helps you to add some conditional formats to values of the selected field.
Condition
Displays all the conditions created on the filed.
●
Creates a new condition using the Edit Conditions dialog.
●
●
●
Edits the selected condition using the Edit Conditions dialog.
Removes the selected condition.
Priority
Specifies the priority of each condition.
❍
❍
Moves a condition up for a higher priority.
Moves a condition down for a lower priority.
Format
You can specify a format for each condition. The format will be applied to the field values when the
specified condition is fulfilled.
●
●
●
●
●
●
●
●
●
Font
Specifies the font type for the field values.
Border
Specifies the border line style for the field values.
Size
Specifies the font size for the field values.
Bold
Specifies whether or not to bold the field values.
Italic
Specifies whether or not to make the field values italic.
Underline
Specifies whether or not to underline the field values.
Foreground Color
Specifies the foreground color for the field values.
Background Color
Specifies the background color for the field values.
Sample Text
Displays a preview sample of your selection.
OK
Applies the changes and closes the dialog.
Cancel
Cancels the changes and exits the dialog.
Help
Displays this help document.
Convert Data Fields dialog
A component created in JReport Designer is based on a dataset, while that created in JReport Viewer is
based on a business/report cube. For the former, if you want to do analytic actions in JReport Viewer,
such as adding a cube element, converting the component type, drilling it, or changing chart definition,
JReport Viewer will convert its fields to cube elements of a business/report cube. In those cases, the
Convert Data Fields dialog will appear for your confirmation of the conversion.
Do not display this message again
Check this option if you do not want this dialog to be displayed in future.
To display the dialog again, on the JReport Console page, click Profile > Customize Profile > DHTML
> Properties > Default, and then check Always Prompt to Convert Data Fields.
OK
Confirm the conversion.
Cancel
Do not convert the fields to cube elements.
Help
Displays this help document.
Crosstab Properties dialog
This dialog helps you to edit the properties of a crosstab. It contains the following tabs:
●
General tab
●
Border tab
●
Crosstab tab
●
Others tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the crosstab.
Name
Specifies the display name of the crosstab, which will be shown on the shortcut menu of the crosstab.
Position
Displays the position mode of the crosstab. If the crosstab is directly contained in the report body, a tabular cell, or a text
box, its position mode can be modified.
●
●
Absolute: The crosstab's position will be decided by its X and Y property values.
Static: The crosstab will be positioned at the default location in its container. If selected, the X, Y and other positionrelated properties will be hidden or disabled.
X
Specifies the X coordinate of the crosstab, in inches.
Y
Specifies the Y coordinate of the crosstab, in inches.
Width
Specifies the width of the crosstab, in inches.
Height
Specifies the height of the crosstab, in inches.
Background
Specifies the background color of the crosstab.
To change the color, click the color indicator to access the Select Color dialog and then specify a new color, or input a color
string in the format #RRGGBB. If you want to make the background transparent, input Transparent in the text box.
Border tab
This tab shows information about borders of the crosstab.
Color
Specifies the color of the borders. To change the color, click the color indicator to access the Select Color dialog and then
specify a new color, or input a color string in the format #RRGGBB. If you want to make the border transparent, input
Transparent in the text box.
Has Border
Specifies whether or not to show the borders.
Crosstab tab
This tab shows the layout-related information of the crosstab.
Horizontal Gap
Specifies the space between the content and left/right edge of a crosstab cell.
Vertical Gap
Specifies the space between the content and top/bottom edge of a crosstab cell.
Block Gap
Specifies the spacing between each part of the crosstab if the crosstab will be split into more than one part.
Boundary Value
Specifies the number of columns in one aggregate cell when the crosstab is displayed horizontally, or rows when displayed
vertically.
Row Total on Top
Specifies whether or not to display the Total row in the first row of the crosstab.
Column Total on Left
Specifies whether or not to display the Total column in the first column in the crosstab.
Repeat Column Header
Specifies whether or not to repeat column headings on every page.
Avoid Orphan Header
Sometimes the column header happens to be at the bottom of a page. To keep the column header together with the data
in the next page, set this property to true.
Expand Data
Specifies whether or not to enable JReport Viewer users to expand or collapse dimensions in the crosstab.
Suppress Row Header
Specifies whether or not to hide the row headers.
Outside Aggregate Title
Specifies whether or not to place the titles of aggregate fields outside.
Suppress Column Header
Specifies whether or not to hide the column headers.
Table Style
Specifies whether or not to add headers to the Total rows and columns.
Repeat Aggregate
Specifies whether or not to repeat the crosstab for different aggregate fields.
Others tab
You can use this tab to view and configure some miscellaneous settings.
Current Row Block Index
Specifies the vertical index of the data block that will be displayed. 0 means the first block index, and 1 the second, and so
on.
Current Column Block Index
Specifies the horizontal index of the data block that will be displayed. 0 means the first block index, and 1 the second, and
so on.
Items per Row Block
Specifies the number of rows of records in each data block.
Items per Column Block
Specifies the number of columns of records in each data block.
The four properties work together to control the data of the crosstab to be displayed in continuous page mode: Current
Row Block Index, Current Column Block Index, Items per Row Block, and Items per Column Block.
TOC Anchor
Specifies whether or not to add the node that represents the crosstab to the TOC tree that is displayed in the TOC Browser.
Suppress When No Records
If true and no records are returned by the report, the crosstab will not be displayed.
Export to XLS
If true, the crosstab will be exported when you save the report result as an XLS file (make sure to check Data Format in
the Export dialog).
Export to CSV
If true, the crosstab will be exported when you save the report result as a TXT file with Delimited Format selected.
Crosstab Wizard
This wizard guides you through the process of creating a crosstab. It contains the following screens:
●
Data screen
●
Display screen
●
Query Filter screen
●
Style screen
Back
Returns to the previous tab.
Next
Goes to the next tab.
Finish
Creates the crosstab and closes the wizard.
Cancel
Closes the wizard without creating a crosstab.
Help
Displays this help document.
Data screen
Specifies the business/report cube to use to create the crosstab. This screen is hidden when there is only one
cube in the current catalog.
Available Data Resources
Lists all the available business/report cubes in the current catalog, with which you can create the crosstab.
Display screen
Specifies the fields to be displayed in the crosstab.
Resources
Displays the cube elements in the selected business/report cube. Select one non-folder resource each time and
then click a proper arrow button to add it into the corresponding box.
Adds the selected dimension object
to be displayed on the columns of the crosstab.
Adds the selected dimension object
to be displayed on the rows of the crosstab.
Adds the selected measure object
to be the aggregate field of the crosstab.
Columns/Rows
●
●
●
Field
Lists the dimension objects that will be displayed on the columns/rows of the crosstab.
Display Name
Specifies the display names of the dimension objects. By default these are blank and no labels will be created
for the dimension objects to name the columns/rows. You can click the cells to edit them if required.
Sort
Specifies the sort order of the dimension objects.
Summaries
●
●
Field
Lists the measure objects that will be the aggregate fields of the crosstab.
Display Name
Specifies the display names of the measure objects. By default these are blank and no labels will be created
for the measure objects to name the summaries. You can click the cells to edit them if required.
Moves the selected resource one level up. The order here defines the order of the resources displayed in the
crosstab from left to right or from top to bottom.
Moves the selected resource one level down. The order here defines the order of the resources displayed in the
crosstab from left to right or from top to bottom.
Removes the selected resource from the crosstab.
Query Filter screen
Specifies the filter which you want to apply to the selected business/report cube.
In this screen, all the predefined filters of the business/report cube are listed in the Query Filter drop-down list.
You can choose one of them to apply. If you prefer to define a filter on your own, select User Defined from the
drop-down list, and then define it according to your requirements.
For details about options in the screen, refer to Query Filter dialog.
Style screen
Specifies the style of the crosstab. This screen is hidden when there is only one style available to be applied to
the crosstab.
Style
Lists all the available styles for you to select from.
Inherit Style
Specifies to take the style of the parent component. The option is available only when you specify to insert the
crosstab into a banded object.
Preview
Shows a preview of the selected style.
Customized Page dialog
This dialog is displayed when the web action user_popCustomizedPage() bound with a web control is
triggered. It by default shows all the parameters the current report and its subreport use. You can
change the parameter values to re-run the report according to your requirement. Also, you can
customize the JSP page of this dialog to make it display what you need by using the DHTML API.
OK
Applies the changes and closes the dialog.
Cancel
Cancels the changes and exits the dialog.
Help
Displays this help document.
Data Field Properties dialog
This dialog helps you to edit the properties of a DBField. It contains the following tabs:
●
General tab
●
Font tab
●
Border tab
●
Others tab
●
Display tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the data field.
Name
Specifies the display name of the data field.
Position
Displays the position mode of the data field. If the data field is directly contained in the report body, a tabular
cell, or a text box, its position mode can be modified.
●
●
Absolute: The data field's position will be decided by its X and Y property values.
Static: The data field will be positioned at the default location in its container. If selected, the X, Y and other
position-related properties will be hidden or disabled.
Format
Specifies the data format of the data field.
X
Specifies the X coordinate of the data field.
Y
Specifies the Y coordinate of the data field.
Width
Specifies the width of the data field.
Height
Specifies the height of the data field.
Top Padding
Specifies the space between the text of the field and its top border.
Bottom Padding
Specifies the space between the text of the field and its bottom border.
Left Padding
Specifies the space between the text of the field and its left border.
Right Padding
Specifies the space between the text of the field and its right border.
Background
Specifies the background color of the data field.
To change the color, click the color indicator to baccess the Select Color dialog and then specify a new color, or
input a color string in the format #RRGGBB. If you want to make the background transparent, input Transparent
in the text box.
Foreground
Specifies the foreground color of the data field.
To change the color, click the color indicator to access the Select Color dialog and then specify a new color, or
input a color string in the format #RRGGBB.
Font tab
This tab shows the font-related information of the data field.
Font
Specifies the font face of the text.
Size
Specifies the font size of the text.
Horizontal Alignment
Specifies the horizontal alignment mode of the text in the data field.
Vertical Alignment
Specifies the vertical alignment mode of the text in the data field.
Bold
Specifies whether to make the text bold or not.
Underline
Specifies whether the text will be underlined or not.
Strikethrough
Specifies whether or not to attach a strikeout line to the text.
Italic
Specifies whether to make the text italic or not.
Autofit
Specifies whether or not to automatically adjust the width of the data field according to the maximum length of
the contents.
Word Wrap
Specifies whether or not to wrap the text to the data field width.
Ignore HTML Tag
If this option is set to false, JReport will parse HTML tag elements in the field value while the report is to be saved
as an HTML file; or the field value will appear in the HTML file the same as that in JReport Viewer (HTML tag
elements in the field value, if any, will not be parsed).
Border tab
This tab shows information about borders of the data field.
Color
Specifies the border color. To change the color, click the color indicator to access the Select Color dialog and then
specify a new color, or input a color string in the format #RRGGBB. If you want to make the border transparent,
input Transparent in the text box.
Width
Specifies the border width in inches.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Shadow
Specifies whether the borders will have a shadow effect or not.
Shadow Color
Specifies the color of the border shadow. To change the color, click the color indicator to access the Select Color
dialog and then specify a new color, or input a color string in the format #RRGGBB.
Others tab
You can use this tab to view and configure some miscellaneous settings.
TOC Anchor
Specifies whether or not to add the node that represents the data field to the TOC tree that is displayed in the
TOC Browser.
Suppress When No Records
If true and no records are returned by the report, the data field will not be displayed.
Suppress If Null
If true and the field value is null, the data field will not be displayed.
Export to XLS
If true, the data field will be exported when you save the report result as an XLS file (make sure to check Data
Format in the Export dialog).
Export to CSV
If true, the data field will be exported when you save the report result as a TXT file with Delimited Format
selected.
Scope
Available only for data fields in a table or crosstab. It is a representation of the standard HTML attribute scope.
This attribute specifies the set of data cells for which the current header cell provides header information.
●
Row - The current cell provides header information for the rest of the row that contains it.
●
Column - The current cell provides header information for the rest of the column that contains it.
●
None - The scope attribute will not be generated when exporting to HTML.
Logic Column
Specifies whether to show the data field in the next visible table cell in the same row when the column which
holds the field is hidden.
Display tab
You can use this tab to modify the display type of the data field as one of the following: Text, Barcode, Image,
Text Field, Text Area, Checkbox, Radio Button, Image Button, Button, Submit, Reset, and Hidden. What you need
to do is select the display type from the Display Type drop-down list, and then set the corresponding options.
Note: For the display type Text, there is no option available. For a field displayed as rank, you cannot change its
display type.
Barcode
Specifies to display the data field as barcode.
Symbology
Specifies the barcode type.
Scale Mode
Specifies the unit for the values of the quiet zone, narrow width, supplement, height, and ratio.
Quiet Zone
Specifies the space around the barcode.
Narrow Width
Specifies the width of the narrowest barcode bar.
Supplement
Specifies the supplement of the barcode.
Height
Specifies the height of the barcode bars.
Message
Specifies the default value of the barcode.
Ratio
Specifies the width ratio of the thick bar to the thin bar.
Orientation
Specifies the rotation angle in degrees.
Use Default Message
Specifies whether or not to use the Message value as the barcode value when you view the report result.
Enable Checking Digits
Specifies whether or not to include check digits in the barcode.
Display HR
Specifies whether or not to display the characters together with the barcode bars.
Image
Specifies to display the data field as image.
Scaling Mode
Specifies a way to decide the size of the image. This option is enabled when Original Size is false. The mode can
be:
●
Actual Size: The image will be shown in its actual size.
●
Customize: You can customize the size of the image by setting the Width and Height properties.
●
Fit Height: The image will be scaled largest under the limitation of Max Ratio to fit the height of the field.
●
Fit Image: The image will be scaled largest under the limitation of Max Ratio to wholly show in the field.
●
Fit Width: The image will be scaled largest under the limitation of Max Ratio to fit the width of the field.
Rotation
Rotates the image at a specified angle in degrees. The following is the meaning of different values:
●
0 - No rotation.
●
Positive value - Rotates the image clockwise.
●
Negative value - Rotates the image anticlockwise.
Note: When you rotate an image, the rectangle that holds the image maintains its original size, which may result
in that the image exceeds the field border and therefore the parts that extend outside of the border will be cut off.
Name
Specifies the name of the image. It is mapped to the HTML element attribute "name".
Alternate Text
If the image cannot be displayed, the alternate text will be used instead.
Max Ratio
Specifies the maximum scaling ratio of the image.
Width
Specifies the width of the image, applying if Scaling Mode is set to Customize. This option is enabled when
Original Size is false.
Height
Specifies the height of the image, applying if Scaling Mode is set to Customize. This option is enabled when
Original Size is false.
Original Size
Specifies whether or not to show the image in its original size.
Text Field
Specifies to display the data field as text field.
Type
Specifies whether to render the field as a normal text field or to a password box.
Name
Specifies the name of the text field. It is mapped to the HTML element attribute "name".
Title
Specifies the tip information which will be shown when you hover the mouse over the text field. It is mapped to
the HTML element attribute "title".
Character Width
Specifies the width of the text field mesured in the number of characters.
Max Length
Specifies the maximum number of the characters that can be input into the text field.
Read Only
Specifies whether or not to make the text field read-only.
Disabled
Specifies whether or not to make the text field disabled.
Note: When a data field is displayed as text field, the value you have specified for the field's font property
Vertical Alignment will no longer take effect. This is because the property is not supported in HTML standards.
Text Area
Specifies to display the data field as text area.
Name
Specifies the name of the text area. It is mapped to the HTML element attribute "name".
Title
Specifies the tip information which will be shown when you hover the mouse over the the text area. It is mapped
to the HTML element attribute "title".
Wrap
Specifies whether or not to wrap text to the width of the text area.
Note: When a data field is displayed as text area, the value you have specified for the field's font property
Vertical Alignment will no longer take effect. This is because the property is not supported in HTML standards.
Read Only
Specifies whether or not to make the text area read-only.
Disabled
Specifies whether or not to make the text area disabled.
Checkbox
Specifies to display the data field as checkbox.
Name
Specifies the name of the checkbox. It is mapped to the HTML element attribute "name".
Title
Specifies the tip information which will be shown when you hover the mouse over the the checkbox. It is mapped
to the HTML element attribute "title".
Disabled
Specifies whether or not to make the checkbox disabled.
Initially Checked
Specifies whether or not the checkbox is selected by default.
Radio Button
Specifies to display the data field as radio button.
Name
Specifies the name of the radio button. It is mapped to the HTML element attribute "name".
Title
Specifies the tip information which will be shown when you hover the mouse over the radio button. It is mapped
to the HTML element attribute "title".
Disabled
Specifies whether or not to make the radio button disabled.
Initially Checked
Specifies whether or not the radio button is selected by default.
Image Button
Specifies to display the data field as image button.
Scaling Mode
Specifies the scaling mode of the image. This option is enabled when Original Size is false. The mode can be:
●
Actual Size: The image will be shown in its actual size.
●
Customize: You can customize the size of the image by setting the Width and Height properties.
●
Fit Height: The image will be scaled largest under the limitation of Max Ratio to fit the height of the field.
●
Fit Image: The image will be scaled largest under the limitation of Max Ratio to wholly show in the field.
●
Fit Width: The image will be scaled largest under the limitation of Max Ratio to fit the width of the field.
Name
Specifies the name of the image button. It is mapped to the HTML element attribute "name".
Alternate text
If the image cannot be displayed, this attribute value will be used as the alternate text.
Title
Specifies the tip information which will be shown when you hover the mouse over the image button. It is mapped
to the HTML element attribute "title".
Max Ratio
Specifies the scaling ratio of the image button.
Width
Specifies the width of the image button, applying if Scaling Mode is set to Customize. This option is enabled when
Original Size is false.
Height
Specifies the height of the image button, applying if Scaling Mode is set to Customize. This option is enabled when
Original Size is false.
Original Size
Specifies whether or not to show the image button in its original size.
Disabled
Specifies whether or not to make the image button disabled.
Button
Specifies to display the data field as button.
Name
Specifies the name of the button. It is mapped to the HTML element attribute "name".
Title
Specifies the tip information which will be shown when you hover the mouse over the button. It is mapped to the
HTML element attribute "title".
Value
Specifies the text displayed on the button by directly inputting or using a formula. To make this property work,
you need to set From Database to false.
From Database
If true, the current DBField value will be kept as the display text on the button. If false, you can use the Value
property to specify the display text.
Disabled
Specifies whether or not to make the button disabled.
Note: When a data field is displayed as button, the value you have specified for the field's font property Vertical
Alignment will no longer take effect. This is because the property is not supported in HTML standards.
Submit
Specifies to display the data field as submit button.
Name
Specifies the name of the submit button. It is mapped to the HTML element attribute "name".
Title
Specifies the tip information which will be shown when you hover the mouse over the submit button. It is mapped
to the HTML element attribute "title".
Value
Specifies the text displayed on the submit button by directly inputting or using a formula. To make this property
work, you need to set From Database to false.
From Database
If true, the current DBField value will be kept as the display text on the submit button. If false, you can use the
Value property to specify the display text.
Disabled
Specifies whether or not to make the submit button disabled.
Reset
Specifies to display the data field as reset button.
Name
Specifies the name of the reset button. It is mapped to the HTML element attribute "name".
Title
Specifies the tip information which will be shown when you hover the mouse over the reset button. It is mapped
to the HTML element attribute "title".
Value
Specifies the text displayed on the reset button by directly inputting or using a formula. To make this property
work, you need to set From Database to false.
From Database
If true, the current DBField value will be kept as the display text on the reset button. If false, you can use the
Value property to specify the display text.
Disabled
Specifies whether or not to make the reset button disabled.
Hidden
Specifies to render the data field as hidden field.
Name
Specifies the name of the hidden field. It is mapped to the HTML element attribute "name".
Value
Specifies the value of the hidden field by directly inputting or using a formula.
Edit Additional Value dialog
This dialog helps you to edit an additional value. It varies according to value types.
If it is a constant value, options in the dialog are as follows.
Name
Specifies the display name of the constant value, which will be shown under the subtype in the Show
Values box.
Value
Specifies a float number for the constant value.
OK
Applies the settings and closes the dialog.
Cancel
Closes the dialog and discards any changes.
Help
Displays this help document.
If it is an average value, options in the dialog are as follows.
Name
Specifies the display name of the average value, which will be shown under the subtype in the Show
Values box.
Based On
Specifies the measure object based on which the average value will be calculated.
OK
Applies the settings and closes the dialog.
Cancel
Closes the dialog and discards any changes.
Help
Displays this help document.
Edit Conditions dialog
This dialog helps you to edit a condition for the selected field for adding conditional format. It contains the
following two modes:
●
Basic
●
Advanced
Advanced/Basic
Switches the dialog to the advanced/basic mode.
OK
Applies the changes and closes the dialog.
Cancel
Cancels the changes and exits the dialog.
Help
Displays this help document.
Basic mode
The basic mode provides function for creating simple filter conditions which are connected by the AND and
OR operators.
Deletes the current condition line. Each condition line contains an expression with a logic operator which
either connects the current expression with the following one or ends when it is the last line. An expression
is composed of a field, an operator, and a value.
Field
Specifies the field to be filtered.
Operator
Specifies the operator to compose the filter expression.
●
●
=
Equal to
>
Greater than
●
●
●
●
>=
Greater than or equal to
<
Less than
<=
Less than or equal to
!=
Not equal to
Value
Specifies the value of how to filter the field. You can either enter the value manually in the text box or select
a value from the drop-down list. When you type in the value manually, if multiple values are required, they
should be separated with ",", and if "," or "\" is contained in the values, write it as "\," or "\\".
Logic
Lists the logic operator.
●
●
●
AND
Logic operator AND which is applied to this and the next line.
OR
Logic operator OR which is applied to this and the next line.
END
When this is the last line, use END to end the whole condition expression.
Advanced mode
The advanced mode enables the building of more complex filter conditions via the grouping of conditions.
Add Condition
Adds a new condition line. Each condition line contains an expression which is composed of a field, an
operator, and a value.
Delete
Deletes the selected condition lines and groups.
Group
Makes the selected condition lines become a group. A group can have one logic operator to connect all of its
condition lines, for example, a group contains three conditions lines which are expression A, B and C and the
group's logic operator is OR, then the group's expression is: A OR B OR C.
Condition lines can also be added to an existing group by selecting the condition lines and the group while
holding the Ctrl button, and then clicking the Group button.
Ungroup
Makes the selected condition lines and groups out of a group or disbands a group.
Up
Moves the selected condition line or group up to a higher level.
Down
Moves the selected condition line or group down to a lower level.
Logic
Specifies the logic operator of a condition group. By clicking the logic button the following items will be rolled
one by one.
●
●
●
●
AND
Logic operator AND which is used to connect all of the condition lines in the group.
OR
Logic operator OR which is used to connect all of the condition lines in the group.
AND NOT
Logic operator AND NOT which is used to connect all of the condition lines in the group.
OR NOT
Logic operator OR NOT which is used to connect all of the condition lines in the group.
Field
Specifies the field to be filtered.
Operator
Specifies the operator to compose the filter expression.
Value
Specifies the value of how to filter the field. You can either enter the value manually in the text box or select
a value from the drop-down list. When you type in the value manually, if multiple values are required, they
should be separated with ",", and if "," or "\" is contained in the values, write it as "\," or "\\".
Condition Expression
Displays the SQL statement of the filter condition.
Edit Measure dialog
This dialog helps you to edit an existing measure object.
Measure Name
Specifies the display name of the measure object.
Mapping Name
Specifies the mapping name of the field to which the measure object is mapped. Click
field in the Select Resource dialog.
to select the
This option and the button are disabled when you specify to create a measure object on a dynamic
formula.
Aggregate Function
Specifies the aggregate function of the measure object. The function will be applied according to the
group where the measure is placed or the entire report if placed in the report header or footer.
●
●
●
Count
This function computes the number of values referred to by the argument.
Sum
This function computes the sum of all the values referred to by the argument.
Average
The function is used to get the average value of the values referred to by the argument.
●
●
●
●
●
●
Maximum
This function returns the highest value referred to by the argument.
Minimum
This function returns the lowest value referred to by the argument.
DistinctCount
This function computes the number of distinct values referred to by the argument.
PopulationVariance
This function computes the population variance of the values referred to by the argument.
StdDev
This function computes the standard deviation of the values referred to by the argument.
Variance
This function computes the variance of all the values referred to by the argument.
OK
Accepts the changes and closes the dialog.
Cancel
Cancels the operation and closes the dialog.
Help
Displays this help document.
Encoding dialog
When a report designer links a trigger field of a master report to a detail report in JReport Designer, if
he or she hasn't checked the option Use the same encoding and DB settings for the detail report as
that of the mater report, then when the report is published to JReport Server and run in JReport
Viewer, when you click the trigger field, this dialog will be displayed for you to specify the encoding for
the detail report.
Page Report
Displays the path and name of the current page report.
Catalog
Displays the path and name of the current catalog.
Enable Converting Encoding
Specifies to enable the conversion of encoding. From the Before Converting and After Converting dropdown lists, select encoding as required.
Encoding
Specifies the encoding for the detail report.
Connect to [Data Source Name]
Specifies the DB user and password with which you want to connect to the data source used by the
detail report.
●
●
Use the DB user and password defined in catalog
If checked, the DB user and password defined in the catalog will be used.
Use the DB User
If checked, specify another DB user and password instead of the one defined in the catalog.
OK
Closes this dialog and applies the settings to run the detail report.
Cancel
Closes this dialog and runs the detail report without regard to the settings.
Help
Displays this help document.
Enter Values dialog
This dialog helps you to specify multiple values for a parameter.
Available Values
Lists all predefined parameter values for selection. When the parameter is bound with a column, but
the Display Column is different from the Bind Column, values of the Display Column are listed here.
Selected Values
Lists the values selected. The selected values are case sensitive.
Adds the selected values from the Available Values box to the Selected Values box.
Removes the selected values from the Selected Values box.
Adds all the selected values from the Available Values box to the Selected Values box.
Removes all the selected values from the Selected Values box.
Enter Values
This option is available when the parameter's Allow Type-in of Value property is set to true in JReport
Designer.
Enter a value manually in the text box and then click the button next to add the value to the Selected
Values box. When the parameter is bound with a column, but the display column is different from the
bind column, make sure the value you enter is that of the bind column.
Opens the Calendar dialog to specify a date and time value. Available only for Date, DateTime, or Time
parameter which allows for type-in values and is not bound with any column.
All
If selected, it means that the parameter value result is all the values in the DBMS. This option is
available when the parameter's Enable the "All" Option property is set to true in JReport Designer. This
is translated in SQL to remove the parameter which may select more values than listed in the available
values list.
For example, when the parameter query is:
SELECT CUSTOMERS.CUSTOMERID,CUSTOMERS.CUSTOMERNAME FROM CUSTOMERS where
CUSTOMERS.CUSTOMERID>0 and CUSTOMERS.CUSTOMERID<4
When you click
SQL is:
to add 1, 2 and 3 as the parameter values, which are all the available values, the
(CUSTOMERS.CUSTOMERID IN ( 1,2,3))
Run the same report again and this time check the All checkbox in the Enter Values dialog, the query is
then:
( 1 = 1)
In this case, you will get more customers even though available values are only 1 – 3.
Note:When a multi-value parameter is inserted as a field into a report and All is selected as the value,
the field will show the string "All". If the parameter allows type-in values, "All" means all possible
values of the parameter data type; if the parameter does not, "All" represents all the values of the
parameter that come from the DBMS.
OK
Applies the selected values to the parameter and closes the dialog.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
Export dialog
This dialog helps you to set settings for exporting the report result to different formats.
File Name
Specifies the name of the result file.
View Report Result
If selected, the result will be directly opened in the web browser if the format is supported by a plug-in of
the web browser; otherwise you will be prompted to save the result file.
Save to File System
If selected, the web browser will prompt you to save the result file to a specified folder.
Save to Version System
If selected, the report result will be saved as a result version in JReport Server's versioning system.
Select Format
Specifies the format to which the report result will be exported.
More/Less Options
Shows/Hides the additional settings for exporting the report to the specified format.
●
●
Style Group
Specifies the style group that will be applied to the exported result. When the No Style item in the Style
Group drop-down list is selected, the style group property predefined for specific export format in
JReport Designer will be applied to export the report result to that format.
Properties
Specifies the properties for the selected format:
❍
PDF
❍
HTML
❍
Excel
❍
Text
❍
RTF
❍
XML
❍
PostScript
❍
DHTML Result
■
Zip Result
Specifies to compress the result and its size would be smaller.
OK
Exports the report with the settings you specified.
Cancel
Cancels the operation and closes this dialog.
Help
Displays this help document.
Filter Control Properties dialog
This dialog helps you to edit the properties of a filter control. It contains the following tabs:
●
General tab
●
Font tab
●
Border tab
●
Title tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the filter control.
Name
Specifies the name of the filter control.
Position
Displays the position mode of the filter control. If the filter control is directly contained in the report body, a
tabular cell, or a text box, its position mode can be modified.
●
●
Absolute: The filter control's position will be decided by its X and Y property values.
Static: The filter control will be positioned at the default location in its container. If selected, the X, Y and
other position-related properties will be hidden or disabled.
Format
Specifies the field value format in the filter control.
Filter On
Displays the fields that the filter control is based on. You can click the button
dialog to select other fields.
X
Specifies the X coordinate of the filter control.
Y
to open the Select Field
Specifies the Y coordinate of the filter control.
Width
Specifies the width of the filter control.
Height
Specifies the height of the filter control.
Background
Specifies the background color of the filter control.
To change the color, click the color indicator to access the Select Color dialog and then specify a new color,
or input a color string in the format #RRGGBB. If you want to make the background transparent, input
Transparent in the text box.
Foreground
Specifies the foreground color of the filter control.
To change the color, click the color indicator to access the Select Color dialog and then specify a new color,
or input a color string in the format #RRGGBB.
Show Title
Specifies whether to show the title of the filter control.
Font tab
This tab shows the font-related information of the text in the filter control.
Font
Specifies the font face of the text.
Size
Specifies the font size of the text.
Bold
Specifies whether to make the text bold or not.
Underline
Specifies whether the text will be underlined or not.
Italic
Specifies whether to make the text italic or not.
Border tab
This tab shows information about borders of the filter control.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Title tab
This tab shows information about the title of the filter control. It is available when the Show Title option is
selected in the General tab of the same dialog.
Text
Specifies the text of the title.
●
Auto Map Field Name
Specifies whether to use the field name as the title. If selected, the Text box above is disabled for
inputting.
Background
Specifies the background color of the title.
To change the color, click the color indicator to access the Select Color dialog and then specify a new color,
or input a color string in the format #RRGGBB. If you want to make the background transparent, input
Transparent in the text box.
Foreground
Specifies the foreground color of the title.
To change the color, click the color indicator to access the Select Color dialog and then specify a new color,
or input a color string in the format #RRGGBB.
Font
Specifies the font face of the text.
Size
Specifies the font size of the text.
Horizontal Alignment
Specifies the horizontal alignment mode of the text.
Bold
Specifies whether to make the text bold or not.
Underline
Specifies whether the text will be underlined or not.
Italic
Specifies whether to make the text italic or not.
Filter dialog
This dialog helps you to set criteria for filtering records in a report. It has the following two modes:
●
Basic
●
Advanced
Advanced/Basic
Switches the dialog to the advanced/basic mode.
OK
Accepts the changes, and regenerates the result using the filter settings with this dialog closed.
Cancel
Cancels the operation and closes this dialog.
Apply
Accepts the changes in the current tab, and regenerates the result using the filter settings.
Reset
Restores this dialog to its opening status.
Help
Displays this help document.
Basic mode
The basic mode provides function for creating simple filter conditions which are connected by the AND and
OR operators.
Apply to
Specifies the object to which the filter will be applied.
Deletes the current condition line.
Field
Specifies the field to be filtered.
Operator
Specifies the operator to compose the filter expression.
●
●
●
●
●
●
●
●
●
●
=
Equal to
>
Greater than
>=
Greater than or equal to
<
Less than
<=
Less than or equal to
!=
Not equal to
[not] in
Causes an enumerated list of values to appear in the WHERE clause predicate, used for evaluating for a
true condition.
[not] like
Like string pattern matching operator is used to compare the first expression string value to the pattern
string (the second expression). If you want to use wildcard character in the pattern string, only "_" and
"%" are supported.
[not] between
Allows the system to evaluate whether or not data values are located between a range of values indicated
in the predicate.
is [not] null
It is used in WHERE clause predicates to match null values occurring in a specified data field.
Value
Specifies the value of how to filter the field. You can either enter the value manually in the text box or select
a value from the drop-down list. When you type in the value manually, if multiple values are required, they
should be separated with ",", and if "," or "\" is contained in the values, write it as "\," or "\\".
Logic
Lists the logic operator.
●
●
AND
Logic operator AND which is applied to this and the next line.
OR
Logic operator OR which is applied to this and the next line.
Advanced mode
The advanced mode enables the building of more complex filter conditions via the grouping of condition.
Apply to
Specifies the object to which the filter will be applied.
Add Condition
Adds a new condition line.
Delete
Deletes the selected condition line.
Group
Makes the selected conditions in one group. Conditions can also be added to an existing group by selecting
the conditions and the group while holding the Ctrl button, and then clicking the Group button.
Ungroup
Makes the selected condition ungrouped.
Up
Moves the selected condition or group up to a higher level.
Down
Moves the selected condition or group down to a lower level.
Logic
Specifies the logic operator.
●
●
●
●
AND
Logic operator AND which is applied to this and the next line.
OR
Logic operator OR which is applied to this and the next line
AND NOT
Logic operator AND NOT which is applied to this and the next line.
OR NOT
Logic operator OR NOT which is applied to this and the next line.
Field
Specifies the field to be filtered.
Operator
Specifies the operator to compose the filter expression.
Value
Specifies the value of how to filter the field. You can either enter the value manually in the text box or select
a value from the drop-down list. When you type in the value manually, if multiple values are required, they
should be separated with ",", and if "," or "\" is contained in the values, write it as "\," or "\\".
Condition Expression
Displays the SQL statement of the filter condition.
Format Category(X) Axis dialog
This dialog appears when you right-click a chart and then select Format Category(X) Axis from the shortcut menu. It helps you to
format the category(X) axis of the chart, and consists of the following tabs:
●
Axis tab
●
Tick Mark tab
●
Font tab
●
Orientation tab
●
Format tab
OK
Applies the changes and closes the dialog.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
Axis tab
This tab shows some general information of the category(X) axis of the chart.
Option
Specifies the options for the axis.
●
●
●
●
●
Minimum Value
Specifies the minimum value that is to be displayed on the axis. Available only to bubble charts which use the axis to show
numeric data and scatter charts.
Maximum Value
Specifies the maximum value that is to be displayed on the axis. Available only to bubble charts which use the axis to show
numeric data and scatter charts.
Increment
Specifies the difference between two adjacent values on the axis. Available only to bubble charts which use the axis to show
numeric data and scatter charts.
Number of Tick Marks
Specifies how many tick marks to be displayed on the axis. Available only to bubble charts which use the axis to show numeric
data and scatter charts.
Show Gridlines
Specifies whether to show the horizontal gridlines in the chart.
Scrollable Chart
Specifies whether to make the chart scrollable. If checked, a scroll bar will be added in the chart, with which you can control the
visible value range on the axis. Available to 2-D charts of bar, bench, line, area and stock types only.
●
●
●
Scrollable Visible Values
Specifies how many data items will be selected on the scrollbar and displayed on the axis by default.
Scrolling Area Percentage
Specifies the percentage the scrollbar occupies the whole size of the chart.
Show Chart in Scrolling Area
Specifies whether to show the thumbnail chart on the scrollbar.
Line
Specifies the line style for the axis.
●
●
●
●
Color
Specifies the color of the axis.
Style
Specifies the style for the line of the axis.
Transparency
Specifies the transparency for the color of the axis.
Thickness
Specifies the thickness for the line of the axis, in inches.
Gap
Specifies the gap properties for the labels on the axis.
●
●
Label Axis Gap
Specifies the distance between the label and the axis, in inches.
Best Effect
Specifies whether to adjust the labels automatically to make them placed best.
Tick Mark tab
The tab consists of three sub tabs: major tick mark tab, minor tick mark tab, and scale tab.
Major Tick Mark tab
Specifies properties of the major tick marks on the axis.
Type
Specifies the type of the major tick marks on the axis.
●
●
●
●
None
If selected, major tick marks will not be shown on the axis and it will be meaningless to specify all the other major tick mark
related properties.
Inside
If selected, major tick marks will be inside the chart.
Outside
If selected, major tick marks will be outside the chart.
Cross
If selected, major tick marks will be across the axis.
Line
Specifies the line properties of the major tick marks on the axis.
If checked, the line properties of the major tick marks will correlate with that of the axis automatically.
●
❍
❍
❍
Color
Specifies the color of the major tick marks.
Style
Specifies the type of the major tick marks.
Transparency
Specifies the transparency for the color of the major tick marks.
❍
●
Thickness
Specifies the thickness of the major tick marks, in inches.
Tick Mark Length
Specifies the length for the major tick marks on the axis, in inches.
Option
Specifies the other properties of the major tick mark labels on the axis.
●
●
●
●
Show Major Tick Mark Labels
Specifies whether to display the labels of the major tick marks on the axis. If checked, the following properties will be enabled.
Label Every N Major Tick Marks
Specifies the frequency at which the major tick marks will be labeled.
Show Axis Label Tips
Specifies whether to display the complete label text when the mouse pointer points at a label on the axis.
Number of Major Labels
Specifies how many major tick mark labels to be displayed on the axis.
❍
❍
Auto
If checked, all major tick mark labels will be shown.
Fixed
If checked, you can specify the number of the major tick mark labels to be displayed on the axis.
Minor Tick Mark tab
Specifies properties of the minor tick marks on the axis.
Type
Specifies the type of the minor tick marks on the axis.
●
●
●
●
None
If selected, minor tick marks will not be shown on the axis and it will be meaningless to specify all the other minor tick mark
related properties.
Inside
If selected, minor tick marks will be inside the chart.
Outside
If selected, minor tick marks will be outside the chart.
Cross
If selected, minor tick marks will be across the axis.
Line
Specifies the line properties for the minor tick marks on the axis.
●
Correlate with Axis
If checked, the line properties of the minor tick marks will correlate with that of the axis automatically.
❍
❍
❍
❍
●
Color
Specifies the color of the minor tick marks.
Style
Specifies the type of the minor tick marks.
Transparency
Specifies the transparency of the minor tick marks.
Thickness
Specifies the thickness of the minor tick marks, in inches.
Tick Mark Length
Specifies the length of the minor tick marks, in inches.
Option
Specifies the other properties of the minor tick marks on the axis.
●
●
●
Show Minor Tick Mark Labels
Specifies whether to display the labels of the minor tick marks on the axis. If checked, the following two properties will be
enabled.
Label Every N Minor Tick Marks
Specifies the frequency at which the minor tick marks will be labeled.
Number of Minor Labels
Specifies how many minor tick mark labels to be displayed on the axis.
❍
❍
Auto
If checked, all minor tick mark labels will be shown.
Fixed
If checked, you can specify the number of the minor tick mark labels to be displayed on the axis.
Scale tab
Customizes the way in which to label the tick marks on the axis. Available only when the field on the category axis is one of the
following types: Number, Date, DateTime, and Time, and not applied for scatter charts or when the category axis is used to show
numeric data in bubble charts.
Use Constant Interval
Specifies whether to use a constant interval to label the tick marks. If checked, the values of the tick marks will be increased
continually on the axis based on the following properties, instead of just using the data values.
Minimum
●
Specifies the minimum value which will be used to label the tick marks.
❍
❍
Auto
If checked, the minimum value will be defined by JReport automatically.
Fixed
If checked, you can define the minimum value as required. Input the value in the text box, or specify it in the calendar if the
field on the category axis is of Date, DateTime or Time type.
Maximum
Specifies the maximum value which will be used to label the tick marks.
❍
❍
Auto
If checked, the maximum value will be defined by JReport automatically.
Fixed
If checked, you can define the maximum value as required. Input the value in the text box, or specify it in the calendar if the
field on the category axis is of Date, DateTime or Time type.
Major Unit
Specifies the unit between two adjacent major tick marks.
❍
Auto
If checked, the unit will be defined by JReport automatically.
❍
Fixed
If checked, you can define the unit as required. Input the value in the text box, or choose the desired one from the drop-down
list if the field on the category axis is of Date, DateTime or Time type.
Minor Unit
Specifies the unit between two adjacent minor tick marks.
❍
❍
Auto
If checked, the unit will be defined by JReport automatically.
Fixed
If checked, you can define the unit as required. Input the value in the text box, or choose the desired one from the drop-down
list if the field on the category axis is of the Date, DateTime or Time type.
Font tab
The tab consists of two sub tabs: major label tab and minor label tab.
Major Label tab
Specifies the font format of the major tick mark labels on the axis.
Font
Specifies the font face of the label text.
Size
Specifies the font size of the label text.
Fill Type
Specifies the fill type of the label text.
Color
Specifies the color of the label text.
Transparency
Specifies the transparency of the label text.
Font Style
Specifies the font style of the text. It can be one of the following: Plain, Bold, Italic and Bold Italic.
Minor Label tab
Specifies the font format of the minor tick mark labels on the axis.
Correlate with Major Label
If checked, the font format of the minor tick mark labels will correlate with that of the major tick mark labels automatically. Only
when it is unchecked can the font properties of the minor tick mark labels take effect.
Font
Specifies the font face of the label text.
Size
Specifies the font size of the label text.
Fill Type
Specifies the fill type of the label text.
Color
Specifies the color of the label text.
Transparency
Specifies the transparency of the label text.
Font Style
Specifies the font style of the text. It can be one of the following: Plain, Bold, Italic and Bold Italic.
Orientation tab
The tab consists of two sub tabs: major label tab and minor label tab.
Major Label tab
Specifies the rotation angle of the major tick mark labels on the axis.
Automatic
Specifies to adjust the rotation angle of the major tick mark label text on the axis automatically according to the length of the
label text, in degrees.
When this option is checked by default:
●
●
If the text can be completely displayed horizontally, the default rotation angle will be 0.
If the text cannot be completely displayed horizontally, the default rotation angle will be 30 anticlockwise, and the cut off part
will be shown as suspension points.
Angle
Specifies to customize the rotation angle of the major tick mark label text on the axis.
Minor Label tab
Specifies the rotation angle of the minor tick mark labels on the axis.
Correlate with Major Label
If checked, the orientation setting of the minor tick mark labels will correlate with that of the major tick mark labels automatically.
Only when it is unchecked can the orientation properties of the minor tick mark labels take effect.
Automatic
Specifies to adjust the rotation angle of the minor tick mark label text on the axis automatically according to the length of the
label text, in degrees.
When this option is checked by default:
●
If the text can be completely displayed horizontally, the default rotation angle will be 0.
●
If the text cannot be completely displayed horizontally, the default rotation angle will be 30 anticlockwise, and the cut off part
will be shown as suspension points.
Angle
Specifies to customize the rotation angle of the minor tick mark label text on the axis.
Format tab
The tab consists of two sub tabs: major label tab and minor label tab.
Major Label tab
Specifies the data format of the major tick mark labels on the axis.
Category
Lists the category types. Select one to customize its format.
Format
Displays all the formats of the selected category. Select the required one and click Add to add it as the format of the specified
category. You can add only one format for each category.
Properties
Displays the properties of the format you select. If the formats listed in the Format box cannot meet your requirement, define the
format in the text field and then click Add to add it as the format of the specified category.
Sample
Displays the selected format effects.
Stack
Lists all the formats you select from different categories.
Add
Adds a format to the Stack list box.
Remove
Removes a format from the Stack list box.
Apply
Applies the specified format in the Stack list box to the major tick mark labels.
Minor Label tab
Specifies some properties for the minor tick mark labels on the axis.
Correlate with Major Label
If checked, the data format of the minor tick mark labels will correlate with that of the major tick mark labels automatically. Only
when it is unchecked can the format properties of the minor tick mark labels take effect.
Category
Lists the category types. Select one to customize its format.
Format
Displays all the formats of the selected category. Select the required one and click Add to add it as the format of the specified
category. You can add only one format for each category.
Properties
Displays the properties of the format you select. If the formats listed in the Format box cannot meet your requirement, define the
format in the text field and then click Add to add it as the format of the specified category.
Sample
Displays the selected format effects.
Stack
Lists all the formats you select from different categories.
Add
Adds a format to the Stack list box.
Remove
Removes a format from the Stack list box.
Apply
Applies the specified format in the Stack list box to the minor tick mark labels.
Format Label dialog
This dialog helps you to format labels in a chart. It contains the following tabs:
●
General tab
●
Border tab
●
Font tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the label.
Name
Specifies the display name of the label, which will be shown on the shortcut menu of the label.
Text
Specifies the label text.
X
Specifies the X coordinate of the label.
Y
Specifies the Y coordinate of the label.
Width
Specifies the width of the label.
Height
Specifies the height of the label.
Alignment
Specifies the alignment mode of the chart label.
Fill Type
Specifies the type for filling the label.
Color
Indicates the background color of the label.
To change the color, click the color indicator to access the Select Color dialog, and then specify a new color, or input a
color string in the format #RRGGBB. If you want to make the background transparent, input Transparent in the text
box.
Transparency
Specifies the transparency of the label background.
Border tab
This tab shows information about borders of the label.
Line Style
Specifies the style of the label borders.
Border Type
Specifies the border type.
Color
Specifies the color of the label borders.
Transparency
Specifies the transparency of the label borders.
Thickness
Specifies the thickness of the label borders.
Font tab
This tab shows the font-related information of the label.
Font
Specifies the font face of the label text.
Size
Specifies the font size of the label text.
Fill Type
Specifies the fill type of the label text.
Color
Specifies the color of the label text.
Transparency
Specifies the transparency of the label text.
Font Style
Specifies the font style of the label text.
Font Effect
Specifies the font effect of the label text.
Font Underline
Specifies the style of the line under the label text.
Font Strikeout
Specifies whether or not to attach a strikeout line to the label text.
Font Rotation
Specifies the rotation angle of the label around its center, in degrees.
Font Shearing
Specifies the shearing transformation of the label around its center, in degrees.
Word Wrap
Specifies whether or not to enable word wrapping for the label text.
Format Legend dialog
This dialog helps you to format the legend of a chart. It contains the following tabs:
●
General tab
●
Placement tab
●
Border tab
●
Font tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the chart legend.
Name
Specifies the display name of the chart legend, which will be shown on the shortcut menu of the legend.
X
Specifies the X coordinate of the chart legend. Available only when the Placement option in the Placement tab is set to
auto.
Y
Specifies the Y coordinate of the chart legend. Available only when the Placement option in the Placement tab is set to
auto.
Width
Specifies the width of the chart legend. Available only when the Placement option in the Placement tab is set to auto.
Height
Specifies the height of the chart legend. Available only when the Placement option in the Placement tab is set to auto.
Fill Type
Specifies the type for filling the chart legend.
Color
Indicates the background color of the chart legend.
To change the color, click the color indicator to access the Select Color dialog, and then specify a new color, or input a
color string in the format #RRGGBB. If you want to make the background transparent, input Transparent in the text
box.
Transparency
Specifies the transparency of the legend background.
Show Value
Specifies whether to show the value of each legend.
Show Percent
Specifies whether to show the percentage of each legend.
Show Tips
Specifies whether to show the corresponding data information when the mouse pointer points at a target in the chart
legend.
Placement tab
This tab shows the position-related information of the chart legend.
Placement
Specifies the position of the legend in the platform. It can be auto, bottom, left, right or top.
Secondary Placement
Specifies the position of the legend on the basis of the Placement property.
Label Vertical Spacing
Specifies the vertical distance between two adjacent legend labels.
Label Horizontal Spacing
Specifies the horizontal distance between two adjacent legend labels.
Top Margin
Specifies the distance between the legend labels and the top border of the legend.
Bottom Margin
Specifies the distance between the legend labels and the bottom border of the legend.
Left Margin
Specifies the distance between the legend labels and the left border of the legend.
Right Margin
Specifies the distance between the legend labels and the right border of the legend.
Reverse Labels
Specifies whether or not to arrange the legend labels in a reverse order.
Border tab
This tab shows information about borders of the chart legend.
Line Style
Specifies the line style of the legend borders.
Border Type
Specifies the type of the legend borders.
Color
Specifies the color of the legend borders.
Transparency
Specifies the transparency of the legend borders.
Thickness
Specifies the thickness of the legend borders.
Font tab
This tab shows the font-related information of the chart legend.
Font
Specifies the font face of the legend labels.
Size
Specifies the font size of the legend labels.
Fill Type
Specifies the fill type of the legend labels.
Color
Specifies the color of the legend labels.
Transparency
Specifies the transparency of the legend labels.
Font Style
Specifies the font style of the legend labels.
Font Effect
Specifies the font effect of the legend labels.
Font Underline
Specifies the style of the line under the legend labels.
Font Strikeout
Specifies whether or not to attach a strikeout line to the legend labels.
Font Rotation
Specifies the rotation angle of each legend label around its center, in degrees.
Font Shearing
Specifies the shearing transformation of each legend label around its center, in degrees.
Word Wrap
Specifies whether or not to enable word wrapping for the label text.
Format Paper dialog
This dialog helps you to format the paper of a chart. It contains the following tabs (some tabs may be not applicable for
certain chart types):
●
General tab
●
Border tab
●
Coordinate tab
●
Graph tab
●
Threshold Line tab
●
Axis Z tab
●
Bullet tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the chart paper.
Name
Specifies the display name of the chart paper, which will be shown on the shortcut menu of the paper.
X
Specifies the X coordinate of the chart paper.
Y
Specifies the Y coordinate of the chart paper.
Width
Specifies the width of the chart paper.
Height
Specifies the height of the chart paper.
Fill Type
Specifies the type for filling the chart paper.
Color
Indicates the background color of the chart paper.
To change the color, click the color indicator to access the Select Color dialog, and then specify a new color, or input a color
string in the format #RRGGBB. If you want to make the background transparent, input Transparent in the text box.
Transparency
Specifies the transparency of the chart paper background.
Show Tips
Specifies whether to show the corresponding data information when the mouse pointer points at a target in the chart paper.
Show Category and Series
Specifies whether to show data of the category and value axes when the mouse pointer points at a target in the chart
paper. It takes effect only when the option Show Tips is checked.
Border tab
This tab shows information about borders of the chart paper.
Line Style
Specifies the line style of the chart paper borders.
Border Type
Specifies the type of the chart paper borders.
Color
Specifies the color of the chart paper borders.
Transparency
Specifies the transparency of the chart paper borders.
Thickness
Specifies the thickness of the chart paper borders.
Coordinate tab
You can use this tab to view and configure properties of the coordinates.
Scale X
Specifies the scaling ratio for the X axis.
Scale Y
Specifies the scaling ratio for the Y axis.
Scale Z
Specifies the scaling ratio for the Z axis.
Angle X
Specifies the rotation angle around the X axis. Applies to 3-D charts and pie charts.
Angle Y
Specifies the rotation angle around the Y axis. Applies to 3-D charts and pie charts.
Angle Z
Specifies the rotation angle around the Z axis. Applies to 3-D charts and pie charts.
Perspective
Specifies the perspective effect of the chart. Input an integer to set the effect.
Interactive
Specifies whether the chart can be interactive or not.
Graph tab
You can use this tab to view and configure properties of the graphic object.
Bar Width
Specifies the width of the bars. Applies to bar charts only.
Line Thickness
Specifies thickness of the lines. Applies to line charts only.
Show Wall
Specifies whether or not to show the chart wall.
Show Floor
Specifies whether or not to show the chart floor.
Use Depth
Specifies whether to make the chart visually three-dimensional. Applies to 2-D bar, bench, line and area charts only.
●
●
Depth
Specifies the depth of the bars/benches/lines/areas.
Depth Direction
Specifies the angle of the axis along the depth of the bars/benches/lines/areas.
Show Static Data Label
Specifies whether or not to show the static data labels on the data markers. Applies to 2-D bar, bench, line, area, pie and
radar charts only, and wnly when it is set to true can the following static data label related properties take effect.
Data Label Type
Specifies in which way the static data labels will be displayed.
●
Value - Shows the value for each data marker.
●
Category Name - Shows the category name for each pie section. Only applies to pie chart.
●
Percent - Shows the percentage of each data marker to the total.
●
Value and Percent - Shows the value and the percentage for each data marker.
Position
Specifies the position of the static data labels around the data markers.
●
●
●
●
●
●
●
●
●
●
●
Autofit
If selected, the static data labels will be displayed automatically.
Outside Top
If selected, the static data labels will be displayed on the outside top of the bars. Available to bar and bench charts only.
Inside Top
If selected, the static data labels will be displayed on the inside top of the bars. Available to bar and bench charts only.
Inside Center
If selected, the static data labels will be displayed at the inside center of the bars. Available to bar and bench charts only.
Inside Bottom
If selected, the static data labels will be displayed at the inside bottom of the bars. Available to bar and bench charts
only.
Top Center
If selected, the static data labels will be displayed on the top center of the line/area nodes. Available to line and area
charts only.
Top Left
If selected, the static data labels will be displayed on the top left of the line/area nodes. Available to line and area charts
only.
Top Right
If selected, the static data labels will be displayed on the top right of the line/area nodes. Available to line and area
charts only.
Bottom Left
If selected, the static data labels will be displayed at the bottom left of the line/area nodes. Available to line and area
charts only.
Bottom Center
If selected, the static data labels will be displayed at the bottom center of the line/area nodes. Available to line and area
charts only.
Bottom Right
If selected, the static data labels will be displayed at the bottom right of the line/area nodes. Available to line and area
charts only.
●
●
●
●
Sticker
If selected, the static data labels will be displayed beside each section of the pies. Available to pie charts only.
Slim Leg
If selected, the static data labels will be displayed beside each section and pointed by thin lines. Available to pie charts
only.
Best Fit
If selected, the static data labels will be displayed at the best fit position automatically. Available to pie charts only.
On Slices
If selected, the static data labels will be displayed on each section (slice) of the pies. Available to pie charts only.
Auto Arrange
Specifies whether to display the static data labels inside the bars at the best position. Available only to bar and bench
charts and when the static data label's position is set to one of the following: Inside Center, Inside Top or Inside Bottom.
●
●
true
The static data label will be displayed horizontally at the specified position if the bar has enough room horizontally,
otherwise, it will be displayed vertically. If a bar does not have enough room both vertically and horizontally, its static
data label will not be displayed.
false
The static data labels will be displayed at the specified position, and if the labels get overlapping, some of them will not
be displayed.
Show Pie Name
Specifies whether or not to show the pie name. Applies to pie charts only.
Threshold Line tab
You can use this tab to view and configure properties of the threshold lines.
Show Threshold Line1
Specifies whether or not to show the first threshold line.
Threshold Value1
Specifies the value of the first threshold line.
Threshold Line Color1
Specifies the color of the first threshold line.
Show Threshold Line2
Specifies whether or not to show the second threshold line.
Threshold Value2
Specifies the value of the second threshold line.
Threshold Line Color2
Specifies the color of the second threshold line.
Transparency
Specifies the transparency of the threshold lines.
Axis Z tab
You can use this tab to view and configure properties of the Z axis.
Show Axis Z
Specifies whether or not to show the Z axis.
Placement
Specifies the position of the axis.
Show Axis Label Tips
Specifies whether to display the complete label text when the mouser pointer points at a label on the axis.
Label Font Automatic Orientation
Specifies to adjust the rotation angle of the label text on the axis automatically according to the length of the label text, in
degrees.
When this option is true by default:
●
●
If the text can be completely displayed horizontally, the default rotation angle will be 0.
If the text can not be completely displayed horizontally, the default rotation angle will be 30 anticlockwise, and the cut
off part will be shown as suspension points.
Angle
Specifies to customize the rotation angle of the label text on the axis. Activated when Label Font Automatic Orientation is
set to false (unchecked). You can input the angle in the text box directly.
Bullet tab
You can use this tab to view and configure properties of the bullets in a chart.
Featured Measure Width
Specifies the width of the featured measures, measured in a percentage of the unit width. Enter a numeric value to change
the width.
Comparative Measure Width
Specifies the width of the comparative measures, measured in a percentage of the unit width. Enter a numeric value to
change the width.
Qualitative Ranges Width
Specifies the width of the qualitative ranges, measured in a percentage of the unit width. Enter a numeric value to change
the width.
Format Platform dialog
This dialog helps you to format the platform of a chart. It contains the following tabs:
●
General tab
●
Border tab
●
Data tab
●
Others tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the chart platform.
Name
Specifies the display name of the platform, which will be shown on the shortcut menu of the platform.
Position
Displays the position mode of the platform. If the platform is directly contained in the report body, a tabular cell, or a
text box, its position mode can be modified.
●
●
Absolute: The platform's position will be decided by its X and Y property values.
Static: The platform will be positioned at the default location in its container. If selected, the X, Y and other
position-related properties will be hidden or disabled.
X
Specifies the X coordinate of the platform.
Y
Specifies the Y coordinate of the platform.
Width
Specifies the width of the platform.
Height
Specifies the height of the platform.
Fill Type
Specifies a type for filling the platform.
Color
Indicates the background color of the platform.
To change the color, click the color indicator to bring out the Select Color dialog, and then specify a new color, or
input a color string in the format #RRGGBB. If you want to make the background transparent, input Transparent in
the text box.
Transparency
Specifies the transparency of the chart background.
Show Legend
Specifies whether or not to show the legend.
Border tab
This tab shows information about borders of the chart platform.
Line Style
Specifies the line style of the platform borders.
Border Type
Specifies the type of the platform borders.
Color
Specifies the color of the platform borders.
Transparency
Specifies the transparency of the platform borders.
Thickness
Specifies the thickness of the platform borders.
Data tab
You can use this tab to view and configure properties of the chart data.
Sort Category
Specifies the sorting order for the category field values.
Sort Series
Specifies the sorting order for the series field values.
Reverse Category
Specifies whether or not to reverse the category field value sequence.
Reverse Series
Specifies whether or not to reverse the series field value sequence.
Category Start Offset
Specifies the starting offset of the categories.
Category End Offset
Specifies the ending offset of the categories.
Series Start Offset
Specifies the starting offset of the series.
Series End Offset
Specifies the ending offset of the series.
Category Value Encoding
Specifies the encoding format for values on the category axis. Formats here usually refer to the following: BIG5,
EUCJIS, GBK, UTF8, and XXXXX....
Series Value Encoding
Specifies the encoding format for values on the series axis. Formats here usually refer to the following: BIG5, EUCJIS,
GBK, UTF8, and XXXXX....
Swap Data Group
Specifies to display values from different data fields by switching data between the category and series axes, the
category and values axes.
Others tab
You can use this tab to view and configure some miscellaneous settings.
TOC Anchor
Specifies whether or not to add the node that represents the platform to the TOC tree that is displayed in the TOC
Browser.
Suppress When No Records
If true and no records are returned by the report, the platform will not be displayed.
Export to XLS
If true, the platform will be exported when you save the report result as an XLS file (make sure to check Data Format
in the Export dialog).
Export to CSV
If true, the platform will be exported when you save the report result as a TXT file with Delimited Format selected.
Format Value(Y) Axis dialog
This dialog appears when you right-click a chart and select Format Axes > Format Value (Y) Axis from the shortcut menu. It helps
you to format the value(Y) axis of the chart and contains the following tabs:
●
Axis tab
●
Tick Mark tab
●
Font tab
●
Orientation tab
●
Format tab
OK
Applies the changes and closes the dialog.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
Axis tab
Specifies the general properties for the axis.
Option
Specifies the options for the axis.
●
●
●
●
●
●
Minimum Value
Specifies the minimum value that is to be displayed on the axis.
Maximum Value
Specifies the maximum value that is to be displayed on the axis.
Increment
Specifies the difference between two adjacent values on the axis.
Number of Tick Marks
Specifies how many tick marks to be displayed on the axis.
Show Gridlines
Specifies whether to show the horizontal gridlines in the chart.
Show Percent
Specifies whether to show the value labels on the axis in percent. Only applies to radar, bullet, bar/bench, line, and area chart
that are not 100% stacked type.
Line
Specifies the line style for the axis.
●
●
●
●
Color
Specifies the color of the axis.
Style
Specifies the style of the axis.
Transparency
Specifies the transparency for the color of the axis.
Thickness
Specifies the thickness of the axis, in pixels.
Gap
Specifies the properties for the labels on the axis.
●
●
Label Axis Gap
Specifies the distance between the label and the axis, in pixels.
Best Effect
Specifies whether to adjust the labels on the axis automatically to make them placed best.
Tick Mark tab
The tab consists of two sub tabs: major tick mark tab, and minor tick mark tab.
Major Tick Mark tab
Specifies properties of the major tick marks on the axis.
Type
Specifies the type of the major tick marks on the axis.
●
●
●
●
None
If selected, major tick marks will not be shown on the axis and it will be meaningless to specify all the other major tick mark
related properties.
Inside
If selected, major tick marks will be inside the chart.
Outside
If selected, major tick marks will be outside the chart.
Cross
If selected, major tick marks will be across the axis.
Line
Specifies the line properties of the major tick marks on the axis.
●
Correlate with Axis
If checked, the line properties of the major tick marks will correlate with that of the axis automatically.
❍
❍
❍
Color
Specifies the color of the major tick marks.
Transparency
Specifies the transparency for the color of the major tick marks.
Style
Specifies the type of the major tick marks.
❍
●
Thickness
Specifies the thickness of the major tick marks, in pixels.
Tick Mark Length
Specifies the length for the major tick marks, in pixels.
Option
Specifies the other properties of the major tick mark labels on the axis.
●
●
●
●
Show Major Tick Mark Labels
Specifies whether to display the labels of the major tick marks on the axis. If checked, the following properties will be enabled.
Label Every N Major Tick Marks
Specifies the frequency at which the major tick marks will be labeled.
Show Axis Label Tips
Specifies whether to display the complete label text when the mouse pointer points at a label on the axis.
Number of Major Labels
Specifies how many major tick mark labels to be displayed on the axis.
❍
❍
Auto
If checked, all major tick mark labels will be shown.
Fixed
If checked, you can specify the number of the major tick mark labels to be displayed on the axis.
Minor Tick Mark tab
Specifies properties of the minor tick marks on the axis.
Type
Specifies the type of the minor tick marks on the axis.
●
●
●
●
None
If selected, minor tick marks will not be shown on the axis and it will be meaningless to specify all the other minor tick mark
related properties.
Inside
If selected, minor tick marks will be inside the chart.
Outside
If selected, minor tick marks will be outside the chart.
Cross
If selected, minor tick marks will be across the axis.
Line
Specifies the line properties of the minor tick marks on the axis.
●
Correlate with Axis
If checked, the line properties of the minor tick marks will correlate with that of the axis automatically.
❍
❍
❍
❍
●
Color
Specifies the color of the minor tick marks.
Style
Specifies the type of the minor tick marks.
Transparency
Specifies the transparency for the color of the minor tick marks.
Thickness
Specifies the thickness of the minor tick marks, in pixels.
Tick Mark Length
Specifies the length of the minor tick marks, in pixels.
Font tab
Specifies the font format for text in the major tick mark labels on the axis.
Font
Specifies the font face of the label text.
Size
Specifies the font size of the label text.
Fill Type
Specifies the fill type of the label text.
Color
Specifies the color of the label text.
Transparency
Specifies the transparency for the color of the label text.
Font Style
Specifies the font style of the text. It can be one of the following: Plain, Bold, Italic and Bold Italic.
Orientation tab
Specifies the rotation angle of the major tick mark labels on the axis.
Automatic
Specifies whether to adjust the rotation angle of the label text on the axis automatically according to the length of the label text,
in degrees.
When this option is checked by default:
●
●
If the text can be completely displayed horizontally, the default rotation angle will be 0.
If the text cannot be completely displayed horizontally, the default rotation angle will be 30 anticlockwise, and the cut off part
will be shown as suspension points.
Angle
Specifies to customize the rotation angle of the label text on the axis.
Format tab
Specifies the data format of the major tick mark labels on the axis.
Category
Lists the category types. Select one to customize its format.
Format
Displays all the formats of the selected category. Select the required one and click Add to add it as the format of the specified
category. You can add only one format for each category.
Properties
Displays the properties of the format you select. If the formats listed in the Format box cannot meet your requirement, define the
format in the text field and then click Add to add it as the format of the specified category.
Sample
Displays the selected format effects.
Stack
Lists all the formats you select from different categories.
Add
Adds a format to the Stack list box.
Remove
Removes a format from the Stack list box.
Apply
Applies the specified format in the Stack list box to the major tick mark labels.
Format Value(Y2) Axis dialog
This dialog appears when you right-click a chart and select Format Axes > Format Value (Y2) Axis from the shortcut menu. It
helps you to format the value(Y2) axis of the chart and contains the following tabs:
●
Axis tab
●
Tick Mark tab
●
Font tab
●
Orientation tab
●
Format tab
OK
Applies the changes and closes the dialog.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
Axis tab
Specifies the general properties for the axis.
Option
Specifies the options for the axis.
●
●
●
●
●
●
Minimum Value
Specifies the minimum value that is to be displayed on the axis.
Maximum Value
Specifies the maximum value that is to be displayed on the axis.
Increment
Specifies the difference between two adjacent values on the axis.
Number of Tick Marks
Specifies how many tick marks to be displayed on the axis.
Show Gridlines
Specifies whether to show the horizontal gridlines in the chart.
Show Percent
Specifies whether to show the value labels on the axis in percent. Only applies to radar, bullet, bar/bench, line, and area chart
that are not 100% stacked type.
Line
Specifies the line style for the axis.
●
●
●
●
Color
Specifies the color of the axis.
Style
Specifies the style of the axis.
Transparency
Specifies the transparency for the color of the axis.
Thickness
Specifies the thickness of the axis, in pixels.
Gap
Specifies the gap properties for the labels on the axis.
●
●
Label Axis Gap
Specifies the distance between the label and the axis, in pixels.
Best Effect
Specifies whether to adjust the labels on the axis automatically to make them placed best.
Tick Mark tab
The tab consists of two sub tabs: major tick mark tab, and minor tick mark tab.
Major Tick Mark tab
Specifies the properties of the major tick marks on the axis.
Type
Specifies the type of the major tick marks on the axis.
●
●
●
●
None
If selected, major tick marks will not be shown on the axis and it will be meaningless to specify all the other major tick mark
related properties.
Inside
If selected, major tick marks will be inside the chart.
Outside
If selected, major tick marks will be outside the chart.
Cross
If selected, major tick marks will be across the axis.
Line
Specifies the line properties of the major tick marks on the axis.
●
Correlate with Axis
If checked, the line properties of the major tick marks will correlate with that of the axis automatically.
❍
❍
❍
Color
Specifies the color of the major tick marks.
Transparency
Specifies the transparency for the color of the major tick marks.
Style
Specifies the type of the major tick marks.
❍
●
Thickness
Specifies the thickness of the major tick marks, in pixels.
Tick Mark Length
Specifies the length for the major tick marks, in pixels.
Option
Specifies the other properties of the major tick mark labels on the axis.
●
●
●
●
Show Major Tick Mark Labels
Specifies whether to display the labels of the major tick marks on the axis. If checked, the following properties will be enabled.
Label Every N Major Tick Marks
Specifies the frequency at which the major tick marks will be labeled.
Show Axis Label Tips
Specifies whether to display the complete label text when the mouse pointer points at a label on the axis.
Number of Major Labels
Specifies how many major tick mark labels to be displayed on the axis.
❍
❍
Auto
If checked, all major tick mark labels will be shown.
Fixed
If checked, you can specify the number of the major tick mark labels to be displayed on the axis.
Minor Tick Mark tab
Specifies the properties of the minor tick marks on the axis.
Type
Specifies the type of the minor tick marks on the axis.
●
●
●
●
None
If selected, minor tick marks will not be shown on the axis and it will be meaningless to specify all the other minor tick mark
related properties.
Inside
If selected, minor tick marks will be inside the chart.
Outside
If selected, minor tick marks will be outside the chart.
Cross
If selected, minor tick marks will be across the axis.
Line
Specifies the line properties of the minor tick marks on the axis.
●
Correlate with Axis
If checked, the line properties of the minor tick marks will correlate with that of the axis automatically.
❍
❍
❍
❍
●
Color
Specifies the color of the minor tick marks.
Style
Specifies the type of the minor tick marks.
Transparency
Specifies the transparency for the color of the minor tick marks.
Thickness
Specifies the thickness of the minor tick marks, in pixels.
Tick Mark Length
Specifies the length of the minor tick marks, in pixels.
Font tab
Specifies the font format for text in the major tick mark labels on the axis.
Font
Specifies the font face of the label text.
Size
Specifies the font size of the label text.
Fill Type
Specifies the fill type of the label text.
Color
Specifies the color of the label text.
Transparency
Specifies the transparency for the color of the label text.
Font Style
Specifies the font style of the text. It can be one of the following: Plain, Bold, Italic and Bold Italic.
Orientation tab
Specifies the rotation angle of the major tick mark labels on the axis.
Automatic
Specifies whether to adjust the rotation angle of the label text on the axis automatically according to the length of the label text,
in degrees.
When this option is checked by default:
●
●
If the text can be completely displayed horizontally, the default rotation angle will be 0.
If the text cannot be completely displayed horizontally, the default rotation angle will be 30 anticlockwise, and the cut off part
will be shown as suspension points.
Angle
Specifies to customize the rotation angle of the label text on the axis
Format tab
Specifies data format of the major tick mark labels on the axis.
Category
Lists the category types. Select one to customize its format.
Format
Displays all the formats of the selected category. Select the required one and click Add to add it as the format of the specified
category. You can add only one format for each category.
Properties
Displays the properties of the format you select. If the formats listed in the Format box cannot meet your requirement, define the
format in the text field and then click Add to add it as the format of the specified category.
Sample
Displays the selected format effects.
Stack
Lists all the formats you select from different categories.
Add
Adds a format to the Stack list box.
Remove
Removes a format from the Stack list box.
Apply
Applies the specified format in the Stack list box to the major tick mark labels.
Formula Editor dialog
This dialog helps you to create a dynamic formula in a report.
Formula Name
Specifies the name of the formula.
Fields box
Displays a list of those fields that are available for formulas. The fields include the dimension objects and detail information objects in the
current business/report cube, and the dynamic formulas and measures that have been created in the report. You can select one field and
double-click it to insert the field into the editing box at the insertion point.
Functions box
Displays a list of JReport functions that are available for formulas. When you select one function and double-click it, JReport will insert the
selected function into the editing box at the insertion point completely with its required syntax items (parentheses, commas, etc).
Operators box
Displays a list of operators that are available for formulas. Select one operator and double-click it to insert the selected operator into the
formula text box at the insertion point.
Editing box
In this box, you can build and edit your formula. There are several ways to work with formulas:
●
Select formula components from the Fields, Functions and Operators boxes in the Formula Editor, and then double-click the components,
JReport will then insert them in the formula;
●
Type your formula in the editing box directly;
●
Use the above two methods together;
●
Paste formula text from the text document of other programs.
Note: If you refer to any field in the formula, the reference name for that field will be prefixed with an @ sign. If the field name contains
spaces, the reference name in formula will be quoted with double-quotation marks (""). For example, if the field name is Customer Name,
then the reference name will be @"Customer Name".
Check
Tests the syntax of your formula. If the syntax is incorrect, JReport provides an opportunity to correct the errors.
Add Operators
Selects a general operator to be used in the editing box.
Color Converter
A color palette is provided for you to insert the HEX code of a color simply by clicking the corresponding color in the color palette instead of
inputting the HEX code manually.
OK
Creates the formula and adds it to the Resource View panel.
Cancel
Doesn't add the formula and closes the dialog.
Help
Displays this help document.
Group Properties dialog
This dialog helps you to edit the properties of a group object. It contains the following tabs:
●
General tab
●
Others tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the group object.
Expand Detail Data
Specifies whether to expand or collapse the detailed records in the group level.
Keep Group Together
Specifies whether or not to try to keep groups wholly in a report page (try not to make a group across two pages).
Repeat While Group Footer
If the group header is set to be repeated, you can specify whether or not to still repeat the group header when a
page break occurs on the group footer.
Shrink Footer
Specifies whether or not to shrink the group footer when you shrink detailed records in the group level.
Special Function
Specifies a special function for the group level to group. This option is available only when the group field is of
Date/Time type.
Select Type
Specifies the type for Select N condition:
●
●
●
ALL: The Select N condition will not take effect, and all groups will be retrieved.
TOP_N: The first N groups of the group level will be displayed. Herein N is what you type in the Select N text
box.
BOTTOM_N: The last N groups of the group level will be displayed. N is the integer you type in the Select N
text box.
Select N
If you want only the first or last several groups of the group level to be displayed, you can type an integer which
will be the number of groups to be displayed.
Sort
Specifies a sorting direction for the groups of the group level.
Others tab
You can use this tab to view and configure some miscellaneous settings.
TOC Anchor
Specifies whether or not to add the node that represents the object to the TOC tree that is displayed in the TOC
Browser.
Image Properties dialog
This dialog helps you to edit the properties of an image. It contains the following tabs:
●
General tab
●
Others tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the image.
Name
Specifies the display name of the image, which will be shown on the shortcut menu of the image.
Picture Name
Displays the image file name.
Scaling Mode
Specifies the scaling mode for the image. The mode can be:
●
Actual Size: The image will be shown in its actual size.
●
Customize: The image size will be equal to the image field size.
●
Fit Image: The image will be scaled largest to wholly show in the image field.
●
Fit Width: The image will be scaled largest to fit the width of the image field.
●
Fit Height: The image will be scaled largest to fit the height of the image field.
Horizontal Alignment
Specifies the horizontal alignment of the image in its container.
Vertical Alignment
Specifies the vertical alignment of the image in its container.
Rotation
Rotates the image at a specified angle in degrees. The following is the meaning of different values:
●
0 - No rotation.
●
Positive value - Rotate the image clockwise.
●
Negative value - Rotate the image anticlockwise.
Note: When you rotate an image, the rectangle that holds the image maintains its original size, which may
result in that the image exceeds the field border and therefore the parts that extend outside of the border
will be cut off.
X
Specifies the X coordinate of the image.
Y
Specifies the Y coordinate of the image.
Width
Specifies the width of the image.
Height
Specifies the height of the image.
Alt
Specifies the alternate text which will be shown if the image cannot be displayed.
Title
Specifies tip information about the image, which will be displayed when the mouse cursor hovers on the
image.
Others tab
You can use this tab to view and configure some miscellaneous settings.
TOC Anchor
Specifies whether or not to add the node that represents the image to the TOC tree that is displayed in the
TOC Browser.
Suppress When No Records
If true and no records are returned by the report, the image will not be displayed.
Export to XLS
If true, the image will not be exported when you save the report result as an XLS file (make sure to check
Data Format in the Export dialog).
Export to CSV
If true, the image will not be exported when you save the report result as a TXT file with Delimited Format
selected.
Insert Detail Column dialog
The dialog helps you to insert a new detail column into a table.
Resources
Lists all the available data resources for the new detail column. Select the resource you want from the
list.
OK
Inserts the column with the specified resource and closes the dialog.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
Insert Filter Control dialog
The dialog helps you to insert a filter control into a report for filtering data components in the report
(excluding its subreport).
Select Fields
Specifies the fields to bind to the filter control. All the selected fields should be of the same data type.
The common usage is to select one field, and then based on the field to filter the data of the
components created from the same data source as the field.
To filter components using different data sources, choose a common field all the data sources contain
and select the field in all the data sources.
Apply To
Specifies the components to which the filter created with the filter control will be applied.
OK
Inserts a filter control into the report and closes the dialog.
Cancel
Cancels the operation and closes the dialog.
Help
Displays this help document.
Insert Group Column dialog
The dialog helps you to insert new group columns into a table.
Resources
Lists all the available data resources for new group columns.
Adds the selected field to be used to group data in the table.
Removes the selected group by field.
Group By
Lists the fields that are used to group data in the table.
Sort
Specifies how groups at the specific group level will be sorted.
●
●
●
Ascend
Groups will be sorted in an ascending order (A, B, C).
Descend
Groups will be sorted in a descending order (C, B, A).
No Sort
Groups will be sorted in the original order in database.
Group Above
Specifies to place the selected group by field above the detail information.
Group Left Above
Specifies to place the selected group by field left above the detail information.
Group Left
Specifies to place the selected group by field left to the detail information.
Moves the selected group by field one step up.
Moves the selected group by field one step down.
OK
Inserts the group columns and closes the dialog.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
Insert Image dialog
This dialog helps you to insert an image into a report.
Image From
Specifies the source of the image file.
●
Local File
Specifies to use an image from the local file system. The types and size of the images that can be
used are defined by the administrator in the Upload panel.
❍
File Name
Specifies the path and name of the image file. You can click the Browse button to locate the image
file.
●
Web URL
Specifies to use an image via URL.
❍
Image URL
Specifies the URL of the image file. JReport will record the latest 10 entered URLs in the drop-down
list.
Note: If your JReport Server is in an intranet, to successfully access the image via URL, you
need to add the parameters -Dhttp.proxyHost=XXX -Dhttp.proxyPort=XX to the server's
startup file JRServer.bat, which locates in <install_root>\bin.
●
Library
Specifies to use an existing image.
❍
❍
My Images
The My Images folder is a virtual location where JReport Server stores the images that have once
been inserted into reports. Select the one you want to use.
Preview
Displays a preview of the selected image.
OK
Inserts the image in the report and closes the dialog.
Cancel
Cancels the insertion and closes the dialog.
Help
Displays this help document.
Insert Parameter Control dialog
The dialog helps you to insert a parameter control into a report for delivering parameter values to the
report.
Select a Parameter
Specifies a parameter from the list where all the parameters except cascading parameters used by the
current report are displayed.
OK
Inserts a parameter control into the report and closes the dialog.
Cancel
Cancels the insertion and closes the dialog.
Help
Displays this help document.
Insert Parameter Form Control dialog
This dialog helps you to insert a parameter form control into a report for running reports from the
current report.
Please Select Target Reports
Specifies the reports to run.
●
Current Report
Specifies to run the current report with the specified parameters.
❍
●
Select Parameters
Specifies the parameters that are used to run the current report. Once you select one of a group of
cascading parameters, all the other parameters in the cascading group will be selected
automatically, and vice versa.
Others
Specifies to run other reports.
❍
❍
Reports
Specifies the target reports to run. If all the selected reports contain no parameters, you cannot
finish the dialog.
Parameter Information
You can click a report and then view its parameters here.
Include "Submit" Button
Specifies whether the inserted parameter form control contains the Submit button. If Submit is
included, it is used to submit the parameter values you specified in the parameter form control. If
Submit is not included, once you change the values of a parameter in the parameter form control, the
new values will be applied automatically.
OK
Inserts a parameter form control into the report and closes the dialog.
Cancel
Cancels the operation and closes the dialog.
Help
Displays this help document.
Insert Summary Column dialog
The dialog helps you to insert a new summary column into a table.
Resources
Lists all the available data resources for the new summary column. Select the resource you want from
the list.
OK
Inserts the column with the specified resource and closes the dialog.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
Label Properties dialog
This dialog helps you to edit the properties of a label. It contains the following tabs:
●
General tab
●
Font tab
●
Border tab
●
Others tab
●
Display tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the label.
Name
Specifies the display name of the label, which will be shown on the shortcut menu of the label.
Position
Displays the position mode of the label. If the label is directly contained in the report body, a tabular cell, or a
text box, its position mode can be modified.
●
●
Absolute: The label's position will be decided by its X and Y property values.
Static: The label will be positioned at the default location in its container. If selected, the X, Y and other
position-related properties will be hidden or disabled.
Text
Specifies the text of the label.
X
Specifies the X coordinate of the label.
Y
Specifies the Y coordinate of the label.
Width
Specifies the width of the label.
Height
Specifies the height of the label.
Top Padding
Specifies the space between the text of the label and its top border.
Bottom Padding
Specifies the space between the text of the label and its bottom border.
Left Padding
Specifies the space between the text of the label and its left border.
Right Padding
Specifies the space between the text of the label and its right border.
Background
Specifies the background color of the label.
To change the color, click the color indicator to access the Select Color dialog and then specify a new color, or
input a color string in the format #RRGGBB. If you want to make the background transparent, input Transparent
in the text box.
Foreground
Specifies the foreground color of the label.
To change the color, click the color indicator to access the Select Color dialog and then specify a new color, or
input a color string in the format #RRGGBB.
Font tab
This tab shows the font-related information of the label.
Font
Specifies the font face of the label text.
Size
Specifies the font size of the label text.
Horizontal Alignment
Specifies the horizontal alignment mode of the text in the label.
Vertical Alignment
Specifies the vertical alignment mode of the text in the label.
Bold
Specifies whether to make the label text bold or not.
Underline
Specifies whether the label text will be underlined or not.
Strikethrough
Specifies whether or not to attach a strikeout line to the label text.
Italic
Specifies whether to make the label text italic or not.
Autofit
Specifies whether or not to automatically adjust the width of the label.
Word Wrap
Specifies whether or not to wrap the text to the label width.
Ignore HTML Tag
If this option is unchecked, JReport will parse HTML tag elements in the field value while the report is to be saved
as an HTML file; or the field value will appear in the HTML file the same as that in JReport Viewer (HTML tag
elements in the field value, if any, will not be parsed).
Border tab
This tab shows information about borders of the label. You can modify all the border settings in this tab.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Shadow
Specifies whether the borders will have a shadow effect or not.
Shadow Color
Specifies the color of the border shadow.
Others tab
You can use this tab to view and configure some miscellaneous settings.
TOC Anchor
Specifies whether or not to add the node that represents the label to the TOC tree that is displayed in the TOC
Browser.
Suppress When No Records
If true and no records are returned by the report, the label will not be displayed.
Export to XLS
If true, the label will be exported when you save the report result as an XLS file (make sure to check Data Format
in the Export dialog).
Export to CSV
If true, the label will be exported when you save the report result as a TXT file with Delimited Format selected.
Logic Column
Specifies whether to show the label in the next visible table cell in the same row when the column which holds the
label is hidden.
Display tab
You can use this tab to modify the display type of the label. For details, see the Data Field Properties dialog.
Max Records dialog
This dialog allows you to set the maximum number of records for components to retrieve.
Max Records
Specifies the maximum record number. All means that all records will be retrieved, Top 10/20/50/100
means that the first 10/20/50/100 records will be retrieved, and you can directly input a number here
to retrieve the corresponding first records.
Note: If any filter condition has been set on the component, which will filter out some records, the
number of retrieved records may not accord with the number set for Max Records.
OK
Applies the settings to report components and closes this dialog.
Cancel
Discards the settings and closes this dialog.
Help
Displays this help document.
Multivalue Container Properties dialog
This dialog helps you to edit the properties of a multivalue container. It contains the following tabs:
●
General tab
●
Font tab
●
Border tab
●
Others tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the multivalue container.
Name
Specifies the display name of the multivalue container, which will be shown on its shortcut menu.
Position
Specifies the position mode of the multivalue container. If the multivalue container is directly contained
in the report body, a tabular cell, or a text box, its position mode can be modified.
●
●
Absolute: The multivalue container's position will be decided by its X and Y property values.
Static: The multivalue container will be positioned at the default location in its container. If selected,
the X, Y and other position-related properties will be hidden or disabled.
X
Specifies the X coordinate of the multivalue container.
Y
Specifies the Y coordinate of the multivalue container.
Width
Specifies the width of the multivalue container.
Height
Specifies the height of the multivalue container.
Background
Specifies the background color of the multivalue container.
To change the color, click the color indicator to access the Select Color dialog and then specify a new
color, or input a color string in the format #RRGGBB. If you want to make the background transparent,
input Transparent in the text box.
Foreground
Specifies the foreground color of the multivalue container.
To change the color, click the color indicator to access the Select Color dialog and then specify a new
color, or input a color string in the text box.
Font tab
This tab shows the font-related information of the multivalue container.
Font
Specifies the font face of the text.
Size
Specifies the font size of the text.
Bold
Specifies whether to make the text bold or not.
Italic
Specifies whether to make the text italic or not.
Border tab
This tab shows information about borders of the multivalue container.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Others tab
You can use this tab to view and configure some miscellaneous settings.
TOC Anchor
Specifies whether or not to add the node that represents the multivalue container to the TOC tree that
is displayed in the TOC Browser.
Suppress When No Records
If true and no records are returned by the report, the multivalue container will not be displayed.
Export to XLS
If true, the multivalue container will be exported when you save the report result as an XLS file (make
sure to check Data Format in the Export dialog).
Export to CSV
If true, the multivalue container will be exported when you save the report result as a TXT file with
Delimited Format selected.
Navigation Control Properties dialog
This dialog helps you to edit the properties of a navigation control. It contains the following tabs:
●
General tab
●
Border tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the navigation control.
Name
Specifies the name of the navigation control.
Position
Displays the position mode of the navigation control. If the navigation control is directly contained in the
report body, a tabular cell, or a text box, its position mode can be modified.
●
●
Absolute: The navigation control's position will be decided by its X and Y property values.
Static: The navigation control will be positioned at the default location in its container. If selected, the X, Y
and other position-related properties will be hidden or disabled.
X
Specifies the X coordinate of the navigation control.
Y
Specifies the Y coordinate of the navigation control.
Width
Specifies the width of the navigation control.
Height
Specifies the height of the navigation control.
Background
Specifies the background color of the navigation control.
To change the color, click the color indicator to access the Select Color dialog and then specify a new color,
or input a color string in the format #RRGGBB. If you want to make the background transparent, input
Transparent in the text box.
Border tab
This tab shows information about borders of the navigation control.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
New Page Report dialog
This dialog helps you to create a new page report that contains one report tab.
Report Title
Specifies the title of the report tab.
Choose Report Layout
Lists the report layouts on which you can create your report tab.
●
●
●
Banded
Creates a report containing a banded object.
Table (Group Above)
Creates a report containing a table with group information above the detail panel.
Table (Group Left)
Creates a report containing a table with group information left to the detail panel.
●
●
●
●
●
Table (Group Left Above)
Creates a report containing a table with group information left above the detail panel.
Summary Table
Creates a report containing a table with only group and summary information.
Chart
Creates a report containing a chart.
Crosstab
Creates a report containing a crosstab.
Blank
Creates a report with nothing in it.
OK
Closes this dialog, and in accord with the selected report layout, the corresponding component wizard will be displayed,
or a new page report will be created with a blank report tab if Blank is selected.
Jump to the corresponding component wizard:
●
●
Banded Wizard
Table Wizard
All four table types go to this wizard.
●
Chart Wizard
●
Crosstab Wizard
Cancel
Closes this dialog without creating a page report.
Help
Displays this help document.
New Report Tab dialog
This dialog helps you to append a new report tab to the current report.
Report Title
Specifies the title of the report tab.
Choose Report Layout
Lists the report layouts on which you can create your report tab.
●
●
●
Banded
Creates a report containing a banded object.
Table (Group Above)
Creates a report containing a table with group information above the detail panel.
Table (Group Left)
Creates a report containing a table with group information left to the detail panel.
●
●
●
●
●
Table (Group Left Above)
Creates a report containing a table with group information left above the detail panel.
Summary Table
Creates a report containing a table with only group and summary information.
Chart
Creates a report containing a chart.
Crosstab
Creates a report containing a crosstab.
Blank
Creates a report with nothing in it.
OK
Closes this dialog, and in accord with the selected report layout, the corresponding component wizard will be displayed,
or a blank report will be created if Blank is selected.
Jump to the corresponding component wizard:
●
●
Banded Wizard
Table Wizard
All four table types go to this wizard.
●
Chart Wizard
●
Crosstab Wizard
Cancel
Closes this dialog without creating a report tab.
Help
Displays this help document.
New Toolbar Name dialog
This dialog helps you to input the name for the new toolbar.
Name
Specifies the name of the new toolbar.
A valid toolbar name:
●
●
Can only contain alphanumeric characters, underlines and spaces (except for at the beginning or end
of the name).
Cannot be the same as that of an existing toolbar.
OK
Accepts a valid name (see above), and returns to the Options dialog.
Cancel
Closes this dialog without creating a new toolbar.
Help
Displays this help document.
Open Report Tabs dialog
This dialog helps you to open or hide report tabs in the current report, and shows the display name and
description of each report tab.
In this dialog, the open report tabs in the current report are marked with a check symbol. To change
the display state of the report tabs in the report, check those report tabs to be opened, uncheck those
to be closed, and then click the OK button.
Display Name
Shows the display names of the report tabs in the report.
Instance Name
Shows the instance names of the report tabs in the report.
Description
Shows the descriptions of the report tabs if any.
OK
Closes this dialog, opens the selected report tabs, and closes those deselected.
Cancel
Closes this dialog without changing the report display state.
Help
Displays this help document.
Options dialog
This dialog helps you to set the user interface of JReport Viewer. It contains the following tabs:
●
Option tab
●
Customize tab
Restore Defaults
Restores the default settings.
OK
Applies the settings and closes the Options dialog.
Cancel
Cancels the settings and closes the Options dialog.
Help
Displays this help document.
Option tab
This tab allows you to specify the skin of JReport Viewer user interface.
Skin
Specifies the skin of the JReport Viewer user interface. The skin can be the Standard, Classical, or
Windows XP style.
Customize tab
This tab allows you to customize the toolbars in JReport Viewer.
Current Toolbar
Lists all the available toolbars. If you want to customize a toolbar, click it to select.
Displays the New Toolbar Name dialog for you to input the name for the new toolbar. The new toolbar
name will then be displayed in the Current Toolbar list box.
Removes the selected toolbar.
Available Tools
Displays the tools that you can add to the toolbars. The tools available in the box are determined by
which feature profile is applied.
Selected Tools
Displays the tools of the toolbar selected in the Current Toolbar list box in the order that they will
appear (from left to the right) on the toolbar.
Adds the selected tool from the Available Tools list box to the Selected Tools list box.
Removes the selected tool.
Empties the contents of the Selected Tools list box.
Adds all the available tools from the Available Tools list box to the Selected Tools list box.
Adjusts the location of the selected tool by moving it to the left on the toolbar.
Adjusts the location of the selected tool by moving it to the right on the toolbar.
Order/Select N dialog
This dialog helps you to set the sort order and the Select N condition in a chart.
Order
Specifies in which order data on the category/series axis of a chart will be displayed.
●
●
●
Ascend
Lists data in an ascending order.
Descend
Lists data in a descending order.
No Sort
Keeps the data in their original order.
Select N
Specifies the Select N condition to define the number of category/series values that will be displayed
while others are hidden.
Select N
●
❍
❍
❍
●
●
All
If selected, all category/series values in the chart will be displayed.
Top
If selected, specify a number in the text box to the right and the first N category/series values in
the chart will be displayed.
Bottom
If selected, specify a number in the text box to the right and the last N category/series values in
the chart will be displayed.
Based On
If checked, the category/series values will be sorted by the values of the summary selected with the
direction specified. If unchecked, the category/series values will be sorted by the order specified in
the Order box of the dialog.
Other
Enabled when Top or Bottom is selected from the Select N drop-down list. Check this option and then
type a character string in the text box to group all the category/series values beyond the top/bottom
N category/series values.
OK
Accepts the changes and closes the dialog.
Cancel
Discards the changes and closes the dialog.
Help
Displays this help document.
Page Properties dialog
This dialog helps you to control the report page settings.
Page
Specifies the page properties.
●
●
●
Type
Specifies the paper type.
Width
Shows the paper width. If you select the paper type as Custom size, you can input the width of the
paper here.
Height
Shows the paper height. If you select the paper type as Custom size, you can input the height of the
paper here.
Orientation
Specifies the paper orientation.
●
●
Portrait
Displays the report data in a portrait orientation (vertically).
Landscape
Displays the report data in a landscape orientation (horizontally).
Margin
Specifies the margin properties.
●
●
●
●
Top Margin
Specifies the distance of report data to the top edge of the page.
Left Margin
Specifies the distance of report data to the left edge of the page.
Bottom Margin
Specifies the distance of report data to the bottom edge of the page.
Right Margin
Specifies the distance of report data to the right edge of the page.
OK
Applies all changes and closes this dialog.
Cancel
Does not retain any changes and exits this dialog.
Help
Displays this help document.
Parameter Control Properties dialog
This dialog helps you to edit the properties of a parameter control. It contains the following tabs:
●
General tab
●
Font tab
●
Border tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the parameter control.
Name
Specifies the name of the parameter control.
Parameter
Displays the name of the parameter.
Format
Specifies the display format of the parameter value.
Position
Displays the position mode of the parameter control. If the parameter control is directly contained in the
report body, a tabular cell, or a text box, its position mode can be modified.
●
●
Absolute: The parameter control's position will be decided by its X and Y property values.
Static: The parameter control will be positioned at the default location in its container. If selected, the X, Y
and other position-related properties will be hidden or disabled.
X
Specifies the X coordinate of the parameter control.
Y
Specifies the Y coordinate of the parameter control.
Width
Specifies the width of the parameter control.
Height
Specifies the height of the parameter control.
Top Padding
Specifies the space between the text of the parameter control and its top border.
Bottom Padding
Specifies the space between the text of the parameter control and its bottom border.
Left Padding
Specifies the space between the text of the parameter control and its left border.
Right Padding
Specifies the space between the text of the parameter control and its right border.
Background
Specifies the background color of the parameter control.
To change the color, click the color indicator to access the Select Color dialog and then specify a new color,
or input a color string in the format #RRGGBB. If you want to make the background transparent, input
Transparent in the text box.
Foreground
Specifies the foreground color of the parameter control.
To change the color, click the color indicator to access the Select Color dialog and then specify a new color,
or input a color string in the format #RRGGBB.
Font tab
This tab shows the font-related information of the text in the parameter control.
Font
Specifies the font face of the text.
Size
Specifies the font size of the text.
Horizontal Alignment
Specifies the horizontal alignment mode of the text.
Vertical Alignment
Specifies the vertical alignment mode of the text.
Bold
Specifies whether to make the text bold or not.
Underline
Specifies whether the text will be underlined or not.
Italic
Specifies whether to make the text italic or not.
Border tab
This tab shows information about borders of the parameter control.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Parameter Field Properties dialog
This dialog helps you to edit the properties of a parameter field. It contains the following tabs:
●
General tab
●
Font tab
●
Border tab
●
Others tab
●
Display tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the parameter field.
Name
Specifies the display name of the parameter field, which will be shown on the shortcut menu of the
parameter.
Position
Specifies the position mode of the parameter field. If the parameter field is directly contained in the report
body, a tabular cell, or a text box, its position mode can be modified.
●
●
Absolute: The parameter field's position will be decided by its X and Y property values.
Static: The parameter field will be positioned at the default location in its container. If selected, the X, Y
and other position-related properties will be hidden or disabled.
Format
Specifies the data format of the parameter field.
X
Specifies the X coordinate of the parameter field.
Y
Specifies the Y coordinate of the parameter field.
Width
Specifies the width of the parameter field.
Height
Specifies the height of the parameter field.
Top Padding
Specifies the space between the text of the parameter field and its top border.
Bottom Padding
Specifies the space between the text of the parameter field and its bottom border.
Left Padding
Specifies the space between the text of the parameter field and its left border.
Right Padding
Specifies the space between the text of the parameter field and its right border.
Background
Specifies the background color of the parameter field.
To change the color, click the color indicator to access the Select Color dialog, and then specify a new color,
or input a color string in the format #RRGGBB. If you want to make the background transparent, input
Transparent in the text box.
Foreground
Specifies the foreground color of the parameter field.
To change the color, click the color indicator to access the Select Color dialog and then specify a new color,
or input a color string in the text box.
Font tab
This tab shows the font-related information of the parameter field.
Font
Specifies the font face of the field text.
Size
Specifies the font size of the field text.
Horizontal Alignment
Specifies the horizontal alignment mode of the text in the parameter field.
Vertical Alignment
Specifies the vertical alignment mode of the text in the parameter field.
Bold
Specifies whether to make the field text bold or not.
Underline
Specifies whether the field text will be underlined or not.
Strikethrough
Specifies whether or not to attach a strikeout line to the field text.
Italic
Specifies whether to make the field text italic or not.
Autofit
Specifies whether or not to automatically adjust the width of the parameter field.
Word Wrap
Specifies whether or not to wrap the text to the parameter field width.
Ignore HTML Tag
If this option is unchecked, JReport will parse HTML tag elements in the field value while the report is to be
saved as an HTML file; or the field value will appear in the HTML file the same as that in JReport Viewer
(HTML tag elements in the field value, if any, will not be parsed).
Border tab
This tab shows information about borders of the parameter field.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Shadow
Specifies whether the borders will have a shadow effect or not.
Shadow Color
Specifies the color of the border shadow.
Others tab
You can use this tab to view and configure some miscellaneous settings.
TOC Anchor
Specifies whether or not to add the node that represents the parameter field to the TOC tree that is displayed
in the TOC Browser.
Suppress When No Records
If true and no records are returned by the report, the parameter field will not be displayed.
Export to XLS
If true, the parameter field will be exported when you save the report result as an XLS file (make sure to
check Data Format in the Export dialog).
Export to CSV
If true, the parameter field will be exported when you save the report result as a TXT file with Delimited
Format selected.
Display tab
For a parameter field, you can change its display type to one of the following: Text, Rank, Image, Barcode,
Text Field, Hidden Field, Text Area, Checkbox, Radio Button, List, Drop-down List, Image Button, Button,
Submit, Reset and Hidden.
List
Specifies to display the parameter field as list.
Name
Specifies the name of the list.
Title
Specifies the title of the list.
Selected
Specifies the item to be selected.
Allow Multiple
Specifies whether or not to allow multiple items to be selected.
Disabled
Specifies whether or not to make the list disabled.
Drop-down List
Specifies to display the parameter field as drop-down list.
Name
Specifies the name of the drop-down list.
Title
Specifies the title of the drop-down list.
Selected
Specifies the item to be selected.
Disabled
Specifies whether or not to make the drop-down list disabled.
Note: For the rest display types, see the Data Field Properties dialog.
Parameter Form Control Properties dialog
This dialog helps you to edit the properties of a parameter form control. It contains the following tabs:
●
General tab
●
Border tab
●
Title tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the parameter form control.
Name
Specifies the name of the parameter form control.
Position
Displays the position mode of the parameter form control. If the parameter form control is directly contained
in the report body, a tabular cell, or a text box, its position mode can be modified.
●
●
Absolute: The parameter form control's position will be decided by its X and Y property values.
Static: The parameter form control will be positioned at the default location in its container. If selected,
the X, Y and other position-related properties will be hidden or disabled.
X
Specifies the X coordinate of the parameter form control.
Y
Specifies the Y coordinate of the parameter form control.
Width
Specifies the width of the parameter form control.
Height
Specifies the height of the parameter form control.
Background
Specifies the background color of the parameter form control.
To change the color, click the color indicator to access the Select Color dialog and then specify a new color,
or input a color string in the format #RRGGBB. If you want to make the background transparent, input
Transparent in the text box.
Show Title
Specifies whether to show the title of the parameter form control.
Border tab
This tab shows information about borders of the parameter form control.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Title tab
This tab shows information about the title of the parameter form control. It is available when the Show Title
option is selected in the General tab of the same dialog.
Text
Specifies the text of the title.
Background
Specifies the background color of the title.
To change the color, click the color indicator to access the Select Color dialog and then specify a new color,
or input a color string in the format #RRGGBB. If you want to make the background transparent, input
Transparent in the text box.
Foreground
Specifies the foreground color of the title.
To change the color, click the color indicator to access the Select Color dialog and then specify a new color,
or input a color string in the format #RRGGBB.
Font
Specifies the font face of the text.
Size
Specifies the font size of the text.
Horizontal Alignment
Specifies the horizontal alignment mode of the text.
Bold
Specifies whether to make the text bold or not.
Underline
Specifies whether the text will be underlined or not.
Italic
Specifies whether to make the text italic or not.
PDF Encrypt Option dialog
This dialog helps you to set encryption options for the PDF file to be saved.
Compatibility
Specifies the encryption type to encrypt the PDF document. The option Acrobat 3.0 and later uses a low
encryption level (40-bit RC4), while the other option Acrobat 5.0 and later uses a high encryption level
(128-bit RC4).
Encryption Level
Shows the level of the encryption compatibility that you specified in the Compatibility drop-down list.
Require a password to open the document
Specifies the Document Open Password to prevent others from opening the document without
authorization.
●
●
Document Open Password
Specifies the password to prevent others from opening the document without authorization.
Confirm Password
Confirms the password you have specified in the Document Open Password text box.
Use a password to restrict printing and editing of the document and its security settings
Specifies the Permission Password to prevent others from printing and editing the document. The
password you specify here cannot be the same as the one that you use to open the document.
●
●
●
●
Permissions Password
Specifies the password to prevent others from printing and editing.
Confirm Password
Confirms the password you have specified in the Permissions Password text box.
Printing Allowed
Specifies the printing quality for the PDF document.
Changes Allowed
Specifies the editing actions that are permitted in the PDF document.
Enable copying of text, images and other content
Allows others to select and copy the contents of the PDF document.
Enable text access for screen reader devices for the visually impaired
Allows visually impaired users to read the PDF document with window readers. This option is available
only if the Compatibility option is set to Acrobat 5.0 or later Acrobat version.
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
PDF Sign Option dialog
This dialog helps you to set signing options for the PDF file to be saved.
Method
Specifies the digital signing method.
Digital ID File
Specifies whether to use a digital ID file from a specified directory.
User Password
Specifies a password for this digital ID file.
Confirm Password
Confirms the password.
Reason for Signing Document
Specifies the reason for signing the document.
Edit by Yourself
Edits the reason for signing the document. It is enabled when I agree to 'specified' portions of this
document is selected from the Reason for Signing Document drop-down list.
Location
Specifies your location accordingly.
Your Contact Information
Specifies your contact information accordingly.
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
Printable Version dialog
This dialog helps you to set the print settings.
Format
Specifies the format to which the report result will be printed.
●
●
PDF
Specifies to print the report result to a PDF file.
HTML
Specifies to print the report result to a HTML file.
Page Range
Specifies the range of the pages that are to be printed.
●
All
Specifies that all pages will be printed.
●
●
Current Page
Specifies that only the current page will be printed.
Pages
Specifies page numbers and/or page ranges separated by commas.
OK
Prints the report result with the specified settings to a PDF or HTML file and opens it in an associated
program with which you can print the result to a printer.
Cancel
Cancels the print settings and closes this dialog.
Help
Displays this help document.
Query Filter dialog
This dialog helps you to apply a filter to the business/report cube used by the specified data component to
narrow down its data scope. It has the following two modes:
●
Basic
●
Advanced
Advanced/Basic
Switches the dialog to the advanced/basic mode.
OK
Applies the settings and closes the dialog.
Cancel
Closes the dialog and discards any changes.
Help
Displays this help document.
Basic mode
The basic mode provides function for creating simple filter conditions which are connected by the AND and OR
operators.
Query Filter
Specifies the filter you want to apply to the business/report cube.
●
●
User Defined
Specifies to create a user defined filter to apply to the business/report cube.
Predefined filters
The names of the predefined filters which were created on the business/report cube in JReport Designer. You
can choose one of them to apply.
❍
❍
Edit
Edits the selected predefined filter. Once a predefined filter is edited, it will be saved as a user defined filter
in the business/report cube.
Description
Displays the description of the selected predefined filter.
Deletes the current condition line.
Field
Specifies the field to be filtered.
Operator
Specifies the operator to compose the filter expression.
●
●
●
●
●
●
●
●
●
●
=
Equal to
>
Greater than
>=
Greater than or equal to
<
Less than
<=
Less than or equal to
!=
Not equal to
[not] in
Causes an enumerated list of values to appear in the WHERE clause predicate, used for evaluating for a true
condition.
[not] like
Like string pattern matching operator is used to compare the first expression string value to the pattern string
(the second expression). If you want to use wildcard character in the pattern string, only "_" and "%" are
supported.
[not] between
Allows the system to evaluate whether or not data values are located between a range of values indicated in
the predicate.
is [not] null
It is used in WHERE clause predicates to match null values occurring in a specified data field.
Value
Specifies the value of how to filter the field. You can either enter the value manually in the text box or select a
value from the drop-down list. Click the button
or
to switch to filter the field by field or value. When you
type in the value manually, if multiple values are required, they should be separated with ",", and if "," or "\" is
contained in the values, write it as "\," or "\\".
Logic
Lists the logic operator.
●
●
AND
Logic operator AND which is applied to this and the next line.
OR
Logic operator OR which is applied to this and the next line.
Advanced mode
The advanced mode enables the building of more complex filter conditions via the grouping of conditions.
Query Filter
Specifies the filter you want to apply to the business/report cube.
●
●
User Defined
Specifies to create a user defined filter to apply to the business/report cube.
Predefined filters
The names of the predefined filters which were created on the business/report cube in JReport Designer. You
can choose one of them to apply.
❍
Edit
Edits the selected predefined filter. Once a predefined filter is edited, it will be saved as a user defined filter
in the business/report cube.
Description
Displays the description of the selected predefined filter.
❍
Add Condition
Adds a new condition line.
Delete
Deletes the selected condition line.
Group
Makes the selected conditions in one group. Conditions can also be added to an existing group by selecting the
conditions and the group while holding the Ctrl button, and then clicking the Group button.
Ungroup
Makes the selected condition ungrouped.
Up
Moves the selected condition or group up to a higher level.
Down
Moves the selected condition or group down to a lower level.
Logic
Specifies the logic operator.
●
●
●
●
AND
Logic operator AND which is applied to this and the next line.
OR
Logic operator OR which is applied to this and the next line.
AND NOT
Logic operator AND NOT which is applied to this and the next line.
OR NOT
Logic operator OR NOT Not which is applied to this and the next line.
Field
Specifies the field to be filtered.
Operator
Specifies the operator to compose the filter expression.
Value
Specifies the value of how to filter the field. You can either enter the value manually in the text box or select a
value from the drop-down list. Click the button
or
to switch to filter the field by field or value. When you
type in the value manually, if multiple values are required, they should be separated with ",", and if "," or "\" is
contained in the values, write it as "\," or "\\".
Condition Expression
Displays the SQL statement of the filter condition.
Related topics:
●
Applying filters to business/report cubes
Rename Report Tab dialog
This dialog helps you to rename the current report tab.
Input New Name
Specifies the new name for the report tab.
OK
Applies the new name to the report tab and closes this dialog.
Cancel
Discards the setting and closes this dialog.
Help
Displays this help document.
Report Body Properties dialog
This dialog helps you to set the properties of the report body. It contains the following tabs:
●
General tab
●
Border tab
●
Others tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the report body.
Name
Specifies the display name of the report body, which will be shown on its shortcut menu.
Background
Specifies the background color of the report body.
To change the color, click the color indicator to access the Select Color dialog and then specify a new
color, or input a color string in the format #RRGGBB. If you want to make the background transparent,
input Transparent in the text box.
Border tab
This tab shows information about borders of the report body.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Others tab
You can use this tab to view and configure some miscellaneous settings.
TOC Anchor
Specifies whether or not to add the node that represents the report body to the TOC tree that is
displayed in the TOC Browser.
Suppress When No Records
If true and no records are returned by the report, the report body will not be displayed.
Export to XLS
If true, the report body will be exported when you save the report result as an XLS file (make sure to
check Data Format in the Export dialog).
Export to CSV
If true, the report body will be exported when you save the report result as a TXT file with Delimited
Format selected.
Report Parameters dialog
This dialog appears when you click Finish in a report wizard to run a page report with parameters or
click Menu > Report > Change Parameters if the current report has parameters. It helps you to input
parameter values for a report.
You may specify parameter values in these ways:
●
●
●
In the parameter value combo box, select the required one from the drop-down list or input the
value manually.
Click the chooser button
if it is available to specify multiple values in the Enter Values dialog.
Click the calendar button
if it is available to specify a date and time value using either calendar
or expression in the Calendar dialog.
OK
Accepts the parameter values or further processing.
Help
Displays this help document.
Report Properties dialog
This dialog helps you to set the properties of a report. It contains the following tabs:
●
General tab
●
Others tab
OK
Applies the settings and closes this dialog.
Cancel
Discards the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the report.
Name
Specifies the report name.
Records per Page
Specifies the number of records in each page for the data buffer.
Page Background
Specifies the page background color.
Max Page Number
Specifies the maximum number of pages in the data buffer.
Max Records
Specifies the maximum number of records you want to display for the whole report.
Result Buffer Size
Specifies the size of the result buffer for storing the report result.
Embedded Fonts
Specifies the True Type Fonts that have been used in the report. This property is only for exporting PDF
files.
Compress If No Record
If this option is set to true and there is no record retrieved to the report, the report page will be
compressed.
Para List Auto
If true, values defined in the catalog will be used as the default parameter values; otherwise, JReport will
get the default values from a specified class file.
Others tab
This tab shows some miscellaneous information of the current report.
National Language Support
Specifies a language profile file.
Compress Result
Specifies whether or not to compress the exported RST file.
Excel Buffer Size
Specifies the size of the Excel buffer to store the XLS format report result.
Fast Pass
If true, the performance of the engine when saving the report result to a CSV format file on JReport Server
will be improved.
Rows per Sheet
Specifies the maximal number of rows for every worksheet when exporting the result to an XLS file.
Applet Width
Specifies the applet width for the exported applets to be run in a web server.
Applet Height
Specifies the applet height for the exported applets to be run in a web server.
Save As dialog
This dialog helps you to save a report as a new file.
Save In
Specifies the directory in the server resource tree where you want to save the report. Use the button
to go to the parent folder.
The resource table shows the resources in the current directory.
File Name
Specifies the name for the saved report, without suffix.
File Type
Specifies the type of the saved report.
Advanced/Simple
Displays the following settings or hides them.
●
Catalog
Shows the catalog that the report uses.
The following two options are available only when Select Catalog Linking Model is checked in the
Profile > Customize Profile > DHTML > Properties > Advanced tab.
❍
❍
●
●
●
Set Original Catalog as Linked Catalog into Saved Report
If checked, the saved report will be linked with the catalog and the saved report will run with the
catalog no matter whether the two are in the same directory. If later the catalog is updated, the
saved report will run with the latest version of the catalog.
Set Catalog Copy to Target Folder
If checked, the catalog will be copied to the directory where the report is saved and the saved
report will run with the copied catalog.
Save Sort Criteria
Specifies whether or not to save the changes made by sorting.
Save Filter Criteria
Specifies whether or not to save the changes made by filtering.
Description
Provides a description for the saved report.
OK
Saves the new file with the specified settings and closes this dialog.
Cancel
Does not save the report as a new file and closes the dialog.
Help
Displays this help document.
Save Report Template dialog
This dialog requires your confirmation on whether or not to save the report template when saving a
report. You can use the option Pop Up Save Criteria Dialog in the Profile > Customize Profile > DHTML
> Properties > Default tab to control whether or not to display this dialog when saving a report.
Save Sort Criteria
Specifies whether or not to save the sorting criteria with the report.
Save Filter Criteria
Specifies whether or not to save the filtering criteria with the report.
Yes
Applies the settings and closes this report.
Cancel
Does not save the changes to the report and returns to the report.
Help
Displays this help document.
Search dialog
This dialog helps you to find specific text in a report.
The content can be found in two places - in the values of a certain field, or in the report content.
●
●
To find a certain field value, select the field from the Select Field drop-down list, define the value
range in the Value Range drop-down list and then select the value from the Value drop-down list.
To find text in the report content, check the Search in Whole Report checkbox, type the search
content in the Value box.
Select Field
Specifies the field in which you want to find the text. Disabled when Search in Whole Report is checked.
Value Range
Specifies the range of the displayed values so that you can select a required value quickly from the
Value field. Disabled when Search in Whole Report is checked.
Note: If All is selected in the Value Range drop-down list, the only item in the Value drop-down list will
be All and you cannot change the value, in which case, when you submit the search, JReport will search
for all the values of the selected field.
Value
Specifies the text you want to find. When Search in Whole Report is unchecked, you can select a value
from the drop-down list.
Search in Whole Report
Finds text in the report content. The Select Field drop-down list and the Value Range drop-down list are
disabled when this box is checked.
Match Case
Finds text only if it matches the capitalization of the text you have entered.
Find Whole Word
Finds text only if it matches a whole word.
Highlight All
Highlights all the matching text.
Direction
Specifies the searching direction.
●
●
Up
Searches from the last found string to the beginning of the report.
Down
Searches from the last found string to the end of the report. This option is selected by default.
Search
Searches the report or field value for the next match of the specified text.
Cancel
Cancels the operation and closes this dialog.
Help
Displays this help document.
Select Color dialog
This dialog helps you to specify a color. It contains the following tabs:
●
Swatches tab
●
Color Picker tab
OK
Closes this dialog and returns the color value specified in the current tab.
Cancel
Closes this dialog without changing the color value.
Help
Displays this help document.
Swatches tab
This tab allows you to select one from the web safe color swatches.
Web Safe Colors
Lists the web safe colors for you to select one.
Transparent
Click this swatch to delete the color and specify the object to be transparent.
Color indicator
The upper part will be displayed in the color you selected from Web Safe Colors and labeled the
hexadecimal value of the color (or "Transparent" if you click the Transparent swatch). The lower part is
always displayed in the original color. Clicking the lower part will restore the color to the original.
Color Picker tab
This tab allows you to customize the color in JReport Viewer.
Select Color
Displays a color matrix. To define a color, click anywhere in the matrix. Change saturation by moving
the pointer horizontally, and change brightness by moving the pointer vertically.
Color slider
Drag the slider to change the hue.
Color indicator
The upper part will be displayed in the color you have newly defined. The lower part is always displayed
in the original color. Clicking the lower part will restore the color to the original.
R
Specifies the amount of red in a color.
G
Specifies the amount of green in a color.
B
Specifies the amount of blue in a color.
Color value
Specifies the hexadecimal value of the color.
Select Field dialog
This dialog helps you to select some fields of the same type to replace the current fields in a filter
control.
Select Fields
Specifies the fields which will replace the current fields in the filter control. The selected fields should
be of the same type.
Apply To
Specifies the components to which the filter created with the filter control will be applied.
OK
Applies the selected field to the filter control and closes the dialog.
Cancel
Cancels the selection and closes the dialog.
Help
Displays this help document.
Select Group Position dialog
This dialog helps you to specify the position of the group by field when you convert a table detail
column to a group column.
Group Above
Specifies to place the group by field in its own row above the detail columns.
Group Left Above
Specifies to place the group by field in its own row and column above and left of the detail columns.
Group Left
Specifies to place the group by field in its own column left of the detail columns.
OK
Applies the setting to convert the column and closes the dialog.
Cancel
Cancels the conversion and closes the dialog.
Help
Displays this help document.
Select Resource dialog
This dialog helps you to specify the field to which the dynamic measure object will be mapped.
In this dialog, all the dimension objects
and detail information objects
in the current business/
report cube and the dynamic formulas
that have been created in the report will be listed. Select the
required field and then click OK to make it as the mapping field of the measure object.
OK
Applies the settings and closes this dialog.
Cancel
Closes the dialog.
Help
Displays this help document.
Select Values dialog
This dialog helps you to specify one or more values to apply a filter criterion.
Available
Specifies the values from this list to filter report data with.
Adds the selected value to the Chosen list.
Chosen
Lists all the values that have been chosen.
Add
Adds a new line to the Chosen list for you to input a value.
Edit
Edits the selected item in the Chosen list. You can also double-click the item to edit it.
Remove
Removes the selected item from the Chosen list.
Go to
Goes to the specified value list. Input a number N here and click the Get button to fetch a value list
starting from the Nth value.
Prev
Fetches the previous value list.
Next
Fetches the next value list.
Number of List Items
Specifies the number of list items here and click the Get button to fetch a value list.
OK
Applies all changes and closes this dialog.
Cancel
Closes the dialog and deletes any unsaved changes.
Help
Displays this help document.
Sort dialog
This dialog helps you to specify the settings in order to sort the records or groups in a banded object.
Sort in Scope
Specifies on which level the sorting is based.
Deletes the specified sort expression line.
Field
Specifies the field by which to sort the records or groups.
Ascend
Specifies to sort the data ascendingly.
Descend
Specifies to sort the data descendingly.
Moves up a sort expression line.
Moves down a sort expression line.
Adds a new sort expression line after the current one. This button appears after the first sort condition
has been composed.
OK
Accepts the changes and re-loads the report result using the sort settings with this dialog closed.
Cancel
Cancels the operation and closes this dialog.
Apply
Accepts the changes and re-loads the report result using the sort settings with this dialog displayed.
Reset
Restores this dialog to its opening status.
Help
Displays this help document.
Special Field Properties dialog
This dialog helps you to edit the properties of a special field. It contains the following tabs:
●
General tab
●
Font tab
●
Border tab
●
Others tab
●
Display tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the special field.
Name
Specifies the display name of the special field, which will be shown on the shortcut menu of the special field.
Position
Specifies the position mode of the special field. If the special field is directly contained in the report body, a
tabular cell, or a text box, its position mode can be modified.
●
●
Absolute: The special field's position will be decided by its X and Y property values.
Static: The special field will be positioned at the default location in its container. If selected, the X, Y and
other position-related properties will be hidden or disabled.
Type
Specifies the type of the special field. Select a new one from the drop-down list if you want to change the
type. The following types are available:
●
●
Fetch Date
Prints the date when the data is retrieved from the database.
Fetch Time
Prints the time when the data is retrieved from the database.
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
Global Page N of M
Prints a specific global page number out of the global total page number. You can specify the format of this
special field in the Report Inspector. The operation is the same as Page N of M.
Global Page Number
Prints the global page number of the whole report wherever it is placed.
Global Total Page Number
Prints the global total page number of the whole report wherever the field is placed.
Group Name
Prints the group name, which usually placed in the Group Header/Footer panel.
Group Number
Prints the group number, which is usually placed in the Group Header/Footer panel.
Modified Date
Prints the last modified date for the catalog.
Modified Time
Prints the last modified time for the catalog.
Page N of M
Prints the page number of the total page number.
Page Number
Prints the page number for each page.
Print Date
Prints today's date (or the date designated on your computer).
Print Time
Prints the current time on your computer.
Record Number
Prints the record number, which is usually placed in the Details panel.
SQL Statement
Prints the SQL statements used to execute the query.
Task ID
Prints the internal task ID, which is a unique time stamp.
Total Fetched Records
Prints the total number of records which take part in grouping calculation. The possible result of the special
field is as follows:
❍
❍
●
●
●
If you don't set any filter condition in the Filter dialog, print the very number of the record obtained after
setting the property Maximum Records.
If you set filter conditions in the Filter dialog, print the number of records obtained after performing the
filters, even though you have set the property Maximum Records before setting the filters.
Total Group Number
Prints the total group number, which is usually placed in the group Header/Footer panel.
Total Page Number
Prints the total number of pages in the report.
Total Records
Prints the total number of records after all the filter conditions are performed, except the ones created in
the Filter dialog of JReport Viewer, and the Group Filter dialog and top N or bottom N condition in JReport
Designer.
●
User Name
Prints the User ID with which you log onto JReport Server.
X
Specifies the X coordinate of the special field.
Y
Specifies the Y coordinate of the special field.
Width
Specifies the width of the special field.
Height
Specifies the height of the special field.
Background
Specifies the background color of the special field.
To change the color, click the color indicator to bring out the Select Color dialog and then specify a new color,
or input a color string in the format #RRGGBB. If you want to make the background transparent, input
Transparent in the text box.
Foreground
Specifies the foreground color of the special field.
To change the color, click the color indicator to bring out the Select Color dialog and then specify a new color,
or input a color string in the text box.
Font tab
This tab shows the font-related information of the special field. You can modify all the font settings in this
tab.
Font
Specifies the font face of the field text.
Size
Specifies the font size of the field text.
Horizontal Alignment
Specifies the horizontal alignment mode of the text in the special field.
Vertical Alignment
Specifies the vertical alignment mode of the text in the special field.
Bold
Specifies whether to make the object text bold or not.
Underline
Specifies whether the field text will be underlined or not.
Strikethrough
Specifies whether or not to attach a strikeout line to the field text.
Italic
Specifies whether to make the field text italic or not.
Autofit
Specifies whether or not to automatically adjust the width of the special field.
Word Wrap
Specifies whether or not to wrap the text to the special field width.
Ignore HTML Tag
If this option is unchecked, JReport will parse HTML tag elements in the field value while the report is to be
saved as an HTML file; or the field value will appear in the HTML file the same as that in JReport Viewer
(HTML tag elements in the field value, if any, will not be parsed).
Repeat
Specifies whether to repeat the group name in the report result. Only available for table and it takes effect
only when the group by field is placed in the detail row.
Border tab
This tab shows information about borders of the special field. You can modify all the border settings in this
tab.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Shadow
Specifies whether the borders will have a shadow effect or not.
Shadow Color
Specifies the color of the border shadow.
Others tab
You can use this tab to view and configure some miscellaneous settings.
TOC Anchor
Specifies whether or not to add the node that represents the special field to the TOC tree that is displayed in
the TOC Browser.
Suppress When No Records
If true and no records are returned by the report, the special field will not be displayed.
Export to XLS
If true, the special field will be exported when you save the report result as an XLS file (make sure to check
Data Format in the Export dialog).
Export to CSV
If true, the special field will be exported when you save the report result as a TXT file with Delimited Format
selected.
Logic Column
Specifies whether to show the special field in the next visible table cell in the same row when the column
which holds the field is hidden.
Data Evaluation Setting
Specifies the group information for the object. Available only for the group by fields in table.
●
●
current column
The object will take value of the group by field in the current column.
current row
The object will take value of the group by field in the current row.
Display tab
You can use this tab to modify the render type of the special field. For details, see the Data Field Properties
dialog.
Split dialog
This dialog helps you to specify the number of rows and columns that the specified tabular cell will be
split into.
Number of Columns
Specifies the number of columns the tabular cell will be split into. Input a positive integer in the text
box to specify the number.
Number of Rows
Specifies the number of rows the tabular cell will be split into. Input a positive integer in the text box to
specify the number.
OK
Closes this dialog and applies the settings.
Cancel
Discards any modifications and closes this dialog.
Help
Displays this help document.
Table Cell Properties dialog
This dialog helps you to edit the properties of a table cell. It contains the following tabs:
●
General tab
●
Border tab
●
Others tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the table cell.
Name
Specifies the display name of the table cell, which will be shown on the shortcut menu of the table cell.
Background
Specifies the background color of the table cell.
To change the color, click the color indicator to access the Select Color dialog and then specify a new
color, or input a color string in the format #RRGGBB. If you want to make the background transparent,
input Transparent in the text box.
Border tab
This tab shows information about borders of the table cell. You can modify all the border settings in this
tab.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Others tab
You can use this tab to view and configure some miscellaneous settings.
Export to XLS
If true, the table cell will be exported when you save the report result as an XLS file (make sure to
check Data Format in the Export dialog).
Export to CSV
If true, the table cell will be exported when you save the report result as a TXT file with Delimited
Format selected.
Horizontal Alignment
Specifies the horizontal alignment mode of the content in the table cell. When the Position property for
the object in the cell is set to absolute, this property does not take effect.
Vertical Alignment
Specifies the vertical alignment mode of the content in the table cell. When the Position property for the
object in the cell is set to absolute, this property does note take effect.
Scope
A representation of the standard HTML attribute scope. This attribute specifies the set of data cells for
which the current header cell provides header information.
●
Row - The current cell provides header information for the rest of the row that contains it.
●
Column - The current cell provides header information for the rest of the column that contains it.
●
None - The scope attribute will not be generated when exporting to HTML.
Joining Merge
Specifies whether to make all the sequential rows included in the cell vertically merged in the report
results. It is meaningful to set the property only when the cell is merged with other cells in the same
column.
Repeat
Specifies whether to repeat the content of the cell in every page of the report results when the cell is
split into pages. Available only for vertically merged cell.
Table Properties dialog
This dialog helps you to edit the properties of a table. It contains the following tabs:
●
General tab
●
Border tab
●
Others tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the table.
Name
Specifies the display name of the table, which will be shown on the shortcut menu of the table.
Position
Specifies the position mode of the table. If the table is directly contained in the report body, a tabular
cell, or a text box, its position mode can be modified.
●
●
Absolute: The table's position will be decided by its X and Y property values.
Static: The table will be positioned at the default location in its container. If selected, the X, Y and
other position-related properties will be hidden or disabled.
X
Specifies the X coordinate of the table.
Y
Specifies the Y coordinate of the table.
Width
Specifies the width of the table.
Height
Specifies the height of the table.
Background
Specifies the background color of the table.
To change the color, click the color indicator to bring out the Select Color dialog and then specify a new
color, or input a color string in the format #RRGGBB. If you want to make the background transparent,
input Transparent in the text box.
Border tab
This tab shows information about borders of the table.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Others tab
You can use this tab to view and configure some miscellaneous settings.
TOC Anchor
Specifies whether or not to add the node that represents the table to the TOC tree that is displayed in
the TOC Browser.
Suppress When No Records
If true and no records are returned by the report, the table will not be displayed.
Export to XLS
If true, the table will be exported when you save the report result as an XLS file (make sure to check
Data Format in the Export dialog).
Export to CSV
If true, the table will be exported when you save the report result as a TXT file with Delimited Format
selected.
Table Row Properties dialog
This dialog helps you to edit the properties of a table row. It contains the following tabs:
●
General tab
●
Others tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the object.
Name
Specifies the display name of the table row, which will be shown on its shortcut menu.
Background
Specifies the background color of the table row.
To change the color, click the color indicator to access the Select Color dialog and then specify a new
color, or input a color string in the format #RRGGBB. If you want to make the background transparent,
input Transparent in the text box.
Others tab
You can use this tab to view and configure some miscellaneous settings.
Suppress When No Records
If true and no records are returned by the report, the table row will not be displayed.
Export to XLS
If true, the table row will be exported when you save the report result as an XLS file (make sure to
check Data Format in the Export dialog).
Export to CSV
If true, the table row will be exported when you save the report result as a TXT file with Delimited
Format selected.
Table Wizard
This wizard guides you through the process of creating a table report. It contains the following screens:
●
Data screen
●
Display screen
●
Group screen
●
Summary screen
●
Query Filter screen
●
Style screen
Back
Returns to the previous screen.
Next
Goes to the next screen.
Finish
Creates a report containing the table and closes the wizard.
Cancel
Closes the wizard without creating a report.
Help
Displays this help document.
Data screen
Specifies the business/report cube to use to create the table. This screen is hidden when there is only one cube
in the current catalog.
Available Data Resources
Lists all the available business/report cubes in the current catalog, with which you can create the table.
Display screen
Specifies the fields to be displayed in the table.
Resources
Displays all the cube elements in the selected business/report cube.
Adds the selected cube element to be displayed in the table.
Removes the selected cube element.
Display Fields
Lists the cube elements that have been added to the table.
Display Name
Specifies the display names of the added cube elements.
Moves the selected cube element one step up.
Moves the selected cube element one step down.
Group screen
Specifies the fields to group the data.
Resources
Displays all the available dimension objects
you can use to group the data in the table.
Adds the selected dimension object as a group field.
Removes the selected dimension object.
Group By
Lists all the dimension objects that have been added as group fields.
Sort
Specifies the sort order for each group: Ascend, Descend, or No Sort.
Moves the selected group one step up.
Moves the selected group one step down.
Summary screen
Specifies the fields on which to create aggregation functions.
Resources
Displays all the available measure objects
you can use to create aggregation functions in the table.
Adds the selected measure object as the summary field.
Removes the selected measure object.
Summarized Fields
Lists the groups that have been created in the table and the measure objects you have added to summarize
data in each group.
Display Name
Specifies the display names of the measure objects.
Row
Specifies to put the summary field in the header or footer row. If the summary is calculated on a group by field,
it will be put in the group header or footer row of the corresponding group; if the summary is calculated on the
whole dataset, it will be put in the table header or footer row. Available only when the table is Group Left type.
Column
Specifies to put the summary field in the specified detail column. Available only when the table is Group Left
type.
Moves the selected measure object one step up.
Moves the selected measure object one step down.
Query Filter screen
Specifies the filter which you want to apply to the selected business/report cube.
In this screen, all the predefined filters of the business/report cube are listed in the Query Filter drop-down list.
You can choose one of them to apply. If you prefer to define a filter on your own, select User Defined from the
drop-down list, and then define it according to your requirements.
For details about options in the screen, refer to Query Filter dialog.
Style screen
Specifies the style of the table. This screen is hidden when there is only one style available to be applied to the
table.
Style
Lists all table styles for you to select one from.
Inherit Style
Specifies to take the style of the parent component. The option is available only when you specify to insert the
table into a banded object.
Preview
Shows a preview of the selected style.
Tabular Cell Properties dialog
This dialog helps you to edit the properties of a tabular cell. It contains the following tabs:
●
General tab
●
Border tab
●
Others tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the tabular cell.
Name
Specifies the display name of the tabular cell, which will be shown on its shortcut menu.
Background
Specifies the background color of the tabular cell.
To change the color, click the color indicator to access the Select Color dialog and then specify a new
color, or input a color string in the format #RRGGBB. If you want to make the background transparent,
input Transparent in the text box.
Border tab
This tab shows information about borders of the tabular cell.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Others tab
You can use this tab to view and configure some miscellaneous settings.
Export to XLS
If true, the tabular cell will be exported when you save the report result as an XLS file (make sure to
check Data Format in the Export dialog).
Export to CSV
If true, the tabular cell will be exported when you save the report result as a TXT file with Delimited
Format selected.
Tabular Properties dialog
This dialog helps you to edit the properties of a tabular. It contains the following tabs:
●
General tab
●
Others tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the tabular.
Name
Specifies the display name of the tabular, which will be shown on the shortcut menu of the tabular.
Position
Specifies the position mode of the tabular. If the tabular is directly contained in the report body, a
tabular cell, or a text box, its position mode can be modified.
●
●
Absolute: The tabular's position will be decided by its X and Y property values.
Static: The tabular will be positioned at the default location in its container. If selected, the X, Y and
other position-related properties will be hidden or disabled.
Vertical Auto Size
Specifies whether or not to automatically adjust the height of the tabular according to the size of the
components inserted.
Horizontal Auto Size
Specifies whether or not to automatically adjust the width of the tabular according to the size of the
components inserted.
X
Specifies the X coordinate of the tabular.
Y
Specifies the Y coordinate of the tabular.
Width
Specifies the width of the tabular.
Height
Specifies the height of the tabular.
Background
Specifies the background color of the tabular.
To change the color, click the color indicator to access the Select Color dialog and then specify a new
color, or input a color string in the format #RRGGBB. If you want to make the background transparent,
input Transparent in the text box.
Others tab
You can use this tab to view and configure some miscellaneous settings.
TOC Anchor
Specifies whether or not to add the node that represents the tabular to the TOC tree that is displayed in
the TOC Browser.
Suppress When No Records
If true and no records are returned by the report, the tabular will not be displayed.
Export to XLS
If true, the tabular will be exported when you save the report result as an XLS file (make sure to check
Data Format in the Export dialog).
Export to CSV
If true, the tabular will be exported when you save the report result as a TXT file with Delimited Format
selected.
Text Box Properties dialog
This dialog helps you to edit the properties of a text box. It contains the following tabs:
●
General tab
●
Border tab
●
Others tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the text box.
Name
Specifies the display name of the text box, which will be shown on its shortcut menu.
Position
Specifies the position mode of the text box. If the text box is directly contained in the report body, a
tabular cell, or a text box, its position mode can be modified.
●
●
Absolute: The text box's position will be decided by its X and Y property values.
Static: The text box will be positioned at the default location in its container. If selected, the X, Y and
other position-related properties will be hidden or disabled.
Vertical Alignment
Specifies vertical justification of the text in the text box.
Vertical Auto Size
Specifies whether or not to automatically adjust the height of the text box according to the size of the
components inserted.
X
Specifies the X coordinate of the text box.
Y
Specifies the Y coordinate of the text box.
Width
Specifies the width of the text box.
Height
Shows the height of the text box.
Background
Specifies the background color of the text box.
To change the color, click the color indicator to bring out the Select Color dialog and then specify a new
color, or input a color string in the format #RRGGBB. If you want to make the background transparent,
input Transparent in the text box.
Border tab
This tab shows information about borders of the text box.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Others tab
You can use this tab to view and configure some miscellaneous settings.
TOC Anchor
Specifies whether or not to add the node that represents the text box to the TOC tree that is displayed
in the TOC Browser.
Suppress When No Records
If true and no records are returned by the report, the text box will not be displayed.
Export to XLS
If true, the text box will be exported when you save the report result as an XLS file (make sure to check
Data Format in the Export dialog).
Export to CSV
If true, the text box will be exported when you save the report result as a TXT file with Delimited
Format selected.
Top N dialog
This dialog helps you to filter data to display records that meet the Top N condition.
Value
Specifies a positive integer N here so that records with the field value equal to one of the top N field
values will be displayed.
OK
Applies the settings and closes the dialog.
Cancel
Closes the dialog and discards any changes.
Help
Displays this help document.
To Chart dialog
This dialog helps you to specify settings for converting a crosstab into a chart. It contains the following
tabs:
●
Chart Type tab
●
Display tab
●
Style tab
Back
Returns to the previous tab.
Next
Goes to the next tab.
OK
Applies the settings and closes the dialog.
Cancel
Cancels the settings and closes the dialog.
Help
Displays this help document.
Chart Type tab
This tab allows you to set the type of the chart.
Chart Type
Lists all chart types for you to select one.
Subtype
Shows subtypes of the selected chart type in thumbnail form.
Chart Type Groups
Lists the subtypes defined for the chart.
Removes the selected subtype.
Display tab
This tab allows you to set the fields that will be displayed in the chart.
Resources
Displays all the cube elements used in the crosstab.
Adds the selected dimension or measure object to be displayed in the chart.
Removes the selected cube element.
Category
Lists the dimension object
that will be displayed on the category axis.
Series
Lists the dimension object
that will be displayed on the series axis.
Show Values
Lists the measure objects
that will be displayed on the value axis.
Order/Select N
Opens the Order/Select N dialog to define the sort order and Select N condition in the chart.
Style tab
This tab allows you to select a style for the chart. It is hidden when there is only one style available.
Style
Lists all the styles for you to select from.
●
Custom
There is no style information in this style and it is only used to support reports built with previous
versions which did not bind any style or the bound style cannot be found in the style list.
Preview
Shows a preview of the selected style.
Inherit Style
Specifies to take the style of the parent component. The option is available when the crosstab is in a
banded object.
To Crosstab dialog
This dialog helps you to specify settings for converting a chart into a crosstab. It contains the following
tabs:
●
Display tab
●
Style tab
Back
Returns to the previous tab.
Next
Goes to the next tab.
OK
Applies the settings and closes the dialog.
Cancel
Cancels the settings and closes the dialog.
Help
Displays this help document.
Display tab
This tab allows you to set the data fields that you want to display in the crosstab.
Resources
Displays the cube elements used in the chart.
Adds the selected cube element to the crosstab.
Removes the selected cube element.
Columns/Rows
Lists the dimension objects
●
●
●
that will be displayed on the columns/rows of the crosstab.
Field
Lists the dimension objects that you selected to display in the crosstab.
Display Name
Lists the display name for the selected dimension objects. You can edit the names if required.
Sort
Specifies how the selected dimension objects will be sorted.
Summaries
Lists the measure objects
●
●
that will be the aggregate fields of the crosstab.
Field
Lists the measure objects that you selected to display in the crosstab.
Display Name
Lists the display name for the selected measure objects. You can edit the names if required.
Moves the selected cube element one step up.
Moves the selected cube element one step down.
Style tab
This tab allows you to select a style for the crosstab. It is hidden when there is only one style available.
Style
Lists all the styles for you to select one.
●
Custom
There is no style information in this style and it is only used to support reports built with previous
versions which did not bind any style or the bound style cannot be found in the style list.
Preview
Shows a preview of the selected style.
Inherit Style
Specifies to take the style of the parent component. The option is available when the chart is in a table
or banded object.
Turn to Page dialog
This dialog helps you to input the page number so as to turn to the specified page.
Input Page Number
Specifies the page number you would like to turn to.
Go
Goes to the specified page.
Cancel
Closes this dialog without turning the report page.
Help
Displays this help document.
Zoom dialog
This dialog helps you to set a magnification of the report page.
Zoom to
Specifies the magnification in percentage.
OK
Closes this dialog and zooms the report page in or out to the magnification.
Cancel
Closes this dialog without changing the magnification of the report page.
Help
Displays this help document.
JReport Studio dialogs
While using JReport Studio, you will go through the following dialogs. This section introduces each of
these dialogs in alphabetical order. You can go into the links for details.
●
Add Aggregation dialog
●
Aggregate On dialog
●
Button Properties dialog
●
Category Options dialog
●
Chart Properties dialog
●
Chart Wizard
●
Color Picker dialog
●
Conditional Formatting dialog
●
Crosstab Properties dialog
●
Crosstab Wizard
●
Edit Additional Value dialog
●
Edit Conditions dialog
●
Edit Detail Table dialog
●
Edit Image dialog
●
Edit Link dialog
●
Edit Multimedia dialog
●
Enter Values dialog
●
Export dialog
●
Field Properties dialog
●
Fill Effects dialog
●
Filter Control Properties dialog
●
Filter dialog
●
Filter Inspector dialog
●
Flash Properties dialog
●
Font dialog
●
Format Category(X) Axis dialog
●
Format Category(X) Gridline dialog
●
Format Floor dialog
●
Format Graph dialog
●
Format Legend dialog
●
Format Paper dialog
●
Format Platform dialog
●
Format Value(Y) Axis dialog
●
Format Value(Y2) Axis dialog
●
Format Value(Y) Gridline dialog
●
Format Wall dialog
●
Formula Editor dialog
●
Group Footer Properties dialog
●
Group Header Properties dialog
●
Image Properties dialog
●
Insert Chart dialog
●
Insert Crosstab dialog
●
Insert Filter Control dialog
●
Insert Image dialog
●
Insert Link dialog
●
Insert Multimedia dialog
●
Insert Parameter Control dialog
●
Insert Parameter Form Control dialog
●
Insert Table dialog
●
JReport Studio Wizard
●
Label Properties dialog
●
Navigation Control Properties dialog
●
Page Setup dialog
●
Parameter Control Properties dialog
●
Parameter Field Properties dialog
●
Parameter Form Control Properties dialog
●
PDF Encrypt Option dialog
●
PDF Sign Option dialog
●
Print dialog
●
Query Filter dialog
●
RealMedia Properties dialog
●
Report Body Properties dialog
●
Report Parameters dialog
●
Save As dialog
●
Select a Report dialog
●
Select Field dialog
●
Select Resource dialog
●
Select Values dialog
●
Series Options dialog
●
Special Field Properties dialog
●
Split Cell dialog
●
Summary Properties dialog
●
Table Cell Properties dialog
●
Table Detail Properties dialog
●
Table Footer Properties dialog
●
Table Header Properties dialog
●
Table Properties dialog
●
Table Wizard
●
Tabular Cell Properties dialog
●
Tabular Properties dialog
●
To Chart dialog
●
To Crosstab dialog
●
Windows Media Properties dialog
Add Aggregation dialog
This dialog is displayed when you expand the Dynamic Resource > Aggregations node in the Resources
panel, then click <Add Aggregation…> or right-click a dynamic aggregation and then select Edit from
the shortcut menu. It helps you to create or edit a dynamic aggregation in a report.
Aggregation Name
Specifies the name of the aggregation.
Mapping Name
Click
dialog.
to select a field or a formula on which the aggregation is based on in the Select Resource
Aggregate Function
Specifies the function for the aggregation.
●
●
●
●
●
Count
This function computes the number of values referred to by the argument.
Sum
This function computes the sum of all the values referred to by the argument.
Average
The function is used to get the average value of the values referred to by the argument.
Maximum
This function returns the highest value referred to by the argument.
Minimum
This function returns the lowest value referred to by the argument.
●
●
●
●
DistinctCount
This function computes the number of distinct values referred to by the argument.
PopulationStdDev
This function computes the population standard deviation of the values referred to by the argument.
StdDev
This function computes the standard deviation of the values referred to by the argument.
Variance
This function computes the variance of all the values referred to by the argument.
OK
Creates or edits the aggregation and closes the dialog.
Cancel
Cancels the operation and closes the dialog.
Help
Displays this help document.
Aggregate On dialog
The dialog appears when you do either of the following:
●
Right-click the field in a table detail column and select Aggregate On from the shortcut menu.
●
Click a column header to select the column, then on the Context toolbar, click the Aggregate On
button
.
It helps you to summarize data in the selected table detail column.
Aggregate On
Displays the field bound with the detail column. The field is also the one on which the summary is
based.
Function
Specifies the function to summarize the field in the detail column.
OK
Summarizes the detail column data with the specified function and closes the dialog.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
Button Properties dialog
This dialog appears when you right-click a button in a navigation control and select Properties from the
shortcut menu. It helps you to modify the properties of the button.
Button Type
●
●
Button
The button is displayed as a normal button.
Image Button
The button is displayed as an image.
Button
When Button is selected as the button type, the following options are available.
Button Label
Specifies the properties of the button label.
●
●
●
●
●
●
Text
Specifies the text of the label.
Font
Specifies the font face of the text.
Font Style
Specifies the font style of the text.
Font Size
Specifies the font size of the text.
Align
Specifies the alignment way of the label in the button.
Font Color
Specifies the font color of the text.
Border
Specifies the properties of the button border.
●
●
●
●
●
●
Color
Specifies the border color.
Thickness
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Button Body
Specifies the properties of the button body.
●
Background
Specifies the background color of the button body.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in
the format #RRGGBB. If you want to make the background transparent, input Transparent in the text box.
●
●
Width
Specifies the width of the button.
Height
Specifies the height of the button.
Preview
Displays a preview of the button according to the button properties.
Image Button
When Button Image is selected as the button type, the following options are available.
Image From
Specifies the source of the image file.
●
Local File
Specifies to use an image from the local file system.
❍
File Name
Specifies the path and name of the image file. You can click the Browse button to locate the image file.
●
Web URL
Specifies to use an image via URL.
❍
Image URL
Specifies the URL of the image file. JReport will record the latest 10 entered URLs in the drop-down list.
Note: If your JReport Server is in an intranet, to successfully access the image via URL, you need to
add the parameters -Dhttp.proxyHost=XXX -Dhttp.proxyPort=XX to the server's startup file JRServer.
bat, which locates in <install_root>\bin.
●
Library
Specifies to use an existing image.
❍
My Images
The My Images folder is a virtual location where JReport Server stores the images that have once been
inserted into reports. Select the one you want to use.
Preview
Displays a preview of the selected image.
OK
Applies the button properties and closes this dialog.
Cancel
Cancels the changes and closes this dialog.
Help
Displays this help document.
Category Options dialog
This dialog appears when you click the Top N button
above the Category box in the Bind Data
screen of chart in the JReport Studio Wizard, Insert Chart dialog, Chart Wizard, or To Chart dialog. It
helps you to set the sort order of the category values and define the number of the category values
that will be displayed in the chart.
Category Order
Specifies in which order data on the category axis of a chart will be displayed.
●
●
●
Ascend
Lists data in an ascending order.
Descend
Lists data in a descending order.
No Sort
Keeps the data in their original order in database.
Category Selection
Specifies the number of the category values that will be displayed in the chart.
●
Select
Specifies the Select N condition to define the number of the category values that will be displayed.
❍
❍
❍
●
●
●
All
If selected, all category values will be displayed.
Top N
If selected, specify a number in the field to the right and the first N category values will be
displayed.
Bottom N
If selected, specify a number in the field to the right and the last N category values will be
displayed.
Based On
If checked, the category values will be sorted by values of the summary selected with the direction
specified. If unchecked, the category values will be sorted by the order specified in the Category
Order box of the dialog.
Remaining Categories In
Enabled only when Top N or Bottom N is selected from the Select drop-down list. Check this option
and then type a character string in the text field to group all the category values beyond the top/
bottom N range.
Skip First
If you check the Skip First option and input a number M in the text field to the right, then the first M
category values in the chart will be skipped and the Select N condition will take effect beginning with
M+1. The skipped values will be included in the Remaining Categories group together with all the
category values beyond the top/bottom N range.
OK
Accepts the changes and closes the dialog.
Cancel
Discards the changes and closes the dialog.
Help
Displays this help document.
Chart Properties dialog
The dialog appears when you right-click a chart and select Properties from the shortcut menu. It helps you to
specify the properties of the chart.
Name
Specifies the display name of the chart, which will be shown on the shortcut menu of the chart.
Horizontal Alignment
Specifies the horizontal justification of the chart. Choose an option from the drop-down list.
●
left: Aligns the chart on the left of the report.
●
right: Aligns the chart on the right of the report.
●
center: Aligns the chart in the center of the report.
Width
Specifies the width of the chart.
Height
Specifies the height of the chart.
Show Legend
Specifies whether to make the legend in the chart visible.
Show Wall
Specifies whether to show the wall in the chart.
Show Floor
Specifies whether to show the floor, only for 3-D chart types.
Show Axis Y
Specifies whether to show the axis Y.
Show Axis X
Specifies whether to show the axis X.
Show Gridline X
Specifies whether to show the gridlines perpendicular to the axis X.
Show Gridline Y
Specifies whether to show the gridlines perpendicular to the axis Y.
OK
Applies the chart properties and closes this dialog.
Cancel
Cancels the changes and closes this dialog.
Help
Displays this help document.
Chart Wizard
This wizard is displayed when you do one of the following:
●
Select a chart, then click Menu > Edit > Wizard.
●
Select a chart, then click the Chart Wizard button
●
on the Context toolbar.
Right-click the icon
of a chart or any part of a chart other than the legend and label, then select Chart Wizard
from the shortcut menu.
It helps you to change data and modify the type of the chart.
Chart Title
Specifies a title for the chart.
Sets the font, font style, size, alignment, font color and background color properties for the chart title.
Data Source
Displays the business view that has been used in the chart.
Filter
Opens the Query Filter dialog to specify the filter which you want to apply to the selected business view.
Resources
Displays the view elements in the selected business view.
Edits the selected dynamic resource.
Adds the selected group or aggregation object to be displayed in the chart.
Show Values
Lists the values you want to show in the chart. For a real time chart, the values you add must be of Numeric type
and cannot be aggregation objects.
●
●
●
●
●
Primary Axis
Adds a chart type to the primary axis.
Secondary Axis
Adds a chart type to the secondary axis. Active only when the option Secondary Axis is checked.
X Axis
Lists the value you want to show on the X axis of the bubble chart.
Y Axis
Lists the value you want to show on the Y axis of the bubble chart.
Radius
Lists the value you want to show as the bubble radius.
Adds a combo chart to the Primary Axis or Secondary Axis.
Opens the Edit Additional Value dialog to edit the selected additional value.
Moves the selected view element one level up.
Moves the selected view element one level down.
Adds a new pair of Y Axis and Radius for the bubble chart.
Secondary Axis
Specifies whether to show the secondary axis in the chart.
Category
Lists the group object
that will be displayed on the category axis of the chart. For a real time chart, if no object
is specified on the category axis, Use System Refresh Time will be automatically displayed in the Category text box,
namely, the time at which the chart refreshes itself will be used as the category value.
Series
Lists the group object
that will be displayed on the series axis of the chart. Not available for real time chart.
Opens the Category Options dialog or Series Options dialog to define the sort order of the category or series values
and specify the number of the category or series values that will be displayed in the chart.
Motion Bar for Playable Chart
Lists the group object
you want to use as the motion field. A motion field can only be of Integer, Date or Time
data type. Available to single bar, bench and bubble chart types only.
●
Special Function
Available only when the motion field is of Date data type. Click it to define the special function.
❍
❍
❍
❍
Field
Displays on which field the special function will be applied.
Function
Specifies the special function to the field.
OK
Accepts the special function settings and leaves the dialog.
Cancel
Cancels the special function settings and leaves the dialog.
Real Time
Specifies to run the chart in real time mode, which means it will be updated automatically by using real time data.
Available to single bar, bench, line, and area chart types only. Click
number of the records to be kept.
●
●
●
●
to specify the refresh interval and the
Refresh Interval
Specifies the interval that the chart will get the data and refresh itself automatically.
Keep Last N Records
Specifies the number of records that will be kept for the real time data on the chart.
OK
Accepts the interval and records settings and closes the dialog.
Cancel
Cancels the interval and records settings and closes the dialog.
Removes the selected resource.
OK
Applies the changes and closes the wizard.
Cancel
Cancels the changes and closes the wizard.
Help
Displays this help document.
Color Picker dialog
This dialog helps you to specify a color for an object. It contains the following tabs:
●
Standard tab
●
Custom tab
OK
Closes this dialog and returns the color value specified in the current tab.
Cancel
Closes this dialog without changing the color value.
Help
Displays this help document.
Standard tab
This tab allows you to select one from the web safe color swatches.
Web Safe Colors
Lists the web safe colors for you to select one.
R
Specifies the amount of red in a color. The value is from 0 to 255.
G
Specifies the amount of green in a color. The value is from 0 to 255.
B
Specifies the amount of blue in a color. The value is from 0 to 255.
#
Specifies the hexadecimal value of the color.
New
This part displays the color you select.
Current
This part always displays the original color. Clicking this part will restore the color to the original.
Custom tab
This tab allows you to customize the color within a wider range.
Color matrix
Select a color you want in the color matrix. The hue of the matrix is based on the color you define on
the color bar.
Color bar
Specifies a color on the bar which will be the hue of the color matrix.
R
Specifies the amount of red in a color. The value is from 0 to 255.
G
Specifies the amount of green in a color. The value is from 0 to 255.
B
Specifies the amount of blue in a color. The value is from 0 to 255.
#
Specifies the hexadecimal value of the color.
New
This part displays the color you select.
Current
This part always displays the original color. Clicking this part will restore the color to the original.
Conditional Formatting dialog
This dialog appears when you right-click a field and select Conditional Formatting from the shortcut
menu. It helps you to add some conditional formats to values of the selected field.
Condition
Displays all the conditions you have already added.
●
●
Adds a new condition in the Edit Conditions dialog.
Edits the selected condition.
●
●
Removes the selected condition.
Priority
Specifies the priority of each condition.
❍
❍
Moves a condition up for a higher priority.
Moves a condition down for a lower priority.
Format
Specifies the format which will be applied to the field values when the specified condition is fulfilled.
●
●
●
●
●
●
●
●
●
Font
Specifies the font type for the field values.
Border
Specifies the border line style for the field values.
Size
Specifies the font size for the field values.
Bold
Specifies whether or not to bold the field values.
Italic
Specifies whether or not to make the field values italic.
Underline
Specifies whether or not to underline the field values.
Foreground Color
Specifies the foreground color for the field values.
Background Color
Specifies the background color for the field values.
Sample Text
Displays a preview sample of your settings.
OK
Applies the settings and exits the dialog.
Cancel
Cancels the settings and closes the dialog.
Help
Displays this help document.
Crosstab Properties dialog
The dialog appears when you right-click a crosstab and select Properties from the shortcut menu. It helps you
to specify the properties of the crosstab and contains the following tabs:
●
General tab
●
Border tab
●
Crosstab tab
●
Others tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the crosstab.
Name
Specifies the display name of the crosstab, which will be shown on the shortcut menu of the crosstab.
Horizontal Alignment
Specifies the horizontal justification of the crosstab. Choose an option from the drop-down list.
●
Left: Aligns the crosstab on the left of the tabular cell.
●
Right: Aligns the crosstab on the right of the tabular cell.
●
Center: Aligns the crosstab in the center of the tabular cell.
Background
Specifies the background color of the crosstab.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB. If you want to make the background transparent, input Transparent in the text box.
Border tab
This tab shows information about borders of the crosstab.
Color
Specifies the color of the borders.
Width
Specifies the width of the borders.
Top Line
Specifies the line style of the top border. Choose a style from the drop-down list.
Bottom Line
Specifies the line style of the bottom border. Choose a style from the drop-down list.
Left Line
Specifies the line style of the left border. Choose a style from the drop-down list.
Right Line
Specifies the line style of the right border. Choose a style from the drop-down list.
Crosstab tab
This tab shows the layout-related information of the crosstab.
Boundary Value
Specifies the number of columns in one aggregate cell when the crosstab is displayed horizontally, or rows
when displayed vertically.
Row Total on Top
Specifies whether or not to display the Total row in the first row of the crosstab
Column Total on Left
Specifies whether or not to display the Total column in the first column in the crosstab.
Suppress Column Header
Specifies whether or not to suppress the column headers.
Suppress Row Header
Specifies whether or not to suppress the row headers.
Others tab
You can use this tab to view and configure some miscellaneous settings.
Current Row Block Index
Specifies the vertical index of the data block that will be displayed. 0 means the first block index, and 1 the
second, and so on.
Current Column Block Index
Specifies the horizontal index of the data block that will be displayed. 0 means the first block index, and 1 the
second, and so on.
Items per Row Block
Specifies the number of rows of records in each data block.
Items per Column Block
Specifies the number of columns of records in each data block.
The four properties work together to control the data of the crosstab to be displayed in continuous page mode:
Current Row Block Index, Current Column Block Index, Items per Row Block, and Items per Column Block.
Crosstab Wizard
This wizard is displayed when you do one of the following:
●
Select a crosstab, then click Menu > Edit > Wizard.
●
Select a crosstab, then click the Crosstab Wizard button
●
Right-click the icon
on the Context toolbar.
of a crosstab and select Crosstab Wizard from the shortcut menu.
It helps you to change data of the crosstab.
Crosstab Title
Specifies a title for the crosstab.
Sets the font, font style, size, alignment, font color and background color properties for the crosstab title.
Data Source
Displays the business view that has been used in the crosstab.
Filter
Opens the Query Filter dialog to specify the filter which you want to apply to the selected business view.
Resources
Displays the view elements in the selected business view.
Edits the selected dynamic resource.
Adds the selected group object
to be displayed on the columns of the crosstab.
Adds the selected group object
to be displayed on the rows of the crosstab.
Adds the selected aggregation object
or detail object
to be the summary field of the crosstab.
Columns/Rows
●
●
●
Field
Lists the group objects that will be displayed in the columns/rows of the crosstab.
Label
Specifies the display names of the group objects. By default these are blank and no names will be created for the
group objects to label the columns/rows. You can click in the cells to edit them if required.
Sort
Specifies the sort order of the group objects.
Summaries
●
●
●
Field
Lists the aggregation/detail objects that you select to create summaries.
Label
Specifies the display names of the aggregation/detail objects. By default these are blank and no names will be
created for the objects to label the summaries. You can click in the cells to edit them if required.
Aggregation
Specifies the functions used to summarize data of the detail objects.
Moves the selected view element one level up.
Moves the selected view element one level down.
Removes the selected resource.
OK
Applies the changes and closes the wizard.
Cancel
Does not retain changes and closes the wizard.
Help
Displays this help document.
Edit Additional Value dialog
This dialog is displayed when you add an additional value to the Show Values box in the chart wizard. It
also appears when you select an existing additional value and then click the Edit button
helps you to edit an additional value. It varies according to value types.
. The dialog
If it is a constant value, options in the dialog are as follows.
Name
Specifies the display name of the constant value, which will be shown under the subtype in the Show
Values box.
Value
Specifies a float number for the constant value.
OK
Applies the settings and closes the dialog.
Cancel
Closes the dialog and discards any changes.
Help
Displays this help document.
If it is an average value, options in the dialog are as follows.
Name
Specifies the display name of the average value, which will be shown under the subtype in the Show
Values box.
Based On
Specifies the aggregation object based on which the average value will be calculated.
OK
Applies the settings and closes the dialog.
Cancel
Closes the dialog and discards any changes.
Help
Displays this help document.
Edit Conditions dialog
The dialog appears when you click the button
or
in the Conditional Formatting dialog. It helps
you to add a new condition or edit an existing condition for the selected field, and has the following two
modes:
●
Basic
●
Advanced
Advanced/Basic
Switches the dialog to the advanced/basic mode.
OK
Applies the settings and exits the dialog.
Cancel
Cancels the settings and closes the dialog.
Help
Displays this help document.
Basic mode
The basic mode provides function for creating simple filter conditions which are connected by AND and OR
operators.
Delete the current condition line.
Field
Specifies the field to be filtered.
Operator
Specifies the operator to compose the filter expression.
●
●
●
●
●
●
●
●
●
●
=
Equal to
>
Greater than
>=
Greater than or equal to
<
Less than
<=
Less than or equal to
!=
Not equal to
[not] in
Causes an enumerated list of values to appear in the WHERE clause predicate, used for evaluating for a
true condition.
[not] like
Like string pattern matching operator is used to compare the first expression string value to the pattern
string (the second expression). If you want to use wildcard character in the pattern string, only "_" and
"%" are supported.
[not] between
Allows the system to evaluate whether or not data values are located between a range of values
indicated in the predicate.
is [not] null
It is used in WHERE clause predicates to match null values occurring in a specified data field.
Value
Specifies the value of how to filter the field. You can either enter the value manually in the text box or
select a value from the drop-down list. When you type in the value manually, if multiple values are
required, they should be separated with ",", and if "," or "\" is contained in the values, write it as "\," or "\
\".
Logic
Lists the logic operator.
●
●
AND
Logic operator AND which is applied to this and the next line.
OR
Logic operator OR which is applied to this and the next line.
Advanced mode
The advanced mode enables the building of more complex filter conditions via the grouping of conditions.
Add Condition
Adds a new condition line.
Delete
Deletes the selected condition line.
Group
Makes the selected conditions in a group. Conditions can also be added to an existing group by selecting
the conditions and the group while holding the Ctrl button, and then clicking the Group button.
Ungroup
Makes the selected condition ungrouped.
Up
Moves the selected condition or group up to a higher level.
Down
Moves the selected condition or group down to a lower level.
Logic
Specifies the logic operator.
●
●
●
●
AND
Logic operator AND which is applied to this and the next line.
OR
Logic operator OR which is applied to this and the next line
AND NOT
Logic operator AND NOT which is applied to this and the next line.
OR NOT
Logic operator OR NOT which is applied to this and the next line.
Field
Specifies the field to be filtered.
Operator
Specifies the operator to compose the filter expression.
Value
Specifies the value of how to filter the field. You can either enter the value manually in the text box or
select a value from the drop-down list. When you type in the value manually, if multiple values are
required, they should be separated with ",", and if "," or "\" is contained in the values, write it as "\," or "\
\".
Condition Expression
Displays the SQL statement of the condition.
Edit Detail Table dialog
This dialog appears when you right-click a summary and select Edit Detail Table from the shortcut menu. It helps
you to edit which fields will be displayed in the table when performing the go to detail action on the summary.
Resources
Displays all the group and detail objects in the selected business view.
Adds the selected view element to be displayed in the table.
Removes the selected view element.
Field
Lists the view elements that have been added to the table.
Moves the selected view element one step up.
Moves the selected view element one step down.
OK
Applies the changes and closes the dialog.
Cancel
Cancels the changes and exits the dialog.
Help
Displays this help document.
Edit Image dialog
This dialog appears when you right-click an image and select Edit from the shortcut menu. It helps you
to edit the image.
Image From
Specifies the source of the image file.
●
Local File
Specifies to use an image from the local file system.
❍
●
File Name
Specifies the path and name of the image file. You can click Browse button to locate the image file.
Web URL
Specifies to use an image via URL.
❍
Image URL
Specifies the URL of the image file.
Note: If your JReport Server is in an intranet which requires a proxy, to successfully access the
image via URL, you need to add the parameters -Dhttp.proxyHost=XXX -Dhttp.proxyPort=XX
to the server's startup file JRServer.bat, which is located in <install_root>\bin.
●
Library
Specifies to use an existing image.
❍
My Images
The My Images folder is a virtual location where JReport Server stores the images that have once
been inserted into reports. Select the one you want to use.
Preview
Displays a preview of the selected image.
OK
Applies the settings and closes the dialog.
Cancel
Cancels the changes and closes the dialog.
Help
Displays this help document.
Edit Link dialog
This dialog appears when you select an object which contains the defined link, right-click it and select
Edit Link on the shortcut menu. It helps you to edit the existing link of the object.
Select Link Type
Specifies the type of the link target. It can be one of the following:
●
Link to Report
●
Link to URL
●
Link to E-mail
Advanced
Displays the advanced settings. Available to the Link to Report type only.
OK
Applies the settings and closes the dialog.
Cancel
Cancels the changes and exits the dialog.
Help
Displays this help document.
Link to Report
It helps you to link a specified object to a report.
Report
Specifies the target linked report. Click the Browse button to select the desired report in the Select a
Report dialog.
Target
Specifies the window or frame in which to load the linked report.
●
●
New Window
Loads the linked file into a new window. This window is not named.
Parent Frame
Loads the linked file into the parent frame of the frame that contains the link.
●
●
●
●
Same Frame
Loads the linked file into the same frame as the link.
Whole Window
Loads the linked file into the full browser window.
<Server Setting>
Loads the linked file according to setting of the Pop Up New Window for Links option in the Customize
Profile panel of the Profile dialog in JReport Server.
Other Frame
Loads the linked file into some other specified frame. If the frame name does not exist, the linked file
will be loaded into a new window.
Conditions tab
Specifies the link conditions between the primary report and the linked report.
●
Components
Specifies the components in the linked report that will be interlinked with the primary report.
❍
❍
●
●
Adds a component in the linked report to be interlinked with the primary report.
Removes the selected component.
Default Linked Component
Specifies the default linked component in the linked report. The setting is applied when the primary
report runs in HTML, PDF or Excel format, or in JReport Studio.
Field Conditions
Specifies the link conditions between the primary report and the target linked report.
❍
❍
❍
❍
❍
Adds a new condition line to set up link between the linked report and the primary report.
Removes the selected condition line.
Fields(Primary)
Lists the selected fields of the primary report.
OP
Specifies the operator to set up links between the primary report and linked report. It can be =,
<>, <, >, <=, >= or IN.
Fields(LinkedReport)
Lists the fields in the datasets of the linked report which are of the same data as the selected fields
in the primary report.
Parameters tab
It helps you to assign values to the parameters of the linked report automatically.
●
Target Report Parameters
Assigns values to the parameters of the target linked report.
❍
Parameters
Lists all parameters contained in the target linked report.
❍
Value
Lists all the DBFields, formulas, summaries and parameters in the primary report which are of the
same data type as the parameters of the target linked report.
Link to URL
It helps you to link a specified object to a location specified by a URL.
Hyperlink
Specifies the URL for the hyperlink that is to be used to link the object.
Target
Specifies the window or frame in which to load the location specified by the URL.
●
●
●
●
●
●
New Window
Loads the linked file into a new window. This window is not named.
Parent Frame
Loads the linked file into the parent frame of the frame that contains the link.
Same Frame
Loads the linked file into the same frame as the link.
Whole Window
Loads the linked file into the full browser window.
<Server Setting>
Loads the linked file according to setting of the Pop Up New Window for Links option in the Customize
Profile panel of the Profile dialog in JReport Server.
Other Frame
Loads the linked file into some other specified frame. If the frame name does not exist, the linked file
will be loaded into a new window.
Link to E-mail
It helps you to link the specified object to an e-mail address.
Hyperlink
Specifies the e-mail address that the object will be linked to.
Related topics:
●
Binding Links to components
Edit Multimedia dialog
This dialog appears when you right-click a multimedia object and select Edit from the shortcut menu. It
helps you to edit the multimedia object.
Flash
Specifies to insert a flash file to the current report.
Real Media File
Specifies to insert a realmedia file to the current report.
Windows Media File
Specifies to insert a Windows Media file to the current report.
File Name/URL
Specifies the name or URL of the multimedia object that is to be inserted into the report. Type in the
name or URL in the text box or click Browse to find the file.
Plug-in Page
Specifies the URL of the plug-in page from which to download the player with which to play the
multimedia object file (if it isn't already installed on your local disk).
Properties
Specifies the properties of the multimedia object.
●
For Flash
Play
Specifies whether to start the flash file automatically when the report is opened.
❍
Loop
Specifies whether to play the flash file repeatedly.
❍
Movie Quality
Specifies the quality of the flash.
❍
For Real Media File
●
Auto Start
Specifies whether to start the realmedia file automatically when the report is opened.
❍
Center
Specifies whether to place the realmedia file in the center of the report.
❍
Loop
Specifies whether to play the realmedia file repeatedly.
❍
Loop Number
Specifies how many times you want to play the realmedia file.
❍
For Windows Media File
●
❍
❍
❍
Auto Start
Specifies whether or not to start the Windows Media automatically when the report is opened.
Auto Rewind
Specifies whether or not to rewind the Windows Media file automatically.
Play Count
Specifies the number of times you want to play this media file.
OK
Applies the settings for the multimedia object and closes this dialog.
Cancel
Cancels the edition and closes the dialog.
Help
Displays this help document.
Enter Values dialog
The dialog appears when you click the button
you to specify multiple values for the parameter.
while specifying values for a parameter. It helps
Available Values
Lists all predefined parameter values for selection. When the parameter is bound with a column, but
the Display Column is different from the Bind Column, values of the Display Column are listed here.
Selected Values
Lists the values selected. The selected values are case sensitive.
Adds the selected values from the Available Values box to the Selected Values box.
Removes the selected values from the Selected Values box.
Adds all the selected values from the Available Values box to the Selected Values box.
Removes all the selected values from the Selected Values box.
Enter Values
This option is available when the parameter's Allow Type-in of Value property is set to true in JReport
Designer.
Enter a value manually in the text box and then click the button next to add the value to the Selected
Values box. When the parameter is bound with a column, but the display column is different from the
bind column, make sure the value you enter is that of the bind column.
Opens the Calendar dialog to specify a date and time value. Available only for Date, DateTime, or Time
parameter which allows for type-in values and is not bound with any column.
All
If selected, it means that the parameter value result is all the values in the DBMS. This option is
available when the parameter's Enable the "All" Option property is set to true in JReport Designer. This
is translated in SQL to remove the parameter which may select more values than listed in the available
values list.
For example, when the parameter query is:
SELECT CUSTOMERS.CUSTOMERID,CUSTOMERS.CUSTOMERNAME FROM CUSTOMERS where CUSTOMERS.
CUSTOMERID>0 and CUSTOMERS.CUSTOMERID<4
When you click
SQL is:
to add 1, 2 and 3 as the parameter values, which are all the available values, the
(CUSTOMERS.CUSTOMERID IN ( 1,2,3))
Run the same report again and this time check the All checkbox in the Enter Values dialog, the query is
then:
( 1 = 1)
In this case, you will get more customers even though available values are only 1 – 3.
Note: When a multi-value parameter is inserted as a field into a report and All is selected as the value,
the field will show the string "All". If the parameter allows type-in values, "All" means all possible
values of the parameter data type; if the parameter does not, "All" represents all the values of the
parameter that come from the DBMS.
OK
Applies the selected values to the parameter and closes the dialog.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
Export dialog
This dialog appears when you click Menu > File > Export. It helps you to set settings for exporting the
report result to different formats.
File Name
Specify a name for the result file in the field.
View Report Result
If selected, the result will be directly opened in the web browser if the format is supported by a plug-in
of the web browser; otherwise you will be prompted to save the result file.
Save to File System
If selected, the report result will be saved to a specified folder.
Save to Version System
If selected, the report result will be saved as a result version in JReport Server's versioning system.
Select Report Result Format
Specifies the format to which the report result will be exported.
More/Less Options
Click to show/hide the additional settings for exporting the report to the specified format.
●
●
Style Group
Specifies the style group that will be applied to the exported result. When the <No Style> item in the
Style Group drop-down list is selected, the style group property defined for specific exporting format in
JReport Designer will be applied to export the report result to that format.
Properties
Specifies the properties for the selected format:
❍
PDF
❍
HTML
❍
Excel
❍
Text
❍
RTF
❍
XML
❍
PostScript
OK
Exports the report with the settings you specified.
Cancel
Cancels the operation and closes this dialog.
Help
Displays this help document.
Field Properties dialog
The dialog appears when you right-click a field and select Properties from the shortcut menu. It helps you to
specify the properties of the field and contains the following tabs:
●
General tab
●
Font tab
●
Border tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the field.
Name
Specifies the display name of the field.
Width
Specifies the width of the field.
Format
Specifies the format of the field.
Height
Specifies the height of the field.
Position
Displays the position mode of the field. If the field is directly contained in the report body, a tabular cell, or a
text box, its position mode can be modified.
●
●
Absolute: The field's position will be decided by its X and Y property values.
Static: The field will be positioned at the default location in its container. If selected, the X, Y and other
position-related properties will be hidden or disabled.
Top Padding
Specifies the space between the text of the field and its top border.
Bottom Padding
Specifies the space between the text of the field and its bottom border.
Left Padding
Specifies the space between the text of the field and its left border.
Right Padding
Specifies the space between the text of the field and its right border.
Background
Specifies the background color of the field.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB. If you want to make the background transparent, input Transparent in the text box.
Foreground
Specifies the foreground color of the field.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB.
Font tab
This tab shows the font-related information of the field.
Font
Specifies the font face of the text.
Size
Specifies the font size of the text.
Horizontal Alignment
Specifies the horizontal alignment mode of the text in the field.
Vertical Alignment
Specifies the vertical alignment mode of the text in the field.
Bold
Specifies whether to make the text bold or not.
Underline
Specifies whether the text will be underlined or not.
Strikethrough
Specifies whether or not to attach a strikeout line to the text.
Italic
Specifies whether to make the text italic or not.
Autofit
Specifies whether or not to automatically adjust the width of the field.
Word Wrap
Specifies whether or not to wrap the text to the field width.
Ignore HTML Tag
If this option is unchecked, JReport will parse HTML tag elements in the field value while the report is to be
saved as an HTML file; or the field value will appear in the HTML file the same as that in JReport Studio (HTML
tag elements in the field value, if any, will not be parsed).
Border tab
This tab shows information about borders of the field.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Shadow
Specifies whether the borders will have a shadow effect or not.
Shadow Color
Specifies the color of the border shadow.
Fill Effects dialog
This dialog helps you to specify either a gradient or an image as the fill effect of an object. It contains
the following tabs:
●
Gradient tab
●
Image tab
OK
Applies the changes and closes the dialog.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
Gradient tab
This tab allows you to specify the gradient colors to fill the object.
Fill Gradient
Displays the type of gradient to fill the object. It is Linear by default.
Start Color
Specifies a color in the gradient graph.
End Color
Specifies the other color in the gradient graph.
Start X
Specifies the horizontal position, measured in the percentage of the object's width, from the left edge
of the object, where the gradient starts.
Start Y
Specifies the vertical position, measured in the percentage of the object's height, from the top edge of
the object, where the gradient starts.
End X
Specifies the horizontal position, measured in the percentage of the object's width, from the left edge
of the object, where the gradient ends.
End Y
Specifies the vertical position, measured in the percentage of the object's height, from the top edge of
the object, where the gradient ends.
Preview
Displays a preview of your settings.
Image tab
This tab allows you to specify an image to fill the object.
Choose Image File
Specifies the image file. Click Browse to select the required image.
Display
Specifies the layout style of the image in the object. It can be one of the following: Tile, Center and
Scaled.
Image X
Displays the left position of the area, measured in the percentage of the image's width, from the left
edge of the image.
Image Y
Displays the bottom position of the area, measured in the percentage of the image's width, from the
bottom edge of the image.
Width
Displays the width of the area, measured in the percentage of the image's width.
Height
Displays the height of the area, measured in the percentage of the image's height.
The above four options, namely Image X, Image Y, Width and Height, are used to define an area in the
image and put the defined area of the image into the object. Their values are fixed.
Preview
Displays a preview of your settings.
Filter Control Properties dialog
This dialog appears when you right-click a filter control and select Properties from the shortcut menu. It helps
you to edit the properties of the filter control and contains the following tabs:
●
General tab
●
Font tab
●
Border tab
●
Title tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the filter control.
Name
Specifies the name of the filter control.
Format
Specifies the field value format in the filter control.
Filter On
Displays the fields that the filter control is based on. You can click the button
dialog to select other fields.
to open the Select Field
Width
Specifies the width of the filter control.
Height
Specifies the height of the filter control.
Background
Specifies the background color of the filter control.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB. If you want to make the background transparent, input Transparent in the text box.
Foreground
Specifies the foreground color of the filter control.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB.
Show Title
Specifies whether to show the title of the filter control.
Font tab
This tab shows the font-related information of the text in the filter control.
Font
Specifies the font face of the text.
Size
Specifies the font size of the text.
Bold
Specifies whether to make the text bold or not.
Underline
Specifies whether the text will be underlined or not.
Italic
Specifies whether to make the text italic or not.
Border tab
This tab shows information about borders of the filter control.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Title tab
This tab shows information about the title of the filter control. It is available when the Show Title option is
selected in the General tab of the same dialog.
Text
Specifies the text of the title.
●
Auto Map Field Name
Specifies whether to use the field name as the title. If selected, the Text box above is disabled for inputting.
Background
Specifies the background color of the title.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB. If you want to make the background transparent, input Transparent in the text box.
Foreground
Specifies the foreground color of the title.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB.
Font
Specifies the font face of the text.
Size
Specifies the font size of the text.
Horizontal Alignment
Specifies the horizontal alignment mode of the text.
Bold
Specifies whether to make the text bold or not.
Underline
Specifies whether the text will be underlined or not.
Italic
Specifies whether to make the text italic or not.
Filter dialog
The dialog appears when you click Menu > Edit > Filter. It helps you to set criteria for filtering records,
and has the following two modes:
●
Basic
●
Advanced
Inspector
Opens the Filter Inspector dialog.
Advanced/Basic
Switches the dialog to the advanced/basic mode.
OK
Closes the dialog and filters the records of the report with the specified criteria.
Cancel
Cancels to set criteria for filtering records and exits the dialog.
Help
Displays this help document.
Basic mode
The basic mode provides function for creating simple filter conditions which are connected by AND and OR
operators.
Apply to
Specifies the component to which the filter will be applied.
Deletes the current condition line.
Field
Specifies the field to be filtered.
Operator
Specifies the operator to compose the filter expression.
●
●
●
●
●
●
●
●
●
●
=
Equal to
>
Greater than
>=
Greater than or equal to
<
Less than
<=
Less than or equal to
!=
Not equal to
[not] in
Causes an enumerated list of values to appear in the WHERE clause predicate, used for evaluating for a
true condition.
[not] like
Like string pattern matching operator is used to compare the first expression string value to the pattern
string (the second expression). If you want to use wildcard character in the pattern string, only "_" and
"%" are supported.
[not] between
Allows the system to evaluate whether or not data values are located between a range of values
indicated in the predicate.
is [not] null
It is used in WHERE clause predicates to match null values occurring in a specified data field.
Value
Specifies the value of how to filter the field. You can either enter the value manually in the text box or
select a value from the drop-down list. When you type in the value manually, if multiple values are
required, they should be separated with ",", and if "," or "\" is contained in the values, write it as "\," or "\
\".
Logic
Lists the logic operator.
●
●
●
AND
Logic operator AND which is applied to this and the next line.
OR
Logic operator OR which is applied to this and the next line.
END
Logic operator END which is applied to this line.
Advanced mode
The advanced mode enables the building of more complex filter conditions via the grouping of conditions.
Apply to
Specifies the component to which the filter will be applied.
Add Condition
Adds a new condition line.
Delete
Deletes the selected condition line or group.
Group
Makes the selected condition lines in a group. Condition lines can also be added to an existing group by
selecting the condition lines and the group while holding the Ctrl button, and then clicking the Group
button.
Ungroup
Makes the selected condition line or group ungrouped.
Up
Moves the selected condition line or group up to a higher level.
Down
Moves the selected condition line or group down to a lower level.
Logic
Specifies the logic operator.
●
●
●
●
AND
Logic operator AND which is applied to this and the next line.
OR
Logic operator OR which is applied to this and the next line
AND NOT
Logic operator AND NOT which is applied to this and the next line.
OR NOT
Logic operator OR NOT which is applied to this and the next line.
Field
Specifies the field to be filtered.
Operator
Specifies the operator to compose the filter expression.
Value
Specifies the value of how to filter the field. You can either enter the value manually in the text box or
select a value from the drop-down list. When you type in the value manually, if multiple values are
required, they should be separated with ",", and if "," or "\" is contained in the values, write it as "\," or "\
\".
Condition Expression
Displays the SQL statement of the filter.
Filter Inspector dialog
The dialog appears when you click the Inspector button in the Filter dialog. It lists all the filters the
current web report is using for your information.
Query Filter
Lists the filters created via the Query Filter dialog.
Dialog Filter
Lists the filters created via the Filter dialog.
On Screen Filter
Lists the filters created via the Filter panel and via filter controls.
Go To Filter
Lists all the go to filters that are created when performing the go-to-by-value action on the report.
OK
Applies the changes and closes the dialog.
Cancel
Cancels the changes and exits the dialog.
Help
Displays this help document.
Flash Properties dialog
The dialog appears when you right-click a flash object and select Properties from the shortcut menu. It helps
you to edit the properties of the flash object.
Name
Specifies the display name of the flash, which will be shown on the shortcut menu of the flash.
Alternate Text
Specifies the alternate text which will be shown if the flash cannot be displayed.
Width
Specifies the width of the flash.
Height
Specifies the height of the flash.
Movie Quality
Specifies the quality of the flash.
Play
Specifies whether to start the flash file automatically when the report is opened.
Loop
Specifies whether to play the flash file repeatedly.
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
Font dialog
This dialog appears when you select a label or field and click the font button
helps you to specify the font format of the label or field.
on the toolbar. It
Font
Specifies the font face.
Size
Specifies the font size.
Color
Specifies the font color.
To change the color, click the color indicator to select a color, or click More Colors in the color
indicator to access the Color Picker dialog in which you can select a color within a wider range or input
a color string in the format #RRGGBB.
Specifies whether to make the object bold.
Specifies whether to make the object italic.
Specifies whether to underline the object.
Preview
Shows the font effect.
OK
Applies the font format you specified and closes this dialog.
Cancel
Cancels to change the font format and closes the dialog.
Help
Displays this help document.
Format Category(X) Axis dialog
This dialog appears when you right-click a chart and then select Format Axes > Format Category(X) Axis from
the shortcut menu. It helps you to format the category(X) axis of the chart, and consists of the following tabs:
●
Axis tab
●
Tick Mark tab
●
Font tab
●
Orientation tab
●
Format tab
OK
Applies the changes and closes the dialog.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
Axis tab
This tab shows some general information of the axis.
Option
Specifies the options for the axis.
●
●
●
●
●
Minimum Value
Specifies the minimum value that is to be displayed on the axis. Available only to bubble charts which use
the axis to show numeric data.
Maximum Value
Specifies the maximum value that is to be displayed on the axis. Available only to bubble charts which use
the axis to show numeric data.
Increment
Specifies the difference between two adjacent values on the axis. Available only to bubble charts which use
the axis to show numeric data.
Number of Tick Marks
Specifies how many tick marks to be displayed on the axis. Available only to bubble charts which use the
axis to show numeric data.
Show Gridlines
Specifies whether to show the horizontal gridlines in the chart.
Scrollable Chart
Specifies whether to make the chart scrollable. If checked, a scrollbar will be added in the chart, with which
you can control the visible value range on the axis. Available to 2-D charts of bar, bench, line, area and stock
types only.
●
●
●
Scrollable Visible Values
Specifies how many data items will be selected on the scrollbar and displayed on the axis by default.
Scrolling Area Percentage
Specifies the percentage the scrollbar occupies the whole size of the chart.
Show Chart in Scrolling Area
Specifies whether to show the thumbnail chart on the scrollbar.
Line
Specifies the line style for the axis.
●
●
●
●
Color
Specifies the color of the axis.
Style
Specifies the style for the line of the axis.
Transparency
Specifies the transparency for the color of the axis.
Thickness
Specifies the thickness for the line of the axis, in inches.
Gap
Specifies the gap properties for the labels on the axis.
●
●
Label Axis Gap
Specifies the distance between the label and the axis, in inches.
Best Effect
Specifies whether to adjust the labels automatically to make them placed best.
Tick Mark tab
The tab consists of three sub tabs: major tick mark tab, minor tick mark tab, and scale tab.
Major Tick Mark tab
Specifies properties of the major tick marks on the axis.
Type
Specifies the type of the major tick marks on the axis.
●
●
●
●
None
If selected, major tick marks will not be shown on the axis and it will be meaningless to specify all the other
major tick mark related properties.
Inside
If selected, major tick marks will be inside the chart.
Outside
If selected, major tick marks will be outside the chart.
Cross
If selected, major tick marks will be across the axis.
Line
Specifies the line properties of the major tick marks on the axis.
●
Correlate with Axis
If checked, the line properties of the major tick marks will correlate with that of the axis automatically.
❍
Color
Specifies the color of the major tick marks.
❍
❍
❍
●
Style
Specifies the type of the major tick marks.
Transparency
Specifies the transparency for the color of the major tick marks.
Thickness
Specifies the thickness of the major tick marks, in inches.
Tick Mark Length
Specifies the length of the major tick marks, in inches.
Option
Specifies the other properties of the major tick mark labels on the axis.
●
●
●
●
Show Major Tick Mark Labels
Specifies whether to display the labels of the major tick marks on the axis. If checked, the following
properties will be enabled.
Label Every N Major Tick Marks
Specifies the frequency at which the major tick marks will be labeled.
Show Axis Label Tips
Specifies whether to display the complete label text when the mouse pointer points at a label on the axis.
Number of Major Labels
Specifies how many major tick mark labels to be displayed on the axis.
❍
❍
Auto
If checked, all major tick mark labels will be shown.
Fixed
If checked, you can specify the number of the major tick mark labels to be displayed on the axis.
Minor Tick Mark tab
Specifies properties of the minor tick marks on the axis.
Type
Specifies the type of the minor tick marks on the axis.
●
●
●
●
None
If selected, minor tick marks will not be shown on the axis and it will be meaningless to specify all the other
minor tick mark related properties.
Inside
If selected, minor tick marks will be inside the chart.
Outside
If selected, minor tick marks will be outside the chart.
Cross
If selected, minor tick marks will be across the axis.
Line
Specifies the line properties for the minor tick marks on the axis.
●
Correlate with Axis
If checked, the line properties of the minor tick marks will correlate with that of the axis automatically.
❍
Color
Specifies the color of the minor tick marks.
❍
❍
❍
●
Style
Specifies the type of the minor tick marks.
Transparency
Specifies the transparency of the minor tick marks.
Thickness
Specifies the thickness of the minor tick marks, in inches.
Tick Mark Length
Specifies the length of the minor tick marks, in inches.
Option
Specifies the other properties of the minor tick marks on the axis.
●
●
●
Show Minor Tick Mark Labels
Specifies whether to display the labels of the minor tick marks on the axis. If checked, the following two
properties will be enabled.
Label Every N Minor Tick Marks
Specifies the frequency at which the minor tick marks will be labeled.
Number of Minor Labels
Specifies how many minor tick mark labels to be displayed on the axis.
❍
❍
Auto
If checked, all minor tick mark labels will be shown.
Fixed
If checked, you can specify the number of the minor tick mark labels to be displayed on the axis.
Scale tab
Customizes the way in which to label the tick marks on the axis. Available only when the field on the category
axis is one of the following types: Number, Date, DateTime, and Time, and not applied when the category axis
is used to show numeric data in bubble charts.
Use Constant Interval
Specifies whether to use a constant interval to label the tick marks. If checked, the values of the tick marks
will be increased continually on the axis based on the following properties, instead of just using the data
values.
Minimum
Specifies the minimum value which will be used to label the tick marks.
●
●
Auto
If checked, the minimum value will be defined by JReport automatically.
Fixed
If checked, you can define the minimum value as required. Input the value in the text box, or specify it in
the calendar if the field on the category axis is of Date, DateTime or Time type.
Maximum
Specifies the maximum value which will be used to label the tick marks.
●
●
Auto
If checked, the maximum value will be defined by JReport automatically.
Fixed
If checked, you can define the maximum value as required. Input the value in the text box, or specify it in
the calendar if the field on the category axis is of Date, DateTime or Time type.
Major Unit
Specifies the unit between two adjacent major tick marks.
●
●
Auto
If checked, the unit will be defined by JReport automatically.
Fixed
If checked, you can define the unit as required. Input the value in the text box, or choose the desired one
from the drop-down list if the field on the category axis is of Date, DateTime or Time type.
Minor Unit
Specifies the unit between two adjacent minor tick marks.
●
●
Auto
If checked, the unit will be defined by JReport automatically.
Fixed
If checked, you can define the unit as required. Input the value in the text box, or choose the desired one
from the drop-down list if the field on the category axis is of the Date, DateTime or Time type.
Font tab
The tab consists of two sub tabs: major label tab and minor label tab.
Major Label tab
Specifies the font format of the major tick mark labels on the axis.
Font
Specifies the font face of the label text.
Size
Specifies the font size of the label text.
Fill Type
Specifies the fill type of the label text.
Color
Specifies the color of the label text.
Transparency
Specifies the transparency of the label text.
Font Style
Specifies the font style of the text. It can be one of the following: Plain, Bold, Italic and Bold Italic.
Minor Label tab
Specifies the font format of the minor tick mark labels on the axis.
Correlate with Major Label
If checked, the font format of the minor tick mark labels will correlate with that of the major tick mark labels
automatically. Only when it is unchecked can the font properties of the minor tick mark labels take effect.
Font
Specifies the font face of the label text.
Size
Specifies the font size of the label text.
Fill Type
Specifies the fill type of the label text.
Color
Specifies the color of the label text.
Transparency
Specifies the transparency of the label text.
Font Style
Specifies the font style of the text. It can be one of the following: Plain, Bold, Italic and Bold Italic.
Orientation tab
The tab consists of two sub tabs: major label tab and minor label tab.
Major Label tab
Specifies the rotation angle of the major tick mark labels on the axis.
Automatic
Specifies to adjust the rotation angle of the major tick mark label text on the axis automatically according to
the length of the label text, in degrees.
When this option is checked by default:
●
●
If the text can be completely displayed horizontally, the default rotation angle will be 0.
If the text cannot be completely displayed horizontally, the default rotation angle will be 30 anticlockwise,
and the cut off part will be shown as suspension points.
Angle
Specifies to customize the rotation angle of the major tick mark label text on the axis.
Minor Label tab
Specifies the rotation angle of the minor tick mark labels on the axis.
Correlate with Major Label
If checked, the orientation setting of the minor tick mark labels will correlate with that of the major tick mark
labels automatically. Only when it is unchecked can the orientation properties of the minor tick mark labels
take effect.
Automatic
Specifies to adjust the rotation angle of the minor tick mark label text on the axis automatically according to
the length of the label text, in degrees.
When this option is checked by default:
●
●
If the text can be completely displayed horizontally, the default rotation angle will be 0.
If the text cannot be completely displayed horizontally, the default rotation angle will be 30 anticlockwise,
and the cut off part will be shown as suspension points.
Angle
Specifies to customize the rotation angle of the minor tick mark label text on the axis.
Format tab
The tab consists of two sub tabs: major label tab and minor label tab.
Major Label tab
Specifies the data format of the major tick mark labels on the axis.
Category
Lists the category types. Select one to customize its format.
Format
Displays all the formats of the selected category. Select the required one and click Add to add it as the format
of the specified category. You can add only one format for each category.
Properties
Displays the properties of the format you select. If the formats listed in the Format box cannot meet your
requirement, define the format in the text field and then click Add to add it as the format of the specified
category.
Sample
Displays the selected format effects.
Stack
Lists all the formats you select from different categories.
Add
Adds a format to the Stack list box.
Remove
Removes a format from the Stack list box.
Apply
Applies the specified format in the Stack list box to the major tick mark labels.
Minor Label tab
Specifies the data format of the minor tick mark labels on the axis.
Correlate with Major Label
If checked, the data format of the minor tick mark labels will correlate with that of the major tick mark labels
automatically. Only when it is unchecked can the format properties of the minor tick mark labels take effect.
Category
Lists the category types. Select one to customize its format.
Format
Displays all the formats of the selected category. Select the required one and click Add to add it as the format
of the specified category. You can add only one format for each category.
Properties
Displays the properties of the format you select. If the formats listed in the Format box cannot meet your
requirement, define the format in the text field and then click Add to add it as the format of the specified
category.
Sample
Displays the selected format effects.
Stack
Lists all the formats you select from different categories.
Add
Adds a format to the Stack list box.
Remove
Removes a format from the Stack list box.
Apply
Applies the specified format in the Stack list box to the minor tick mark labels.
Format Category(X) Gridline dialog
This dialog appears when you right-click a chart and then select Format Gridlines > Category(X) Gridline from
the shortcut menu. It helps you to format the category(X) gridline of the chart.
Color
Specifies the color schema for category(X) gridlines in the chart.
Transparency
Specifies the transparency of the color of category(X) gridlines in the chart.
Line Style
Specifies the line style for category(X) gridlines in the chart.
Thickness
Specifies the thickness for category(X) gridlines in the chart.
OK
Applies the changes and closes the dialog.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
Format Floor dialog
This dialog appears when you right-click a chart and then select Format Walls > Format Floor from the shortcut
menu. It helps you to format the floor of the chart and contains the following tabs:
●
General tab
●
Border tab
OK
Applies the changes and closes the dialog.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the floor.
Fill Type
Specifies the fill type for the floor of the chart.
Color
Specifies the color schema for the floor of the chart.
Transparency
Specifies the transparency of the color schema that is applied to the floor of the chart.
Border tab
This tab shows information about borders of the floor.
Color
Specifies the color for border of the chart floor.
Thickness
Specifies the thickness for border of the chart floor.
Transparency
Specifies the transparency for color of the border.
Line Style
Specifies the style for border of the chart floor.
Border Type
Specifies the type for the border of the chart floor.
Format Graph dialog
This dialog appears when you right-click an indicator chart and select Format Graph from the shortcut menu.
This dialog helps you to format the indicators of the indicator chart and contains the following tabs:
●
General tab
●
Border tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
Specifies the general properties of the indicator chart.
Option
Specifies the options for the indicators.
●
●
●
Left Margin
Specifies the gap between the left labels and the left indicators, in pixels.
Top Margin
Specifies the gap between the top labels and the top indicators, in pixels.
Range Radius
Specifies the relative size of an indicator in a percentage of the total indicator size.
Color Range
Specifies different colors or images to fill the indicators.
●
●
●
Show Value
Specifies the value you want to format.
Show Image
Specifies to use images to represent the value ranges.
Show Category Label
Specifies whether to show the category labels for the indicators. The label displays the category value each
indicator represents.
Others
Specifies the properties for values that do not fall into any of the ranges you have defined. Available only when
the fields displayed on the value axis of the indicator chart are of String or Numeric type.
●
●
●
Name
Specifies the name of the values.
Color
Specifies the color of the values.
Image
Specifies the image to represent the values.
Border tab
Specifies the properties for the borders of the indicators. Applied when the indicators are not represented by
images.
Style
Specifies the style of the indicator.
Line Style
Specifies the line style to apply to the border.
Thickness
Specifies the thickness of the border, in pixels.
Border Color
Specifies the color of the border.
Transparency
Specifies the transparency for color of the border.
Format Legend dialog
This dialog appears when you right-click a chart and select Format Legend from the shortcut menu. This dialog
helps you to format the legend of the chart and contains the following tabs:
●
General tab
●
Placement tab
●
Border tab
●
Font tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the chart legend.
Name
Specifies the display name of the chart legend, which will be shown on the shortcut menu of the legend.
Width
Specifies the width of the chart legend.
Height
Specifies the height of the chart legend.
Fill Type
Specifies the type for filling the chart legend.
Color
Indicates the background color of the chart legend.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB. If you want to make the background transparent, input Transparent in the text box.
Transparency
Specifies the transparency of the legend background.
Show Value
Specifies whether to show the value of each legend.
Show Percent
Specifies whether to show the percentage of each legend.
Show Tips
Specifies whether to show the corresponding data information when the mouse pointer points at a target in the
chart legend.
Show Scrollbar
Specifies whether to show a scrollbar on the legend to fully view the legend content when the content does not
fit into the legend.
Truncate
Specifies whether to truncate the legend entry label text when the text overflow the labels.
Placement tab
This tab shows the position-related information of the chart legend.
Placement
Specifies the position of the legend in the platform.
Secondary Placement
Specifies the position of the legend on the basis of the Placement property.
Top Margin
Specifies the distance between the legend labels and the top border of the legend.
Bottom Margin
Specifies the distance between the legend labels and the bottom border of the legend.
Left Margin
Specifies the distance between the legend labels and the left border of the legend.
Right Margin
Specifies the distance between the legend labels and the right border of the legend.
Label Vertical Spacing
Specifies the vertical distance between two adjacent legend labels.
Label Horizontal Spacing
Specifies the horizontal distance between two adjacent legend labels.
Reverse Labels
Specifies whether or not to arrange the legend labels in a reverse order.
Border tab
This tab shows information about borders of the chart legend.
Line Style
Specifies the line style of the legend borders.
Border Type
Specifies the type of the legend borders.
Color
Specifies the color of the legend borders.
Transparency
Specifies the transparency of the legend borders.
Thickness
Specifies the thickness of the legend borders.
Font tab
This tab shows the font-related information of the chart legend.
Font
Specifies the font face for the legend labels.
Size
Specifies the font size for the legend labels.
Fill Type
Specifies the fill type for the legend labels.
Color
Specifies the color for the legend labels.
Transparency
Specifies the transparency for the legend labels, in percent.
Font Style
Specifies the font style of the text. It can be one of the following: Plain, Bold, Italic and Bold Italic.
Font Rotation
Specifies the rotation angle of each legend label around its center, in degrees.
Word Wrap
Specifies whether or not to enable word wrapping for the label text.
Format Paper dialog
This dialog appears when you right-click a chart and select Format Paper from the shortcut menu. It helps you
to format the paper of the chart and contains the following tabs:
●
General tab
●
Border tab
●
Coordinate tab
●
Graph tab
●
Threshold Line tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the chart paper.
Name
Specifies the display name of the chart paper, which will be shown on the shortcut menu of the paper.
Width
Specifies the width of the chart paper.
Height
Specifies the height of the chart paper.
Fill Type
Specifies the type for filling the chart paper.
Color
Indicates the background color of the chart paper.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB. If you want to make the background transparent, input Transparent in the text box.
Transparency
Specifies the transparency of the chart paper background.
Show Tip
Specifies whether to show the corresponding data information when the mouse pointer points at a target in the
chart paper.
Show Category and Series
Specifies whether to show data of the category and value axes when the mouse pointer points at a target in
the chart paper. It takes effect only when the option Show Tips is checked.
Border tab
This tab shows information about borders of the chart paper.
Line Style
Specifies the line style of the chart paper borders.
Border Type
Specifies the type of the chart paper borders.
Color
Specifies the color of the chart paper borders.
Transparency
Specifies the transparency of the chart paper borders.
Thickness
Specifies the thickness of the chart paper borders.
Coordinate tab
You can use this tab to view and configure properties of the coordinates.
Scale X
Specifies the scaling ratio for the X axis.
Scale Y
Specifies the scaling ratio for the Y axis.
Angle X
Specifies the rotation angle around the X axis. Applies to 3-D charts and pie charts.
Angle Y
Specifies the rotation angle around the Y axis. Applies to 3-D charts and pie charts.
Perspective
Specifies the perspective effect of the chart. Input an integer to set the effect.
Interactive
Specifies whether the chart can be interactive or not.
Graph tab
You can use this tab to view and configure properties of the graphic object. This tab differs according to the
following chart types:
●
Bar/Bench
●
Line/Area
●
Pie/Donut
Bar/Bench
Specifies the properties on bars of the chart.
Type
Specifies the type of the bars.
●
Normal
Specifies to make the bars be quadrate.
●
Cylinder
Specifies to make the bars be columned.
Size
Specifies the size of the bars.
●
Width
Specifies the width of the bars.
Depth
Specifies the depth properties for the bars.
●
●
●
Use Depth
Specifies whether to make the bars visually three-dimensional.
Depth
Specifies the depth of the bars.
Direction
Specifies the angle of the axis along the depth of the bars.
Static Data Label
Specifies properties of the static data labels.
●
●
●
Show Static Data Label
Specifies whether or not to show the static data labels on the bars. Only when it is checked can the following
static data label related properties take effect.
Type
Specifies in which way the static data labels will be displayed.
❍
Value - Shows the value for each bar.
❍
Percent - Shows the percentage of each bar to the total.
❍
Value Percent - Shows the value and the percentage for the each bar.
Position
Specifies the position of the static data labels on the bars.
❍
❍
❍
❍
❍
●
Autofit
If selected, the static data labels will be displayed automatically.
Outside Top
If selected, the static data labels will be displayed on the outside top of the bars.
Inside Top
If selected, the static data labels will be displayed on the inside top of the bars.
Inside Center
If selected, the static data labels will be displayed at the inside center of the bars.
Inside Bottom
If selected, the static data labels will be displayed at the inside bottom of the bars.
Auto Arrange
Specifies whether to display the static data labels inside the bars at the best position. Available only when
the static data label's position is set to one of the following: Inside Center, Inside Top and Inside Bottom.
❍
True
The static data label will be displayed horizontally at the specified position if the bar has enough room
horizontally, otherwise, it will be displayed vertically. If a bar does not have enough room both vertically
and horizontally, its static data label will not be displayed.
❍
False
The static data labels will be displayed at the specified position, and if the labels get overlapping, some of
them will not be displayed.
Line/Area
Specifies properties on lines/areas in the chart.
Size
Specifies the size of the lines. Available to line chart only.
●
Line Thickness
Specifies the thickness of the lines.
Depth
Specifies the depth properties of the lines/areas.
●
●
Use Depth
Specifies whether to make the lines/areas visually three-dimensional.
Depth
Specifies the depth of the lines/areas.
●
Direction
Specifies the angle of the axis along the depth of the lines/areas.
Static Data Label
Specifies properties of the static data labels.
●
●
●
Show Static Data Label
Specifies whether or not to show the static data labels on the lines/areas. Only when it is checked can the
following static data label related properties take effect.
Type
Specifies in which way the static data labels will be displayed.
❍
Value - Shows the value for each line/area node.
❍
Percent - Shows the percentage of each line/area node to the total.
❍
Value Percent - Shows the value and the percentage for each line/area node.
Position
Specifies the position of the static data labels on the lines/areas.
❍
❍
❍
❍
❍
❍
❍
●
Autofit
If selected, the static data labels will be displayed automatically.
Top Center
If selected, the static data labels will be displayed on the top center of the line/area nodes.
Top Left
If selected, the static data labels will be displayed on the top left of the line/area nodes.
Top Right
If selected, the static data labels will be displayed on the top right of the line/area nodes.
Bottom Left
If selected, the static data labels will be displayed at the bottom left of the line/area nodes.
Bottom Center
If selected, the static data labels will be displayed at the bottom center of the line/area nodes.
Bottom Right
If selected, the static data labels will be displayed at the bottom right of the line/area nodes.
Auto Arrange
Specifies whether to display the static data labels at the best position. Not supported on line and area charts.
Pie/Donut
Specifies the pie properties.
Donut Hole
Specifies the percentage the hole’s thickness will take from the total radius of the donut pie circle. Available to
donut pie chart only.
Pie/Donut
●
Show Pie/Donut Name
Specifies whether or not to show the pie name.
Static Data Label
Specifies properties of the static data labels.
●
●
Show Static Data Label
Specifies whether or not to show the static data labels on the pies. Only when it is checked can the following
static data label related properties take effect.
Type
Specifies in which way the static data labels will be displayed.
❍
Value - Shows the value for each pie section.
❍
Category Name - Shows the category name for each pie section.
❍
Percent - Shows the percentage of each pie section to the total.
❍
Value Percent - Shows the value and the percentage for each pie section.
●
Position
Specifies the position of the static data labels on the pies.
❍
❍
❍
❍
❍
●
Autofit
If selected, the static data labels will be displayed automatically.
Sticker
If selected, the static data labels will be displayed beside each section of the pies.
Slim Leg
If selected, the static data labels will be displayed beside each section and pointed by thin lines.
Best Fit
If selected, the static data labels will be displayed at the best fit position automatically.
On Slices
If selected, the static data labels will be displayed on each section (slice) of the pies.
Auto Arrange
Specifies whether to display the static data labels at the best position. Not supported on pie charts.
Notes:
●
●
If the chart is a combo chart composed by areas, bars and lines, the Area, Bar, and Line tabs will be shown
as sub tabs in the Graph tab.
There is no Graph tab for indicator, gauge, bubble and bullet charts.
Threshold Line tab
You can use this tab to view and configure properties of the threshold lines.
Threshold Line1
Specifies the properties of the first threshold line.
●
●
●
Show Threshold Line1
Specifies whether or not to show the first threshold line.
Threshold Value
Specifies the value of the first threshold line.
Threshold Line Color
Specifies the color of the first threshold line.
Threshold Line2
Specifies the properties of the second threshold line.
●
●
●
Show Threshold Line2
Specifies whether or not to show the second threshold line.
Threshold Value
Specifies the value of the second threshold line.
Threshold Line Color
Specifies the color of the second threshold line.
Transparency
Specifies the transparency of the threshold lines.
Format Platform dialog
This dialog appears when you right-click a chart and select Format Platform from the shortcut menu. It you to
format the platform of the chart and contains the following tabs:
●
General tab
●
Border tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
Specifies the color schema to fill the platform.
Color
Specifies the color with which to fill the platform.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB, or click More Fill Effects to specify a gradient or an image as the fill effect in the Fill Effects
dialog. If you want to make the background transparent, input Transparent in the text box.
Transparency
Specifies the transparency of the color.
Border tab
Specifies the properties for borders of the chart platform.
Border Type
Specifies the type for border of the platform.
●
●
●
●
●
None
The object has no visible border lines.
Raised
The object has 3D borders that appear as if they are raised off the page.
Recess
The object has 3D borders that appear as if they are pressed into the page.
Shadow
The object has two shadowed borders, beneath and to the right of the object.
Solid
The object has single-line borders (default value).
Color
Specifies the color for border of the platform.
Transparency
Specifies the transparency for color of the border.
Line Style
Specifies the line style to apply to the border of the platform.
Thickness
Specifies the thickness of the border.
End Caps
Specifies the ending style of the border line.
●
●
●
Butt
Ends unclosed subpaths and dash segments with no added decoration.
Round
Ends unclosed subpaths and dash segments with a round decoration that has a radius equal to half of the
width of the pen.
Square
Ends unclosed subpaths and dash segments with a square projection that extends beyond the end of the
segment to a distance equal to half of the line width.
Line Joint
Specifies the line joint style for the border line.
●
●
●
●
Miter
Joins path segments by extending their outside edges until they meet.
Round
Joins path segments by rounding off the corner at a radius of half the line width.
Bevel
Joins path segments by connecting the outer corners of their wide outlines with a straight segment.
Joint Round
Joins path segments by rounding off the corner at a specified radius.
Radius
Specifies the radius for the border joint of the platform border line. Available only when Line Joint is set to Joint
Round.
Dash
Specifies the dash size of border line.
●
●
Auto Adjusted Dash
If selected, the dash size will be adjusted automatically.
Fixed Dash Size
If selected, the dash size will be fixed size.
Format Value(Y) Axis dialog
This dialog appears when you right-click a chart and select Format Axes > Format Value (Y) Axis from the
shortcut menu. It helps you to format the value(Y) axis of the chart and contains the following tabs:
●
Axis tab
●
Tick Mark tab
●
Font tab
●
Orientation tab
●
Format tab
OK
Applies the changes and closes the dialog.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
Axis tab
Specifies the general properties for the axis.
Option
Specifies the options for the axis.
●
●
●
●
●
●
Minimum Value
Specifies the minimum value that is to be displayed on the axis.
Maximum Value
Specifies the maximum value that is to be displayed on the axis.
Increment
Specifies the difference between two adjacent values on the axis.
Number of Tick Marks
Specifies how many tick marks to be displayed on the axis.
Show Gridlines
Specifies whether to show the horizontal gridlines in the chart.
Show Percent
Specifies whether to show the value labels on the axis in percent. Only applies to bullet, bar/bench, line, and
area chart that are not 100% stacked type.
Line
Specifies the line style for the axis.
●
●
●
●
Color
Specifies the color of the axis.
Style
Specifies the style of the axis.
Transparency
Specifies the transparency for the color of the axis.
Thickness
Specifies the thickness of the axis, in pixels.
Gap
Specifies the gap properties for the labels on the axis.
●
●
Label Axis Gap
Specifies the distance between the label and the axis, in pixels.
Best Effect
Specifies whether to adjust the labels on the axis automatically to make them placed best.
Tick Mark tab
The tab consists of two sub tabs: major tick mark tab, and minor tick mark tab.
Major Tick Mark tab
Specifies properties of the major tick marks on the axis.
Type
Specifies the type of the major tick marks on the axis.
●
●
●
●
None
If selected, major tick marks will not be shown on the axis and it will be meaningless to specify all the other
major tick mark related properties.
Inside
If selected, major tick marks will be inside the chart.
Outside
If selected, major tick marks will be outside the chart.
Cross
If selected, major tick marks will be across the axis.
Line
Specifies the line properties of the major tick marks on the axis.
●
Correlate with Axis
If checked, the line properties of the major tick marks will correlate with that of the axis automatically.
❍
❍
❍
❍
●
Color
Specifies the color of the major tick marks.
Transparency
Specifies the transparency for the color of the major tick marks.
Style
Specifies the type of the major tick marks.
Thickness
Specifies the thickness of the major tick marks, in pixels.
Tick Mark Length
Specifies the length for the major tick marks, in pixels.
Option
Specifies the other properties of the major tick mark labels on the axis.
●
●
●
●
Show Major Tick Mark Labels
Specifies whether to display the labels of the major tick marks on the axis. If checked, the following
properties will be enabled.
Label Every N Major Tick Marks
Specifies the frequency at which the major tick marks will be labeled.
Show Axis Label Tips
Specifies whether to display the complete label text when the mouse pointer points at a label on the axis.
Number of Major Labels
Specifies how many major tick mark labels to be displayed on the axis.
❍
❍
Auto
If checked, all major tick mark labels will be shown.
Fixed
If checked, you can specify the number of the major tick mark labels to be displayed on the axis.
Minor Tick Mark tab
Specifies properties of the minor tick marks on the axis.
Type
Specifies the type of the minor tick marks on the axis.
●
●
●
●
None
If selected, minor tick marks will not be shown on the axis and it will be meaningless to specify all the other
minor tick mark related properties.
Inside
If selected, minor tick marks will be inside the chart.
Outside
If selected, minor tick marks will be outside the chart.
Cross
If selected, minor tick marks will be across the axis.
Line
Specifies the line properties of the minor tick marks on the axis.
●
Correlate with Axis
If checked, the line properties of the minor tick marks will correlate with that of the axis automatically.
❍
❍
❍
❍
●
Color
Specifies the color of the minor tick marks.
Style
Specifies the type of the minor tick marks.
Transparency
Specifies the transparency for the color of the minor tick marks.
Thickness
Specifies the thickness of the minor tick marks, in pixels.
Tick Mark Length
Specifies the length of the minor tick marks, in pixels.
Font tab
Specifies the font format for text text in the major tick mark labels on the axis.
Font
Specifies the font face of the label text.
Size
Specifies the font size of the label text.
Fill Type
Specifies the fill type of the label text.
Color
Specifies the color of the label text.
Transparency
Specifies the transparency of the label text.
Font Style
Specifies the font style of the text. It can be one of the following: Plain, Bold, Italic and Bold Italic.
Orientation tab
Specifies the rotation angle of the major tick mark labels on the axis.
Automatic
Specifies whether to adjust the rotation angle of the label text on the axis automatically according to the length
of the label text, in degrees.
When this option is checked by default:
●
●
If the text can be completely displayed horizontally, the default rotation angle will be 0.
If the text cannot be completely displayed horizontally, the default rotation angle will be 30 anticlockwise,
and the cut off part will be shown as suspension points.
Angle
Specifies to customize the rotation angle of the label text on the axis.
Format tab
Specifies the data format of the major tick mark labels on the axis.
Category
Lists the category types. Select one to customize its format.
Format
Displays all the formats of the selected category. Select the required one and click Add to add it as the format
of the specified category. You can add only one format for each category.
Properties
Displays the properties of the format you select. If the formats listed in the Format box cannot meet your
requirement, define the format in the text field and then click Add to add it as the format of the specified
category.
Sample
Displays the selected format effects.
Stack
Lists all the formats you select from different categories.
Add
Adds a format to the Stack list box.
Remove
Removes a format from the Stack list box.
Apply
Applies the specified format in the Stack list box to the major tick mark labels.
Format Value(Y2) Axis dialog
This dialog appears when you right-click a chart and select Format Axes > Format Value (Y2) Axis from the
shortcut menu. It helps you to format the value(Y2) axis of the chart and contains the following tabs:
●
Axis tab
●
Tick Mark tab
●
Font tab
●
Orientation tab
●
Format tab
OK
Applies the changes and closes the dialog.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
Axis tab
Specifies the general properties for the axis.
Option
Specifies the options for the axis.
●
●
●
●
●
●
Minimum Value
Specifies the minimum value that is to be displayed on the axis.
Maximum Value
Specifies the maximum value that is to be displayed on the axis.
Increment
Specifies the difference between two adjacent values on the axis.
Number of Tick Marks
Specifies how many tick marks to be displayed on the axis.
Show Gridlines
Specifies whether to show the horizontal gridlines in the chart.
Show Percent
Specifies whether to show the value labels on the axis in percent. Only applies to bullet, bar/bench, line, and
area chart that are not 100% stacked type.
Line
Specifies the line style for the axis.
●
●
●
●
Color
Specifies the color of the axis.
Style
Specifies the style of the axis.
Transparency
Specifies the transparency for the color of the axis.
Thickness
Specifies the thickness of the axis, in pixels.
Gap
Specifies the gap properties for the labels on the axis.
●
●
Label Axis Gap
Specifies the distance between the label and the axis, in pixels.
Best Effect
Specifies whether to adjust the labels on the axis automatically to make them placed best.
Tick Mark tab
The tab consists of two sub-tabs: major tick mark tab, and minor tick mark tab.
Major Tick Mark tab
Specifies properties of the major tick marks on the axis.
Type
Specifies the type of the major tick marks on the axis.
●
●
●
●
None
If selected, major tick marks will not be shown on the axis and it will be meaningless to specify all the other
major tick mark related properties.
Inside
If selected, major tick marks will be inside the chart.
Outside
If selected, major tick marks will be outside the chart.
Cross
If selected, major tick marks will be across the axis.
Line
Specifies the line properties of the major tick marks on the axis.
●
Correlate with Axis
If checked, the line properties of the major tick marks will correlate with that of the axis automatically.
❍
❍
❍
❍
●
Color
Specifies the color of the major tick marks.
Transparency
Specifies the transparency for the color of the major tick marks.
Style
Specifies the type of the major tick marks.
Thickness
Specifies the thickness of the major tick marks, in pixels.
Tick Mark Length
Specifies the length for the major tick marks, in pixels.
Option
Specifies the other properties of the major tick mark labels on the axis.
●
●
●
●
Show Major Tick Mark Labels
Specifies whether to display the labels of the major tick marks on the axis. If checked, the following
properties will be enabled.
Label Every N Major Tick Marks
Specifies the frequency at which the major tick marks will be labeled.
Show Axis Label Tips
Specifies whether to display the complete label text when the mouse pointer points at a label on the axis.
Number of Major Labels
Specifies how many major tick mark labels to be displayed on the axis.
❍
❍
Auto
If checked, all major tick mark labels will be shown.
Fixed
If checked, you can specify the number of the major tick mark labels to be displayed on the axis.
Minor Tick Mark tab
Specifies properties of the minor tick marks on the axis.
Type
Specifies the type of the minor tick marks on the axis.
●
●
●
●
None
If selected, minor tick marks will not be shown on the axis and it will be meaningless to specify all the other
minor tick mark related properties.
Inside
If selected, minor tick marks will be inside the chart.
Outside
If selected, minor tick marks will be outside the chart.
Cross
If selected, minor tick marks will be across the axis.
Line
Specifies the line properties of the minor tick marks on the axis.
●
Correlate with Axis
If checked, the line properties of the minor tick marks will correlate with that of the axis automatically.
❍
❍
❍
❍
●
Color
Specifies the color of the minor tick marks.
Style
Specifies the type of the minor tick marks.
Transparency
Specifies the transparency for the color of the minor tick marks.
Thickness
Specifies the thickness of the minor tick marks, in pixels.
Tick Mark Length
Specifies the length of the minor tick marks, in pixels.
Font tab
Specifies the font format for text in the major tick mark labels on the axis.
Font
Specifies the font face of the label text.
Size
Specifies the font size of the label text.
Fill Type
Specifies the fill type of the label text.
Color
Specifies the color of the label text.
Transparency
Specifies the transparency of the label text.
Font Style
Specifies the font style of the text. It can be one of the following: Plain, Bold, Italic and Bold Italic.
Orientation tab
Specifies the rotation angle of the major tick mark labels on the axis.
Automatic
Specifies whether to adjust the rotation angle of the label text on the axis automatically according to the length
of the label text, in degrees.
When this option is checked by default:
●
●
If the text can be completely displayed horizontally, the default rotation angle will be 0.
If the text cannot be completely displayed horizontally, the default rotation angle will be 30 anticlockwise,
and the cut off part will be shown as suspension points.
Angle
Specifies to customize the rotation angle of the label text on the axis.
Format tab
Specifies the data format of the major tick mark labels on the axis.
Category
Lists the category types. Select one to customize its format.
Format
Displays all the formats of the selected category. Select the required one and click Add to add it as the format
of the specified category. You can add only one format for each category.
Properties
Displays the properties of the format you select. If the formats listed in the Format box cannot meet your
requirement, define the format in the text field and then click Add to add it as the format of the specified
category.
Sample
Displays the selected format effects.
Stack
Lists all the formats you select from different categories.
Add
Adds a format to the Stack list box.
Remove
Removes a format from the Stack list box.
Apply
Applies the specified format in the Stack list box to the major tick mark labels.
Format Value(Y) Gridline dialog
This dialog appears when you right-click a chart and select Format Gridlines > Value(Y) Gridline from the
shortcut menu. It helps you to format the value(Y) gridline of the chart.
Color
Specifies the color schema for value(Y) gridlines in the chart.
Line Style
Specifies the style for value(Y) gridlines in the chart.
Transparency
Specifies the transparency of the color of value(Y) gridlines in the chart.
Thickness
Specifies the thickness for value(Y) gridlines in the chart.
OK
Applies the changes and closes the dialog.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
Format Wall dialog
This dialog appears when you right-click a chart and select Format Walls > Format Wall from the shortcut
menu. It helps you to format the wall of the chart and contains the following tabs:
●
General tab
●
Border tab
OK
Applies the changes and closes the dialog.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the wall.
Wall
Specifies the color or the fill effect of the wall of the chart.
●
●
●
Fill Type
Specifies the fill type of the wall.
Color
Specifies the color of the wall.
Transparency
Specifies the transparency of the color schema that is applied to the wall of the chart.
Bound
Specifies the fill color or effect to compound with the basic fill which is set in the Wall area.
●
●
●
Fill Type
Specifies the fill type of the wall.
Color
Specifies the fill color schema or effect to compound with the basic fill which is set for the walls of a chart in
the Wall area.
Transparency
Specifies the transparency of the color schema that is applied here.
Border tab
This tab shows information about borders of the wall.
Color
Specifies the color schema for the border of the wall.
Transparency
Specifies the transparency of the color schema that is applied to the border of the wall.
Thickness
Specifies the thickness for the border of the wall.
Line Style
Specifies the line style for the border of the wall.
Formula Editor dialog
This dialog appears when you expand the Dynamic Resource > Formulas node in the Resources panel, then click <Add Formula…> or right-click a
dynamic formula and then select Edit from the shortcut menu. It helps you to create or edit a dynamic formula in a report.
Formula Name
Specifies the name of the formula.
Fields box
Displays a list of those fields that are available to formulas. The fields include the group and detail objects in the current business view, and the
dynamic formulas that have been created in the report. You can select one field and double-click it to insert the field into the editing box at the
insertion point.
Functions box
Displays a list of JReport functions that are available to formulas. When you select one function and double-click it, JReport will insert the selected
function into the editing box at the insertion point completely with its required syntax items (parentheses, commas, etc).
Operators box
Displays a list of operators that are available to formulas. Select one operator and double-click it to insert the selected operator into the editing box at
the insertion point.
Editing box
In this box, you can build and edit your formula. There are several ways to work with formulas:
●
Select formula components from the Fields, Functions and Operators boxes in the Formula Editor, and then double-click the components, JReport will
then insert them in the formula;
●
Type your formula in the editing box directly;
●
Use the above two methods together;
●
Paste formula text from the text document of other programs.
Note: If you refer to any field in the formula, the reference name for that field will be prefixed with an @ sign. If the field name contains spaces, the
reference name in formula will be quoted with double-quotation marks (""). For example, if the field name is Customer Name, then the reference name
will be @"Customer Name".
Tests the syntax of your formula. If the syntax is incorrect, JReport provides an opportunity to correct the errors.
Selects a general operator to be used in the editing box.
A color palette is provided for you to insert the HEX code of a color simply by clicking the corresponding color in the color palette instead of inputting
the HEX code manually.
OK
Creates or edits the formula and closes the dialog.
Cancel
Cancels the creation or edition of the formula and closes the dialog.
Help
Displays this help document.
Group Footer Properties dialog
The dialog appears when you right-click a table group footer and select Table Row > Properties from the
shortcut menu. It helps you to specify the properties of the group footer and contains the following tabs:
●
General tab
●
Border tab
OK
Applies the settings for the group footer properties and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the group footer.
Name
Specifies the display name of the group footer.
Height
Specifies the height of the group footer.
Background
Specifies the background color of the group footer.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB, or click More Fill Effects to specify a gradient or an image as the fill effect in the Fill Effects
dialog. If you want to make the background transparent, input Transparent in the text box.
Border tab
This tab shows information about borders of the group footer.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Group Header Properties dialog
The dialog appears when you right-click a table group header and select Table Row > Properties from the
shortcut menu. It helps you to specify the properties of the group header and contains the following tabs:
●
General tab
●
Border tab
OK
Applies the settings for the group header properties and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the group header.
Name
Specifies the display name of the group header.
Height
Specifies the height of the group header.
Background
Specifies the background color of the group header.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB, or click More Fill Effects to specify a gradient or an image as the fill effect in the Fill Effects
dialog. If you want to make the background transparent, input Transparent in the text box.
Border tab
This tab shows information about borders of the group header.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Image Properties dialog
The dialog appears when you right-click an image and select Properties from the shortcut menu. It helps you to
edit the properties of the image.
Name
Specifies the display name of the image, which will be shown on the shortcut menu of the image.
Picture Name
Displays the image file name.
Scaling Mode
Specifies the scaling mode for the image. The mode can be:
●
actual size: The image will be shown in its actual size.
●
customize: The image size will be equal to the image field size.
●
fit image: The image will be scaled largest to wholly show in the image field.
●
fit width: The image will be scaled largest to fit the width of the image field.
●
fit height: The image will be scaled largest to fit the height of the image field.
Horizontal Alignment
Specifies the horizontal alignment of the image in its container.
Vertical Alignment
Specifies the vertical alignment of the image in its container.
Rotation
Rotates the image at a specified angle in degrees. The following is the meaning of different values:
●
0 - No rotation.
●
Positive value - Rotate the image clockwise.
●
Negative value - Rotate the image anticlockwise.
Note: When you rotate an image, the rectangle that holds the image maintains its original size, which may
result in that the image exceeds the field border and therefore the parts that extend outside of the border will
be cut off.
Width
Specifies the width of the image.
Height
Specifies the height of the image.
Alt
Specifies the alternate text which will be shown if the image cannot be displayed.
Title
Specifies tip information about the image, which will be displayed when the mouse cursor hovers on the image.
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
Insert Chart dialog
This dialog appears when you click Menu > Insert > Chart, or drag Chart from the Components panel to the
destination. It helps you to insert a chart to a report.
Chart Title
Specifies a title for the chart.
Sets the font, font style, size, alignment, font color and background color properties for the chart title.
Data Source
Specifies the data source on which the chart will be built.
Filter
Opens the Query Filter dialog to specify the filter which you want to apply to the selected business view.
Resources
Displays the view elements in the selected business view.
Edits the selected dynamic resource.
Adds the selected resource to be displayed in the chart.
Show Values
Lists the values you want to show in the chart. For a real time chart, the values you add must be of Numeric type
and cannot be aggregation objects.
●
●
●
●
●
Primary Axis
Adds a chart type to the primary axis.
Secondary Axis
Adds a chart type to the secondary axis. Active only when the option Secondary Axis is checked.
X Axis
Lists the value you want to show on the X axis of the bubble chart.
Y Axis
Lists the value you want to show on the Y axis of the bubble chart.
Radius
Lists the value you want to show as the bubble radius.
Adds a combo chart to the Primary Axis or Secondary Axis.
Opens the Edit Additional Value dialog to edit the selected additional value.
Moves the selected view element one level up.
Moves the selected view element one level down.
Adds a new pair of Y Axis and Radius for the bubble chart.
Secondary Axis
Specifies whether to show the secondary axis in the chart.
Category
Lists the group object
that will be displayed on the category axis of the chart. For a real time chart, if no object
is specified on the category axis, Use System Refresh Time will be automatically displayed in the Category text box,
namely, the time at which the chart refreshes itself will be used as the category value.
Series
Lists the group object
that will be displayed on the series axis of the chart. Not available for real time chart.
Opens the Category Options dialog or Series Options dialog to define the sort order of the category or series values
and specify the number of the category or series values that will be displayed in the chart.
Motion Bar for Playable Chart
you want to use as the motion field. A motion field can only be of Integer, Date or Time
Lists the group object
data type. Available to single bar, bench and bubble chart types only.
●
Special Function
Available only when the motion field is of Date data type. Click it to define the special function.
❍
❍
❍
❍
Field
Displays on which field the special function will be applied.
Function
Specifies the special function to the field.
OK
Accepts the special function settings and leaves the dialog.
Cancel
Cancels the special function settings and leaves the dialog.
Real Time
Specifies to run the chart in real time mode, which means it will be updated automatically by using real time data.
Available to single bar, bench, line, and area chart types only. Click
number of the records to be kept.
●
●
●
●
to specify the refresh interval and the
Refresh Interval
Specifies the interval that the chart will get the data and refresh itself automatically.
Keep Last N Records
Specifies the number of records that will be kept for the real time data on the chart.
OK
Accepts the interval and records settings and closes the dialog.
Cancel
Cancels the interval and records settings and closes the dialog.
Removes the selected resource.
OK
Inserts a chart in the report and closes the dialog.
Cancel
Cancels the insertion and closes the dialog.
Help
Displays this help document.
Insert Crosstab dialog
This dialog appears when you click Menu > Insert > Crosstab, or drag Crosstab from the Components panel to the
destination. It helps you to insert a crosstab to a report.
Crosstab Title
Specifies a title for the crosstab.
Sets the font, font style, size, alignment, font color and background color properties for the crosstab title.
Data Source
Specifies a data source on which the crosstab will be built from the data source drop-down list.
Filter
Opens the Query Filter dialog to specify the filter which you want to apply to the selected business view.
Resources
Displays the elements in the selected business view.
Edits the selected dynamic resource.
Adds the selected group object
to be displayed in the columns of the crosstab.
Adds the selected group object
to be displayed in the rows of the crosstab.
Adds the selected aggregation object
or detail object
to be the summary field of the crosstab.
Columns/Rows
●
●
●
Field
Lists the group objects that will be displayed in the columns/rows of the crosstab.
Label
Specifies the display names for the selected group objects.
Sort
Specifies the sort order of the group objects.
Summaries
●
●
●
Field
Lists the fields that you select to create summaries.
Label
Specifies the display names for the selected fields.
Aggregation
Specifies the functions used to summarize data of the selected detail objects.
Moves the selected view element one level up.
Moves the selected view element one level down.
Removes the selected resource.
OK
Inserts a crosstab and closes the dialog.
Cancel
Cancels the insertion and closes the dialog.
Help
Displays this help document.
Insert Filter Control dialog
The dialog is displayed when you drag Filter Control from the Components panel to a report, or click
Menu > Insert > Filter Control. It helps you to insert a filter control into a report for filtering data
components in the report.
Select Fields
Specifies the fields to bind to the filter control. All the selected fields should be of the same data type.
The common usage is to select one field, and then based on the field to filter the data of the
components created from the same data source as the field.
To filter components using different data sources, choose a common field all the data sources contain
and select the field in all the data sources.
Apply To
Specifies the components to which the filter created with the filter control will be applied.
OK
Inserts a filter control into the report and closes the dialog.
Cancel
Cancels the insertion and closes the dialog.
Help
Displays this help document.
Insert Image dialog
This dialog appears when you click Menu > Insert > Image, drag Image from the Components panel to
a report, or click
image into a report.
on the Page screen of the JReport Studio Wizard. It helps you to insert an
Image From
Specifies the source of the image file.
●
Local File
Specifies to use an image from the local file system.
❍
●
File Name
Specifies the path and name of the image file. You can click the Browse button to locate the image
file.
Web URL
Specifies to use an image via URL.
❍
Image URL
Specifies the URL of the image file.
Note: If your JReport Server is in an intranet which requires a proxy, to successfully access the
image via URL, you need to add the parameters -Dhttp.proxyHost=XXX -Dhttp.proxyPort=XX
to the server's startup file JRServer.bat, which is located in <install_root>\bin.
●
Library
Specifies to use an existing image.
❍
My Images
The My Images folder is a virtual location where JReport Server stores the images that have once
been inserted into reports. Select the one you want to use.
Preview
Displays a preview of the selected image.
OK
Inserts the image into the report and closes the dialog.
Cancel
Cancels the insertion and closes the dialog.
Help
Displays this help document.
Insert Link dialog
This dialog appears when you right-click an object, click Link on the shortcut menu. It helps you to link
the specified object to a report, URL or e-mail address as required.
Select Link Type
Specifies the type of the link target. It can be one of the following:
●
Link to Report
●
Link to URL
●
Link to E-mail
Advanced
Displays the advanced settings. Available to the Link to Report type only.
OK
Applies the settings and closes the dialog.
Cancel
Cancels the changes and exits the dialog.
Help
Displays this help document.
Link to Report
It helps you to link a specified object to a report.
Report
Specifies the target linked report. Click the Browse button to select the desired report in the Select a
Report dialog.
Target
Specifies the window or frame in which to load the linked report.
●
●
New Window
Loads the linked file into a new window. This window is not named.
Parent Frame
Loads the linked file into the parent frame of the frame that contains the link.
●
●
●
●
Same Frame
Loads the linked file into the same frame as the link.
Whole Window
Loads the linked file into the full browser window.
<Server Setting>
Loads the linked file according to setting of the Pop Up New Window for Links option in the Customize
Profile panel of the Profile dialog in JReport Server.
Other Frame
Loads the linked file into some other specified frame. If the frame name does not exist, the linked file
will be loaded into a new window.
Conditions tab
Specifies the link conditions between the primary report and the linked report.
●
Components
Specifies the components in the linked report that will be interlinked with the primary report.
❍
❍
●
●
Adds a component in the linked report to be interlinked with the primary report.
Removes the selected component.
Default Linked Component
Specifies the default linked component in the linked report. The setting is applied when the primary
report runs in HTML, PDF or Excel format, or in JReport Studio.
Field Conditions
Specifies the link conditions between the primary report and the target linked report.
❍
❍
❍
❍
❍
Adds a new condition line to set up link between the linked report and the primary report.
Removes the selected condition line.
Fields(Primary)
Lists the selected fields of the primary report.
OP
Specifies the operator to set up links between the primary report and linked report. It can be =,
<>, <, >, <=, >= or IN.
Fields(LinkedReport)
Lists the fields in the datasets of the linked report which are of the same data as the selected fields
in the primary report.
Parameters tab
This tab is available when the linked report uses parameters. It helps you to assign values to the
parameters of the linked report automatically.
●
Target Report Parameters
Assigns values to the parameters of the target linked report.
❍
❍
Parameters
Lists all parameters contained in the target linked report.
Value
Lists all the DBFields, formulas, summaries and parameters in the primary report which are of the
same data type as the parameters of the target linked report.
Link to URL
It helps you to link a specified object to a location specified by a URL.
Hyperlink
Specifies the URL for the hyperlink that is to be used to link the object.
Target
Specifies the window or frame in which to load the location specified by the URL.
●
●
●
●
●
●
New Window
Loads the linked file into a new window. This window is not named.
Parent Frame
Loads the linked file into the parent frame of the frame that contains the link.
Same Frame
Loads the linked file into the same frame as the link.
Whole Window
Loads the linked file into the full browser window.
<Server Setting>
Loads the linked file according to setting of the Pop Up New Window for Links option in the Customize
Profile panel of the Profile dialog in JReport Server.
Other Frame
Loads the linked file into some other specified frame. If the frame name does not exist, the linked file
will be loaded into a new window.
Link to E-mail
It helps you to link the specified object to an e-mail address.
Hyperlink
Specifies the e-mail address that the object will be linked to.
Related topics:
●
Binding Links to components
Insert Multimedia dialog
This dialog appears when you click Menu > Insert > Multimedia Object or drag Multimedia Object from
the Components panel to the report. It helps you to insert a multimedia object to a report.
Flash
Specifies to insert a flash file to the current report.
Real Media File
Specifies to insert a real media file to the current report.
Windows Media File
Specifies to insert a Windows Media file to the current report.
File Name/URL
Specifies the name or URL of the multimedia object that is to be inserted into the report. Type in the
name or URL in the text box or click Browse to find the file.
Plug-in Page
Specifies the URL of the plug-in page from which to download the player with which to play the inserted
multimedia object on a webpage, if the player isn't already installed on your local disk.
Properties
Specifies the properties of the multimedia object.
●
For Flash
Play
Specifies whether to start the flash file automatically when the report is opened.
❍
Loop
Specifies whether to play the flash file repeatedly.
❍
Movie Quality
Specifies the quality of the flash.
❍
For Real Media File
●
Auto Start
Specifies whether to start the realmedia file automatically when the report is opened.
❍
Center
Specifies whether to place the realmedia file in the center of the report.
❍
Loop
Specifies whether to play the realmedia file repeatedly.
❍
Loop Number
Specifies how many times you want to play the realmedia file.
❍
For Windows Media File
●
❍
❍
❍
Auto Start
Specifies whether or not to start the Windows Media automatically when the report is opened.
Auto Rewind
Specifies whether or not to rewind the Windows Media file automatically.
Play Count
Specifies the number of times you want to play this media file.
OK
Inserts the multimedia object to the report and closes the dialog.
Cancel
Cancels the insertion and closes the dialog.
Help
Displays this help document.
Insert Parameter Control dialog
The dialog is displayed when you drag Parameter Control from the Components panel to a report, or
click Menu > Insert > Parameter Control. It helps you to insert a parameter control into a report for
delivering parameter values to the report.
Select a Parameter
Specifies a parameter from the list where all the parameters except cascading parameters used by the
current report are displayed.
OK
Inserts a parameter control into the report and closes the dialog.
Cancel
Cancels the operation and closes the dialog.
Help
Displays this help document.
Insert Parameter Form Control dialog
The dialog is displayed when you drag Parameter Form Control from the Components panel to a report,
or click Menu > Insert > Parameter Form Control. It helps you to insert a parameter form control into a
report for running reports from the current report.
Please Select Target Reports
Specifies the reports to run.
●
Current Report
Specifies to run the current report with the specified parameters.
❍
●
Select Parameters
Specifies the parameters that are used to run the current report. Once you select one of a group of
cascading parameters, all the other parameters in the cascading group will be selected
automatically, and vice versa.
Others
Specifies to run other reports.
❍
❍
Reports
Specifies the target reports to run. If all the selected reports contain no parameters, you cannot
finish the dialog.
Parameter Information
You can click a report and then view its parameters here.
Include "Submit" Button
Specifies whether the inserted parameter form control contains the Submit button. If Submit is
included, it is used to submit the parameter values you specified in the parameter form control. If
Submit is not included, once you change the values of a parameter in the parameter form control, the
new values will be applied automatically.
OK
Inserts a parameter form control into the report and closes the dialog.
Cancel
Cancels the operation and closes the dialog.
Help
Displays this help document.
Insert Table dialog
This dialog appears when you click Menu > Insert > Table, or drag Table from the Components panel to the
destination. It helps you to insert a table into a report, and consists of the following tabs:
●
Display tab
●
Group tab
●
Summary tab
Table Title
Specifies a title for the table.
Sets the font, font style, size, alignment, font color and background color properties for the table title.
Data Source
Specifies a data source on which the table will be built from the data source drop-down list.
Filter
Opens the Query Filter dialog to specify the filter which you want to apply to the selected business view.
Table Type
Selects a type for the table you want from the Table Type drop-down list. By default, the Group Left Above is
selected.
●
●
●
●
Group Above
Creates a table with group information above the detail panel.
Group Left
Creates a table with group information left to the detail panel.
Group Left Above
Creates a table with group information left above the detail panel.
Summary Table
Creates a table with only group and summary information.
Display tab
Specifies the fields that you want to display in the table.
Resources
Displays all the view elements in the selected business view.
Edits the selected dynamic resource.
Removes the selected dynamic resource.
Adds the selected view element to be displayed in the table.
Removes the selected view element.
Field
Lists the view elements that have been added to the table.
Label
Specifies the display names for the added view elements.
Moves the selected view element one step up.
Moves the selected view element one step down.
Group tab
Specifies the fields to group the data.
Resources
Displays all the available group objects
you can use to group the data in the table.
Adds the selected group object as a group field.
Removes the selected group object.
Field
Lists all the group objects that have been added as the group fields.
Sort
Specifies the sort order for each group: Ascend, Descend, or No Sort.
Moves the selected group one step up.
Moves the selected group one step down.
Summary tab
Specifies the fields on which to create summaries.
Resources
Displays all the available aggregation objects
you can use to create summaries in the table.
Edits the selected dynamic resource.
Removes the selected dynamic resource.
Adds the selected aggregation object as the summary field.
Removes the selected aggregation object.
Field
Lists the groups that have been added in the table and the aggregation objects added to summarize data in each
group.
Moves the selected aggregation object one step up.
Moves the selected aggregation object one step down.
OK
Inserts a table and closes the dialog.
Cancel
Cancels the insertion and closes the dialog.
Help
Displays this help document.
JReport Studio Wizard
This wizard appears after you click Menu > File > New Report (or the New Report button
on the Standard
toolbar). It guides you through the process of creating a web report, and contains the following screens:
●
Page screen
●
Layout screen
●
Bind Data screen
●
Style screen
Displays this help document.
Back
Goes back to the previous screen.
Next
Goes to the next screen.
Save
Saves the report to the server resource tree.
Run
Opens the report in JReport Studio.
Page screen
Specifies the page settings of the report.
Templates
Specifies the template to be applied to the report.
●
●
●
Blank
Specifies to use the blank template.
Template1
Specifies to use Template1, in which you can specify the report title and company logo.
Template2
Specifies to use Template2, in which you can specify the company logo, company title, report title and sub title.
Page Setup
Opens the Page Setup dialog to specify the page properties.
Report Title
Specifies the display name of the report title.
Company Logo
Specifies the company logo image file.
Company Title 1
Specifies the display name of the company title 1.
Company Title 2
Specifies the display name of the company title 2.
Sub Title
Specifies the display name of the sub title.
Specifies the font properties for report title, sub title or company title.
●
●
●
●
●
●
Font
Lists all the available font faces that can be selected to apply to the title.
Font Style
Specifies the font style of the title. It can be one of the following: plain, bold, italic, and bold italic.
Size
Specifies the font size of the title.
Align
Specifies the position of the title to be left, right, center or justify.
Font Color
Specifies the font color of the title.
Background Color
Specifies the background color of the title.
Opens the Insert Image dialog to customize the image for company logo.
Layout screen
Specifies the layout of the report.
Built-in layouts
Lists the built-in layouts.
●
●
●
Default
There is only a cell in the tabular.
Top and Bottom
There are two cells in the tabular. One is at the top, and the other is at the bottom. Each cell uses half the height
of the tabular.
T-Style
There are two rows in the tabular. Each row uses half the height of the tabular. The top row has two cells with
each using half the width of the row, and the bottom row has only a cell.
●
●
2×3
There are six cells in the tabular. Each cell uses one third the height and one third the width of the tabular.
T-Style 2
There are two rows in the tabular. Each row uses half the height of the tabular. The top row has only a cell, and
the bottom row has two cells with each using half the width of the row.
Toolbar
The toolbar is enabled when a tabular cell in the below edit layout panel is selected.
●
●
●
●
Horizontal Split
Splits the selected tabular cell into two cells horizontally.
Vertical Split
Splits the selected tabular cell into two cells vertically.
Merge
Merges the selected adjacent tabular cells that form a rectangular into one cell.
Align
Specifies how the component aligns in the tabular cell.
❍
❍
❍
Left
Aligns the component to the left of the tabular cell.
Center
Aligns the component to the center of the tabular cell.
Right
Aligns the component to the right of the tabular cell.
Edit layout panel
Specifies the component to be inserted into the selected tabular cell.
●
●
Existing Components
Specifies a component from the ones existing in the open report to create the report.
New Components
Specifies the component you want to place in the tabular cell.
❍
❍
❍
❍
Table
Creates a table in the tabular cell.
Crosstab
Creates a crosstab in the tabular cell.
Chart
Creates a chart in the tabular cell.
Blank
Creates nothing in the tabular cell.
Tabular Cell Size
Displays the size of the selected tabular cell, in percent.
●
●
Width
Shows the width of the tabular cell.
Height
Shows the height of the tabular cell.
Bind Data screen
Specifies the data source and the fields to be displayed in each component selected in the Layout screen. This
screen differs according to the following component types: Table, Crosstab, Chart and Blank.
For Table component
Specifies the data displayed in the table.
Table Title
Specifies the title of the table. The title is a special label bound with the table. Though it can be positioned freely in
a report, once you remove the table from the report, the title will be removed too.
Specifies the font properties of the table title.
Data Source
Specifies the business view in the current catalog on which the table will be built.
Filter
Opens the Query Filter dialog to specify the filter you want to apply to the selected business view.
Table Type
Specifies the table type.
●
●
●
●
Group Above
Creates a table with group information above the detail panel.
Group Left
Creates a table with group information left to the detail panel.
Group Left Above
Creates a table with group information left above the detail panel.
Summary Table
Creates a table with only group and summary information.
Display tab
Specifies the fields to be displayed in the table.
●
●
●
●
●
●
●
●
●
Resources
Displays all the view elements in the selected business view.
Edits the selected dynamic resource.
Removes the selected dynamic resource.
Adds the selected view element to be displayed in the table.
Removes the selected view element.
Field
Lists the view elements that have been added to the table.
Label
Specifies the display names of the added view elements.
Moves the selected view element one step up.
Moves the selected view element one step down.
Group tab
Specifies the fields to group the data.
●
Resources
Displays all the available group objects
●
you can use to group data in the table.
Adds the selected group object as a group by field.
●
●
●
●
●
Removes the selected group object.
Field
Lists all the group objects that have been added as the group by fields.
Sort
Specifies the sort order for each group: Ascending, Descending, or No Sort.
Moves the selected group object one step up.
Moves the selected group object one step down.
Summary tab
Specifies the fields on which to create summaries.
●
Resources
Displays all the available aggregation objects
●
●
●
●
●
●
●
●
●
you can use to create summaries in the table.
Edits the selected dynamic resource.
Removes the selected dynamic resource.
Adds the selected aggregation object as the summary field.
Removes the selected aggregation object.
Field
Lists the groups that have been added in the table and the aggregation objects added to summarize data in each
group.
Row
Specifies to put the summary field in the header or footer row. If the summary is calculated on a group by field,
it will be put in the group header or footer row of the corresponding group; if the summary is calculated on the
whole dataset, it will be put in the table header or footer row. Available only when the table is Group Left type.
Column
Specifies to put the summary field in the specified detail column. Available only when the table is Group Left type.
Moves the selected aggregation object one step up.
Moves the selected aggregation object one step down.
For Crosstab component
Specifies the data displayed in the crosstab.
Crosstab Title
Specifies the title of the crosstab. The title is a special label bound with the crosstab. Though it can be positioned
freely in a report, once you remove the crosstab from the report, the title will be removed too.
Specifies the font properties of the crosstab title.
Data Source
Specifies the business view in the current catalog on which the crosstab will be built.
Filter
Opens the Query Filter dialog to specify the filter you want to apply to the selected business view.
Resources
Displays the elements in the selected business view.
Edits the selected dynamic resource.
Adds the selected group object
to be displayed on the columns of the crosstab.
Adds the selected group object
to be displayed on the rows of the crosstab.
Adds the selected aggregation object
or detail object
to be the summary field of the crosstab.
Columns/Rows
●
●
●
Field
Lists the group objects that will be displayed on the columns/rows of the crosstab.
Label
Specifies the display names of the group objects. By default these are blank and no names will be created for the
group objects to label the columns/rows. You can double-click the cells to edit them if required.
Sort
Specifies the sort order of the group objects.
Summaries
●
●
●
Field
Lists the aggregation/detail objects that you select to create summaries.
Label
Specifies the display names of the aggregation/detail objects. By default these are blank and no names will be
created for the objects to label the summaries. You can click in the cells to edit them if required.
Aggregation
Specifies the functions used to summarize data of the detail objects.
Moves the selected view element one level up.
Moves the selected view element one level down.
Removes the selected view element.
For Chart component
Specifies the data displayed in the chart.
Chart Title
Specifies the title of the chart. The title is a special label bound with the chart. Though it can be positioned freely in
a report, once you remove the chart from the report, the title will be removed too.
Specifies the font properties of the chart title.
Data Source
Specifies the business view in the current catalog on which the chart will be built.
Filter
Opens the Query Filter dialog to specify the filter you want to apply to the selected business view.
Resources
Displays the view elements in the selected business view.
Edits the selected dynamic resource.
Adds the selected resource to be displayed in the chart.
Show Values
Lists the values you want to show in the chart. For a real time chart, the values you add must be of Numeric type
and cannot be aggregation objects.
●
●
●
●
●
Primary Axis
Adds a chart type to the primary axis.
Secondary Axis
Adds a chart type to the secondary axis. Active only when the option Secondary Axis is checked.
X Axis
Lists the value you want to show on the X axis of the bubble chart.
Y Axis
Lists the value you want to show on the Y axis of the bubble chart.
Radius
Lists the value you want to show as the bubble radius.
Adds a combo chart to the Primary Axis or Secondary Axis.
Opens the Edit Additional Value dialog to edit the selected additional value.
Moves the selected view element one level up.
Moves the selected view element one level down.
Adds a new pair of Y Axis and Radius for the bubble chart.
Secondary Axis
Specifies whether to show the secondary axis in the chart.
Category
Lists the group object
that will be displayed on the category axis of the chart. For a real time chart, if no object
is specified on the category axis, Use System Refresh Time will be automatically displayed in the Category text box,
namely, the time at which the chart refreshes itself will be used as the category value.
Series
Lists the group object
that will be displayed on the series axis of the chart. Not available for real time chart.
Opens the Category Options dialog or Series Options dialog to define the sort order of the category or series values
and specify the number of the category or series values that will be displayed in the chart.
Motion Bar for Playable Chart
you want to use as the motion field. A motion field can only be of Integer, Date or Time
Lists the group object
data type. Available to single bar, bench and bubble chart types only.
●
Special Function
Available only when the motion field is of Date data type. Click it to define the special function.
❍
❍
❍
❍
Field
Displays on which field the special function will be applied.
Function
Specifies the special function to the field.
OK
Accepts the special function settings and leaves the dialog.
Cancel
Cancels the special function settings and leaves the dialog.
Real Time
Specifies to run the chart in real time mode, which means it will be updated automatically by using real time data.
Available to single bar, bench, line, and area chart types only. Click
number of the records to be kept.
●
●
●
●
to specify the refresh interval and the
Refresh Interval
Specifies the interval that the chart will get the data and refresh itself automatically.
Keep Last N Records
Specifies the number of records that will be kept for the real time data on the chart.
OK
Accepts the interval and records settings and closes the dialog.
Cancel
Cancels the interval and records settings and closes the dialog.
Removes the selected resource.
For Blank
The Bind Data screen is disabled for Blank.
Style screen
Specifies the style of the report.
Styles
Lists all the available styles for you to select from. No style will be applied when you select None.
Label Properties dialog
The dialog appears when you right-click a label and select Properties from the shortcut menu. It helps you to
specify the properties of the label and contains the following tabs:
●
General tab
●
Font tab
●
Border tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the label.
Name
Specifies the display name of the label, which will be shown on the shortcut menu of the label.
Width
Specifies the width of the label.
Text
Specifies the text of the label.
Height
Specifies the height of the label.
Position
Displays the position mode of the label. If the label is directly contained in the report body, a tabular cell, or a
text box, its position mode can be modified.
●
●
Absolute: The label's position will be decided by its X and Y property values.
Static: The label will be positioned at the default location in its container. If selected, the X, Y and other
position-related properties will be hidden or disabled.
Top Padding
Specifies the space between the text of the label and its top border.
Bottom Padding
Specifies the space between the text of the label and its bottom border.
Left Padding
Specifies the space between the text of the label and its left border.
Right Padding
Specifies the space between the text of the label and its right border.
Background
Specifies the background color of the label.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB. If you want to make the background transparent, input Transparent in the text box.
Foreground
Specifies the foreground color of the label.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB.
Font tab
This tab shows the font-related information of the label.
Font
Specifies the font face of the label text.
Size
Specifies the font size of the label text.
Horizontal Alignment
Specifies the horizontal alignment mode of the text in the label.
Vertical Alignment
Specifies the vertical alignment mode of the text in the label.
Bold
Specifies whether to make the label text bold or not.
Underline
Specifies whether the label text will be underlined or not.
Strikethrough
Specifies whether or not to attach a strikeout line to the label text.
Italic
Specifies whether to make the label text italic or not.
Autofit
Specifies whether or not to automatically adjust the width of the label.
Word Wrap
Specifies whether or not to wrap the text to the label width.
Ignore HTML Tag
If this option is unchecked, JReport will parse HTML tag elements in the field value while the report is to be
saved as an HTML file; or the field value will appear in the HTML file the same as that in JReport Studio (HTML
tag elements in the field value, if any, will not be parsed).
Border tab
This tab shows information about borders of the label. You can modify all the border settings in this tab.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Shadow
Specifies whether the borders will have a shadow effect or not.
Shadow Color
Specifies the color of the border shadow.
Navigation Control Properties dialog
This dialog appears when you right-click a navigation control and select Properties from the shortcut menu. It
helps you to edit the properties of the navigation control and contains the following tabs:
●
General tab
●
Border tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the navigation control.
Name
Specifies the name of the navigation control.
Width
Specifies the width of the navigation control.
Height
Specifies the height of the navigation control.
Background
Specifies the background color of the navigation control.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB. If you want to make the background transparent, input Transparent in the text box.
Border tab
This tab shows information about borders of the navigation control.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Page Setup dialog
This dialog appears when you click the Page Setup link in the JReport Studio Wizard or click Menu >
File > Page Setup in JReport Studio. It helps you to specify the page properties and consists of the
following two options:
●
Web Report
●
Print Report
OK
Applies all changes and closes the dialog.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
Web Report
If selected, the unit of page size is pixel, and the dialog appears
Resolution
Specifies the paper resolution. If you select Custom Size, you can then input the paper's Width and
Height.
●
●
●
Type
Specifies the paper type.
Width
Specifies the paper width.
Height
Specifies the paper height.
Margin
Specifies the distance of the report data to the top, bottom, left, or right edge of the page.
●
●
●
●
Top
Specifies the top margin of the page.
Bottom
Specifies the bottom margin of the page.
Left
Specifies the left margin of the page.
Right
Specifies the right margin of the page.
Print Report
If selected, the unit of the page size is inch, and the dialog appears
Page
Specifies the paper size. If you select Custom Size, you can then input the paper's Width and Height.
●
●
●
Type
Specifies the paper type.
Width
Specifies the width of the paper.
Height
Specifies the height of the paper.
Orientation
Specifies the paper orientation.
●
●
Portrait
Displays the report data in a portrait orientation (vertically).
Landscape
Displays the report data in a landscape orientation (horizontally).
Margin
Specifies the margin properties.
●
●
●
●
Top
Specifies the distance of report data to the top edge of the page.
Left
Specifies the distance of report data to the left edge of the page.
Bottom
Specifies the distance of report data to the bottom edge of the page.
Right
Specifies the distance of report data to the right edge of the page.
Parameter Control Properties dialog
This dialog appears when you right-click a parameter control and select Properties from the shortcut menu. It
helps you to edit the properties of the parameter control and contains the following tabs:
●
General tab
●
Font tab
●
Border tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the parameter control.
Name
Specifies the name of the parameter control.
Parameter
Displays the name of the parameter.
Format
Specifies the display format of the parameter value.
Width
Specifies the width of the parameter control.
Height
Specifies the height of the parameter control.
Top Padding
Specifies the space between the text of the parameter control and its top border.
Bottom Padding
Specifies the space between the text of the parameter control and its bottom border.
Left Padding
Specifies the space between the text of the parameter control and its left border.
Right Padding
Specifies the space between the text of the parameter control and its right border.
Background
Specifies the background color of the parameter control.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB. If you want to make the background transparent, input Transparent in the text box.
Foreground
Specifies the foreground color of the parameter control.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB.
Font tab
This tab shows the font-related information of the text in the parameter control.
Font
Specifies the font face of the text.
Size
Specifies the font size of the text.
Horizontal Alignment
Specifies the horizontal alignment mode of the text.
Vertical Alignment
Specifies the vertical alignment mode of the text.
Bold
Specifies whether to make the text bold or not.
Underline
Specifies whether the text will be underlined or not.
Italic
Specifies whether to make the text italic or not.
Border tab
This tab shows information about borders of the parameter control.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Parameter Field Properties dialog
The dialog appears when you right-click a parameter field and select Properties from the shortcut menu. It
helps you to modify the properties of the parameter field and contains the following tabs:
●
General tab
●
Font tab
●
Border tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the parameter field.
Name
Specifies the display name of the parameter field, which will be shown on the shortcut menu of the parameter
field.
Width
Specifies the width of the parameter field.
Format
Specifies the data format of the parameter field.
Height
Specifies the height of the parameter field.
Top Padding
Specifies the space between the text of the parameter field and its top border.
Bottom Padding
Specifies the space between the text of the parameter field and its bottom border.
Left Padding
Specifies the space between the text of the parameter field and its left border.
Right Padding
Specifies the space between the text of the parameter field and its right border.
Background
Specifies the background color of the parameter field.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB. If you want to make the background transparent, input Transparent in the text box.
Foreground
Specifies the foreground color of the parameter field.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB.
Font tab
This tab shows the font-related information of the parameter field. You can modify all the font settings in this
tab.
Font
Specifies the font face of the parameter field text.
Size
Specifies the font size of the parameter field text.
Horizontal Alignment
Specifies the horizontal alignment mode of the text in the parameter field.
Vertical Alignment
Specifies the vertical alignment mode of the text in the parameter field.
Bold
Specifies whether to make the object text bold or not.
Underline
Specifies whether the field text will be underlined or not.
Strikethrough
Specifies whether or not to attach a strikeout line to the parameter field text.
Italic
Specifies whether to make the field text italic or not.
Autofit
Specifies whether or not to automatically adjust the width of the parameter field.
Word Wrap
Specifies whether or not to wrap the text to the parameter field width.
Ignore HTML Tag
If this option is unchecked, JReport will parse HTML tag elements in the field value while the report is to be
saved as an HTML file; or the field value will appear in the HTML file the same as that in JReport Studio (HTML
tag elements in the field value, if any, will not be parsed).
Border tab
This tab shows information about borders of the parameter field. You can modify all the border settings in this
tab.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Shadow
Specifies whether the borders will have a shadow effect or not.
Shadow Color
Specifies the color of the border shadow.
Parameter Form Control Properties dialog
This dialog appears when you right-click a parameter form control and select Properties from the shortcut
menu. It helps you to edit the properties of the parameter form control and contains the following tabs:
●
General tab
●
Border tab
●
Title tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the parameter form control.
Name
Specifies the name of the parameter form control.
Width
Specifies the width of the parameter form control.
Height
Specifies the height of the parameter form control.
Background
Specifies the background color of the parameter form control.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB. If you want to make the background transparent, input Transparent in the text box.
Show Title
Specifies whether to show the title of the parameter form control.
Border tab
This tab shows information about borders of the parameter form control.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Title tab
This tab shows information about the title of the parameter form control. It is available when the Show Title
option is selected in the General tab of the same dialog.
Text
Specifies the text of the title.
Background
Specifies the background color of the title.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB. If you want to make the background transparent, input Transparent in the text box.
Foreground
Specifies the foreground color of the title.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB.
Font
Specifies the font face of the text.
Size
Specifies the font size of the text.
Horizontal Alignment
Specifies the horizontal alignment mode of the text.
Bold
Specifies whether to make the text bold or not.
Underline
Specifies whether the text will be underlined or not.
Italic
Specifies whether to make the text italic or not.
PDF Encrypt Option dialog
This dialog appears when you check the Encrypt checkbox in the Export dialog. It helps you to set
encryption options for the PDF file to be saved.
Compatibility
Specifies the encryption type to encrypt the PDF document. The option Acrobat 3.0 and later uses a low
encryption level (40-bit RC4), while the other option Acrobat 5.0 and later uses a high encryption level
(128-bit RC4).
Encryption Level
Shows the level of the encryption compatibility that you specified in the Compatibility drop-down list.
Require a password to open the document
Specifies the Document Open Password to prevent others from opening the document without
authorization.
●
Document Open Password
Specifies the password to prevent others from opening the document without authorization.
●
Confirm Password
Confirms the password you have specified in the Document Open Password text box.
Use a password to restrict printing and editing of the document and its security settings
Specifies the Permission Password to prevent others from printing and editing the document. The
password you specify here cannot be the same as the one that you use to open the document.
●
●
●
●
Permissions Password
Specifies the password to prevent others from printing and editing.
Confirm Password
Confirms the password you have specified in the Permissions Password text box.
Printing Allowed
Specifies the printing quality for the PDF document.
Changes Allowed
Specifies the editing actions that are permitted in the PDF document.
Enable copying of text, images and other content
Allows others to select and copy the contents of the PDF document.
Enable text access for screen reader devices for the visually impaired
Allows visually impaired users to read the PDF document with window readers. This option is available
only if the Compatibility option is set to Acrobat 5.0 or later Acrobat version.
OK
Applies the encryption option settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
PDF Sign Option dialog
This dialog appears when you check the Sign checkbox in the Export dialog. It helps you to set signing
options for the PDF file to be saved.
Method
Specifies the digital signing method.
Digital ID File
Specifies whether to use a digital ID file from a specified directory.
User Password
Specifies a password for this digital ID file.
Confirm Password
Confirms the password.
Reason for Signing Document
Specifies the reason for signing the document.
Edit by Yourself
Edits the reason for signing the document. It is enabled when I agree to 'specified' portions of this
document is selected from the Reason for Signing Document drop-down list.
Location
Specifies your location accordingly.
Your Contact Information
Specifies your contact information accordingly.
OK
Applies the signing option settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
Print dialog
This dialog appears when you click Menu > File > Print. It helps you to set settings for printing the
report result and contains the following tabs:
●
General tab
●
Appearance tab
OK
Prints the report result with the specified settings to a PDF or HTML file and opens it in an associated
program with which you can print the result to a printer.
Cancel
Cancels the print settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the report to be printed.
Print Method
Specifies the printing method to print the report result.
Printer
Specifies the settings of the printer.
●
●
●
Printer
Specifies the name of the printer. Select one from the drop-down list.
Media Tray
Specifies the media tray for the printer. Select one from the drop-down list.
Print to File
Prints the document to a file instead of a printer. This kind of files can only be opened and printed by
serial port printer on Windows via DOS command.
Print Range
Specifies the pages to be printed.
●
●
All
All pages will be printed.
Pages...to...
Specifies the pages to be printed.
Copies
Specifies the information of the copies.
●
●
Number of Copies
Specifies the number of copies you want to print. The number of copies will be applied to all specified
pages.
Collate
Specifies the printing order for printing multiple-page reports. If checked, when you print two copies
of a three-page report, the page order is 1, 2, 3; 1, 2, 3.
Appearance tab
This tab shows the appearance of the report to be printed.
Color
Specifies the color of the report to be printed.
●
Monochrome
Specifies to print the reports in Monochrome.
●
Color
Specifies to print the reports in Color.
Quality
Specifies the printing quality.
●
●
●
Draft
Specifies to print the report in draft quality.
Normal
Specifies to print the report in normal quality.
High
Specifies to print the report in high quality.
Sides
Specifies the print sides for the printed reports.
●
●
●
One Side
Imposes each consecutive print-stream page upon the same side of consecutive media sheets.
Duplex
Imposes each consecutive pair of print-stream pages upon the front and back sides of consecutive
media sheets, such that the orientation of each pair of print-stream pages on the medium is correct
for the reader as if for binding on the long edge.
Tumble
Imposes each consecutive pair of print-stream pages upon the front and back sides of consecutive
media sheets, such that the orientation of each pair of print-stream pages on the medium is correct
for the reader as if for binding on the short edge.
Job Attributes
Specifies the properties of the print task.
●
●
●
Priority
Specifies the print priority for this task.
Job Name
Specifies the name of the print task.
User Name
Specifies the name of the user.
Query Filter dialog
This dialog appears when you click the Filter button in the Bind Data screen of the JReport Studio Wizard.
It helps you to apply a filter to the business view used by the specified data component to narrow down
data scope. The dialog contains the following two modes:
●
Basic
●
Advanced
Advanced/Basic
Switches the dialog to the advanced/basic mode.
OK
Applies the filter and closes the dialog.
Cancel
Does not retain changes and closes this dialog.
Help
Displays this help document.
Basic mode
The basic mode provides function for creating simple filter conditions which are connected by AND and OR
operators.
Delete the selected condition line.
Field
Specifies the field to be filtered.
Operator
Specifies the operator to compose the filter expression.
●
●
●
●
●
●
●
●
●
●
=
Equal to
>
Greater than
>=
Greater than or equal to
<
Less than
<=
Less than or equal to
!=
Not equal to
[not] in
Causes an enumerated list of values to appear in the WHERE clause predicate, used for evaluating for a
true condition.
[not] like
Like string pattern matching operator is used to compare the first expression string value to the pattern
string (the second expression). If you want to use wildcard character in the pattern string, only "_" and
"%" are supported.
[not] between
Allows the system to evaluate whether or not data values are located between a range of values
indicated in the predicate.
is [not] null
It is used in WHERE clause predicates to match null values occurring in a specified data field.
Value
Specifies the value of how to filter the field. You can either enter the value manually in the text box or
select a value from the drop-down list. When you type in the value manually, if multiple values are
required, they should be separated with ",", and if "," or "\" is contained in the values, write it as "\," or "\
\".
Logic
Lists the logic operator.
●
●
AND
Logic operator AND which is applied to this and the next line.
OR
Logic operator OR which is applied to this and the next line.
Advanced mode
The advanced mode enables the building of more complex filter conditions via the grouping of conditions.
Filter
Specifies the filter you want to apply to the business view.
●
●
User Defined
Specifies to create a user defined filter to apply to the business view.
Predefined filters
The names of the predefined filters which were created on the business view in JReport Designer. You
can choose one of them to apply.
Add Condition
Adds a new condition line.
Delete
Deletes the selected condition line.
Group
Makes the selected conditions in a group. Conditions can also be added to an existing group by selecting
the conditions and the group while holding the Ctrl button, and then clicking the Group button.
Ungroup
Makes the selected group ungrouped.
Up
Moves the selected condition or group up to a higher level.
Down
Moves the selected condition or group down to a lower level.
Logic
Specifies the logic operator.
●
●
●
●
AND
Logic operator And which is applied to this and the next line.
OR
Logic operator Or which is applied to this and the next line.
AND NOT
Logic operator And Not which is applied to this and the next line.
OR NOT
Logic operator Or Not which is applied to this and the next line.
Field
Specifies the field to be filtered.
Operator
Specifies the operator to compose the filter expression.
Value
Specifies the value of how to filter the field. You can either enter the value manually in the text box or
select a value from the drop-down list. When you type in the value manually, if multiple values are
required, they should be separated with ",", and if "," or "\" is contained in the values, write it as "\," or "\
\".
Condition Expression
Displays the SQL statement of the condition.
RealMedia Properties dialog
The dialog appears when you right-click a RealMedia object and select Properties from the shortcut menu. It
helps you to specify the properties of the RealMedia object and contains the following tabs:
●
General tab
●
Controls tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the object.
Name
Specifies the display name of the object.
Alternate Text
Specifies the alternate text which will be shown if the object cannot be displayed.
Width
Specifies the width of the object.
Height
Specifies the height of the object.
Controls tab
This tab specifies the RealPlayer controls you want to display. The controls will be reproduced in the container
as they appear in RealPlayer.
Auto Start
Specifies whether to start the media file automatically when the report is opened.
Center
Specifies whether to place the presentation in the center of the image window and display it in its original size
(the size is determined by the Width and Height properties).
Loop
Specifies whether to play the media file repeatedly.
Loop Number
Specifies the number of the times the media file will loop during playback.
Note: If you have checked the Loop option and specified the Loop Number at the same time, the media file will
be played back according to the specified number, which means the Loop option will be ignored even though
the loop number is set to zero.
All Controls
Specifies whether to show all controls.
Pause Button
Specifies whether to show the Pause Button.
Play Button
Specifies whether to show the Play Button.
Stop Button
Specifies whether to show the Stop Button.
Control Panel
Specifies whether to show the Control Panel, which contains the following playback controls: Play Button,
Pause Button, Stop Button, Fast-forward Button, Rewind Button, Position Slider and Home Button.
Fast-forward Button
Specifies whether to show the Fast-forward Button.
Home Control
Specifies whether to show the Home Button, which is connected to the www.real.com website.
Image Window
Specifies whether to show the Image Window, which is used for displaying presentations.
Information Panel
Specifies whether to show the Information Panel that displays the title, author, and copyright for the currently
playing clip.
Volume Information
Specifies whether to show the Information/Volume Bar, which consists of the Information Panel and the Mute/
Volume Bar.
Mute Button and Volume Slider
Specifies whether to show the Mute Button and Volume Slider. If checked, the Volume Slider and Mute
checkboxes will be checked correspondingly. Otherwise, you can check Volume Slider or Mute respectively.
Position Field
Specifies whether to show the Position Field, which shows the position of the current clip that identifies the
clip's current place within the presentation timeline and the total clip length.
Position Slider
Specifies whether to show the Position Slider, which shows the currently playing position within the clip.
Rewind Button
Specifies whether to show the Rewind Button.
Status Bar
Specifies whether to show the Status Bar, which consists of a text message area, the network congestion LED,
and the current clip position indicator.
Status Field
Specifies whether to show the Status Field, which consists only of a text message area.
Information Field
Specifies whether to show the Information Field, which displays the title, author, and copyright for the
currently playing clip or portion of a multi-clip.
Report Body Properties dialog
The dialog appears when you click Menu > Edit > Report Body Properties. It helps you to specify the properties
of the report body and contains the following tabs:
●
General tab
●
Border tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the report body.
Name
Specifies the display name of the report body, which will be shown on the shortcut menu of the report body.
Color
Specifies the color of the report body.
To change the color, click the color indicator to select a color or click More Colors in the color indicator to
access the Color Picker dialog to specify a new color, or input a color string in the format #RRGGBB. You can
also click More Fill Effects in the color indicator to specify a gradient or an image as the fill effect of the
report body in the Fill Effects dialog. If you want to make the color transparent, input Transparent in the text
box.
Border tab
This tab shows information about borders of the report body.
Color
Specifies the color of the borders.
Width
Specifies the width of the border.
Top Line
Specifies the line style of the top border of the report body. Choose a style from the drop-down list.
Bottom Line
Specifies the line style of the bottom border of the report body. Choose a style from the drop-down list.
Left Line
Specifies the line style of the left border of the report body. Choose a style from the drop-down list.
Right Line
Specifies the line style of the right border of the report body. Choose a style from the drop-down list.
Report Parameters dialog
This dialog appears when you click Run in the JReport Studio Wizard to run a web report with
parameters. It allows you to input parameter values for the report.
You may specify parameter values in these ways:
●
●
●
In the parameter value combo box, select the required one from the drop-down list or input the
value manually.
Click the chooser button
if it is available to specify multiple values in the Enter Values dialog.
Click the calendar button
if it is available to specify a date and time value using either calendar
or expression in the Calendar dialog.
OK
Accepts the parameter values for further processing.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
Save As dialog
This dialog appears when you click Menu > File > Save As (or the Save As button
on the Standard toolbar) or
click Save on the JReport Studio Wizard. It helps you to save the current web report.
Save in
Specifies where the report will be saved. The folder may be Public Reports or My Reports.
●
Name
Displays the file names.
●
●
●
Size
Displays the file size.
Type
Displays the file type.
Last Modified
Displays the last modified time of the file.
File Name
Specifies the name for the report.
File Type
Shows the type as Web Report.
Advanced
Displays the advanced settings.
●
Status
Specifies the status of the report.
❍
❍
❍
●
Inactive
The report cannot be executed. If selected, the corresponding Run, Advanced Run and Schedule commands for
the report are not available.
Incomplete
The report is not completely designed and cannot be executed. If selected, the corresponding Run, Advanced
Run and Schedule commands for the report are not available.
Catalog
Specifies the catalog for the new file.
❍
❍
●
Active
The report can be executed. To execute a report means to run, advanced run and schedule to run it.
Set Original Catalog as Linked Catalog into Saved Report
If checked, the saved report will be linked with the catalog and the saved report will run with the catalog no
matter whether the two are in the same directory. If later the catalog is updated, the saved report will run with
the latest version of the catalog.
Set Catalog Copy to Target Folder
If checked, the catalog will be copied to the directory where the report is saved and the saved report will run
with the copied catalog.
Description
Specifies the description for the new file.
Save
Saves the new file with the specified settings and closes this dialog.
Cancel
Does not save the file as a new one and closes the dialog.
Help
Displays this help document.
Select a Report dialog
This dialog appears when you click Menu > File > Open (or the Open button
on the Standard toolbar), or click
the Browse button in the Insert Link dialog or Edit Link dialog. It helps you to select the report you want to open or
to specify the target report which you want to link with the specified object.
Open
Specifies the catalog file which contains the report you want to open. When the dialog is opened by clicking the
Browse button in the Insert Link dialog or Edit Link dialog, this option only displays the file name of the catalog
which is used by the target linked report.
●
●
●
●
Name
Displays the file names.
Size
Displays the file size.
Type
Displays the file type.
Last Modified
Displays the last modified time of the file.
File Name
Specifies the name for the new file.
File Type
Specifies the type of the file.
OK
Applies the changes and closes the dialog.
Cancel
Does not retain any changes and closes the dialog.
Help
Displays this help document.
Select Field dialog
This dialog appears when you click + on the title bar of the Filter panel or click
beside the Filter On
text box in the Filter Control Properties dialog. It allows you to select fields you want.
Select Fields
Specifies the fields of the same type to add into the Filter panel, or to replace the current fields in the
filter control.
Apply To
Specifies the components to which the filter will be applied.
OK
Applies the selected field and closes the dialog.
Cancel
Cancels the selection and closes the dialog.
Help
Displays this help document.
Select Resource dialog
This dialog is displayed when you click
in the Add Aggregation dialog. It helps you to specify the
field on which the dynamic aggregation will be based.
In this dialog, all the group objects
dynamic formulas
then click OK.
and detail objects
in the current business view and the
that have been created in the report will be listed. Select the required field and
OK
Selects the field and closes this dialog.
Cancel
Cancels the selection of a field and closes the dialog.
Help
Displays this help document.
Select Values dialog
This dialog appears when you right-click a table column and select Filter > More from the shortcut
menu. It helps you to specify a value to apply a filter criterion.
Available Values
Specifies the value to filter data with.
Opens the quick search toolbar as follows. You can search for values in the following value list using the
quick search toolbar.
The following are more about the usage of the quick search toolbar:
●
●
●
Text field
Type in the text you want to search for in the text field and the matched text will be highlighted
among the values.
X
Closes the quick search toolbar.
Lists the advanced options.
❍
❍
❍
●
●
Highlight All
Specifies whether to highlight all matched text.
Match Case
Specifies whether to search for text that meets the case of the typed text.
Match Whole Word
Specifies whether to search for text that looks the same as the typed text.
Highlights the next matched text.
Highlights the previous matched text.
Cancels the selection of a value.
OK
Closes the dialog and filters the table column with the value you specified.
Cancel
Cancels to filter the table column and closes the dialog.
Help
Displays this help document.
Series Options dialog
This dialog appears when you click the Top N button
above the Series box in the Bind Data screen
of chart in the JReport Studio Wizard, Insert Chart dialog, Chart Wizard, or To Chart dialog. It helps
you to set the sort order of the series values and define the number of the series values that will be
displayed in a chart.
Series Order
Specifies in which order data on the series axis will be displayed.
●
●
●
Ascend
Lists data in an ascending order.
Descend
Lists data in a descending order.
No Sort
Keeps the data in their original order in database.
Series Selection
Specifies the number of the series values that will be displayed in the chart.
●
Select
Specifies the Select N condition to define the number of series values that will be displayed.
❍
❍
❍
●
●
●
All
If selected, all series values will be displayed.
Top N
If selected, specify a number in the field to the right and the first N series values will be displayed.
Bottom N
If selected, specify a number in the field to the right and the last N series values will be displayed.
Based On
If checked, the series values will be sorted by values of the summary selected with the direction
specified. If unchecked, the series values will be sorted by the order specified in the Series Order box
of the dialog.
Remaining Series In
Enabled only when Top N or Bottom N is selected from the Select drop-down list. Check this option
and then type a character string in the text field to group all the series values beyond the top/bottom
N range.
Skip First
If you check the Skip First option and input a number M in the text field to the right, then the first M
series values in the chart will be skipped and the Select N condition will take effect beginning with M
+1. The skipped values will be included in the Remaining Series group together with all the series
values beyond the top/bottom N range.
OK
Accepts the changes and closes the dialog.
Cancel
Discards the changes and closes the dialog.
Help
Displays this help document.
Special Field Properties dialog
The dialog appears when you right-click a special field and select Properties from the shortcut menu. It helps
you to edit the properties of the special field and contains the following tabs:
●
General tab
●
Font tab
●
Border tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the special field.
Name
Specifies the display name of the special field, which will be shown on the shortcut menu of the special field.
Width
Specifies the width of the special field.
Type
Specifies the type of the special field. Select a new one from the drop-down list if you want to change the type.
The following types are available:
●
●
●
●
●
●
●
User Name
Prints the User ID with which you log onto JReport Server.
Modified Date
Prints the last modified date for the catalog.
Modified Time
Prints the last modified time for the catalog.
Print Date
Prints today's date (or the current date from your computer).
Print Time
Prints the current time from your computer.
Fetch Date
Prints the date when the data is retrieved from the database.
Fetch Time
Prints the time when the data is retrieved from the database.
Height
Specifies the height of the special field.
Position
Specifies the position mode of the special field. If the special field is directly contained in the report body, a
tabular cell, or a text box, its position mode can be modified.
●
●
Absolute: The special field's position will be decided by its X and Y property values.
Static: The special field will be positioned at the default location in its container. If selected, the X, Y and
other position-related properties will be hidden or disabled.
Top Padding
Specifies the space between the text of the special field and its top border.
Bottom Padding
Specifies the space between the text of the special field and its bottom border.
Left Padding
Specifies the space between the text of the special field and its left border.
Right Padding
Specifies the space between the text of the special field and its right border.
Background
Specifies the background color of the special field.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB. If you want to make the background transparent, input Transparent in the text box.
Foreground
Specifies the foreground color of the special field.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB.
Font tab
This tab shows the font-related information of the special field. You can modify all the font settings in this tab.
Font
Specifies the font face of the special field text.
Size
Specifies the font size of the special field text.
Horizontal Alignment
Specifies the horizontal alignment mode of the text in the special field.
Vertical Alignment
Specifies the vertical alignment mode of the text in the special field.
Bold
Specifies whether to make the object text bold or not.
Underline
Specifies whether the field text will be underlined or not.
Strikethrough
Specifies whether or not to attach a strikeout line to the field text.
Italic
Specifies whether to make the field text italic or not.
Autofit
Specifies whether or not to automatically adjust the width of the special field.
Word Wrap
Specifies whether or not to wrap the text to the special field width.
Ignore HTML Tag
If this option is unchecked, JReport will parse HTML tag elements in the field value while the report is to be
saved as an HTML file; or the field value will appear in the HTML file the same as that in JReport Studio (HTML
tag elements in the field value, if any, will not be parsed).
Border tab
This tab shows information about borders of the special field. You can modify all the border settings in this tab.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Shadow
Specifies whether the borders will have a shadow effect or not.
Shadow Color
Specifies the color of the border shadow.
Split Cell dialog
The dialog appears when you right-click a tabular cell and click
button on the toolbar or click
Menu > Format > Split. It helps you to specify the number of rows and columns that the specified
tabular cell will be split into.
Split Cell Into
Specifies the number of rows and columns to split the selected tabular cell into.
●
●
Number of Rows
Specifies the number of rows the tabular cell will be split into. Input a positive integer in the text box
to specify the number.
Number of Columns
Specifies the number of columns the tabular cell will be split into. Input a positive integer in the text
box to specify the number.
OK
Closes this dialog and splits the tabular cell.
Cancel
Cancels to split the cell and closes this dialog.
Help
Displays this help document.
Summary Properties dialog
The dialog appears when you right-click a summary field and select Properties from the shortcut menu. It helps
you to specify the properties of the summary field and contains the following tabs:
●
General tab
●
Font tab
●
Border tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the summary field.
Name
Specifies the display name of the summary field.
Width
Specifies the width of the summary field.
Format
Specifies the format of the summary field.
Height
Specifies the height of the summary field.
Top Padding
Specifies the space between the text of the summary field and its top border.
Bottom Padding
Specifies the space between the text of the summary field and its bottom border.
Left Padding
Specifies the space between the text of the summary field and its left border.
Right Padding
Specifies the space between the text of the summary field and its right border.
Background
Specifies the background color of the summary field.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB. If you want to make the background transparent, input Transparent in the text box.
Foreground
Specifies the foreground color of the summary field.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB.
Font tab
This tab shows the font-related information of the summary field.
Font
Specifies the font face of the text.
Size
Specifies the font size of the text.
Horizontal Alignment
Specifies the horizontal alignment mode of the text in the summary field.
Vertical Alignment
Specifies the vertical alignment mode of the text in the summary field.
Bold
Specifies whether to make the text bold or not.
Underline
Specifies whether the text will be underlined or not.
Strikethrough
Specifies whether or not to attach a strikeout line to the text.
Italic
Specifies whether to make the text italic or not.
Autofit
Specifies whether or not to automatically adjust the width of the summary field.
Word Wrap
Specifies whether or not to wrap the text to the summary field width.
Ignore HTML Tag
If this option is unchecked, JReport will parse HTML tag elements in the field value while the report is to be
saved as an HTML file; or the field value will appear in the HTML file the same as that in JReport Studio (HTML
tag elements in the field value, if any, will not be parsed).
Border tab
This tab shows information about borders of the summary field.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Shadow
Specifies whether the borders will have a shadow effect or not.
Shadow Color
Specifies the color of the border shadow.
Table Cell Properties dialog
The dialog appears when you right-click an empty table cell and select Properties from the shortcut menu, or
right-click a table cell and select Table Cell > Properties from the shortcut menu. It helps you to specify the
properties of the table cell and contains the following tabs:
●
General tab
●
Border tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the table cell.
Width
Specifies the width of the table cell.
Horizontal Alignment
Specifies the horizontal alignment mode of the text in the table cell.
Height
Specifies the height of the table cell.
Vertical Alignment
Specifies the vertical alignment mode of the text in the table cell.
Top Padding
Specifies the space between the text of the table cell and its top border.
Bottom Padding
Specifies the space between the text of the table cell and its bottom border.
Left Padding
Specifies the space between the text of the table cell and its left border.
Right Padding
Specifies the space between the text of the table cell and its right border.
Background
Specifies the background color of the table cell.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB. If you want to make the background transparent, input Transparent in the text box.
Border tab
This tab shows information about borders of the table cell.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Table Detail Properties dialog
The dialog appears when you right-click a table detail row and select Table Row > Properties from the shortcut
menu. It helps you to specify the properties of the table detail row and contains the following tabs. Specify the
settings in each tab to suit your requirement.
●
General tab
●
Border tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the table detail field.
Name
Specifies the display name of the table detail field.
Height
Specifies the height of the table detail field.
Background
Specifies the background color of the table detail field.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB, or click More Fill Effects to specify a gradient or an image as the fill effect in the Fill Effects
dialog. If you want to make the background transparent, input Transparent in the text box.
Border tab
This tab shows information about borders of the table detail field.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Table Footer Properties dialog
The dialog appears when you right-click a table footer and select Table Row > Properties from the shortcut
menu. It helps you to specify the properties of the table footer and contains the following tabs:
●
General tab
●
Border tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the table footer.
Name
Specifies the display name of the table footer.
Height
Specifies the height of the table footer.
Background
Specifies the background color of the table footer.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB, or click More Fill Effects to specify a gradient or an image as the fill effect in the Fill Effects
dialog. If you want to make the background transparent, input Transparent in the text box.
Border tab
This tab shows information about borders of the table footer.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Table Header Properties dialog
The dialog appears when you right-click a table header and select Table Row > Properties from the shortcut
menu. It helps you to specify the properties of the table header and contains the following tabs:
●
General tab
●
Border tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the table header.
Name
Specifies the display name of the table header.
Height
Specifies the height of the table header.
Background
Specifies the background color of the table header.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB, or click More Fill Effects to specify a gradient or an image as the fill effect in the Fill Effects
dialog. If you want to make the background transparent, input Transparent in the text box.
Repeat On Each Page
Specifies whether to repeat the table header on each page of the report.
Border tab
This tab shows information about borders of the table header.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Table Properties dialog
The dialog appears when you right-click a table and select Properties from the shortcut menu, or right-click
anywhere in the table and select Table > Properties from the shortcut menu. It helps you to specify the
properties of the table and contains the following tabs:
●
General tab
●
Border tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the table.
Name
Specifies the display name of the table, which will be shown on the shortcut menu of the table.
Horizontal Alignment
Specifies the horizontal justification of the table. Choose an option from the drop-down list.
●
left: Aligns the table on the left of the report.
●
right: Aligns the table on the right of the report.
●
center: Aligns the table in the center of the report.
Background
Specifies the background color of the table.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB. If you want to make the background transparent, input Transparent in the text box.
Expand Data
Specifies whether or not to enable JReport Studio users to expand or collapse dimensions in the table.
Border tab
This tab shows information about borders of the table.
Color
Specifies the border color.
Width
Specifies the border width.
Top Line
Specifies the style of the top border line.
Bottom Line
Specifies the style of the bottom border line.
Left Line
Specifies the style of the left border line.
Right Line
Specifies the style of the right border line.
Table Wizard
This wizard is displayed when you do one of the following:
●
Select a table, then click Menu > Edit > Wizard.
●
Select a table, then click the Table Wizard button
●
Right-click the icon
on the Context toolbar.
of a table and select Table Wizard from the shortcut menu.
It helps you to change data of the table and consists of the following tabs:
●
Display tab
●
Group tab
Table Title
Specifies a title for the table.
Sets the font, font style, size, alignment, font color and background color properties for the table title.
Data Source
Displays the business view that has been used in the table.
Filter
Opens the Query Filter dialog to specify the filter which you want to apply to the selected business view.
Display tab
Specifies the fields to be displayed in the table.
Resources
Displays all the view elements in the selected business view.
Edits the selected dynamic resource.
Removes the selected dynamic resource.
Adds the selected view element to be displayed in the table.
Removes the selected view element.
Field
Lists the view elements that have been added to the table.
Label
Specifies the display names of the selected fields.
Moves the selected view element one step up.
Moves the selected view element one step down.
Group tab
Specifies the fields to group the data.
Resources
Displays all the available group objects
you can use to group the data in the table.
Adds the selected group object as a group field.
Removes the selected group object.
Field
Lists all the group objects that have been added as the group fields.
Sort
Specifies the sort order for each group: Ascend, Descend, or No Sort.
Moves the selected group one step up.
Moves the selected group one step down.
OK
Applies the changes and closes the wizard.
Cancel
Does not retain changes and closes this wizard.
Help
Displays this help document.
Tabular Cell Properties dialog
The dialog appears when you right-click a tabular cell and select Properties from the shortcut menu. It helps
you to specify the properties of the tabular cell.
Width
Specifies the width of the tabular cell.
Horizontal Alignment
Specifies the horizontal alignment mode of the text in the tabular cell.
Height
Specifies the height of the tabular cell.
Vertical Alignment
Specifies the vertical alignment mode of the text in the tabular cell.
Top Padding
Specifies the space between the text of the tabular cell and its top border.
Bottom Padding
Specifies the space between the text of the tabular cell and its bottom border.
Left Padding
Specifies the space between the text of the tabular cell and its left border.
Right Padding
Specifies the space between the text of the tabular cell and its right border.
Background
Specifies the background color of the tabular cell.
To change the color, click the color indicator to select a color, or click More Colors in the color indicator to
access the Color Picker dialog in which you can select a color within a wider range or input a color string in the
format #RRGGBB. If you want to make the background transparent, input Transparent in the text box.
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
Tabular Properties dialog
The dialog appears when you right-click a tabular and select Properties from the shortcut menu. It
helps you to edit the properties of the tabular.
Width
Specifies the width of the tabular.
Height
Specifies the height of the tabular.
Background
Specifies the background color of the tabular.
To change the color, click the color indicator to select a color, or click More Colors in the color
indicator to access the Color Picker dialog in which you can select a color within a wider range or input
a color string in the format #RRGGBB. If you want to make the background transparent, input
Transparent in the text box.
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
To Chart dialog
This dialog appears when you right-click a crosstab and then select To Chart on the shortcut menu or click Menu >
Edit > To Chart. It allows you to specify settings for converting a crosstab into a chart.
Title
Specifies a title for the chart.
Specifies the font, font style, size, align, font color and background color properties for the title.
Resources
Displays all the view elements used in the crosstab.
Adds the selected group or aggregation object to be displayed in the chart.
Category
Lists the group object
that will be displayed on the category axis of the chart.
Series
Lists the group object
that will be displayed on the series axis of the chart.
Show Values
Specifies the types for chart and sets the values for the Primary Axis or Secondary Axis separately.
●
●
●
●
●
Primary Axis
Adds a chart type to the primary axis.
Secondary Axis
Adds a chart type to the secondary axis.
X Axis
Lists the value you want to show on the X axis of the bubble chart.
Y Axis
Lists the value you want to show on the Y axis of the bubble chart.
Radius
Lists the value you want to show as the bubble radius.
Secondary Axis
Specifies whether to show the secondary axis in the chart.
Opens the Category Options dialog or Series Options dialog to define the sort order of the category or series values
and specify the number of the category or series values that will be displayed in the chart.
Adds a combo chart to the Primary Axis or Secondary Axis.
Moves the selected view element one level up.
Moves the selected view element one level down.
Adds a new pair of Y Axis and Radius for the bubble chart.
Removes the selected view element.
OK
Applies the settings and closes the dialog.
Cancel
Cancels the settings and closes the dialog.
Help
Displays this help document.
To Crosstab dialog
This dialog appears when you right-click a chart and then select To Crosstab on the shortcut menu or click Menu >
Edit > To Crosstab. It allows you to specify settings for converting a chart into a crosstab.
Title
Specifies a title for the crosstab.
Specifies the font, font style, size, align, font color and background color properties for the title.
Resources
Displays all the view elements used in the chart.
Adds the selected group object
to be displayed in the columns of the crosstab.
Adds the selected group object
to be displayed in the rows of the crosstab.
Adds the selected aggregation object
to be the summary field of the crosstab.
Columns/Rows
Lists the group objects
●
●
●
that will be displayed on the columns/rows of the crosstab.
Field
Lists the group objects that you selected to display in the crosstab.
Label
Specifies the display names of the added group objects. By default these are blank and no names will be created
for the group objects to label the columns/rows. You can click in the cells to edit them if required.
Sort
Specifies how the selected group objects will be sorted.
Summaries
Lists the aggregation/detail objects that will be the summary fields of the crosstab.
●
●
●
Field
Lists the aggregation/detail objects that you selected to display in the crosstab.
Label
Specifies the display names of the summary fields. By default these are blank and no names will be created for
the objects to label the summaries. You can click in the cells to edit them if required.
Aggregation
Specifies the functions used to summarize data of the detail objects.
Moves the selected view element one level up.
Moves the selected view element one level down.
Removes the selected view element.
OK
Applies the settings and closes the dialog.
Cancel
Cancels the settings and closes the dialog.
Help
Displays this help document.
Windows Media Properties dialog
The dialog appears when you right-click a Windows Media object and select Properties from the shortcut menu.
It helps you to specify the properties of the Windows Media object and contains the following tabs:
●
General tab
●
Controls tab
OK
Applies the settings and closes this dialog.
Cancel
Cancels the settings and closes this dialog.
Help
Displays this help document.
General tab
This tab shows some general information of the Windows Media.
Name
Specifies the display name of the Windows Media.
Alternate Text
Specifies the alternate text which will be shown if the Windows Media cannot be displayed.
Width
Specifies the width of the Windows Media.
Height
Specifies the height of the Windows Media.
Controls tab
This tab specifies the properties for the media file to control the options when playing the media file.
Auto Start
Specifies whether or not to start the media file automatically when the report is opened in JReport Studio.
Auto Rewind
Specifies whether or not to rewind the media file automatically.
Play Count
Specifies the number of times you want to play this media file.
Show Controls
Specifies whether or not to show the Windows Media Player controls.
Show Audio Controls
Specifies whether or not to show the Mute Button and the Volume Slider on the Control Bar.
Show Position Controls
Specifies whether or not to show the Fast Forward, Fast Rewind, Skip Ahead, Skip Previous, and Preview
buttons on the Control Bar.
Show Tracker
Specifies whether to show the Tracker Bar. It is only enabled when the Control Bar is visible.
Show Display
Specifies whether to show the Display Panel.
Show Caption
Specifies whether to show the Closed Captioning Displayed Panel.
Show Go To Bar
Specifies whether to show the Go To Bar.
Show Status Bar
Specifies whether to show the Status Bar.
JDashboard dialogs
While using JDashboard, you will go through the following dialogs. This section introduces each of these
dialogs in alphabetical order. You can go into the links for details.
●
Color Picker dialog
●
Customize Component Title Bar dialog
●
Customize Value dialog
●
Edit Filter Control dialog
●
Edit HTML dialog
●
Edit Image dialog
●
Edit Label dialog
●
Edit Slider dialog
●
Edit Special Field dialog
●
Edit URL Frame dialog
●
Enter Parameter Values dialog
●
Enter Values dialog
●
Export dialog
●
Filter dialog
●
Insert Filter Control dialog
●
Insert HTML dialog
●
Insert Image dialog
●
Insert Link dialog
●
Insert Slider dialog
●
Insert Special Field dialog
●
Insert URL Frame dialog
●
Open Dashboard dialog
●
Page Setup dialog
●
Print dialog
●
Printer Properties dialog
●
Save As dialog
●
Share Parameters Setting dialog
●
Themes dialog
Color Picker dialog
This dialog helps you to specify a color for an object. It contains the following tabs:
●
Standard tab
●
Custom tab
OK
Closes this dialog and returns the color value specified.
Cancel
Closes this dialog without changing the color value.
Displays this help document.
Ignores the setting and closes this dialog.
Standard tab
This tab allows you to select one from the web safe colors.
Colors
Lists the colors for you to select one.
R
Specifies the amount of red in a color. The value is from 0 to 255.
G
Specifies the amount of green in a color. The value is from 0 to 255.
B
Specifies the amount of blue in a color. The value is from 0 to 255.
#
Specifies the hexadecimal value of the color.
New
This part displays the color you select.
Current
This part always displays the original color. Clicking this part will restore the color to the original.
Custom tab
This tab allows you to customize the color within a wider range.
Color matrix
Select a color you want in the color matrix. The hue of the matrix is based on the color you define on
the color bar.
Color bar
Specifies a color on the bar which will be the hue of the color matrix.
R
Specifies the amount of red in a color. The value is from 0 to 255.
G
Specifies the amount of green in a color. The value is from 0 to 255.
B
Specifies the amount of blue in a color. The value is from 0 to 255.
#
Specifies the hexadecimal value of the color.
New
This part displays the color you select.
Current
This part always displays the original color. Clicking this part will restore the color to the original.
Customize Component Title Bar dialog
This dialog helps you to customize the way of showing component title bar and the icons on it.
Component Title Bar
Specifies the way of showing the component title bar.
Icon on Component Title Bar
Specifies the way of showing the icons on the component title bar.
Save into My Preferences Settings
Specifies whether to save the setting here into your profile.
OK
Closes this dialog and applies the setting.
Cancel
Cancels the setting and closes this dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Customize Value dialog
The dialog appears when you specify the fields to bind to a slider and click the Customize button in the
Insert Slider dialog or Edit Slider dialog. It helps you to customize the values of the selected field and
varies with the slider type: Range of Values or Single Value.
If the slider type is Range of Values, options in the dialog are as follows.
Special Function
Specifies a special function from the drop-down list. Available to Date/Time/DateTime type fields.
All Values
This option is selected by default, which means that all the values of the selected field will be available
on the slider. To customize the values, you need unselect this option.
From
Specifies the start value of the value range. You can select the value from the drop-down list or type it
into the text field. For Date/Time/DateTime type fields, you can also use the calendar button
specify a value.
to
To
Specifies the end value of the value range. You can select the value from the drop-down list or type it
into the text field. For Date/Time/DateTime type fields, you can also use the calendar button
specify a value.
OK
Closes this dialog and saves the customized values.
Cancel
Cancels customizing the values for the selected field.
Displays this help document.
Ignores the setting and closes this dialog.
If the slider type is Single Value, options in the dialog are as follows.
to
Special Function
Specifies a special function from the drop-down list. Available to Date/Time/DateTime type fields.
All Values
This option is selected by default, which means that all the values of the selected field will be available
on the slider. To customize the values, you need unselect this option.
Name
Specifies the values in the Name box.
Adds a value line to the Name box. You can select a value from the drop-down list or type a value into
the text field.
Removes the selected value.
OK
Closes this dialog and saves the customized values.
Cancel
Cancels customizing the values for the selected field.
Displays this help document.
Ignores the setting and closes this dialog.
Edit Filter Control dialog
This dialog is displayed after you click
It helps you to edit the filter control.
on the title bar of a filter control and then select Edit Setting.
Title
Specifies a title for the filter control.
Select Fields
Specifies the fields to bind to the filter control. All the selected fields should be of the same data type.
The common usage is to select one field, and then based on the field to filter the data of the
components created from the same data source as the field.
To filter components using different data sources, choose a common field all the data sources contain
and select the field in all the data sources.
Apply To
Specifies the data components from the drop-down list to apply the filter control to. <All> means all
data components involving the selected fields in the dashboard.
OK
Closes this dialog and applies the changes to the filter control.
Cancel
Cancels the edition and closes this dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Edit HTML dialog
This dialog is displayed after you click
on the title bar of an HTML component and then select Edit
Setting. It helps you to edit the title and contents of the HTML component.
Title
Specifies a title for the HTML component.
HTML text box
Type text in the box directly. You can make use of the buttons above the text box to format the text,
insert images, and create hyperlinks.
Here are the buttons:
●
●
●
Font Face
Specifies the font of the text from the drop-down list.
Font Size
Specifies the font size of the text from the drop-down list.
B
Specifies whether to make the text bold.
●
●
●
I
Specifies whether to make the text italic.
U
Specifies whether to underline the text.
Font Color
Specifies the color of the text.
To change the color, click the color indicator to select a color, or click More Colors in the color
indicator to access the Color Picker dialog in which you can select a color within a wider range.
●
Background Color
Specifies the background color of the text.
To change the color, click the color indicator to select a color, or click More Colors in the color
indicator to access the Color Picker dialog in which you can select a color within a wider range.
●
●
●
●
●
Align Left
Specifies to align the text to the left.
Align Center
Specifies to align the text in the center.
Align Right
Specifies to align the text to the right.
Insert Image
Opens the Insert Image dialog for inserting an image into the text box.
Insert Link
Opens the Insert Link dialog to create a hyperlink to a URL address.
OK
Closes this dialog and applies the changes to the HTML component.
Cancel
Cancels the changes and closes this dialog.
Apply
Applies the changes to the HTML component without exiting the dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Edit Image dialog
This dialog is displayed when you hover the cursor on an image in the dashboard header and then click
in the appearing dotted rectangle. It helps you to select another image to replace the
the button
current image.
Image From
Specifies the source of the image file.
●
Local File
Specifies to use an image from the local file system.
❍
●
File Name
Specifies the path and name of the image file. You can click the Browse button to locate the image
file.
Web URL
Specifies to use an image via URL.
❍
File URL
Specifies the URL of the image file.
Note: If your JReport Server is in an intranet which requires a proxy, to successfully access the
image via URL, you need to add the parameters -Dhttp.proxyHost=XXX -Dhttp.proxyPort=XX
to the server's startup file JRServer.bat, which is located in <install_root>\bin.
●
Library
Specifies to use an existing image.
❍
My Pictures
The My Pictures folder is a virtual location where JReport Server stores the images that have once
been inserted into JDashboard. Select the one you want to use.
Preview
Displays a preview of the selected image.
OK
Closes this dialog and use the selected image to replace the current image.
Cancel
Cancels the change of the image and closes this dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Edit Label dialog
This dialog is displayed when you hover the cursor on a label and then click the button
in the
appearing dotted rectangle. It helps you to edit the properties of the label such as font, size, color,
border, the way of aligning text etc.
Font Face
Specifies the font of the text from the drop-down list.
Font Size
Specifies the font size of the text from the drop-down list.
Font Color
Specifies the color of the text.
To change the color, click the color indicator to select a color, or click More Colors in the color
indicator to access the Color Picker dialog in which you can select a color within a wider range.
Background Color
Specifies the background color of the label.
To change the color, click the color indicator to select a color, or click More Colors in the color
indicator to access the Color Picker dialog in which you can select a color within a wider range.
B
Specifies whether to make the text bold.
I
Specifies whether to make the text italic.
U
Specifies whether to underline the text.
Align Left
Specifies to align the text to the left.
Align Center
Specifies to align the text in the center.
Align Right
Specifies to align the text to the right.
Preview box
Displays a preview of the label with the specified properties.
Width
Specifies the width of the label.
Height
Specifies the height of the label.
Border
Specifies the border properties of the label.
●
●
●
Border Width
Specifies the width of the border.
Border Line
Specifies the line style of the border from the drop-down list.
Border Color
Specifies the color of the border.
To change the color, click the color indicator to select a color, or click More Colors in the color
indicator to access the Color Picker dialog in which you can select a color within a wider range.
Padding
Specifies the space between the text and the borders of the label.
OK
Closes this dialog and applies the properties to the label.
Cancel
Cancels the edition and closes this dialog.
Apply
Applies the properties but does not close the dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Edit Slider dialog
This dialog is displayed after you click
helps you to edit the slider.
on the title bar of a slider and then select Edit Setting. It
Title
Specifies a title for the slider.
Slider Type
Specifies whether the slider is used to specify a range of values or to specify a single value:
●
●
Range of Values
If selected, you can select a range of values at runtime.
Single Value
If selected, you can select one value at runtime. Not available for numeric data type fields.
Select Fields
Specifies the fields to bind to the slider. All the selected fields should be of the same data type.
The common usage is to select one field, and then based on the field to filter the data of the
components created from the same data source as the field.
To filter components using different data sources, choose a common field all the data sources contain
and select the field in all the data sources.
Customize
Opens the Customize Value dialog for you to customize the values of the selected field.
Apply To
Specifies the data components from the drop-down list to apply the slider to. <All> means all data
components involving the selected fields in the dashboard.
OK
Closes this dialog and applies the changes to the slider.
Cancel
Cancels the edition and closes this dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Edit Special Field dialog
This dialog is displayed when you hover the cursor on a special field and then click the button
in the
appearing dotted rectangle. It helps you to edit the properties of the special field such as font, size,
color, border, the way of aligning text etc.
Field Type
The current special field is selected by default. If it is not User Name, a date or time format drop-down
list will be displayed on the right for you to choose one.
Font Face
Specifies the font of the text from the drop-down list.
Font Size
Specifies the font size of the text from the drop-down list.
Font Color
Specifies the color of the text.
To change the color, click the color indicator to select a color, or click More Colors in the color
indicator to access the Color Picker dialog in which you can select a color within a wider range.
Background Color
Specifies the background color of the special field.
To change the color, click the color indicator to select a color, or click More Colors in the color
indicator to access the Color Picker dialog in which you can select a color within a wider range.
B
Specifies whether to make the text bold.
I
Specifies whether to make the text italic.
U
Specifies whether to underline the text.
Align Left
Specifies to align the text to the left.
Align Center
Specifies to align the text in the center.
Align Right
Specifies to align the text to the right.
Preview box
Displays a preview of the special field with the specified properties.
Width
Specifies the width of the special field.
Height
Specifies the height of the special field.
Border
Specifies the border properties of the special field.
●
●
●
Border Width
Specifies the width of the border.
Border Line
Specifies the line style of the border from the drop-down list.
Border Color
Specifies the color of the border.
To change the color, click the color indicator to select a color, or click More Colors in the color
indicator to access the Color Picker dialog in which you can select a color within a wider range.
Padding
Specifies the space between the text and the borders of the special field.
OK
Closes this dialog and applies the properties to the special field.
Cancel
Cancels the edition and closes this dialog.
Apply
Applies the properties but does not close the dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Edit URL Frame dialog
This dialog is displayed after you click
Setting. It helps you to edit the URL.
on the title bar of a web page window and then select Edit
Title
The title of the window that holds the web page.
URL
The URL of the web page you would like to show in the dashboard.
Auto refresh
Enables to refresh the specified web page periodically.
●
Interval
Specifies the time interval between two refreshes.
OK
Closes this dialog and applies the changes.
Cancel
Cancels the edition and closes this dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Enter Parameter Values dialog
This dialog appears after you click
on the side bar. In this dialog, all the parameters used in the
current dashboard are listed. Same-name parameters are allowed when they are from different library
components. You can specify the values to rerun the dashboard.
You may specify parameter values in these ways:
●
●
●
In the parameter value combo box, select the required one from the drop-down list or input the
value manually.
Click the chooser button
if it is available to specify multiple values in the Enter Values dialog.
Click the calendar button
if it is available to specify a date and time value using either calendar
or expression in the Calendar dialog.
Reset
Resets the values to that as when the dialog was opened.
Submit
Closes this dialog and applies the specified values to run the dashboard.
Cancel
Cancels changing the parameter values and closes this dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Note: You are recommended not to use blank as the thousands separator in Number-typed parameter
values under French locale, otherwise your input will not be correctly recognized because of a JVM bug.
For details, see http://bugs.sun.com/view_bug.do;jsessionid=c8cdaf911b20fffffffffd9fc6340b30d670?
bug_id=4510618.
Enter Values dialog
The dialog appears when you click the button
while specifying values for a parameter in the
configuration panel of a library component. It helps you to specify multiple values for the parameter.
Available Values
Lists all predefined parameter values for selection. When the parameter is bound with a column, but
the Display Column is different from the Bind Column, values of the Display Column are listed here.
Selected Values
Lists the values selected. The selected values are case sensitive.
Adds the selected values from the Available Values box to the Selected Values box.
Removes the selected values from the Selected Values box.
Adds all the values from the Available Values box to the Selected Values box.
Removes all the values from the Selected Values box.
Enter Values
This option is available when the parameter's Allow Type-in of Value property is set to true in JReport
Designer.
Enter a value manually in the text box and then click the button next to add the value to the Selected
Values box. When the parameter is bound with a column, but the display column is different from the
bind column, make sure the value you enter is that of the bind column.
Opens the Calendar dialog to specify a date and time value. Available only for Date, DateTime, or Time
parameter which allows for type-in values and is not bound with any column.
All
If selected, it means that the parameter value result is all the values in the DBMS. This option is
available when the parameter's Enable the "All" Option property is set to true in JReport Designer. This
is translated in SQL to remove the parameter which may select more values than listed in the available
values list.
For example, when the parameter query is:
SELECT CUSTOMERS.CUSTOMERID,CUSTOMERS.CUSTOMERNAME FROM CUSTOMERS where CUSTOMERS.
CUSTOMERID>0 and CUSTOMERS.CUSTOMERID<4
When you click
SQL is:
to add 1, 2 and 3 as the parameter values, which are all the available values, the
(CUSTOMERS.CUSTOMERID IN ( 1,2,3))
Run the same dashboard again and this time check the All checkbox in the Enter Values dialog, the
query is then:
( 1 = 1)
In this case, you will get more customers even though available values are only 1 – 3.
Note: When a multi-value parameter is inserted as a field into a library component and All is selected
as the value, the field will show the string "All". If the parameter allows type-in values, "All" means all
possible values of the parameter data type; if the parameter does not, "All" represents all the values of
the parameter that come from the DBMS.
OK
Closes this dialog and applies the specified values to the parameter.
Cancel
Cancels changing the parameter values and closes this dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Export dialog
There is a component level Export dialog which exports a specific library component, and a dashboard level Export dialog which allows you to export
one or more library components in a dashboard into one format at a time.
Exportable library components include library components that were created using JReport Designer and then inserted into dashboards via the
Resources panel.
OK
Closes this dialog and starts exporting the specified library components.
Cancel
Cancels the export and closes this dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Export dialog for component level
The component level Export dialog is displayed after you click
individual library component.
and select Export on the title bar of a library component. It allows you to export
Export File Format
Specifies the format in which to export the library component.
Export dialog for dashboard level
The dashboard level Export dialog is displayed after you click the Export button
on the side bar, or click the Options button
on the side bar
and select Export from the option list. It helps you to export one or more library components in a dashboard using the same format.
Resources
●
For System Layout
Specifies which library components you are going to export and their exporting order.
By default all exportable library components are listed and selected. To export some of them, unselect the others.
The order of the listed library components determines the order in which they will be exported. Click the buttons
exporting order if necessary.
●
and
to adjust the
For Customize Layout
Displays all the exportable library components in the dashboard. When customizing the layout for exporting, you can drag the components from
here to the Design tab.
Layout
●
System Layout
Uses a layout calculated by JReport based on the position of the exportable library components in the current dashboard. The preview result of
the system layout is displayed on the right.
The system layout allows you to decide the components to export and their exporting order using the Resources box.
●
●
Customize Layout
Allows rearranging the layout of the library components you would like to export using a tabular. You can customize the layout in the Design tab
and preview it in the Preview tab.
Other customized layouts saved
Your saved layouts are also listed for choosing. You can do further modifications based on them. For each of the customized layout, you can edit
its name or delete it using the two buttons - Rename and Delete - appearing on the right when the mouse hovers over the layout item on the
drop-down list.
Page Setup
Opens the Page Setup dialog for specifying the page size for exported files. Enabled for non-system layouts.
Export
Opens a dialog for doing the last setting and then exporting.
●
●
●
●
●
●
●
Export File Format
Specifies the format in which to export the library components. For a format other than XML, all selected library components will be exported into
one single file. For XML, each library component will be exported to a separate XML file. When the exported result contains more than one file, all
the files will be zipped.
File Name
The exported result may be either a single file or a zipped package of multiple files, so this name is either a file name or a zipped package name.
Run Linked Report
If the library components are linked with other reports, you can check whether or not to generate the linked reports in the exported result file. If
you are not interested in the linked report, leave this option unchecked. Generating linked reports at the same time, especially when the linked
reports contain a large amount of data, will cause performance issue.
OK
Starts exporting.
Cancel
Ignores the setting and exits the dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Save
Saves changes to an existing layout or opens the Save As dialog for saving a newly created layout. The saved layouts are available in the Layout
drop-down list for applying. The layouts that you save will be available to all users using the same dashboard.
Save As
Opens the Save As dialog for saving an existing layout with a different name.
Options for managing tabular cell
Available to non-system layouts. They are used for customizing the layout in the Design tab.
●
●
●
Horizontal Split
Splits a cell into two horizontal cells. When there is a library component in the cell, it will be placed in the left cell after the splitting.
Merge
Merges adjacent cells forming a rectangle into one cell. When there are more than one library component in the cells, the cells cannot be merged.
Vertical Split
Splits a cell into two vertical cells. When there is a library component in the cell, it will be placed in the top cell after the splitting.
Options for navigating pages
●
●
●
●
First
Goes to the start page.
Previous
Goes to the previous page.
Turn to Page
Input a number in the text box and then press the Enter button on the keyboard to go to that page directly. If the number is out of the range, the
page will be restored to the last accessed page.
Next
Goes to the next page.
●
Last
Goes to the end page.
Options for zooming in/out the pages
The usage of the tool:
●
Click - to zoom out.
●
Click + to zoom in.
●
Select a percentage from the drop-down list.
●
Input a percentage in the text box. The zoom range is from 30% to 400%. If you input a value out of the range, the ratio will be restored to the
previously applied percentage.
Design tab
Available to non-system layouts. It is where you customize the component layout. The page size is determined by the page setup properties and
the ratio setting. A tabular fulfills the page printable area for holding a library component in each cell. Split or merge the cells and then drag library
components from the Resources box into the cells to customize the layout.
When exporting, for tables and crosstabs, only their current view of data as displayed in the dashboard will be exported by default. For example, if
a table contains 10 pages of data and you browse to page 3 when you open the Export dialog, then in the exported result, the table will only
contain data of page 3. If you want their full data to be exported, you need to use the Filter option on the context menu to switch from Current
View to All.
There are these options on the context menu after right-clicking in a tabular cell:
●
●
Filter
Opens the Filter dialog to choose the data scope of the table or crosstab in the tabular cell.
Remove
Removes the library component from the tabular cell.
View tab
Available to non-system layouts. It provides a preview of the customized layout. You can click the page navigation and zooming buttons to preview
the result.
Filter dialog
The dialog is displayed when you right-click a table or crosstab in the Design tab of the Export dialog or
Print dialog. It helps you to choose whether to export/print all the data of the library component or just
the current page displayed in the dashboard.
Current View
Specifies to export/print the table or crosstab's current page displayed in the dashboard.
All
Specifies to export/print all the data of the table or crosstab.
OK
Closes this dialog and applies the setting.
Cancel
Cancels the setting and closes this dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Insert Filter Control dialog
This dialog is displayed when you drag Filter Control from Toolbox in the Resources panel to the
dashboard body. It helps you to insert a filter control into the dashboard body to filter component data.
Title
Specifies a title for the filter control.
Select Fields
Specifies the fields to bind to the filter control. All the selected fields should be of the same data type.
The common usage is to select one field, and then based on the field to filter the data of the
components created from the same data source as the field.
To filter components using different data sources, choose a common field all the data sources contain
and select the field in all the data sources.
Apply To
Specifies the data components from the drop-down list to apply the filter control to. <All> means all
data components involving the selected fields in the dashboard.
OK
Closes this dialog and inserts the filter control in the dashboard body.
Cancel
Cancels the insertion and closes this dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Insert HTML dialog
This dialog is displayed when you drag HTML from Toolbox in the Resources panel to the dashboard
body. It helps you to insert an HTML component into the dashboard body.
Title
Specifies a title for the HTML component.
HTML text box
Type text in the box directly. You can make use of the buttons above the text box to format the text,
insert images, and create hyperlinks.
Here are the buttons:
●
●
●
Font Face
Specifies the font of the text from the drop-down list.
Font Size
Specifies the font size of the text from the drop-down list.
B
Specifies whether to make the text bold.
●
●
●
I
Specifies whether to make the text italic.
U
Specifies whether to underline the text.
Font Color
Specifies the color of the text.
To change the color, click the color indicator to select a color, or click More Colors in the color
indicator to access the Color Picker dialog in which you can select a color within a wider range.
●
Background Color
Specifies the background color of the text.
To change the color, click the color indicator to select a color, or click More Colors in the color
indicator to access the Color Picker dialog in which you can select a color within a wider range.
●
●
●
●
●
Align Left
Specifies to align the text to the left.
Align Center
Specifies to align the text in the center.
Align Right
Specifies to align the text to the right.
Insert Image
Opens the Insert Image dialog for inserting an image into the text box.
Insert Link
Opens the Insert Link dialog to create a hyperlink to a URL address.
OK
Closes this dialog and inserts the HTML component in the dashboard body.
Cancel
Cancels the insertion and closes this dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Insert Image dialog
This dialog is displayed when you drag Image from Toolbox in the Resources panel to the dashboard
header. It helps you to insert an image into the dashboard header.
Image From
Specifies the source of the image file.
●
Local File
Specifies to use an image from the local file system.
❍
●
File Name
Specifies the path and name of the image file. You can click the Browse button to locate the image
file.
Web URL
Specifies to use an image via URL.
❍
File URL
Specifies the URL of the image file.
Note: If your JReport Server is in an intranet which requires a proxy, to successfully access the
image via URL, you need to add the parameters -Dhttp.proxyHost=XXX -Dhttp.proxyPort=XX
to the server's startup file JRServer.bat, which is located in <install_root>\bin.
●
Library
Specifies to use an existing image.
❍
My Pictures
The My Pictures folder is a virtual location where JReport Server stores the images that have once
been inserted into JDashboard. Select the one you want to use.
Preview
Displays a preview of the selected image.
OK
Closes this dialog and inserts the selected image in the dashboard header.
Cancel
Cancels the insertion and closes this dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Insert Link dialog
This dialog is displayed when you click
Insert Link in the Edit HTML dialog or Insert HTML dialog.
It helps you to insert a hyperlink to a web page.
URL
Specifies a URL that the hyperlink will be directed to.
OK
Closes this dialog and inserts the link.
Cancel
Cancels the insertion and closes this dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Insert Slider dialog
This dialog is displayed when you drag Slider from Toolbox in the Resources panel to the dashboard
body. It helps you to insert a slider into the dashboard body to filter component data.
Title
Specifies a title for the slider.
Slider Type
Specifies whether the slider is used to specify a range of values or to specify a single value:
●
●
Range of Values
If selected, you can select a range of values at runtime.
Single Value
If selected, you can select one value at runtime. Not available for numeric data type fields.
Select Fields
Specifies the fields to bind to the slider. All the selected fields should be of the same data type.
The common usage is to select one field, and then based on the field to filter the data of the
components created from the same data source as the field.
To filter components using different data sources, choose a common field all the data sources contain
and select the field in all the data sources.
Customize
Opens the Customize Value dialog for you to customize the values of the selected field.
Apply To
Specifies the data components from the drop-down list to apply the slider to. <All> means all data
components involving the selected fields in the dashboard.
OK
Closes this dialog and inserts the slider in the dashboard body.
Cancel
Cancels the insertion and closes this dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Insert Special Field dialog
This dialog is displayed when you drag Special Field from Toolbox in the Resources panel to the
dashboard header. It helps you to insert a special field in the dashboard header.
●
●
●
●
●
User Name
The User ID with which you log onto JReport Server.
Modified Date
The date when the dashboard was last modified.
Modified Time
The time when the dashboard was last modified.
Print Date
The date to run the dashboard.
Print Time
The time to run the dashboard.
OK
Closes this dialog and inserts the selected special field in the dashboard header.
Cancel
Cancels the insertion and closes this dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Insert URL Frame dialog
This dialog is displayed when you drag URL Frame from Toolbox in the Resources panel to the
dashboard body. It helps you to insert a web page into the dashboard.
Title
The title of the window that holds the web page.
URL
The URL of the web page you would like to show in the dashboard.
Auto refresh
Enables to refresh the specified web page periodically.
●
Interval
Specifies the time interval between two refreshes.
OK
Closes this dialog and inserts the web page in the dashboard body.
Cancel
Cancels the insertion and closes this dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Open Dashboard dialog
This dialog helps you to open another dashboard in the web browser.
Open In
Browse to the directory in the server resource tree where the target dashboard is located and then select the dashboard.
Use the button
to go to the parent folder.
The resource table shows the resources in the current directory.
File Name
Shows the selected dashboard file name.
OK
Closes this dialog and opens the selected dashboard.
Cancel
Cancels opening another dashboard and closes this dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Page Setup dialog
This dialog appears when you click the Page Setup button in the Export dialog for dashboard level or
Print dialog. It helps you to specify the page properties.
Page
Specifies the paper size. If you select Custom Size, you can then input the paper's Width and Height.
●
●
●
Type
Specifies the paper type.
Width
Specifies the width of the paper.
Height
Specifies the height of the paper.
Orientation
Specifies the paper orientation.
●
●
Portrait
The page is positioned vertically.
Landscape
The page is positioned horizontally.
Margin
Specifies the margin properties.
●
●
●
●
Top
Specifies the distance of the layout area to the top edge of the page.
Left
Specifies the distance of the layout area to the left edge of the page.
Bottom
Specifies the distance of the layout area to the bottom edge of the page.
Right
Specifies the distance of the layout area to the right edge of the page.
OK
Closes this dialog and applies the setting to the Design tab on the right section of the Export/Print
dialog.
Cancel
Cancels the changes and closes this dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Print dialog
The dialog is displayed after you click the Print button
on the side bar, or click the Options button
on the side bar and select Print from
the option list. It helps you to print one or more library components in a dashboard using the same format.
Resources
●
For System Layout
Specifies which library components you are going to print and their printing order.
By default all printable library components are listed and selected. To print some of them, unselect the others.
The order of the listed library components determines the order in which they will be printed. Click the buttons
order if necessary.
●
and
to adjust the printing
For Customize Layout
Displays all the printable library components in the dashboard. When customizing the layout for printing, you can drag the components from
here to the Design tab.
Layout
●
●
●
System Layout
Uses a layout calculated by JReport based on the position of the printable library components in the current dashboard. The preview result of
the system layout is displayed on the right.
Customize Layout
Allows rearranging the layout of the components you would like to print using a tabular object. You can customize the layout in the Design tab
and preview it in the Preview tab.
Other customized layouts saved
Your saved layouts are also listed for choosing. You can do further modifications based on them. For each of the customized layouts, you can
edit its name or delete it using the two buttons - Rename and Delete - appearing on the right when the mouse hovers over the layout item on
the drop-down list.
Printer properties
Opens the Printer Properties dialog for specifying the printer properties.
Page Setup
Opens the Page Setup dialog for specifying the page size for printed files. Enabled for non-system layouts.
Print
Starts printing.
Save
Saves changes to an existing layout or opens the Save As dialog for saving a newly created layout. The saved layouts are available in the Layout
drop-down list for applying. The layouts that you save will be available to all users using the same dashboard.
Save As
Opens the Save As dialog to save an existing layout with a different name.
Options for managing tabular cell
Available to non-system layouts. They are used for customizing the layout in the Design tab.
●
●
●
Horizontal Split
Splits a cell into two horizontal cells. When there is a library component in the cell, it will be placed in the left cell after the splitting.
Merge
Merges adjacent cells forming a rectangle into one cell. When there are more than one library component in the cells, the cells cannot be
merged.
Vertical Split
Splits a cell into two vertical cells. When there is a library component in the cell, it will be placed in the top cell after the splitting.
Options for navigating pages
●
●
●
●
●
First
Goes to the start page.
Previous
Goes to the previous page.
Turn to Page
Input a number in the text box and then press the Enter button on the keyboard to go to that page directly. If the number is out of the range,
the page will be restored to the last accessed page.
Next
Goes to the next page.
Last
Goes to the end page.
Options for zooming in/out the pages
The usage of the tool:
●
Click - to zoom out.
●
Click + to zoom in.
●
Select a percentage from the drop-down list.
●
Input a percentage in the text box. The zoom range is from 30% to 400%. If you input a value out of the range, the ratio will be restored to
the previously applied percentage.
Design tab
Available to non-system layouts. It is where you customize the component layout. The page size is determined by the page setup properties and
the ratio setting. A tabular fulfills the page printable area for holding a library component in each cell. Split or merge the cells and then drag
library components from the Resources box into the cells to customize the layout.
When printing, for tables and crosstabs, only their current view of data as displayed in the dashboard will be printed by default. For example, if a
table contains 10 pages of data and you browse to page 3 when you open the Print dialog, then in the printed result, the table will only contain
data of page 3. If you want their full data to be printed, you need to use the Filter option on the context menu to switch from Current View to All.
There are these options on the context menu after right-clicking in a tabular cell:
●
●
Filter
Opens the Filter dialog to choose the data scope of the table or crosstab in the tabular cell.
Remove
Removes the library component from the tabular cell.
View tab
Available to non-system layouts. It provides a preview of the customized layout. You can click the page navigation and zooming buttons to
preview the result.
Printer Properties dialog
This dialog appears when you click the Printer Properties link in the Print dialog. It helps you to specify
the printing properties and contains the following tabs:
●
General tab
●
Appearance tab
OK
Closes this dialog and applies the setting when printing.
Cancel
Cancels the changes and closes this dialog.
Displays this help document.
Ignores the setting and closes this dialog.
General tab
This tab shows some general print information.
Print Method
Specifies the printing method to print the result.
Printer
Specifies the settings of the printer.
●
●
●
Printer
Specifies the name of the printer. Select one from the drop-down list.
Media Tray
Specifies the media tray for the printer. Select one from the drop-down list.
Print to File
Prints the document to a file instead of a printer. This kind of files can only be opened and printed by
serial port printer on Windows via DOS command.
Print Range
Specifies the pages to be printed.
●
●
All
All pages will be printed.
Pages...to...
Specifies continuous pages to be printed.
Copies
Specifies the information of the copies.
●
●
Number of Copies
Specifies the number of copies you want to print. The number of copies will be applied to all specified
pages.
Collate
Specifies the printing order for printing multiple pages. If checked, when you print two copies of a
three-page result, the page order is 1, 2, 3; 1, 2, 3. Otherwise, the order will be 1, 1, 2, 2, 3, 3.
Appearance tab
This tab shows the appearance of the result to be printed.
Color
Specifies the color of the result to be printed.
●
●
Monochrome
Specifies to print the result in Monochrome.
Color
Specifies to print the result in Color.
Quality
Specifies the printing quality.
●
Draft
Specifies to print the result in draft quality.
●
●
Normal
Specifies to print the result in normal quality.
High
Specifies to print the result in high quality.
Sides
Specifies the print sides for the printed result.
●
●
●
One Side
Imposes each consecutive print-stream page upon the same side of consecutive media sheets.
Duplex
Imposes each consecutive pair of print-stream pages upon the front and back sides of consecutive
media sheets, such that the orientation of each pair of print-stream pages on the medium is correct
for the reader as if for binding on the long edge.
Tumble
Imposes each consecutive pair of print-stream pages upon the front and back sides of consecutive
media sheets, such that the orientation of each pair of print-stream pages on the medium is correct
for the reader as if for binding on the short edge.
Job Attributes
Specifies the properties of the print task.
●
●
●
Priority
Specifies the print priority for this task.
Job Name
Specifies the name of the print task.
User Name
Specifies the name of the user.
Save As dialog
This dialog is used to save different resources when it is accessed from different places.
●
●
●
When accessed via the Save or Save As option on the JDashboard side bar, it is used to save the current open
dashboard.
When accessed using the Save As option on the menu list of a library component in the dashboard body, it is used to
save the component.
When accessed by clicking the Save
or Save As button
in the Export dialog or Print dialog, it is used to save a
newly created export or print layout or an existing layout with a different name.
When the dialog is used to save dashboard or library component, it contains the following options.
Save In
Specifies the directory in the server resource tree where you want to save the resource. Use the button
parent folder. The root folder cannot be used to store resources into.
to go to the
Dashboards are saved in the My Reports and Public Reports folders together with reports. Library components are saved
in the My Components and Public Components folders.
The resource table shows the resources in the current directory.
File Name
Specifies the file name for the resource to save, without suffix.
OK
Closes this dialog and saves the resource.
Cancel
Cancels saving the resource and closes this dialog.
Displays this help document.
Ignores the setting and closes this dialog.
When the dialog is for saving export or print layout, it contains the following options.
Existing Layout
Lists the names of the already saved layouts and the time when they were last modified.
Name
Specifies the name of the current layout to be saved. Characters supported in file names can be used here. No suffix is
required.
OK
Saves the current layout.
Cancel
Ignores the setting and exits the dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Share Parameters Setting dialog
The dialog appears when you click the Options button
on the side bar and then select Share Parameters
from the option list. It lists all the parameters used in the current dashboard and helps you to share
parameters among library components.
All Parameters
Lists all the parameters used in the library components in the dashboard. Cascading parameters in the same
group are placed within one row.
●
●
●
To share parameters, hold the Ctrl key to select the target parameters and then click the Share button. The
parameters will be added into one sharing group.
To add another parameter into a sharing group, select any parameter in the group while holding Ctrl and
then select the parameter, then click Share.
To remove parameters from a sharing group, select the parameters and then click Cancel Share.
OK
Closes this dialog and applies the setting.
Cancel
Cancels the setting and closes this dialog.
Apply
Applies the setting without exiting the dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Related topic:
●
Sharing parameters between library components
Themes dialog
This dialog is displayed after you click
on the side bar and then select Themes from the option list. It helps
you to change the theme of the current dashboard.
Theme list
The left panel lists the themes for choosing. Each theme is displayed in a rectangle with the name and three
color boxes. Hover the cursor on a rectangle to show an arrow at the right most of the rectangle. Move the
cursor on the arrow and when the cursor becomes a hand icon, click the arrow to show that the color in each
color box is for which window element.
Preview
The right panel shows a preview of the current dashboard window with the selected theme.
OK
Closes this dialog and applies the selected theme to the current dashboard.
Cancel
Cancels changing the theme and closes this dialog.
Apply
Applies the selected theme to the current dashboard without closing this dialog.
Displays this help document.
Ignores the setting and closes this dialog.
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement