Ir para o conteúdo

Detalhes da Conexão do Financial Edge NXT

Introdução

Versão do conector

Esta documentação é baseada na versão 21.0.8257 do conector.

Começando

Suporte à versão Blackbaud Financial Edge NXT

O conector utiliza a API Blackbaud FinancialEdge NXT SKY para permitir acesso bidirecional ao Blackbaud Financial Edge NXT.

Estabelecendo uma Conexão

Autenticação no Blackbaud Financial Edge NXT

O Blackbaud Financial Edge NXT usa o padrão de autenticação OAuth. O Blackbaud Financial Edge NXT deve ser ativado em uma conta de autorização para recuperar os resultados.

Você pode se conectar depois de definir as propriedades de conexão necessárias para suas credenciais de usuário e obter os tokens de acesso necessários usando uma ferramenta como o Postman.

Consulte Usando autenticação OAuth para obter um guia de autenticação e detalhes do fluxo de autenticação OAuth.

Usando Autenticação OAuth

OAuth requer o uso de tokens de acesso obtidos com Postman ou ferramenta similar. A autenticação OAuth é suportada conforme descrito em Conexão em Configurar conexões OAuth.

Anotações Importantes

Procedimentos Armazenados

  • Os recursos de procedimentos armazenados descritos nesta documentação não são suportados no momento.
  • Como os procedimentos armazenados não são suportados atualmente, qualquer recurso dependente de procedimentos armazenados também não é suportado atualmente.

Arquivos de Configuração e Seus Caminhos

  • Todas as referências para adicionar arquivos de configuração e seus caminhos referem-se a arquivos e locais no Harmony Agente onde o conector está instalado. Esses caminhos devem ser ajustados conforme apropriado, dependendo do agente e do sistema operacional. Se vários agentes forem usados em um grupo de agentes, arquivos idênticos serão necessários em cada agente.

Características Avançadas

Esta seção detalha uma seleção de recursos avançados do conector Blackbaud Financial Edge NXT.

Visualizações definidas pelo usuário

O conector permite definir tabelas virtuais, denominadas visões definidas pelo usuário, cujo conteúdo é decidido por uma consultar pré-configurada. Essas exibições são úteis quando você não pode controlar diretamente as consultas enviadas aos drivers. Consulte Visualizações definidas pelo usuário para obter uma visão geral da criação e configuração de exibições personalizadas.

Configuração SSL

Use Configuração SSL para ajustar como o conector lida com as negociações de certificado TLS/SSL. Você pode escolher entre vários formatos de certificado; Veja o SSLServerCert propriedade em "Opções de cadeia de conexão" para obter mais informações.

Procurador

Para configurar o conector usando configurações de proxy do Agente Privado, selecione os Use Proxy Settings caixa de seleção na tela de configuração da conexão.

Visualizações Definidas pelo Usuário

O Conector Jitterbit para Blackbaud Financial Edge NXT permite definir uma tabela virtual cujo conteúdo é decidido por uma consultar pré-configurada. Elas são chamadas de Visualizações Definidas pelo Usuário, que são úteis em situações onde você não pode controlar diretamente a consultar que está sendo emitida para o driver, por exemplo, ao usar o driver do Jitterbit. As Visualizações Definidas pelo Usuário podem ser usadas para definir predicados que são sempre aplicados. Se você especificar predicados adicionais na consultar para a visualização, eles serão combinados com a consultar já definida como parte da visualização.

Há duas maneiras de criar exibições definidas pelo usuário:

  • Crie um arquivo de configuração em formato JSON definindo as visualizações desejadas.
  • declarações DDL.

Definindo Visualizações Usando um Arquivo de Configuração

As visualizações definidas pelo usuário são definidas em um arquivo de configuração formatado em JSON chamado UserDefinedViews.json. O conector detecta automaticamente as visualizações especificadas neste arquivo.

Você também pode ter várias definições de exibição e controlá-las usando o UserDefinedViews propriedade de conexão. Quando você usa essa propriedade, apenas as exibições especificadas são vistas pelo conector.

Este arquivo de configuração de exibição definida pelo usuário é formatado da seguinte forma:

  • Cada elemento raiz define o nome de uma exibição.
  • Cada elemento raiz contém um elemento filho, chamado query, que contém a consultar SQL personalizada para a exibição.

Por exemplo:

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

Use o UserDefinedViews propriedade de conexão para especificar a localização do seu arquivo de configuração JSON. Por exemplo:

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

Esquema para Exibições Definidas pelo Usuário

As visualizações definidas pelo usuário são expostas no UserViews esquema por padrão. Isso é feito para evitar que o nome da exibição entre em conflito com uma entidade real no modelo de dados. Você pode alterar o nome do esquema usado para UserViews definindo o UserViewsSchemaName propriedade.

Trabalhando com Exibições Definidas pelo Usuário

Por exemplo, uma instrução SQL com uma Visualização Definida pelo Usuário chamada UserViews.RCustomers lista apenas clientes em Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

Exemplo de consultar ao driver:

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

Resultando na consultar efetiva à fonte:

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

Esse é um exemplo muito simples de uma consultar a uma exibição definida pelo usuário que é efetivamente uma combinação da consultar de exibição e da definição de exibição. É possível compor essas consultas em padrões muito mais complexos. Todas as operações SQL são permitidas em ambas as consultas e são combinadas quando apropriado.

Configuração SSL

Personalizando a Configuração SSL

Por padrão, o conector tenta negociar SSL/TLS verificando o certificado do servidor em relação ao armazenamento de certificados confiáveis do sistema.

Para especificar outro certificado, consulte o SSLServerCert propriedade para os formatos disponíveis para fazê-lo.

Modelo de Dados

O Conector Jitterbit para Blackbaud Financial Edge NXT modela objetos Blackbaud Financial Edge NXT como exibições relacionais. Um objeto Blackbaud Financial Edge NXT tem relacionamentos com outros objetos; nas exibições, esses relacionamentos são expressos por meio de chaves estrangeiras. As seções a seguir mostram os objetos de API disponíveis e fornecem mais informações sobre a execução de SQL para APIs Financial Edge NXT.

Os esquemas para a maioria dos objetos de banco de dados são definidos em arquivos de configuração simples baseados em texto. Para as exibições que podem ter campos personalizados, as colunas estão sendo listadas dinamicamente. Quando o usuário autenticado alterar campos personalizados para alguns objetos, eles serão refletidos nas respectivas exibições.

O conector transfere o máximo possível do processamento da instrução SELECT para as APIs Financial Edge NXT e, em seguida, processa o restante da consultar na memória. Ver SupportEnhancedSQL para obter mais informações sobre como o conector contorna as limitações da API com processamento na memória do lado do cliente.

Visualizações

As exibições são compostas por colunas e pseudocolunas. As exibições são semelhantes às tabelas na forma como os dados são representados; no entanto, as exibições não oferecem suporte a atualizações. Entidades que são representadas como exibições são normalmente entidades somente leitura. Frequentemente, um procedimento armazenado* está disponível para atualizar os dados se tal funcionalidade for aplicável à fonte de dados.

As consultas podem ser executadas em uma exibição como se fosse uma tabela normal, e os dados retornados são semelhantes nesse aspecto. Para saber mais sobre tabelas e procedimentos armazenados, navegue até as entradas correspondentes neste documento de ajuda.

Jitterbit Connector para Blackbaud Financial Edge NXT Views

Nome Descrição
AccountCashflows Retorna a lista de valores de fluxo de caixa disponíveis
AccountCodes Retorna os códigos de conta.
AccountFundRequirements Retorna os requisitos para os fundos da conta.
AccountFunds Devolve os fundos da conta.
Accounts Recuperar e consultar contas.
AccountSegments Retorna o valor do segmento de conta especificado.
AccountStructures Retorna uma lista de estruturas de contas.
AccountWorkingCapitals Retorna a lista de valores de capital de giro disponíveis
BatchValidations Retorna os resultados da validação do lote.
BudgetAccounts Retorna detalhes para cada período fiscal e conta no cenário.
BudgetDetails Retorna os detalhes do orçamento especificado.
BudgetFiscalPeriods Retorna os detalhes de cada período fiscal em um cenário de orçamento.
BudgetGrants Retorna detalhes para cada período fiscal e concessão no cenário.
BudgetLines Retorna as linhas de orçamento especificadas.
BudgetProjects Retorna detalhes para cada período fiscal e projeto no cenário.
Budgets Retorna uma visão geral de nível superior de cada cenário de orçamento.
BudgetScenarios Retorna detalhes para cada ID de cenário.
CashManagementDistributionSetLineItemProjects A distribuição do projeto para os itens de linha nos conjuntos de distribuição de gerenciamento de caixa.
CashManagementDistributionSets Retorna a lista de conjuntos de distribuição de gerenciamento de caixa e seus itens de linha.
Classes A lista de aulas
ClientNames Retorna os nomes dos tipos de cliente.
FiscalYears Retorna a lista de detalhes do ano fiscal.
GrantCustomFields Retorna a lista de opções de campo personalizado de concessão.
GrantStatuses Retorna a lista de status de concessão.
GrantTypes Retorna a lista de tipos de concessão.
JournalCodes Retorna a lista de todos os códigos de lançamento disponíveis.
JournalEntries Recupere e consultar entradas de diário.
JournalEntryBatches Retorna a lista de lotes de lançamentos contábeis manuais.
LedgerSummaries Lista os resumos do razão geral para o ano fiscal e os critérios especificados. Observe que os registros de resumo existem apenas para anos fiscais otimizados fechados. Se alguma atividade ocorrer em um período fiscal que não tenha sido fechado e otimizado desde então, ela não será incluída no(s) registro(s) de resumo GL.
MediaTypes Retorna uma lista de opções de tipo de mídia.
PeriodSummaries Depois que o processo de resumo estiver concluído, é assim que você obtém os dados retornados.
PeriodSummariesProcessingInfo Este endpoint relata o status atual da solicitação de resumo, se ela está concluída, ainda em execução ou com falha.
ProjectAttachments Retorna a lista de anexos para o projeto especificado.
ProjectContactMethods Informações de endereço de contatos para projetos.
ProjectContacts Os contatos para um projeto.
ProjectDepartments Retorna a lista de departamentos do projeto.
ProjectDivisions Retorna a lista de divisões do projeto.
ProjectLocations Retorna a lista de locais do projeto.
Projects Recupere e consultar projetos.
ProjectStatuses Retorna a lista de status do projeto.
ProjectTypes Retorna a lista de tipos de projeto.
TransactionCodes Retorna a lista de todos os códigos de transação disponíveis.
TransactionCodeValues Retorna a lista de todos os valores para o código de transação especificado.
TransactionDistributions Retorna uma lista de transações correspondentes aos critérios de pesquisa
TransactionDistributionSets Retorna a lista de conjuntos de distribuição de transações.

