Detalles de Conexión de Financial Edge NXT¶

Introducción¶

Versión del conector

Esta documentación se basa en la versión 21.0.8257 del conector.

Empezando¶

Compatibilidad con la versión Blackbaud Financial Edge NXT

El conector aprovecha la API Blackbaud FinancialEdge NXT SKY para permitir el acceso bidireccional a Blackbaud Financial Edge NXT.

Establecer una Conexión¶

Autenticación en Blackbaud Financial Edge NXT¶

Blackbaud Financial Edge NXT utiliza el estándar de autenticación OAuth. Blackbaud Financial Edge NXT debe estar habilitado en una cuenta de autorización para recuperar resultados.

Puede conectarse después de configurar las propiedades de conexión requeridas para sus credenciales de usuario y obtener los tokens de acceso requeridos utilizando una herramienta como Postman.

Consulte Uso de la autenticación OAuth para obtener una guía de autenticación y detalles del flujo de autenticación de OAuth.

Uso de la Autenticación OAuth¶

OAuth requiere el uso de tokens de acceso obtenidos con Postman o una herramienta similar. La autenticación OAuth es compatible como se describe en Conexión en Configurar conexiones OAuth.

Notas Importantes¶

Procedimientos Almacenados¶

• Las funciones de procedimientos almacenados descritas en esta documentación no se admiten actualmente.
• Debido a que los procedimientos almacenados no se admiten actualmente, cualquier característica que dependa de los procedimientos almacenados tampoco se admite actualmente.

Archivos de Configuración y Sus Rutas¶

• Todas las referencias a la adición de archivos de configuración y sus rutas se refieren a archivos y ubicaciones en Harmony Agente donde está instalado el conector. Estas rutas deben ajustarse según corresponda según el agente y el sistema operativo. Si se utilizan varios agentes en un grupo de agentes, se requerirán archivos idénticos en cada agente.

Características Avanzadas¶

Esta sección detalla una selección de funciones avanzadas del conector Blackbaud Financial Edge NXT.

Vistas definidas por el usuario

El conector le permite definir tablas virtuales, llamadas vistas definidas por el usuario, cuyo contenido se decide mediante una consultar preconfigurada. Estas vistas son útiles cuando no puede controlar directamente las consultas que se envían a los controladores. Consulte Vistas definidas por el usuario para obtener una descripción general de la creación y configuración de vistas personalizadas.

Configuración SSL

Usar Configuración SSL para ajustar cómo el conector maneja las negociaciones de certificados TLS/SSL. Puede elegir entre varios formatos de certificado; ver el SSLServerCert propiedad en "Opciones de cadena de conexión" para obtener más información.

Apoderado

Para configurar el conector mediante Configuración de proxy de Agente Privado, Selecciona el Use Proxy Settings casilla de verificación en la pantalla de configuración de la conexión.

Vistas Definidas por el Usuario¶

El conector Jitterbit para Blackbaud Financial Edge NXT le permite definir una tabla virtual cuyos contenidos se deciden mediante una consultar preconfigurada. Estas se denominan Vistas definidas por el usuario, que son útiles en situaciones en las que no puede controlar directamente la consultar que se envía al controlador, por ejemplo, cuando se utiliza el controlador de Jitterbit. Las vistas definidas por el usuario se pueden utilizar para definir predicados que siempre se aplican. Si especifica predicados adicionales en la consultar a la vista, se combinan con la consultar ya definida como parte de la vista.

Hay dos formas de crear vistas definidas por el usuario:

• Cree un archivo de configuración con formato JSON que defina las vistas que desea.
• Declaraciones DDL.

Definición de Vistas Utilizando un Archivo de Configuración¶

Las vistas definidas por el usuario se definen en un archivo de configuración con formato JSON llamado UserDefinedViews.json. El conector detecta automáticamente las vistas especificadas en este archivo.

También puede tener múltiples definiciones de vista y controlarlas usando UserDefinedViews propiedad de conexión. Cuando utiliza esta propiedad, el conector solo ve las vistas especificadas.

Este archivo de configuración de vista definida por el usuario tiene el siguiente formato:

