Financial Edge NXT Connection Details¶

Introduction¶

Connector Version

This documentation is based on version 23.0.8803 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 Harmony 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 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 Blackbaud Financial Edge NXT and then processes the rest of the query in memory (client-side).

User Defined Views¶

The Jitterbit Connector for Blackbaud Financial Edge NXT 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 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¶

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¶

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

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.

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

jdbc:cdata:financialedgenxt: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¶

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¶

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.

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¶

The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.

Data Type¶

string

Default Value¶

""

Remarks¶

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

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%\FinancialEdgeNXT 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%\FinancialEdgeNXT 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¶

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¶

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 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

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