Ir para o conteúdo

Detalhes da conexão do ServiceNow

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.

Para obter mais informações sobre como estabelecer uma conexão, consulte Conexão ServiceNow.

Autenticação

Propriedade Descrição
Esquema de autenticação O esquema de autorização a ser usado quando a autorização do servidor for executada.
URL A URL base da sua instância do ServiceNow.
Usuário A conta de usuário do ServiceNow usada para autenticação.
Senha A senha usada para autenticar o usuário.

SSO

Propriedade Descrição
URL de login do SSO URL de login do provedor de identidade.
SSOPropriedades Propriedades adicionais necessárias para conectar-se ao provedor de identidade em uma lista separada por ponto e vírgula.

OAuth

Propriedade Descrição
IniciarOAuth Defina esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth quando você se conectar.
OAuthClientId O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthClientSecret O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
Token de acesso OAuth O token de acesso para conexão usando OAuth.
Localização das configurações do OAuth O local do arquivo de configurações onde os valores OAuth são salvos quando InitiateOAuth é definido como GETANDREFRESH ou REFRESH. Como alternativa, isso pode ser mantido na memória especificando um valor começando com memory://.
URL de retorno de chamada A URL de retorno de chamada do OAuth para retornar ao autenticar. Este valor deve corresponder à URL de retorno de chamada que você especificar nas configurações do seu aplicativo.
Tipo de Concessão OAuth O tipo de concessão para o fluxo OAuth.
VerificadorOAuth O código do verificador retornado da URL de autorização do OAuth.
Token de atualização do OAuth O token de atualização OAuth para o token de acesso OAuth correspondente.
OAuthExpiraEm O tempo de vida em segundos do OAuth AccessToken.
Carimbo de data/hora do OAuthToken O registro de data e hora da época do Unix em milissegundos quando o Token de Acesso atual foi criado.

SSL

Propriedade Descrição
Certificado de Servidor SSL O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

Firewall

Propriedade Descrição
Tipo de Firewall O protocolo usado por um firewall baseado em proxy.
Servidor de Firewall O nome ou endereço IP de um firewall baseado em proxy.
Porta do Firewall A porta TCP para um firewall baseado em proxy.
Usuário do Firewall O nome de usuário a ser usado para autenticação com um firewall baseado em proxy.
Senha do Firewall Uma senha usada para autenticação em um firewall baseado em proxy.

Procurador

Propriedade Descrição
Detecção Automática de Proxy Quando esta propriedade de conexão é definida como true, o provedor verifica as configurações de proxy do seu sistema para configurações de servidor proxy existentes (não há necessidade de fornecer manualmente os detalhes do servidor proxy). Defina como false se quiser configurar manualmente o provedor para se conectar a um servidor proxy específico.
Servidor Proxy O nome do host ou endereço IP do servidor proxy pelo qual você deseja rotear o tráfego HTTP.
Porta proxy A porta TCP na qual o servidor proxy (especificado na propriedade de conexão ProxyServer) está sendo executado.
Esquema de autenticação do proxy O método de autenticação que o provedor usa ao autenticar no servidor proxy especificado na propriedade de conexão ProxyServer.
Usuário Proxy O nome de usuário de uma conta de usuário registrada no servidor proxy especificado na propriedade de conexão ProxyServer.
Senha do Proxy A senha associada ao usuário especificado na propriedade de conexão ProxyUser.
Tipo ProxySSL O tipo SSL a ser usado ao conectar-se ao proxy ProxyServer.
Exceções de Proxy Uma lista separada por ponto e vírgula de nomes de host de destino ou IPs que estão isentos de conexão por meio do ProxyServer.

Registro

Propriedade Descrição
Arquivo de log Um caminho de arquivo que designa o nome e o local do arquivo de log.
Verbosidade O nível de verbosidade que determina a quantidade de detalhes incluídos no arquivo de log.
Módulos de Log Módulos principais a serem incluídos no arquivo de log.
TamanhoMáximoDoArquivoDeLog Uma string especificando o tamanho máximo em bytes para um arquivo de log (por exemplo, 10 MB).
Contagem Máxima de Arquivos de Log Uma string especificando a contagem máxima de arquivos de log.

Esquema

Propriedade Descrição
Localização Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, visualizações e procedimentos armazenados.
Esquemas Navegáveis Esta propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tabelas Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tables=TableA,TableB,TableC.
Visualizações Restringe as visualizações reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA,ViewB,ViewC.
IncluirVisualizaçõesDeBancoDeDados Controla se as visualizações do banco de dados devem ser expostas ou não.
IncluirTabelasDoSistema Controla se as tabelas do sistema devem ser expostas ou não.

Cache

Propriedade Descrição
AutoCache Armazena em cache automaticamente os resultados de consultas SELECT em um banco de dados de cache especificado por CacheLocation ou CacheConnection e CacheProvider.
Driver de cache O driver de banco de dados usado para armazenar dados em cache.
Conexão de Cache A string de conexão para o banco de dados de cache. Esta propriedade é sempre usada em conjunto com CacheProvider. Definir ambas as propriedades substituirá o valor definido para CacheLocation para armazenar dados em cache.
Localização do cache Especifica o caminho para o cache ao armazenar em cache um arquivo.
Tolerância de cache A tolerância para dados obsoletos no cache especificada em segundos ao usar o AutoCache.
Off-line Use o modo offline para obter os dados do cache em vez da fonte ativa.
Metadados de cache Esta propriedade determina se os metadados da tabela devem ou não ser armazenados em cache em um armazenamento de arquivos.

Formatação de Dados

Propriedade Descrição
PushEmptyValuesAsNull Indica se os valores vazios devem ser lidos como vazios ou nulos.

Diversos

Propriedade Descrição
Tamanho do lote O tamanho máximo de cada operação em lote a ser enviada.
Tempo de vida da conexão O tempo máximo de vida de uma conexão em segundos. Uma vez decorrido o tempo, o objeto de conexão é descartado.
ConectarEmAbrir Esta propriedade especifica se deve se conectar ao ServiceNow quando a conexão for aberta.
ValorExibido Com base nesse valor, o provedor recupera o valor de exibição ou o valor real do banco de dados.
NomedaColunaExibirValor Padrão para exibir nomes de colunas quando a propriedade DisplayValue está definida como ALL.
AplicarValoresColuna Controla se os valores disponíveis para um elemento são recuperados e verificados ao executar instruções INSERT ou UPDATE.
ExcluirLinkReferência Com base nesse valor, as informações adicionais fornecidas para campos de referência serão suprimidas ou não.
ObterColunasMetadados Indica a preferência do usuário sobre quando e como o provedor deve obter os metadados das colunas.
LinhasMáximas Limita o número de linhas retornadas quando nenhuma agregação ou GROUP BY é usado na consultar. Isso tem precedência sobre cláusulas LIMIT.
Outro Essas propriedades ocultas são usadas apenas em casos de uso específicos.
Tamanho da página O número máximo de resultados a serem retornados por página do ServiceNow.
Tempo limite de inatividade do pool O tempo ocioso permitido para uma conexão antes de ser fechada.
TamanhoMáxPool O máximo de conexões no pool.
TamanhoMínimoPool O número mínimo de conexões no pool.
TempoDeEsperaDoPool O máximo de segundos para esperar por uma conexão disponível.
PseudoColunas Especifique um conjunto de pseudocolunas para expor como colunas.
Somente leitura Você pode usar esta propriedade para impor acesso somente leitura ao ServiceNow do provedor.
RTK A chave de tempo de execução usada para licenciamento.
Mostrar descrições Controla se as descrições de colunas e tabelas são retornadas por meio dos endpoints da API sys_documentation e sys_db_object.
Tempo limite O valor em segundos até que o erro de tempo limite seja lançado, cancelando a operação.
Usar Pool de Conexões Esta propriedade habilita o pool de conexões.
UsarNomesDeTabelasDeExibição Booleano que determina se os nomes de exibição da tabela devem ser usados em vez dos nomes da API.
Visualizações definidas pelo usuário Um caminho de arquivo apontando para o arquivo de configuração JSON que contém suas visualizações personalizadas.

Autenticação

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

Propriedade Descrição
Esquema de autenticação O esquema de autorização a ser usado quando a autorização do servidor for executada.
URL A URL base da sua instância do ServiceNow.
Usuário A conta de usuário do ServiceNow usada para autenticação.
Senha A senha usada para autenticar o usuário.

Esquema de autenticação

O esquema de autorização a ser usado quando a autorização do servidor for executada.