• Cada elemento raíz define el nombre de una vista.
• Cada elemento raíz contiene un elemento hijo, llamado query, que contiene la consultar SQL personalizada para la vista.

Por ejemplo:

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

Utilizar el UserDefinedViews propiedad de conexión para especificar la ubicación de su archivo de configuración JSON. Por ejemplo:

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

Esquema para Vistas Definidas por el Usuario¶

Las vistas definidas por el usuario se exponen en UserViews esquema por defecto. Esto se hace para evitar que el nombre de la vista entre en conflicto con una entidad real en el modelo de datos. Puede cambiar el nombre del esquema utilizado para UserViews configurando UserViewsSchemaName propiedad.

Trabajar con Vistas Definidas por el Usuario¶

Por ejemplo, una instrucción SQL con una vista definida por el usuario llamada UserViews.RCustomers solo enumera clientes en Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

Un ejemplo de una consultar al controlador:

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

Dando como resultado la consultar efectiva a la fuente:

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

Ese es un ejemplo muy simple de una consultar a una vista definida por el usuario que es efectivamente una combinación de la consultar de vista y la definición de vista. Es posible componer estas consultas en patrones mucho más complejos. Todas las operaciones de SQL están permitidas en ambas consultas y se combinan cuando corresponde.

Configuración SSL¶

Personalización de la Configuración SSL¶

De forma predeterminada, el conector intenta negociar SSL/TLS comparando el certificado del servidor con el almacén de certificados de confianza del sistema.

Para especificar otro certificado, consulte SSLServerCert propiedad de los formatos disponibles para hacerlo.

Modelo de Datos¶

El Jitterbit Connector para Blackbaud Financial Edge NXT modela los objetos de Blackbaud Financial Edge NXT como vistas relacionales. Un objeto Blackbaud Financial Edge NXT tiene relaciones con otros objetos; en las vistas, estas relaciones se expresan a través de claves foráneas. Las siguientes secciones muestran los objetos de API disponibles y brindan más información sobre la ejecución de SQL en las APIs de Blackbaud Financial Edge NXT.

Los esquemas para la mayoría de los objetos de la base de datos se definen en archivos de configuración simples basados en texto. Para las vistas que pueden tener campos personalizados, las columnas se enumeran dinámicamente. Cuando el usuario autenticado cambie los campos personalizados para algunos objetos, se reflejarán en las vistas respectivas.

El conector descarga la mayor cantidad posible del procesamiento de sentencias SELECT a las APIs de Blackbaud Financial Edge NXT y luego procesa el resto de la consultar en la memoria. Ver SupportEnhancedSQL para obtener más información sobre cómo el conector elude las limitaciones de la API con el procesamiento del lado del cliente en memoria.

Puntos de Vista¶

Las vistas se componen de columnas y pseudocolumnas. Las vistas son similares a las tablas en la forma en que se representan los datos; sin embargo, las vistas no admiten actualizaciones. Las entidades que se representan como vistas suelen ser entidades de solo lectura. A menudo, un procedimiento almacenado* está disponible para actualizar los datos si dicha funcionalidad es aplicable a la fuente de datos.

Las consultas se pueden ejecutar contra una vista como si fuera una tabla normal, y los datos que regresan son similares en ese sentido. Para obtener más información sobre las tablas y los procedimientos almacenados, vaya a sus entradas correspondientes en este documento de ayuda.

Conector Jitterbit para Vistas Blackbaud Financial Edge NXT¶

CuentaCashflows¶

Devuelve la lista de valores de flujo de caja disponibles

Columnas¶

Códigos de Cuenta¶

Devuelve los códigos de cuenta.

Columnas¶

CuentaFondoRequisitos¶

Devuelve los requisitos para los fondos de la cuenta.

Columnas¶

CuentaFondos¶

Devuelve los fondos de la cuenta.

Columnas¶

Cuentas¶

Recuperar y consultar cuentas.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• Id admite el operador '='. Esta columna se filtra con el ID del conjunto de informes del servidor (RSID)e cuando es el único filtro especificado en los criterios.
• DateModified admite los siguientes operadores: >,>=.

Por ejemplo, las siguientes consultas se procesan en el lado del 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' 

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas¶

Segmentos de Cuenta¶

