Professional Documents
Culture Documents
This document provides information and procedures for using SAP BusinessObjects Business Intelligence (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 BI platform. Data sources—
objects, Crystal reports, BI workspaces, Analysis edition for OLAP, Web Intelligence documents, and Dashboards
models—are deployed and integrated in BI launch pad as plug-in components from BI platform. This document
explains types of BI workspaces and modules, how to create BI workspaces and modules, and content linking
between data sources using BI workspaces.
This document is intended for business report creators, professional report creators, and BI workspace
administrators working on BI platform and BI workspaces applications on the Microsoft Windows, Unix, or Linux
operating system. Familiarity with report generation, types of data sources, methods of content linking for deeper
data analysis, and performance statistics is essential.
For more information about the product, see the Getting Started Creating BI Workspaces Guide and the SAP
BusinessObjects BI Workspaces Help.
1.3 Overview
BI workspaces helps you manage, understand, monitor, and track business activities and performance using
modules and BI workspaces. Management of corporate BI workspaces allow organizations 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 and tab-based navigation and page creation for all users. You can
build applications quickly, without programming, and customize existing applications with a point-and-click
assembly.
BI workspaces has 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 Intelligence documents, and Dashboards
models. Users can create their own application views while retaining administrative control.
For information about configuration, summary, and tracing details, refer to the SAP BusinessObjects Business
Intelligence Platform Administrator Guide, SAP BusinessObjects Business Intelligence Platform 4.1 Installation
Guide, SAP BusinessObjects Business Intelligence platform 4.1 Deployment Planning Guide, and SAP
BusinessObjects Business Intelligence Platform User Guide.
2.1 Overview
A BI workspace allows you to organize and display different BI platform data sources, such as Design Studio
documents, Web Intelligence documents, hyperlinks, Crystal reports, non-visual modules, or external pages such
as web pages via URL, in a single view. You can analyze and manage complex data effectively, and share the
information across organizations. BI workspaces provides high visibility of your organizational goals and enables
you to monitor your organization's performance and growth. BI workspaces provides a single view of all the
elements of business that you need to track on a daily basis as well as interportlet communication 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 and display them
as needed.
● Modules
● Web Intelligence documents, Analysis edition for OLAP documents, and Dashboards models
● Crystal reports
● Adobe PDF documents
● Microsoft Excel spreadsheets
● Microsoft Word documents
● Text files
● Rich text format (RTF) files
● Microsoft PowerPoint presentations
● Hyperlinks
You can store your BI workspaces in the folders of the Documents tab:
A BI workspace can contain useful, informative, and motivating content based on analyzed data. BI workspaces
also help to define strategies. BI workspaces and compound modules can be created or edited only inside BI
launch pad. This includes OpenDocument and PIK as well, even if the user can edit them by permission. The
default BI launch pad home page is read-only. All other custom home pages can be edited, in BI workspaces. When
custom home pages are edited, the changes are automatically available in BI launch pad.
To create a BI workspace:
○ A list of information that you want the BI workspace or BI workspace tab to transmit. When creating a
corporate BI workspace, analyze your audience to determine the information they need. If you have a lot
of information, consider creating categories of information and creating a tab in the BI workspace for each
category.
○ A list of content that you want to use. Modules can include Web Intelligence reports, Dashboards models,
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 your audience?
How much detail do you want them to see?
2. In BI launch pad, do the following to create a BI workspace:
Note
Specify the folder in which you want to save the BI workspace. Store BI workspaces in either Personal
Categories or Public Folders.
You can use the BI workspaces toolbar to save new BI workspaces or to open existing BI workspaces. The Save As
option copies an existing BI workspace and saves it with a new name.
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 name you entered exists in the
1. On the Documents tab, browse the Public Folders folder in the left pane and locate the BI workspace that
you want to rename.
2. Right-click the BI workspace and select Properties.
The BI workspace Properties dialog box appears.
3. On the General Properties page, in the Title box, enter a new name for the BI workspace.
4. Click Save & Close.
The BI workspace is saved with the new name.
1. Double-click the name of a BI workspace in the Public Folders or Personal Categories folder, or
browse the categories under Documents.
The selected BI workspace opens.
2. Click Edit BI workspace.
You must have appropriate edit rights (assigned by the administrator) to edit BI workspaces in the CMC. If you
edit a BI workspace saved to a public folder, the changes are visible to everyone. If you edit a BI workspace
saved in a personal category, the changes are visible only to you.
The edit BI workspace toolbar and Module Library "handle" appear.
3. To configure workspace properties, click the arrow on the right side of the tab or subtab, and select Properties.
The Properties window appears.
4. Select a layout style, and click OK.
The layout style is applied to the entire BI workspace, including tabs and subtabs. However, the layout style
that you select from a tab or subtab properties window applies only to that tab or subtab (not the entire BI
workspace).
5. In the Module Library, select and drag module objects to the layout area, resizing and fitting them to the
preferred BI workspace design.
Modules that you drag and drop from the Module Library to a BI workspace are stored as embedded objects in
that BI workspace. Text and compound modules created using the Applications Module option are
saved and stored as independent InfoObjects in the CMS.
6. Add tabs or subtabs to the BI workspace.
7. Edit the BI workspace using the following toolbar options:
○ (Save As): Saves the new BI workspace in the Public Folders or My Favorites category
○ (Revert Changes): Cancels any changes entered in the BI workspace and returns to the
previously saved version
○ (Exit Edit Mode): Exits edit mode. If you did not save your changes, this action cancels the
modifications made since the last save action
Note
When you choose to exit edit mode, you are promoted to either save or cancel the changes made to the
BI workspace.
Note
To move a subtab to another tab, drag it to that tab.
The tab or subtab is placed in the new location on the BI workspace toolbar.
You can duplicate a tab or subtab 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 subtab. For example, you can create a standard
corporate BI workspace Welcome tab that includes the corporate logo, documents, and some common indicators.
When you duplicate BI workspace tabs and subtabs, all modules in the duplicated tabs are copied. The subtab
hierarchy in a duplicated tab is also duplicated.
Note
To recreate a BI workspace tab using BI workspace objects in the BI workspaces category in the module library,
drag the item to the BI workspace layout.
1. Select the BI workspace tab or subtab to duplicate, click the arrow next to the title, and select Duplicate.
A duplicate of the object appears to the right of existing objects, with the title appended with an edition
number. For example, if you make a duplicate of the "Sales" tab, the title of the new tab is "Sales(1)".
2. (Optional) Rename the tab or subtab.
At times, more tabs and subtabs are in a BI workspace than can be displayed. To view tabs that are not displayed,
scroll.
You can delete the tabs and subtabs that you created in a BI workspace stored in either the public folders and
personal categories.
To display the properties menu for a BI workspace tab or subtab in the BI workspace edit mode, click the arrow on
the tab or subtab. You can configure the following properties:
● Help URL: Type or paste the default help URL in the text box.
● Style sheet: Select a style sheet for a BI workspace. You set the default option in the BI launch pad
preferences.
BI workspaces inherit their layout from the style sheet selected in BI launch pad preferences. BI workspace
subtabs inherit their layout from their parent BI workspace tabs.
BI workspaces saved in public folders share vital information across a large community or with specific groups 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 group of people for business confidentiality.
You set security rules for BI workspaces in the BI platform Central Management Console (CMC). You can set
security in two ways:
● At the folder level: BI workspaces are stored in BI launch pad Public folders. Administrators can limit access
to a folder in the folder's access settings or in account settings in the CMC for individual users or user groups.
● Via user rights: Only users with specific edit rights can edit BI workspaces. For information about setting rights
for BI workspaces, see the SAP BusinessObjects Business Intelligence Platform Administrator Guide.
1. In the BI platform CMC, expand the list of BI workspaces in the Folders area, and select a BI workspace.
2. Right-click the BI workspace and select User Security.
The User Security window appears.
3. Click Add Principals.
The Add Principals window page appears, showing the available users and groups.
4. Select a user in the Available users/groups list, and click the > arrow to move the user to the Selected users/
groups list.
Right Description
Full Control (Owner) Grants full access rights and ownership to the object
View On Demand Grants view rights for objects and view-on-demand content
Note
When you select a view access level, the Edit BI workspace button becomes unavailable.
You can modify the layout of tabs and subtabs created in BI workspaces and saved in the personal categories or
public folders.
In the BI workspace that you are editing, select the layout style:
○ To place objects on a BI workspace without using a layout format, select the Freeform layout.
○ To use a predefined layout, select the Template layout. You can select a column, row, or mixed column-and-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 rearranged to fit the new
layout mode.
Option Description
A link, so only the name is visible Module appears as a linked object a new tab.
Note
When you click the link on a BI workspace that contains a Viewer module, the link
destination opens in the viewer.
5. Click OK.
The Freeform layout mode enables you to place objects on a BI workspace tab or subtab or on a compound
module, without using a layout format. You can use the grid options to align objects.
1. In the BI workspace or compound module edit mode, select Freeform in the Layout list.
The workspace background is blank.
2. To activate a grid on the background, select a grid size in the Grid size list.
3. To adhere objects to grid lines in the layout area, select the Snap to grid check box.
When you move objects on the layout or add new objects, they will snap to the gridlines.
The Template layout mode provides layout formats for BI workspace objects. Switching to Template mode from
another mode affects BI workspaces in the following manner:
● When you switch from Freeform mode, if BI workspace objects are not in any particular order, they are placed
in adjacent columns. When you select a template, the BI workspace objects are moved to fit rows and columns
in the template.
● If you switch from Columns mode and select a template, the BI workspace objects shift to fit the cells in the
template.
● If you have more objects than available placeholders in the selected predefined template, extra modules are
appended to the bottom of the BI workspace.
● Empty spots can occur when you switch to a template or between templates. Rearrange modules as
necessary.
Option Description
Split component horizontally The component splits into components that are one above the other.
The Columns layout mode enables you to add, remove, and resize columns by adjusting the length and width of BI
workspace objects. You can drag each column in the layout to resize them, which enhances viewing and usability of
BI workspaces.
Option Description
Click object and drag its edges Resizes the layout and objects accordingly
● Templates contains module templates that you can customize to display data:
○ 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
Tip
To show or hide the Module Library toolbar, click Show Module Library on the BI workspace toolbar. You can set
the Module Library as docked or floating in the BI workspace layout.
Note
You can drag an existing module from the Module Library to the tab or subtab level on the BI workspace toolbar.
This enables you to reuse existing modules while creating new BI workspaces.
You can use the search box at the top of the Module Library to search for any document in the SAP
BusinessObjects Business Intelligence platform by typing the keyword and clicking the icon. The results are
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 any metadata
search.
For more information on searching results in the BI platform, refer Platform Search in the Business Intelligence
Platform Administrator guide at: http://help.sap.com/businessobject/product_guides/sbo41/en/
sbo41sp5_bip_admin_en.pdf
Use the print option to view and print dynamic content in a BI workspace. It displays the current state 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, change the printer settings to landscape.
The print preview page appears, showing the print options and a preview of the BI workspace tab or subtabs
that will print.
2. Perform one of the following actions:
○ Select Current Tab to print the tab you are currently viewing. This is the default option.
○ Select All Tabs, to print all tabs and subtabs in the BI workspace you are currently viewing.
3. Click Print.
Note
The contents of the BI workspace are adjusted to fit on one page; items may appear smaller.
Print preview resets the BI workspace view to the default view. For example, a BI workspace with a module
loads data for the slice <California> for year <2007> by default. The user changes the slice to <Texas> and
moves the slider to year <2005>. If a user clicks Print, data for <Texas> for year <2005> is not loaded, but
data for <California> for year <2007> is loaded. The user can change the slice to <Texas> on the print
page and click Print.
Since BI workspaces may contain vital information for corporate purposes, check with stakeholders before
deleting a workspace.
1. On the Documents tab in BI launch pad, locate the public folder or personal category that contains the BI
workspace.
2. Select the workspace, and select Organize Delete .
3.1 Overview
Modules are documents into which you insert data for viewing in a BI workspace. Modules can be based on Design
Studio documents, 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 add
modules to BI workspaces to display data in a meaningful and efficient manner.
Modules that you create in BI workspaces are saved as embedded objects in a BI workspace. The information
displayed in the modules is protected at the data source.
To modify a text or compound module, open the module on the Documents tab in BI launch pad, and click Edit on
the module toolbar.
BI workspaces is the primary container for modules. BI launch pad leverages the BI workspace tab framework to
display different pages. By default, the home page appears on the first tab. BI workspaces enable you to customize
and to assign home pages to users or groups. BI workspace administrators can create custom home pages and
assign them through customization enhancements.
BI launch pad uses modules to display relevant information to users on the home page. This enables users to
quickly find information without navigating My Favorites, Personal Categories, and public folders in the
document list.
● My Alerts
● My Applications
● My Inbox
● My Recently Run Documents
● My Recently Viewed Documents
● Collaboration Feed
For collaboration, you can add a module to a workspace and define the workspace as a custom SAP Jam or
SAP StreamWork home page in BI launch pad.
For information about defining custom home pages, see the SAP BusinessObjects Business Intelligence Launch
Pad User Guide and the SAP BusinessObjects Business Intelligence Platform Administrator Guide.
Create a compound module in BI launch pad when you want to repeat content on more than one BI workspace tab.
You can use a compound module to create one or more of any combination of modules on a page. Modules in a
compound module are edited individually.
For example, if you want a BI workspace to have a standard title page or header that includes the corporate logo,
name, and confidentiality information, create a compound module that contains the information and save it to a
public folder.
In another example, to reuse a specific layout of modules, save the modules in a compound-module template. You
can then create other compound modules based on the template and reset the data source in each module
instance.
When you click a link in a the Viewer module (made from a compound module) in a BI workspace, the destination
appears on the Viewer page, instead of in a separate browser window.
Create HTML code or link text for a text module in a text editor, and then copy and paste the syntax to the module
text box. You can set the following properties for a text module:
BI workspaces exposes all URL parameters for a web page module as in-port parameters. This enables users to
change the original parameters of a URL to another value (by sending a value from a linked module on the same
page in the workspace).
Note
You must ensure the authenticity of the website before adding it to the Web Page module in the BI Workspace.
The Navigation List module, used with the Viewer module, maximizes the space on a BI workspace tab by serving
as an active table of contents. Multiple content presentation styles are available for navigation lists.
Note
If you are editing a BI workspace in Columns mode, you can press and hold Ctrl and drag multiple objects
to the navigation list.
When you select an item in the navigation list, it appears in the Viewer module.
5. Click Edit on the navigation list toolbar.
The Edit Contents dialog box appears.
6. On the Content tab, you can perform the following actions:
By default, objects that are called from a module link open and occupy an entire BI workspace. The Viewer module
enables display of objects called from the navigation list through module links that use open module variables. The
Viewer module also enables you resize modules.
You can place multiple Viewer modules on a BI workspace page and view reports concurrently. For example, on a
BI workspace tab that contains the Viewer module, when you select a module that contains a report, the
destination module appears in the Viewer module. You can see the report and the destination module, side by side.
In another example, you create a Web Intelligence document and use the Viewer module to display documents
selected from links in the main document.
The Viewer module is particularly useful with the Navigation List module. You use the Navigation List module as a
table of contents and the Viewer module as the viewing portlet, which saves space.
Access the Viewer module in Edit mode ( Module Library Templates ). To add it to a BI workspace, drag
Viewer to the BI workspace layout area and resize it as needed.
Using openModule syntax, you can send information from the following documents on the Central Management
Server in BI platform to the Viewer module in a BI workspace:
Sample syntax:
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
○ For Web Intelligence documents or Crystal reports, copy the syntax to the cell of the query and then run a
report.
○ For the Text module, in Edit mode, paste the syntax in the Enter text or HTML to display box, select html,
and save the module to a public folder.
○ For the Web Page module, in Edit mode, on the Content tab, paste the syntax in the Enter the web page
URL box, and click OK. On the Layout tab, select A link, so only the name is visible under Display as.
You can modify modules to display the type of information that you want to analyze and view. You can perform the
following actions on modules embedded in a BI workspace page:
You can create modules to display performance levels and trends on specific data. Data can originate from a single
ad-hoc query on a Web Intelligence document, a Crystal report, or a Dashboards model. You create modules in the
following ways:
● Via BI launch pad: Display, edit, and save a module and its contents independent of the workspace
● In a BI workspace: Saves the module as an object embedded in that workspace
1. On the BI launch pad home page, select Applications Module or My Applications Module .
For text modules, a dialog box for entering the text appears. For compound modules, the layout toolbar and a
link to the module library appear.
3. Enter text or add modules to design the module, and click OK.
4. Click Save As, and rename and save the module in the target location.
You can edit Text or Compound modules in the My Favorites, Public Folders, or Personal Categories
folder on the Documents tab in BI launch pad.
You save Text and Compound modules to the My Favorites, Public Folders, or Personal Categories
folder in BI launch pad.
1. On the Documents tab in BI launch pad, with the module open, click Save As.
Note
Click Folders in the left pane. The Public Folders folder is displayed.
4. Expand Public Folders, and select a folder in the Public Folders list.
5. Click Save
The module is saved to the selected folder in BI launch pad.
You can delete Text and Compound modules from public folders and personal categories in BI launch pad.
Note
When you delete a module that is referenced by a BI workspace, a message appears in the BI workspace,
indicating that the document no longer exists in the system.
1. On the Documents tab in BI launch pad, locate the folder containing the Text or Compound module.
A BI workspace is composed of tabs, and each tab contains modules that provide business information. BI
workspaces modules can be saved to the Central Management Server (CMS) in BI platform or embedded in other
BI workspaces.
○ Open a BI workspace.
○ Create a new BI workspace.
○ Create a tab or subtab on an existing or new BI workspace.
2. Click Edit BI workspace.
3. In the module library, locate the module to add, and perform one of the following actions:
○ To insert the module from the CMS, select it in Document Explorer or in the Public Modules or Private
Modules category, and drag it to the workspace.
○ To insert a new module and customize it in the BI workspace, drag it from the Templates category to the
workspace.
Note
Modules selected from categories and configured in a BI workspace are saved as embedded objects in
the BI workspace. They are not independent InfoObjects in the CMS. Embedded objects always refresh
when they are opened.
4. Edit, resize, and move the module as needed, and save it.
You use BI launch pad to locate data and to select the type of module in which to display the data. Data in BI launch
pad may originate from the following sources:
To configure display settings for Crystal reports in BI workspaces, click Edit on the module toolbar. On the
Contents tab of the Edit Contents dialog box, you can configure the following options:
Table 1:
Document to View Document list Displays the folder tree that you browse to locate reports
Retrieve this Document From the source folder only Where to find the data source for the displayed document
Display Mode Part view Displays only the first part of the report in the default
viewer
Report Content On demand Refreshes report data each time the report opens
Latest instance Shows report data from the latest instance in BI platform
Latest instance by user Shows report data from the latest instance in BI platform
for the user you specify in the User Name box
Report Parts to Display Default report part Displays the report part that you defined in the Report Part
viewer
Selected report part Displays the report part that you select. Set the following
options in the Report Options dialog box for the report.
For information about report parts and the Report Part viewer, see the Crystal Reports documentation.
To determine how Web Intelligence documents appear in BI workspaces, after dragging a document to a BI
workspace, configure the following options:
● To select part of a Web Intelligence document, right-click the part and select Select this report part. Only the
part you selected appears. Click Edit to edit the document.
● To deselect part of a Web Intelligence document, right-click the part and select Unselect this report part. The
entire document appears.
To configure display settings for Web Intelligence documents in BI workspaces, click Edit on the module toolbar. On
the Contents tab of the Edit Contents dialog box, you can configure the following options:
Table 2:
Category Option Description
Document to View Document list Displays the folder tree that you browse to locate docu
ments
Retrieve this Document From the source folder only Where to find the data source for the displayed document
Report Content On demand Refreshes document data each time the document opens
Latest instance Shows document data from the latest instance in BI plat
form
Latest instance by user Shows document data from the latest instance in BI plat
form for the user you specify in the User Name box
Display Mode Full report Displays the document with a toolbar. For information
about the toolbar options, see the Web Intelligence docu
mentation.
Compact mode Display the document with options determined by the us
er's rights and with a toolbar. This saves space in the
workspace.
Selected report part Displays the selected document part. The part ID appears
in the text box; you can use the ID in other applications.
You can link modules and include prompt parameters in the links. Adding prompt parameters dynamically
generates the data that appears on the target module or document, according to values displayed on the first
module. You can link a single module and document or multiple modules and documents.
You can view data in the source module and link the data to the following target modules in a BI workspace:
Note
Content linking is not supported for Design Studio documents.
Content linking enables you to use dynamic module linking at a granular level, which provides more control over
information sent. To define the granularity of linking, select a list of ranges or parameters to display in the source
and target modules in the BI workspace content-linking layout.
Note
You can link legacy content between target and source modules through the legacy in- and out-port indicators.
With granular linking, a BI workspace does not need to interpret data sent between source and target reports.
This option is useful for designing BI workspace with interportlet communication in older releases, using
PortalData or FS Command connections.
To preview parameters (ranges, prompts, and filters) for linking, set the user interface to selectively link or unlink
components. Visual indicators identify which components that are linked.
To configure content linking in a BI workspace, click Content Linking on the BI workspace toolbar.
Before you can perform content linking with Web Intelligence modules, you must set Web Intelligence preferences
in BI launch pad to show Web options.
You can configure dynamic communication between Dashboards models, Web Intelligence documents, Crystal
reports modules, and Web Page modules on the same BI workspace tab or subtab. At runtime, the source module
sends information to the target module or modules as parameter values. The parameter values provide input to
prompts in Web Intelligence documents, Crystal reports, Web Page modules, or the data spreadsheet range of
Dashboards models.
To facilitate dynamic communication between a source Dashboards or Web Intelligence module and other target
modules, use the External Interface Connection component. Users select values in the parameters area, and the
information is sent from source modules to target modules and then inserted as prompt values.
Note
To use a Dashboards model in a BI workspace as both a source and target module, you must configure the
report with an External Interface Connection component, using Dashboards. For more information about
configuring portal connections in a Dashboards model, see the Dashboards and Presentation Design User's
Guide.
1. From the module library, drag the source module to the BI workspace layout.
2. Drag one or more target modules (Dashboards modules, Crystal reports, Web Intelligence documents, or Web
Page modules) to the workspace layout.
3. On the BI workspace toolbar, click Content Linking.
The Content Linking dialog box appears, displaying potential source and target modules. A table lists the
source and target modules and the associated source and target parameters. A dotted line indicates linked
modules; however, you must map parameters before the connection is configured.
4. In the Parameter Mapping table, select a source parameter in the Source Parameter column and then select a
target parameter in the Target Parameter column.
The parameter are paired and the modules are linked. The connection is represented by a solid line. Other
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.
BI workspaces provides an API that enables the workspace creator to define events that can be sent between a
Web Page module and other IPC-supporting modules. The Web Page module can be the source module (that is,
send parameter values through its "out" port) or the target module (that is, receive 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 events
received 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 to
be 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 values
The two arrays must be in the same order (name-value pairs)
*/
sendParameters(paramNames, paramValues)
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.
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 (SampleSource_WPM.html and
SampleTarget_WPM.html) provided with BI workspaces to implement basic content linking.
Coding Samples
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system
environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and
completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, unless damages were caused by SAP
intentionally or by SAP's gross negligence.
Gender-Neutral Language
As far as possible, SAP documentation is gender neutral. Depending on the context, the reader is addressed directly with "you", or a gender-neutral noun (such as "sales
person" or "working days") is used. If when referring to members of both sexes, however, the third-person singular cannot be avoided or a gender-neutral noun does not
exist, SAP reserves the right to use the masculine form of the noun and pronoun. This is to ensure that the documentation remains comprehensible.
Internet Hyperlinks
The SAP documentation may contain hyperlinks to the Internet. These hyperlinks are intended to serve as a hint about where to find related information. SAP does not
warrant the availability and correctness of this related information or the ability of this information to serve a particular purpose. SAP shall not be liable for any damages
caused by the use of related information unless damages have been caused by SAP's gross negligence or willful misconduct. All links are categorized for transparency (see:
https://help.sap.com/viewer/disclaimer).