Valores Possíveis

Básico, OAuth, OAuthPassword, OKTA, ADFS, OneLogin, PingFederate

Tipo de dados

corda

Valor Padrão

"Básico"

Observações

Esta propriedade especifica o tipo de autenticação a ser realizada. Os valores possíveis são:

  • Basic: Defina para usar autenticação básica.
  • OAuth: Defina para executar autenticação OAuth.
  • OAuthPassword: Defina para executar autenticação OAuth com GrantType Password.

Por padrão, AuthScheme é Basic. O conector executará autenticação OAuth se AuthScheme estiver definido como OAuth ou OAuthAccessToken propriedade está definida.

As seguintes opções estão disponíveis para SSO:

  • OKTA: Defina para usar uma conexão de logon único com OKTA como o provedor de identidade.
  • ADFS: Defina para usar uma conexão de logon único com ADFS como o provedor de identidade.
  • OneLogin: Defina para usar uma conexão de logon único com OneLogin como o provedor de identidade.
  • PingFederate: Defina para usar uma conexão de logon único com PingFederate como o provedor de identidade.

URL

A URL base da sua instância do ServiceNow.

Tipo de dados

corda

Valor Padrão

""

Observações

Defina a URL base do seu site de instância do ServiceNow. Por exemplo: https://dev47813.service-now.com/.

Usuário

A conta de usuário do ServiceNow usada para autenticação.

Tipo de dados

corda

Valor Padrão

""

Observações

Junto com Senha, este campo é usado para autenticação no servidor ServiceNow.

Senha

A senha usada para autenticar o usuário.

Tipo de dados

corda

Valor Padrão

""

Observações

O Usuário e Senha são usados juntos para autenticar com o servidor.

SSO

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

Propriedade Descrição
URL de login do SSO URL de login do provedor de identidade.
SSOPropriedades Propriedades adicionais necessárias para conectar-se ao provedor de identidade em uma lista separada por ponto e vírgula.

URL de login do SSO

URL de login do provedor de identidade.

Tipo de dados

corda

Valor Padrão

""

Observações

URL de login do provedor de identidade.

Propriedades SSO

Propriedades adicionais necessárias para conectar ao provedor de identidade em uma lista separada por ponto e vírgula.

Tipo de dados

corda

Valor Padrão

""

Observações

Propriedades adicionais necessárias para conectar-se ao provedor de identidade em uma lista separada por ponto e vírgula. é usado em conjunto com SSOLoginURL.

A configuração do SSO é discutida mais detalhadamente em Estabelecendo uma conexão do CData documentação.

OAuth

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

Propriedade Descrição
IniciarOAuth Defina esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth quando você se conectar.
OAuthClientId O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthClientSecret O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
Token de acesso OAuth O token de acesso para conexão usando OAuth.
Localização das configurações do OAuth O local do arquivo de configurações onde os valores OAuth são salvos quando InitiateOAuth é definido como GETANDREFRESH ou REFRESH. Como alternativa, isso pode ser mantido na memória especificando um valor começando com memory://.
URL de retorno de chamada A URL de retorno de chamada do OAuth para retornar ao autenticar. Este valor deve corresponder à URL de retorno de chamada que você especificar nas configurações do seu aplicativo.
Tipo de Concessão OAuth O tipo de concessão para o fluxo OAuth.
VerificadorOAuth O código do verificador retornado da URL de autorização do OAuth.
Token de atualização do OAuth O token de atualização OAuth para o token de acesso OAuth correspondente.
OAuthExpiraEm O tempo de vida em segundos do OAuth AccessToken.
Carimbo de data/hora do OAuthToken O registro de data e hora da época do Unix em milissegundos quando o Token de Acesso atual foi criado.

IniciarOAuth

Defina esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth quando você se conectar.

Valores Possíveis

OFF, OBTERATUALIZAR, ATUALIZAR

Tipo de dados

corda

Valor Padrão

"DESLIGADO"

Observações

As seguintes opções estão disponíveis:

  1. OFF: indica que o fluxo OAuth será manipulado inteiramente pelo usuário. Um OAuthAccessToken será necessário para autenticação.
  2. GETANDREFRESH: indica que todo o fluxo OAuth será manipulado pelo conector. Se nenhum token existir no momento, ele será obtido solicitando ao usuário por meio do navegador. Se um token existir, ele será atualizado quando aplicável.
  3. REFRESH: indica que o conector manipulará apenas a atualização do OAuthAccessToken. O usuário nunca será solicitado pelo conector a autenticar por meio do navegador. O usuário deve manipular a obtenção do OAuthAccessToken e do OAuthRefreshToken inicialmente.

OAuthClientId

O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.

Tipo de dados

corda

Valor Padrão

""

Observações

Como parte do registro de um aplicativo OAuth, você receberá o valor OAuthClientId, às vezes também chamado de chave do consumidor, e um segredo do cliente, o OAuthClientSecret.

OAuthClientSecret

O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.

Tipo de dados

corda

Valor Padrão

""

Observações

Como parte do registro de um aplicativo OAuth, você receberá o OAuthClientId, também chamada de chave do consumidor. Você também receberá um segredo do cliente, também chamado de segredo do consumidor. Defina o segredo do cliente na propriedade OAuthClientSecret.

Token de acesso OAuth

O token de acesso para conectar usando OAuth.

Tipo de dados

corda

Valor Padrão

""

Observações

A propriedade OAuthAccessToken é usada para conectar usando OAuth. O OAuthAccessToken é recuperado do servidor OAuth como parte do processo de autenticação. Ele tem um tempo limite dependente do servidor e pode ser reutilizado entre solicitações.

O token de acesso é usado no lugar do seu nome de usuário e senha. O token de acesso protege suas credenciais mantendo-as no servidor.

Localização das configurações do OAuth

O local do arquivo de configurações onde os valores OAuth são salvos quando InitiateOAuth é definido como GETANDREFRESH ou REFRESH. Como alternativa, isso pode ser mantido na memória especificando um valor começando com memory://.

Tipo de dados

corda

Valor Padrão

"%APPDATA%\ Provedor de dados do ServiceNow \OAuthSettings.txt"

Observações

Quando InitiateOAuth estiver definido como GETANDREFRESH ou REFRESH, o conector salva os valores do OAuth para evitar que o usuário insira manualmente as propriedades da conexão do OAuth e permitir que as credenciais sejam compartilhadas entre conexões ou processos.

