BIWorkspacesUserGuide ... · PDF fileother Objects and the Business Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius,

BI Workspaces User Guide■ SAP BusinessObjects Business Intelligence platform 4.0 Support Package 4

2012-03-15

© 2011 SAP AG. All rights reserved.SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAPBusinessObjects Explorer, StreamWork, and other SAP products and services mentioned herein as

Copyright

well as their respective logos are trademarks or registered trademarks of SAP AG in Germany andother countries.Business Objects and the Business Objects logo, BusinessObjects, Crystal Reports,Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products and servicesmentioned herein as well as their respective logos are trademarks or registered trademarks of BusinessObjects Software Ltd. Business Objects is an SAP company.Sybase and Adaptive Server, iAnywhere,Sybase 365, SQL Anywhere, and other Sybase products and services mentioned herein as well astheir respective logos are trademarks or registered trademarks of Sybase, Inc. Sybase is an SAPcompany. All other product and service names mentioned are the trademarks of their respectivecompanies. Data contained in this document serves informational purposes only. National productspecifications may vary.These materials are subject to change without notice. These materials areprovided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only,without representation or warranty of any kind, and SAP Group shall not be liable for errors oromissions with respect to the materials. The only warranties for SAP Group products and servicesare those that are set forth in the express warranty statements accompanying such products andservices, if any. Nothing herein should be construed as constituting an additional warranty.

2012-03-15

Contents

Welcome to SAP BusinessObjects BI workspaces................................................................5Chapter 1

About this document................................................................................................................51.1Who should read this document?.............................................................................................51.2Overview..................................................................................................................................51.3

Working with BI workspaces...................................................................................................7Chapter 2

Overview..................................................................................................................................72.1Creating a BI workspace..........................................................................................................82.2Copying or saving a BI workspace...........................................................................................92.3Renaming a BI workspace........................................................................................................92.4Editing a BI workspace...........................................................................................................102.5Adding tabs and sub tabs to BI workspaces...........................................................................112.5.1Renaming a BI workspace tab or sub tab...............................................................................122.5.2Moving BI workspace tabs and sub tabs ...............................................................................122.5.3Duplicating a BI workspace tab or sub tab .............................................................................132.5.4Scrolling BI workspace tabs and sub tabs..............................................................................132.5.5Deleting a tab or sub tab in BI workspace .............................................................................142.5.6BI workspace properties .......................................................................................................142.5.7Adding security to BI workspaces..........................................................................................142.5.8Modifying the layout in a BI workspace .................................................................................162.5.9Module Library in BI workspace.............................................................................................192.5.10Printing a BI workspace .........................................................................................................212.6Deleting a BI workspace .......................................................................................................212.7

Working with modules..........................................................................................................23Chapter 3

Overview................................................................................................................................233.1Types of modules...................................................................................................................233.2BI launch pad modules...........................................................................................................233.2.1Compound module.................................................................................................................243.2.2Text module...........................................................................................................................253.2.3Web Page module..................................................................................................................253.2.4Using a Navigation List on a BI workspace tab.......................................................................253.2.5

2012-03-153

Viewer module.......................................................................................................................263.2.6Creating and configuring modules..........................................................................................283.3Working with modules............................................................................................................283.3.1Data sources for modules......................................................................................................313.3.2Configuring the display of Crystal Reports.............................................................................313.3.3Configuring the display of Web Intelligence reports ...............................................................333.3.4Linking modules and documents............................................................................................353.3.5Content linking.......................................................................................................................363.3.6

More Information...................................................................................................................41Appendix A

Index 43

2012-03-154

Contents

Welcome to SAP BusinessObjects BI workspaces

1.1 About this document

This document provides information and procedures for using SAP BusinessObjects BI workspaces.BI workspaces is a web application that is integrated to function within the BI launch pad application.BI launch pad provides the interface for working with objects in SAP BusinessObjects BusinessIntelligence platform. The various data sources in the form of different types of objects, Crystal reports,BI workspaces, Analysis edition for OLAP, Web Intelligence documents, and Dashboards models aredeployed and integrated into the application as plug-in components from SAP BusinessObjects BusinessIntelligence platform. This document contains topics that provide information about the new featuresand enhancements in BI workspaces, types of BI workspaces and modules, how to create BI workspacesand modules, and content linking between various data sources using BI workspaces.

1.2 Who should read this document?

This document is intended for users, such as a business report creator, professional report creator, orBI workspace administrator working on the SAP BusinessObjects Business Intelligence platform andBI workspaces applications on Microsoft Windows, Unix, or Linux operating systems. Familiarity withreport generation, other types of data sources, various methods of content linking for deeper dataanalysis, and performance statistics is essential.

For more information about the product, refer to the Getting Started Creating BI workspaces Guideand SAP BusinessObjects BI workspaces Online Help Guide.

1.3 Overview

BI workspaces helps you manage, understand, monitor, and track your business activities andperformance using modules and BI workspaces. Management of corporate BI workspaces alloworganizations to gain insight from underlying analysis and alter business rules as conditions change.BI workspaces provides consistent, up-to-date means for monitoring critical business areas. It alsoprovides tab-based navigation and page creation capabilities for all users. You can build applicationsquickly, without programming, and customize existing applications with a point-and-click assembly.

2012-03-155


With BI workspaces, you can:

• Structure your web-based application menus and hierarchy• Assemble your application by selecting modular components and dropping them onto the desired

pages• Select a template from a catalog of predefined module templates• Apply these reusable, prebuilt module templates to a broad range of business scenarios• Customize the application

BI workspaces provides a simple web interface that lets you define the look and feel of the content.You can easily incorporate existing content in applications, such as Crystal reports, Web Intelligencedocuments, and Dashboards models. Users can create their own application views, while retainingadministrative control.

This document helps you:• Understand the basic features of BI workspaces• Understand the different types of BI workspaces and modules• Create BI workspaces and modules• Learn about content linking between modules

Note:The Performance Manager, Set Analysis, Predictive Analysis, Process Control components, and theDashboards and Analytics setup have been removed. The tracing option has been moved to the CentralManagement Console (CMC) server summary and unified tracing sections respectively.

For information about configuration, summary, and tracing details, refer to the SAP BusinessObjectsBusiness Intelligence platform Administrator 's Guide , SAP BusinessObjects Business Intelligenceplatform 4.0 Feature Pack 3 Installation Guide , SAP BusinessObjects Business Intelligence platform4.0 Feature Pack 3 Deployment Planning Guide, and SAP BusinessObjects Business Intelligenceplatform User's Guide.

Related Topics• Overview• Creating a BI workspace• Creating a module

2012-03-156


Working with BI workspaces

2.1 Overview

A BI workspace allows you to organize and display different BI platform data sources, such as WebIntelligence documents, hyperlinks, Crystal reports, non-visual modules, or external pages such as webpages via URL, in a single view. You can analyze and manage complex data effectively, and share theinformation across organizations. BI workspaces provides high visibility of your organizational goalsand enables you to monitor your organization's performance and growth. BI workspaces provides asingle view of all the elements of business that you need to track on a daily basis as well as interportletcommunication capabilities for enabling page components to talk to each other and exchange information.

