Rapidly Develop Zoom-Driven Apps with Active Query Builder

Connect to Zoom as an ODBC Data Source

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.

Start by setting the Profile connection property to the location of the Zoom Profile on disk (e.g. C:\profiles\Zoom.apip). Next, set the ProfileSettings connection property to the connection string for Zoom (see below).

Zoom API Profile Settings

To authenticate to Zoom, you can use the OAuth standard to connect to your own data or to allow other users to connect to their data.

First you will need to create an OAuth app. To do so, navigate to https://marketplace.zoom.us/develop/create and click Create under the OAuth section. Select whether or not the app will be for individual users or for the entire account, and uncheck the box to publish the app. Give the app a name and click Create. You will then be given your Client Secret and Client ID

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 OAuth Client ID that is specified in your app settings.

OAuthClientSecret: Set this to the OAuth Client Secret that is specified in your app settings.

CallbackURL: Set this to the Redirect URI you specified in your app settings.

Use SQL to Interact with Zoom

Follow the steps below to create a WinForms visual query builder.

In a new Windows Forms project, drag the QueryBuilder from the Toolbox onto the form.

Add a reference to ActiveQueryBuilder.ODBCMetadataProvider.

Add an OdbcConnection and set the connection string to the DSN that you created in the first section.


OdbcConnection connection = new OdbcConnection();
connection.ConnectionString = "DSN=API"

Initialize ODBCMetadataProvider and GeneralSyntaxProvider instances and set the Connection property of the ODBCMetadataProvider object to the OdbcConnection.


GenericSyntaxProvider syntaxProvider = new GenericSyntaxProvider();
ODBCMetadataProvider metadataProvider = new ODBCMetadataProvider();
metadataProvider.Connection = connection;

Set the corresponding MetadataProvider and SyntaxProvider properties of the QueryBuilder object.


  queryBuilder1.MetadataProvider = metadataProvider;
  queryBuilder1.SyntaxProvider = syntaxProvider;

Call the InitiatelizeDatabaseSchemaTree method of the QueryBuilder class to retrieve Zoom metadata and generate a tree view of Zoom tables. queryBuilder1.InitializeDatabaseSchemaTree();

After creating the QueryBuilder, connect it to a TextBox or, as we use, the ActiveQueryBuilder SQLTextEditor: Drag and drop an SQLTextEditor onto the designer.

Add the following code to the Validating event for the SQLTextEditor:


private void sqlTextEditor1_Validating(object sender, CancelEventArgs e) {
  try {

    // Update the query builder with manually edited query text:
    queryBuilder1.SQL = sqlTextEditor1.Text; 
  }
  catch (SQLParsingException ex) {
    e.Cancel = true;

    // Set caret to error position
    sqlTextEditor1.SelectionStart = ex.ErrorPos.pos;

    // Report error
    MessageBox.Show(ex.Message, "Parsing error");
  }
}

Add the following to the SQLUpdated event:


private void queryBuilder1_SQLUpdated(object sender, EventArgs e) {
  sqlTextEditor1.Text = queryBuilder1.FormattedSQL; 
}

You can now build queries visually: Double-click a table in the Columns Pane Area and an entity/relationship diagram is displayed in the Query Building Area. Columns that you select in the diagram are added to the query.

Ready to get started?

In this article

Related articles

Rapidly Develop Zoom-Driven Apps with Active Query Builder

Connect to Zoom as an ODBC Data Source

Zoom API Profile Settings

Use SQL to Interact with Zoom