Business objects DASHBOARD BUILDER 3.0 FOR WINDOWS User Manual

BusinessObjects Dashboard Builder User Guide

BusinessObjects Dashboard Builder 3.0

Windows

© 2008 Business Objects. All rights reserved. Business Objects owns the following U.S. patents, which may cover products that are offered and licensed by Business Objects: 5,555,403; 5,857,205; 6,289,352; 6,247,008; 6,490,593; 6,578,027; 6,831,668; 6,768,986; 6,772,409; 6,882,998; 7,139,766; 7,299,419; 7,194,465; 7,222,130; 7,181,440 and 7,181,435. Business Objects and the Business Objects logo, BusinessObjects, Business Objects Crystal Vision, Business Process On Demand, BusinessQuery, Crystal Analysis, Crystal Applications, Crystal Decisions, Crystal Enterprise, Crystal Insider, Crystal Reports, Desktop Intelligence, Inxight, the Inxight Logo, LinguistX, Star Tree, Table Lens, ThingFinder, Timewall, Let there be light, Metify, NSite, Rapid Marts, RapidMarts, the Spectrum Design, Web Intelligence, Workmail and Xcelsius are trademarks or registered trademarks in the United States and/or other countries of Business Objects and/or affiliated companies. All other names mentioned herein may be trademarks of their respective owners.

Third-party Contributors

Business Objects products in this release may contain redistributions of software licensed from third-party contributors. Some of these individual components may also be available under alternative licenses. A partial listing of third-party contributors that have requested or permitted acknowledgments, as well as required notices, can be found at: http://www.businessobjects.com/thirdparty

Dashboard Builder 9Chapter 1

About this document..................................................................................10

Dashboards 11Chapter 2

My Dashboard...........................................................................................13

Corporate Dashboards..............................................................................13

Configuring dashboards.............................................................................13

Analytics in dashboards.............................................................................24

Creating a corporate dashboard..........................................................13

Configuring a dashboard tab or sub tab...............................................15

Adding tabs and sub tabs to dashboards.............................................16

Modifying the layout in a dashboard....................................................17

Renaming a dashboard tab or sub tab.................................................20

Moving dashboard tabs and sub tabs..................................................21

Copying a corporate dashboard, tab or sub tab...................................21

Deleting a dashboard, tab or sub tab...................................................22

The analytic toolbox in the dashboard edit mode and in the Compound

analytic.................................................................................................22

Dashboard properties...........................................................................23

Analytics and dashboards....................................................................24

Adding analytics to dashboards...........................................................25

Expanded toolbar actions on analytics.................................................26

Configuring the Crystal Report appearance in a dashboard................26

Configuring the Web Intelligence report appearance in a dashboard...28

Using a Navigation List on a dashboard tab........................................28

The Viewer analytic in dashboards......................................................30

BusinessObjects Dashboard Builder User Guide 3

Contents

Using analytics for analysis 33Chapter 3

Analytics based on a single metric or goal................................................34

What is a universe query?.........................................................................34

Data for universe queries.....................................................................34

Defining a universe query for an analytic.............................................35

Defining a filter for analytics that use universe queries........................35

Defining the display data for a universe query in the Bubble, Pie and

Radar analytics.....................................................................................36

Analytic display modes..............................................................................37

Creating an analytic...................................................................................39

Creating an analytic via Dashboard Builder.........................................40

Creating an analytic via InfoView.........................................................40

Creating an analytic based on an existing analytic..............................41

Data sources for analytics....................................................................41

Editing an analytic......................................................................................42

Linking analytics and documents...............................................................43

Linking from goal, universe query and metric-based analytics..................43

Linking to multiple documents from an analytic based on a goal, metric

or universe query..................................................................................43

Linking from a goal, metric or universe query-based analytic to a document

or analytic.............................................................................................45

Using variables for dynamic links to documents..................................46

Sending information to the Viewer analytic in a dashboard using

openAnalytic.........................................................................................90

Emailing an analytic...................................................................................91

Downloading an analytic............................................................................92

Deleting an analytic from an InfoView folder.............................................93

Saving an analytic to a folder.....................................................................93

Saving an analytic as a document.............................................................94

Analytics that can be created in Dashboard Builder..................................95

4 BusinessObjects Dashboard Builder User Guide

Contents

Dashboard Builder Analytics................................................................95

Data Exploration analytics based on metrics, metric prompts and universe

queries................................................................................................112

Goal and strategy analytics in Performance Manager.......................130

Process Analysis Control Chart analytics..........................................177

Alerts analytic based on Performance Manager rules.......................226

Predictive Analytics based on predictive models...............................229

Set Analytics.......................................................................................251

Tools...................................................................................................268

Dashboard Builder Scheduler 273Chapter 4

Viewing scheduled tasks in Scheduler....................................................274

Managing scheduled tasks in Scheduler............................................274

Adding a scheduled task in Scheduler....................................................276

Scheduling a metric refresh in Scheduler..........................................276

Scheduling a set refresh in Scheduler...............................................277

Scheduling a Predictive model refresh in Scheduler..........................278

Scheduling an analytic refresh in Scheduler......................................278

Scheduling a control chart refresh in Scheduler................................279

Creating a scheduled task in Scheduler..................................................279

Run object in a scheduled event task................................................280

Setting the destination in a scheduled task in Scheduler...................281

Sending personalized data in analytics to individual recipients.........282

Server.................................................................................................284

Events................................................................................................284

Dashboard and analytic applications 285Chapter 5

What is Dashboard Builder?....................................................................286

What is Performance Manager?..............................................................286

What is Predictive Analysis?....................................................................286

BusinessObjects Dashboard Builder User Guide 5

Contents

What is Process Analysis?......................................................................287

What is Set Analysis?..............................................................................287

Analytic Catalog in Dashboards and Analytics 289Chapter 6

Analytics in the Analytic Catalog.............................................................290

Metric analytics in the Analytic Catalog...................................................290

Sample trend analysis analytics.........................................................290

Sample comparison analytics.............................................................293

Sample deviation analytics.................................................................296

Statistical analytics in the Analytic Catalog.............................................299

Sample forecast analytics..................................................................299

Sample correlation analytics..............................................................302

Sample projection and distribution analytics......................................304

Set analytics in the Analytic Catalog.......................................................305

Membership breakdown.....................................................................305

Migrants compare...............................................................................305

Migration by tier..................................................................................306

Multi set scatter..................................................................................306

Percent of group total.........................................................................306

Percent of enterprise..........................................................................307

Set compare.......................................................................................307

Set vs enterprise................................................................................307

Set vs group average.........................................................................307

Set vs group total growth....................................................................308

Set vs group turnover.........................................................................308

Predictive analytic samples in the Analytics Catalog...............................308

Process control analytics in the Analytic Catalog....................................309

Process Control Analytics (Samples).................................................309

Process Control Analytics..................................................................315

6 BusinessObjects Dashboard Builder User Guide

Contents

Dashboard Builder Terms 317Chapter 7

Aggregation functions..............................................................................318

What is arithmetic mean?...................................................................318

Average functions...............................................................................318

Count functions..................................................................................318

What is geometric mean?...................................................................318

What is harmonic mean?....................................................................319

What is a median?..............................................................................319

What is maximum?.............................................................................320

What is minimum?..............................................................................320

What is population kurtosis?..............................................................320

What is population skew?...................................................................321

What is population standard deviation?.............................................321

What is population variance?.............................................................322

What is sample kurtosis?...................................................................322

What is sample skew?........................................................................322

What is sample standard deviation?..................................................323

What is sample variance?..................................................................323

What is sum?......................................................................................323

What is sum distinct?.........................................................................324

What is an alert?......................................................................................324

What is an analytic?.................................................................................324

What is a metric?.....................................................................................324

Moving averages explained.....................................................................325

What is the moving average?.............................................................325

Moving average transformations........................................................325

What is single exponential smoothing?..............................................328

BusinessObjects Dashboard Builder User Guide 7

Contents

Get More Help 329Appendix A

Index 333

8 BusinessObjects Dashboard Builder User Guide

Dashboard Builder

About this document

Dashboard Builder is a BusinessObjects Dashboard and Analytics application that helps you manage and track your company's performance using analytics and dashboards, as well as schedule the refresh of metrics, sets, control charts, Predictive models and analytics.

This documentation helps you to:

• Learn about analytics and dashboards

• Create a dashboard or analytic

• Schedule a refresh

Related Topics

• What is Dashboard Builder? on page 286

• Dashboard and analytic applications on page 285

• What is an analytic? on page 324

• Dashboards on page 11

• Creating a corporate dashboard on page 13

• Creating an analytic on page 39

• Adding a scheduled task in Scheduler on page 276

About this document

The Dashboard Builder User Guide provides information on creating analytics and dashboards using Dashboard Builder, a Dashboard and Analytics application. In addition, you use Dashboard Builder to create alerts, calendars and much more.

10 BusinessObjects Dashboard Builder User Guide

Dashboards

My Dashboard

Dashboard Builder is the Dashboard and Analytics application that allows you to create dashboards that provide visibility to your business activities across your organization. Dashboard Builder offers metrics, alerting and dashboard management capabilities to help your organization monitor and understand business activities.

Dashboards can include the following:

• Analytics

• Web Intelligence, Xcelsius and Desktop Intelligence documents

• Crystal Reports

• Adobe Reader PDF documents

• Microsoft Excel spreadsheets

• Microsoft Word documents

• Text files

• Rich text (rtf) files

• Microsoft Powerpoint presentations

• Hyperlinks

You can create, customize and view the following types of dashboards:

• Corporate dashboards

Corporate dashboards contain analytics created either via InfoView or in the corporate dashboards menu for public viewing. A corporate dashboard can have several tabs and sub tabs.

• Personal dashboard tabs in "My Dashboard"

My Dashboard stores your personal dashboard tabs, which can contain personal analytics and corporate analytics whose parameters you can to some extent modify for your view only. A personal dashboard can contain one or more tabs.

Note: You cannot copy My Dashboard tabs into corporate dashboards, nor

can you copy corporate dashboard tabs or sub tabs into My Dashboard. However, you can use the same analytics and objects in all of them.

Related Topics

• Creating a corporate dashboard on page 13

• My Dashboard on page 13

12 BusinessObjects Dashboard Builder User Guide

My Dashboard

"My Dashboard" is your location in which to build personal dashboard tabs that offer strategic information at a glance. You can:

• structure "My Dashboard" to follow any management or process

methodology.

• include corporate dashboard analytics to which you have access.

Corporate Dashboards

Corporate dashboards share vital information across a large community or to specific groups of people. Corporate dashboards can be easily adapted to fit management and information-sharing philosophies.

Are corporate dashboards secure?

Some ways to control access to data in a corporate dashboard:

• At the folder level: Corporate dashboards are stored in the InfoView

"Public Folders". Administrators can limit access to a folder in the folder's access settings or in account settings for individual users or user groups.

• Via user rights: Only those with specific edit rights can edit corporate

dashboards.

• Access to universe data: In Designer, you set security access rights to

the entire universe or sections of the universe.

Dashboards

My Dashboard

Configuring dashboards

Creating a corporate dashboard

A good dashboard can inform and motivate, as well as define strategies.

1. Gather the following information:

