BOD410 - EN - Col17 SAP Lumira Designer - Basic
BOD410 - EN - Col17 SAP Lumira Designer - Basic
BOD410 - EN - Col17 SAP Lumira Designer - Basic
.
.
PARTICIPANT HANDBOOK
INSTRUCTOR-LED TRAINING
.
Course Version: 17
Course Duration: 5 Day(s)
e-book Duration: 5 Hours 10 Minutes
Material Number: 50155684
SAP Copyrights, Trademarks and
Disclaimers
Demonstration
Procedure
Warning or Caution
Hint
Facilitated Discussion
TARGET AUDIENCE
This course is intended for the following audiences:
Application Consultant
Development Consultant
Technology Consultant
Business User
Lesson 1
Describing the positioning of SAP Lumira 2
Lesson 2
Describing the Architecture of SAP Lumira, Designer Edition 4
UNIT OBJECTIVES
LESSON OBJECTIVES
After completing this lesson, you will be able to:
The convergence of SAP BusinessObjects Lumira and SAP BusinessObjects Design Studio,
has the following benefits:
SAP Lumira 2.x is one tool, with two combinable user interfaces.
LESSON SUMMARY
You should now be able to:
LESSON OBJECTIVES
After completing this lesson, you will be able to:
Architecture
SAP decided to streamline the platform strategy for SAP Lumira Designer for the following
reasons:
Going forward, SAP intends to focus on SAP Lumira Designer investments on the BI platform.
We recommend that all customers deploy SAP Lumira Designer on the BI platform.
SAP NetWeaver and SAP HANA deployments only support a minimal feature scope. New
investments are not planned.
LESSON SUMMARY
You should now be able to:
Lesson 1
Understanding and Using the Format LUMX 8
Lesson 2
Creating an Application with Online Data Access 12
Lesson 3
Using a Data Source with Data Acquisition 17
Lesson 4
Creating a Basic Application 20
Lesson 5
Using Filter Components 27
Lesson 6
Using Data Bound Component Properties 33
Lesson 7
Using Scorecards 36
Lesson 8
Using Structural Elements for Design 39
Lesson 9
Creating the Simple Map Component Presentation 45
Lesson 10
Using Composites 49
Lesson 11
Describing Interoperability Between BI Clients 53
Create an application
Use composites
LESSON OBJECTIVES
After completing this lesson, you will be able to:
SAP Lumira Documents mode is the default mode of SAP Lumira Designer. It can be
considered as the 2.x mode. In this mode, you can create new applications to use the 2.x
features, such as composites and bookmarks. This mode can handle both local documents
and documents stored on the BI platform.
Note that, as in SAP Lumira Designer, local documents are meant for demo purposes only.
Store documents meant for productive use on the BI platform.
If you have used SAP BusinessObjects Design Studio before, you are familiar with BI Platform
mode (legacy) and Local mode (legacy). In SAP Lumira Designer, you can consider those
modes as the design-studio-compatibility modes.
You work with these modes just as you would in SAP BusinessObjects Design Studio. The only
exception is that you cannot create new applications using New or Save As. As a workaround,
you can create copies of SAP BusinessObjects Design Studio applications in the BI
Launchpad. You can open, edit, and save existing SAP BusinessObjects Design Studio
applications in these modes.
You need these modes as a starting point for a conversion of existing SAP BusinessObjects
Design Studio objects.
In SAP Lumira Designer, users can create applications and composites. Multiple applications
and multiple composites can be created within one LUMX file.
A LUMX file created in SAP Lumira Discovery contains one or multiple stories and data sets
(for example, acquired Microsoft Excel files). Since data sets can be shared between stories in
SAP Lumira Discovery, they are not contained within a story element. Instead, they are stored
as root level objects in the LUMX file. They are available as offline data sources in SAP Lumira
Designer.
LUMX files, regardless of their content, are the entities that are exposed to the BI platform
and its users. Administrators secure SAP Lumira documents by defining user authorizations
for LUMX files in BI Launchpad folders.
One of the significant changes for users of SAP BusinessObjects Design Studio, is the new
Documents view in SAP Lumira Designer. This view is only available in Documents mode. In
this new mode, you can handle both local documents and documents on the BI platform.
Documents created in the local file system appear under the Local Documents folder node in
the figure, SAP Lumira Designer - Documents View 1. However, local documents are meant
for non-productive purposes only. For example, if you want to test a feature of SAP Lumira
Designer, or if you want to create a demo application that you do not need to share with other
users. In a default installation, the local documents folder is located as follows: C:\Users
\ <userid> \Documents\SAP Lumira Documents
You would create documents that are meant to be used by multiple users on the BI platform.
Those documents appear under the BI Platform Documents folder node in the figure, SAP
Lumira Designer - Documents View 1.
Note:
In SAP Lumira Designer, make sure that you create a document that is meant for
productive use on the BI platform from the very beginning.
In the figure, SAP Lumira Designer - Documents View 2, you can see the Create Document
option and the Download Documents option.
The Create Document option allows you to create a new, empty document (LUMX file) on the
BI platform.
The Download Documents option allows you to open an existing LUMX file from the BI
Launchpad folders. Any documents that you download from the BI platform appears under
the BI Platform Documents folder node. They are kept by the designer component of SAP
Lumira as local copies. These local copies are not to be confused with the documents under
the Local Documents folder node.
SAP Lumira Designer also remembers the original location on the BI platform (BI Launchpad
folder), and ensures synchronization with the BI platform. SAP Lumira Designer edition
checks the state of the local copy against the state on the BI platform, to determine whether
they are in sync. Therefore, it is a good idea to remove documents from the client if you know
they are not being worked on.
To edit a document in SAP Lumira Designer, you need to open it. To do so, right-click the
document, and choose Open. You can recognize open documents by the dark font. While
documents that are not open are displayed in grey font.
When opening a document, SAP Lumira Designer reads all metadata, detects dependencies,
and loads acquired data from discovery documents. It also performs a number of other tasks,
which can be time consuming. This is the reason why not all documents under the BI Platform
Documents and Local Documents folder node are automatically opened by default.
Once you start editing the document in SAP Lumira Designer, an asterisk (*) appears in front
of the document name. This indicates that the local copy is out-of-sync with the version on
the BI platform. The same indicator appears if someone else modifies the version on the
server. In case of conflicts between local and server changes, a merge dialog appears to help
to resolve the conflicts.
In the figure, Defining the Default Application, you see the open LUMX document: Global
Fashion Material Trend Analysis.
The document contains one SAP Lumira Discovery component story: Story -01. As well as two
SAP Lumira Designer component applications: APPLICATION_01 and APPLICATION_02.
You need to define which of these three executable elements should be displayed when an
end user opens the LUMX document from the BI Launchpad. To do this, define the default
application in the context menu of the document itself.
If you use the OpenDocument functionality of the BI Platform, you can add the URL parameter
&APP_TO_LAUNCH= <applicationname> to the URL of the LUMX document to start a non-
default application.
LESSON SUMMARY
You should now be able to:
LESSON OBJECTIVES
After completing this lesson, you will be able to:
Create an application
The figure, Welcome Page, shows the sections Getting Started, Create New, Recently-Used,
and Useful Links.
In Getting Started, you can watch recent tutorials.
In Create New, you can create a new application.
In Recently-Used, you can directly open applications or composites you have worked on.
In Useful Links, you can open related public resources.
Figure 15: Define and Design the Application: Main Screen Elements
Documents
Components
Outline
Layout
Properties
Additional Properties
Script Problems
Search Results
Error Log
Supported Platform:
SAP Lumira Designer only supports universe access as of BI platform 4.2.
Supported Universe Types:
SAP Lumira Designer supports the following universe types:
Relational universes
Single-source universes
2. In the Outline tab of the design tool, right-click Data Sources, and choose New.
3. Use Copy and Paste from another Design Studio application, or within an application.
4. Use the interoperability features from SAP BusinessObjects Analysis for Microsoft Office
or SAP Lumira Discovery.
The Initial View dialog allows you to modify the initial state of any data source.
You can change the following data in the initial state of a data source:
The active hierarchy (if available), and its initial expansion level.
The totals display mode (show, hide, hide if only one member).
The Initial View dialog allows you to use predefined hierarchies. Hierarchies must be
activated. The Initial view assistant cannot initiate hierarchies.
Activate hierarchies provide the following options:
In the Components view, click a component, and drag-and-drop it into the preview area.
Alternatively, drag-and-drop the component into the Layout folder of the Outline view.
LESSON SUMMARY
You should now be able to:
Create an application
LESSON OBJECTIVES
After completing this lesson, you will be able to:
SAP Lumira Discovery allows you to change and work with imported data from different
sources.
You can import data from SAP Business Warehouse, add new data, and use the imported
data for calculating or aggregating functions.
SAP Lumira Discovery can also be used to merge data from different sources.
The new dataset can be used by all tools of the SAP Lumira family. This allows the designer
component of SAP Lumira to access the same information level as the discovery component.
Hint:
This can only be done with imported data. There is no live data support for that
kind of data manipulation.
Upon acquisition, SAP Lumira Discovery converts the data into a flat file structure (rows and
columns). This makes it easier to combine data across multiple sources.
Once you complete the data acquisition, select the Data View option.
After changing and setting the data configuration, the changes can be used further.
This data source is now ready to be used in the discovery edition, but can also be exported to
the designer component, using the same .lumx document.
After saving the document, the lumx file contains data about changes to the data source.
After opening the same document, SAP Lumira Designer can recycle all data about the used
data set. The old data source, from SAP Lumira Discovery can now be part of a new
application in SAP Lumira Designer.
In a new application in SAP Lumira Designer, the reuse of data from the data manipulation
tool is called an internal data acquirement solution in SAP Lumira 2.x.
Data can be prepared and further used in the discovery edition.
LESSON SUMMARY
You should now be able to:
LESSON OBJECTIVES
After completing this lesson, you will be able to:
Table components, such as crosstabs, help you to visualize your data. After you have dragged
and dropped a crosstab into the layout editor, the component initially displays a placeholder
waiting for data from your individual data source.
Once you assign a data source to the crosstab, it displays the data of the data source.
The Chart Components folder contains a number of components with different functions.
Components, such as Chart, help you to visualize aggregated data. Components, such as the
Chart Feeding panel or the Chart Type Picker, help you to navigate through the possibilities
that the chart components have granted. It helps you to customize components in your
application.
The Basic Components folder contains a variety of components with different functions. Filter
components, such as Dropdown Box, Radio Button, and Checkbox, are used to select or filter
data, and thus enable user interaction at runtime.
Components, such as Button and Image, are used to enable navigation. Whereas components
such as Text and Date Field are used to enhance the design and layout of the application.
Container components are used to group and structure the content of an application. They
can also be used to optimize an application for a mobile device, and thus enable specific
motion gestures in mobile applications.
The application designer can choose to enable or disable navigation functions, such as
hierarchical navigation, sorting, and column resizing.
Exceptions defined in the SAP BW backend, or in conditional formatting rules for SAP
BusinessObjects Analysis for Microsoft Office, can be activated in the crosstab setting.
The width of each column within a crosstab can be adjusted individually. A context menu is
available and can be adjusted. A report-to-report interface is also supported.
The context menu enables the application user to navigate and analyze data at runtime.
Additionally, for each crosstab, you can decide if you want to have a context menu or not.
The context menu enhances the optional function of a crosstab, without scripting.
The context menu must be activated in Outline, as a technical component.
You can add entries to the context menu in the properties of the context_menu component.
You can show and hide the standard entries, via scripting commands.
Many formatting options can be given to the user of the application by special formatting
components.
These formatting components have the following benefits:
More flexibility
The Data Selection dialog allows you to select single or multiple rows, or columns from the
data source. This allows you to define different charts from the same data source.
Data binding can be used to restrict data on columns, rows, and cells of the Initial view.
Data binding is used to restrict data in a view, without using a query filter. It depends on an
area of the Initial view, which can be chosen in the Binding Assistant.
The Binding Assistant has its own syntax, and can be used to extract different calculated
areas of the Initial view.
Data binding can be used in many ways:
The data volume in the Initial view is not reduced, so it can be used further in another
component. It can only be used for a component where it is defined — it cannot be copied.
Each component is bound to its surrounding borders. These borders can be the borders of the
application, or a surrounding object, such as a Tabstrip.
For each axis (horizontal or vertical), specify the three values. One of these values is always
defined as Auto. You can specify the position values in the Layout Properties of each
component.
SAP Lumira Designer allows you to align and distribute components. It is convenient for
designers to organize components, without writing exact margin. All types of components can
be aligned and distributed.
Components within the same container, or under the same root, can be aligned and
Alignment and distribution can be done via the context menu in layout, or via buttons in the
SAP Lumira Designer menu.
LESSON SUMMARY
You should now be able to:
LESSON OBJECTIVES
After completing this lesson, you will be able to:
The Navigation Panel allows end users to navigate data, via drag-and-drop (dimensions and
measures). In the navigation panel, measures can be shown separately.
It has a simplified view (as a dimension list), in which the order of dimensions can be
determined in design time.
It also has a search bar for quick access to dimensions and measures, and a list-only function.
Filter Only
Navigation Only
To filter values, the user can use the direct input option, or the member selector option. This
depends on where the user clicks during Application Runtime.
The filter line is a horizontal filter area. End users can easily select filter criteria and filter
values.
Application designers can configure whether key figures are included in the filter line.
Configuration is completed through properties. No scripting effort is required.
The dimension filter is a more convenient way to use the filter panel for selecting data.
The member display can be defined with key, text, or both.
The Submit event enables triggering interactions.
Dimension names can be hidden or shown.
Ranges can be defined in addition to the multiple selection of members. Defined ranges and
selected members can be deleted, included, or excluded.
The filter bar can be hidden or shown. Filters can also be separately administrated.
The design element, for showing and using filter elements in a report, ensures more
interactivity for users.
In the Prompts dialog, application designers and application users set values for prompts.
For SAP NetWeaver BW, data sources and prompts are defined as variables. Variables are
created in the Query Designer.
Note:
SAP Lumira Designer cannot create variables.
SAP Lumira Designer generates a generic prompt screen. If prompts are defined as
mandatory, and do not have a valid default value, it is set to Force Prompts on Startup or
Merged Prompts, in the properties of the application.
To use the compact mode, set the application property Compact Prompts Enabled to true.
The variable names and the corresponding input fields are arranged horizontally one behind
the other in this mode.
With the application property Value Help Settings you can use the Value Help Settings
technical component for the Prompts dialog. You can configure the Value Help Settings for all
dimensions provided by the data source that you have assigned to the application.
Use Variants
You can use variants to store selection data for variables in an SAP BW query. To use this
functionality, the designer must set the application Prompt property Variant Mode either to
Query variants or Document variants .
For a user to create a variant, he simply types the name of the variant in the variant box in the
prompt dialog and saves it.
Once saved, the variant is available the next time the application is used.
LESSON SUMMARY
You should now be able to:
LESSON OBJECTIVES
After completing this lesson, you will be able to:
Component properties have data binding functions to set the value of the property.
Properties are automatically updated when the bounded data source changes. This saves a
lot of scripting, and is denoted in the properties area with the plus symbol (+).
3. Choose OK.
Basic component properties can be defined by a combination of data binding and formatter
function.
Function parts are automatically updated when the bound data source changes. This saves a
lot of scripting.
You can review the formatter functions in your Central Functions, in the Outline view (central
administration). You can format by data source.
LESSON SUMMARY
You should now be able to:
LESSON OBJECTIVES
After completing this lesson, you will be able to:
The Scorecard component is designed for use in dashboards, and reports with controlled
visualization content and restricted navigation possibilities.
The Scorecard component is not recommended for use in applications with dynamic data
sources, or data sources with free multidimensional navigation.
You can add a Scorecard Analytic component to an analysis application. This allows users to
view the data as a highly customizable table, with the addition of micro-charts in columns.
Depending on how you configure the Scorecard column properties, each column can display
information in the form of text, image, or charts. Each column property can be connected to a
selection of the assigned data source.
Header and column customizing allows you to select data from a result set. It contains multi-
line headers, merged header cells, custom column header texts, text alignment, and custom
column formats.
Rule-based highlighting shows exceptions from the BW query as trend or status icons,
colored text, or background. It also shows conditional formats in smart copied SAP
BusinessObjects Analysis for Microsoft Office views.
Micro charts refer to variance and trend charts.
Auto-Generation does not analyze any specialties of the data source. For example, it assumes
that all dimensions have result members activated.
You have to check all selections and properties of the generated columns, and ensure that the
selected data is fulfilling your requirements.
LESSON SUMMARY
You should now be able to:
LESSON OBJECTIVES
After completing this lesson, you will be able to:
You can use the Grid Layout component to group and order the content of your application in
a grid, which is not displayed at runtime.
It helps to arrange different objects in the same alignment.
The Pagebook component enables the user to switch between different views of an
application.
You group the components and contents of a view on a separate page. The Pagebook shows
one page at once.
Note:
The pages are shown in the Outline view.
If you drag-and-drop a Pagebook component in the layout editor, the system
automatically creates two pages for the Pagebook.
If you want to add more pages to the Pagebook, go to the Outline view, open the
context menu of the Pagebook, and choose Create Child Page.
Use the Tabstrip component to group and order the content of your application in tabs. You
can also use it to enable user interaction within the application.
With the selected tab index property, you can specify which tab is displayed initially. This
Index starts with 0, which means that the first tab is Index = 0
You use the Panel component to group other components in your application. The Panel
component is a simple container component. The components nested in the Panel are
positioned relative to the Panel, and not to the application borders.
With the use of the CSS Style property, you can visually group the nested components
together. For example, with a border.
Dialog
Panel
Popup
Story
Tabstrip
You can use the Tile Container component to create a responsive application that
automatically adapts to the number of tiles per row, automatically wrap them, according to
the browser size of the viewing device. You can specify the width and height of the tile during
the Design time.
The Tile Rows allow the grouping of tiles so that you can set certain tiles to be vertically below
others and therefore will never overlap. The Tile Container contains a series of Tile Rows
which in turn contain a series of Tiles. Each tile row can contain multiple tiles. The Tile Rows
allow vertical separation of Tiles. The Tile Rows allow the wrapping of the tiles horizontally
while the rows themselves are wrapped vertically using the Tile Container.
A tile allows the user to add components to build an application. Each tile can contain any
component. Tiles can be resized to any width and height, and tiles in a row do not need to be
sized equally. Once defined, the tile width and height is fixed on all devices and only the
number of tiles per row changes dependent on the browser size.
The Popup component helps users to enter information, perform configurations, or make
selections. In addition, popups can also be useful for displaying more specific data for a
selected item displayed on the main page of the application. Since the popup is a container
component, you can put any other component into the popup. For example, crosstab, button,
or checkbox.
Restrictions of the Popup component are as follows:
The popup can only be nested in the root layout, and not within another container
component.
You use the Dialog component to create a dialog box, with or without buttons. The dialog can
only be used in the root layout. You can only set the height and width of the component. You
can place further elements, items, or components inside the dialog, but not in the header area
or footer.
Hint:
The Dialog component only works with SAPUI5 rendering mode. It must be
opened by API.
You use the Image component to enhance applications, by adding images. Depending on the
deployment type, the images are stored in different places.
Images can be changed dynamically, using scripting, to react to various elements. For
example, active filters.
Using more than one structural element has the following benefits:
Hint:
A grid box that is integrated in another container element, can help to align and
position objects easier.
LESSON SUMMARY
You should now be able to:
LESSON OBJECTIVES
After completing this lesson, you will be able to:
The map allows you to display and interact with geographical information on a map.
The main features of the map are as follows:
The first step in creating a map, is to drag-and-drop the Map component from the Chart
Components, onto the canvas.
The map-specific properties are:
Basemap URL
Basemap Copyright
Additional Properties
MapQuest
http://otile1.mqcdn.com/tiles/1.0.0/map/{LOD}/{X}/{Y}.png
MapQuest Satellite
http://otile1.mqcdn.com/tiles/1.0.0/sat/{LOD}/{X}/{Y}.png
http://server.arcgisonline.com/ArcGIS/rest/services/World_Street_Map/MapServer/
tile/{LOD}/{Y}/{X}
Nokia HERE
http://1.base.maps.cit.api.here.com/maptile/2.1/maptile/newest/normal.day/
{LOD}/{X}/{Y}/256/png8?
app_id=DemoAppId01082013GAL&app_code=AJKnXv84fjrb0KIHawS0Tg
Stamen Watercolor
http://tile.stamen.com/watercolor/{LOD}/{X}/{Y}.png
Stamen Toner
http://tile.stamen.com/toner/{LOD}/{X}/{Y}.png
To add a layer, click the Add Layer (+) button, located at the top right.
Reordering layers:
If LAYER_1 is above LAYER_2 in the properties, this is reflected in the geo map.
ID:
A unique identifier used when scripting the layer.
Show Layer:
To show or hide a layer. This can also be done through scripting.
The geographic dimension should be in the rows and contain an identifier that represents
the desired shapes
LESSON SUMMARY
You should now be able to:
LESSON OBJECTIVES
After completing this lesson, you will be able to:
Use composites
Composites are components, which can be created by an application designer. They are
similar to SDK components, but the application designer does not have to be a software
developer.
In addition, composites, like applications, can contain other components and data sources.
This allows you to group user interface elements and corresponding business logic into a
dedicated composite.
This can be used for refactoring purposes to group a subset of an application. For example, a
header or repeating elements in your applications. Alternatively, it can be used to make the
subset reusable so it can be shared with other application designers.
In this use case, you would create an application that contains the shell, such as a header,
toolbar, footer, and a tabstrip. As well as one composite for the contents of each page, which
you embed on the pages of your pagebook/ tabstrip component in the application.
In this use case, you would put the application and the individual page composites in one
LUMX file. This keeps them together and manages the whole thing as one object on the
platform.
However, if multiple users are meant to work independently on individual pages, you would
separate the application and composites in multiple LUMX files. In this way, you can use
authorizations to control which users can edit the individual parts.
In this use case, you would put the composite in a dedicated LUMX file to keep it separate
from LUMX files containing the applications. You can use the composite in multiple
applications, even if it is contained in separate LUMX files.
You can group multiple composites that belong together in one LUMX file, so as to form a
library of re-usable components.
Hint:
LUMX files, containing only composites, are hidden from end users in the BI
Launchpad. The recommendation is to store this composite library of LUMX files
in dedicated folders on the BI platform. In this way, you can deny view rights for
end users on the folder, while not propagating this right to content and sub-
folders in this folder. This hides the folder and its contents from end users, while
keeping all necessary access rights on the composite library LUMX files.
Composites are only supported in the SAP Lumira Documents mode of the SAP Lumira
Designer.
Applications can use composites from the same document and other documents. To use
composites from another document, the referenced document must already exist.
Therefore, dependent documents need to be considered during transportation of objects
(promotion), for example.
One composite can be part of multiple applications. One application can contain multiple
composites, even if they are of the same type.
You can nest composites one in another. There is no restriction on the nesting level.
However, you cannot drag a composite into itself, either directly or indirectly via some
intermediate composite, as the run time will fail if such a circular reference exists. The
system tries to prevent the creation of circular references by showing the error message
Composites cannot be nested recursively. However, circular references cannot be
prevented in all cases.
All available composites of open documents are shown in the Components view. They are
listed in the Composites area by default. While creating a composite, the designer can specify
the component group name.
You can drag-and-drop a composite into the layout of an application, or into the outline dialog,
just like any other component.
Double-click a component to open the element itself, so that you can modify the definition.
After adding a composite to an application, you can do the following:
1. Define Properties
2. Define Events
LESSON SUMMARY
You should now be able to:
Use composites
LESSON OBJECTIVES
After completing this lesson, you will be able to:
Figure 74: Interoperability of SAP Lumira Discovery and SAP Lumira Designer
End users who create storyboards, and require them to be tailored towards enterprise-wide
dashboards, can now do this easily in the same SAP Lumira product.
SAP Lumira Discovery enables simple data exploration, data blending, and data
visualizations. This can be done through the use of a storyboard.
Storyboards provide the user with an advanced and focused view of different datasets.
The restriction of the storyboard is that data presentation is focused on the simple creation of
a data-dependent, graphical view.
If a user needs additional, advanced features applied to the storyboard, SAP Lumira Designer
offers the solution, for example Javascripting, different components, functions such as
selectors, and so on.
You can import the SAP Lumira Discovery storyboard to SAP Lumira Designer, use the
potential, and send it back.
You can also improve a story by merging different storyboards into one.
The designer component creates one dashboard application, in which you can collect
different storyboards, with different intentions.
Access to other BI tools, via Open Document link and URL Linking.
Figure 77: Document Reuse: SAP Lumira Discovery to SAP Lumira Designer
Content created in SAP Lumira Discovery can be seen in SAP Lumira Designer, but not the
other way around.
Keep in mind that SAP Lumira Discovery cannot work directly with applications and
composites.
You can edit or enhance stories which are created in SAP Lumira Discovery, in SAP Lumira
Designer. This can be used to add elements that are not available in the discovery component,
such as navigation components.
All composite components in a LUMX document is used as stories in the discovery
component.
To add a new story to a LUMX file in SAP Lumira Designer, you need to add a new Composite
component to the file. Within this composite, you can use a Story component to achieve the
SAP Lumira Discovery look and feel.
The newly created story is available in read-only mode in the SAP Lumira Discovery.
After opening a LUMX file in SAP Lumira Designer, you can create one or many applications.
If the LUMX file contains imported data, you can reuse this dataset as an offline data source in
an application.
If the LUMX file contains online connections, they are part of the reusable story (composite
component). From there, you can copy and paste online data sources into your application.
The created application is not visible in the SAP Lumira Discovery.
The story remains editable in SAP Lumira Discovery, unless it was changed in SAP Lumira
Designer.
SAP Analysis for Microsoft Office enables you to create data sources using methods that are
not available in SAP Lumira Designer. You can use calculations to change a data source for
example. You may then want to use this changed data source in SAP Lumira Designer.
To use a data source created in SAP Analysis for Microsoft Office, the following prerequisites
apply:
Make sure that you have installed SAP Analysis for Microsoft Office and SAP Lumira
Designer on your machine.
Make sure that you use both tools in either the local mode or with a BI platform. Otherwise
you cannot insert an exported data source.
In Analysis for Microsoft Excel, you can copy a crosstab or chart that is currently displayed in
the workbook. Once you have changed and saved the data source, choose Smart Copy . The
data source is copied to the clipboard.
Note:
In SAP Analysis for MS Office you have the possibility to choose Create Web
Application . With this functionality you can transfer the whole workbook to SAP
Design Studio. See SAP note 2636541 for using this functionality with SAP Lumira
Designer.
In SAP Lumira Designer, there are two ways to insert this data source:
Right-click the Data Sources folder (or any data source listed in this folder) in the Outline
view and click Smart Paste . The data source in your clipboard is inserted into the Data
Source folder. You can now assign this data source to components in the editor.
Right-click the Layout folder (or any element listed in this folder) in the Outline view and
click Smart Paste . The data source in your clipboard is automatically inserted into a
crosstab component and displayed in the editor.
LESSON SUMMARY
You should now be able to:
Lesson 1
Using Standard and Custom Templates 60
Lesson 2
Working with Themes, CSS Formatting, and the Embedded CSS Editor 64
Lesson 3
Using Conditional Formatting 67
UNIT OBJECTIVES
LESSON OBJECTIVES
After completing this lesson, you will be able to:
SAP Lumira Designer offers a set of predefined templates, which serve various design and
business needs. When you choose a predefined template, the system automatically creates a
copy of this template. You can change the copy according to your needs.
Provided templates have the following functions:
You can use standard templates to create a new document or a new application, with a
predefined template. You can easily adapt and extend the template, using a data source of
your choice.
The available standard templates are as follows:
The Generic Analysis template has no data source assigned by default. You can keep the
template as it is, execute it, and assign a data source at runtime. This means that the
template remains generic and independent of the data sources.
The Generic Analysis template contains the following elements:
Menu
Filter Area
Navigation Area
Action Area
Simplified Layout
Drag-and-Drop
LESSON SUMMARY
You should now be able to:
LESSON OBJECTIVES
After completing this lesson, you will be able to:
Working with Themes, CSS Formatting, and the Embedded CSS Editor
You can define the used theme in the properties of your application.
In the CSS Style attribute, you can specify the following CSS attributes:
Font size
Font color
Weight (bold)
Style (italic)
This attribute provides advanced options for text formatting. You can type in the CSS style
code directly. Alternatively, you can use an external CSS style editor (such as CSSMate) to
generate code for the CSS attributes you want to use. Copy this code into the CSS style editor
of the design tool.
The CSS attributes listed previously are supported for both desktop browser, and Apple iPad
or iPhone applications.
If you use any other CSS attributes in the external CSS style editor, run the application on
your target device to check whether the text is displayed as required, and as defined by the
attributes.
You can use an external CSS file to adopt customer corporate identity to your applications.
To do so, perform the following steps:
LESSON SUMMARY
You should now be able to:
LESSON OBJECTIVES
After completing this lesson, you will be able to:
Conditional Formatting
Introduction to Conditional Formatting
Application designers and business users running applications can use conditional formatting
for analysis. Values in the application can be displayed according to formatting rules, which
can be based on values of measures or dimensions.
SAP Lumira Designer offers these tools regarding conditional formatting:
BEx Exceptions
Using the BEx Query Designer in SAP BW, BEx Exceptions can be defined on BEx Queries. BEx
Exceptions include rules of conditional formatting, containing a maximum of 9 BEx Level
Exceptions (from extremely bad to extremely good) for each rule. If a data source in SAP
Lumira Designer is based on a BEx Query which includes a predefined BEx Exception, these
rules can be reused.
Application designers can reuse BEx Exceptions in components, for example crosstabs and
charts, by setting the Conditional Formatting Visible in the component properties to the value
True .
Business users running these applications can than use the context menu option Conditional
Formatting to launch the BEx Exception Manager. With the BEx Exception Manager business
users can set predefined BEx Exceptions to active/non active or create their own rules.
Note:
It is not required to initiate the technical component Conditional Formatting
Settings to use BEx Exceptions. However, it is possible to use BEx Exceptions in
Conditional Formatting Settings .
To make conditional formatting rules visible on components when running the application, the
following steps need to be taken:
1. In the properties of the selected component set Conditional Formatting Visible to True .
2. Conditional Formatting Settings must be set to your component by setting the Applied
checkbox for the desired rule in the Conditional Formatting Rule Manager .
Business users running these applications can than use the context menu option Conditional
Formatting to launch the Conditional Formatting Rule Manager . With the Conditional
Formatting Rule Manager business users can apply predefined conditional formatting rules,
change the format of predefined rules or create their own rules.
Restrictions of the Conditional Formatting Settings component are as follows:
Hierarchy of rules.
The first formatting rule has higher priority than the following rules. This means that you
have to pay attention to the sorting of the rules, if you are using more than one rule on a
component.
Using the Show Conditional Formatting Items chart property, you can decide that the
conditional formatting settings are displayed in the legend of a chart. You can also decide to
maintain the original legend items, by selecting the Keep Original Legend Items chart
property. These properties are in the Legend area of the Properties tab, within the Configure
Chart dialog.
Figure 97: Using BEx Exception Manager in Conditional Format Settings Dialog
LESSON SUMMARY
You should now be able to:
Lesson 1
Describing the Script Editor 73
Lesson 2
Defining the Navigation Behavior of Basic Components by Scripting 78
Lesson 3
Using Conditional Statement in Scripts 83
Lesson 4
Using Metadata and Single Values in Documents 84
Lesson 5
Using Variables in Scripting 87
Lesson 6
Using Keyboard Shortcuts 91
Lesson 7
Outling Export Scenarios 93
Lesson 8
Using Action Sheets 97
Lesson 9
Describing Commentary Functionality 100
UNIT OBJECTIVES
LESSON OBJECTIVES
After completing this lesson, you will be able to:
Script Editor
The Script Editor allows for the flexible definition of interactions between components.
It is a JavaScript-based command editor, with an easy-to-use scripting wizard, and intuitive
content assistance via CRTL+SPACE.
You can display live data for selection, use built-in documentation for script API, and
automatically check for the correctness of the scripting.
The scripts are executed on the Analysis Application Design Service (unlike JavaScript, which
is executed in the web browser).
Call statements execute an API method of an object. They have the following format:
<ComponentVariable>.<method>(<arguments>);
<ComponentVariable> is the name of a data source alias or a component in your
application. For example, DS_1 or Button_1.
<method> is an operation that is applied to the object specified on the left of the period. The
available methods depend on component type. Data Source Alias objects, for example,
provide methods to filter data, and visual components provide methods to modify visibility.
<arguments> is a comma-separated list of expressions. The passed expressions must match
the requirements of the method.
Each statement ends with a semicolon (;).
Also, the ForEach loop belongs to the call statements.
The system automatically checks the syntax of your script in the background. If there is a
mistake, you see an error marker on the left-hand side, and the bad code is underlined. You
can hover over the error marker, or the underlined text, to see the error message.
When you hover over the script text, and keep the mouse pointer still, you see additional
information about the text. For example, if you hover over a data source alias name, you see
the corresponding query or query view data source. Or if you hover over a dimension, you see
its display name.
Each script is validated before it is executed. If an error is found, for example, in the syntax,
the script is not executed. Instead, a log entry and a message are created and displayed.
As an application designer, you can use the following application methods to analyze the
general behavior of your application:
log
alert
createErrorMessage
createWarningMessage
createInfoMessage
If you use the methods log and alert, the results are displayed in the design tool. For example,
if you want to find out whether or not a certain script has been aborted, you can add the log or
alert call statements, with a user-defined message as the last line of the script.
If the message does not appear in a dialog (application method alert), or in the Error Log view
of the design tool (application method log), this means that the script has been aborted. You
can add more messages to the script, to find the exact statement that causes the script to be
aborted.
If you use the methods createErrorMessage , createWarningMessage or
createInfoMessage , the results of the analysis are displayed in the executed application.
They can be viewed on external machines or mobile devices (for example, Apple iPads).
LESSON SUMMARY
You should now be able to:
LESSON OBJECTIVES
After completing this lesson, you will be able to:
Buttons enable the user to interact within the application. To do this, add a script to the
button's OnClick property.
The script is triggered when the user clicks the button in the application. You can insert any
text for the button label and add an icon.
Example code to fill DROPDOWNBOX1 with all divisions from data source 1:
DROPDOWN_1.setItems(DS_1.getMemberList("0DIVISION",
MemberPresentation.INTERNAL_KEY, MemberDisplay.TEXT, 50));
The two bold arguments represent the two columns: Value and Text (Optional).
Checkboxes enable the user to interact within the application. To do this, add a script to the
On Click property of the checkbox component. The script is triggered when the user activates
the checkbox in the application. You can use any text for the checkbox.
The date field component enables the user to select a date. To activate user interaction with
the date field, you need to add a script to the On Select property. The script is triggered when
the user picks a date in the date field, or when the user enters a date manually at runtime.
The input field enables the user to write user-specific content in the input field at runtime.
Type conversion is a simple converting of formats. It can only be used for the moment the
script is executed, not any further.
Simple mathematical functions are available. They can be used to manipulate data, but only in
the moment a push event indicates them to be executed.
You can use the context-sensitive help function to create the basic syntax in your script.
Technically, this is done via a scripting template. These templates can be maintained under
Tools Preferences.
LESSON SUMMARY
You should now be able to:
LESSON OBJECTIVES
After completing this lesson, you will be able to:
Multiple conditions combined with && and ||, parentheses are optional.
LESSON SUMMARY
You should now be able to:
LESSON OBJECTIVES
After completing this lesson, you will be able to:
To read single bits of information, you have a variety of different commands, such as:
getDimensionText(dimension)
getInfo()
getFilterExt(dimension)
getConditionalFormatValue(measure, selection)
getStaticFilterText(dimension)
getVariableValueText(variable)
There are additional commands available, depending on, for example, how you want to
reference dimension members (with internal key or with external key).
Figure 121: Reading Data from Data Source: Example (incl. Scripting and Positioning of Components)
For example:
var t1 = DS_1.getData("D8V8M1UZETXM7FJDQMJJ9SRV8",
{"T_SOLD_TO__0COUNTRY":"DE"}).scalingFactor;
var t2 = DS_1.getData("D8V8M1UZETXM7FJDQMJJ9SRV8",
{"T_SOLD_TO__0COUNTRY":"DE"}).formattedValue;
var t3 = DS_1.getData("D8V8M1UZETXM7FJDQMJJ9SRV8",
{"T_SOLD_TO__0COUNTRY":"DE"}).unitOfMeasure;
var t3 = DS_1.getData("D8V8M1UZETXM7FJDQMJJ9SRV8".
if (t1 == 1000000)
{TEXT_1.setText("in Million");}
else
{TEXT_1.setText("");}
TEXT_2.setText((t2));
TEXT_3.setText(t3); ……………
LESSON SUMMARY
You should now be able to:
LESSON OBJECTIVES
After completing this lesson, you will be able to:
Local script variables are script variables that can only be used in the script in which they were
defined. To define a local script variable, open a script with the Script Editor and add a line of
the following format:
var <variable> = <expression>;
The type of the script variable is automatically determined by the type of the expression.
Global variables can be defined as special class in Global Variables in the Outline view. Once
you have created a new global variable, you can use it in your document. They can be used as
Array and as URL Parameter.
When you create a global script variable, you can specify the following properties of the
variable:
Name
Description
Data Type
Array
Default Value
When you execute the application, you can specify the URL parameter by adding, for
example: http://<<applicationURL>>&Xcurrency=USD
Script variable names used as a URL parameter must start with a capital X.
URL parameters can be used to start other BI documents with predefined filter or variable
settings, using the open document syntax.
Convert.urlEncode encodes a string into x-www-form-urlencoded format. This is useful
if the string is used as a parameter of a URL.
For example, in the following sample Convert.urlEncode("Hello world!"); , the
returned string is "Hello+world%21" .
In SAP Lumira Designer, you can define global script objects to reuse scripting.
To create a new global script object, perform the following steps:
3. Enter the function name in the Create Script Function dialog, and choose OK.
The Create Script Function dialog displays.
4. Enter a description and the code for the global script function.
Each script function has a configurable return type, and can have any number of typed
input parameters.
When you use data bound properties, you can additionally use formatter functions, which are
always part of a global script object.
Lets assume you write the value of a cell in a text component. The typical output would be
22.147 EUR .
To change the standard output, you can use a formatter function to get an output such as The
value is: 22.147 Euro .
LESSON SUMMARY
You should now be able to:
LESSON OBJECTIVES
After completing this lesson, you will be able to:
Keyboard Shortcuts
You can create your own set of keyboard shortcuts, using the Keyboard Shortcuts technical
component.
You can execute scripting methods within your application, using shortcuts.
Duplicate key codes for different scripting methods are not supported. Attempting to create a
duplicate key code stops the application. The new key code must start with CTRL/CMD, and
must contain one or two more keys. Only alphanumeric keys, and the SHIFT and ALT keys,
can be used.
If there are duplicate key codes, the browser or the original program takes precedence over
the key codes you have created. To avoid such problems, perform browser-based testing
before publishing your documents.
Keyboard shortcuts can only be created with the keyboard shortcut element.
Create keyboard shortcuts under Events, and then activate them. They can include
commands in JavaScript. You can define your own shortcut to start a command.
LESSON SUMMARY
You should now be able to:
LESSON OBJECTIVES
After completing this lesson, you will be able to:
Export Scenarios
Before using export functions, you must initiate the several types of export format you want
to use. This is done in the Outline area.
The Export Excel technical component allows the user to specify and export a crosstab, from
SAP Lumira Designer to Microsoft Excel. If the crosstab contains expanded hierarchies, or
expanded multiple hierarchies, in either columns, rows, or both, the export to Microsoft Excel
represents the same expanded state as shown in the crosstab.
The following file format is supported: Microsoft Excel 2007 (.xlsx)
Note:
In Microsoft Excel 2007, the metadata is separated from the crosstab data, and
displays in a separate tab in the MS Excel spreadsheet.
For example, the crosstab itself is represented in sheet 1. Sheet 2 contains
metadata, including runtime changes, applied filters, or variables. Columns can
also be resized depending on the length of the exported columns.
Export to Microsoft Excel is not supported with SAP BusinessObjects Mobile.
Export to XLS file format is no longer supported either.
Export to Excel supports displaying BEx level exceptions. You can enable or
disable the export of BEx Level Exceptions to Microsoft Excel in the Components
property of the Export Excel technical component.
Export to Excel supports formatting for headers. You can select from the three
predefined options (Normal, Subtle, Emphasized) of the Header Formatting
property of the Export Excel technical component during design time or use API
scripting to choose the predefined options during runtime.
Consult the following SAP Notes when exporting to Microsoft Excel:
SAP Note 1917890: Listing the Microsoft Excel export feature as the last
statement in the scripting.
SAP Note 1917891: Increasing jvm memory for large data export.
SAP Note 1917944: The third parameter export setting currently not
corresponding with the first parameter export type.
SAP Note 2167615: Design Studio Microsoft Excel export cell size.
Use the Export PDF technical component to export your application, or parts of it, to PDF.
There are 3 ways to export to PDF:
WYSIWYG Screen:
Code: Export_PDF.exportView();
WYSIWYG Panel:
The designer edition can pinpoint a list of panels (Array) to be exported as WYSIWYG.
Code: Export_PDF.exportPanelView(panelArray);
Report Style:
Exports all metadata associated with a query for a component to the header.
Code: Export_PDF.exportReport();
Export to PDF supports a range of languages. The locale of the user's session determines the
language to use for export to PDF. Only one language can be exported to PDF, per application.
You can export a crosstab with collapsed or expanded hierarchies on the column headers and
row headers. If your crosstab contains hierarchies on the column headers and row headers,
these hierarchies are also shown when exporting to PDF in a report style. When the hierarchy
is collapsed in your crosstab at the time of export to PDF, the output displays the indentation
and expansion symbols. When the hierarchy is expanded at the time of export, this too is
reflected in the export to PDF.
The Pagebook Component and Export to PDF feature allow you to export components on all
pages within a Pagebook once the component has been selected as a report component. You
can select which pages of a Pagebook should be available at export time. Pages are only
displayed for selection if there are one or more components on that page selected as report
components.
You can also use the export functions in the context menu.
LESSON SUMMARY
You should now be able to:
LESSON OBJECTIVES
After completing this lesson, you will be able to:
Action Sheets
Action sheets generate a list of possible end user actions. It is similar to a context menu, but
usable with a lot of components.
The technical component must be initiated in the outline area, and must be activated by a
script-based event. The modal should be closed if it's no longer used.
You can create custom, context-based action lists, and provide a list of entries, which can
contain further actions.
Action sheets in an application must be opened before that application is usable. Action
sheets support planning functions.
The Action Sheet Items property allows you to set the value, text, and icon to appear in your
action sheet. The Placement property allows you to position the action sheet relative to
another component.
Figure 134: Define the Action Sheet Items and Open the Action Sheet
1. In the properties of your action sheet, define the list of actions that should be available.
Each list entry needs its own value.
2. Open the action sheet, using a script in an event of another component, such as Button.
3. In the properties of your action sheet, define the placement of where the action sheet
should be displayed.
The action sheet can return the value, or text entry, belonging to a special value or list entry.
For example, a list of possible export formats.
Figure 135: Define the Actions Belonging to Each Action Sheet Item
1. To define which action belongs to which item of the action sheet list, insert coding in the
properties of the action sheet.
2. Use a control structure to define which action belongs to which selection of the item list.
LESSON SUMMARY
You should now be able to:
LESSON OBJECTIVES
After completing this lesson, you will be able to:
Commentary Functionality
Comments are available in SAP Lumira Designer only, and they have the following features:
Application-based comments and data context / data cell-based comments are both
supported.
The functionality provided by comments allows users to create, delete, and modify
comments in SAP Lumira applications.
Comments across all applications within one SAP Lumira document (.lumx file) can be
shared using the BI commentary service on the BI platform.
Comments can be created in local mode for testing purposes, but in such cases they do
not use the BI commentary service on the BI platform.
The following are the different comment types, and they can be seen in the figure, Comments
Types:
Note:
As this is a basic training course, this section is an overview of commentary
functionality. You can find more details in the documentation or ask your
instructor for the SAP Lumira Designer - Advanced Training (BOD420) course.
LESSON SUMMARY
You should now be able to:
Lesson 1
Accessing Application on Mobile Devices 104
Lesson 2
Using the Adaptive Layout Container 107
Lesson 3
Using Movable Components 110
Lesson 4
Optimizing Components for Mobile Devices 112
UNIT OBJECTIVES
LESSON OBJECTIVES
After completing this lesson, you will be able to:
Integration into the SAP BusinessObjects Mobile solution provides convenient and unified
user access for a large mobile community.
You can download and access applications of SAP Lumira Designer via the SAP
BusinessObjects Mobile solution (native Apple iOS application). You can also leverage
collaboration functionality, such as annotations, SAP Jam, and so on.
SAP BusinessObjects Mobile solution provides unified usability for a large mobile community.
Figure 140: Assigning SAP Lumira Designer Applications to the Mobile Category
Before users can access SAP Lumira Designer applications on a mobile device, using the SAP
BusinessObjects Mobile solution, you need to assign the applications to the Mobile category
on the BI platform.
To do so, perform the following steps:
1. In the BI Launchpad, go to the folder that contains the application that you want to assign.
5. Choose OK.
Figure 141: QR Code Scan for Simple Deployment on Apple iPad or iPhone
1. If you work in Lumira Documents mode, click Send to Mobile Device - or - if you work in the
BI platform legacy mode, click Send to Mobile Device (using QR code ®) in the toolbox of
the design tool. The dialog box QR Code ®is displayed with the URL of the current
application encoded.
2. If there are several network adapters active for your computer, the dropdown box IP
address to use is displayed. Select the IP address you need.
3. Scan the QR code with a mobile device, for example an iPad (iPad 2 or higher), using one
of the various QR code scanner apps.
When you click the QR code, a new web browser window with the document link opens,
but without the current session of the platform. You have to log on to the platform. This
is useful when you want to execute the application with different credentials, for
example, to check access rights or personalized result sets.
To copy the document link to the clipboard, click the Copy URL to clipboard button. You
can paste the URL into an e-mail, send the e-mail and the URL can be opened on a
mobile device. If you want to add this URL to your bookmarks, you need to do this
manually (and not by choosing the corresponding button on the mobile device).
LESSON SUMMARY
You should now be able to:
LESSON OBJECTIVES
After completing this lesson, you will be able to:
After creating a block in the Adaptive Layout component, you can add the content
(components) to it. As the width of a block is dynamically calculated, its content should use
the auto-width setting.
A viewport is the visible area of an adaptive layout container. The viewport changes size,
depending on the width of the adaptive layout container.
In the context menu of the adaptive layout, you can select the Preview of Viewport context
menu item, and select one of the following options:
Auto
Small
Medium
Large
Extra large
This option offers you the flexibility to arrange the content in a responsive way.
The adaptive layout rearranges blocks, according to the colspan of the blocks and the current
viewport.
Each row in the adaptive layout container has 12 columns. Blocks are aligned next to each
other, if the sum of their colspan attributes is 12 in maximum. If the 12 columns are full in a
row, and a block would require a 13th column, the adaptive layout component pushes the
blocks underneath.
LESSON SUMMARY
You should now be able to:
LESSON OBJECTIVES
After completing this lesson, you will be able to:
Movable Components
LESSON SUMMARY
You should now be able to:
LESSON OBJECTIVES
After completing this lesson, you will be able to:
Enable mobile-like navigation for crosstabs, with pixel-based scrolling. This ensures a smooth
scrolling experience.
The Pixel-based Scrolling property is recommended when creating mobile applications, or
applications with a low data volume. If you do not activate pixel-based scrolling, row-based,
and column-based scrolling is applied by default.
Data is cropped after a specified number of rows or columns. Pixel-based scrolling is not
suitable for large data sets.
Note:
This property is mandatory for setting the following properties of row and column
limits.
For iPad applications, we recommend that you limit the total number of cells (the
product of rows * columns) to 500, to improve performance and user experience.
Figure 152: Optimize the Dimension Filter Components for Mobile Use
Enable mobile-like navigation for dimension filters, with different visualization modes.
Use visualization modes with care, according to their functions.
Try not to double them by using 2 filters, when if 1 could be enough.
Keep the applications simple, and do not use too many components.
Only create applications based on the predefined templates for iPhones (do not use the
blank template for iPhones).
Do not use crosstab components for iPhone applications, as this method is not supported
by SAP.
Only design iPhone applications in portrait format. Landscape orientation is not supported
when running the application in the SAP BusinessObjects Mobile solution.
LESSON SUMMARY
You should now be able to: