DataBind Controls to SAP Netweaver Gateway Data in Delphi

The CData ODBC driver for SAP Netweaver Gateway supports the ODBC standard to enable integration of live SAP Netweaver Gateway data with visual form designers and other rapid development tools in Delphi. The ODBC driver simplifies data access strategies for applications that share a single codebase like Delphi by providing a single API for database development. This article shows how to how to connect to SAP Netweaver Gateway data and query data from a simple visual component library (VCL) application, as well as from Delphi code.

Create a Connection to SAP Netweaver Gateway 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.

SAP Gateway allows both basic and OAuth 2.0 authentication. You can use basic authentication to connect to your own account, or you can use OAuth to enable other users to retrieve data from your service with their accounts. In addition to authenticating, set the following connection properties to access SAP Gateway tables.

• Url: Set this to the URL of your environment, or to the full URL of the service. For example, the full URL might appear as: https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/. In this example, the environment URL would just be: https://sapes5.sapdevcenter.com.
• Namespace: Set the appropriate Service Namespace. In the example above, IWBEP is the namespace. It is optional if the full URL to the service is specified.
• Service: Set this to the service you want to retrieve data from. In the example above, the service is GWSAMPLE_BASIC. It is not required if the full URL is specified.

Authenticate via Basic Authentication

In basic authentication, you use your login credentials to connect. Set the following properties:

• User: This is the username you use to log in to SAP Gateway.
• Password: This is the password you use to log in to SAP Gateway.

Authenticate via OAuth Authentication

You can connect to SAP Gateway using the embedded OAuth connectivity (without setting any additional authentication connection properties). When you connect, the OAuth endpoint opens in your browser. Log in and grant permissions to complete the OAuth process. See the OAuth section in the online Help documentation for more information on other OAuth authentication flows.

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

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 Netweaver Gateway.

👁 A FireDAC connection to the ODBC data source. (Salesforce is shown.)

Create VCL Applications with Connectivity to SAP Netweaver Gateway Data

Follow the procedure below to start executing queries to SAP Netweaver Gateway 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 Netweaver Gateway data.
   • 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 ProductID, Quantity FROM SalesOrderLineItems WHERE Quantity < 15
     

   • 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.

👁 Components in FireDAC used to databind an editable grid to the data source. (Salesforce is shown.)

Execute Commands to SAP Netweaver Gateway with FireDAC Components

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

Connect to SAP Netweaver Gateway 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 := 'mysapgateway';
FDConnection1.Connected := true;

Create Parameterized Queries

Parameterized resources can improve performance: 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.Open('select * from SalesOrderLineItems where Quantity = :Quantity',['15']);

To execute a query that does not return a result set, such as a delete, use the ExecSQL method. The ExecSQL method will return an error if the query returns a result set. To retrieve the count of affected rows, use the TFD.RowsAffected property.

FDQuery1.ExecSQL('delete from SalesOrderLineItems where Id= :myId',['x12345']);
i := FDQuery1.RowsAffected;

Related Articles

Below you can find other articles for using the CData ODBC Driver with RAD Studio, Delphi, and C++ Builder.

• DataBind Controls to SAP Netweaver Gateway Data in C++Builder
• Viewing SAP Netweaver Gateway Data in RAD Studio Data Explorer
• Build a Simple VCL Application for SAP Netweaver Gateway Data