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¶

Fluxos de Caixa da Conta¶

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

Colunas¶

Códigos de Conta¶

Retorna os códigos de conta.

Colunas¶

Requisitos do Fundo da Conta¶

Retorna os requisitos para os fundos da conta.

Colunas¶

Fundos da Conta¶

Devolve os fundos da conta.

Colunas¶

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¶

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¶

Estruturas de Contas¶

Retorna uma lista de estruturas de contas.

Colunas¶

ContaFuncionamentoCapitais¶

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

Colunas¶

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¶

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¶

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¶

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¶

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¶

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¶

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¶

Orçamentos¶

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

Colunas¶

Cenários de Orçamento¶

Retorna detalhes para cada ID de cenário.

Colunas¶

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¶

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¶

Aulas¶

A lista de aulas

Colunas¶

ClientNames¶

Retorna os nomes dos tipos de cliente.

Colunas¶

Exercícios Fiscais¶

Retorna a lista de detalhes do ano fiscal.

Colunas¶

GrantCustomFields¶

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

Colunas¶

Conceder Status¶

Retorna a lista de status de concessão.

Colunas¶

GrantTypes¶

Retorna a lista de tipos de concessão.

Colunas¶

Journal Codes¶

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

Colunas¶

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¶

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¶

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¶

Tipos de Mídia¶

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

Colunas¶

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¶

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¶

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¶

ProjetoContatoMétodos¶

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

Colunas¶

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¶

Departamentos de Projeto¶

Retorna a lista de departamentos do projeto.

Colunas¶

ProjetoDivisões¶

Retorna a lista de divisões do projeto.

Colunas¶

Localizações do Projeto¶

Retorna a lista de locais do projeto.

Colunas¶

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¶

Status do Projeto¶

Retorna a lista de status do projeto.

Colunas¶

ProjectTypes¶

Retorna a lista de tipos de projeto.

Colunas¶

Códigos de Transação¶

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

Colunas¶

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¶

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¶

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¶

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¶

GetOAuthAccessToken¶

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

Entrada¶

Colunas do Conjunto de Resultados¶

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¶

Colunas do Conjunto de Resultados¶

RefreshOAuthAccessToken¶

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

Entrada¶

Colunas do Conjunto de Resultados¶

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:

• sys_catalogs: Lista os bancos de dados disponíveis.
• sys_schemas: Lista os esquemas disponíveis.
• sys_tables: Lista as tabelas e exibições disponíveis.
• sys_tablecolumns: Descreve as colunas das tabelas e exibições disponíveis.
• sys_procedures: Descreve os procedimentos armazenados disponíveis.
• sys_procedureparameters: Descreve procedimento armazenado* parâmetros.
• sys_keycolumns: Descreve as chaves primárias e estrangeiras.
• sys_indexes: Descreve os índices disponíveis.

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¶

Sys_schemas¶

Lista os esquemas disponíveis.

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

SELECT * FROM sys_schemas

Colunas¶

Sys_tables¶

Lista as tabelas disponíveis.

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

SELECT * FROM sys_tables

Colunas¶

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¶

Sys_procedures¶

Lista os procedimentos armazenados disponíveis.

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

SELECT * FROM sys_procedures

Colunas¶

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¶

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¶

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¶

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¶

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¶

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.

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¶

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¶

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

SSL

Esquema

Diversos

OAuth¶

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

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.

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:

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.

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:

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.

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¶

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.