Fluxos de Caixa da Conta

Retorna a lista de valores de fluxo de caixa disponíveis

Colunas
Nome Tipo Referências Descrição
CashflowId [KEY] Integer O identificador de fluxo de caixa.
Description String A descrição para este fluxo de caixa.
Value String O valor para este fluxo de caixa.

Códigos de Conta

Retorna os códigos de conta.

Colunas
Nome Tipo Referências Descrição
AccountCodeId [KEY] Integer O identificador para este código de conta.
IsControl Boolean Se esta conta for uma conta controlada.
IsContra Boolean Se esta é uma conta contra.
Category String A categoria para este código de conta.
Description String A descrição para este código de conta.
Value Integer O valor desse código de conta.
Class String A classe deste código de conta.

Requisitos do Fundo da Conta

Retorna os requisitos para os fundos da conta.

Colunas
Nome Tipo Referências Descrição
FundId [KEY] Integer Fundos da conta.FundId O identificador desse fundo.
Name [KEY] String O nome desse requisito de fundo.
Type String O tipo para este requisito de fundo.
PreserveDetailsDuringClosing Boolean Se esse requisito de fundo ou não preserva os detalhes durante o fechamento.
RequireToBalance Boolean Se este requisito de fundo é ou não necessário para equilibrar.
RequireOnAccountsSpecified String A exigência em contas especificadas para este requisito de fundo.
Default String O padrão para este requisito de fundo.

Fundos da Conta

Devolve os fundos da conta.

Colunas
Nome Tipo Referências Descrição
FundId [KEY] Integer O identificador deste fundo.
Value String O valor para este fundo.
Description String A descrição deste fundo.
BeginningBalancesLocked Datetime A data de bloqueio dos saldos iniciais para este fundo.
FundBalanceAccount String A conta de saldo do fundo para este fundo.

Contas

Recuperar e consultar contas.

O conector usará a API Financial Edge NXT para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

  • Id suporta o operador '='. Esta coluna é filtrada pelo ID do conjunto de relatórios do servidor (RSID) e quando é o único filtro especificado nos critérios.
  • DateModified suporta os seguintes operadores: >,>=.

Por exemplo, as seguintes consultas são processadas no lado do servidor:

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'

Você pode desativar a execução do lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a outras colunas resultará no envio de dados não filtrados.

Colunas
Nome Tipo Referências Descrição
AccountId [KEY] Integer O identificador desta conta.
AccountNumber String O número da conta para esta conta.
Class String A classe para esta conta.
Description String A descrição desta conta.
DateModified Datetime A data de modificação da conta.
WorkingCapital String O cronograma de capital de giro para esta conta.
Cashflow String O fluxo de caixa desta conta.
PreventPostingDate Datetime Se, e a data após a qual, para impedir a postagem. O preenchimento desse campo definirá automaticamente o campo de entrada de dados de prevenção como 'verdadeiro'.
ModifiedBy String O modificador da conta.
DefaultTransactionCodes String Os códigos de transação padrão nesta conta.
PreventDataEntry Boolean Se para impedir a entrada de dados. Se for fornecida uma data para impedir a postagem, esse valor será definido como verdadeiro.
DateAdded Datetime A data de criação da conta.
AddedBy String O criador da conta.
CustomFields String Campo personalizado: a lista de campos personalizados com suporte como colunas distict.

Segmentos de Conta

Retorna o valor do segmento de conta especificado.

O conector usará a API Financial Edge NXT para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

  • SegmentId suporta o operador '='. Esta é a única coluna suportada.

Por exemplo, a seguinte consultar é processada no lado do servidor:

Select * FROM AccountSegments WHERE SegmentId = 123

Você pode desativar a execução do lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a outras colunas resultará no envio de dados não filtrados.

Colunas
Nome Tipo Referências Descrição
SegmentId [KEY] Integer Estruturas da Conta.SegmentId O identificador para este segmento de conta.
Type [KEY] String O tipo para este segmento de conta.
Value String Os valores para este segmento de conta.
Description String As descrições para este segmento de conta.

Estruturas de Contas

Retorna uma lista de estruturas de contas.

Colunas
Nome Tipo Referências Descrição
SegmentId [KEY] Integer O identificador para este segmento de conta.
Type String O tipo para este segmento de conta.
Length Integer O comprimento deste segmento de conta.
Separator String O separador para este segmento de conta.
Sequence Integer A sequência para este segmento de conta.

ContaFuncionamentoCapitais

Retorna a lista de valores de capital de giro disponíveis

Colunas
Nome Tipo Referências Descrição
WorkingCapitalId [KEY] Integer O identificador do valor do capital de giro.
Description String A descrição desse valor de capital de giro.
Value String O valor para este valor de capital de giro.

Validações em Lote

Retorna os resultados da validação do lote.

O conector usará a API Financial Edge NXT para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

  • BatchId suporta o operador '='. Esta é a única coluna suportada.

Por exemplo, a seguinte consultar é processada no lado do servidor:

Select * FROM BatchValidations WHERE BatchId = 123

Você pode desativar a execução do lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a outras colunas resultará no envio de dados não filtrados.

Colunas
Nome Tipo Referências Descrição
BatchId [KEY] String JournalEntryBatches.BatchId Indica se a solicitação foi válida.
IsValid Boolean Indica se a solicitação foi válida.
Errors String A lista de erros recebidos durante a validação.

OrçamentoContas

Retorna detalhes para cada período fiscal e conta no cenário.

O conector usará a API Financial Edge NXT para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

  • BudgetScenarioId, AccountNumber suporta o operador '='. Uma pesquisa em branco não é suportada.

Por exemplo, as seguintes consultas são processadas no lado do servidor:

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

Você pode desativar a execução do lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a outras colunas resultará no envio de dados não filtrados.

Colunas
Nome Tipo Referências Descrição
BudgetScenarioId [KEY] Integer Orçamentos.BudgetScenarioId O ID do cenário para este orçamento.
AccountNumber [KEY] String Contas.AccountNumber O número da conta para este período.
BudgetCategory String A categoria de orçamento para este período.
FiscalYear String Anos Fiscais.Ano O ano fiscal para este período.
FiscalPeriodId Integer Anos Fiscais.FiscalPeriodId O período fiscal.
PeriodPercent Double A porcentagem desse período.
PeriodAmount Decimal O valor para este período.
TotalAmount Decimal O valor total para este período.

Detalhes do Orçamento

Retorna os detalhes do orçamento especificado.

O conector usará a API Financial Edge NXT para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

  • BudgetScenarioId suporta o operador '='. Esta é a única coluna suportada.

Por exemplo, a seguinte consultar é processada no lado do servidor:

Select * FROM BudgetDetails WHERE BudgetScenarioId = 123

Você pode desativar a execução do lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a outras colunas resultará no envio de dados não filtrados.

Colunas
Nome Tipo Referências Descrição
BudgetScenarioId [KEY] Integer Orçamentos.BudgetScenarioId O ID do cenário para este orçamento.
ScenarioId String Orçamentos.ScenarioId A ID do cenário para este cenário de orçamento.
BudgetType String O tipo de orçamento para este orçamento.
Status String O status deste orçamento.
Description String A descrição para este orçamento.
Locked Boolean O status do bloqueio para este orçamento.
StartFiscalYear String O ano fiscal inicial para este orçamento.
EndFiscalYear String O ano fiscal final para este orçamento.
StartFiscalPeriod Integer O período fiscal inicial para este orçamento.
EndFiscalPeriod Integer O período fiscal final para este orçamento.
TotalExpense Double A despesa total para este orçamento.
TotalRevenue Double A receita total para este orçamento.
DateAdded Datetime A data em que este orçamento foi adicionado.
AddedBy String O nome de quem adicionou este orçamento.
DateModified Datetime A data em que este orçamento foi modificado.
ModifiedBy String O nome de quem modificou este orçamento.

