Detalhes da Conexão do Sage 300¶
Introdução¶
Versão do conector
Esta documentação é baseada na versão 21.0.8257 do conector.
Começando¶
Suporte à versão Sage 300
O conector aproveita a API do Sage 300 para permitir o acesso bidirecional ao Sage 300.
Estabelecendo uma Conexão¶
Antes de Autenticar¶
O Sage 300 requer algumas configurações iniciais para se comunicar pela API da Web do Sage 300. O usuário logado deve ter acesso API a um ou todos os módulos da instância Sage300. No Sage300, um usuário recebe um grupo de segurança. Um grupo de segurança é um conjunto de permissões para cada módulo. É recomendável que você use um usuário diferente do ADMIN
usuário para acessar a API. O ADMIN
o usuário tem algumas etapas extras para obter acesso à API. Siga as etapas abaixo para obter acesso à API.
Criando um Usuário¶
Ignore esta etapa se você já criou um novo usuário ou gostaria de usar uma conta existente.
- Abra o Sage300 Desktop Application que está incluído na instalação do Sage300. Faça login com
ADMIN
conta. - Vá para
Administrative Services
->Users
- Preencha as informações solicitadas e clique em
Add
Configurando o Grupo de Segurança¶
- Abra o Sage300 Desktop Application que está incluído na instalação do Sage300. Faça login com
ADMIN
conta. - Vá para
Administrative Services
->Security Groups
- No
Application
você encontrará todos os módulos do Sage300. OGroup ID
representa o grupo de segurança que você deseja modificar. Abaixo você encontrará uma lista de permissões que você pode verificar. - (Opcional)Crie um novo
Security Group
preencha oGroup ID
,Group Description
e verifique qualquer uma das permissões, incluindo oSage 300 Web API
permissão. Por último cliqueAdd
(por cada aplicação necessária) - Ou selecione um existente
Security Group
você vai atribuir ao usuário emGroup ID
e marqueSage 300 Web API
permissão no final das permissões (por cada aplicativo necessário).
Atribuindo um Grupo de Segurança¶
- Abra o Sage300 Desktop Application que está incluído na instalação do Sage300. Faça login com
ADMIN
conta. - Vá para
Administrative Services
->User Authorization
- Sob
User ID
selecione seu novo/existenteUser
- Agora para cada
Application
atribuir oGroup ID
que você criou/modificou - Uma vez feito o acesso do usuário, certifique-se de que ele tenha acesso à API da web. Construa um URL para testar o acesso à API da Web do Sage 300 da seguinte forma:
https://{servidor}/Sage300WebApi/
, substituindo{server}
com o URL da sua instância Sage300.
Conectando ao Sage 300¶
O Jitterbit Connector for Sage 300 se comunica com o Sage 300 pela API OData. Você pode autenticar no Sage 300 usando autenticação básica.
Conectar Usando Autenticação Básica¶
Você deve fornecer valores para as seguintes propriedades para autenticar com sucesso no Sage 300. Observe que o provedor reutilizará a sessão aberta pelo Sage 300 usando cookies.
Isso significa que suas credenciais serão usadas apenas na primeira solicitação para abrir a sessão. Depois disso, os cookies devolvidos pelo Sage 300 serão usados para autenticação.
URL
: Defina isso para o URL do servidor que hospeda o Sage 300. Construa um URL para o Sage 300 Web API da seguinte forma:{protocol}://{host-application-path}/v{versão}/{tenant}/
Por exemplo:http://localhost/Sage300WebApi/v1.0/-/
.User
: Defina isso para o nome de usuário da sua conta.Password
: Defina isso como a senha da sua conta.
Acesso a Dados de Ajuste Fino¶
Acesso a Dados de Ajuste Fino¶
Você pode usar as seguintes propriedades para obter mais controle sobre os dados retornados do Sage 300:
Company
: Especifique a empresa da qual deseja obter os dados. Se não for especificado, a primeira empresa encontrada no/Companies
endpoint será escolhido.Modules
: Use esta propriedade de conexão para limitar a recuperação de metadados apenas aos módulos desejados. Isso melhorará o desempenho dos metadados recuperados.IncludeCustomFields
: Defina como true para listar os campos personalizados como colunas da tabela.
Anotações Importantes¶
Procedimentos Armazenados¶
- Os recursos de procedimentos armazenados descritos nesta documentação não são suportados no momento.
- Como os procedimentos armazenados não são suportados atualmente, qualquer recurso dependente de procedimentos armazenados também não é suportado atualmente.
Arquivos de Configuração e Seus Caminhos¶
- Todas as referências para adicionar arquivos de configuração e seus caminhos referem-se a arquivos e locais no Harmony Agente onde o conector está instalado. Esses caminhos devem ser ajustados conforme apropriado, dependendo do agente e do sistema operacional. Se vários agentes forem usados em um grupo de agentes, arquivos idênticos serão necessários em cada agente.
Características Avançadas¶
Esta seção detalha uma seleção de recursos avançados do conector Sage 300.
Visualizações definidas pelo usuário
O conector permite definir tabelas virtuais, denominadas visões definidas pelo usuário, cujo conteúdo é decidido por uma consultar pré-configurada. Essas exibições são úteis quando você não pode controlar diretamente as consultas enviadas aos drivers. Consulte Visualizações definidas pelo usuário para obter uma visão geral da criação e configuração de exibições personalizadas.
Configuração SSL
Use Configuração SSL para ajustar como o conector lida com as negociações de certificado TLS/SSL. Você pode escolher entre vários formatos de certificado; Veja o SSLServerCert
propriedade em "Opções de cadeia de conexão" para obter mais informações.
Procurador
Para configurar o conector usando configurações de proxy do Agente Privado, selecione os Use Proxy Settings
caixa de seleção na tela de configuração da conexão.
Visualizações Definidas pelo Usuário¶
O Jitterbit Connector for Sage 300 permite definir uma tabela virtual cujo conteúdo é decidido por uma consultar pré-configurada. Elas são chamadas de Visualizações Definidas pelo Usuário, que são úteis em situações onde você não pode controlar diretamente a consultar que está sendo emitida para o driver, por exemplo, ao usar o driver do Jitterbit. As Visualizações Definidas pelo Usuário podem ser usadas para definir predicados que são sempre aplicados. Se você especificar predicados adicionais na consultar para a visualização, eles serão combinados com a consultar já definida como parte da visualização.
Há duas maneiras de criar exibições definidas pelo usuário:
- Crie um arquivo de configuração em formato JSON definindo as visualizações desejadas.
- declarações DDL.
Definindo Visualizações Usando um Arquivo de Configuração¶
As visualizações definidas pelo usuário são definidas em um arquivo de configuração formatado em JSON chamado UserDefinedViews.json
. O conector detecta automaticamente as visualizações especificadas neste arquivo.
Você também pode ter várias definições de exibição e controlá-las usando o UserDefinedViews
propriedade de conexão. Quando você usa essa propriedade, apenas as exibições especificadas são vistas pelo conector.
Este arquivo de configuração de exibição definida pelo usuário é formatado da seguinte forma:
- Cada elemento raiz define o nome de uma visualização.
- Cada elemento raiz contém um elemento filho, chamado
query
, que contém a consultar SQL personalizada para a visualização.
Por exemplo:
{
"MyView": {
"query": "SELECT * FROM OEInvoices WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use o UserDefinedViews
propriedade de conexão para especificar a localização do seu arquivo de configuração JSON. Por exemplo:
"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"
Esquema para Exibições Definidas pelo Usuário¶
As visualizações definidas pelo usuário são expostas no UserViews
esquema por padrão. Isso é feito para evitar que o nome da exibição entre em conflito com uma entidade real no modelo de dados. Você pode alterar o nome do esquema usado para UserViews definindo o UserViewsSchemaName
propriedade.
Trabalhando com Exibições Definidas pelo Usuário¶
Por exemplo, uma instrução SQL com uma Visualização Definida pelo Usuário chamada UserViews.RCustomers
lista apenas clientes em Raleigh:
SELECT * FROM Customers WHERE City = 'Raleigh';
Exemplo de consultar ao driver:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';
Resultando na consultar efetiva à fonte:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';
Esse é um exemplo muito simples de uma consultar a uma exibição definida pelo usuário que é efetivamente uma combinação da consultar de exibição e da definição de exibição. É possível compor essas consultas em padrões muito mais complexos. Todas as operações SQL são permitidas em ambas as consultas e são combinadas quando apropriado.
Configuração SSL¶
Personalizando a Configuração SSL¶
Por padrão, o conector tenta negociar SSL/TLS verificando o certificado do servidor em relação ao armazenamento de certificados confiáveis do sistema.
Para especificar outro certificado, consulte o SSLServerCert
propriedade para os formatos disponíveis para fazê-lo.
Modelo de Dados¶
Visão geral
O Jitterbit Connector for Sage 300 modela objetos Sage 300 como tabelas relacionais e visualizações. Um objeto do Sage 300 tem relacionamentos com outros objetos; nas tabelas, esses relacionamentos são expressos por meio de chaves estrangeiras.
Características principais
- O conector modela as entidades do Sage 300 como tabelas e visualizações relacionais, permitindo que você escreva SQL para consultar os dados do Sage 300.
- Procedimentos armazenados* permitem que você execute operações no Sage 300.
- A conectividade ao vivo com esses objetos significa que quaisquer alterações em sua conta Sage 300 são refletidas imediatamente ao usar o conector.
Mesas
As tabelas são recuperadas dinamicamente da conta Sage 300 autenticada.
Tabelas Filhas¶
Tabelas filhas também são recuperadas, as quais contêm objetos filhos de seus pais. Por exemplo, OEOrders tem OEOrders_OrderCommentsInstructions e OEOrders_OrderDetails como suas tabelas filhas. Essas tabelas são expostas como colunas agregadas durante a consulta de sua tabela pai. Eles também têm referências ao identificador exclusivo de seus pais.
Visualizações
Visualizações somente leitura são recuperadas dinamicamente da conta Sage 300 autenticada.
Procedimentos armazenados
NOTE:
Procedimentos armazenados não são suportados atualmente. Veja a nota para detalhes.
Procedimentos armazenados são interfaces semelhantes a funções para o Sage 300. Procedimentos armazenados* permitem que você execute operações no Sage 300.
Processamento de consulta colaborativa
O conector transfere o máximo possível do processamento da instrução SELECT para o Sage 300 e, em seguida, processa o restante da consultar na memória. As limitações e requisitos da API também estão documentados nesta seção.
Ver SupportEnhancedSQL
para obter mais informações sobre como o conector contorna as limitações da API com processamento na memória do lado do cliente.
As instruções SELECT para as tabelas principais são mais suportadas do lado do servidor. Por exemplo:
SELECT * FROM APInvoiceBatches WHERE BatchDate='2019-01-09 01:00:00.0'
será executado no lado do servidor.
Observação: Ao executar instruções SELECT em tabelas filhas, tudo é processado no lado do cliente.
Procedimentos Armazenados¶
Procedimentos armazenados* estão disponíveis para complementar os dados disponíveis no Modelo de Dados. Pode ser necessário atualizar os dados disponíveis em uma exibição usando um procedimento armazenado* porque os dados não fornecem atualizações bidirecionais diretas, semelhantes a tabelas. Nessas situações, a recuperação dos dados é feita usando a visualização ou tabela apropriada, enquanto a atualização é feita chamando um procedimento armazenado. Procedimentos armazenados* pega uma lista de parâmetros e retorna um conjunto de dados que contém a coleção de tuplas que constituem a resposta.
Conector Jitterbit para Sage 300 Stored Procedures¶
Nome | Descrição |
---|---|
APCreateGLBatch | Informações de uso para a operação APCreateGLBatch.rsb. |
APCreateRecurringPayableBatch | Informações de uso para a operação APCreateRecurringPayableBatch.rsb. |
APCreateRetainageDocumentBatch | Informações de uso para a operação APCreateRetainageDocumentBatch.rsb. |
APDeleteInactiveRecords | Informações de uso para a operação APDeleteInactiveRecords.rsb. |
APPostInvoices | Informações de uso para a operação APPostInvoices.rsb. |
APPostPaymentsAndAdjustments | Informações de uso para a operação APPostPaymentsAndAdjustments.rsb. |
ARCreateGLBatch | Informações de uso para a operação ARCreateGLBatch.rsb. |
ARCreateRecurringCharge | Informações de uso para a operação ARCreateRecurringCharge.rsb. |
ARCreateRetainageDocumentBatch | Informações de uso para a operação ARCreateRetainageDocumentBatch.rsb. |
ARPostInvoices | Informações de uso para a operação ARPostInvoices.rsb. |
ARPostReceiptsAndAdjustments | Informações de uso para a operação ARPostReceiptsAndAdjustments.rsb. |
ARPostRefunds | Informações de uso para a operação ARPostRefunds.rsb. |
CreateSchema | Cria um arquivo de esquema para a tabela ou exibição especificada. |
GLPostJournal | Informações de uso para a operação GLPostJournal.rsb. |
ICCreateGLBatch | Informações de uso para a operação ICCreateGLBatch.rsb. |
ICDayEndProcessing | Informações de uso para a operação ICDayEndProcessing.rsb. |
POCreateBatch | Informações de uso para a operação POCreateBatch.rsb. |
PODayEndProcessing | Informações de uso para a operação PODayEndProcessing.rsb. |
APCreateGLBatch¶
Informações de uso para a operação APCreateGLBatch.rsb.
Entrada¶
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
ProcessPaymentBatch | String | Falso | Valores possíveis: DoNotPostPaymentBatches, PostPaymentBatches |
ThruPaymentPostingSequenceNumber | String | Falso | Valores Possíveis: Número Decimal |
ProcessInvoiceBatch | String | Falso | Valores possíveis: DoNotPostInvoiceBatches, PostInvoiceBatches |
ThruInvoicePostingSequenceNumber | String | Falso | Valores Possíveis: Número Decimal |
ProcessAdjustmentBatch | String | Falso | Valores possíveis: DoNotPostAdjustmentBatches, PostAdjustmentBatches |
ThruAdjustmentPostingSequenceNumber | String | Falso | Valores Possíveis: Número Decimal |
ProcessRevalueBatch | String | Falso | Valores Possíveis: DoNotPostRevaluationBatches, PostRevaluationBatches |
ThruRevaluePostingSequenceNumber | String | Falso | Valores Possíveis: Número Decimal |
ActionSelector | String | Falso | Valores Possíveis: String Texto |
UpdateOperation | String | Falso | Valores Possíveis: Não Especificado, Atualizar, Inserir, Excluir |
Colunas do Conjunto de Resultados¶
Nome | Tipo | Descrição |
---|---|---|
Success | String | Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não. |
APCreateRecurringPayableBatch¶
Informações de uso para a operação APCreateRecurringPayableBatch.rsb.
Entrada¶
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
RunDate | String | Falso | Valores possíveis: DateTime |
Mode | String | Falso | Valores possíveis: Número inteiro |
SelectRecordsBy | String | Falso | Valores possíveis: RecurringPayableCode, VendorNumber, VendorGroup, ScheduleLink, SpecificRecurringChargeCode |
StartingRecurringPayableCode | String | Falso | Valores Possíveis: String Texto |
EndingRecurringPayableCode | String | Falso | Valores Possíveis: String Texto |
StartingVendorNumber | String | Falso | Valores Possíveis: String Texto |
EndingVendorNumber | String | Falso | Valores Possíveis: String Texto |
StartingVendorGroupCode | String | Falso | Valores Possíveis: String Texto |
EndingVendorGroupCode | String | Falso | Valores Possíveis: String Texto |
ScheduleKey | String | Falso | Valores Possíveis: String Texto |
ScheduleLink | String | Falso | Valores Possíveis: Número Decimal |
Status | String | Falso | Valores possíveis: Número inteiro |
DateGenerationMethod | String | Falso | Valores possíveis: RunDate, NextScheduleDate, SpecificDate |
BatchGenerationMethod | String | Falso | Valores possíveis: Padrão, CreateaNewBatch, AddToanExistingBatch |
ForcedInvoiceDate | String | Falso | Valores Possíveis: datetime |
AppendToBatchNumber | String | Falso | Valores Possíveis: Número Decimal |
ActionSelector | String | Falso | Valores Possíveis: String Texto |
UpdateOperation | String | Falso | Valores Possíveis: Não Especificado, Atualizar, Inserir, Excluir |
Colunas do Conjunto de Resultados¶
Nome | Tipo | Descrição |
---|---|---|
Success | String | Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não. |
APCreateRetainageDocumentBatch¶
Informações de uso para a operação APCreateRetainageDocumentBatch.rsb.
Entrada¶
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
RunDate | String | Falso | Valores Possíveis: datetime |
Mode | String | Falso | Valores possíveis: Número inteiro |
SelectRecordsBy | String | Falso | Valores possíveis: VendorNumber, DocumentNumber, VendorGroup |
StartingDocumentNumber | String | Falso | Valores Possíveis: String Texto |
EndingDocumentNumber | String | Falso | Valores Possíveis: String Texto |
StartingVendorNumber | String | Falso | Valores Possíveis: String Texto |
EndingVendorNumber | String | Falso | Valores Possíveis: String Texto |
StartingVendorGroupCode | String | Falso | Valores Possíveis: String Texto |
EndingVendorGroupCode | String | Falso | Valores Possíveis: String Texto |
IncludeInvoice | String | Falso | Valores Possíveis: Sim, Não |
IncludeDebitNote | String | Falso | Valores Possíveis: Sim, Não |
IncludeCreditNote | String | Falso | Valores Possíveis: Sim, Não |
DaysBeforeRetainageDue | String | Falso | Valores possíveis: Número inteiro |
CommandCode | String | Falso | Valores possíveis: UserRun, ScheduledRun |
Status | String | Falso | Valores possíveis: Número inteiro |
ActionSelector | String | Falso | Valores Possíveis: String Texto |
UpdateOperation | String | Falso | Valores Possíveis: Não Especificado, Atualizar, Inserir, Excluir |
Colunas do Conjunto de Resultados¶
Nome | Tipo | Descrição |
---|---|---|
Success | String | Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não. |
APDeleteInactiveRecords¶
Informações de uso para a operação APDeleteInactiveRecords.rsb.
Entrada¶
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
ClearFromVendorNumber | String | Falso | Valores Possíveis: String Texto |
ClearThruVendorNumber | String | Falso | Valores Possíveis: String Texto |
ClearFromGroupCode | String | Falso | Valores Possíveis: String Texto |
ClearThruGroupCode | String | Falso | Valores Possíveis: String Texto |
ClearRemitToFromVendorNumber | String | Falso | Valores Possíveis: String Texto |
ClearRemitToThruVendorNumber | String | Falso | Valores Possíveis: String Texto |
ClearFromDate | String | Falso | Valores Possíveis: Data/Hora |
ClearThruDate | String | Falso | Valores Possíveis: Data/Hora |
ClearInactiveVendors | String | Falso | Valores Possíveis: Sim, Não |
ClearInactiveGroups | String | Falso | Valores Possíveis: Sim, Não |
ClearInactiveRemitToLocation | String | Falso | Valores Possíveis: Sim, Não |
ClearInactiveRecurringPayable | String | Falso | Valores Possíveis: Sim, Não |
ClearFromRecurringPayable | String | Falso | Valores Possíveis: String Texto |
ClearThruRecurringPayable | String | Falso | Valores Possíveis: String Texto |
ActionSelector | String | Falso | Valores Possíveis: String Texto |
UpdateOperation | String | Falso | Valores Possíveis: Não Especificado, Atualizar, Inserir, Excluir |
Colunas do Conjunto de Resultados¶
Nome | Tipo | Descrição |
---|---|---|
Success | String | Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não. |
APós Faturas¶
Informações de uso para a operação APPostInvoices.rsb.
Entrada¶
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
ProcessAllBatches | String | Falso | Valores Possíveis: Donotpostallbatches, Postallbatches |
FromBatch | String | Falso | Valores Possíveis: Número Decimal |
ToBatch | String | Falso | Valores Possíveis: Número Decimal |
ActionSelector | String | Falso | Valores Possíveis: String Texto |
UpdateOperation | String | Falso | Valores Possíveis: Não Especificado, Atualizar, Inserir, Excluir |
Colunas do Conjunto de Resultados¶
Nome | Tipo | Descrição |
---|---|---|
Success | String | Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não. |
APósPagamentosEAjustes¶
Informações de uso para a operação APPostPaymentsAndAdjustments.rsb.
Entrada¶
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
BatchType | String | Falso | Valores Possíveis: String Texto |
PostAllBatches | String | Falso | Valores Possíveis: Donotpostallbatches, Postallbatches |
PostBatchFrom | String | Falso | Valores Possíveis: Número Decimal |
PostBatchTo | String | Falso | Valores Possíveis: Número Decimal |
ActionSelector | String | Falso | Valores Possíveis: String Texto |
UpdateOperation | String | Falso | Valores Possíveis: Não Especificado, Atualizar, Inserir, Excluir |
Colunas do Conjunto de Resultados¶
Nome | Tipo | Descrição |
---|---|---|
Success | String | Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não. |
ARCreateGLBatch¶
Informações de uso para a operação ARCreateGLBatch.rsb.
Entrada¶
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
ProcessReceiptBatch | String | Falso | Valores Possíveis: DonotpostCashbatches, PostCashbatches |
ReceiptThroughPostingSequenceNumber | String | Falso | Valores Possíveis: Número Decimal |
ProcessInvoiceBatch | String | Falso | Valores Possíveis: DonotpostInvoicebatches, PostInvoicebatches |
InvoiceThroughPostingSequenceNumber | String | Falso | Valores Possíveis: Número Decimal |
ProcessAdjustmentBatch | String | Falso | Valores Possíveis: DonotpostAdjustmentbatches, PostAdjustmentbatches |
AdjustmentThroughPostingSequenceNumber | String | Falso | Valores Possíveis: Número Decimal |
ProcessRevaluationBatch | String | Falso | Valores possíveis: DonotpostRevaluebatches, PostRevaluebatches |
RevaluationThroughPostingSequenceNumber | String | Falso | Valores Possíveis: Número Decimal |
ProcessRefundBatch | String | Falso | Valores Possíveis: DonotpostRefundbatches, PostRefundbatches |
RefundThroughPostingSequenceNumber | String | Falso | Valores Possíveis: Número Decimal |
ActionSelector | String | Falso | Valores Possíveis: String Texto |
UpdateOperation | String | Falso | Valores Possíveis: Não Especificado, Atualizar, Inserir, Excluir |
Colunas do Conjunto de Resultados¶
Nome | Tipo | Descrição |
---|---|---|
Success | String | Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não. |
ARCreateRecurringCharge¶
Informações de uso para a operação ARCreateRecurringCharge.rsb.
Entrada¶
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
RangeType | String | Falso | Valores possíveis: RecurringChargeCode, CustomerNumber, CustomerGroup, NationalAccount, ScheduleLink, SpecificRecurringChargeCode |
RangeFrom | String | Falso | Valores Possíveis: String Texto |
RangeThrough | String | Falso | Valores Possíveis: String Texto |
RunDate | String | Falso | Valores Possíveis: Data/Hora |
Mode | String | Falso | Valores possíveis: Número inteiro |
FiscalYear | String | Falso | Valores Possíveis: String Texto |
FiscalPeriod | String | Falso | Valores Possíveis: String Texto |
ScheduleKey | String | Falso | Valores Possíveis: String Texto |
ScheduleLink | String | Falso | Valores Possíveis: Número Decimal |
Status | String | Falso | Valores possíveis: Número inteiro |
DateGenerationMethod | String | Falso | Valores possíveis: RunDate, NextScheduleDate, SpecificDate |
BatchGenerationMethod | String | Falso | Valores possíveis: Padrão, CreatDecimaleaNewBatch, AddToanExistingBatch |
ForcedInvoiceDate | String | Falso | Valores Possíveis: Data/Hora |
AppendToBatchNumber | String | Falso | Valores Possíveis: Número Decimal |
ActionSelector | String | Falso | Valores Possíveis: String Texto |
UpdateOperation | String | Falso | Valores Possíveis: Não Especificado, Atualizar, Inserir, Excluir |
Colunas do Conjunto de Resultados¶
Nome | Tipo | Descrição |
---|---|---|
Success | String | Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não. |
ARCreateRetainageDocumentBatch¶
Informações de uso para a operação ARCreateRetainageDocumentBatch.rsb.
Entrada¶
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
RunDate | Date | Falso | Valores possíveis: DateTime |
Mode | String | Falso | Valores possíveis: Número inteiro |
SelectRecordsBy | String | Falso | Valores possíveis: VendorNumber, DocumentNumber, VendorGroup |
StartingDocumentNumber | String | Falso | Valores Possíveis: String Texto |
EndingDocumentNumber | String | Falso | Valores Possíveis: String Texto |
StartingCustomerNumber | String | Falso | Valores Possíveis: String Texto |
EndingCustomerNumber | String | Falso | Valores Possíveis: String Texto |
StartingCustomerGroupCode | String | Falso | Valores Possíveis: String Texto |
EndingCustomerGroupCode | String | Falso | Valores Possíveis: String Texto |
StartingNationalAccount | String | Falso | Valores Possíveis: String Texto |
EndingNationalAccount | String | Falso | Valores Possíveis: String Texto |
IncludeInvoice | String | Falso | Valores Possíveis: Não, Sim |
IncludeDebitNote | String | Falso | Valores Possíveis: Não, Sim |
IncludeCreditNote | String | Falso | Valores Possíveis: Não, Sim |
DaysBeforeRetainageDue | String | Falso | Valores possíveis: Número inteiro |
CommandCode | String | Falso | Valores possíveis: UserRun, ScheduledRun |
Status | String | Falso | Valores possíveis: Número inteiro |
ActionSelector | String | Falso | Valores Possíveis: String Texto |
UpdateOperation | String | Falso | Valores Possíveis: Não Especificado, Atualizar, Inserir, Excluir |
Colunas do Conjunto de Resultados¶
Nome | Tipo | Descrição |
---|---|---|
Success | String | Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não. |
AR PostInvoices¶
Informações de uso para a operação ARPostInvoices.rsb.
Entrada¶
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
PostAllBatches | String | Falso | Valores Possíveis: Donotpostallbatches, Postallbatches |
PostBatchFrom | String | Falso | Valores Possíveis: Número Decimal |
PostBatchTo | String | Falso | Valores Possíveis: Número Decimal |
ActionSelector | String | Falso | Valores Possíveis: String Texto |
UpdateOperation | String | Falso | Valores Possíveis: Não Especificado, Atualizar, Inserir, Excluir |
Colunas do Conjunto de Resultados¶
Nome | Tipo | Descrição |
---|---|---|
Success | String | Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não. |
ARPostReceiptsAndAdjustments¶
Informações de uso para a operação ARPostReceiptsAndAdjustments.rsb.
Entrada¶
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
BatchType | String | Falso | Valores Possíveis: String Texto |
PostAllBatches | String | Falso | Valores Possíveis: Donotpostallbatches, Postallbatches |
PostBatchFrom | String | Falso | Valores Possíveis: Número Decimal |
PostBatchTo | String | Falso | Valores Possíveis: Número Decimal |
ActionSelector | String | Falso | Valores Possíveis: String Texto |
UpdateOperation | String | Falso | Valores Possíveis: Não Especificado, Atualizar, Inserir, Excluir |
Colunas do Conjunto de Resultados¶
Nome | Tipo | Descrição |
---|---|---|
Success | String | Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não. |
ARPostRefunds¶
Informações de uso para a operação ARPostRefunds.rsb.
Entrada¶
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
PostAllBatches | String | Falso | Valores Possíveis: Donotpostallbatches, Postallbatches |
PostBatchFrom | String | Falso | Valores Possíveis: Número Decimal |
PostBatchTo | String | Falso | Valores Possíveis: Número Decimal |
ActionSelector | String | Falso | Valores Possíveis: String Texto |
UpdateOperation | String | Falso | Valores Possíveis: Não Especificado, Atualizar, Inserir, Excluir |
Colunas do Conjunto de Resultados¶
Nome | Tipo | Descrição |
---|---|---|
Success | String | Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não. |
Criar Esquema¶
Cria um arquivo de esquema para a tabela ou exibição especificada.
Entrada¶
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
TableName | String | Verdade | O nome da tabela ou visualização. |
FileName | String | Verdade | O caminho completo do arquivo e o nome do esquema a ser gerado. Ex: 'C:\Usuários\Usuário\Desktop\SmartSheet\sheet.rsd' |
Colunas do Conjunto de Resultados¶
Nome | Tipo | Descrição |
---|---|---|
Result | String | Retorna Sucesso ou Falha. |
GLPostJournal¶
Informações de uso para a operação GLPostJournal.rsb.
Entrada¶
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
PostAllBatchesSwitch | String | Falso | Valores Possíveis: PostbyBatchRange, PostallBatches |
ProvisionalPostSwitch | String | Falso | Valores possíveis: ActualPost, ProvisionalPost |
FromBatchNumber | String | Falso | Valores Possíveis: String Texto |
ToBatchNumber | String | Falso | Valores Possíveis: String Texto |
ErrorBatchCreatedSwitch | String | Falso | Valores Possíveis: Errorbatchnotcreated, Errorbatchcreated |
ActionSelector | String | Falso | Valores Possíveis: String Texto |
UpdateOperation | String | Falso | Valores Possíveis: Não Especificado, Atualizar, Inserir, Excluir |
Colunas do Conjunto de Resultados¶
Nome | Tipo | Descrição |
---|---|---|
Success | String | Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não. |
ICCreateGLBatch¶
Informações de uso para a operação ICCreateGLBatch.rsb.
Entrada¶
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
DayEndNumber | String | Falso | Valores possíveis: Número inteiro |
TransactionsCreated | String | Falso | Valores Possíveis: true, false |
ActionSelector | String | Falso | Valores Possíveis: String Texto |
UpdateOperation | String | Falso | Valores Possíveis: Não Especificado, Atualizar, Inserir, Excluir |
Colunas do Conjunto de Resultados¶
Nome | Tipo | Descrição |
---|---|---|
Success | String | Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não. |
ICDayEndProcessing¶
Informações de uso para a operação ICDayEndProcessing.rsb.
Entrada¶
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
ClearHistory | String | Falso | Valores Possíveis: true, false |
Application | String | Falso | Valores Possíveis: String Texto |
ProcessingType | String | Falso | Valores possíveis: Número inteiro |
TransactionNumber | String | Falso | Valores Possíveis: Número Decimal |
PostSequenceNumber | String | Falso | Valores possíveis: Número inteiro |
ActionSelector | String | Falso | Valores Possíveis: String Texto |
UpdateOperation | String | Falso | Valores Possíveis: Não Especificado, Atualizar, Inserir, Excluir |
Colunas do Conjunto de Resultados¶
Nome | Tipo | Descrição |
---|---|---|
Success | String | Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não. |
POCreateBatch¶
Informações de uso para a operação POCreateBatch.rsb.
Entrada¶
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
DayEndNumber | String | Falso | Valores Possíveis: Número Decimal |
TransactionsCreated | String | Falso | Valores Possíveis: true, false |
PostGLBatch | String | Falso | Valores Possíveis: true, false |
PostAPBatch | String | Falso | Valores Possíveis: true, false |
ActionSelector | String | Falso | Valores Possíveis: String Texto |
UpdateOperation | String | Falso | Valores Possíveis: Não Especificado, Atualizar, Inserir, Excluir |
Colunas do Conjunto de Resultados¶
Nome | Tipo | Descrição |
---|---|---|
Success | String | Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não. |
PODayEndProcessing¶
Informações de uso para a operação PODayEndProcessing.rsb.
Entrada¶
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
ClearHistory | String | Falso | Valores Possíveis: true, false |
Application | String | Falso | Valores Possíveis: String Texto |
ProcessingType | String | Falso | Valores possíveis: Número inteiro |
TransactionNumber | String | Falso | Valores Possíveis: Número Decimal |
PostSequenceNumber | String | Falso | Valores possíveis: Número inteiro |
ActionSelector | String | Falso | Valores Possíveis: String Texto |
UpdateOperation | String | Falso | Valores Possíveis: Não Especificado, Atualizar, Inserir, Excluir |
Colunas do Conjunto de Resultados¶
Nome | Tipo | Descrição |
---|---|---|
Success | String | Este valor mostra uma indicação booleana se a operação foi bem-sucedida ou não. |
Tabelas do Sistema¶
Você pode consultar as tabelas do sistema descritas nesta seção para acessar informações de esquema, informações sobre a funcionalidade da fonte de dados e estatísticas de operação em lote.
Tabelas de Esquema¶
As tabelas a seguir retornam os metadados do banco de dados para o Sage 300:
- sys_catalogs: Lista os bancos de dados disponíveis.
- sys_schemas: Lista os esquemas disponíveis.
- sys_tables: Lista as tabelas e exibições disponíveis.
- sys_tablecolumns: Descreve as colunas das tabelas e exibições disponíveis.
- sys_procedures: Descreve os procedimentos armazenados disponíveis.
- sys_procedureparameters: Descreve procedimento armazenado* parâmetros.
- sys_keycolumns: Descreve as chaves primárias e estrangeiras.
- sys_indexes: Descreve os índices disponíveis.
Tabelas de Fonte de Dados¶
As tabelas a seguir retornam informações sobre como se conectar e consultar a fonte de dados:
- sys_connection_props: Retorna informações sobre as propriedades de conexão disponíveis.
- sys_sqlinfo: Descreve as consultas SELECT que o conector pode descarregar para a fonte de dados.
Consultar Tabelas de Informações¶
A tabela a seguir retorna estatísticas de consultar para consultas de modificação de dados:
- sys_identity: Retorna informações sobre operações em lote ou atualizações únicas.
Sys_catalogs¶
Lista os bancos de dados disponíveis.
A consultar a seguir recupera todos os bancos de dados determinados pela string de conexão:
SELECT * FROM sys_catalogs
Colunas¶
Nome | Tipo | Descrição |
---|---|---|
CatalogName | String | O nome do banco de dados. |
Sys_schemas¶
Lista os esquemas disponíveis.
A consultar a seguir recupera todos os esquemas disponíveis:
SELECT * FROM sys_schemas
Colunas¶
Nome | Tipo | Descrição |
---|---|---|
CatalogName | String | O nome do banco de dados. |
SchemaName | String | O nome do esquema. |
Sys_tables¶
Lista as tabelas disponíveis.
A consultar a seguir recupera as tabelas e exibições disponíveis:
SELECT * FROM sys_tables
Colunas¶
Nome | Tipo | Descrição |
---|---|---|
CatalogName | String | O banco de dados que contém a tabela ou exibição. |
SchemaName | String | O esquema que contém a tabela ou exibição. |
TableName | String | O nome da tabela ou exibição. |
TableType | String | O tipo de tabela (tabela ou exibição). |
Description | String | Uma descrição da tabela ou exibição. |
IsUpdateable | Boolean | Se a tabela pode ser atualizada. |
Sys_tablecolumns¶
Descreve as colunas das tabelas e exibições disponíveis.
A consultar a seguir retorna as colunas e os tipos de dados da tabela OEInvoices:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='OEInvoices'
Colunas¶
Nome | Tipo | Descrição |
---|---|---|
CatalogName | String | O nome do banco de dados que contém a tabela ou exibição. |
SchemaName | String | O esquema que contém a tabela ou exibição. |
TableName | String | O nome da tabela ou exibição que contém a coluna. |
ColumnName | String | O nome da coluna. |
DataTypeName | String | O nome do tipo de dados. |
DataType | Int32 | Um número inteiro indicando o tipo de dados. Esse valor é determinado no tempo de execução com base no ambiente. |
Length | Int32 | O tamanho de armazenamento da coluna. |
DisplaySize | Int32 | A largura máxima normal da coluna designada em caracteres. |
NumericPrecision | Int32 | O número máximo de dígitos em dados numéricos. O comprimento da coluna em caracteres para caracteres e dados de data e hora. |
NumericScale | Int32 | A escala da coluna ou o número de dígitos à direita do ponto decimal. |
IsNullable | Boolean | Se a coluna pode conter null. |
Description | String | Uma breve descrição da coluna. |
Ordinal | Int32 | O número de sequência da coluna. |
IsAutoIncrement | String | Se o valor da coluna é atribuído em incrementos fixos. |
IsGeneratedColumn | String | Se a coluna é gerada. |
IsHidden | Boolean | Se a coluna está oculta. |
IsArray | Boolean | Se a coluna é uma matriz. |
Sys_procedures¶
Lista os procedimentos armazenados disponíveis.
A consultar a seguir recupera os procedimentos armazenados disponíveis:
SELECT * FROM sys_procedures
Colunas¶
Nome | Tipo | Descrição |
---|---|---|
CatalogName | String | O banco de dados que contém o procedimento armazenado. |
SchemaName | String | O esquema que contém o procedimento armazenado. |
ProcedureName | String | O nome do procedimento armazenado. |
Description | String | Uma descrição do procedimento armazenado. |
ProcedureType | String | O tipo do procedimento, como PROCEDURE ou FUNCTION. |
Sys_procedureparameters¶
Descreve procedimento armazenado* parâmetros.
A consultar a seguir retorna informações sobre todos os parâmetros de entrada para o procedimento armazenado APCreateGLBatch:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='APCreateGLBatch' AND Direction=1 OR Direction=2
Colunas¶
Nome | Tipo | Descrição |
---|---|---|
CatalogName | String | O nome do banco de dados que contém o procedimento armazenado. |
SchemaName | String | O nome do esquema que contém o procedimento armazenado. |
ProcedureName | String | O nome do procedimento armazenado* contendo o parâmetro. |
ColumnName | String | O nome do procedimento armazenado* parâmetro. |
Direction | Int32 | Um número inteiro correspondente ao tipo do parâmetro: entrada (1), entrada/saída (2) ou saída (4). parâmetros de tipo de entrada/saída podem ser parâmetros de entrada e saída. |
DataTypeName | String | O nome do tipo de dados. |
DataType | Int32 | Um número inteiro indicando o tipo de dados. Esse valor é determinado no tempo de execução com base no ambiente. |
Length | Int32 | O número de caracteres permitido para dados de caractere. O número de dígitos permitidos para dados numéricos. |
NumericPrecision | Int32 | A precisão máxima para dados numéricos. O comprimento da coluna em caracteres para caracteres e dados de data e hora. |
NumericScale | Int32 | O número de dígitos à direita do ponto decimal em dados numéricos. |
IsNullable | Boolean | Se o parâmetro pode conter null. |
IsRequired | Boolean | Se o parâmetro é necessário para a execução do procedimento. |
IsArray | Boolean | Se o parâmetro é uma matriz. |
Description | String | A descrição do parâmetro. |
Ordinal | Int32 | O índice do parâmetro. |
Sys_keycolumns¶
Descreve as chaves primárias e estrangeiras. A consultar a seguir recupera a chave primária da tabela OEInvoices:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='OEInvoices'
Colunas¶
Nome | Tipo | Descrição |
---|---|---|
CatalogName | String | O nome do banco de dados que contém a chave. |
SchemaName | String | O nome do esquema que contém a chave. |
TableName | String | O nome da tabela que contém a chave. |
ColumnName | String | O nome da coluna chave. |
IsKey | Boolean | Se a coluna é uma chave primária na tabela referenciada no campo TableName. |
IsForeignKey | Boolean | Se a coluna é uma chave estrangeira referenciada no campo TableName. |
PrimaryKeyName | String | O nome da chave primária. |
ForeignKeyName | String | O nome da chave estrangeira. |
ReferencedCatalogName | String | O banco de dados que contém a chave primária. |
ReferencedSchemaName | String | O esquema que contém a chave primária. |
ReferencedTableName | String | A tabela que contém a chave primária. |
ReferencedColumnName | String | O nome da coluna da chave primária. |
Sys_foreignkeys¶
Descreve as chaves estrangeiras. A consultar a seguir recupera todas as chaves estrangeiras que se referem a outras tabelas:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Colunas¶
Nome | Tipo | Descrição |
---|---|---|
CatalogName | String | O nome do banco de dados que contém a chave. |
SchemaName | String | O nome do esquema que contém a chave. |
TableName | String | O nome da tabela que contém a chave. |
ColumnName | String | O nome da coluna chave. |
PrimaryKeyName | String | O nome da chave primária. |
ForeignKeyName | String | O nome da chave estrangeira. |
ReferencedCatalogName | String | O banco de dados que contém a chave primária. |
ReferencedSchemaName | String | O esquema que contém a chave primária. |
ReferencedTableName | String | A tabela que contém a chave primária. |
ReferencedColumnName | String | O nome da coluna da chave primária. |
ForeignKeyType | String | Designa se a chave estrangeira é uma chave de importação (aponta para outras tabelas) ou de exportação (referenciada de outras tabelas). |
Sys_indexes¶
Descreve os índices disponíveis. Ao filtrar por índices, você pode escrever consultas mais seletivas com tempos de resposta de consultar mais rápidos.
A consultar a seguir recupera todos os índices que não são chaves primárias:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Colunas¶
Nome | Tipo | Descrição |
---|---|---|
CatalogName | String | O nome do banco de dados que contém o índice. |
SchemaName | String | O nome do esquema que contém o índice. |
TableName | String | O nome da tabela que contém o índice. |
IndexName | String | O nome do índice. |
ColumnName | String | O nome da coluna associada ao índice. |
IsUnique | Boolean | True se o índice for exclusivo. Falso caso contrário. |
IsPrimary | Boolean | Verdadeiro se o índice for uma chave primária. Falso caso contrário. |
Type | Int16 | Um valor inteiro correspondente ao tipo de índice: estatística (0), agrupado (1), hash (2) ou outro (3). |
SortOrder | String | A ordem de classificação: A para crescente ou D para decrescente. |
OrdinalPosition | Int16 | O número de sequência da coluna no índice. |
Sys_connection_props¶
Retorna informações sobre as propriedades de conexão disponíveis e as definidas na string de conexão.
Ao consultar esta tabela, a string de conexão de configuração deve ser usada:
jdbc:cdata:sage300:config:
Esta string de conexão permite que você consultar esta tabela sem uma conexão válida.
A consultar a seguir recupera todas as propriedades de conexão que foram definidas na string de conexão ou definidas por meio de um valor padrão:
SELECT * FROM sys_connection_props WHERE Value <> ''
Colunas¶
Nome | Tipo | Descrição |
---|---|---|
Name | String | O nome da propriedade de conexão. |
ShortDescription | String | Uma breve descrição. |
Type | String | O tipo de dados da propriedade de conexão. |
Default | String | O valor padrão, se não houver um definido explicitamente. |
Values | String | Uma lista separada por vírgulas de valores possíveis. Um erro de validação é lançado se outro valor for especificado. |
Value | String | O valor que você definiu ou um padrão pré-configurado. |
Required | Boolean | Se a propriedade é necessária para se conectar. |
Category | String | A categoria da propriedade de conexão. |
IsSessionProperty | String | Se a propriedade é uma propriedade de sessão, usada para salvar informações sobre a conexão atual. |
Sensitivity | String | O nível de sensibilidade da propriedade. Isso informa se a propriedade está ofuscada nos formulários de registro e autenticação. |
PropertyName | String | Uma forma truncada em camel case do nome da propriedade de conexão. |
Ordinal | Int32 | O índice do parâmetro. |
CatOrdinal | Int32 | O índice da categoria do parâmetro. |
Hierarchy | String | Mostra as propriedades dependentes associadas que precisam ser definidas juntamente com esta. |
Visible | Boolean | Informa se a propriedade está visível na UI da conexão. |
ETC | String | Diversas informações diversas sobre o imóvel. |
Sys_sqlinfo¶
Descreve o processamento da consultar SELECT que o conector pode transferir para a fonte de dados.
Processamento de Consultas Colaborativas¶
Ao trabalhar com fontes de dados que não suportam SQL-92, você pode consultar a exibição sys_sqlinfo para determinar os recursos de consultar das APIs subjacentes, expressas na sintaxe SQL. O conector transfere o máximo possível do processamento da instrução SELECT para o servidor e, em seguida, processa o restante da consultar na memória.
Descobrindo os Recursos SELECT da Fonte de Dados¶
Abaixo está um exemplo de conjunto de dados de recursos SQL. O conjunto de resultados a seguir indica a funcionalidade SELECT que o conector pode descarregar para a fonte de dados ou processar o lado do cliente. Sua fonte de dados pode suportar sintaxe SQL adicional. Alguns aspectos da funcionalidade SELECT são retornados em uma lista separada por vírgulas, se suportados; caso contrário, a coluna contém NO.
Nome | Descrição | Valores Possíveis |
---|---|---|
AGGREGATE_FUNCTIONS | Funções de agregação suportadas. | AVG , COUNT , MAX , MIN , SUM , DISTINCT |
COUNT | Se a função COUNT é suportada. | YES , NO |
IDENTIFIER_QUOTE_OPEN_CHAR | O caractere de abertura usado para escapar de um identificador. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | O caractere de fechamento usado para escapar de um identificador. | ] |
SUPPORTED_OPERATORS | Uma lista de operadores SQL com suporte. | = , > , < , >= , <= , <> , != , LIKE , NOT LIKE , IN , NOT IN , IS NULL , IS NOT NULL , AND , OR |
GROUP_BY | Se GROUP BY é compatível e, em caso afirmativo, o grau de suporte. | NO , NO_RELATION , EQUALS_SELECT , SQL_GB_COLLATE |
STRING_FUNCTIONS | Funções de string suportadas. | LENGTH , CHAR , LOCATE , REPLACE , SUBSTRING , RTRIM , LTRIM , RIGHT , LEFT , UCASE , SPACE , SOUNDEX , LCASE , CONCAT , ASCII , REPEAT , OCTET , BIT , POSITION , INSERT , TRIM , UPPER , REGEXP , LOWER , DIFFERENCE , CHARACTER , SUBSTR , STR , REVERSE , PLAN , UUIDTOSTR , TRANSLATE , TRAILING , TO , STUFF , STRTOUUID , STRING , SPLIT , SORTKEY , SIMILAR , REPLICATE , PATINDEX , LPAD , LEN , LEADING , KEY , INSTR , INSERTSTR , HTML , GRAPHICAL , CONVERT , COLLATION , CHARINDEX , BYTE |
NUMERIC_FUNCTIONS | Funções numéricas suportadas. | ABS , ACOS , ASIN , ATAN , ATAN2 , CEILING , COS , COT , EXP , FLOOR , LOG , MOD , SIGN , SIN , SQRT , TAN , PI , RAND , DEGREES , LOG10 , POWER , RADIANS , ROUND , TRUNCATE |
TIMEDATE_FUNCTIONS | Funções de data/hora suportadas. | NOW , CURDATE , DAYOFMONTH , DAYOFWEEK , DAYOFYEAR , MONTH , QUARTER , WEEK , YEAR , CURTIME , HOUR , MINUTE , SECOND , TIMESTAMPADD , TIMESTAMPDIFF , DAYNAME , MONTHNAME , CURRENT_DATE , CURRENT_TIME , CURRENT_TIMESTAMP , EXTRACT |
REPLICATION_SKIP_TABLES | Indica tabelas ignoradas durante a replicação. | |
REPLICATION_TIMECHECK_COLUMNS | Uma matriz de string contendo uma lista de colunas que serão usadas para verificar (na ordem especificada) para usar como uma coluna modificada durante a replicação. | |
IDENTIFIER_PATTERN | Valor de string que indica qual string é válida para um identificador. | |
SUPPORT_TRANSACTION | Indica se o provedor oferece suporte a transações como confirmação e reversão. | YES , NO |
DIALECT | Indica o dialeto SQL a ser usado. | |
KEY_PROPERTIES | Indica as propriedades que identificam o banco de dados uniforme. | |
SUPPORTS_MULTIPLE_SCHEMAS | Indica se vários esquemas podem existir para o provedor. | YES , NO |
SUPPORTS_MULTIPLE_CATALOGS | Indica se vários catálogos podem existir para o provedor. | YES , NO |
DATASYNCVERSION | A versão do Data Sync necessária para acessar este driver. | Standard , Starter , Professional , Enterprise |
DATASYNCCATEGORY | A categoria Data Sync deste driver. | Source , Destination , Cloud Destination |
SUPPORTSENHANCEDSQL | Se a funcionalidade SQL aprimorada além do que é oferecido pela API é suportada. | TRUE , FALSE |
SUPPORTS_BATCH_OPERATIONS | Se as operações em lote são suportadas. | YES , NO |
SQL_CAP | Todos os recursos SQL suportados para este driver. | SELECT , INSERT , DELETE , UPDATE , TRANSACTIONS , ORDERBY , OAUTH , ASSIGNEDID , LIMIT , LIKE , BULKINSERT , COUNT , BULKDELETE , BULKUPDATE , GROUPBY , HAVING , AGGS , OFFSET , REPLICATE , COUNTDISTINCT , JOINS , DROP , CREATE , DISTINCT , INNERJOINS , SUBQUERIES , ALTER , MULTIPLESCHEMAS , GROUPBYNORELATION , OUTERJOINS , UNIONALL , UNION , UPSERT , GETDELETED , CROSSJOINS , GROUPBYCOLLATE , MULTIPLECATS , FULLOUTERJOIN , MERGE , JSONEXTRACT , BULKUPSERT , SUM , SUBQUERIESFULL , MIN , MAX , JOINSFULL , XMLEXTRACT , AVG , MULTISTATEMENTS , FOREIGNKEYS , CASE , LEFTJOINS , COMMAJOINS , WITH , LITERALS , RENAME , NESTEDTABLES , EXECUTE , BATCH , BASIC , INDEX |
PREFERRED_CACHE_OPTIONS | Um valor de string especifica o cacheOptions preferencial. | |
ENABLE_EF_ADVANCED_QUERY | Indica se o driver oferece suporte direto a consultas avançadas provenientes do Entity Framework. Caso contrário, as consultas serão tratadas no lado do cliente. | YES , NO |
PSEUDO_COLUMNS | Uma matriz de cadeia de caracteres que indica as pseudocolunas disponíveis. | |
MERGE_ALWAYS | Se o valor for verdadeiro, o modo de mesclagem será executado à força no Data Sync. | TRUE , FALSE |
REPLICATION_MIN_DATE_QUERY | Uma consultar de seleção para retornar a data e hora de início da replicação. | |
REPLICATION_MIN_FUNCTION | Permite que um provedor especifique o nome da fórmula a ser usado para executar um min do lado do servidor. | |
REPLICATION_START_DATE | Permite que um provedor especifique uma data de início de replicação. | |
REPLICATION_MAX_DATE_QUERY | Uma consultar de seleção para retornar a data e hora de término da replicação. | |
REPLICATION_MAX_FUNCTION | Permite que um provedor especifique o nome da fórmula a ser usado para executar um máximo do lado do servidor. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | Uma lista de tabelas que ignorará a divisão da replicação em blocos na replicação inicial. | |
CHECKCACHE_USE_PARENTID | Indica se a instrução CheckCache deve ser executada na coluna de chave pai. | TRUE , FALSE |
CREATE_SCHEMA_PROCEDURES | Indica procedimentos armazenados* que pode ser usado para gerar arquivos de esquema. |
A consultar a seguir recupera os operadores que podem ser usados na cláusula WHERE:
SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'
Observe que tabelas individuais podem ter diferentes limitações ou requisitos na cláusula WHERE; consulte o Modelo de Dados para obter mais informações.
Colunas¶
Nome | Tipo | Descrição |
---|---|---|
NAME | String | Um componente da sintaxe SQL ou um recurso que pode ser processado no servidor. |
VALUE | String | Detalhes sobre a sintaxe SQL ou SQL suportada. |
Sys_identity¶
Retorna informações sobre tentativas de modificação.
A consultar a seguir recupera os IDs das linhas modificadas em uma operação em lote:
SELECT * FROM sys_identity
Colunas¶
Nome | Tipo | Descrição |
---|---|---|
Id | String | O ID gerado pelo banco de dados retornado de uma operação de modificação de dados. |
Batch | String | Um identificador para o lote. 1 para uma única operação. |
Operation | String | O resultado da operação no lote: INSERTED, UPDATED ou DELETED. |
Message | String | SUCCESS ou uma mensagem de erro se a atualização no lote falhou. |
Propriedades de Configurações Avançadas¶
As propriedades de configurações avançadas são as várias opções que podem ser usadas para estabelecer uma conexão. Esta seção fornece uma lista completa das opções que você pode configurar. Clique nos links para mais detalhes.
Propriedade | Descrição |
---|---|
URL | Defina o URL para o endpoint HTTP ou HTTPS do seu sistema Sage 300. Por exemplo, http://localhost/Sage300WebApi/v1.0/-/ . |
User | A conta de usuário do Sage 300 usada para autenticação. |
Password | A senha usada para autenticar o usuário. |
Propriedade | Descrição |
---|---|
Company | Determina a empresa. |
Modules | Lista separada por vírgulas de módulos. |
Propriedade | Descrição |
---|---|
SSLServerCert | O certificado a ser aceito do servidor ao conectar usando TLS/SSL. |
Propriedade | Descrição |
---|---|
Location | Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados. |
BrowsableSchemas | Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tables=TableA, TableB, TableC. |
Views | Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA, ViewB, ViewC. |
Propriedade | Descrição |
---|---|
IncludeCustomFields | Determina se os Campos Personalizados devem ser incluídos como colunas da tabela ou não. |
MaxRows | Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design. |
Other | Essas propriedades ocultas são usadas apenas em casos de uso específicos. |
PseudoColumns | Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela. |
RowScanDepth | O número máximo de linhas a serem verificadas para procurar as colunas disponíveis em uma tabela. |
Timeout | O valor em segundos até que o erro de timeout seja lançado, cancelando a operação. |
Autenticação¶
Esta seção fornece uma lista completa de propriedades de autenticação que você pode configurar.
Propriedade | Descrição |
---|---|
URL | Defina o URL para o endpoint HTTP ou HTTPS do seu sistema Sage 300. Por exemplo, http://localhost/Sage300WebApi/v1.0/-/ . |
User | A conta de usuário do Sage 300 usada para autenticação. |
Password | A senha usada para autenticar o usuário. |
URL¶
Defina o URL para o endpoint HTTP ou HTTPS do seu sistema Sage 300. Por exemplo, http://localhost/Sage300WebApi/v1.0/-/
.
Tipo de Dados¶
string
Valor Padrão¶
""
Observações¶
Defina o URL para o endpoint HTTP ou HTTPS do seu sistema Sage 300 um URL para o Sage 300 Web API da seguinte forma: {protocol}://{host-application-path}/v{version}/{tenant}/
Por exemplo, http://localhost/Sage300WebApi/v1.0/-/
.
Do Utilizador¶
A conta de usuário do Sage 300 usada para autenticação.
Tipo de Dados¶
string
Valor Padrão¶
""
Observações¶
Juntamente com Senha, este campo é usado para autenticação no servidor Sage 300.
Senha¶
A senha usada para autenticar o usuário.
Tipo de Dados¶
string
Valor Padrão¶
""
Observações¶
O usuário e Password
são usados juntos para autenticar com o servidor.
Conexão¶
Esta seção fornece uma lista completa de propriedades de conexão que você pode configurar.
Propriedade | Descrição |
---|---|
Company | Determina a empresa. |
Modules | Lista separada por vírgulas de módulos. |
Empresa¶
Determina a empresa.
Tipo de Dados¶
string
Valor Padrão¶
""
Observações¶
Especifique a empresa da qual deseja obter os dados. Se não for especificado, a primeira empresa encontrada no endpoint /Empresas será escolhida.
Módulos¶
Lista separada por vírgulas de módulos.
Tipo de Dados¶
string
Valor Padrão¶
"\*"
Observações¶
Lista separada por vírgulas de módulos. (Use esta propriedade de conexão para ter acesso apenas nos módulos desejados. Isso irá melhorar o desempenho dos metadados recuperados.) Opções: AP(Contas a Pagar), AR(Contas a Receber), BK(Bancos), CS(Serviços Comuns), GL (contabilidade geral), IC (controle de estoque), OE (entrada de pedido), PO (pedidos de compra), TX (rastreamento de impostos)
SSL¶
Esta seção fornece uma lista completa de propriedades SSL que você pode configurar.
Propriedade | Descrição |
---|---|
SSLServerCert | O certificado a ser aceito do servidor ao conectar usando TLS/SSL. |
SSLServerCert¶
O certificado a ser aceito do servidor ao conectar usando TLS/SSL.
Tipo de Dados¶
string
Valor Padrão¶
""
Observações¶
Se estiver usando uma conexão TLS/SSL, esta propriedade pode ser usada para especificar o certificado TLS/SSL a ser aceito do servidor. Qualquer outro certificado que não seja confiável para a máquina é rejeitado.
Esta propriedade pode assumir as seguintes formas:
Descrição | Exemplo |
---|---|
Um certificado PEM completo (exemplo abreviado para concisão) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
Um caminho para um arquivo local contendo o certificado | C:\cert.cer |
A chave pública (exemplo abreviado para concisão) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
O Thumbprint MD5 (os valores hexadecimais também podem ser separados por espaço ou dois-pontos) | ecadbdda5a1529c58a1e9e09828d70e4 |
A impressão digital SHA1 (os valores hexadecimais também podem ser separados por espaço ou dois-pontos) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Se não for especificado, qualquer certificado confiável pela máquina será aceito.
Os certificados são validados como confiáveis pela máquina com base no armazenamento confiável do sistema. O armazenamento confiável usado é o valor 'javax.net.ssl.trustStore' especificado para o sistema. Se nenhum valor for especificado para esta propriedade, o armazenamento confiável padrão do Java será usado (por exemplo, JAVA_HOME\lib\security\cacerts).
Use '*' para indicar a aceitação de todos os certificados. Observe que isso não é recomendado devido a questões de segurança.
Esquema¶
Esta seção fornece uma lista completa de propriedades de esquema que você pode configurar.
Propriedade | Descrição |
---|---|
Location | Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados. |
BrowsableSchemas | Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tables=TableA, TableB, TableC. |
Views | Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA, ViewB, ViewC. |
Localização¶
Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.
Tipo de Dados¶
string
Valor Padrão¶
"%APPDATA%\\\Sage300 Data Provider\\Schema"
Observações¶
O caminho para um diretório que contém os arquivos de esquema para o conector (arquivos .rsd para tabelas e exibições, arquivos .rsb para procedimentos armazenados). A localização da pasta pode ser um caminho relativo a partir da localização do executável. O Location
a propriedade só é necessária se você quiser personalizar definições (por exemplo, alterar um nome de coluna, ignorar uma coluna e assim por diante) ou estender o modelo de dados com novas tabelas, exibições ou procedimentos armazenados.
Se não for especificado, o local padrão é "%APPDATA%\\Sage300 Data Provider\Schema" com %APPDATA%
sendo definido para o diretório de configuração do usuário:
Plataforma | %APPDATA% |
---|---|
Windows | O valor da variável de ambiente APPDATA |
Mac | ~/Biblioteca/Suporte de aplicativos |
Linux | ~/.config |
Esquemas Navegáveis¶
Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tipo de Dados¶
string
Valor Padrão¶
""
Observações¶
Listar os esquemas de bancos de dados pode ser caro. Fornecer uma lista de esquemas na string de conexão melhora o desempenho.
Tabelas¶
Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tabelas=TabelaA,TabelaB,TabelaC.
Tipo de Dados¶
string
Valor Padrão¶
""
Observações¶
Listar as tabelas de alguns bancos de dados pode ser caro. Fornecer uma lista de tabelas na string de conexão melhora o desempenho do conector.
Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitas para trabalhar.
Especifique as tabelas que deseja em uma lista separada por vírgulas. Cada tabela deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.
Visualizações¶
Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA,ViewB,ViewC.
Tipo de Dados¶
string
Valor Padrão¶
""
Observações¶
Listar as exibições de alguns bancos de dados pode ser caro. Fornecer uma lista de exibições na string de conexão melhora o desempenho do conector.
Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitos para trabalhar.
Especifique as exibições desejadas em uma lista separada por vírgulas. Cada exibição deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.
Diversos¶
Esta seção fornece uma lista completa de diversas propriedades que você pode configurar.
Propriedade | Descrição |
---|---|
IncludeCustomFields | Determina se os Campos Personalizados devem ser incluídos como colunas da tabela ou não. |
MaxRows | Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design. |
Other | Essas propriedades ocultas são usadas apenas em casos de uso específicos. |
PseudoColumns | Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela. |
RowScanDepth | O número máximo de linhas a serem verificadas para procurar as colunas disponíveis em uma tabela. |
Timeout | O valor em segundos até que o erro de timeout seja lançado, cancelando a operação. |
IncludeCustomFields¶
Determina se os Campos Personalizados devem ser incluídos como colunas da tabela ou não.
Tipo de Dados¶
bool
Valor Padrão¶
false
Observações¶
Para recuperar seus valores, você pode definir IncludeCustomFields=true como uma propriedade de conexão. Isso listará os campos personalizados criados como colunas da tabela.
MaxRows¶
Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.
Tipo de Dados¶
int
Valor Padrão¶
-1
Observações¶
Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.
Outro¶
Essas propriedades ocultas são usadas apenas em casos de uso específicos.
Tipo de Dados¶
string
Valor Padrão¶
""
Observações¶
As propriedades listadas abaixo estão disponíveis para casos de uso específicos. Casos de uso de driver normal e funcionalidade não devem exigir essas propriedades.
Especifique várias propriedades em uma lista separada por ponto e vírgula.
Integração e Formatação¶
Propriedade | Descrição |
---|---|
DefaultColumnSize | Define o comprimento padrão dos campos de string quando a fonte de dados não fornece o comprimento da coluna nos metadados. O valor padrão é 2000. Voltar para o início |
ConvertDateTimeToGMT | Determina se os valores de data e hora devem ser convertidos em GMT, em vez da hora local da máquina. |
RecordToFile=filename | Registra a transferência de dados do soquete subjacente para o arquivo especificado. |
Pseudocolunas¶
Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.
Tipo de Dados¶
string
Valor Padrão¶
""
Observações¶
Essa configuração é particularmente útil no Entity Framework, que não permite definir um valor para uma pseudocoluna, a menos que seja uma coluna de tabela. O valor dessa configuração de conexão está no formato "Table1=Column1, Table1=Column2, Table2=Column3". Você pode usar o caractere "*" para incluir todas as tabelas e todas as colunas; por exemplo, "*=*".
RowScanDepth¶
O número máximo de linhas a serem verificadas para procurar as colunas disponíveis em uma tabela.
Tipo de Dados¶
int
Valor Padrão¶
100
Observações¶
As colunas em uma tabela devem ser determinadas pela varredura das linhas da tabela. Esse valor determina o número máximo de linhas que serão verificadas.
Definir um valor alto pode diminuir o desempenho. Definir um valor baixo pode impedir que o tipo de dados seja determinado corretamente, especialmente quando houver dados nulos.
Tempo Esgotado¶
O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.
Tipo de Dados¶
int
Valor Padrão¶
60
Observações¶
Se Timeout
= 0, as operações não expiram. As operações são executadas até serem concluídas com êxito ou até encontrarem uma condição de erro.
Se Timeout
expira e a operação ainda não está concluída, o conector lança uma exceção.