Financial Edge NXT Connection Details

Introduction

Connector Version

This documentation is based on version 25.0.9368 of the connector.

Get Started

Blackbaud Financial Edge NXT Version Support

The connector leverages the Blackbaud FinancialEdge NXT SKY API V1 to enable bidirectional access to Blackbaud Financial Edge NXT.

Establish a Connection

Authenticate to Blackbaud Financial Edge NXT

Blackbaud Financial Edge NXT uses the OAuth authentication standard. Blackbaud Financial Edge NXT should be enabled on an authorization account to retrieve results.

You can connect after setting required connection properties for your user credentials and obtaining required access tokens using a tool such as Postman.

See Using OAuth Authentication for an authentication guide and details of the OAuth authentication flow.

Create a Custom OAuth App

For more information about the first two steps, please see the getting started guide on Blackbaud here: BlackBaud Getting Started documentation.

To create an application to obtain the OAuth client credentials, the OAuthClientId and OAuthClientSecret:

1. Set up a developer account

To do so, go to BlackBaud Sign Up.

2. Get a subscription key

1. Request a subscription to an API from the BlackBaud Products page and select SKY API Standard Edition.

2. Select Subscribe. A confirmation screen appears.

3. To submit your request, select Confirm.

   BlackBaud sends an email notification when your request is approved. After it is approved, you can view the subscription key within your developer profile.

3. Register your app