Devuelve el valor del segmento de cuenta especificado.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• SegmentId admite el operador '='. Esta es la única columna admitida.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

Select * FROM AccountSegments WHERE SegmentId = 123 

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas¶

Estructuras de Cuenta¶

Devuelve una lista de estructuras de cuenta.

Columnas¶

CuentaWorkingCapitals¶

Devuelve la lista de valores de capital de trabajo disponibles

Columnas¶

BatchValidations¶

Devuelve los resultados de la validación lote.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• BatchId admite el operador '='. Esta es la única columna admitida.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

Select * FROM BatchValidations WHERE BatchId = 123 

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas¶

PresupuestoCuentas¶

Devuelve detalles para cada período fiscal y cuenta en el escenario.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• BudgetScenarioId, AccountNumber admite el operador '='. No se admite una búsqueda en blanco.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor:

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

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas¶

PresupuestoDetalles¶

Devuelve los detalles del presupuesto especificado.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• BudgetScenarioId admite el operador '='. Esta es la única columna admitida.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

Select * FROM BudgetDetails WHERE BudgetScenarioId = 123 

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas¶

BudgetFiscalPeriods¶

Devuelve detalles de cada período fiscal en un escenario de presupuesto.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• BudgetScenarioId admite el operador '='. Esta es la única columna admitida.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

Select * FROM BudgetFiscalPeriods WHERE BudgetScenarioId = 123 

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas¶

Presupuesto Subvenciones¶

Devuelve detalles para cada período fiscal y concesión en el escenario.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• BudgetScenarioId, Grant admite el operador '='. No se admite una búsqueda en blanco.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor:

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

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas¶

LíneasPresupuestarias¶

Devuelve las líneas presupuestarias especificadas.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• BudgetScenarioId admite el operador '='. Esta es la única columna admitida.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

Select * FROM BudgetLines WHERE BudgetScenarioId = 123 

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas¶

PresupuestoProyectos¶

Devuelve detalles para cada período fiscal y proyecto en el escenario.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• BudgetScenarioId, UiProjectId admite el operador '='. No se admite una búsqueda en blanco.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor:

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

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas¶

Presupuestos¶

Devuelve una descripción general de nivel superior de cada escenario de presupuesto.

Columnas¶

PresupuestoEscenarios¶

Devuelve detalles para cada ID de escenario.

Columnas¶

CashManagementDistributionSetLineItemProjects¶

La distribución del proyecto para las partidas en los conjuntos de distribución de gestión de efectivo.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• SetId admite el operador '='. Esta es la única columna admitida.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

Select * FROM CashManagementDistributionSetLineItemProjects WHERE SetId = 123 

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas¶

CashManagementDistributionSets¶

Devuelve la lista de conjuntos de distribución de gestión de efectivo y sus partidas.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• SetId admite el operador '='. Esta es la única columna admitida.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

Select * FROM CashManagementDistributionSets WHERE SetId = 123 

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas¶

Clases¶

La lista de clases

Columnas¶

Nombres de Clientes¶

Devuelve los nombres de tipo de cliente.

Columnas¶

Años Fiscales¶

Devuelve la lista de detalles del año fiscal.

Columnas¶

GrantCustomFields¶

Devuelve la lista de opciones de campos personalizados de concesión.

Columnas¶

GrantStatuses¶

Devuelve la lista de estados de concesión.

Columnas¶

GrantTypes¶

Devuelve la lista de tipos de concesión.

Columnas¶

JournalCodes¶

Devuelve la lista de todos los códigos de diario disponibles.

Columnas¶

Entradas de Diario¶

Recuperar y consultar entradas de diario.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• BatchId admite el operador '='. Esta es la única columna admitida.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

Select * FROM JournalEntries WHERE BatchId = 123 

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas¶

Lotes de Entrada de Diario¶

Devuelve la lista de lotes de entradas de diario.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• BatchId admite el operador '='. Esta columna se filtra con el ID del conjunto de informes del servidor (RSID)e cuando es el único filtro especificado en los criterios.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

Select * FROM JournalEntryBatches WHERE BatchId = 123

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas¶

Libro Mayorresúmenes¶

