Saltar al contenido

Detalles de Conexión de Sage 300

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

El conector aprovecha la API de Sage 300 para habilitar el acceso bidireccional a Sage 300.

Establecer una Conexión

Antes de Autenticar

Sage 300 requiere una configuración inicial para comunicarse a través de la API web de Sage 300. El usuario conectado debe tener acceso API a uno o todos los módulos de la instancia de Sage300. En Sage300 a un usuario se le asigna un grupo de seguridad. Un grupo de seguridad es un conjunto de permisos para cada módulo. Se recomienda que utilice un usuario diferente al ADMIN usuario para acceder a la API. El ADMIN el usuario tiene un par de pasos adicionales para obtener acceso a la API. Siga los pasos a continuación para obtener acceso a la API.

Crear un Usuario

Omita este paso si ya ha creado un nuevo usuario o desea utilizar una cuenta existente.

  • Abra la aplicación de escritorio Sage300 que se incluye en la instalación de Sage300. Inicie sesión con el ADMIN cuenta.
  • Ir a Administrative Services -> Users
  • Complete la información requerida y haga clic en Add
Configuración del Grupo de Seguridad
  • Abra la aplicación de escritorio Sage300 que se incluye en la instalación de Sage300. Inicie sesión con el ADMIN cuenta.
  • Ir a Administrative Services -> Security Groups
  • En el Application encontrarás todos los módulos de Sage300. El Group ID representa el grupo de seguridad que desea modificar. A continuación encontrará una lista de permisos que puede consultar.
  • (Opcional) Crear un nuevo Security Group llena la Group ID, Group Description y verifique cualquiera de los permisos, incluido el Sage 300 Web API permiso. Por último, haga clic en Add(por cada aplicación requerida)
  • O seleccione uno existente Security Group vas a asignar al Usuario bajo Group ID y comprobar el Sage 300 Web API permiso al final de los permisos (por cada aplicación requerida).
Asignación de un Grupo de Seguridad
  • Abra la aplicación de escritorio Sage300 que se incluye en la instalación de Sage300. Inicie sesión con el ADMIN cuenta.
  • Ir a Administrative Services -> User Authorization
  • Bajo User ID seleccione su nuevo/existente User
  • Ahora para cada Application asignar el Group ID que creaste/modificaste
  • Una vez realizado el acceso del usuario, asegúrese de que tenga acceso a la API web. Cree una URL para probar el acceso a la API web de Sage 300 de la siguiente manera: **https://{servidor}/Sage300WebApi/**, reemplazando {server} con la URL de su instancia de Sage300.

Conexión a Sage 300

El Jitterbit Connector para Sage 300 se comunica con Sage 300 a través de la API de OData. Puede autenticarse en Sage 300 mediante la autenticación básica.

Conectar Mediante Autenticación Básica

Debe proporcionar valores para las siguientes propiedades para autenticarse correctamente en Sage 300. Tenga en cuenta que el proveedor reutilizará la sesión abierta por Sage 300 utilizando cookies.

Esto significa que sus credenciales se utilizarán solo en la primera solicitud para abrir la sesión. Después de eso, las cookies devueltas por Sage 300 se utilizarán para la autenticación.

  • URL: establezca esto en la URL del servidor que aloja Sage 300. Construya una URL para la API web de Sage 300 de la siguiente manera: {protocolo}://{ruta-de-la-aplicación-del-host}/v{versión}/{inquilino}/
    Por ejemplo: http://localhost/Sage300WebApi/v1.0/-/.
  • User: establezca esto en el nombre de usuario de su cuenta.
  • Password: Establézcalo en la contraseña de su cuenta.

Ajuste Fino del Acceso a los Datos

Ajuste Fino del Acceso a Datos

Puede usar las siguientes propiedades para obtener más control sobre los datos devueltos por Sage 300:

  • Company: Especifique la empresa de la que desea obtener datos. Si no se especifica, la primera empresa encontrada en el /Companies se elegirá el extremo.
  • Modules: use esta propiedad de conexión para limitar la recuperación de metadatos solo a los módulos deseados. Esto mejorará el rendimiento de los metadatos recuperados.
  • IncludeCustomFields: Establézcalo en verdadero para enumerar los campos personalizados como columnas de la tabla.

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 Sage 300.

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 Sage 300 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 Usando 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 OEInvoices 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

Descripción general

El conector Jitterbit para Sage 300 modela los objetos de Sage 300 como tablas y vistas relacionales. Un objeto Sage 300 tiene relaciones con otros objetos; en las tablas, estas relaciones se expresan a través de claves foráneas.

Características clave

  • El conector modela las entidades de Sage 300 como tablas y vistas relacionales, lo que le permite escribir SQL para consultar los datos de Sage 300.
  • Procedimientos almacenados* le permiten ejecutar operaciones a Sage 300.
  • La conectividad en vivo con estos objetos significa que cualquier cambio en su cuenta de Sage 300 se refleja de inmediato al usar el conector.

Mesas

Las tablas se recuperan dinámicamente de la cuenta Sage 300 autenticada.

Mesas Infantiles

También se recuperan las tablas secundarias, que contienen objetos secundarios de sus padres. Por ejemplo, OEOrders tiene OEOrders_OrderCommentsInstructions y OEOrders_OrderDetails como sus tablas secundarias. Estas tablas se exponen como columnas agregadas al consultar su tabla principal. También tienen referencias al identificador único de su padre.

Puntos de vista