Em vez de especificar um caminho de arquivo, você pode usar o armazenamento de memória. Os locais de memória são especificados usando um valor que começa com 'memory://' seguido por um identificador exclusivo para esse conjunto de credenciais (por exemplo, memory://user1). O identificador pode ser qualquer coisa que você escolher, mas deve ser exclusivo para o usuário. Ao contrário do armazenamento baseado em arquivo, onde as credenciais persistem entre as conexões, o armazenamento de memória carrega as credenciais na memória estática, e as credenciais são compartilhadas entre as conexões usando o mesmo identificador durante a vida útil do processo. Para persistir credenciais fora do processo atual, você deve armazenar manualmente as credenciais antes de fechar a conexão. Isso permite que você as defina na conexão quando o processo for iniciado novamente. Você pode recuperar valores de propriedade OAuth com uma consultar à tabela de sistema sys_connection_props. Se houver várias conexões usando as mesmas credenciais, as propriedades serão lidas da conexão fechada anteriormente.

Se não for especificado, o local padrão é "%APPDATA%\ ServiceNow Data Provider\OAuthSettings.txt" com %APPDATA% sendo definido como o diretório de configuração do usuário:

Plataforma %APPDATA% Localização
Windows O valor da variável de ambiente APPDATA
Mac ~/Biblioteca/Suporte a aplicativos
Linux ~/.config

URL de retorno de chamada

A URL de retorno de chamada do OAuth para retornar ao autenticar. Este valor deve corresponder à URL de retorno de chamada que você especificar nas configurações do seu aplicativo.

Tipo de dados

corda

Valor Padrão

http://localhost:33333

Observações

Durante o processo de autenticação, o servidor de autorização OAuth redireciona o usuário para esta URL. Este valor deve corresponder à URL de retorno de chamada que você especificar nas configurações do seu aplicativo.

Tipo de concessão OAuth

O tipo de concessão para o fluxo OAuth.

Valores Possíveis

CÓDIGO, SENHA

Tipo de dados

corda

Valor Padrão

"CÓDIGO"

Observações

O tipo de concessão para o fluxo OAuth. As seguintes opções estão disponíveis: CODE,PASSWORD

Verificador OAuth

O código do verificador retornado do URL de autorização do OAuth.

Tipo de dados

corda

Valor Padrão

""

Observações

O código verificador retornado da URL de autorização OAuth. Isso pode ser usado em sistemas onde um navegador não pode ser iniciado, como sistemas headless.

Autenticação em máquinas sem cabeça

Veja Estabelecendo uma conexão do CData documentação para obter o valor OAuthVerifier.

Defina OAuthSettingsLocation junto com OAuthVerifier. Quando você se conecta, o conector troca o OAuthVerifier pelos tokens de autenticação OAuth e os salva, criptografados, no arquivo especificado. Defina InitiateOAuth para GETANDREFRESH automatizar a troca.

Depois que o arquivo de configurações do OAuth for gerado, você pode remover OAuthVerifier das propriedades de conexão e conectar com OAuthSettingsLocation definido.

Para atualizar automaticamente os valores do token OAuth, defina OAuthSettingsLocation e adicionalmente definir InitiateOAuth para ATUALIZAR.

Token de atualização OAuth

O token de atualização OAuth para o token de acesso OAuth correspondente.

Tipo de dados

corda

Valor Padrão

""

Observações

A propriedade OAuthRefreshToken é usada para atualizar o OAuthAccessToken ao usar autenticação OAuth.

OAuthExpiraEm

A vida útil em segundos do OAuth AccessToken.

Tipo de dados

corda

Valor Padrão

""

Observações

Emparelhe com OAuthTokenTimestamp para determinar quando o AccessToken irá expirar.

OAuthTokenCarimbo de data/hora

O registro de data e hora da época Unix em milissegundos quando o Access Token atual foi criado.

Tipo de dados

corda

Valor Padrão

""

Observações

Emparelhe com OAuthExpiresIn para determinar quando o AccessToken irá expirar.

SSL

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

Propriedade Descrição
Certificado de Servidor SSL O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

Certificado do Servidor SSL

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

Tipo de dados

corda

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 pela máquina será rejeitado.

Esta propriedade pode assumir as seguintes formas:

Descrição Exemplo
Um Certificado PEM completo (exemplo abreviado para brevidade) -----INÍCIO DO CERTIFICADO----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----FIM DO CERTIFICADO-----
Um caminho para um arquivo local contendo o certificado C:\cert.cer
A chave pública (exemplo abreviado para brevidade) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
A impressão digital MD5 (valores hexadecimais também podem ser separados por espaço ou dois pontos) ecadbdda5a1529c58a1e9e09828d70e4
A impressão digital SHA1 (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 que todos os certificados devem ser aceitos. Observe que isso não é recomendado devido a preocupações de segurança.

Firewall

Esta seção fornece uma lista completa das propriedades do Firewall que você pode configurar.

Propriedade Descrição
Tipo de Firewall O protocolo usado por um firewall baseado em proxy.
Servidor de Firewall O nome ou endereço IP de um firewall baseado em proxy.
Porta do Firewall A porta TCP para um firewall baseado em proxy.
Usuário do Firewall O nome de usuário a ser usado para autenticação com um firewall baseado em proxy.
Senha do Firewall Uma senha usada para autenticação em um firewall baseado em proxy.

Tipo de Firewall

O protocolo usado por um firewall baseado em proxy.

Valores Possíveis

NENHUM, TÚNEL, MEIAS4, MEIAS5

Tipo de dados

corda

Valor Padrão

"NENHUM"

Observações

Esta propriedade especifica o protocolo que o conector usará para fazer o túnel de tráfego através do FirewallServer proxy. Observe que, por padrão, o conector se conecta ao proxy do sistema; para desabilitar esse comportamento e se conectar a um dos seguintes tipos de proxy, defina ProxyAutoDetect para falso.

Tipo Porta Padrão Descrição
TÚNEL 80 Quando isso é definido, o conector abre uma conexão com o ServiceNow e o tráfego flui de um lado para o outro pelo proxy.
SOCKS4 1080 Quando isso é definido, o conector envia dados por meio do proxy SOCKS 4 especificado por FirewallServer e FirewallPort e passa o FirewallUser valor para o proxy, que determina se a solicitação de conexão deve ser atendida.
SOCKS5 1080 Quando isso é definido, o conector envia dados por meio do proxy SOCKS 5 especificado por FirewallServer e FirewallPort. Se o seu proxy exigir autenticação, defina FirewallUser e FirewallPassword para credenciais que o proxy reconhece.

Para conectar-se a proxies HTTP, use ProxyServer e ProxyPort. Para autenticar em proxies HTTP, use ProxyAuthScheme, ProxyUser e ProxyPassword.

Servidor de Firewall

O nome ou endereço IP de um firewall baseado em proxy.

Tipo de dados

corda

Valor Padrão

""

Observações

Esta propriedade especifica o endereço IP, nome DNS ou nome do hospedar de um proxy permitindo a travessia de um firewall. O protocolo é especificado por FirewallType: Use FirewallServer com esta propriedade para conectar através de SOCKS ou fazer tunelamento. Use ProxyServer para conectar-se a um proxy HTTP.

Observe que o conector usa o proxy do sistema por padrão. Para usar um proxy diferente, defina ProxyAutoDetect para falso.

Porta de Firewall

A porta TCP para um firewall baseado em proxy.

Tipo de dados

inteiro

Valor Padrão

0

Observações

Isto especifica a porta TCP para um proxy permitindo a travessia de um firewall. Use FirewallServer para especificar o nome ou endereço IP. Especifique o protocolo com FirewallType.

Usuário de Firewall

O nome de usuário a ser usado para autenticação com um firewall baseado em proxy.

Tipo de dados

corda

Valor Padrão

""

Observações

O FirewallUser e FirewallPassword propriedades são usadas para autenticação no proxy especificado em FirewallServer e FirewallPort, seguindo o método de autenticação especificado em FirewallType.

Senha do Firewall

Uma senha usada para autenticação em um firewall baseado em proxy.

Tipo de dados

corda

Valor Padrão

""

Observações

Esta propriedade é passada para o proxy especificado por FirewallServer e FirewallPort, seguindo o método de autenticação especificado por FirewallType.

Procuração

Esta seção fornece uma lista completa das propriedades do Proxy que você pode configurar.

Propriedade Descrição
Detecção Automática de Proxy Quando esta propriedade de conexão é definida como true, o provedor verifica as configurações de proxy do seu sistema para configurações de servidor proxy existentes (não há necessidade de fornecer manualmente os detalhes do servidor proxy). Defina como false se quiser configurar manualmente o provedor para se conectar a um servidor proxy específico.
Servidor Proxy O nome do host ou endereço IP do servidor proxy pelo qual você deseja rotear o tráfego HTTP.
Porta proxy A porta TCP na qual o servidor proxy (especificado na propriedade de conexão ProxyServer) está sendo executado.
Esquema de autenticação do proxy O método de autenticação que o provedor usa ao autenticar no servidor proxy especificado na propriedade de conexão ProxyServer.
Usuário Proxy O nome de usuário de uma conta de usuário registrada no servidor proxy especificado na propriedade de conexão ProxyServer.
Senha do Proxy A senha associada ao usuário especificado na propriedade de conexão ProxyUser.
Tipo ProxySSL O tipo SSL a ser usado ao conectar-se ao proxy ProxyServer.
Exceções de Proxy Uma lista separada por ponto e vírgula de nomes de host de destino ou IPs que estão isentos de conexão por meio do ProxyServer.

Detecção automática de proxy

Quando esta propriedade de conexão é definida como true, o provedor verifica as configurações de proxy do seu sistema para configurações de servidor proxy existentes (não há necessidade de fornecer manualmente os detalhes do servidor proxy). Defina como false se quiser configurar manualmente o provedor para se conectar a um servidor proxy específico.

Tipo de dados

bolo

Valor Padrão

falso

Observações

Esta propriedade de conexão tem precedência sobre outras configurações de proxy, então você precisará definir ProxyAutoDetect como falso para usar configurações de proxy personalizadas.

Quando essa propriedade é definida como true, o proxy a ser usado é determinado pela verificação desses locais, nessa ordem. Se o proxy não puder ser determinado em um lugar, o driver verifica o próximo.

  1. O driver realiza uma pesquisa nas propriedades da JVM (http.proxy, https.proxy, socksProxy, etc.).
  2. Caso as propriedades da JVM não existam, o driver realiza uma busca em java.home/lib/net.properties.
  3. Caso java.net.useSystemProxies esteja definido como true, o driver executa uma pesquisa no SystemProxy.
  4. No Windows, as configurações de proxy são lidas nas Opções da Internet no registro, especificamente a chave de registro HKCU\SOFTWARE\Microsoft\ Windows\CurrentVersion\Internet Settings. No Windows 10 e posteriores, isso corresponde às Configurações de Proxy encontradas nas Configurações do Windows.

Observe que essas configurações se aplicam somente ao usuário atual da máquina. Se você estiver executando um aplicativo como um serviço, o driver não lerá as configurações do seu próprio usuário. Em vez disso, você deve fornecer manualmente as configurações de proxy nas propriedades de conexão do driver.

Para conectar-se a um proxy HTTP, veja ProxyServer. Para outros proxies, como SOCKS ou tunneling, veja FirewallType.

Servidor proxy

O nome do host ou endereço IP do servidor proxy pelo qual você deseja rotear o tráfego HTTP.

Tipo de dados

corda

Valor Padrão

""

Observações

O nome do host ou endereço IP de um proxy para rotear o tráfego HTTP. O driver pode usar os tipos de autenticação HTTP, Windows (NTLM) ou Kerberos para autenticar em um proxy HTTP.

Se você precisar se conectar por meio de um proxy SOCKS ou fazer um túnel de conexão, consulte FirewallType.

Por padrão, o driver usa o proxy do sistema. Se você precisar usar outro proxy, defina ProxyAutoDetect para falso.

Porta proxy

A porta TCP na qual o servidor proxy (especificado na propriedade de conexão ProxyServer) está sendo executado.

Tipo de dados

inteiro

Valor Padrão

80

Observações

A porta em que o proxy HTTP está sendo executado e pela qual você deseja redirecionar o tráfego HTTP. Especifique o proxy HTTP em ProxyServer. Para outros tipos de proxy, consulte FirewallType.

Esquema de autenticação de proxy

O método de autenticação que o provedor usa ao autenticar no servidor proxy especificado na propriedade de conexão ProxyServer.

Valores Possíveis

BÁSICO, RESUMO, NENHUM, NEGOCIAR, NTLM, PROPRIETÁRIO

Tipo de dados

corda

Valor Padrão

"BÁSICO"

Observações

Este valor especifica o tipo de autenticação a ser usado para autenticar no proxy HTTP especificado por ProxyServer e ProxyPort.

Observe que o conector usará as configurações de proxy do sistema por padrão, sem necessidade de configuração adicional; se você quiser se conectar a outro proxy, precisará definir ProxyAutoDetect para falso, além de ProxyServer e ProxyPort. Para autenticar, defina ProxyAuthScheme e defina ProxyUser e ProxyPassword, se necessário.

O tipo de autenticação pode ser um dos seguintes:

  • BÁSICO: O conector executa autenticação HTTP BASIC.
  • DIGEST: O conector executa autenticação HTTP DIGEST.
  • NEGOCIAR: O conector recupera um token NTLM ou Kerberos com base no protocolo aplicável para autenticação.
  • PROPRIETÁRIO: O conector não gera um token NTLM ou Kerberos. Você deve fornecer esse token no cabeçalho Authorization da solicitação HTTP.

Se você precisar usar outro tipo de autenticação, como autenticação SOCKS 5, consulte FirewallType.

Usuário Proxy

O nome de usuário de uma conta de usuário registrada com o servidor proxy especificado na propriedade de conexão ProxyServer.

Tipo de dados

corda

Valor Padrão

""

Observações

O ProxyUser e ProxyPassword opções são usadas para conectar e autenticar no proxy HTTP especificado em ProxyServer.

Você pode selecionar um dos tipos de autenticação disponíveis em ProxyAuthScheme. Se você estiver usando autenticação HTTP, defina isso como o nome de usuário de um usuário reconhecido pelo proxy HTTP. Se você estiver usando autenticação Windows ou Kerberos, defina essa propriedade como um nome de usuário em um dos seguintes formatos:

user@domain
domain\user

Senha do Proxy

A senha associada ao usuário especificado na propriedade de conexão ProxyUser.

Tipo de dados

corda

Valor Padrão

""

Observações

Esta propriedade é usada para autenticar em um servidor proxy HTTP que suporta autenticação NTLM (Windows), Kerberos ou HTTP. Para especificar o proxy HTTP, você pode definir ProxyServer e ProxyPort. Para especificar o tipo de autenticação, defina ProxyAuthScheme.

Se você estiver usando autenticação HTTP, defina adicionalmente ProxyUser e ProxyPassword para proxy HTTP.

Se você estiver usando autenticação NTLM, defina ProxyUser e ProxyPassword para sua senha do Windows. Você também pode precisar deles para concluir a autenticação Kerberos.

Para autenticação ou tunelamento SOCKS 5, consulte FirewallType.

Por padrão, o conector usa o proxy do sistema. Se você quiser se conectar a outro proxy, defina ProxyAutoDetect para falso.

Tipo ProxySSL

O tipo SSL a ser usado ao conectar-se ao proxy ProxyServer.

Valores Possíveis

AUTO, SEMPRE, NUNCA, TÚNEL

Tipo de dados

corda

Valor Padrão

"AUTO"

Observações

Esta propriedade determina quando usar SSL para a conexão com um proxy HTTP especificado por ProxyServer. Este valor pode ser AUTO, ALWAYS, NEVER ou TUNNEL. Os valores aplicáveis são os seguintes:

  • AUTO: Configuração padrão. Se a URL for uma URL HTTPS, o driver usará a opção TUNNEL. Se a URL for uma URL HTTP, o componente usará a opção NEVER.
  • SEMPRE: A conexão está sempre habilitada para SSL.
  • NUNCA: A conexão não está habilitada para SSL.
  • TUNNEL: A conexão é por meio de um proxy de tunelamento. O servidor proxy abre uma conexão com o hospedar remoto e o tráfego flui de um lado para o outro pelo proxy.

Exceções de proxy

Uma lista separada por ponto e vírgula de nomes de host de destino ou IPs que estão isentos de conexão através do ProxyServer.

Tipo de dados

corda

Valor Padrão

""

Observações

O Servidor Proxy é usado para todos os endereços, exceto para endereços definidos nesta propriedade. Use ponto e vírgula para separar entradas.

Observe que o conector usa as configurações de proxy do sistema por padrão, sem necessidade de configuração adicional; se você quiser configurar explicitamente exceções de proxy para esta conexão, você precisa definir ProxyAutoDetect = falso e configure ProxyServer e ProxyPort. Para autenticar, defina ProxyAuthScheme e defina ProxyUser e ProxyPassword, se necessário.

Registro

Esta seção fornece uma lista completa das propriedades de Logging que você pode configurar na string de conexão para este provedor.

Propriedade Descrição
Arquivo de log Um caminho de arquivo que designa o nome e o local do arquivo de log.
Verbosidade O nível de verbosidade que determina a quantidade de detalhes incluídos no arquivo de log.
Módulos de Log Módulos principais a serem incluídos no arquivo de log.
TamanhoMáximoDoArquivoDeLog Uma string especificando o tamanho máximo em bytes para um arquivo de log (por exemplo, 10 MB).
Contagem Máxima de Arquivos de Log Uma string especificando a contagem máxima de arquivos de log.

Arquivo de log

Um caminho de arquivo que designa o nome e o local do arquivo de log.

Tipo de dados

corda

Valor Padrão

""

Observações

Uma vez que essa propriedade é definida, o driver preencherá o arquivo de log conforme ele realiza várias tarefas, como quando a autenticação é realizada ou consultas são executadas. Se o arquivo especificado ainda não existir, ele será criado.

As sequências de conexão e as informações de versão também são registradas, embora as propriedades de conexão que contêm informações confidenciais sejam mascaradas automaticamente.

Se um caminho de arquivo relativo for fornecido, o local do arquivo de log será resolvido com base no caminho encontrado em Local propriedade de conexão.

Para mais controle sobre o que é escrito no arquivo de log, você pode ajustar a Verbosidade propriedade.

O conteúdo do log é categorizado em vários módulos. Você pode mostrar/ocultar módulos individuais usando LogModules propriedade.

Para editar o tamanho máximo de um único arquivo de log antes que um novo seja criado, veja MaxLogFileSize.

Se você quiser colocar um limite no número de arquivos de log gerados, use MaxLogFileCount.

Registro Java

O registro Java também é suportado. Para habilitar o registro Java, defina Logfile para:

Logfile=JAVALOG://myloggername

Como no exemplo acima, JAVALOG:// é um prefixo necessário para usar o registro Java, e você substituirá seu próprio Logger.

O método getLogger do Logger fornecido é então chamado, usando o valor fornecido para criar a instância do Logger. Se uma instância de registro já existir, ela referenciará a instância existente.

Quando o registro Java estiver habilitado, o Verbosity agora corresponderá a níveis de registro específicos.

Verbosidade

O nível de verbosidade que determina a quantidade de detalhes incluídos no arquivo de log.

Tipo de dados

corda

Valor Padrão

"1"

Observações

O nível de verbosidade determina a quantidade de detalhes que o driver relata ao Logfile. Níveis de verbosidade de 1 a 5 são suportados. Eles são detalhados em Logging do CData documentação.

Módulos de Log

Módulos principais a serem incluídos no arquivo de log.

Tipo de dados

corda

Valor Padrão

""

Observações

Somente os módulos especificados (separados por ';') serão incluídos no arquivo de log. Por padrão, todos os módulos são incluídos.

Veja Logging do CData documentação para uma visão geral.

Tamanho máximo do arquivo de log

Uma string especificando o tamanho máximo em bytes para um arquivo de log (por exemplo, 10 MB).

Tipo de dados

corda

Valor Padrão

"100MB"

Observações

Quando o limite é atingido, um novo log é criado na mesma pasta com a data e a hora anexadas ao final. O limite padrão é 100 MB. Valores menores que 100 kB usarão 100 kB como valor.

Ajuste o número máximo de arquivos de log gerados com MaxLogFileCount.

Contagem máxima de arquivos de log

Uma string especificando a contagem máxima de arquivos de log.

Tipo de dados

inteiro

Valor Padrão

-1

Observações

Quando o limite é atingido, um novo log é criado na mesma pasta com a data e hora anexadas ao final e o arquivo de log mais antigo será excluído.

O valor mínimo suportado é 2. Um valor de 0 ou um valor negativo indica que não há limite na contagem.

Ajuste o tamanho máximo dos arquivos de log gerados com MaxLogFileSize.

Esquema

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

Propriedade Descrição
Localização Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, visualizações e procedimentos armazenados.
Esquemas Navegáveis Esta propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tabelas Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tables=TableA,TableB,TableC.
Visualizações Restringe as visualizações reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA,ViewB,ViewC.
IncluirVisualizaçõesDeBancoDeDados Controla se as visualizações do banco de dados devem ser expostas ou não.
IncluirTabelasDoSistema Controla se as tabelas do sistema devem ser expostas ou não.

Localização

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

Tipo de dados

corda

Valor Padrão

"%APPDATA%\ Provedor de dados do ServiceNow \Esquema"

Observações

O caminho para um diretório que contém os arquivos de esquema para o conector (arquivos .rsd para tabelas e visualizações, arquivos .rsb para procedimentos armazenados). O local da pasta pode ser um caminho relativo do local do executável. A propriedade Location 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, visualizações ou procedimentos armazenados.

Se não for especificado, o local padrão será "%APPDATA%\ ServiceNow Data Provider\Schema", com %APPDATA% sendo definido como o diretório de configuração do usuário:

Plataforma %APPDATA%
Windows O valor da variável de ambiente APPDATA
Mac ~/Biblioteca/Suporte a aplicativos
Linux ~/.config

Esquemas Navegáveis

Esta propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Tipo de dados

corda

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, Tables=TableA,TableB,TableC.

Tipo de dados

corda

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.

Esta propriedade também pode ser usada como uma alternativa para listar automaticamente as visualizações se você já sabe com quais deseja trabalhar e, de outra forma, 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 ambiguidade entre tabelas que existem em vários catálogos ou esquemas.

Visualizações

Restringe as visualizações reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA,ViewB,ViewC.

Tipo de dados

corda

Valor Padrão

""

Observações

Listar as visualizações de alguns bancos de dados pode ser caro. Fornecer uma lista de visualizações na string de conexão melhora o desempenho do conector.

Esta propriedade também pode ser usada como uma alternativa para listar automaticamente as visualizações se você já sabe com quais deseja trabalhar e, de outra forma, haveria muitas para trabalhar.

Especifique as visualizações que deseja em uma lista separada por vírgulas. Cada visualizaçã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 ambiguidade entre tabelas que existem em vários catálogos ou esquemas.

IncluirVisualizações de Banco de Dados

Controla se deve expor ou não as Visualizações do Banco de Dados.

Tipo de dados

bolo

Valor Padrão

falso

Observações

Controla se deve expor as Database Views ou não. Se verdadeiro, o conector enviará várias chamadas de metadados adicionais para obter os metadados das Database Views.

IncluirTabelasDoSistema

Controla se as tabelas do sistema devem ser expostas ou não.

Tipo de dados

bolo

Valor Padrão

verdadeiro

Observações

Controla se as tabelas do sistema devem ser expostas ou não. Normalmente, apenas usuários com função de administrador têm acesso a essas tabelas. Definir essa propriedade como false forçará que elas não sejam listadas em chamadas de metadados.

Armazenamento em cache

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

Propriedade Descrição
AutoCache Armazena em cache automaticamente os resultados de consultas SELECT em um banco de dados de cache especificado por CacheLocation ou CacheConnection e CacheProvider.
Driver de cache O driver de banco de dados usado para armazenar dados em cache.
Conexão de cache A string de conexão para o banco de dados de cache. Esta propriedade é sempre usada em conjunto com CacheProvider. Definir ambas as propriedades substituirá o valor definido para CacheLocation para armazenar dados em cache.
Localização do cache Especifica o caminho para o cache ao armazenar em cache um arquivo.
Tolerância de cache A tolerância para dados obsoletos no cache especificada em segundos ao usar o AutoCache.
Off-line Use o modo offline para obter os dados do cache em vez da fonte ativa.
Metadados de cache Esta propriedade determina se os metadados da tabela devem ou não ser armazenados em cache em um armazenamento de arquivos.

Cache automático

Cacheia automaticamente os resultados de consultas SELECT em um banco de dados de cache especificado por CacheLocation ou ambos, CacheConnection e CacheProvider.

Tipo de dados

bolo

Valor Padrão

falso

Observações

Quando AutoCache é true, o conector mantém automaticamente um cache dos dados da sua tabela no banco de dados de sua escolha. Por padrão, o conector atualiza o cache incrementalmente, recuperando apenas as alterações desde a última consultar SELECT executada se o período de tempo desde a última execução tiver excedido o CacheTolerance. Após a atualização do cache, a consultar é executada nos dados armazenados em cache.

Configurando o cache do banco de dados

Quando AutoCache é true, o conector armazena em cache um cache simples baseado em arquivo. Você pode configurar sua localização ou cache para um banco de dados diferente com as seguintes propriedades:

Veja também
  • Tolerância de cache: Esta propriedade controla a tolerância para dados obsoletos no cache.
  • CacheMetadata: Esta propriedade reduz a quantidade de metadados que cruzam a rede ao persistir esquemas de tabela recuperados dos metadados do ServiceNow. Os metadados precisam ser recuperados apenas uma vez, em vez de a cada conexão.
  • Armazenamento Explícito de Dados: CData fornece mais exemplos de uso do AutoCache em Offline modo.
  • Instruções CACHE: CData detalha como você pode usar a instrução CACHE para persistir qualquer consultar SELECT, bem como gerenciar o cache; por exemplo, atualizando esquemas.

Driver de cache

O driver de banco de dados a ser usado para armazenar dados em cache.

Tipo de dados

corda

Valor Padrão

""

Observações

Você pode fazer cache em qualquer banco de dados para o qual tenha um driver JDBC, incluindo drivers JDBC.

O banco de dados de cache é determinado com base no CacheDriver e CacheConnection propriedades. O CacheDriver é o nome da classe do driver JDBC que você deseja usar para armazenar dados em cache.

Observe que você também deve adicionar o arquivo JAR CacheDriver ao classpath.

Os exemplos a seguir mostram como armazenar em cache vários bancos de dados principais. Consulte CacheConnection para obter mais informações sobre a sintaxe de URL do JDBC e propriedades de conexão típicas.

Derby e Java DB

O driver simplifica a configuração do Derby. Java DB é a distribuição Oracle do Derby. O arquivo JAR é enviado no JDK. Você pode encontrar o arquivo JAR, derby.jar, na subpasta db da instalação do JDK. Na maioria dos cenários de cache, você precisa especificar apenas o seguinte, após adicionar derby.jar ao classpath:

jdbc:servicenow:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:sample';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;User=MyUser;Password=MyPassword;Url=https://MyInstance12345.service-now.com/;

Para personalizar o URL do Derby JDBC, use CacheDriver e CacheConnection. Por exemplo, para armazenar em cache em um banco de dados na memória, use uma URL JDBC como a seguinte:

jdbc:servicenow:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;User=MyUser;Password=MyPassword;Url=https://MyInstance12345.service-now.com/;
SQLite

A seguir está uma URL JDBC para o driver JDBC do SQLite:

jdbc:servicenow:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;User=MyUser;Password=MyPassword;Url=https://MyInstance12345.service-now.com/;
MySQL

A seguir está uma URL JDBC para o driver JDBC incluído para MySQL:

jdbc:servicenow:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;User=MyUser;Password=MyPassword;Url=https://MyInstance12345.service-now.com/;
SQL Server

O seguinte URL JDBC usa o Microsoft JDBC Driver para SQL Server:

jdbc:servicenow:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;User=MyUser;Password=MyPassword;Url=https://MyInstance12345.service-now.com/;
Oracle

A seguir está uma URL JDBC para o Oracle Thin Client:

jdbc:servicenow:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;User=MyUser;Password=MyPassword;Url=https://MyInstance12345.service-now.com/;

OBSERVAÇÃO: se estiver usando uma versão do Oracle anterior à 9i, o driver de cache será oracle.jdbc. driver.OracleDriver.

PostgreSQL

A seguinte URL do JDBC usa o driver JDBC oficial do PostgreSQL:

jdbc:servicenow:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;User=MyUser;Password=MyPassword;Url=https://MyInstance12345.service-now.com/;

Conexão de cache

A string de conexão para o banco de dados de cache. Esta propriedade é sempre usada em conjunto com CacheProvider. Definir ambas as propriedades substituirá o valor definido para CacheLocation para armazenar dados em cache.

Tipo de dados

corda

Valor Padrão

""

Observações

O banco de dados de cache é determinado com base no CacheDriver e propriedades CacheConnection. Ambas as propriedades são necessárias para usar o banco de dados de cache. Exemplos de configurações comuns de banco de dados de cache podem ser encontrados abaixo. Para obter mais informações sobre como definir o driver do banco de dados de cache, consulte CacheDriver.

A string de conexão especificada na propriedade CacheConnection é passada diretamente para o CacheDriver subjacente. Consulte a documentação do driver JDBC específico para obter mais informações sobre as propriedades disponíveis. Certifique-se de incluir o driver JDBC no classpath do seu aplicativo.

Derby e Java DB

O driver simplifica o cache para Derby, exigindo apenas que você defina o CacheLocation propriedade para fazer uma conexão básica.

Como alternativa, você pode configurar a conexão com o Derby manualmente usando CacheDriver e CacheConnection. A seguir está a sintaxe da URL do Derby JDBC:

jdbc:derby:[subsubprotocol:][Nome do banco de dados][;attribute=value[;attribute=value] ... ]

Por exemplo, para armazenar em cache em um banco de dados na memória, use o seguinte:

jdbc:derby:memory
SQLite

Para fazer cache no SQLite, você pode usar o driver JDBC do SQLite. A seguir está a sintaxe do URL JDBC:

jdbc:sqlite:dataSource
  • Fonte de dados: O caminho para um arquivo de banco de dados SQLite. Ou use um valor de :memory para armazenar em cache na memória.
MySQL

A instalação inclui o JDBC Driver for MySQL. O seguinte é um exemplo de URL JDBC:

jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache

As seguintes são propriedades de conexão típicas:

  • Servidor: O endereço IP ou nome de domínio do servidor ao qual você deseja se conectar.
  • Porta: A porta na qual o servidor está sendo executado.
  • Usuário: O nome de usuário fornecido para autenticação no banco de dados.
  • Senha: A senha fornecida para autenticação no banco de dados.
  • Banco de dados: O nome do banco de dados.
SQL Server

O URL JDBC para o Microsoft JDBC Driver para SQL Server tem a seguinte sintaxe:

jdbc:sqlserver://[serverName[\instance][: porta]][;database=databaseName][;propriedade=valor[;propriedade=valor] ... ]

Por exemplo:

jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true

A seguir estão as propriedades típicas de conexão do SQL Server:

  • Servidor: O nome ou endereço de rede do computador que executa o SQL Server. Para conectar-se a uma instância nomeada em vez da instância padrão, esta propriedade pode ser usada para especificar o nome do hospedar e a instância, separados por uma barra invertida.

  • Porta: A porta na qual o SQL Server está sendo executado.

  • Banco de dados: O nome do banco de dados do SQL Server.

  • Segurança Integrada: Defina esta opção como true para usar a conta atual do Windows para autenticação. Defina esta opção como false se estiver definindo o Usuário e a Senha na conexão.

    Para usar a segurança integrada, você também precisará adicionar sqljdbc_auth.dll a uma pasta no caminho do sistema Windows. Este arquivo está localizado na subpasta auth da instalação do Microsoft JDBC Driver for SQL Server. A quantidade de bits do assembly deve corresponder à quantidade de bits da sua JVM.

  • ID do usuário: O nome do usuário fornecido para autenticação com o SQL Server. Esta propriedade só é necessária se você não estiver usando segurança integrada.

  • Senha: A senha fornecida para autenticação com o SQL Server. Esta propriedade só é necessária se você não estiver usando segurança integrada.

Oracle

A seguir está a sintaxe convencional da URL JDBC para o driver Oracle JDBC Thin:

jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]

Por exemplo:

jdbc:oracle:thin:scott/tiger@myhost:1521:orcl

As seguintes são propriedades de conexão típicas:

  • Fonte de Dados: O descritor de conexão que identifica o banco de dados Oracle. Pode ser um descritor de conexão TNS, um nome Oracle Net Services que resolve para um descritor de conexão ou, após a versão 11g, uma nomenclatura Easy Connect (o nome do hospedar do servidor Oracle com uma porta opcional e nome de serviço).

  • Senha: A senha fornecida para autenticação com o banco de dados Oracle.

  • ID do usuário: O ID do usuário fornecido para autenticação com o banco de dados Oracle.

PostgreSQL

A seguir está a sintaxe da URL JDBC para o driver JDBC oficial do PostgreSQL:

jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&opção=valor][&option=value] ... ]]

