Wave Financial Connection Details

Introduction

Connector Version

This documentation is based on version 23.0.8895 of the connector.

Get Started

Wave Financial Version Support

The connector leverages the Wave Financial API to enable bidirectional access to Wave Financial.

Establish a Connection

Connect to Wave Financial

Wave Financial provides two means of connecting to data: by specifying the API Token, or by using OAuth credentials.

API Token

To obtain the Wave Financial API Token:

1. Log into your Wave Financial account.
2. In the left pane, navigate to Manage Applications.
3. Select the application that you would like to create a token for. You may need to create an application first.
4. To generate the API Token, click Create token.

OAuth

Wave Financial supports OAuth authentication only. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth.

The following subsections describe how to authenticate to Wave Financial from three common authentication flows:

• Desktop: a connection to a server on the user's local machine, frequently used for testing and prototyping. Authenticated via either embedded OAuth or custom OAuth.
• Web: access to data via a shared website. Authenticated via custom OAuth only.
• Headless Server: a dedicated computer that provides services to other computers and their users, which is configured to operate without a monitor and keyboard. Authenticated via embedded OAuth or custom OAuth.

For information about creating a custom OAuth application, and why you might want to create one even for auth flows that have embedded OAuth credentials, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in Wave Financial, see Connection.

Desktop Applications

provides an embedded OAuth application that simplifies authentication at the desktop.

You can also authenticate from the desktop via a custom OAuth application, which you configure and register at the Wave Financial console. For further information, see Creating a Custom OAuth Application.

Before you connect, set the following variables:

• InitiateOAuth = GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
• Custom OAuth applications only:
  • OAuthClientId = the client ID assigned when you registered your custom OAuth application.
  • OAuthClientSecret = the client secret assigned when you registered your custom OAuth application.
  • CallbackURL = the redirect URI defined when you registered your custom OAuth application.

When you connect, the connector opens Wave Financial's OAuth endpoint in your default browser. Log in and grant permissions to the application.

After you grant permissions to the application, the connector completes the OAuth process:

1. The connector obtains an access token from Wave Financial and uses it to request data.
2. The OAuth values are saved in the path specified in OAuthSettingsLocation. These values persist across connections.

The connector refreshes the access token automatically when it expires.

Automatic refresh of the OAuth access token

To have the connector automatically refresh the OAuth access token, do the following:

1. The first time you connect to data, set the following connection parameters:
   • InitiateOAuth = REFRESH.
   • OAuthClientId = the client ID in your application settings.
   • OAuthClientSecret = the client secret in your application settings.
   • OAuthAccessToken = the access token returned by GetOAuthAccessToken.
   • OAuthSettingsLocation = the path where you want the connector to save the OAuth values, which persist across connections.
2. On subsequent data connections, set the following:
   • InitiateOAuth
   • OAuthSettingsLocation

Manual refresh of the OAuth Access Token

The only value needed to manually refresh the OAUth access token is the OAuth refresh token.

1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
2. Set the following connection properties:
   • OAuthClientId = the Client ID in your application settings.
   • OAuthClientSecret = the Client Secret in your application settings.
3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Create a Custom OAuth Application

Create a Custom OAuth Application

embeds OAuth Application Credentials with branding that can be used when connecting to Wave Financial via a desktop

application or a headless machine. To use the embedded credentials from a Desktop or Headless Server, all you need to do is:

• set AuthScheme to OAuth,
• get and set the OAuthAccessToken, and
• set the necessary configuration parameters.

(For information on getting and setting OAuthAccessToken and other configuration parameters, see the Desktop Authentication section of "Connecting to Wave Financial".)

However, you must create a custom OAuth application to connect to Wave Financial via the Web. And since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for those auth flows anyway.

Custom OAuth applications are useful if you want to:

• control branding of the authentication dialog;.
• control the redirect URI that the application redirects the user to after the user authenticates;, or
• customize the permissions that you are requesting from the user.

Procedure

1. Log into your Wave Financial account.
2. Navigate to the WaveApps console.
3. Click Create an application.
4. Fill in your application details. We recommend assigning a redirect URL of http://localhost:33333/ (default for this tool).
5. Save the new application.
6. Retrieve the OAuthClientId and OAuthClientSecret.

GraphQL Limitations

Every GraphQL API has its own limitations and we can not query an arbitrarily large number of nodes because every query has a cost and the API will return an error if the connector exceeds the maximum cost. The query cost function is directly dependent on the page sizes. The connector uses its own algorithms for finding the page sizes but also gives you the freedom to tweak them based on your needs. There are two ways you can achieve this behavior:

• Specify custom page size weights by including the "other:pageSizeWeights" attribute. Let's suppose that we have a "Customers" table which has two nested GraphQl connections, businesses and customers. If you want a specific ratio between these two entities per query, let's say 200 customers per 1 business, you should specify "other:pageSizeWeights=1:200" in the respective script. The advantage of this attribute is that you do not bypass our logic for finding the optimal page size based on the query cost.
• Specify custom page sizes by including the "other:pageSizes" attribute. By specifying this attribute you will bypass any check we do for query cost, so you should be careful because there will be API errors if you exceed the maximum cost per query. Example: "other:pageSizeWeights=10,30", retrieve at most 10 businesses and at most 30 customers per business in one query.

