0% found this document useful (0 votes)
8 views186 pages

VC Reference Guide

The SAP NetWeaver Visual Composer Reference Guide provides detailed information for creating and adapting model-based applications within the SAP NetWeaver environment. It emphasizes user-friendly features such as drag-and-drop capabilities and browser-based access, enabling business analysts to develop applications without coding skills. The guide serves as a complement to the Modeler's Guide, detailing the attributes of model elements and controls.

Uploaded by

Marcelo Otranto
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
8 views186 pages

VC Reference Guide

The SAP NetWeaver Visual Composer Reference Guide provides detailed information for creating and adapting model-based applications within the SAP NetWeaver environment. It emphasizes user-friendly features such as drag-and-drop capabilities and browser-based access, enabling business analysts to develop applications without coding skills. The guide serves as a complement to the Modeler's Guide, detailing the attributes of model elements and controls.

Uploaded by

Marcelo Otranto
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 186

Reference Guide

SAP NetWeaver
Visual Composer
Document Version 1.00 – January 2007

SAP NetWeaver 2004s SP Stack 11


SAP AG
Neurottstraße 16
69190 Walldorf
Germany
T +49/18 05/34 34 24
F +49/18 05/34 34 20
www.sap.com

SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver,


© Copyright 2007 SAP AG. All rights reserved. and other SAP products and services mentioned herein as well as
their respective logos are trademarks or registered trademarks of
No part of this publication may be reproduced or transmitted in SAP AG in Germany and in several other countries all over the
any form or for any purpose without the express permission of world. All other product and service names mentioned are the
SAP AG. The information contained herein may be changed trademarks of their respective companies. Data contained in this
without prior notice. document serves informational purposes only. National product
specifications may vary.
Some software products marketed by SAP AG and its distributors
contain proprietary software components of other software
vendors.
These materials are subject to change without notice. These
Microsoft, Windows, Outlook, and PowerPoint are registered materials are provided by SAP AG and its affiliated companies
trademarks of Microsoft Corporation. ("SAP Group") for informational purposes
only, without representation or warranty of any kind, and SAP
IBM, DB2, DB2 Universal Database, OS/2, Parallel Sysplex, Group shall not be liable for errors or omissions with respect to
MVS/ESA, AIX, S/390, AS/400, OS/390, OS/400, iSeries, the materials. The only warranties for SAP Group products and
pSeries, xSeries, zSeries, z/OS, AFP, Intelligent Miner, services are those that are set forth in the express warranty
WebSphere, Netfinity, Tivoli, and Informix are trademarks or statements accompanying such products and services, if any.
registered trademarks of IBM Corporation in the United States Nothing herein should be construed as constituting an additional
and/or other countries. warranty.

Oracle is a registered trademark of Oracle Corporation.


Disclaimer
UNIX, X/Open, OSF/1, and Motif are registered trademarks of Some components of this product are based on Java™. Any code
the Open Group. change in these components may cause unpredictable and severe
malfunctions and is therefore expressively prohibited, as is any
Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, decompilation of these components.
VideoFrame, and MultiWin are trademarks or registered
trademarks of Citrix Systems, Inc. Any Java™ Source Code delivered with this product is only to be
used by SAP’s Support Services and may not be modified or
HTML, XML, XHTML and W3C are trademarks or registered altered in any way.
trademarks of W3C®, World Wide Web Consortium,
Massachusetts Institute of Technology.
Documentation on SAP Service Marketplace
Java is a registered trademark of Sun Microsystems, Inc. You can find this documentation at
service.sap.com/instguidesNW04

JavaScript is a registered trademark of Sun Microsystems, Inc.,


used under license for technology invented and implemented by
Netscape.

MaxDB is a trademark of MySQL AB, Sweden.

SAP NetWeaver Visual Composer Reference Guide


Typographic Conventions Icons

Type Style Represents Icon Meaning


Example Text Words or characters quoted from Caution
the screen. These include field
names, screen titles, Example
pushbuttons labels, menu
names, menu paths, and menu
options. Note

Cross-references to other Recommendation


documentation.
Example text Emphasized words or phrases in Syntax
body text, graphic titles, and
table titles.
EXAMPLE TEXT Technical names of system
objects. These include report
names, program names,
transaction codes, table names,
and key concepts of a
programming language when
they are surrounded by body
text, for example, SELECT and
INCLUDE.
Example text Output on the screen. This
includes file and directory names
and their paths, messages,
names of variables and
parameters, source text, and
names of installation, upgrade
and database tools.
Example text Exact user entry. These are
words or characters that you
enter in the system exactly as
they appear in the
documentation.
<Example text> Variable user entry. Angle
brackets indicate that you
replace these words and
characters with appropriate
entries to make entries in the
system.
EXAMPLE TEXT Keys on the keyboard, for
example, F2 or ENTER.
Contents
SAP NETWEAVER VISUAL COMPOSER REFERENCE GUIDE ........................................... 1
1 OVERVIEW OF VISUAL COMPOSER.............................................................................. 1
2 HOW TO USE THIS GUIDE............................................................................................... 2
3 MAIN WORKSPACE ELEMENTS..................................................................................... 3
3.1 Main Menu................................................................................................................. 3
3.2 Main Toolbar ............................................................................................................. 7
3.3 Workspace Boards.................................................................................................... 8
3.4 Workspace Toolboxes............................................................................................... 9
4 MODEL MENU DIALOG BOXES .................................................................................... 11
4.1 New Model .............................................................................................................. 11
4.2 Open Model............................................................................................................. 12
4.3 Save As ................................................................................................................... 12
4.4 Manage Models....................................................................................................... 13
4.5 Print 13
4.6 Export to File ........................................................................................................... 14
4.7 Import from File ....................................................................................................... 14
4.8 Unlock Models......................................................................................................... 15
5 TASK PANELS ................................................................................................................ 16
5.1 Get Started Task Panel........................................................................................... 16
5.2 Browse Model and Search Model Task Panels ...................................................... 17
5.2.1 Browse Model Task Panel ........................................................................ 18
5.2.2 Search Model Task Panel ......................................................................... 19
5.3 Compose Model Task Panel ................................................................................... 20
5.3.1 Select Display Fields Dialog Box .............................................................. 23
5.4 Configure Element Task Panel ............................................................................... 25
5.4.1 Annotation ................................................................................................. 26
5.4.2 Calendar View ........................................................................................... 27
5.4.3 Chart View................................................................................................. 30
5.4.4 Combine Operator..................................................................................... 35
5.4.5 Data Binding.............................................................................................. 36
5.4.6 Data Flow .................................................................................................. 37
5.4.7 Data Mapping ............................................................................................ 38
5.4.8 Data Service.............................................................................................. 39
5.4.9 Distinct Operator ....................................................................................... 43
5.4.10 End Point .................................................................................................. 43
5.4.11 Filter Operator........................................................................................... 44
5.4.12 Form View................................................................................................. 45
5.4.13 Group by Operator.................................................................................... 47
5.4.14 HTML View ............................................................................................... 48
5.4.15 Input Signal............................................................................................... 49
5.4.16 Intersection Operator................................................................................ 50
5.4.17 iView ......................................................................................................... 51

SAP NetWeaver Visual Composer Reference Guide


5.4.18 Layers ....................................................................................................... 53
5.4.19 Lower-Range Operator............................................................................. 55
5.4.20 Model ........................................................................................................ 55
5.4.21 Navigation Point........................................................................................ 56
5.4.22 Nested iView............................................................................................. 57
5.4.23 Output Port ............................................................................................... 58
5.4.24 Output Signal ............................................................................................ 59
5.4.25 Package.................................................................................................... 59
5.4.26 Page ......................................................................................................... 60
5.4.27 Popup Signal ............................................................................................ 61
5.4.28 Sigma Operator ........................................................................................ 62
5.4.29 Sort Operator ............................................................................................ 63
5.4.30 Start Point ................................................................................................. 63
5.4.31 Subtraction Operator ................................................................................ 64
5.4.32 Table View ................................................................................................ 65
5.4.33 Timer......................................................................................................... 68
5.4.34 Transition .................................................................................................. 69
5.4.35 Union Operator ......................................................................................... 70
5.4.36 Upper-Range Operator............................................................................. 70
5.4.37 User Data.................................................................................................. 71
5.5 Inspect Formulas Task Panel.................................................................................. 72
5.6 Find Data Services Task Panel............................................................................... 73
5.6.1 Define Data Service Dialog Box................................................................ 77
5.6.2 Favorites Folders ...................................................................................... 78
5.6.3 Test Data Service Dialog Box ................................................................... 79
5.6.4 Define / Test Query Dialog Box................................................................. 80
5.7 Deploy to Portal Task Panel.................................................................................... 81
6 CONTROL PROPERTIES DIALOG BOX ....................................................................... 82
6.1 Available Controls and Fields.................................................................................. 84
6.2 Control Properties - General Tab ............................................................................ 87
6.3 Control Properties - Display Tab ............................................................................. 89
6.4 Control Properties - Range Tab .............................................................................. 92
6.5 Control Properties - Styles Tab ............................................................................... 93
6.6 Control Properties - Formatting Tab ....................................................................... 94
6.7 Control Properties - Entry List Tab.......................................................................... 96
6.7.1 Find Data Service Dialog Box ................................................................... 99
6.8 Control Properties - Validation Tab....................................................................... 100
6.9 Control Properties - Image Tab............................................................................. 101
6.10 Control Properties - Action Tab............................................................................. 102
6.11 Control Properties - HTML Tab ............................................................................. 106
6.12 Value Help Configuration Wizard .......................................................................... 107

SAP NetWeaver Visual Composer Reference Guide


7 TOOLS MENU DIALOG BOXES................................................................................... 113
7.1 Documentation Wizard.......................................................................................... 114
7.2 Entry List Manager ................................................................................................ 115
7.2.1 Value Help List ........................................................................................ 116
7.3 Image Manager ..................................................................................................... 119
7.4 Alias Manager ....................................................................................................... 120
7.5 System Definition (Web Service) .......................................................................... 121
7.6 Alert Data Service ................................................................................................. 122
7.7 Customize Toolbar ................................................................................................ 124
7.8 Options Dialog Box ............................................................................................... 125
7.8.1 Options - Model Tab................................................................................ 125
7.8.2 Options - Drawing Tab ............................................................................ 126
7.8.3 Options - Editing Tab .............................................................................. 127
7.8.4 Options - Workspace Tab ....................................................................... 128
7.8.5 Options - Compiler Tab ........................................................................... 129
7.8.6 Options - Administration Tab................................................................... 130
8 BI MENU DIALOG BOXES............................................................................................ 131
8.1 BI Integration Wizard............................................................................................. 132
8.1.1 Select a System ...................................................................................... 133
8.1.2 Select a Query Template ........................................................................ 134
8.1.3 Select a Cube.......................................................................................... 163
8.1.4 Define Filters ........................................................................................... 164
8.1.5 Select a Table ......................................................................................... 166
8.1.6 Design a Layout ...................................................................................... 166
8.1.7 Select Fields............................................................................................ 168
8.1.8 Configure Joins ....................................................................................... 170
8.1.9 Configure Filters...................................................................................... 171
8.1.10 Specify the Sort Order ............................................................................ 172
8.1.11 Review Output ........................................................................................ 172
8.2 SQL Editor............................................................................................................. 173
8.3 MDX Editor ............................................................................................................ 175
9 EXPRESSION EDITOR ................................................................................................. 178
10 CREATE TOOLBAR BUTTONS DIALOG BOX ........................................................... 180

Document History
Document version Description
V 1.0 SAP Library release of document, with SPS 11. The following section
was updated since the SPS 10 release:
ƒ Options Dialog Box → Options – Compiler Tab: addition of the
Enable styling of Flex controls in portal themes checkbox

SAP NetWeaver Visual Composer Reference Guide


November 2006

SAP NetWeaver Visual Composer


Reference Guide
This Reference Guide is a complement to the SAP NetWeaver Visual Composer Modeler's
Guide [External] for SAP Visual Composer. It provides detailed information needed for
performing the tasks described in the Modeler’s Guide.
For an introduction to Visual Composer, see Overview of Visual Composer [Page 1].
For information about all of the manuals in the Visual Composer documentation set, see How
to Use this Guide [Page 2].

1 Overview of Visual Composer


SAP Visual Composer provides a development environment for rapidly creating and adapting
model-based transactional and analytical applications. It has been designed to enable
business analysts to create enterprise applications using standardized components that meet
SAP standards and quality criteria.
Visual Composer has been designed according to the following prime considerations:
• Simplicity
{ Visual Composer enables fast development of model-based business
applications, without requiring manual coding skills.
{ The Visual Composer graphical interface is very user friendly: it implements
drag-and-drop capabilities, direct layout visualization and a range of other tools
for facilitating model building and adaptation
{ Visual Composer is browser-based, eliminating the need for client-side
installation and maintenance
• SAP NetWeaver 2004 integration
Visual Composer is tightly integrated into the SAP NetWeaver 2004 suite of
applications.
• Connectivity to SAP and third-party systems
Visual Composer operates on top of the SAP NetWeaver portal, utilizing the portal’s
connector-framework interfaces to enable access to a range of data services, including
SAP and third-party enterprise systems. In addition to accessing mySAP ERP systems,
users can access SAP Business Warehouse and any open/JDBC stored procedures.
• Support for different runtime environments
Visual Composer is a robust tool whose models can be deployed to run in a number of
different environments, including Web Dynpro and Adobe Flex.
• Reusable components
The building blocks implemented in the models ensure consistency in functionality and
UI design from application to application. Using them ensures significant savings in
time and effort by eliminating the need to recreate similar functionality from model to
model.
• Trial-and-error
Visual Composer is ideal for trying out a model, quickly simulating it in runtime – or
even deploying it – and then going back to the “drawing board” (Storyboard) for
correction and tweaking.

SAP NetWeaver Visual Composer Reference Guide 1


November 2006

In summary, Visual Composer enables business analysts to apply their inherent


understanding of their organizations’ requirements to create and adapt applications to their
specific business needs. These applications can then be subsequently customized and
continuously changed in Visual Composer as the organization’s business objectives evolve.
To understand the role of this manual in the Visual Composer documentation set, see How
to Use this Guide [Page 2].

2 How to Use this Guide


You should use this guide in conjunction with the other manuals in the documentation set for
SAP Visual Composer. In general, the Modeler’s Guide is intended to guide you through the
general workflow tasks that you perform when creating and modifying models in Storyboard.
This manual complements the Modeler’s Guide in that it provides the details for filling in the
screens and defining the attributes of every model element, control and field.
For a description of the general concepts of Visual Composer, and a glossary of terms used
when working with the application, refer to the Getting Involved [External] chapter of the
Modeler’s Guide.
The following documents are included in the Visual Composer documentation set:
• SAP NetWeaver Visual Composer Modeler's Guide [External]
• SAP NetWeaver Visual Composer Installation & Configuration Guide [External]
• SAP NetWeaver Visual Composer Reference Guide [Page Error! Bookmark not
defined.]
• SAP NetWeaver Visual Composer Security Guide [External]
• Administration of SAP NetWeaver Visual Composer [External]

Be sure to read SAP Note 919388 for the latest information about
limitations, known issues, and workarounds for SAP Visual Composer.
You can find the SAP Note at SAP Service Marketplace at
service.sap.com/notes.

SAP NetWeaver Visual Composer Reference Guide 2


November 2006

3 Main Workspace Elements


The two main sections of the Storyboard desktop are the workspace and the task panel at the
right. This section provides detailed descriptions of the following areas of the workspace:
• Main Menu [Page 3]
• Main Toolbar [Page 7]
• Workspace Boards [Page 8]
• Workspace Toolboxes [Page 9]
For information about the task panels, see Task Panels [Page 16].

3.1 Main Menu


Definition
The main menu includes most of the options for managing your model files, creating the
logical flow and displaying the Storyboard options and task panels.

Structure
The following table lists the functions of each main menu option:

Main Menu Option

Option Sub-option Description


Model New Model Displays the Create a New Model dialog box.
See Creating a New Model [External] in the SAP
NetWeaver Visual Composer Modeler’s Guide.
Open Model Displays the Open Model dialog box for
selecting the model to open. See Opening a
Model [External] in the SAP NetWeaver Visual
Composer Modeler’s Guide.
Close Model Closes the model currently open in Storyboard.
Save Model Saves the changes made since the last Save.
See Saving a Model [External] in the SAP
NetWeaver Visual Composer Modeler’s Guide.
Save As Displays the Save As dialog box for saving the
open model under a different name or in a
different location. See Saving a Model [External]
in the SAP NetWeaver Visual Composer
Modeler’s Guide.
Manage Models Opens the Model Browser, for performing
different operations such as creating a subfolder,
and opening, deleting and renaming a model.
See Using the Model Browser [External] in the
SAP NetWeaver Visual Composer Modeler’s
Guide.

SAP NetWeaver Visual Composer Reference Guide 3


November 2006

Option Sub-option Description


Print Prints the model diagram currently displayed in
Storyboard.
Export to File Saves the model as a *.gml file at a location that
you specify. See Exporting a Model [External] in
the SAP NetWeaver Visual Composer Modeler’s
Guide.
Import from File Imports a model previously exported from Visual
Composer. See Importing a Model [External] in
the SAP NetWeaver Visual Composer Modeler’s
Guide.
Unlock Models Unlocks select models that you have created, so
that they can be opened for editing.
Log Off Closes the model currently displayed in
Storyboard (prompting you to save or not) and
logs you off from the connected portal.
Edit Undo Cancels the last action performed in Storyboard.
(You can set the number of undo levels in the
Model tab of the Options dialog box. See
Options Dialog Box [Page 125].)
Redo Restores the last action undone in Storyboard.
Cut Deletes the selected item.
Copy Copies the selected item.
Paste Pastes the item that was copied.
Rename Allows you to rename the selected item.
Delete Removes the selected item.
Duplicate Creates a copy of the selected item.
Select All Selects all items currently displayed in
Storyboard.
Search Browse Model Displays the Browse Model task panel, which
shows the hierarchy of elements in the model.
See Browse Model and Search Model Task
Panels [Page 17].
Search Model Displays the Search Model task panel, to enable
you to search for occurrences of model
elements. See Browse Model and Search Model
Task Panels [Page 17].
Back After you have drilled down in a model, returns
you to the previous level.
Forward After you have drilled down and returned to a
higher level, drills down to the last level.
Parent Returns you to the top level of your iView.
Home Returns to you the highest level of your model.

SAP NetWeaver Visual Composer Reference Guide 4


November 2006

Option Sub-option Description


Tools Compile Model Compiles the model in the selected runtime
code. Click View source code in the Deploy to
Portal task panel to display the compiled file.
Deploy Model Compiles the model in the selected runtime code
and packages it for deployment to the portal.
See Deploy to Portal Task Panel [Page 81].
Documentation Wizard Generates model documentation for all or
specified parts of your model. See
Documentation Wizard [Page 113].
Entry List Manager Displays the Entry List Manager dialog box for
creating global entry lists, for use with list
controls (such as radio buttons or drop-down
lists). See Entry List Manager [Page 115] and
Create an Entry List [External] in the SAP
NetWeaver Visual Composer Modeler’s Guide.
Image Manager Displays the Image Manager dialog box for
creating an image library, for use in the different
UI components of the model. See Image
Manager [Page 119].
Alias Manager Displays the System Alias Manager dialog box,
for organizing and reassigning systems from
which data services have been added to the
model. See Alias Manager [Page 120].
Define Web Service System Displays the System Definition (Web Service)
dialog box, for creating new web services. See
System Definition (Web Service) [Page 121].
Alert Data Service Adds an alert data service to Storyboard,
operating in conjunction with the Universal
Worklist (UWL).
Customize Displays the Customize Toolbar dialog box, to
rearrange and add buttons to the Storyboard
main toolbar. See Customize Toolbar [Page
124].
Options Displays the Options dialog box, for customizing
the operation of Storyboard. See Options Dialog
Box [Page 125].
BI BI Integration Wizard Walks you step-by-step through creating iView
content that defines queries on BI data services.
MDX Editor Displays the MDX Editor dialog box for creating
or editing OLAP queries.
Window New Window Opens an additional Storyboard window.
Full Screen Displays the workspace on the entire Storyboard
area.
Maximize Window Restores a minimized window.
Cascade Windows Displays multiple windows in a cascade fashion.

SAP NetWeaver Visual Composer Reference Guide 5


November 2006

Option Sub-option Description


Tile Horizontally Displays multiple windows one above the other.
Tile Vertically Displays multiple windows size-by-side.
Close All Windows Closes all open Storyboard windows.
Help Online Help Displays the first topic in the online help (with
access to the entire guide).
SDN Online Opens a new browser Window to the Visual
Composer page of SAP Developers Network.
About Displays information about currently-installed
Visual Composer version.

Integration
Most of the options in the main menu can be accessed by clicking the corresponding button in
the main toolbar or by using the appropriate right-click context menu. The small icon to the left
of each menu option indicates its corresponding toolbar button.

SAP NetWeaver Visual Composer Reference Guide 6


November 2006

3.2 Main Toolbar


Definition
The row of buttons under the Storyboard main menu contains shortcuts to many of the most-
commonly used functions in the main menu.

Structure
The default toolbar contains the following options:

Default Main-Toolbar Buttons

Button Name Description


New Model Displays the Create a New Model dialog box in order to create
a new model. See Creating a New Model [External] in the SAP
NetWeaver Visual Composer Modeler's Guide.
Open Model Displays the Open Model dialog box for selecting the model to
open. See Opening a Model [External] in the SAP NetWeaver
Visual Composer Modeler's Guide.
Close Model Closes the model currently open in Storyboard.

Save Model Saves the changes made since the last Save. See Saving a
Model [External] in the SAP NetWeaver Visual Composer
Modeler's Guide.
Manage Models Opens the Model Browser, for performing different operations
such as creating a subfolder, and opening, deleting and
renaming a model. See Using the Model Browser [External] in
the SAP NetWeaver Visual Composer Modeler's Guide.
Print Prints the model diagram currently displayed in Storyboard.
See Print the Model [External] in the SAP NetWeaver Visual
Composer Modeler's Guide.
Cut Deletes the selected item.

Copy Copies the selected item.

Paste Pastes the item that was copied.

Undo Cancels the last action performed in Storyboard. (You can set
the number of undo levels in the Model tab of the Options
dialog box. See Options Dialog Box [Page 125].
Redo Restores the last action undone in Storyboard.

Back After you have drilled down in a model, returns you to the
previous level.
Forward After you have drilled down and returned to a higher level,
drills down to the last level.
Parent Returns you to the top level of your iView.

Home Returns to you the highest level of your model.

Compile Model Compiles the model in the selected runtime code. Click View

SAP NetWeaver Visual Composer Reference Guide 7


November 2006

Button Name Description


source code in the Deploy to Portal task panel to display the
compiled file.
Deploy Model Compiles the model in the selected runtime code and
packages it for deployment to the portal. See Deploy to Portal
Task Panel [Page 81].

Integration
These icons also appear next to the left of the main menu options.
To customize the main toolbar – changing the position of buttons, and adding and deleting
others – see Customize Toolbar [Page 124].

3.3 Workspace Boards


Definition
The workspace consists of a tabbed set of grids – or boards – on which you build and design
your model.

Structure
The workspace can contain up to four boards, displaying different views of the model:

Board Use
Design Constructing your model
Layout Customizing the layout of iViews
Source Reviewing the code that is automatically generated by Storyboard as
you build your model

The various boards are available according to the model component you are working with.
Each board has its own toolbox, which provides a set of board-specific tools to assist you
with the tasks you perform on that board. See the following sections (from Workspace
Toolboxes [Page 9]) for detailed descriptions of the contents of each toolbox.

SAP NetWeaver Visual Composer Reference Guide 8


November 2006

3.4 Workspace Toolboxes


Definition
Each workspace board has a toolbox of functions specific to that board. The following
toolboxes are available:
• Design board toolbox
• Layout board toolbox
• Source toolbox

Use
By default, the toolbox appears at the bottom of the displayed board. You can change its
location or hide it by choosing Tools → Options → Workspace. You can customize each
toolbox by choosing Tools → Customize.

Structure
The following tables describes each of the buttons in the four toolboxes:

Design-Board Toolbox Buttons

Button Name Description


Pointer Standard pointer.

Zoom In Zooms into the board incrementally with each mouse click.
Note that you can also use the Fit, 1:1 and zoom value field at
the top right of the board to define your exact zoom view.
Zoom Out Zooms out on the board incrementally with each mouse click.
Note that you can also use the Fit, 1:1 and zoom value field at
the top right of the board to define your exact zoom view.
Hand Tool Moves the entire board with the cursor.

Zoom Tool Magnifies the element in the area you define by dragging the
mouse.
Annotation Tool Adds a text block for writing notes (design-time only).

View Level 1 Displays the layers and transitions only.

View Level 2 Displays the layers and transitions, and the layer contents
(what the user sees).
View Level 3 Displays the full model logic.

High Quality Displays the elements in the workspace in high/low quality.

Show Grid Shows/hides the workspace grid.

Show Magnifier Provides a “magnifying glass“ for magnifying the part of an


element under the magnifying circle.

Layout-Board Toolbox Buttons

SAP NetWeaver Visual Composer Reference Guide 9


November 2006

Button Name Description


Bring to Front Moves selected element(s) to the top layer of layout.

Send to Back Moves selected element(s) to the bottom layer of layout.

Align Controls Displays a context menu for aligning the selected


elements.
Distribute Controls Displays a context menu for distributing the selected
elements.
Fit to Contents Resizes the selected UI element (view) so that its contents
fit properly within the view, without unneeded space.
Fit to Window Resizes the width of the view to match the width of the
iView.
Show Grid Shows/hides the workspace grid.

Wireframe Displays the outlines of the model elements as dashed


lines.
Arrange Drawing This feature is not yet implemented.

Source Toolbox Button

Button Name Description


Wrap Lines Wraps the text lines to fit the viewing window. If not
selected, use the horizontal scrollbar to view the text.

SAP NetWeaver Visual Composer Reference Guide 10


November 2006

4 Model Menu Dialog Boxes


This chapter describes the operations performed when you choose an option from the Model
menu in the Visual Composer main menu.
The topics included in this section are:
• New Model [Page 11]
• Open Model [Page 12]
• Save As [Page 12]
• Manage Models [Page 13]
• Print [Page 13]
• Export to File [Page 14]
• Import from File [Page 14]
• Unlock Models [Page 15]

4.1 New Model


Definition
The Create a New Model dialog box is displayed when you choose Model → New Model or
click the New Model button in the main toolbar. You use the dialog box to enter a name for
the new model file in the path displayed.

Structure
The fields of the dialog box are listed in the following table:
Field Description
Name The unique name you give to the new model. Naming rules include:
• Only alphanumeric characters and underscores
• No spaces or punctuation marks
• No special characters
Path Read-only
To change the path, choose Model → Manage Models and in the Model
Browser dialog box, navigate to the location that you want to display as the
default path.

Integration
Once you click OK in the Create a New Model dialog box, the Storyboard workspace (Design
board) is displayed, with the Compose Model task panel at the right.
You can create models using the Model Browser dialog box (Model → Manage Models) as
well, navigating to the folder in which you want to create the model and clicking the New
Model button. See Manage Models [Page 13].

SAP NetWeaver Visual Composer Reference Guide 11


November 2006

4.2 Open Model


Definition
The Open Model dialog box is displayed when you choose Model → Open Model or click the
Open Model button in the main toolbar. You use the dialog box to locate and open the file you
want to edit.

Structure
The Open Model dialog box – like the Model Browser – displays a tree hierarchy of the folders
and models on the Visual Composer server. There are two main nodes:
• MyModels includes the user models that you create in your client workspace.
• Public includes models created and saved for general use by all users.
To open a model, select it and click Open. If you decide to create a new model rather than
select an existing one, click New.

4.3 Save As
Definition
The Save As dialog box is displayed when you choose Model → Save As.

Use
You use the dialog box to save the open model under a different name, so that the original file
remains as it was when opened, without the recent changes you may have made.

You can also use the dialog box to save the file in a different location on the server. For
example, you may want to save a copy of your own model in the Public folder, so that other
users can have free access to the model.

Structure
The dialog box displays a tree hierarchy of the folders and models on the Visual Composer
server. You browse through the tree to indicate the location in which you want to save the
model. The main fields and controls of the dialog box are listed in the following table:
Field Description
Model Path Read-only.
Textually lists the path defined in the tree structure above.
Model Name A unique name for the new copy of the model.

SAP NetWeaver Visual Composer Reference Guide 12


November 2006

4.4 Manage Models


Definition
The Model Browser dialog box is displayed when you choose Model → Manage Models or
when you click the Manage Models button in the main toolbar. You use the Model Browser to
perform basic operations residing in the model tree, and to create new models as well.

Structure
The tree structure displays the hierarchy of folders and models residing on the Visual
Composer server. You use the buttons of the toolbar to perform the following actions on the
selected tree item:

Model Browser Toolbar Buttons

Button Name Description


New Model Opens the Create a New Model dialog box for creating a
new model at the path you define.
New Folder Creates a new folder in the selected open folder.

Open Model Opens the selected model in Storyboard.

Delete Model First, displays a confirmation message ensuring that you


want to delete the selected folder or model. If you answer
Yes, the item is removed from the tree structure and deleted
from the server.
Rename Activates the text of the selected item so that you can type in
a new name.

4.5 Print
Definition
The Model → Print option generates a “printer-friendly“ version of the model, displayed in a
separate browser window.

Use
From the File menu of the browser window, choose Print. The standard Windows Print dialog
box is displayed. Click Print to print the displayed diagram.
See also Documentation Wizard [Page 113].

SAP NetWeaver Visual Composer Reference Guide 13


November 2006

4.6 Export to File


Definition
When you choose Model → Export to File, the standard Windows File Download dialog box is
displayed for activating the export process. This enables you to save the currently-open
model at the location you indicate on your computer or elsewhere in the network.

Structure
From the File Download dialog box, click Save. The standard Windows Save As dialog box is
displayed to navigate to the location at which the file is to be saved. Locate the file location
and in the File name text box, enter an appropriate name for the exported model. Then click
Save. The file is saved as a GML file.

Integration
Once you have exported a model, it can be subsequently imported into other Visual
Composer models using the Model → Import from File option.

4.7 Import from File


Definition
The Import from File dialog box enables you to select a previously-exported model and
integrate it into the currently-open model.

Use
You can import models previously exported from Visual Composer Storyboard, and saved as
GML (Generic Modeling Language) files on a computer in the network or on the Storyboard
server.

Structure
The fields and controls of the dialog box are listed in the following table:
Field/Control Description
File Name Name of model to be imported. Use the Browse
button to locate the file.
Merge imported package into this model If you check this option, the contents of the
selected model are integrated into the open
model. If you leave the box unchecked, the
model is imported in a package (folder) so that
you can open it separately.

SAP NetWeaver Visual Composer Reference Guide 14


November 2006

4.8 Unlock Models


Definition
The Unlock Models dialog box, displayed when you choose Model → Unlock Models, is used
to enable you to release certain of your models that may have become locked for editing by
other users.

Use
In the Unlock Models dialog box, a list is displayed showing any models in your client
workspace that may have, for some reason, become locked. Using the checkboxes, you
select the models that you want to unlock.

Structure
The main fields and controls of the dialog box are listed in the following table:
Field/Control Description
Select all Checks the boxes of all the listed models
Clear all Clears the checks from all boxes of the listed model

SAP NetWeaver Visual Composer Reference Guide 15


November 2006

5 Task Panels
The task panels are the panes to the right of the Storyboard workspace. They contain the
tools required to build your model, configure each model element, locate the data services,
and deploy the model.
You use the task panels in conjunction with the different workspace boards, and according to
the task you are performing for building your application.
The task panels in this version of Visual Composer have been defined for use with freestyle
application modeling. The task panels are:
• Get Started Task Panel [Page 16]
• Browse Model and Search Model Task Panels [Page 17]
• Compose Model Task Panel [Page 20]
• Configure Element Task Panel [Page 25]
• Find Data Services Task Panel [Page 73]
• Deploy to Portal Task Panel [Page 81]
At times, you may want to hide the open task panel in order to enlarge the available
workspace. To do so, click the X at the top right of the panel, or use the window splitter
between the workspace and the task panel to close it partially or entirely. You can reopen the
panel by moving the splitter to the left.
To move the task panel to the left of the workspace, choose Tools → Options → Workspace
tab, and from the Taskbar position drop-down list, choose Left.

5.1 Get Started Task Panel


Definition
The Get Started task panel is the first task panel displayed when you open Visual Composer
Storyboard. It enables you to open existing models or to create a new model.

Use
You can use the Get Started task panel as an alternative to the menu options (Model → New
Model and Model → Open Model) or the main toolbar options (New Model and Open Model).

Structure
In the main pane of the task panel, under Open an existing model, a tree hierarchy is
displayed of all models available to you on the Visual Composer server. In the MyModels
folder are models that you have created. In the Public folder are models that have been
created for access by all users.
Rather than select a model from the tree, you can use the Look for other models option under
Related tasks at the bottom. This opens the Open Model dialog box (see Open Model [Page
12]).
To create a new model, you can use the Create a new model option in the Related tasks list,
opening the Create a New Model dialog box (see New Model [Page 11]).

SAP NetWeaver Visual Composer Reference Guide 16


November 2006

5.2 Browse Model and Search Model Task Panels


Definition
The Browse Model task panel displays a hierarchical tree that represents the open model.
The Search Model task panel is a search engine used in conjunction with the Browse Model
task panel.

Use
You can use the Browse Model tree to modify the model hierarchy and to navigate through
the model. The Search Model task panel, accessed from the open Browse Model panel,
enables you to locate elements within the open model.

Structure
For details about each task panel, see:
• Browse Model Task Panel [Page 17]
• Search Model Task Panel [Page 19]

SAP NetWeaver Visual Composer Reference Guide 17


November 2006

5.2.1 Browse Model Task Panel


Definition
This task panel is used to view a hierarchical tree of the model elements.

Structure
The Browse Model task panel includes the following elements:
• Drop-down lists for adjusting the display
• Hierarchical tree

Use the drop-down lists to filter the tree display as follows:


• Display options:
Menu Option Description
Detailed tree Expands nodes to display all elements within the model,
down to component level (not included are operators and
connectors).
Top-level elements only Collapses all nodes to display only the top-most items, such
as package, page or iView.

• Sort by options:
Menu Option Description
Element type Orders the display according to the type of element. For
example, top-level elements are grouped by package, page
and iView, while the elements in expanded nodes are
grouped according to input forms, tables, data services and
so on.
Element name Orders each level of elements alphabetically.

The hierarchical tree displays the elements in the model, starting from the top-level elements:
packages, pages and iViews. Each top-level node can be expanded to display all the
elements contained in that node, according to the display and sort options from the drop-
down menus. You can use the tree to:
• Locate and view an element in the model, by double-clicking the element in the tree to
display it on the Design board
• Copy elements from a node, by dragging them to the target top-level node
• Rename an element, by double-clicking it in the tree, and then using the right-click
context menu
• Delete an element, by double-clicking it in the tree, and then using the context menu

SAP NetWeaver Visual Composer Reference Guide 18


November 2006

5.2.2 Search Model Task Panel


Definition
This task panel – accessed through the Browse Model task panel – is used to search for
elements of a given name or mask. Searches can find elements as small as an input port of a
data service or a data-binding line.

Use
To display the search model, click Search Model at the bottom of the Browse Model task
panel. Using the fields and controls listed in the following section, define your search and click
Search. The results are displayed in the empty pane. When you double-click an item in the
results pane, the model area containing that item is displayed on the Design board and the
specific item is highlighted.

Structure
The Search Model task panel includes the following fields and controls:
Field/Control Description
Look for field The partial or complete text of the element(s) you are
searching for. To mask a name, use an asterisk (*).
Filter by drop-down list Limits the search defined in the Look for field according
to the following types of element:
None Model
BI and alert data service Nested iView
BI data service OLAP query
BI query Package
Black box Page
Characteristic Relational query
Chart view Rule
Data service SAP data service
Form view Table view
HTML view Web service
iView
Layer
For details about each type of element, see Compose
Model Task Panel [Page 20]
Search button Executes the search you define.
Clear button Deletes the results displayed from a previous search.
Option button Displays additional search options, listed in the
following rows.
Search entire model checkbox Searches both high-level and lower-level nodes of the
model.
Case-sensitive search checkbox Search only for text listed exactly as in the Look for
field.
Full-text search checkbox Searches through all text at all levels of the model.

SAP NetWeaver Visual Composer Reference Guide 19


November 2006

5.3 Compose Model Task Panel


Definition
The Compose Model task panel serves as a repository of elements that can be dragged-and-
dropped onto the Design board to compose the model workflow. Only those elements
applicable to the current level of the model are displayed.

Use
You build your model diagram by dragging the required icon from the Compose Model task
panel onto the Design board. Once you have placed certain elements on the board, you can
also drag out from their input or output ports and use the context menu to create the required
item.

If you drag out from a component that includes a large number of fields, the
Select Display Fields dialog box may be displayed, to enable you to limit the
fields that will be displayed in the form or table at runtime. For more information,
see Select Display Fields Dialog Box [Page 23].
When you create a new model or open an existing one, the Compose Model task panel
contains only icons for top-level elements: Package, Page and iView. As you drill down into
each element, the display in the task panel changes according to level.
Note also that the collection of elements displayed at iView level may change according to the
runtime environment that you select. To display only those model elements available in the
selected runtime (deploy) environment, choose Tools → Options → Compiler tab and check
the Mask Unsupported features option.
For more information, see Compose the Model [External] in the SAP NetWeaver Visual
Composer Modeler's Guide.

Structure
The following table describes the elements available in the different Compose Model task
panels:

Compose Model Elements

Element
Group Name Name Description Model Level
iView A diagram for defining a portal Top
iView.
Page A diagram for composing Top
iViews on a portal page.
Package A “container“ for organizing Top
model elements into a portal
package.
Components Form view A single form for data entry iView
and selection.
Table view A tabular view of data, for iView
display and/or edit.

SAP NetWeaver Visual Composer Reference Guide 20


November 2006

Element
Group Name Name Description Model Level
Chart view A range of chart types for iView
displaying data.
HTML view A container for displaying an iView
external HTML document.
Nested iView An iView within a selected iView
iView.
Layer A group of components that iView
are shown or hidden together
at runtime.
Connectors Start Defines a value to initialize the iView
flow.
End Defines the end of the flow. iView
Navigate Defines navigation to a iView
different iView.
Signal In Receives parameters from a iView
different iView.
Signal Out Sends parameters to another iView
iView.
Popup Signal Defines the flow of popup iView
data.
Timer Defines the timing of an event. iView
User Data Contains the personal data of iView
the user.
Data Store Temporarily stores data from iView
the model for later use.
Operators Filter Defines selection criteria for iView
retrieving and displaying data.
Sort Sorts data according to a iView
specified field.
Sigma Aggregates the values of all iView
the records into a single
record.
Upper Retains only the specified top iView
number of records.
Lower Retains only the specified iView
bottom number of records.
Distinct Omits records containing iView
duplicate data in the selected
fields. Note that the fewer
fields checked as distinct, the
fewer records are returned.

SAP NetWeaver Visual Composer Reference Guide 21


November 2006

Element
Group Name Name Description Model Level
Additional Union Merges into a new dataset the iView
Operators data of two datasets, and
removes duplicates.

Intersect Creates a new dataset from iView


data that exists in both of two
datasets.

Subtract Creates a new dataset from iView


two datasets by including data
that is only in the first dataset
but not in the second dataset.

Group by Groups a dataset according to iView


the selected operation – such
as Min or Count – defined for
one or more fields (columns).
Combine Combines two datasets into a iView
new dataset, channeled into
an input form.

For examples about using each element, see the Compose the Model [External] section of
the SAP NetWeaver Visual Composer Modeler's Guide. For details about each element and
its properties, see Configure Element Task Panel [Page 25].
You can filter the display of elements in the task panel by using the \ drop-down menu at the
top center. The options available in the menu are:

Menu Option Description


Large Icons Displays each icon with its label beneath it
Small Icons Displays icons only
List View Displays icons in a list, with labels to the right
Details View Displays icons in a list, with labels and tooltips
Expand All Displays icons (and labels) of all the groups
Collapse All Displays only the group names

SAP NetWeaver Visual Composer Reference Guide 22


November 2006

Integration
Usually, you will use the Find Data Services task panel first, to add the main data services of
the model. Afterwards, you will use the Compose Model task panel to add model elements
not inserted into the model by dragging out from the data services. See the Developing
Business Logic [External] section of the SAP NetWeaver Visual Composer Modeler's Guide
for a description of the overall model-creation process.
For more information about the Find Data Services task panel, see Find Data Services Task
Panel [Page 73].

5.3.1 Select Display Fields Dialog Box


Definition
This dialog box may be displayed when you drag out from a component that includes a large
number of fields. It enables you to limit the fields displayed in the form or table that you are
creating to those that are needed at runtime.

This option is activated/deactivated from the Options dialog box:


...

i. Choose Tools → Options.


ii. Click the Composing tab.
iii. In the top section (Ask for user intervention when creating:), choose
Components with more than and indicate the base number of fields that
will cause this dialog box to be displayed.

Structure
All the fields that can be output to the form or table are listed in the pane of the window.
Check the fields that should be included in the component. You can use the Select all and
Clear all checkboxes to facilitate the selection.
To define display fields for query information in a BI query, see Select Display Fields: Query
Information [Page 24].

SAP NetWeaver Visual Composer Reference Guide 23


November 2006

5.3.1.1 Select Display Fields: Query Information


Definition
Use the Select Display Fields dialog box to select the query information you want to display in
your model. Query information is textual information saved in a BI query such as query author
and last update of the data, and is generated from an output port on the BI query data
service. The Select Display Fields dialog box is displayed when you drag from a query's Info
port and choose Add Form View from the context menu.

Use
In the Select Display Fields dialog box, a list is displayed showing available query information.
Using the checkboxes, you select the query information that you want to display.

Structure
The main fields and controls of the dialog box are listed in the following table:
Field/Control Description
Select all Checks the boxes of all the information types.
Clear all Clears the checks from all boxes.
AUTHOR Author: The user who defined the query.
INFOCUBE InfoProvider: The InfoProvider that provides the data reported by the
query.
MODTIME Changed At: The time at which the query definition was last changed.
MODUSER Last Changed by: The user who last changed the query definition so
that the query has been regenerated.
REPTNAME Query Technical Name: Technical name for the query.
REPTXTLG Query Description: Description of the query.
ROLLUPTIME Status / Validity of Data: The point in time when data for the latest
request that can be used for reporting was posted to the InfoProvider.
This shows a date and a time (in the local time zone).
ROLLUP_DATE Relevance of the Data (date): The date of the ROLLUPTIME text
element.
ROLLUP_TIME Relevance of the Data (hour): The time of the ROLLUPTIME text
element.
SRDATE Key Date: The date for which time-dependent master data is selected.
SYUSER Current User: The user who has this query open.
SYUZEIT Last Refreshed: When the query data was last refreshed.

Example
See Adding Query Information to Your Model [External] in the SAP NetWeaver Visual
Composer Modeler's Guide.

SAP NetWeaver Visual Composer Reference Guide 24


November 2006

5.4 Configure Element Task Panel


Definition
The Configure Element task panel is used to configure the properties of each model element
on the Design board. In addition to defining the various element properties, you also use this
task panel to define and configure the fields and controls within the UI components.

Use
You can display the Configure Element task panel in one of three ways:
• Click the Configure button in the task-panel toolbar.
• Right-click the element and choose Configure Element from the context menu.
• On the Design board, double-click on the element.
The set of properties for each type of element differs, and many include tables at the bottom
of the task panel for mapping fields between elements.
For more information, see Configure Elements [External] in the SAP NetWeaver Visual
Composer Modeler's Guide.

Structure
Each model element and line defined in the Compose Model task panel can be configured in
the Configure Element task panel. However, note that:
• Layers are configured within the framework of the iView in which they are created.
• Annotations, created from the Design board toolbox, can also be configured.
The following sub-sections detail all of the properties and attributes that can be configured for
each model element. The topics are arranged alphabetically for easy access. Each element is
described according to the following format:
• Definition keyblock:
Provides a short description of the model element.
• Use keyblock:
Provides the following information about the element:
{ Group in the Compose Model task panel
{ Model level at which it can be added to the model
{ Restrictions to its use, if any
• Structure keyblock:
Provides a table or tables with the following information:
{ Property: the model characteristic
{ Attribute: the metadata of the element property
{ Description: explanation of the property or attribute, if needed

SAP NetWeaver Visual Composer Reference Guide 25


November 2006

5.4.1 Annotation
Definition
A design-time-only “note” or descriptive text added to the Design board.

Use
Free text inserted at any level of the model.

This element is added using the Annotation Tool button ( ) in the Design toolbox at the
bottom of the Design board. To insert it, click the button and click on the workspace at the
location you want to insert the annotation. Then type your text.

Structure
The following table describes the properties and attributes of this model element:
Property Attribute Description
Font style Normal Default
Emphasized Bold
Italics
Underline
Font size Given in points. Default size is 8
Alignment Left Aligns text to left
Right Aligns text to right
Center Centers each line of text
Fill color Displays a color palette for selecting the
background color of the annotation block

SAP NetWeaver Visual Composer Reference Guide 26


November 2006

5.4.2 Calendar View


Definition
A calendar view for display and/or edit of data information. Data is mapped onto the calendar
according to time periods.

Use
Group: Components
Model level: iView

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Calendar view Calendar title Name of calendar
Time period From date field The field in the back-end system
from which the start date is
retrieved and displayed in the
calendar
To date field The field in the back-end system
from which the end date is
retrieved and displayed in the
calendar
Calendar range Auto Displays data starting from the
earliest record retrieved from the
back-end system
Fixed Displays data starting from the date
defined in the Calendar start field
Bound Adds (or subtracts) incrementally
one month to the date defined in
the Calendar start field to display
data starting from that date
Calendar start The first month displayed in the
Calendar view (applicable only
when selecting Fixed or Bound)
Legend Legend Below
placement
Above
Left
Right
None
Legend filtering Filter Displays only legend items
corresponding to the data currently
displayed on the calendar

SAP NetWeaver Visual Composer Reference Guide 27


November 2006

Group Property Attribute Description


Show all Displays all legend items coming
from the back-end system,
regardless of the data currently
displayed on the calendar
Dynamic legend If selected, the calendar legend is
taken from the back-end system
(otherwise the legend must be
defined in Storyboard)
Edit Displays the Dynamic Legend
dialog box, where you can
select/create the entry list on which
the legend is based. See Entry List
Manager [Page 115] and Create an
Entry List [External] in the SAP
NetWeaver Visual Composer
Modeler's Guide.
Legend ID field The field in the back-end system
that contains the legend ID
Calendar Week numbers Show Adds the number of each week to
Formatting the calendar
Hide Hides the number of each week
Weekends Include Highlights weekends that overlap
the retrieved data
Skip Weekends that overlap retrieved
data are not highlighted on the
calendar
Color scheme Default Uses colors as defined by the
system default settings
Straight Uses light shades of various colors
(blue, green, yellow, ...), as defined
in the system default color palette
Reverse Uses dark shades of various colors
(blue, green, yellow, ...) as defined
in the system default color palette
Snake Uses different shades of the same
color, starting with light shades and
gradually shifting to dark ones
No. of months Number of months appearing in the
Calendar view
First week day The first day of the week displayed
on the calendar
Selection mode Single User can select one time period
Unselectable Read only
Toolbar Show Adds a toolbar button area
Hide Hides the toolbar button area

SAP NetWeaver Visual Composer Reference Guide 28


November 2006

Group Property Attribute Description


Edit Displays the Create Toolbar
Buttons dialog box (see Create
Toolbar Buttons Dialog Box [Page
179])
Layout Fit contents Auto Automatically sizes the contents of
the view according to its size
defined on the Layout board
Frame style Default Standard portal view frame

Primary frame Top border in standard color


White Top border in white
Neutral color Top border in lighter color
Dark color Top border in darker color
Transparent No frame
Frame title bar Displays view title
Collapsible Contents of view can be
frame hidden/displayed
Visibility Non No conditions are given for
condition displaying the calendar in runtime,
so that it will be automatically
visible
True The calendar will be visible when
this value appears in the formula
defining when the calendar is
displayed, such as Hidden,
Required and so on
False The calendar will not be visible
when this value appears in the
formula defining when the calendar
is displayed, such as Hidden,
Required and so on
Table at bottom # Legend item ID
Label Legend item label
Color Displays a color palette for
selecting the color of the legend
item
Condition A Boolean expression indicating
the condition that must be satisfied
in order for the legend item to be
displayed
Table at bottom ID Legend item ID
(when selecting
Dynamic Color Displays a color palette for
legend) selecting the color of the legend
item

SAP NetWeaver Visual Composer Reference Guide 29


November 2006

5.4.3 Chart View


Definition
A diagram, selected from a range of chart types, for displaying data.

Use
Group: Components
Model level: iView
For more information about creating a chart, see Create a Chart [External] in the SAP
NetWeaver Visual Composer Modeler's Guide.
...
...

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Chart view Chart type Area Calculates the interception point of
the X value and the Y value, filling
in the area below it, displaying the
trend of each value over time or
category
Bar Compares values across
categories, in a horizontal display
(with the category given in the
vertical, Y, axis)
Column Compares values across
categories in a vertical display (with
the category given in the horizontal,
X, axis)
Line Displays the results of a data series
as a continuous line drawn from
point to point (value to value) of the
X axis
Pie Shows how the values in a single
data series relate to the sum of the
results, with each value depicted as
a percentage of the total value
Doughnut Displays the results in a pie chart
that is hollow and may depict
multiple series
Combo A combination of column and line
chart
Data series Clustered For bar, column or combo charts,
compares the values of a category
by depicting one next to the other
Stacked For bar, column, line, area or
combo charts, shows the
relationship of each value of a
category as a part of a single bar or
line

SAP NetWeaver Visual Composer Reference Guide 30


November 2006

Group Property Attribute Description


Overlaid For area or line charts, overlays the
values of a category to show the
relationship of each value to the
whole
3-D clustered Adds a third dimension to the
clustered display
3-D stacked Adds a third dimension to the
stacked display
3-D overlaid Adds a third dimension to the
overlaid display
Area contour Slope The edges of the area are drawn
and smoothly
Line contour
Curve The edges of the area are drawn
as sharper corners
Elbow The edges of the area are drawn
as right angles
Pie labels Auto Inserts the value inside the pie or
doughnut segment if possible
Inside Inserts the value inside the pie or
doughnut segment
Outside Places the value inside the pie or
doughnut segment
Callout Draws a line from the pie or
doughnut segment to the value
placed outside
Inner radius The radius of the hollow part of the
doughnut
Category Axis Field The field whose values are used as
the categories of the chart
Axis label A name for the category axis
Value Axis Axis label A name for the value axis
Value range Auto-adjust Determines the points and
increments of the value axis
according to the resulting values
Base at zero Sets the first point of the value axis
at 0

SAP NetWeaver Visual Composer Reference Guide 31


November 2006

Group Property Attribute Description


Fixed range User-defined range, as follows:
• Minimum value: first point on
axis
• Maximum value: last point on
axis
• Interval size: number
indicating the amount
between points on the axis
Range slider Adds a slider to the chart. Although
the value range begins at 0, the
slider range is defined according to
the same values defined in Fixed
range previously
Dynamic range Same as the range slider, but the
slider value axis begins at the Minimum
value rather than at 0
Tick marks Number of marks to be indicated
on the axis
Data Animation Effect None No animation
Interpolate Calculates how to connect data
points, in order to fill in gaps and
create a continuous line or series of
values. The interpolation method is
defined according to:
• Speed: from Very slow to
Very fast
• Apply to:
{ Entire chart
{ Data series
(categories)
{ Data points (values)
{ Data series/points
(both)

SAP NetWeaver Visual Composer Reference Guide 32


November 2006

Group Property Attribute Description


Slide in / out Displays the chart data in a sliding
motion, according to the following
parameters:
• Direction: From left, From
right, From top or From
bottom
• Speed: from Very slow to
Very fast
• Apply to:
{ Entire chart
{ Data series
(categories)
{ Data points (values)
{ Data series/points
(both)
Fold / Unfold Displays the chart data as
“unfolding“ motion, according to the
following parameters:
• Speed: from Very slow to
Very fast
• Apply to:
{ Entire chart
{ Data series
(categories)
{ Data points (values)
{ Data series/points
(both)
Chart Legend Below
Formatting placement
Above
Left
Right
None
Grid display Default For HTMLB, this indicates “no grid
display“
Horizontal lines Horizontal lines only
Vertical lines Vertical lines only
Grid lines Standard vertical and horizontal
lines
Horizontal Horizontal stripes (thick lines) only
stripes
Vertical stripes Vertical stripes (thick lines) only

SAP NetWeaver Visual Composer Reference Guide 33


November 2006

Group Property Attribute Description


None No grid at all
Color scheme Default Standard portal color scheme
Straight Portal color scheme used for area,
column and bar charts
Reverse Portal color scheme used for line
charts
Snake Portal color scheme used for pie
charts
Toolbar Show Adds a toolbar button area
Hide Hides the toolbar button area
Edit Displays the Create Toolbar
Buttons dialog box (see Create
Toolbar Buttons Dialog Box [Page
179])
Layout Fit contents Auto Automatically sizes the contents of
the view according to its size
defined on the Layout board
Frame style Default Standard portal view frame
Primary frame Top border in standard color
White Top border in white
Neutral color Top border in lighter color
Dark color Top border in darker color
Transparent No frame
Frame title bar Displays view title
Collapsible Contents of view can be
frame hidden/displayed
Visibility [none] No conditions are given for
condition displaying the form in runtime, so
that it will be automatically visible
true The form will be visible when this
value appears in the formula
defining when the form is
displayed, such as Hidden,
Required and so on
false The form will not be visible when
this value appears in the formula
defining when the form is
displayed, such as Hidden,
Required and so on
Enter formula Formula for indicating under what
conditions the view is displayed in
the iView

SAP NetWeaver Visual Composer Reference Guide 34


November 2006

Group Property Attribute Description


Table at bottom # Series ID
Data Series Name of the data series (category)
axis
Formula Field on which to base the data-
series axis

5.4.4 Combine Operator


Definition
A Flex-based operator that combines two datasets into a new dataset, channeled into an
input form.

Use
Group: Additional Operators
Model level: iView

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Combine Name Label for the operator
Operator
Table at bottom Type of data in field

Field Name of field processed through


the operator

SAP NetWeaver Visual Composer Reference Guide 35


November 2006

5.4.5 Data Binding


Definition
A connection between two UI components (or between a web service and a UI component)
that channels identical data from the output port of one UI component to the input port of the
other UI component.

Use
This connection line is defined directly on the Design board.
Model level: iView

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Data Binding Event name Disabled; not relevant
Guard condition Disabled; not relevant
Line style Straight Direct 45-degree line with no
corners
Angular Direct line
Curved
With right angles Line with 90-degree angles
(orthogonal)
[default] Orthogonal lines
Table at bottom Type of data in field

Field Name of field processed through


the operator

SAP NetWeaver Visual Composer Reference Guide 36


November 2006

5.4.6 Data Flow


Definition
The means by which data is channeled between a data service and connected UI
components, or between two UI components whose connection was changed from Data
binding to Data flow.

Use
This connection line is defined directly on the Design board.
Model level: iView

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Data Flow Event name Disabled; not relevant
Guard condition Disabled; not relevant
Line style Straight Direct 45-degree line with no
corners
Angular Direct line
Curved
With right angles Line with 90-degree angles
(orthogonal)
[default] Orthogonal lines
Table at bottom Type of data in field

Field Name of field processed through


the operator

SAP NetWeaver Visual Composer Reference Guide 37


November 2006

5.4.7 Data Mapping


Definition
A connection between two model components, describing, for example, what data is input to
an element or what fields are output from another element. This type of connection requires
mapping of the data fields from the input element to the fields of the data service.

When you drag out from the input port of a data service in order to create the
input element, the fields are mapped automatically.

Use
This connection line is defined directly on the Design board.
Model level: iView

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Data Mapping Event name The name of the action that raises the event
for transferring the data to the data service
Guard condition An expression indicating the condition that
must be satisfied in order for the event to be
activated
Mapping scope All data Transfers to the data service all of the table’s
rows rows
(appears only if
Multiple is Selected Transfers to the data service only table rows
selected in the data rows selected by the user
Selection mode
drop-down list.
See Table View
[Page 65])
Line style Straight Direct 45-degree line with no corners
Angular Direct line
Curved
With right Line with 90-degree angles (orthogonal)
angles
[default] Orthogonal lines
Table at bottom Type of data in field

Input Field The name of the field required at the input to


the data service
Assigned Value The name of the field coming from the output
of the component that corresponds to the
field at the input to the data service

SAP NetWeaver Visual Composer Reference Guide 38


November 2006

5.4.8 Data Service


Definition
An element that provides access to data, such as that in a query, BAPI, or stored procedure,
from one of different types of systems configured on the portal.

Use
Group: N/A
Model level: iView
Restrictions: The list of available systems depends on what is configured in the portal and
how it is configured. For example, SAP BW systems 3.1C configured as OLAP systems using
the BI XMLA Connector are displayed as OLAP query data services in the workspace. SAP
BW systems 3.5 and higher configured with the SAP Java Connector, however, are displayed
as BI queries in the workspace. See the SAP NetWeaver Visual Composer Installation &
Configuration Guide [External] for more information about preparing your back-end systems.

Structure
The following table describes the properties and attributes available in different types of
systems:
Data Service Property Attribute Description
SAP Data Service Service name Name of the data
service as referred to
in Visual Composer
System alias The alias defined for
the system in the
portal system
landscape
System type Formal name of the
back-end system
Technical name Technical name
assigned to the data
service
Auto commit For function modules
that modify the
database, a second
“commit” call is
automatically sent to
confirm the database
update
Auto convert Indicates that a
conversion BAPI is
required, for values in
one unit of
measurement to
another
SAP Web service Service name Name of the web
service as referred to
in Visual Composer

SAP NetWeaver Visual Composer Reference Guide 39


November 2006

Data Service Property Attribute Description


System alias The alias defined for
the system in the
portal system
landscape
System type Formal name of the
web service system
Technical name Technical name
assigned to the data
service
Auto commit For function modules
that modify the
database, a second
“commit” call is
automatically sent to
confirm the database
update
Auto convert Indicates that a
conversion BAPI is
required, for values in
one unit of
measurement to
another
BI Query Name Name of the data
service as referred to
in Visual Composer
System BI system name,
which you can edit in
case you move the
model to a different
system environment
Provider Technical name of
the InfoProvider (not
editable)
Query Technical name of
the query (not
editable)
View Technical name of
the query view, if
applicable (not
editable)
Maximum rows Display limit of the
query’s result as
deployed to the
portal, to avoid
unintentionally
returning a very large
result

SAP NetWeaver Visual Composer Reference Guide 40


November 2006

Data Service Property Attribute Description


Suppress sum Indicates that the
result rows should
not be displayed in
the query result
Characteristic Name Name of the data
service as referred to
in Visual Composer
System BI system name,
which you can edit in
case you move the
model to a different
system environment
Provider Technical name of
the InfoProvider (not
editable)
Technical name Technical name of
the characteristic (not
editable)
Read mode Master Data Table Offers all values of
the selected
characteristic that
appear in the master
data table. Since
InfoCubes may be
quite sparsely
populated, this will
yield many selections
that show no results,
but the logic involved
is simple and hence
the performance is
optimal.
Dimension Table Performs a SELECT
on the dimension
table to retrieve the
list of characteristic
values. This
calculation is more
time-consuming than
Master Data Table,
but with better
chances of yielding
applicable results.
Relational Query Name Name of the data
service as referred to
in Visual Composer

SAP NetWeaver Visual Composer Reference Guide 41


November 2006

Data Service Property Attribute Description


System System name, which
you can edit in case
you move the model
to a different system
environment
Maximum rows Display limit of the
query’s result as
deployed to the
portal, to avoid
unintentionally
returning a very large
result
OLAP Query Name Name of the data
service as referred to
in Visual Composer
System System name, which
you can edit in case
you move the model
to a different system
environment
Maximum rows Display limit of the
query’s result as
deployed to the
portal, to avoid
unintentionally
returning a very large
result

SAP NetWeaver Visual Composer Reference Guide 42


November 2006

5.4.9 Distinct Operator


Definition
A general operator that omits records containing duplicate data in the selected fields. Note
that the fewer fields checked as distinct, the fewer records are returned.

Use
Group: Operators
Model level: iView

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Distinct Name Label for the operator
Operator
Table at bottom Type of data in field

Field Field whose values should be


returned only once
Distinct Checkbox for selecting Field

5.4.10 End Point


Definition
A connector that defines the end of a flow. In a popup, it returns data to the item that called up
the popup.

Use
Group: Connectors
Model level: iView

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
End Point Name Label for the connector
Table at bottom Type of data in field

Output Field returned by the end point.


Parameters

SAP NetWeaver Visual Composer Reference Guide 43


November 2006

5.4.11 Filter Operator


Definition
A general operator that defines selection criteria for retrieving and displaying data.

Use
Group: Operators
Model level: iView

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Filter Operator Name Label for the operator
Table at bottom Type of data in field

Field Field in which filter criteria (User


Parameters) is defined
User Parameters Equals to “text“ Value of the text field exactly
matches the defined text
Starts with “text“ Value of the text field begins with
the defined text
Ends with “text“ Value of the text field ends with the
defined text
Contains “text“ Value of the text field contains the
defined text
“text1“ or “text2“ Value of the text field contains
either one text or another text
“text1“ or “text2“ Value of the text field contains both
of two defined texts
Equals to 10 Value of the numerical field exactly
equals the number entered
Greater than 10 Value of the numerical field is
greater than the number entered
Smaller than 10 Value of the numerical field is less
than the number entered
Between 10 and Value of the numerical field ranges
20 between the two numbers entered

SAP NetWeaver Visual Composer Reference Guide 44


November 2006

5.4.12 Form View


Definition
A single form used for entering and selecting data.

Use
Group: Components
Model level: iView
...

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Form view Form title Name of form
Editing mode Editable User can enter data into the form and
change displayed data
Read-only User can view displayed data only
Toolbar Show Adds a toolbar button area
Hide Hides the toolbar button area
Edit Displays the Create Toolbar Buttons
dialog box (see Create Toolbar Buttons
Dialog Box [Page 179])
Scroll buttons Show Adds a scrolling button area
Hide Hides the scrolling button area
Edit Displays the Page Scrolling Buttons
dialog box
Layout Fit contents Auto Sizes the contents of the view according
to system default settings
Actual size Sizes the contents of the view as defined
on the Layout board
Fit width Changes the contents of the view in
proportion to the form size
Align contents Absolute User can freely arrange the UI
components on the form (long labels may
not be fully shown at runtime)
Vertical Lines up the form’s UI components
vertically
Horizontal Lines up the form’s UI components
horizontally
Place labels Before Places the labels to the left of the form’s
fields and controls
Above Places the labels above the form’s fields
and controls

SAP NetWeaver Visual Composer Reference Guide 45


November 2006

Group Property Attribute Description


Size window Exact The size of the form at runtime is exactly
as defined on the Layout board (if
necessary, scroll bars will appear in order
to display all UI components)
Expand Enables the form to expand as needed at
runtime in order to accommodate all UI
components
Fit Shrinks or expands the form at runtime so
that it tightly fits around the UI
components
Frame style Default Standard portal view frame
Primary frame Top border in standard color
White Top border in white
Neutral color Top border in lighter color
Dark color Top border in darker color
Transparent No frame
Frame title bar Displays view title
Collapsible Contents of view can be hidden/displayed
frame
Visibility [none] No conditions are given for displaying the
condition form in runtime, so that it will be
automatically visible
true The form will be visible when this value
appears in the formula defining when the
form is displayed, such as Hidden,
Required and so on
false The form will not be visible when this
value appears in the formula defining
when the form is displayed, such as
Hidden, Required and so on
Enter formula Formula for indicating under what
conditions the view is displayed in the
iView
Table at The field is visible in form
bottom
Data type of the field

Field Name of the field


Control Type of control (for a full list of control
types, see Control Properties Dialog Box
[Page 82])

SAP NetWeaver Visual Composer Reference Guide 46


November 2006

5.4.13 Group by Operator


Definition
An operator that groups a dataset according to the specified set of grouping fields, for which
selected sigma functions have been defined.

Use
Group: Additional Operators
Model level: iView

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Group Operator Name Label for the operator
Table at bottom Type of data in field

Field Field from which data should be


grouped
Sigma Group1 Subgroupings of the selected field
Group2
Group3
COUNT Totals the number of field values
that are not blank
MIN Returns the lowest field value
MAX Returns the greatest field value
SUM Returns the sum of all field values
AVERAGE Returns the average (arithmetic
mean) of the field values
VARIANCE Estimates variance based on the
field values
STDDEV Estimates standard deviation
based on the field values
[none]

SAP NetWeaver Visual Composer Reference Guide 47


November 2006

5.4.14 HTML View


Definition
A container for displaying an external HTML document.

Use
Group: Components
Model level: iView

Be aware that all text written in the HTML View is not translated with the model.
...

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
HTML view HTML title Name of the view
Default URL URL of the HTML document to be
displayed
Toolbar Show Adds a toolbar button area
Hide Hides the toolbar button area
Edit Displays the Create Toolbar
Buttons dialog box (see Create
Toolbar Buttons Dialog Box [Page
179])
Layout Fit contents Auto Automatically sizes the contents of
the view according to its size
defined on the Layout board
Frame style Default Standard portal view frame
Primary frame Top border in standard color
White Top border in white
Neutral color Top border in lighter color
Dark color Top border in darker color
Transparent No frame
Frame title bar Displays view title
Collapsible Contents of view can be
frame hidden/displayed
Visibility [none] No conditions are given for
condition displaying the form in runtime, so
that it is automatically visible
true The form is visible when this value
appears in the formula defining
when the form is displayed, such as
Hidden, Required and so on

SAP NetWeaver Visual Composer Reference Guide 48


November 2006

Group Property Attribute Description


false The form is not visible when this
value appears in the formula
defining when the form is
displayed, such as Hidden,
Required and so on
Enter formula Formula for indicating under what
conditions the view is displayed in
the iView

5.4.15 Input Signal


Definition
A connector that receives parameters from a different iView.

Use
Group: Connectors
Model level: iView

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Input Signal Name Label for the connector
EPCM Event URN of the other portal iView
Table at bottom Type of data in field

Input Fields Fields input through the signal

SAP NetWeaver Visual Composer Reference Guide 49


November 2006

5.4.16 Intersection Operator


Definition
An operator that creates a new dataset from data that exists in both of two datasets, as in the
following illustration:

Use
Group: Additional Operators
Model level: iView

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Intersection Name Label for the operator
Operator
Table at bottom Type of data in field

Field Field from which data should be


grouped
Key Checkbox for selecting the Field

SAP NetWeaver Visual Composer Reference Guide 50


November 2006

5.4.17 iView
Definition
A diagram for defining a portal iView.

Use
Group: Components
Model level: Model (top level)

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Portal iView Window type Primary window A standalone window or source
window for other windows
Nested window A window that is designated to
display a nested iView within
another iView (see Nested iView
[Page 57])
Popup window A window that is designated to
display an iView activated by a
popup signal within another iView
(see Popup Signal [Page 60])
Window title iView name
Show title bar Display iView name in window
Fit contents Default Sizes the contents of the iView
according to system default
settings
Actual size Automatically sizes the iView
components according to its size
defined on the Layout board
Fit width Changes the size of the iView
components to fit the window’s
width
Fit height Changes the size of the iView
components to fit the window’s
height
Both Changes the size of the iView
components to fit the window’s
width and height
Layout method Auto Arranges the contents of the iView
according to system default
settings
Absolute User can freely arrange the
components of the iView
Vertical Lines up the iView components
vertically

SAP NetWeaver Visual Composer Reference Guide 51


November 2006

Group Property Attribute Description


Horizontal Lines up the iView components
horizontally
Window splitters Adds splitters between iView
components that enables their
resizing at runtime
Window Enables dragging and rearranging
dragging iView components at runtime
Layers See Layers [Page 53]
Table at bottom The display is according to the type
of layers defined (if any). See
Layers [Page 53]

SAP NetWeaver Visual Composer Reference Guide 52


November 2006

5.4.18 Layers
Definition
A mechanism for grouping components that are shown or hidden together at runtime.

Use
Group: Components
Model level: iView
For more information about building layered iViews, see How to . . . Create Layered iViews
[External] in the SAP NetWeaver Visual Composer Modeler's Guide.
...

Structure
Layers are configured as part of the Portal iView model component. The following table
describes the properties and attributes that are relevant to configuring the layers only:
Group Property Attribute Description
Layers Navigation None Standard layers are used, without
control tabs or wizard steps (see Using
Standard Layers [External] in the
SAP NetWeaver Visual Composer
Modeler's Guide)
Tab strip Labeled tabs are used to enable the
user to navigate between layers
Wizard Numbered and labeled boxes are
used as steps and optional
substeps to navigate between
layers
Accordion A stack of collapsible panels is used
to display and hide the information
in each layer
Link list A horizontal row of link controls, like
tabs, is used to navigate between
layers
Link tree A hierarchical tree of
collapsible/expandable link controls
is used to display the content of the
layers to the right of the tree
Default layer For standard layers (None as
Navigation control), the Layer Name
(from the table at the bottom of the
task panel) that indicates the first
layer to be displayed
Default step For a wizard, the Step Name (from
the table at the bottom of the task
panel) that indicates the first layer
to be displayed

SAP NetWeaver Visual Composer Reference Guide 53


November 2006

Group Property Attribute Description


Default tab For tab strips, link lists and link
trees, the Tab Name (from the table
at the bottom of the task panel) that
indicates the first layer to be
displayed
Default panel For accordions, the Panel Name
(from the table at the bottom of the
task panel) that indicates the first
layer to be displayed
Transition effect [none] The next layer is displayed directly,
without animated effects
Slide (horiz) Slide in from left
Slide (vert) Slide in from top
Swap (horiz) Swap horizontally
Swap (vert) Swap vertically
Swivel Swivel in/out
Wipe (horiz) Wipe horizontally
Wipe (vert) Wipe vertically
Fade In/Out
Zoom In/Out
Roadmap steps Show all steps For wizards, displays both main and
substeps
Show main For wizards, displays only main
steps steps
Table at bottom # For all types of layers, the layer ID
number
For design purposes only, highlights
the selected layer
Layer Name Label of a standard layer (None)
Tab Name For tab strips, link lists and link
trees, the layer name, displayed in
the tab
Step Name For wizards, the label of the step
displayed below the box
Step Label For wizards, the number displayed
in the box
Panel Name For accordions, the label of the
layer displayed in the panel

SAP NetWeaver Visual Composer Reference Guide 54


November 2006

5.4.19 Lower-Range Operator


Definition
A general operator that retains only the specified bottom number of records.

Use
Group: Operators
Model level: iView

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Lower-Range Name Label for the operator
Operator
Field Field whose values define the
range
No. of rows The number of records in the range

5.4.20 Model
Definition
The top-level model component (diagram), on which packages, pages and iViews are defined.

Use
Group: Components
Model level: Model (top level)
Using the Add (plus) button at the bottom, you can enter data describing the model in order to
create a model profile. When you click the button, the Model Property dialog box is
displayed. Define the property using the two controls:
• Name
Drop-down list of already-defined properties. To enter a property not defined, choose
Type text and enter a property name.
• Value
The attribute that you enter for the property

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Model Name Model (file) name
Comments Text describing model
Table at bottom Type of data field

Property Name of property


Value Data that you enter for the property

SAP NetWeaver Visual Composer Reference Guide 55


November 2006

5.4.21 Navigation Point


Definition
A connector that defines navigation to a different iView, which is displayed in the window of
the source iView, causing the source iView to close. In this case, navigation is from the
source iView to the target iView only.

Use
Group: Connectors
Model level: iView
When you drag the connector onto the Design board, the Select Target iView dialog box is
displayed, showing a hierarchical tree with the iViews currently available in your model. Two
options (radio buttons) are available for choosing the target iView:
• Select existing iView
Select one of the iViews shown in the tree; its name is displayed in the Name field
• Create new iView
In the name field, you can overwrite the New iView text and create a new target iView
of any name

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Navigation Point Name Label for the connector
Target iView Name of iView to which the point
connects
Table at bottom Type of data in field

Input Fields Fields input from the connected


form to the target iView

SAP NetWeaver Visual Composer Reference Guide 56


November 2006

5.4.22 Nested iView


Definition
An iView displayed within another iView. The nested iView can be defined either as a
separate iView entirely (with Nested window as Window type), or by using the Nested iView
icon within the iView that will be the source window.

Use
Group: Components
Model level: iView
When you drag the Nested iView icon onto the Design board, the Select Nested iView dialog
box is displayed, showing a hierarchical tree with the iViews currently available in your model.
Two options (radio buttons) are available for choosing the target iView:
• Select existing iView
Select one of the iViews shown in the tree; its name is displayed in the Name field
• Create new iView
In the name field, you can overwrite the New iView text and create a new nested
iView of any name
...

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Nested iView Window title Name of the iView within the
source iView
Target iView The source window in which the
nested iView is displayed
Toolbar Show Adds a toolbar button area
Hide Hides the toolbar button area
Edit Displays the Create Toolbar
Buttons dialog box (see Create
Toolbar Buttons Dialog Box [Page
179])
Layout Fit contents Auto Automatically sizes the contents of
the view according to its size
defined on the Layout board
Frame style Default Standard portal view frame
Primary frame Top border in standard color
White Top border in white
Neutral color Top border in lighter color
Dark color Top border in darker color
Transparent No frame
Frame title bar Displays view title

SAP NetWeaver Visual Composer Reference Guide 57


November 2006

Group Property Attribute Description


Collapsible Contents of view can be
frame hidden/displayed
Visibility [none] No conditions are given for
condition displaying the form in runtime, so
that it will be automatically visible
true The form will be visible when this
value appears in the formula
defining when the form is
displayed, such as Hidden,
Required and so on
false The form will not be visible when
this value appears in the formula
defining when the form is
displayed, such as Hidden,
Required and so on
Enter formula Formula for indicating under what
conditions the view is displayed in
the iView

5.4.23 Output Port


Definition
The port that contains the result of the request coming from the input port of the data service.

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Output Port Port name Label for the port
Dynamic port When selected, indicates that the
metadata of the data service
channeled through the port is
unknown (all data will be displayed
at runtime)
Capacity The maximum number of records
stored in the dataset.
Table at bottom Type of data in field

Output Fields Fields output through the port

SAP NetWeaver Visual Composer Reference Guide 58


November 2006

5.4.24 Output Signal


Definition
A connector that sends parameters to another iView.

Use
Group: Connectors
Model level: iView
Deploy environment: All

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Output Signal Name Label for the connector
EPCM Event URN of the other portal iView
Table at bottom Type of data in field

Output Fields Fields output through the signal to


the other iView

5.4.25 Package
Definition
A “container“ for organizing model elements, such as pages and iViews, into a portal
package.

Use
Group: Components
Model level: Model (top level)
...

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Package Name Package (folder) name
Comments Text describing the package

SAP NetWeaver Visual Composer Reference Guide 59


November 2006

5.4.26 Page
Definition
A diagram for composing iViews on a portal page.

Use
Group: Components
Model level: Model (top level)
...

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Portal Page Name Page name
Comments Text describing the page

SAP NetWeaver Visual Composer Reference Guide 60


November 2006

5.4.27 Popup Signal


Definition
A connector that defines a popup iView. Popup iViews are displayed in a separate window,
receiving input from the source iView and sending output back to it.

Use
Group: Connectors
Model level: iView
When you drag the connector onto the Design board, the Select Popup iView dialog box is
displayed, showing a hierarchical tree with the iViews currently available in your model. Two
options (radio buttons) are available for choosing the target iView:
• Select existing iView
Select one of the iViews shown in the tree; its name is displayed in the Name field
• Create new iView
In the name field, you can overwrite the New iView text and create a new popup iView
of any name

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Popup Signal Name Label for the connector.
Target iView Name of iView to which the point
connects.
Modal window Indicates if the user can interact
with the popup window
independently of the source iView.
If the window is modal, the user
must close the popup window to
continue to work with the source
iView. If Modal window is not
checked, the user can continue
working in the source iView with the
popup window open.
Center window Indicates whether to center the
popup window in the middle of the
application screen when it is
opened.

SAP NetWeaver Visual Composer Reference Guide 61


November 2006

5.4.28 Sigma Operator


Definition
A general operator that aggregates the values of all the records into a single record, displayed
in a form view.

Use
Group: Operators
Model level: iView

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Sigma Operator Name Label for the operator
Type of data in field

Field Field whose data should be


aggregated according to the Sigma
attribute
Sigma COUNT Totals the number of field values
that are not blank
MIN Returns the lowest field value
MAX Returns the greatest field value
SUM Returns the sum of all field values
AVERAGE Returns the average (arithmetic
mean) of the field values
STDDEV Estimates standard deviation
based on the field values
[none]

SAP NetWeaver Visual Composer Reference Guide 62


November 2006

5.4.29 Sort Operator


Definition
A general operator that sorts data according to a specified field.

Use
Group: Operators
Model level: iView

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Sort Operator Name Label for the operator
Table at bottom # Sort priority
Type of data in field

Sort By: Field according to which the data


should be sorted
Direction up Ascending order numerically (also
A to Z)
down Descending order numerically (and
Z to A)

5.4.30 Start Point


Definition
A connector that defines the value that initializes the flow.

Use
Group: Connectors
Model level: iView

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Start Point Name Label for the connector
Table at bottom Type of data in field

Input Fields that are input from the


Parameters connector into the flow

SAP NetWeaver Visual Composer Reference Guide 63


November 2006

5.4.31 Subtraction Operator


Definition
An operator that creates a new dataset from two datasets by including data that is only in the
first dataset but not in the second dataset, as in the following illustration:

The dataset from which the subtraction is made (the "first" dataset) is that which is transferred
to the topmost input port of the operator.

Use
Group: Additional Operators
Model level: iView

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Subtraction Name Label for the operator
Operator
Table at bottom Type of data in field

Field Field that serves as the basis for


the subtraction operation
Key Checkbox for selecting the Field

SAP NetWeaver Visual Composer Reference Guide 64


November 2006

5.4.32 Table View


Definition
A tabular view of data, for display and/or edit. The table displays each object in the dataset in
a separate row and each object field in a separate column.

Use
Group: Components
Model level: iView
...

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Table view Table title Name of form
Editing mode Editable User can enter data into the form
and change displayed data
Read-only User can view displayed data only
Selection mode Single User can select one row only
Multiple User can select multiple rows
Unselectable Read-only – users cannot select
any rows
Toolbar Show Adds a toolbar button area
Hide Hides the toolbar button area
Edit Displays the Create Toolbar
Buttons dialog box (see Create
Toolbar Buttons Dialog Box [Page
179])
Scroll buttons Show Adds a scrolling button area
Hide Hides the scrolling button area
Edit Displays the Page Scrolling Buttons
dialog box
Row colors Standard Initial display is a plain grid
Alternating Rows are displayed in alternating
dark-white pattern
Transparent No background grid
No. of rows Number of rows to display per page
Keep selected When a row is selected in a table
row and the table is refreshed with new
data, the focus remains on the
selected row, rather than moving to
the first row of the table.

SAP NetWeaver Visual Composer Reference Guide 65


November 2006

Group Property Attribute Description


Layout Fit contents Auto Sizes the contents of the view
according to system default
settings
Actual size Sizes the contents of the view
according to its size defined on the
Layout board
Fit width Changes the contents of the view in
proportion to the form size
Frame style Default Standard portal view frame
Primary frame Top border in standard color
White Top border in white
Neutral color Top border in lighter color
Dark color Top border in darker color
Transparent No frame
Frame title bar Displays view title
Collapsible Contents of view can be
frame hidden/displayed
Visibility [none] No conditions are given for
condition displaying the form in runtime, so
that it will be automatically visible
true The form will be visible when this
value appears in the formula
defining when the form is
displayed, such as Hidden,
Required and so on
false The form will not be visible when
this value appears in the formula
defining when the form is
displayed, such as Hidden,
Required and so on
Enter formula Formula for indicating under what
conditions the view is displayed in
the iView
Table at bottom The field is visible in the table

Data type of the field

Column Name of the field (column header).


To add a field/column, click the Add
(plus) button.
Control Type of control (for full list of control
types, see Control Properties
Dialog Box [Page 82])

SAP NetWeaver Visual Composer Reference Guide 66


November 2006

5.4.32.1 Messages Table


Definition
A messages table displays messages related to SAP BI system queries in a table that you
can integrate into your Visual Composer model. The messages displayed provide information
relevant to the query, such as whether the query has been successfully saved or if there has
been a problem saving it.

Some messages will only appear the first time they are issued if, for instance,
they have to do with successfully generating a query, which is an activity that is
not repeated (until the query definition is changed again).

Use
You generate a message table by dragging from the Messages output port on an SAP BI
query, and choosing Add Form View from the context menu.

Structure
In a message table, each message is displayed in a row in a table which has the following
three columns by default:
Type Number Text
The key to the message type. The message ID number The text of the message
Possible types include:
• E – Error
• W – Warning
• I – Information
• S – Success
• A – Abend

Example
See Using Messages [External] in the SAP NetWeaver Visual Composer Modeler's Guide.

SAP NetWeaver Visual Composer Reference Guide 67


November 2006

5.4.33 Timer
Definition
A connector that defines the timing of an event. The timer may trigger any number of
execution flows in the component. Multiple timers, with different intervals, can be used in the
same component.

Use
Group: Connectors
Model level: iView

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Timer Name Label for the connector.
Interval Indicates the frequency, in minutes,
that the timer is evaluated.
Initial delay Delays the start of the timer count
according to the amount of time
intervals specified.
Guard condition Enables or disables the component
session according to the formula
entered. While the timer is disabled
the clock still keeps ticking, but no
timer events are generated.
Table at bottom Type of data in field.

Field The fields that hold the timer data.

SAP NetWeaver Visual Composer Reference Guide 68


November 2006

5.4.34 Transition
Definition
A connecting line between two layers of a wizard or with standard layers, indicating the event
that must be invoked in order to trigger the transition from one layer to the other.

Use
This connection line is defined directly on the Design board.
Model level: iView

Structure
The following table describes the properties and attributes of this model element.
Group Property Attribute Description
Transition Event name
Guard condition Enables or disables the transition
to the next layer according to the
formula entered.
Line style Straight Direct 45-degree line with no
corners
Angular Direct line
Curved
With right angles Line with 90-degree angles
(orthogonal)
[default] Orthogonal lines

SAP NetWeaver Visual Composer Reference Guide 69


November 2006

5.4.35 Union Operator


Definition
An operator that merges into a dataset the data of two datasets and removes duplicates, as in
the following illustration:

Use
Group: Additional Operators
Model level: iView

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Union Operator Name Label for the operator
Table at bottom Type of data in field

Field Field whose values are unified


Key Checkbox for selecting the Field

5.4.36 Upper-Range Operator


Definition
A general operator that the retains only the specified top number of records.

Use
Group: Operators
Model level: iView

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Upper-Range Name Label for the operator
Operator
Field Field whose values define the
range
No. of rows The number of records in the range

SAP NetWeaver Visual Composer Reference Guide 70


November 2006

5.4.37 User Data


Definition
A connector that contains the personal data of the user. The User Data fields can be
referenced from any dynamic expression, thereby personalizing the component by creating
dynamic attributes that depend on the current user data and preferences.

Use
Group: Connectors
Model level: iView

Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
User Data Name Label for the connector.
Table at bottom Type of data in field.

User Parameters The fields in the User Data dataset.


Additional fields can be added
using the Add (plus) button.

SAP NetWeaver Visual Composer Reference Guide 71


November 2006

5.5 Inspect Formulas Task Panel


Definition
The Inspect Formulas task panel is used to view and edit formulas that have been defined in
the fields of the different model components.

Use
You access the task panel by drilling down into the iView and clicking the Inspect button in the
task-panel toolbar. According to the selections in the drop-down lists, formulas used
throughout the model or in the selected element are displayed.

Structure
The Inspect Formulas task panel includes the following controls:
Control Menu Option Description
Display All formulas Formulas of any type defined for
any element of the model
Computations All formulas and computations
defined in the General tab of the
Control Properties dialog box
Display state Formulas created to define Hidden,
Disabled, Required and Visibility
conditions (in the UI Control part of
the General tab of the Control
Properties dialog box or in the
Configure task panel)
Execution flow Formulas – such as Guard
conditions – defined for activating
events
Formatting Formulas defined in the Formatting
tab of the Control Properties dialog
box
Appearance Formulas defined in the Display tab
of the Control Properties dialog box
Validation Formulas defined in the Validation
tab of the Control Properties dialog
box
Scope Current Element Displays the name of each element
that contains a formula
Entire diagram Displays the elements along with
each formula that they contain
Refresh Refreshes the display of formulas

SAP NetWeaver Visual Composer Reference Guide 72


November 2006

5.6 Find Data Services Task Panel


Definition
The Find Data Services task panel is used to locate and add data services – queries, BAPIs,
web services, stored procedures and others – to your model.

Use
You access the task panel by drilling down into the iView and clicking the Find Data button in
the task-panel toolbar. You then select the system alias of the back-end system in which the
data service resides, search for the data service and drag it onto the workspace.
When a data service includes a very large number of ports and fields, you may be prompted
to define the exact ports and fields that you want to include. For more information, see Define
Data Service Dialog Box [Page 77].
For more information about the process of adding data services to your model, see Find Data
[External] in the SAP NetWeaver Visual Composer Modeler's Guide.

Structure
The fields and controls of the task panel change dynamically according to the type of system
that you choose, such as BI system or SAP system. The following controls and fields are
available:
System Type Control/Field Menu Option Description
System list Portal alias of the back-end
system containing the data
service.
SAP BI System Look for list Look for a query Enables you to search for a
specific query by entering its
name in the Query field.
Look for a view Enables you to search for a
specific query view by entering
its name in the Query field.
Browse infoarea Enables you to browse the
tree InfoArea tree, viewing a selected
system’s InfoCubes, queries,
query views, and InfoObjects in
a tree.
Display query Displays the list of recently
history accessed queries for the current
BI system user. Note that
depending on how users are
mapped in the system, this could
differ from the current portal
user.
Display view history Displays the list of recently
accessed query views for the
current BI system user. Note that
depending on how users are
mapped in the system, this could
differ from the current portal
user.

SAP NetWeaver Visual Composer Reference Guide 73


November 2006

System Type Control/Field Menu Option Description


Display favorites Displays the list of favorites for
the current BI system user. Note
that depending on how users are
mapped in the system, this could
differ from the current portal
user. See also Favorites Folders
[Page 78].
Display roles Enables you to browse queries
based on roles saved in the BI
system.
Query field Displayed with Look for a query
and Look for a view. Either enter
the query/query view or a mask,
or select from a drop-down list of
recent searches.
Search button Used to locate the query or
query view entered in the Query
field.
Reload button Refreshes the display of search
results.
Clear button Clears the display of search
results.
Details button Displays information about the
selected data service.
SAP System Look for list Look for a service Enables you to search for a
by name specific data service by entering
its name in the Service field.
Look for a service Enables you to search for a data
by group service by locating the function
group to which it belongs.
Browse services Displays the hierarchy of data
catalog services available in the selected
back-end system.
Service field Displayed with Look for a service
by name. Either enter the name
of the data service or a mask, or
select from a drop-down list of
recent searches.
Group field Displayed with Look for a service
by group. Either enter the name
of the group or a mask, or select
from a drop-down list of recent
searches.
Search button Used to locate the data service
or group entered in the Service
or Group field, accordingly.

SAP NetWeaver Visual Composer Reference Guide 74


November 2006

System Type Control/Field Menu Option Description


Details button Displays information about the
selected data service.
Clear button Clears the display of search
results.
Web Service Group field Displayed with repository-based
System web services. Either enter the
name of the group that holds the
required operations, or select
from a drop-down list of recent
searches.
Operation list Displayed with third party-based
web services. Either enter the
name of the operation, or select
from a drop-down list of recent
searches.
Search button Used to locate the operation or
group entered in the Group or
Operation field, accordingly.
Details button Displays information about the
selected data service.
Clear button Clears the display of search
results.
OLAP System Look for list Look for a cube Enables you to search for a
specific query by entering its
name in the Cube field.
Browse cubes Enables you to browse the
catalog catalog of cubes.
Cube field Displayed with Look for a cube.
Either enter the name of the
cube or a mask, or select from a
drop-down list of recent
searches.
Search button Used to locate the cube entered
in the Cube field.
Reload button Refreshes the display of search
results.
Clear button Clears the display of search
results.
Details button Displays information about the
selected data service.
Relational Look for list Look for a table Enables you to search for a
System specific table by entering its
name in the Table field.
Browse tables Enables you to browse the
catalog catalog of tables.

SAP NetWeaver Visual Composer Reference Guide 75


November 2006

System Type Control/Field Menu Option Description


Table field Displayed with Look for a table.
Either enter the name of the
table or a mask, or select from a
drop-down list of recent
searches.
Search button Used to locate the table entered
in the Table field.
Reload button Refreshes the display of search
results.
Clear button Clears the display of search
results.
Details button Displays information about the
selected data service.
Non-SAP Function button Enables you to select from a list
System of functions.
Search button Used to locate the function
entered in the Function field.
Details button Displays information about the
selected data service.
Clear button Clears the display of search
results.

You can test the functionality of the data service by choosing Test Data Service from its
context menu. For more information, see Test Data Service Dialog Box [Page 79].

SAP NetWeaver Visual Composer Reference Guide 76


November 2006

5.6.1 Define Data Service Dialog Box


Definition
This dialog box may be displayed when you drag a data service onto your workspace. If the
data service includes a large number of fields or ports, you can use the dialog box to limit the
selection to the specific ports and fields to include in your model.
If the dialog box is not displayed automatically when you drag to the workspace, you can
display it by right-clicking the data service and choosing Define Data Service from the context
menu.

This option is activated/deactivated from the Options dialog box:


...

i. Choose Tools → Options.


ii. Click the Editing tab.
iii. In the top section (Ask for user intervention when creating:), choose Data
services with more than and indicate the base number of fields that will
cause this dialog box to be displayed automatically.

Structure
The dialog box is divided as follows:
• In the left pane, the Input Ports group contains the names of all ports at the input to
the data service. When you select the checkbox next to a port, all of its fields are
displayed in the right pane.
• Like the Input Ports group, the Output Ports group contains all of the ports at the
output from the data service. When you select the checkbox next to a port, all of its
fields are displayed in the right pane.
• The Select all checkbox at the top right enables you to check all of the fields displayed
in the right pane.
• The Clear all checkbox removes the checks from all the fields in the right pane except
those that are mandatory (displayed in red with an asterisk). If there are no mandatory
fields in the port, the check is also removed from the port name in the left pane.

SAP NetWeaver Visual Composer Reference Guide 77


November 2006

5.6.2 Favorites Folders


Definition
Favorites provide an easy way to store and access frequently used SAP BI system queries.
You can store Favorites at the root of a system node, or in folders. Use the Favorites folders
dialog boxes to add Favorites, and to create and work with Favorites folders. These dialog
boxes are displayed when you select a BI query in the Find Data Services task panel, and
from the context menu, choose Add to Favorites.

Favorites are stored in lists by the current BI system user. Note that depending
on how users are mapped in the system, the current BI system user could differ
from the current portal user.

Use
Use the Select Favorites Folder dialog box to browse for, select, and add a Favorite or to
remove a folder. Use the Create Folder dialog box to specify a name for a new folder.

Structure
The main fields and controls of the dialog boxes are listed in the following tables:

Select Favorites Folder Dialog Box

Field/Control Description
Select the folder to which to add the query System tree in which to navigate to a location
in which to add a selected query as a
Favorite. You can store Favorites at the root
of the system node or in a folder.
Create New Folder Displays the Create Folder dialog box with
which you can name a new folder in which to
store Favorites. You can also nest folders
into existing folders.
Remove Folder Removes a selected folder.
Add Stores the Favorite in the selected location
and dismisses the dialog box.

Create Folder Dialog Box

Field/Control Description
New Folder Name Field in which to enter a name for the new
folder.
Create Creates the folder.

Integration
You can perform other Favorites activities on the Find Data Services task panel.
To browse for and select a Favorite:
...

1. On the Find Data Services Task Panel [Page 73], select an SAP BI data service.
2. In the Look for drop-down list, select Display favorites.

SAP NetWeaver Visual Composer Reference Guide 78


November 2006

3. Navigate to, select, and work with an InfoObject in the favorites and query structure as
desired.
While browsing Favorites, you can also remove a query from Favorites:
4. Select a query, and from the context menu, select Remove from Favorites.
...

Example
See Working with Favorites [External] in the SAP NetWeaver Visual Composer Modeler's
Guide.

5.6.3 Test Data Service Dialog Box


Definition
This dialog box enables you to test the functionality of the selected data service.

Use
You display the dialog box by right-clicking the data service and choosing Test Data Service
from its context menu. The Test Data Service dialog box is displayed, showing all of the fields
that it processes.

Structure
The left pane displays the fields of information for input and the right pane displays the results
that are received. Values must be entered into the mandatory fields (displayed in red with an
asterisk). Click Execute to display the results of the query, Clear to remove the results from
the right pane, and Close to close the dialog box.

SAP NetWeaver Visual Composer Reference Guide 79


November 2006

5.6.4 Define / Test Query Dialog Box


Definition
This dialog box enables you to test and update the query or query view definition of an SAP
BI query data service. You can use this dialog box to enter values for variables or filters,
execute the query, and select required output fields that you need in the BI query data
service.

Use
You display the dialog box by right-clicking the BI query data service and choosing Define /
Test Query from its context menu. The Define / Test Query dialog box is displayed, showing
all of the fields that it processes.

Structure
The dialog box is divided as follows:
• In the Specify filter section:
{ The Input group contains the names of all input fields on the Input port of the
data service. You may enter input values in the fields to test the query with
these filter values.
{ The Variables group contains the names of all variables on the Variables port of
the data service, if any. You may enter variable values in these fields to test the
query with these values.
• In the Select fields for output port section:
The Select fields for output ports list contains all of the fields at the output from the
data service. When you select the checkbox next to a field, it will be included in
the query results.
The Select all checkbox at the top right enables you to check all of the fields
displayed in the right pane.
The Clear all checkbox removes the checks from all the fields in the right pane.
In the Review output section, the results of the values you have currently selected are
displayed in a table after you click the Execute button.
Click Execute to execute the query with the values provided above and display the results
in a table in the Review output section.
Click Generate to update the query or query view definition, adding the checked fields to
the data service’s Output port and removing the unchecked fields.
Click Close to close the dialog box.

Be aware that you actually update the BI query or query view definition with this
dialog box.

SAP NetWeaver Visual Composer Reference Guide 80


November 2006

5.7 Deploy to Portal Task Panel


Definition
The Deploy to Portal task panel is used to compile and deploy the model currently open in
Storyboard.

Use
The models that you build in Visual Composer are generated in Generic Modeling Language
(GML) code. To deploy your application to a portal, the GML code must be compiled into a
language supported by the portal. During compilation, warnings and possible errors may be
discovered, enabling you to check the model validity. The compiled content is deployed
directly to the portal, in the runtime environment that you select.
You access the task panel by displaying the iView in the Design board, at the level you want
to deploy, and clicking the Deploy button in the task-panel toolbar.
For more information, see Deploy the Model [External] in the SAP NetWeaver Visual
Composer Modeler's Guide.

Structure
The following controls and fields are used in the task panel:
Control/Field Description
iView read-only field Displays the name of the iView being deployed.
Deploy entire model If selected, deploys the entire model (regardless of the level
displayed on the Design board), otherwise deploys only the
part of the model currently displayed.
Deploy button Activates the compilation and deployment process.
Successful deployment is indicated by a Deployed
Successfully message. If errors or problems occur, the
appropriate messages or warnings are displayed along with
the source code. To view the deployed file, click on the Run
“<iView Name>“ line.
Compile button Compiles the model code. Successful compilation is
indicated by a Compiled Successfully message. If
errors or problems occur, the appropriate messages or
warnings are displayed along with the source code. To
display the code, click the View source code line.
Clear button Clears the displayed compilation or deployment messages.

Integration
The contents of the model are packaged into standard PAR files, one file per iView.

SAP NetWeaver Visual Composer Reference Guide 81


November 2006

6 Control Properties Dialog Box


Definition
The Control Properties dialog box is used to define all the properties of the fields and controls
contained in each UI component of the iView.

Use
For each control or field, you define a range of control-specific properties, grouped together
by function, such as Display, Formatting or Validation.
To display the controls and fields, it is recommended to use the Layout board, where you can
see a visualization of each control and field, and the overall layout within the component.
Using the Configure Element task panel, you select the control and open the Control
Properties dialog box by:
• Right-clicking the control or field on the Layout board and choosing Properties from the
context menu
• Double-clicking the row of the control or field displayed in the table at the bottom of the
Configure Element task panel
• Choosing Properties from the pull-down list in the Control column of the table at the
bottom of the Configure Element task panel
To create a new control, click the Add (plus) button at the bottom of the Configure Element
task panel.
To delete an existing control:
• Select it on the Layout board and press Del on your keyboard
• Double-click the row of the control or field in the Configure Element table and click the
Delete (minus) button
You can leave the Control Properties dialog box open as you configure different controls and
fields; it is not necessary to close it as you move from control to control.

Structure
The following controls and fields can be defined using the Control Properties dialog box:
Bulleted list Drop-down list Input field Radio button group
Calendar Expression box List box Spinner
Checkbox Gauge Numbered list Text editor
Clock Horizontal slider Plain text Ticker
Combo Box HTML text Progress bar Toggle button
Date picker Image Pushbutton Vertical slider (

For a description of all of these items, see Available Controls and Fields [Page 84].
The Control Properties dialog box contains a set of different tabs of properties, displayed
according to the control or field being configured. The following topics describe the properties
in each tab:
• Control Properties - General Tab [Page 87]
• Control Properties - Display Tab [Page 89]

SAP NetWeaver Visual Composer Reference Guide 82


November 2006

• Control Properties - Range Tab [Page 92]


• Control Properties - Styles Tab [Page 93]
• Control Properties - Formatting Tab [Page 94]
• Control Properties - Entry List Tab [Page 96]
• Control Properties - Validation Tab [Page 100]
• Control Properties - Image Tab [Page 101]
• Control Properties - Action Tab [Page 102]
• Control Properties - HTML Tab [Page 106]
Each of these sections describes the different properties defined within the tab for each type
of control or field. A table lists each property, giving its possible attributes, the control/field for
which it is relevant and a description of the property.

SAP NetWeaver Visual Composer Reference Guide 83


November 2006

6.1 Available Controls and Fields


Definition
This section lists all the controls and fields that can be defined within a UI component.

Use
Controls and fields are defined either automatically when a component, such as a form, is
created, or they are added using the Configure Element Task Panel [Page 25]. To configure
the properties of the control, use the Control Properties dialog box, as described in the topics
of this section.

Structure
The following table describes the available controls and properties:
Control/Field Example Description
Bulleted list A selection control that displays a
menu of options presented in a
bulleted list.
Calendar A date selection control that allows
the user to select a date or a range of
dates using a navigable monthly
calendar.

Checkbox A dual-state selection control used


for setting or clearing Boolean
(yes/no) fields.
Clock A read-only control for displaying
time values in an analog or digital
clock. It can be used either for
displaying the value of a time field, or
the continuously running time of the
system clock.

Combo box A combination of a drop-down list


and an input field, enabling the user
to choose an option from a drop-
down list or else enter values not
available in the list.
Date picker A date selection control that allows
the user to select a date using a
drop-down calendar.

Drop-down list A list showing the possible values


that a user can select and also the
currently-selected value.
Expression box A read-only control for displaying a
calculated value in a single-line
textbox.

SAP NetWeaver Visual Composer Reference Guide 84


November 2006

Control/Field Example Description


Gauge A read-only control for displaying
numeric values on a radial scale. The
current value of the gauge is
determined by the angle of the
gauge’s needle relative to the total
angular extent of the gauge
Horizontal slider A numeric selection control that lets
(HSlider) the user select a value by moving a
slider thumb right and left between
the end points of a horizontal slider
track.
HTML text A read-only control used for
displaying an HTML-formatted
fragment.
Image A control used for displaying an
embedded image. It is used in
conjunction with the Image Library.

Input field A single-line input control supporting


all data types.
List box A selection control consisting of a list
that presents the possible values that
a user can select. Exactly one item in
the list can be selected at any time.
Numbered list A selection control used for creating
ordered menus of numbered options.

Plain text A control used for displaying a text


message with uniform formatting. If
the control is associated with an
action, it is displayed as a hyperlink.
Progress bar A read-only control for displaying
numeric values using a gradually
filled bar. The current value is
determined by the size of the filled
portion of the bar, relative to the total
size of the bar.
Pushbutton A control used to invoke actions
when it is clicked with the mouse or
activated using the keyboard.
Radio group A selection control consisting of a
group of radio buttons, one for each
of the possible values that a user can
select. Only one radio button in the
group can be selected at any time.
Spinner A numeric range control with
up/down buttons for stepping through
the values in the range.

SAP NetWeaver Visual Composer Reference Guide 85


November 2006

Control/Field Example Description


Text edit A multi-line text editing control with
support for line breaks, word
wrapping and scrolling.
Ticker An animated read-only control for
displaying values on a continuously-
moving display ribbon.
Toggle button A dual-state selection control used
for setting or clearing Boolean fields.
Toggle buttons are usually
associated with actions that are
triggered when the toggle state is
changed.
Value Help A button next to an input field that
displays a dialog box with a list of
valid values for the field. This helps
an end-user select the right, properly
formatted value to enter into the field.
You configure the list of values with
the Value Help Configuration Wizard
[Page 107].

Vertical slider A numeric selection control that lets


(VSlider) the user select a value by moving a
slider thumb up and down between
the end points of a vertical slider
track.

SAP NetWeaver Visual Composer Reference Guide 86


November 2006

6.2 Control Properties - General Tab


Definition
This tab is used with all controls and fields in order to define the runtime visibility parameters
(such as hidden or disabled) and default values.

Use
You can use the Control type drop-down list to change the control that has been selected.
The fields and controls of the tab may then change accordingly. In all fields, you can enter a
dynamic expression that defines the exact visibility condition or the default value. To do so,
click the Condition or Formula button to the right of the appropriate field.

Structure
The following table describes the properties configured in this tab:
Section Property Attribute Control Description
UI Control Control type All controls Drop-down list showing all
other controls of the same
Data type
Hidden All controls The control should be
hidden or displayed,
according to the condition
outlined in the expression

Note that this parameter can


operate only on full columns,
rather than on single cells.
The value can be specified
as either the Boolean
true/false or else activated
by a control external to the
table (rather than according
to a value in another field of
the same table).
Disabled Bulleted list, The control is displayed but
Calendar, not enabled
Checkbox,
Combo box,
Date picker,
Drop-down
list, HSlider,
HTML text,
Image, Input
field, List box,
Numbered
list, Plain text,
Pushbutton,
Radio group,
Spinner,Text
editor, Toggle
button,VSlider

SAP NetWeaver Visual Composer Reference Guide 87


November 2006

Section Property Attribute Control Description


Required Bulleted list, The control or field –
Calendar, displayed in red and with an
Combo box, asterisk –requires client-side
Date picker, validation: It must be filled in
Drop-down or selected
list, HSlider,
Input field,
List box,
Numbered
list, Radio
group, Text
editor, VSlider
Inherit The field inherits attributes
from another field in the
displayed iView.
Attributes that can be
inherited include: label,
tooltip, field length, data
type, static entry list.
Data Source Field name All controls Read-only
Data type All controls Read-only
Default value Bulleted list, A value or an expression
Calendar, describing the value
Checkbox, automatically given for the
Combo box, control
Date picker,
Drop-down
list, HSlider,
Input field,
List box,
Numbered
list, Radio
group, Text
editor, Toggle
button,
VSlider
Expression Clock, Used in controls that contain
Expression a computed value
box, Gauge,
Progress bar,
Gauge

SAP NetWeaver Visual Composer Reference Guide 88


November 2006

6.3 Control Properties - Display Tab


Definition
This tab is used with all controls other than Text Editor, to define the label text and format of
the control, and to determine exactly where in the component the control is displayed.

Use
Use the Appearance section to configure the exact “look” of the control and its label.
Use the Layout section to configure where the control is placed, its size and its tabbing order,
if needed.

Structure
The following table describes the properties configured in this tab:
Section Property Attribute Control Description
Appearance Display label All controls The name displayed on the
except Text control, written in quotation
editor marks (“ “). You can use the
Formula button to enter an
expression that indicates
the label to use, and when
Tooltip All controls Displays a quick description
except Text of the control when the user
editor runs the mouse over it
Text style Normal Bulleted list, Default text style
Plain text
Bold
Small
Header 1 First header style
Header 2 Second header style
Header 3 Third header style
Monospace Box-like font
Border style Default Bulleted list, Default border style of the
Calendar, control
Clock,
Solid Combo box, Border is a solid line
Inset Date picker, “Engraved“ 3D border
Drop-down
Outset list, “Embossed“ 3D border

SAP NetWeaver Visual Composer Reference Guide 89


November 2006

Section Property Attribute Control Description


None Expression No border
box, HTML
text, Image,
Input field,
List box,
Numbered
list, Plain
text,
Progress bar,
Pushbutton,
Spinner,
Ticker
Label Label before Calendar,
position Checkbox,
Label above Combo box,
Long label Data picker,
Drop-down
Short label list,
No label Expression
box, Gauge,
HTML text,
Image, Input
field, List box,
Numbered
list, Progress
bar, Radio
group,
Spinner
Clock options Running Clock Indicates that the time
clock should be taken (and
continuously updated) from
the running system clock.
Otherwise, the time value is
taken from the bound data
field
Second hand Shows the second hand for
analog-clock displays
Digital time Shows the clock in digital
display format
Time zone Negative Adjusts the time display
number, 0 or according to the specified
positive time zone, according to the
number number of hours before or
after GMT
Scrolling Ticker The rate at which the values
speed are moved along the ticker
strip
Button Without notch Pushbutton Displays button without the
options bar to the left

SAP NetWeaver Visual Composer Reference Guide 90


November 2006

Section Property Attribute Control Description


With notch Adds the standard bar to left
of button
Toggle Label only Toggle button Displays the label text
without the button border
Notch and Displays a ► notch with the
Label label
Button only Displays the label within a
button border
Layout Position All controls Offset from top left, in pixels
except Text
Dimensions editor Size of control, HxW, in
pixels
Layer If control is stacked with
other controls, its number
from the top of the stack
Tab order When user tabs through the
controls of the component in
runtime, the number
indicating what place this
control has in the tab order.
Note that -1 removes the
control from the tab order
entirely and 0 indicates that
it is highlighted according to
its appearance in the
component
Max. length Input field, Maximum number of
HSlider, characters allowed in the
Spinner, field or control
VSlider
No. columns Checkbox, Number of columns in which
Radio group to group the items of the
control
Wrap text No Plain text Truncates text according to
width of the field
Yes Automatically wraps text to
match the width of the field

SAP NetWeaver Visual Composer Reference Guide 91


November 2006

6.4 Control Properties - Range Tab


Definition
This tab is used to define the range of value for a number of controls: gauge, horizontal and
vertical slider, progress bar and spinner.

Use
Using the Minimum and Maximum lists, you define the value range, along with an optional
Step size value (precision). Sliders and gauges must be bound on both sides (specifying both
Minimum and Maximum), while spinners can be bound on one or both sides (specifying either
Minimum or Maximum or both), or unbound (specifying neither Minimum or Maximum), as
described in the table that follows.
You can also choose to add tick marks to the range control.

Structure
The following table describes the properties configured in this tab:
Section Property Attribute Control Description
Value range Minimum Gauge, Lowest numerical value in
HSlider, the range. You can use the
Progress bar, Label checkbox and field to
Spinner, define a label for the low end
VSlider of the range.
Maximum Highest numerical value in
the range. You can use the
Label checkbox and field to
define a label for the high
end of the range.
Step size Gauge, A value for dividing up the
HSlider, range.
Spinner,
VSlider
Ticks Gauge, Tick marks displayed on the
HSlider, control.
VSlider
Enable HSlider, As you drag the slider, the
dragging VSlider chart is continuously
updated.
Show Progress bar Displays, in percentage, the
percentage amount of the bar already
filled in (the percent of the
task completed).

SAP NetWeaver Visual Composer Reference Guide 92


November 2006

6.5 Control Properties - Styles Tab


Definition
This tab is used to define the styles used for the text of the control, and the conditions under
which the styles are to be applied.

Use
Use the Style tab to create a table of different text styles, each with an expression defining the
condition under which that style is used.
Use the buttons to the right of the table as follows:

• Add a style

• Delete the selected style

• Move the selected style up one place in the table

• Move the selected style down one place in the table


For an example of how to define a set of styles using the Styles tab, see Using Exceptions in
Your Model [External] in the SAP NetWeaver Visual Composer Modeler's Guide.

Structure
The following table describes the properties configured in this tab:
Section Property Attribute Control Description
Style Style column Expression The number or name of the
Selectors head box, style
Progress bar,
Condition Ticker The expression defining
column head when the style should be
applied
Text font A drop-down list of available
font names
Foreground A palette of colors from
which to select the font color
Background A palette of colors from
which to select the color
filling the text box
Bold Boldface font
Italic Italic font
Underline Text is underlined
Left Text is left-aligned
Center Text is centered
Right Text is right-aligned

SAP NetWeaver Visual Composer Reference Guide 93


November 2006

6.6 Control Properties - Formatting Tab


Definition
This tab is used to define the format of the number, text, time or date in the field.

Use
The properties configured in this field are displayed according to the data type of the control:
• Text
• Number
• Date
• Time
Certain controls, such as an input field or an expression box, can contain data of any of the
four types listed. Others, such as a horizontal slider or a progress bar, must be of a single
data type.

Structure
The following table describes the properties configured in this tab:
Section Property Attribute Control Description
Text Format None Expression Uses default text format
box, Input
Zero fill field, Ticker Fills a string of a given
length with zeroes
Password Indicates whether text
characters entered into the
control should be displayed
as asterisks
Trim spaces Removes extra spaces
between words or at the
beginning of the text
Lower case Uses only lower-case
characters for the text
Upper case Uses only upper-case
characters for the text
Proper case Capitalizes the first letter of
the main words
Custom Activates the Expression
field to define specific text
formatting
Expression Read-only field displaying
the defined format; activated
when Custom is selected
Number Numeric Expression Standard numbering
Format box, HSlider,
Local format Input field, Uses the portal runtime
locale formatting

SAP NetWeaver Visual Composer Reference Guide 94


November 2006

Section Property Attribute Control Description


Percentage Progress bar, Displays numbers as a
Spinner, percentage of 100
Ticker,
Currency VSlider Adds a symbol of the
currency, selected from
Currency symbol drop-down
list
Custom Activates the Expression
field to define specific text
formatting
Expression Read-only field displaying
the defined format; activated
when Custom is selected
Decimal Auto Automatically adds decimal
places places according to the
values received
1 to 7 Indicates the number of
decimal places to display
Thousands None No separator is used
separator between the thousands and
hundreds numbers
Comma A comma is used to set off
the thousands
Currency Currency icon, such as for
symbol dollar or Euro
Date Format Local format Date picker, Uses the portal runtime
Expression locale formatting
box, Input
[date formats] field, Ticker A range of different formats
for displaying the date
Custom Activates the Expression
field to define specific text
formatting
Expression Read-only field displaying
the defined format; activated
when Custom is selected
Time Format Local format Expression Uses the portal runtime
box, Input locale formatting
field, Ticker
[time formats] A range of different formats
for displaying the time
Custom Activates the Expression
field to define specific text
formatting
Expression Read-only field displaying
the defined format; activated
when Custom is selected

SAP NetWeaver Visual Composer Reference Guide 95


November 2006

6.7 Control Properties - Entry List Tab


Definition
This tab is used to create or select static or dynamic lists of options, for use in bulleted and
numbered lists, drop-down lists, and groups of radio buttons.

Use
The list controls can have one of two types of entry lists:
• Static lists have set values that you define.
• Dynamic lists are populated at runtime according to the input fields selected and the
corresponding values assigned.
You can use this list in conjunction with the Entry List Manager, for selecting global lists that
have been defined for use throughout the model. For more information, see How to . . .
Create an Entry List [External] in the SAP NetWeaver Visual Composer Modeler's Guide.

Structure
When the Entry List tab is first displayed, the List scope set of radio buttons provides these
options:
• Static
• Dynamic
• Global
The display of the properties in the tab changes according to these selections, described in
the following three tables:

Static Entry List

Control Description
Value column header The value of the option displayed in the list
Display Text column header The text to display for the option
Add a new entry

Delete the selected entry

Move the selected entry one place up in the


list
Move the selected entry one place down in
the list

Example

SAP NetWeaver Visual Composer Reference Guide 96


November 2006

Dynamic Entry List

Section/Field Control Description


Data service Used to display the Find Data Service
Dialog Box [Page 99], for selecting the
data service and its input and output
ports, for the entry list.
Input port Input Field column header Displays the fields channeled through
the input port that you selected in the
Find Data Service dialog box.
Assigned Value column header The values that you require in order to
get the output values that you want in
your list, defined by:
• Entering a fixed value
• Entering a formula (choose Enter
formula from the drop-down list)
• Using the Expression Editor,
entering a different field in the
form, from which to take the value
Output port Output Field column header Displays the VALUE and the TEXT rows
to define the two fields that correspond
to the actual value returned and the text
to be displayed in the list (see example
following)
Assigned Value column header The VALUE is the field from which the
value should be taken and the TEXT is
the field from which the actual displayed
text should be taken (see example
following).
Sort checkbox Lists the options alphabetically in the
list.
Allow duplicates checkbox Enters identical text options more than
once, according to the results returned.
Additional entries checkbox Expands the dialog box to allow you to
add static text options to the list.
Additional Value column header Adds static entries to the list, defined by
entries clicking and defining a static entry
Display Text column header
list as described in the previous table.
Click to return to the Dynamic List
screen.

SAP NetWeaver Visual Composer Reference Guide 97


November 2006

Example

Global Entry List

This option displays a pane listing all static and dynamic entry lists that have been defined in
the Entry List Manager as “global“, for use throughout the model. To edit a displayed global
entry list, select it and click at the right.

SAP NetWeaver Visual Composer Reference Guide 98


November 2006

6.7.1 Find Data Service Dialog Box


Definition
This dialog box is used when creating a local or global entry list, in order to define the data
service – and its input and output ports – from which the values for the list are taken.

Use
When defining a dynamic entry list for global use, using the Entry List Manager, this dialog
box is displayed automatically (see Entry List Manager [Page 115]). When defining a dynamic
entry list for local use within a form, you need to display it by clicking at the right of the
Data service field (see Control Properties - Entry List Tab [Page 96]).

Structure
The following table describes the controls and fields in the dialog box:
Control/Field Description
System The portal system in which the data service resides
Look for A combo box from which you can select from a list of data services
contained in that data service and used in the model, or enter a mask for
searching for a data service
Search Activates a search for the data service
Select data service Displays all data services matching the text in the Look for field and
residing on the selected System
Input port Drop-down list of input ports on the selected data service, enabling you
to select the port that channels the values you need for your list
Output port Drop-down list of output ports on the selected data service, enabling you
to select the port that returns the values you define for your list

SAP NetWeaver Visual Composer Reference Guide 99


November 2006

6.8 Control Properties - Validation Tab


Definition
This tab is used to define a set of rules used to check the validity of the values of the control
and to respond in case of an invalid value. If the user enters a value that is defined here as
invalid, the error message defined for that condition and value is displayed.

Use
Use the table of this tab to define a set of conditions corresponding to the appearance of a
value and create an error message. Note that the order of the conditions can be important.
Use the buttons at the right of the table as follows:

• Add a condition

• Delete the selected condition

• Move the selected condition up one place in the table

• Move the selected condition down one place in the table

Structure
The following table describes the properties configured in this tab:
Section Property Attribute Control Description
Validation Condition Calendar, Drop-down list of standard
Rules column head Checkbox, conditions for starting the
Combo box, condition clause, such as: Is
Data picker, equal, Is blank, Contains
Drop-down and Ends with
list, HSlider,
Value column Type text Input field, Enter a specific value, such
head List box, as ’Chicago’ (note the
Radio group, single quotation marks) or
Spinner, 10
Enter formula Toggle Enter a formula using the
button, Expression Editor
VSlider
[fields in The controls and fields
component] defined within the
component
Error Text of the message that
Message should appear if the error
column head condition occurs

SAP NetWeaver Visual Composer Reference Guide 100


November 2006

6.9 Control Properties - Image Tab


Definition
This tab is used to select an image to be displayed in an image control.

Use
In order to select an image, you must first have defined an image library for the model. To do
so, see Define an Image Control [External] in the SAP NetWeaver Visual Composer
Modeler's Guide (for the procedure) or Image Manager [Page 119] in this guide.
Once defined, the images in the image library are displayed in the pane of this tab. Use the
checkbox beneath each image to select the image to be added.

Structure
The following table describes the properties configured in this tab:
Control/Field Description
Image The condition under which the selected image should be displayed in
the image control. Click Condition to define an image, or accept true
(default) to display the image at all times.
Original size The image is displayed in its original size. Its edges are cut off if the
control size is smaller than the image dimensions.
Fit size The image is sized to fill the control.

SAP NetWeaver Visual Composer Reference Guide 101


November 2006

6.10 Control Properties - Action Tab


Definition
This tab is used to define the action, or event, triggered when the control is selected. It is
used to define actions for the following types of controls:
Bulleted list Date picker Input field Pushbutton
Calendar Drop-down list List box Spinner
Checkbox HSlider Numbered list Toggle button
Combo box Image Plain text VSlider

Use
You can use this tab to define one of two types of actions:
• A System action is a predefined event, such as closing a window or inserting a row.
You select the specific action from the System action drop-down list.
• A Custom action is a specialized action that you define, by entering the name of the
event in the Custom action field
The fields and controls of the tab change according to the type of action you define, and
according to the specific option you chose for that type of action.

Structure
The following table describes the controls and fields that are displayed in the tab, according to
your selection in the Action type row of radio buttons:
Action Type Property Attribute Description
System action System action Close window Closes the window (for example, a
drop-down list popup window)
Delete row Deletes the current object and
moves the cursor to the next
object.
Dynamic action Invokes a dynamic action,
according to the given formula
defined in the Action formula field.
Export data Copies data to the clipboard, which
can then be exported to another
program (for example, Excel)
Find row Looks for the next object in the
dataset that matches the
expression defined in the Search
formula field. The search starts
from the current cursor position
until the end of the dataset, and
then continues from the beginning
back to the cursor position, in a
cyclic manner.
History back Navigates back one step through
the target element’s history

SAP NetWeaver Visual Composer Reference Guide 102


November 2006

Action Type Property Attribute Description


Hyperlink Opens the document at the URL
address specified in the Hyperlink
address field.
Insert row Inserts a new row and moves the
cursor to the new object. Selected
according to the following
Parameters:
Insert after
Insert before
Insert first
Insert last
Move row Moves to a new row position,
specified according to the following
Parameters:
Move after
Move before
Move first
Move last
Print Sends data to printer
Prompt Displays the message defined in
the Prompt message field in a
modal dialog box
Select row Selects the object that corresponds
to the specified row, and scrolls the
dataset so that the row is brought
into view. Selected according to the
following Parameters:
First row
Last row
Next row
Previous row
Row number (selected from
spinner)

SAP NetWeaver Visual Composer Reference Guide 103


November 2006

Action Type Property Attribute Description


Show page Scrolls the dataset so that the
specified page is brought into view,
according to the following
Parameters:
First page
Last page
Next page
Previous page
Page number (selected from
spinner)
Sort rows Sorts the target dataset according
to the order specified in the Sorting
formula field.
Submit form Starts execution of the form.
Apply to Self Defines on which element to apply
the action.
[other UI
component in
iView]
Validation scope None Defines the controls that will
undergo validation once the action
Element is triggered:
Window None – no validation occurs.
For example, Cancel action
requires no validation.
Element – validation of all
controls targeted by the
action.
For example, if Apply to is
set to Self, clicking a submit
button in a form triggers
validation of all fields in the
form to which validation
conditions have been
defined.
Window – validation of controls
displayed in the main
window and in the current
layer (if one exists).
For example, controls in
components such as forms,
but not nested iViews or
popups, and in the selected
layer, will be validated.
Action formula Used with Dynamic action to define
the entire action.

SAP NetWeaver Visual Composer Reference Guide 104


November 2006

Action Type Property Attribute Description


Parameters Export row Used with Export data to define the
data to be exported.
Export table
Export screen
Parameters Print page Used with Print to define the data
to be printed.
Print table
Print screen
Prompt message Used with Prompt, the formula that
defines the string to display in the
displayed dialog box.
Search formula Used with Find row, a boolean
expression that is evaluated
against each object in turn and
returns true if, and only if, the
tested object matches the search
criteria.
Hyperlink Used with Hyperlink, the URL to be
address displayed.
Sorting formula Used with Sort rows, an expression
string expression that is evaluated
against each object of the dataset,
returning a value that defines the
position of the object in the sort
order.
Custom action Custom action Name assigned to the custom
field event.
Apply to Self Defines on which element to apply
the action.
[other UI
component in
iView]
No action No action is defined for the control.
Action code Read-only field displaying the
defined formula for the action

SAP NetWeaver Visual Composer Reference Guide 105


November 2006

6.11 Control Properties - HTML Tab


Definition
This tab is used to insert formatted HTML text into the block of the HTML control.

Use
You should first type in the HTML text in the pane and then format it, selecting part or all of
the text and applying the different controls.

Structure
The following table describes the properties configured in this tab:
Control Description
[font list] Drop-down list of fonts to choose from
[font size list] Drop-down list of font sizes
Boldface font

Italic font

Underlined font

Font color

Align to left

Align to center

Align to right

SAP NetWeaver Visual Composer Reference Guide 106


November 2006

6.12 Value Help Configuration Wizard


Definition
You can add value help to input fields in your model. This creates a button that displays a
dialog box with a list of valid values for the field, which helps an end-user select the right,
properly formatted value to enter into the field. You configure this list of values with the Value
Help Configuration Wizard, which you access from the Layout board. Select an input field,
and from the context menu, choose Add Value Help.
Value help also generates the proper selection syntax required by Visual Composer and can
therefore be particularly useful when working with variables, for example. (See Working with
Variables [External]).

You may only deploy models that contain value help to Adobe Flash format. To
check that your runtime is set to Flash: from the Visual Composer main menu,
choose Tools → Options. Select the Compiler tab, and from the Runtime
dropdown box, select Flash.

Use
Configure the list of values to appear in value help using three steps provided by the wizard:
...

1. Select the type of value help to add on the Add Value Help for Selected Input Field
screen
2. Select the data service that provides the values on the Select Data Service screen
3. Configure the advanced options on the Specify Data Service Runtime Parameters
screen (optional for BI systems – this screen appears only if you have deselected the
Hide advanced configuration options (BI systems only) checkbox on the Add Value
Help for Select Input Field screen)
When you have completed the steps, the wizard generates an embedded iView that
represents the value help dialog box and its functionality. Next to the input field, the wizard
also generates a value help button. At runtime, when the user presses the button, the dialog
box appears and lists values for the input field.

Structure
The main sections and controls of the three screens in the wizard are described in the
following three tables:

Add Value Help for Selected Input Field

The wizard attempts to suggest the best type of value help for the selected field, but you can
change the selection on this screen.

For variables, the wizard recommends the value help type that will generate the
proper syntax depending on the type of variable selected. Do not change the
recommended selection.

SAP NetWeaver Visual Composer Reference Guide 107


November 2006

Control/Field Menu Option Example Description


Type Single selection Allows the user to
select a single value.
This is the simplest
type of value help.

Interval selection Allows the user to


select a range of
values. Suggested
particularly for BI
system interval
variables.

Multiple selection Allows the user to


select one or more
individual values.
Suggested particularly
for BI system multiple
selection variables.

Selection options Allows the user to


select a set of values
according to complex
selection criteria.
Suggested particularly
for BI system selection
options variables.

Single value and Allows the user to


selection options either select a single
value or use more
complex selection
options. Suggested
particularly for BI
queries, query views,
or characteristics.

SAP NetWeaver Visual Composer Reference Guide 108


November 2006

Control/Field Menu Option Example Description


Selected Field Properties Review properties of
the selected input field.
Hide advanced configuration options (BI systems only) If selected, the
advanced Specify Data
Service Runtime
Parameters screen
(the final screen in the
wizard) does not
appear.
This option is only
valid for value help
based on BI systems
and has no affect if
you are using data
services in other
systems. Filling out the
options in the Specify
Data Service Runtime
Parameters screen is
required for value help
based on, for example,
an SAP System. In
such cases, the
advanced dialog box
will appear even if you
have chosen to hide it.

Select Data Service

You can base the value help list on any type of data service.

Section/Control Area/Menu Option Description

Select Data Service System area Browse and search a selected


system for a data service. See Find
Data Services Task Panel [Page
73], which describes similar
functionality.

SAP NetWeaver Visual Composer Reference Guide 109


November 2006

Section/Control Area/Menu Option Description

Data service tree Select the data service that will


provide the values. Typically, this is
the same object represented by the
input field itself, but not necessarily.
You may select the following types
of data services:
• SAP systems: BAPI or RFC
• SAP BI systems:
characteristic, query, or
query view
• OLAP systems: cube,
dimension, or level
• Relational systems: table
Properties Review properties of the selected
data service.
Properties – Get data from Master Data Table Retrieve characteristic values from
(SAP BI system characteristic the master data table.
only)
Dimension Table Retrieve characteristic values from
the dimension table.
Properties – axis (SAP BI system characteristic only) Indicates whether the selected
characteristic is on the free
characteristics, rows, or columns
axis in the query definition.

Specify Data Service Runtime Parameters

This screen appears if you have deselected the Hide advanced configuration options (BI
systems only) checkbox on the Add Value Help for Selected Input Field screen. It also
appears, regardless of selection of the checkbox, if you are using an SAP System.
Configuring the parameters on this advanced screen is mandatory for SAP Systems, but
optional for BI systems.
Note: Asterisks (*) on this screen indicate required fields.
Section Control/Field Menu Option Description
Input Port (available input Typically, this is an
ports) Input port, but data
services can have
multiple input ports.
You can select the
Variable port of a BI
query if available, for
example.
Input Fields List of available input
fields.

SAP NetWeaver Visual Composer Reference Guide 110


November 2006

Section Control/Field Menu Option Description


Assigned Value Allows you to assign
a default value to the
corresponding field.
You can type text or
enter a formula.
Search Field ID (available fields) Select a field to
provide search
capabilities within
that field.
Search Field Name Enter a label for the
search field, if
selected.
Output Port (available output Select the output port
ports) to which to deliver the
value the user
selects. Typically, this
is an Output port, but
data services can
have multiple output
ports.
Output Fields List of available
output fields. Place a
checkmark in the ?
column to indicate
that the field should
be displayed in the
value help dialog box.
Field Text You may overwrite
the values in this
column to change the
label of the
corresponding field.
Key Field (available key fields) The value delivered
to the input field.
For input fields, the
Key value is typically
required.
For variable input
fields, the Key
(External Display)
value is required.

Example
See Integrating Value Help into Your Model [External], in the SAP NetWeaver Visual
Composer Modeler’s Guide.

SAP NetWeaver Visual Composer Reference Guide 111


November 2006

Visual Composer also provides a second type of value help that you can use
during design-time in formulas or to populate controls such as drop-down lists.
See Value Help List [Page 116].
See also:
See Using a BI System as a Data Service [External] in the SAP NetWeaver Visual
Composer Modeler’s Guide for a table of BI system InfoObjects and their different
formats. For example, you typically want to use the _ext_key format of a characteristic
in value help as input for a variable.
See Working with Variables [External] in the SAP NetWeaver Visual Composer Modeler’s
Guide to see how value help helps you generate proper selection syntax in addition to
field values.

SAP NetWeaver Visual Composer Reference Guide 112


November 2006

7 Tools Menu Dialog Boxes


This section describes the different options that are available from the Tools option of the
Storyboard main menu:
• Documentation Wizard [Page 113]
• Entry List Manager [Page 115]
• Image Manager [Page 119]
• Alias Manager [Page 120]
• System Definition (Web Service) [Page 121]
• Alert Data Service [Page 122]
• Customize Toolbar [Page 124]
• Options [Page 125]

SAP NetWeaver Visual Composer Reference Guide 113


November 2006

7.1 Documentation Wizard


Definition
The Documentation Wizard organizes the information in your model according to the
parameters that you specify (such as printing notes or creating an index), creates a document
and enables you to print it and save it.

Use
You display the Documentation Wizard by choosing Tools → Documentation Wizard. Once
you select the model level and the print options, and click Print, the document is displayed for
printing or saving.

Structure
The following table lists the options in the wizard for printing your documentation:
Control Option Description
Source Diagram A drop-down list showing all the upper-level
elements (“diagrams“) of your model, such as
pages and iViews, to enable you to select how
much of the model is to be documented.
Print Options Print drawings Prints the diagram displayed on the Design
board.
Print definitions Prints information about the model (for
example, the iView name, author, last modified
date, user-defined hyperlink and user defined
notes). In addition, it prints a table listing the
elements belonging to the model component,
and properties of those elements. If the
component has no lower-level elements, the
table does not appear.
Print statistics A section at the end of the document that
provides the following model statistics: Total
Diagrams, Total Definitions, Total Property
Values, Average Definitions per Diagram,
Average Properties per Element.
Print index Adds an alphabetized index of model elements
to the document.
Include sub-diagrams Prints all diagrams of component levels below
that displayed on the Design board.

SAP NetWeaver Visual Composer Reference Guide 114


November 2006

7.2 Entry List Manager


Definition
The Entry List Manager is used to create global lists of options, for use in bulleted and
numbered lists, drop-down lists, and groups of radio buttons throughout the model. Once
created, these global entry lists are available in any of the model UI components that contain
the relevant controls.

Use
You use this dialog box, accessed by choosing Tools → Entry List Manager, to create three
types of lists:
• Static lists, which have set values that you define.
• Dynamic lists, which are populated at runtime according to the input fields selected and
the corresponding values assigned.
• Value Help lists, which are auxiliary design-time tools implemented through a wizard.
They help you identify a data service and configure a list of master data values to store
in a static entry list.
For an explanation of the procedure for creating global and local entry lists, see Create an
Entry List [External] in the SAP NetWeaver Visual Composer Modeler's Guide.

Structure
The structure of the dialog box changes according to the type of list chosen. Once you have
added an entry list, you create it exactly as you do local entry lists in the Control Properties
dialog box.
The three buttons at the bottom left are used to manage the creation of the global entry lists:
Add: a drop-down list for selecting the type of global entry list that you want to create:
{ Static list: for details, see Control Properties - Entry List Tab [Page 96]
{ Dynamic list: for details, see Control Properties - Entry List Tab [Page 96]
{ Value Help list: for details, see Value Help List [Page 116]
Each list is shown in the Entry Lists pane above the buttons. When you click on the list,
the details about it are displayed to the right, for viewing and/or editing.
Remove: Deletes the selected global entry list
Rename: Activates the name for you to edit the existing one

SAP NetWeaver Visual Composer Reference Guide 115


November 2006

7.2.1 Value Help List


Definition
Value help lists are reusable selections of master data values that are made available as
entry lists for use while designing your model. You can use these to, for example, supply valid
values to a formula or to populate controls such as drop-down lists. Value help lists are
created with the help of a wizard that is accessed from the Entry List Manager [Page 115]
when you click Add, and choose Value Help List.

Use
You create a value help entry list in two steps provided by the wizard:
• Select a data source
• Review value help list
You can repeat these steps as many times as you wish while creating the list (for example, to
create lists with values from different data services).

Structure
The main sections and controls of the two screens of the wizard are described in the following
two tables:

Select a Data Source

Section Control Description


Available Services Select system Browse and search a selected
system for a data service. See
Find Data Services Task Panel
[Page 73], which describes
similar functionality. Data
services from three types of
systems are supported:
SAP BI systems
XMLA systems
JDBC systems
Data service tree Depending on the type of data
service you have selected above,
select the following kind of object
in the data service tree:
Characteristic (SAP BI system)
Level (XMLA system)
Table column (field) (JDBC
system)
Description Review the description, if available, of the object selected in
the data service tree.

SAP NetWeaver Visual Composer Reference Guide 116


November 2006

Review Value Help List

Section/Control Field Description


Search section Look for Browse data – retrieve and
browse all master data
values, without search
restrictions
Look for key – SAP BI
systems only – Restrict
the list of master data
to be retrieved by
searching in keys
based on numeric
operator values
specified below.
Look for text – SAP BI
systems only – Restrict
the list of master data
to be retrieved by
searching in text based
on textual operator
values specified below.
Operator If Look for key or Look for
text is selected, choose an
operator to apply:
Keys (numeric operators):
Equal To
Not Equal To
Between
Not Between
Less Than Equal To
Greater Than
Greater Than Equal To
Less Than
Contains Pattern
Not Contains Pattern
Text (textual operators):
Equal To
Contains Pattern
Low Enter a low or text value for
the selected operator, if
relevant.
High Enter a high value for the
selected operator, if relevant.

SAP NetWeaver Visual Composer Reference Guide 117


November 2006

Section/Control Field Description


Find data used in cube only If checked, search for values
(SAP BI systems only) within the dimension table. If
unchecked, all values of the
selected characteristic that
appear in the master data
table are retrieved.
Browse / Search Browse when browse data is
selected, otherwise Search.
Retrieve the available master
data values for the object
selected on the previous
screen. Up to the first 1000
values are retrieved. Search
masks are applied (as above)
if relevant, to reduce the size
of the list.
Available Values The list of values available for your list. Move individual
selected values back and forth between lists with the arrows
or clear them with the Clear button.
Selected Values Values selected to appear in your list. Move individual
selected values back and forth between lists with the arrows
or clear them with the Clear button.

Example
See Creating a Value Help Entry List [External] in the SAP NetWeaver Visual Composer
Modeler's Guide.

Entry list value help is also known as design-time value help. A second type of
value help, a run-time value help, is also available in Visual Composer. With
this, you create a button next to an input field that displays a dialog box of valid
values during your model’s runtime. See Value Help Configuration Wizard [Page
107].

SAP NetWeaver Visual Composer Reference Guide 118


November 2006

7.3 Image Manager


Definition
The Image Manager is used to create a library of images for use in image controls within the
model. When defining an image control in a model component, you use the Image tab in the
Control Properties dialog box to select an image from this image library.

Use
Choose Tools → Image Manager to access the dialog box. To add an image, you first click
Browse, locate and select the image you want to add, and then click Upload.
Images that you add to the library are then available throughout the model. For more
information about adding images and using the Image Manager, see How to . . . Define an
Image Control [External] in the SAP NetWeaver Visual Composer Modeler's Guide.

Structure
The main parts of the Image Manager dialog box are:
• The toolbar, for renaming and deleting images
• The display pane, for showing the images contained in the library
• The fields and buttons at the bottom, for locating and adding the images
The following table describes the controls in the dialog box:
Control Description
Activates the name of the selected image for you to edit it.

Deletes the selected image.

Browse Opens the standard Choose file dialog box for you to locate the
image that you want to add. When you click Open, the dialog box is
closed and the file name is displayed in the field at the bottom.
Upload Enters the image named in the field into the library, displaying a
thumbnail in the display pane.
Close Closes the Image Manager.

SAP NetWeaver Visual Composer Reference Guide 119


November 2006

7.4 Alias Manager


Definition
The System Alias Manager enables you to review the back-end systems from which you have
chosen the data services in the model and:
• Change the source system as necessary
• Rename a portal system alias if it has been renamed in the portal
• Rename a system alias if a model has been ported between servers that have different
aliases for the same back-end system

Use
Choose Tools → Alias Manager to access the dialog box. A table is displayed listing all
system aliases used in the model, along with their details. To change a system alias, you
check its row and click Rename.
For more information about using the Alias Manager, see How to . . . Manage Your Portal
System Aliases [External] in the SAP NetWeaver Visual Composer Modeler's Guide.

Structure
The following table describes the controls of the System Alias Manager dialog box:
Control Option Description
Select Select “<name>“ Selects all instances of the selected alias
Alias
Select All Aliases Selects the entire list of aliases
Select None Deselects all selected aliases
Replace Displays a dialog box, in whose field you
enter the new portal alias that you require
[table] Alias column header Alias currently defined for the system in the
System Landscape editor of your portal
Used in column Name of the iView containing a data service
header within the named system
Used by column Name of the data service
header
System Type column Type of system containing the data service
header

SAP NetWeaver Visual Composer Reference Guide 120


November 2006

7.5 System Definition (Web Service)


Definition
The System Definition (Web Service) is used to define web services to be used in the
modeling process. Web services that you define will be accessible only to users logging on to
Visual Composer using your user name and password.

Use
You display the System Definition (Web Service) dialog box by choosing Tools → Define Web
service system. You then enter all the information relating to the new web service system.

Structure
The System Definition (Web Service) dialog box includes the following fields and controls:
Control Description
New system name Unique name of the web service system
New system alias Alias that will be used in the portal to identify the web service system
Web service URL Web service’s URL address
URL requires User Defines that the web service requires user authentication
and Password
checkbox
User The user name
Password The password assigned to the user

SAP NetWeaver Visual Composer Reference Guide 121


November 2006

7.6 Alert Data Service


Definition
An alert data service is a data service that displays all SAP alerts available in the Universal
Worklist on the portal. You can build an alert data service into your model to display alerts in
an analytical application. You display the alerts in a table, using the Select Display Fields
dialog box to select which alert attributes are displayed.
All SAP and SAP BI systems that are configured as alert connectors on the portal are capable
of broadcasting alerts. See prerequisites in Add an Alert Data Service [External] in the SAP
NetWeaver Visual Composer Modeler's Guide, and Configuring Universal Worklist
Connectivity [External] in the SAP NetWeaver Visual Composer Installation & Configuration
Guide [External] for more information.

Use
Within an iView, choose Tools → Alert Data Service, then click Generate to place an alert
data service on your storyboard.
Configure a start point on the data service’s Input port, then drag from the data service’s
Output port and select Add Table View to display the alerts in a table. The Select Display
Fields dialog box appears, which allows you to select which alert attributes to display.

Structure
The following table lists the available alert attributes you can display using the Select Display
Fields dialog box:
Attribute Description
ACTIVITYLINK1 URL link to an activity you need to complete. There can be up to
three activities for each alert.
ACTIVITYLINK2
This could also display the URL link to an associated an SAP BI
ACTIVITYLINK3 system query view, if relevant.
ACTIVITYTEXT1 Description of the associated activity you need to complete.
ACTIVITYTEXT2
ACTIVITYTEXT3
ALERTCATEGORY Category of alert. For example: Sales Performance; Max. vacation
time exceeded; Book sold out.
ALERTID Back-end alert ID.
ATTRIBUTES List of all attributes for alert, delivered in one string. For design-
time usage only. Not recommended to deploy this into a table for
end-users.
DESCRIPTION Description of alert (long text). Compare with SUBJECT (short
text).
DUEDATE Date by which the task described in the alert needs to be
completed, in the current portal user's time zone.
DUETIME Time by which the task described in the alert needs to be
completed, in the current portal user's time zone.
ESCALATED Boolean value indicating whether the alert has been escalated.

SAP NetWeaver Visual Composer Reference Guide 122


November 2006

Attribute Description
EXPIREDATE Date when the alert is scheduled to be removed from the list, in the
current portal user's time zone.
EXPIRETIME Time when the alert is scheduled to be removed from the list, in the
current portal user's time zone.
PRIORITY Priority of alert. For example: High; Very High.
RECIPIENTS List of people who received the alert. There can be multiple people
in this list.
STATUS Status of alert. For example: New; In Progress.
SUBJECT Description of alert (short text). Compare with DESCRIPTION (long
text).

Example
See Add an Alert Data Service [External] in the SAP NetWeaver Visual Composer Modeler's
Guide.

See also:
Universal Worklist Configuration [External] in the SAP NetWeaver Technology Consultant's
Guide.

SAP NetWeaver Visual Composer Reference Guide 123


November 2006

7.7 Customize Toolbar


Definition
The Customize Toolbar dialog box enables you to change the contents of the following
toolbars and toolboxes:
• Main toolbar (see Main Toolbar [Page 7])
• Design board toolbox (see Workspace Toolboxes [Page 9])
• Layout board toolbox (see Workspace Toolboxes [Page 9])
• Source board toolbox (see Workspace Toolboxes [Page 9])

Use
You display the Customize Toolbar dialog box by choosing Tools → Customize. When you
select your choice of toolbar or toolbox, the list of buttons that can be displayed in the toolbar
is shown in the Available buttons pane at the right. You use the arrow buttons to add them to
or remove them from the currently-displayed buttons (at the left).

Structure
The following table describes the controls in the Customize Toolbar dialog box:
Control Option Description
Toolbar Main toolbar Displays the buttons of the main toolbar
Task panel Displays the buttons of the task panel
Design toolbox Displays the buttons of the Design board
toolbox
Layout toolbox Displays the buttons of the Layout board
toolbox
Source toolbox Displays the button of the Source toolbox
Help Not relevant
Moves the selected button one place up (to
the left) in the configuration
Moves the selected button one place down
(to the right) in the configuration
Removes a currently-displayed button from
the toolbar
Adds the selected button to the toolbar

Reset Resets the toolbar to its original configuration


OK Closes the dialog box
Apply Displays the new toolbar configuration
immediately
Cancel Closes the dialog box and cancels all
changes made since the last time you clicked
Apply

SAP NetWeaver Visual Composer Reference Guide 124


November 2006

7.8 Options Dialog Box


Definition
This dialog box contains a set of tabs that enable you to customize the layout and general
behavior of the Visual Composer Storyboard.

Use
The Options dialog box, displayed by choosing Tools → Options, defines much of the base
functionality of your Storyboard. You should review the parameters in the Options tabs before
beginning to create models in Visual Composer.

Structure
Tables describing the options available in each tab of the Options dialog box are found in
subsequent topics:
• Options - Model Tab [Page 125]
• Options - Drawing Tab [Page 126]
• Options - Editing Tab [Page 127]
• Options - Workspace Tab [Page 128]
• Options - Compiler Tab [Page 129]
• Options - Administration Tab [Page 130]

7.8.1 Options - Model Tab


Definition
Used to define the top-level functionality of model creation.

Structure
Option Description
Reload last model at startup Used to automatically display the last model worked on when
you next access Visual Composer. If this is not selected, you
need to open a model each time you access the application.
Save model every The interval at which the open model is saved automatically:
from 5 minutes to 2 hours.
Maximum undo levels Number of times that you can consecutively click the
Undo/Redo toolbar buttons (Edit → Undo/Redo).
Maximum history size Number of times that you can consecutively click the
Back/Forward toolbar buttons (Search → Back/Forward) in
order to go back one level in your model.
Reset Settings Restores the previous set of parameters.
Optimize for Speed Select the option configuration parameters that provide optimal
speed of operation.

SAP NetWeaver Visual Composer Reference Guide 125


November 2006

7.8.2 Options - Drawing Tab


Definition
Used to define what occurs as you drag-and-drop elements onto the Design board, and how
the items are drawn and displayed.

Structure
Group Option Sub-Option Description
Drawing Avoid overlapping This is important when dragging layers
shapes onto the Design board. However, it is
recommended to leave this checked so
that you need to manually drag the
elements into the layer, thereby joining
them into one unit.
Automatically fit Adjusts the size of the last-opened
diagram on open model in the workspace when you first
access Visual Composer.
Display diagram title Displays (or hides) the title of the model
component in the workspace.
Interaction Show drag and drop Displays the animated shape of the
sprite object you are dragging.
Snap shapes to grid Automatically snaps the icon that you
while dragging drag to the lines of the grid.
Highlight shapes Highlights the border of the icon as you
under the mouse run the mouse over it.
Select shapes Lets you select a group of objects by
partially within area dragging the bounding rectangle partly
over them.
Optimize screen Enhances the speed and quality of the
refreshing model display.
Line Routing Routing method Automatic With right angles (orthogonal).
Straight Direct 45-degree line with no corners.
Angular Direct line.
Curved
Orthogonal Line with 90-degree angles.
Line corners None Lines drawn straight, from element to
element (port to port).
Small Degree of sharpness of the corners.
Medium
Large

SAP NetWeaver Visual Composer Reference Guide 126


November 2006

7.8.3 Options - Editing Tab


Definition
Used to define monitoring capabilities.

Structure
Editing Tab

Option Sub-Option Description


Ask for under intervention These three options are used to limit
when creating: the amount of unneeded data that
may ultimately be handled by the
model.
Data services with more than X fields/port or Y Displays the Define Data Service
ports dialog box for you to select the ports
and fields to be included in the data
service that you are adding.
Interactors with more than Z fields Displays the Select Display Fields
dialog box to select only those fields of
the form or table that are needed at
runtime.
Connectors with more than X fields Displays the Select Input Fields or
Select Output Fields dialog box when
dragging out and creating a connector,
in order to limit the number of fields
channeled through the connector
Automatically create data Similar There is at least one matching field.
mapping when source and
target are: Very similar Same as Similar.
Exactly match All fields match.
Never No data mapping is created.
Request confirmation before Diagrams Displays a confirmation dialog box
deleting: when deleting a model.
Primary elements Displays a confirmation dialog box
when deleting data services and
components.
Other elements Displays a confirmation dialog box
when deleting all other model items.
When editing elements with All fields Displays the fields in the Configure
many fields, initially show: Element task panel.
Selective fields
Only fields in use

SAP NetWeaver Visual Composer Reference Guide 127


November 2006

7.8.4 Options - Workspace Tab


Definition
Used to position the task panel and the workspace toolboxes, and adjust the layout of multiple
workspace windows.

Structure
Option Sub-Option Description
Taskbar position Right Positions the task panels
either at the right or the left of
Left the workspace

Toolbox position Top Positions the main toolbar


either horizontally at the top
Bottom or bottom of the workspace,
Right or vertically at the right or left
of the workspace
Left
Hide Removes the toolbar from
the display
Windows mode Maximized Standard Windows options
for displaying multiple
Cascading windows windows of the workspace
Horizontal tiles
Vertical tiles
Maximum windows Single Only one window can be
displayed at the same time
5, 10, 20, 25 Number of windows that can
be open at the same time
Unlimited Any number of windows can
be open at the same time
Enable synchronized Disabling this option can
windows enhance performance

SAP NetWeaver Visual Composer Reference Guide 128


November 2006

7.8.5 Options - Compiler Tab


Definition
Used to define processes for finding data services and deploying the model.

Structure
Option Sub-Option Description
Runtime Lets you choose from the
available runtime
environments to which you
can deploy. The same model
can be deployed to one
environment and
subsequently deployed to
another environment.
PAR name prefix The prefix of all PAR files
created by Visual Composer
Portal deployment folder The path to the Portal
Catalog folder that will
include the compiled files
Portal system folder The path to the Portal
Catalog folder where new
systems will be created
Data service retrieval Cache retrieved services (for Caches the data services
fast retrieval) found in the Find Data
Services task panel
Do not cache data services Retrieves the same data
(get latest) services each time rather
than caching them
Mask unsupported features Removes from the display
items – such as model
elements and property
options – that are not
supported by the currently-
selected deploy environment
Deploy model with PAR Deploys the PAR file with the
model, so that a portal user
can open the model in
Storyboard, directly from the
portal PCD (using the Open
in Storyboard option).
Add Guided Procedure Enables the model to be
information subsequently used as a
callable object for Guided
Procedure.
This option automatically
renders input and output
parameters for display in
Guided Procedures.

SAP NetWeaver Visual Composer Reference Guide 129


January 2007

Option Sub-Option Description

Enable styling of Flex Enables you to define a


controls in portal themes customized portal theme for
the Flex controls used in the
application being modeled.

Report unsupported features Displays a message


indicated that the selected
item is not supported by the
currently-selected deploy
environment
Generate Translations Info Generates the standard
file portal translation worklist file
Add Flash debugging (Flex applications only)
console Displays a debugging
console at the bottom of the
screen listing debug
messages

7.8.6 Options - Administration Tab


Definition
Used to define monitoring capabilities.

Structure
Option Sub-Option Description
Log Severity Fatal Errors from which the application cannot recover and
which cause the system to terminate
Error Error from which the application can recover, but
whcih prevents it from fulfilling the required task
Warning An anomaly from which the application can recover
and fulfill the required task, although attention from a
developer or operator is required
Info Text describing what actions have been performed
None No messages are displayed
Trace Severity Path Used to trace the execution flow
Debug Used for debugging purposes, with extensive and low-
level information
None No trace messages are displayed

SAP NetWeaver Visual Composer Reference Guide 130


November 2006

8 BI Menu Dialog Boxes


This section describes the different options that are available on the BI menu in the Visual
Composer main menu:
• BI Integration Wizard [Page 132]
• SQL Editor [Page 173]
• MDX Editor [Page 175]

• Data sources supported by these menu options include systems based on a


BI Java Connector (BI XMLA, BI ODBO, BI JDBC, or BI SAP Query
Connector). See Defining Portal Systems and Aliases [External] in the SAP
NetWeaver Visual Composer Installation & Configuration Guide.
• SAP BW systems 3.1C and higher are supported if they have been
configured as OLAP systems using the BI XMLA Connector. We recommend,
however, that you configure SAP BW systems 3.5 and higher with the SAP BI
Connector. You can access queries, query views, and characteristics from
these systems directly on the Find Data Services task panel (see Using a BI
System as a Data Service [External] in the SAP NetWeaver Visual Composer
Modeler’s Guide). You cannot use the BI menu options with systems
configured in this way.
• You may only deploy models created using BI menu functionality to Adobe
Flash format. To check that your runtime is set to Flash: from the Visual
Composer main menu, choose Tools → Options. Select the Compiler tab,
and from the Runtime dropdown box, select Flash.

Queries with mandatory variables are not supported by BI XMLA connections.

BI Terminology Notes
BI menu functionality allows you to build queries on diverse OLAP (as well as relational) data
sources defined in your portal. These may include SAP BI systems (BW) or non-SAP data
sources. In cases where SAP BI system terminology differs from general OLAP terminology,
the BI dialog boxes use the standard OLAP terminology. Some of the major differences
between standard OLAP and SAP BI terms follow:
OLAP Standard Term SAP BI Term
dimension characteristic
measure key figure
member characteristic level
level hierarchy level

For OLAP systems, the caption value from your data service is displayed in
dialog box fields. For relational systems, the field name is displayed.

For definitions of terms used in Visual Composer, see the Glossary [External] in the SAP
NetWeaver Visual Composer Modeler’s Guide.

SAP NetWeaver Visual Composer Reference Guide 131


November 2006

8.1 BI Integration Wizard


Definition
The BI Integration Wizard walks you through the process of creating a query using one of a
set of query templates. The wizard creates a data service element in the Visual Composer
workspace configured with the query you choose.

See the prerequisites described in the notes in BI Menu Dialog Boxes [Page
131].

Use
...

1. Create an iView and drill down into it.


2. Start the BI Integration Wizard by choosing BI → BI Integration Wizard.
3. Follow the wizard steps. The wizard’s process flow differs depending on the system and
template selected.
Once you have completed the wizard screens, a data service, configured automatically with a
start input and a table view as output (or HTML view, in the case of the Heatmap template), is
created on the workspace. These three elements together constitute a complete iView, ready
for deployment to your portal.

All formats of fields in the query represented by the data service are displayed
by default in the table view (key, value, and so on). Edit the table element to
select only the specific fields or field formats that you wish to see in the results
(see Table View [Page 65]: Table at bottom).

Structure
Reference topics for available wizard screens are listed below:
• Select a System [Page 133]
• Select a Query Template [Page 134] (includes links to template configuration
subtopics)
• Select a Cube [Page 163]
• Define Filters [Page 164]
• Select a Table [Page 166]
• Design a Layout [Page 166]
• Select Fields [Page 168]
• Configure Joins [Page 169]
• Configure Filters [Page 171]
• Specify the Sort Order [Page 172]
• Review Output [Page 172]

Example
See Use the BI Integration Wizard [External] and Creating a BI iView [External] in the SAP
NetWeaver Visual Composer Modeler’s Guide.

SAP NetWeaver Visual Composer Reference Guide 132


November 2006

8.1.1 Select a System


Use
Use this screen to select the system that contains the data service for which you want to build
a query. OLAP and relational systems configured using a BI Java Connector are supported.
The list of available query templates on the subsequent wizard screen varies depending on
the system you have selected on this screen.

Structure
The main sections of this screen are listed in the following table:
Section Description
Available Systems Displays the systems available, categorized in folders based on the BI
Java Connector used to configure the system. Available systems
depend on what you have configured on the portal, and may include:
• XMLA connections – OLAP systems based on the BI XMLA
Connector
• ODBO connections – OLAP systems based on the BI ODBO
Connector
• JDBC connections – Relational systems based on the BI JDBC
Connector
• SAPQ connections – Relational systems based on the BI SAP
Query Connector
Description Displays the description of selected folder or system, if available.
Properties Displays properties for the selected folder or system, if available.

SAP NetWeaver Visual Composer Reference Guide 133


November 2006

8.1.2 Select a Query Template


Definition
A query template is a set of screens that you complete to answer a typical business question,
which is a question formulated to organize and analyze the data in your data source.

Use
Use this screen to learn about available query templates and select one to base your query
upon. The set of templates available depends on whether you have selected a relational or
OLAP system on the previous screen (Select a System [Page 133]). After you select a
template, you proceed to the first screen specific to configuring your query (if applicable).
Subsequent steps in the wizard’s navigation trail update based on the template you have
chosen.
Note that although a sample business question is provided for each query template, a given
template can address many different questions. For example, you can configure the Top N
query template to address any of the questions below:
• What are my top five customers based on sales?
• What are my bottom ten products based on margin?
• What products make up the top 10% of sales?

Structure
The main sections of this screen are listed in the following table:
Section Description
Available Templates Displays the list of available query templates. OLAP
templates are grouped into categories. See below for the
complete list of available templates.
Description Displays a description of the selected query template.
Sample Business Question Displays the sample business question associated with the
selected query template.

The following query templates are available for OLAP systems:


Category / Name Description Sample Business Parameters /
Question Example
Grand Totals Aggregates all What is the total Not applicable.
measures to the revenue of all sales
highest level. transactions?
Returns one column
of data with the total
for each measure.
Freeform Walks you through Not applicable. See Design a Layout
defining a query [Page 166].
without the constraint
of a particular
business question.
Aggregation
Count For a selected level, Sales returns for See Count

SAP NetWeaver Visual Composer Reference Guide 134


November 2006

Category / Name Description Sample Business Parameters /


Question Example
counts members MyCompany equal Parameters [Page
contributing to a $25,000. How many 137].
specific measure. product lines does
this represent?
Percentage Share Calculates the share What percentages do See Percentage
that selected Canada and Mexico Share Parameters
members represent represent of my total [Page 147].
within the sum of the sales?
level members, and
expresses this as a
percentage.
Dynamic Calculation
Cumulative Total Cumulates the value What is my monthly See Cumulative
of a measure over a year-to-date expense Total Parameters
specific date range. total? [Page 140].
Moving Average Calculates the What are the average See Moving Average
average values of manufacturing costs Parameters [Page
selected measures of products A and B 142].
based on specified for Q2 and Q3, based
time periods on the previous four
months?
Rank
Rank Change Based on a specific What is the change in See Rank Change
measure, calculates rank for my top ten Parameters [Page
the change in rank of customers between 152].
members of a last year and this
particular level year?
compared with their
rank from a previous
period.
Top N Calculates the rank Who are my top ten See Top N
of a level based on a or bottom ten Parameters [Page
specific measure. customers? 154].
Trend
Trend Over Time Displays the trend of What is the trend in See Trend Over
a specific measure my gross margin over Time Parameters
for a selected the past few years? [Page 156].
member over time.
Variance
Percentage Growth Calculates the By what percentage See Percentage
percentage by which did my sales increase Growth Parameters
a specific measure this year compared to [Page 145].
has increased or last year?
decreased for a
selected member in
comparison to the
same period of time
previously or

SAP NetWeaver Visual Composer Reference Guide 135


November 2006

Category / Name Description Sample Business Parameters /


Question Example
subsequently.
Planned vs. Actual Calculates the values How do my actual See Planned vs.
of a measure defined costs compare to the Actual Parameters
as actual and a planned costs? [Page 149].
measure defined as
planned, illustrating
the difference
between actual and
expected results.
Zero Activity Identifies members of Which products didn't See Zero Activity
a selected level that sell last year? Parameters [Page
have had sales in the 158].
past, but which have
had no sales in a
specified time period.

The following query templates are available for relational systems:


Name Description Sample Business Parameters /
Question Example
All Data Selects all records What are all the Not applicable.
and all fields as the available grade
final result, without levels and their
any filters or joins. details?
Count (not available Counts all How many See Select Fields
for SAP Query occurrences of a employees is each [Page 168] for an
systems) certain type of data different manager example.
in a group or groups responsible for?
within a table.
Freeform Walks you through Not applicable. Not applicable.
defining a query
without the
constraint of a
particular business
question.
Heatmap Aggregates values What is the relative Heatmap Parameters
of a selected primary distribution of sales [Page 160]
group and compares among certain
them with values of divisions and
a secondary group companies?
by displaying the
results in boxes of
differing sizes and
colors.
Minimum/Maximum Finds the minimum Which store has the See
or maximum value of smallest revenue; Minimum/Maximum
a field, and provides where is that store Parameters [Page
details from the row and who is the 162].
that holds that value. manager?

SAP NetWeaver Visual Composer Reference Guide 136


November 2006

8.1.2.1 Count Parameters


Use
Use the Configure Count Parameters screen to configure parameters specific to the Count
(OLAP) template. With this template, you can build queries that count members of a selected
level that contribute to a specific measure. This can address business questions such as the
following:
Sales returns for MyCompany equal $25,000. How many product lines does this represent?

Structure
The main sections and controls of this screen are listed in the following table:
Section Control Description
Count Members of Dimension Lists all dimensions in the cube on which
the query is based.
As each of the screen’s three sections
must be based on different dimensions,
dimensions selected in the other two
sections are omitted from this list.
Select the dimension that contains the
hierarchy to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently
selected dimension.
Select the hierarchy that contains the level
to display in the Level field.
Level Lists all levels in the currently selected
hierarchy.
Select the level that contains all the
members you wish to count.
With measure ... not Lists all measures in the cube on which
equal to zero the query is based.
Select the measure to which all members
in the selected level contribute. Any
member in the selected level with a non-
zero value in this measure will be counted.
Displayed by Dimension Lists all dimensions in the cube on which
Members of the query is based.
As each of the screen’s three sections
must be based on different dimensions,
dimensions selected in the other two
sections are omitted from this list.
Select the dimension that contains the
hierarchy to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently
selected dimension.
Select the hierarchy that contains the level
to display in the Level field.

SAP NetWeaver Visual Composer Reference Guide 137


November 2006

Section Control Description


Level Lists all levels in the currently selected
hierarchy.
Select the level that contains the members
that should be listed on the rows in the
result.
For Date Range Time dimension Lists all the time dimensions in the cube
on which the query is based.
As each of the screen’s three sections
must be based on different dimensions,
dimensions selected in the other two
sections are omitted from this list.
Select the dimension that contains the
hierarchy to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently
selected dimension.
Select the hierarchy that contains the level
to display in the Level field.
Period level Lists all levels in the currently selected
hierarchy.
Select the level that contains the time
granularity upon which to base the date
range.
From Lists all members in the currently selected
level.
Select the start period of the date range in
which to count members.
To Lists all members in the currently selected
level.
Select the end period of the date range in
which to count members.

Example
You want to know how the quantity of products sold is distributed over states, and how that
quantity changes from month to month. To create this query, configure the values on this
screen in the following manner:

Count Members Of section:


• Dimension = Product
• Hierarchy = Product
• Level = Product Name
• With measure ... not equal to zero = Store Sales

SAP NetWeaver Visual Composer Reference Guide 138


November 2006

Displayed by Members Of section:


Dimension = Customers
Hierarchy = Customers
Level = State

For Date Range section:


Time dimension = Time
Hierarchy = Time
Period level = Month
From = January
To = March

The result of this query might be a table such as the following:

Products Sold by States: January to March

Customers January February March


CA 1056 1131 1074
OR 1185 970 1239
WA 1343 1382 1391

This table shows that, for example, 1056 different products were sold in California in January,
1131 different products were sold in February, and so on.

SAP NetWeaver Visual Composer Reference Guide 139


November 2006

8.1.2.2 Cumulative Total Parameters


Use
Use the Configure Cumulative Total Parameters screen to configure parameters specific to
the Cumulative Totals template. With this template, you can build queries that cumulate the
value of a measure over a specific date range.
In the result, the measure is first cumulated over the date range specified, and the starting cell
displays that initial period's sum. Thereafter, each cell in the grid displays the accumulation of
the previous sum plus the sum in the next time period, and so on.
This kind of query is particularly useful if you have a specific target to hit by the end of the
year, for example, and you want to track your progress toward it throughout the year. This can
address business questions such as the following:
What is my monthly year-to-date expense total?

Structure
The main sections and controls of this screen are listed in the following table:
Section Control Description
Calculate Running total of measure Lists all measures in the cube on which the
query is based.
Select the measure for which you want to
display a running total.
For Members of Dimension Lists all dimensions in the cube on which the
query is based.
Select the dimension that contains the
hierarchy to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected
dimension.
Select the hierarchy that contains the level to
display in the Level field.
Level Lists all levels in the currently selected
hierarchy.
Select the level that contains the members you
want to see in the query’s result.
For Date Range Time dimension Lists all the time dimensions in the cube on
which the query is based.
Select the dimension that contains the
hierarchy to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected
dimension.
Select the hierarchy that contains the level to
display in the Level field.
Period level Lists all levels in the currently selected
hierarchy.
Select the level that contains the time
granularity upon which to base the date range.

SAP NetWeaver Visual Composer Reference Guide 140


November 2006

Section Control Description


From Lists all levels in the currently selected
hierarchy.
Select the start period of the date range in
which to cumulate the total.
To Lists all members in the currently selected
level.
Select the end period of the date range in
which to cumulate the total.
Display the last ... periods If checked, restricts your display to the number
of periods specified.

Example
You want to show the cumulative total of store sales for certain machine parts. To create this
query, configure the values on this screen in the following manner:

Calculate section:
• Running total of measure = Store Sales

For Members of section:


Dimension = Product
Hierarchy = Product
Level = Product Name

For Date Range section:


Time dimension = Time
Hierarchy = Time
Period level = Month
From = July
To = December
Display the last ... periods = checked; set to 3 periods

The data used to cumulate the total, together with the result of this query (the shaded cells),
are shown in the tables below:

Cumulative Total Query: Data Reference

Part Jul Aug Sep Oct Nov Dec


Part A 25 15 10 10 10 5
Part B 20 10 5 5 10 15
Part C 5 5 5 5 10 5

SAP NetWeaver Visual Composer Reference Guide 141


November 2006

Cumulative Total of Store Sales for Machine Parts (Result Shaded)

Part Jul Aug Sep Oct Nov Dec


Part A 25 40 50 60 70 75
Part B 20 30 35 40 50 65
Part C 5 10 15 20 30 35

The result table above also illustrates the difference between restricting your display to the
last few time periods and not restricting your display. If you uncheck the Display the last ...
periods field, the result will show values in the entire table.

8.1.2.3 Moving Average Parameters


Use
Use the Configure Moving Average Parameters screen to configure parameters specific to the
Moving Average template. With this template, you can build queries that calculate the
average values of selected measures based on specified time periods. You determine the
time periods to be averaged, and you can use the result to analyze past or forecast future
results. Typically, your forecasts are more accurate if you perform the average over larger
time periods.
This can address business questions such as the following:
What are the average manufacturing costs of products A and B for Q2 and Q3, based on the
previous four months?

Structure
The main sections and controls of this screen are listed in the following table:
Section Control Description
Calculate Moving average of measure Lists all measures in the cube on which the
query is based.
Select the measure for which you want to
display a moving average.
Based on number of periods Enter the number of time periods on which
to base the average.
For Members of Dimension Lists all dimensions in the cube on which
the query is based.
Select the dimension that contains the
hierarchy to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently
selected dimension.
Select the hierarchy that contains the level
to display in the Level field.

SAP NetWeaver Visual Composer Reference Guide 142


November 2006

Section Control Description


Level Lists all levels in the currently selected
hierarchy.
Select the level that contains the members
you want to see in the query's result.
Display Date Time dimension Lists all the time dimensions in the cube on
Range which the query is based.
Select the dimension that contains the
hierarchy to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently
selected dimension.
Select the hierarchy that contains the level
to display in the Level field.
Period level Lists all levels in the currently selected
hierarchy.
Select the level that contains the time
granularity upon which to base the date
range display.
From Lists all members in the currently selected
level.
Select the start period of the date range to
display.
To Lists all members in the currently selected
level.
Select the end period of the date range to
display.

Example
You want to know the average manufacturing costs for March and April based on the previous
four months. To create this query, configure the values on this screen in the following manner:

Calculate section:
• Moving average of measure = Manufacturing Cost
• Based on number of periods = 4

For Members of section:


Dimension = Product
Hierarchy = Product
Level = Product Name

SAP NetWeaver Visual Composer Reference Guide 143


November 2006

Display Date Range section:


Time dimension = Time
Hierarchy = Time
Period level = Month
From = December
To = April

The data used to calculate the moving average, together with the result of this query (the
shaded cells), are shown in the tables below:

Moving Average Query: Data Reference

Part Dec Jan Feb Mar Apr


Part A $25 $15 $10 $10 $5
Part B $20 $10 $5 $5 $15
Part C $5 $5 $5 $5 $5

Average Manufacturing Costs (Based on Previous Four Months)

Part Dec Jan Feb Mar Apr


Part A $15 $10
Part B $10 $9
Part C $5 $5

Each cell in the result shows the average of its own figure and the previous three months,
since the Based on number of periods value is set to 4 months.

SAP NetWeaver Visual Composer Reference Guide 144


November 2006

8.1.2.4 Percentage Growth Parameters


Use
Use the Configure Percentage Growth Parameters screen to configure parameters specific to
the Percentage Growth template. With this template, you can build queries that calculate the
percentage by which a specific measure has increased or decreased for a selected member
in comparison to the same period of time previously or subsequently.
This template is similar to the Rank Change template, but it doesn't perform a Top N
calculation to select the members of the base period (and the results are expressed as a
percentage).
This template can address business questions such as the following:
By what percentage did my sales increase this year compared to last year?

Structure
The main sections and controls of this screen are listed in the following table:
Section Control Description
Calculate Absolute percentage Lists all measures in the cube on which the
growth of measure query is based.
Select the measure for which you want to
calculate growth.
For Members of Dimension Lists all dimensions in the cube on which the
query is based.
Select the dimension that contains the hierarchy
to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected
dimension.
Select the hierarchy that contains the level to
display in the Level field.
Level Lists all levels in the currently selected
hierarchy.
Select the level that contains the members you
want to see in the query’s result.
Between Base Time dimension Lists all the time dimensions in the cube on
and Comparison which the query is based.
Periods
Select the dimension that contains the hierarchy
to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected
dimension.
Select the hierarchy that contains the level to
display in the Level field.
Period level Lists all levels in the currently selected
hierarchy.
Select the level that contains the time
granularity for the base and comparison periods.

SAP NetWeaver Visual Composer Reference Guide 145


November 2006

Section Control Description


Base period Lists all members in the currently selected level.
Select the base period for the growth
calculation.
Comparison period Lists all members in the currently selected level.
Select the comparison period for the growth
calculation.

Example
The result of a Percentage Growth query is displayed in a table with five columns such as the
below:

Percentage Growth Query Result

Product Base Period Comparison Difference Percentage


Period Change
Wine 20 60 40 200%
Beer 80 60 -20 -25%
Juice 100 10 -90 -90%

A percentage growth result may not always show a growth trend, as you can see from the
sample results above. You may see a decrease or decline (negative value) in your growth
result.

SAP NetWeaver Visual Composer Reference Guide 146


November 2006

8.1.2.5 Percentage Share Parameters


Use
Use the Configure Percentage Share Parameters screen to configure parameters specific to
the Percentage Share template. With this template, you can build queries that calculate the
share that selected members represent within the sum of the level members. The result is
expressed as a percentage.
This template can address business questions such as the following:
What percentages do Canada and Mexico represent of my total sales?

Structure
The controls in the main section of this screen, Calculate Share of Members of, are listed in
the following table:
Control Description
Dimension Lists all dimensions in the cube on which the query is based.
Select the dimension that contains the hierarchy to display in
the Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected dimension.
Select the hierarchy that contains the level to display in the
Level field.
Level Lists all levels in the currently selected hierarchy.
Select the level that contains the members you want to see in
the query’s result.
The level name in the radio buttons below updates according
to the value you select.
As a percentage of the sum of all Calculates individual members’ shares in proportion to the
members of <level name> total for all level members.
Note that defining filters (on the subsequent wizard screen)
will have an effect on the way your result displays.
As a percentage of the sum of all Calculates individual members’ shares in proportion to only
filtered members of <level those members you select in the subsequent step of defining
name> a filter.
You must define a filter (on the subsequent wizard screen) for
this option to work properly.
Based on measure Lists all measures in the cube on which the query is based.
Select the measure upon which to base the calculation.

SAP NetWeaver Visual Composer Reference Guide 147


November 2006

Example
The table below illustrates the difference between basing the result on all level members and
basing the result on filtered level members:

Percentage Share Result – All vs. Filtered

Product Family Unit Sales % Based on All % Based on Filtered


Wine 200 20% 33%
Beer 200 20% 33%
Juice 200 20% 33%
Whiskey 200 20%
Soft drinks 200 20%

In this case, the Product Family level has five members. You have selected three members
(Wine, Beer, and Juice) on the Define Filters screen (which follows this screen in the wizard).
To illustrate the effect of this template’s different options:
• As a percentage of the sum of all members of level Product Family:
The percentage share is based on the total for the whole level. In the table above, each
member has 20% of the share of the total. If you wanted to define a query that tells you
what percentage Canada and Mexico make up of your total sales, you would also use
this option. In this case, you would filter your results to just select Canada and Mexico,
and their percentages added together would not add up to 100% if there are other
members contributing to the total that are simply not displayed.
• As a percentage of the sum of all filtered members of level Product Family:
The percentage share is based on only the total of the filtered members. In the table
above, each member takes 33% of this share. You might also use such a query to
compare sales results among three sales representatives, excluding the rest of the
group – essentially comparing themselves to each other within a subset of a level.

The table above is for illustration purposes. The actual result of this query will
show three columns: one for the level, one for the measure, and one for the
percentage share.

SAP NetWeaver Visual Composer Reference Guide 148


November 2006

8.1.2.6 Planned vs. Actual Parameters


Use
Use the Configure Planned vs. Actual Parameters screen to configure parameters specific to
the Planned vs. Actual template. With this template, you can build queries that calculate the
values of a measure defined as actual and a measure defined as planned, illustrating the
difference between actual and expected results.
This template can address business questions such as the following:
How do my actual costs compare to the planned costs?
Results to business queries such as these can be key in optimizing sales. For example, if
your result is far greater than your plan for a specific product, this could indicate a lost
opportunity or insufficient supply for the demand.

Structure
The main controls of this screen are listed in the following table:
Control Value Description
Calculate Planned Measures Use this value if you actually have
versus Actual defined measures defined as Planned and Actual
by in your data service. The measures might
have names such as the below:
• Planned; Actual
• Plan Profit; Actual Profit
• Plan Sales; Actual Sales
• Quantity Ordered; Quantity Shipped
The controls displayed on this screen
differ based on which value is selected in
this control.
Planned vs. Actual Use this value if you have members (not
Indicators measures) that indicate planned and
actual values.
This type of configuration is typically found
in data services based on SAP BI
systems.
The controls displayed on this screen
differ based on which value is selected in
this control.
Dimension Lists all dimensions in the cube on which the query is based.
Select the dimension that contains the hierarchy to display in the
Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected dimension.
Select the hierarchy that contains the level to display in the Level field.

SAP NetWeaver Visual Composer Reference Guide 149


November 2006

Control Value Description


Level Lists all levels in the currently selected hierarchy.
Select the level that contains the members for which to evaluate
planned vs. actual results.
These are the members that will appear on the rows in the result.
Planned versus Actual defined by = Measures only:
Plan measure Lists all measures in the cube on which the query is based.
Select the planned measure.
Actual measure Lists all measures in the cube on which the query is based.
Select the actual measure.
Planned versus Actual defined by = Planned vs. Actual Indicators only:
Measure for Lists all measures in the cube on which the query is based.
comparison
Select the measure for which you want to compare planned vs. actual
values. For example, Profit.
Planned / Actual Lists all dimensions in the cube on which the query is based.
dimension
Select the dimension that contains the hierarchy to display in the
Planned / Actual hierarchy field.
Planned / Actual Lists all hierarchies in the currently selected planned / actual
hierarchy dimension.
Select the hierarchy that contains the level to display in the Planned /
Actual level field.
Planned / Actual level Lists all levels in the currently selected planned / actual hierarchy.
Select the level that contains the members to display in the Planned
indicator and Actual indicator fields.
Planned indicator Lists all members in the currently selected planned / actual level.
Select the member that indicates the planned value.
Actual indicator Lists all members in the currently selected planned / actual level.
Select the member that indicates the actual value.
Either Planned versus Actual Option:
Plan version If checked, allows you to specify a plan version using the controls
below.
This option is typically only valid for data services based on SAP BI
systems.
Version dimension Lists all dimensions in the cube on which the query is based.
Select the dimension that contains the hierarchy to display in the
Version hierarchy field.
Version hierarchy Lists all hierarchies in the currently selected version dimension.
Select the hierarchy that contains the level to display in the Version
level field.

SAP NetWeaver Visual Composer Reference Guide 150


November 2006

Control Value Description


Version level Lists all levels in the currently selected version hierarchy.
Select the level that contains the members to display in the Version
field.
Version Lists all members in the currently selected version level.
Select the member that indicates plan version. For example, this might
be a numeric value such as “001” or “003.”

Example
You want to use planned and actual indicators to compare values in your accounts. To create
this query, you might configure the values on this screen in the following manner:
• Calculate Planned versus Actual defined by = Measures
• Dimension = Product
• Hierarchy = Product
• Level = Product Name
• Plan measure = Units Ordered
• Actual measure = Units Shipped
• Plan version = unchecked (leave section blank)

The result of this query might be a table such as the following:

Products Shipped: Planned vs. Actual

Product Plan Actual


Good Imported Beer 275 275
Portsmouth Light Beer 121 78
Walrus Light Beer 211 188
Good Chardonnay Wine 422 242

SAP NetWeaver Visual Composer Reference Guide 151


November 2006

8.1.2.7 Rank Change Parameters


Use
Use the Configure Rank Change Parameters screen to configure parameters specific to the
Rank Change template. With this template, you can build queries that, based on a specific
measure, calculate the change in rank of members of a particular level compared with their
rank from a previous period.
This template borrows from the functionality of the Top N template in order to select the
members of the base period.
This template can address business questions such as the following:
What is the change in rank for my top ten customers between last year and this year?

Structure
The main sections and controls of this screen are listed in the following table:
Section Control Description
Calculate Change in Rank type Select from the following rank types:
• Top Count
• Bottom Count
• Top Percent
• Bottom Percent
Value Enter the rank value. For Count rank types, the
value is numeric. For Percent rank types, the value
corresponds to a percentage.
For example:
If you select Top Count and enter a Value of 5,
you want to calculate the change in rank of
your top five members between one period
and another.
If you select Top Percent and enter a Value of 10,
you want to calculate the change in rank of
your top 10% of members between one
period and another.
For Members of Dimension Lists all dimensions in the cube on which the query
is based.
Select the dimension that contains the hierarchy to
display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected
dimension.
Select the hierarchy that contains the level to display
in the Level field.
Level Lists all levels in the currently selected hierarchy.
Select the level that contains the members you want
to see in the query’s result.

SAP NetWeaver Visual Composer Reference Guide 152


November 2006

Section Control Description


According to Lists all measures in the cube on which the query is
measure based.
Select the measure to use for the rank change
calculation.
Between Base and Time dimension Lists all the time dimensions in the cube on which
Comparison Periods the query is based.
Select the dimension that contains the hierarchy to
display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected
dimension.
Select the hierarchy that contains the level to display
in the Level field.
Period level Lists all levels in the currently selected hierarchy.
Select the level that contains the time granularity for
the base and comparison periods.
Base period Lists all members in the currently selected level.
Select the base period from which to calculate the
rank change.
Comparison Lists all members in the currently selected level.
period
Select the comparison period with which to calculate
the rank difference.

Example
The result of a Rank Change query is displayed in a table with five columns such as the
below:

Rank Change Query Result

Product Base Period Rank Rank Base Rank Difference


Comparison Period
Period
Wine 1500 6 1 5
Beer 1300 8 2 6
Juice 800 1 3 -2

There are three steps to the calculation in this query:


...

1. The query first computes the results of a Top N query in the base period you specify
(values in Base Period and Rank Base Period columns). This also selects the members
that will appear on the rows in the table.
2. Next, it calculates the Top N results for those same members in the comparison period
(Rank Comparison Period column).
3. Finally, the query computes the difference between the base and comparison period
ranks, and delivers that value in the Rank Difference column.

SAP NetWeaver Visual Composer Reference Guide 153


November 2006

8.1.2.8 Top N Parameters


Use
Use the Configure Top N Parameters screen to configure parameters specific to the Top N
template. With this template, you can build queries that calculate the rank of a level based on
a specific measure. This template is not limited to top values, but also lets you select bottom
values, independently or together with top values. This sort of query makes it easy to identify
your leaders and laggards.
This template can address business questions such as the following:
Who are my top ten or bottom ten customers?

Structure
The main sections and controls of this screen are listed in the following table:
Section Control / Value Description
Define Query Ranks In this section, use the checkboxes to include top, bottom, or both
and Values rank types in the query results. Use the values below to configure the
rank type (count or percent), which can differ between the two.
Top rank type Count Select this option to configure a
top count rank.
Enter a number in the Value field
to indicate count (for example, 5
specifies top 5).
Percent Select this option to configure a
top percent rank.
Enter a number in the Value field
to indicate percentage (for
example, 10 specifies top 10%).
Bottom rank type Count Select this option to configure a
bottom count rank.
Enter a number in the Value field
to indicate count (for example, 5
specifies bottom 5).
Percent Select this option to configure a
bottom percent rank.
Enter a number in the Value field
to indicate percentage (for
example, 10 specifies bottom
10%).
Define Members Dimension Lists all dimensions in the cube on
which the query is based.
Select the dimension that contains
the hierarchy to display in the
Hierarchy field.

SAP NetWeaver Visual Composer Reference Guide 154


November 2006

Section Control / Value Description


Hierarchy Lists all hierarchies in the currently
selected dimension.
Select the hierarchy that contains
the level to display in the Level
field.
Level Lists all levels in the currently
selected hierarchy.
Select the level that contains the
members you want to see in the
query’s result.
According to measure Lists all measures in the cube on
which the query is based.
Select the measure to use for the
top (or bottom) N calculation.

Example
For a step-by-step example, see Creating a BI iView [External] in the SAP NetWeaver Visual
Composer Modeler’s Guide.

SAP NetWeaver Visual Composer Reference Guide 155


November 2006

8.1.2.9 Trend Over Time Parameters


Use
Use the Configure Trend Over Time Parameters screen to configure parameters specific to
the Trend Over Time template. With this template, you can build queries that display the trend
of a specific measure for a selected member over time.
This is a common type of business query with which you track performance over a specific
time period, helping you to easily identify and react to trends from one year (or other time
period) to the next.
This template can address business questions such as the following:
What is the trend in my gross margin over the past few years? Is it increasing or decreasing?

Structure
The main sections and controls of this screen are listed in the following table:
Section Control Description
Display Trend in measure Lists all measures in the cube on which the
query is based.
Select the measure for which you want to
display a trend.
For Members of Dimension Lists all dimensions in the cube on which the
query is based.
Select the dimension that contains the
hierarchy to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected
dimension.
Select the hierarchy that contains the level to
display in the Level field.
Level Lists all levels in the currently selected
hierarchy.
Select the level that contains the members
you want to see in the query’s result.
During Date Range Time dimension Lists all the time dimensions in the cube on
which the query is based.
Select the dimension that contains the
hierarchy to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected
dimension.
Select the hierarchy that contains the level to
display in the Level field.
Period level Lists all levels in the currently selected
hierarchy.
Select the level that contains the time
granularity upon which to base the trend
calculations.

SAP NetWeaver Visual Composer Reference Guide 156


November 2006

Section Control Description


From Lists all members in the currently selected
level.
Select the start period of the trend.
To Lists all members in the currently selected
level.
Select the end period of the trend.

Example
You want to identify the trend in unit sales for product families over the last half of the year.
To create this query, configure the values on this screen in the following manner:

Display section:
• Trend in measure = Unit Sales

For Members of section:


Dimension = Product
Hierarchy = Product
Level = Product Family

During Date Range section:


Time dimension = Time
Hierarchy = Time
Period level = Month
From = July
To = December

The result of this query is displayed in a table similar to the below:

Unit Sales Trend: Month to Month

Product Jul Aug Sep Oct Nov Dec


Family
Drink 2,205 1,921 1,939 1,898 2,344 2,419
Food 17,036 15,741 14,663 14,232 18,278 19,356
Non- 4,522 4,035 3,786 3,828 4,648 5,021
Consumable

SAP NetWeaver Visual Composer Reference Guide 157


November 2006

8.1.2.10 Zero Activity Parameters


Use
Use the Configure Zero Activity Parameters screen to configure parameters specific to the
Zero Activity template. With this template, you can build queries that identify members of a
selected level that have had sales in the past, but that have had no sales in a specified time
period.
This template can address business questions such as the following:
Which products didn't sell last year?

Structure
The main sections and controls of this screen are listed in the following table:
Section Control Description
Display Members of Dimension Lists all dimensions in the cube on which the
query is based.
Select the dimension that contains the
hierarchy to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected
dimension.
Select the hierarchy that contains the level to
display in the Level field.
Level Lists all levels in the currently selected
hierarchy.
Select the level that contains the members
you want to see in the query’s result.
Based on the measure Lists all measures in the cube on which the
query is based.
Select the measure in which to look for a
zero value.
With No Activity for Time dimension Lists all the time dimensions in the cube on
which the query is based.
Select the dimension that contains the
hierarchy to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected
dimension.
Select the hierarchy that contains the level to
display in the Level field.
Period level Lists all levels in the currently selected
hierarchy.
Select the level that contains the time
granularity for the from and to periods.

SAP NetWeaver Visual Composer Reference Guide 158


November 2006

Section Control Description


From Lists all members in the currently selected
level.
Select the beginning of the time period that
should have zero activity.
To Lists all members in the currently selected
level.
Select the end of the time period that should
have zero activity.

Example
You want to know which products did not sell at all in January. To create this query, configure
the values on this screen in the following manner:
Display Members Of section:
• Dimension = Product
• Hierarchy = Product
• Level = Product Name
• Based on the measure= Store Sales

With No Activity For section:


Time dimension = Time
Hierarchy = Time
Period level = Month
From = January
To = January

The result of this query is a simple table such as the following:

Products Not Sold: January

Product
Portsmouth Imported Beer
Top Measure Imported Beer
Fabulous Apple Drink
Great Cranberry Muffins
Great Muffins

SAP NetWeaver Visual Composer Reference Guide 159


November 2006

8.1.2.11 Heatmap Parameters


Use
Use the Configure Heatmap Parameters screen to configure parameters specific to the
Heatmap template. With this template, you can build queries that aggregate values of a
selected primary group and compare them with values of a secondary group by displaying the
results in boxes of differing sizes and colors.
Using heatmaps, a large quantity of results can be organized within boxes in a specifically
constrained space, making it easy to compare the major factors within a result set at a glance.
Both color intensity (shifting within a gradient) and size of the boxes indicate relative
performance, helping you to easily spot trends or standouts in a quick overview.
This template can address business questions such as the following:
What is the relative distribution of sales among certain divisions and companies?

You must configure the Internet Graphics Server URL in the Visual Administrator
to use the Heatmap template. See Configuring Optional Properties in the Visual
Administrator [External] in the SAP NetWeaver Visual Composer Installation &
Configuration Guide.

• You may only use one heatmap per model, and one per portal
page.
• In order to resize the display of the heatmap, follow the
procedure below in Resizing Heatmaps.

Structure
The main sections and controls of this screen are listed in the following table:
Section Control Description
Display Heatmap for Primary grouping Lists all the fields selected on the Select
Fields [Page 168] screen.
Select the field that should designate the
primary grouping (larger boxes). You may
select any data type.
Secondary grouping Lists all the fields selected on the Select
Fields screen.
Select the field that should designate the
secondary grouping (smaller sub-boxes).
You may select any data type.
Where Size is determined by Lists all the numeric fields selected on
the Select Fields screen.
Select the field that should determine the
relative size of the boxes.
Color is determined by Lists all the numeric fields selected on
the Select Fields screen.
Select the field that should determine the
relative color of the boxes.

SAP NetWeaver Visual Composer Reference Guide 160


November 2006

Resizing Heatmaps
Heatmaps are displayed in a special container in an HTML view. If you want to resize the
display of the heatmap, you must resize both the HTML view and the heatmap container
itself. Follow this procedure:
...

1. In the storyboard, double-click the URL port on the heatmap data service.
2. On the Configure Element task panel, in the Output Fields section, double-click the
URL field to modify it.
3. In the Compute Field field, change the width and height parameters in the URL.
4. Save the value.

Make sure that the HTML view and the heatmap container are the same size. To
see the size of the HTML view, go to the Layout tab and select the HTML view.
Its width and height are displayed in the pane below.

Example
You want to view the relative distribution of sales (both in quantity and revenue) among
certain divisions and companies. To do this, configure the values on this screen in the
following manner:

Display Heatmap for section:


• Primary grouping = Sales.Division (the Division field from the Sales table)
• Secondary grouping = Sales.Company (the Company field from the Sales table)

Where section:
• Size is determined by = Sales.Quantity (the Quantity field from the Sales table)
• Color is determined by = Sales.Revenue (the Revenue field from the Sales table)

For these values to be available in the drop-down lists on this screen, you must
first have selected them on the Select Fields [Page 168] screen.
The result of this query would generate a heatmap similar to the following:

SAP NetWeaver Visual Composer Reference Guide 161


November 2006

In this heatmap:
1. Instances of Division are represented by the large, primary boxes.
2. Instances of Company are represented by the smaller, colored boxes secondary to 1.
3. Instances of Sales in quantity are represented by the size of 2. The larger the box, the
higher the quantity.
4. Instances of Sales in revenue are represented by the color of 2, in a gradient. The
darker the color (towards the right side of the gradient legend – which might denote
millions of dollars), the higher the sales in revenue.
Although the display looks simple at first glance, note that sizes of both the primary and
secondary boxes are shown relative to each other, as well as the colors of the boxes (in a
relative gradient). You can compare how divisions are doing relative to each other, as well as
how companies are doing relative to each other.
It is easy in a heatmap to note standouts within a large pool of data. For example, in this
result:
• The company represented by the largest sub-box (in the Financials division in the
upper-left corner) has the highest sales in quantity.
• The company represented by the darkest sub-box (in the Industrials division) has the
highest sales in revenue.

8.1.2.12 Minimum/Maximum Parameters


Use
Use the Configure Minimum/Maximum Parameters screen to configure parameters specific to
the Minimum/Maximum template. With this template, you can build queries that find the
minimum or maximum value of a field and provide details from the row that holds that value.
This template can address business questions such as the following:
Which store has the smallest revenue; where is that store and who is the manager?

Structure
The main sections and controls of this screen are listed in the following table:
Section Control Description
Select criteria Smallest Indicates that the value should be the smallest (minimum).
Largest Indicates that the value should be the largest (maximum).
Select field Lists all fields in any table selected on the Select Fields [Page 168] screen.
Select the field in which to search for the smallest or largest value.
Although the fields you selected with Select Fields determine which fields will
appear in the result, you can base your minimum or maximum requirement on
any field in the table. The field you select does not have to be a numeric data
type.

SAP NetWeaver Visual Composer Reference Guide 162


November 2006

Example
You want to know which store has the smallest revenue, where the store is, and who the
manager of the store is. To find this out, you configure the values on this screen in the
following manner:
...

1. Since you want to see the store, city, and manager’s name in the result, you have
already used the Select Fields screen to select the Store, City, and Manager fields from
a table called Sales.
2. On this screen, select the Smallest radio button.
3. From the Field drop-down list, select the Sales.Revenue field (the Revenue field from
the Sales table).

The result of this query is one row displayed in a table such as the following:

Smallest Revenue: Store Details

Store City Manager


NotSoSuperStore Palo Alto Jones

The result shows that NotSoSuperStore had the smallest revenue, and the fields (columns)
displayed in the table are those that you configured on the Select Fields screen. Note that you
do not actually need to see the Revenue field in the result, since you know the query result
will show you the record with the minimum value for Revenue.

8.1.3 Select a Cube


Use
Use this screen to select the cube upon which to base your query.

Structure
The main sections of this screen are listed in the following table:
Section Description
Available Cubes Lets you look for a cube or browse the cubes catalog. See Find Data
Services Task Panel [Page 73] for a description of the similar Look for
functionality.
The data service tree lists the system you selected on the Select a
System [Page 133] screen as the root node in the tree, followed by any
catalogs contained in that service, followed by any cubes contained in
the catalog.
Description Displays the description of the selected cube, if available.
Properties Displays properties for the selected cube, if available.

SAP NetWeaver Visual Composer Reference Guide 163


November 2006

8.1.4 Define Filters


Use
Use this screen to define single filter values and filter ranges. A filter is a set of criteria that
restricts the set of records returned as the result of a query. With filters, you define which
subset of data appears in the result set.

Defining filters is usually optional, but depending on the template you have
chosen it may be an important step. For the Percentage Share template, for
example, you usually need to define filters in order for the business logic to work
correctly.

Structure
The main sections and controls of this screen are listed in the following table:
Section Control Description
Æ button Transfers a selected member to the Selected
Filter Values list. Repeat to define additional filter
values. You may create individual filter values
with members from different levels, hierarchies,
or dimensions.
Range Æ button Defines a filter range:
...

1. Select a start member (to indicate the start


of the range).
2. Click Æ to transfer it to the Selected Filter
Values list.
3. From the same level in the metadata
hierarchy, select the end member of the
range.
4. Click Range Æ.
The end member’s name is appended to the
name of the start member in the Selected Filter
Values list, indicating that the range is active.
Å button Removes a selected filter or filter range from the
Selected Filter Values list.
Clear button Removes all values from the Selected Filter
Values list
Browse tab Lets you navigate within a metadata hierarchy to
the desired member.
Dimension Lists available dimensions in the selected cube.
Hierarchy Lists available hierarchies in the selected
dimension.
Metadata list Lists available metadata in the selected
hierarchy. Expand the desired level and locate
the member or members desired.

SAP NetWeaver Visual Composer Reference Guide 164


November 2006

Section Control Description


Search tab Allows you to search for a specific member within
a selected level. Useful if you are having trouble
locating a specific member in your data service,
or if you have expanded a level with too many
members to display in the list.
Dimension Lists available dimensions in the selected cube.
Hierarchy Lists available hierarchies in the selected
dimension.
Level Lists available levels in the selected hierarchy.
Search Type the name of the member you wish to find
into this field. The field also functions as a drop-
down list, which you can use to select from the
history of searched members.
Search button Searches for the member entered in the Search
field.
Metadata list Displays a list of members found, with both
Caption and Unique Name
Selected Lists the selected individual filter values or filter
Filter Values ranges.
Filter Details Displays details about a selected filter or filter
range.

SAP NetWeaver Visual Composer Reference Guide 165


November 2006

8.1.5 Select a Table


Use
Use this screen to select the table upon which to base your query.

Structure
The main sections of this screen are listed in the following table:
Section Description
Available Tables Lets you look for a table or browse the tables catalog. See Find Data
Services Task Panel [Page 73] for a description of the similar Look for
functionality.
The data service tree lists the system you selected on the Select a
System [Page 133] screen as the root node in the tree, followed by
any catalogs contained in that service, followed by any schema
contained in the catalog, followed by any tables in the schema.
Table Description Displays the description of the selected table, if available.
Table Properties Displays properties for the selected table, if available.

8.1.6 Design a Layout


Use
Use this screen to design the layout for your Freeform OLAP query results. The Freeform
template is a special template that walks you through defining a query without the constraint
of a particular business question. On this screen, you select from available measures (key
figures), dimensions, and levels and place them into either rows or columns. You can also
optionally specify sort conditions for dimensions or levels.

Structure
The main sections and controls of this screen are listed in the following table:
Section Control/Sub-section Description
Cube Data Lists the metadata for the cube you
selected on the Select a Cube [Page
163] screen, in tree format. At the
root of the tree is the cube, followed
by dimensions (including the special
measures and time dimensions),
followed by available hierarchies,
levels, and members.
Select a measure, dimension, or level
to place in either rows or columns.
Selected Data -- Rows Æ button Transfers the measure, dimension, or
level selected in the Cube Data list to
the rows. You can create multiple
rows in the query definition, as long
as the metadata for each row comes
from a different dimension.

SAP NetWeaver Visual Composer Reference Guide 166


November 2006

Section Control/Sub-section Description


Å button Clears the selected data from the
query definition.
Clear button Removes all objects in the Selected
Data -- Rows list from the query
definition.
Rows Lists all objects currently selected to
appear on the rows.
Selected Data -- Columns Æ button Transfers the measure, dimension, or
level selected in the Cube Data list to
the columns. You can create multiple
columns in the query definition, as
long as the metadata for each
column comes from a different
dimension
Å button Clears the selected data from the
query definition.
Clear button Removes all objects in the Selected
Data -- Columns list from the query
definition.
Columns Lists all objects currently selected to
appear on the columns.
Properties Caption Review the caption of the metadata
selected in one of the Selected Data
lists to help you determine sort
conditions.
Unique name Review the unique name of the
metadata selected in one of the
Selected Data lists to help you
determine sort conditions.
Type Review the type (dimension, level, or
measure) of the metadata selected in
one of the Selected Data lists to help
you determine sort conditions.
Sort by Select from the available metadata to
specify sort conditions. Any
dimension members in the query can
be sorted either by one of its
attributes (caption, name, or unique
name) or by any measure.
Sort order Select whether to sort in Ascending
or Descending order on the metadata
selected in Sort by, above.

SAP NetWeaver Visual Composer Reference Guide 167


November 2006

8.1.7 Select Fields


Use
Use this screen to select the fields upon which to base your query. You may select fields from
different tables in your data service (note that you must select fields from at least two different
tables to use joins). There is no limit to the number of fields you may select.
Selecting fields typically determines which fields will be displayed in the result. For the Count
(relational) template, the order in which you select the fields is also important because it
determines grouping (see Example, below).
When using the Heatmap template, at least two of the fields you select must be numeric.

Structure
The main sections and controls of this screen are listed in the following table:
Section Control Description
Æ button From the Available Tables and Fields list,
transfers a selected field, or all fields in a
selected table, to the Selected Values list.
Å button Removes a selected field from the Selected
Values list.
Clear button Removes all fields from the Selected
Values list.
Available Tables and Fields Lets you look for a table or browse the
tables catalog. See Find Data Services
Task Panel [Page 73] for a description of
the similar Look for functionality.
The data service tree lists the system you
selected on the Select a System [Page
133] screen as the root node in the tree,
followed by any catalogs contained in that
service, followed by any schema contained
in the catalog, followed by any tables in the
schema.
Select individual fields or tables.
Selected Values Lists the fields selected in the query,
including their Table, Column, and Type
identifiers.

Example
You are using the Count (relational) template to determine how many employees each
manager is responsible for, and how many are part-time or full-time employees. To find out,
you use the Count template and select the Manager field, and then the Type field from the
Employees table. This query counts all occurrences in groups, with one group per selected
field.
The result of such a Count query is a table such as the below:

SAP NetWeaver Visual Composer Reference Guide 168


November 2006

Count Query With Grouping: Configuration One

Manager Type Count


Miller Full-time 38
Miller Part-time 3
Jackson Full-time 10
Jackson Part-time 1
Sullivan Full-time 16

Note that the order in which the fields appear in the Selected Fields list is important. The
results are first grouped by the first field, then by the second field, and so on.
If you had first selected Type and then Manager from the Employees table, the order of the
columns above would be reversed, grouping the result first by employment type, then by
manager, as in the table below:

Count Query With Grouping: Configuration Two

Type Manager Count


Full-time Miller 38
Full-time Jackson 10
Full-time Sullivan 16
Part-time Miller 3
Part-time Jackson 1

SAP NetWeaver Visual Composer Reference Guide 169


November 2006

8.1.8 Configure Joins


Use
Use this screen to create or delete joins. Since multiple tables are required for joins, you must
have selected fields from multiple tables on the Select Fields [Page 168] screen in order to
configure joins. If you have only selected fields from one table, this step is bypassed.

• This is an optional step.


• The type of join created with this step is an inner join (intersect).

Structure
The main controls of this screen are listed in the following table:
Control Description
Left Field Lists all fields from all the tables selected on the Select Fields [Page 168]
screen. Select the join field for the left table.
Operator Lists operators that specify how the left and right fields should be compared.
Available operators are:
= (Equal to)
> (Greater than)
< (Less than)
>= (Greater than or equal to)
<= (Less than or equal to)
<> (Not equal to)
Right Field Lists all fields from all the tables selected on the Select Fields screen. Select
the join field for the right table. The Left Field and Right Field selections
must be from different tables.
Add Adds the join configured by the Left Field, Operator, and Right Field lists to
the Joins list. You may add as many joins as you want.
Joins list Lists the currently configured joins.
Delete Deletes a selected join from the Joins list.

SAP NetWeaver Visual Composer Reference Guide 170


November 2006

8.1.9 Configure Filters


Use
Use this screen to create or delete (relational) filters.

This is an optional step.

Structure
The main controls of this screen are described in the following table:
Control Description
And/Or Specifies and/or conditions for multiple filters. The And/Or
control is enabled after the first filter has been added.
Select from the following values for second and subsequent
filters:
• And: This filter’s condition must apply.
• Or: This filter’s condition is handled after any And
filters.
Field Lists all fields from all the tables selected on the Select
Fields [Page 168] screen. Select the field for which to
configure the filter.
Operator Lists operators that specify how the Field entry and the
corresponding Value entry should be compared. Available
operators are:
= (Equal to)
> (Greater than)
< (Less than)
>= (Greater than or equal to)
<= (Less than or equal to)
<> (Not equal to)
is between (Is between)
is like (Is like)
is null (Is null)
Value Enter the value to which to compare the field. The value can
be either numeric or text.
And (Is between operator only) If you have selected Is between as your operator, enter the
end value for your range.
Add Transfers the filter to the Filters list.
Filters list Lists the currently configured filters.
Delete Deletes a selected filter from the Filters list.

SAP NetWeaver Visual Composer Reference Guide 171


November 2006

8.1.10 Specify the Sort Order


Use
Use this screen to specify or delete sort orders for specific fields, and to arrange entries
according to priority.

This is an optional step.

Structure
The main controls of this screen are listed in the following table:
Control Description
Field Lists all fields selected on the Select Fields [Page 168] screen. Select the
field for which to specify a sort order.
Order Allows you to specify Ascending or Descending order for the field selected
above.
Add Transfers the sort configuration to the Sort list. You may add as many sort
configurations as you wish.
Sort list Lists the currently configured sort configurations.
Up Increases the priority of the entry selected in the Sort list.
Down Decreases the priority of the entry selected in the Sort list.
Delete Deletes the entry selected in the Sort list.

8.1.11 Review Output


Use
Use this screen to review the query you have defined and see a preview of its result in a
table.

Structure
The main sections of this screen are described in the following table:
Section Description
Description Confirms the values you have selected from your data service in a
descriptive phrase of the result.
Output Displays results of the query, listed in the columns you have configured using
the wizard. The display is limited to a maximum of fifteen rows of the result.

SAP NetWeaver Visual Composer Reference Guide 172


November 2006

8.2 SQL Editor


Use
Use the SQL Editor to create new relational data services or edit the SQL statements of
existing relational data services. You can edit the SQL statements of relational data services
that have been created by the BI Integration Wizard, dragged from the Find Data Services
Task Panel [Page 73], or generated by the SQL Editor itself.
The SQL statement is available as a field on the Input port of the corresponding relational
data service.

For security purposes, SQL Editor functionality is turned off by default in Visual
Composer. Therefore, if you try to access it you will see the message "You are
not authorized to use this functionality."
See Security Risks with the SQL Editor and MDX Editor [External] in the SAP
NetWeaver Visual Composer Security Guide for more information.

• See the prerequisites described in the notes in BI Menu Dialog


Boxes [Page 131].
• The SQL Editor is not available for SAP Query data services
(services defined based on the BI SAP Query Connector).
To create a new relational data service using the SQL Editor:
...

1. Create an iView and drill into it.


2. Choose BI → SQL Editor.
3. See the reference below.
After you save your statement and close SQL Editor, you return to the workspace where a
new relational data service has been configured with the SQL statement you’ve created.
To edit the SQL statement of an existing relational data service:
...

1. In the workspace on the Design board, select the relational data service, and from the
context menu, choose SQL Editor (alternately, choose BI → SQL Editor).
2. See the reference below.

Structure
The main sections and controls of the SQL Editor are described below:
Section Control Description
Object Browser Browse tab Lets you browse or look for and select relational
data. See Find Data Services Task Panel [Page
73] for a description of the similar Look for
functionality for relational systems.
Select any type of relational metadata, and drag it
to the Editor pane, or double-click to add it at the
current cursor location. The unique name of the
selected metadata is added to the statement.

SAP NetWeaver Visual Composer Reference Guide 173


November 2006

Section Control Description


Syntax Examples tab Provides syntax templates, organized into several
categories, with which to build your SQL
statement.
Select a syntax example, and drag it to the Editor
pane, or double-click to add it at the current
cursor location. Replace the objects in brackets
(<< >>) with selected metadata from your data
service.
Editor Editor icons
Cut – Cuts text selected in the Editor pane.

Copy – Copies text selected in the Editor


pane.

Paste – Pastes at the current cursor location.

Undo – Reverts the last action.

Redo – Repeats the last action.

Validate – Checks your SQL statement and


lets you know if it is valid. The editor lets you
save statements even if they are invalid.

Run – Runs your statement to preview its


result. Generates a table of the result in the
Preview section.
Editor pane Displays the current SQL statement and lets you
edit it using the following methods:
Type directly into the pane.
Transfer metadata objects or syntax examples
from the Object Browser.
Use the editor icons.
Preview Displays a table of the results. Generate the
preview using the Run icon. Maximize or restore
the pane by clicking the up (Expand) or down
(Collapse) arrows.
Save Saves your statement and closes the editor.
Close Closes the editor without saving.

SAP NetWeaver Visual Composer Reference Guide 174


November 2006

8.3 MDX Editor


Use
Use the MDX Editor to create new OLAP data services or edit the MDX statements of existing
OLAP data services. You can edit the MDX statements of OLAP data services that have been
created by the BI Integration Wizard, dragged from the Find Data Services Task Panel [Page
73], or generated by the MDX Editor itself.
The MDX statement is available as a field on the Input port of the corresponding OLAP data
service.

For security purposes, MDX Editor functionality is turned off by default in Visual
Composer. Therefore, if you try to access it you will see the message "You are
not authorized to use this functionality."
See Security Risks with the SQL Editor and MDX Editor [External] in the SAP
NetWeaver Visual Composer Security Guide for more information.

See the prerequisites described in the notes in BI Menu Dialog Boxes [Page
131].
To create a new OLAP data service using the MDX Editor:
...

1. Create an iView and drill into it.


2. Choose BI → MDX Editor.
3. See the reference below.
After you save your statement and close MDX Editor, you return to the workspace where a
new OLAP data service has been configured with the MDX statement you’ve created.
To edit the MDX statement of an existing OLAP data service:
...

1. In the workspace on the Design board, select the OLAP data service, and from the
context menu, choose MDX Editor (alternately, choose BI → MDX Editor).
2. See the reference below.

Structure
The main sections and controls of the MDX Editor are described below:
Section Control Description

SAP NetWeaver Visual Composer Reference Guide 175


November 2006

Section Control Description


Object Browser Browse tab Lets you browse for and select OLAP metadata within
the selected system. To help narrow your search,
restrict your criteria to a certain type of metadata using
the Criteria drop-down list:
• Schema
• Cube
• Dimension
• Hierarchy
• Level
• Member
If using a Criteria selection, select metadata from
additional drop-down lists as required (required fields
are denoted by red asterisks).
Select any type of OLAP metadata and drag it to the
Editor pane, or double-click to add it at the current
cursor location. The unique name of the selected
metadata is added to the statement.
Syntax Provides syntax templates, organized into several
Examples tab categories, with which to build your MDX statement.
Select a syntax example and drag it to the Editor pane,
or double-click to add it at the current cursor location.
Replace the objects in brackets (<< >>) with selected
metadata from your data service.
Editor Editor icons
Cut – Cuts text selected in the Editor pane.

Copy – Copies text selected in the Editor pane.

Paste – Pastes at the current cursor location.

Undo – Reverts the last action.

Redo – Repeats the last action.

Validate – Checks your MDX statement and lets


you know if it is valid. The editor lets you save
statements even if they are invalid.

Run – Runs your statement to preview its result.


Generates a table of the result in the Preview section.
Editor pane Displays the current MDX statement and lets you edit it
using the following methods:
• Type directly into the pane.
• Transfer metadata objects or syntax examples
from the Object Browser.
• Use the editor icons.

SAP NetWeaver Visual Composer Reference Guide 176


November 2006

Section Control Description


Preview Displays a table of the results. Generate the preview
using the Run icon. Maximize or restore the pane by
clicking the up (Expand) or down (Collapse) arrows.
Save Saves your statement and closes the editor.
Close Closes the editor without saving.

The MDX Editor cannot create a preview of results that consist of a


single cell, such as the result of the statement SELECT FROM
<<cube>>. You may save such a query, but the resultant data
service will not have input and output ports.
If you use the MDX Editor to save changes to data service generated
using the BI integration wizard’s Zero Activity template, your
result will be changed to a horizontal display (results listed
across columns) instead of a vertical display (results listed in
rows).

SAP NetWeaver Visual Composer Reference Guide 177


November 2006

9 Expression Editor
Definition
The Expression Editor is a dialog box displayed in a wide range of configuration tasks in order
to enable you to define a formula for a specific dynamic behavior.

Use
The expressions defined through the Expression Editor are evaluated at runtime, according to
the actual values returned in the runtime workflow. Expressions can be written for all element
attributes of the “formula“ or “expression“ type. This includes field initialization, calculation,
validation and text formatting, as well as display visibility and event guard conditions. The
expression syntax was designed for ease-of-use by non-programmers, being very similar to
that used to write spreadsheet formulas.
The dialog box is displayed when you:
• Click a Formula or Condition button

• Choose Enter formula from a drop-down list (which includes the fx symbol)
For full instructions about how to use the Expression Editor, see Define a Dynamic
Expression [External] in the SAP NetWeaver Visual Composer Modeler's Guide.

Structure
The Expression Editor dialog box is named differently according to the attributes being
defined. For example:
• When defining a Visibility condition in the Configure Element task panel, it is called the
Hiding Condition dialog box.
• When defining properties in the Control Properties dialog box, it is called, among other
names:
{ Computed Value dialog box (when defining a formula in the Expression field of
the General tab)
{ Dynamic Label dialog box (when defining a formula in the Label field of the
Display tab)
• When defining actions in the Create Toolbar Buttons dialog box, the Expression Editor
is called, among other names:
{ Search Formula dialog box (when defining a system-action expression in the
Search formula field)
{ Prompt Message dialog box (when defining a system-action expression in the
Prompt message field)
In all cases, the structure of the Expression Editor is the same and contains the following
sections:
• The Formula pane at the left, in which you construct the dynamic expression.
• The Assistant pane at the right, listing the available basic formulas, which you select
(and enter into the Formula pane) by double-clicking.
The Data Fields node at the top contains all of the fields available in the different model
components, for use in your formula.
The Operators node at the bottom lists all the operators available for use in the formula.

SAP NetWeaver Visual Composer Reference Guide 178


November 2006

• The Check button at the bottom right is important for checking the validity of your
formula before you enter it into the field. (Only after validating your formula should you
click OK to close the Expression Editor.)
• The Message corner at the bottom left displays the responses when you click Check.

SAP NetWeaver Visual Composer Reference Guide 179


November 2006

10 Create Toolbar Buttons Dialog Box


Definition
You use this dialog box to create, in a table or other UI component, a collection of buttons that
initiate different actions in the workflow, such as adding a row in a table, displaying a popup
window or closing a window.

Use
This dialog box is displayed when you right-click a component and choose Create Toolbar
from the context menu. You can display the dialog box on either the Design board or the
Layout board.
For an explanation of the procedure for creating a runtime toolbar, see Create a Toolbar
[External] in the SAP NetWeaver Visual Composer Modeler's Guide.

Structure
To create toolbar buttons, you use the buttons at the bottom left of the dialog box, naming
each button in the Button text field at the top. The buttons that you create are listed in the
Toolbar Buttons pane at the left.
Once you have added and named the toolbar button, you define the action assigned to the
button exactly as you do in the Control Properties dialog box. The contents of this dialog box
change according to the type of action you define for the button:
• A System action is a predefined event, such as closing a window or inserting a row.
You select the specific action from the System action drop-down list.
• A Custom action is a specialized action that you define, defining the name of the event
in the Custom action field
The options for defining these types of actions are described fully in Control Properties -
Action Tab [Page 102].
The following table describes the controls and fields of this dialog box:
Section Control Description
[Bottom left] Adds a new button to the toolbar

Removes the selected button from the toolbar

Moves the selected button one place up (to the left) in the
toolbar configuration
Moves the selected button one place down (to the right) in
the toolbar configuration
Adds a separator bar to the toolbar

Define Button Button text The text appearing on the button, which should
correspond to the event name defined for the connector
line
Define Action See Control Properties - Action Tab [Page 102]

SAP NetWeaver Visual Composer Reference Guide 180

You might also like