Enumera los resúmenes del libro mayor para el año fiscal y los criterios especificados. Tenga en cuenta que los registros de resumen solo existen para ejercicios cerrados y optimizados. Si se produce alguna actividad en un período fiscal que no se ha cerrado y optimizado desde entonces, no se incluirá en los registros de resumen del libro mayor.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• FiscalYearId, AccountNumber y UiProjectId admite el operador '='. No se admite una búsqueda en blanco.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

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

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas¶

Tipos de Medios¶

Devuelve una lista de opciones de tipo de medio.

Columnas¶

PeríodoResúmenes¶

Una vez que se completa el proceso de resumen, así es como se devuelven los datos.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• FiscalYear, FiscalPeriod, AccountNumber y UiProjectId admite el operador '='. No se admite una búsqueda en blanco.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

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

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas¶

PeríodoResúmenesProcesamientoInfo¶

Este extremo informa sobre el estado actual de la solicitud de resumen, ya sea que esté completa, aún en ejecución o fallida.

Columnas¶

Archivos Adjuntos del Proyecto¶

Devuelve la lista de archivos adjuntos para el proyecto especificado.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• ProjectId admite el operador '='. Esta columna es necesaria para obtener los archivos adjuntos del proyecto.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor:

SELECT * FROM ProjectAttachments WHERE ProjectId = 1

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas¶

Métodos de Contacto del Proyecto¶

Dirección de información de contactos para proyectos.

Columnas¶

ProyectoContactos¶

Los contactos para un proyecto.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• ProjectId admite el operador '='. Esta columna es el único filtro admitido.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

SELECT * FROM ProjectContacts WHERE ProjectId = 1 

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas¶

ProyectoDepartamentos¶

Devuelve la lista de departamentos del proyecto.

Columnas¶

ProyectoDivisiones¶

Devuelve la lista de divisiones del proyecto.

Columnas¶

ProyectoUbicaciones¶

Devuelve la lista de ubicaciones del proyecto.

Columnas¶

Proyectos¶

Recuperar y consultar proyectos.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• ProjectId admite el operador '='. Esta columna se filtra con el ID del conjunto de informes del servidor (RSID)e cuando es el único filtro especificado en los criterios.
• Location,Type,Division y Department admite el operador '='. No se admite una búsqueda en blanco.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor:

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

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas¶

Estados del Proyecto¶

Devuelve la lista de estados del proyecto.

Columnas¶

Tipos de Proyectos¶

Devuelve la lista de tipos de proyectos.

Columnas¶

Códigos de Transacción¶

Devuelve la lista de todos los códigos de transacción disponibles.

Columnas¶

Valores de Código de Transacción¶

Devuelve la lista de todos los valores para el código de transacción especificado.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• TransactionCodeId admite el operador '='. Esta columna es el único filtro admitido.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

SELECT * FROM TransactionCodeValues WHERE TransactionCodeId = 1 

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas¶

Distribuciones de Transacciones¶

Devuelve una lista de transacciones que coinciden con los criterios de búsqueda.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• BatchId, AccountNumber, UiProjectId, TypeCode, Encumbrance, Journal, y PostStatus admite el operador '='. No se admite una búsqueda en blanco.
• PostDate admite los siguientes operadores: <,<=,=,>=,>.
• DateModified admite los siguientes operadores: >,>=.

Por ejemplo, las siguientes consultas se procesan en el lado del 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'

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas¶

TransactionDistributionSetsTransactionDistributionSets¶

Devuelve la lista de conjuntos de distribución de transacciones.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• SetId admite el operador '='. Esta columna es el único filtro admitido.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

SELECT * FROM TransactionDistributionSets WHERE SetId = 1 

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas¶

Procedimientos Almacenados¶

Procedimientos almacenados* están disponibles para complementar los datos disponibles del Modelo de datos. Puede ser necesario actualizar los datos disponibles desde una vista usando un procedimiento almacenado* porque los datos no proporcionan actualizaciones bidireccionales directas, similares a tablas. En estas situaciones, la recuperación de los datos se realiza utilizando la vista o tabla adecuada, mientras que la actualización se realiza llamando a un procedimiento almacenado. Procedimientos almacenados* toman una lista de parámetros y devuelven un conjunto de datos que contiene la colección de tuplas que constituyen la respuesta.

