Learn more
 

Ready to get started?

Download a free trial of the SAP ByDesign ODBC Driver to get started:

 Download Now

Learn more:

SAP ByDesign Icon SAP ByDesign ODBC Driver

The SAP ByDesign ODBC Driver is a powerful tool that allows you to connect with live data from SAP ByDesign, directly from any applications that support ODBC connectivity.

Access SAP ByDesign data like you would a database - read, write, and update SAP ByDesign Customers, Products, Leads, Suppliers, etc. through a standard ODBC Driver interface.

In this article

Related articles

DataBind Controls to SAP ByDesign Data in C++Builder


DataBind to SAP ByDesign data in C++Builder with standard components and controls.

The CData ODBC Driver for SAP ByDesign makes it easy to integrate connectivity to live SAP ByDesign data with standard data access components in C++Builder. This article shows how to create a simple visual component library (VCL) application in C++Builder that connects to SAP ByDesign data, executes queries, and displays the results in a grid. An additional section shows how to use FireDAC components to execute commands from code.

Create a Connection to SAP ByDesign Data

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

Set the following connection properties to connect to SAP ByDesign.

  • Url: Set this to the Url of your SAP ByDesign site. For example, https://test.sapbydesign.com
  • User: Set this to the username of your account.
  • Password: Set this to the password of your account.
  • CustomService or AnalyticsService: Only one of these must be specified. If you have a custom service you want to retrieve data from, specify CustomService. If you want to retrieve the reports of a analytical service, specify AnalyticsService.
    If neither is specified, 'cc_home_analytics.svc' will used as a default for the AnalyticsService property. If you are not sure what service to specify, you can always query the Services view to list available services.

You can then follow the steps below to use the Data Explorer to create a FireDAC connection to SAP ByDesign.

  1. In a new VCL Forms application, expand the FireDAC node in the Data Explorer.
  2. Right-click the ODBC Data Source node in the Data Explorer.
  3. Click Add New Connection.
  4. Enter a name for the connection.
  5. In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for SAP ByDesign.

Create VCL Applications with Connectivity to SAP ByDesign Data

Follow the procedure below to start querying SAP ByDesign data from a simple VCL application that displays the results of a query in a grid.

  1. Drop a TFDConnection component onto the form and set the following properties:

    • ConnectionDefName: Select the FireDAC connection to SAP ByDesign.
    • Connected: Select True from the menu and, in the dialog that appears, enter your credentials.

  2. Drop a TFDQuery component onto the form and set the properties below:

    • Connection: Set this property to the TFDConnection component, if this component is not already specified.

    • SQL: Click the button in the SQL property and enter a query. For example:

      SELECT ID, ProductCategoryID FROM [Inventory Balance] WHERE ProductCategoryID = '1234567'
    • Active: Set this property to true.

  3. Drop a TDataSource component onto the form and set the following property:

    • DataSet: In the menu for this property, select the name of the TFDQuery component.

  4. Drop a TDBGrid control onto the form and set the following property:

    • DataSource: Select the name of the TDataSource.
  5. Drop a TFDGUIxWaitCursor onto the form — this is required to avoid a run-time error.

Execute Commands to SAP ByDesign with FireDAC Components

You can use the TFDConnection and TFQuery components to execute queries to SAP ByDesign data. This section provides SAP ByDesign-specific examples of executing queries with the TFQuery component.

Connect to SAP ByDesign Data

To connect to the data source, set the Connected property of the TFDConnection component to true. You can set the same properties from code:

FDConnection1->ConnectionDefName = "CData SAP ByDesign ODBC Source"; FDConnection1->Connected = true;

To connect the TFDQuery component to SAP ByDesign data, set the Connection property of the component. When a TFDQuery component is added at design time, its Connection property is automatically set to point to a TFDConnection on the form, as in the application above.

Create Parameterized Queries

To create a parameterized query, use the following syntax below:

FDQuery1->SQL->Text = "select * from [Inventory Balance] where productcategoryid = :ProductCategoryID"; FDQuery1->ParamByName("productcategoryid")->AsString = "1234567"; query->Open();

The example above binds a string-type input parameter by name and then opens the dataset that results.

Prepare the Statement

Preparing statements is costly in system resources and time. The connection must be active and open while a statement is prepared. By default, FireDAC prepares the query to avoid recompiling the same query over and over. To disable statement preparation, set ResourceOptions.DirectExecute to True; for example, when you need to execute a query only once.

Execute a Query

To execute a query that returns a result set, such as a select query, use the Open method. The Open method executes the query, returns the result set, and opens it. The Open method will return an error if the query does not produce a result set.

FDQuery1->SQL->Text := "select * from [Inventory Balance] where productcategoryid = :ProductCategoryID"; FDQuery1.ParamByName("productcategoryid")->AsString = "1234567"; FDQuery1->Open();