Build SAP Ariba Source-Connected Web Apps in Servoy

Servoy is a rapid application development and deployment platform. When paired with the CData JDBC Driver for SAP Ariba Source, users can build SAP Ariba Source-connected apps that work with live SAP Ariba Source data. This article describes how to connect to SAP Ariba Source from Servoy and build a simple web app to display and search SAP Ariba Source data.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live SAP Ariba Source data. When you issue complex SQL queries to SAP Ariba Source, the driver pushes supported SQL operations, like filters and aggregations, directly to SAP Ariba Source and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying lets you work with SAP Ariba Source data using native data types.

Connect to SAP Ariba Source in Servoy Developer

To build SAP Ariba Source-connected apps, you need to first create a data provider in Servoy Developer using the CData JDBC Driver for SAP Ariba Source.

1. Install the JDBC Driver.
2. Copy the JDBC Driver JAR file. (cdata.jdbc.saparibasource.jar) to the /application_server/drivers/ directory in the installation directory for Servoy.
3. Open Servoy Developer.
4. In the Solution Explorer, right-click Database Server (under Resources) and choose "Connect to existing database" -> "empty."
   1. Name the server.
   2. Click to show the advanced server settings.

      • Set the URL, for example: jdbc:saparibasource:API=SupplierDataAPIWithPagination-V4;APIKey=wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU;Environment=SANDBOX;Realm=testRealm;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH

        Built-In Connection String Designer

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

        java -jar cdata.jdbc.saparibasource.jar

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

        In order to connect with SAP Ariba Source, set the following:

        • API: Specify which API you would like the provider to retrieve SAP Ariba data from. Select the Supplier, Sourcing Project Management, or Contract API based on your business role (possible values are SupplierDataAPIWithPaginationV4, SourcingProjectManagementAPIV2, or ContractAPIV1).
        • DataCenter: The data center where your account's data is hosted.
        • Realm: The name of the site you want to access.
        • Environment: Indicate whether you are connecting to a test or production environment (possible values are TEST or PRODUCTION).

        If you are connecting to the Supplier Data API or the Contract API, additionally set the following:

        • User: Id of the user on whose behalf API calls are invoked.
        • PasswordAdapter: The password associated with the authenticating User.

        If you're connecting to the Supplier API, set ProjectId to the Id of the sourcing project you want to retrieve data from.

        Authenticating with OAuth

        After setting connection properties, you need to configure OAuth connectivity to authenticate.

        • Set AuthScheme to OAuthClient.
        • Register an application with the service to obtain the APIKey, OAuthClientId and OAuthClientSecret.

          For more information on creating an OAuth application, refer to the Help documentation.

        Automatic OAuth

        After setting the following, you are ready to connect:

        APIKey: The Application key in your app settings. OAuthClientId: The OAuth Client Id in your app settings. OAuthClientSecret: The OAuth Secret in your app settings.

        When you connect, the provider automatically completes the OAuth process:

        1. The provider obtains an access token from SAP Ariba and uses it to request data.
        2. The provider refreshes the access token automatically when it expires.
        3. The OAuth values are saved in memory relative to the location specified in OAuthSettingsLocation.
      • Select the Driver class you just copied, for example, cdata.jdbc.saparibasource.SAPAribaSourceDriver

Build a SAP Ariba Source-Connected Web App

Once you have configured the connection to SAP Ariba Source in the Servoy Developer resources, you are ready to build apps with access to live SAP Ariba Source data.

Create a New Solution

1. In the Server Explorer, right-click "All solutions" and select "Create new solution."
2. Name the solution.
3. Select the checkbox to include the "search" module.
4. Click "Finish."

Create a New Form

Right-click "Forms" and select "Create new form."

1. Name the form.
2. Select a Datasource.
3. Set the type (e.g., Simple) and click "Finish."

Add a Data Grid to the Form

1. Drag a Data Grid component (from Servoy NG-Grids) onto the form.

2. Drag a column component onto the Data Grid and set the "dataprovider" property for each column component to a column from the SAP Ariba Source "table" (e.g., SMVendorID from the Vendors table).

   Continue adding columns as desired.

Add Searching to the App

Note that the "svySearch" extension is required to add search functionality (included by default when you create a new solution). If you did not add the extension when you created the solution or you are modifying an existing solution, you can add the search module by right-clicking Modules (in the solution) and selecting "Add Module." Select "svySearch" and click "OK."

1. Drag a Text Field component onto the Form.
2. Right-click the Form and select "Open in Script Editor."
3. Create a new variable (JavaScript) to hold the search value:

   var searchText = '';
   

4. Back on the Form, in the Text Field properties:
   1. Set the "dataprovider" property to the Form variable you just created.
   2. Double-click to add a method for the onAction event.
   3. Click to create the method in "Form," name the method (e.g., onEnter), and click "Create private."
   4. Click "OK & Show."
5. Add the following JavaScript to the JavaScript file to use the Servoy framework to implement searching bound data based on the text in the Text Field:

   var search = scopes.svySearch.createSimpleSearch(foundset).setSearchText(searchText);
   search.setSearchAllColumns();
   search.loadRecords(foundset);
   

Save and Launch the App

Save the form and JavaScript file, then click Run -> Launch NGClient to start the web app.

Download a free, 30-day trial of the CData JDBC Driver for SAP Ariba Source and start building SAP Ariba Source-connected apps with Servoy. Reach out to our Support Team if you have any questions.