OrçamentoPeríodosFiscais

Retorna os detalhes de cada período fiscal em um cenário de orçamento.

O conector usará a API Financial Edge NXT para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

  • BudgetScenarioId suporta o operador '='. Esta é a única coluna suportada.

Por exemplo, a seguinte consultar é processada no lado do servidor:

Select * FROM BudgetFiscalPeriods WHERE BudgetScenarioId = 123

Você pode desativar a execução do lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a outras colunas resultará no envio de dados não filtrados.

Colunas
Nome Tipo Referências Descrição
BudgetScenarioId [KEY] Integer Orçamentos.BudgetScenarioId O ID do cenário para este orçamento.
Category [KEY] String A categoria de orçamento para este período.
FiscalYear String Anos Fiscais.Ano O ano fiscal deste período.
FiscalPeriodId [KEY] Integer Anos Fiscais.FiscalPeriodId O período fiscal.
PeriodAmount Decimal O valor para este período.
TotalAmount Decimal O valor total para este período.

Subsídios de Orçamento

Retorna detalhes para cada período fiscal e concessão no cenário.

O conector usará a API Financial Edge NXT para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

  • BudgetScenarioId, Grant suporta o operador '='. Uma pesquisa em branco não é suportada.

Por exemplo, as seguintes consultas são processadas no lado do servidor:

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

Você pode desativar a execução do lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a outras colunas resultará no envio de dados não filtrados.

Colunas
Nome Tipo Referências Descrição
BudgetScenarioId [KEY] Integer Orçamentos.BudgetScenarioId O ID do cenário para este orçamento.
Grant [KEY] String O nome da concessão para este período.
AccountNumber [KEY] String Contas.AccountNumber O número da conta para este período.
BudgetCategory String A categoria de orçamento para este período.
FiscalYear String Anos Fiscais.Ano O ano fiscal para este período.
FiscalPeriodId Integer Anos Fiscais.FiscalPeriodId O período fiscal.
PeriodPercent Double A porcentagem desse período.
PeriodAmount Decimal O valor para este período.
TotalAmount Decimal O valor total para este período.

Linhas Orçamentárias

Retorna as linhas de orçamento especificadas.

O conector usará a API Financial Edge NXT para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

  • BudgetScenarioId suporta o operador '='. Esta é a única coluna suportada.

Por exemplo, a seguinte consultar é processada no lado do servidor:

Select * FROM BudgetLines WHERE BudgetScenarioId = 123

Você pode desativar a execução do lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a outras colunas resultará no envio de dados não filtrados.

Colunas
Nome Tipo Referências Descrição
BudgetScenarioId [KEY] Integer Orçamentos.BudgetScenarioId O ID do cenário para este orçamento.
BudgetLineId [KEY] Integer O ID da linha de orçamento.
AccountNumber String Contas.AccountNumber O número de uma conta neste orçamento.
AccountDescription String A descrição de uma conta neste orçamento.
UiProjectId String O ID do projeto definido pelo usuário para esta linha de orçamento.
ProjectDescription String A descrição de um projeto nesta linha de orçamento.
Notes String A nota para esta linha de orçamento.
GrantDescription String A descrição do código t {Grant}.
Total Decimal O valor total dessa linha de orçamento.
Periods String As distribuições de período para esta linha de orçamento.

OrçamentoProjetos

Retorna detalhes para cada período fiscal e projeto no cenário.

O conector usará a API Financial Edge NXT para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

  • BudgetScenarioId, UiProjectId suporta o operador '='. Uma pesquisa em branco não é suportada.

Por exemplo, as seguintes consultas são processadas no lado do servidor:

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

Você pode desativar a execução do lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a outras colunas resultará no envio de dados não filtrados.

Colunas
Nome Tipo Referências Descrição
BudgetScenarioId [KEY] Integer Orçamentos.BudgetScenarioId O ID do cenário para este orçamento.
UiProjectId [KEY] String O identificador do projeto visível ao usuário.
BudgetCategory String A categoria de orçamento para este período.
FiscalYear String Anos Fiscais.Ano O ano fiscal para este período.
FiscalPeriodId Integer Anos Fiscais.FiscalPeriodId O período fiscal.
AccountNumber String Contas.AccountNumber O número da conta para este período.
PeriodAmount Decimal O valor para este período.
TotalAmount Decimal O valor total para este período.
PeriodPercent Double A porcentagem desse período.

Orçamentos

Retorna uma visão geral de nível superior de cada cenário de orçamento.

Colunas
Nome Tipo Referências Descrição
BudgetScenarioId [KEY] Integer O identificador para este cenário de orçamento.
ScenarioId String Cenários de Orçamento.ScenarioId A ID do cenário deste cenário de orçamento.
Status String O status deste cenário de orçamento.
Description String A descrição para este cenário de orçamento.
BudgetType String O tipo para este cenário de orçamento.
StartDate Datetime A data de início para este cenário de orçamento.
EndDate Datetime A data final para este cenário de orçamento.
StartFiscalYear String O ano fiscal inicial para este cenário de orçamento.
EndFiscalYear String O ano fiscal final para este cenário de orçamento.
Locked String O status bloqueado deste cenário de orçamento.

Cenários de Orçamento

Retorna detalhes para cada ID de cenário.

Colunas
Nome Tipo Referências Descrição
ScenarioId [KEY] Integer O identificador do banco de dados para a id do cenário.
Value String Pequena descrição.
Inactive Boolean Se o ID do cenário está ou não inativo.
Description String Longa descrição.

CashManagementDistributionSetLineItemProjects

A distribuição do projeto para os itens de linha nos conjuntos de distribuição de gerenciamento de caixa.

O conector usará a API Financial Edge NXT para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

  • SetId suporta o operador '='. Esta é a única coluna suportada.

Por exemplo, a seguinte consultar é processada no lado do servidor:

Select * FROM CashManagementDistributionSetLineItemProjects WHERE SetId = 123

Você pode desativar a execução do lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a outras colunas resultará no envio de dados não filtrados.

Colunas
Nome Tipo Referências Descrição
SetId [KEY] Integer CashManagementDistributionSets.SetId O identificador do conjunto de distribuição de gerenciamento de caixa.
ProjectId [KEY] Integer O identificador do projeto para o item de linha.
LineNumber Integer O número da linha do item de linha.
Percent Double A porcentagem da distribuição que o item de linha representa.
AccountClass String A classe da conta para o item de linha.

CashManagementDistributionSets

Retorna a lista de conjuntos de distribuição de gerenciamento de caixa e seus itens de linha.

O conector usará a API Financial Edge NXT para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

  • SetId suporta o operador '='. Esta é a única coluna suportada.

Por exemplo, a seguinte consultar é processada no lado do servidor:

Select * FROM CashManagementDistributionSets WHERE SetId = 123

Você pode desativar a execução do lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a outras colunas resultará no envio de dados não filtrados.

Colunas
Nome Tipo Referências Descrição
SetId [KEY] Integer O identificador do conjunto de distribuição de gerenciamento de caixa.
Name String O nome do conjunto de distribuição de gerenciamento de caixa.
LineItemPercent Double A porcentagem do conjunto de distribuição total que o item de linha representa.
LineItemRowNumber Integer O número da linha do item de linha.
LineItemAccountId String O identificador da conta para o item de linha.

Aulas

A lista de aulas

Colunas
Nome Tipo Referências Descrição
ClassId [KEY] Integer O identificador de classe.
Value String O valor para esta classe.
Description String A descrição para esta classe.

ClientNames

Retorna os nomes dos tipos de cliente.

Colunas
Nome Tipo Referências Descrição
RecordType String O nome do tipo de registro.
ClientRecordTypeName String O nome do cliente para este tipo de registro.

Exercícios Fiscais

Retorna a lista de detalhes do ano fiscal.

Colunas
Nome Tipo Referências Descrição
FiscalYearId [KEY] Integer O identificador para este ano fiscal.
StartDate Datetime A data de início deste ano fiscal.
Status String O status deste ano fiscal.
Year String O ano deste ano fiscal.
Description String A descrição deste ano fiscal.
EndDate Datetime A data final deste ano fiscal.
FiscalPeriodId [KEY] Integer O identificador para este período fiscal.
FiscalPeriodStartDate Datetime A data de início deste período fiscal.
FiscalPeriodEndDate Datetime A data final deste período fiscal.
FiscalPeriodSequence Integer A sequência deste período fiscal.
FiscalPeriodClosed Boolean Se este período fiscal está fechado ou não.

GrantCustomFields

Retorna a lista de opções de campo personalizado de concessão.

Colunas
Nome Tipo Referências Descrição
CustomFieldId [KEY] Integer O identificador para este campo personalizado.
Name String O nome desse campo personalizado.
Type String O tipo (booleano, tabela etc.) desse campo personalizado.
IsRequired Boolean Se este campo personalizado for obrigatório.
TableValues String Lista de valores da tabela. Aplicável somente se tipo = 'Tabela'.

Conceder Status

Retorna a lista de status de concessão.

Colunas
Nome Tipo Referências Descrição
Id [KEY] Integer O identificador para este valor de pesquisa.
Value String O valor para este valor de pesquisa.
Description String A descrição para este valor de pesquisa.