Las vistas de solo lectura se recuperan dinámicamente de la cuenta Sage 300 autenticada.

Procedimientos almacenados

NOTE: Los procedimientos almacenados no se admiten actualmente. Consulte la nota anterior para detalles.

Procedimientos almacenados son interfaces similares a funciones para Sage 300. Procedimientos almacenados* le permiten ejecutar operaciones a Sage 300.

Procesamiento colaborativo de consultas

El conector descarga la mayor parte posible del procesamiento de sentencias SELECT a Sage 300 y luego procesa el resto de la consultar en la memoria. Las limitaciones y los requisitos de la API también se documentan en esta sección.

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.

Las declaraciones SELECT para las tablas principales se admiten principalmente en el lado del servidor. Por ejemplo:

SELECT * FROM APInvoiceBatches WHERE BatchDate='2019-01-09 01:00:00.0'

se ejecutará del lado del servidor.

Nota: Al ejecutar sentencias SELECT en tablas secundarias, todo se procesa del lado del cliente.

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 de Sage 300

Nombre Descripción
APCreateGLBatch Información de uso para la operación APCreateGLBatch.rsb.
APCreateRecurringPayableBatch Información de uso para la operación APCreateRecurringPayableBatch.rsb.
APCreateRetainageDocumentBatch Información de uso para la operación APCreateRetainageDocumentBatch.rsb.
APDeleteInactiveRecords Información de uso para la operación APDeleteInactiveRecords.rsb.
APPostInvoices Información de uso para la operación APPostInvoices.rsb.
APPostPaymentsAndAdjustments Información de uso para la operación APPostPaymentsAndAdjustments.rsb.
ARCreateGLBatch Información de uso para la operación ARCreateGLBatch.rsb.
ARCreateRecurringCharge Información de uso para la operación ARCreateRecurringCharge.rsb.
ARCreateRetainageDocumentBatch Información de uso para la operación ARCreateRetainageDocumentBatch.rsb.
ARPostInvoices Información de uso para la operación ARPostInvoices.rsb.
ARPostReceiptsAndAdjustments Información de uso para la operación ARPostReceiptsAndAdjustments.rsb.
ARPostRefunds Información de uso para la operación ARPostRefunds.rsb.
CreateSchema Crea un archivo de esquema para la tabla o vista especificada.
GLPostJournal Información de uso para la operación GLPostJournal.rsb.
ICCreateGLBatch Información de uso para la operación ICCreateGLBatch.rsb.
ICDayEndProcessing Información de uso para la operación ICDayEndProcessing.rsb.
POCreateBatch Información de uso para la operación POCreateBatch.rsb.
PODayEndProcessing Información de uso para la operación PODayEndProcessing.rsb.

APCreateGLBatch

Información de uso para la operación APCreateGLBatch.rsb.

Aporte
Nombre Tipo Obligatorio Descripción
ProcessPaymentBatch String Falso Valores posibles: DoNotPostPaymentBatches, PostPaymentBatches
ThruPaymentPostingSequenceNumber String Falso Valores posibles: Número decimal
ProcessInvoiceBatch String Falso Valores posibles: DoNotPostInvoiceBatches, PostInvoiceBatches
ThruInvoicePostingSequenceNumber String Falso Valores posibles: Número decimal
ProcessAdjustmentBatch String Falso Valores posibles: DoNotPostAdjustmentBatches, PostAdjustmentBatches
ThruAdjustmentPostingSequenceNumber String Falso Valores posibles: Número decimal
ProcessRevalueBatch String Falso Valores posibles: DoNotPostRevaluaciónBatches, PostRevaluaciónBatches
ThruRevaluePostingSequenceNumber String Falso Valores posibles: Número decimal
ActionSelector String Falso Valores posibles: Texto de cadena
UpdateOperation String Falso Valores posibles: Sin especificar, Actualizar, Insertar, Eliminar
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
Success String Este valor muestra una indicación booleana de si la operación fue exitosa o no.

APCreateRecurringPayableBatch

Información de uso para la operación APCreateRecurringPayableBatch.rsb.

Aporte
Nombre Tipo Obligatorio Descripción
RunDate String Falso Valores posibles: Fecha y hora
Mode String Falso Valores posibles: Número entero
SelectRecordsBy String Falso Valores posibles: RecurringPayableCode, VendorNumber, VendorGroup, ScheduleLink, SpecificRecurringChargeCode
StartingRecurringPayableCode String Falso Valores posibles: Texto de cadena
EndingRecurringPayableCode String Falso Valores posibles: Texto de cadena
StartingVendorNumber String Falso Valores posibles: Texto de cadena
EndingVendorNumber String Falso Valores posibles: Texto de cadena
StartingVendorGroupCode String Falso Valores posibles: Texto de cadena
EndingVendorGroupCode String Falso Valores posibles: Texto de cadena
ScheduleKey String Falso Valores posibles: Texto de cadena
ScheduleLink String Falso Valores posibles: Número decimal
Status String Falso Valores posibles: Número entero
DateGenerationMethod String Falso Valores posibles: RunDate, NextScheduleDate, SpecificDate
BatchGenerationMethod String Falso Valores posibles: Predeterminado, CreateaNewBatch, AddToanExistingBatch
ForcedInvoiceDate String Falso Valores posibles: fecha y hora
AppendToBatchNumber String Falso Valores posibles: Número decimal
ActionSelector String Falso Valores posibles: Texto de cadena
UpdateOperation String Falso Valores posibles: Sin especificar, Actualizar, Insertar, Eliminar
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
Success String Este valor muestra una indicación booleana de si la operación fue exitosa o no.

