Ad Hoc: Report Design Guide v10.3 - Logi DevNet

Ad Hoc: Report Design Guide v10.3 - Logi DevNet
Logi Ad Hoc Reporting
Report Design Guide
Version 10.3
Last Updated: August 2012
Page 2
Table of Contents
INTRODUCTION ........................................................................................... 4
What is Logi Ad Hoc Reporting? ................................................................ 5
CHAPTER 1 Getting Started.......................................................................... 6
Learning the Interface ................................................................................ 7
Updating Your Profile ............................................................................... 12
Setting Your Preferences ......................................................................... 13
The Report Builder ................................................................................... 15
The Dashboard Builder ............................................................................ 24
CHAPTER 2 Data Sources .......................................................................... 27
Selecting a Data Source .......................................................................... 27
Sorting Data ............................................................................................. 31
Setting Filters ........................................................................................... 33
Advanced Concepts in Data Filtering ....................................................... 39
CHAPTER 3 Creating Data Columns .......................................................... 43
Calculated Columns ................................................................................. 43
Statistical Columns ................................................................................... 47
CHAPTER 4 Tables ..................................................................................... 51
Configuring Table Columns ...................................................................... 52
Grouping Data .......................................................................................... 65
Table Settings .......................................................................................... 79
CHAPTER 5 Crosstabs ............................................................................... 81
Crosstab Configuration ............................................................................ 81
Crosstab Settings ..................................................................................... 92
CHAPTER 6 Charts ..................................................................................... 93
CHAPTER 7 Interactive Data Views .......................................................... 102
CHAPTER 8 Heat Maps ............................................................................ 111
CHAPTER 9 Style & Formatting ................................................................ 114
Report Header........................................................................................ 114
Adding Labels ........................................................................................ 115
Adding Images ....................................................................................... 116
Report Settings ...................................................................................... 118
CHAPTER 10 Export Options .................................................................... 119
Searchable Report ................................................................................. 122
Printable Paging ..................................................................................... 123
Export to Excel ....................................................................................... 124
Export to Word ....................................................................................... 125
Export to PDF......................................................................................... 126
Export to CSV ........................................................................................ 127
Export to XML ........................................................................................ 128
Add to Archive ........................................................................................ 129
Send PDF Report By Email .................................................................... 130
CHAPTER 11 Running Reports ................................................................. 131
CHAPTER 12 Managing Reports .............................................................. 134
Page 3
Organizing Reports ................................................................................ 135
Scheduling Reports ................................................................................ 138
Sharing Reports ..................................................................................... 143
Modifying Reports .................................................................................. 144
Archiving Reports ................................................................................... 145
Web Studio............................................................................................. 147
View Dependencies ............................................................................... 149
CHAPTER 13 Dashboards ........................................................................ 150
CHAPTER 14 Multiple Data Sources ......................................................... 154
CHAPTER 15 Mobile Reports.................................................................... 156
CONTACT US ........................................................................................... 159
Page 4
INTRODUCTION
The Logi Ad Hoc Report Design Guide provides information and instructions for
users building reports.
The following information is included in this manual:







Getting started
Creating reports with the Report Builder
Creating dashboards with the Dashboard Builder
Viewing reports and dashboards
Archiving, organizing, sharing and modifying reports
Exporting reports to popular formats such as Excel, Word, PDF, CSV and
XML
Contact information
Target Audience
This guide is intended for the end-user. For additional technical documentation or
support for this or any other Logi Analytics product, please visit our web site at
http://www.logianalytics.com/support/.
Page 5
What is Logi Ad Hoc Reporting?
Logi Ad Hoc Reporting is a web-based reporting utility designed to make
building, sharing, and analyzing business intelligence reports a quick and easy
process, even for non-technical users. With Ad Hoc, there is no need for
downloadable report viewers, and no time or assistance is required from
technical developers to easily create professional, informative reports.
Ad Hoc delivers a user-friendly interface and full-featured reporting tools. Users
can create interactive charts and graphs, as well as publish comprehensive
reports to share with others. An easy-to-use Report Builder walks a user through
all the steps required to create comprehensive and interactive reports. It is not
necessary to understand SQL or databases in order to create robust, customized
reports in minutes.
Page 6
CHAPTER 1
Getting Started
Open a browser window using the internet browser. Type the URL for the Ad Hoc
instance in the Address bar of the browser. Bookmark the location for future
reference.
The Ad Hoc login screen appears.
Logi Analyticswas formerly known as LogiXML
Enter your username and password, and click LOGIN to access the application.
Notes:
1. Based on the configuration determined by the system administrator, the Login
screen may be bypassed.
2. The system administrator can issue a username and password.
Page 7
Learning the Interface
Menu Bar
There are six main links available in Ad Hoc in the menu bar at the top of the
page:
 Report Management - Modify, share and run reports
 Profile Management - Update your user account information and
preferences
 Home - Display your designated Homepage
 About – Get summarized information about Ad Hoc
 Help - Get help using Ad Hoc
 Logout - Exit Ad Hoc
IMPORTANT: Unless specifically stated otherwise, use of the word 'report' or
'reports' in the description of the Ad Hoc's functionality implies both reports and
dashboards.
Page 8
Reports Page
The Reports page is the default main page in Ad Hoc. For end users, reports are
divided into Personal Reports and Shared Reports. The Personal Reports tab will
display a list of reports, dashboards and folders specific to the logged in user.
The Shared Reports tab will similarly display a list of the shared by all users.
Initially, the Reports page will not have any reports, dashboards, or folders to list
or manage and the page will appear as:
On the page are a Personal Reports breadcrumb link to this page, the
to display brief help for the page, and the Add button to create reports,
dashboards and folders.
icon
Page 9
Once reports, dashboards or folders are added to the application, the Reports
page will appear as:
If more than one reporting database is available for the end user a Database
dropdown list will be presented. The Database dropdown list acts as a filter for
the list of reports. Only reports based on the selected database will be shown in
the list.
The Report Builder and Dashboard Builder use the currently selected database
as the source for all report data. Consequently, if the currently selected database
is changed, any reports that contain data from another database are not visible.
Note:
If the Database drop-down menu is not visible, then the user only has access to
one database. Contact the system administrator if additional access is needed.
In the above example is a folder named “Weekly Reports”, a report named
“Customers List”, and a dashboard named “News Dashboard.
Note:
The “(All)” option will only be presented if the System Administrator has enabled
the “Multiple Connection” option. When the “(All)” option is selected, the report
list is not filtered. In addition, the “Modify Data Source” dialog will present all of
the data objects for all of the reporting databases to which the user has access.
Page 10
Following are the available functions:
Add – hover over the Add button to display the dropdown list to create a report,
dashboard or folder
Delete – click on the Delete button to remove selected items from the list
Copy – click on the Copy button to replicate the selected items
Move – click on the Move button to move the selected items to another location
Find Reports – click on the Find Reports button to do a “contains” search of the
Name column for the associated text. Click on the
icon in the textbox to clear
the text and refresh the list. This option is configurable and may be hidden.
Notes:
1. The Find Reports criteria will be retained for all subsequent visits to the page
until it has been cleared out.
2. Depending on a user's Preference settings, the Find Reports criteria may be
retained after logging out or terminating a browser session.
Select All – click on the checkbox in the list header to select or deselect all items
in the list
Sort – sort the list by clicking on the Name or Last Modified header. Clicking a
second time will reverse the sort order.
Select Items – click on the checkbox within a row to select or deselect the item in
the list
Run Reports and Dashboards – click on the report or dashboard link in the list to
execute the item
Folder – click on the folder link in the list to navigate to a folder
- this action icon indicates that only a single action can be performed on the
item. Click on the icon to perform the action. Typically the single action is Modify.
- this action icon indicates that there are multiple actions that may be
performed on the item. Hover the mouse over the icon to display the dropdown
list of actions available. The available actions are dependent upon the
configuration and the item type; however, the list may include Modify, Rename,
Copy, Move, Schedule, Archive and View Dependencies.
Page 11
The following icons are used to signify a report's status or type:







Ad Hoc Report
Ad Hoc Report - Scheduled
Subscribed Ad Hoc Report
Ad Hoc Dashboard
Imported or Web Studio Report*
Scheduled Imported or Web Studio Report*
Subscribed Imported or Web Studio
Report*
* Web Studio is not available in the Java version.
Page 12
Updating Your Profile
Click Profile Management to change your profile information. Profile information
is divided into User Profile and Preferences and accessed by clicking on the
respective tabs.
User Profile
The User Profile covers the user specific information. From this screen, a user's
Username, Password, First Name, Last Name and Email Address may be
changed.
To update your profile:
1. Type the new information into the User Profile fields provided.
2. If the Security Authentication method is not NT, then
a. Click the Set Password button.
b. Type your old password and new password twice in the fields
provided.
c. From the Password panel, click OK to apply the changes.
3. Modify other fields as desired.
4. Click Save to commit the changes.
Notes:
1. Username cannot be changed.
2. The ability to modify a user password from the User Profile screen may be
disabled by the administrator.
3. The content of the Email Address field cannot be deleted if the user has
Page 13
subscribed to a report.
Hint:
Enter an email address in order to be able to subscribe to scheduled reports.
Setting Your Preferences
Click Profile Management button and then select the Preferences tab to change
your user preference settings.
To update your preferences:
1. Select a Homepage Type, then:
a. If Application Page, select a webpage from the application tree. If a
report area is selected (e.g., Shared Reports), then further refine
your selection by:
i. Click Change Folder.
ii. Select a folder from the folder tree and then click OK.
b. If Report, select a report by using the
icon to view a list of
reports and then click OK.
c. If URL, then specify a URL address. Click Test URL to confirm that
the URL can be viewed.
d. If Pre-defined Report, select a report by using the
icon to view a
list of reports and then click OK.
2. Enabling the Retain search strings feature will retain your last search
criteria for any page even after a logout.
Page 14
3. Enabling the Retain sort preferences feature will retain your last choices
for sorting of grids in the application.
4. Click Save to commit the changes and return to the Profile page.
5. OPTIONAL: Click Restore Original Settings to revert the preference
settings back to the default settings.
Note:
If a Homepage is specified, the application will automatically display the
designated Homepage immediately after logging into the application and when
the Home link is selected.
Page 15
The Report Builder
The Report Builder is a comprehensive and flexible interface designed to build
full-featured reports.
Note:
The Report Builder is not designed to build or modify dashboards.
Hover the mouse over the Add button and select Report from the dropdown list
to access the Report Builder.
Navigating the Report Builder
Following is a high level overview of the Report Builder and the various
components and options. The details of each component are covered elsewhere
in this document.
The core steps in the building of a report involve:





selecting a report template
selecting a source of the data for the report,
selecting the display elements,
configuring the display elements, and
reviewing the output.
These steps will be exercised in this section just to show the navigation options.
Page 16
After clicking the Add / Report option, a template selection dialog will be
presented.
Six templates are included in addition to the Blank template The Blank template
is initially selected. Click on a template and then click on the OK button.
Page 17
The Select or Modify Data Source dialog will be presented to allow the user to
determine the data objects on which the report will be based.
The Add/Remove tab allows the user to select all of the data objects that form
the basis of the report. Until data objects have been selected for the report the
other tabs will be disabled. The Calculated Columns tab allows the user to
create custom columns. The Statistical Columns tab may be selected to do
cursory analysis of the data. The Sort tab determines the initial sort sequence of
the data returned from the reporting database. The Filter tab allows the user to
specify filter criteria for the data.
The list of data objects available to the user may be filtered by the Data Objects
in dropdown list. These are categories of data objects.
The data objects tree identifies the data objects available to the end user. As
objects are selected the tree will be refreshed to show the related data objects.
The columns of a data object can be viewed by expanding the data object.
Sample data for the object can be displayed by clicking on the
icon.
The Information panel will display any helpful descriptions of the data object or
column that the mouse is on.
The Preview Selected Data button will display a report dialog based on the data
objects selected. From this dialog the selections can be confirmed and all of the
dialogs dismissed.
Page 18
The OK button saves the currently selected data objects and dismisses the
dialog.
If the end user has access to multiple reporting databases and the “(All)” option
was selected on the Database filter, the Modify Data Source dialog will allow the
user to select data objects from any of the reporting databases.
Notice in the above image that the Database filter is set to “(All)”. The tree of data
objects includes two databases; “Adventure Works Schema” and “Northwind”.
The initial presentation of the tree in this scenario is normally for all databases to
be fully expanded. The “Adventure Works Schema” was collapsed in this
example for documentation legibility.
Page 19
Once the data objects for the report have been selected, the full Report Builder
interface is available.
Across the top of the page is the breadcrumb trail, a series of links to the pages
and folders recently visited.
For example, clicking on Personal Reports link in the breadcrumb trail will display
the Reports page. If changes to the report have not been saved, the following
confirmation dialog will be displayed:
Page 20
The tabbed function ribbon follows with File, Insert, and Settings tabs.
The File options are generally related to the report definition files. From this set of
options you can create a new report, open an existing report, save the report
definition, save the report definition by a new name or preview the current report.
The Insert options are related to display elements. The options presented in this
ribbon are configurable by the administrator. The display elements may be added
to the report by either clicking on the display element or drag-and-drop to a
location in the Report Layout panel.
The Settings options allow the user to control the paging aspects of the report as
well as select the stylesheet to be used to render the report.
Quick shortcuts are provided to save the current report definition and preview the
report via the
and
icons, respectively.
Page 21
On the left side of the page below the function ribbons are the Report Layout and
Data Source panels.
The Report Layout panel displays thumbnails of the
display elements in the sequence defined in the report.
Display elements may be removed by clicking on the
icon. Display elements may be added or rearranged by
drag-and-drop methods. Clicking on the display
element in the Report Layout panel will open the
configuration page for the display element.
The Data Source panel displays the defined sources of
data for the report. Data objects, calculated columns
and statistical columns are listed. The Modify Data
Source button will display the Select or Modify Data
Source dialog.
Either panel may be collapsed or expanded by clicking
on the
or
buttons.
Page 22
Centered on the page is the tabbed Configuration panel. Each tab allows the end
user to configure some aspect of a display element. Every display element will
have at least one configuration tab associated with it.
As display elements are added to the report, the number of configuration tabs will
grow. When the number of tabs exceeds the page width, the tabs become
scrollable.
Clicking on the
or
arrows will scroll the tabs left and right.
The Previous Step and Next Step buttons will display the contents of the
previous or next configuration tab in the Configuration panel. Hovering the mouse
over the buttons will display a tooltip describing the action.
Page 23
At the bottom of the page is the Live Preview panel that will show the report as it
being developed. As changes are made to the configuration, the impact on the
report can be viewed “live”.
This panel is initially collapsed. Click on the
or
buttons to collapse or
expand the panel in the current browser window. Click on the
to display the
report preview in a separate browser window.
Note:
The Live Preview is refreshed with each change to the report configuration. The
preview is a full rendering of the display element as it would appear in the report.
Rendering the display element will impact the performance of the Report Builder,
particularly for large volumes of data.
Notes:
1. When creating a report, the Live Preview panel will not begin displaying
anything until a Data Object has been selected.
2. When exiting the Report Builder, the Ad Hoc will remember the state in which
the Live Preview panel was last in, expanded or collapsed. Therefore, upon
the next launching of the Report Builder, non-specific to any report, the Ad
Hoc will display the Live Preview panel in the viewable state it was last in.
3. If the Live Preview feature is not offered in the Report Builder, contact the
System Administrator to enable it.
Note:
After an extended period of inactivity, the web server will end a browser session
and work may be lost. It is a good idea to save report modifications often to avoid
this scenario.
Page 24
The Dashboard Builder
The Dashboard Builder is an interface designed to build dashboards.
Note:
The Dashboard Builder is not designed to build or modify reports.
Hover the mouse over the Add button and select Dashboard from the dropdown
list to access the Dashboard Builder.
Navigating the Dashboard Builder
Following is a high level overview of the Dashboard Builder.
The core steps in the building of a dashboard involve:


