Bulk extract data from SAP Business ByDesign

Post describes how Power Query (Get & Transform) can be used as ETL tool for SAP Business ByDesign (SAP ByD).

Purely Self-Service BI solution built on Excel for SAP Business ByDesign (SAP ByD).

Level: Advanced

How to extract master and operational data from SAP ByD using Power Query

Common information can be found in my previous posts, which I’d recommend to go through

Several ways of data extraction from SAP Business ByDesign

Query SAP Business ByDesign Web Services via Power Query

From all possible methods of data extraction, I chose Excel + Power Query as the most simple one for Modern Excel data analysts (non-IT pro).

What do we need to start this journey?

What can help?

Massive data extraction from SAP ByDesign

Let’s start from the most interesting – extract of large data volume from SAP ByD.

If you, for example, required to transfer data from SAP ByDesign to MS SQL, you most probably have to transfer

  • Master data; e.g. Account Master Data, Materials, Contacts, Employees, Organization Structure etc.
  • Operational data; e.g. Invoices, Sales Orders, Service Orders, Activities, General Ledger etc.

Both types of data sources can contain huge amount of records. This makes impossible to export all data at once through SAP ByD reporting engine.

OData has limits as well, so do Web Services.

But we can make many queries, each for small portion of data – and in the end combine them.

Depending on report we need to choose field that can help granulate data so, that small portion of data does not reach limit.

For example, Posting Date is a good field to slice General Ledger.

Build connection strings

What we need to do is to build list of connection string, where each connection string represents request for a small portion of data, having different $filter

Date Filter ConnectionString


CSETOFBKS eq ‘9011’ and KCAMTCOMP ne 0 and CPOSTING_DATE eq datetime’2015-01-01T00:00:00′ https://my336123.sapbydesign.com/sap/byd/odata/cc_home_analytics.svc/RPZ9398CB74255DBC51F208B2QueryResults?$top=100000&$skip=0&

$filter=CSETOFBKS eq ‘9011’ and KCAMTCOMP ne 0 and CPOSTING_DATE eq datetime’2015-01-01T00:00:00’&



CSETOFBKS eq ‘9011’ and KCAMTCOMP ne 0 and CPOSTING_DATE eq datetime’2015-01-02T00:00:00′ https://my336123.sapbydesign.com/sap/byd/odata/cc_home_analytics.svc/RPZ9398CB74255DBC51F208B2QueryResults?$top=100000&$skip=0&

$filter=CSETOFBKS eq ‘9011’ and KCAMTCOMP ne 0 and CPOSTING_DATE eq datetime’2015-01-02T00:00:00’&



CSETOFBKS eq ‘9011’ and KCAMTCOMP ne 0 and CPOSTING_DATE eq datetime’2015-01-03T00:00:00′ https://my336123.sapbydesign.com/sap/byd/odata/cc_home_analytics.svc/RPZ9398CB74255DBC51F208B2QueryResults?$top=100000&$skip=0&

$filter=CSETOFBKS eq ‘9011’ and KCAMTCOMP ne 0 and CPOSTING_DATE eq datetime’2015-01-03T00:00:00’&



If you have no many transactions per month, you may use Accounting Period/Fiscal year field to slice data source.

Sample query that generates list of dates and connection strings can be found in Advanced Report Workbook

Add column with a custom function in Power Query

After watching Deep Dive into Power Query Formula Language I realized the true power of Power Query in work with data.

When we have a table with list of connection strings – nothing stops us from add column with function ByD.GetReportDataIDs.

PQ will apply this function for each row, each connection string – and in the end we have a column with Table objects in each row, where each Table represents data set for particular date. Left only to expand each table.

Sometimes, there is no data for particular date, and if you load result into PowerPivot Data Model you must load table with defined list of columns. For this purpose you may use custom function Table.FromString.

Checking PQ trace log I found that Power Query requests data in multiple threads – this helps to dramatically reduce refresh time. All small portions are collecting faster.

Described approach can be applied to any SAP ByD report. Using it you can download entire data source if needed, just find a good slicing field.

Keep reading if you interested in details of this solution. Below you may find step-by-step guideline.

How perform OData query from SAP using Power Query?

  1. Prepare report in SAP ByDesign for OData
  2. Create connection string for OData
  3. Query report by Power Query function Web.Contents
  4. Parse response in Power Query, do necessary transformations
  5. Load result to worksheet (or Data Model)

    1. Prepare report in SAP ByDesign


    This step is needed only for those reports that have restricted Initial Selection.

    For example, G/L Accounts – Line Items by default has initial selection restricted to “Current Fiscal Period”

    It means that you cannot get any data from other fiscal periods through OData, as it works only with Initial Selection.

    How to make un-restricted report?

    Find report in Business Analytics work center

    And create new as copy of existing report

    Provide a name that will allow to identify this report

    Remove tick from “Copy With Navigation” checkbox. Keep it only if you really need this.

    Next step is very important – select key figures

    Select “Show All” key figures (by default you may see Key Figure Groups)

    Key Figure Groups may contain key figures restricted by variable, that is mandatory in report.

    Usually, for data extraction we need only pure basic key figures.

    Un-select groups and select basic key figures

    Add characteristics missing in original report.

    If you plan to use this report not only for OData – add characteristics to Selection.

    Note: it is not required for OData! Through OData you may filter by all fields that are configured as “filterable”, even if they are not shown in Selection Area.

    Save new report and assign to corresponding work centers. I usually assign to the same work centers as original report to avoid data access issues.

    2. Create OData connection string

    Our goal is to get something like


    From the first sight it looks scarifying.

    For $select string we need ID of each field. This info can be retrieved from report metadata.

    Get SAP ByD Report Metadata

    As new report was manually created it got unique ID – find it in Business Analytics work center

    According to guide: OData for SAP Business ByDesign Analytics

    We should build following string to get report metadata (mainly for field IDs and names)


    String with our data


    In Firefox it shows me

    Actually, it is enough to configure $select string with such XML, but too tedious.

    To simplify this process I developed simple Excel workbook – Report String Generator, where I can enter tenant and report ID, and get metadata

    Then enter field names in column and Excel formulas will finish the task.

    3. Query report via Power Query