• A list of the information that you want the dashboard or dashboard tab

to transmit. If you are creating a corporate dashboard, analyze your audience to determine the information they need. If you have a lot of

BusinessObjects Dashboard Builder User Guide 13

Dashboards

Configuring dashboards

information, consider creating categories of information and creating a tab in the dashboard for each category.

• A list of the content that you want to use. Analytics can include

speedometer gauges, strategy maps, Web Intelligence or Desktop Intelligence reports or Crystal Reports.

• A rough sketch of how you want to organize analytics on the dashboard

tabs and sub tabs. More information is not always best, and a cluttered, crowded dashboard is counter-productive.

• A list of data security issues for corporate dashboards: What data is

appropriate for your audience? How much detail do you want for them to see?

2. Do one of the following:

• In InfoView, do one of the following create a corporate dashboard:

• Click Open > Dashboard and Analytics then the new link under

"Corporate Dashboards".

• Click Dashboards > Create Corporate Dashboard.

• Click Document List > New > Corporate Dashboard.

Note: Anyone who has access to corporate dashboards can see the

changes you make.

3. Type a name for the corporate dashboard.

4. Specify the folder in which you want to save the dashboard.

Save personal dashboards to your personal folders and corporate dashboards to a folder in "Public Folders".

5. Select a category.

6. Click OK.

7. To edit the dashboard, click Edit dashboard.

8. Click one of the following:

• Save to apply the new definition or changes you made.

• Cancel to cancel any changes entered and return to the previously

saved version.

• Exit Edit Mode to leave the edit mode. If you did not save your

changes, the modifications made since the last Save action are cancelled.

Related Topics

• Configuring a dashboard tab or sub tab on page 15

14 BusinessObjects Dashboard Builder User Guide

• My Dashboard on page 13

• Corporate Dashboards on page 13

• Adding tabs and sub tabs to dashboards on page 16

• Dashboard properties on page 23

Configuring a dashboard tab or sub tab

The following process applies to:

• "Corporate Dashboards" tabs and sub tabs

• "My Dashboard" tabs

1. In My Dashboard or Corporate Dashboards, select the dashboard tab or

sub tab that you want to edit.

2. Click Edit Dashboard.

The edit toolbars for the dashboard objects and the Analytic Toolbox appear.

Note: You can only edit corporate dashboards if you have the appropriate

edit rights, or if the corporate dashboard is one that you created. If you edit a corporate dashboard, the changes are visible to everyone viewing it.

Dashboards

Configuring dashboards

3. To configure the properties click the arrow next to the dashboard, tab or

sub tab title and select Properties.

4. Select the layout style.

The "Analytic Toolbox" appears.

5. In the "Analytic Toolbox", select and drag analytic objects to the layout

area. Resize and fit them according to the preferred dashboard design.

Note: Analytics that you drag into and edit in the dashboard tabs are

saved on the Central Management Server (CMS) as part of the dashboard. Analytics created via InfoView using Dashboard Builder are saved as independent InfoObjects on the CMS.

6. Add tabs or sub tabs to the dashboard as necessary.

7. Click one of the following:

• Save to apply the new definition or changes you made to the

dashboard.

BusinessObjects Dashboard Builder User Guide 15

Dashboards

Configuring dashboards

• Cancel to cancel any changes entered in the dashboard and return

to the previously saved version.

• Exit Edit Mode to leave the edit mode. If you did not save your

changes, this action cancels the modifications made since the last Save action.

Related Topics

• Adding tabs and sub tabs to dashboards on page 16

• Modifying the layout in a dashboard on page 17

• Creating a corporate dashboard on page 13

• The analytic toolbox in the dashboard edit mode and in the Compound

analytic on page 22

• Dashboard properties on page 23

Adding tabs and sub tabs to dashboards

You can add as many tabs to a personal dashboard and add as many tabs and sub tabs to corporate dashboards as you need.

This process applies to tabs in "My Dashboard" and tabs and sub tabs

"Corporate Dashboards".

1. In "My Dashboard" or a corporate dashboard, click Edit Dashboard.

2. Do one of the following:

• To create a "My Dashboard" tab, click Add a new tab.

• To create a "Corporate Dashboards" tab or sub tab, click Add a

new tab.

A cursor appears.

3. Type a name and press Enter.

You can change the name at any time in edit mode by clicking the arrow next to the tab name and selecting Rename.

4. Configure the tab or sub tab.

5. Click Save to save your edits.

6. If you are done modifying the dashboard, click Exit Edit Mode.

Related Topics

• Configuring a dashboard tab or sub tab on page 15

16 BusinessObjects Dashboard Builder User Guide

Modifying the layout in a dashboard

This process applies to dashboard tabs and sub tabs in My Dashboard and Corporate Dashboards.

• In the dashboard you are editing, select the layout style:

• To place objects on a dashboard without using any specific layout

format, select the "Freeform" layout.

• To use a pre-defined layout, select the "Template" layout. You can

select column, row, or a mixed column/row layout.

• To construct a column-structured dashboard, select the "Docking"

layout.

Note: When you change the layout of a dashboard that contains analytics,

the analytics are rearranged to fit the new layout mode.

Related Topics

• Configuring a dashboard tab or sub tab on page 15

• Configuring the display options of a dashboard analytic on page 20

• Working with a dashboard or Compound analytic in Freeform layout mode

on page 17

• Modifying a dashboard in Template layout mode on page 18

Dashboards

Configuring dashboards

Working with a dashboard or Compound analytic in Freeform layout mode

The "Freeform" layout mode allows you to place objects in a dashboard tab or sub tab or Compound analytic without using any specific layout format. In the "Freeform" mode, you can use the grid options to align objects.

1. In the dashboard or Compound analytic edit mode, select Freeform from

the "Layout" list. The "Analytic Toolbox" appears on a blank layout area. Click Toolbox

to deactivate or activate the "Analytic Toolbox".

Note: If you switch to "Freeform" from another layout mode, any objects

on the layout area remain in their original positions.

2. To activate a grid, select from the "Grid size" dropdown list one of the

following grid sizes:

BusinessObjects Dashboard Builder User Guide 17

Dashboards

Configuring dashboards

Small•

• Medium

• Large

When you select a grid size, grid lines appear on the layout area. If you do not want a grid, select None.

3. Activate Snap to grid to make objects in the layout area adhere to the

grid lines.

4. To select objects, drag them from the "Analytic Toolbox" to the layout

area. You can resize and move the objects.

5. When you are done working on the layout, do the following:

• If you are creating a dashboard tab or sub tab, click Save.

Note: If at any time during the process you decide that you do not

want to keep the dashboard changes as of the last save action, click Cancel. The dashboard appears in view mode without the modifications.

• If you are creating a Compound analytic, click OK.

Related Topics

• Expanded toolbar actions on analytics on page 26

• Adding analytics to dashboards on page 25

• The analytic toolbox in the dashboard edit mode and in the Compound

analytic on page 22

• Adding tabs and sub tabs to dashboards on page 16

• Configuring the display options of a dashboard analytic on page 20

• Compound analytic on page 268

Modifying a dashboard in Template layout mode

The Template layout mode offers several layout formats for dashboard objects.

1. In the dashboard edit mode, select Template from the "Layout" list.

2. Select a template from the "Predefined Templates" list.

Note: Switching to "Template" from another mode affects the dashboard

in the following manner:

18 BusinessObjects Dashboard Builder User Guide

Dashboards

Configuring dashboards

When you switch from "Freeform" mode, the objects, if they are not

•

in any particular order, are separated into columns. When you select a template, the dashboard objects are moved to fit rows and columns in the template you select.

• If you switch from "Docking" mode and select a template, the

dashboard objects shift to fit the cells in the template.

• If you have more than objects than available placeholders in the

selected predefined template, the extra analytics are appended to the bottom of the dashboard.

• Empty spots can occur when you switch to a template, or between

templates. Rearrange the analytics as necessary.

3. To have the dashboard columns adjust to the width of the browser window

as it is enlarged or reduced in size, activate Scale width.

Note: Scale width is only available in Template mode.

4. If you want to split an empty cell in two, click one of the following icons

from the cell toolbar:

DescriptionOption

"Split component vertically"

"Split component horizontally"

Note: The options are only available in Template mode.

5. When you are done working on the dashboard, click Save.

Note: If at any time during the process, you decide that you do not want

to keep the dashboard changes as of the last save action, click Cancel. The dashboard reverts to the last saved version of the dashboard.

Related Topics

• The analytic toolbox in the dashboard edit mode and in the Compound

analytic on page 22

• Working with a dashboard or Compound analytic in Freeform layout mode

on page 17

• Configuring the display options of a dashboard analytic on page 20

BusinessObjects Dashboard Builder User Guide 19

If you select this option, the cell splits into cells that are side by side.

If you select this option, the cell splits to have one cell above the other.

Dashboards

Configuring dashboards

Configuring the display options of a dashboard analytic

1. Select a dashboard tab or sub tab and click Edit Dashboard.

2. In the title bar of the dashboard analytic you want to edit, click the "edit"

icon.

3. Select the Layout tab.

4. Choose from the following options:

DescriptionOption

A window inside of a tab

A link, so only the name is visible

Show window border

Show expanded bar

5. Click OK to save your configuration and return to the dashboard layout.

Activate this option to have the analytic appear as an object in the tab.

Activate this option to have the analytic appear as a linked object that when you click it appears full size.

When you select this option, the Show window border and Show expanded bar options are unavailable.

Note: When you click on the link in a dashboard that

contains a Viewer analytic, the link's destination opens in the Viewer.

Activate this option to add a border around an analytic.

Activate this option so that the title of the dashboard object becomes an active link that, when clicked, enlarges the analytic object to full browser screen.

Renaming a dashboard tab or sub tab

1. From My Dashboard or Corporate Dashboards, select the tab or sub tab

that you want to edit.

2. Click Edit Dashboard.

3. Click the arrow next to the title that you want to change.

4. Select Rename.

20 BusinessObjects Dashboard Builder User Guide

Configuring dashboards

The name field is activated.

5. Type the new name and press Enter.

6. When you have finished changing the dashboard, click Save > Exit Edit

Mode.

Moving dashboard tabs and sub tabs

1. From My Dashboard or Corporate Dashboards, select the dashboard or

dashboard page that you want to edit.

2. Click Edit Dashboard.

3. Select the dashboard tab or sub tab and drag it to the new location.

Note: To move a Corporate Dashboard sub tab to another tab, drag and

drop it on the dashboard tab.

4. When you have finished making changes, click Save > Exit Edit Mode.

Copying a corporate dashboard, tab or sub tab

Dashboards

To create a corporate dashboard tab configuration similar to an existing one, you can save time by making a copy of the existing dashboard, and then renaming and modifying the copy.

For example, you can create a standard corporate dashboard welcome tab that includes the corporate logo, document lists, and some common indicators.

Note: When you copy a corporate dashboard tabs and sub tabs, all of the

analytics in it are also copied. The sub tab hierarchy in a copied tab is also duplicated.

1. Select from "Corporate Dashboards" the dashboard, tab or sub tab that

you want to copy.

2. Click Edit Dashboard.

3. Click the arrow next to the title of the tab you want to copy, and select

Copy.