Specifying a dashboard name
Configuring one or more dashboard panels
These steps will be exercised in this section just to show the navigation options.
Across the top of the page is the breadcrumb trail, a series of links to the pages
and folders recently visited.
For example, clicking on Personal Reports link in the breadcrumb trail will display
the Reports page. If changes to the dashboard have not been saved, the
following confirmation dialog will be displayed:
Page 25
.
Below the breadcrumb trail is dashboard management bar that allows the
specification of the Dashboard Name, dashboard management with Save and
Save As buttons, dashboard review with the Preview Dashboard button,
navigation back to the Reports page with the Back to Reports List button, and
general control of the dashboard configuration with the Dashboard Settings
expand/collapse button.
Clicking on the
panel.
or
buttons will collapse or expand the dashboard settings
Below the dashboard management bar is the list of dashboard panels. Initially
only the Add button is displayed. When one or more panels have been
configured, the dashboard list will appear as:
The Delete button will remove the selected panels. Panels are selected by
clicking on the checkbox for the panel. All panels may be selected or deselected
by clicking on the checkbox in the list header.
Actions may be performed on each panel by hovering the mouse over the icon
to display the dropdown list of actions available and selecting the action. The
available actions are Modify Dashboard Panel, Move Up and Move Down.
Page 26
Both the Add button and the Modify Dashboard Panel action will display the
Panel Settings dialog.
After entering the panel settings, click on the Save Panel button to temporarily
save the panel definition and return to the list of panels.
The dashboard definition is permanently saved through the Save or Save As
options in the Dashboard Builder.
Page 27
CHAPTER 2
Data Sources
Every report is based on a source of data. Data sources refers to the data
objects and columns related to a reporting database as well as calculated
columns and statistical columns defined for the report.
Selecting a Data Source
Generally the first step in the Report Builder is the selection of the data source.
The Report Builder wizard automatically drives the user to the Select or Modify
Data Source dialog as part of creating a new report. The same dialog is
presented when the Modify Data Source button is clicked.
Page 28
If the data objects have been categorized, a Data Object in dropdown list will be
presented and acts as a filter for the list of data objects. The list of data objects
may be changed by selecting a different category from the list. All data objects
may be displayed by selecting the “(All)” option in the list.
If the end user has access to multiple reporting databases and the “(All)” option
was selected on the Database filter, the Modify Data Source dialog will allow the
user to select data objects from any of the reporting databases.
Notice in the above image that the Database filter is set to “(All)”. The tree of data
objects includes two databases; “Adventure Works Schema” and “Northwind”.
The initial presentation of the tree in this scenario is normally for all databases to
be fully expanded. The “Adventure Works Schema” was collapsed in this
example for documentation legibility.
Page 29
To select a data object to be used in the report, click on the checkbox adjacent to
the data object. Every time a data object is selected the tree of data objects is
refreshed to display all of the related data objects. Continue selecting data
objects and click on the OK button to save the selected items as a data source
for the report.
The Exclude duplicate rows checkbox indicates that only distinct rows should be
returned from the database when the report is executed. Rows having identical
values for all selected columns will be excluded.
After saving the data source, the Data Source panel will reflect the selected data
objects and columns.
If the data source for the report needs to be adjusted, click on the Modify Data
Source button, make the required changes in the Select or Modify Data Source
dialog, and click on the OK button to save the changes.
Note:
Modifying a data source for the report may require reconfiguration of the
attributes for a display element.
Note:
Most reports are based on a single data source. All of the display elements share
the same data source. By default Ad Hoc is configured to allow only a single data
source per report; however, the administrator can configure Ad Hoc to allow the
specification of multiple data sources for a report. See Chapter 14 for details on
using multiple data sources in a report.
Note:
Calculated Columns and Statistical Columns are also data sources for a report
and are reflected in the Data Source panel. Refer to Chapter 3 for details on
Page 30
Calculated and Statistical Columns.
Note:
If only one data object is selected, column references in the Report Builder will
not identify the data object. If multiple data objects are selected, column
references will be “Data Object.Column Name” notation.
Page 31
Sorting Data
The data returned from the database may have a default sort order specified.
This will determine the initial display order of the data for tabular reports and the
initial population of crosstab reports. The sort order may be overridden when the
report is executed if that option is enabled.
To set the initial sort order of the data, click on the Modify Data Source button to
display the Select or Modify Data Objects dialog. Click on the Sort tab to display:
The sort order must be set column by column.
Page 32
Click on the Add a Column button to create a sorting level.
Select a column from the Column dropdown list and the Direction (Ascending or
Descending). Repeat the process for all of the columns that must be used to set
the sort sequence of the data.
To remove a column from the sort sequence, click on the
for the column.
If the Column order in the list needs to be adjusted, use the drag-and-drop
method by clicking on the drag handle and dropping the column where
necessary.
At the bottom of the Sort tab is the Return First n Rows attribute. This may be set
to limit the number of rows returned from the reporting database for the report.
This feature allows the report to be built on large datasets more efficiently by
restricting the number of rows returned during development and testing. After the
report design is complete, the value may be removed to report from the full
dataset.
Page 33
Setting Filters
Data used in the report may be filtered by various criteria. The criteria may be set
for the report by the developer (“non-Ask” parameters) or may be supplied by the
user when the report is executed (“Ask” parameters).
To set a filter for the report click on the Modify Data Source button to display the
Select or Modify Data Objects dialog. Click on the Filter tab to display:
To create a filter parameter, click on the Add a Parameter button to display the
Parameter Details dialog.
Page 34
A parameter takes the form of an equation similar to:
Label is Compared to Value
where label represents a column name, compared to represents a comparison
operator, and value represents a threshold.
The available comparison operators are:










Equal to
Not equal to
Less than
Greater than
Less than or equal to
Greater than or equal to
Starts with 1
Does not start with 1
Ends with 1
Does not end with 1









Contains 1
Does not contain 1
Is null
Is not null
Between
Not between
In list
Not in list
In cascading list
Notes:
1. These operators are only available for data of type String or Text.
2. The operators available are dependent upon the column's data type. For
example, a numeric data type would not include operators such as true/false.
Page 35
To set a data parameter to a Specific Value or Pre-defined Date:
1. From the Column drop-down menu, select the desired column.
2. From the Operator drop-down menu, select the desired comparison
operator.
3. From the Value type drop-down menu, select either Specific Value or Predefined Date.
4. Specify a threshold value(s) in the Value field. Click the
icon to view a
list of valid values from the database and then populate the Value field
from the value(s) selected.
5. Click OK to add the parameter to the report.
6. Click the
icon adjacent to any parameter to delete that parameter from
the report. Click the
icon to modify a parameter.
7. Add more parameters by clicking the Add a Parameter button and
repeating the steps above.
Notes:
1. If the 'In list' or 'Not in list' operator is selected, then more than one value may
be specified. If manually typing in each value, then follow each entry by the
[ENTER] key.
2. If the main data column is of date type, an additional choice of values called
Pre-defined Date. Pre-defined dates are dates in the form of a token, such
as Today, This Year End, Last Fiscal Quarter Start, etc. Pre-defined dates get
evaluated at the time the report runs. If the pre-defined date token is
evaluated to a column containing time, then no records will be returned at
runtime.
3. If the value is a number, the Value field must contain a valid number to build
the report. If the 'In cascading list' or 'Not in cascading list' operator is
selected, then a user must choose a cascading filter and as a result do not
have the option to specify a value. See the 'Running Reports' chapter for
more information about cascading filters.
4. The Filter functionality does not support conditions against data types of type
Time. Date/Time data types are supported but their time portion will be
ignored.
5. Specifying a Session Parameter as a value in report parameters is
permissible. There are implications related to scheduling and archiving. In
addition, modification of the session parameter after the report is built may
“break” the report which may “break” schedules. Subscribed users may be
automatically notified when a schedule is “broken”.
Hint:
When adding multiple parameters, a logical operator (And or Or) becomes
available for selection at the beginning of the next parameter. Use this operator
to set the cumulative conditions for the parameters.
Page 36
If the report contains two or more parameters, the
icon appears for each
additional parameter. The directional pad gives users the ability to create levels
for each parameter. Control the order of evaluation for multiple parameters using
the directional pad.
Page 37
Ask Parameters
Enable the Ask in Report option to offer the report viewer the option of changing
the threshold value before the report is rendered. Instead of limiting the report to
predefined parameters, the values can be modified while browsing the report.
Marking an operator as an "ask" parameter presents a few other options in the
Parameter Details dialog.
The parameter caption will be automatically generated if left blank.
Control Type values depend on both the operator picked and the selected
column's data type. For example, a text type column with Equal To operator
presents the following choices:
 Text
 Dropdown
 List (single select)
The In list operator produces the following choices:
 List (multi-select)
 Text (multi line)
A date type column with Equal To operator produces the following choices:
 Date
 Dropdown
 List (single select)
Page 38
A Boolean type column with Equal To operator produces the following choices:
 Checkbox
 Dropdown
 List (single select)