OK, we got parts of connection string, let’s use them.

For quick win you may take Simple Report template

Just input your report parameters and refresh Result query.

If you interested in details of the process behind – keep reading

We had built connection string:


Note: this URL doesn’t contain keyword $filter ! It means that PQ will pull everything – entire data source (until reach limit set by $top=100000). According to size of data set such report can fail.

Use standard query from Web

Paste that ugly URL

Provide basic credentials of your user

As we requested, report came in json format (keyword $format=json is important)

By unknown reasons, PQ applied Lined.FromBinary function, instead of Json.Document (maybe related to PQ version).


Open Advanced Editor and change the code


Source = Web.Contents(“https://my336123.sapbydesign.com/sap/byd/odata/cc_home_analytics.svc/RPZ9398CB74255DBC51F208B2QueryResults?$top=100000&



buffer = Binary.Buffer( Source ), // buffer to avoid possible repetitive requests

json = Json.Document( buffer )



After this you can just drill down, expand json till you get desired result (if you want to do these steps on your own).

I described how I had being doing this when did my first steps in this direction.

Then I simplified process by developing function ByD.GetReportDataIDs

This function expand result for you, just provide a connection string:

And then I came to life saving templates – such as Simple Report Workbook.

4. Parse response in Power Query, do necessary transformations

  1. Simply pull data from SAP ByDesign usually is not enough for data model.We need to doRename fields

    Check data type of every field

    Convert date fields into normal date

    Convert time fields (if any)

    Probably – clean data, e.g. replace “Not Assigned” or # with null

    Use function Date.EpochToDate.m to convert ByD json date field into normal date.

    You may read here how to transform column in Power Query with a specific function.

    For quick renaming headers in Power Query – use rename technique described here

    5. Load result to worksheet (or Data Model)

Depending on purpose of data extraction, choose where do you want to place your data.

Btw, so far, I couldn’t find a way to connect SSIS to SAP ByDesign directly, maybe because of SAP security settings, maybe because OData in SAP ByDesign is not pure OData, maybe because it requires more professional knowledge.


8 thoughts on “Bulk extract data from SAP Business ByDesign

  1. kevin Ledley 2018-03-25 / 12:02

    have you also worked with WSDL in ByD for the purpose of label printing

    • Ivan Bondarenko 2018-03-25 / 13:49

      Hi Kevin,
      I used Web Services (WSDL) as well, but not for label printing. Does purpose of getting data make difference?
      I can give you better advice if you provide more details on your scenario.
      Kind regards,

      • kevin Ledley 2018-03-26 / 00:58

        Hi Ivan, you are kind to follow up, the current system “Bartender” label printer, is able to draw directly on demand any details that SAP B1 has directly from the SQL data, it is preferable to be able to do the same with ByD. for this i need to be able to access data on demand, so far only reporting functions seem to be available. i have also found the standard reporting functions all centre around financials none address in stock serial / batch numbers which we require on the label at the point of stores receipt for tracking. what are your thoughts. cheers Kevin.

        • Ivan Bondarenko 2018-04-02 / 17:16

          Hi Kevin, first of all, you need to identify object in ByD that contains required info. From your comment I couldn’t understand what exactly you need for labels to be printed. Outbound Deliveries / Materials / Customer Invoice Header / Customer Invoice Item etc. When you find object, it becomes clear what you need to find next – Data Source and Report based on that data source, or – Web Service (check page https://help.sap.com/doc/saphelp_byd1802_en/2018.02/en-US/PUBLISHING/IntegrationServices.html).
          Sometimes, there is a data source in ByD but no Report, in this case you can create report.
          In worst case you can create your own OData Service with fields needed and query it from your application using standard http-odata query.
          ByD is quite flexible nowadays, all depends on object required and possibilities of your application.
          Kind regards,

  2. kevin Ledley 2018-04-03 / 06:31

    thanks Ivan,
    at this stage we are looking at SOAP and gathering required data for the printer to draw off,

    part no,
    batch no,
    serial no,
    bar code.

    is the essential data.
    identifying the “serial no” and “batch no” is a puzzle, 8,000 unique fields as a guess.
    once we get connected, find the correct fields and control “in stock only” we will have what we need for the printer.

    i assumed “Query Materials” would have “serial no” but cannot see it in the doc briefing.
    any insight you have will be greatly appreciated.

    i am also interested in the “create you own report”, i had a look through Excel and did not see the option, is Crystal the preferred method.

    cheers Kevin

    • Ivan Bondarenko 2018-04-09 / 03:44

      Hi Kevin, to create your own report you need to go to Business Analytics work center “Design Reports” view. Check out video course https://open.sap.com/courses/byd2 (Unt3 on Week1, Week3).
      I think “serial no” location depends on your system architecture. Follow the business process, where it is generated or where user input serial no.
      In my case, serial no appears in the system as “Registered Product” after Outbound Delivery is completed, where user inputs serial numbers for Materials requiring identification.
      BR, Ivan

      • Kevin Ledley 2018-04-09 / 04:16

        Thanks Ivan, much appreciated, will explore that avenue. Cheers Kevin

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google+ photo

You are commenting using your Google+ account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )


Connecting to %s