1. From My Applications (see https://developer.blackbaud.com/apps), select Register app.
2. Enter your application details, including the redirect URI:
   • For Desktop applications, use http://localhost:33333 or another port of your choice.
   • For Web applications, use a URL where you want users to land after granting access to your custom application.
3. Click Save.

You can now retrieve your application client ID and client secret. Record these for future use.

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 Blackbaud Financial Edge NXT connector.

User Defined Views

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

SSL Configuration

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

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 Blackbaud Financial Edge NXT and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Log

For an overview of configuration settings that can be used to refine logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

User Defined Views

The Jitterbit Connector for Blackbaud Financial Edge NXT supports the use of user defined views: user-defined virtual tables whose contents are decided by a preconfigured query. User defined views are useful in situations where you cannot directly control the query being issued to the driver; for example, when using the driver from Jitterbit.

Use a user defined view 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 so that each root element defines the name of a view, and includes a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Accounts 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

In order to avoid a view's name clashing with an actual entity in the data model, user defined views are exposed in the UserViews schema by default. To change the name of the schema used for UserViews, reset 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 TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Data Model

The Jitterbit Connector for Blackbaud Financial Edge NXT models Blackbaud Financial Edge NXT objects as relational views. A Blackbaud Financial Edge NXT object has relationships to other objects; in the views, these relationships are expressed through foreign keys. The following sections show the available API objects and provide more information on executing SQL to Blackbaud Financial Edge NXT APIs.

Schemas for most database objects are defined in simple, text-based configuration files. For the views that may have custom fields, the columns are being listed dynamically. When the authenticated user changes custom fields for some objects, they will be reflected in the respective views.

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.

Jitterbit Connector for Blackbaud Financial Edge NXT Views

AccountCashflows

Returns the list of available cashflow values

Columns

AccountCodes

Returns the account codes.

Columns

AccountFundRequirements

Returns the requirements for the account funds.

Columns

AccountFunds

Returns the account funds.

Columns

Accounts

Retrieve and query accounts.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the '=' operator. This column is filtered servereport suite ID (RSID)e when it is the only specified filter in the criteria.
• DateModified supports the following operators : >,>=.

For example, the following queries are processed server side:

SELECT * FROM Accounts WHERE AccountId = 123
SELECT * FROM Accounts WHERE DateModified >= '2010-01-01 10:10:10'
SELECT * FROM Accounts WHERE DateModified > '2010-01-01 10:10:10' 

Columns

AccountSegments

Returns the specified account segment value.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• SegmentId supports the '=' operator. This the only supported column.

For example, the following query is processed server side:

SELECT * FROM AccountSegments WHERE SegmentId = 123

Columns

AccountStructures

Returns a list of account structures.

Columns

AccountWorkingCapitals

Returns the list of available working capital values

Columns

BatchValidations

Returns the results of batch validation.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• BatchId supports the '=' operator. This the only supported column.

For example, the following query is processed server side:

SELECT * FROM BatchValidations WHERE BatchId = 123

Columns

BudgetAccounts

Returns details for every fiscal period and account in scenario.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• BudgetScenarioId, AccountNumber support the '=' operator. A blank search is not supported.

For example, the following queries are processed server side:

SELECT * FROM BudgetAccounts WHERE BudgetScenarioId = 123
SELECT * FROM BudgetAccounts WHERE BudgetScenarioId = 123 AND AccountNumber = 'abc' 

Columns

BudgetDetails

Returns the specified budget details.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• BudgetScenarioId supports the '=' operator. This the only supported column.

For example, the following query is processed server side:

SELECT * FROM BudgetDetails WHERE BudgetScenarioId = 123

Columns

BudgetFiscalPeriods

Returns details for every fiscal period in a budget scenario.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• BudgetScenarioId supports the '=' operator. This the only supported column.

For example, the following query is processed server side:

SELECT * FROM BudgetFiscalPeriods WHERE BudgetScenarioId = 123

Columns

BudgetGrants

Returns details for every fiscal period and grant in scenario.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• BudgetScenarioId, Grant support the '=' operator. A blank search is not supported.

For example, the following queries are processed server side:

SELECT * FROM BudgetGrants WHERE BudgetScenarioId = 123
SELECT * FROM BudgetGrants WHERE BudgetScenarioId = 123 AND Grant = 'abc'

Columns

BudgetLines

Returns the specified budget lines.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• BudgetScenarioId supports the '=' operator. This the only supported column.

For example, the following query is processed server side:

SELECT * FROM BudgetLines WHERE BudgetScenarioId = 123

Columns

BudgetProjects

Returns details for every fiscal period and project in scenario.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• BudgetScenarioId, UiProjectId support the '=' operator. A blank search is not supported.

For example, the following queries are processed server side:

SELECT * FROM BudgetProjects WHERE BudgetScenarioId = 123
SELECT * FROM BudgetProjects WHERE BudgetScenarioId = 123 AND UiProjectId = 'abc'

Columns

Budgets

Returns a top level overview of every budget scenario.

Columns

BudgetScenarios

Returns details for every scenario ID.

Columns

CashManagementDistributionSetLineItemProjects

The project distribution for the line items in the cash management distribution sets.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• SetId supports the '=' operator. This the only supported column.

For example, the following query is processed server side:

SELECT * FROM CashManagementDistributionSetLineItemProjects WHERE SetId = 123

Columns

CashManagementDistributionSets

Returns the list of cash management distribution sets and their line items.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• SetId supports the '=' operator. This the only supported column.

For example, the following query is processed server side:

SELECT * FROM CashManagementDistributionSets WHERE SetId = 123

Columns

Classes

The list of classes

Columns

ClientNames

Returns the client type names.

Columns

FiscalYears

Returns the list of fiscal year details.

Columns

GrantCustomFields

Returns the list of grant custom field options.

Columns

GrantStatuses

Returns the list of grant statuses.

Columns

GrantTypes

Returns the list of grant types.

Columns

JournalCodes

Returns the list of all available journal codes.

Columns

JournalEntries

Retrieve and query journal entries.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• BatchId supports the '=' operator. This the only supported column.

For example, the following query is processed server side:

SELECT * FROM JournalEntries WHERE BatchId = 123

Columns

JournalEntryBatches

Returns the list of journal entry batches.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• BatchId supports the '=' operator. This column is filtered servereport suite ID (RSID)e when it is the only specified filter in the criteria.

For example, the following query is processed server side:

SELECT * FROM JournalEntryBatches WHERE BatchId = 123

Columns

LedgerSummaries

Lists general ledger summaries for the specified fiscal year and criteria. Note that summary records only exist for closed, optimized fiscal years. If any activity occurs in a fiscal period that has not since been closed and optimized, it will not be included in the GL summary record(s).

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• FiscalYearId, AccountNumber and UiProjectId support the '=' operator. A blank search is not supported.

For example, the following query is processed server side:

SELECT * FROM LedgerSummaries WHERE FiscalYearId = 1 AND AccountNumber = 'abc' AND UiProjectId = 'def'

Columns

MediaTypes

Returns a list of media type options.

Columns

PeriodSummaries

Once the summarization process is complete, this is how you get data returned.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• FiscalYear, FiscalPeriod, AccountNumber and UiProjectId support the '=' operator. A blank search is not supported.

For example, the following query is processed server side:

SELECT * FROM PeriodSummaries WHERE FiscalYear = 'year' AND FiscalPeriod = 'period' AND  AccountNumber = 'abc' AND UiProjectId = 'def'

Columns

PeriodSummariesProcessingInfo

This endpoint reports on the current status of the summarize request, whether it is completed, still running, or failed.

Columns

ProjectAttachments

Returns the list of attachments for the specified project.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• ProjectId supports the '=' operator. This column is required to fetch the project attachments.

For example, the following queries are processed server side:

SELECT * FROM ProjectAttachments WHERE ProjectId = 1

Columns

ProjectContactMethods

Address information of contacts for projects.

Columns

ProjectContacts

The contacts for a project.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• ProjectId supports the '=' operator. This column is the only supported filter.

For example, the following query is processed server side:

SELECT * FROM ProjectContacts WHERE ProjectId = 1

Columns

ProjectDepartments

Returns the list of project departments.

Columns

ProjectDivisions

Returns the list of project divisions.

Columns

ProjectLocations

Returns the list of project locations.

Columns

Projects

Retrieve and query projects.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• ProjectId supports the '=' operator. This column is filtered servereport suite ID (RSID)e when it is the only specified filter in the criteria.
• Location,Type,Division and Department support the '=' operator. A blank search is not supported.

For example, the following queries are processed server side:

SELECT * FROM Projects WHERE ProjectId = 1
SELECT * FROM Projects WHERE Location = 'abc' AND Type = 'def' AND Division = 'abc' AND Department = 'abc'

Columns

ProjectStatuses

Returns the list of project statuses.

Columns

ProjectTypes

Returns the list of project types.

Columns

TransactionCodes

Returns the list of all available transaction codes.

Columns

TransactionCodeValues

Returns the list of all values for the specified transaction code.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• TransactionCodeId supports the '=' operator. This column is the only supported filter.

For example, the following query is processed server side:

SELECT * FROM TransactionCodeValues WHERE TransactionCodeId = 1

Columns

TransactionDistributions

Returns a list of transactions matching the search criteria

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• BatchId, AccountNumber , UiProjectId , TypeCode , Encumbrance, Journal, and PostStatus support the '=' operator. A blank search is not supported.
• PostDate supports the following operators : <,<=,=,>=,>.
• DateModified supports the following operators : >,>=.

For example, the following queries are processed server side:

SELECT * FROM TransactionDistributions WHERE BatchId = 123 AND PostDate < '2010-01-01 10:10:10'
SELECT * FROM TransactionDistributions WHERE AccountNumber = 'abc' AND Journal = 'def' AND PostDate <= '2010-01-01 10:10:10'
SELECT * FROM TransactionDistributions WHERE UiProjectId = 'abc' AND PostStatus = 'def' AND PostDate = '2010-01-01 10:10:10'
SELECT * FROM TransactionDistributions WHERE TypeCode = 'abc' AND DateModified > '2010-01-01 08:10:10' AND PostDate >= '2010-01-01 10:10:10'
SELECT * FROM TransactionDistributions WHERE Encumbrance = 'abc' AND PostDate > '2010-01-01 10:10:10'

Columns

TransactionDistributionSets

Returns the list of transaction distribution sets.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• SetId supports the '=' operator. This column is the only supported filter.

For example, the following query is processed server side:

SELECT * FROM TransactionDistributionSets WHERE SetId = 1

Columns

Stored Procedures

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

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

Jitterbit Connector for Blackbaud Financial Edge NXT Stored Procedures

GetOAuthAccessToken

Gets an authentication token from Blackbaud Financial Edge NXT.

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 Blackbaud Financial Edge NXT.

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 Blackbaud Financial Edge NXT:

• 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 Accounts table:

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

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 SelectEntries stored procedure:

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

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'

Columns

Pseudo-Columns

sys_keycolumns

Describes the primary and foreign keys.

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

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

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.

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.

OAuth

SSL

Schema

Miscellaneous

OAuth

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

InitiateOAuth

Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.

Possible Values

OFF, REFRESH, GETANDREFRESH

Data Type

string

Default Value

OFF

Remarks

OAuth is an authorization framework that enables applications to obtain limited access to user accounts on an HTTP service. The OAuth flow defines the method to be used for logging in users, exchanging their credentials for an OAuth access token to be used for authentication, and providing limited access to applications.

Blackbaud Financial Edge NXT supports the following options for initiating OAuth access:

1. OFF: No automatic OAuth flow initiation. The OAuth flow is handled entirely by the user, who will take action to obtain their OAuthAccessToken. Note that with this setting the user must refresh the token manually and reconnect with an updated OAuthAccessToken property when the current token expires.
2. GETANDREFRESH: The OAuth flow is handled entirely by the connector. If a token already exists, it is refreshed when necessary. If no token currently exists, it will be obtained by prompting the user to login.
3. REFRESH: The user handles obtaining the OAuth Access Token and sets up the sequence for refreshing the OAuth Access Token. (The user is never prompted to log in to authenticate. After the user logs in, the connector handles the refresh of the OAuth Access Token.

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required when using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration. It is also required if an embedded OAuth application is not available for the driver. When an embedded OAuth application is available, this value may already be provided by the connector and not require manual entry.

This value is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can typically find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server.

Data Type

string

Default Value

""

Remarks

This property is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication will fail, and the server may return an invalid_client or unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application. It may be referred to as the client secret, application secret, or consumer secret.

This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments. Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

OAuthAccessToken

Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken is a temporary credential that authorizes access to protected resources. It is typically returned by the identity provider after the user or client application completes an OAuth authentication flow. This property is most commonly used in automated workflows or custom OAuth implementations where you want to manage token handling outside of the driver.

The OAuth access token has a server-dependent timeout, limiting user access. This is set using the OAuthExpiresIn property. However, it can be reissued between requests to keep access alive as long as the user keeps working.

If InitiateOAuth is set to REFRESH, we recommend that you also set both OAuthExpiresIn and OAuthTokenTimestamp. The connector uses these properties to determine when the token expires so it can refresh most efficiently. If OAuthExpiresIn and OAuthTokenTimestamp are not specified, the connector refreshes the token immediately.

Access tokens should be treated as sensitive credentials and stored securely. Avoid exposing them in logs, scripts, or configuration files that are not access-controlled.

SubscriptionKey

Subscription key which provides access to the API. Found in your Profile.

Data Type

string

Default Value

""

Remarks

Subscription key which provides access to the API. Found in your Profile.

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%\CData\Acumatica Data Provider\OAuthSettings.txt

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver 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%\CData\Acumatica Data Provider\OAuthSettings.txt" with %APPDATA% set to the user's configuration directory. The default values are

• Windows: "register://%DSN"
• Unix: "%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:

CallbackURL

Identifies the URL users return to after authenticating to Blackbaud Financial Edge NXT via OAuth. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

If you created a custom OAuth application, the OAuth authorization server redirects the user to this URL during the authentication process. This value must match the callback URL you specified when you Configured the custom OAuth application.

OAuthVerifier

Specifies a verifier code returned from the OAuthAuthorizationURL. Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set.

Data Type

string

Default Value

""

OAuthRefreshToken

Specifies the OAuth refresh token used to request a new access token after the original has expired.

Data Type

string

Default Value

""

Remarks

The refresh token is used to obtain a new access token when the current one expires. It enables seamless authentication for long-running or automated workflows without requiring the user to log in again. This property is especially important in headless, CI/CD, or server-based environments where interactive authentication is not possible.

The refresh token is typically obtained during the initial OAuth exchange by calling the GetOAuthAccessToken stored procedure. After that, it can be set using this property to enable automatic token refresh, or passed to the RefreshOAuthAccessToken stored procedure if you prefer to manage the refresh manually.

When InitiateOAuth is set to REFRESH, the driver uses this token to retrieve a new access token automatically. After the first refresh, the driver saves updated tokens in the location defined by OAuthSettingsLocation, and uses those values for subsequent connections.

The OAuthRefreshToken should be handled securely and stored in a trusted location. Like access tokens, refresh tokens can expire or be revoked depending on the identity provider’s policies.

OAuthExpiresIn

Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.

Data Type

string

Default Value

""

Remarks

The OAuth Access Token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.

An access token created by the server is only valid for a limited time. OAuthExpiresIn is the number of seconds the token is valid from when it was created. For example, a token generated at 2024-01-29 20:00:00 UTC that expires at 2024-01-29 21:00:00 UTC (an hour later) would have an OAuthExpiresIn value of 3600, no matter what the current time is.

To determine how long the user has before the Access Token will expire, use OAuthTokenTimestamp.

OAuthTokenTimestamp

Displays a Unix epoch timestamp in milliseconds that shows how long ago the current Access Token was created.

Data Type

string

Default Value

""

Remarks

The OAuth Access Token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.

An access token created by the server is only valid for a limited time. OAuthTokenTimestamp is the Unix timestamp when the server created the token. For example, OAuthTokenTimestamp=1706558400 indicates the OAuthAccessToken was generated by the server at 2024-01-29 20:00:00 UTC.

SSL

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

SSLServerCert

Specifies 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

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Data Type

string

Default Value

%APPDATA%\FinancialEdgeNXT Data Provider\Schema

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\FinancialEdgeNXT Data Provider\Schema, where %APPDATA% is set to the user's configuration directory:

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, 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`.

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, 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`.

Miscellaneous

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

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

This property sets an upper limit on the number of rows the connector returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Data Type

string

Default Value

""

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

PageSize

The number of results to return per page of data retrieved from Blackbaud Financial Edge NXT.

Data Type

string

Default Value

""

Remarks

The pagesize will automatically be determined if you do not manually set it. It is generally not necessary to ever set this value.

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the connector exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Data Type

int

Default Value

60

Remarks

This property controls the maximum time, in seconds, that the connector waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the connector cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond the timeout value if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UserDefinedViews

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Data Type

string

Default Value

""

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the connector and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:

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

}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the connector.

Refer to User Defined Views for more information.