Por exemplo, a seguinte string de conexão conecta-se a um banco de dados no hospedar padrão (localhost) e na porta (5432):

jdbc:postgresql:postgres

As seguintes são propriedades de conexão típicas:

  • Host: O endereço do servidor que hospeda o banco de dados PostgreSQL.
  • Porta: A porta usada para conectar ao servidor que hospeda o banco de dados PostgreSQL.
  • Banco de dados: O nome do banco de dados.
  • Nome de usuário: O ID de usuário fornecido para autenticação com o banco de dados PostgreSQL. Você pode especificar isso na URL do JDBC com o parâmetro "user".
  • Senha: A senha fornecida para autenticação com o banco de dados PostgreSQL.

Localização do cache

Especifica o caminho para o cache ao armazenar em cache um arquivo.

Tipo de dados

corda

Valor Padrão

"%APPDATA%\ Provedor de dados do ServiceNow "

Observações

O CacheLocation é um cache simples baseado em arquivo. O conector usa Java DB, a distribuição do banco de dados Derby da Oracle. Para armazenar em cache no Java DB, você precisará adicionar o arquivo JAR do Java DB ao classpath. O arquivo JAR, derby.jar, é enviado no JDK e localizado na subpasta db da instalação do JDK.

Se não for especificado, o local padrão será "%APPDATA%\ ServiceNow Data Provider", com %APPDATA% sendo definido como o diretório de configuração do usuário:

Plataforma %APPDATA%
Windows O valor da variável de ambiente APPDATA
Mac ~/Biblioteca/Suporte a aplicativos
Linux ~/.config
Veja também
  • AutoCache: Defina para criar e manter implicitamente um cache para uso offline posterior.
  • CacheMetadata: Defina para persistir o catálogo do ServiceNow em CacheLocation.

Tolerância de cache

A tolerância para dados obsoletos no cache especificado em segundos ao usar AutoCache.

Tipo de dados

inteiro

Valor Padrão

600

Observações

A tolerância para dados obsoletos no cache especificado em segundos. Isso só se aplica quando AutoCache é usado. O conector verifica com a fonte de dados se há registros mais novos após o intervalo de tolerância ter expirado. Caso contrário, ele retorna os dados diretamente do cache.

Desligado

Use o modo offline para obter os dados do cache em vez da fonte ao vivo.

Tipo de dados

bolo

Valor Padrão

falso

Observações

Quando Offline é verdadeiro, todas as consultas são executadas no cache em oposição à fonte de dados ativa. Neste modo, certas consultas como INSERT, UPDATE, DELETE e CACHE não são permitidas.

CacheMetadados

Esta propriedade determina se os metadados da tabela devem ou não ser armazenados em cache em um armazenamento de arquivos.