If more than one parameter is presented to the user, the option to display each
parameter adjacent the previous one or on a new line is available. Choose by
marking the desired radio button for Display this parameter.
Notes:
1. With the control type of List (multi select) selected, the initial display of the
report will appear with the Ask parameter's list populated with all possible
values from the database and with the default values highlighted/preselected.
2. With the control type of Text (multi line) selected, the initial display of the
report will appear with the Ask parameter's list populated with only the default
values. The values will not be highlighted/pre-selected.
3. With the control type of Dropdown selected, Offer All Option checkbox is
made available. Checking this checkbox will set the first row of the dropdown
list to “All”, allowing the report viewer to use that option as the report
parameter.
4. Parameters based on comparing two columns cannot be “asked” from the
user.
Page 39
Advanced Concepts in Data Filtering
Advanced data filtering makes it possible to define groups of parameters that
work together to filter undesirable data from the report. Users can define multiple
parameters and control the order of evaluation. Filter report data to control what
users see at runtime.
Data filtering gives users the ability to control the content of the report. Filter
extraneous data from the report by defining one or more parameters that are
evaluated at runtime. The directional pad control (
) enables users to control
the order of evaluation.
The individual arrows of the control perform the following functions:
Shifts a parameter one position higher in the list (retains indentation)
Shifts a parameter one position lower in the list (retains indentation)
Indents a parameter one position left
Indents a parameter one position right
As parameters are indented to the right, enclosing parentheses appear to
indicate the order of evaluation.
Users can also perform a row-level comparison with fields in two different
columns. In this case, the parameter takes the form of an equation similar to:
Label1 is Compared to Label2
where label1 represents the first column name, compared to represents a
comparison operator, and label2 represents the second column name.
To compare values from two different columns:
1. From the Column drop-down menu, select the desired column.
2. From the Operator drop-down menu, select the desired comparison
operator.
3. From the Value type drop-down menu, select Other Data Column.
4. From the Value field drop-down menu, select the desired column the
comparison will be performed against.
5. Click OK to add the parameter to the report.
6. Click the
icon adjacent to any parameter to delete that parameter from
the report. Click the
icon to modify a parameter.
Note:
When comparing two different columns, the Ask in Report checkbox is disabled.
Page 40
Using Session Parameters
If session parameters have been defined for the Ad Hoc instance, the
parameters detail dialog may be slightly different. See the following picture:
Notice that there is a Value source dropdown. The Value source is typically a
“Specific Value”; however, if session parameters have been defined, “Session
Parameter” may be selected as the Value source. When “Session Parameter” is
selected, a dropdown list of relevant session parameters is displayed.
Session parameters are one of five types; date, number, numeric list, text or
textual list. The dropdown list of session parameters will contain the session
parameters that match the data type of the Column. The list is also restricted by
the Operator selected.
For date Columns, the date session parameters will be shown in the list of
available session parameters.
For numeric Columns, either the number or numeric list session parameters will
be shown in the list of available session parameters. If the Operator is set to “In
List” or “Not In List”, the numeric list session parameters will be shown, otherwise
the number session parameters will be shown.
For text Columns, either the text or textual list session parameters will be shown
in the list of available session parameters. If the Operator is set to “In List” or “Not
In List”, the textual list session parameters will be shown, otherwise the text
session parameters will be shown.
Page 41
Input Parameters
Certain data objects, those based on a stored procedure or function, may depend
upon input parameters to execute properly. If the System Administrator has
determined that the input parameter values may be supplied by the end user,
when the data object is selected for use filters will be automatically generated.
These generated filters may be reviewed and edited on the Filter tab of the
Modify Data Source dialog.
As an example:
This filter was automatically created when the data object requiring the input
value was selected for use in the report. Notice that there is no operator
specified. The logic associated with the usage of the value is contained in the
stored procedure or function.
Page 42
The filter may be edited by clicking on the
dialog will be shown.
action icon. The Parameter Details
The Default Value reflects the default value set by the System Administrator and
may be overridden for the report.
By default the parameter value will be entered by the report user when the report
is run. The Ask in Report checkbox determines whether the user is permitted to
supply the value when the report is executed.
The Caption is displayed in the report and identifies the type of value expected
by the end user when the report is run.
The Control Type dropdown list presents the list of controls that might be used to
collect the value when the report is run.
Click on the OK button to store the parameter details in the report definition.
Page 43
CHAPTER 3
Creating Data Columns
Ad Hoc gives users the ability to create custom data columns. Custom data
columns can either be a calculation or a computed statistic from data in other
columns. Both types of columns are considered data sources for the report and
may be created through the Select or Modify Data Sources dialog.
To create either a Calculated Column or Statistical Column, click on the Modify
Data Source button to display the Select or Modify Data Objects dialog. Click on
either the Calculated Columns or Statistical Columns tabs.
Calculated Columns
Calculated Columns offer the ability to create new columns for the report based
on a specified formula applied to data from existing columns.
In addition to the availability of data source columns, customized columns can be
created that consist of calculations performed on data from other columns in the
report. Calculations are performed with date, numeric and non-numeric data
types. The operands of the formula are either constants or the names of existing
data columns included in the report. Users can create formulas from the six
provided operators, use the predefined functions or utilize any SQL function
supported by the selected report database.
Page 44
The goal of the calculated column process is to create and name a Definition that
the reporting database can interpret and return data. Consequently, the Definition
must conform to the reporting DBMS SQL syntax rules for a column.
It is not required that any of the helpful controls are used to create the Definition.
Knowledgeable users can simply enter the definition in the text box. It is highly
recommended, however, that columns are inserted into the Definition by clicking
on the column from the data object/column tree. The column reference will be
placed at the last cursor position in the Definition textbox.
In the upper left corner of the Calculated Columns tab are the most common
functions that are used in the definition of a calculated column.
The functions are categorized according to the generic data types of columns;
date, text, and numeric data. The dropdown lists may be viewed by hovering the
mouse over the buttons. Click on the function to insert the reference into the
Definition textbox. For the functions requiring additional arguments or
information, a dialog will be presented to complete the function. For example, the
Text/Concatenate function will display the following dialog:
Page 45
To complete this particular dialog, click on the String1 text box and then click on
a column. The column reference will be placed into the text box. Only the
columns relevant to the function type will be presented for selection. Repeat the
process for String2 and click on OK to post the function into the Definition text
box. The other function dialogs behave similarly.
On the left side of the Calculated Columns tab of the Select or Modify Data
Source dialog is the data objects/columns tree. To place the column reference
into the Definition, click on the column.
After a calculated column has been defined, the data objects/columns tree will be
refreshed and the calculated column added to the tree along with two
management actions. Click on the icon to edit the calculated column definition.
Click on the to remove the calculated column.
At the top of the right side of the Calculated Columns tab are operators that may
be added to the Definition.
Clicking on any of the operators will place the symbol in the Definition at the last
cursor position. The More dropdown list contains the AND, OR, and NOT
operators that may be added to the Definition by clicking on them.
The Definition text box is the actual work area. It may be populated from the
functions, columns and operators available or the user can enter the calculated
column definition directly by typing in the textbox.
The Test button will verify that the calculated column definition meets the syntax
rules for the reporting DBMS. If so, a mini-report displaying the calculated column
and the underlying data from the reporting database will be shown.
Page 46
Ad Hoc must know the data type of the resultant calculated column. In most
cases the data type can be accurately determined from the data type of the
underlying columns or calculation. The Auto option allows Ad Hoc to use the
implied data type. To provide the specific data type or override the implied data
type, either select the data type from the Type dropdown list or click on the
Determine Type button.
Enter the Name of the calculated column in the provided textbox.
The Preview Selected Data button will display a report of all of the columns,
including the defined calculated column in the Selected Data Preview dialog.
From this report dialog, clicking on the Select and Continue button will save the
current calculated column definition and dismiss all of the dialogs.
The Save button verifies the Definition, stores the Name and Definition
temporarily, clears the Definition textbox and updates the data object / column
tree.
The Clear button erases the contents of the Definition textbox.
The New button clears the contents of the Definition textbox and resets the
Name. If the existing Definition has not been saved, a confirmation dialog will be
shown.
The Cancel button will discard any changes made in the Select or Modify Data
Source dialog and dismiss the dialog.
Click the OK button to save all of the changes made in the Select or Modify Data
Source dialog. The newly defined calculated columns are then available for
selection in the Report Builder.
Note:
A calculated column must be used in the report for the column to be saved in the
report definition. Unused calculated columns are automatically removed from the
report definition.
Page 47
Statistical Columns
Statistical Columns give users the ability to create new columns for the report
based on a particular statistic from data in other columns. The following statistical
column types are supported with the application:



Rank
Reverse Rank
Percentile


Running Total
Difference from Previous
To create a statistical column:
1. Click on the Modify Data Source button to show the Select or Modify
Data Source dialog
2. Click on the Statistical Columns tab
3. Choose a function from the Function Type drop-down menu.
4. Select a column from the Columns list - the function is applied to the
column's value.
5. OPTIONAL: Modify the default Name in the field provided.
6. Click OK to make the newly created statistical column available for
selection in the Report Builder.
Page 48
Notes:
1. When the OK button is clicked the column's name is validated for SQL syntax
accuracy. If the name is invalid, then a message will appear.
2. If a statistical column is not used in the report, then it shall be deleted when
exiting the Report Builder. Basically, use it or lose it.
The Rank function ranks data from the lowest value to the highest value. For
example, a total of $15.00 would receive a higher rank than a total of $25.00.
When one or more data rows have equal values, the rank value is the same for
each row. In the following figure, the first five orders listed all have a rank of 1.
Since five orders share a rank of 1, the next available rank value is 6.
The Quantity - Rank column ranks the Quantity column's value from lowest to highest.
Note:
Rank values are never higher than the actual number of rows in the report.
Page 49
The Reverse Rank function classifies data from the highest value to the lowest
value; a larger value receives a higher rank. For example, a total of $25.00 would
receive a higher rank than a total of $15.00. When one or more data rows have
equal values, the rank value is the same for each row. In the following figure, the
eighth order and subsequent four orders listed all have a rank of 8. Since five
orders share a rank of 8, the next available rank value is 13.
The Quantity - Reverse Rank column ranks data in the Quantity column from highest to lowest.
The Percentile function classifies data based on a percentage of the value
distribution. In the following figure, a value equal to or greater than 70 but less
than 100 is reported as the 98th percentile.
The Quantity Percentile column ranks data in the Quantity column based on a percentage of the
value distribution.
Page 50
The Running Total function maintains a current total of values provided in the
specified column as illustrated in the following figure.
Example use of Running Total based on the Freight column
The Difference from Previous function displays the difference from the current
value and the previous value of a specified column. In the following figure, a
difference of 31 is reported from rows one to two indicating a gain. A difference of
-34 is reported from rows two to three indicating a loss.
The Quantity Difference column maintains the difference from the current value and the previous
value of the Quantity column.
Page 51
CHAPTER 4
Tables
A table (also referred to as a “display table” to avoid confusion) presents data in
a tabular style report. A column is created for every data column that is included
in the report, and a row is created for every value in that data column. The
Report Builder provides a table wizard to customize the table's select columns,
appearance, group data and configure paging options.
Four tabs are presented in the Report Builder for each display table; Table
Columns, Column Configuration, Grouping, and Table Settings.
The Table Columns tab allows the user to determine which columns are included
in the final report.
The Column Configuration tab allows the user to determine the display
characteristics for each column and define column aggregations.
The Grouping tab allows the user to defined data grouping levels, the display
style (flat or drill), and group level aggregations.
The Table Settings tab allows the user to configure the display table presentation
characteristics such as a title, rows per page and the location of summary
information.
Page 52
Configuring Table Columns
The first step of the table wizard is to select the columns to be used in the display
table.
To select columns for the table:
1. Click on the Table Columns tab.
2. Select one or more Available Columns and then click to add the
column(s) to the Assigned Columns list-box. Hold the CTRL key down to
select multiple columns.
3. From the Assigned Columns list-box, change a column's initial display
order by clicking on either the or icon to move the row up or down.
Hold the CTRL key down to select multiple columns.
4. If a column(s) in the Assigned Columns list-box is not desired, select one
or more Assigned Columns and then click to remove the column(s) from
the Assigned Columns list-box. Hold the CTRL key down to select multiple
columns.
5. When done assigning and arranging columns, either click the Next Step
button or the Column Configuration tab to begin formatting the
appearance of each column.
Notes:
1. At least one data column should be selected before continuing.
2. A column description will only be available if one has been specified by the
System Administrator.
Page 53
To configure and delete columns in the table:
After having added columns, a column's order of appearance, display
characteristics and summary information may be defined on the Column
Configuration tab.
Initially only the Column, Header and Sortable columns are shown in the
configuration grid. By clicking on the Show All Attributes icon, the grid is
expanded as shown above. The grid may be collapsed by clicking on the Show
Minimum Attributes icon.
Columns may be selected (or deselected) by clicking on the checkbox adjacent
to the column. All columns may be selected or deselected by clicking on the
checkbox in the upper left corner of the grid. Some of the following functions
apply to the selected columns.
Columns may be rearranged by drag-and-drop methods using the handle on
the left of the grid. Mousedown on the drag handle, move the row to the target
location and release the mouse. Columns may also be rearranged by selecting
the row and then click either the or icon to move the row up or down. To
move a group of columns, select the desired columns by enabling their
respective checkboxes and then click either the
or icon to move the rows up
or down.
Columns may be removed from the display table by selecting the column(s) and
clicking the
icon.
Page 54
There are 9 configurable options available in Column Configuration:



Header
Linkable
Sortable






Summary
Format
Visualization
Width
Alignment
Style
The Header determines the column header displayed when the report is
rendered.
The Linkable option toggles predefined hyperlinks for records in the column.
Each record in the Linkable column contains a hyperlink to an address specified
by the System Administrator. Make column records linkable from the report by
placing a check in the corresponding Linkable checkbox.
Note
The Linkable column will only be shown if the System Administrator has
configured at least one of the columns as “hyperlink capable”.
The Sortable option determines whether the column in the rendered report may
be sorted by the end user. The Sortable checkbox determines the column’s sort
capability. Sort capability may be enabled or disabled for all columns by clicking
on the checkbox in the header of the Sortable column.
The Summary option offers the ability to create table footers containing
aggregates of values for each column of data. An unlimited number of
aggregates can be created for each table column. The following aggregate
functions are supported:





Sum
Average
Standard Deviation
Count
Count Distinct



Maximum
Minimum
Calculation
Page 55
To manage summary values:
1. Click
to add a summary value for a specific column.
2. Click the Add an Aggregate button on the Aggregates dialog.
3. Type a name used as the internal value for the aggregate in the Name
field.
4. Type a displayed name for the new value in the Label field.
5. Choose an Aggregate function from the drop-down menu.
6. Choose a Format from the drop-down menu.
7. OPTIONAL: If more than one aggregate has been specified, click the
or
icon to arrange the order in which the aggregate will appear in the
column. Aggregates may also be rearranged by drag-and-drop methods
using the handle on the left of the grid. Mousedown on the drag handle,
move the row to the target location and release the mouse.
8. Continue adding additional aggregates or click OK to add the summary
value(s) and return to the Column Configuration interface.
9. Aggregates may be removed by selecting the aggregate and clicking the
icon
Note
The
icon indicates that a summary value exists for that particular column.
Page 56
One of the aggregation options is “Calculation”. This option allows the user to
create a new aggregation from previously defined summary information. When
“calculation” is selected, the following dialog is displayed:
The “AvgPrice” and “SumQTY” aggregates have been used in the calculation of
the “AveLineItem” in this example. These two summaries were simple
aggregations on the Unit Price and Quantity column.
In the Modify Calculation dialog, any of the previously defined summaries may be
used in the calculation as well as aggregate functions on columns and direct
constants in the definition. The default internal name for an aggregation is
AGGRn, where “n” is a unique number.
Page 57
The Format option provides data formatting options for values in each column.
The following formatting options are supported:









(none)
General Number
Currency
Integer
Fixed
Standard
Percent
Scientific
2 or 3-digit place holder








General Date
Long/Medium/Short Date
Long/Medium/Short Time
Yes/No
True/False
On/Off
HTML2
Preserve line feed3
Notes:
1. The application chooses the default Format type for each column. Changing
the format type may yield undesirable results.
2. The Format of "HTML" may only be specified by the System Administrator
and may not be changed to something different from the Column
Configuration panel.
3. The Format of 'Preserve line feed' allows text in a memo type field to display
as it is stored with line feeds (a.k.a., carriage returns) observed.
4. If a Format is needed that is not offered, contact your System Administrator.
5. Additional formats may be provided by the System Administrator
Page 58
The Visualization option allows numeric fields to be displayed with a colored
indicator. The following indicators are available:





(none)
Bar
Color Slider (background)
Color Slider (circle)
Color Slider (square)
Color indicators allow the user to define their own threshold for comparing a
value at a particular row with all other values in that column. When enabling
visualization on a particular column, a color slider appears in the column header
for setting the threshold. The color spectrum is determined by how much the data
values in the column deviate from the specified threshold. Choose to visualize
each cell value as a colored shape - bar, circle or square - or shade the entire
cell background. Additionally, the numeric data value can be displayed adjacent
to the visualization. Following is an example of visualization.
To add a visualization affect:
1. Click
to add a visualization affect for a specific column. The
Visualization Options dialog will be displayed.
2. Choose a style from the Visualization Style drop-down menu.
3. Change the Show Data Values option as desired. Default setting is Yes.
Page 59
4. Choose an aggregate function from the drop-down menu.
5. Click OK to add the summary value and return to the Column
Configuration interface.
Note:
The
icon indicates that a visualization exists for that particular column.
To modify or remove a visualization effect:
1. Click the
icon associated to the column with an existing visualization.
2. From the Visualization Options dialog,
a. If modifying a visualization affect, modify the settings as desired.
b. If removing a visualization affect, select "(none)" as a Style.
3. Click OK to save the modifications and return to the Column Configuration
interface.
Page 60
The Width option offer the ability to customize the width of each column, thereby
improve the appearance of the report when it is rendered in the webpage and
when exported (e.g., Word, PDF). By default, a column's Width value is left blank
to allow the application the option to automatically determine the appropriate
width based on:
 All columns in the report
 The context in each column
 The available webpage space
 The page size and orientation
When customizing a column's width, it is important to determine the scale by
which an entered value will be measured. The scale of measured can be either
pixels or percent where:
 Pixel is a single point of picture data displayed on the monitor. Hundreds
of pixels can be used to display a very small image.
 Percentage is a fraction of the screen space allocated for each column.
To modify a column's width:
1. OPTIONAL: Determine the scale type to use for the entire tabular report.
To toggle the scale of a column, click on the label to the right on the width
field where px equates to pixel and % equates to percentage.
2. Input or modify the column's Width value.
Notes:
1. When specifying a tabular report's column's widths in pixels, keep in mind the
average monitor resolution settings of the end-users viewing the report.
2. When specifying a tabular report's column's widths in percentages, keep in
mind that:
a. The sum total of the percentage values must not exceed 100%.
b. The application will use whatever percentage has not been allocated to
columns for the columns without a value.
Page 61
The Alignment option adjusts the position of values in columns. In the following
figure, numerical values are now centered in the Quantity column.
The Style option offers the ability to apply conditional formatting to a column's cell
based on a specific value or another column's value. Users must create the
condition and specify the formatting style. When more than one condition is
specified, the application will apply the style associated to the first condition that
is satisfied. Conditions are evaluated when the report is run.
Users can optionally apply the specified conditional formatting to all data columns
by checking the appropriate checkbox.
A conditional style takes the form of an equation similar to:
Label is Compared to Value
or
Label is Compared to Column
where Label represents a column name, Compared to represents a comparison
operator, Value represents a threshold, and Column represents another data
column.
Page 62
The available comparison operators are:







Equal to
Not equal to
Less than
Greater than
Less than or equal to
Greater than or equal to
Starts with 1







Does not start with 1
Ends with 1
Does not end with 1
Contains 1
Does not contain 1
Between
Not between
Notes:
1. These operators are only available for data type of type String or Text.
2. The operators available are dependent upon the column's data type.
To add a conditional Style:
1. Click or to access the Condition Styles dialog. In the figure below two
styles have been added and the Add a Condition panel opened to show
the various options in the dialog.
2. Click the Add a Condition button. In the panel are the Column, Operator,
Value and Style attributes.
3. Choose a Column from the drop-down menu to base the conditional
styling on.
4. Choose a comparison Operator from the drop-down menu.
Page 63
5. From the Value type drop-down menu, choose either Specific Value, Predefined Date, or Other Data Column.
6. Specify a threshold Value. If a Value type of:
a. Specific Value was selected, then type in a value or click the
icon to view and select a valid value from the database.
b. Pre-defined Date was selected, select a token (i.e., Today).
c. Other Data Column was selected, select a column from the
dropdown list.
7. Choose a Style from the dropdown list.
8. Click OK to add the styling condition.
9. Add more parameters by clicking Add a Condition and repeating the
steps above.
10. OPTIONAL: As styles are applied based on the first condition that is
satisfied, move a condition up or down in the list by clicking the
or
icon respectively.
11. OPTIONAL: Enable Add this style to all columns to apply the Style to all
columns of a row in the table.
12. Click OK to save the styling condition(s) and return to the Column
Configuration interface.
Notes:
1. Pre-defined dates get evaluated at the time the report runs.
2. If the value is a number, the value field must contain a valid number to
complete the comparison.
3. The icon indicates that a least one conditional style exists for that particular
column.
To modify or remove a conditional Style:
1. Click the icon to access the Style Details panel for a specific column.
2. From the Style Details panel:
a. If modifying a Style, click the icon associated to a specific Style's
condition. Modify the conditions as desired and then click OK to
save the condition.
b. If removing a Style, click the
icon associated to a specific Style's
condition.
c. OPTIONAL: Enable/Disable Add this style to all columns to
apply/remove the Style to/from all columns in the table.
3. Click OK to save the modifications and return to the Column Configuration
interface.
Page 64
Adding a new custom column to the data table
From the Column Configuration page, a new column may be added to the data
table by clicking on the Add Custom Column button. Columns created in this
manner may reference previously defined summary information.
In the example below, a percentage column (Pct Qty) has been created using the
Quantity column and the SumQty summary.
The sequence of events for this example was:
1. Click on the Add Calculated Column button on the Column Configuration
page
2. Click on the Quantity column from the Order Details data object
3. Click on the division symbol from the list of operators
4. Click on the SumQty summary from the Available Summaries (previously
created as a simple column summary and named SumQty)
5. Click on the multiplication symbol from the list of operators
6. Type 100.0 in the Definition text area
7. Type Pct Qty in the Name text box
8. Click on the OK button to save the result
Note: This type of calculated column may use reporting summary information in
the calculated column definition.
Note: If a data table contains a calculated column, the configuration grid will
display an Actions column. Clicking on the
icon allows the column to be
edited.
Page 65
Grouping Data
Ad Hoc provides two styles of grouped reports - Flat-Table and Drill-Down. The
grouped flat-table style organizes records into groups and hides duplicate entries
to make the grouped report more presentable. Use the flat-table style to give
other users the ability to export the complete report to different formats such as
PDF and Excel. The grouped drill-down style organizes records into groups and
any remaining columns are included in a sub-report. Use the drill-down style to
give other users the ability to hide and show sub-reports.
The feasibility of grouping data highly depends on the data source chosen for the
report. A grouped report is not necessarily appropriate when the data is simply a
list of customers. If the data source contains information about customers and
orders, a grouped report will definitely improve the presentation of the report. The
application provides two ways to group data for flat-table and drill-down style
reports - multiple grouping columns and multiple layers. Users can combine both
methods when creating grouped reports.
Multiple Grouping Layers
Creating grouped reports with multiple layers is useful in scenarios where the
report requires more than one grouping to organize all the data.
For example, all the customers can be grouped together, and then group by the
shipping company and then group by the order date. This scenario is illustrated
as a grouped flat-table report and as a grouped drill-down report in the following
figures.
A grouped flat-table report with three layers.
Page 66
A grouped drill-down report with three grouping layers.
Multi-Column Grouping
Multi-column grouping is useful for displaying more information on a single
grouping layer. For example, users can group by customer and then by shipping
company, showing both the customer and shipping company on the same layer.
Multiple grouping columns work well with flat-table style reports, since duplicate
entries are removed from the final report.
A grouped flat-table report with two grouping columns.
Page 67
Grouped Flat-Table
The grouping flat-table report style is useful for displaying the entire report in an
organized, presentable way.
In the following figure, the Customer Name column is the grouping column and
any row that contains a group is highlighted. All associated rows for a specific
group are displayed beneath the grouping row. Aggregated values for each
group are computed and displayed in a separate row.
A grouped flat-table report of customer invoices.
Page 68
Grouped Drill-Down
The grouped drill-down report offers viewers the ability to control the appearance
of the report by hiding and showing sub-reports for each record in the grouping
column.
In the following figure, the Customer Name column is the grouping column
(always the first column of the main report) and all other columns appear in the
sub-report. Users can show/hide sub-reports for each group of records by
clicking the hyperlink provided in the Details column. Any additional columns
included in the main report are aggregations of a particular column from the subreport.
A drill-down style report of customer invoices.
Note:
Users can disable drill-down functionality for the Details column or hide the
column completely.
Page 69
Grouping Layers
Creating and configuring a grouping layer:
1. PREREQUISITE: If grouping aggregates are to be defined, then the
column(s) to be aggregated must first be added to the report in the Table
Columns tab.
2. Click on the Grouping tab.
The Grouping tab with the Grouped Flat-Table style selected.
Note:
The Roll up last layer option is presented for the flat grouping. This allows the
user to create “summary” flat grouped reports where the non-aggregated
information is hidden from view. The data details that are normally shown in the
last grouping layer are excluded from the report.
3. Choose a grouping style (e.g., Flat-Table, Drill-Down) and then click Add
Grouping Layer to display the Grouping Columns dialog.
Page 70
4. Select a column(s) from the Available Columns list-box and then click to
move the column(s) to the Grouped Columns list-box. Hold the CTRL key
down to select multiple columns.
5. OPTIONAL: If a column(s) in the Grouped Columns list-box1 is not
desired, select the column(s) in the Grouped Columns list-box and then
click to move the column(s) back to Available Columns list-box . Hold
the CTRL key down to select multiple columns.
6. OPTIONAL: To move a column in the Grouped Columns list-box2 up or
down, select the column(s) and click the
or icon respectively.
7. OPTIONAL: If using the flat-table grouping style, enable the 'Insert a page
break between groups of PDF Export' option3.
8. OPTIONAL: Click OK to retain the modification and exit the panel or
continue configuring the other features on the grouping layer.
Notes:
1. The Grouping Layer dialog keeps track of the grouped columns used.
2. The order in which the columns appear in the Grouped Columns list-box
dictates the order in which the columns will appear in the report. This display
order over-rides that which is specified in the Column Configuration tab.
3. This feature is only offered on the first layer of a grouped flat-table. If the
Export to PDF feature is not used in the report, then enabling this feature will
not have any effect on the report.
Page 71
After having added columns to display in the tabular report and after having
selected a column(s) to group the layer on, group aggregates can be created.
To create a grouping layer aggregate:
1. From the Grouping Layer dialog, click the Add an Aggregate Column
button. If the button is not visible, click on the Show All Attributes icon at
the top of the dialog.
Grouping Columns dialog for a flat-table group
2. Choose a Column from the drop-down menu.
3. Choose an Aggregate function1, 2, 3 from the drop-down menu.
4. OPTIONAL: If using the grouped flat-table style, type a descriptive name
for the aggregate value in the Label field.
5. OPTIONAL: If using the grouped drill-down style:
a. Type a descriptive name for the aggregate column in the Header
field.
b. To include the column in the sub-report, enable the Include in subreport option.
6. OPTIONAL: If more than one aggregate has been specified in the
grouping layer, click the or icon to arrange the order in which the
aggregate will appear in the grouping column.
Page 72
7. OPTIONAL: Click
to remove a grouping aggregate.
8. OPTIONAL: Click OK to retain the modification and exit the panel or
continue configuring the other features on the grouping layer.
Notes:
1. For numeric values, choose aggregations like Sum, Average, Standard
Deviation, Count, Count Distinct, Minimum, or Maximum.
2. For text values, Sum and Average are excluded from the list of aggregate
functions. Choosing Minimum selects the first alphabetized entry and
Maximum selects the last.
3. For date values, Maximum chooses the latest date and Minimum chooses the
earliest.
Page 73
Group aggregates in a flat-table report.
Group aggregates in a drill-down report.
Page 74
When using the grouped drill-down style, the Grouping Layer dialog presents
different options.
Grouping Columns dialog for a drill-style group
The Summary Column Options are described in the following table.
Option
No summary
Behavior
The report is rendered without a Details column and no means
to drill-down to the sub-report.
Auto-generated column The report is rendered with a Details column
(drill-down enabled)
displaying a hyperlink with the count of the number
of detail records contained in the sub-report. The
hyperlink allows the user the ability to drill-down to
the sub-report. This is the default option.
Page 75
Auto-generated column The report is rendered with a Details column
(drill-down disabled)
displaying a count of the number of detail records
contained in the sub-report. Drill-down is disabled.
Grouping / Aggregate
The report is rendered without a Details column but displays
column
one of the columns used in the grouping layer (i.e., grouped
(drill-down enabled)
column or aggregate) as a hyperlink. The hyperlinked column
allows the user the ability to
drill-down to the sub-report.
When one of the auto-generated column display options is selected, the following
options may be applied to the summary column:
 The column's header label can be changed from 'Details' to something
more descriptive (i.e., Records, Accounts, Parts, Entries).
 The suffix text following a summary count can be changed from 'Rows' to