A copy of the object appears to the right of the existing objects with the title appended with an edition number. For example, if you make a copy of the 'Sales' tab, the title of the copy is 'Sales(1)'.

BusinessObjects Dashboard Builder User Guide 21

Dashboards

Configuring dashboards

4. Optionally, rename the item

5. When you have finished changing the dashboard, click Save > Exit Edit

Mode.

Note: You can recreate a dashboard tab using dashboard objects in the

"Existing Analytics" category in the analytic toolbox. Select the item, and

then drag and drop it in the dashboard layout.

Related Topics

• Renaming a dashboard tab or sub tab on page 20

• The analytic toolbox in the dashboard edit mode and in the Compound

analytic on page 22

Deleting a dashboard, tab or sub tab

This procedure applies to your "My Dashboard" tabs and "Corporate Dashboards" dashboards, tabs and sub tabs.

1. From My Dashboard or Corporate Dashboards, select the item that you

want to delete.

2. Click Edit Dashboard.

3. Click the arrow next to the item's title and select Delete.

4. In the confirmation panel, click Yes.

The item disappears.

5. When you have finished changing your dashboard, click Save > Exit Edit

Mode.

The analytic toolbox in the dashboard edit mode and in the Compound analytic

The "Analytic Toolbox" offers the following analytic categories from which you can drag and drop analytics onto your dashboard tabs and sub tabs and Compound analytic layout:

• "Analytic Catalog"

This category contains pre-defined analytics that you can apply to your data.

22 BusinessObjects Dashboard Builder User Guide

Dashboards

Configuring dashboards

• "Analytics Services"

This category contains Dashboard Builder interface components.

• "Corporate Analytics"

This category contains analytics used in the dashboards in your Corporate Documents list, organized in folders and categories.

• "Existing Analytics"

This category contains all analytics displayed in corporate dashboards, organized by dashboard.

Note: You cannot copy corporate dashboards into My Dashboard tabs.

• "List of Analytics"

This category contains the analytics that you saved to your personal and corporate list files, and that are in your InfoView Inbox.

• "New Analytic"

This category contains the list of pre-defined analytic templates that you can customize to display your data.

Tip: Enlarge or reduce the size of the toolbox using the lower right-hand

corner. To activate or deactivate the toolbox, click Toolbox in the dashboard menu bar.

Related Topics

• Compound analytic on page 268

• Creating a corporate dashboard on page 13

Dashboard properties

To display the properties menu for a dashboard, tab or sub tab in the dashboard edit mode, click the arrow next to the dashboard name, tab or sub tab title. Configure the following properties:

• the help URL

Type or copy in the text box the default help URL.

By default, the dashboard home tab opens the Dashboard Builder online help.

BusinessObjects Dashboard Builder User Guide 23

Dashboards

Analytics in dashboards

• Style sheet

You can select a style sheet for a dashboard. You set the default option in the InfoView preferences.

Note: Dashboard's inherit their style from the style sheet selected in the

InfoView preferences. Corporate dashboard sub tabs inherit their style from their parent corporate dashboard tabs.

Analytics in dashboards

Analytics and dashboards

In Dashboard and Analytics, analytics are documents into which you insert the data that you want to view via a dashboard. Analytics can be based on Web Intelligence, Crystal Report or Desktop Intelligence queries, or display metric, goal, or universe data.

There are two methods you can use to work with analytics in dashboards:

• Create an analytic via InfoView, save it to a public or private folder on the

Central Management Server, schedule its refresh in Dashboard Builder > Scheduler, and then insert it into one or more dashboards.

• Create an analytic in a dashboard, whereupon it is saved as an embedded

object in the dashboard.

Note: You can use Web Intelligence, Crystal Report or Desktop

Intelligence reports and modify their queries from within a dashboard, however you cannot create actual queries in dashboards.

The information displayed by analytics in dashboards is protected at the data source.

To modify an analytic in dashboard edit mode, click the edit icon on the analytic toolbar.

Related Topics

• Configuring the Web Intelligence report appearance in a dashboard on

page 28

• Configuring the Crystal Report appearance in a dashboard on page 26

24 BusinessObjects Dashboard Builder User Guide

Adding analytics to dashboards

A dashboard is composed tabs that contain analytics. These analytics provide key information. You can add to dashboards analytics saved on the Central Management Server (CMS) or embedded in other dashboards.

1. Do one of the following:

• In My Dashboard, open an existing tab or create a tab.

• In Corporate Dashboards, open an existing dashboard or create a

dashboard tab or sub tab.

2. Click Edit Dashboard.

3. In the "Analytics Toolbox", navigate to the analytic you want to add:

• If you want to insert an analytic from the CMS, select it from the "List

of Analytics", "Corporate Analytics" or "Existing Analytics"

categories.

• If you want to insert a new analytic and customize it via the dashboard,

select it from the "Analytics Catalog" or "New Analytics" categories.

Dashboards

Analytics in dashboards

Note: Analytics selected from these categories and configured within

a dashboard are saved as embedded objects in the dashboard, not as independent InfoObjects on the CMS. Embedded objects are always refreshed on open. It is more efficient to use InfoObjects on which you have scheduled a refresh. See the section on Scheduler in the Dashboard Builder documentation.

4. Resize and move the analytic as necessary in the dashboard.

5. When you have finished changing the dashboard, click Save > Exit Edit

Mode.

Note: To quickly add a CMS analytic to a new or existing My Dashboard

page, click Add to My Dashboard in the analytic view mode.

Related Topics

• The analytic toolbox in the dashboard edit mode and in the Compound

analytic on page 22

• Analytics and dashboards on page 24

BusinessObjects Dashboard Builder User Guide 25

Dashboards

Analytics in dashboards

Expanded toolbar actions on analytics

When you click the analytic's title in a dashboard or view an analytic directly from the personal or corporate folders, the analytic expands to fit the full page, and the expanded toolbar appears.

Note: Access to the expanded toolbar can be activated and deactivated in

the analytic edit mode.

You can perform the following actions on analytics:

• Add to My Dashboard

Click this link to add the analytic to a My Dashboard tab.

• Edit

Click this link to enter the analytic edit mode.

Note: When you edit an analytic that is stored on the Central Management

Server, you are editing all occurrences of the analytic in all dashboards in which it appears.

• Save

Click this link to save the analytic.

Note: Embedded dashboard analytics cannot use this action. Because

they were created directly in the dashboard, they are only populated with data when the dashboard is opened and only saved as part of the dashboard.

• Save As

Click Save As to save the analytic for the first time, or to save it to a different location.

Configuring the Crystal Report appearance in a dashboard

You can apply the following options to a Crystal Report on a dashboard:

26 BusinessObjects Dashboard Builder User Guide

Dashboards

Analytics in dashboards

Effect on the reportOptionCategory

Parts Viewer

Viewer The entire report appears in the de-

Zoom level

Report content

Report part settings

Page Viewer

Custom zoom level

On Demand

Last Instance

Latest Instance By User

Default Report Part

Specific Report Part

• Object Name

• Data Context

Only the first part of the report is visible.

fault viewer.

You can view by 25%, 50% or 100%%

If you select the Custom Zoom Level option, specify a zoom level.

The report content is refreshed when the report is opened.

The report data is from the last instance that the report was opened.

The report data is from the last instance that the report was opened for a specific user.

The report opens to the home object that you defined in the Report Part Viewer.

The report opens to the report part that you specify.

Locate the information for this option in the report's "Report Options" dialog box.

The Object Name option is the name of the report object that you want to use as the destination object.

To set the Data Context option, enter the data context that you want to use in the destination object.

For information on report parts and the Report Part Viewer, see the Crystal Reports documentation.

BusinessObjects Dashboard Builder User Guide 27

Dashboards

Analytics in dashboards

Configuring the Web Intelligence report appearance in a dashboard

You can control how a Web Intelligence report appears in a dashboard. Once you have dragged and dropped a report onto a dashboard, you can configure the view of the entire report or just one part of the report.

• To select a part of the Web Intelligence report right-click the part and

select Select this report part. While viewing the report part, you can edit its view by clicking the Edit icon.

• To unselect a report part, right-click the part and select Unselect this

report part.

The entire report appears.

You can apply the following options:

Effect on the reportOption

The report is displayed with a toolbar that includes all

Display full report

Display report in compact mode

Display specific report part

options. For information on these options, see the Web Intelligence documentation.

The report is displayed with a compact toolbar, the options of which are determined by the user's rights. This saves space in the display of your report.

If you have selected a report part, this option is activated by default, and the part's ID appears in the text box. You can use this ID in other applications.

Note: This option is not valid for the full report display.

Using a Navigation List on a dashboard tab

A Navigation List analytic when used with the Viewer analytic allows you to maximize the space on a dashboard tab by acting as an active 'table of contents'.

28 BusinessObjects Dashboard Builder User Guide

Dashboards

Analytics in dashboards

1. In the dashboard edit mode, click Toolbox to activate the "Analytic

Toolbox".

2. From the "New Analytic" category, drag Navigation List to the

dashboard layout area.

3. From the "New Analytic" category, drag Viewer to the dashboard layout

area and resize as necessary using the lower, right-hand corner resize icon.

4. Drag an analytic from any category in the "Analytic Toolbox" to the

Navigation List.

Remember: If you are editing the dashboard in "Docking" mode, hold

down the control button to use the mouse for dragging and dropping objects into the Navigation List.

When you select an item in the navigation list, it appears in the viewer.

5. In the Navigation List title bar, click the "edit" icon.

The content and layout panel appears.

6. In the "Content" tab:

• Optionally, create folders in which to organize the analytics.

• Organize Navigation List items.

• Edit the properties of the Navigation List items, including analytic

properties.

• Delete items from the Navigation List.

• Change the name of an item.

7. In the "Layout" tab, type a title and description, and select the display

options and style sheet.

8. Click OK to save the content and layout configuration.

For information on configuring analytic properties, see the Dashboard Builder documentation.

Related Topics

• The Viewer analytic in dashboards on page 269

• Configuring the display options of a dashboard analytic on page 20

BusinessObjects Dashboard Builder User Guide 29

Dashboards

Analytics in dashboards

The Viewer analytic in dashboards

By default objects called from an analytic link open to occupy the full dashboard space. The Viewer analytic offers a way to display, in the size you determine, objects called from analytics via analytic links that use openAnalytic variables.

For example, in a dashboard tab that contains a Viewer, when you select in a Metric Tree a box title that contains a link, the destination analytic appears in the Viewer. This allows you to see the Metric Tree itself and the destination analytic side by side.

In another example, you created a Web Intelligence report and you want to select linked items in the report, and have the linked document appear in the Viewer.

The Viewer analytic is particularly useful with the Navigation List analytic. You use the Navigation List as a 'table of contents' and the Viewer as the viewing portlet. This saves you dashboard space.

You find the Viewer analytic in the dashboard edit mode, in Toolbox > New Analytic. To add it to a dashboard, drag Viewer to the dashboard layout area and resize as necessary using the lower, right-hand corner resize icon.

Related Topics

• Using a Navigation List on a dashboard tab on page 28

• OpenAnalytic variables used in goal, metric and universe query analytics

on page 47

• Configuring the box title in a Metric Tree analytic on page 141

Sending information to the Viewer analytic in a dashboard using openAnalytic