APCreateRetainageDocumentBatch

Información de uso para la operación APCreateRetainageDocumentBatch.rsb.

Aporte
Nombre Tipo Obligatorio Descripción
RunDate String Falso Valores posibles: fecha y hora
Mode String Falso Valores posibles: Número entero
SelectRecordsBy String Falso Valores posibles: VendorNumber, DocumentNumber, VendorGroup
StartingDocumentNumber String Falso Valores posibles: Texto de cadena
EndingDocumentNumber String Falso Valores posibles: Texto de cadena
StartingVendorNumber String Falso Valores posibles: Texto de cadena
EndingVendorNumber String Falso Valores posibles: Texto de cadena
StartingVendorGroupCode String Falso Valores posibles: Texto de cadena
EndingVendorGroupCode String Falso Valores posibles: Texto de cadena
IncludeInvoice String Falso Valores posibles: Sí, No
IncludeDebitNote String Falso Valores posibles: Sí, No
IncludeCreditNote String Falso Valores posibles: Sí, No
DaysBeforeRetainageDue String Falso Valores posibles: Número entero
CommandCode String Falso Valores posibles: UserRun, ScheduledRun
Status String Falso Valores posibles: Número entero
ActionSelector String Falso Valores posibles: Texto de cadena
UpdateOperation String Falso Valores posibles: Sin especificar, Actualizar, Insertar, Eliminar
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
Success String Este valor muestra una indicación booleana de si la operación fue exitosa o no.

APDeleteInactiveRecords

Información de uso para la operación APDeleteInactiveRecords.rsb.

Aporte
Nombre Tipo Obligatorio Descripción
ClearFromVendorNumber String Falso Valores posibles: Texto de cadena
ClearThruVendorNumber String Falso Valores posibles: Texto de cadena
ClearFromGroupCode String Falso Valores posibles: Texto de cadena
ClearThruGroupCode String Falso Valores posibles: Texto de cadena
ClearRemitToFromVendorNumber String Falso Valores posibles: Texto de cadena
ClearRemitToThruVendorNumber String Falso Valores posibles: Texto de cadena
ClearFromDate String Falso Valores posibles: Fecha y hora
ClearThruDate String Falso Valores posibles: Fecha y hora
ClearInactiveVendors String Falso Valores posibles: Sí, No
ClearInactiveGroups String Falso Valores posibles: Sí, No
ClearInactiveRemitToLocation String Falso Valores posibles: Sí, No
ClearInactiveRecurringPayable String Falso Valores posibles: Sí, No
ClearFromRecurringPayable String Falso Valores posibles: Texto de cadena
ClearThruRecurringPayable String Falso Valores posibles: Texto de cadena
ActionSelector String Falso Valores posibles: Texto de cadena
UpdateOperation String Falso Valores posibles: Sin especificar, Actualizar, Insertar, Eliminar
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
Success String Este valor muestra una indicación booleana de si la operación fue exitosa o no.

APPostFacturas

Información de uso para la operación APPostInvoices.rsb.

Aporte
Nombre Tipo Obligatorio Descripción
ProcessAllBatches String Falso Valores posibles: Donotpostallbatches, Postallbatches
FromBatch String Falso Valores posibles: Número decimal
ToBatch String Falso Valores posibles: Número decimal
ActionSelector String Falso Valores posibles: Texto de cadena
UpdateOperation String Falso Valores posibles: Sin especificar, Actualizar, Insertar, Eliminar
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
Success String Este valor muestra una indicación booleana de si la operación fue exitosa o no.

APPostPagosYAjustes

Información de uso para la operación APPostPaymentsAndAdjustments.rsb.

Aporte
Nombre Tipo Obligatorio Descripción
BatchType String Falso Valores posibles: Texto de cadena
PostAllBatches String Falso Valores posibles: Donotpostallbatches, Postallbatches
PostBatchFrom String Falso Valores posibles: Número decimal
PostBatchTo String Falso Valores posibles: Número decimal
ActionSelector String Falso Valores posibles: Texto de cadena
UpdateOperation String Falso Valores posibles: Sin especificar, Actualizar, Insertar, Eliminar
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
Success String Este valor muestra una indicación booleana de si la operación fue exitosa o no.

ARCreateGLBatch

Información de uso para la operación ARCreateGLBatch.rsb.

Aporte
Nombre Tipo Obligatorio Descripción
ProcessReceiptBatch String Falso Valores posibles: DonotpostCashbatches, PostCashbatches
ReceiptThroughPostingSequenceNumber String Falso Valores posibles: Número decimal
ProcessInvoiceBatch String Falso Valores posibles: DonotpostInvoicebatches, PostInvoicebatches
InvoiceThroughPostingSequenceNumber String Falso Valores posibles: Número decimal
ProcessAdjustmentBatch String Falso Valores posibles: DonotpostAdjustmentbatches, PostAdjustmentbatches
AdjustmentThroughPostingSequenceNumber String Falso Valores posibles: Número decimal
ProcessRevaluationBatch String Falso Valores posibles: DonotpostRevaluebatches, PostRevaluebatches
RevaluationThroughPostingSequenceNumber String Falso Valores posibles: Número decimal
ProcessRefundBatch String Falso Valores posibles: DonotpostRefundbatches, PostRefundbatches
RefundThroughPostingSequenceNumber String Falso Valores posibles: Número decimal
ActionSelector String Falso Valores posibles: Texto de cadena
UpdateOperation String Falso Valores posibles: Sin especificar, Actualizar, Insertar, Eliminar
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
Success String Este valor muestra una indicación booleana de si la operación fue exitosa o no.