Tipo de dados

bolo

Valor Padrão

falso

Observações

À medida que você executa consultas com esta propriedade definida, os metadados da tabela no catálogo do ServiceNow são armazenados em cache no armazenamento de arquivos especificado por CacheLocation se definido ou o diretório home do usuário caso contrário. Os metadados de uma tabela serão recuperados apenas uma vez, quando a tabela for consultada pela primeira vez.

Quando usar CacheMetadata

O conector persiste automaticamente os metadados na memória por até duas horas quando você descobre os metadados de uma tabela ou exibição pela primeira vez e, portanto, CacheMetadata geralmente não é necessário. CacheMetadata se torna útil quando as operações de metadados são caras, como quando você está trabalhando com grandes quantidades de metadados ou quando tem muitas conexões de curta duração.

Quando não usar CacheMetadata
  • Quando você está trabalhando com metadados voláteis: Os metadados para uma tabela são recuperados somente na primeira vez que a conexão com a tabela é feita. Para pegar colunas novas, alteradas ou excluídas, você precisaria excluir e reconstruir o cache de metadados. Portanto, é melhor confiar no cache na memória para casos em que os metadados mudam frequentemente.
  • Quando você está armazenando em cache em um banco de dados: CacheMetadata só pode ser usado com CacheLocation. Se você estiver armazenando em cache em outro banco de dados com o CacheDriver e CacheConnection propriedades, use AutoCache para armazenar em cache implicitamente. Ou use REPLICATE Statements ou Instruções CACHE para armazenar em cache explicitamente.