something more descriptive (i.e., Loans, Transactions, etc.). The suffix is
used in the group-level and overall summary row counts.
 A summary row may be included in the report with a caption (i.e., Total
Parts: ).
To configure a grouped drill-down's Details column options:
1. OPTIONAL: Choose a summary column display option. Refer to Error!
Reference source not found. for the explanation of the options.
2. OPTIONAL: If the summary column display option of 'Grouping /
Aggregate column' was selected, then choose a column from the dropdown menu.
3. OPTIONAL: If either one of the 'Auto-generated column' summary column
display options were selected, then:
a. Type an alternate Column header name for the summary column
in the field provided.
b. Type an alternate Suffix name for the summary hyperlink in the
field provided.
c. Enable the Include summary row for Summary column option
and type a descriptive Caption in the field provided.
4. OPTIONAL: Click OK to retain the modification and exit the panel or
continue configuring the other features of the grouping layer.
Page 76
Grouped drill-down report with customized Details column heading, suffix and summary row
The application supports an unlimited number of grouping layers for any single
report. Each layer can have multiple grouped columns, including any number of
group aggregates.
Grouped drill-down report with three grouping layers
On the first grouping layer, the option to display an “Expand All/Collapse All” link
in the report is presented. The link, as the name implies, will allow the user to
expand or collapse all drill levels of the report. Also on the first grouping layer,
the behavior of the initial display of the report can be set to “collapsed” (the
default) or “expanded”. The “expanded” option will cause the report to take longer
to render.
Page 77
To modify a grouping layer (all options):
1. Click on the Grouping tab.
2. Choose a different grouping style (e.g., Flat-Table, Drill-Down).
3. If more than one grouping layer has been defined, click the or
icon to
change grouping order in the report.
4. Click the icon associated to the grouping layer to be modified.
5. If modifying a grouped flat-table's first grouping layer, enable or disable
the 'Insert a page break between groups of PDF Export' option.
6. If modifying the lowest level grouping layer:
a. Move columns between the Available Columns list-box and the
Grouped Columns list-box by selecting the column(s) and clicking
the or icons to move the column from one list-box to the other.
b. Move a column in the Grouped Columns list-box up or down by
selecting the column(s) and click the
or icon respectively.
7. If the grouping layer contain an aggregate:
a. choose a different Aggregate function from the drop-down menu.
b. If using the grouped flat-table style, modify the Label.
c. If using the grouped drill-down style:
i. Modify the Header.
ii. Enable or disable the Include in sub-report option to
include or not include the column in the sub-report.
d. If more than one aggregate has been specified, click the
or
icon to arrange the order in which the aggregate will appear in the
grouping column.
e. Click
to remove the aggregate.
Page 78
8. If using the grouped drill-down style:
a. Choose a different summary column display option. Refer to Error!
Reference source not found. for the explanation of the options.
b. If the summary column display option of 'Grouping / Aggregate
column' was selected, then choose a column from the drop-down
menu.
c. If either one of the 'Auto-generated column' summary column
display options were selected, then:
i. Type an alternate Column header name for the summary
column in the field provided.
ii. Type an alternate Suffix name for the summary hyperlink in
the field provided.
d. Enable the Include summary row for Summary column option
and type a descriptive Caption in the field provided.
9. Click OK.
To delete a grouping layer:
1. Navigate to the Table component's Grouping panel.
2. Click the
icon associated to the grouping layer to be deleted.
Page 79
Table Settings
The Table Settings tab offers the ability to control the general characteristics of
the display table. It offers the ability to specify a table title and add paging
controls for large result sets. Interactive paging controls can be added for the
entire table as well as individual sub-reports in a drill-down style grouped table.
To modify a tabular report's table settings:
Click on the Table Settings tab.
The Title will be displayed above the display table in the generated report.
The Show Record Count option will display the number of rows returned at the
bottom of the report.
The Include row number option will display a row number in the first column of
the display table.
The Paging Style drop-down list will display the range of paging options. The
default option is “Interactive Paging”. Select “None” to remove the paging
controls from a report.
The Paging Location drop down list will display “Top”, “Bottom” and “Both”. This
allows the user to set the location of the paging controls on the report.
Page 80
The Rows Per Page and Rows Per Sub-Report Page attributes set the number of
rows displayed on the display table and drill reports, respectively. Headers and
summary rows are not considered in the number of rows per page. Only data
rows are affected by these attributes.
The Summary Row Location is normally at the bottom of the display table. It may
be set to the top of the display table just below the column headers.
Summary rows are typically displayed once at the bottom of the display table.
The Show Summary Row option may be set to repeat the summary row on each
page of the display table.
Drill Style grouped reports typically display the sub-reports within a minimum
space. The Table Width attribute allows the sub-reports to display in a larger,
fixed space. Set the Table Width to 100% to display drill-style reports across the
full page.
Page 81
CHAPTER 5
Crosstabs
Crosstab Configuration
Cross tabulation style reports give users the ability to display joint distributions of
data from three separate columns. The results of the cross tabulation are
displayed in table format. Every crosstab table consists of three columns.
Column Type
Header
Label
Values
Use in Crosstab Table
Populate the first row of the table. Each new value encountered in
the crosstab column produces a new column in the crosstab table.
Populate the first column of the table.
Populate the aggregate data. The aggregate values are a sum,
count, standard deviation or average of the fields in the Value
column.
A crosstab report displaying sales totals per employee across years.
Page 82
Users can also include crosstab summary data by adding an optional summary
row or summary column.
In order to build a crosstab, you only need to pick three columns, Header, Label
and Value, and decide how you want the value column be aggregated. These
selections can be made in the Crosstab Configuration tab, with minimum
attributes displayed.
You have many other options with the crosstab at your fingertips that you can
use if needed. All of these other options can be accessed either on Crosstab
Configuration page, with all attributes displayed, or on the Crosstab Settings tab.
Below, we will discuss how to create a crosstab with its minimum requirements
and later introduce the optional controls.
To add a simple Crosstab table:
1. From the Report Builder interface, click on the
in the Insert ribbon at
the top of the interface to add the Crosstab component to the report. Use
drag-and-drop methods to place the crosstab into the report in a specific
location in the Report Layout panel.
2. From the Crosstab Configuration panel's Header Values Column section,
choose a header Column from the drop-down list.
3. From the Label Values Column section, choose a label Column from the
drop-down menu.
Page 83
4. From the Values Column section:
a. Choose a value Column from the drop-down menu.
b. Choose an Aggregate Function1 from the drop-down menu.
Your crosstab table is ready at this point.
Note:
1. The available aggregate functions are Sum, Average, Standard Deviation and
Count.
Exploring the options
Click on the Show All Attributes icon to view the extended options on the
Crosstab Configuration tab.
If the Header column is a date column, a drop down list of time periods will be
displayed.
The options in the list include:
 None – display the date information in the header and aggregate the
values by date
 Year – display the year information and aggregate the values by year
 Quarter – display the first day of the quarter and aggregate the values by
quarter
 Fiscal Quarter – display the first day of the fiscal quarter and aggregate
the values by fiscal quarter
 Month – display the first day of the month and aggregate the values by
month
When all attributes are displayed on the Crosstab Configuration tab, the following
extra options are available for Label column:
Page 84
1. Header – This is the caption that is shown for the Label column on the title
row of the crosstab. It changes every time you select a new Label column
to reflect the name of the selected column. But you can change it to your
desired text.
2. Sortable1 – When checked, this option changes the header of the Label
column into a link that toggles the sort order of the crosstab rows by the
values in the Label column.
3. Linked – This option may or may not be available, depending on whether
the selected Label column has a pre-defined link associated with it or not.
4. Format – Allows you to choose a display format for the label column value.
5. Alignment – Sets a cell alignment for the label column values.
6. Add a Layer – Layering the Label column is an advanced function that
automatically generates drill-down capability for the crosstab Label
column. Read about it in the Adding Drill-down Capability to Crosstabs
section.
The following extra options are available for Value column:
1.
2.
3.
4.
5.
Page 85
Sortable – When checked, this option changes the header of the Value
column, if available (otherwise the link is put on Header column instead),
into a link that toggles the sort order of the crosstab rows by the values in
the Value column.
Format – Allows you to choose a display format for the Value column
values.
Alignment – Sets a cell alignment for the Value columns.
Style – Adds conditional styling to values. This feature is explained fully in
Conditional Styling of Crosstabs section, later.
Add Extra Value Columns – Displaying multiple Value columns in a
single crosstab table is an advanced feature that is described fully in
Adding Multiple Value Columns section.
1
The following options are available for adding a Summary Row:
1.
2.
3.
4.
Include – This checkbox adds or removes the Summary Row.
Caption – Type a caption, which describes the summary value.
Aggregate Function2 – Sets a cell alignment for the Value columns.
Format – Choose a display Format for the summary value.
The following options are available for adding a Summary Column:
1.
2.
3.
4.
Include – This checkbox adds or removes the Summary Column.
Header – Type a caption, which describes the summary value.
Aggregate Function3 – Sets a cell alignment for the Value columns.
Format – Choose a display Format for the summary value.
Page 86
Notes:
1. The default sort order of the Label and Header column values is dictated by
the sort order of the Data Source, however a crosstab is created dynamically
and may not reflect the expected sort order of the Label and Header. This is
particularly true when the data has missing information.
2. The available aggregate functions for Summary Row are: Sum, Average (of
crosstab rows), Standard Deviation, Count (of crosstab rows), Count Distinct,
Average of All Rows, and Count of All Rows.
3. The available aggregate functions for Summary Column are: Sum, Average
(of value columns), Standard Deviation, Count (of value columns), Average of
All Rows (used for the particular row of the crosstab pertaining to the
summary value), and Count of All Rows (used for the particular row of the
crosstab pertaining to the summary value).
Hint:
Crosstab tables can become quite long if there are a large numbers of distinct
values in the crosstab Label and Header columns. If such is the case, limit the
data by setting parameters on the data from the Data component's Parameters
step.
Page 87
Adding Drill-down Capability to Crosstabs
At times you may need to drill down to the details of a crosstab layer and find out
how the top level values came to be.
You can add as many layers to a crosstab as you need in a very easy manner.
Click on the Add a Layer button to display the following dialog.
Each layer consists of another crosstab table identical to the main layer, but with
a different Label column. It makes sense to pick a column that can serve as the
detail for the Label column in the layer right above it.
All available columns, except for those that have already been selected for the
previous layers, can be selected for this new layer.
Just like the main layer, a Header can be entered for this new Label Column and
it can be set as sortable and/or linked (if pre-defined as being linkable). Its format
and alignment can also be determined.
Page 88
Once a new layer has been defined, the default view of the Label Values Column
panel will change to a grid.
Layers can be moved up or down using and or by using drag-and-drop
methods using the handle. They may be edited using
and removed using
action icons.
Adding Multiple Value Columns
If more than one Value Column is needed under crosstab, additional columns
can be added by clicking the Add Extra Value Columns button. The following
Crosstab Value Column dialog will be displayed.
Page 89
The process is exactly like adding the first Value Column. The difference is in the
Header option, which is missing for the first Value column. However if multiple
Value Columns have been defined, each column can have its own header, which
will be displayed under the Header Column values.
Once a new Value Column has been defined, the default view of the Value
Column panel will change to a grid.
Value Columns can be moved up or down using or or by using drag-anddrop methods using the handle. They may be edited using
and removed
using
action icons.
Separate Summary Row and Summary Column functions, as well as Styles can
be defined for each Value Column by using respective icons in each row of the
grid. If either of these items has been defined, their icons will change to an “on”
state.
Page 90
Conditional Styling of Crosstabs
Conditional styling of crosstabs is very similar to that of a data table. The only
difference is that styles can only be set, as well as depend on Value columns.
Therefore the columns listed in the Column dropdown only consist of all
selections for Value columns.
The following figure shows the results of conditional styling of “Product Sales
Sum” to be red if the value is less than $5,000 and another green style set on
Product Sales Average to show as green if sales average is greater than $1,000.
Page 91
Linking from Crosstabs
If the administrator has set up links from any column that is used as the Label
column for the crosstab, the “Linked” checkbox appears in the Label Column
panel area. Since both links and drill-down are defined on the Label column, they
cannot co-exist. Therefore only last layer of a crosstab can be linked. A link can
be established to any other report or website. By checking Linked checkbox, the
link is automatically enabled and the resulting report displays its Label columns
as active HTML links that take you to the pre-determined report or web page,
passing any required parameters to the report or site.
This feature can be used in lieu of drill-down, in order to display a report other
than the detail crosstab report that is automatically generated by the application.
The following figure displays a linked crosstab that opens up Google Maps and
shows the map of the selected country, each time a country link is clicked on the
report.
Page 92
Crosstab Settings
The Crosstab Settings tab offers the ability to specify a crosstab table title and
add and configure interactive paging controls for large result sets.
To modify a crosstab's settings:
Click on the Crosstab Settings tab.
The Title will be displayed above the display table in the generated report.
The Paging Style drop-down list will display the range of paging options. The
default option is “Interactive Paging”. Select “None” to remove the paging
controls from a report.
The Rows Per Page and Rows Per Sub-Report Page attributes set the number of
rows displayed on the display table and drill reports, respectively. Headers and
summary rows are not considered in the number of rows per page. Only data
rows are affected by these attributes.
Page 93
CHAPTER 6
Charts
Chart Settings
The Report Builder charting components allow various types of charts to be built
to bolster a report. Charts provide a visual representation of data utilizing
different styles and types. The following chart types are supported in the
application:




Pie
Bar
Line/Spline/Area
Scatter
In addition, animated versions of these chart styles are available. Since animated
charts are not exportable, they are presented in a separate section of the
interface.
To add a chart to a report, click on the Insert tab to display the reporting
elements and click on the Chart option. The following chart select panel will be
displayed:
Page 94
The chart panel offers categories of charts down the left side and a scrollable
area on the right side with all of the basic charting options. Clicking on a category
of chart will reposition the panel to display the selected options. Click on the
desired chart type to add it to the report.
When a chart is added to a report definition, a tab called Chart Settings is
created with the appropriate attributes for the chart type. If multiple charts are
added there will be multiple Chart Settings tabs that follow the sequence of the
charts in the Report Layout panel.
The Chart Settings tab will appear similar to the following (Bar Chart example):
Notice that a bar chart image was added to the report layout area. The Chart
Settings tab, by default, displays the most common and minimum attributes
necessary to render a complete chart.
The
icon in the report layout panel will delete the chart when clicked.
The icon the report layout panel will present the chart selection panel and
allow a different chart type to be selected. To the extent possible, the attributes of
the current chart will be replicated in the replacement chart.
Page 95
Click on the Show All Attributes icon to display the advanced settings available
for the chart. Using the same example the Chart Settings tab will be redisplayed
as:
Notice the scroll bar down the right side of the Chart Settings tab. Scroll down to
view and set the advanced attributes for the chart.
Chart attributes are grouped according to functional area. Following are the
general areas that may apply to charts:











Label Column
Label (x-axis) Column
Label (x-axis) Scaling
Data Column
Data (y-axis) Column
Data (y-axis) Scaling
Legend
Relevance
Trend Line
Crosstab Column
Style
Note:
Not all charting attribute functional areas are available for all chart types. In
addition, attributes in each functional area may be different based on the chart
type selected and the data type of the selected columns.
Page 96
Three attributes are presented as stand-alone properties of the chart; Title, Show
Data Values, and Allow Resizing.
The Title attribute value will be displayed as a chart title over the displayed chart.
The Show Data Values attribute will include the numeric data values driving the
chart elements in the chart display. By default this attribute is enabled.
The Allow Resizing attribute will present resizing bars around the displayed chart
so that the end user can adjust the display.
Attribute Functional Areas
Label Column area – The Label Column area allows the user to select the
column to be used for a pie chart label. Data values will be aggregated based on
this column.
Label Column (x-axis) area – For X/Y charts, the Label Column area allows the
user to select the column to be displayed along the x-axis, specify the caption for
the x-axis and select the format.
If the Label Column for the x-axis is a date column, a drop down list of time
periods will be displayed (Apply Time Period). Data will be aggregated according
to the time period.
The options in the list include:
 None – display the date information on the x-axis and aggregate the
values by date
 Year – display the year information on the x-axis and aggregate the values
by year



Page 97
Quarter – display the first day of the quarter on the x-axis and aggregate
the values by quarter
Fiscal Quarter – display the first day of the fiscal quarter on the x-axis and
aggregate the values by fiscal quarter
Month – display the first day of the month on the x-axis and aggregate the
values by month
Label (x-axis) Scaling area – the user may override the default scaling of the xaxis by entering values for the Lower and Upper Bound attributes.
If the column used for the x-axis content is numeric, the Linear Numeric attribute
is available and if enabled will provide fixed numeric intervals along the x-axis.
If the column used for the x-axis content is date oriented, the Linear Time
attribute is available and if enabled will provide fixed time intervals along the xaxis.
Data Column area – The Data Column area allows the user to select the data to
be shown in the chart, select the format from the suite of numeric formats, and
select the aggregation function to be applied to the data.
Data Column (y-axis) area – For X/Y charts, the Data Column area allows the
user to select the column used for the data displayed along the Y-axis. In
Page 98
addition the user can specify a caption for the Y-axis, select a format for the data
values, select an aggregation function, and indicate whether the data values
should be displayed as a percentage.
Data (y-axis) Scaling area - the user may override the default scaling of the yaxis by entering values for the Lower and Upper Bound attributes.
Legend area – The Legend area allows the user to indicate whether a legend
should be displayed for the chart. For some chart types the user may also select
the legend position relative to the chart.
Page 99
Relevance area – a Relevance filter allows the user to specify data thresholds to
be included in the chart.
Enable/Disable a relevance filter by clicking on the Use Relevance Values
checkbox. Identify the relevance scale by clicking on either the Top N rows or
Percentage options. Enter the threshold value in the area provided.
For example, only the top 75% of data in the chart could be relevant. In this case,
check the Use Relevance Values checkbox, enter a value of 75 in the value field,
and click the Percentage radio button.
Alternatively, only the top 5 rows of data in the chart could be relevant. In this
case, enable the Use Relevance Values feature, enter a value of 5 in the value.
Trend Line area – the Trend Line area allows the user to indicate that a trend line
should be displayed on the chart.
Crosstab Column area – the Crosstab Column area allows the user to identify a
second column of data to be represented in the chart.
Page 100
Style area – the Style attributes allow the report designer the change the size
and spacing regarding the display element. Two examples of Style areas follow:
Pie Chart Style
X/Y Chart Style
The Size attribute drop-down list offers three standard sizes; small, medium and
large. Selecting one of the standard sizes will reset the other size attributes. If the
size attributes are over-ridden, the Size attribute will be set to Custom.
Color may be set by exercising the color wheel or selecting colors from the dropdown list, depending on the chart type.
Page 101
Definition of different areas of a chart have been described in the figure below.
CHAPTER 7
Interactive Data Views
The Interactive Data View (IDV) is an analysis tool included with the application,
and provides a versatile way to interact with data in a chart or table. The IDV
chart can display data in a table, pie chart, grid chart, line chart or area chart.
Use the IDV to perform quick calculations on the data or create "what-if"
scenarios by filtering columns out of the report.
Note:
IDV Charts require the Java Runtime Engine browser plug-in. The JRE can be
downloaded from http://java.sun.com/j2se/1.5.0/download.jsp.
Page 103
The Report Builder provides a wizard for configuring the IDV; however, most of
these settings only apply to the initial view of the IDV. The IDV is a highly
interactive and dynamic reporting component, and most of these options can be
changed after it loads in the browser.
Page 104
The Interactive Data View interface.
Filter the Crosstab and Label Columns:
The IDV provides the Label Selector and Crosstab Selector to dynamically filter
data presented in the data view. Select a single record or hold CTRL to select
multiple records. The IDV is updated each time a record is selected or removed.
Page 105
Find Data Values:
Move the cursor over an item in the label column to see all the corresponding
data values from the data column.
The data values for Leverling are displayed across the IDV.
Alternatively, an individual element can be selected to view its associated label.
Move the cursor across the chart to view individual data values.
Page 106
Scale the Chart:
The IDV chart is automatically scaled to view all records in the crosstab column
(x-axis). The crosstab column may contain hundreds of records, causing an
undesirable data view.
Sliding the horizontal scrollbar creates a more desirable data view.
The View menu provides other ways to dynamically change the way data is
displayed in the chart. Data can be presented in table form, chart form and
chart/table form. Other flexible view options include transposing the x- and yaxes, reversing the columns and restoring the initial order.
Page 107
Transpose the X- and Y-Axes:
Transposing the x- and y-axes swaps the label and crosstab columns.
The IDV allows the user to dynamically swap the label and crosstab columns
without modifying the chart from the Report Builder.
Page 108
Sort the Data Table:
From the Table view, users can sort records in the data column for each record
in the crosstab column.
Values for 1998 are dynamically sorted in descending order.
Click the column headers to sort the data in ascending or descending order.
Page 109
The Chart Type menu gives users the ability to visualize data using different
types of charts. Charts are either 2D or 3D and are one of the following:

Line

Clustered Bar

Stacked Bar

Stacked Area

Pie
Page 110
The Calculate menu provides several functions to perform calculations on the
IDV. The calculations available are:




























Original Data (restores IDV to original state)
Statistical Summary
Average
Column Average
Median
Maximum
Minimum
Sort Ascending
Sort Descending
Incremental % Change
Cumulative % Change
Percent of Maximum
Percent of Minimum
Percent Deviation from Mean
Percent Deviation from Column Mean
Absolute Deviation from Mean
Absolute Deviation from Column Mean
Percent of Total
Percent of Column Total
Add Multiple Datasets
Sum
Cumulative Sum
Normalize
Rank
Count
Count Distinct
Standard Deviation
Column Standard Deviation
Page 111
CHAPTER 8
Heat Maps
Heat maps are useful for giving business users quick views of large amounts of
data to find trends and anomalies at-a-glance. It would be very difficult to view
and comprehend information about 2,000 items in a pie chart; a heat map,
however, makes this possible. Heat maps can show relationships among
hundreds or thousands of items in hierarchies with rectangular spaces divided
into regions. Each region is divided again to correspond to each level in the
hierarchy. Business users easily interact with these hierarchical, colorful regions
to get more information.
The Map of the Market heat map of daily stock quotes by SmartMoney.
Heat maps are especially useful when an organization has numerous facts to
analyze, such as many sales regions, many manufacturing plants or hundreds of
product lines and wants to monitor the complex activities among those many
products, projects or salespeople.
Page 112
Heat maps are comprised of multiple cells that have a varying size and color.
Each cell has a specific label so that users can determine what each cell
represents. The size, color and label for each cell are determined by values from
three different points of data. In order to fully populate a heat map, select three
distinct data columns for the label, cell size and cell color.
A heat map displaying the number of orders and revenue received from each product.
A cell is created for each distinct product name in the ProductName column. The
size of the cell is determined by the corresponding value from the Revenue
column; larger values produce larger cells. The color of the cell is determined by
the value of the Order Count column.
Note:
Numeric data columns must be selected for the Cell Size and Cell Color
columns.
Page 113
The heat map color slider displays gradients of 3 different colors.
The Heat Map component also includes an interactive color slider that allows
dynamic modification to the gradients of three distinct colors that correspond with
values from the cell color column. The left color corresponds to low values, the
center color corresponds to middle values, and the right color corresponds to
high values. The gradients help establish the relationship each cell color value
has to another. In the example, the highest values will get the purest shade of
green. Slide the control to the left to single out the lowest value. Slide the control
to the right to find the cell with the highest value.
Page 114
CHAPTER 9
Style & Formatting
The application allows a header, custom labels and images to be added to a
report and the overall look and feel of the report to be configured (e.g., report
style, page size, print orientation).
Report Header
By default, a report header is included in the standard report template with the
Date and Time options enabled.
Default report header
Click
from the Insert ribbon to add the Header to a report. A Header tab
will be created. A report may only have one Header.
Header Information tab with Date and Time options not enabled.
Notes:
1. Since only one Header may be specified in a report, the
icon may be
disabled and appear as
.
2. If a Header is added without the Date and Time options enabled, then only a
report name will appear in the header.
3. The font and background colors of the header are dictated by the Report
Style selected (e.g., Classic) in Report Settings.
Page 115
Adding Labels
The Label component offers the ability to add custom messages and text in the
report. An unlimited number of labels above or below other reporting components
can be added. Use labels to add text to the report that would otherwise be too
long for a table or chart caption.
A bar chart with a red label beneath it.
Click
to add a Label to the report definition. Alternatively, use the dragand-drop method to place the label in the Report Layout panel. A corresponding
Label Information tab will be created.
Type the text for the Label in the field provided.
Page 116
Choose a Label Type from the drop-down menu where Simple always centers
the text and Full Width uses the full available width of the report.
OPTIONAL: Choose a text-style orientation from the Style drop-down menu (e.g.,
red, green, Align Text Left, etc.)..
Adding Images
The Image component offers the ability to add an image to the report layout. An
unlimited number of images above or below other reporting components can be
added. Use images to display a company logo, disclaimer or warning or to bring
emphasis to a new or updated section of a report. The image may be added to
the report from a file or via a URL. Image files must be 1 megabyte or smaller
and be one of the following file types: JPG, JPEG, GIF, BMP. Animated images
are supported.
A report with an image appearing before the tabular report.
Click
to add an Image to the report definition. An Image Information tab
will be created.
Choose a Source location to retrieve the image from. If File is selected then click
a “source” button. If the From My Computer button is clicked then click Browse
to locate and select a file from your computer1. When done, click OK. If the From
Server button is clicked then select an image and then click OK.
Page 117
If URL is selected then specify the URL path to the image and then click OK.
OPTIONAL: Choose an image-type2 orientation style from the Style drop-down
menu.
Image Information panel with a source file-type image selected.
Notes:
1. Images selected from your computer are automatically uploaded to the
application server for later use by all users.
2. Images require a specific style to align (e.g.,. Align Image Center). If one is
not available, contact the system administrator.
Page 118
Report Settings
The Settings ribbon offers the ability to control report paging and style by clicking
on the
or
icons, respectively.
The Printable Paging dialog appears as:
From this dialog the Page Size and Orientation may be modified. Page numbers
may appear in the displayed report based on the Show Page Number checkbox.
The available printable page sizes are:


Letter
Legal


Executive
A4

The Report Style dialog appears as:
Select a style from the dropdown list and click on the OK button.
A5
Page 119
CHAPTER 10
Export Options
The Export Options component allows links to be added to the bottom of the
report that give users the ability to publish reports. Reports can be printed from a
browser, exported to popular formats such as Excel and PDF, and added to the
archive for other users to view.
Click on the
report definition.
from the Insert ribbon to add the Export Options tab to the
Export capability is added to the report by enabling the individual export options.
Page 120
The below listed export options are available to report developers to provide to
the end user. None, some or all of the icons may be visible to the end user based
availability and user permissions.

Searchable Report

Printable Paging

Export to Excel

Export to Word

Export to PDF

Export to CSV

Export to XML

Add to Archive