Important Notes

Configuration Files and Their Paths

• All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

This section details a selection of advanced features of the Wave Financial connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using private agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to Wave Financial and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

User Defined Views

The Wave Financial connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Define Views Using a Configuration File

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Invoices WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Data Model

Overview

The Wave Financial connector models Wave Financial objects as relational tables and views.

A Wave Financial object has relationships to other objects; in the tables, these relationships are expressed through foreign keys. The following sections show the available API objects and provide more information on executing SQL to Wave Financial APIs.

Schemas for most database objects are defined in simple, text-based configuration files.

Views

Views describes the available views. Views are statically defined to model Accounts, Customers, Products, and more.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Wave Financial Connector Views

Accounts

Chart of Accounts for the business.

Table Specific Information

The connector uses the Wave Financial API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Accounts WHERE Id = 'QWNjb3VudDo4MDEyMDg4OD3MWUwYWYtZDZiZS00OGI3LWE1ZTAtNmYyNzU4N2IwNGNi'
SELECT * FROM Accounts WHERE BusinessId = 'QnVzaW5lc3M6MDU3MWUwYWYtZDZiZS00OGI3LWE1ZTAtNmYyNzU4N2IwNGNi'
SELECT * FROM Accounts WHERE Name = 'Accounting Fees'
SELECT * FROM Accounts WHERE TypeValue = 'EXPENSE'
SELECT * FROM Accounts WHERE SubtypeValue = 'CASH_AND_BANK'
SELECT * FROM Accounts WHERE IsArchived = true
SELECT * FROM Accounts WHERE TypeValue IN ('EXPENSE', 'LIABILITY')

SELECT * FROM Accounts WHERE SubtypeValue IN ('COST_OF_GOODS_SOLD', 'EXPENSE')

Columns

AccountSubtypes

List subtypes of accounts.

Columns

AccountTypes

List types of accounts.

SELECT

SELECT * FROM AccountTypes

Columns

Businesses

List businesses.

Table Specific Information

The connector uses the Wave Financial API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT name FROM Businesses WHERE ID = 'QnVzaW5lc3M6MDU3MWUwYWYtGI3LWE1ZTAtNmYyNzU4N2IwNGNi'

Columns

Countries

List countries.

Table Specific Information

The connector uses the Wave Financial API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Countries WHERE Code = 'US'

Columns

Currencies

List currencies.

Table Specific Information

The connector uses the Wave Financial API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Currencies WHERE Code = 'USD'

Columns

Customers

List of customers for the business.

Table Specific Information

The connector uses the Wave Financial API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Customers WHERE Id = 'QnVzaW5lc3M6NjE2MtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdlO0N1c3RvbWVyOjMyNzkyMTY1'
SELECT * FROM Customers WHERE BusinessId = 'QnVYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl'

SELECT * FROM Customers WHERE ModifiedAt > '2019-10-30 07:14:55.0' AND ModifiedAt < '2019-10-30 07:18:03.0'

Columns

InvoiceItems

The line items (product, unit and price) that make up the invoiced sale.

Table Specific Information

The connector uses the Wave Financial API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM InvoiceItems WHERE InvoiceId = 'QnVzaW5lc3M6MTY4NTYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl'

Columns

InvoiceItemTaxes

List of taxes applied to an invoice item.

SELECT

SELECT * FROM InvoiceItemTaxes

Columns

Invoices

List of invoices for the business.

Table Specific Information

The connector uses the Wave Financial API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Invoices WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl'
SELECT * FROM Invoices WHERE CustomerID = 'QnVzaW5lc3M6NjE2MTY4NzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdlO0N1c3RvbWVyOjMyNzkyMTEz'
SELECT * FROM Invoices WHERE ModifiedAt < '2020-02-26 18:02:06.171'
SELECT * FROM Invoices WHERE InvoiceDate >= '2020-07-03'
SELECT * FROM Invoices WHERE Status = 'SENT'

SELECT * FROM Invoices WHERE CurrencyCode = 'USD'

Columns

ProductDefaultSalesTaxes

Default sales taxes to apply on product.

Table Specific Information

The connector uses the Wave Financial API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM ProductDefaultSalesTaxes WHERE ProductId = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y'

SELECT * FROM ProductDefaultSalesTaxes WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTY4NzVlMSyOjMyNzkyMTEz'

Columns

ProductDefaultSalesTaxRates

Tax rates with their effective dates of application.

Table Specific Information

The connector uses the Wave Financial API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM ProductDefaultSalesTaxRates WHERE ProductId = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y'

SELECT * FROM ProductDefaultSalesTaxRates WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTY4NzVlMSyOjMyNzkyMTEz'

Columns

Products