ARCrearRecurringCharge

Información de uso para la operación ARCreateRecurringCharge.rsb.

Aporte
Nombre Tipo Obligatorio Descripción
RangeType String Falso Valores posibles: RecurringChargeCode, CustomerNumber, CustomerGroup, NationalAccount, ScheduleLink, SpecificRecurringChargeCode
RangeFrom String Falso Valores posibles: Texto de cadena
RangeThrough String Falso Valores posibles: Texto de cadena
RunDate String Falso Valores posibles: Fecha y hora
Mode String Falso Valores posibles: Número entero
FiscalYear String Falso Valores posibles: Texto de cadena
FiscalPeriod String Falso Valores posibles: Texto de cadena
ScheduleKey String Falso Valores posibles: Texto de cadena
ScheduleLink String Falso Valores posibles: Número decimal
Status String Falso Valores posibles: Número entero
DateGenerationMethod String Falso Valores posibles: RunDate, NextScheduleDate, SpecificDate
BatchGenerationMethod String Falso Valores posibles: Predeterminado, CreatDecimaleaNewBatch, AddToanExistingBatch
ForcedInvoiceDate String Falso Valores posibles: Fecha y hora
AppendToBatchNumber String Falso Valores posibles: Número decimal
ActionSelector String Falso Valores posibles: Texto de cadena
UpdateOperation String Falso Valores posibles: Sin especificar, Actualizar, Insertar, Eliminar
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
Success String Este valor muestra una indicación booleana de si la operación fue exitosa o no.

ARCreateRetainageDocumentBatch

Información de uso para la operación ARCreateRetainageDocumentBatch.rsb.

Aporte
Nombre Tipo Obligatorio Descripción
RunDate Date Falso Valores posibles: Fecha y hora
Mode String Falso Valores posibles: Número entero
SelectRecordsBy String Falso Valores posibles: VendorNumber, DocumentNumber, VendorGroup
StartingDocumentNumber String Falso Valores posibles: Texto de cadena
EndingDocumentNumber String Falso Valores posibles: Texto de cadena
StartingCustomerNumber String Falso Valores posibles: Texto de cadena
EndingCustomerNumber String Falso Valores posibles: Texto de cadena
StartingCustomerGroupCode String Falso Valores posibles: Texto de cadena
EndingCustomerGroupCode String Falso Valores posibles: Texto de cadena
StartingNationalAccount String Falso Valores posibles: Texto de cadena
EndingNationalAccount String Falso Valores posibles: Texto de cadena
IncludeInvoice String Falso Valores posibles: No, Sí
IncludeDebitNote String Falso Valores posibles: No, Sí
IncludeCreditNote String Falso Valores posibles: No, Sí
DaysBeforeRetainageDue String Falso Valores posibles: Número entero
CommandCode String Falso Valores posibles: UserRun, ScheduledRun
Status String Falso Valores posibles: Número entero
ActionSelector String Falso Valores posibles: Texto de cadena
UpdateOperation String Falso Valores posibles: Sin especificar, Actualizar, Insertar, Eliminar
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
Success String Este valor muestra una indicación booleana de si la operación fue exitosa o no.

ARPostFacturas

Información de uso para la operación ARPostInvoices.rsb.

Aporte
Nombre Tipo Obligatorio Descripción
PostAllBatches String Falso Valores posibles: Donotpostallbatches, Postallbatches
PostBatchFrom String Falso Valores posibles: Número decimal
PostBatchTo String Falso Valores posibles: Número decimal
ActionSelector String Falso Valores posibles: Texto de cadena
UpdateOperation String Falso Valores posibles: Sin especificar, Actualizar, Insertar, Eliminar
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
Success String Este valor muestra una indicación booleana de si la operación fue exitosa o no.

ARPostReceiptsAndAdjustments

Información de uso para la operación ARPostReceiptsAndAdjustments.rsb.

Aporte
Nombre Tipo Obligatorio Descripción
BatchType String Falso Valores posibles: Texto de cadena
PostAllBatches String Falso Valores posibles: Donotpostallbatches, Postallbatches
PostBatchFrom String Falso Valores posibles: Número decimal
PostBatchTo String Falso Valores posibles: Número decimal
ActionSelector String Falso Valores posibles: Texto de cadena
UpdateOperation String Falso Valores posibles: Sin especificar, Actualizar, Insertar, Eliminar
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
Success String Este valor muestra una indicación booleana de si la operación fue exitosa o no.

ARPostReembolsos

Información de uso para la operación ARPostRefunds.rsb.

Aporte
Nombre Tipo Obligatorio Descripción
PostAllBatches String Falso Valores posibles: Donotpostallbatches, Postallbatches
PostBatchFrom String Falso Valores posibles: Número decimal
PostBatchTo String Falso Valores posibles: Número decimal
ActionSelector String Falso Valores posibles: Texto de cadena
UpdateOperation String Falso Valores posibles: Sin especificar, Actualizar, Insertar, Eliminar
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
Success String Este valor muestra una indicación booleana de si la operación fue exitosa o no.

CrearEsquema

Crea un archivo de esquema para la tabla o vista especificada.

