Bookmarks functionality with online Composition template in BIP mode
In this blog we will try to concentrate on how to use the Portable Fragment Bookmarks in SAP Business Object Design Studio BIP mode and use those Fragments also called as Smart objects in creating a dashboard using the online composition template in the BIP mode. We will also see where in the BIP the Bookmarks are managed and how are they stored.
Before I go into details I would like to point that their is a blog written by my colleague Ravin Angara which talks about simulating the Online composition template in local mode, using portable fragments (Bookmarks). Please have a look at that blog too.
In Design Studio there are three types of bookmarks. There are blogs and documentations explaining what these three bookmarks are in detail but just as a quick recap here is the small definition of 3 types of bookmarks.
Standard Bookmarks: Used when application user wishes to serialize the state of entire application and persist that state in their BIP or SAP NW backend.
Fragment Bookmarks: If the application user just wants to serialize only a selected part of their analysis application.
Portable fragments / Smart Objects – Used when application user wants to serialize the selected part of the application. The application user can use these smart objects in the online composition template and build their own online dashboards on demand.
- Login into the Design Studio in the BIP mode
- Create an Application using the Generic Analysis template, Make sure you save the application in the right folder in the BI Launchpad
- Create one more Application using the Online Composition template.
- Login into the BI Launchpad, browse to the folder where the Application is saved
- Run the Application and assign the Data Source. In this scenario we will use BEx Queries as the data sources
- Select the BEx query , drag and drop required fields into rows and columns so that crosstab and charts are filled with data.
- Save the Crosstab and charts as the smart objects in the bookmark folders. Folders are already created in the CMC under manage folders option. Once saved as bookmarks you can assign a new data source to the same generic analysis template and create new smart objects.
- Go back to folders in BI Launchpad where the Online Composition template is stored and run the template
- With online composition build the dashboard using the different smart objects coming from different data sources.
- Check the CMC how and where the bookmarks are stored, how to identify the fragments and what is group identifier.
Login into the SAP Design Studio client in the BIP mode. Provide the valid BIP logon credentials.
If the Design Studio client is started in the local mode then to change it to start in BIP mode go to Tools -> Preferences -> Application Design -> Preferred startup mode and select the BIP. It will prompt to restart the Design Studio client and next time when you start the Design Studio it will start in the BIP mode.
In order to create the bookmarks in the BIP mode, you have to use the Generic Analysis template. Design Studio 1.6 version has simplified and categorized the delivered templates well. Create a new Application SALES_APPLICATION in the Design Studio clinet, select the folder in the BI Launchpad where you want to save the Application.
For Template, lets keep the default selection “SAPUI5” option. In Design Studio 1.6 version they have introduced template types as SAPUI5 and SAPUI5m. SAPUI5m is used when you have a plan to integrate Design Studio Apps into Fiori. Lets just use the SAPUI5 standard library and select the Generic Analysis template. Click on create button to create the application.
Similarly lets create one more Application ONLINE_COMP_APP using the Online Composition Template. Make sure to save the Application in the same folder where the SALES_APPLICATION is saved.
Now both the Applications are created in the BIP mode so logon to the BI Launchpad and browse to the folder where the Applications are saved.
Double click on the SALES_APPLICATION and the application opens in a new tab. Assign the BW query and create couple of charts for e.g. a Column Chart, Crosstabs and save them as them Smart objects or Portable fragment bookmarks. In the below image at the bottom right you see a pin like icon, click on that and you will see the Create new smart object pop-up window. Here we will select the SALES folder and will save the smart object in this folder. These folders are created in the CMC and users with proper authorizations only will be able to save smart objects in the folders.
Save one smart object in the FINANCE folder too.
Now lets see how to manage these folders so that users can save their smart objects.
Login into the Central Management Console and select the Application from the Dropdown or from Manage option.
Under Applications , select the Design Studio Runtime to manage the Folders and Bookmarks. Usually this tasks are done by the administrators.
Once you select the Design Studio Runtime option , you will observe that “Actions” option gets enabled. Click on the arrow and see the options to manage Bookmarks. Folders, Properties and User security.
In order to create the Folders in CMC, select the “Manage Folder” option under Actions and here you can create new Folders and arrange them in a certain structure. We can also maintain the security of the folders so that the users who have access to the folders can only see or save the smart objects in authorized folder.
To manage Bookmarks, we need to go to the Manage Bookmarks option. When the Manage Bookmark windows opens, you can see different types of Bookmarks created by different users. Administrator can manage the Bookmarks by deleting or moving the Bookmarks to folders. Usually Bookmarks maintenance is done by Administrators only and regular users will not have access to the CMC.
From the below figure you can see the Bookmark types. As mentioned earlier there are 3 types of Bookmarks. Fragment Bookmarks, Portable Fragments Bookmarks and Standard Bookmarks. If there are too many Bookmarks then we can narrow down the results by applying some filters or simply searching the Bookmarks.
For Portable Fragment Bookmark / Smart Objects, if we see in the screenshot below, a Group Identifier “ONLINE_COMP” is assigned. Usually this group identifier will be will assigned if you create the smart object using Generic analysis template.
The Bookmarks which have the Group identifier will be read by the Online Composition template. We can also create custom applications and write / modify code to have custom group identifier.
Please refer to the blog created by my colleague Ravin Angara on how to simulate the Online Complication template in local mode, have custom group identifier and how custom Online composition template reads the smarts objects created in the local mode.
Now lets build the Dashboard using the Smart Objects created earlier. Login into the BI Launchpad and browse to the folder where the Online Composition Application is saved. Double click on the Online Composition Application to open it in a separate tab. The Online Composition Application consists of 2 pages. 1st page will show the created Dashboards in tiles or as thumbnails and in the 2nd page actually the Dashboards are created. Select the “Create” option on page 1 and it will take us to the page 2.
We can also select the dashboard thumbnail and edit or share or delete the dashboard. We can also export the dashboard to the pdf format or share the link through email.
On the Page 2, we see the Fragment gallery on the right side which displays the folders which are available for users. Upon selecting the Folders the Smart objects will appear. To create the Dashboard, the smart objects are dragged and dropped from the fragment gallery to the spilt cell container area on the left. These smart objects are connected to different Data sources and can belong to different Applications. So using the Online Composition template we can create a Dashboard with different smart objects coming from different applications and different data sources.
Lets select the SALES folder and we see the 3 Portable fragments which we created earlier using the generic analysis template. Lets drag and drop the smart objects to the split cell container area to create a Dashboard. We can set the folder level authorizations for each users in CMC so that only users will proper authorizations would be able to access the folders and see the smart objects for e.g. here the users who have access to the SALES folder will only be able to see the SALES folder. Upon selecting SALES folder we can see the two smart objects which we created earlier All the folders, user authorizations will be maintained by the administrator in the CMC.
So we have successfully created the Portable Fragments using the Generic Analysis template in the BIP mode. We also checked where and how to manage the bookmark in the CMC, how to manage the folders, how to identify the different types of bookmarks. We also created a simple Dashboard using the Online composition template with smart objects stored in different folders. This concludes the blog.