List of products (and services) for the business.

Table Specific Information

The connector uses the Wave Financial API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Products WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl'
SELECT * FROM Products WHERE Id = 'QzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdlO0N1c3RvbWVyOjMyNzkyMTEz'
SELECT * FROM Products WHERE IsSold = true
SELECT * FROM Products WHERE IsBought = true
SELECT * FROM Products WHERE IsArchived = true

SELECT * FROM Products WHERE ModifiedAt < '2020-07-03 08:28:56.0'

Columns

Provinces

List of principal subdivisions.

Table Specific Information

The connector uses the Wave Financial API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Provinces WHERE CountryCode = 'US'

Columns

SalesTaxes

List of sales taxes for the business.

Table Specific Information

The connector uses the Wave Financial API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM SalesTaxes WHERE Id = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl'
SELECT * FROM SalesTaxes WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTY4NzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdlO0N1c3RvbWVyOjMyNzkyMTEz'
SELECT * FROM SalesTaxes WHERE ModifiedAt < '2020-02-26 18:02:06.171'

SELECT * FROM SalesTaxes WHERE IsArchived = true

Columns

SalesTaxRates

Tax rates with their effective dates of application

Columns

Vendors

List of vendors for the business.

Table Specific Information

The connector uses the Wave Financial API to process some of the filters. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Vendors WHERE Id = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y2DM4MTcyNTdl'

SELECT * FROM Vendors WHERE ModifiedAt < '2020-02-26 18:02:06.171'

Columns

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT operations with Wave Financial.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Wave Financial, along with an indication of whether the procedure succeeded or failed.

Wave Financial Connector Stored Procedures

GetOAuthAccessToken

Gets an authentication token from WaveFinancial.

Input

Result Set Columns

GetOAuthAuthorizationURL

Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the auth token from this URL.

Input

Result Set Columns

RefreshOAuthAccessToken

Refreshes the OAuth access token used for authentication with WaveFinancial.

Input

Result Set Columns

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Wave Financial:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Invoices table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Invoices'

Columns

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SampleProcedure stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SampleProcedure' AND Direction=1 OR Direction=2

Columns

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Invoices table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Invoices'

Columns

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

SELECT * FROM sys_primarykeys

Columns

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:wavefinancial:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity

Columns

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Advanced Configurations Properties

The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.

Authentication

OAuth

SSL

Schema

Miscellaneous

Authentication

This section provides a complete list of authentication properties you can configure.

AuthScheme

The type of authentication to use when connecting to Wave Financial.

Possible Values

OAuth, Token

Data Type

string

Default Value

OAuth

Remarks

• Token: Set this to perform Wave Financial token authentication.
• OAuth: Set this to perform Wave Financial OAuth authentication.

APIToken

The API token obtained when you register a Wave Financial application.

Data Type

string

Default Value

""

Remarks

You can obtain an API Token using the following steps:

1. Log in to your Wave Financial account and navigate to Manage Applications in the left pane.
2. Select the application that you would like to create a token for. You may need to create an application first.
3. Click the Create token button to generate an APIToken

OAuth

This section provides a complete list of OAuth properties you can configure.

InitiateOAuth

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

Possible Values

OFF, GETANDREFRESH, REFRESH

Data Type

string

Default Value

OFF

Remarks

The following options are available:

1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
3. REFRESH: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthClientId

The client ID assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken

The access token for connecting using OAuth.

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

OAuthSettingsLocation

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.

Data Type

string

Default Value

%APPDATA%\WaveFinancial Data Provider\OAuthSettings.txt

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the connector saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.

Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

The default location is "%APPDATA%\WaveFinancial Data Provider\OAuthSettings.txt" with %APPDATA% set to the user's configuration directory. The default values are

• Windows: "register://%DSN"
• Unix: "%AppData%..."
• Mac: "%AppData%..."

where DSN is the name of the current DSN used in the open connection.

The following table lists the value of %APPDATA% by OS:

OAuthVerifier

The verifier code returned from the OAuth authorization URL.

Data Type

string

Default Value

""

Remarks

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines

See to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the connector exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified location. Set InitiateOAuth to GETANDREFRESH to automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

OAuthRefreshToken

The OAuth refresh token for the corresponding OAuth access token.

Data Type

string

Default Value

""

Remarks

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn

The lifetime in seconds of the OAuth AccessToken.

Data Type

string

Default Value

""

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp

The Unix epoch timestamp in milliseconds when the current Access Token was created.

Data Type

string

Default Value

""

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

SSL

This section provides a complete list of SSL properties you can configure.

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema

This section provides a complete list of schema properties you can configure.

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Data Type

string

Default Value

%APPDATA%\WaveFinancial Data Provider\Schema

Remarks

The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\WaveFinancial Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

MaxRows

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Other

These hidden properties are used only in specific use cases.

Data Type

string

Default Value

""

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type

int

Default Value

60

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the connector throws an exception.

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Data Type

string

Default Value

""

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Invoices WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.