Send Email
Notes:
1. Microsoft Office is integrated with Internet Explorer. Exporting the reports in
an Office format opens a new browser window to edit and save the report.
Microsoft Office is required to edit the reports from a browser window.
2. The various Export Options are available in the rendered report to users with
the respective Right to add the export option(s) to the report from the Report
Builder.
Page 121
Searchable Report presents the report in a single-page view. The CTRL-F
shortcut is then available to search the entire report overlooking pagination.
Printable Paging presents the report in a view that is suitable to print.
Export to Excel saves the report in Microsoft Excel format. If Microsoft Excel is
installed, the report can be edited as an Excel spreadsheet from the browser
window.
Export to Word saves the report in Microsoft Word format. If Microsoft Word is
installed, the report can be edited as a Word document from the browser window.
Export to PDF saves the report as a PDF (Portable Document Format), which
can be viewed with Adobe Reader and edited with Adobe Acrobat.
Export to CSV saves the report to a comma-delimited format. The file can be
viewed with Microsoft Excel.
Export to XML saves the report data in XML format. The XML dataset is viewable
from Internet Explorer.
Add to Archive saves a copy of the current report to the archive. Archiving is a
great way to backup a report before it is modified.
Send PDF Report by Email exports the report to PDF format and attaches it to
emails sent to selected recipients.
Note:
Archiving and XML exports are not always available when creating a new report.
Contact the system administrator for assistance with archiving and XML exports.
Page 122
Searchable Report
Searchable Report opens a new browser window, displaying the entire report on
one page.
Note:
Reports containing drill-down groupings will not be expanded.
Press CTRL-F to open the Find window in most of the popular Internet browsers.
Type the name of the record to search for and click Find Next to jump to the first
occurrence of that record.
The main difference between the Searchable Report view and the Printable
Paging view is how the webpage is configured for printing. Printing a report from
the Searchable Report view prints the entire report as one page, cutting off any
graphics or records as the report prints. Use Printable Paging to print reports
properly.
Page 123
Printable Paging
Printable Paging opens a new browser window formatted for printing, avoiding
the "cutoff" scenario that commonly occurs when printing web pages.
Note:
Reports containing drill-down groupings will not be expanded.
Page numbers are placed throughout the webpage indicating the portions of the report printed on
a particular page.
Note:
The progress of the page formatting will display in the lower left corner of the
browser window. It may take a few seconds to format a large report for printable
paging.
Click the print icon from the web browser to print the report.
Page 124
Export to Excel
Export to Excel opens a new browser window, displaying the report in Microsoft
Excel (spreadsheet) format.
Note:
Reports containing drill-down groupings will not be expanded when exported.
The report is exported to Microsoft Excel as a spreadsheet.
If Microsoft Excel is installed, the report opens as an Excel spreadsheet. Select
rows or columns for sorting, copying, pasting, etc., and perform many other
typical Excel functions.
Hint:
Click View > Toolbars to add standard Excel toolbars to the browser window.
Save the report in Excel format by clicking the File menu and choosing Save as.
Choose a name and location for the file and click Save.
Page 125
Export to Word
Export to Word downloads the report into a Microsoft Word document. A
temporary name is given to the file, with the Word file extension (.doc).
Notes:
1. Reports containing drill-down groupings will not be expanded when exported.
2. Due to a MS-Word limitation, if a report contains more than 50 columns, then
only the first 50 columns will be exported.
The report is exported to Microsoft Word format.
If Microsoft Word is installed, the report opens as a Word document. Edit the
report as a Word document or save the report unedited.
Hint:
Click View > Toolbars to add standard Word toolbars to the browser window.
Save the report in Word format by clicking the File menu and choosing Save as.
Choose a name and location for the file and click Save.
Page 126
Export to PDF
Export to PDF opens the report in the current browser window as a PDF
document viewable with Adobe Reader.
Note:
Reports containing drill-down groupings will not be expanded when exported. In
order to view PDF reports from the browser, the Adobe Acrobat Reader plug-in
must be installed. See the system administrator for additional help.
The report is exported to Adobe Portable Document Format.
The Adobe toolbar is displayed across the top of the report, providing many
typical PDF functions. Users can save, print and search the entire document.
Save the report in PDF format by clicking Save a copy from the Adobe toolbar.
Choose the name and location and click Save. The default file type is Adobe
PDF Files (*.pdf).
Page 127
Export to CSV
Export to CSV opens a new browser window and displays the report in commaseparated values within a spreadsheet (comma-delimited text file).
Note:
Reports containing drill-down groupings will not be expanded when exported.
Hint:
The CSV format is viewable by a variety of applications. It is best viewed by
spreadsheet, database, and text-editing applications.
The report is exported to CSV format and viewed by the Microsoft Excel browser plug-in.
Save the report in CSV format by clicking the File menu and choosing Save as.
Choose the filename and location and click Save. The default file type is CSV
(comma delimited).
Page 128
Export to XML
Export to XML opens a new browser window and displays all the data presented
in the report in XML (Extensible Markup Language) format.
The report data is exported to XML format and viewed by Internet Explorer.
Save the report data in XML format by clicking the File menu and choosing Save
as. Choose the filename and location, and then choose XML Files from the dropdown menu. Click Save to create the XML file.
Page 129
Add to Archive
Add to Archive creates a new copy of the current report in the associated
archive.
A copy of the Sales by Employee w/Unit Price Greater Than or Equal to report is added to the
archive
The date and timestamp are updated when the archiving footer link is clicked.
For this reason, the timestamp of the report at runtime may not match the
timestamp in the archive.
Page 130
Send PDF Report By Email
Send PDF Report by Email opens a form where the email can be composed and
recipients specified.
Manually enter an email recipient(s) or click the respective
icon to view and
select from a list of application users. Specify a Subject and message. When
done, click Send to send the email with a PDF version of the report attached.
Click Cancel to cancel this export action.
Notes:
1. The 'From' email address is defaulted to the email address specified in the
logged in user's Profile.
2. All fields except for Cc and Bcc are required.
Page 131
CHAPTER 11
Running Reports
The Report Management button displays the main page of the application.
A list of reports is available under the Personal Reports and Shared Reports
tabs. If no reports have been created, this list is empty.
Click the name of the report to launch it in a new browser window.
Any reporting components that reference the ShipCountry data column will show only orders
shipped to Mexico.
The figure above shows a field requesting a parameter value. Runtime
parameters are defined on the Select or Modify Data Sources dialog under the
Filter tab. Click on the Modify Data Source button to access the dialog. A default
value is chosen during the report-creation process and can be changed by the
user.
Page 132
Note:
Date values less than 01/01/1753 may not be specified.
There are two options for running the report.


Run and Hide Parameters - Run the report and hide parameter input box
Run - Run the report and leave parameter input box visible
Hint:
If the report contains numerous parameters, click Run and Hide Parameters to
provide more screen space for the report. Run the report again to input additional
parameters.
Run and Run and Hide Parameters affect the parameters for the report. Any
additional settings specified in the Report Builder are left intact.
Note:
Run and Run and Hide Parameters are only available by placing a check in the
'Ask' checkbox when defining parameters.
Cascading filter parameters produce one or more drop-down menus at runtime.
The value selected from the first drop-down menu is used to filter the second
drop-down menu and so on. The last parameter is selected from a list and
passed to the report when the user clicks Run.
Cascading filter parameters produce multiple, dependent drop-down menus.
Page 133
A drill-down report with a sortable Customer ID column.
The column header, Customer ID is displayed as a link. The heading link allows
the user to sort that column. The sort option was configured in the Column
Configuration panel of the Table component in the Report Builder.
Drill-down reports are created in the Grouping step of the Table wizard. The
Customer ID column is the grouping column and each record in the Details
column is a hyperlink. Clicking each link in the Details column reveals the subreport.
Export options always appear at the bottom of a report.
Export options give users the ability to export reports to popular formats such as
Microsoft Excel and Adobe PDF. Users can also search the report, print from the
browser and add the report to the archive. Add or remove export options through
the Report Builder.
Note:
The various export options will appear if the user viewing the report has Rights to
add the respective export option(s) to the report in the Report Builder.
Page 134
CHAPTER 12
Managing Reports
As reports are created in the application, it is important to learn how to organize
and manage them. This chapter focuses on the various actions a user can take
on each report. The application provides the following actions:









Modify Report/Folder
Rename Report
Copy Report
Move Report
Modifying Scheduling Information
Change Subscription to Report
View Archives
Modify Report in Web Studio*
View Dependencies
* Web Studio is not available in the Java version.
Some actions can be performed in batch mode by enabling the checkbox
adjacent each report or report folder. Users can perform the following actions in
batch mode:



Delete Reports/Folders
Copy Reports
Move Reports
Note:
Some of the actions listed above are not available to all users and/or all
reports/dashboards. Contact the system administrator if a particular action is
needed but not available.
Page 135
Organizing Reports
Users can create and store reports in the root folder or within an existing folder to
store reports. Administrators can create folders in the Shared Reports area,
which can be accessed by all users or limited to users based on the role(s)
assigned to the user.
To create a new folder to store reports:
1. Navigate to a report area (e.g., Personal Reports, Shared Reports) or
folder in which the new folder is to be created.
2. Hover the mouse over the Add button and select Folder from the list.
3. Type the name of the new folder into the Folder field
4. OPTIONAL: Type a description into the Description textbox.
5. OPTIONAL: As a designated administrator of a User Group and from the
Shared Reports area, specify restricted access to this folder based on a
user's role. By default, all roles have access to the folder. To limit access:
a. Select the Specific Roles option.
Page 136
b. Move roles between the Available Roles and the Roles With
Access list-boxes by double-clicking on the listed role or by
selecting the role and then clicking the (right) or (left) icon. At a
minimum, the roles currently assigned to the user creating the
folder must have access.
6. Click Save to create the new folder.
To modify a report folder:
1. Click the icon to modify the corresponding report folder.
2. As desired, modify the folder name and description in the provided fields.
3. OPTIONAL: As a designated administrator of a User Group and from the
Shared Reports area, specify restricted access to this folder based on a
user's role. By default, all roles have access to the folder. To limit access:
a. Select the Specific Roles option.
b. Move roles between the Available Roles and the Roles With
Access list-boxes by double-clicking on the listed role or by
selecting the role and then clicking the (right) or (left) icon. At a
minimum, the roles currently assigned to the user creating the
folder must have access.
4. Click Save to commit the changes.
Changes are reflected in the Name column and the Last Modified column is
updated to the current timestamp.
To delete one or more report folders:
1. Select the desired folder(s) by enabling its respective checkbox(es).
2. Click the Delete button.
3. Click OK to confirm the removal.
Note:
Deleting a report folder removes all reports stored within that folder. A backup
copy of deleted reports is stored in the ..\_Definitions\_Reports\_Backup
directory before they are removed from the application. Imported reports will be
deleted from being visible in the application interface but will not be deleted from
the _Reports directory.
Page 137
After creating a new report folder, move reports out of the root folder to make the
workspace more manageable.
To move reports into a folder:
1. To move a single report, hover the mouse over the icon and select Move
from the list of actions or select the report with the checkbox adjacent to
the report name and click on the Move button. Multiple reports may be
moved by selecting the reports and clicking on the Move button.
2. OPTIONAL: From the Organization drop-down menu, select a user group.
Organizations are not available by default. The administrator must have
specifically enabled the Organization capability and created multiple
organizations.
3. From the Destination Folder Type drop-down menu, select a folder type.
4. OPTIONAL: From the Folder tree, locate and select a folder to store the
report in.
5. Click Save to move the report.
Page 138
Scheduling Reports
The scheduling process is flexible and easy, offering the ability to deliver reports
via email in HTML format, attached in a document (e.g., PDF, Word, Excel, CSV)
or offering a link to the report in the archive directory on the server.
Scheduling reports is typically a two step process; 1) specification of when the
report is scheduled to run and 2) identification of who should receive it
(subscribers). From the Reports list page, the first time the Schedule action is
invoked the user can create the schedule. After a schedule has been created, the
Schedule action must be invoked a second time to get the list of schedules for
the report and subscribe users to the report.
Note:
Dashboards may not be scheduled.
Hint:
Contact the system administrator about being able to schedule reports.
To schedule a report, hover the mouse over the
the dropdown list.
icon and select Schedule from
If a schedule already exists for the report, the Schedules page will be presented.
Click on the Add button to create a new schedule for the report.
Click on the Delete button to remove selected schedules for the report.
Schedules may be selected by clicking on the checkbox adjacent to the
schedule(s).
Page 139
The Schedules list may be sorted by clicking on the Frequency or Schedule
column headers.
The three actions available for a schedule are Modify Schedule, Change
Subscription and Run Schedule. The Run Schedule option will not be presented
until subscribers have been added to the schedule or if the report has expired.
Hover the mouse over the
dropdown list.
icon and select the appropriate action from the
Some or all of the following options are available when scheduling a new report:
The Output Format determines how the report is delivered in the email. HTML
reports are embedded in the email and PDF, Word, Excel and CSV reports are
sent as attachments.
Reports can be added to the archive whenever the scheduler delivers the report.
If the report is added to the archive, the email contains a link to the directory
containing the archives. The report is not embedded or sent as an attachment
but rather saved to the archive directory.
The Add to Archive checkbox is only visible when archiving is enabled by the
System Administrator. If the Add to Archive checkbox is selected, the Output
Format will be set to the default archive format specified by the System
Administrator and the Output Format list will be disabled.
Page 140
The following options are presented in the Schedule Task list (with the default set
to Daily):




Once
Daily
Weekly
Monthly
As these options are selected, the subordinate gray dialog will either be hidden
or present options pertinent to the scheduling option selected. If “Once” is
selected, the gray dialog is hidden. Following are the respective dialogs:
The Start Time specified determines the time when the scheduler will run the
report. The hour and minute options are presented as drop-down lists.
The Start Date specified determines the initial date when the scheduler will run
the report. The date may be manually keyed in or populated from the calendar
control by clicking on the
icon.
Page 141
The End Date checkbox allows the user to let the report run indefinitely if
unchecked. If the option is checked, the option to specify a date to terminate
report execution is presented. Specification of the End Date is identical to the
process for the Start Date.
The Repeat Task option allows a report to be run repeatedly, beginning at the
Start Time and Start Date specified earlier. If the Repeat Task option is
exercised, the Interval and Duration for running the report may be specified. The
Interval determines the frequency and the Duration determines “for how long”.
Both values must be greater than 0, and the Interval value must be less than the
Duration value.
The initial scheduling page presented was for a report that did not require any
user input. Following is a schedule page for a report that expects user input when
it is run:
Since a scheduled report is run “unattended”, parameter values that would
normally be supplied by the user (called “Ask” parameters) must be set at the
time of scheduling. The scheduling page is adjusted to allow the specification of
Page 142
the parameter values to be used when the scheduled report is run. Notice at the
bottom of the schedule page a section labeled Report Input Parameters is
presented.
Reports may have multiple parameters defined. Every parameter requiring user
input must have values set. To set the values for a parameter, click on the
icon and a Parameter Details dialog will be presented.
Clicking on the “helper” icons such as the
and
(when the parameter is
date-based) may assist in selecting the values. Click on the Save Parameter
button to save the values to be used for the associated parameter when the
report is run.
When the scheduling options have been completed, click on the Save button at
the bottom of the page to save the information and create the scheduled task.
If the Subscribed Users list is not present, then no users have elected to receive
the report.
Subscribed users are listed at the bottom of the webpage.
Hint:
Test that the scheduled report is delivered as expected by first subscribing
yourself and then running the report from the Scheduled Reports grid. The speed
of delivery depends on the size of the report and the local network configuration.
Page 143
Sharing Reports
Reports can be copied to the Shared Reports area for all users to view.
Copying reports typically involves selecting the reports to be copied and clicking
on the Copy button. Single reports may be copied by clicking on the Copy action
from the dropdown list of available actions for a report.
The New Report Name should be entered and the Destination Folder Type of
Shared Reports selected. The option to select a folder within the Shared Reports
area may be presented.
Click on the Save button to save the reports in the new destination.
Notes:
1. When a report is copied, the report's name will be prefixed with Copy of (#) in
order to distinguish them from the original. The "(#)" will only occur after a
report is copied more than once.
2. An Expiration Date is used to designate when a time sensitive report is
deemed obsolete. The date must be a date greater than the current date.
3. Any corresponding report archives are not copied with the report.
Page 144
Modifying Reports
To modify a report or dashboard:
Reports and dashboards created in Ad Hoc can be modified using the Report
Builder and Dashboard Builder respectively.
To modify a report, hover the mouse over the
dropdown list.
icon and select Modify from the
To rename a report or dashboard:
To rename a report, hover the mouse over the
the dropdown list.
icon and select Rename from
Modify the Report Name, Description and/or Expiration Date.
Click on the Save button to save the changes.
Page 145
To delete one or more reports and the associated archives:
Select the desired report(s) and/or dashboard(s) by enabling its respective
checkbox(es). Click on the Delete button to remove the selected reports.
Click the OK button to confirm the removal.
Note:
1. Deleting a report or dashboard removes the report from the Reports list.
2. A copy of deleted reports and dashboards are placed in the
..\_Definitions\_Reports\_Backup directory. Imported reports will be deleted
from being visible in the application interface but will not be deleted from the
_Reports directory.
3. Archives associated to the deleted report(s) will be deleted according to the
setting specified by the System Administrator in the Application Settings
webpage.
Archiving Reports
Archiving reports gives users the ability to retain copies of a single report as the
report is changed over time. Reports created with a Logi Analytics tools are
interactive and dynamic - the report data may change depending on when the
report is executed or modified. A report archive stores copies of the report to
retain important data.
To add a report to the archive at runtime for report built with the Add to
Archive option:
1. Ensure that the Add to Archive checkbox is enabled in the Export Options
tab.
2. Run the report and click the Add to Archive icon at the bottom of the
report.
3. When the Reports list is refreshed, the View Archives action will be
available for the report.
Page 146
To view and manage an archived report:
To view archived reports, hover the mouse over the
select View Archives from the dropdown list.
icon for the report and
Click the Archive Date timestamp of the desired archive from the list to view the
report.
Click on the
to email the archived report.
Click on the Archived Date column header to sort the list.
Click on the Delete Archives button to remove the selected reports from the
archives. Archived reports may be selected by enabling the checkbox adjacent to
the Archive Date. Confirm the deletion by clicking on the OK button in the
confirmation dialog.
Page 147
Web Studio
* This feature is not available in the Java version.
For the more advanced user, Logi Web Studio is available to create Logi Info
based reports, modify imported reports and modify reports created in the Report
Builder.
Note:
Once a report is modified in Web Studio, it may no longer be modified using the
Report Builder.
To create a report in Web Studio:
1. Click the Open Web Studio button to launch the Web Studio interface.
2. From the Web Studio interface, click on the Reports folder and then using
the left-mouse button, select the "Add > New Definition…" menu option.
3. From the Web Studio interface, construct the report definition.
4. From Web Studio's menu bar, click the
icon in to save changes.
5. To exit the Web Studio interface and return to the application interface,
click on any control in the application's menu bars (e.g., Reports).
To modify a report in Web Studio:
1. OPTIONAL: If desiring to modify a report created using the Report Builder
which had never been modified in Web Studio before, then it is suggested
to make a copy of the report before proceeding.
2. To modify a report in Web Studio, hover the mouse over the icon for the
report and select Web Studio from the dropdown list.
3. Click OK to the "Are you sure…" warning message.
4. From the Web Studio interface, modify the report's definition.
5. From Web Studio's menu bar, click the
icon in to save the changes.
6. To exit the Web Studio interface and return to the application interface,
click on any control in the application's menu bars (e.g., Reports).
Hint:
Refer to the Logi Analytics Developers Network web site (a.k.a., Dev Net) at
http://devnet.logianalytics.com for general help on using Logi Studio. For more
specific help for a topic currently being used in Web Studio, click the
icon in
Page 148
the Information panel (lower left hand corner of the interface).
Page 149
View Dependencies
Ad Hoc allows the user to view the various dependencies for the reports. The
broad dependency categories are:




Firm dependencies – items on which the report depends
Loose dependencies – items that may be adjusted and still allow the
report to run
Firm relations – items that depend on the presence of the report
Loose relations – items that may need the report to be present
To view the dependencies report, hover the mouse over the
and select View Dependencies from the dropdown list.
icon for the report
A fully collapsed view of a dependency page:
Click on the
or the
icons to expand or collapse a report section.
Page 150
CHAPTER 13
Dashboards
Dashboards are created by adding and configuring different panels. A panel is
build with one of the following content types:




Pre-defined reports - Canned reports that provide a quick view of a
user's most:
o Frequently Viewed Reports
o Recently View Reports
Favorites - A user specified list of reports contained with a folder
accessible from the My Personal Reports page.
URL - Any valid URL the user has access to.
Reports - A user specified report accessible from the My Personal
Reports or Shared Reports pages.
Panels are organized into columns in the dashboard. A column may contain none
to many panels but as a minimum, a dashboard must contain at least one panel
to be saved.
The Dashboard Builder Panel Interface
The Dashboard Panel definition dialog
Page 151
To add a dashboard panel:
An unlimited number of panels can be added to a dashboard. The panels can be
configured to appear in the dashboard layout using panel settings and the panel
drag feature controls provided.
1. Click the Add button to view the Panel Settings panel.
2. Type a Name and Description for the panel in the fields provided.
3. Change the Initial Column value based on where the panel should appear
in the dashboard. The default value is 1.
4. Change the Initial Display setting based on:
 Yes - display the panel at initial viewing of the dashboard (default).
 No - do not display the panel at initial viewing of the dashboard.
Note:
If Initial Display = No, then the user has the option to add the panel via the
Change Dashboard option within the dashboard viewer.
5. Adjust the panel Height. Default value is 300 pixels. The value range of
possible settings is 10 to 5000 pixels.
6. Select the Panel Content type (default is Report).
7. Specify the report, folder or URL in the field provided.
a. If Pre-defined reports, then select one of the listed reports and click
OK.
b. If Favorites, then locate and select a Personal Reports folder and
click OK.
c. If URL, then specify a URL address. Click Test URL to confirm that
the URL can be viewed.
d. If Reports, then locate and select a report located in the Personal
Reports or Shared Reports.
8. Click Save Panel and return to the Dashboard Builder interface.
9. If the dashboard had not been previously saved, then type a name for the
dashboard in the field provided.
10. Rearrange panels as necessary with the up/down arrows
11. Click Save to store the dashboard.
Hint:
The dashboard may be previewed at any time by clicking Preview Dashboard,
as long as the Panel Settings panel is not being viewed.
Page 152
To modify a dashboard panel:
1. Hover the mouse over the icon for the report and select Modify
Dashboard Panel from the dropdown list.
2. Modify the panel as desired.
3. Click Save Panel and return to the Dashboard Builder interface.
4. If the dashboard had not been previously saved, then type a name for the
dashboard in the field provided.
5. Click Save to store the dashboard definition.
To delete one or more dashboard panels:
1.
2.
3.
4.
Select the desired panel(s) by enabling its respective checkbox(es).
Click the Delete button.
Click OK to confirm the removal.
If the dashboard had not been previously saved, then type a name for the
dashboard in the field provided.
5. Click Save to store the dashboard definition.
Note:
At least one dashboard panel must exist in order to save the dashboard.
Page 153
To modify a Dashboard's Settings:
Click on the icon for the Dashboard Settings to expand the page and allow
general dashboard appearance to be customized.
The Dashboard Settings panel, offers the ability to configure a dashboard's
general appearance and provide an optional description. A panel's appearance is
controlled by the selected Dashboard Style, which gives the dashboard a specific
"look and feel". The available dashboard styles are:





(None)
Classic
Gray
Harmony
LemonLime





Light
Mocha
Nature
Ocean
Professional



RedWine
Technical
Tropical
Notes:
1. The system administrator may add additional Dashboard Styles to this list.
2. The Dashboard Style will not control the appearance of any of the reports
viewed in a panel.
As necessary, specify or modify the Description, Dashboard Expiration Date and
header content.
Click the icon for the Dashboard Settings collapse/hide the Dashboard
Settings panel.
Note:
The description appears under the dashboard's name in the Reports list in the
Personal Reports and Shared Reports areas.
Page 154
CHAPTER 14
Multiple Data Sources
Most Ad Hoc reports rely on a single data source. All of the display elements
(display tables, crosstabs, and various charts) in the report would display data
from that source. Logically this makes sense because analytical reports are
typically used to make a point, tell a story, or reveal information about the data.
Ad Hoc is initially configured to accept data from a single data source; however, if
the System Administrator discovers that reports need to reflect data from
disparate data sources they can configure Ad Hoc to allow the end user to
identify multiple data sources for a report.
Note:
In prior versions of Ad Hoc, the concept of report “Sections” accomplished this
goal. This concept has been replaced by design. “Sections” of reports no longer
exist.
If the System Administrator enables the “Multiple Data Sources” option, the
Select or Modify Data Source dialog changes for all users as well as the Data
Sources panel.
To create a new data source, click on the Modify Data Source button. The
Select or Modify Data Source dialog is presented.
Page 155
The dropdown list of data sources will appear at the bottom of the dialog along
with a Save as New button. Select the data objects for the new data source from
the data objects tree and click on the Save as New button. Enter a name for the
data source in the Save as New dialog and click on the OK button to confirm it.
The Data Sources panel will reflect the new data source by having an entry in a
dropdown list in the header of the Data Sources panel. This dropdown list may
be used to assign a data source to a display element.
As data sources are selected from the dropdown list, the tree displayed in the
panel content will be refreshed.
Every data-oriented display element in the report needs a data
source. As they are added to the report definition, they will assume
that the currently selected data source is to be used.
Page 156
CHAPTER 15
Mobile Reports
Users have the ability to create mobile reports from Ad Hoc. These reports are
defined through the Ad Hoc Report Builder interface just as regular reports are
defined.
There are a few limitations in the report definitions. Mobile reports are not
permitted to contain:





A Header element
Export options
The IDV element
The Heatmap element
Animated Charts
Note:
Regular reports can be either converted to mobile reports or copied and
converted to a mobile equivalent. If, during editing, the mobile option is selected
the user will be prompted to remove all of the above elements before the report
can be saved as a mobile report.
Note:
If a scheduled report is converted to a mobile report, all schedules for the report
will be removed when the report is saved.
Note:
Mobile reports may only be linked to other mobile reports. Links to normal reports
will be removed when a mobile report is saved.
Note:
The System Administrator must enable the Mobile Reports option for nonadministrative users by including the associated right in one of the user’s roles.
Without the right the mobile mode option is not presented to the user.
When accessing mobile reports through a mobile device, the user may only view
the report. Users cannot create, modify, copy, rename or delete a report from
their mobile device. In addition, some home page considerations are basically
ignored and the user is taken to the most logical report list based on their current
home page settings.
Page 157
The mobile device will only display the mobile reports and folders that contain
mobile reports.
Only the Personal, Shared and Global reports areas are available from the
mobile device.
Mobile reports are identified in the reports list with an
the user would see:
icon. From a reports list
Page 158
Working with the Mobile option
The Ad Hoc Report Builder interface offers a Mobile icon that toggles the mobile
mode for the building and validation of a mobile report.
The
icon indicates that the mobile mode is enabled. When the mobile mode
is enabled the Insert and Settings ribbons will only show the display elements
relevant to a mobile report.
Other differences between the normal and mobile mode include:



The
The default Paging Style on the Table Settings and Crosstab Settings tabs
is set to “Append Rows” for mobile mode and “Interactive Paging” for
normal mode.
Pixel widths for columns in mobile mode are removed. The table width is
set to 100%.
A resizer element is automatically added to display elements in mobile
mode.
icon indicates that the normal (non-mobile) mode is enabled.
Page 159
CONTACT US
For more information about other Logi Analytics products or assistance beyond
this user manual, please contact Logi Analytics in the following ways:
Corporate Headquarters
Phone:
1-888-564-4965
(703) 752-9700
Fax:
(703) 995-4811
Email:
[email protected]
Address:
7900 Westpark Drive, Suite A200
McLean, VA 22102
Web Site:
www.logianalytics.com
Sales Department
Phone:
1-888-564-4965
(703) 752-9700
Email:
[email protected]
Customer Support
Phone:
1-888-564-4965
(703) 752-9700
Link:
http://www.logianalytics.com/support/
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