You can build your own portfolio of reports and categories and create one or more BI workspaces anddisplay them as needed.

BI workspaces can contain the following types of objects:• Modules• Web Intelligence documents, Analysis edition for OLAP documents, and Dashboards models• Crystal reports• Adobe Reader PDF documents• Microsoft Excel spreadsheets• Microsoft Word documents• Text files• Rich text (RTF) files• Microsoft PowerPoint presentations• Hyperlinks

You can store your BI workspaces in the folders of the "Documents" tab:• Public Folders, My Favorites, and Personal Categories

• BI workspaces saved in "Public Folders" contain BI workspaces and modules created for publicviewing. These BI workspaces can be accessed and viewed by everyone.

• BI workspaces saved in "My Favorites" or "Personal Categories" contain BI workspaces andmodules created for personal viewing. They store information about modules whose parameterscan be extended and modified personally. These BI workspaces cannot be accessed and viewedby everyone. A BI workspace, whether saved in "Public Folders" or "Personal Categories", cancontain one or more tabs and sub tabs.

For example, you can create a BI workspace that contains a website, a Crystal report or a WebIntelligence report that you frequently access. You can store this BI workspace in "Personal

2012-03-157


Categories" or" My Favorites" folder and set it as your default view, or click its link in the navigationpanel. The default location for a BI workspace is your favorites folder.

Related Topics• Creating a BI workspace• Editing a BI workspace• Deleting a BI workspace

2.2 Creating a BI workspace

A BI workspace can contain useful, informative, and motivating content based on analyzed data. BIworkspaces also help to define strategies. BI workspaces and compound modules can be created oredited only inside BI launch pad. This includes OpenDocument and PIK as well, even if the user canedit them by permission. The default BI launch pad home page is read-only. All other custom homepages can be edited, in BI workspaces. When custom home pages are edited, the changes areautomatically available in BI launch pad.

To create a BI workspace:1. Gather the following:

• A list of information that you want the BI workspace or BI workspace tab to transmit. Whencreating a corporate BI workspace, analyze your audience to determine the information theyneed. If you have a lot of information, consider creating categories of information and creating atab in the BI workspace for each category.

• A list of content that you want to use. Modules can include Web Intelligence reports, Dashboardsmodels, or Crystal reports.

• A rough sketch of how you want to organize modules on the BI workspace tabs and sub tabs.More information is not always best, and a cluttered, crowded BI workspace is counter-productive.

• A list of data security issues for corporate BI workspaces. What data is appropriate for youraudience? How much detail do you want them to see?

2. In BI launch pad, do the following to create a BI workspace:• Click Applications > BI workspace.

3. Make the changes that you require, such as adding modules to the workspace.4. Click Save or Save As, provide a name and location for the new BI workspace, and then click OK.

The "Save As" dialog box is displayed.

5. Select a location to save the BI workspace, assign a category, and click OK.

Note:Specify the folder in which you want to save the BI workspace. Store BI workspaces in either "PersonalCategories" or "Public Folders".

6. To edit the BI workspace, click Edit BI workspace.

2012-03-158


The BI workspace opens in edit mode.

Related Topics• Editing a BI workspace• Overview• Adding tabs and sub tabs to BI workspaces• BI workspace properties

2.3 Copying or saving a BI workspace

You can save new BI workspaces or open existing BI workspaces using the menu options provided onthe BI workspace toolbar. The "Save As" option copies an existing BI workspace and saves it with anew name that you enter.

Note:When you save a BI workspace, the original or existing BI workspace is not altered. The "Save As"option displays a dialog box where you can enter a new name for the BI workspace. If the new nameyou enter exists in either of the personal category or public folders, a message appears indicating thata BI workspace of that name already exists in the location selected, and you will not be allowed to savethe BI workspace. If a BI workspace with a duplicate name does not exist in either of the Public Folders,My Favorites, or Personal Categories, you will be allowed to save the BI workspace in the locationselected.

2.4 Renaming a BI workspace

To rename a BI workspace:1. From the "Documents" tab, browse the "Public Folders" in the left pane to locate the BI workspace

that you want to rename.2. Right-click the BI workspace and select Properties.

The BI workspace "Properties" dialog box is displayed.

3. On the "General Properties" page, in the "Title" field, enter a new name for the BI workspace.4. Click Save & Close.

The BI workspace is saved with the new name.

2012-03-159


2.5 Editing a BI workspace

To edit a BI workspace:1. Double-click the name of the BI workspace from "Public Folders" or "Personal Categories", or browse

the categories in "Documents".The selected BI workspace opens.

2. Click Edit BI workspace.The edit BI workspace toolbar and Module Library "handle" are displayed.

Note:The administrator assigns the right to edit a specific BI workspace in CMC. You must have theappropriate edit rights to edit BI workspaces. If you edit a BI workspace saved in a public folder, thechanges are visible to everyone viewing it. If you edit a BI workspace saved in a personal category,the changes are visible only to you.

3. To configure the workspace properties, click the arrow on the right side of the tab or sub tab andselect Properties.The "Properties" window is displayed.

4. Select the layout style and click OK to close the "Properties" window.

Note:The layout style that you select is applied to the entire BI workspace, including the tabs and subtabs in that BI workspace. However, the layout style that you select from the tab or sub tab propertieswindow applies only to that particular tab or sub tab and not the entire BI workspace.

5. In the Module Library, select and drag module objects to the layout area. Resize and fit them accordingto the preferred BI workspace design.

Note:Modules that you drag and drop from the Module Library to the BI workspace are stored as embeddedobjects within that BI workspace. Text and compound modules created through the Applications> Module option are saved and stored as independent InfoObjects in the CMS.

6. Add tabs or sub tabs to the BI workspace.7. You can edit the BI workspace using the following toolbar options:

• New

Creates a new BI workspace.

• Open

Opens an existing BI workspace stored in the "Public Folders" or "My Favorites" category.

• Save

Applies the latest changes you made to the BI workspace.

2012-03-1510


•Save As

Saves the new BI workspace in the "Public Folders" or "My Favorites" category.

• Show Module Library

Opens the Module Library.

• Revert Changes

Cancels any changes entered in the BI workspace and returns to the previously saved version.

• Content Linking

Enables content linking between modules.

•Exit Edit Mode

Exits edit mode. If you did not save your changes, this action cancels the modifications madesince the last save action.

Note:When you choose to exit edit mode, you are promoted to either save or cancel the changes madeto the BI workspace.

Related Topics• Adding tabs and sub tabs to BI workspaces• Modifying the layout in a BI workspace• Creating a BI workspace• BI workspace properties

2.5.1 Adding tabs and sub tabs to BI workspaces

Creating tabs and sub tabs in your BI workspace enables you to fully and clearly organize your content.

To add tabs and sub tabs to BI workspaces:1. Open your workspace.2. Click Edit BI workspace.

The BI workspace opens in edit mode.