Conector Jitterbit para Procedimientos Almacenados Blackbaud Financial Edge NXT¶

Obtener Token de Acceso de OAuth¶

Obtiene un token de autenticación de Blackbaud Financial Edge NXT.

Aporte¶

Columnas del Conjunto de Resultados¶

Obtener URL de Autorización de OAuth¶

Obtiene la URL de autorización que el usuario debe abrir por separado para otorgar acceso a su aplicación. Solo se necesita al desarrollar aplicaciones web. Solicitará el token de autenticación de esta URL.

Aporte¶

Columnas del Conjunto de Resultados¶

RefreshOAuthAccessToken¶

Actualiza el token de acceso de OAuth utilizado para la autenticación con Blackbaud Financial Edge NXT.

Aporte¶

Columnas del Conjunto de Resultados¶

Tablas del Sistema¶

Puede consultar las tablas del sistema que se describen en esta sección para acceder a la información del esquema, la información sobre la funcionalidad del origen de datos y las estadísticas de operación lote.

Tablas de Esquema¶

Las siguientes tablas devuelven metadatos de la base de datos para Blackbaud Financial Edge NXT:

• sys_catalogs: enumera las bases de datos disponibles.
• sys_schemas: enumera los esquemas disponibles.
• sys_tablas: enumera las tablas y vistas disponibles.
• sys_tablecolumns: Describe las columnas de las tablas y vistas disponibles.
• procedimientos_sys: describe los procedimientos almacenados disponibles.
• parámetros_procedimiento_sys: Describe procedimiento almacenado* parámetros.
• sys_keycolumns: describe las claves principal y externa.
• índices_sys: Describe los índices disponibles.

Tablas de Fuentes de Datos¶

Las siguientes tablas devuelven información sobre cómo conectarse y consultar la fuente de datos:

• sys_connection_props: Devuelve información sobre las propiedades de conexión disponibles.
• sys_sqlinfo: describe las consultas SELECT que el conector puede descargar al origen de datos.

Tablas de Información de Consulta¶

La siguiente tabla devuelve estadísticas de consultar para consultas de modificación de datos:

• identidad_sys: devuelve información sobre operaciones lote o actualizaciones individuales.

Sys_catalogs¶

Enumera las bases de datos disponibles.

La siguiente consultar recupera todas las bases de datos determinadas por la cadena de conexión:

SELECT * FROM sys_catalogs

Columnas¶

Sys_schemas¶

Enumera los esquemas disponibles.

La siguiente consultar recupera todos los esquemas disponibles:

SELECT * FROM sys_schemas

Columnas¶

Sys_tables¶

Enumera las tablas disponibles.

La siguiente consultar recupera las tablas y vistas disponibles:

SELECT * FROM sys_tables

Columnas¶

Sys_tablecolumns¶

Describe las columnas de las tablas y vistas disponibles.

La siguiente consultar devuelve las columnas y los tipos de datos de la tabla Cuentas:

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

Columnas¶

Sys_procedimientos¶

Enumera los procedimientos almacenados disponibles.

La siguiente consultar recupera los procedimientos almacenados disponibles:

SELECT * FROM sys_procedures

Columnas¶

Sys_procedureparameters¶

Describe procedimiento almacenado* parámetros.

La siguiente consultar devuelve información sobre todos los parámetros de entrada para el procedimiento almacenado SelectEntries:

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

Columnas¶

Sys_keycolumns¶

Describe las claves primarias y foráneas. La siguiente consultar recupera la clave principal de la tabla Cuentas:

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

Columnas¶

Sys_foreignkeys¶

Describe las claves foráneas. La siguiente consultar recupera todas las claves foráneas que hacen referencia a otras tablas:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columnas¶

Sys_indexes¶

Describe los índices disponibles. Al filtrar en los índices, puede escribir consultas más selectivas con tiempos de respuesta de consultar más rápidos.

La siguiente consultar recupera todos los índices que no son claves principales:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columnas¶

Sys_connection_props¶

Devuelve información sobre las propiedades de conexión disponibles y las establecidas en la cadena de conexión.