Aporte
Nombre Tipo Obligatorio Descripción
TableName String Cierto El nombre de la tabla o vista.
FileName String Cierto La ruta completa del archivo y el nombre del esquema a generar. Ej: 'C:\Users\User\Desktop\SmartSheet\sheet.rsd'
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
Result String Devuelve éxito o fracaso.

GLPostJournal

Información de uso para la operación GLPostJournal.rsb.

Aporte
Nombre Tipo Obligatorio Descripción
PostAllBatchesSwitch String Falso Valores posibles: PostbyBatchRange, PostallBatches
ProvisionalPostSwitch String Falso Valores posibles: ActualPost, ProvisionalPost
FromBatchNumber String Falso Valores posibles: Texto de cadena
ToBatchNumber String Falso Valores posibles: Texto de cadena
ErrorBatchCreatedSwitch String Falso Valores posibles: Error por lotes no creado, Error por lotes creado
ActionSelector String Falso Valores posibles: Texto de cadena
UpdateOperation String Falso Valores posibles: Sin especificar, Actualizar, Insertar, Eliminar
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
Success String Este valor muestra una indicación booleana de si la operación fue exitosa o no.

ICCreateGLBatch

Información de uso para la operación ICCreateGLBatch.rsb.

Aporte
Nombre Tipo Obligatorio Descripción
DayEndNumber String Falso Valores posibles: Número entero
TransactionsCreated String Falso Valores posibles: verdadero, falso
ActionSelector String Falso Valores posibles: Texto de cadena
UpdateOperation String Falso Valores posibles: Sin especificar, Actualizar, Insertar, Eliminar
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
Success String Este valor muestra una indicación booleana de si la operación fue exitosa o no.

ICDayEndProcessing

Información de uso para la operación ICDayEndProcessing.rsb.

Aporte
Nombre Tipo Obligatorio Descripción
ClearHistory String Falso Valores posibles: verdadero, falso
Application String Falso Valores posibles: Texto de cadena
ProcessingType String Falso Valores posibles: Número entero
TransactionNumber String Falso Valores posibles: Número decimal
PostSequenceNumber String Falso Valores posibles: Número entero
ActionSelector String Falso Valores posibles: Texto de cadena
UpdateOperation String Falso Valores posibles: Sin especificar, Actualizar, Insertar, Eliminar
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
Success String Este valor muestra una indicación booleana de si la operación fue exitosa o no.

POCreateBatch

Información de uso para la operación POCreateBatch.rsb.

Aporte
Nombre Tipo Obligatorio Descripción
DayEndNumber String Falso Valores posibles: Número decimal
TransactionsCreated String Falso Valores posibles: verdadero, falso
PostGLBatch String Falso Valores posibles: verdadero, falso
PostAPBatch String Falso Valores posibles: verdadero, falso
ActionSelector String Falso Valores posibles: Texto de cadena
UpdateOperation String Falso Valores posibles: Sin especificar, Actualizar, Insertar, Eliminar
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
Success String Este valor muestra una indicación booleana de si la operación fue exitosa o no.

PODayEndProcessing

Información de uso para la operación PODayEndProcessing.rsb.

Aporte
Nombre Tipo Obligatorio Descripción
ClearHistory String Falso Valores posibles: verdadero, falso
Application String Falso Valores posibles: Texto de cadena
ProcessingType String Falso Valores posibles: Número entero
TransactionNumber String Falso Valores posibles: Número decimal
PostSequenceNumber String Falso Valores posibles: Número entero
ActionSelector String Falso Valores posibles: Texto de cadena
UpdateOperation String Falso Valores posibles: Sin especificar, Actualizar, Insertar, Eliminar
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
Success String Este valor muestra una indicación booleana de si la operación fue exitosa o no.

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 Sage 300:

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 Consultas

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
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos.

Sys_schemas

Enumera los esquemas disponibles.

La siguiente consultar recupera todos los esquemas disponibles:

SELECT * FROM sys_schemas
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos.
SchemaName String El nombre del esquema.

Sys_tables

Enumera las tablas disponibles.

La siguiente consultar recupera las tablas y vistas disponibles:

SELECT * FROM sys_tables
Columnas
Nombre Tipo Descripción
CatalogName String La base de datos que contiene la tabla o vista.
SchemaName String El esquema que contiene la tabla o vista.
TableName String El nombre de la tabla o vista.
TableType String El tipo de tabla (tabla o vista).
Description String Una descripción de la tabla o vista.
IsUpdateable Boolean Si la tabla se puede actualizar.

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

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='OEInvoices' 
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos que contiene la tabla o vista.
SchemaName String El esquema que contiene la tabla o vista.
TableName String El nombre de la tabla o vista que contiene la columna.
ColumnName String El nombre de la columna.
DataTypeName String El nombre del tipo de datos.
DataType Int32 Un número entero que indica el tipo de datos. Este valor se determina en tiempo de ejecución en función del ambiente.
Length Int32 El tamaño de almacenamiento de la columna.
DisplaySize Int32 El ancho máximo normal de la columna designada en caracteres.
NumericPrecision Int32 El número máximo de dígitos en datos numéricos. La longitud de la columna en caracteres para datos de carácter y fecha y hora.
NumericScale Int32 La escala de columna o número de dígitos a la derecha del punto decimal.
IsNullable Boolean Si la columna puede contener nulo.
Description String Una breve descripción de la columna.
Ordinal Int32 El número de secuencia de la columna.
IsAutoIncrement String Si el valor de la columna se asigna en incrementos fijos.
IsGeneratedColumn String Si se genera la columna.
IsHidden Boolean Si la columna está oculta.
IsArray Boolean Si la columna es una matriz.