3. To create a tab in your BI workspace, click Add a new tab. To create a sub tab in the BI workspace,click Add a new sub tab.The name field for the new tab is activated.

4. Type a name and press Enter.

2012-03-1511


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

5. Configure the tab or sub tab.6. Click Save to save your edits.7. After you have finished modifying the BI workspace, click Exit Edit Mode.

A scroll button appears only when there are several tabs and sub tabs. You can use the scroll buttonto switch between tabs and sub tabs and view the complete list of tabs and sub tabs that you created.The BI workspace is saved when you click the Save button on the BI workspace toolbar. However,you will not lose the changes and do not need to keep clicking Save when you switch between tabsor sub tabs.

Related Topics• Editing a BI workspace• Module Library in BI workspace

2.5.2 Renaming a BI workspace tab or sub tab

To rename a BI workspace tab or sub tab:1. From the BI workspace, select the tab or sub tab whose name you want to edit.2. Click the arrow next to the tab or sub tab title.3. From the menu, select Rename.

The name field is activated.

4. Type the new name and press Enter.The tab or sub tab is saved with the new name.

2.5.3 Moving BI workspace tabs and sub tabs

To move BI workspace tabs and sub tabs:• From the BI workspace, select the tab or sub tab that you want to move, and drag it to the new

location.

Note:To move a sub tab to another tab, drag and drop it onto that tab.

The tab or sub tab is placed in a new location on the BI workspace toolbar.

2012-03-1512


2.5.4 Duplicating a BI workspace tab or sub tab

You can duplicate a tab or sub tab in a BI workspace to create a new tab similar to the existing one.You can subsequently rename and modify the copied BI workspace tab or sub tab.

For example, you can create a standard corporate BI workspace "Welcome" tab that includes thecorporate logo, documents, and some common indicators.

Note:When you duplicate BI workspace tabs and sub tabs, all the modules in the duplicated tabs are alsocopied. The sub tab hierarchy in a duplicated tab is also duplicated.

To duplicate a BI workspace tab or sub tab:1. Select the BI workspace tab or sub tab that you want to duplicate, click the arrow next to the title

and select Duplicate.A duplicate of the object appears to the right of the existing objects with the title appended with anedition number. For example, if you make a duplicate of the 'Sales' tab, the title of the new tab is'Sales(1)'.

2. Optionally, rename the tab or sub tab.

Note:You can recreate a BI workspace tab using BI workspace objects in the "BI workspaces " category inthe module library. Select the item and then drag and drop it in the BI workspace layout.

Related Topics• Renaming a BI workspace tab or sub tab• Module Library in BI workspace

2.5.5 Scrolling BI workspace tabs and sub tabs

At times, the number of tabs or subtabs in a BI workspace is greater than the number of tabs that canbe fully displayed. To view tabs that are not displayed:1. From the BI workspace, select the tab or sub tab that you want to edit.2. Use the following controls to scroll through and display the tabs:

• : to scroll through the BI workspace tabs and sub tabs one by one• : to select the tab or subtab name from a dropdown menu

2012-03-1513


2.5.6 Deleting a tab or sub tab in BI workspace

You can delete the tabs and sub tabs that you created in a BI workspace stored in either the publicfolders and personal categories.

To delete a tab or sub tab in a BI workspace:1. Select the tab or sub tab in the BI workspace that you want to delete.2. Click the arrow in that tab and select Delete.3. In the "Remove tab" dialog box, click Yes.

2.5.7 BI workspace properties

To display the properties menu for a BI workspace tab or sub tab in the BI workspace edit mode, clickthe arrow in the BI workspace tab or sub tab. You can configure the following properties:• The help URL

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

• Style sheet

You can select a style sheet for a BI workspace. You set the default option in the BI launch padpreferences.

BI workspaces inherit their style from the style sheet selected in the BI launch pad preferences. BIworkspace sub tabs inherit their style from their parent BI workspace tabs.

2.5.8 Adding security to BI workspaces

BI workspaces saved in public folders share vital information across a large community or with specificgroups of people. These BI workspaces can be used for information-sharing.

With public BI workspaces, you can set additional security options that cannot be shared with a groupof people for business confidentiality or any other purpose. You can set security rules on any BIworkspace through the BI platform Central Management Console (CMC).

Ways to control access to data in a corporate BI workspace include:

2012-03-1514


• At the folder level: BI workspaces are stored in the BI launch pad "Public Folders". Administratorscan limit access to a folder in the folder's access settings or in account settings in the CMC forindividual users or user groups.

• Via user rights: Only those with specific edit rights can edit BI workspaces.

To add security features to a BI workspace through the CMC.1. In the SAP BusinessObjects Business Intelligence platformCentral Management Console (CMC),

expand the list of BI workspaces from the "Folders" view and select a BI workspace.2. Right-click the BI workspace and choose User Security.

The "User Security" window opens.

3. Click Add Principals.The "Add Principals" window page opens with the available list of users and groups.

4. Select a user from the "Available users/groups" list and click the > arrow to move the user to the"Selected users/groups" list.

5. Click Add and Assign Security.The "Assign Security" window opens with the available access levels.

6. Select one of the following security options from the "Available Access Levels" section and click the> arrow to add it to the Assigned Access Levels list:

DescriptionTitle

Grants full accessFull Control

Grants full access rights and ownership to the objectFull Control (Owner)

Grants view rights for objects and view-on-demand contentSchedule

Grants view rights for objectsView

Grants view rights for objects and view-on-demand contentView On Demand

The selected access level is moved to the "Assigned Access Level" section.

7. Click Apply and OK.The "User Security" window opens with the selected access level displayed in the "Add Principals"page.

8. Click Close to go back to the folder view in CMC.

Note:When you select a view access level, the Edit BI workspace button is deactivated.

Note:For more information about setting rights for BI workspaces, refer to the Rights Appendix topic in theSAP BusinessObjects Business Intelligence platform Administrator's Guide.

2012-03-1515


2.5.9 Modifying the layout in a BI workspace

You can modify the layout of tabs and sub tabs created in BI workspaces and saved in the personalcategories or public folders.

To modify the layout in a BI workspace:• In the BI workspace that you are editing, select the layout style:

• To place objects on a BI workspace 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 mixedcolumn or row layout.

• To construct a column-structured BI workspace, select the "Columns" layout.

Note:When you change the layout of a BI workspace that contains modules, the modules are rearrangedto fit into the new layout mode.

Related Topics• Editing a BI workspace• Configuring the display options of a BI workspace module• Working with a BI workspace or compound module in Freeform layout mode• Working with a BI workspace in Template layout mode

2.5.9.1 Configuring the display options of a BI workspace module

To configure the display options for a BI workspace:1. Select a BI workspace tab or sub tab and click Edit BI workspace.

The "Edit Contents" dialog box is displayed.

2. In the title bar of the BI workspace module that you want to edit, click the Edit button.3. Open the Layout tab.4. Choose from the following options:

2012-03-1516


DescriptionOption

The module is displayed as a linked object that appears in a new tabwhen clicked.

Note:When you click on the link in a BI workspace that contains a "Viewer"module, the link destination opens in the "Viewer".