Al consultar esta tabla, se debe usar la cadena de conexión de configuración:

jdbc:cdata:financialedgenxt:config:

Esta cadena de conexión le permite consultar esta tabla sin una conexión válida.

La siguiente consultar recupera todas las propiedades de conexión que se han establecido en la cadena de conexión o se han establecido a través de un valor predeterminado:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columnas¶

Sys_sqlinfo¶

Describe el procesamiento de consultar SELECT que el conector puede descargar al origen de datos.

Procesamiento Colaborativo de Consultas¶

Al trabajar con fuentes de datos que no admiten SQL-92, puede consultar la vista sys_sqlinfo para determinar las capacidades de consultar de las APIs subyacentes, expresadas en sintaxis SQL. El conector descarga la mayor cantidad posible del procesamiento de sentencias SELECT al servidor y luego procesa el resto de la consultar en la memoria.

Descubrimiento de las Capacidades SELECT de la Fuente de Datos¶

A continuación se muestra un conjunto de datos de ejemplo de las capacidades de SQL. El siguiente conjunto de resultados indica la funcionalidad SELECT que el conector puede descargar en el origen de datos o en el lado del cliente del proceso. Su fuente de datos puede admitir sintaxis SQL adicional. Algunos aspectos de la funcionalidad SELECT se devuelven en una lista separada por comas si es compatible; de lo contrario, la columna contiene NO.

La siguiente consultar recupera los operadores que se pueden usar en la cláusula WHERE:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Tenga en cuenta que las tablas individuales pueden tener diferentes limitaciones o requisitos en la cláusula WHERE; consulte el Modelo de datos para obtener más información.

Columnas¶

Sys_identidad¶

Devuelve información sobre los intentos de modificación.

La siguiente consultar recupera los Id. de las filas modificadas en una operación lote:

SELECT * FROM sys_identity

Columnas¶

Propiedades de Configuraciones Avanzadas¶

Las propiedades de configuraciones avanzadas son las diversas opciones que se pueden utilizar para establecer una conexión. Esta sección proporciona una lista completa de las opciones que puede configurar. Haga clic en los enlaces para obtener más detalles.

OAuth

SSL

Esquema

Misceláneas

OAuth¶

Esta sección proporciona una lista completa de las propiedades de OAuth que puede configurar.

Iniciar OAuth¶

Establezca esta propiedad para iniciar el proceso para obtener o actualizar el token de acceso de OAuth cuando se conecte.

Valores Posibles¶

OFF, GETANDREFRESH, REFRESH

Tipo de Datos¶

string

Valor por Defecto¶

"OFF"

Observaciones¶

Las siguientes opciones están disponibles:

1. OFF: Indica que el flujo de OAuth será manejado en su totalidad por el usuario. Se requerirá un OAuthAccessToken para la autenticación.
2. GETANDREFRESH: indica que el conector manejará todo el flujo de OAuth. Si actualmente no existe ningún token, se obtendrá solicitándolo al usuario a través del navegador. Si existe un token, se actualizará cuando corresponda.
3. REFRESH: indica que el conector solo manejará la actualización de OAuthAccessToken. El conector nunca le pedirá al usuario que se autentique a través del navegador. El usuario debe manejar la obtención de OAuthAccessToken y OAuthRefreshToken inicialmente.

OAuthClientId¶

El ID de cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Como parte del registro de una aplicación OAuth, recibirá el OAuthClientId valor, a veces también llamado clave de consumidor, y un secreto de cliente, el OAuthClientSecret.

OAuthClientSecretOAuthClientSecret¶

El secreto del cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Como parte del registro de una aplicación OAuth, recibirá el OAuthClientId, también denominada clave de consumidor. También recibirá un secreto de cliente, también llamado secreto de consumidor. Establezca el secreto del cliente en OAuthClientSecret propiedad.

Token de Acceso de OAuth¶

El token de acceso para conectarse mediante OAuth.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

El OAuthAccessToken la propiedad se usa para conectarse usando OAuth. El OAuthAccessToken se recupera del servidor OAuth como parte del proceso de autenticación. Tiene un tiempo de espera dependiente del servidor y se puede reutilizar entre solicitudes.