GrantTypes

Retorna a lista de tipos de concessão.

Colunas
Nome Tipo Referências Descrição
Id [KEY] Integer O identificador para este valor de pesquisa.
Value String O valor para este valor de pesquisa.
Description String A descrição para este valor de pesquisa.

Journal Codes

Retorna a lista de todos os códigos de lançamento disponíveis.

Colunas
Nome Tipo Referências Descrição
JournalCodeId [KEY] Integer O identificador do diário.
Code String O código abreviado do jornal.
Journal String O nome completo do diário do diário.

Entradas de Diário

Recupere e consultar entradas de diário.

O conector usará a API Financial Edge NXT para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

  • BatchId suporta o operador '='. Esta é a única coluna suportada.

Por exemplo, a seguinte consultar é processada no lado do servidor:

Select * FROM JournalEntries WHERE BatchId = 123

Você pode desativar a execução do lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a outras colunas resultará no envio de dados não filtrados.

Colunas
Nome Tipo Referências Descrição
JournalEntryId [KEY] Integer O identificador de entrada de diário.
BatchId Integer O identificador do lote.
AccountNumber String O número da conta do lançamento contábil manual.
TypeCode String O tipo de transação do lançamento contábil manual (débito ou crédito).
Journal String O nome completo da revista.
LineNumber Integer O número da linha do lançamento contábil manual.
Reference String A referência de entrada de diário.
PostDate Datetime A data de postagem do lançamento contábil manual, no formato ISO 8601: 2016-03-14.
Amount Double O valor do lançamento contábil manual.
Notes String As notas de entrada de diário.
Encumbrance String O tipo de ônus do lançamento no diário.
Distributions String As distribuições de entrada de diário.
CustomFields String Campo personalizado: a lista de campos personalizados com suporte como colunas distict.

Lotes de Entrada de Diário

Retorna a lista de lotes de lançamentos contábeis manuais.

O conector usará a API Financial Edge NXT para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

  • BatchId suporta o operador '='. Esta coluna é filtrada pelo ID do conjunto de relatórios do servidor (RSID) e quando é o único filtro especificado nos critérios.

Por exemplo, a seguinte consultar é processada no lado do servidor:

Select * FROM JournalEntryBatches WHERE BatchId = 123

Você pode desativar a execução do lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a outras colunas resultará no envio de dados não filtrados.

Colunas
Nome Tipo Referências Descrição
BatchId [KEY] Integer O identificador do lote.
UiBatchId String O identificador do lote visível ao usuário.
Description String A descrição do lote.
BatchStatus String O status do lote.
CreateInterfundSets Boolean Indica se o lote deve ou não criar lançamentos entre fundos quando lançado.
CreateBankAccountAdjustments Boolean Indica se o lote deve ou não criar ajustes de conta bancária quando lançado.
DateAdded Datetime A data de criação do lote.
AddedBy String O criador do lote.
DateModified Datetime A data de modificação do lote.
ModifiedBy String O modificador do lote.

Resumos do Razão

Lista os resumos do razão geral para o ano fiscal e os critérios especificados. Observe que os registros de resumo existem apenas para anos fiscais otimizados fechados. Se alguma atividade ocorrer em um período fiscal que não tenha sido fechado e otimizado desde então, ela não será incluída no(s) registro(s) de resumo GL.

O conector usará a API Financial Edge NXT para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

  • FiscalYearId, AccountNumber e UiProjectId suporta o operador '='. Uma pesquisa em branco não é suportada.

Por exemplo, a seguinte consultar é processada no lado do servidor:

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

Você pode desativar a execução do lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a outras colunas resultará no envio de dados não filtrados.

Colunas
Nome Tipo Referências Descrição
FiscalYearId String Anos Fiscais.FiscalYearId O identificador do ano fiscal.
FiscalYear String Anos Fiscais.Ano O ano fiscal resumido.
AccountNumber String Contas.AccountNumber O número da conta de transações resumidas.
PeriodStartDate Datetime A data de início do período resumido.
FiscalPeriod String O período fiscal resumido.
EncumberedBeginningBalance Double O saldo da transação onerada no início do período resumido.
EncumberedCredit Double A soma dos créditos de transação onerados no período resumido.
UiProjectId String O identificador do projeto de transações resumidas.
PeriodEndDate Datetime A data final do período resumido.
TransactionCodes String Os valores do código de transação das transações resumidas.
Credit Double A soma dos créditos da transação no período resumido.
Debit Double A soma dos débitos da transação no período resumido.
EncumberedDebit Double A soma dos débitos de transação onerados no período resumido.
BeginningBalance Double O saldo total da transação no início do período resumido.

Tipos de Mídia

Retorna uma lista de opções de tipo de mídia.

Colunas
Nome Tipo Referências Descrição
TypeId [KEY] Integer O identificador para este tipo de mídia.
Value String O valor do tipo de mídia.
Description String A descrição do tipo de mídia.

PeríodoResumos

Depois que o processo de resumo estiver concluído, é assim que você obtém os dados retornados.

O conector usará a API Financial Edge NXT para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

  • FiscalYear, FiscalPeriod, AccountNumber e UiProjectId suporta o operador '='. Uma pesquisa em branco não é suportada.

Por exemplo, a seguinte consultar é processada no lado do servidor:

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

Você pode desativar a execução do lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a outras colunas resultará no envio de dados não filtrados.

Colunas
Nome Tipo Referências Descrição
FiscalYear String Anos Fiscais.Ano O ano fiscal resumido.
FiscalPeriod String Anos Fiscais.Período Fiscal O período fiscal resumido.
AccountNumber String Contas.AccountNumber O número da conta de transações resumidas.
UiProjectId String O identificador do projeto de transações resumidas.
PeriodStartDate Datetime A data de início do período resumido.
PeriodEndDate Datetime A data final do período resumido.
TransactionCodes String Os valores do código de transação das transações resumidas.
BeginningBalance Double O saldo total da transação no início do período resumido.
Debit Double A soma dos débitos da transação no período resumido.
Credit Double A soma dos créditos da transação no período resumido.
EncumberedBeginningBalance Double O saldo da transação onerada no início do período resumido.
EncumberedCredit Double A soma dos créditos de transação onerados no período resumido.
EncumberedDebit Double A soma dos débitos de transação onerados no período resumido.

PeriodSummariesProcessingInfo

Este endpoint relata o status atual da solicitação de resumo, se ela está concluída, ainda em execução ou com falha.

Colunas
Nome Tipo Referências Descrição
ProcessId [KEY] String O identificador do processo para o processo de resumo
FiscalPeriodId Integer Anos Fiscais.FiscalPeriodId O identificador do período fiscal para o processo sumário
Status String O status do processo sumário
StatusMessage String A mensagem de status dos processos de resumo

ProjetoAnexos

Retorna a lista de anexos para o projeto especificado.

O conector usará a API Financial Edge NXT para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

  • ProjectId suporta o operador '='. Esta coluna é necessária para buscar os anexos do projeto.

Por exemplo, as seguintes consultas são processadas no lado do servidor:

SELECT * FROM ProjectAttachments WHERE ProjectId = 1

Você pode desativar a execução do lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a outras colunas resultará no envio de dados não filtrados.

Colunas
Nome Tipo Referências Descrição
Id Integer O identificador de anexo
ProjectId Integer O identificador do projeto para recuperar os anexos
Name String O nome deste anexo
Url String A URL deste anexo
Type String O tipo de anexo. Os valores disponíveis são Link e Physical
MediaType String Categoria definida pelo usuário deste anexo
DateAttached Datetime A data em que o anexo foi adicionado

ProjetoContatoMétodos

Informações de endereço de contatos para projetos.

Colunas
Nome Tipo Referências Descrição
ProjectId [KEY] Integer Contatos do Projeto.ProjectId O identificador para este projeto.
ContactId [KEY] Integer Contatos do Projeto.ContatoId O identificador desse contato.
ContactMethodId [KEY] Integer O identificador do método de contato do endereço.
ContactType String O tipo de contato (e-mail, telefone, etc).
ContactInfo String As informações de contato (endereço e-mail, número de telefone, etc.) para este método.

ProjetoContatos

Os contatos para um projeto.

O conector usará a API Financial Edge NXT para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

  • ProjectId suporta o operador '='. Esta coluna é o único filtro compatível.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM ProjectContacts WHERE ProjectId = 1

Você pode desativar a execução do lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a outras colunas resultará no envio de dados não filtrados.

Colunas
Nome Tipo Referências Descrição
ProjectId [KEY] Integer Projetos.ProjectId O identificador para este projeto.
ContactId [KEY] Integer O identificador desse contato.
Description String A descrição para este endereço.
Country String O país do endereço.
City String A cidade do endereço.
County String O condado deste endereço.
State String O estado ou província (ou subúrbio na Nova Zelândia) do endereço.
Postal String Refere-se ao Código Postal ou CEP do endereço.
Title String O título do contato principal.
FirstName String O primeiro nome do contato principal.
MiddleName String A inicial do meio ou o nome do contato principal.
LastName String O sobrenome do contato principal.
Suffix String O sufixo do contato principal.
Position String A posição do contato principal.

Departamentos de Projeto

Retorna a lista de departamentos do projeto.