A link, so only the name isvisible

The module is displayed as an object in the tab.A window inside of a tab

Adds a border around a module.Show window border

5. Click OK.

2.5.9.2 Working with a BI workspace or compound module in Freeform layoutmode

The "Freeform" layout mode allows you to place objects in a BI workspace tab or sub tab or compoundmodule without using any specific layout format. In the "Freeform" mode, you can use the grid optionsto align objects.

To modify the BI workspace in "Freeform" layout mode:1. In the BI workspace or compound module edit mode, select Freeform from the "Layout" list.

The workspace background becomes blank.

2. To activate a grid on the empty background, select a grid size from the "Grid size" dropdown list.3. Select the Snap to grid checkbox to make objects in the layout area adhere to the grid lines.

When you move objects on the layout, or add new objects, they will snap to the gridlines.

Related Topics• Module Library in BI workspace• Adding tabs and sub tabs to BI workspaces• Configuring the display options of a BI workspace module

2.5.9.3 Working with a BI workspace in Template layout mode

2012-03-1517


The "Template" layout mode offers several layout formats for BI workspace objects.

To modify a BI workspace in "Template" layout mode:1. In the BI workspace 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 BI workspace in the following manner:• When you switch from "Freeform" mode, if the BI workspace objects are not in any particular

order, they are placed in adjacent columns. When you select a template, the BI workspace objectsare moved to fit rows and columns in the template that you select.

• If you switch from "Columns" mode and select a template, the BI workspace objects shift to fitthe cells in the template.

• If you have more objects than available placeholders in the selected predefined template, theextra modules are appended to the bottom of the BI workspace.

• Empty spots can occur when you switch to a template, or between templates. Rearrange themodules as necessary.

3. To have the BI workspace columns adjust to the width of the browser window when it is enlargedor reduced in size, activate Scale width.

Note:Scale width and Scale height are available only in Template mode.

4. To have the BI workspace rows adjust to the height of the browser window when it is enlarged orreduced in size, activate Scale height.

5. To split components, click one of the following icons from the component toolbar:

DescriptionOption

The component splits into side-by-side components."Split component vertically"

The component splits into components that are one above the other."Split component horizontally"

Note:These options are available in Template mode only.

Related Topics• Module Library in BI workspace• Working with a BI workspace or compound module in Freeform layout mode• Configuring the display options of a BI workspace module

2.5.9.4 Working with a BI workspace in Columns layout mode

2012-03-1518


The "Columns" layout mode allows you to add, remove, and resize the columns by adjusting the lengthand width of the BI workspace objects. You can drag each column in the layout to resize them. Thisenhances viewing and usability of BI workspaces.

To modify a BI workspace in "Columns" layout mode:1. In the BI workspace edit mode, select Columns from the "Layout" list.2. You can use the following controls to define your layout:

DescriptionOption

Adds columns to the layoutAdd Column

Removes columns from the layoutRemove Column

Resizes the layout and objects accordinglyClick object and drag its edges

Related Topics• Module Library in BI workspace• Working with a BI workspace or compound module in Freeform layout mode• Configuring the display options of a BI workspace module

2.5.10 Module Library in BI workspace

The "Module Library" toolbar provides the following options:

• "Templates"

Contains the following list of pre-defined module templates that you can customize to display yourdata.• Group• Navigation List• Text module• Viewer• Web Page module

• "BI Launch Pad modules"

Includes modules from the BI launch pad home page:• My Alerts• My Applications• My Inbox• My Recently Run Documents• My Recently Viewed Documents

2012-03-1519


• SAP StreamWork Feed• "Public Modules"

Contains BI workspaces stored in public folders.

• "Private Modules"