El token de acceso se utiliza en lugar de su nombre de usuario y contraseña. El token de acceso protege sus credenciales manteniéndolas en el servidor.

Clave de Suscripción¶

Clave de suscripción que proporciona acceso a la API. Encontrado en tu perfil.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Clave de suscripción que proporciona acceso a la API. Encontrado en tu perfil.

URL de Devolución de Llamada¶

La URL de devolución de llamada de OAuth a la que volver cuando se autentica. Este valor debe coincidir con la URL de devolución de llamada que especifica en la configuración de su aplicación.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Durante el proceso de autenticación, el servidor de autorización de OAuth redirige al usuario a esta URL. Este valor debe coincidir con la URL de devolución de llamada que especifica en la configuración de su aplicación.

OAuthVerifier¶

El código verificador devuelto desde la URL de autorización de OAuth.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

El código verificador devuelto desde la URL de autorización de OAuth. Esto se puede usar en sistemas en los que no se puede iniciar un navegador, como los sistemas sin cabeza.

Autenticación en Máquinas Sin Cabeza¶

Ver para obtener el OAuthVerifier valor.

Establezca OAuthSettingsLocation junto con OAuthVerifier. Cuando se conecta, el conector intercambia el OAuthVerifier para los tokens de autenticación de OAuth y los guarda, encriptados, en el archivo especificado. Establecer Iniciar OAuth para GETANDREFRESH automatizar el intercambio.

Una vez que se haya generado el archivo de configuración de OAuth, puede eliminar OAuthVerifier desde las propiedades de conexión y conéctese con OAuthSettingsLocation colocar.

Para actualizar automáticamente los valores del token de OAuth, establezca OAuthSettingsLocation y además configure InitiateOAuth refrescar.

OAuthRefreshToken¶

El token de actualización de OAuth para el token de acceso de OAuth correspondiente.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

El OAuthRefreshToken la propiedad se usa para actualizar el OAuthAccessToken al usar la autenticación OAuth.

OAuthExpiresIn¶

La vida útil en segundos del AccessToken de OAuth.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Empareje con OAuthTokenTimestamp para determinar cuándo caducará el AccessToken.

OAuthTokenTimestamp¶

La marca de tiempo de la época de Unix en milisegundos cuando se creó el token de acceso actual.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Emparéjese con OAuthExpiresIn para determinar cuándo expirará AccessToken.

SSL¶

Esta sección proporciona una lista completa de las propiedades SSL que puede configurar.

SSLServerCert¶

El certificado que se aceptará del servidor al conectarse mediante TLS/SSL.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Si usa una conexión TLS/SSL, esta propiedad se puede usar para especificar el certificado TLS/SSL que se aceptará del servidor. Se rechaza cualquier otro certificado que no sea de confianza para la máquina.

Esta propiedad puede tomar las siguientes formas:

Si no se especifica, se acepta cualquier certificado en el que confíe la máquina.

La máquina valida los certificados como confiables según el almacén de confianza del sistema. El almacén de confianza utilizado es el valor 'javax.net.ssl.trustStore' especificado para el sistema. Si no se especifica ningún valor para esta propiedad, se utiliza el almacén de confianza predeterminado de Java (por ejemplo, JAVA_HOME\lib\security\cacerts).

Use '*' para indicar que acepta todos los certificados. Tenga en cuenta que esto no se recomienda debido a problemas de seguridad.

Esquema¶

Esta sección proporciona una lista completa de propiedades de esquema que puede configurar.

Ubicación¶

Una ruta al directorio que contiene los archivos de esquema que definen tablas, vistas y procedimientos almacenados.

Tipo de Datos¶

string

Valor por Defecto¶

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

Observaciones¶

La ruta a un directorio que contiene los archivos de esquema para el conector (archivos .rsd para tablas y vistas, archivos .rsb para procedimientos almacenados). La ubicación de la carpeta puede ser una ruta relativa desde la ubicación del ejecutable. El Location La propiedad solo es necesaria si desea personalizar las definiciones (por ejemplo, cambiar el nombre de una columna, ignorar una columna, etc.) o ampliar el modelo de datos con nuevas tablas, vistas o procedimientos almacenados.

