Developer

Creating a SQL Connection Profile for the Agentry Connector Studio

Create a profile for a connection to a back-end data source. You can use the profile as a template for setting up other connection profiles.

Prerequisites

  • A JDBC connection between the Data Source Tools and the target database. Select the appropriate JDBC drivers and locate and make note of the associated resource files (JAR files or otherwise). You will need this information when you create a driver definition.
  • If a suitable driver definition already exists, make a note of the name of the definition.
  • Gather information about the selected JDBC drivers, specifically the attributes and values needed to configure a connection using the specific driver package. This will likely include the syntax for specifying the database host and server, login and password information, and the Java class or package within the JDBC driver to be used.

Context

You can access the connection you create in this task via the Data Source Explorer view in Eclipse. This view is not a part of the Agentry Editor Eclipse plug-in but is provided with Eclipse. Detailed instruction and information on its functionality and behavior is not provided by SAP; however, you can obtain such information from the Eclipse.org Website. Once this connection is created, it will be listed in the Data Source Explorer view. From here you will be able to perform all functionality supported by the Data Source Tools plus use the Connector Studio functionality provided with the Agentry Editor. These steps use a Microsoft SQL Server back end as an example.

Procedure

  1. From Eclipse, select Start of the navigation path Window Next navigation step Show View Next navigation step Other End of the navigation path. In the tree control, expand the Connectivity node and select Data Source Explorer.

  2. Create a new connection to a database by either right-clicking Database Connections and selecting New; or by clicking in the toolbar. Either shows the New Connection Profile wizard.

  3. Select the database type to which you are making a connection. As well as the database type, this selection is also based on the JDBC driver package to be used. For this example, the connection profile type to be used is Generic JDBC. Enter a name and a description for the connection profile, and click Next.

  4. Create or select the driver to be used for the connection. If a suitable driver profile already exists, select it from the Drivers list, and skip to step 9.
  5. To create a new driver profile, click the New Driver Profile button

  6. On the Name/Type tab, select the driver template. The contents of the list depend on the type of Connection Profile you are creating. In this example, there is only one option, Generic JDBC Driver. Enter a name for the driver definition.
  7. Select the Jar List tab, which contains the JAR files for the JDBC driver package to be used for this driver definition. For this example, the list is empty.

  8. Add the appropriate JAR files to this list by selecting from those that are provided with the selected JDBC driver package: click the Add Jar/Zip button, then browse to the JAR file on the file system.

    For the example, the selected item is the JAR file for the jTDS <x.x.x> JDBC driver package provided by SourceForge.net. The selected JAR file or files for other driver packages will differ.

  9. Select the Properties tab. The items that appear on this tab are dependent on the selected JAR file, and are those items the JDBC driver requires to establish connections.

    The values set here should be used as default or template values. You can reuse the driver definition for multiple connections to the same type of database. The values you enter here provide the default values when you use this driver definition in a new connection profile. Once these items are set, click OK.


    You see the New Connection Profile wizard again. The values on this screen match those entered for the selected JDBC driver properties.

  10. Alter these settings by entering the proper values for the specific database connection to be created. In this example, the database name, URL, user name, and password are altered for a connection to a Northwind database in MS SQL Server.

  11. If the target database is available, you can clickTest Connection. If the connection is successful, you see the message "Ping succeeded!". Click OK..
  12. Choose whether to connect when this wizard closes, and also whether or not to connect automatically when the Data Source Explorer view appears in Eclipse. Click Next to view a summary of the configuration, or Finish to close the wizard.

    The Data Source Explorer View now includes the new connection profile under Database Connections with the name you entered.


Results

The database connection enables you to use the schema information provided by the database in the object definition process. The developer can use the Agentry Connector Studio, accessed through the Data Source Explorer view, to select a table and to create or modify an object definition, as well as its related transactions and SQL Step definitions, based on the structure of the database table.