Ready to get started?

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

 Download Now

Learn more:

SAP ByDesign Icon SAP ByDesign JDBC Driver

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

Connect to SAP ByDesign Data from a Connection Pool in JBoss



Integrate SAP ByDesign data into Java servlets: Use the Management Console in JBoss to install the SAP ByDesign JDBC Driver.

CData JDBC drivers can be configured in JBoss by following the standard procedure for connection pooling. This article details how to access SAP ByDesign data from a connection pool in JBoss applications. This article details how to use the JBoss Management Interface to configure the CData JDBC Driver for SAP ByDesign. You will then access SAP ByDesign data from a connection pool.

Create a JDBC Data Source for SAP ByDesign from the Management Console

Follow the steps below to add the driver JAR and define required connection properties.

  1. In the Runtime menu, select the Domain or Server menu, depending on whether you are deploying to a managed domain or to a stand-alone server, and click "Manage deployments" to open the Deployments page.
  2. Click Add. In the resulting wizard, add the JAR file and license for the driver, located in the lib subfolder of the installation directory. Finish the wizard with the defaults, select the driver, and click Enable.
  3. In the Configuration menu, click Subsystems -> Connector -> Datasources. This opens the JDBC Datasources page.
  4. Click Add and, in the resulting wizard, enter a name for the driver and the JNDI name. For example: java:jboss/root/jdbc/SAPByDesign
  5. Select the driver that you added above.
  6. Enter the JDBC URL and the username and password. The syntax of the JDBC URL is jdbc:sapbydesign: followed by a semicolon-separated list of connection properties.

    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.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the SAP ByDesign JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.sapbydesign.jar

    Fill in the connection properties and copy the connection string to the clipboard.

    A typical connection string is below:

    jdbc:sapbydesign:URL=https://my999999.sapbydesign.com;User=username;Password=password;CustomService=servicename;
  7. Test the connection and finish the wizard. Select the SAP ByDesign data source and click Enable.

More JBoss Integration

The steps above show how to configure the driver in a simple connection pooling scenario. For more information, refer to the Data Source Management chapter in the JBoss EAP documentation.