Colunas
Nome Tipo Referências Descrição
Id [KEY] Integer O identificador para este valor de pesquisa.
Value String O valor para este valor de pesquisa.
Description String A descrição para este valor de pesquisa.

ProjetoDivisões

Retorna a lista de divisões do projeto.

Colunas
Nome Tipo Referências Descrição
Id [KEY] Integer O identificador para este valor de pesquisa.
Value String O valor para este valor de pesquisa.
Description String A descrição para este valor de pesquisa.

Localizações do Projeto

Retorna a lista de locais do projeto.

Colunas
Nome Tipo Referências Descrição
Id [KEY] Integer O identificador para este valor de pesquisa.
Value String O valor para este valor de pesquisa.
Description String A descrição para este valor de pesquisa.

Projetos

Recupere e consultar projetos.

O conector usará a API Financial Edge NXT para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

  • ProjectId suporta o operador '='. Esta coluna é filtrada pelo ID do conjunto de relatórios do servidor (RSID) e quando é o único filtro especificado nos critérios.
  • Location,Type,Division e Department suporta o operador '='. Uma pesquisa em branco não é suportada.

Por exemplo, as seguintes consultas são processadas no lado do servidor:

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

Você pode desativar a execução do lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a outras colunas resultará no envio de dados não filtrados.

Colunas
Nome Tipo Referências Descrição
ProjectId [KEY] Integer O identificador do banco de dados do projeto.
UiProjectId String O identificador visível ao usuário do projeto.
Description String A descrição do projeto.
Location String A localização do projeto.
EndDate Datetime A data final do projeto, no formato ISO 8601: 2016-03-14.
StartDate Datetime A data de início do projeto, no formato ISO 8601: 2016-03-14.
Type String O tipo de projeto.
AddedBy String O idealizador do projeto.
PostingDate Datetime A data após a qual impedir a postagem, se aplicável.
PreventPostingAfter Boolean Se impedir a entrada de dados, se for para impedir a postagem após uma determinada data.
Division String A divisão do projeto.
PreventDataEntry Boolean Se para impedir a entrada de dados para este projeto.
ModifiedBy String O modificador do projeto.
Status String O estado do projeto.
Department String O departamento de projetos.
AccountRestrictions String Os subsídios ou restrições de conta para este projeto.
DateAdded Datetime A data de criação do projeto.
DateModified Datetime A data de modificação do projeto.
CustomFields String Campo personalizado: a lista de campos personalizados com suporte como colunas distict.

Status do Projeto

Retorna a lista de status do projeto.

Colunas
Nome Tipo Referências Descrição
Id [KEY] Integer O identificador para este valor de pesquisa.
Value String O valor para este valor de pesquisa.
Description String A descrição para este valor de pesquisa.

ProjectTypes

Retorna a lista de tipos de projeto.

Colunas
Nome Tipo Referências Descrição
Id [KEY] Integer O identificador para este valor de pesquisa.
Value String O valor para este valor de pesquisa.
Description String A descrição para este valor de pesquisa.

Códigos de Transação

Retorna a lista de todos os códigos de transação disponíveis.

Colunas
Nome Tipo Referências Descrição
TransactionCodeId [KEY] Integer O identificador do código da transação.
Name String O nome do código da transação.
UsedForGrants Boolean Se o código de transação for usado para concessões.
Description String A descrição do código da transação.

Valores de Código de Transação

Retorna a lista de todos os valores para o código de transação especificado.

O conector usará a API Financial Edge NXT para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

  • TransactionCodeId suporta o operador '='. Esta coluna é o único filtro compatível.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM TransactionCodeValues WHERE TransactionCodeId = 1

Você pode desativar a execução do lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a outras colunas resultará no envio de dados não filtrados.

Colunas
Nome Tipo Referências Descrição
TransactionCodeId Integer Códigos de transação.TransactionCodeId O identificador do código da transação.
Id [KEY] Integer O ID do valor do código da transação.
Name String O nome do código da transação.
Value String O valor do código da transação.

Distribuições de Transações

Retorna uma lista de transações correspondentes aos critérios de pesquisa

O conector usará a API Financial Edge NXT para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

  • BatchId, AccountNumber, UiProjectId, TypeCode, Encumbrance, Journal, e PostStatus suporta o operador '='. Uma pesquisa em branco não é suportada.
  • PostDate suporta os seguintes operadores: <,<=,=,>=,>.
  • DateModified suporta os seguintes operadores: >,>=.

Por exemplo, as seguintes consultas são processadas no lado do servidor:

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'

Você pode desativar a execução do lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a outras colunas resultará no envio de dados não filtrados.

Colunas
Nome Tipo Referências Descrição
DistributionId [KEY] Integer O identificador de distribuição.
TransactionId [KEY] Integer O identificador da transação.
TransactionAmount Double O valor da transação.
BatchId Integer JournalEntryBatches.BatchId O identificador de lote
DistributionAmount Double O valor da distribuição.
AccountNumber String Contas.AccountNumber O número da conta.
AccountClass String A classe conta.
UiProjectId String O identificador visível ao usuário do projeto.
PostDate Datetime A data de postagem da transação.
TypeCode String O tipo de transação (débito ou crédito). Os valores permitidos são Débito, Crédito.
Reference String A referência da transação.
Encumbrance String O tipo de ônus da transação.
Journal String O nome completo da revista.
TransactionCodeValues String Os códigos de transação de distribuição.
DateAdded Datetime A data de criação da distribuição da transação.
AddedBy String O criador da distribuição da transação.
DateModified Datetime A data modificada da distribuição da transação.
ModifiedBy String O modificador da distribuição da transação.
PostStatus String O status de postagem da distribuição da transação.

Conjuntos de Distribuição de Transações

Retorna a lista de conjuntos de distribuição de transações.

O conector usará a API Financial Edge NXT para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

  • SetId suporta o operador '='. Esta coluna é o único filtro compatível.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM TransactionDistributionSets WHERE SetId = 1

Você pode desativar a execução do lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a outras colunas resultará no envio de dados não filtrados.

Colunas
Nome Tipo Referências Descrição
SetId [KEY] Integer O identificador para o conjunto de distribuição da transação.
Name String O nome do conjunto de distribuição da transação.
LineNumber [KEY] Integer O número do item de linha.
LineItemPercent Double A porcentagem do conjunto de distribuição total que o item de linha representa.
LineItemProjectId Integer O identificador do projeto para o item de linha.
LineItemAccountClass String A classe da conta para o item de linha.
LineItemTransactionCodeValues String Os valores do código de transação para o item de linha.

Procedimentos Armazenados

Procedimentos armazenados* estão disponíveis para complementar os dados disponíveis no Modelo de Dados. Pode ser necessário atualizar os dados disponíveis em uma exibição usando um procedimento armazenado* porque os dados não fornecem atualizações bidirecionais diretas, semelhantes a tabelas. Nessas situações, a recuperação dos dados é feita usando a visualização ou tabela apropriada, enquanto a atualização é feita chamando um procedimento armazenado. Procedimentos armazenados* pega uma lista de parâmetros e retorna um conjunto de dados que contém a coleção de tuplas que constituem a resposta.

Conector Jitterbit para Procedimentos Armazenados Blackbaud Financial Edge NXT

Nome Descrição
GetOAuthAccessToken Obtém um token de autenticação do Blackbaud Financial Edge NXT.
GetOAuthAuthorizationURL Obtém a URL de autorização que deve ser aberta separadamente pelo usuário para conceder acesso ao seu aplicativo. Necessário apenas ao desenvolver aplicativos da Web. Você solicitará o token de autenticação deste URL.
RefreshOAuthAccessToken Atualiza o token de acesso OAuth usado para autenticação com Blackbaud Financial Edge NXT.

GetOAuthAccessToken

Obtém um token de autenticação do Blackbaud Financial Edge NXT.

Entrada
Nome Tipo Obrigatório Descrição
AuthMode String Falso O tipo de modo de autenticação a ser usado. Selecione App para obter tokens de autenticação por meio de um aplicativo de desktop. Selecione Web para obter tokens de autenticação por meio de um aplicativo Web. Os valores permitidos são APP, WEB. O valor padrão é APP.
CallbackURL String Falso Determina para onde a resposta é enviada. O valor desse parâmetro deve corresponder exatamente a um dos valores registrados nas configurações do aplicativo (incluindo os esquemas HTTP ou HTTPS, letras maiúsculas e '/' à direita).
Verifier String Falso O verificador retornou do Blackbaud Financial Edge NXT depois que o usuário autorizou seu aplicativo a ter acesso aos seus dados. Esse valor será retornado como um parâmetro para a URL de retorno de chamada em GetOAuthAuthorizationURL.
State String Falso Este campo indica qualquer estado que pode ser útil para sua aplicação após o recebimento da resposta. Seu aplicativo recebe o mesmo valor que enviou, pois esse parâmetro faz uma viagem de ida e volta para o servidor de autorização Blackbaud Financial Edge NXT e vice-versa. Os usos possíveis incluem redirecionar o usuário para o recurso correto em seu site, usar nonces e atenuar a falsificação de solicitação entre sites.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
OAuthAccessToken String O token de acesso usado para comunicação com o Blackbaud Financial Edge NXT.
OAuthRefreshToken String O token de atualização usado para o procedimento RefreshOAuthAccessToken.

