Import SAP ByDesign Data into Apache Solr

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SAP ByDesign JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with SAP ByDesign.



Use the CData JDBC Driver for SAP ByDesign in Data Import Handler and create an automated import of SAP ByDesign data to Apache Solr Enterprise Search platform.

The Apache Solr platform is a popular, blazing-fast, open source enterprise search solution built on Apache Lucene.

Apache Solr is equipped with the Data Import Handler (DIH), which can import data from databases and, XML, CSV, and JSON files. When paired with the CData JDBC Driver for SAP ByDesign, you can easily import SAP ByDesign data to Apache Solr. In this article, we show step-by-step how to use CData JDBC Driver in Apache Solr Data Import Handler and import SAP ByDesign data for use in enterprise search.

Create an Apache Solr Core and a Schema for Importing SAP ByDesign

  1. Run Apache Solr and create a Core. > solr create -c CDataCore For this article, Solr is running as a standalone instance in the local environment and you can access the core at this URL: http://localhost:8983/solr/#/CDataCore/core-overview
  2. Create a schema consisting of "field" objects to represent the columns of the SAP ByDesign data to be imported and a unique key for the entity. LastModifiedDate, if it exists in SAP ByDesign, is used for incremental updates. If it does not exist, you cannot do the deltaquery in the later section. Save the schema in the managed-schema file created by Apache Solr.
  3. SAPByDesignUniqueKey
  4. Install the CData SAP ByDesign JDBC Driver. Copy the JAR and license file (cdata.sapbydesign.jar and cdata.jdbc.sapbydesign.lic) to the Solr directory.
    • CData JDBC JAR file: C:\Program Files\CData\CData JDBC Driver for SAP ByDesign ####\lib
    • Apache Solr: solr-8.5.2\server\lib

Now we are ready to use SAP ByDesign data in Solr.

Define an Import of SAP ByDesign to Apache Solr

In this section, we walk through configuring the Data Import Handler.

  1. Modify the Config file of the created Core. Add the JAR file reference and add the DIH RequestHander definition. <lib dir="${solr.install.dir:../../../..}/dist/" regex="solr-dataimporthandler-.*\.jar" /> <requestHandler name="/dataimport" class="org.apache.solr.handler.dataimport.DataImportHandler"> <lst name="defaults"> <str name="config">solr-data-config.xml</str> </lst> </requestHandler>
  2. Next, create a solr-data-config.xml at the same level. In this article, we retrieve a table from SAP ByDesign, but you can use a custom SQL query to request data as well. The Driver Class and a sample JDBC Connection string are in the sample code below. <dataConfig> <dataSource driver="cdata.jdbc.sapbydesign.SAPByDesignDriver" url="jdbc:sapbydesign:URL=https://my999999.sapbydesign.com;User=username;Password=password;CustomService=servicename;"> </dataSource> <document> <entity name="[Inventory Balance]" query="SELECT Id,SAPByDesignColumn1,SAPByDesignColumn2,SAPByDesignColumn3,SAPByDesignColumn4,SAPByDesignColumn5,SAPByDesignColumn6,SAPByDesignColumn7,LastModifiedDate FROM [Inventory Balance]" deltaQuery="SELECT Id FROM [Inventory Balance] where LastModifiedDate >= '${dataimporter.last_index_time}'" deltaImportQuery="SELECT Id,SAPByDesignColumn1,SAPByDesignColumn2,SAPByDesignColumn3,SAPByDesignColumn4,SAPByDesignColumn5,SAPByDesignColumn6,SAPByDesignColumn7,LastModifiedDate FROM [Inventory Balance] where Id=${dataimporter.delta.Id}"> <field column="Id" name="Id" ></field> <field column="SAPByDesignColumn1" name="SAPByDesignColumn1" ></field> <field column="SAPByDesignColumn2" name="SAPByDesignColumn2" ></field> <field column="SAPByDesignColumn3" name="SAPByDesignColumn3" ></field> <field column="SAPByDesignColumn4" name="SAPByDesignColumn4" ></field> <field column="SAPByDesignColumn5" name="SAPByDesignColumn5" ></field> <field column="SAPByDesignColumn6" name="SAPByDesignColumn6" ></field> <field column="SAPByDesignColumn7" name="SAPByDesignColumn7" ></field> <field column="LastModifiedDate" name="LastModifiedDate" ></field> </entity> </document> </dataConfig>
  3. In the query section, set the SQL query that select the data from SAP ByDesign. deltaQuery and deltaImportquery define the ID and the conditions when using incremental updates from the second import of the same entity.
  4. After all settings are done, restart Solr. > solr stop -all > solr start

Run a DataImport of SAP ByDesign Data.

  1. Execute DataImport from the URL below:
    http://localhost:8983/solr/#/CDataCore/dataimport//dataimport
  2. Select the "full-import" Command, choose the table from Entity, and click "Execute."
  3. Check the result of the import from the Query.
  4. Try an incremental update using deltaQuery. Modify some data in the original SAP ByDesign data set. Select the "delta-import" command this time from DataImport window and click "Execute."
  5. Check the result of the incremental update.

Using the CData JDBC Driver for SAP ByDesign you are able to create an automated import of SAP ByDesign data into Apache Solr. Download a free, 30 day trial of any of the 200+ CData JDBC Drivers and get started today.