Using the openAnalytic syntax, you can send information from the following documents saved on the Central Management Server (CMS) to a Viewer analytic on a dashboard:

• Web Intelligence reports

• Crystal Reports

• Text analytic

30 BusinessObjects Dashboard Builder User Guide

Dashboards

Analytics in dashboards

• Desktop Intelligence reports

• Web page analytic

Sample syntax:

<a href='http://[WEB APPLICATION LOCATION] aa-open-inlist.jsp?url=openAnalytic.jsp? DocumentName=text+analytic&RepositoryType=C &RepositoryName=PM&DocumentExt=afd &DocumentId=AQ74dXHxW59HlHvZivNsypI&mode=full ' target='hiddenFrame'>[LINK NAME IN DASHBOARD]</a>

The key items in the sample are aa-open-inlist.jsp and target='hid

denframe'.

1. In a text editor, copy and paste the sample syntax.

2. Replace [WEB APPLICATION LOCATION] with the web application

location after http://. For example: http://<server>:<port>/PerformanceManagement/jsp

3. Enter the correct information after the variables.

4. Replace [LINK NAME IN DASHBOARD] with the name of the link as you

want it to appear.

5. Copy and paste the text in the following location:

• For a Web Intelligence, Crystal Report or Desktop Intelligence report,

copy the text in the cell of the query and then run a report.

• For a Text analytic, go to the edit mode and paste the text in the "Enter

text or HTML to display" text box and select html. Save the analytic in the public folders.

• For a Web page analytic, go to the edit mode and in the "Content"

tab paste the text in the "Enter the web page URL" text box and click

OK. In the "Layout" tab, select from the "Display as" section A link, so only the name is visible.

6. In InfoView, go to Dashboards > Create Corporate Dashboard.

7. Enter the title, select a public folder, and click OK.

8. Click Dashboards > Organize Corporate Dashboards, and select your

dashboard.

9. Click Edit Dashboard.

10. From the "Analytic Toolbox", expand the "Corporate Analytics" list

to find your report, and drag it to the dashboard layout.

11. From the "Analytic Toolbox", expand the "New Analytic" list, and drag

the "Viewer" analytic from the list to the dashboard layout.

BusinessObjects Dashboard Builder User Guide 31

Dashboards

Analytics in dashboards

12. Click Save, then Exit Edit Mode.

Click on any linked item in the report and the destination appears in the viewer.

32 BusinessObjects Dashboard Builder User Guide

Using analytics for analysis

Analytics based on a single metric or goal

The data in an analytic can come from a metric, goal, or a universe-based, Web Intelligence, Desktop Intelligence, Crystal Reports or Xcelsius query. You create and add analytics to your dashboards to display data in a meaningful and efficient manner.

Business Objects offers you pre-built analytic templates delivered with its Dashboard and Analytics applications.

Analytics based on a single metric or goal

You can create the following analytics using a single metric or goal:

• Gauge

• Interactive Metric Trend

• Pareto Chart

What is a universe query?

Universe queries map to data from relational and OLAP data sources, and can include goals from other data sources via a universe, and show, in addition to metrics, goals and tolerance levels.

For information on customizing universes from which to create query-based metrics, see the Designer documentation.

Data for universe queries

Analytics can use data obtained from querying any Business Objects universe that has been exported in Designer.

Universes for these types of queries do not have to be imported in Dashboard and Analytics Setup.

Any security conditions created to these universes in Designer are carried over when you create an analytic. Objects with security restrictions in the universe, for example, are not visible in the Query Panel.

34 BusinessObjects Dashboard Builder User Guide

Using analytics for analysis

Defining a universe query for an analytic

1. In the data selection section of the analytic edit panel, select Define

Query.

2. In the "Define query" panel, select the universe on which you want to

base your query. If you do not see your universe listed, click Refresh List. If it still does

not appear, click Search and migrate to it.

3. Select a universe object and click >> to add it to the "Result Objects"

list box. Filters are automatically added to the "Query Filters" list box. To remove

items from the list box, click <<.

4. Click OK to save.

The analytic edit panel reappears.

Related Topics

• Defining the display data for a universe query in the Bubble, Pie and

Radar analytics on page 36

• Configuring a Gauge analytic using a metric, goal or universe query on

page 105

• Configuring a Bubble Chart analytic on page 109

• Configuring a Pie Chart analytic on page 110

• Configuring a Radar Chart analytic on page 111

• Configuring an Interactive Metric Trend analytic using on goals, metrics

and universe queries on page 95

• Configuring a Pareto Chart analytic on page 149

• Configuring the Metric Tree analytic properties on page 140

What is a universe query?

Defining a filter for analytics that use universe queries

Before you can do the following steps, you need to be in the analytic edit panel, have selected Universe Query from the "Select Data to Display" list, and defined the universe query.

BusinessObjects Dashboard Builder User Guide 35

Using analytics for analysis

What is a universe query?

A filter refines the list of data displayed. This is useful when the universe you are querying contains a lot of data.

1. To add a filter to the analytic, click Add under "Analytic Filter".

If you are editing an existing filter, select it in the "Analytic Filter" list box, and click Edit.

2. In the "Filter Creation" panel, select a dimension from the "Result

Object" list.

3. Select a dimension from the "Secured Dimension" list.

4. Select Use all slices when displaying this analytic to allow all users

to see all slices associated with the metric. If you do not want users to see the slices, select Display nothing.

5. Click OK.

The filter appears in the "Analytic Filter" list box.

To delete a filter, select it in the "Analytic Filter" list box and click Remove.

Related Topics

• Defining a universe query for an analytic on page 35

• Defining the display data for a universe query in the Bubble, Pie and

Radar analytics on page 36

Defining the display data for a universe query in the Bubble, Pie and Radar analytics

Before you can do the following steps, you need to be in the analytic edit panel, have selected Universe Query from the "Select Data to Display" list, and defined the universe query.

1. If you are configuring:

• a Pie chart, select the measure you want to display.

• a bubble or radar chart, select one primary measure and one or more

secondary measures.

2. Select a dimension from the "Dimension for X-axis and slider" list.

3. Select a dimension for the slice list.

4. Optionally, add filters.

36 BusinessObjects Dashboard Builder User Guide

Related Topics

• Defining a filter for analytics that use universe queries on page 35

• Configuring a Bubble Chart analytic on page 109

• Configuring a Pie Chart analytic on page 110

• Configuring a Radar Chart analytic on page 111

Analytic display modes

The display formats are:

• SVG – Scalable Vector Graphics format. This format is less interactive

than the applet.

• Applet – The Java Applet allows interactive editing of the analytic.

• Flash – Macromedia Flash provides a more interactive interface, and a

zero footprint.

• HTML – The HTML display allows you to provide accessibility for

508-compliant analytics.

The display modes for the analytics are shown in the following table.

Using analytics for analysis

Analytic display modes

DHTMLHTMLFlashAppletSVGAnalytic

XAlerts

XBubble chart

XControl chart

XCurve fitting

XFrequency histogram

XXXGauge

XGoal

XGoal subscriptions

XGoal-based influencer detail

XIndividual list

BusinessObjects Dashboard Builder User Guide 37

Using analytics for analysis

Analytic display modes

DHTMLHTMLFlashAppletSVGAnalytic

XInfluencer detail

XInfluencer gains chart

XXXInteractive metric trend

XKey influencers

XLag plot

XXMap

XXMembership

XMetric forecaster

XMetric list

XMetric tree

38 BusinessObjects Dashboard Builder User Guide

XXMetrics overview

XXMigration

XModel gains chart

XXMulti-set same time events

XNavigation list

XNormal probability

XPareto

XPie chart

XProfiler

XRadar chart

XScorecard

Creating an analytic

You create analytics to visualize performance levels and trends on specific data. The data can originate from single metrics or goals, Predictive models, sets stored on the Performance Manager repository or ad hoc queries on a universe.

Using analytics for analysis

Creating an analytic

DHTMLHTMLFlashAppletSVGAnalytic

XSmoothing

XStrategy Map

XText

XVariable profile box plot

XXVisual data counts

XWeb page

You can create analytics in the following ways:

• via InfoView

• via Dashboard Builder

• Create an analytic directly in a dashboard, whereupon it is saved as an

embedded object in the dashboard.

Note: You can use Web Intelligence, Crystal Report or Desktop

Intelligence reports and modify their queries from within a dashboard, however you cannot create actual queries in dashboards.

Related Topics

• What is an analytic? on page 324

• Creating an analytic via InfoView on page 40

• Creating an analytic via Dashboard Builder on page 40

BusinessObjects Dashboard Builder User Guide 39

Using analytics for analysis

Creating an analytic

Creating an analytic via Dashboard Builder

You create analytics from within Dashboard Builder on the Create New Analytic page.

1. In InfoView, go to Open > Dashboard and Analytics > Dashboard

Builder > Create New Analytic.

The analytic types are listed by category.

2. Select a category.

The analytics in the selected category appear on the right.

3. Select an analytic.

For information on configuring a specific analytic, refer to its section in the Dashboard and Analytics documentation.

Related Topics

• Saving an analytic as a document on page 94

• Emailing an analytic on page 91

• Adding analytics to dashboards on page 25

Creating an analytic via InfoView

You can create analytics directly in InfoView.

1. On the InfoView home page, go to Document List > New > Analytic.

The analytic types are listed by category.

2. Select a category.

The analytics in the selected category appear on the right.

3. Select an analytic.

For information on configuring a specific analytic, refer to its section in the Dashboard Builder documentation.

40 BusinessObjects Dashboard Builder User Guide

Using analytics for analysis

Creating an analytic

Creating an analytic based on an existing analytic

You can edit an existing analytic based on universe queries, metrics, and goals to select a different data source and save it as a new analytic.

Note: You cannot change the data source of analytics based on Web

Intelligence, Crystal Reports, or Desktop Intelligence queries. Instead, you edit the query to create an analytic. The process to edit queries is located in the documentation for Web Intelligence, Crystal Reports, or Desktop Intelligence .

1. Select the analytic on which you want to base the new analytic.

2. Click Edit.

The analytic's edit panel appears. See the information on configuring the analytic in the "Analytics Catalog" in the Dashboard and Analytics documentation.

Data sources for analytics

Choosing the right data for an analytic is critical. The data you select depends on the business question you want to answer, type of analytic you choose, and what data is available to you.

The data can be:

• a metric created in Designer

A metric is defined using objects in a universe created using Designer and stored in the Central Mangement Server. Metric definitions are stored in the Performance Manager repository.

• a universe query created in Dashboard Builder or Performance Manager

A universe query uses filtered data exported from a specific universe.

• a predictive model or model-based metric created in Predictive Analysis.

For information on performance models, see the Predictive Analysis documentation.

• a goal created in Performance Manager

BusinessObjects Dashboard Builder User Guide 41

Using analytics for analysis

Editing an analytic

For more information, see the Performance Manager documentation. For example, in a Gauge analytic, you can display goal data returned from prompt values.

Related Topics

• What is a metric? on page 324

• What is a goal? on page 246

• What is a universe query? on page 34

Editing an analytic

This section shows you how to:

• Add analytics to dashboards

• Save analytics as documents

• Email analytics

• Delete an analytic from an InfoView folder