Sys_procedimientos

Enumera los procedimientos almacenados disponibles.

La siguiente consultar recupera los procedimientos almacenados disponibles:

SELECT * FROM sys_procedures
Columnas
Nombre Tipo Descripción
CatalogName String La base de datos que contiene el procedimiento almacenado.
SchemaName String El esquema que contiene el procedimiento almacenado.
ProcedureName String El nombre del procedimiento almacenado.
Description String Una descripción del procedimiento almacenado.
ProcedureType String El tipo de procedimiento, como PROCEDIMIENTO o FUNCIÓN.

Sys_procedureparameters

Describe procedimiento almacenado* parámetros.

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

SELECT * FROM sys_procedureparameters WHERE ProcedureName='APCreateGLBatch' AND Direction=1 OR Direction=2
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos que contiene el procedimiento almacenado.
SchemaName String El nombre del esquema que contiene el procedimiento almacenado.
ProcedureName String El nombre del procedimiento almacenado* que contiene el parámetro.
ColumnName String El nombre del procedimiento almacenado* parámetro.
Direction Int32 Un número entero correspondiente al tipo de parámetro: entrada (1), entrada/salida (2) o salida (4). Los parámetros de tipo de entrada/salida pueden ser tanto parámetros de entrada como de salida.
DataTypeName String El nombre del tipo de datos.
DataType Int32 Un número entero que indica el tipo de datos. Este valor se determina en tiempo de ejecución en función del ambiente.
Length Int32 El número de caracteres permitidos para los datos de caracteres. El número de dígitos permitidos para datos numéricos.
NumericPrecision Int32 La máxima precisión para datos numéricos. La longitud de la columna en caracteres para datos de carácter y fecha y hora.
NumericScale Int32 El número de dígitos a la derecha del punto decimal en datos numéricos.
IsNullable Boolean Si el parámetro puede contener nulo.
IsRequired Boolean Si el parámetro es necesario para la ejecución del procedimiento.
IsArray Boolean Si el parámetro es una matriz.
Description String La descripción del parámetro.
Ordinal Int32 El índice del parámetro.

Sys_keycolumns

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

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='OEInvoices'
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos que contiene la clave.
SchemaName String El nombre del esquema que contiene la clave.
TableName String El nombre de la tabla que contiene la clave.
ColumnName String El nombre de la columna clave.
IsKey Boolean Si la columna es una clave principal en la tabla a la que se hace referencia en el campo TableName.
IsForeignKey Boolean Si la columna es una clave externa a la que se hace referencia en el campo TableName.
PrimaryKeyName String El nombre de la clave principal.
ForeignKeyName String El nombre de la clave foránea.
ReferencedCatalogName String La base de datos que contiene la clave principal.
ReferencedSchemaName String El esquema que contiene la clave principal.
ReferencedTableName String La tabla que contiene la clave principal.
ReferencedColumnName String El nombre de la columna de la clave principal.

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
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos que contiene la clave.
SchemaName String El nombre del esquema que contiene la clave.
TableName String El nombre de la tabla que contiene la clave.
ColumnName String El nombre de la columna clave.
PrimaryKeyName String El nombre de la clave principal.
ForeignKeyName String El nombre de la clave foránea.
ReferencedCatalogName String La base de datos que contiene la clave principal.
ReferencedSchemaName String El esquema que contiene la clave principal.
ReferencedTableName String La tabla que contiene la clave principal.
ReferencedColumnName String El nombre de la columna de la clave principal.
ForeignKeyType String Designa si la clave externa es una clave de importación (apunta a otras tablas) o de exportación (hace referencia desde otras tablas).

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
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos que contiene el índice.
SchemaName String El nombre del esquema que contiene el índice.
TableName String El nombre de la tabla que contiene el índice.
IndexName String El nombre del índice.
ColumnName String El nombre de la columna asociada con el índice.
IsUnique Boolean True si el índice es único. Falso en caso contrario.
IsPrimary Boolean True si el índice es una clave principal. Falso en caso contrario.
Type Int16 Un valor entero correspondiente al tipo de índice: estadística (0), agrupado (1), hash (2) u otro (3).
SortOrder String El orden de clasificación: A para ascender o D para descender.
OrdinalPosition Int16 El número de secuencia de la columna en el índice.

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:sage300: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
Nombre Tipo Descripción
Name String El nombre de la propiedad de conexión.
ShortDescription String Una breve descripción.
Type String El tipo de datos de la propiedad de conexión.
Default String El valor predeterminado si no se establece uno explícitamente.
Values String Una lista separada por comas de valores posibles. Se lanza un error de validación si se especifica otro valor.
Value String El valor que establezca o un valor predeterminado preconfigurado.
Required Boolean Si la propiedad es necesaria para conectarse.
Category String La categoría de la propiedad de conexión.
IsSessionProperty String Si la propiedad es una propiedad de sesión, utilizada para guardar información sobre la conexión actual.
Sensitivity String El nivel de sensibilidad de la propiedad. Esto informa si la propiedad está ofuscada en los formularios de registro y autenticación.
PropertyName String Una forma truncada en mayúsculas y minúsculas del nombre de la propiedad de conexión.
Ordinal Int32 El índice del parámetro.
CatOrdinal Int32 El índice de la categoría de parámetro.
Hierarchy String Muestra las propiedades dependientes asociadas que deben configurarse junto con esta.
Visible Boolean Informa si la propiedad está visible en la interfaz de usuario de la conexión.
ETC String Diversa información miscelánea sobre la propiedad.

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.

