Build a Simple VCL Application for Webex Data
Embarcadero RAD Studio provides a development environment for Delphi and C++Builder applications. With the CData ODBC Driver for Webex, you gain access to live Webex data within RAD Studio, abstracting the data into tables, views, and stored procedures that can be used to retrieve Webex data. This article will walk through connecting to Webex and creating a simple VCL application with the Form Designer.
Create a Connection to Webex 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.
To authenticate to Webex, and connect to your own data or to allow other users to connect to their data, you can use the OAuth standard.
Using OAuth Authentication
First, you will need to register an OAuth application with Webex. To do so, navigate to the Webex Developer Portal and create a new integration. Your OAuth application will be assigned a client id and a client secret.
After setting the following connection properties, you are ready to connect:
- AuthScheme: Set this to OAuth.
- InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
- OAuthClientId: Set this to the client_id that is specified in your app settings.
- OAuthClientSecret: Set this to the client_secret that is specified in your app settings.
- CallbackURL: Set this to the Redirect URI that is specified in your app settings.
- Scope: Set this in ProfileSettings to specify the OAuth scopes requested during authorization. Multiple scopes can be space-separated (e.g. ProfileSettings='Scope=spark:all spark:kms').
Example connection string:
Profile=C:\profiles\Webex.apip;Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;ProfileSettings='Scope=your_scopes';
You can then follow the steps below to use the Data Explorer to create a FireDAC connection to Webex data.
- In a new VCL Forms application, expand the FireDAC node in the Data Explorer.
- Right-click the ODBC Data Source node in the Data Explorer.
- Click Add New Connection.
- Enter a name for the connection.
- In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for Webex.
Create VCL Applications with Connectivity to Webex Data
Follow the procedure below to start executing queries to Webex data from a simple VCL application that displays the results of a query in a grid.
-
Drop a TFDConnection component onto the form and set the following properties:
- ConnectionDefName: Select the FireDAC connection to Webex data.
- Connected: Select True from the menu and, in the dialog that appears, enter your credentials.
-
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 , FROM AdminAuditEvents WHERE OrgId = 'org123'
- Active: Set this property to true.
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.
-
Drop a TDBGrid control onto the form and set the following property:
- DataSource: Select the name of the TDataSource.
- Drop a TFDGUIxWaitCursor onto the form — this is required to avoid a run-time error.
You now have an executable application that displays the results of the SQL Query set in the TFDQuery object.
Related Articles
Below you can find other articles for using the CData ODBC Driver with RAD Studio, Delphi, and C++ Builder.