Provides a list of modules currently available in personal categories or (user 's) My Favorites folder.

Note:The "Private Modules" tab appears only when you open a personal BI workspace that is stored in"My Favorites" or "Personal Categories".

• "BI Workspaces"

Contains all the existing modules and provides a list of available BI workspaces (by user rights).Users can add a tab, sub tab or module from another BI workspace to the currently open BIworkspace.

• "Document Explorer"

Enables you to browse the personal categories and public folders and categories available in BIlaunch pad. The root folder displays the "Document Explorer" page with its folders and categories.

Tip:To activate or deactivate the Module Library, click Show Module Library on the BI workspace toolbar.You can also set the Module Library as docked or floating in the BI workspace layout.

Note:You can drag and drop an existing module from the Module Library to the tab or sub tab level on theBI workspace toolbar. This enables you to reuse the existing modules while creating new BI workspaces.

Related Topics• Creating a BI workspace• Content linking

2.5.10.1 Module Library search

You can use the search box at the top of the Module Library to search for any document in the SAPBusinessObjects Business Intelligence platform by typing the keyword and clicking the icon. The resultsare displayed below the Module Library toolbar. To clear the results, click any of the toolbar icons.The search filters all documents whose names match the keyword. However, it does not provide anymetadata search.

Note:You can search only for modules that are embedded in BI workspaces. A module is not an InfoObjectwithin a BI workspace. The "Module Library" search function does not work for BI workspaces or modules

2012-03-1520


stored in Public Folders, Templates list, BI launch pad modules list, and Document Explorer. For moreinformation, refer to the Searching in BI launch pad topic in the BI Launch Pad User's Guide.

2.6 Printing a BI workspace

The print option allows you to view and print dynamic content in a BI workspace. It displays the currentstate of the BI workspace view so that you do not have to reload a particular document for printing.

Tip:To print a BI workspace containing many objects, it is recommended that you first change the printersettings to landscape.

To print a BI workspace:1. In the BI workspace, click the Print button in the toolbar.

The print preview page is displayed with the print options and a preview of the BI workspace tab orsub tabs that will be printed.

2. Select one of the following options:• Current Tab, to print just the tab you are currently viewing. This is the default option.

• All Tabs, to print all of the tabs and sub tabs in the BI workspace you are currently viewing.

3. Click Print.

Each BI workspace tab is printed on one page.

Note:The contents of the BI workspace are adjusted to fit onto one page. Therefore items can appearsmaller.

The print preview resets the BI workspace view to the default view. For example, a BI workspacewith a module loads the data for the slice California for year 2007 by default. The user changesthe slice to Texas and moves the slider to year 2005. If the user clicks Print, the data of Texas foryear 2005 does not get loaded. The data of California in the year 2007 gets loaded. The usercan choose to change the slice to Texas in the print page and click Print.

2.7 Deleting a BI workspace

Before you delete a BI workspace, ensure that you have the appropriate permissions to perform adeletion. Since BI workspaces may contain vital information for corporate purposes, it is important tocheck with the stakeholders before deleting the workspace.

To delete a BI workspace:

2012-03-1521


1. From the Documents pane in BI launch pad, browse to the public folder or personal category nodethat contains the BI workspace.

2. Click Organize > Delete to delete the selected workspace.

2012-03-1522


Working with modules

3.1 Overview

Modules are documents into which you insert data for viewing in a BI workspace. Modules can be basedon Web Intelligence documents, Crystal reports, Dashboards models, or non-visualization modules,such as Web Page, Text, or Viewer modules that display data for analysis. You can create and addmodules to your BI workspaces to display data in a meaningful and efficient manner.

Modules that you create in BI workspaces are saved as embedded objects in the BI workspace. Theinformation displayed in the modules is protected at the data source.

To modify a text or compound module, open the module from the "Documents" tab and click the Editbutton in the module toolbar.

Related Topics• Configuring the display of Web Intelligence reports• Configuring the display of Crystal Reports

3.2 Types of modules

3.2.1 BI launch pad modules

A BI workspace is used as the primary container for modules. BI launch pad leverages the BI workspacetab framework to display different pages. By default, the home page opens and is displayed on the firsttab.

A common feature is to provide the ability to customize and assign different home pages to differentusers or groups. BI workspace administrators can create custom home pages and assign them throughcustomization enhancements.

2012-03-1523


BI launch pad uses modules to bring relevant information forward to users on the home page. Thisenables users to quickly find the business information without having to drill down through the "MyFavorites", "Personal Categories", or "Public Folders" listed in the "Document List".

The following BI launch pad modules can be added to a BI workspace:

1. My Alerts2. My Applications3. My Inbox4. My Recently Run Documents5. My Recently Viewed Documents6. SAP StreamWork Feed

Note:You can add this module to a BI workspace and define that workspace as a custom StreamWorkhome page in BI launch pad. For more information about defining the custom home page, see theBI Launch Pad User Guide and the Business Intelligence Platform Administrator Guide.

3.2.2 Compound module

A compound module is a simplified BI workspace without tabs and sub tabs. It is integrated with the BIworkspace creation workflow. You can create a compound module from BI launch pad.

You can create one or more of any combination of modules in a page using a compound module. Themodules in a compound module are edited individually. The compound module is useful when you havecontent that you want to repeat in more than one BI workspace tab.

For example, if you want a BI workspace to have a standard title page or header that includes thecorporate logo, name, and confidentiality information, you can create a compound module that containsall of this information and save it to a public folder.

In another example, to reuse a specific layout of modules, you can save the modules in acompound-module "template". You can then create other compound modules based on this template,but reset the data source in each module instance.

The compound module can work with the Viewer module in a BI workspace, so that when you click alink in a module, the destination appears in the Viewer page itself, instead of in a separate browserwindow.

Note:A compound module can be reused from a saved location similar to a Crystal report or Web Intelligencedocument.

Related Topics• Viewer module• Working with a BI workspace or compound module in Freeform layout mode

2012-03-1524


3.2.3 Text module

You use a Text module to add a block of text to a BI workspace. The text can be a header, descriptivetext, HTML or even an OpenModule hyperlink that opens in a BI workspace viewer. You can create atext module from BI launch pad or from within a BI workspace.

Configuring a text moduleThe best practice when creating HTML code or link text for use in the module is to create the code ina text editor, and then copy and paste the syntax into the module text box.

You can set the following properties for this module:• Type of text (plain or HTML)

• Style sheet used

Related Topics• Sending information to the Viewer module in a BI workspace using openModule• Viewer module

3.2.4 Web Page module

The Web Page module is available in the "Templates" category of the BI workspace Module Library.You use it in a BI workspace to display web pages or images.

You can use either a URL or a relative path to an image.

BI workspaces exposes all URL parameters of a Web Page module as in-port parameters. This allowsthe user to change the original parameters in the URL to another value by sending a value from a linkedmodule located on the same page in the workspace.

Related Topics• Linking module content

3.2.5 Using a Navigation List on a BI workspace tab

2012-03-1525


A "Navigation List " module, when used with the Viewer module, allows you to maximize the space ona BI workspace tab by serving as an active table of contents. You can choose from the multiple stylesavailable for presentation of content in the "Navigation List" modules.1. In the BI workspace edit mode, open the Module Library.2. From the "Templates" category, drag a Navigation List to the BI workspace layout area.3. From the "Templates" category, drag a Viewer to the BI workspace layout area and resize as

necessary using the lower, right-hand corner resize icon.4. Drag a module from any category in the Module Library to the Navigation List.

Note:If you are editing the BI workspace in "Columns" mode, hold down the Control button to drag-and-dropobjects into the Navigation List.

When you select an item in the Navigation List, it is displayed in the View.

5. In the Navigation List toolbar, click the Edit button.The "Edit Contents" dialog box is displayed.

6. In the "Content" tab, you can:• Optionally, create folders to organize the modules• Organize Navigation List items• Edit the properties of the Navigation List items, including module properties• Delete items from the Navigation List• Change the name of an item

7. In the "Layout" tab, type a title and description for the list, and select the display options and stylesheet.

8. In the "Viewer" tab, select the viewer to display the contents of the Navigation List items.9. Click OK to save the content and layout configuration.

Related Topics• Viewer module• Configuring the display options of a BI workspace module

3.2.6 Viewer module

By default, objects called from a module link, open and occupy the entire BI workspace space. The"Viewer" module offers a way to display the objects called from a Navigation List through module linksthat use open module variables. The Viewer also provides an option to resize the modules.

You can place multiple Viewer modules on a BI workspace page and view the reports concurrently fordeeper analysis.

2012-03-1526


For example, in a BI workspace tab that contains a Viewer, when you select a module that contains areport, the destination module appears in the Viewer. This allows you to see the report itself and thedestination module side by side.

In another example, you create a Web Intelligence document and use a Viewer to display documentsselected from links within the main document.

The Viewer module is particularly useful with the Navigation List module. You use the Navigation Listas a table of contents and the Viewer as the viewing portlet. This saves you BI workspace space.

You can find the Viewer module in the BI workspace Edit mode, in Module Library > Templates. Toadd it to a BI workspace, drag a Viewer to the BI workspace layout area and resize it as necessaryusing the resize icon at the lower right-hand corner.

3.2.6.1 Sending information to the Viewer module in a BI workspace usingopenModule

Using the openModule syntax, you can send information from the following documents on the CentralManagement Server (CMS) to a Viewer module on a BI workspace:• Web Intelligence documents• Crystal reports• Text module• Web page module

Sample syntax:

http://<server host>:<server port>/BOE/PerformanceManagement/jsp/aa-open-inlist.jsp?target="hiddenFrame"&URL=<encoded URL is displayed as target URLin the viewer>

For example:http://ildabvm0012:8080/BOE/PerformanceManagement/jsp/aa-open-inlist.jsp?target="hiddenFrame"&url=http%3a%2f%2fildabvm0012%3a8080%2fBOE%2fOpenDocument%2fopendoc%2fopenDocument.jsp%3fsDocName%3dComp%26sPath%3d%5bTemp%5d

The key items in the sample are aa-open-inlist.jsp and target='hiddenframe'.1. In a text editor, copy and paste the sample syntax.2. Replace {<server host>:<server port>} with the web application location after http://.

For example: http://<server>:<port>/PerformanceManagement/jsp

3. Enter the correct information after the variables.4. Replace {URL} in the BI workspace with the name of the {URL} as you want it to appear.5. Copy and paste the text in the following location:

• For Web Intelligence document or Crystal report copy the text in the cell of the query and thenrun a report.

2012-03-1527


• For a Text module, go to Edit mode, paste the text in the "Enter text or HTML to display" textboxm and select html. Save the module in the public folders.

• For a Web page module, go to Edit mode, in the "Content" tab, paste the text in the "Enter theweb page URL" text box, and click OK. In the "Layout" tab, select from the "Display as" sectionA link, so only the name is visible.

6. In BI launch pad, go to Applications > BI workspace.7. Enter the title, select a public folder, and click OK to save the BI workspace.8. Click Documents and find the BI workspace from the "Public Folders" node.9. Select the BI workspace and double-click to open it.

The BI workspace opens.

10. Click Edit BI workspace.11. From the Module Library, click the Document Explorer tab to find your report, and drag it to the BI

workspace layout.12. From the Module Library, click the Templates tab, and drag the Viewer module to the BI workspace

layout.13. Click Save, then Exit Edit Mode.

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

3.3 Creating and configuring modules

3.3.1 Working with modules

You can edit a module based on the type of information or data that you want to analyze and view. Youcan perform functions on a module embedded on a BI workspace page.

This section explains how to:• Add modules to BI workspaces• Create a module based on an existing module• Save a module to a BI launch pad folder• Delete a module from a BI launch pad folder• Link modules to documents or other modules

Related Topics• Adding modules from the Module Library to BI workspaces• Deleting a Text or Compound module from a BI launch pad folder• Saving a Text or Compound module to a BI launch pad folder

2012-03-1528


3.3.1.1 Creating a module

You create modules to visualize performance levels and trends on specific data. The data can originatefrom single ad hoc queries on a Web Intelligence report, Crystal report, or Dashboards models.

You can create modules in the following ways:• Via BI launch pad

Creating a module in this manner enables you to display, edit, and save the module and its contentsindependently of any workspace.

• Directly in a BI workspace

Creating a module within a BI workspace saves the module as an object embedded in that workspace.

Related Topics• Creating a Text or Compound module from the BI launch pad homepage

3.3.1.1.1 Creating a Text or Compound module from the BI launch pad homepage

To create Text or Compound modules directly from the BI launch pad homepage:1. On the BI launch pad home page, click Applications > Module or My ApplicationsModule.

A "New Module" is displayed.

2. Select the icon of the type of module – Text or Compound – that you want to create.

For text modules, a dialog box for creating the text is displayed. For compound modules, the layouttoolbar and link to the module library are displayed.

3. Design the module by selecting the content (by entering text or adding modules) and click OK.4. Click the Save As link to rename and save the module in the target location.

3.3.1.1.2 Editing a Text or Compound module

You can edit Text or Compound modules stored in the "My Favorites" or "Public Folders" , or "PersonalCategories" in the "Documents" tab of BI launch pad.

Note:When you edit a module that is stored in the CMS, you edit all instances of the module that have beenembedded in BI workspaces.

2012-03-1529


3.3.1.1.3 Saving a Text or Compound module to a BI launch pad folder

You can save Text and Compound modules to the "My Favorites", "Public Folders" , or "PersonalCategories" in the "Document" node of BI launch pad.

To save a module:1. With the module open, click Save As.

The Save module dialog box is displayed.

2. In the "Filename" field, enter a name of the module.3. Ensure that the "Module" option is selected for the "Save As Type" field.

This step is optional. The "Save As Type" field is automatically set to "Module".

4. Browse to the folder location where you want to save the module.

Note:Click "Folders" in the left pane. The "Public Folders" node is displayed.

5. Expand the "Public Folders" node and select a folder from the "Public Folders" list.The selected folder with all the documents saved opens.

6. Click SaveThe module is saved in the selected folder in BI launch pad.

3.3.1.1.4 Deleting a Text or Compound module from a BI launch pad folder

You can delete Text and Compound modules that have been saved to public folders or personalcategories.

Note:When you delete a module that is referenced by a BI workspace, an error message appears in the BIworkspace indicating that the document no longer exists in the system.

To delete a text or compound module:1. From the "Documents" node, browse to the folder that contains the module.2. Right-click the module and select Organize > Delete.

3.3.1.2 Adding modules from the Module Library to BI workspaces

A BI workspace is composed of tabs that contain modules that provide key business information. BIworkspaces can contain modules saved to the Central Management Server (CMS) or embedded inother BI workspaces.1. Perform one of the following:

• Open an existing BI workspace.

2012-03-1530


• Create a new BI workspace.• Create a tab or sub tab in an existing or new BI workspace.

2. Click Edit BI workspace.3. In the Module Library, navigate to the module you want to add:

• To insert a module from the CMS, select it from the "Document Explorer", or "Public Modules"or "Private Modules" categories and drag-and-drop it onto the workspace.

• To insert a new module and customize it in the BI workspace, drag it from the "Templates "categoryto the workspace.

Note:Modules selected from these categories and configured within a BI workspace are saved asembedded objects in the BI workspace and not as independent InfoObjects on the CMS.Embedded objects are always refreshed when opened.

4. Edit, resize, and move the module as necessary.5. When you have finished editing the BI workspace, save it and click Save > Exit Edit Mode.

Related Topics• Module Library in BI workspace

3.3.2 Data sources for modules

BI launch pad enables you to find the data that you need, and to select the type of module that candisplay the data most appropriately.

The data can originate from a:• Dashboards model with data imported from an Excel sheet• Web Intelligence report created using BI launch pad with data imported from an Excel sheet• Crystal report generated using Crystal Reports• Text module that contains text or HTML content• Web page module that contains a URL

3.3.3 Configuring the display of Crystal Reports

To configure the display settings of a Crystal Report in a BI workspace, click the Edit icon in the moduletoolbar, and in the "Contents" tab of the "Edit Contents" dialog box, select from among the followingoptions:

2012-03-1531


Effect on the reportOptionCategory

Displays the tree of folders for browsing to thedocument. All remaining categories of the tabledescribe the available options.

Document list

"Document toView"

The contents of the report are displayedthrough the viewer. No settings are neededwith this option.

Viewer

Options for determining the source of the dis-played document

From the source folder only

"Retrieve this Doc-ument"

By first checking the Inboxand if no copy exists, retriev-ing it from the source folder

From the Inbox only

Only the first part of the report is visible. Thisoption is applicable only to reports that havereport parts configured and defined usingCrystal Reports. For more information, seetopic18.2.1.1.1 Report Part Viewer in the SAPCrystal Reports 2011 User's Guide.

Part view

"Display Mode "

The entire report is displayed in the defaultviewer.Page view

You can view the report in 25%, 50%, or 100%zoom levels. For more information, see topic13.3.7 Zooming in and out on a map in the SAPCrystal Reports 2011 User's Guide.

%"Zoom Level"

Specify a zoom level.Custom

2012-03-1532


Effect on the reportOptionCategory

The report content is refreshed when the reportis opened.On demand

"Report Content "

The report data is from the latest instance inthe SAP BusinessObjects Business Intelligenceplatform Scheduler.

Latest instance

The report data is from the latest instance inthe SAP BusinessObjects Business Intelligenceplatform Scheduler for the user whose nameyou specify in the <User Name> field.

Latest instance by user

The report opens to the default report that youdefined in the Report Part Viewer.Default report part

"Report Parts toDisplay"

The report opens to the report part that youspecify.

Locate the information for this option in the re-port's "Report Options" dialog box.• <Object Name>: the name of the report

object to use as the destination object• <Data Context>: the data context to use in

the destination object

Selected report part

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

3.3.4 Configuring the display of Web Intelligence reports

You can control how a Web Intelligence document is displayed in a BI workspace. Once you havedragged and dropped the report onto a BI workspace, you can configure the view of the entire reportor just one part of it.• To select a part of the Web Intelligence document, right-click the part and choose Select this report

part. Click Edit to edit the report.• To deselect a report part, right-click the part and select Unselect this report part.

The entire report is displayed.

2012-03-1533


To configure the display settings of a Web Intelligence report, click the Edit icon in the module toolbar,and in the "Contents" tab of the "Edit Contents" dialog box, select from among the following options:

DescriptionOptionCategory

Displays the tree of folders for browsing to thedocument. All remaining categories of the ta-ble describe the available options.

Document list

Document to ViewThe contents of the report are displayedthrough the viewer. No settings are neededwith this option.

Viewer

Options for determining the source of the dis-played document

From the source folderonly

Retrieve this Docu-ment

By first checking the In-box and if no copy exists,retrieving it from thesource folder

From the Inbox only

The report content is refreshed when the re-port is opened.On demand

"Report Content"

The report data is from the latest run in theSAP BusinessObjects Enterprise Scheduler.Latest instance

The report data is from the latest instance runin the SAP BusinessObjects EnterpriseScheduler for a specific user, whose nameyou enter in the <User Name> field.

Latest instance by user

2012-03-1534


DescriptionOptionCategory

The report is displayed with a toolbar that in-cludes all options. For information about theseoptions, see the Web Intelligence documenta-tion.

Full report

"Display Mode"

The report is displayed with options deter-mined by the user's rights. This saves spacein the display of your report. The toolbar isalso displayed.

Compact mode

If you have selected a report part, this optionis activated by default, and the part ID ap-pears in the text box. You can use this ID inother applications.

Note:This option is not valid for the full report dis-play.

Selected report part

3.3.5 Linking modules and documents

Adding links to modules allows users to access and share information between one module and othermodules or documents that provide information for further analysis.

Linking modules that use Dashboards models, Web Intelligence documents, Web PageModules, or Crystal reportsYou can link one or more modules and include prompt parameters in links. Adding prompt parametersmeans that the data displayed on the target module or document is dynamically generated accordingto the values displayed on the first module. You can link:• A single module and a document• Multiple modules and documents

Related Topics• Linking module content

2012-03-1535


3.3.6 Content linking

Connecting two or more components through the Interportlet Communication Framework is known as“content linking”. It allows BI workspace components to communicate with each other by visuallyrepresenting the modules and creating links to transfer data between the modules. This enables diversemodules to interoperate and transfer data. You can view the data in a source module and link data tothe following target modules in a BI workspace:

Note:Only Dashboards modules, Web Intelligence documents and Web Page modules can be used as sourcemodules for content linking.

• Dashboards models as source and target modules.

A Dashboards model defined as a target module receives information from the source module andutilizes this information as input to variables defined in the Dashboards module.

• Web Intelligence documents as source and target modules, and Crystal reports as target modules.

When the user interacts with a Dashboards model defined as the source module, the dynamic valuesare passed through the content linking framework to the prompts in the Crystal reports and WebIntelligence documents selected as the target modules within the BI workspace tab or sub tab.

• Web Page modules

You can link a Web Page module as a source or a target with another module in order to transferevents between the Web page or image, and another report or module.

Content linking allows you to set up dynamic module linking at a granular level through the externalinterface capability, giving you control over the information that is sent. You can define granular linkingby selecting the list of ranges or parameters displayed by the source and target modules in the BIworkspace content linking layout.

Note:You can link legacy content between target and source modules through the legacy in- and out-portindicators. With granular linking, a BI workspace does not need to interpret any data sent betweensource and target reports. This option is useful for designing BI workspace with interportlet communicationin older releases, using PortalData or FS Command connections.

For each source range displayed, you can choose the corresponding target range or ranges to sendthe visual representation of the data. For any specific range triggered in the source module, at runtime,the BI workspace determines the ranges that have been displayed, retrieves their values and passesthem on to the target modules based on granular linking.

With content linking, it is easy to preview parameters, such as ranges, prompts, and filters for linking.You can set the user interface to selectively link or unlink components. You can have visual indicatorsto identify the components that have been linked.

2012-03-1536


To configure content linking in a BI workspace, click the Content Linking button on the BI workspacetoolbar.

3.3.6.1 Linking module content

To perform content linking with Web Intelligence modules, you need to first do the following:1. From the BI launch pad home page, select Preferences. The "Preferences - Administrator" dialog

box is displayed.2. From the "Preferences" list in the left pane, select Web Intelligence.3. From the "View" list of options available in the main pane, select Web.

You can set up dynamic visual communication between Dashboards models, Web Intelligencedocuments, Crystal reports modules and Web Page modules, all of which are placed on the same BIworkspace tab or sub tab. At runtime, the source module sends information to the target module ormodules. The targets use the information sent by the source module as parameter values, which areused as input for prompts in the case of Web Intelligence documents, Crystal reports, or Web Pagemodules, or in the data spreadsheet range of a Dashboards model.

Remember:To use a Dashboards model in a BI workspace as both a source and a target module, you must configurethe report with an "External Interface Connection" using Dashboards. For more information aboutconfiguring Portal Connections in a Dashboards model, refer to the Dashboards and PresentationDesign User's Guide.

To facilitate dynamic communication between a source Dashboards or Web Intelligence module andother target modules, use the External Interface Connection component. The user selects thevalues in the parameters section to begin linking between the modules. This information is sent by thesource modules to the target modules, and is substituted as prompt values.

To link content:1. From the Module Library, drag the source module to the BI workspace layout.2. Drag one or more target modules to the workspace layout.

Note:The following target modules can be configured for content linking:• Dashboards models• Crystal reports• Web Intelligence documents• Web Page modules

3. On the BI workspace toolbar, click Content Linking. The "Content Linking" dialog box is displayedwith the potential source and target modules. The parameters are represented visually in a table.A visual link represented by a dotted line is created between the modules, displaying a possibleconnection. The dotted line indicates that the parameter mapping must be set for the actual connection

2012-03-1537


to happen. A table with the source and target modules, and the associated source and targetparameters is displayed.

4. From the "Source Parameter" column of the "Parameter Mapping" table, choose the parameter tomap, and from the corresponding row in the "Target Parameter" column, select a target parameterfor the modules being linked.The parameter pairing is completed and the modules are linked. The connection is color-coded andrepresented by a solid line.

Note:The content linking connections are represented by the following indicators:• Granular linking: Rounded icon (connection with parameters)• Imported data: Blue• Output data: Green• Linking/connection: Orange

5. Click Close.

3.3.6.2 Advanced: exposing Web Page module in and out parameters forinter-portlet communication (IPC)

BI workspaces provides an API that enables the workspace creator to define events that can be sentbetween a Web Page module and other IPC-supporting modules. The Web Page module can be eitherthe source module – sending the parameter values through its out port – or the target module, receivingthe values through its in port.

The following API methods are used:

/*Declare the list of in and out parameters that the module exposes, and the callback method to handle eventsreceived by the module@paramsIn - String array of parameter names that the module can receive@paramsOut - String array of parameter names that the module can send@callback - Function to invoke upon receipt of events from other modules. Likely tobe used when the module receives events, and @paramsIn is expected to be populated/*exposeModuleParameters(paramsIn, paramsOut, callback)

/*Send parameters to modules connected through the "Content Linking" dialog box with this module@paramNames - Array of parameter names@paramValues - Array of parameter valuesThe two arrays must be in the same order (name-value pairs)*/sendParameters(paramNames, paramValues)

To use this API to implement content linking between modules:1. Implement a callback method that handles the parameters and values received from other modules.

This callback will be invoked by the BI workspaces framework when an event is sent to the module.

2. During module loading, invoke the exposeModuleParameters function by calling parent.exposeModuleParameters() with the relevant parameters and callback provided.

2012-03-1538


3. To send parameter data to other modules connected through content linking, invoke the sendParameters function by calling parent.sendParameters() with the relevant parameter data.

Example: Linking Content between Web Page Modules

You can use the sample source and target Web Page modules provided with the BI workspacesinstallation – named SampleSource_WPM.html and SampleTarget_WPM.html – to implementbasic content linking.1. Create a new workspace in BI workspaces.2. Drag a Web Page Module from the Module Library to the workspace.3. Drag another Web Page Module to the workspace, to the right of the first module.4. Click the Edit icon in the module toolbar of the first (source) Web Page module. The "Edit Contents"

dialog box is displayed.5. In the <Web Page URL> field, enter the URL that points to the source sample Web Page module;

for example: http://samples/SampleSource_WPM.html6. Repeat the previous two steps to define the URL of the target Web Page module.7. From the BI workspaces toolbar, click the Content Linking button. The "Content Linking" dialog

box is displayed. At the top, a diagram illustrates the source and target modules. The "AvailableConnections" table lists the potential modules and ports that can be linked.

8. In the diagram, drag a connecting line from the out port ("PARAMETERS_OUT") of the SourceWeb Page module to the in port ("PARAMETERS_IN") of the Target Web Page module. The "0"in the link circle indicates that no parameters have been mapped between the modules.

9. In the "Parameter Mapping" table at the right, map the parameters in each row by selecting theparameter from the dropdown list in the "Target Parameter" column that corresponds to theparameter in the "Source Parameter" column. The selections in the "Target Parameters" columnshould be, for our example:• yearParam• countryParam• stateParam

Note that after mapping, the number "3" is displayed in the link circle in the diagram.

10. Click Close to save the workspace.11. In the source module, select values from the dropdown lists in the "Single Parameter" and "Multiple

Parameters" sections at the bottom. When you click the relevant Send button, you can see thateach value is transferred to the corresponding field in the target module.

Related Topics• Web Page module• Linking modules and documents• Linking module content

2012-03-1539


2012-03-1540


More Information

LocationInformation Resource

http://www.sap.comSAP product information

http://help.sap.com/businessobjects

Access the most up-to-date English documentation covering all SAPBusinessObjects products at the SAP Help Portal:• http://help.sap.com/bobi (Business Intelligence)• http://help.sap.com/boepm (Enterprise Performance Management)• http://help.sap.com/boeim (Enterprise Information Management)

Certain guides linked to from the SAP Help Portal are stored on the SAPService Marketplace. Customers with a maintenance agreement havean authorized user ID to access this site. To obtain an ID, contact yourcustomer support representative.

To find a comprehensive list of product documentation in all supportedlanguages, visit:http://help.sap.com/boall.

SAP Help Portal

http://service.sap.com/bosap-support

The SAP Support Portal contains information about Customer Supportprograms and services. It also has links to a wide range of technical in-formation and downloads. Customers with a maintenance agreementhave an authorized user ID to access this site. To obtain an ID, contactyour customer support representative.

SAP Support Portal

http://www.sdn.sap.com/irj/sdn/bi-sdk-dev

https://www.sdn.sap.com/irj/sdn/businessobjects-sdklibraryDeveloper resources

http://www.sdn.sap.com/irj/boc/articles

These articles were formerly known as technical papers.SAP BusinessObjects articles onthe SAP Community Network

2012-03-1541

More Information

http://www.sap.com

http://help.sap.com/businessobjects

http://help.sap.com/bobi

http://help.sap.com/boepm

http://help.sap.com/boeim

http://help.sap.com/boall

http://service.sap.com/bosap-support

http://www.sdn.sap.com/irj/sdn/bi-sdk-dev

https://www.sdn.sap.com/irj/sdn/businessobjects-sdklibrary

http://www.sdn.sap.com/irj/boc/articles

LocationInformation Resource

https://service.sap.com/notes

These notes were formerly known as Knowledge Base articles.Notes

https://www.sdn.sap.com/irj/scn/forumsForums on the SAP CommunityNetwork

http://www.sap.com/services/education

From traditional classroom learning to targeted e-learning seminars, wecan offer a training package to suit your learning needs and preferredlearning style.

Training

http://www.sap.com/services/bysubject/businessobjectsconsulting

Consultants can accompany you from the initial analysis stage to thedelivery of your deployment project. Expertise is available in topics suchas relational and multidimensional databases, connectivity, databasedesign tools, and customized embedding technology.

Consulting

2012-03-1542

More Information

https://service.sap.com/notes

https://www.sdn.sap.com/irj/scn/forums

http://www.sap.com/services/education

http://www.sap.com/services/bysubject/businessobjectsconsulting

IndexA

adding 30

B

BI workspacecustomizing 10module library 19

BI workspaces 31adding tabs and sub tabs 11columns layout mode 19content linking 36copying 13creating 8customizing 16deleting 14, 21freeform layout mode 17module display options 16modules 23moving 12personal 7printing 21properties menu 14renaming 9, 12scrolling 13template layout mode 18

C

compound module 24module library 19

content linking 37copying, saving 9creating 29creating modules 29Crystal Report 31

D

Dashboard Design modules, contentlinking 37

E

editing 28

M

module 25, 26module in BI launch pad 29module library 19, 28modules 25, 28, 30

data sources 31editing 29removing 30saving 30

modules, linking 35

N

navigation list, viewer 25

O

openModule 27

S

security 14

T

Text module 25

V

View modulemultiple viewer 26

W

Web Intelligence 33Web Page module 25

2012-03-1543

2012-03-1544

Index