VC Reference Guide
VC Reference Guide
SAP NetWeaver
Visual Composer
Document Version 1.00 – January 2007
Document History
Document version Description
V 1.0 SAP Library release of document, with SPS 11. The following section
was updated since the SPS 10 release:
Options Dialog Box → Options – Compiler Tab: addition of the
Enable styling of Flex controls in portal themes checkbox
Be sure to read SAP Note 919388 for the latest information about
limitations, known issues, and workarounds for SAP Visual Composer.
You can find the SAP Note at SAP Service Marketplace at
service.sap.com/notes.
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:
Save Model Saves the changes made since the last Save. See Saving a
Model [External] in the SAP NetWeaver Visual Composer
Modeler's Guide.
Manage Models Opens the Model Browser, for performing different operations
such as creating a subfolder, and opening, deleting and
renaming a model. See Using the Model Browser [External] in
the SAP NetWeaver Visual Composer Modeler's Guide.
Print Prints the model diagram currently displayed in Storyboard.
See Print the Model [External] in the SAP NetWeaver Visual
Composer Modeler's Guide.
Cut Deletes the selected item.
Undo Cancels the last action performed in Storyboard. (You can set
the number of undo levels in the Model tab of the Options
dialog box. See Options Dialog Box [Page 125].
Redo Restores the last action undone in Storyboard.
Back After you have drilled down in a model, returns you to the
previous level.
Forward After you have drilled down and returned to a higher level,
drills down to the last level.
Parent Returns you to the top level of your iView.
Compile Model Compiles the model in the selected runtime code. Click View
Integration
These icons also appear next to the left of the main menu options.
To customize the main toolbar – changing the position of buttons, and adding and deleting
others – see Customize Toolbar [Page 124].
Structure
The workspace can contain up to four boards, displaying different views of the model:
Board Use
Design Constructing your model
Layout Customizing the layout of iViews
Source Reviewing the code that is automatically generated by Storyboard as
you build your model
The various boards are available according to the model component you are working with.
Each board has its own toolbox, which provides a set of board-specific tools to assist you
with the tasks you perform on that board. See the following sections (from Workspace
Toolboxes [Page 9]) for detailed descriptions of the contents of each toolbox.
Use
By default, the toolbox appears at the bottom of the displayed board. You can change its
location or hide it by choosing Tools → Options → Workspace. You can customize each
toolbox by choosing Tools → Customize.
Structure
The following tables describes each of the buttons in the four toolboxes:
Zoom In Zooms into the board incrementally with each mouse click.
Note that you can also use the Fit, 1:1 and zoom value field at
the top right of the board to define your exact zoom view.
Zoom Out Zooms out on the board incrementally with each mouse click.
Note that you can also use the Fit, 1:1 and zoom value field at
the top right of the board to define your exact zoom view.
Hand Tool Moves the entire board with the cursor.
Zoom Tool Magnifies the element in the area you define by dragging the
mouse.
Annotation Tool Adds a text block for writing notes (design-time only).
View Level 2 Displays the layers and transitions, and the layer contents
(what the user sees).
View Level 3 Displays the full model logic.
Structure
The fields of the dialog box are listed in the following table:
Field Description
Name The unique name you give to the new model. Naming rules include:
• Only alphanumeric characters and underscores
• No spaces or punctuation marks
• No special characters
Path Read-only
To change the path, choose Model → Manage Models and in the Model
Browser dialog box, navigate to the location that you want to display as the
default path.
Integration
Once you click OK in the Create a New Model dialog box, the Storyboard workspace (Design
board) is displayed, with the Compose Model task panel at the right.
You can create models using the Model Browser dialog box (Model → Manage Models) as
well, navigating to the folder in which you want to create the model and clicking the New
Model button. See Manage Models [Page 13].
Structure
The Open Model dialog box – like the Model Browser – displays a tree hierarchy of the folders
and models on the Visual Composer server. There are two main nodes:
• MyModels includes the user models that you create in your client workspace.
• Public includes models created and saved for general use by all users.
To open a model, select it and click Open. If you decide to create a new model rather than
select an existing one, click New.
4.3 Save As
Definition
The Save As dialog box is displayed when you choose Model → Save As.
Use
You use the dialog box to save the open model under a different name, so that the original file
remains as it was when opened, without the recent changes you may have made.
You can also use the dialog box to save the file in a different location on the server. For
example, you may want to save a copy of your own model in the Public folder, so that other
users can have free access to the model.
Structure
The dialog box displays a tree hierarchy of the folders and models on the Visual Composer
server. You browse through the tree to indicate the location in which you want to save the
model. The main fields and controls of the dialog box are listed in the following table:
Field Description
Model Path Read-only.
Textually lists the path defined in the tree structure above.
Model Name A unique name for the new copy of the model.
Structure
The tree structure displays the hierarchy of folders and models residing on the Visual
Composer server. You use the buttons of the toolbar to perform the following actions on the
selected tree item:
4.5 Print
Definition
The Model → Print option generates a “printer-friendly“ version of the model, displayed in a
separate browser window.
Use
From the File menu of the browser window, choose Print. The standard Windows Print dialog
box is displayed. Click Print to print the displayed diagram.
See also Documentation Wizard [Page 113].
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.
Use
You can import models previously exported from Visual Composer Storyboard, and saved as
GML (Generic Modeling Language) files on a computer in the network or on the Storyboard
server.
Structure
The fields and controls of the dialog box are listed in the following table:
Field/Control Description
File Name Name of model to be imported. Use the Browse
button to locate the file.
Merge imported package into this model If you check this option, the contents of the
selected model are integrated into the open
model. If you leave the box unchecked, the
model is imported in a package (folder) so that
you can open it separately.
Use
In the Unlock Models dialog box, a list is displayed showing any models in your client
workspace that may have, for some reason, become locked. Using the checkboxes, you
select the models that you want to unlock.
Structure
The main fields and controls of the dialog box are listed in the following table:
Field/Control Description
Select all Checks the boxes of all the listed models
Clear all Clears the checks from all boxes of the listed model
5 Task Panels
The task panels are the panes to the right of the Storyboard workspace. They contain the
tools required to build your model, configure each model element, locate the data services,
and deploy the model.
You use the task panels in conjunction with the different workspace boards, and according to
the task you are performing for building your application.
The task panels in this version of Visual Composer have been defined for use with freestyle
application modeling. The task panels are:
• Get Started Task Panel [Page 16]
• Browse Model and Search Model Task Panels [Page 17]
• Compose Model Task Panel [Page 20]
• Configure Element Task Panel [Page 25]
• Find Data Services Task Panel [Page 73]
• Deploy to Portal Task Panel [Page 81]
At times, you may want to hide the open task panel in order to enlarge the available
workspace. To do so, click the X at the top right of the panel, or use the window splitter
between the workspace and the task panel to close it partially or entirely. You can reopen the
panel by moving the splitter to the left.
To move the task panel to the left of the workspace, choose Tools → Options → Workspace
tab, and from the Taskbar position drop-down list, choose Left.
Use
You can use the Get Started task panel as an alternative to the menu options (Model → New
Model and Model → Open Model) or the main toolbar options (New Model and Open Model).
Structure
In the main pane of the task panel, under Open an existing model, a tree hierarchy is
displayed of all models available to you on the Visual Composer server. In the MyModels
folder are models that you have created. In the Public folder are models that have been
created for access by all users.
Rather than select a model from the tree, you can use the Look for other models option under
Related tasks at the bottom. This opens the Open Model dialog box (see Open Model [Page
12]).
To create a new model, you can use the Create a new model option in the Related tasks list,
opening the Create a New Model dialog box (see New Model [Page 11]).
Use
You can use the Browse Model tree to modify the model hierarchy and to navigate through
the model. The Search Model task panel, accessed from the open Browse Model panel,
enables you to locate elements within the open model.
Structure
For details about each task panel, see:
• Browse Model Task Panel [Page 17]
• Search Model Task Panel [Page 19]
Structure
The Browse Model task panel includes the following elements:
• Drop-down lists for adjusting the display
• Hierarchical tree
• Sort by options:
Menu Option Description
Element type Orders the display according to the type of element. For
example, top-level elements are grouped by package, page
and iView, while the elements in expanded nodes are
grouped according to input forms, tables, data services and
so on.
Element name Orders each level of elements alphabetically.
The hierarchical tree displays the elements in the model, starting from the top-level elements:
packages, pages and iViews. Each top-level node can be expanded to display all the
elements contained in that node, according to the display and sort options from the drop-
down menus. You can use the tree to:
• Locate and view an element in the model, by double-clicking the element in the tree to
display it on the Design board
• Copy elements from a node, by dragging them to the target top-level node
• Rename an element, by double-clicking it in the tree, and then using the right-click
context menu
• Delete an element, by double-clicking it in the tree, and then using the context menu
Use
To display the search model, click Search Model at the bottom of the Browse Model task
panel. Using the fields and controls listed in the following section, define your search and click
Search. The results are displayed in the empty pane. When you double-click an item in the
results pane, the model area containing that item is displayed on the Design board and the
specific item is highlighted.
Structure
The Search Model task panel includes the following fields and controls:
Field/Control Description
Look for field The partial or complete text of the element(s) you are
searching for. To mask a name, use an asterisk (*).
Filter by drop-down list Limits the search defined in the Look for field according
to the following types of element:
None Model
BI and alert data service Nested iView
BI data service OLAP query
BI query Package
Black box Page
Characteristic Relational query
Chart view Rule
Data service SAP data service
Form view Table view
HTML view Web service
iView
Layer
For details about each type of element, see Compose
Model Task Panel [Page 20]
Search button Executes the search you define.
Clear button Deletes the results displayed from a previous search.
Option button Displays additional search options, listed in the
following rows.
Search entire model checkbox Searches both high-level and lower-level nodes of the
model.
Case-sensitive search checkbox Search only for text listed exactly as in the Look for
field.
Full-text search checkbox Searches through all text at all levels of the model.
Use
You build your model diagram by dragging the required icon from the Compose Model task
panel onto the Design board. Once you have placed certain elements on the board, you can
also drag out from their input or output ports and use the context menu to create the required
item.
If you drag out from a component that includes a large number of fields, the
Select Display Fields dialog box may be displayed, to enable you to limit the
fields that will be displayed in the form or table at runtime. For more information,
see Select Display Fields Dialog Box [Page 23].
When you create a new model or open an existing one, the Compose Model task panel
contains only icons for top-level elements: Package, Page and iView. As you drill down into
each element, the display in the task panel changes according to level.
Note also that the collection of elements displayed at iView level may change according to the
runtime environment that you select. To display only those model elements available in the
selected runtime (deploy) environment, choose Tools → Options → Compiler tab and check
the Mask Unsupported features option.
For more information, see Compose the Model [External] in the SAP NetWeaver Visual
Composer Modeler's Guide.
Structure
The following table describes the elements available in the different Compose Model task
panels:
Element
Group Name Name Description Model Level
iView A diagram for defining a portal Top
iView.
Page A diagram for composing Top
iViews on a portal page.
Package A “container“ for organizing Top
model elements into a portal
package.
Components Form view A single form for data entry iView
and selection.
Table view A tabular view of data, for iView
display and/or edit.
Element
Group Name Name Description Model Level
Chart view A range of chart types for iView
displaying data.
HTML view A container for displaying an iView
external HTML document.
Nested iView An iView within a selected iView
iView.
Layer A group of components that iView
are shown or hidden together
at runtime.
Connectors Start Defines a value to initialize the iView
flow.
End Defines the end of the flow. iView
Navigate Defines navigation to a iView
different iView.
Signal In Receives parameters from a iView
different iView.
Signal Out Sends parameters to another iView
iView.
Popup Signal Defines the flow of popup iView
data.
Timer Defines the timing of an event. iView
User Data Contains the personal data of iView
the user.
Data Store Temporarily stores data from iView
the model for later use.
Operators Filter Defines selection criteria for iView
retrieving and displaying data.
Sort Sorts data according to a iView
specified field.
Sigma Aggregates the values of all iView
the records into a single
record.
Upper Retains only the specified top iView
number of records.
Lower Retains only the specified iView
bottom number of records.
Distinct Omits records containing iView
duplicate data in the selected
fields. Note that the fewer
fields checked as distinct, the
fewer records are returned.
Element
Group Name Name Description Model Level
Additional Union Merges into a new dataset the iView
Operators data of two datasets, and
removes duplicates.
For examples about using each element, see the Compose the Model [External] section of
the SAP NetWeaver Visual Composer Modeler's Guide. For details about each element and
its properties, see Configure Element Task Panel [Page 25].
You can filter the display of elements in the task panel by using the \ drop-down menu at the
top center. The options available in the menu are:
Integration
Usually, you will use the Find Data Services task panel first, to add the main data services of
the model. Afterwards, you will use the Compose Model task panel to add model elements
not inserted into the model by dragging out from the data services. See the Developing
Business Logic [External] section of the SAP NetWeaver Visual Composer Modeler's Guide
for a description of the overall model-creation process.
For more information about the Find Data Services task panel, see Find Data Services Task
Panel [Page 73].
Structure
All the fields that can be output to the form or table are listed in the pane of the window.
Check the fields that should be included in the component. You can use the Select all and
Clear all checkboxes to facilitate the selection.
To define display fields for query information in a BI query, see Select Display Fields: Query
Information [Page 24].
Use
In the Select Display Fields dialog box, a list is displayed showing available query information.
Using the checkboxes, you select the query information that you want to display.
Structure
The main fields and controls of the dialog box are listed in the following table:
Field/Control Description
Select all Checks the boxes of all the information types.
Clear all Clears the checks from all boxes.
AUTHOR Author: The user who defined the query.
INFOCUBE InfoProvider: The InfoProvider that provides the data reported by the
query.
MODTIME Changed At: The time at which the query definition was last changed.
MODUSER Last Changed by: The user who last changed the query definition so
that the query has been regenerated.
REPTNAME Query Technical Name: Technical name for the query.
REPTXTLG Query Description: Description of the query.
ROLLUPTIME Status / Validity of Data: The point in time when data for the latest
request that can be used for reporting was posted to the InfoProvider.
This shows a date and a time (in the local time zone).
ROLLUP_DATE Relevance of the Data (date): The date of the ROLLUPTIME text
element.
ROLLUP_TIME Relevance of the Data (hour): The time of the ROLLUPTIME text
element.
SRDATE Key Date: The date for which time-dependent master data is selected.
SYUSER Current User: The user who has this query open.
SYUZEIT Last Refreshed: When the query data was last refreshed.
Example
See Adding Query Information to Your Model [External] in the SAP NetWeaver Visual
Composer Modeler's Guide.
Use
You can display the Configure Element task panel in one of three ways:
• Click the Configure button in the task-panel toolbar.
• Right-click the element and choose Configure Element from the context menu.
• On the Design board, double-click on the element.
The set of properties for each type of element differs, and many include tables at the bottom
of the task panel for mapping fields between elements.
For more information, see Configure Elements [External] in the SAP NetWeaver Visual
Composer Modeler's Guide.
Structure
Each model element and line defined in the Compose Model task panel can be configured in
the Configure Element task panel. However, note that:
• Layers are configured within the framework of the iView in which they are created.
• Annotations, created from the Design board toolbox, can also be configured.
The following sub-sections detail all of the properties and attributes that can be configured for
each model element. The topics are arranged alphabetically for easy access. Each element is
described according to the following format:
• Definition keyblock:
Provides a short description of the model element.
• Use keyblock:
Provides the following information about the element:
{ Group in the Compose Model task panel
{ Model level at which it can be added to the model
{ Restrictions to its use, if any
• Structure keyblock:
Provides a table or tables with the following information:
{ Property: the model characteristic
{ Attribute: the metadata of the element property
{ Description: explanation of the property or attribute, if needed
5.4.1 Annotation
Definition
A design-time-only “note” or descriptive text added to the Design board.
Use
Free text inserted at any level of the model.
This element is added using the Annotation Tool button ( ) in the Design toolbox at the
bottom of the Design board. To insert it, click the button and click on the workspace at the
location you want to insert the annotation. Then type your text.
Structure
The following table describes the properties and attributes of this model element:
Property Attribute Description
Font style Normal Default
Emphasized Bold
Italics
Underline
Font size Given in points. Default size is 8
Alignment Left Aligns text to left
Right Aligns text to right
Center Centers each line of text
Fill color Displays a color palette for selecting the
background color of the annotation block
Use
Group: Components
Model level: iView
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Calendar view Calendar title Name of calendar
Time period From date field The field in the back-end system
from which the start date is
retrieved and displayed in the
calendar
To date field The field in the back-end system
from which the end date is
retrieved and displayed in the
calendar
Calendar range Auto Displays data starting from the
earliest record retrieved from the
back-end system
Fixed Displays data starting from the date
defined in the Calendar start field
Bound Adds (or subtracts) incrementally
one month to the date defined in
the Calendar start field to display
data starting from that date
Calendar start The first month displayed in the
Calendar view (applicable only
when selecting Fixed or Bound)
Legend Legend Below
placement
Above
Left
Right
None
Legend filtering Filter Displays only legend items
corresponding to the data currently
displayed on the calendar
Use
Group: Components
Model level: iView
For more information about creating a chart, see Create a Chart [External] in the SAP
NetWeaver Visual Composer Modeler's Guide.
...
...
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Chart view Chart type Area Calculates the interception point of
the X value and the Y value, filling
in the area below it, displaying the
trend of each value over time or
category
Bar Compares values across
categories, in a horizontal display
(with the category given in the
vertical, Y, axis)
Column Compares values across
categories in a vertical display (with
the category given in the horizontal,
X, axis)
Line Displays the results of a data series
as a continuous line drawn from
point to point (value to value) of the
X axis
Pie Shows how the values in a single
data series relate to the sum of the
results, with each value depicted as
a percentage of the total value
Doughnut Displays the results in a pie chart
that is hollow and may depict
multiple series
Combo A combination of column and line
chart
Data series Clustered For bar, column or combo charts,
compares the values of a category
by depicting one next to the other
Stacked For bar, column, line, area or
combo charts, shows the
relationship of each value of a
category as a part of a single bar or
line
Use
Group: Additional Operators
Model level: iView
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Combine Name Label for the operator
Operator
Table at bottom Type of data in field
Use
This connection line is defined directly on the Design board.
Model level: iView
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Data Binding Event name Disabled; not relevant
Guard condition Disabled; not relevant
Line style Straight Direct 45-degree line with no
corners
Angular Direct line
Curved
With right angles Line with 90-degree angles
(orthogonal)
[default] Orthogonal lines
Table at bottom Type of data in field
Use
This connection line is defined directly on the Design board.
Model level: iView
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Data Flow Event name Disabled; not relevant
Guard condition Disabled; not relevant
Line style Straight Direct 45-degree line with no
corners
Angular Direct line
Curved
With right angles Line with 90-degree angles
(orthogonal)
[default] Orthogonal lines
Table at bottom Type of data in field
When you drag out from the input port of a data service in order to create the
input element, the fields are mapped automatically.
Use
This connection line is defined directly on the Design board.
Model level: iView
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Data Mapping Event name The name of the action that raises the event
for transferring the data to the data service
Guard condition An expression indicating the condition that
must be satisfied in order for the event to be
activated
Mapping scope All data Transfers to the data service all of the table’s
rows rows
(appears only if
Multiple is Selected Transfers to the data service only table rows
selected in the data rows selected by the user
Selection mode
drop-down list.
See Table View
[Page 65])
Line style Straight Direct 45-degree line with no corners
Angular Direct line
Curved
With right Line with 90-degree angles (orthogonal)
angles
[default] Orthogonal lines
Table at bottom Type of data in field
Use
Group: N/A
Model level: iView
Restrictions: The list of available systems depends on what is configured in the portal and
how it is configured. For example, SAP BW systems 3.1C configured as OLAP systems using
the BI XMLA Connector are displayed as OLAP query data services in the workspace. SAP
BW systems 3.5 and higher configured with the SAP Java Connector, however, are displayed
as BI queries in the workspace. See the SAP NetWeaver Visual Composer Installation &
Configuration Guide [External] for more information about preparing your back-end systems.
Structure
The following table describes the properties and attributes available in different types of
systems:
Data Service Property Attribute Description
SAP Data Service Service name Name of the data
service as referred to
in Visual Composer
System alias The alias defined for
the system in the
portal system
landscape
System type Formal name of the
back-end system
Technical name Technical name
assigned to the data
service
Auto commit For function modules
that modify the
database, a second
“commit” call is
automatically sent to
confirm the database
update
Auto convert Indicates that a
conversion BAPI is
required, for values in
one unit of
measurement to
another
SAP Web service Service name Name of the web
service as referred to
in Visual Composer
Use
Group: Operators
Model level: iView
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Distinct Name Label for the operator
Operator
Table at bottom Type of data in field
Use
Group: Connectors
Model level: iView
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
End Point Name Label for the connector
Table at bottom Type of data in field
Use
Group: Operators
Model level: iView
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Filter Operator Name Label for the operator
Table at bottom Type of data in field
Use
Group: Components
Model level: iView
...
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Form view Form title Name of form
Editing mode Editable User can enter data into the form and
change displayed data
Read-only User can view displayed data only
Toolbar Show Adds a toolbar button area
Hide Hides the toolbar button area
Edit Displays the Create Toolbar Buttons
dialog box (see Create Toolbar Buttons
Dialog Box [Page 179])
Scroll buttons Show Adds a scrolling button area
Hide Hides the scrolling button area
Edit Displays the Page Scrolling Buttons
dialog box
Layout Fit contents Auto Sizes the contents of the view according
to system default settings
Actual size Sizes the contents of the view as defined
on the Layout board
Fit width Changes the contents of the view in
proportion to the form size
Align contents Absolute User can freely arrange the UI
components on the form (long labels may
not be fully shown at runtime)
Vertical Lines up the form’s UI components
vertically
Horizontal Lines up the form’s UI components
horizontally
Place labels Before Places the labels to the left of the form’s
fields and controls
Above Places the labels above the form’s fields
and controls
Use
Group: Additional Operators
Model level: iView
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Group Operator Name Label for the operator
Table at bottom Type of data in field
Use
Group: Components
Model level: iView
Be aware that all text written in the HTML View is not translated with the model.
...
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
HTML view HTML title Name of the view
Default URL URL of the HTML document to be
displayed
Toolbar Show Adds a toolbar button area
Hide Hides the toolbar button area
Edit Displays the Create Toolbar
Buttons dialog box (see Create
Toolbar Buttons Dialog Box [Page
179])
Layout Fit contents Auto Automatically sizes the contents of
the view according to its size
defined on the Layout board
Frame style Default Standard portal view frame
Primary frame Top border in standard color
White Top border in white
Neutral color Top border in lighter color
Dark color Top border in darker color
Transparent No frame
Frame title bar Displays view title
Collapsible Contents of view can be
frame hidden/displayed
Visibility [none] No conditions are given for
condition displaying the form in runtime, so
that it is automatically visible
true The form is visible when this value
appears in the formula defining
when the form is displayed, such as
Hidden, Required and so on
Use
Group: Connectors
Model level: iView
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Input Signal Name Label for the connector
EPCM Event URN of the other portal iView
Table at bottom Type of data in field
Use
Group: Additional Operators
Model level: iView
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Intersection Name Label for the operator
Operator
Table at bottom Type of data in field
5.4.17 iView
Definition
A diagram for defining a portal iView.
Use
Group: Components
Model level: Model (top level)
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Portal iView Window type Primary window A standalone window or source
window for other windows
Nested window A window that is designated to
display a nested iView within
another iView (see Nested iView
[Page 57])
Popup window A window that is designated to
display an iView activated by a
popup signal within another iView
(see Popup Signal [Page 60])
Window title iView name
Show title bar Display iView name in window
Fit contents Default Sizes the contents of the iView
according to system default
settings
Actual size Automatically sizes the iView
components according to its size
defined on the Layout board
Fit width Changes the size of the iView
components to fit the window’s
width
Fit height Changes the size of the iView
components to fit the window’s
height
Both Changes the size of the iView
components to fit the window’s
width and height
Layout method Auto Arranges the contents of the iView
according to system default
settings
Absolute User can freely arrange the
components of the iView
Vertical Lines up the iView components
vertically
5.4.18 Layers
Definition
A mechanism for grouping components that are shown or hidden together at runtime.
Use
Group: Components
Model level: iView
For more information about building layered iViews, see How to . . . Create Layered iViews
[External] in the SAP NetWeaver Visual Composer Modeler's Guide.
...
Structure
Layers are configured as part of the Portal iView model component. The following table
describes the properties and attributes that are relevant to configuring the layers only:
Group Property Attribute Description
Layers Navigation None Standard layers are used, without
control tabs or wizard steps (see Using
Standard Layers [External] in the
SAP NetWeaver Visual Composer
Modeler's Guide)
Tab strip Labeled tabs are used to enable the
user to navigate between layers
Wizard Numbered and labeled boxes are
used as steps and optional
substeps to navigate between
layers
Accordion A stack of collapsible panels is used
to display and hide the information
in each layer
Link list A horizontal row of link controls, like
tabs, is used to navigate between
layers
Link tree A hierarchical tree of
collapsible/expandable link controls
is used to display the content of the
layers to the right of the tree
Default layer For standard layers (None as
Navigation control), the Layer Name
(from the table at the bottom of the
task panel) that indicates the first
layer to be displayed
Default step For a wizard, the Step Name (from
the table at the bottom of the task
panel) that indicates the first layer
to be displayed
Use
Group: Operators
Model level: iView
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Lower-Range Name Label for the operator
Operator
Field Field whose values define the
range
No. of rows The number of records in the range
5.4.20 Model
Definition
The top-level model component (diagram), on which packages, pages and iViews are defined.
Use
Group: Components
Model level: Model (top level)
Using the Add (plus) button at the bottom, you can enter data describing the model in order to
create a model profile. When you click the button, the Model Property dialog box is
displayed. Define the property using the two controls:
• Name
Drop-down list of already-defined properties. To enter a property not defined, choose
Type text and enter a property name.
• Value
The attribute that you enter for the property
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Model Name Model (file) name
Comments Text describing model
Table at bottom Type of data field
Use
Group: Connectors
Model level: iView
When you drag the connector onto the Design board, the Select Target iView dialog box is
displayed, showing a hierarchical tree with the iViews currently available in your model. Two
options (radio buttons) are available for choosing the target iView:
• Select existing iView
Select one of the iViews shown in the tree; its name is displayed in the Name field
• Create new iView
In the name field, you can overwrite the New iView text and create a new target iView
of any name
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Navigation Point Name Label for the connector
Target iView Name of iView to which the point
connects
Table at bottom Type of data in field
Use
Group: Components
Model level: iView
When you drag the Nested iView icon onto the Design board, the Select Nested iView dialog
box is displayed, showing a hierarchical tree with the iViews currently available in your model.
Two options (radio buttons) are available for choosing the target iView:
• Select existing iView
Select one of the iViews shown in the tree; its name is displayed in the Name field
• Create new iView
In the name field, you can overwrite the New iView text and create a new nested
iView of any name
...
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Nested iView Window title Name of the iView within the
source iView
Target iView The source window in which the
nested iView is displayed
Toolbar Show Adds a toolbar button area
Hide Hides the toolbar button area
Edit Displays the Create Toolbar
Buttons dialog box (see Create
Toolbar Buttons Dialog Box [Page
179])
Layout Fit contents Auto Automatically sizes the contents of
the view according to its size
defined on the Layout board
Frame style Default Standard portal view frame
Primary frame Top border in standard color
White Top border in white
Neutral color Top border in lighter color
Dark color Top border in darker color
Transparent No frame
Frame title bar Displays view title
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Output Port Port name Label for the port
Dynamic port When selected, indicates that the
metadata of the data service
channeled through the port is
unknown (all data will be displayed
at runtime)
Capacity The maximum number of records
stored in the dataset.
Table at bottom Type of data in field
Use
Group: Connectors
Model level: iView
Deploy environment: All
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Output Signal Name Label for the connector
EPCM Event URN of the other portal iView
Table at bottom Type of data in field
5.4.25 Package
Definition
A “container“ for organizing model elements, such as pages and iViews, into a portal
package.
Use
Group: Components
Model level: Model (top level)
...
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Package Name Package (folder) name
Comments Text describing the package
5.4.26 Page
Definition
A diagram for composing iViews on a portal page.
Use
Group: Components
Model level: Model (top level)
...
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Portal Page Name Page name
Comments Text describing the page
Use
Group: Connectors
Model level: iView
When you drag the connector onto the Design board, the Select Popup iView dialog box is
displayed, showing a hierarchical tree with the iViews currently available in your model. Two
options (radio buttons) are available for choosing the target iView:
• Select existing iView
Select one of the iViews shown in the tree; its name is displayed in the Name field
• Create new iView
In the name field, you can overwrite the New iView text and create a new popup iView
of any name
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Popup Signal Name Label for the connector.
Target iView Name of iView to which the point
connects.
Modal window Indicates if the user can interact
with the popup window
independently of the source iView.
If the window is modal, the user
must close the popup window to
continue to work with the source
iView. If Modal window is not
checked, the user can continue
working in the source iView with the
popup window open.
Center window Indicates whether to center the
popup window in the middle of the
application screen when it is
opened.
Use
Group: Operators
Model level: iView
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Sigma Operator Name Label for the operator
Type of data in field
Use
Group: Operators
Model level: iView
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Sort Operator Name Label for the operator
Table at bottom # Sort priority
Type of data in field
Use
Group: Connectors
Model level: iView
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Start Point Name Label for the connector
Table at bottom Type of data in field
The dataset from which the subtraction is made (the "first" dataset) is that which is transferred
to the topmost input port of the operator.
Use
Group: Additional Operators
Model level: iView
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Subtraction Name Label for the operator
Operator
Table at bottom Type of data in field
Use
Group: Components
Model level: iView
...
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Table view Table title Name of form
Editing mode Editable User can enter data into the form
and change displayed data
Read-only User can view displayed data only
Selection mode Single User can select one row only
Multiple User can select multiple rows
Unselectable Read-only – users cannot select
any rows
Toolbar Show Adds a toolbar button area
Hide Hides the toolbar button area
Edit Displays the Create Toolbar
Buttons dialog box (see Create
Toolbar Buttons Dialog Box [Page
179])
Scroll buttons Show Adds a scrolling button area
Hide Hides the scrolling button area
Edit Displays the Page Scrolling Buttons
dialog box
Row colors Standard Initial display is a plain grid
Alternating Rows are displayed in alternating
dark-white pattern
Transparent No background grid
No. of rows Number of rows to display per page
Keep selected When a row is selected in a table
row and the table is refreshed with new
data, the focus remains on the
selected row, rather than moving to
the first row of the table.
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.33 Timer
Definition
A connector that defines the timing of an event. The timer may trigger any number of
execution flows in the component. Multiple timers, with different intervals, can be used in the
same component.
Use
Group: Connectors
Model level: iView
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Timer Name Label for the connector.
Interval Indicates the frequency, in minutes,
that the timer is evaluated.
Initial delay Delays the start of the timer count
according to the amount of time
intervals specified.
Guard condition Enables or disables the component
session according to the formula
entered. While the timer is disabled
the clock still keeps ticking, but no
timer events are generated.
Table at bottom Type of data in field.
5.4.34 Transition
Definition
A connecting line between two layers of a wizard or with standard layers, indicating the event
that must be invoked in order to trigger the transition from one layer to the other.
Use
This connection line is defined directly on the Design board.
Model level: iView
Structure
The following table describes the properties and attributes of this model element.
Group Property Attribute Description
Transition Event name
Guard condition Enables or disables the transition
to the next layer according to the
formula entered.
Line style Straight Direct 45-degree line with no
corners
Angular Direct line
Curved
With right angles Line with 90-degree angles
(orthogonal)
[default] Orthogonal lines
Use
Group: Additional Operators
Model level: iView
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Union Operator Name Label for the operator
Table at bottom Type of data in field
Use
Group: Operators
Model level: iView
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
Upper-Range Name Label for the operator
Operator
Field Field whose values define the
range
No. of rows The number of records in the range
Use
Group: Connectors
Model level: iView
Structure
The following table describes the properties and attributes of this model element:
Group Property Attribute Description
User Data Name Label for the connector.
Table at bottom Type of data in field.
Use
You access the task panel by drilling down into the iView and clicking the Inspect button in the
task-panel toolbar. According to the selections in the drop-down lists, formulas used
throughout the model or in the selected element are displayed.
Structure
The Inspect Formulas task panel includes the following controls:
Control Menu Option Description
Display All formulas Formulas of any type defined for
any element of the model
Computations All formulas and computations
defined in the General tab of the
Control Properties dialog box
Display state Formulas created to define Hidden,
Disabled, Required and Visibility
conditions (in the UI Control part of
the General tab of the Control
Properties dialog box or in the
Configure task panel)
Execution flow Formulas – such as Guard
conditions – defined for activating
events
Formatting Formulas defined in the Formatting
tab of the Control Properties dialog
box
Appearance Formulas defined in the Display tab
of the Control Properties dialog box
Validation Formulas defined in the Validation
tab of the Control Properties dialog
box
Scope Current Element Displays the name of each element
that contains a formula
Entire diagram Displays the elements along with
each formula that they contain
Refresh Refreshes the display of formulas
Use
You access the task panel by drilling down into the iView and clicking the Find Data button in
the task-panel toolbar. You then select the system alias of the back-end system in which the
data service resides, search for the data service and drag it onto the workspace.
When a data service includes a very large number of ports and fields, you may be prompted
to define the exact ports and fields that you want to include. For more information, see Define
Data Service Dialog Box [Page 77].
For more information about the process of adding data services to your model, see Find Data
[External] in the SAP NetWeaver Visual Composer Modeler's Guide.
Structure
The fields and controls of the task panel change dynamically according to the type of system
that you choose, such as BI system or SAP system. The following controls and fields are
available:
System Type Control/Field Menu Option Description
System list Portal alias of the back-end
system containing the data
service.
SAP BI System Look for list Look for a query Enables you to search for a
specific query by entering its
name in the Query field.
Look for a view Enables you to search for a
specific query view by entering
its name in the Query field.
Browse infoarea Enables you to browse the
tree InfoArea tree, viewing a selected
system’s InfoCubes, queries,
query views, and InfoObjects in
a tree.
Display query Displays the list of recently
history accessed queries for the current
BI system user. Note that
depending on how users are
mapped in the system, this could
differ from the current portal
user.
Display view history Displays the list of recently
accessed query views for the
current BI system user. Note that
depending on how users are
mapped in the system, this could
differ from the current portal
user.
You can test the functionality of the data service by choosing Test Data Service from its
context menu. For more information, see Test Data Service Dialog Box [Page 79].
Structure
The dialog box is divided as follows:
• In the left pane, the Input Ports group contains the names of all ports at the input to
the data service. When you select the checkbox next to a port, all of its fields are
displayed in the right pane.
• Like the Input Ports group, the Output Ports group contains all of the ports at the
output from the data service. When you select the checkbox next to a port, all of its
fields are displayed in the right pane.
• The Select all checkbox at the top right enables you to check all of the fields displayed
in the right pane.
• The Clear all checkbox removes the checks from all the fields in the right pane except
those that are mandatory (displayed in red with an asterisk). If there are no mandatory
fields in the port, the check is also removed from the port name in the left pane.
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.
Remove Folder Removes a selected folder.
Add Stores the Favorite in the selected location
and dismisses the dialog box.
Field/Control Description
New Folder Name Field in which to enter a name for the new
folder.
Create Creates the folder.
Integration
You can perform other Favorites activities on the Find Data Services task panel.
To browse for and select a Favorite:
...
1. On the Find Data Services Task Panel [Page 73], select an SAP BI data service.
2. In the Look for drop-down list, select Display favorites.
3. Navigate to, select, and work with an InfoObject in the favorites and query structure as
desired.
While browsing Favorites, you can also remove a query from Favorites:
4. Select a query, and from the context menu, select Remove from Favorites.
...
Example
See Working with Favorites [External] in the SAP NetWeaver Visual Composer Modeler's
Guide.
Use
You display the dialog box by right-clicking the data service and choosing Test Data Service
from its context menu. The Test Data Service dialog box is displayed, showing all of the fields
that it processes.
Structure
The left pane displays the fields of information for input and the right pane displays the results
that are received. Values must be entered into the mandatory fields (displayed in red with an
asterisk). Click Execute to display the results of the query, Clear to remove the results from
the right pane, and Close to close the dialog box.
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.
Use
The models that you build in Visual Composer are generated in Generic Modeling Language
(GML) code. To deploy your application to a portal, the GML code must be compiled into a
language supported by the portal. During compilation, warnings and possible errors may be
discovered, enabling you to check the model validity. The compiled content is deployed
directly to the portal, in the runtime environment that you select.
You access the task panel by displaying the iView in the Design board, at the level you want
to deploy, and clicking the Deploy button in the task-panel toolbar.
For more information, see Deploy the Model [External] in the SAP NetWeaver Visual
Composer Modeler's Guide.
Structure
The following controls and fields are used in the task panel:
Control/Field Description
iView read-only field Displays the name of the iView being deployed.
Deploy entire model If selected, deploys the entire model (regardless of the level
displayed on the Design board), otherwise deploys only the
part of the model currently displayed.
Deploy button Activates the compilation and deployment process.
Successful deployment is indicated by a Deployed
Successfully message. If errors or problems occur, the
appropriate messages or warnings are displayed along with
the source code. To view the deployed file, click on the Run
“<iView Name>“ line.
Compile button Compiles the model code. Successful compilation is
indicated by a Compiled Successfully message. If
errors or problems occur, the appropriate messages or
warnings are displayed along with the source code. To
display the code, click the View source code line.
Clear button Clears the displayed compilation or deployment messages.
Integration
The contents of the model are packaged into standard PAR files, one file per iView.
Use
For each control or field, you define a range of control-specific properties, grouped together
by function, such as Display, Formatting or Validation.
To display the controls and fields, it is recommended to use the Layout board, where you can
see a visualization of each control and field, and the overall layout within the component.
Using the Configure Element task panel, you select the control and open the Control
Properties dialog box by:
• Right-clicking the control or field on the Layout board and choosing Properties from the
context menu
• Double-clicking the row of the control or field displayed in the table at the bottom of the
Configure Element task panel
• Choosing Properties from the pull-down list in the Control column of the table at the
bottom of the Configure Element task panel
To create a new control, click the Add (plus) button at the bottom of the Configure Element
task panel.
To delete an existing control:
• Select it on the Layout board and press Del on your keyboard
• Double-click the row of the control or field in the Configure Element table and click the
Delete (minus) button
You can leave the Control Properties dialog box open as you configure different controls and
fields; it is not necessary to close it as you move from control to control.
Structure
The following controls and fields can be defined using the Control Properties dialog box:
Bulleted list Drop-down list Input field Radio button group
Calendar Expression box List box Spinner
Checkbox Gauge Numbered list Text editor
Clock Horizontal slider Plain text Ticker
Combo Box HTML text Progress bar Toggle button
Date picker Image Pushbutton Vertical slider (
For a description of all of these items, see Available Controls and Fields [Page 84].
The Control Properties dialog box contains a set of different tabs of properties, displayed
according to the control or field being configured. The following topics describe the properties
in each tab:
• Control Properties - General Tab [Page 87]
• Control Properties - Display Tab [Page 89]
Use
Controls and fields are defined either automatically when a component, such as a form, is
created, or they are added using the Configure Element Task Panel [Page 25]. To configure
the properties of the control, use the Control Properties dialog box, as described in the topics
of this section.
Structure
The following table describes the available controls and properties:
Control/Field Example Description
Bulleted list A selection control that displays a
menu of options presented in a
bulleted list.
Calendar A date selection control that allows
the user to select a date or a range of
dates using a navigable monthly
calendar.
Use
You can use the Control type drop-down list to change the control that has been selected.
The fields and controls of the tab may then change accordingly. In all fields, you can enter a
dynamic expression that defines the exact visibility condition or the default value. To do so,
click the Condition or Formula button to the right of the appropriate field.
Structure
The following table describes the properties configured in this tab:
Section Property Attribute Control Description
UI Control Control type All controls Drop-down list showing all
other controls of the same
Data type
Hidden All controls The control should be
hidden or displayed,
according to the condition
outlined in the expression
Use
Use the Appearance section to configure the exact “look” of the control and its label.
Use the Layout section to configure where the control is placed, its size and its tabbing order,
if needed.
Structure
The following table describes the properties configured in this tab:
Section Property Attribute Control Description
Appearance Display label All controls The name displayed on the
except Text control, written in quotation
editor marks (“ “). You can use the
Formula button to enter an
expression that indicates
the label to use, and when
Tooltip All controls Displays a quick description
except Text of the control when the user
editor runs the mouse over it
Text style Normal Bulleted list, Default text style
Plain text
Bold
Small
Header 1 First header style
Header 2 Second header style
Header 3 Third header style
Monospace Box-like font
Border style Default Bulleted list, Default border style of the
Calendar, control
Clock,
Solid Combo box, Border is a solid line
Inset Date picker, “Engraved“ 3D border
Drop-down
Outset list, “Embossed“ 3D border
Use
Using the Minimum and Maximum lists, you define the value range, along with an optional
Step size value (precision). Sliders and gauges must be bound on both sides (specifying both
Minimum and Maximum), while spinners can be bound on one or both sides (specifying either
Minimum or Maximum or both), or unbound (specifying neither Minimum or Maximum), as
described in the table that follows.
You can also choose to add tick marks to the range control.
Structure
The following table describes the properties configured in this tab:
Section Property Attribute Control Description
Value range Minimum Gauge, Lowest numerical value in
HSlider, the range. You can use the
Progress bar, Label checkbox and field to
Spinner, define a label for the low end
VSlider of the range.
Maximum Highest numerical value in
the range. You can use the
Label checkbox and field to
define a label for the high
end of the range.
Step size Gauge, A value for dividing up the
HSlider, range.
Spinner,
VSlider
Ticks Gauge, Tick marks displayed on the
HSlider, control.
VSlider
Enable HSlider, As you drag the slider, the
dragging VSlider chart is continuously
updated.
Show Progress bar Displays, in percentage, the
percentage amount of the bar already
filled in (the percent of the
task completed).
Use
Use the Style tab to create a table of different text styles, each with an expression defining the
condition under which that style is used.
Use the buttons to the right of the table as follows:
• Add a style
Structure
The following table describes the properties configured in this tab:
Section Property Attribute Control Description
Style Style column Expression The number or name of the
Selectors head box, style
Progress bar,
Condition Ticker The expression defining
column head when the style should be
applied
Text font A drop-down list of available
font names
Foreground A palette of colors from
which to select the font color
Background A palette of colors from
which to select the color
filling the text box
Bold Boldface font
Italic Italic font
Underline Text is underlined
Left Text is left-aligned
Center Text is centered
Right Text is right-aligned
Use
The properties configured in this field are displayed according to the data type of the control:
• Text
• Number
• Date
• Time
Certain controls, such as an input field or an expression box, can contain data of any of the
four types listed. Others, such as a horizontal slider or a progress bar, must be of a single
data type.
Structure
The following table describes the properties configured in this tab:
Section Property Attribute Control Description
Text Format None Expression Uses default text format
box, Input
Zero fill field, Ticker Fills a string of a given
length with zeroes
Password Indicates whether text
characters entered into the
control should be displayed
as asterisks
Trim spaces Removes extra spaces
between words or at the
beginning of the text
Lower case Uses only lower-case
characters for the text
Upper case Uses only upper-case
characters for the text
Proper case Capitalizes the first letter of
the main words
Custom Activates the Expression
field to define specific text
formatting
Expression Read-only field displaying
the defined format; activated
when Custom is selected
Number Numeric Expression Standard numbering
Format box, HSlider,
Local format Input field, Uses the portal runtime
locale formatting
Use
The list controls can have one of two types of entry lists:
• Static lists have set values that you define.
• Dynamic lists are populated at runtime according to the input fields selected and the
corresponding values assigned.
You can use this list in conjunction with the Entry List Manager, for selecting global lists that
have been defined for use throughout the model. For more information, see How to . . .
Create an Entry List [External] in the SAP NetWeaver Visual Composer Modeler's Guide.
Structure
When the Entry List tab is first displayed, the List scope set of radio buttons provides these
options:
• Static
• Dynamic
• Global
The display of the properties in the tab changes according to these selections, described in
the following three tables:
Control Description
Value column header The value of the option displayed in the list
Display Text column header The text to display for the option
Add a new entry
Example
Example
This option displays a pane listing all static and dynamic entry lists that have been defined in
the Entry List Manager as “global“, for use throughout the model. To edit a displayed global
entry list, select it and click at the right.
Use
When defining a dynamic entry list for global use, using the Entry List Manager, this dialog
box is displayed automatically (see Entry List Manager [Page 115]). When defining a dynamic
entry list for local use within a form, you need to display it by clicking at the right of the
Data service field (see Control Properties - Entry List Tab [Page 96]).
Structure
The following table describes the controls and fields in the dialog box:
Control/Field Description
System The portal system in which the data service resides
Look for A combo box from which you can select from a list of data services
contained in that data service and used in the model, or enter a mask for
searching for a data service
Search Activates a search for the data service
Select data service Displays all data services matching the text in the Look for field and
residing on the selected System
Input port Drop-down list of input ports on the selected data service, enabling you
to select the port that channels the values you need for your list
Output port Drop-down list of output ports on the selected data service, enabling you
to select the port that returns the values you define for your list
Use
Use the table of this tab to define a set of conditions corresponding to the appearance of a
value and create an error message. Note that the order of the conditions can be important.
Use the buttons at the right of the table as follows:
• Add a condition
Structure
The following table describes the properties configured in this tab:
Section Property Attribute Control Description
Validation Condition Calendar, Drop-down list of standard
Rules column head Checkbox, conditions for starting the
Combo box, condition clause, such as: Is
Data picker, equal, Is blank, Contains
Drop-down and Ends with
list, HSlider,
Value column Type text Input field, Enter a specific value, such
head List box, as ’Chicago’ (note the
Radio group, single quotation marks) or
Spinner, 10
Enter formula Toggle Enter a formula using the
button, Expression Editor
VSlider
[fields in The controls and fields
component] defined within the
component
Error Text of the message that
Message should appear if the error
column head condition occurs
Use
In order to select an image, you must first have defined an image library for the model. To do
so, see Define an Image Control [External] in the SAP NetWeaver Visual Composer
Modeler's Guide (for the procedure) or Image Manager [Page 119] in this guide.
Once defined, the images in the image library are displayed in the pane of this tab. Use the
checkbox beneath each image to select the image to be added.
Structure
The following table describes the properties configured in this tab:
Control/Field Description
Image The condition under which the selected image should be displayed in
the image control. Click Condition to define an image, or accept true
(default) to display the image at all times.
Original size The image is displayed in its original size. Its edges are cut off if the
control size is smaller than the image dimensions.
Fit size The image is sized to fill the control.
Use
You can use this tab to define one of two types of actions:
• A System action is a predefined event, such as closing a window or inserting a row.
You select the specific action from the System action drop-down list.
• A Custom action is a specialized action that you define, by entering the name of the
event in the Custom action field
The fields and controls of the tab change according to the type of action you define, and
according to the specific option you chose for that type of action.
Structure
The following table describes the controls and fields that are displayed in the tab, according to
your selection in the Action type row of radio buttons:
Action Type Property Attribute Description
System action System action Close window Closes the window (for example, a
drop-down list popup window)
Delete row Deletes the current object and
moves the cursor to the next
object.
Dynamic action Invokes a dynamic action,
according to the given formula
defined in the Action formula field.
Export data Copies data to the clipboard, which
can then be exported to another
program (for example, Excel)
Find row Looks for the next object in the
dataset that matches the
expression defined in the Search
formula field. The search starts
from the current cursor position
until the end of the dataset, and
then continues from the beginning
back to the cursor position, in a
cyclic manner.
History back Navigates back one step through
the target element’s history
Use
You should first type in the HTML text in the pane and then format it, selecting part or all of
the text and applying the different controls.
Structure
The following table describes the properties configured in this tab:
Control Description
[font list] Drop-down list of fonts to choose from
[font size list] Drop-down list of font sizes
Boldface font
Italic font
Underlined font
Font color
Align to left
Align to center
Align to right
You may only deploy models that contain value help to Adobe Flash format. To
check that your runtime is set to Flash: from the Visual Composer main menu,
choose Tools → Options. Select the Compiler tab, and from the Runtime
dropdown box, select Flash.
Use
Configure the list of values to appear in value help using three steps provided by the wizard:
...
1. Select the type of value help to add on the Add Value Help for Selected Input Field
screen
2. Select the data service that provides the values on the Select Data Service screen
3. Configure the advanced options on the Specify Data Service Runtime Parameters
screen (optional for BI systems – this screen appears only if you have deselected the
Hide advanced configuration options (BI systems only) checkbox on the Add Value
Help for Select Input Field screen)
When you have completed the steps, the wizard generates an embedded iView that
represents the value help dialog box and its functionality. Next to the input field, the wizard
also generates a value help button. At runtime, when the user presses the button, the dialog
box appears and lists values for the input field.
Structure
The main sections and controls of the three screens in the wizard are described in the
following three tables:
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.
This screen appears if you have deselected the Hide advanced configuration options (BI
systems only) checkbox on the Add Value Help for Selected Input Field screen. It also
appears, regardless of selection of the checkbox, if you are using an SAP System.
Configuring the parameters on this advanced screen is mandatory for SAP Systems, but
optional for BI systems.
Note: Asterisks (*) on this screen indicate required fields.
Section Control/Field Menu Option Description
Input Port (available input Typically, this is an
ports) Input port, but data
services can have
multiple input ports.
You can select the
Variable port of a BI
query if available, for
example.
Input Fields List of available input
fields.
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 [Page 116].
See also:
See Using a BI System as a Data Service [External] in the SAP NetWeaver Visual
Composer Modeler’s Guide for a table of BI system InfoObjects and their different
formats. For example, you typically want to use the _ext_key format of a characteristic
in value help as input for a variable.
See Working with Variables [External] in the SAP NetWeaver Visual Composer Modeler’s
Guide to see how value help helps you generate proper selection syntax in addition to
field values.
Use
You display the Documentation Wizard by choosing Tools → Documentation Wizard. Once
you select the model level and the print options, and click Print, the document is displayed for
printing or saving.
Structure
The following table lists the options in the wizard for printing your documentation:
Control Option Description
Source Diagram A drop-down list showing all the upper-level
elements (“diagrams“) of your model, such as
pages and iViews, to enable you to select how
much of the model is to be documented.
Print Options Print drawings Prints the diagram displayed on the Design
board.
Print definitions Prints information about the model (for
example, the iView name, author, last modified
date, user-defined hyperlink and user defined
notes). In addition, it prints a table listing the
elements belonging to the model component,
and properties of those elements. If the
component has no lower-level elements, the
table does not appear.
Print statistics A section at the end of the document that
provides the following model statistics: Total
Diagrams, Total Definitions, Total Property
Values, Average Definitions per Diagram,
Average Properties per Element.
Print index Adds an alphabetized index of model elements
to the document.
Include sub-diagrams Prints all diagrams of component levels below
that displayed on the Design board.
Use
You use this dialog box, accessed by choosing Tools → Entry List Manager, to create three
types of lists:
• Static lists, which have set values that you define.
• Dynamic lists, which are populated at runtime according to the input fields selected and
the corresponding values assigned.
• Value Help lists, which are auxiliary design-time tools implemented through a wizard.
They help you identify a data service and configure a list of master data values to store
in a static entry list.
For an explanation of the procedure for creating global and local entry lists, see Create an
Entry List [External] in the SAP NetWeaver Visual Composer Modeler's Guide.
Structure
The structure of the dialog box changes according to the type of list chosen. Once you have
added an entry list, you create it exactly as you do local entry lists in the Control Properties
dialog box.
The three buttons at the bottom left are used to manage the creation of the global entry lists:
Add: a drop-down list for selecting the type of global entry list that you want to create:
{ Static list: for details, see Control Properties - Entry List Tab [Page 96]
{ Dynamic list: for details, see Control Properties - Entry List Tab [Page 96]
{ Value Help list: for details, see Value Help List [Page 116]
Each list is shown in the Entry Lists pane above the buttons. When you click on the list,
the details about it are displayed to the right, for viewing and/or editing.
Remove: Deletes the selected global entry list
Rename: Activates the name for you to edit the existing one
Use
You create a value help entry list in two steps provided by the wizard:
• Select a data source
• Review value help list
You can repeat these steps as many times as you wish while creating the list (for example, to
create lists with values from different data services).
Structure
The main sections and controls of the two screens of the wizard are described in the following
two tables:
Example
See Creating a Value Help Entry List [External] in the SAP NetWeaver Visual Composer
Modeler's Guide.
Entry list value help is also known as design-time value help. A second type of
value help, a run-time value help, is also available in Visual Composer. With
this, you create a button next to an input field that displays a dialog box of valid
values during your model’s runtime. See Value Help Configuration Wizard [Page
107].
Use
Choose Tools → Image Manager to access the dialog box. To add an image, you first click
Browse, locate and select the image you want to add, and then click Upload.
Images that you add to the library are then available throughout the model. For more
information about adding images and using the Image Manager, see How to . . . Define an
Image Control [External] in the SAP NetWeaver Visual Composer Modeler's Guide.
Structure
The main parts of the Image Manager dialog box are:
• The toolbar, for renaming and deleting images
• The display pane, for showing the images contained in the library
• The fields and buttons at the bottom, for locating and adding the images
The following table describes the controls in the dialog box:
Control Description
Activates the name of the selected image for you to edit it.
Browse Opens the standard Choose file dialog box for you to locate the
image that you want to add. When you click Open, the dialog box is
closed and the file name is displayed in the field at the bottom.
Upload Enters the image named in the field into the library, displaying a
thumbnail in the display pane.
Close Closes the Image Manager.
Use
Choose Tools → Alias Manager to access the dialog box. A table is displayed listing all
system aliases used in the model, along with their details. To change a system alias, you
check its row and click Rename.
For more information about using the Alias Manager, see How to . . . Manage Your Portal
System Aliases [External] in the SAP NetWeaver Visual Composer Modeler's Guide.
Structure
The following table describes the controls of the System Alias Manager dialog box:
Control Option Description
Select Select “<name>“ Selects all instances of the selected alias
Alias
Select All Aliases Selects the entire list of aliases
Select None Deselects all selected aliases
Replace Displays a dialog box, in whose field you
enter the new portal alias that you require
[table] Alias column header Alias currently defined for the system in the
System Landscape editor of your portal
Used in column Name of the iView containing a data service
header within the named system
Used by column Name of the data service
header
System Type column Type of system containing the data service
header
Use
You display the System Definition (Web Service) dialog box by choosing Tools → Define Web
service system. You then enter all the information relating to the new web service system.
Structure
The System Definition (Web Service) dialog box includes the following fields and controls:
Control Description
New system name Unique name of the web service system
New system alias Alias that will be used in the portal to identify the web service system
Web service URL Web service’s URL address
URL requires User Defines that the web service requires user authentication
and Password
checkbox
User The user name
Password The password assigned to the user
Use
Within an iView, choose Tools → Alert Data Service, then click Generate to place an alert
data service on your storyboard.
Configure a start point on the data service’s Input port, then drag from the data service’s
Output port and select Add Table View to display the alerts in a table. The Select Display
Fields dialog box appears, which allows you to select which alert attributes to display.
Structure
The following table lists the available alert attributes you can display using the Select Display
Fields dialog box:
Attribute Description
ACTIVITYLINK1 URL link to an activity you need to complete. There can be up to
three activities for each alert.
ACTIVITYLINK2
This could also display the URL link to an associated an SAP BI
ACTIVITYLINK3 system query view, if relevant.
ACTIVITYTEXT1 Description of the associated activity you need to complete.
ACTIVITYTEXT2
ACTIVITYTEXT3
ALERTCATEGORY Category of alert. For example: Sales Performance; Max. vacation
time exceeded; Book sold out.
ALERTID Back-end alert ID.
ATTRIBUTES List of all attributes for alert, delivered in one string. For design-
time usage only. Not recommended to deploy this into a table for
end-users.
DESCRIPTION Description of alert (long text). Compare with SUBJECT (short
text).
DUEDATE Date by which the task described in the alert needs to be
completed, in the current portal user's time zone.
DUETIME Time by which the task described in the alert needs to be
completed, in the current portal user's time zone.
ESCALATED Boolean value indicating whether the alert has been escalated.
Attribute Description
EXPIREDATE Date when the alert is scheduled to be removed from the list, in the
current portal user's time zone.
EXPIRETIME Time when the alert is scheduled to be removed from the list, in the
current portal user's time zone.
PRIORITY Priority of alert. For example: High; Very High.
RECIPIENTS List of people who received the alert. There can be multiple people
in this list.
STATUS Status of alert. For example: New; In Progress.
SUBJECT Description of alert (short text). Compare with DESCRIPTION (long
text).
Example
See Add an Alert Data Service [External] in the SAP NetWeaver Visual Composer Modeler's
Guide.
See also:
Universal Worklist Configuration [External] in the SAP NetWeaver Technology Consultant's
Guide.
Use
You display the Customize Toolbar dialog box by choosing Tools → Customize. When you
select your choice of toolbar or toolbox, the list of buttons that can be displayed in the toolbar
is shown in the Available buttons pane at the right. You use the arrow buttons to add them to
or remove them from the currently-displayed buttons (at the left).
Structure
The following table describes the controls in the Customize Toolbar dialog box:
Control Option Description
Toolbar Main toolbar Displays the buttons of the main toolbar
Task panel Displays the buttons of the task panel
Design toolbox Displays the buttons of the Design board
toolbox
Layout toolbox Displays the buttons of the Layout board
toolbox
Source toolbox Displays the button of the Source toolbox
Help Not relevant
Moves the selected button one place up (to
the left) in the configuration
Moves the selected button one place down
(to the right) in the configuration
Removes a currently-displayed button from
the toolbar
Adds the selected button to the toolbar
Use
The Options dialog box, displayed by choosing Tools → Options, defines much of the base
functionality of your Storyboard. You should review the parameters in the Options tabs before
beginning to create models in Visual Composer.
Structure
Tables describing the options available in each tab of the Options dialog box are found in
subsequent topics:
• Options - Model Tab [Page 125]
• Options - Drawing Tab [Page 126]
• Options - Editing Tab [Page 127]
• Options - Workspace Tab [Page 128]
• Options - Compiler Tab [Page 129]
• Options - Administration Tab [Page 130]
Structure
Option Description
Reload last model at startup Used to automatically display the last model worked on when
you next access Visual Composer. If this is not selected, you
need to open a model each time you access the application.
Save model every The interval at which the open model is saved automatically:
from 5 minutes to 2 hours.
Maximum undo levels Number of times that you can consecutively click the
Undo/Redo toolbar buttons (Edit → Undo/Redo).
Maximum history size Number of times that you can consecutively click the
Back/Forward toolbar buttons (Search → Back/Forward) in
order to go back one level in your model.
Reset Settings Restores the previous set of parameters.
Optimize for Speed Select the option configuration parameters that provide optimal
speed of operation.
Structure
Group Option Sub-Option Description
Drawing Avoid overlapping This is important when dragging layers
shapes onto the Design board. However, it is
recommended to leave this checked so
that you need to manually drag the
elements into the layer, thereby joining
them into one unit.
Automatically fit Adjusts the size of the last-opened
diagram on open model in the workspace when you first
access Visual Composer.
Display diagram title Displays (or hides) the title of the model
component in the workspace.
Interaction Show drag and drop Displays the animated shape of the
sprite object you are dragging.
Snap shapes to grid Automatically snaps the icon that you
while dragging drag to the lines of the grid.
Highlight shapes Highlights the border of the icon as you
under the mouse run the mouse over it.
Select shapes Lets you select a group of objects by
partially within area dragging the bounding rectangle partly
over them.
Optimize screen Enhances the speed and quality of the
refreshing model display.
Line Routing Routing method Automatic With right angles (orthogonal).
Straight Direct 45-degree line with no corners.
Angular Direct line.
Curved
Orthogonal Line with 90-degree angles.
Line corners None Lines drawn straight, from element to
element (port to port).
Small Degree of sharpness of the corners.
Medium
Large
Structure
Editing Tab
Structure
Option Sub-Option Description
Taskbar position Right Positions the task panels
either at the right or the left of
Left the workspace
Structure
Option Sub-Option Description
Runtime Lets you choose from the
available runtime
environments to which you
can deploy. The same model
can be deployed to one
environment and
subsequently deployed to
another environment.
PAR name prefix The prefix of all PAR files
created by Visual Composer
Portal deployment folder The path to the Portal
Catalog folder that will
include the compiled files
Portal system folder The path to the Portal
Catalog folder where new
systems will be created
Data service retrieval Cache retrieved services (for Caches the data services
fast retrieval) found in the Find Data
Services task panel
Do not cache data services Retrieves the same data
(get latest) services each time rather
than caching them
Mask unsupported features Removes from the display
items – such as model
elements and property
options – that are not
supported by the currently-
selected deploy environment
Deploy model with PAR Deploys the PAR file with the
model, so that a portal user
can open the model in
Storyboard, directly from the
portal PCD (using the Open
in Storyboard option).
Add Guided Procedure Enables the model to be
information subsequently used as a
callable object for Guided
Procedure.
This option automatically
renders input and output
parameters for display in
Guided Procedures.
Structure
Option Sub-Option Description
Log Severity Fatal Errors from which the application cannot recover and
which cause the system to terminate
Error Error from which the application can recover, but
whcih prevents it from fulfilling the required task
Warning An anomaly from which the application can recover
and fulfill the required task, although attention from a
developer or operator is required
Info Text describing what actions have been performed
None No messages are displayed
Trace Severity Path Used to trace the execution flow
Debug Used for debugging purposes, with extensive and low-
level information
None No trace messages are displayed
BI Terminology Notes
BI menu functionality allows you to build queries on diverse OLAP (as well as relational) data
sources defined in your portal. These may include SAP BI systems (BW) or non-SAP data
sources. In cases where SAP BI system terminology differs from general OLAP terminology,
the BI dialog boxes use the standard OLAP terminology. Some of the major differences
between standard OLAP and SAP BI terms follow:
OLAP Standard Term SAP BI Term
dimension characteristic
measure key figure
member characteristic level
level hierarchy level
For OLAP systems, the caption value from your data service is displayed in
dialog box fields. For relational systems, the field name is displayed.
For definitions of terms used in Visual Composer, see the Glossary [External] in the SAP
NetWeaver Visual Composer Modeler’s Guide.
See the prerequisites described in the notes in BI Menu Dialog Boxes [Page
131].
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 [Page 65]: Table at bottom).
Structure
Reference topics for available wizard screens are listed below:
• Select a System [Page 133]
• Select a Query Template [Page 134] (includes links to template configuration
subtopics)
• Select a Cube [Page 163]
• Define Filters [Page 164]
• Select a Table [Page 166]
• Design a Layout [Page 166]
• Select Fields [Page 168]
• Configure Joins [Page 169]
• Configure Filters [Page 171]
• Specify the Sort Order [Page 172]
• Review Output [Page 172]
Example
See Use the BI Integration Wizard [External] and Creating a BI iView [External] in the SAP
NetWeaver Visual Composer Modeler’s Guide.
Structure
The main sections of this screen are listed in the following table:
Section Description
Available Systems Displays the systems available, categorized in folders based on the BI
Java Connector used to configure the system. Available systems
depend on what you have configured on the portal, and may include:
• XMLA connections – OLAP systems based on the BI XMLA
Connector
• ODBO connections – OLAP systems based on the BI ODBO
Connector
• JDBC connections – Relational systems based on the BI JDBC
Connector
• SAPQ connections – Relational systems based on the BI SAP
Query Connector
Description Displays the description of selected folder or system, if available.
Properties Displays properties for the selected folder or system, if available.
Use
Use this screen to learn about available query templates and select one to base your query
upon. The set of templates available depends on whether you have selected a relational or
OLAP system on the previous screen (Select a System [Page 133]). After you select a
template, you proceed to the first screen specific to configuring your query (if applicable).
Subsequent steps in the wizard’s navigation trail update based on the template you have
chosen.
Note that although a sample business question is provided for each query template, a given
template can address many different questions. For example, you can configure the Top N
query template to address any of the questions below:
• What are my top five customers based on sales?
• What are my bottom ten products based on margin?
• What products make up the top 10% of sales?
Structure
The main sections of this screen are listed in the following table:
Section Description
Available Templates Displays the list of available query templates. OLAP
templates are grouped into categories. See below for the
complete list of available templates.
Description Displays a description of the selected query template.
Sample Business Question Displays the sample business question associated with the
selected query template.
Structure
The main sections and controls of this screen are listed in the following table:
Section Control Description
Count Members of Dimension Lists all dimensions in the cube on which
the query is based.
As each of the screen’s three sections
must be based on different dimensions,
dimensions selected in the other two
sections are omitted from this list.
Select the dimension that contains the
hierarchy to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently
selected dimension.
Select the hierarchy that contains the level
to display in the Level field.
Level Lists all levels in the currently selected
hierarchy.
Select the level that contains all the
members you wish to count.
With measure ... not Lists all measures in the cube on which
equal to zero the query is based.
Select the measure to which all members
in the selected level contribute. Any
member in the selected level with a non-
zero value in this measure will be counted.
Displayed by Dimension Lists all dimensions in the cube on which
Members of the query is based.
As each of the screen’s three sections
must be based on different dimensions,
dimensions selected in the other two
sections are omitted from this list.
Select the dimension that contains the
hierarchy to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently
selected dimension.
Select the hierarchy that contains the level
to display in the Level field.
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.
Structure
The main sections and controls of this screen are listed in the following table:
Section Control Description
Calculate Running total of measure Lists all measures in the cube on which the
query is based.
Select the measure for which you want to
display a running total.
For Members of Dimension Lists all dimensions in the cube on which the
query is based.
Select the dimension that contains the
hierarchy to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected
dimension.
Select the hierarchy that contains the level to
display in the Level field.
Level Lists all levels in the currently selected
hierarchy.
Select the level that contains the members you
want to see in the query’s result.
For Date Range Time dimension Lists all the time dimensions in the cube on
which the query is based.
Select the dimension that contains the
hierarchy to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected
dimension.
Select the hierarchy that contains the level to
display in the Level field.
Period level Lists all levels in the currently selected
hierarchy.
Select the level that contains the time
granularity upon which to base the date range.
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:
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.
Structure
The main sections and controls of this screen are listed in the following table:
Section Control Description
Calculate Moving average of measure Lists all measures in the cube on which the
query is based.
Select the measure for which you want to
display a moving average.
Based on number of periods Enter the number of time periods on which
to base the average.
For Members of Dimension Lists all dimensions in the cube on which
the query is based.
Select the dimension that contains the
hierarchy to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently
selected dimension.
Select the hierarchy that contains the level
to display in the Level field.
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:
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.
Structure
The main sections and controls of this screen are listed in the following table:
Section Control Description
Calculate Absolute percentage Lists all measures in the cube on which the
growth of measure query is based.
Select the measure for which you want to
calculate growth.
For Members of Dimension Lists all dimensions in the cube on which the
query is based.
Select the dimension that contains the hierarchy
to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected
dimension.
Select the hierarchy that contains the level to
display in the Level field.
Level Lists all levels in the currently selected
hierarchy.
Select the level that contains the members you
want to see in the query’s result.
Between Base Time dimension Lists all the time dimensions in the cube on
and Comparison which the query is based.
Periods
Select the dimension that contains the hierarchy
to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected
dimension.
Select the hierarchy that contains the level to
display in the Level field.
Period level Lists all levels in the currently selected
hierarchy.
Select the level that contains the time
granularity for the base and comparison periods.
Example
The result of a Percentage Growth query is displayed in a table with five columns such as the
below:
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.
Structure
The controls in the main section of this screen, Calculate Share of Members of, are listed in
the following table:
Control Description
Dimension Lists all dimensions in the cube on which the query is based.
Select the dimension that contains the hierarchy to display in
the Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected dimension.
Select the hierarchy that contains the level to display in the
Level field.
Level Lists all levels in the currently selected hierarchy.
Select the level that contains the members you want to see in
the query’s result.
The level name in the radio buttons below updates according
to the value you select.
As a percentage of the sum of all Calculates individual members’ shares in proportion to the
members of <level name> total for all level members.
Note that defining filters (on the subsequent wizard screen)
will have an effect on the way your result displays.
As a percentage of the sum of all Calculates individual members’ shares in proportion to only
filtered members of <level those members you select in the subsequent step of defining
name> a filter.
You must define a filter (on the subsequent wizard screen) for
this option to work properly.
Based on measure Lists all measures in the cube on which the query is based.
Select the measure upon which to base the calculation.
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.
Structure
The main controls of this screen are listed in the following table:
Control Value Description
Calculate Planned Measures Use this value if you actually have
versus Actual defined measures defined as Planned and Actual
by in your data service. The measures might
have names such as the below:
• Planned; Actual
• Plan Profit; Actual Profit
• Plan Sales; Actual Sales
• Quantity Ordered; Quantity Shipped
The controls displayed on this screen
differ based on which value is selected in
this control.
Planned vs. Actual Use this value if you have members (not
Indicators measures) that indicate planned and
actual values.
This type of configuration is typically found
in data services based on SAP BI
systems.
The controls displayed on this screen
differ based on which value is selected in
this control.
Dimension Lists all dimensions in the cube on which the query is based.
Select the dimension that contains the hierarchy to display in the
Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected dimension.
Select the hierarchy that contains the level to display in the Level field.
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)
Structure
The main sections and controls of this screen are listed in the following table:
Section Control Description
Calculate Change in Rank type Select from the following rank types:
• Top Count
• Bottom Count
• Top Percent
• Bottom Percent
Value Enter the rank value. For Count rank types, the
value is numeric. For Percent rank types, the value
corresponds to a percentage.
For example:
If you select Top Count and enter a Value of 5,
you want to calculate the change in rank of
your top five members between one period
and another.
If you select Top Percent and enter a Value of 10,
you want to calculate the change in rank of
your top 10% of members between one
period and another.
For Members of Dimension Lists all dimensions in the cube on which the query
is based.
Select the dimension that contains the hierarchy to
display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected
dimension.
Select the hierarchy that contains the level to display
in the Level field.
Level Lists all levels in the currently selected hierarchy.
Select the level that contains the members you want
to see in the query’s result.
Example
The result of a Rank Change query is displayed in a table with five columns such as the
below:
1. The query first computes the results of a Top N query in the base period you specify
(values in Base Period and Rank Base Period columns). This also selects the members
that will appear on the rows in the table.
2. Next, it calculates the Top N results for those same members in the comparison period
(Rank Comparison Period column).
3. Finally, the query computes the difference between the base and comparison period
ranks, and delivers that value in the Rank Difference column.
Structure
The main sections and controls of this screen are listed in the following table:
Section Control / Value Description
Define Query Ranks In this section, use the checkboxes to include top, bottom, or both
and Values rank types in the query results. Use the values below to configure the
rank type (count or percent), which can differ between the two.
Top rank type Count Select this option to configure a
top count rank.
Enter a number in the Value field
to indicate count (for example, 5
specifies top 5).
Percent Select this option to configure a
top percent rank.
Enter a number in the Value field
to indicate percentage (for
example, 10 specifies top 10%).
Bottom rank type Count Select this option to configure a
bottom count rank.
Enter a number in the Value field
to indicate count (for example, 5
specifies bottom 5).
Percent Select this option to configure a
bottom percent rank.
Enter a number in the Value field
to indicate percentage (for
example, 10 specifies bottom
10%).
Define Members Dimension Lists all dimensions in the cube on
which the query is based.
Select the dimension that contains
the hierarchy to display in the
Hierarchy field.
Example
For a step-by-step example, see Creating a BI iView [External] in the SAP NetWeaver Visual
Composer Modeler’s Guide.
Structure
The main sections and controls of this screen are listed in the following table:
Section Control Description
Display Trend in measure Lists all measures in the cube on which the
query is based.
Select the measure for which you want to
display a trend.
For Members of Dimension Lists all dimensions in the cube on which the
query is based.
Select the dimension that contains the
hierarchy to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected
dimension.
Select the hierarchy that contains the level to
display in the Level field.
Level Lists all levels in the currently selected
hierarchy.
Select the level that contains the members
you want to see in the query’s result.
During Date Range Time dimension Lists all the time dimensions in the cube on
which the query is based.
Select the dimension that contains the
hierarchy to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected
dimension.
Select the hierarchy that contains the level to
display in the Level field.
Period level Lists all levels in the currently selected
hierarchy.
Select the level that contains the time
granularity upon which to base the trend
calculations.
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
Structure
The main sections and controls of this screen are listed in the following table:
Section Control Description
Display Members of Dimension Lists all dimensions in the cube on which the
query is based.
Select the dimension that contains the
hierarchy to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected
dimension.
Select the hierarchy that contains the level to
display in the Level field.
Level Lists all levels in the currently selected
hierarchy.
Select the level that contains the members
you want to see in the query’s result.
Based on the measure Lists all measures in the cube on which the
query is based.
Select the measure in which to look for a
zero value.
With No Activity for Time dimension Lists all the time dimensions in the cube on
which the query is based.
Select the dimension that contains the
hierarchy to display in the Hierarchy field.
Hierarchy Lists all hierarchies in the currently selected
dimension.
Select the hierarchy that contains the level to
display in the Level field.
Period level Lists all levels in the currently selected
hierarchy.
Select the level that contains the time
granularity for the from and to periods.
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
Portsmouth Imported Beer
Top Measure Imported Beer
Fabulous Apple Drink
Great Cranberry Muffins
Great Muffins
You must configure the Internet Graphics Server URL in the Visual Administrator
to use the Heatmap template. See Configuring Optional Properties in the Visual
Administrator [External] in the SAP NetWeaver Visual Composer Installation &
Configuration Guide.
• You may only use one heatmap per model, and one per portal
page.
• In order to resize the display of the heatmap, follow the
procedure below in Resizing Heatmaps.
Structure
The main sections and controls of this screen are listed in the following table:
Section Control Description
Display Heatmap for Primary grouping Lists all the fields selected on the Select
Fields [Page 168] screen.
Select the field that should designate the
primary grouping (larger boxes). You may
select any data type.
Secondary grouping Lists all the fields selected on the Select
Fields screen.
Select the field that should designate the
secondary grouping (smaller sub-boxes).
You may select any data type.
Where Size is determined by Lists all the numeric fields selected on
the Select Fields screen.
Select the field that should determine the
relative size of the boxes.
Color is determined by Lists all the numeric fields selected on
the Select Fields screen.
Select the field that should determine the
relative color of the boxes.
Resizing Heatmaps
Heatmaps are displayed in a special container in an HTML view. If you want to resize the
display of the heatmap, you must resize both the HTML view and the heatmap container
itself. Follow this procedure:
...
1. In the storyboard, double-click the URL port on the heatmap data service.
2. On the Configure Element task panel, in the Output Fields section, double-click the
URL field to modify it.
3. In the Compute Field field, change the width and height parameters in the URL.
4. Save the value.
Make sure that the HTML view and the heatmap container are the same size. To
see the size of the HTML view, go to the Layout tab and select the HTML view.
Its width and height are displayed in the pane below.
Example
You want to view the relative distribution of sales (both in quantity and revenue) among
certain divisions and companies. To do this, configure the values on this screen in the
following manner:
Where section:
• Size is determined by = Sales.Quantity (the Quantity field from the Sales table)
• Color is determined by = Sales.Revenue (the Revenue field from the Sales table)
For these values to be available in the drop-down lists on this screen, you must
first have selected them on the Select Fields [Page 168] screen.
The result of this query would generate a heatmap similar to the following:
In this heatmap:
1. Instances of Division are represented by the large, primary boxes.
2. Instances of Company are represented by the smaller, colored boxes secondary to 1.
3. Instances of Sales in quantity are represented by the size of 2. The larger the box, the
higher the quantity.
4. Instances of Sales in revenue are represented by the color of 2, in a gradient. The
darker the color (towards the right side of the gradient legend – which might denote
millions of dollars), the higher the sales in revenue.
Although the display looks simple at first glance, note that sizes of both the primary and
secondary boxes are shown relative to each other, as well as the colors of the boxes (in a
relative gradient). You can compare how divisions are doing relative to each other, as well as
how companies are doing relative to each other.
It is easy in a heatmap to note standouts within a large pool of data. For example, in this
result:
• The company represented by the largest sub-box (in the Financials division in the
upper-left corner) has the highest sales in quantity.
• The company represented by the darkest sub-box (in the Industrials division) has the
highest sales in revenue.
Structure
The main sections and controls of this screen are listed in the following table:
Section Control Description
Select criteria Smallest Indicates that the value should be the smallest (minimum).
Largest Indicates that the value should be the largest (maximum).
Select field Lists all fields in any table selected on the Select Fields [Page 168] screen.
Select the field in which to search for the smallest or largest value.
Although the fields you selected with Select Fields determine which fields will
appear in the result, you can base your minimum or maximum requirement on
any field in the table. The field you select does not have to be a numeric data
type.
Example
You want to know which store has the smallest revenue, where the store is, and who the
manager of the store is. To find this out, you configure the values on this screen in the
following manner:
...
1. Since you want to see the store, city, and manager’s name in the result, you have
already used the Select Fields screen to select the Store, City, and Manager fields from
a table called Sales.
2. On this screen, select the Smallest radio button.
3. From the Field drop-down list, select the Sales.Revenue field (the Revenue field from
the Sales table).
The result of this query is one row displayed in a table such as the following:
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.
Structure
The main sections of this screen are listed in the following table:
Section Description
Available Cubes Lets you look for a cube or browse the cubes catalog. See Find Data
Services Task Panel [Page 73] for a description of the similar Look for
functionality.
The data service tree lists the system you selected on the Select a
System [Page 133] screen as the root node in the tree, followed by any
catalogs contained in that service, followed by any cubes contained in
the catalog.
Description Displays the description of the selected cube, if available.
Properties Displays properties for the selected cube, if available.
Defining filters is usually optional, but depending on the template you have
chosen it may be an important step. For the Percentage Share template, for
example, you usually need to define filters in order for the business logic to work
correctly.
Structure
The main sections and controls of this screen are listed in the following table:
Section Control Description
Æ button Transfers a selected member to the Selected
Filter Values list. Repeat to define additional filter
values. You may create individual filter values
with members from different levels, hierarchies,
or dimensions.
Range Æ button Defines a filter range:
...
Structure
The main sections of this screen are listed in the following table:
Section Description
Available Tables Lets you look for a table or browse the tables catalog. See Find Data
Services Task Panel [Page 73] for a description of the similar Look for
functionality.
The data service tree lists the system you selected on the Select a
System [Page 133] screen as the root node in the tree, followed by
any catalogs contained in that service, followed by any schema
contained in the catalog, followed by any tables in the schema.
Table Description Displays the description of the selected table, if available.
Table Properties Displays properties for the selected table, if available.
Structure
The main sections and controls of this screen are listed in the following table:
Section Control/Sub-section Description
Cube Data Lists the metadata for the cube you
selected on the Select a Cube [Page
163] screen, in tree format. At the
root of the tree is the cube, followed
by dimensions (including the special
measures and time dimensions),
followed by available hierarchies,
levels, and members.
Select a measure, dimension, or level
to place in either rows or columns.
Selected Data -- Rows Æ button Transfers the measure, dimension, or
level selected in the Cube Data list to
the rows. You can create multiple
rows in the query definition, as long
as the metadata for each row comes
from a different dimension.
Structure
The main sections and controls of this screen are listed in the following table:
Section Control Description
Æ button From the Available Tables and Fields list,
transfers a selected field, or all fields in a
selected table, to the Selected Values list.
Å button Removes a selected field from the Selected
Values list.
Clear button Removes all fields from the Selected
Values list.
Available Tables and Fields Lets you look for a table or browse the
tables catalog. See Find Data Services
Task Panel [Page 73] for a description of
the similar Look for functionality.
The data service tree lists the system you
selected on the Select a System [Page
133] screen as the root node in the tree,
followed by any catalogs contained in that
service, followed by any schema contained
in the catalog, followed by any tables in the
schema.
Select individual fields or tables.
Selected Values Lists the fields selected in the query,
including their Table, Column, and Type
identifiers.
Example
You are using the Count (relational) template to determine how many employees each
manager is responsible for, and how many are part-time or full-time employees. To find out,
you use the Count template and select the Manager field, and then the Type field from the
Employees table. This query counts all occurrences in groups, with one group per selected
field.
The result of such a Count query is a table such as the below:
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:
Structure
The main controls of this screen are listed in the following table:
Control Description
Left Field Lists all fields from all the tables selected on the Select Fields [Page 168]
screen. Select the join field for the left table.
Operator Lists operators that specify how the left and right fields should be compared.
Available operators are:
= (Equal to)
> (Greater than)
< (Less than)
>= (Greater than or equal to)
<= (Less than or equal to)
<> (Not equal to)
Right Field Lists all fields from all the tables selected on the Select Fields screen. Select
the join field for the right table. The Left Field and Right Field selections
must be from different tables.
Add Adds the join configured by the Left Field, Operator, and Right Field lists to
the Joins list. You may add as many joins as you want.
Joins list Lists the currently configured joins.
Delete Deletes a selected join from the Joins list.
Structure
The main controls of this screen are described in the following table:
Control Description
And/Or Specifies and/or conditions for multiple filters. The And/Or
control is enabled after the first filter has been added.
Select from the following values for second and subsequent
filters:
• And: This filter’s condition must apply.
• Or: This filter’s condition is handled after any And
filters.
Field Lists all fields from all the tables selected on the Select
Fields [Page 168] screen. Select the field for which to
configure the filter.
Operator Lists operators that specify how the Field entry and the
corresponding Value entry should be compared. Available
operators are:
= (Equal to)
> (Greater than)
< (Less than)
>= (Greater than or equal to)
<= (Less than or equal to)
<> (Not equal to)
is between (Is between)
is like (Is like)
is null (Is null)
Value Enter the value to which to compare the field. The value can
be either numeric or text.
And (Is between operator only) If you have selected Is between as your operator, enter the
end value for your range.
Add Transfers the filter to the Filters list.
Filters list Lists the currently configured filters.
Delete Deletes a selected filter from the Filters list.
Structure
The main controls of this screen are listed in the following table:
Control Description
Field Lists all fields selected on the Select Fields [Page 168] screen. Select the
field for which to specify a sort order.
Order Allows you to specify Ascending or Descending order for the field selected
above.
Add Transfers the sort configuration to the Sort list. You may add as many sort
configurations as you wish.
Sort list Lists the currently configured sort configurations.
Up Increases the priority of the entry selected in the Sort list.
Down Decreases the priority of the entry selected in the Sort list.
Delete Deletes the entry selected in the Sort list.
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.
1. In the workspace on the Design board, select the relational data service, and from the
context menu, choose SQL Editor (alternately, choose BI → SQL Editor).
2. See the reference below.
Structure
The main sections and controls of the SQL Editor are described below:
Section Control Description
Object Browser Browse tab Lets you browse or look for and select relational
data. See Find Data Services Task Panel [Page
73] for a description of the similar Look for
functionality for relational systems.
Select any type of relational metadata, and drag it
to the Editor pane, or double-click to add it at the
current cursor location. The unique name of the
selected metadata is added to the statement.
For security purposes, MDX Editor functionality is turned off by default in Visual
Composer. Therefore, if you try to access it you will see the message "You are
not authorized to use this functionality."
See Security Risks with the SQL Editor and MDX Editor [External] in the SAP
NetWeaver Visual Composer Security Guide for more information.
See the prerequisites described in the notes in BI Menu Dialog Boxes [Page
131].
To create a new OLAP data service using the MDX Editor:
...
1. In the workspace on the Design board, select the OLAP data service, and from the
context menu, choose MDX Editor (alternately, choose BI → MDX Editor).
2. See the reference below.
Structure
The main sections and controls of the MDX Editor are described below:
Section Control Description
9 Expression Editor
Definition
The Expression Editor is a dialog box displayed in a wide range of configuration tasks in order
to enable you to define a formula for a specific dynamic behavior.
Use
The expressions defined through the Expression Editor are evaluated at runtime, according to
the actual values returned in the runtime workflow. Expressions can be written for all element
attributes of the “formula“ or “expression“ type. This includes field initialization, calculation,
validation and text formatting, as well as display visibility and event guard conditions. The
expression syntax was designed for ease-of-use by non-programmers, being very similar to
that used to write spreadsheet formulas.
The dialog box is displayed when you:
• Click a Formula or Condition button
• Choose Enter formula from a drop-down list (which includes the fx symbol)
For full instructions about how to use the Expression Editor, see Define a Dynamic
Expression [External] in the SAP NetWeaver Visual Composer Modeler's Guide.
Structure
The Expression Editor dialog box is named differently according to the attributes being
defined. For example:
• When defining a Visibility condition in the Configure Element task panel, it is called the
Hiding Condition dialog box.
• When defining properties in the Control Properties dialog box, it is called, among other
names:
{ Computed Value dialog box (when defining a formula in the Expression field of
the General tab)
{ Dynamic Label dialog box (when defining a formula in the Label field of the
Display tab)
• When defining actions in the Create Toolbar Buttons dialog box, the Expression Editor
is called, among other names:
{ Search Formula dialog box (when defining a system-action expression in the
Search formula field)
{ Prompt Message dialog box (when defining a system-action expression in the
Prompt message field)
In all cases, the structure of the Expression Editor is the same and contains the following
sections:
• The Formula pane at the left, in which you construct the dynamic expression.
• The Assistant pane at the right, listing the available basic formulas, which you select
(and enter into the Formula pane) by double-clicking.
The Data Fields node at the top contains all of the fields available in the different model
components, for use in your formula.
The Operators node at the bottom lists all the operators available for use in the formula.
• 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.
Use
This dialog box is displayed when you right-click a component and choose Create Toolbar
from the context menu. You can display the dialog box on either the Design board or the
Layout board.
For an explanation of the procedure for creating a runtime toolbar, see Create a Toolbar
[External] in the SAP NetWeaver Visual Composer Modeler's Guide.
Structure
To create toolbar buttons, you use the buttons at the bottom left of the dialog box, naming
each button in the Button text field at the top. The buttons that you create are listed in the
Toolbar Buttons pane at the left.
Once you have added and named the toolbar button, you define the action assigned to the
button exactly as you do in the Control Properties dialog box. The contents of this dialog box
change according to the type of action you define for the button:
• A System action is a predefined event, such as closing a window or inserting a row.
You select the specific action from the System action drop-down list.
• A Custom action is a specialized action that you define, defining the name of the event
in the Custom action field
The options for defining these types of actions are described fully in Control Properties -
Action Tab [Page 102].
The following table describes the controls and fields of this dialog box:
Section Control Description
[Bottom left] Adds a new button to the toolbar
Moves the selected button one place up (to the left) in the
toolbar configuration
Moves the selected button one place down (to the right) in
the toolbar configuration
Adds a separator bar to the toolbar
Define Button Button text The text appearing on the button, which should
correspond to the event name defined for the connector
line
Define Action See Control Properties - Action Tab [Page 102]