GetOAuthAuthorizationURL

Obtém a URL de autorização que deve ser aberta separadamente pelo usuário para conceder acesso ao seu aplicativo. Necessário apenas ao desenvolver aplicativos da Web. Você solicitará o token de autenticação deste URL.

Entrada
Nome Tipo Obrigatório Descrição
CallbackUrl String Falso A URL para a qual o usuário será redirecionado após autorizar seu aplicativo. Este valor deve corresponder ao URL de redirecionamento nas configurações do aplicativo Blackbaud Financial Edge NXT.
State String Falso Este campo indica qualquer estado que pode ser útil para sua aplicação após o recebimento da resposta. Seu aplicativo recebe o mesmo valor que enviou, pois esse parâmetro faz uma viagem de ida e volta ao servidor de autorização Blackbaud. Os usos possíveis incluem redirecionar o usuário para o recurso correto em seu site, usar nonces e atenuar a falsificação de solicitação entre sites.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
URL String O URL de autorização, inserido em um navegador da Web para obter o token do verificador e autorizar seu aplicativo.

RefreshOAuthAccessToken

Atualiza o token de acesso OAuth usado para autenticação com Blackbaud Financial Edge NXT.

Entrada
Nome Tipo Obrigatório Descrição
OAuthRefreshToken String Verdade O token de atualização retornado da troca do código de autorização original.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
OAuthAccessToken String O token de autenticação retornado do Blackbaud Financial Edge NXT. Isso pode ser usado em chamadas subseqüentes para outras operações para este serviço específico.
OAuthRefreshToken String Um token que pode ser usado para obter um novo token de acesso.
ExpiresIn String O tempo de vida restante no token de acesso.

Tabelas do Sistema

Você pode consultar as tabelas do sistema descritas nesta seção para acessar informações de esquema, informações sobre a funcionalidade da fonte de dados e estatísticas de operação em lote.

Tabelas de Esquema

As tabelas a seguir retornam os metadados do banco de dados para o Blackbaud Financial Edge NXT:

Tabelas de Fonte de Dados

As tabelas a seguir retornam informações sobre como se conectar e consultar a fonte de dados:

  • sys_connection_props: Retorna informações sobre as propriedades de conexão disponíveis.
  • sys_sqlinfo: Descreve as consultas SELECT que o conector pode descarregar para a fonte de dados.

Consultar Tabelas de Informações

A tabela a seguir retorna estatísticas de consultar para consultas de modificação de dados:

  • sys_identity: Retorna informações sobre operações em lote ou atualizações únicas.

Sys_catalogs

Lista os bancos de dados disponíveis.

A consultar a seguir recupera todos os bancos de dados determinados pela string de conexão:

SELECT * FROM sys_catalogs
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados.

Sys_schemas

Lista os esquemas disponíveis.

A consultar a seguir recupera todos os esquemas disponíveis:

SELECT * FROM sys_schemas
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados.
SchemaName String O nome do esquema.

Sys_tables

Lista as tabelas disponíveis.

A consultar a seguir recupera as tabelas e exibições disponíveis:

SELECT * FROM sys_tables
Colunas
Nome Tipo Descrição
CatalogName String O banco de dados que contém a tabela ou exibição.
SchemaName String O esquema que contém a tabela ou exibição.
TableName String O nome da tabela ou exibição.
TableType String O tipo de tabela (tabela ou exibição).
Description String Uma descrição da tabela ou exibição.
IsUpdateable Boolean Se a tabela pode ser atualizada.

Sys_tablecolumns

Descreve as colunas das tabelas e exibições disponíveis.

A consultar a seguir retorna as colunas e os tipos de dados da tabela Accounts:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Accounts'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém a tabela ou exibição.
SchemaName String O esquema que contém a tabela ou exibição.
TableName String O nome da tabela ou exibição que contém a coluna.
ColumnName String O nome da coluna.
DataTypeName String O nome do tipo de dados.
DataType Int32 Um número inteiro indicando o tipo de dados. Esse valor é determinado no tempo de execução com base no ambiente.
Length Int32 O tamanho de armazenamento da coluna.
DisplaySize Int32 A largura máxima normal da coluna designada em caracteres.
NumericPrecision Int32 O número máximo de dígitos em dados numéricos. O comprimento da coluna em caracteres para caracteres e dados de data e hora.
NumericScale Int32 A escala da coluna ou o número de dígitos à direita do ponto decimal.
IsNullable Boolean Se a coluna pode conter null.
Description String Uma breve descrição da coluna.
Ordinal Int32 O número de sequência da coluna.
IsAutoIncrement String Se o valor da coluna é atribuído em incrementos fixos.
IsGeneratedColumn String Se a coluna é gerada.
IsHidden Boolean Se a coluna está oculta.
IsArray Boolean Se a coluna é uma matriz.

Sys_procedures

Lista os procedimentos armazenados disponíveis.

A consultar a seguir recupera os procedimentos armazenados disponíveis:

SELECT * FROM sys_procedures
Colunas
Nome Tipo Descrição
CatalogName String O banco de dados que contém o procedimento armazenado.
SchemaName String O esquema que contém o procedimento armazenado.
ProcedureName String O nome do procedimento armazenado.
Description String Uma descrição do procedimento armazenado.
ProcedureType String O tipo do procedimento, como PROCEDURE ou FUNCTION.

Sys_procedureparameters

Descreve procedimento armazenado* parâmetros.

A consultar a seguir retorna informações sobre todos os parâmetros de entrada para o procedimento armazenado SelectEntries:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém o procedimento armazenado.
SchemaName String O nome do esquema que contém o procedimento armazenado.
ProcedureName String O nome do procedimento armazenado* contendo o parâmetro.
ColumnName String O nome do procedimento armazenado* parâmetro.
Direction Int32 Um número inteiro correspondente ao tipo do parâmetro: entrada (1), entrada/saída (2) ou saída (4). parâmetros de tipo de entrada/saída podem ser parâmetros de entrada e saída.
DataTypeName String O nome do tipo de dados.
DataType Int32 Um número inteiro indicando o tipo de dados. Esse valor é determinado no tempo de execução com base no ambiente.
Length Int32 O número de caracteres permitido para dados de caractere. O número de dígitos permitidos para dados numéricos.
NumericPrecision Int32 A precisão máxima para dados numéricos. O comprimento da coluna em caracteres para caracteres e dados de data e hora.
NumericScale Int32 O número de dígitos à direita do ponto decimal em dados numéricos.
IsNullable Boolean Se o parâmetro pode conter null.
IsRequired Boolean Se o parâmetro é necessário para a execução do procedimento.
IsArray Boolean Se o parâmetro é uma matriz.
Description String A descrição do parâmetro.
Ordinal Int32 O índice do parâmetro.

Sys_keycolumns

Descreve as chaves primárias e estrangeiras. A consultar a seguir recupera a chave primária da tabela Accounts:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Accounts'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém a chave.
SchemaName String O nome do esquema que contém a chave.
TableName String O nome da tabela que contém a chave.
ColumnName String O nome da coluna chave.
IsKey Boolean Se a coluna é uma chave primária na tabela referenciada no campo TableName.
IsForeignKey Boolean Se a coluna é uma chave estrangeira referenciada no campo TableName.
PrimaryKeyName String O nome da chave primária.
ForeignKeyName String O nome da chave estrangeira.
ReferencedCatalogName String O banco de dados que contém a chave primária.
ReferencedSchemaName String O esquema que contém a chave primária.
ReferencedTableName String A tabela que contém a chave primária.
ReferencedColumnName String O nome da coluna da chave primária.

Sys_foreignkeys

Descreve as chaves estrangeiras. A consultar a seguir recupera todas as chaves estrangeiras que se referem a outras tabelas:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém a chave.
SchemaName String O nome do esquema que contém a chave.
TableName String O nome da tabela que contém a chave.
ColumnName String O nome da coluna chave.
PrimaryKeyName String O nome da chave primária.
ForeignKeyName String O nome da chave estrangeira.
ReferencedCatalogName String O banco de dados que contém a chave primária.
ReferencedSchemaName String O esquema que contém a chave primária.
ReferencedTableName String A tabela que contém a chave primária.
ReferencedColumnName String O nome da coluna da chave primária.
ForeignKeyType String Designa se a chave estrangeira é uma chave de importação (aponta para outras tabelas) ou de exportação (referenciada de outras tabelas).

Sys_indexes

Descreve os índices disponíveis. Ao filtrar por índices, você pode escrever consultas mais seletivas com tempos de resposta de consultar mais rápidos.

A consultar a seguir recupera todos os índices que não são chaves primárias:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém o índice.
SchemaName String O nome do esquema que contém o índice.
TableName String O nome da tabela que contém o índice.
IndexName String O nome do índice.
ColumnName String O nome da coluna associada ao índice.
IsUnique Boolean True se o índice for exclusivo. Falso caso contrário.
IsPrimary Boolean Verdadeiro se o índice for uma chave primária. Falso caso contrário.
Type Int16 Um valor inteiro correspondente ao tipo de índice: estatística (0), clusterizado (1), hash (2) ou outro (3).
SortOrder String A ordem de classificação: A para crescente ou D para decrescente.
OrdinalPosition Int16 O número de sequência da coluna no índice.

Sys_connection_props