Formatação de dados

Esta seção fornece uma lista completa das propriedades de Formatação de Dados que você pode configurar na string de conexão para este provedor.

Propriedade Descrição
PushEmptyValuesAsNull Indica se os valores vazios devem ser lidos como vazios ou nulos.

EmpurrarValoresVaziosComoNulo

Indica se os valores vazios devem ser lidos como vazios ou nulos.

Tipo de dados

bolo

Valor Padrão

falso

Observações

Indica se os valores vazios devem ser lidos como vazios ou nulos.

Diversos

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

Propriedade Descrição
Tamanho do lote O tamanho máximo de cada operação em lote a ser enviada.
Tempo de vida da conexão O tempo de vida máximo de uma conexão em segundos. Uma vez decorrido o tempo, o objeto de conexão é descartado.
ConectarEmAbrir Esta propriedade especifica se deve se conectar ao ServiceNow quando a conexão for aberta.
ValorExibido Com base nesse valor, o provedor recupera o valor de exibição ou o valor real do banco de dados.
NomedaColunaExibirValor Padrão para exibir nomes de colunas quando a propriedade DisplayValue está definida como ALL.
AplicarValoresColuna Controla se os valores disponíveis para um elemento são recuperados e verificados ao executar instruções INSERT ou UPDATE.
ExcluirLinkReferência Com base nesse valor, as informações adicionais fornecidas para campos de referência serão suprimidas ou não.
ObterColunasMetadados Indica a preferência do usuário sobre quando e como o provedor deve obter os metadados das colunas.
LinhasMáximas Limita o número de linhas retornadas quando nenhuma agregação ou GROUP BY é usado na consultar. Isso tem precedência sobre cláusulas LIMIT.
Outro Essas propriedades ocultas são usadas apenas em casos de uso específicos.
Tamanho da página O número máximo de resultados a serem retornados por página do ServiceNow.
Tempo limite de inatividade do pool O tempo ocioso permitido para uma conexão antes de ser fechada.
TamanhoMáxPool O máximo de conexões no pool.
TamanhoMínimoPool O número mínimo de conexões no pool.
TempoDeEsperaDoPool O máximo de segundos para esperar por uma conexão disponível.
PseudoColunas Especifique um conjunto de pseudocolunas para expor como colunas.
Somente leitura Você pode usar esta propriedade para impor acesso somente leitura ao ServiceNow do provedor.
RTK A chave de tempo de execução usada para licenciamento.
Mostrar descrições Controla se as descrições de colunas e tabelas são retornadas por meio dos endpoints da API sys_documentation e sys_db_object.
Tempo limite O valor em segundos até que o erro de tempo limite seja lançado, cancelando a operação.
Usar Pool de Conexões Esta propriedade habilita o pool de conexões.
UsarNomesDeTabelasDeExibição Booleano que determina se os nomes de exibição da tabela devem ser usados em vez dos nomes da API.
Visualizações definidas pelo usuário Um caminho de arquivo apontando para o arquivo de configuração JSON que contém suas visualizações personalizadas.

Tamanho do lote

O tamanho máximo de cada operação em lote a ser enviada.

Tipo de dados

inteiro

Valor Padrão

0

Observações

Quando BatchSize é definido como um valor maior que 0, a operação em lote dividirá o lote inteiro em lotes separados de tamanho BatchSize. Os lotes divididos serão então enviados ao servidor individualmente. Isso é útil quando o servidor tem limitações no tamanho da solicitação que pode ser enviada.

Definir BatchSize como 0 enviará o lote inteiro conforme especificado.

ConexãoVidaTempo

A duração máxima de uma conexão em segundos. Uma vez decorrido o tempo, o objeto de conexão é descartado.

Tipo de dados

Inteiro

Valor Padrão

0

Observações

A duração máxima de uma conexão em segundos. Uma vez decorrido o tempo, o objeto de conexão é descartado. O padrão é 0, o que indica que não há limite para a duração da conexão.

ConectarEmAberto

Esta propriedade especifica se deve se conectar ao ServiceNow quando a conexão for aberta.

Tipo de dados

bolo

Valor Padrão

falso

Observações

Quando definido como true, uma conexão será feita com o ServiceNow quando a conexão for aberta. Esta propriedade habilita o recurso Test Connection disponível em várias ferramentas de banco de dados.

Esse recurso atua como um comando NOOP, pois é usado para verificar se uma conexão pode ser feita com o ServiceNow e se nada dessa conexão inicial é mantido.

Definir esta propriedade como falsa pode proporcionar melhorias de desempenho (dependendo do número de vezes que uma conexão é aberta).

Valor de exibição

Com base nesse valor, o provedor recupera o valor de exibição ou o valor real do banco de dados.

Valores Possíveis

VERDADEIRO, FALSO, TUDO

Tipo de dados

corda

Valor Padrão

"FALSO"

Observações

Observação: Se você decidir definir esta propriedade de conexão como "TRUE", todos os campos retornados serão do tipo "String" devido a limitações da API.

  • TRUE: retorna valores de exibição para todos os campos.
  • FALSE: retorna valores reais do banco de dados.
  • ALL: retorna valores reais e de exibição.

NomedaColunaDeValorDeExibição

Padrão para exibir nomes de colunas quando a propriedade DisplayValue está definida como ALL.

Tipo de dados

corda

Valor Padrão

"{0}_exibir_valor"

Observações

A propriedade aceita um valor semelhante a um padrão usado para formatar os nomes das colunas quando DisplayValue=ALL. '{0}' serve como um espaço reservado para os nomes das colunas.

AplicarValoresColuna

Controla se os valores disponíveis para um elemento são recuperados e verificados ao executar instruções INSERT ou UPDATE.

Tipo de dados

bolo

Valor Padrão

falso

Observações

Controla se os valores disponíveis para um elemento são recuperados e verificados ao executar instruções INSERT ou UPDATE. Se o valor não for uma escolha válida, um erro será lançado. Elementos (colunas) no ServiceNow podem ser limitados a um conjunto de valores válidos (escolhas em uma lista). Por exemplo, um elemento 'Tipo de Problema' pode ter apenas valores válidos como 'Bug', 'Melhoria' ou 'Documentação'. Se criar um registro com um valor inválido, o ServiceNow descartará o valor e atribuirá um valor padrão para o registro. Definir esta propriedade como 'true' recuperará as escolhas disponíveis antecipadamente e verificará se algum valor inserido faz parte da lista de valores válidos quando possível. Observe que os valores de exibição diferenciam maiúsculas de minúsculas. Esta propriedade respeita a propriedade de conexão DisplayValue.