Nombre Descripción Valores posibles
AGGREGATE_FUNCTIONS Funciones de agregación admitidas. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Si se admite la función COUNT. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR El carácter de apertura utilizado para escapar de un identificador. [
IDENTIFIER_QUOTE_CLOSE_CHAR El carácter de cierre utilizado para escapar de un identificador. ]
SUPPORTED_OPERATORS Una lista de operadores de SQL admitidos. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Si se admite GROUP BY y, de ser así, el grado de compatibilidad. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Funciones de cadena admitidas. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Funciones numéricas compatibles. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Funciones de fecha/hora admitidas. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Indica tablas omitidas durante la replicación.
REPLICATION_TIMECHECK_COLUMNS Una matriz de cadenas que contiene una lista de columnas que se usarán para verificar (en el orden dado) para usar como una columna modificada durante la replicación.
IDENTIFIER_PATTERN Valor de cadena que indica qué cadena es válida para un identificador.
SUPPORT_TRANSACTION Indica si el proveedor admite transacciones como compromiso y reversión. YES, NO
DIALECT Indica el dialecto SQL a usar.
KEY_PROPERTIES Indica las propiedades que identifican la base de datos uniforme.
SUPPORTS_MULTIPLE_SCHEMAS Indica si pueden existir varios esquemas para el proveedor. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indica si pueden existir varios catálogos para el proveedor. YES, NO
DATASYNCVERSION La versión de sincronización de datos necesaria para acceder a este controlador. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY La categoría Sincronización de datos de este controlador. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Si se admite la funcionalidad de SQL mejorada más allá de lo que ofrece la API. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Si se admiten las operaciones lote. YES, NO
SQL_CAP Todas las funciones de SQL admitidas para este controlador. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS Un valor de cadena especifica las cacheOptions preferidas.
ENABLE_EF_ADVANCED_QUERY Indica si el controlador admite directamente consultas avanzadas provenientes de Entity Framework. De lo contrario, las consultas se manejarán del lado del cliente. YES, NO
PSEUDO_COLUMNS Una matriz de cadenas que indica las pseudocolumnas disponibles.
MERGE_ALWAYS Si el valor es verdadero, el modo de combinación se ejecuta a la fuerza en la sincronización de datos. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY Una consultar de selección para devolver la fecha y hora de inicio de la réplica.
REPLICATION_MIN_FUNCTION Permite que un proveedor especifique el nombre de la fórmula que se usará para ejecutar un min del lado del servidor.
REPLICATION_START_DATE Permite que un proveedor especifique una fecha de inicio de réplica.
REPLICATION_MAX_DATE_QUERY Una consultar de selección para devolver la fecha y hora de finalización de la réplica.
REPLICATION_MAX_FUNCTION Permite que un proveedor especifique el nombre de la fórmula que se usará para ejecutar un máx. del lado del servidor.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE Una lista de tablas que omitirán dividir la réplica en fragmentos en la réplica inicial.
CHECKCACHE_USE_PARENTID Indica si la instrucción CheckCache debe realizarse en la columna de clave principal. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indica procedimientos almacenados* que se puede utilizar para generar archivos de esquema.

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
Nombre Tipo Descripción
NAME String Un componente de la sintaxis SQL o una capacidad que se puede procesar en el servidor.
VALUE String Detalles sobre el SQL o la sintaxis de SQL admitidos.

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
Nombre Tipo Descripción
Id String El ID generado por la base de datos devuelto de una operación de modificación de datos.
Batch String Un identificador para el lote. 1 para una sola operación.
Operation String El resultado de la operación en el lote: INSERTADO, ACTUALIZADO o ELIMINADO.
Message String ÉXITO o un mensaje de error si falla la actualización en el lote.

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.

Autenticación

Propiedad Descripción
URL Establezca la URL en el extremo HTTP o HTTPS de su sistema Sage 300. Por ejemplo, http://localhost/Sage300WebApi/v1.0/-/.
User La cuenta de usuario de Sage 300 utilizada para la autenticación.
Password La contraseña utilizada para autenticar al usuario.

Conexión

Propiedad Descripción
Company Determina la empresa.
Modules Lista de módulos separados por comas.

SSL

Propiedad Descripción
SSLServerCert El certificado que se aceptará del servidor al conectarse mediante TLS/SSL.

Esquema

Propiedad Descripción
Location Una ruta al directorio que contiene los archivos de esquema que definen tablas, vistas y procedimientos almacenados.
BrowsableSchemas Esta propiedad restringe los esquemas informados a un subconjunto de los esquemas disponibles. Por ejemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Esta propiedad restringe las tablas notificadas a un subconjunto de las tablas disponibles. Por ejemplo, Tablas=TablaA, TablaB, TablaC.
Views Restringe las vistas informadas a un subconjunto de las tablas disponibles. Por ejemplo, Vistas=VistaA, VistaB, VistaC.

Misceláneas

Propiedad Descripción
IncludeCustomFields Determina si los campos personalizados deben incluirse como columnas de la tabla o no.
MaxRows 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.
Other Estas propiedades ocultas se usan solo en casos de uso específicos.
PseudoColumns Esta propiedad indica si incluir o no pseudocolumnas como columnas en la tabla.
RowScanDepth El número máximo de filas para escanear para buscar las columnas disponibles en una tabla.
Timeout El valor en segundos hasta que se lanza el error de tiempo de espera, cancelando la operación.

