Configure the CData JDBC Driver for SAP ByDesign in a Connection Pool in Tomcat

The CData JDBC Drivers support standard JDBC interfaces to integrate with Web applications running on the JVM. This article details how to connect to SAP ByDesign data from a connection pool in Tomcat.

Connect to SAP ByDesign Data through a Connection Pool in Tomcat

1. Copy the CData JAR and CData .lic file to $CATALINA_HOME/lib. The CData JAR is located in the lib subfolder of the installation directory.
2. Add a definition of the resource to the context. Specify the JDBC URL here.

   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.

   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   

   You can see the JDBC URL specified in the resource definition below.

   <Resource name="jdbc/sapbydesign" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.sapbydesign.SAPByDesignDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" url="jdbc:sapbydesign:URL=https://my999999.sapbydesign.com;User=username;Password=password;CustomService=servicename;" maxActive="20" maxIdle="10" maxWait="-1" />
   

   To allow a single application to access SAP ByDesign data, add the code above to the context.xml in the application's META-INF directory.

   For a shared resource configuration, add the code above to the context.xml located in $CATALINA_BASE/conf. A shared resource configuration provides connectivity to SAP ByDesign for all applications.

3. Add a reference to the resource to the web.xml for the application.

    SAP ByDesign data JSP
    jdbc/SAPByDesign
    javax.sql.DataSource
    Container
   
   

4. Initialize connections from the connection pool:

   Context initContext = new InitialContext();
   Context envContext = (Context)initContext.lookup("java:/comp/env");
   DataSource ds = (DataSource)envContext.lookup("jdbc/SAPByDesign");
   Connection conn = ds.getConnection();
    

More Tomcat Integration

The steps above show how to connect to SAP ByDesign data in a simple connection pooling scenario. For more use cases and information, see the JNDI Datasource How-To in the Tomcat documentation.