Retorna informações sobre as propriedades de conexão disponíveis e as definidas na string de conexão.

Ao consultar esta tabela, a string de conexão de configuração deve ser usada:

jdbc:cdata:financialedgenxt:config:

Esta string de conexão permite que você consultar esta tabela sem uma conexão válida.

A consultar a seguir recupera todas as propriedades de conexão que foram definidas na string de conexão ou definidas por meio de um valor padrão:

SELECT * FROM sys_connection_props WHERE Value <> ''
Colunas
Nome Tipo Descrição
Name String O nome da propriedade de conexão.
ShortDescription String Uma breve descrição.
Type String O tipo de dados da propriedade de conexão.
Default String O valor padrão, se não houver um definido explicitamente.
Values String Uma lista separada por vírgulas de valores possíveis. Um erro de validação é lançado se outro valor for especificado.
Value String O valor que você definiu ou um padrão pré-configurado.
Required Boolean Se a propriedade é necessária para se conectar.
Category String A categoria da propriedade de conexão.
IsSessionProperty String Se a propriedade é uma propriedade de sessão, usada para salvar informações sobre a conexão atual.
Sensitivity String O nível de sensibilidade da propriedade. Isso informa se a propriedade está ofuscada nos formulários de registro e autenticação.
PropertyName String Uma forma truncada em camel case do nome da propriedade de conexão.
Ordinal Int32 O índice do parâmetro.
CatOrdinal Int32 O índice da categoria do parâmetro.
Hierarchy String Mostra as propriedades dependentes associadas que precisam ser definidas juntamente com esta.
Visible Boolean Informa se a propriedade está visível na UI da conexão.
ETC String Diversas informações diversas sobre o imóvel.

Sys_sqlinfo

Descreve o processamento da consultar SELECT que o conector pode transferir para a fonte de dados.

Processamento de Consultas Colaborativas

Ao trabalhar com fontes de dados que não suportam SQL-92, você pode consultar a exibição sys_sqlinfo para determinar os recursos de consultar das APIs subjacentes, expressas na sintaxe SQL. O conector transfere o máximo possível do processamento da instrução SELECT para o servidor e, em seguida, processa o restante da consultar na memória.

Descobrindo os Recursos SELECT da Fonte de Dados

Abaixo está um exemplo de conjunto de dados de recursos SQL. O conjunto de resultados a seguir indica a funcionalidade SELECT que o conector pode descarregar para a fonte de dados ou processar o lado do cliente. Sua fonte de dados pode suportar sintaxe SQL adicional. Alguns aspectos da funcionalidade SELECT são retornados em uma lista separada por vírgulas, se suportados; caso contrário, a coluna contém NO.

Nome Descrição Valores Possíveis
AGGREGATE_FUNCTIONS Funções de agregação suportadas. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Se a função COUNT é suportada. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR O caractere de abertura usado para escapar de um identificador. [
IDENTIFIER_QUOTE_CLOSE_CHAR O caractere de fechamento usado para escapar de um identificador. ]
SUPPORTED_OPERATORS Uma lista de operadores SQL com suporte. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Se GROUP BY é compatível e, em caso afirmativo, o grau de suporte. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Funções de string suportadas. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Funções numéricas suportadas. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Funções de data/hora suportadas. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Indica tabelas ignoradas durante a replicação.
REPLICATION_TIMECHECK_COLUMNS Uma matriz de string contendo uma lista de colunas que serão usadas para verificar (na ordem especificada) para usar como uma coluna modificada durante a replicação.
IDENTIFIER_PATTERN Valor de string que indica qual string é válida para um identificador.
SUPPORT_TRANSACTION Indica se o provedor oferece suporte a transações como confirmação e reversão. YES, NO
DIALECT Indica o dialeto SQL a ser usado.
KEY_PROPERTIES Indica as propriedades que identificam o banco de dados uniforme.
SUPPORTS_MULTIPLE_SCHEMAS Indica se vários esquemas podem existir para o provedor. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indica se vários catálogos podem existir para o provedor. YES, NO
DATASYNCVERSION A versão do Data Sync necessária para acessar este driver. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY A categoria Data Sync deste driver. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Se a funcionalidade SQL aprimorada além do que é oferecido pela API é suportada. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Se as operações em lote são suportadas. YES, NO
SQL_CAP Todos os recursos SQL suportados para este driver. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS Um valor de string especifica o cacheOptions preferencial.
ENABLE_EF_ADVANCED_QUERY Indica se o driver oferece suporte direto a consultas avançadas provenientes do Entity Framework. Caso contrário, as consultas serão tratadas no lado do cliente. YES, NO
PSEUDO_COLUMNS Uma matriz de cadeia de caracteres que indica as pseudocolunas disponíveis.
MERGE_ALWAYS Se o valor for verdadeiro, o modo de mesclagem será executado à força no Data Sync. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY Uma consultar de seleção para retornar a data e hora de início da replicação.
REPLICATION_MIN_FUNCTION Permite que um provedor especifique o nome da fórmula a ser usado para executar um min do lado do servidor.
REPLICATION_START_DATE Permite que um provedor especifique uma data de início de replicação.
REPLICATION_MAX_DATE_QUERY Uma consultar de seleção para retornar a data e hora de término da replicação.
REPLICATION_MAX_FUNCTION Permite que um provedor especifique o nome da fórmula a ser usado para executar um máximo do lado do servidor.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE Uma lista de tabelas que ignorará a divisão da replicação em blocos na replicação inicial.
CHECKCACHE_USE_PARENTID Indica se a instrução CheckCache deve ser executada na coluna de chave pai. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indica procedimentos armazenados* que pode ser usado para gerar arquivos de esquema.

A consultar a seguir recupera os operadores que podem ser usados na cláusula WHERE:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Observe que tabelas individuais podem ter diferentes limitações ou requisitos na cláusula WHERE; consulte o Modelo de Dados para obter mais informações.

Colunas
Nome Tipo Descrição
NAME String Um componente da sintaxe SQL ou um recurso que pode ser processado no servidor.
VALUE String Detalhes sobre a sintaxe SQL ou SQL suportada.

Sys_identity

Retorna informações sobre tentativas de modificação.

A consultar a seguir recupera os IDs das linhas modificadas em uma operação em lote:

SELECT * FROM sys_identity
Colunas
Nome Tipo Descrição
Id String O ID gerado pelo banco de dados retornado de uma operação de modificação de dados.
Batch String Um identificador para o lote. 1 para uma única operação.
Operation String O resultado da operação no lote: INSERTED, UPDATED ou DELETED.
Message String SUCCESS ou uma mensagem de erro se a atualização no lote falhou.

Propriedades de Configurações Avançadas

As propriedades de configurações avançadas são as várias opções que podem ser usadas para estabelecer uma conexão. Esta seção fornece uma lista completa das opções que você pode configurar. Clique nos links para mais detalhes.

OAuth

Propriedade Descrição
InitiateOAuth Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.
OAuthClientId O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthClientSecret O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthAccessToken O token de acesso para conexão usando OAuth.
SubscriptionKey Chave de assinatura que fornece acesso à API. Encontrado em seu perfil.
CallbackURL O URL de retorno de chamada OAuth para o qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno de chamada especificado nas configurações do aplicativo.
OAuthVerifier O código do verificador retornado da URL de autorização OAuth.
OAuthRefreshToken O token de atualização OAuth para o token de acesso OAuth correspondente.
OAuthExpiresIn O tempo de vida em segundos do OAuth AccessToken.
OAuthTokenTimestamp O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

SSL

Propriedade Descrição
SSLServerCert O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

Esquema

Propriedade Descrição
Location Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.
BrowsableSchemas Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tables=TableA, TableB, TableC.
Views Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA, ViewB, ViewC.

Diversos

Propriedade Descrição
MaxRows Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.
Other Essas propriedades ocultas são usadas apenas em casos de uso específicos.
PageSize O número de resultados a serem retornados por página de dados recuperados do Blackbaud Financial Edge NXT.
PseudoColumns Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.
Timeout O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

OAuth

Esta seção fornece uma lista completa de propriedades OAuth que você pode configurar.

Propriedade Descrição
InitiateOAuth Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.
OAuthClientId O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthClientSecret O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthAccessToken O token de acesso para conexão usando OAuth.
SubscriptionKey Chave de assinatura que fornece acesso à API. Encontrado em seu perfil.
CallbackURL O URL de retorno de chamada OAuth ao qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.
OAuthVerifier O código do verificador retornado da URL de autorização OAuth.
OAuthRefreshToken O token de atualização OAuth para o token de acesso OAuth correspondente.
OAuthExpiresIn O tempo de vida em segundos do OAuth AccessToken.
OAuthTokenTimestamp O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

InitiateOAuth

Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.

Valores Possíveis

OFF, GETANDREFRESH, REFRESH

Tipo de Dados

string

Valor Padrão

"OFF"

Observações

As seguintes opções estão disponíveis:

  1. OFF: Indica que o fluxo OAuth será tratado inteiramente pelo usuário. Um OAuthAccessToken será necessário para autenticação.
  2. GETANDREFRESH: Indica que todo o fluxo OAuth será tratado pelo conector. Se nenhum token existir atualmente, ele será obtido solicitando ao usuário por meio do navegador. Se existir um token, ele será atualizado quando aplicável.
  3. REFRESH: Indica que o conector tratará apenas da atualização do OAuthAccessToken. O usuário nunca será solicitado pelo conector a autenticar por meio do navegador. O usuário deve lidar com a obtenção do OAuthAccessToken e OAuthRefreshToken inicialmente.