• Save an analytic to a folder

• Create an analytic based on an existing analytic

• Linking analytics to documents or other analytics

For information on editing a particular analytic, check the Analytics Catalog section in the Dashboard Builder documentation.

Related Topics

• Adding analytics to dashboards on page 25

• Saving an analytic as a document on page 94

• Emailing an analytic on page 91

• Deleting an analytic from an InfoView folder on page 93

• Saving an analytic to a folder on page 93

• Creating an analytic based on an existing analytic on page 159

• Linking to multiple documents from an analytic based on a goal, metric

or universe query on page 43

• Linking from a goal, metric or universe query-based analytic to a document

or analytic on page 45

• Linking analytics and documents on page 43

42 BusinessObjects Dashboard Builder User Guide

Using analytics for analysis

Linking analytics and documents

Adding links to analytics allows end users navigate from an analytic to other analytics or documents that provide information for further analysis.

Linking to analytics that use a single goal, metric, or universe-based query

You can link to one or multiple documents and you can include prompt parameters in links. Adding prompt parameters means that the data displayed on the target analytic or document is dynamically generated according to the values displayed on the first analytic. You can link to:

• a single analytic or document

• multiple analytics and documents

Related Topics

• Linking from a goal, metric or universe query-based analytic to a document

or analytic on page 45

• Linking to multiple documents from an analytic based on a goal, metric

or universe query on page 43

Linking from goal, universe query and metric-based analytics

Linking to multiple documents from an analytic based on a goal, metric or universe query

You can create links to multiple documents from a goal or metric-based analytic. This is particularly useful for analytic drill down.

1. How you access the options for linking analytics to other documents,

depends on whether you are creating a new analytic or editing an existing analytic.

• If you are creating an analytic, do one of the following in InfoView:

• Go to Open > Dashboard Builder > Create New Analytic.

• Go to Document List > New > Analytic.

• If you are editing an analytic, select the analytic, then click Edit.

BusinessObjects Dashboard Builder User Guide 43

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

2. Expand Navigation.

3. The next step depends on whether you want:

• If you want to link the title of the analytic to multiple documents, click

Multiple Links below "Use Legend/Title as hyperlink to go to".

• If you want to provide data point navigation, so that users can click a

metric result and then view a filtered document that shows other results for that specific time period, click Multiple Links below "Use data point as hyperlink to go to".

The Edit Navigation Link dialog box appears.

4. Click Add, then click Browse to select the document or, if you want to

link to a web page, type the URL into the text box.

5. You can add several links to documents here.

6. Click Update, then click OK.

The link to the multiple documents appears.

For example:

Drill Down Group Level||openAnalytic.jsp?Document Name=Drill+Down+Group+Level&RepositoryType=C&Repository Name=Feature Examples&DocumentExt=rpt&DocumentId=AWbJO JEYvvVMnbtXEQ2An0s&sContentType=OnDemand&mode=full||Total Sales.rpt||openAnalytic.jsp?DocumentName=TotalSales.rpt&Repos itoryType=C&RepositoryName=Feature Samples&Docu mentExt=rpt&DocumentId=AdLEddSQNTlDhMiLiHoD7II&sContent Type=OnDemand&mode=full||Business Objects||http://www.busi nessobjects.com

In this example the multiple link is created to:

• Drill Down Group Level

• TotalSales report

• www.businessobjects.com

The syntax of the links is as follows:

name1||URL||name2||URL||name3||URL

7. To check the links, click OK.

The analytic appears.

8. Place your cursor on a data point or the title.

If the links are defined correctly, a popup menu appears with list of destination documents.

44 BusinessObjects Dashboard Builder User Guide

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

9. Click the destination document of your choice.

Note: When linking from goal and predictive analytics you must enter

the link manually.

Related Topics

• OpenAnalytic variables used in goal, metric and universe query analytics

on page 47

• Using variables for dynamic links to documents on page 46

Linking from a goal, metric or universe query-based analytic to a document or analytic

Adding links to analytics allows end users navigate from an analytic to other analytics or documents that provide information for further analysis.

You can include prompt parameters in links. Adding prompt parameters means that the data displayed on the target analytic or document is dynamically generated according to the values displayed on the first analytic.

1. How you access the options for linking analytics to other documents

depends on whether you are creating an analytic or editing an existing analytic:

• If you are creating an analytic, do one of the following in InfoView:

• Go to Open > Dashboard Builder > Create New Analytic.

• Go to New > Analytic.

• If you are editing an analytic, select the analytic, then click Edit.

2. Expand Navigation.

3. The next step depends on whether you want to link the title or data points

to a destination document:

• If you want to link the title of the analytic to multiple documents, click

Browse below "Use Legend/Title as hyperlink to go to".

• If you want to provide data point navigation, so that users can click a

metric result to view a filtered document that shows other results for that specific time period, click the Browse below "Use data point as hyperlink to go to".

The "Edit Navigation Link Menu" dialog box appears.

BusinessObjects Dashboard Builder User Guide 45

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

4. Click Add, then Browse to select the document or, if you want to link to

a web page, type the URL into the text box.

Note: When linking from goal and predictive analytics you must enter

the link manually.

5. Click Update, then click OK.

The URL to the document appears in the URL box. The URL reads as follows:

openAnalytic.jsp?DocumentName=<FILE_NAME> &RepositoryType= C&RepositoryName=<REPOSITORY_NAME> &DocumentExt=<EXTN>& DocumentId=<DOCID> &sContentType=OnDemand&mode=full

6. To check the links, click OK.

The analytic appears.

7. Place your cursor on a data point or the title.

8. When your cursor turns into a hand sign, click the data point or title.

The destination document appears.

Related Topics

• OpenAnalytic variables used in goal, metric and universe query analytics

on page 47

• Linking to multiple documents from an analytic based on a goal, metric

or universe query on page 43

• Using variables for dynamic links to documents on page 46

Using variables for dynamic links to documents

You can include variables in the links to documents so that the destination document is filtered by the values for a specific metric, dimension, goal or set.

Related Topics

• OpenAnalytic variables used in goal, metric and universe query analytics

on page 47

46 BusinessObjects Dashboard Builder User Guide

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

OpenAnalytic variables used in goal, metric and universe query analytics

The following table gives a description of each variable you can use when used in creating links between analytics.

Note: A universe query analytic where a prompt is defined can use all of the

OpenAnalytic variables.

DescriptionVariable

Metric ID$METRIC_ID$

Metric Name$METRIC_NAME$

Subject ID$SUBJECT_ID$

Subject name$SUBJECT_NAME$

Set ID$SET_ID$

Set Name$SET_NAME$

2nd Set ID (when metric based on two sets)$SET2_ID$

2nd Set Name (when metric based on two sets)$SET2_NAME$

Population ID$POPULATION_ID$

Population Name$POPULATION_NAME$

Dimension ID$DIM_ID$

Dimension Name$DIM_NAME$

2nd Dimension ID$DIM2_ID$

2nd Dimension Name$DIM2_NAME$

Name of goal associated with analytics$GOAL_NAME$

ID of goal associated with analytics$GOAL_ID$

BusinessObjects Dashboard Builder User Guide 47

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

DescriptionVariable

Value of the slice (code)$SLICE_CODE$

Value of the slice (name)$SLICE_NAME$

Class Id from the source universe$CONDITION_ID$

Measure Name$MEASURE_NAME$

First slice of the dimension used for x-axis (QOU)$MIN_SLICE$

Last slice of the dimension used for x-axis (QOU)$MAX_SLICE$

$CURRENT_SLICE$

$CURRENT_DATE$

Current slice of the dimension used for x-axis (QOU)

Begin Date of the displayed period$BEGIN_DATE$

End Date of the displayed period$END_DATE$

Current period (corresponds to a data point in a trend)

Code for the current region displayed$MAP_CODE$

Name of current region displayed$MAP_NAME$

Long name of current region displayed$MAP_LONGNAME$

Model ID$MODEL_ID$

Influencer ID$INFLUENCER_ID$

Influencer Name$INFLUENCER_NAME$

OpenAnalytic variables for Goal variance and Pareto analytics

Pareto analytic

You can only use the $METRIC_ID$ variable to link from a Pareto analytic.

48 BusinessObjects Dashboard Builder User Guide

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Goal variance analytics

You can use the following variables to link from Goal Variance analytics:

• $CONDITION_ ID$

• $CONDITION_ NAME$

• $DIM_ID$

• $DIM_ NAME$

• $GOAL_ ID$

• $MEASURE_ NAME$

• $METRIC_ ID$

• $METRIC_ NAME$

• $POPULATION_ ID$

• $POPULATION_ NAME$

• $SET_ ID$

• $SET_ NAME$

• $SET2_ ID$

• $SET2_ NAME$

• $SLICE_ CODE$

• $SLICE_ NAME$

• $SUBJECT_ ID$

• $SUBJECT_ NAME$

• $USER$

Note: A universe query analytic where a prompt is defined can use all of the

OpenAnalytic variables.

Related Topics

• OpenAnalytic variables used in goal, metric and universe query analytics

on page 47

OpenAnalytic variables for Map analytics

This table shows which variables can be used to link from Map analytics that use metrics or a universe query.

Note: A universe query analytic where a prompt is defined can use all of the

OpenAnalytic variables.

BusinessObjects Dashboard Builder User Guide 49

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Variable

$SUBJECT_ NAME$

$POPULATION_ ID$

Map analytic using metrics

Title link

Map item link

Map analytic using a universe query

Map item linkTitle link

XXXX$METRIC_ ID$

XXXX$METRIC_ NAME$

XXXX$SUBJECT_ ID$

XXXX

XXXX$SET_ID$

XXXX$SET_ NAME$

XXXX$SET2_ID$

XXXX$SET2_ NAME$

XXXX

$POPULATION_ NAME$

50 BusinessObjects Dashboard Builder User Guide

XXXX

XXXX$DIM_ID$

XXXX$DIM_NAME$

X$GOAL_NAME$

XX$GOAL_ID$

XXX$SLICE_CODE$

XXX$SLICE_NAME$

XXXX$CONDITION_ ID$

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Variable

$CONDITION_ NAME$

$MEASURE_ NAME$

$MAP_ LONGNAME$

Map analytic using metrics

Title link

Map item link

Map analytic using a universe query

Map item linkTitle link

XXXX

XX$BEGIN_DATE$

XX$END_DATE$

XXX$MAP_CODE$

XXXX$MAP_NAME$

XXXX$USER$

Related Topics

• OpenAnalytic variables used in goal, metric and universe query analytics

on page 47

OpenAnalytic variables for Metric List and Strategy Map analytics

This table shows which variables can be used to link from Metric Lists and Strategy Maps analytics (only when based on goals, metrics or universe queries).

Strategy MapMetric List

Variable

Attached analyticTitle link

XX$METRIC_NAME$

BusinessObjects Dashboard Builder User Guide 51

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Variable

Strategy MapMetric List

Attached analyticTitle link

XX$SUBJECT_ID$

XX$SUBJECT_ NAME$

XX$SET_ID$

XX$SET_NAME$

XX$SET2_ID$

XX$SET2_NAME$

XX$POPULATION_ ID$

XX$POPULATION_ NAME$

XX$DIM_ID$

