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. O Group 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 o Group ID, Group Description e verifique qualquer uma das permissões, incluindo o Sage 300 Web API permissão. Por último clique Add(por cada aplicação necessária)
• Ou selecione um existente Security Group você vai atribuir ao usuário em Group ID e marque Sage 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/existente User
• Agora para cada Application atribuir o Group 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

APCreateGLBatch

Informações de uso para a operação APCreateGLBatch.rsb.

Entrada

Colunas do Conjunto de Resultados

APCreateRecurringPayableBatch

Informações de uso para a operação APCreateRecurringPayableBatch.rsb.

Entrada

Colunas do Conjunto de Resultados

APCreateRetainageDocumentBatch

Informações de uso para a operação APCreateRetainageDocumentBatch.rsb.

Entrada

Colunas do Conjunto de Resultados

APDeleteInactiveRecords

Informações de uso para a operação APDeleteInactiveRecords.rsb.

Entrada

Colunas do Conjunto de Resultados

APós Faturas

Informações de uso para a operação APPostInvoices.rsb.

Entrada

Colunas do Conjunto de Resultados

APósPagamentosEAjustes

Informações de uso para a operação APPostPaymentsAndAdjustments.rsb.

Entrada

Colunas do Conjunto de Resultados

ARCreateGLBatch

Informações de uso para a operação ARCreateGLBatch.rsb.

Entrada

Colunas do Conjunto de Resultados

ARCreateRecurringCharge

Informações de uso para a operação ARCreateRecurringCharge.rsb.

Entrada

Colunas do Conjunto de Resultados

ARCreateRetainageDocumentBatch

Informações de uso para a operação ARCreateRetainageDocumentBatch.rsb.

Entrada

Colunas do Conjunto de Resultados

AR PostInvoices

Informações de uso para a operação ARPostInvoices.rsb.

Entrada

Colunas do Conjunto de Resultados

ARPostReceiptsAndAdjustments

Informações de uso para a operação ARPostReceiptsAndAdjustments.rsb.

Entrada

Colunas do Conjunto de Resultados

ARPostRefunds

Informações de uso para a operação ARPostRefunds.rsb.

Entrada

Colunas do Conjunto de Resultados

Criar Esquema

Cria um arquivo de esquema para a tabela ou exibição especificada.

Entrada

Colunas do Conjunto de Resultados

GLPostJournal

Informações de uso para a operação GLPostJournal.rsb.

Entrada

Colunas do Conjunto de Resultados

ICCreateGLBatch

Informações de uso para a operação ICCreateGLBatch.rsb.

Entrada

Colunas do Conjunto de Resultados

ICDayEndProcessing

Informações de uso para a operação ICDayEndProcessing.rsb.

Entrada

Colunas do Conjunto de Resultados

POCreateBatch

Informações de uso para a operação POCreateBatch.rsb.

Entrada

Colunas do Conjunto de Resultados

PODayEndProcessing

Informações de uso para a operação PODayEndProcessing.rsb.

Entrada

Colunas do Conjunto de Resultados

Tabelas do Sistema

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

Tabelas de Esquema

As tabelas a seguir retornam os metadados do banco de dados para o 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

Sys_schemas

Lista os esquemas disponíveis.

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

SELECT * FROM sys_schemas

Colunas

Sys_tables

Lista as tabelas disponíveis.

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

SELECT * FROM sys_tables

Colunas

Sys_tablecolumns

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

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

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

Colunas

Sys_procedures

Lista os procedimentos armazenados disponíveis.

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

SELECT * FROM sys_procedures

Colunas

Sys_procedureparameters

Descreve procedimento armazenado* parâmetros.

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

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

Colunas

Sys_keycolumns

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

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

Colunas

Sys_foreignkeys

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

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Colunas

Sys_indexes

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

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

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Colunas

Sys_connection_props

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

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

jdbc:cdata: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

Sys_sqlinfo

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

Processamento de Consultas Colaborativas

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

Descobrindo os Recursos SELECT da Fonte de Dados

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

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

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

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

Colunas

Sys_identity

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

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

SELECT * FROM sys_identity

Colunas

Propriedades de Configurações Avançadas

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

Autenticação

Conexão

SSL

Esquema

Diversos

Autenticação

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

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.

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.

SSLServerCert

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

Tipo de Dados

string

Valor Padrão

""

Observações

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

Esta propriedade pode assumir as seguintes formas:

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

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

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

Esquema

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

Localização

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

Tipo de Dados

string

Valor Padrão

"%APPDATA%\\\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:

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.

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

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.