OAuthClientId

O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

Como parte do registro de um aplicativo OAuth, você receberá o OAuthClientId valor, às vezes também chamado de chave do consumidor e segredo do cliente, o OAuthClientSecret.

OAuthClientSecret

O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

Como parte do registro de um aplicativo OAuth, você receberá o OAuthClientId, também chamada de chave do consumidor. Você também receberá um segredo do cliente, também chamado de segredo do consumidor. Defina o segredo do cliente no OAuthClientSecret propriedade.

OAuthAccessToken

O token de acesso para conexão usando OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

O OAuthAccessToken propriedade é usada para conectar usando OAuth. O OAuthAccessToken é recuperado do servidor OAuth como parte do processo de autenticação. Ele tem um tempo limite dependente do servidor e pode ser reutilizado entre as solicitações.

O token de acesso é usado no lugar do seu nome de usuário e senha. O token de acesso protege suas credenciais, mantendo-as no servidor.

SubscriptionKey

Chave de assinatura que fornece acesso à API. Encontrado em seu perfil.

Tipo de Dados

string

Valor Padrão

""

Observações

Chave de assinatura que fornece acesso à API. Encontrado em seu perfil.

URL de Retorno

O URL de retorno de chamada OAuth ao qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.

Tipo de Dados

string

Valor Padrão

""

Observações

Durante o processo de autenticação, o servidor de autorização OAuth redireciona o usuário para esta URL. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.

OAuthVerifier

O código do verificador retornado da URL de autorização OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

O código do verificador retornado da URL de autorização OAuth. Isso pode ser usado em sistemas em que um navegador não pode ser iniciado, como sistemas headless.

Autenticação em Máquinas Sem Cabeça

Consulte para obter o OAuthVerifier valor.

Defina OAuthSettingsLocation juntamente com OAuthVerifier. Quando você conecta, o conector troca o OAuthVerifier para os tokens de autenticação OAuth e os salva, criptografados, no arquivo especificado. Definir InitiateOAuth para GETANDREFRESH automatizar a troca.

Depois que o arquivo de configurações OAuth for gerado, você poderá remover OAuthVerifier nas propriedades de conexão e conecte-se com OAuthSettingsLocation definir.

Para atualizar automaticamente os valores do token OAuth, defina OAuthSettingsLocation e adicionalmente defina InitiateOAuth para ATUALIZAR.

OAuthRefreshToken

O token de atualização OAuth para o token de acesso OAuth correspondente.

Tipo de Dados

string

Valor Padrão

""

Observações

O OAuthRefreshToken a propriedade é usada para atualizar o OAuthAccessToken ao usar a autenticação OAuth.

OAuthExpiresIn

O tempo de vida em segundos do OAuth AccessToken.

Tipo de Dados

string

Valor Padrão

""

Observações

Emparelhe com OAuthTokenTimestamp para determinar quando o AccessToken expirará.

OAuthTokenTimestamp

O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

Tipo de Dados

string

Valor Padrão

""

Observações

Emparelhe com OAuthExpiresIn para determinar quando o AccessToken expirará.

SSL

Esta seção fornece uma lista completa de propriedades SSL que você pode configurar.

Propriedade Descrição
SSLServerCert O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

SSLServerCert

O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

Tipo de Dados

string

Valor Padrão

""

Observações

Se estiver usando uma conexão TLS/SSL, esta propriedade pode ser usada para especificar o certificado TLS/SSL a ser aceito do servidor. Qualquer outro certificado que não seja confiável para a máquina é rejeitado.

Esta propriedade pode assumir as seguintes formas:

Descrição Exemplo
Um certificado PEM completo (exemplo abreviado para concisão) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
Um caminho para um arquivo local contendo o certificado C:\cert.cer
A chave pública (exemplo abreviado para concisão) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
O Thumbprint MD5 (os valores hexadecimais também podem ser separados por espaço ou dois-pontos) ecadbdda5a1529c58a1e9e09828d70e4
A impressão digital SHA1 (os valores hexadecimais também podem ser separados por espaço ou dois-pontos) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Se não for especificado, qualquer certificado confiável pela máquina será aceito.

Os certificados são validados como confiáveis pela máquina com base no armazenamento confiável do sistema. O armazenamento confiável usado é o valor 'javax.net.ssl.trustStore' especificado para o sistema. Se nenhum valor for especificado para esta propriedade, o armazenamento confiável padrão do Java será usado (por exemplo, JAVA_HOME\lib\security\cacerts).

Use '*' para indicar a aceitação de todos os certificados. Observe que isso não é recomendado devido a questões de segurança.

Esquema

Esta seção fornece uma lista completa de propriedades de esquema que você pode configurar.

Propriedade Descrição
Location Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.
BrowsableSchemas Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tables=TableA, TableB, TableC.
Views Restringe as exibições relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA, ViewB, ViewC.

Localização

Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.

Tipo de Dados

string

Valor Padrão

"%APPDATA%\\\FinancialEdgeNXT Data Provider\\Schema"

Observações

O caminho para um diretório que contém os arquivos de esquema para o conector (arquivos .rsd para tabelas e exibições, arquivos .rsb para procedimentos armazenados). A localização da pasta pode ser um caminho relativo a partir da localização do executável. O Location a propriedade só é necessária se você quiser personalizar definições (por exemplo, alterar um nome de coluna, ignorar uma coluna e assim por diante) ou estender o modelo de dados com novas tabelas, exibições ou procedimentos armazenados.

Se não for especificado, o local padrão é "%APPDATA%\\FinancialEdgeNXT Data Provider\Schema" com %APPDATA% sendo definido para o diretório de configuração do usuário:

Plataforma %APPDATA%
Windows O valor da variável de ambiente APPDATA
Mac ~/Biblioteca/Suporte de aplicativos
Linux ~/.config

Esquemas Navegáveis

Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Tipo de Dados

string

Valor Padrão

""

Observações

Listar os esquemas de bancos de dados pode ser caro. Fornecer uma lista de esquemas na string de conexão melhora o desempenho.

Tabelas

Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tabelas=TabelaA,TabelaB,TabelaC.

Tipo de Dados

string

Valor Padrão

""

Observações

Listar as tabelas de alguns bancos de dados pode ser caro. Fornecer uma lista de tabelas na string de conexão melhora o desempenho do conector.

Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitos para trabalhar.

Especifique as tabelas que deseja em uma lista separada por vírgulas. Cada tabela deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.

Visualizações

Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA,ViewB,ViewC.

Tipo de Dados

string

Valor Padrão

""

Observações

Listar as exibições de alguns bancos de dados pode ser caro. Fornecer uma lista de exibições na string de conexão melhora o desempenho do conector.

Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitas para trabalhar.

Especifique as exibições desejadas em uma lista separada por vírgulas. Cada exibição deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.

Diversos

Esta seção fornece uma lista completa de diversas propriedades que você pode configurar.

Propriedade Descrição
MaxRows Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.
Other Essas propriedades ocultas são usadas apenas em casos de uso específicos.
PageSize O número de resultados a serem retornados por página de dados recuperados do Blackbaud Financial Edge NXT.
PseudoColumns Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.
Timeout O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

MaxRows

Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.

Tipo de Dados

int

Valor Padrão

-1

Observações

Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.

Outro

Essas propriedades ocultas são usadas apenas em casos de uso específicos.

Tipo de Dados

string

Valor Padrão

""

Observações

As propriedades listadas abaixo estão disponíveis para casos de uso específicos. Os casos de uso e a funcionalidade normais do driver não devem exigir essas propriedades.

Especifique várias propriedades em uma lista separada por ponto e vírgula.

Integração e Formatação
Propriedade Descrição
DefaultColumnSize Define o comprimento padrão dos campos de string quando a fonte de dados não fornece o comprimento da coluna nos metadados. O valor padrão é 2000. Voltar para o início
ConvertDateTimeToGMT Determina se os valores de data e hora devem ser convertidos em GMT, em vez da hora local da máquina.
RecordToFile=filename Registra a transferência de dados do soquete subjacente para o arquivo especificado.

Tamanho da Página

O número de resultados a serem retornados por página de dados recuperados do Blackbaud Financial Edge NXT.

Tipo de Dados

string

Valor Padrão

""

Observações

O tamanho da página será determinado automaticamente se você não o definir manualmente. Geralmente não é necessário definir esse valor.

Pseudocolunas

Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.

Tipo de Dados

string

Valor Padrão

""

Observações

Essa configuração é particularmente útil no Entity Framework, que não permite definir um valor para uma pseudocoluna, a menos que seja uma coluna de tabela. O valor dessa configuração de conexão está no formato "Table1=Column1, Table1=Column2, Table2=Column3". Você pode usar o caractere "*" para incluir todas as tabelas e todas as colunas; por exemplo, "*=*".

Tempo Esgotado

O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

Tipo de Dados

int

Valor Padrão

60

Observações

Se Timeout = 0, as operações não expiram. As operações são executadas até serem concluídas com êxito ou até encontrarem uma condição de erro.

Se Timeout expira e a operação ainda não está concluída, o conector lança uma exceção.