sap design studio user guide

User Guide biExport 4 SAP Lumira

Release 1.6.30

biExport 4 SAP Lumira [email protected] Page i

CONTENT

1. INSTALLATION .................................................................................................................. 2

1.1. Download the Installation Package ........................................................................... 3

1.2. bi excellence Export Service ...................................................................................... 3

1.3. biExport 4 SAP Lumira Extensions ........................................................................... 3

2. THE POWERPOINT EXPORT ............................................................................................ 6

2.1. Lumira 1.x .................................................................................................................... 6

2.2. Lumira 2.x Discovery .................................................................................................. 8

3. THE WORD EXPORT ......................................................................................................... 9

3.1. Lumira 1.x .................................................................................................................... 9

3.2. Lumira 2.x Discovery ................................................................................................ 10

4. THE PDF EXPORT ........................................................................................................... 11

4.1. Lumira 1.x .................................................................................................................. 11

4.2. Lumira 2.x Discovery ................................................................................................ 12

5. THE EXCEL EXPORT ...................................................................................................... 14

6. SPECIAL EXPORT REQUIREMENTS .............................................................................. 15

6.1. Use Master Templates .............................................................................................. 15

6.2. Use custom Export Templates ................................................................................. 15

7. PROBLEM SOLVING AND TRACING .............................................................................. 23

biExport 4 SAP Lumira [email protected] Page 2

1. INSTALLATION

Our Export solution uses a central service to create freely customizable, high quality export

documents. The following figure shall introduce you to the architecture and different

components of this Export solution.

Figure 1: Architecture “Online Export”

With this architecture, an export document is created as follows:

When a user requests an export, our Lumira CVOM Component calls the bi excellence

Export Service via http(s) and sends information of the current Lumira storyboard. The

Export service consists of the open bi Repository service and the Lumira Export open bi

Plugin. These two components create a Word or PowerPoint document from the passed

information and return this document in an http(s) response.

As described, the export solution consists of the following components:

• Lumira CVOM Component “biExport 4 SAP Lumira PPT”

• Lumira CVOM Component “biExport 4 SAP Lumira DOC”

• Lumira CVOM Component “biExport 4 SAP Lumira PDF”

• open bi Repository 3.0.1 or higher

• Lumira Export open bi Plugin

The following pages will describe the installation process. Contact us via

[email protected] if you have questions regarding the setup.

As an alternative to installing the bi excellence Export Service (section 1.2) you can also use

our Cloud Export Service. Its URL https://Design Studioexport.biexcellence.com is stored as

a default Server URL in the Lumira Export Component (section 2.1). Contact us via

[email protected] if you want to make use of the Cloud Export Service for productive

usage.

mailto:[email protected]

https://designstudioexport.biexcellence.com/

mailto:[email protected]


1.1. Download the Installation Package

You can download all necessary components from our official website

www.biexcellence.com. You have to register to access the necessary files under “Support

Downloads”.

1.2. bi excellence Export Service

Please refer to the open bi Repository Installation Guide for information on system

requirements and installation (sections 1.2.1 and 3.1 of the Installation Guide).

Make sure to also install the open bi Configurator. This client allows you to easily change the

configuration of the Export service (sections 3.2 and 3.3 of the Installation Guide).

After installing the server and before starting the service, follow the following additional

steps:

1. Create the subfolders “export_temp” and “export_resources in the OPENBI directory.

Check the file IMPORTANT_RELEASE_INFORMATION.pdf for latest installation

information, e.g. how to install the plugin with older open bi installations.

1.3. biExport 4 SAP Lumira Extensions

Our Lumira Extensions come to you as separate compressed ZIP folders. The installation

follows the standard SAP instructions for Lumira extensions.

1.3.1. Installation

Save the ZIP folder to your disk and – to use it with your local installation - perform the

following steps according to the SAP guideline:

1.) Start SAP Lumira

2.) Go to “Tools Install Extension to Lumira…”

http://www.biexcellence.com/


Figure 2: Lumira Extension Manager

3.) Choose “Manual Installation” and select the Add-on archive that you saved on

your disk


Figure 3: Choose Installation Source

4.) Choose “Open”

5.) Restart Lumira


2. THE POWERPOINT EXPORT

In this chapter, we will describe how to use the open bi Export Component for PowerPoint

and its properties in detail.

2.1. Lumira 1.x

1. On “Visualize” view choose the “biExport 4 SAP Lumira PowerPoint” component from

the Chart Extensions dropdown.

Figure 4: Chart Extension for PowerPoint Export

This renders a PowerPoint icon on the screen. You do not have to map any

dimensions or key figures.

Figure 5: Rendered PowerPoint Export Component

2. Switch to the “Compose” view. Please note that only here the export function makes

sense.

3. Maintain the “Export Configuration” under “Visualization Properties”


Figure 6: Export Configuration for PowerPoint Export

Here you can change the “Rendering Mode” of the component:

• “Large”: Renders a large PowerPoint icon (default)

• “Small”: Renders a small PowerPoint icon

• “Link”: Renders a “PowerPoint export” text which is clickable

Also, you define the “Export Server URL”. This is the Export Service, which shall be

used to create the documents. By default our Export Cloud Service is used. If you did

a client-side installation, enter http://localhost:9091. If you want to use a central

server-side instance, enter its URL.

4. Maintain the “Export Parameters” under “Visualization Properties”

Figure 7: Export Parameters for PowerPoint Export

Here you can define the “Separate Slides” parameter. This property allows you to

control whether each component should be placed on a separate slide (checkbox

checked) or all components should be exported as arranged on the page (checkbox

unchecked).

Also you can enter a specific export template (section 4.2.1). If you leave this field

empty (default), the master template is used (section 4.1).

http://localhost:9091/


A click on the PowerPoint icon will initiate the export process. The service generates a

PowerPoint presentation which exports all components of the current page.

2.2. Lumira 2.x Discovery

Available with version 1.6.30.


3. THE WORD EXPORT

In this chapter, we will describe how to use the open bi Export Component for Word and its

properties in detail.

3.1. Lumira 1.x

1. On “Visualize” view choose the “biExport 4 SAP Lumira PowerPoint” component from

the Chart Extensions dropdown.

Figure 8: Chart Extension for Word Export

This renders a Word icon on the screen.

Figure 9: Rendered Word Export Component


sense.





• “Large”: Renders a large Word icon (default)

• “Small”: Renders a small Word icon

• “Link”: Renders a “Word export” text which is clickable






Figure 11: Export Parameters for Word Export

Here you can enter a specific export template (section 4.2.1). If you leave this field


A click on the Word icon will initiate the export process. The service generates a Word

document which exports all components of the current page.





4. THE PDF EXPORT

In this chapter, we will describe how to use the open bi Export Component for PDF and its

properties in detail.

4.1. Lumira 1.x

2. On “Visualize” view choose the “biExport 4 SAP Lumira PDF” component from the

Chart Extensions dropdown.

Figure 12: Chart Extension for Word Export

This renders a Word icon on the screen.

Figure 13: Rendered PDF Export Component


sense.





• “Large”: Renders a large PDF icon (default)

• “Small”: Renders a small PDF icon

• “Link”: Renders a “PDF export” text which is clickable






Figure 15: Export Parameters for Word Export

Here you can enter a specific export template (section 4.2.1). If you leave this field


A click on the PDF icon will initiate the export process. The service generates a Word

document which exports all components of the current page.





5. THE EXCEL EXPORT



6. SPECIAL EXPORT REQUIREMENTS

In this section we describe how you can deal with special export requirements such as:

• Alter the standard template that is used for the plain export (4.1)

• Use predefined PowerPoint or Word template for the export (4.2)

6.1. Use Master Templates

By default, the plain exports to PowerPoint and Word are based on empty documents. If you

want to enhance the plain export by a Corporate Design, you should place the following files

into the “export_resources” directory in the installation directory of open bi Repository:

Export Format File Name

PowerPoint master_template.pptx

Word master_template.docx

In these master templates you can use all placeholders described in sections 3.2.2 to 2.2.4.

In addition you can use the placeholder %CONTENT% to define where exported

components shall be inserted in general. In PowerPoint, you can also use

%CONTENT%:WIDTH and %CONTENT%:HEIGHT to fit the export directly into the textbox.

6.2. Use custom Export Templates

Custom Export Templates enable you to create ready-to-use executive presentations and

briefing books with pixel-precise layout directly from Lumira.

The following sections describe how to work with Export Templates.

6.2.1. Create a Word Template

In the Word Template, you can define your corporate design, include texts, tables and

graphics as you like. To insert a Component at a specific place, you have to use the Merge

Fields of Microsoft Word. To insert a Merge Field, navigate to the menu function Insert

Quick Parts Field.


Figure 16: Insert a Merge Field

This opens a dialog box where you have to choose “MergeField” from the list on the left.

Afterwards you can enter the placeholder into the Then you can enter the placeholder in the

field name input box under field properties.

Figure 17: Choose MergeField

After clicking on OK the result looks as follows:


Figure 18: Placeholder for CHART_1

The name of the placeholder must be the technical name of the component that shall replace

the placeholder, surrounded by “%” (e.g. %CHART_1%).

Important Note:

If you want to alter a merge field, it is not sufficient just to edit its name directly in the

Word document! Right click on the merge field instead and choose Edit. Alter the

name in the dialogue box.

The following suffixes can be used to alter the rendering of the component:

Suffix Description

Without a suffix to the component name, the component is rendered

into the document as an image that fills the complete width of the page.

Example: %CHART_1%

:WIDTH[npx] Use this suffix to render an image of the component in the exact width

specified as “n”. “450” corresponds to the full width of an A4 document.

Example: %CHART_1%:WIDTH[225px]

:HEIGHT[npx] Use this suffix to render an image of the component in the exact height

specified as “n”.

Example: %CHART_1%:HEIGHT[225px]

:TEXT Use this suffix to render the component as an editable text or table,

including styles from the web page (only available for text based

components).

Example: %TABLE_1%:TEXT


Suffix Description

:VALUE Use this suffix to editable copy onto the slide, keeping the format of the

placeholder (only available for text based components).

Example: %TEXT_1%:VALUE

:TEXT[cXr] Use this suffix to render a table component as a native Word table which

is split by “c” columns and “r” rows (only available for text based

components).

Example: %TABLE_1%:TEXT[12X24] – splits the table into smaller tables

with 12 columns and 24 rows

:TEXT[cXr] Use this suffix to render an editable copy onto the slide which is split by

“c” columns and “r” rows (only available for text based components).



:TEXT[cXr] {styles} Use this suffix to control style parameters such as the font size

Example: %TABLE_1%:TEXT{font-size:8pt}

:IMAGE[cXr] Works the same way as :TEXT[cXr] only that the result is rendered as an

image, not as a native table.

6.2.2. Create a PowerPoint Template

In the PowerPoint Template, you can define your corporate design, include texts, tables and

graphics as you like. To insert a Component at a specific place, you have to create a Text

Box and enter the technical name of the component into it surrounded by “%”, e.g.

%CHART_1%.


Figure 19: Exemplary PowerPoint Template with formatting and placeholder

You can also use the following suffixes to the Component’s name to alter the rendering of the

component:

Suffix Description

Without a suffix to the component name, the component is rendered

onto the slide as an image with the width and height of the text box. This

may lead to a distorted result.

Example: %CHART_1%

:HEIGHT Use this suffix to render the component as an image that fits to the

height of the text box. The scale of the image is kept.

Example: %CHART_1%:HEIGHT

:WIDTH Use this suffix to render the component as an image that fits to the width

of the text box. The scale of the image is kept.

Example: %CHART_1%:WIDTH

:SCALESIZE Use this suffix to render the component as an image that automatically

scales down the width and height if they exceed the placeholder size. The

scale of the image is kept.

Example: %CHART_1%:SCALESIZE


Suffix Description

:IMAGE Use this suffix to render the component as an image of exactly the same

size as defined in the application.

Example: %CHART_1%:IMAGE

:VALUE Use this suffix to add editable copy onto the slide, keeping the format of

the placeholder (only available for text based components).

Example: %TABLE_1%:VALUE

:TEXT Use this suffix to render an editable copy onto the slide (only available

for text based components).

Example: %TABLE_1%:TEXT

:TEXT[cXr] Use this suffix to render an editable copy onto the slide which is split by

“c” columns and “r” rows (only available for text based components).



:TEXT[cXr] {styles} Use this suffix to control style parameters such as the font size

Example: %TABLE_1%:TEXT{font-size:8pt}

:IMAGE[cXr] Works the same way as :TEXT[cXr] and renders the result as an image

Also multiple Components can be added to one slide. Feel free to add also any PowerPoint

items, such as Slide Titles, Shapes, Text Boxes, to the Template.

6.2.3. Upload a template directly to the server

You can use a special PowerPoint, Word or Excel Template for your Design Studio

application by placing the document directly on the Export server:

1) Login to the server which runs the open bi Repository

2) Navigate to the export_resources subfolder of the OPENBI installation directory,

typically C:\OPENBI\export_resources

3) Paste your template there

4) Manually enter the name of the file (e.g. MyExport.pptx) into the Template parameter

in the Excel, Word, PowerPoint or PDF Content group.

This way, the Export service will automatically load the file from the export_resources folder.

Important Note:


You can use PPT and PPTX formats for PowerPoint Export, DOC and DOCX for Word

Export, XLS and XLSX for Excel Export. For PDF Exports you can upload templates in

DOC, DOCX, PPT and PPTX formats.

6.2.4. Upload a template via the Additional Properties Pane

If you do not have authorization to access the server which runs the open bi Repository, you

can also upload the template via the Template Manager, which is accessible via Upload

Export Templates on the Additional Properties pane. This does not store the file in the

export_resources directory but in the database of the Repository.

Figure 20: Additional Properties Pane

To upload the template, click on “Export Template Manager”, which opens a new window.

1) Login with the user you created

Figure 21: Login to Export Template Manager

2) You will be forwarded to a dropbox like account, which allows you to upload

templates, rename and organize them in folders.

Figure 22: Export Template Manager

3) Manually enter the name of the file into the Template parameter in the Excel, Word,

PowerPoint or PDF Content group. If you use folders, enter the whole path including

its parent folders (e.g. Controlling/MyTemplate.pptx). If you use multiple export roles,

you should also include it in the path in order to make the file unique (e.g.

designstudio/Controlling/MyTemplate.pptx).


7. PROBLEM SOLVING AND TRACING

If the export does not work or the returned document does not show the expected content,

please proceed as follows.

With a local installation:

1. Create folder C:\BIOX

2. Restart the service

3. Execute the export again

4. Execute the export a second time with the cloud service

5. Find the trace file in the C:\BIOX directory and send it to our support, together with

the time and date of your export

6. Stop the service

7. Delete folder C:\BIOX

8. Restart the service

With a cloud service:

1. Send time and date of your export to our support


Some software products marketed by bi excellence Software GmbH and its

distributors contain proprietary software components of other software vendors.

No part of this publication may be reproduced or transmitted in any form or for any

purpose without the express permission of bi excellence Software GmbH. The

information contained herein may be changed without prior notice.

Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft

Corporation.

IBM, DB2, DB2 Universal Database, OS/2, Parallel Sysplex, MVS/ESA, AIX, S/390,

AS/400, OS/390, OS/400, iSeries, pSeries, xSeries, zSeries, z/OS, AFP, Intelligent

Miner, WebSphere, Netfinity, Tivoli, and Informix are trademarks or registered

trademarks of IBM Corporation in the United States and/or other countries.

Oracle is a registered trademark of Oracle Corporation.

UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group.

HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C®,

World Wide Web Consortium, Massachusetts Institute of Technology.

Java is a registered trademark of Sun Microsystems, Inc.

JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for

technology invented and implemented by Netscape.

Winword and PowerPoint are trademarks of Microsoft Corporation Redmond.

PDF is a registered Trademark of Abobe Systems Corporation.

MaxDB is a trademark of MySQL AB, Sweden.

SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver and other SAP products

and services mentioned herein as well as their respective logos are trademarks or

registered trademarks of SAP AG in Germany and in several other countries all over

the world. All other product and service names mentioned are the trademarks of their

respective companies. Data contained in this document serves informational

purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by

bi excellence Software GmbH for informational purposes only, without representation

or warranty of any kind, and bi excellence Software GmbH shall not be liable for errors

or omissions with respect to the materials. The only warranties for bi excellence

Software GmbH products and services are those that are set forth in the express

warranty statements accompanying such products and services, if any. Nothing

herein should be construed as constituting an additional warranty.

sap design studio user guide

Documents