SAP NetWeaver Visual Composer Reference Guide
SAP NetWeaver Visual Composer Reference Guide
SAP NetWeaver
Visual Composer
Document Version 1.00 – August 2008
HTML, XML, XHTML and W3C are trademarks or registered Any Java™ Source Code delivered with this product is only to be
®
trademarks of W3C , World Wide Web Consortium, used by SAP’s Support Services and may not be modified or
Massachusetts Institute of Technology. altered in any way.
JavaScript is a registered trademark of Sun Microsystems, Inc., Documentation on SAP Service Marketplace
used under license for technology invented and implemented by You can find this documentation at
Netscape. service.sap.com/instguidesNW04
Visual Composer has been designed according to the following prime considerations:
• Simplicity
• Reusable components
The building blocks implemented in the models ensure consistency in functionality
Wand 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.
To understand the role of this manual in the Visual Composer documentation set, see How to
Use this Guide.
Be sure to read SAP Note 1169887 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.
Structure
The following table lists the functions of each main menu option:
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.
Structure
The default toolbar contains the following options:
Button Description
Displays the Open Model dialog box for selecting the model to
(Open Model) open. See Opening a Model in the SAP NetWeaver Visual
Composer Modeler's Guide.
Saves the changes made since the last Save. See Saving a Model
(Save Model) in the SAP NetWeaver Visual Composer Modeler's Guide.
Opens the Save New Version dialog box for saving the open model
(Save New Version) as a new version of the original model. See Save New Version.
Button Description
Cancels the last action performed in Storyboard. (You can set the
(Undo)
number of undo levels in the Model tab of the Options dialog box.
See Options Dialog Box.
After you have drilled down in a model, returns you to the previous
(Back) level.
After you have drilled down and returned to a higher level, drills
(Forward) down to the last level.
Compiles the model in the selected runtime code. Click View source
(Compile Model) code in the Deploy to Portal task panel to display the compiled file.
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.
Structure
The workspace can contain up to four boards, displaying different views of the model:
Board Use
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 [External]) for detailed descriptions of the contents of each toolbox.
• Source toolbox
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:
Button Description
Standard pointer.
(Pointer)
Zooms into the board incrementally with each mouse click. Note
(Zoom In) 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.
Zooms out on the board incrementally with each mouse click.
(Zoom Out) 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.
Moves the entire board with the cursor.
(Hand Tool)
Magnifies the element in the area you define by dragging the
(Zoom Tool)
mouse.
Adds a text block for writing notes (design-time only).
(Annotation Tool)
Displays the layers and transitions only.
(View Level 1)
Displays the layers and transitions, and the layer contents (what
(View Level 2) the user sees).
Displays the full model logic.
(View Level 3)
Displays the elements in the workspace in high/low quality.
(High Quality)
Shows/hides the workspace grid.
(Show Grid)
Provides a "magnifying glass" for magnifying the part of an
(Show Magnifier ) element under the magnifying circle.
Button Description
Moves selected element(s) to the top layer of layout.
(Bring to Front)
Moves selected element(s) to the bottom layer of layout.
(Send to Back)
Displays a context menu for aligning the selected elements.
(Align Controls)
Displays a context menu for distributing the selected elements.
(Distribute Controls)
Resizes the selected UI element (view) so that its contents fit
(Fit to Contents) properly within the view, without unneeded space.
Resizes the width of the view to match the width of the iView.
(Fit to Window)
Shows/hides the workspace grid.
(Show Grid)
Displays the outlines of the model elements as dashed lines.
(Wireframe)
This feature is not yet implemented.
(Arrange Drawing)
Button Description
Wraps the text lines to fit the viewing window. If not selected, use
(Wrap Lines)
the horizontal scrollbar to view the text.
• New Model
• Open Model
• Save As
• Save New Version
• Manage Model Versions
• Manage Models
• Print
• Export to File
• Import from File
• Unlock Models
Structure
The fields of the dialog box are listed in the following table:
(New Folder) Creates a new folder within the currently open folder
Model 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
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.
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
The Save As dialog box is displayed when you choose Model Save As .
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
Structure
The dialog box is used to enter a description of the latest version of the open model.
Field/Control Description
Structure
The dialog box displays a list of the different versions along with their details, as follows:
Field/Control Description
Description Description of the changes made to the specific version, added in the
Save New Version dialog box
Revert Closes the currently-open model, opens the selected model and
makes it the current version
Cancel Closes the dialog box without opening a previous version of the model
Structure
The tree structure displays the hierarchy of folders and models residing on the Visual
Composer server. You can move models by dragging-and-dropping them from their to the
appropriate destination anywhere in the Local Repository (including between the MyModels
and Public repositories). You use the buttons of the toolbar to perform the following actions
on the selected tree item:
Button Description
Opens the Create New Model dialog box for creating a new model at
(New Model) the path you define.
Creates a new folder in the selected open folder.
(New Folder)
Opens the selected model in Storyboard.
(Open Model)
First, displays a confirmation message ensuring that you want to
(Delete Model ) delete the selected folder or model. If you answer Yes, the item is
removed from the tree structure and deleted from the server.
Activates the text of the selected item so that you can type in a new
(Rename) name.
(Search) Displays the Search for Models and Folders dialog box to locate
models and folders in the Local Repository.
4.7 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 [External].
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.
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 If you check this option, the contents of the selected model are
package into this integrated into the open model. If you leave the box unchecked, the
model model is imported in a package (folder) so that you can open it
separately.
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 check boxes, 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
Clear all Clears the checks from all boxes of the listed model
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. To open a task panel, click the
relevant task-panel toolbar button at the far right (default) of the Storyboard desktop.
The task panels in this version of Visual Composer have been defined for use with freestyle
application modeling. The task panels are:
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.
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
This task panel displays groups of options for starting your modeling. Under Open an Existing
Model, a tree hierarchy is displayed to enable you to access all models available to you on
the Visual Composer server. The MyModels folder contains models that you have created.
The Public folder contains models that have been created for access by all users. To
search for a model in the Local Repository, you can click the (Search) button at the top
right of the task panel and use the Search for Models and Folders dialog box to locate the
model you need.
Under Recently Used Models, a list of up to the last five most recently-opened models is
displayed for fast access to the most-recently opened models.
To create a new model, you can use the Create a new model option in the Related Tasks list,
opening the Create New Model dialog box (see New Model).
You can also use the Manage models link under Related Tasks at the bottom. This opens the
Manage Models dialog box (see Manage Models).
The Online Resources list provides links to both Visual Composer documentation and to the
Visual Composer forum on SAP Developer Network (SDN).
You can display the Get Started task panel at any time during your modeling by clicking the
Start button at the bottom of the task panel toolbar..
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 [External]
• Search Model Task Panel [External]
Structure
The Browse Model task panel includes the following elements:
• Hierarchical tree
• Display options:
Detailed tree Expands the nodes to display all elements within the model, down to
component level (not included are operators and connectors).
Top-level Collapses all nodes to display only the top-most items, such as
elements only package, page or iView.
• Sort by options:
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.
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
To display the search model, click Search in 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 combo box The partial or complete text of the element(s) you are searching
for. To mask a name, use an asterisk (*).
You can also search for model elements using their reference ID
codes rather than their names. To locate an element ID, select
the element and open the Configure Element task panel. At the
bottom left of the panel, the ID is displayed as follows: REF:
<ID>.
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
Field/Control Description
Option button Displays additional search options, listed in the following rows.
Search entire model Searches both high-level and lower-level nodes of the model.
checkbox
Case-sensitive search Search only for text listed exactly as in the Look for field.
checkbox
Full-text search checkbox Searches through all text at all levels of the model.
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..
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 in the SAP NetWeaver Visual Composer
Modeler's Guide.
Structure
The following table describes the elements available in the different Compose Model task
panels:
You can filter the display of elements in the task panel by using the (Options) drop-down
menu at the top center. The options available in the menu are:
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 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.
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.
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 26].
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
Field/Control Description
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.
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.
You can display the Configure Element task panel in one of three ways:
• Right-click the element and choose Configure Element from the context menu.
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 in the SAP NetWeaver Visual Composer
Modeler's Guide.
Structure
Each model element and connecting line on the Design board 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:
• Use keyblock:
• Structure keyblock:
5.4.1 Annotation
A design-time-only "note" or descriptive text added to the Design board.
This element is added using the (Annotation Tool) 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:
Emphasized Bold
Italics
Underline
Fill color Displays a color palette for selecting the background color of
the annotation block
Group: Components
Structure
The following table describes the properties and attributes of this model element:
Time period From date The field in the back-end system from which the
field start date is retrieved and displayed in the
calendar
Left
Right
None
Show all Displays all legend items coming from the back-
end system, regardless of the data currently
displayed on the calendar
Formatting Week Show Adds the number of each week to the calendar
numbers
Hide Hides the number of each week
Layout Fit contents Auto Automatically sizes the contents of the view
according to its size defined on the Layout board
Transparent No frame
Group: Components
For more information about creating a chart, see Create a Chart in the SAP NetWeaver Visual
Composer Modeler's Guide.
Structure
The following table describes the properties and attributes of this model element:
Chart View Chart title The title displayed at the top of the chart. You can
either enter a title in the field, or click the browse
button (ellipsis) at the right to open the Edit Title
dialog box and specify a title using a dynamic
expression.
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
Data series Clustered For bar or column charts, compares the values of a
category by depicting one next to the other
Area contour Slope The edges of the area are drawn smoothly
and Line
contour Curve The edges of the area are drawn as sharper corners
Pie labels Auto Inserts the value inside the pie or doughnut segment
if possible
None No label
Inner radius For doughnut charts, the radius of the hollow part of
the doughnut
Category Field The field whose values are used as the categories of
Axis the chart
Axis label A name for the category axis. You can either enter a
title in the field, or click the browse button (ellipsis) at
the right to open the Edit Title dialog box and specify
a title using a dynamic expression.
Value Axis Axis label A name for the value axis. You can either enter a title
in the field, or click the browse button (ellipsis) at the
right to open the Edit Title dialog box and specify a
title using a dynamic expression.
Value range Auto-adjust Determines the points and increments of the value
axis according to the resulting values
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 Same as the range slider, but the value axis begins
range slider at the Minimum value rather than at 0
• Apply to:
o Entire chart
• Apply to:
o Entire chart
• Apply to:
o Entire chart
Left
Right
None
Grid display Default For HTMLB, this indicates "no grid display"
Layout Fit contents Auto Automatically sizes the contents of the view
according to its size defined on the Layout board
Transparent No frame
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
Table at # Series ID
bottom
Data Series Name of the data series (category) axis
Structure
The following table describes the properties and attributes of this model element:
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
Curved
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
Curved
When you drag out from the input port of a data service in order to create the input
element, the fields are mapped automatically..
Structure
The following table describes the properties and attributes of this model element:
Data Event name The name of the action that raises the
Mapping event for transferring the data to the
data service
Mapping scope All data rows Transfers to the data service all of the
(appears only if Multiple is table rows
selected in the Selection
modedrop-down list. See Selected data Transfers to the data service only table
Table View) rows rows selected by the user
Curved
Group: N/A
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 for more information about preparing your back-end systems.
Structure
The following table describes the properties and attributes available in different types of
systems:
System The alias defined for the system in the portal system
alias landscape
System The alias defined for the system in the portal system
alias landscape
System BI system name, which you can edit in case you move
the model to a different system environment
System BI system name, which you can edit in case you move
the model to a different system environment
Read mode Master Offers all values of the selected characteristic that
Data appear in the master data table. Since InfoCubes may
Table 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.
System System name, which you can edit in case you move
the model to a different system environment
System System name, which you can edit in case you move
the model to a different system environment
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
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
Group: Operators
Structure
The following table describes the properties and attributes of this model element:
Filter Equals "text" Value of the text field exactly matches the
defined text
Does not equal “text” Value of the text field differs from the defined
text”
Starts with "text" Value of the text field begins with the defined
text
Does not start with Value of the text field does not begin with the
"text" defined text
Ends with "text" Value of the text field ends with the defined text
Does not end with Value of the text field does not end with the
"text" defined text
Contains "text" Value of the text field contains the defined text
Does not contain Value of the text field contains text that differs
"text" from the defined text
"text1" or "text2" Value of the text field contains either one text or
another text
Not "text1" or "text2" Value of the text field contains neither the first
text nor the second text
"text1" and "text2" Value of the text field contains both of two
defined texts
"text1" and "text2" Value of the text field contains both of two
defined texts
"text1" and "text2" Value of the text field contains both of two
defined texts
Not "text1" or not Value of the text field either does not contains
"text2" the first defined text or else does not contain
the second defined text
[none] No filter
Group: Components
Structure
The following table describes the properties and attributes of this model element:
Form View Form title Name of form. You can either enter a title in the
field, or click the browse button (ellipsis) at the right
to open the Edit Title dialog box and specify a title
using a dynamic expression.
Editing Indicates whether users can enter data into the form
condition and change displayed data at runtime. Enter true
or false to specify whether the form view is
editable, or click the fx button to define the
expression that specifies under which condition the
form view is editable at runtime.
Layout Fit contents Auto Sizes the contents of the view according to system
default settings
Place labels Before Places the labels to the left of the form's fields and
controls
Transparent No frame
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
Structure
The following table describes the properties and attributes of this model element:
[none]
Group: Components
• 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:
HTML HTML title Name of the view. You can either enter a title in the
view field, or click the browse button (ellipsis) at the right
to open the Edit Title dialog box and specify a title
using a dynamic expression.
Transparent No frame
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
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
5.4.17 iView
A diagram for defining a portal iView.
Group: Components
Structure
The following table describes the properties and attributes of this model element:
Portal iView Window type Primary window A standalone window or source window for
other windows
5.4.18 Layers
A mechanism for grouping components that are shown or hidden together at runtime.
Group: Components
For more information about building layered iViews, see How to . . . Create Layered iViews 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:
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
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
Fade In/Out
Zoom In/Out
Roadmap Show all steps For wizards, displays both main and substeps
steps
Show main steps For wizards, displays only main steps
Tab Name For tab strips, link lists and link trees, the layer
name, displayed in the tab
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
5.4.20 Model
Definition
The top-level model component (diagram), on which packages, pages and iViews can be
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
Group: Connectors
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:
Input Fields Fields input from the connected form to the target
iView
Group: Components
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:
Nested Window title Name of the iView within the source iView. You can
iView either enter a title in the field, or click the browse
button (ellipsis) at the right to open the Edit Title
dialog box and specify a title using a dynamic
expression.
Layout Fit contents Actual size Automatically sizes the contents of the view
according to its size defined on the Layout board
Transparent No frame
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
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
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
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
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
Group: Connectors
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:
Popup Window title Display name of the popup view. You can either enter
Signal a title in the field, or click the browse button (ellipsis) at
the right to open the Edit Title dialog box and specify a
title using a dynamic expression.
Target iView Name of iView to which the point connects. You can
either enter a title in the field, or click the browse
button (ellipsis) at the right to open the Edit Title dialog
box and specify a title using a dynamic expression.
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.
Group: Operators
Structure
The following table describes the properties and attributes of this model element:
Sigma COUNT Totals the number of field values that are not
blank
[none]
Use
Group: Operators
Model level: iView
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Use
Group: Connectors
Model level: iView
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
The dataset from which the subtraction is made (the "first" dataset) is that which is transferred
to the topmost input port of the operator.
Structure
The following table describes the properties and attributes of this model element:
Be sure to connect the dataset from which the subtraction occurs to the top port of
the Subtraction operator.
Structure
The following table describes the properties and attributes of this model element:
You add and remove ports on the operator by right-clicking the operator icon on the
Design board and choosing Add Port or Remove Port from the context menu. You
can add an unlimited number of ports.
Group: Components
Structure
The following table describes the properties and attributes of this model element:
Table view Table title Name of the table. You can either enter a title in the
field, or click the browse button (ellipsis) at the right
to open the Edit Title dialog box and specify a title
using a dynamic expression.
Editing User can enter data into the table and change
condition displayed data. Indicates whether users can enter
data into the form and change displayed data at
runtime. Enter true or false to specify whether
the table view is editable, or click the fx button to
define the expression that specifies under which
condition the table view is editable at runtime.
Wrap text If checked, text the table header and in the table
cells automatically wraps as needed.
Layout Fit contents Actual size Sizes the contents of the view according to its size
defined on the Layout board
Transparent No frame
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
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.
5.4.34 Timer
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.
Group: Connectors
Structure
The following table describes the properties and attributes of this model element:
Initial delay Delays the start of the timer count according to the
amount of time intervals specified.
5.4.35 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
Curved
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
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
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
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:
Display All formulas Formulas of any type defined for any element of the model
Scope Collapse list Displays the name of each element that contains a formula
Expand list Displays the elements along with each formula that they
contain
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.
For more information about the process of adding data services to your model, see Find Data
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:
SAP BI Look for list Look for a query Enables you to search for a specific query
System by entering its name in the Query field.
SAP System Look for list Look for a service Enables you to search for a specific data
by name service by entering its name in the Service
field.
OLAP Look for list Look for a cube Enables you to search for a specific query
System by entering its name in the Cube field.
Relational Look for list Look for a table Enables you to search for a specific table
System by entering its name in the Table field.
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.
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.
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 Portsgroup, 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.
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:
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.
Field/Control Description
New Folder Name Field in which to enter a name for the new
folder.
Integration
You can perform other Favorites activities on the Find Data Services task panel.
To browse for and select a Favorite:
...
On the Find Data Services Task Panel [External], select an SAP BI data service.
In the Look for drop-down list, select Display favorites.
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:
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.
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. You must enter values into the mandatory fields (displayed in red with an
asterisk). Click Execute at the bottom left to display the results of the query, Clear to remove
the results from the right pane, and Close to close the 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.
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 in the SAP NetWeaver Visual Composer
Modeler's Guide.
Structure
The following controls and fields are used in the task panel:
Control/Field Description
Deploy entire If selected, deploys the entire model (regardless of the level displayed on
model the Design board), otherwise deploys only the part of the model currently
displayed.
Compile If selected, compiles only those iViews that have been modified. This is
changed iViews useful with nested iViews and enhances performance significantly. If option
only is not checked, compiles entire model.
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.
Control/Field Description
Icon Description
(Preview) Displays the portal content area of the model only (without the
masthead and the navigation panel). This option is faster than the
Run Model option (following). Flash runtime only.
The Last Deployment header displays a link to the runtime component from the last
deployment, if any. When you click this link, all relevant pages and primary iViews that were
previously deployed are retrieved from the portal PCD automatically, with a time stamp..
Integration
The contents of the model are packaged into standard PAR files, one file per iView.
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.
• 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:
For a description of all of these items, see Available Controls and Fields.
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:
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.
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. 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:
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:
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:
Italic
Small
No label
Toggle Label only Toggle button Displays the label text without
button the button border
Layout Position All controls except Offset from top left, in pixels
(pxls) Text editor
At runtime, the system checks the Language value in the Personalize attributes and if the
language is right-to-left reading, adapts the alignment of the controls accordingly..
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 format None Progress Fills the bar with color according to
bar the relative amount of the task
range completed.
Button Description
Add a style
For an example of how to define a set of styles using the Styles tab, see Using Exceptions in
Your Model in the SAP NetWeaver Visual Composer Modeler's Guide.
Structure
The following table describes the properties configured in this tab:
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:
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 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.
Example:
Example
entry list, select it and click (Global Entry List)at the right.
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 [External]). 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 [External]).
Structure
The following table describes the controls and fields in the dialog box:
Control/Field Description
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
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
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.
Button Description
Add a style
Structure
The following table describes the properties configured in this tab:
Value [none]
column
head Type textType Enter a specific value,
numberType such as 'Chicago'
dateType time (note the single quotation
marks) or 10
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 in the SAP NetWeaver Visual Composer Modeler's Guide
(for the procedure) or Image Manager 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
Displays the Image Manager dialog box for adding images to the
Upload button
Image Library.
The image is displayed in its original size. Its edges are cut off if the
Original size
control size is smaller than the image dimensions.
You can use this tab to define one of two types of actions:
• A “custom action” is a specialized action that you define, by choosing Custom action
from the popup menu and entering the name for the action in the Action Name
column of the new row.
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.
For each field and control, you can define a sequence of actions. To do so, add the actions to
be executed for the control, and use the arrow buttons in the toolbar above the action list to
arrange the actions in the proper sequence.
Structure
The following table describes the controls and fields that are displayed in the tab, according to
your selection in the popup menu of system actions:
Clear Form Removes the values currently displayed in the input fields of an
element. Useful, for example, in a Submit sequence of actions.
Delete Row Deletes the current object and moves the cursor to the next object.
Export Data At runtime, copies data to the Clipboard and displays a dialog box
that lets the user choose to display the data according to column
heading or field name. In charts, displays the data series, one
table for each axis.:
• Export row
• Export element – Exports contents of entire view
• Export selected elements – Exports selected content
• Export window - Exports contents of entire window
Export Data Copies selected data to Clipboard and pastes it into a displayed
to Excel Excel worksheet according to the following Action Properties:
• Export row
• Export element – Exports contents of entire view
• Export selected elements – Exports selected content
• Export window - Exports contents of entire window
Find Row Looks for the next object in the dataset that matches the
expression defined in the field in the Action Properties section. 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 cyclical manner.
History Back Navigates back one step through the target element’s history.
Hyperlink Opens the document at the URL address specified in the field in
the Action Properties section.
Insert Row Inserts a new row and moves the cursor to the new object,
selected according to the following Action Properties:
• Insert after
• Insert before
• Insert first
• Insert last
Move Row Moves to a new row position, selected according to the following
Action Properties:
• Move after
• Move before
• Move first
• Move last
Prompt Displays the message defined in the field in the Action Properties
section, 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 Action Properties:
• First row
• Last row
• Next row
• Previous row
• Row number (selected from spinner)
Show Page Scrolls the dataset so that the specified page is brought into view,
according to the following Action Properties:
• 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 field
in the Action Properties section.
Action Read-only field displaying the defined formula for the action.
code
[other UI
component in
iView]
Validation None Defines the controls that will undergo validation once the action is
scope triggered:
Self
• None – No validation occurs.
Element For example, a Cancel action requires no validation.
• Self – Validates only the control that invokes the action.
Window • Element – Validates all controls in the UI element (such as
form or table) that contains the control that invokes 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 – Validates all controls displayed in the window
containing the control that invokes the action.
For example, controls in components such as forms, but
not nested iViews or popups, and in the selected layer, will
be validated.
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
Boldface font
Italic font
Underlined font
Font color
Align to left
Align to center
Align to right
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:
...
Select the type of value help to add on the Add Value Help for Selected Input Field screen
Select the data service that provides the values on the Select Data Service screen
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:
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.
You can base the value help list on any type of 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.
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.
Example
See Integrating Value Help into Your Model [External], in the SAP NetWeaver Visual
Composer Modeler’s Guide.
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 [External].
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.
Structure
The following table lists the options in the wizard for printing your documentation:
Include in Top-level Design Prints only the diagram(s) displayed on the Design
documentation board diagrams only board.
Model elements and Prints information about the model (for example,
properties 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.
You use this dialog box, accessed by choosing Tools Entry List Manager , to create
three types of lists:
• 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 “How to . . .”
Create an Entry List 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:
o Static List: for details, see Control Properties - Entry List Tab
o Dynamic List: for details, see Control Properties - Entry List Tab
Each list is shown in the Entry Lists pane above the buttons. When you click on a list,
the details about it are displayed to the right, for viewing and/or editing.
• Rename: Activates the name for you to edit the existing one
You create a value help entry list in two steps provided by the wizard:
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:
• 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:
Description Review the description, if available, of the object selected in the data
service tree.
Find data used in If checked, search for values within the dimension
cube only (SAP BI table. If unchecked, all values of the selected
systems only) characteristic that appear in the master data table are
retrieved.
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 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..
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 in the SAP NetWeaver Visual Composer Modeler's Guide.
Structure
The main parts of the Image Manager dialog box are:
• The display pane, for showing the images contained in the library
• The fields and buttons at the bottom, for locating and adding the images
Control Description
Activates the name of the selected image for you to edit it.
Opens the standard Choose file dialog box for you to locate the image that you
Browse want to add. When you click Open, the dialog box is closed and the file name is
displayed in the field at the bottom.
Enters the image named in the field into the library, displaying a thumbnail in the
Upload
display pane.
• Rename a system alias if a model has been ported between servers that have
different aliases for the same back-end system
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 in the SAP NetWeaver Visual Composer Modeler's Guide.
Structure
The following table describes the main controls of the System Alias Manager dialog box:
Select Select "<name>" Alias Selects all instances of the selected alias
[table] Alias column header Alias currently defined for the system in the System
Landscape editor of your portal
Used in column header Name of the iView containing a data service within
the named system
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
URL requires User and Password Defines that the web service requires user
checkbox authentication
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
ACTIVITYTEXT2
ACTIVITYTEXT3
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).
ESCALATED Boolean value indicating whether the alert has been escalated.
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.
RECIPIENTS List of people who received the alert. There can be multiple people
in this list.
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.
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:
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
Cancel Closes the dialog box and cancels all changes made since
the last time you clicked Apply
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:
The following buttons, at the bottom of the dialog box, are available for all of the tabs
together.
Button Description
Restore Defaults Cancels all changes and restores default values for all tabs
Optimize for Selects the configuration parameters that provide optimal speed of
Speed operation
Structure
Option Description
Used to automatically display the last model worked on when you next
Reload last model
access Visual Composer. If this is not selected, you need to open a model
at startup
each time you access the application.
Maximum undo Number of times that you can consecutively click the Undo/Redo toolbar
levels buttons ( Edit Undo/Redo ).
Structure
Group Option Sub-Option Description
Interaction Show drag-and- Displays the animated shape of the object you
drop sprite are dragging.
Highlight shapes Highlights the border of the icon as you run the
under mouse mouse over it.
Curved
Medium
Large
Structure
Option Sub-Option Description
Ask for user These three options are used to limit the amount
intervention when of unneeded data that may ultimately be
creating: handled by the model.
Data services with X fields/port or Y Displays the Define Data Service dialog box for
more than ports you to select the ports and fields to be included
in the data service that you are adding.
Components with Z fields Displays the Select Display Fields dialog box to
more than select only those fields of the form or table that
are needed at runtime.
Connectors with more X fields Displays the Select Input Fields or Select Output
than Fields dialog box when dragging out and
creating a connector, in order to limit the number
of fields channeled through the connector
When editing All fields Displays the fields in the Configure Element task
elements with many panel.
fields, initially show:
Selective fields
Modeling Suggest next steps Displays the Next Step tips for guiding you
through your modeling.
Structure
Option Sub-Option Description
Task panel Right Positions the task panels either at the right or the left of the
workspace
Left
Toolbox Top Positions the main toolbar either horizontally at the top or
position bottom of the workspace, or vertically at the right or left of the
Bottom workspace
Right
Left
Windows mode Maximized Standard Windows options for displaying multiple windows of
the workspace
Cascading
windows
Horizontal
tiles
Vertical tiles
Maximum Single Only one window can be displayed at the same time
windows
5, 10, 20, 25 Number of windows that can be open at the same time
Structure
Option Sub-Option Description
PAR name prefix The prefix of all PAR files created by Visual Composer
Portal deployment The path to the Portal Catalog folder that will include
folder the compiled files
Portal system folder The path to the Portal Catalog folder where new
systems will be created
Data service Cache retrieved Caches the data services found in the Find Data
retrieval services (for fast Services task panel
retrieval)
Do not cache Retrieves the same data services each time rather than
data services caching them
(get latest)
Deploy model with Deploys the PAR file with the model, so that a portal
PAR user can open the model in Storyboard, directly from
the portal PCD (using the Open in Storyboard option).
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 which
prevents it from fulfilling the required task
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.
A short summary of some of the major differences between standard OLAP and SAP BI terms
follows:
dimension characteristic
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.
See the prerequisites described in the notes in BI Menu Dialog Boxes [Page
136].
Use
...
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 [External]: Table at bottom).
Structure
Reference topics for available wizard screens are listed below:
• Select a System [Page 139]
• Select a Query Template [Page 139] (includes links to template configuration
subtopics)
• Select a Cube [Page 172]
• Define Filters [Page 172]
• Select a Table [Page 174]
• Design a Layout [Page 175]
• Select Fields [Page 177]
Example
See Use the BI Integration Wizard [External] and Creating a BI iView [External] in the SAP
NetWeaver Visual Composer Modeler’s Guide.
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
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 139]). 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
Sample Business Question Displays the sample business question associated with the
selected query template.
Aggregation
Count For a selected level, Sales returns for See Count Parameters
counts members MyCompany equal [Page 143].
contributing to a $25,000. How many
specific measure. product lines does this
represent?
Percentage Share Calculates the share What percentages do See Percentage Share
that selected members Canada and Mexico Parameters [Page
represent within the represent of my total 153].
sum of the level sales?
members, and
expresses this as a
percentage.
Dynamic Calculation
Cumulative Total Cumulates the value What is my monthly See Cumulative Total
of a measure over a year-to-date expense Parameters [Page
specific date range. total? 146].
Moving Average Calculates the What are the average See Moving Average
average values of manufacturing costs of Parameters [Page
selected measures products A and B for 149].
based on specified Q2 and Q3, based on
time periods 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 159].
members of a last year and this
particular level year?
compared with their
rank from a previous
period.
Top N Calculates the rank of Who are my top ten or See Top N Parameters
a level based on a bottom ten customers? [Page 161].
specific measure.
Trend
Trend Over Time Displays the trend of a What is the trend in See Trend Over Time
specific measure for a my gross margin over Parameters [Page
selected member over the past few years? 163].
time.
Variance
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 155].
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 166].
past, but which have
had no sales in a
specified time period.
All Data Selects all records What are all the Not applicable.
and all fields as the available grade levels
final result, without and their details?
any filters or joins.
Count (not available for Counts all How many employees See Select Fields
SAP Query systems) occurrences of a is each different [Page 177] for an
certain type of data in manager responsible example.
a group or groups for?
within a table.
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.
With measure ... Lists all measures in the cube on which the
not equal to zero 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 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.
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.
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:
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.
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 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.
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
The data used to cumulate the total, together with the result of this query (the shaded cells),
are shown in the tables below:
Part A 25 15 10 10 10 5
Part B 20 10 5 5 10 15
Part C 5 5 5 5 10 5
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.
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
Display 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.
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
The data used to calculate the moving average, together with the result of this query (the
shaded cells), are shown in the tables below:
Part C $5 $5 $5 $5 $5
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.
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
Between Base and Time dimension Lists all the time dimensions in
Comparison Periods the cube on which the query is
based.
Select the dimension that
contains the hierarchy to
display in the Hierarchy field.
Example
The result of a Percentage Growth query is displayed in a table with five columns such as the
below:
Wine 20 60 40 200%
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.
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
Example
The table below illustrates the difference between basing the result on all level members and
basing the result on filtered level members:
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.
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
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.
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.
Measure for comparison Lists all measures in the cube on which the query is based.
Select the measure for which you want to compare planned
vs. actual values. For example, Profit.
Planned / Actual dimension Lists all dimensions in the cube on which the query is based.
Select the dimension that contains the hierarchy to display in
the Planned / Actual hierarchy field.
Planned / Actual hierarchy Lists all hierarchies in the currently selected planned / actual
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.
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 level Lists all levels in the currently selected version hierarchy.
Select the level that contains the members to display in the
Version field.
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:
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
Between Base and Time dimension Lists all the time dimensions in
Comparison Periods the cube on which the query is
based.
Select the dimension that
contains the hierarchy to
display in the Hierarchy field.
Example
The result of a Rank Change query is displayed in a table with five columns such as the
below:
Wine 1500 6 1 5
Beer 1300 8 2 6
Juice 800 1 3 -2
• 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.
• Next, it calculates the Top N results for those same members in the comparison period
(Rank Comparison Period column).
• Finally, the query computes the difference between the base and comparison period
ranks, and delivers that value in the Rank Difference column.
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 and In this section, use the checkboxes to include top, bottom, or
Values both 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 Count Select this option to
type 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 Count Select this option to
type 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.
Hierarchy Lists all hierarchies in the
currently selected dimension.
Select the hierarchy that
contains the level to display
in the Level field.
Example
For a step-by-step example, see Creating a BI iView [External] in the SAP NetWeaver Visual
Composer Modeler’s Guide.
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
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.
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
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
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.
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
Product
Great Muffins
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 177]
screen.
Select the field that should
designate the primary
grouping (larger boxes). You
may select any data type.
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:
...
In the storyboard, double-click the URL port on the heatmap data service.
On the Configure Element task panel, in the Output Fields section, double-click the URL field
to modify it.
In the Compute Field field, change the width and height parameters in the URL.
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:
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 177] screen.
The result of this query would generate a heatmap similar to the following:
In this heatmap:
Instances of Division are represented by the large, primary boxes.
Instances of Company are represented by the smaller, colored boxes secondary to 1.
Instances of Sales in quantity are represented by the size of 2. The larger the box, the higher
the quantity.
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.
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 field Lists all fields in any table selected on the Select Fields [Page
177] 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.
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.
The result of this query is one row displayed in a table such as the following:
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.
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 [External] for a description of the similar
Look for functionality.
The data service tree lists the system you selected on the Select a
System [Page 139] screen as the root node in the tree, followed by
any catalogs contained in that service, followed by any cubes
contained in the catalog.
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
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.
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 [External] for a description of the similar
Look for functionality.
The data service tree lists the system you selected on the Select a
System [Page 139] 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.
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
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
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:
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:
Full-time Miller 38
Full-time Jackson 10
Full-time Sullivan 16
Part-time Miller 3
Part-time Jackson 1
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 177] screen in order to
configure joins. If you have only selected fields from one table, this step is bypassed.
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
177] 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.
Use
Use this screen to create or delete (relational) filters.
Structure
The main controls of this screen are described in the following table:
Control Description
Field Lists all fields from all the tables selected on the Select Fields
[Page 177] 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.
Use
Use this screen to specify or delete sort orders for specific fields, and to arrange entries
according to priority.
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 177] 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.
Down Decreases the priority of the entry selected in the Sort list.
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.
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.
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).
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
[External] 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.
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.
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
136].
To create a new OLAP data service using the MDX Editor:
...
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).
See the reference below.
Structure
The main sections and controls of the MDX Editor are described below:
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.
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.
9 Expression Editor
The Expression Editor is a dynamic dialog box displayed in a wide range of configuration
tasks in order to enable you to define a formula for a specific dynamic behavior.
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.
• Choose Enter formula from a drop-down list (which includes the fx symbol)
For full instructions about how to use the Expression Editor, see “How to . . .” Define a
Dynamic Expression 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:
o Computed Value dialog box (when defining a formula in the Expression field
of the General tab)
o 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:
In all cases, the structure of the Expression Editor is the same and contains the following
sections:
• The Expression 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 Expression 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.
• The Help pane at the bottom right, activated when you click on a formula or drag it
into the Expression pane. The Help pane displays an explanation of the function
along with an example.
• 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.
This dialog box is displayed when you right-click a component and choose Create Toolbar
from the context menu, or when you click the Edit button to the right of the Toolbar field in the
Configure task panel. 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 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 name 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 Action tab of the Control Properties dialog box. The contents
of this dialog box change according to the type of action you define for the button:
• A “custom action” is a specialized action that you define, by choosing Custom action
from the popup menu and entering the name for the action in the Action Name
column of the new row.
The options for defining these types of actions are described fully in Control Properties -
Action Tab.
The following table describes the controls and fields of this dialog box:
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
Define Button The text appearing on the button, which should correspond to the
Button name event name defined for the connector line
Structure
The Edit Title dialog box contains the following options:
Option Description
Default The static title for the model element. The default title is displayed for the
element on the Design board. It is also displayed for the element on the
Layout board, if a custom title is not defined. At runtime, the default title is
used if you do not define a custom title.
Custom The title for the model element. A custom title can contain dynamic
expressions and is created dynamically at runtime. It is used at runtime as
the element title. If you define a custom title, the title [Custom] is used for
the element on the Layout board. The custom title is not used for the
element on the Design board; in this case, the default title is used.