Autenticación

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

Propiedad Descripción
URL Establezca la URL en el extremo HTTP o HTTPS de su sistema Sage 300. Por ejemplo, http://localhost/Sage300WebApi/v1.0/-/.
User La cuenta de usuario de Sage 300 utilizada para la autenticación.
Password La contraseña utilizada para autenticar al usuario.

URL

Establezca la URL en el extremo HTTP o HTTPS de su sistema Sage 300. Por ejemplo, http://localhost/Sage300WebApi/v1.0/-/.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Establezca la URL en el extremo HTTP o HTTPS de su sistema Sage 300 una URL para la API web de Sage 300 de la siguiente manera: {protocol}://{host-application-path}/v{version}/{tenant}/ Por ejemplo, http://localhost/Sage300WebApi/v1.0/-/.

Usuario

La cuenta de usuario de Sage 300 utilizada para la autenticación.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Junto con Contraseña, este campo se utiliza para autenticarse en el servidor Sage 300.

Contraseña

La contraseña utilizada para autenticar al usuario.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El usuario y Password se usan juntos para autenticarse con el servidor.

Conexión

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

Propiedad Descripción
Company Determina la empresa.
Modules Lista de módulos separados por comas.

Compañía

Determina la empresa.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Especifique la empresa de la que desea obtener datos. Si no se especifica, se elegirá la primera empresa que se encuentre en el extremo /Empresas.

Módulos

Lista de módulos separados por comas.

Tipo de Datos

string

Valor por Defecto

"\*"

Observaciones

Lista de módulos separados por comas. (Use esta propiedad de conexión para tener acceso solo a los módulos deseados. Esto mejorará el rendimiento de los metadatos recuperados). Opciones: AP (Cuenta por pagar), AR (Cuenta por cobrar), BK (Bancos), CS (Servicios comunes), GL (Libro mayor), IC (Control de inventario), OE (Entrada de pedidos), PO (Órdenes de compra), TX (Seguimiento de impuestos)

SSL

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

Propiedad Descripción
SSLServerCert El certificado que se aceptará del servidor al conectarse mediante TLS/SSL.

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:

Descripción Ejemplo
Un certificado PEM completo (ejemplo abreviado por brevedad) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
Una ruta a un archivo local que contiene el certificado C:\cert.cer
La clave pública (ejemplo abreviado por brevedad) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
La huella digital MD5 (los valores hexadecimales también pueden estar separados por espacios o dos puntos) ecadbdda5a1529c58a1e9e09828d70e4
La huella digital SHA1 (los valores hexadecimales también pueden estar separados por espacios o dos puntos) 34a929226ae0819f2ec14b4a3d904f801cbb150d

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.

Propiedad Descripción
Location Una ruta al directorio que contiene los archivos de esquema que definen tablas, vistas y procedimientos almacenados.
BrowsableSchemas Esta propiedad restringe los esquemas informados a un subconjunto de los esquemas disponibles. Por ejemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Esta propiedad restringe las tablas notificadas a un subconjunto de las tablas disponibles. Por ejemplo, Tablas=TablaA, TablaB, TablaC.
Views Restringe las vistas informadas a un subconjunto de las tablas disponibles. Por ejemplo, Vistas=VistaA, VistaB, VistaC.

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%\\\Sage300 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%\\Sage300 Data Provider\Schema" con %APPDATA% estando configurado en el directorio de configuración del usuario:

Plataforma %APPDATA%
Windows El valor de la variable de ambiente APPDATA
Mac ~/Biblioteca/Soporte de aplicaciones
Linux ~/.config

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.

Propiedad Descripción
IncludeCustomFields Determina si los campos personalizados deben incluirse como columnas de la tabla o no.
MaxRows 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.
Other Estas propiedades ocultas se usan solo en casos de uso específicos.
PseudoColumns Esta propiedad indica si incluir o no pseudocolumnas como columnas en la tabla.
RowScanDepth El número máximo de filas para escanear para buscar las columnas disponibles en una tabla.
Timeout El valor en segundos hasta que se lanza el error de tiempo de espera, cancelando la operación.

Incluir Campos Personalizados

Determina si los campos personalizados deben incluirse como columnas de la tabla o no.

Tipo de Datos

bool

Valor por Defecto

false

Observaciones

Para recuperar sus valores, puede establecer IncludeCustomFields=true como propiedad de conexión. Al hacerlo, aparecerá una lista de los campos personalizados creados como columnas de la tabla.

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
Propiedad Descripción
DefaultColumnSize Establece la longitud predeterminada de los campos de cadena cuando la fuente de datos no proporciona la longitud de columna en los metadatos. El valor predeterminado es 2000.
ConvertDateTimeToGMT Determina si se convierten los valores de fecha y hora a GMT, en lugar de la hora local de la máquina.
RecordToFile=filename Registra la transferencia de datos del socket subyacente al archivo especificado.

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, "*=*".

FilaExploraciónProfundidad

El número máximo de filas para escanear para buscar las columnas disponibles en una tabla.

Tipo de Datos

int

Valor por Defecto

100

Observaciones

Las columnas de una tabla deben determinarse escaneando las filas de la tabla. Este valor determina el número máximo de filas que se escanearán.

Establecer un valor alto puede disminuir el rendimiento. Establecer un valor bajo puede evitar que el tipo de datos se determine correctamente, especialmente cuando hay datos nulos.

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.