Com base neste valor, as informações adicionais fornecidas para campos de referência serão suprimidas ou não.

Tipo de dados

bolo

Valor Padrão

falso

Observações

Com base neste valor, as informações adicionais fornecidas para campos de referência serão suprimidas ou não.

ObterColumnsMetadata

Indica a preferência do usuário sobre quando e como o provedor deve obter os metadados das colunas.

Valores Possíveis

Ao iniciar, ao usar

Tipo de dados

corda

Valor Padrão

"Em uso"

Observações

As configurações disponíveis são as seguintes:

  • OnStart: O conector executará as chamadas de metadados para descobrir e armazenar em cache todas as colunas de cada tabela, antes de executar a primeira instrução.
  • OnUse: O conector executará as chamadas de metadados específicas da tabela na primeira vez que a tabela for referenciada, desde que os metadados da tabela ainda não estejam armazenados em cache.

Linhas Máximas

Limita o número de linhas retornadas quando nenhuma agregação ou GROUP BY é usado na consultar. Isso tem precedência sobre cláusulas LIMIT.

Tipo de dados

inteiro

Valor Padrão

-1

Observações

Limita o número de linhas retornadas quando nenhuma agregação ou GROUP BY é usado na consultar. Isso tem precedência sobre cláusulas LIMIT.

Outro

Essas propriedades ocultas são usadas apenas em casos de uso específicos.

Tipo de dados

corda

Valor Padrão

""

Observações

As propriedades listadas abaixo estão disponíveis para casos de uso específicos. Os casos de uso e a funcionalidade normais do conector não devem exigir essas propriedades.

Especifique várias propriedades em uma lista separada por ponto e vírgula.

Configuração de cache
Propriedade Descrição
CachePartial=True Armazena em cache apenas um subconjunto de colunas, que você pode especificar em sua consultar.
QueryPassthrough=True Passa a consultar especificada para o banco de dados de cache em vez de usar o analisador SQL do conector.
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.
ConvertDateTimeToGMT Determina se os valores de data e hora devem ser convertidos para GMT, em vez do horário local da máquina.
RecordToFile=filename Registra a transferência de dados do soquete subjacente para o arquivo especificado.

Tamanho da página

O número máximo de resultados a serem retornados por página do ServiceNow.

Tipo de dados

Inteiro

Valor Padrão

5000

Observações

A propriedade Pagesize afeta o número máximo de resultados a serem retornados por página do ServiceNow. Embora a fonte de dados otimize o tamanho de página padrão para a maioria dos casos de uso, talvez seja necessário ajustar esse valor dependendo do objeto específico ou endpoint de serviço que você está consultando. Aumentar o tamanho da página pode melhorar o desempenho, mas também pode resultar em maior consumo de memória por página.

Tempo limite de inatividade da piscina

O tempo ocioso permitido para uma conexão antes de ser fechada.

Tipo de dados

inteiro

Valor Padrão

60

Observações

O tempo ocioso permitido que uma conexão pode permanecer no pool até que a conexão seja fechada. O padrão é 60 segundos.

Tamanho máximo da piscina

O máximo de conexões no pool.

Tipo de dados

inteiro

Valor Padrão

100

Observações

O máximo de conexões no pool. O padrão é 100. Para desabilitar esta propriedade, defina o valor da propriedade como 0 ou menos.

Tamanho mínimo da piscina

O número mínimo de conexões no pool.

Tipo de dados

inteiro

Valor Padrão

1

Observações

O número mínimo de conexões no pool. O padrão é 1.

TempoDeEsperaNaPool

O máximo de segundos para esperar por uma conexão disponível.

Tipo de dados

inteiro

Valor Padrão

60

Observações

O máximo de segundos para esperar que uma conexão fique disponível. Se uma nova solicitação de conexão estiver esperando por uma conexão disponível e exceder esse tempo, um erro será lançado. Por padrão, novas solicitações esperam para sempre por uma conexão disponível.

Pseudocolunas

Especifique um conjunto de pseudocolunas para expor como colunas.

Tipo de dados

corda

Valor Padrão

""

Observações

O valor desta configuração de conexão é do formato "Tabela1=Coluna1;Tabela1=Coluna2;Tabela2=Coluna3".

Você pode usar o caractere "*" para incluir todas as tabelas e todas as colunas; por exemplo, "*=*".

Somente leitura

Você pode usar esta propriedade para impor acesso somente leitura ao ServiceNow do provedor.

Tipo de dados

bolo

Valor Padrão

falso

Observações

Se esta propriedade for definida como true, o conector permitirá apenas consultas SELECT. Consultas INSERT, UPDATE, DELETE e de procedimento armazenado causarão um erro.

RTK

A chave de tempo de execução usada para licenciamento.

Tipo de dados

corda

Valor Padrão

""

Observações

A propriedade RTK pode ser usada para licenciar uma compilação. Veja o arquivo de licenciamento incluso para ver como definir essa propriedade. A chave de tempo de execução só estará disponível se você comprou uma licença OEM.

Descrições do programa

Controla se as descrições de colunas e tabelas são retornadas por meio dos endpoints da API sys_documentation e sys_db_object.

Valores Possíveis

NENHUM, Rótulos de tabela, Rótulos de coluna, Rótulos de tabela e coluna, Comentários de coluna

Tipo de dados

corda

Valor Padrão

"NENHUM"

Observações

Nota: Por padrão, ele é definido como NONE e as descrições para as tabelas e suas respectivas colunas não são mostradas. Chamadas extras de API serão executadas se essa propriedade for definida como um valor diferente de NONE. Defina o valor desta propriedade como TableLabels se quiser recuperar os rótulos (nomes de exibição) para cada tabela do endpoint da API sys_db_object. Defina o valor desta propriedade como ColumnLabels se quiser recuperar os rótulos (nomes de exibição) para cada coluna do endpoint da API sys_documentation. Defina o valor desta propriedade como TableAndColumnLabels se desejar recuperar os rótulos (nomes de exibição) para cada tabela e suas respectivas colunas dos endpoints da API sys_db_object e sys_documentation. Defina o valor desta propriedade como ColumnComments se quiser recuperar os comentários de cada coluna do endpoint da API sys_dictionary.

Tempo esgotado

O valor em segundos até que o erro de tempo limite seja gerado, cancelando a operação.

Tipo de dados

Inteiro

Valor Padrão

60

Observações

Se Timeout = 0, as operações não expiram. As operações são executadas até que sejam concluídas com sucesso ou até que encontrem uma condição de erro.

Se Timeout expirar e a operação ainda não estiver concluída, o conector lançará uma exceção.

UseConexãoPooling

Esta propriedade habilita o pool de conexões.

Tipo de dados

bolo

Valor Padrão

falso

Observações

Esta propriedade habilita o pool de conexões. O padrão é falso. Veja Connection Pooling do CData para obter informações sobre o uso de pools de conexão.

UseDisplayTableNames

Booleano que determina se os nomes de exibição da tabela devem ser usados em vez dos nomes da API.

Tipo de dados

bolo

Valor Padrão

falso

Observações

Por padrão, as tabelas são expostas usando os Nomes de Tabela Internos.

Se esta propriedade for definida como verdadeira, o provedor exporá as tabelas usando os Nomes de Exibição da GUI do ServiceNow.

Visualizações definidas pelo usuário

Booleano que determina se os nomes de exibição da tabela devem ser usados em vez dos nomes da API.

Tipo de dados

corda

Valor Padrão

""

Observações

As Views definidas pelo usuário são definidas em um arquivo de configuração formatado em JSON chamado UserDefinedViews.json. O driver detecta automaticamente as views especificadas neste arquivo.

Você também pode ter várias definições de visualização e controlá-las usando a propriedade de conexão UserDefinedViews. Quando você usa essa propriedade, apenas as visualizações especificadas são vistas pelo driver.

Este arquivo de configuração de exibição definida pelo usuário é formatado da seguinte maneira:

  • Cada elemento raiz define o nome de uma visualização.
  • Cada elemento raiz contém um elemento filho, chamado consultar, que contém a consultar SQL personalizada para a exibição.

Por exemplo:

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

Use a propriedade de conexão UserDefinedViews para especificar o local do seu arquivo de configuração JSON. Por exemplo:

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

Observe que o caminho especificado não está entre aspas.