You are on page 1of 23

Roambi Business BOE Publisher Extension ­ May 2016 

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Roambi Business
Business
​ Object Enterprise Publisher Extension


Roambi Business BOE Publisher Extension ­ May 2016 

Table of Contents 
 
I. Overview 
Introduction 
How it Works 
II. Setup 
Requirements 
Roambi Requirements 
Created a Roambi View to be used as a template 
Roambi Business API Client Key 
Install and configure RoambiScript 
Business Objects Enterprise (BOE) Requirements 
Roambi Configuration 
Creating API Key 
Setting up RoambiScript 
III. How to Use 
Step 1: Create the Template 
Step 2: Set up the Profile 
Create Profile 
Step 3: Create Publication 
Review the Publication Summary 
Sending the Publication to Enterprise Recipients 
Add Plugin to BOE 
Appendix A: Troubleshooting and Common Issues 
Appendix B: Resources 
 


Roambi Business BOE Publisher Extension ­ May 2016 

I. Overview
Introduction
The Roambi Business Objects Enterprise Publisher Extension simplifies the process of updating 
a Roambi report with data coming from a Web Intelligence report.  
 
Additionally, with a publication, you can schedule the delivery or reports and create 
personalized data for different recipients.  
 
Business Objects Enterprise Publisher Extension has provided a framework for 3rd party 
developers to execute scripts during the publication process. This Roambi publication extension 
is leveraging Roambi API behind the scenes. Roambi will respect the row level data 
permissions as specified in BOE.  
 
The key benefit of using this publication extension, is the report creator will not need to script its 
own API, but leverage the existing BOE interface and entities to deliver WebIntelligence reports 
as Roambi views. 
 
 


Roambi Business BOE Publisher Extension ­ May 2016 

II. Setup
Requirements
Roambi Requirements
1. Created a Roambi View​  to be used as a template 
2. Administrator access to Roambi Business  
3. Roambi Business API Client Key 
4. Install and configure RoambiScript 
5. Roambi Users invited into Account 

Business Objects Enterprise (BOE) Requirements


1. BOE version 4.0, 4.1 and 4.2. 
2. Permissions to add BOE plugins (need folder access to the BOE server installation path) 
3. Administrator access to BOE Central Management Console (CMC) 
4. Recipient information has correct email address 

Roambi Configuration
The Roambi BOE Publisher extension uses an existing Roambi report as template and the 
Roambi API to create personalized Roambi reports to your recipients. If you have not created a 
Roambi Report, please review our ​ getting started material​
 and ​
select a Roambi View​
 to create 
your first report. 
 
When creating a Roambi report as a template, the general workflow is: 
 
1. Determine the data to be shared with your recipients. Decide if all recipients will get the 
same data or it will be filtered by specific category, product, or country. 
2. Create or select a WebIntelligence report that contains the data. As a best practice, 
remove any header, footer, and additional formatting from the report. 
3. Export the report as Excel file 
4. Upload to Roambi Business and create your Roambi report 
5. Review and refine the Roambi View 
 
As with all design processes, creating a Roambi report will take few iterations and practice. 
General recommendation is to work through the steps outlined here, and get early feedback 
from recipients before investing on perfecting the smaller details. 


Roambi Business BOE Publisher Extension ­ May 2016 

Creating API Key

 
As mentioned previously, the Roambi BOE Publisher extension leverages the Roambi API to 
facilitate the creation of personalized reports. No programming or API knowledge is required to 
use the extension, but the publisher extension needs to be registered as an API client. 
 
To set up an API client please follow the steps outlined in the knowledge base article ​ How do I 
create a Roambi API client?
 
Please keep the details of the API client readily available, as it will be used in the next section. 

BOE Configuration
To enable the Roambi Publisher Extension, it requires placing two jar files on the BOE server 
  
● RoambiScript ​ ­ API utility that BOE publication will use to communicate to Roambi 
Business. 
● Roambi BOE Publication Extension ​ ­ BOE Publisher extension to set Roambi delivery 
options 
● Restart BOE Server Intelligence Agent so that it loads the classes in the .jar. 


Roambi Business BOE Publisher Extension ­ May 2016 

Setting up RoambiScript
 
1. Download RoambiScript from ​ SAP Service Marketplace​ . Create a folder on the BOE 
Server that can be easily referenced. In this documentation, RoambiScript is installed in 
C:\roambiscript​
 folder 
 
2. Run ​roambiscript configure​  in the terminal to generate a properties file. Note that 
JAVA_HOME/bin folder must be in the Path environment variable. 
 
java ­jar roambi­api­cli.jar configure 
 
3. After executing the above command, it will create a ​roambi­api.cli.properties​  file. 
 

 
 
Open Note you will be required to enter the API client details you previously created in 
“Creating API Key.” This will ensure that this API utility is provisioned to talk to your 
Roambi Business organization. 
 
Additionally, please note the RoambiScript installation path (in this example it is 
C:\roambiscript​). The publisher extension will need to reference this directory path. 

Setting up Roambi Publisher Extension


 
1. Download the ​ Roambi BOE Publication Extension​ . Depending of your version of BOE 
this is the Roambi BOE Publication Extension jar file you need to use: 
BOE 4.0: ​ roambi­boe­14­0­publication­extension­2.0.1.jar 
BOE 4.1: ​ roambi­boe­14­1­publication­extension­2.0.1.jar 
BOE 4.2: ​ roambi­boe­14­1­publication­extension­2.0.1.jar ​ (same jar as BOE 4.1). 


Roambi Business BOE Publisher Extension ­ May 2016 

 
 
publishingPlugins ​
2. Move the Roambi BOE Publication Extension jar file into BOE’s ​ folder: 
 
C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 
4.0\java\lib\publishingPlugins 

Note: This will depend on your BOE installation path. The above folder path is the 
default 
path for BOE 4.0. 
 
3. Restart BOE Server Intelligence Agent.  
a. Open Central Configuration Manager: 
 

 
 
b. Restart Server Intelligence Agent. Wait a few minutes until all services are up 
and running. You can monitor this by clicking the “Manage Servers” icon in the 
toolbar. 
 
 
 

III. How to Use


We will use an example to illustrate all the steps you need to perform to create a personalized 
Roambi report for your recipients powered by BOE. 

Step 1: Establish the Use Case


Our sales team have been requesting to visualize and review their sales reports. While they can 
get by on creating their own Excel charts on the desktop, it is inefficient, not standardized, and 


Roambi Business BOE Publisher Extension ­ May 2016 

not the best use of the sales team time. Additionally, with sales team traveling most of the time, 
easy mobile access is a must. 
 
The IT team identified Roambi as a suitable solution. They can transform each WebIntelligence 
reports into Roambi reports. However, they recognize this is not scalable especially with how 
quickly the sales team is growing, and each sales rep have different level of data access. They 
want to avoid having to create multiple WebIntelligence reports and multiple Roambi reports. 
 
Additionally, they gathered the following requirements: 
 
● Sales want to see revenue, profitability, and sales by state and product lines. 
● Wants a dashboard like presentation, and not spreadsheet 
● Reports should be updated daily 
● Sales reps should only be able to see the metrics for their respective state (e.g. Tony, 
the Account Rep in Texas, should only see data from Texas) 
● Sales manager should be able to see all the states under their supervision (e.g. Ally, the 
US Sales Manager, will see data from All the states) 
● Managers should have the ability to filter data to specific states 
 

Step 2: Create the Template


With a good understanding of the requests, the first step is to gather the necessary sales data 
by state. The IT team created a WebIntelligence report that contains the following dimensions 
and measures 


Roambi Business BOE Publisher Extension ­ May 2016 

 
Sample WebIntelligence Report for Sales Team 
 
The report contains all states that have sales presence including (California, Colorado, Texas, 
etc.). The most important metric, Sales Revenue, is available. Additionally, IT team added 
Margin to help calculate profitability and included other common sales metrics. This report 
contains all the requested information to create a Roambi Dashboard. The report is downloaded 
as an Excel report and uploaded to Roambi Business. 
 
  


Roambi Business BOE Publisher Extension ­ May 2016 

 
Screenshot of creating a Sales Team Dashboard in Roambi Publisher 
 
Since the desired presentation is a dashboard, choosing the ​ Card View​ is an appropriate choice 
as the deliverable. Once you import the WebIntelligence reports, the dimensions and measures 
are available to create charts and visualizations. In this case, single value object, comparison 
charts, bar charts, area charts, and pie chart are used to display the requested information. 
Additionally, a filter dimension is applied on state, so that individual state data can be viewed 
separately. 
 
Once the design is complete, publish the Roambi View and save it in an easily accessible 
Templates.​
folder. In this case, the file will be published to a folder called ​  Review the Roambi on 
the device and collect feedback on whether the data and visualizations are meaningful and 
address the sales team’s needs. 
 
 

10 
Roambi Business BOE Publisher Extension ­ May 2016 

 
Screenshot of creating a Sales Team Dashboard on the iPad 
 
Once the template is finalized, the remaining steps are to personalize the Roambi reports and 
deliver them. These steps are all configured within the BOE interface. The following steps 
assume you have no experience with BOE Publication. If you are already familiar with BOE 
Step 5: Adding Roambi Publication Extension.​
publications, please skip to ​  

Step 3: Create Profile


To personalize the data for recipients, BOE uses an object called Profile to facilitate the 
mapping of the data. From BOE ​ Introduction to Publishing​:  
 
“​
Profiles​ are objects in the BusinessObjects Enterprise system that let you 
classify users and groups. They work in conjunction with publications to 
personalize the content that users see. ​ Profiles link users and groups to 
profile values​ , which are values used to p ​ersonalize data ​within a report.” 
 
 

11 
Roambi Business BOE Publisher Extension ­ May 2016 

This section outlines the steps to create profiles. It assumes that users or groups have been 
created already. ​It is ​
important​
 to note that the users’ email will need to match the email used in 
Roambi Business​ . 
 
1. Login to Central Management Console (CMC) 
2. Click ​Profiles 
3. Select ​Manage > New > New Profile 
4. Create a name for the Profile (example: Publication Demo Profile) 
 

 
 
5. Select ​Profile Targets ​and click ​
Add 
6. Select the appropriate universe and object that will be used as a filter for the publication. 
eFashion ​
In this case it is the ​ universe and Object ​
State 
 

 
 

12 
Roambi Business BOE Publisher Extension ­ May 2016 

Profile Values​
7. Select ​  and determine the users and/or groups that will receive the 
publication. When choosing a specific user, you can define the data value for 
personalization. 

 
 
In this case, Ally All will receive data from all the available states in the State Object. Chris 
California will receive data only from California. Where as Daniel Sutoyo will receive data from a 
subset of states. 
 
Once the steps are completed in creating a profile, it can be used to create personalized 
publication for any Web Intelligence documents based on this universe and selected object. 
 

Step 4: Create Publication

Publication is a BOE entity that enables you to schedule personalized reports. It leverages the 
users and profiles that you created in the previous steps. 
 
1. Login to BI Launch Pad or CMC 
2. Select a folder where the publication will be generated. In this case ​
Public > Publication 
Demo 
3. Click New > Publication to create the Publication 
 

 
13 
Roambi Business BOE Publisher Extension ­ May 2016 

4. Provide a title for the publication. In this example, it is ​
State Sales 
 

 
 
5. Select a Web Intelligence report as a source document. This should be the same report 
you used to create your Roambi template. 

 
 

14 
Roambi Business BOE Publisher Extension ­ May 2016 

6. In ​
Enterprise Recipients ​add all the users you want to receive the publication. These 
should be the users or groups you have included in the profile 
 

 
 
7. In ​Personalization ​ select the local profile and object that the publication should be 
filtered on. In this example, select ​State ​ as the query and ​Publication Demo Profile ​
as 
the Enterprise Recipient Mapping. 
 

 
 

15 
Roambi Business BOE Publisher Extension ­ May 2016 

8. In ​
Formats​
, at the minimum you will need to select Microsoft Excel as output format. 

 
 
 
9. In ​
Destinations​
, select BI Inbox and check the “Deliver objects to each user” option. 
 

 
 
 
10. In ​
Publication Extension​ , you will need to add the Roambi Business Objects 
Publication Extension. Please refer to the table below for instructions on the parameters. 
 
Field  Value 

16 
Roambi Business BOE Publisher Extension ­ May 2016 

Publication Extension  RoambiBusiness (can be a custom title) 
Name 

Class Name  com.mellmo.roambi.businessobjects.publication.PublicationE
xtension 

Parameter  templatePath:​  ​
Roambi Business path to the template 
  Roambi file 
 
roambiScriptFolder​  ​
:​the local path of the Roambi Script jar 
file. 
 
The final parameter value should be in the following format: 
 
templatePath=​ <path to RBI 
template>​ &roambiScriptFolder=​ <path to 
RoambiScript>  
 
Example: 
Note: Final parameter must be URL Encoded 
templatePath=%2FTemplate%2FState%20Sales&roambiScri
ptFolder=c%3A%2Froambiscript 
 
Pre­URL Encoded: 
templatePath=/Template/State 
Sales&roambiScriptFolder=c:/roambiscript 
 
You can encode with this ​ URL encoder here​ . 
 
Note: 
Strongly encourage you to store the source and url encoded parameter path in a 
document for your own reference. Once the publication extension is added, BOE 
does not let you edit it. You will have to remove and reinsert again. 

 
11. The publication extension should be added in the list ​
Before Publication Delivery 
 

17 
Roambi Business BOE Publisher Extension ­ May 2016 

 
 
12. In ​
Schedule​, select the desired frequency to deliver the publication. You can select ​
Run 
Now​, to send the personalized reports. 
 
13. Open Roambi Analytics and review the reports are correctly filtered for recipients. 
 
 
 
 
 
 

Appendix A: Troubleshooting and Common Issues


 
Where do I find RoambiScript, BOE Publication Extensions, and API Key? 
 
RoambiScript:​  Find it in ​
SAP Service Marketplace 
Roambi BOE Publication Extension: ​ Link 
Roambi API Key:​  Please refer to ​
How do I create a Roambi API client? 
 
How do I obtain log files? 
There are two log files you can pull for troubleshooting purposes. 

18 
Roambi Business BOE Publisher Extension ­ May 2016 

For Roambiscript log file, go to the folder where you installed RoambScript. There is a folder 
log​
called ​  and will contain the latests events. 
 
History​
For BOE log files, right click on the BOE publication and click on ​ .  

 
 
 This will open a new pane of previous job runs. Clicking on the run entry will allow you to view 
the log files and other exported files (if you specified in your destination). 

 
 

 
 
 
I am getting empty data set in my Roambi file 
Please check the following items 
1. You provisioned the right users, and you are using a provisioned user to test the RBI 
contents 

19 
Roambi Business BOE Publisher Extension ­ May 2016 

2. Check that your source report matches the dimensions used in the Roambi Report. 
3. The profile values and filters for the user actually matches the data in the source report. 
Make sure you do not have additional query filter that restrict the data than intended 
4. Make sure the data entry matches your filter (e.g. “Texas_”). You can check this by 
looking at the exported Webi or Excel report in the user’s BOE inbox. 
 
Profile mapping and query needs to be accurate. It uses an AND clause 
 
Check that your RBI template can be accessed 
 
I get an invalid path in log 
The RBI is stored in the user’s My Documents folder. And the My Documents folder is specific to 
the user’s email address. Please Double check that the user email address is the same in BOE 
and in Roambi Business. 
 
I get an invalid template path in log 
Double check the user credential you are using for the api client key has access to the RBI 
template and the folder that stores the RBI 
 
My BOE log says it is complete, but I don’t see anything 
Please check whether you have specified Excel as a format in the publication properties. At the 
minimum, the Excel format must be selected.  
 
How can I check if my data issue is a BOE issue or a Roambi Issue? 
In the destination tab of the publication properties, select where you want to review the exported 
file. For easy reference in BOE, select User InBox, and the in the format tab select both Excel 
and Webi report. This way, you can complete the Roambi RBI process and also look at the 
underlying data report in both Excel and Webi report. 
 
I still have issues with the plugin 
Please contact ​ support​
. Please be sure to provide the following information: 
 
­ BOE version 
­ Brief summary of what you are trying to accomplish 
­ Time of publication event 
­ RoambiScript Log (This can be found in the folder where you installed RoambiScript) 
­ The publishing parameters you used 
­ Screenshot of Enterprise Recipients 
­ Screenshot of Profile Values 
 
 

20 
Roambi Business BOE Publisher Extension ­ May 2016 

21 
Roambi Business BOE Publisher Extension ­ May 2016 

Appendix B: Resources
 
Introduction to BOE Platform Publication 
General overview of BOE publication extension and how it can be used to personalize data 
 
Personalization in SAP BOE Publication 
A more detailed step by step guide with additional screenshots and illustrations 
 
BOE Introduction to Publishing (PDF) 
An in depth guide to leveraging the publishing platform in BOE 
 
Adding a Publication Extension to your Publication 
Basic steps on adding a BOE publication extension 
 
Understanding Publication bursting modes 
This is a useful article if you have specific concerns on your database performance 
 
   

22 
Roambi Business BOE Publisher Extension ­ May 2016 

Appendix C: Version History

Version 1.0: January, 2015. General release of Roambi BOE Publisher Extension 
 
Version 2.0: February, 2016. Add step to restart Adaptive Job Server after updating Publication 
jar files. Add more detail on how to see the log file of a Publication run.  
 
Version 2.1: April, 2016. Add step to restart BOE server, just restarting the Adaptive Job Server 
does not always reloads the jar files. 
 
Version 2.2: May, 2016. Add step to configure Destination when creating the Publication. 
Mention that the JAVA_HOME/bin folder must be in your PATH environment variable. 
 
Version 2.3: May, 2016. Add step to restart BOE Server Intelligence Agent. Update links to point 
to SAP Service Marketplace. 

23 

You might also like