Launch SAP Business ByDesign Reports using Parameterized URLs
In SAP Business ByDesign you can launch ByD Analytical Reports from external applications and open the ByD report in a browser or Microsoft Excel.
For this purpose ByD provides parameterized URLs to navigate to ByD analytical reports.
Imagine you are using a central cloud analytics solution for global sales analysis based on aggregated data, that you extracted from multiple locations and systems.
In such a scenario the external navigation to ByD analytical reports enables you to navigate from your global dashboard to ByD reports, drill-down into more detailed views of the ByD report and further navigate to ByD account overviews and business documents like sales orders.
This document describes how to assemble this parameterized URL to navigate to a ByD report and how to transfer parameters like the report view, the selection variant or selection parameter values.
Open ByD Reports in a Browser
The URL schema to open ByD reports in a browser is:
¶m.SelectedViewId=<Report View ID>
¶m.Selection.<Selection Parameter Technical ID>=’<Selection Parameter Value>‘¶m.Selection.<Selection Parameter Technical ID>=’<Selection Parameter Value>‘¶m.Selection…
|<Hostname>||ByD tenant URL (the URL which you click to open the ByD system), for example: https://myXXXXXX.sapbydesign.com|
|<Report ID>||The ID of the Report which you want to use as a mashup, for example: BUPCSD_Q0001|
|<Selection ID>||The technical ID of the selection variant of the report, for example: ZAALD4BSYXAPNLMU5RLRKS5HMAY; The selection variant is applied only if no selection parameter is provided in the report URL|
|<Report View ID>||The technical ID for the View of the report, for example: ACCOUNT%20DATA|
|<Selection Parameter Technical ID>||The technical ID of the parameter that you want to pass as a context to report, for example: P_CITY|
|<Selection Parameter Value>||The actual value of the parameter, for example: Berlin|
Selection Parameter examples:
|Greater than queries:||¶m.Selection.P_YEAR=’>2015′|
|Value range:||¶m.Selection.P_STATUS='[2 .. 3]’|
|Value not assigned/empty:||¶m.Selection.P_CITY=’#’|
|Extension field:||¶m.Selection.1FCFL64T37BTWV0FT0ERXJ40VY=’Hello World’|
Selection ID and Selection Parameter Technical ID:
With release ByD 1602 the system enables you to transfer selection parameters using URL parameter param.Selection.<Selection Parameter Technical ID>. For example, if you would like to open a contextual report based on a city, then the city can be transferred as a selection parameter value.
Please note: if a report URL contains a selection variant as well as selection parameters, then the system ignores the selection variant and applies the selection values from URL parameter param.Selection.<Selection Parameter Technical ID> only.
URL encoding for special characters and spaces:
Some applications/browsers may require URLs without spaces, unsafe characters and special characters outside the ASCII character-set. In this case replace those characters by the corresponding %-syntax. You find more details on HTML URL Encoding Reference.
Since release ByD 1508 the endpoint /sap/public/ap/ui/runtime is recommended to launch ByD reports. This endpoint works for ByD as well as C4C and re-directs you automatically to the right endpoint according the solution and your company settings.
The deprecated endpoint /sap/public/byd/runtime is still supported for compatibility reasons, but should not be used anymore. New features will be supported for the new endpoint /sap/public/ap/ui/runtime only.
Single Sign-On (SSO):
Logon using single sign-on can be implemented by using the corresponding single sign-on hostname.
|myXXXXXX-sso.sapbydesign.com/sap/ap/ui/runtime||Logon using SSO|
|myXXXXXX.sapbydesign.com/sap/public/ap/ui/runtime||Logon without SSO|
with parameter &saml2=disabled
|Logon without SSO by using the SSO hostname with disabled SSO (not recommended)|
Example Report URLs:
Example report URL with selection variant:
Example report URL with selection parameter:
One more example with multiple selection parameter:
Open ByD Report in MS Excel (xml format)
The URL schema to open ByD reports in Microsoft Excel XML format is:
&VIEW=<Report View ID>
How to get URL Parameter Values?
Basically you get all parameter values from the ByD report UI.
To get the Report ID, Report View ID and Selection ID open the ByD report in the ByD UI, select the report view and selection variant of your choice and click on “Details”.
The displayed popup lists all technical details of your report incl. Report ID, Report View ID and Selection ID.
To get the Selection Parameter Technical IDs click on “Show Technical ID” in the selection area of your report. As result the technical IDs of your selection parameters are added to the Selection field names in brackets.
For a quick test you send the ByD report URLs to yourself as e-mail. Open the report with the report view and selection variant of your choice and click on button “Send” >> “As E-Mail Link (Web Browser)” or “As E-Mail Link (Microsoft Excel in XML Format)” and send the report link to yourself or any other user in ByD (please note: the report link in the e-mail contains report ID, report view ID and selection variant ID, but not selection parameters).