Si no se especifica, la ubicación predeterminada es "%APPDATA%\\FinancialEdgeNXT Data Provider\Schema" con %APPDATA% estando configurado en el directorio de configuración del usuario:

Esquemas Navegables¶

Esta propiedad restringe los esquemas informados a un subconjunto de los esquemas disponibles. Por ejemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Enumerar los esquemas de las bases de datos puede resultar costoso. Proporcionar una lista de esquemas en la cadena de conexión mejora el rendimiento.

Mesas¶

Esta propiedad restringe las tablas notificadas a un subconjunto de las tablas disponibles. Por ejemplo, Tablas=TablaA,TablaB,TablaC.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Listar las tablas de algunas bases de datos puede resultar costoso. Proporcionar una lista de tablas en la cadena de conexión mejora el rendimiento del conector.

Esta propiedad también se puede utilizar como una alternativa a la lista automática de vistas si ya sabe con cuáles quiere trabajar y, de lo contrario, habría demasiadas para trabajar.

Especifique las tablas que desea en una lista separada por comas. Cada tabla debe ser un identificador SQL válido con cualquier carácter especial escapado usando corchetes, comillas dobles o acentos graves. Por ejemplo, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Tenga en cuenta que al conectarse a una fuente de datos con varios esquemas o catálogos, deberá proporcionar el nombre completo de la tabla en esta propiedad, como en el último ejemplo aquí, para evitar la ambigüedad entre las tablas que existen en varios catálogos o esquemas.

Puntos de Vista¶

Restringe las vistas informadas a un subconjunto de las tablas disponibles. Por ejemplo, Vistas=VistaA,VistaB,VistaC.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Listar las vistas de algunas bases de datos puede ser costoso. Proporcionar una lista de vistas en la cadena de conexión mejora el rendimiento del conector.

Esta propiedad también se puede utilizar como una alternativa a la lista automática de vistas si ya sabe con cuáles quiere trabajar y, de lo contrario, habría demasiadas para trabajar.

Especifique las vistas que desee en una lista separada por comas. Cada vista debe ser un identificador SQL válido con cualquier carácter especial escapado usando corchetes, comillas dobles o acentos graves. Por ejemplo, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Tenga en cuenta que al conectarse a una fuente de datos con varios esquemas o catálogos, deberá proporcionar el nombre completo de la tabla en esta propiedad, como en el último ejemplo aquí, para evitar la ambigüedad entre las tablas que existen en varios catálogos o esquemas.

Misceláneas¶

Esta sección proporciona una lista completa de propiedades misceláneas que puede configurar.

Filas Máximas¶

Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño.

Tipo de Datos¶

int

Valor por Defecto¶

-1

Observaciones¶

Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño.

Otro¶

Estas propiedades ocultas se usan solo en casos de uso específicos.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Las propiedades enumeradas a continuación están disponibles para casos de uso específicos. Los casos de uso y la funcionalidad normales del controlador no deberían requerir estas propiedades.

Especifique varias propiedades en una lista separada por punto y coma.

Integración y Formateo¶

Tamaño de Página¶

El número de resultados a devolver por página de datos recuperados de Blackbaud Financial Edge NXT.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

El tamaño de la página se determinará automáticamente si no lo configura manualmente. Por lo general, no es necesario establecer nunca este valor.

Pseudocolumnas¶

Esta propiedad indica si incluir o no pseudocolumnas como columnas en la tabla.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Esta configuración es particularmente útil en Entity Framework, que no le permite establecer un valor para una pseudocolumna a menos que sea una columna de tabla. El valor de esta configuración de conexión tiene el formato "Tabla1=Columna1, Tabla1=Columna2, Tabla2=Columna3". Puede usar el carácter "*" para incluir todas las tablas y todas las columnas; por ejemplo, "*=*".

Se Acabó el Tiempo¶

El valor en segundos hasta que se lanza el error de tiempo de espera, cancelando la operación.

Tipo de Datos¶

int

Valor por Defecto¶

60

Observaciones¶

Si Timeout = 0, las operaciones no expiran. Las operaciones se ejecutan hasta que se completan correctamente o hasta que encuentran una condición de error.

Si Timeout caduca y la operación aún no se ha completado, el conector genera una excepción.