Note: A universe query analytic where a prompt is defined can use all of the

OpenAnalytic variables.

52 BusinessObjects Dashboard Builder User Guide

XX$DIM_NAME$

XX$GOAL_NAME$

XX$SLICE_CODE$

XX$SLICE_NAME$

XX$CONDITION_ID$

XX$CONDITION_ NAME$

XX$MEASURE_ NAME$

XX$USER$

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Related Topics

• OpenAnalytic variables used in goal, metric and universe query analytics

on page 47

OpenAnalytic variables for Metric Tree and Metrics Overview analytics

This table shows which variables can be used to link from Metric Trees and Metrics Overview analytics.

Note: A universe query analytic where a prompt is defined can use all of the

OpenAnalytic variables.

Metrics OverviewMetric Tree

Variable

Attached Analytic

X$METRIC_ID$

X$GOAL_NAME$

X$GOAL_ID$

Set Name Link

Datapoint Link

XX$METRIC_NAME$

XX$SUBJECT_ ID$

XXX$SUBJECT_ NAME$

XXX$SET_ID$

XXX$SET_NAME$

XX$POPULATION _ID$

XX$POPULATION _NAME$

XX$DIM_ID$

XX$DIM_NAME$

XX$SLICE_ CODE$

BusinessObjects Dashboard Builder User Guide 53

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Metrics OverviewMetric Tree

Variable

Related Topics

Attached Analytic

Set Name Link

Datapoint Link

XX$SLICE_ NAME$

XX$CONDITION _ID$

XX$CONDITION _NAME$

XX$MEASURE _NAME$

X$BEGIN_DATE$

X$END_DATE$

X$CURRENT _DATE$

XXX$USER$

• OpenAnalytic variables used in goal, metric and universe query analytics

on page 47

OpenAnalytic variables for most volatile metrics and Set Membership analytics

This table shows which variables can be used to link from most volatile metrics and set membership analytics.

Variable

54 BusinessObjects Dashboard Builder User Guide

Set MembershipMost Volatile Metrics

DatapointDatapointAnalytic Link

XX$METRIC_ID$

XX$METRIC_NAME$

XXX$SUBJECT_ID$

XXX$SUBJECT_NAME$

Variable

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Set MembershipMost Volatile Metrics

DatapointDatapointAnalytic Link

XXX$SET_ID$

XXX$SET_NAME$

XX$SET2_ID$

XX$SET2_NAME$

XX$POPULATION_ID$

XX$POPULATION_NAME$

XX$DIM_ID$

XX$DIM_NAME$

XX$SLICE_CODE$

XX$SLICE_NAME$

XX$CONDITION_ID$

XX$CONDITION_NAME$

XX$MEASURE_NAME$

XX$BEGIN_DATE$

XX$END_DATE$

XX$CURRENT_DATE$

XXX$USER$

Note: A universe query analytic where a prompt is defined can use all of the

OpenAnalytic variables.

BusinessObjects Dashboard Builder User Guide 55

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Related Topics

• OpenAnalytic variables used in goal, metric and universe query analytics

on page 47

OpenAnalytic variables for Key Influencers analytics

The following variables can be used to link from Key Influencers analytics:

• $MODEL_ID$

• $INFLUENCER_ID$

• $INFLUENCER_NAME$

Note: A universe query analytic where a prompt is defined can use all of the

OpenAnalytic variables.

Related Topics

• OpenAnalytic variables used in goal, metric and universe query analytics

on page 47

OpenAnalytic variables for the Metric Forecaster analytic

The following variables can be used to link to Metric Forecaster analytic:

• $METRIC_ ID$

• $BEGIN_ DATE$

• $END_ DATE$

OpenAnalytic variables for the Interactive Metric Trend analytic

This table shows the variables can be used to link from Interactive Metric Trends based on goals, metrics or universe queries.

DatapointLegendVariable

XX$METRIC_ID$

XX$METRIC_NAME$

XX$SUBJECT_ ID$

XX$SUBJECT_ NAME$

XX$SET_ID$

XX$SET_NAME$

56 BusinessObjects Dashboard Builder User Guide

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

DatapointLegendVariable

XX$SET2_ID$

XX$SET2_NAME$

XX$POPULATION_ ID$

XX$POPULATION_ NAME$

XX$DIM_ID$

XX$DIM_ NAME$

XX$SLICE_ CODE$

XX$SLICE_ NAME$

XX$CONDITION_ ID$

XX$CONDITION_ NAME$

XX$MEASURE_ NAME$

XX$MIN_ SLICE$

XX$MAX_ SLICE$

X$CURRENT_ SLICE$

XX$USER$

XX$BEGIN_DATE$

X$CURRENT_DATE$

XX$END_DATE$

Note: A universe query analytic where a prompt is defined can use all of the

OpenAnalytic variables.

BusinessObjects Dashboard Builder User Guide 57

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Related Topics

• OpenAnalytic variables used in goal, metric and universe query analytics

on page 47

OpenAnalytic variables for a Migration analytic

The following variables can be used to link from a datapoint in the Migration analytic for set analysis:

• $SUBJECT_ID$

• $SUBJECT_ NAME$

• $SET_ID$

• $SET_NAME$

• $USER$

Note: A universe query analytic where a prompt is defined can use all of the

OpenAnalytic variables.

Related Topics

• OpenAnalytic variables used in goal, metric and universe query analytics

on page 47

OpenAnalytic variables for Gauge analytics

This table shows which variables can be used to link from Gauges.

58 BusinessObjects Dashboard Builder User Guide

Universe queryMetricVariable

X$METRIC_ ID$

X$METRIC_ NAME$

X$SUBJECT_ ID$

X$SUBJECT_ NAME$

X$SET_ID$

X$SET_NAME$

X$SET2_ID$

X$SET2_NAME$

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Universe queryMetricVariable

X$POPULATION _ID$

X$POPULATION _NAME$

XX$DIM_ID$

XX$DIM_NAME$

X$DIM2_ID$

X$DIM2_NAME$

X$GOAL_NAME$

X$GOAL_ID$

X$SLICE_ CODE$

XX$SLICE_ NAME$

X$CONDITION _ID$

X$CONDITION _NAME$

XX$MEASURE _NAME$

X$MIN_SLICE$

X$MAX_SLICE$

X$CURRENT _SLICE$

X$BEGIN_DATE$

X$END_DATE$

X$CURRENT _DATE$

X$USER$

BusinessObjects Dashboard Builder User Guide 59

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

OpenAnalytic variables for the Pie, Bubble and Radar Charts

The following table shows which variables can be used to link from the Pie, Bubble and Radar charts:

XX$METRIC_ ID$

XX$METRIC_ NAME$

X$GOAL_ ID$

X$GOAL_ NAME$

Radar ChartBubble ChartPie ChartVariable

XXX$BEGIN_ DATE$

XXX$END_ DATE$

$CURRENT_ DATE$

Note: A universe query analytic where a prompt is defined can use all of the

OpenAnalytic variables.

Related Topics

• OpenAnalytic variables used in goal, metric and universe query analytics

on page 47

OpenAnalytic variables for Data Exploration analytics

The following variables can be used to link from the Data Exploration analytics, which include Lag Plot, Frequency Histogram, Normal Probability Plot, Smoothing and Curve Fitting :

• $METRIC_ID$

• $METRIC_NAME$

• $BEGIN_DATE$

• $END_DATE$

• $CURRENT_DATE$

XXX

60 BusinessObjects Dashboard Builder User Guide

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Note: A universe query analytic where a prompt is defined can use all of the

OpenAnalytic variables.

Related Topics

• OpenAnalytic variables used in goal, metric and universe query analytics

on page 47

nbPrompts

nbPrompts is a parameter used in customized links between analytics and documents stored on the Central Management Server in which prompts are allowed, including analytics, Crystal Reports, Desktop Intelligence and Web Intelligence documents. Using nbPrompts, you can fill the prompt(s) in the target document with openAnalytic variables.

nbPrompts syntax in links from goal and metric-based analytics

The following are examples of nbPrompts syntax:

openanalytic.jsp?...&mode=full&nbPrompts=1 &[analytic_prompt_name]=$METRIC_NAME$

openanalytic.jsp?...&mode=full&nbPrompts=3 &[analytic_prompt1]=$METRIC_NAME$&[analytic_prompt2]= $BEGIN_DATE$&[analytic_prompt3]=$END_DATE$

where openanalytic.jsp?...&mode=full is automatically included in the address when you select the target document, and you add the remaining text using the following syntax:

&nbPrompts=[#]&[analytic_prompt_name]= $METRIC_NAME$

where you replace [#] with the number of prompts, and for each prompt you add the string &[analytic_prompt_name]=$METRIC_NAME$, where [analytic_prompt_name] is replaced with the name of the prompt in the analytic or document.

Using openDocument in dashboards and analytics

The openDocument.jsp uses the "opendoc" context to open objects from a document or dashboard in InfoView.

BusinessObjects Dashboard Builder User Guide 61

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Use the following syntax:

/OpenDocument/opendoc/ openDocument.jsp?iDocID=vscmMCXk &sIDType=CUID&sType=null&sInstance=Last

where vscmMCXk is the ID of the dashboard.

Note: Use relative instead of absolute links to documents in InfoView, in the

case where you plan to migrate servers.

To use openDocument to open a dashboard from a document or dashboard:

/OpenDocument/opendoc/openDocument.jsp? iDocID=vscmMCXk&sIDType=CUID&sType=null

To use openDocument to open an analytic from a document or dashboard:

/OpenDocument/opendoc/openDocument.jsp? iDocID=vscmMCXk&sIDType=CUID&sType=null

Example: sInstance in openDocument syntax

Use the parameter sInstance=Last with the OpenDocument function to retrieve the last instance of a Web Intelligence or Desktop Intelligence report. You must specify the fully-qualified URL of the target document for the parameter to take effect.

Note: sInstance=Last has no effect in the OpenAnalytic function.

URL Reporting Using openDocument

URL reporting using openDocument provides URL access to multiple document types by passing a URL string to a BusinessObjects Enterprise server. openDocument provides commands to control how reports are generated and displayed.

You can use openDocument in BusinessObjects Enterprise to create cross-system links to and from the following document types:

.wid: Web Intelligence version 6.x documents

•

.rep: Desktop Intelligence documents

•

.rpt: Crystal reports

•

.car: OLAP Intelligence reports

•

Note: For more information about how to customize your Web Intelligence

documents, see the Web Intelligence Report Engine Developer Guide.

62 BusinessObjects Dashboard Builder User Guide

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Structuring an openDocument URL

The next sections explain how to use the openDocument function, and how to construct the URL.

An openDocument URL is generally structured as follows:

http://<servername>:<port>/OpenDocument/<platformSpecific>?<pa rameter1>&<parameter2>&...&<parameterN>

The exact syntax of the <platformSpecific> parameter depends on your implementation:

For Java implementations, use opendoc/openDocument.jsp in place of

•

the <platformSpecific> parameter.

The URL is constructed using the parameters listed in OpenDocument

parameter overview on page 66

Joining parameters

Join parameters with the ampersand (&). Do not place spaces around the ampersand. For example: sType=wid&sDocName=Sales2003

The ampersand is always required between parameters.

Spaces and special characters in parameter values

Because some browsers cannot interpret spaces, the parameters of the link cannot contain spaces or other special characters that require URL encoding. To avoid the misinterpretation of special characters, you can define a URLEncoded string in the source database to replace the special character with an escape sequence. This will allow the database to ignore the special character and correctly interpret the parameter value. Note that certain RDBMS have functions that allow you to replace one special character with another.

By creating an escape sequence for the plus sign (+), you can instruct the database to interpret the plus sign as a space. In this case, a document title Sales Report for 2003 would be specified in the DocName parameter as:

&sDocName=Sales+Report+for+2003&

This syntax prevents the database from misinterpreting the spaces in the title.

BusinessObjects Dashboard Builder User Guide 63

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Trailing spaces in parameter values

Trim trailing spaces at the end of parameter values and prompt names. Do not replace them with a plus sign (+). The viewer may not know whether to interpret the plus sign (+) as part of the prompt name or as a space. For example, if the prompt name displays:

Select a City:_

(where _ represents a space), enter the following text in the link:

lsSSelect+a+City:=Paris

where the spaces within the prompt name are replaced with the plus sign, and the trailing space is trimmed off.

For details on prompt parameters of the link, refer to OpenDocument

parameter overview on page 66 .

Capitalization

All of the openDocument parameters are case sensitive.

Link length limit

The encoded URL cannot exceed 2083 total characters.

Parameter values in links to sub-reports

You cannot pass parameter values to a sub-report of a target Crystal report.

Using the lsS parameter with OLAP Intelligence reports

If the target document is an OLAP Intelligence report (.car) you can use the IsS parameter to specify prompts. The parameters are passed in as a URL-encoded string using the unique name of the parameter set up in the OLAP Intelligence report.

Example: Opening a report to a specific page

If 23CAA3C1-8DBB-4CF3-BA%2CB8%2CD7%2CF0%2C68%2CEF%2C9C%2C6F is the URL-encoded unique name for the page parameter in the OLAP

64 BusinessObjects Dashboard Builder User Guide

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Intelligence report, you would use the following URL to open the OLAP Intelligence report to page 2:

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sType=car&sIDType=InfoObject&iDocID=440&lsS23CAA3C1-8DBB4CF3-BA%2CB8%2CD7%2CF0%2C68%2CEF%2C9C%2C6F=2

Example: Opening a cube parameter

If 8401682C-9B1D-4850-8B%2C5E%2CD9%2C1F%2C20%2CF8%2C1%2C62 is the URL-encoded unique name for the cube parameter opening the warehouse cube in the catalogue FoodMart 2000 on MSAS, you would use the following URL to open this cube parameter:

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sType=car&sIDType=InfoObject&lsS8401682C-9B1D-48508B%2C5E%2CD9%2C1F%2C20%2CF8%2C1%2C62=CATALOG%3DFood Mart%202000,CUBE%3Dwarehouse&iDocID=616

Using the lsM parameter with OLAP Intelligence reports

If the target document is an OLAP Intelligence report (.car) you can use the IsM parameter to specify prompts. The parameters are passed in as a URL-encoded string using the unique name of the parameter set up in the OLAP Intelligence report.

As was the case for the lsS parameter, lsM parameters are also passed in as a URL-encoded string using the unique name of the parameter set up in the OLAP Intelligence report.

Example: Opening a report

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sType=car&sIDType=InfoObject&lsMADC216EA-D9A5-42B5AE%2C21%2C84%2CA9%2CF9%2C6E%2C31%2C7=[%5BCustomers%5D.%5BCoun try%5D.%26%5BMexico%5D],[%5BCustomers%5D.%5BCoun try%5D.%26%5BCanada%5D]&iDocID=544

This is a memberset parameter opening up a report with Customers > Country > Mexico and Customers > Country > Canada in the view.

BusinessObjects Dashboard Builder User Guide 65

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

OpenDocument parameter overview

This section provides a brief overview of openDocument and includes a list of available commands. Details about the available commands, their specific uses, and relevant examples are also provided.

The exact syntax of the <platformSpecific> parameter depends on your implementation:

For Java implementations, use opendoc/openDocument.jsp in place of

•

the <platformSpecific> parameter.

The first parameter of the link

http://<servername>:<port>/OpenDocument/<platformSpecific>?

The first parameter, as displayed in the example above, must precede all other parameters. After this information, the parameters can appear in any order. The parameters of the function are displayed in the following table. The mandatory column indicates whether the parameter is required in the link.

Note: The document containing the openDocument link is called the parent

document, and it resides on the parent system. The document to which the link points is called the target document, and it resides on the target system.

Table 3-10: Platform Parameters

iDocID on page 69

sDocName on page 69

sIDType on page 70

sKind on page 70

sPath on page 71

66 BusinessObjects Dashboard Builder User Guide

DescriptionParameter

Document identifier.

Document name.

Crystal object type.

The file type of target Desktop Intelligence document.

The name of the folder and subfolder containing the target document.

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

DescriptionParameter

sType on page 71

token on page 71

Table 3-11: Input Parameters

lsC on page 72

lsM[NAME] on page 73

lsR[NAME] on page 76

lsS[NAME] on page 79

The file type of target document or report.

A valid logon token for the current CMS session.

DescriptionParameter

Specifies a contextual prompt if there is an ambiguity during SQL generation (Business Objects and Web Intelligence documents only).

Specifies a range of values for a prompt. [NAME] is the text of the prompt.

For Crystal targets only, indicates whether the link should open the full target report or just the report part specified in sReportPart.

Specifies a value for a single prompt.

[NAME] is the text of the prompt.

sInstance on page 81

sPartContext on page 82

sRefresh on page 82

Indicates which specific instance of the target report to open.

In Crystal Reports, a report part is associated to a data context.

Indicates whether a refresh should be forced when the target document or report is opened.

BusinessObjects Dashboard Builder User Guide 67

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

sReportMode on page 83

DescriptionParameter

For Crystal targets only, indicates whether the link should open the full target report or just the report part specified in sReportPart.

sReportName on page 83

sReportPart on page 84

Table 3-12: Output Parameters

NAII on page 85

sOutputFormat on page 85

sViewer on page 86

sWindow on page 87

Indicates which report to open if target document is multi-report.

Indicates which specific part of the target report to open.

DescriptionParameter

Forces the display of the prompt selection page.

Indicates the format in which the target document is opened.

Indicates the selected report viewer (CR & CA only).

Indicates whether the target report will open in the current browser window or whether a new window will be launched.

OpenDocument Platform parameters

The following tables list the openDocument platform parameters:

Note: Variables are denoted with angle brackets. You must substitute the

proper value for these variables. For example, you must use the name of your server in place of <servername> where it is contained in the code samples below, and you must use your port number in place of <port>.

68 BusinessObjects Dashboard Builder User Guide

iDocID

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Parameter syntax

iDocID

Example:

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sType=wid&sDocName=SalesReport&iDocID=2010

Note: To obtain the document ID, navigate to the document in InfoView,

Description of parameter

Document identifier.

Mandatory?

One of sDocName or iDocID is mandatory.

Values accepted for parameter

Document identifier (InfoObjectID).

hover your mouse over the document name hyperlink, and look for the ID number in the browser's status bar. You can also obtain the document ID from the Central Management Console.

sDocName

Parameter syntax

sDocName

Description of parameter

Document name without extension

If multiple documents have the same name, specify the correct document with iDocID.

Mandatory?

One of sDocName or iDocID is mandatory.

Values accepted for parameter

Document name.

Example:

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sPath=[Sales+Reports]&sDocName=Sales+in+200

BusinessObjects Dashboard Builder User Guide 69

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

sIDType

Parameter syntax

sIDType

Example:

http://<servername>:<port>/OpenDocument/<platformSpecific>?iDo cID=2010&sIDType=CUID

sKind

Parameter syntax

sKind

Description of parameter

Central Management Server (CMS) object identifier type.

Description of parameter

The file type of target Desktop Intelligence document.

Mandatory?

Yes if the target is a Crystal report or OLAP Intelligence report (sType=rpt

or =car ) in an

Object Package (otherwise, use

sPath and sDoc Name )

Mandatory?

Yes if the target is a Desktop Intelligence document (otherwise, use

sType )

Values accepted for parameter

• CUID

• GUID

• RUID

• ParentID

• InfoObjectID

(default)

Values accepted for parameter

• FullClient

Example:

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sKind=FullClient

70 BusinessObjects Dashboard Builder User Guide

sPath

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Parameter syntax

sPath

Example:

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sPath=[Sales+Reports]&sDocName=Sales+in+2005

sType

Parameter syntax

sType

Description of parameter

The name of the folder and subfolder containing the target document.

Description of parameter

The file type of target document or report.

Mandatory?

Yes if sDocName is specified and is not unique.

Mandatory?

Yes, but ignored for agnostic documents

Values accepted for parameter

Folder and/or subfolder:

[folder],[sub folder]

Values accepted for parameter

wid

•

rpt

•

car

•

Example:

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sType=wid

token

Parameter syntax

token

Description of parameter

A valid logon token for the current CMS session.

BusinessObjects Dashboard Builder User Guide 71

Mandatory?

Values accepted for parameter

The logon token for the current CMS session.

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Example:

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sType=wid&sDocName=Sales+in+2003&token=<logonToken>

OpenDocument Input parameters

The following tables list the openDocument input parameters:

Note: Variables are denoted with angle brackets. You must substitute the

lsC

Parameter syntax

lsC

Example:

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sType=wid&sDocName=SalesReport&iDocID=2010&lsC=Sales

Description of parameter

Specifies a contextual prompt if there is an ambiguity during SQL generation (Business Objects and Web Intelligence documents only).

Note: Not support-

ed by OLAP Intelligence

Mandatory?

Values accepted for parameter

A prompt value that resolves the ambiguity in the SQL generation.

72 BusinessObjects Dashboard Builder User Guide

lsM[NAME]

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Parameter syntax

lsM[NAME]

Description of parameter

Specifies multiple values for a prompt. [NAME] is the text of the prompt.

Mandatory?

Values accepted for parameter

BusinessObjects Dashboard Builder User Guide 73

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Parameter syntax

Description of parameter

Mandatory?

Values accepted for parameter

Multiple

•

prompt values, separated by a comma. If the target is a Crystal report, each value must be enclosed in square brackets. If the target is a OLAP Intelligence report, use the MDX WITH clause (refer to Using the

lsS parameter with OLAP Intelligence reports on page

64 and Using

the lsM parameter with OLAP Intelligence reports

on page 65).

74 BusinessObjects Dashboard Builder User Guide

no_value (only

•

for optional parameters)

Note: You can

remove an optional parameter from the prompt by set-

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Parameter syntax

Example:

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sType=rpt&sDocName=SalesReport&lsMSe lect+Cities=[Paris],[London]

Description of parameter

Mandatory?

Values accepted for parameter

ting it to no_value in the OpenDocument query string. If you leave an optional parameter out of the OpenDocument query string, a default parameter value will be applied.

BusinessObjects Dashboard Builder User Guide 75

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

lsR[NAME]

Parameter syntax

lsR[NAME]

Description of parameter

Specifies a range of values for a prompt. [NAME] is the text of the prompt.

Note: Not support-

ed by OLAP Intelligence

Mandatory?

Values accepted for parameter

76 BusinessObjects Dashboard Builder User Guide

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Parameter syntax

Description of parameter

Mandatory?

Values accepted for parameter

A range of val-

•

ues for the prompt, separated by a double period (..). If the target is a Crystal report, the range must be enclosed in square brackets and/or parentheses (use a square bracket next to a value to include it in the range, and parentheses to exclude it).

no_value (only

•

for optional parameters)

Note: You can

remove an optional parameter from the prompt by setting it to no_value in the OpenDocument query string. If you leave an optional parameter

BusinessObjects Dashboard Builder User Guide 77

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Parameter syntax

Example:

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sType=rpt&sDocName=SalesReport&lsRTime+Period:=[2000..2004)

Description of parameter

Mandatory?

Values accepted for parameter

out of the OpenDocument query string, a default parameter value will be applied.

78 BusinessObjects Dashboard Builder User Guide

lsS[NAME]

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Parameter syntax

lsS[NAME]

Description of parameter

Specifies a value for a single prompt. [NAME] is the text of the prompt.

Mandatory?

Values accepted for parameter

BusinessObjects Dashboard Builder User Guide 79

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Parameter syntax

Description of parameter

Mandatory?

Values accepted for parameter

A single

•

prompt value (refer to Using

the lsS parameter with OLAP Intelligence reports

on page 64 and Using the

lsM parameter with OLAP Intelligence reports on

page 65).

no_value (only

•

for optional parameters)

Note: You can

remove an optional parameter from the prompt by setting it to no_value in the OpenDocument query string. If you leave an optional parameter out of the OpenDocument query string, a default parameter value will be applied.

80 BusinessObjects Dashboard Builder User Guide

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Example:

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sType=wid&sDocName=SalesReport&iDocID=2010&lsSSe lect+a+City=Paris

sInstance

Parameter syntax

Description of parameter

Mandatory?

Values accepted for parameter

User (Link to

•

latest instance owned by current user)

Last (Link to

•

sInstance

Indicates which specific instance of the target report to open.

No (use with

sDocName and lsS[NAME])

latest instance for report)

Param (Link to

•

latest instance of report with matching parameter values)

Example:

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sPath=[Sales+Reports]&sDocName=Sales+in+2003&sReport Part=Part1&sInstance=User

BusinessObjects Dashboard Builder User Guide 81

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

sPartContext

Parameter syntax

sPartContext

Example:

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sPath=[Sales+Reports]&sDocName=Sales+in+2005&sReport Part=Part1&sPartContext=0-4-0

sRefresh

Parameter syntax

Description of parameter

In Crystal Reports, a report part is associated to a data context.

Description of parameter

Mandatory?

Yes if a value is specified for sRe

portPart

Mandatory?

Values accepted for parameter

Data context of the report part.

Values accepted for parameter

Y (forces the

•

document’s

sRefresh

Indicates whether a refresh should be forced when the target document or report is opened.

refresh)

N (note that

•

the refresh on open feature overrides this value)

Example:

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sType=wid&sDocName=SalesReport&iDocID=2010&sRefresh=Y

82 BusinessObjects Dashboard Builder User Guide

sReportMode

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Parameter syntax

sReportMode

Example:

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sPath=[Sales+Reports]&sDocName=Sales+in+2003&sReport Part=Part1&sReportMode=Part

sReportName

Parameter syntax

sReportName

Description of parameter

For Crystal targets only, indicates whether the link should open the full target report or just the report part specified in sRe

portPart.

Description of parameter

Indicates which report to open if target document is multi-report.

Mandatory?

No (default is Full) Only applies if a

value is specified for sReportPart

Mandatory?

No (default is the first report)

Values accepted for parameter

Full

•

Part

•

Values accepted for parameter

Report name for Web Intelligence documents, subreport for Crystal Reports, pages for OLAP Intelligence reports.

Example:

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sType=wid&sDocName=Sales+in+2003&sReportName=First+Re port+Tab

BusinessObjects Dashboard Builder User Guide 83

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

sReportPart

Parameter syntax

sReportPart

Example:

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sPath=[Sales+Reports]&sDocName=Sales+in+2003&sReport Part=Part1

Description of parameter

Indicates which specific part of the target report to open.

Mandatory?

Values accepted for parameter

Name of the report part.

OpenDocument Output parameters

The following tables list the openDocument output parameters:

Note: Variables are denoted with angle brackets. You must substitute the

84 BusinessObjects Dashboard Builder User Guide

NAII

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Parameter syntax

Description of parameter

Mandatory?

Values accepted for parameter

Y (all prompts

•

whose values are passed with lsS, lsM

NAII

Forces the display of the prompt selection page.

Note: Not support-

ed by OLAP Intelligence

or lsR are pre-selected)

N (displays

•

only the prompts whose values passed with

lsS, lsM or lsR)

Example:

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sType=wid&sDocName=SalesReport&iDocID=2010&NAII=Y

sOutputFormat

Parameter syntax

sOutputFormat

Description of parameter

Indicates the format in which the target document is opened.

BusinessObjects Dashboard Builder User Guide 85

Mandatory?

No (default is HTML if the parameter is not specified in the link)

Values accepted for parameter

• H (HTML)

• P (PDF)

• E (Excel)

• W (Word)

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Example:

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sPath=[Sales+Reports]&sDocName=Sales+in+2003&sOutputFor mat=E

sViewer

Parameter syntax

sViewer

Example:

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sPath=[Sales+Reports]&sDocName=Sales+in+2003&sViewer=html

Example:

Note: In order to use parameters in the URL with the ActiveX viewer, :connect

must be appended to the URL, followed by the parameters.

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sPath=[Sales+Reports]&sDocName=Sales+in+2003&sViewer=ac tx:connect&IsMCountry=[Thailand],[Norway]

Description of parameter

Indicates the viewer that is used to view the document.

Mandatory?

Values accepted for parameter

• html

• actx (Crystal

reports only)

• java (Crystal

reports only)

86 BusinessObjects Dashboard Builder User Guide

sWindow

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Parameter syntax

sWindow

Example:

http://<servername>:<port>/OpenDocument/<platformSpecif ic>?sType=wid&sDocName=SalesReport&iDocID=2010&sWindow=New

Description of parameter

Indicates whether the target report will open in the current browser window or whether a new window will be launched.

Mandatory?

Values accepted for parameter

Same (current

•

browser window)

New (new

•

browser window is launched)

Contextual report linking

The openDocument feature allows you to create contextual links between Crystal reports, OLAP Intelligence reports and Web Intelligence documents. To do this, you construct a URL using the openDocument syntax and then insert the URL into a Crystal report, OLAP Intelligence report or Web Intelligence document.

Contextual report linking allows report designers to specify associations for documents residing in either a Crystal Reports environment (unmanaged) or a BusinessObjects Enterprise environment (managed). Once these associations are created, users follow the resulting navigational paths embedded in the linked documents.

This feature enables you to invoke Business Objects and Web Intelligence documents from Crystal Reports and vice versa. This feature relies on functionality that allows the user to do the following:

Link Web Intelligence or Business Objects documents within the document

•

domain.

Link report objects in Crystal Reports.

•

BusinessObjects Dashboard Builder User Guide 87

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

Click the appropriate link to jump to that section:

To insert a link into a Crystal report on page 88

•

To create a link to another report or document from an OLAP Intelligence

•

report on page 88

Creating links in Web Intelligence documents on page 89

•

To insert a link into a Crystal report

You can use openDocument to create hyperlinks in Crystal Reports. To create a link to another report or document, use the Hyperlink Tab of the field Format Editor.

1. Open the source report in Crystal Reports.

2. Right-click the field in which you want to insert the openDocument link

and select Format from the shortcut menu.

3. In the Format Editor, select the Hyperlink tab.

4. Select A website on the Internet.

5. In the “Hyperlink information” area, leave the Website Address field

empty and click the Format Formula Editor button.

6. Enter the openDocument link in the following format:

"http://[openDocument parameters]"+{Article_lookup.Fami ly_name}

Where [openDocument parameters] are described in OpenDocument

parameter overview on page 66, and the {Article_lookup.Family_name}

enables the report to pass context-dependent data.

Note: Test your link in a browser window before inserting it into a report

or document.

7. Click Save and Close to leave the Formula Workshop.

8. Click OK in the Formula Editor to save the link.

To create a link to another report or document from an OLAP Intelligence report

You can use openDocument to create hyperlinks in OLAP Intelligence reports.

1. Open the source report in the OLAP Intelligence designer.

2. On the Tools menu, select Action Manager .

3. Click New to create a new action.

88 BusinessObjects Dashboard Builder User Guide

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

4. Enter an action name.

5. Select the area to which the action (the link) will apply.

6. Enter the openDocument link using the parameters and syntax described

in this document.

Tip: Test your link in a browser window before inserting it into a report

or document.

7. Click OK to save the link.

8. Close the Action Manager dialog box.

9. Create an Analysis Button on the source report.

10. Right-click the Analysis Button.

11. In the drop-down menu, select Properties and then Edit .

12. Select Launch an action .

13. Select the action that corresponds to the openDocument link created in

steps 3 through 6.

14. Click OK .

Creating links in Web Intelligence documents

You can define objects in a universe that allow Web Intelligence and BusinessObjects users to create reports whose returned values include links to other reports and documents.

When these reports are exported to the repository, users can click returned values displayed as hyperlinks to open another related document stored in the document domain of the repository.You create these links using the openDocument function in the definition of an object in Designer.

More information

For full information on creating links in Web Intelligence reports, see the Building Reports Using the WebIntelligence Java Report Panel guide.

You enable report linking in a universe by creating an object (the link object) whose returned values are the same as the values used as input to a prompt in an existing report (the target report).

The openDocument function allows the values for the link object to be returned as hyperlinks. When the user clicks the hyperlink, its value is used as the prompt input for the target report.

BusinessObjects Dashboard Builder User Guide 89

Using analytics for analysis

Linking from goal, universe query and metric-based analytics

You can create documents using the link object as you would with any other object. Users can then click the hyperlinks to access more detailed documents related to the link object.

To create a link object, use the openDocument function in the object’s Select statement. The Select statement for a link object follows this order:

'<a href="http://<servername>:<port>/OpenDocument/<platformSpe cific>?sDocName=<document name>&sType=<document type>&iDo cID=<document id>&lsS<prompt message>='+object SELECT+'">'+ob ject SELECT+'</a>'

The concatenation operator (+) applies for Microsoft Access databases. Use the operator appropriate to your target RDBMS.

For more details on the Select statement, creating link objects, and using link objects in InfoView, refer to the Designer’s Guide.

Sending information to the Viewer analytic in a dashboard using openAnalytic

Using the openAnalytic syntax, you can send information from the following documents saved on the Central Management Server (CMS) to a Viewer analytic on a dashboard:

• Web Intelligence reports

• Crystal Reports

• Text analytic

• Desktop Intelligence reports

• Web page analytic

Sample syntax:

The key items in the sample are aa-open-inlist.jsp and target='hid

denframe'.

1. In a text editor, copy and paste the sample syntax.

90 BusinessObjects Dashboard Builder User Guide

Using analytics for analysis

Emailing an analytic