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

SSO

OAuth

SSL

Firewall

Procurador

Esquema

Cache

Diversos

Autenticação

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

AuthScheme

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

Valores Possíveis

Automático, Básico, OAuth, OKTA, ADFS, OneLogin, PingFederate

Tipo de Dados

corda

Valor Padrão

"Auto"

Observações

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

• Auto: permite que o conector decida automaticamente com base nas outras propriedades de conexão que você definiu.
• Básico: Defina para usar a autenticação BÁSICA.
• OAuth: Defina para executar a autenticação OAuth.

Por padrão, AuthScheme é Auto, e se as propriedades Usuário e Senha estiverem definidas, o conector tentará a autenticação básica.

O conector executará a autenticação OAuth se AuthScheme estiver definido como OAuth ou OAuthAccessToken está definida.

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

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

URL

A URL base de 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/.

Do Utilizador

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

Tipo de Dados

corda

Valor Padrão

""

Observações

Juntamente com Senha, esse 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.

SSOLoginURL

A URL de login do provedor de identidade.

Tipo de Dados

corda

Valor Padrão

""

Observações

A URL de login do provedor de identidade.

Propriedades SSO

Propriedades adicionais necessárias para se 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 se conectar ao provedor de identidade em uma lista separada por ponto e vírgula. é usado em conjunto com o SSOLoginURL.

A configuração de SSO é discutida mais adiante em Estabelecendo uma conexão.

OAuth

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

InitiateOAuth

Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.

Valores Possíveis

OFF, GETANDREFRESH, REFRESH

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á tratado 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 existir um token, ele será atualizado quando aplicável.
3. REFRESH: indica que o conector tratará apenas da atualização do OAuthAccessToken. O usuário nunca será solicitado pelo conector a autenticar por meio do navegador. O usuário deve lidar com a obtenção do OAuthAccessToken e 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.

OAuthAccessToken

O token de acesso para conexão 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 as 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.

OAuthSettingsLocalização

O local do arquivo de configurações em que 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 ServiceNow \OAuthSettings.txt"

Observações

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

Como alternativa para especificar um caminho de arquivo, o armazenamento de memória pode ser usado. 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 (ex: 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, você deve armazenar manualmente as credenciais ao fechar a conexão com o armazenamento de memória para poder defini-las na conexão quando o processo for iniciado novamente. Os valores da propriedade OAuth podem ser recuperados com uma consultar à tabela do sistema sys_connection_props. Se houver várias conexões usando as mesmas credenciais, as propriedades devem ser lidas a partir da última conexão a ser fechada.

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

URL de Retorno

O URL de retorno de chamada OAuth ao qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno especificado nas configurações do 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. Esse valor deve corresponder ao URL de retorno de chamada especificado nas configurações do aplicativo.

OAuthGrantType

O tipo de concessão para o fluxo OAuth.

Valores Possíveis

CÓDIGO, SENHA

Tipo de Dados

corda

Valor Padrão

"SENHA"

Observações

O tipo de concessão para o fluxo OAuth. As seguintes opções estão disponíveis: CÓDIGO,SENHA

OAuthVerifier

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

Tipo de Dados

corda

Valor Padrão

""

Observações

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

Autenticação em Máquinas Sem Cabeça

Consulte Estabelecendo uma conexão para obter o valor OAuthVerifier.

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

Após a geração do arquivo de configurações OAuth, você pode remover OAuthVerifier das propriedades da conexão e conectar-se com OAuthSettingsLocation definir.

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

OAuthRefreshToken

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 a autenticação OAuth.

OAuthExpiresIn

O tempo de vida em segundos do OAuth AccessToken.

Tipo de Dados

corda

Valor Padrão

""

Observações

Emparelhe com OAuthTokenTimestamp para determinar quando o AccessToken expirará.

OAuthTokenTimestamp

O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

Tipo de Dados

corda

Valor Padrão

""

Observações

Emparelhe com OAuthExpiresIn para determinar quando o AccessToken expirará.

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

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

Firewall

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

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 encapsular o tráfego por meio do FirewallServer procurador. Observe que, por padrão, o conector se conecta ao proxy do sistema; para desativar esse comportamento e conectar-se a um dos seguintes tipos de proxy, defina ProxyAutoDetect para falso.

Para se conectar a proxies HTTP, use ProxyServer e ProxyPort. Para autenticar em proxies HTTP, use ProxyAuthScheme, ProxyUser e Senha do Proxy.

FirewallServer

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 que permite a passagem de um firewall. O protocolo é especificado por FirewallType: Use FirewallServer com esta propriedade para se conectar através de SOCKS ou fazer tunelamento. Use Servidor Proxy para se conectar 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.

FirewallPort

A porta TCP para um firewall baseado em proxy.

Tipo de Dados

int

Valor Padrão

0

Observações

Isso especifica a porta TCP para um proxy que permite a passagem de um firewall. Use FirewallServer para especificar o nome ou endereço IP. Especifique o protocolo com FirewallType.

FirewallUser

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

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

FirewallSenha

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.

Proxy

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

ProxyAutoDetect

Isso indica se deve usar as configurações de proxy do sistema ou não. Isso tem precedência sobre outras configurações de proxy, portanto, você precisará definir ProxyAutoDetect como FALSE para usar configurações de proxy personalizadas.

Tipo de Dados

bool

Valor Padrão

falso

Observações

Isso tem precedência sobre outras configurações de proxy, portanto, você precisará definir ProxyAutoDetect como FALSE para usar configurações de proxy personalizadas. NOTA: Quando esta propriedade está configurada para True, o proxy utilizado é determinado da seguinte forma:

• Uma pesquisa nas propriedades da JVM (http.proxy, https.proxy, meiasProxy, etc.) é executada.
• Caso as propriedades da JVM não existam, é realizada uma busca em java.home/lib/net.properties.
• No caso de java.net.useSystemProxies ser definido como True, uma pesquisa do SystemProxy é realizada.
• Somente no Windows, é feita uma tentativa de recuperar essas propriedades das Opções da Internet no registro.

Para se conectar a um proxy HTTP, consulte ProxyServer. Para outros proxies, como SOCKS ou tunelamento, consulte FirewallType.

Servidor Proxy

O nome do host ou endereço IP de um proxy para 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 conector 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 encapsular a conexão, consulte FirewallType.

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

Porta Proxy

A porta TCP na qual o proxy ProxyServer está sendo executado.

Tipo de Dados

int

Valor Padrão

80

Observações

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

ProxyAuthScheme

O tipo de autenticação a ser usado para autenticação no proxy ProxyServer.

Valores Possíveis

BÁSICO, DIGEST, 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 autenticação 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 false, além de ProxyServer e ProxyPort. Para autenticar, defina ProxyAuthScheme e defina ProxyUser e Senha do Proxy, se necessário.

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

• BASIC: O conector executa a autenticação HTTP BASIC.
• DIGEST: O conector executa a autenticação HTTP DIGEST.
• NEGOTIATE: 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 de autorização da solicitação HTTP.

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

ProxyUser

Um nome de usuário a ser usado para autenticação no proxy ProxyServer.

Tipo de Dados

corda

Valor Padrão

""

Observações

O ProxyUser e a ProxyPassword 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-a 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

ProxySenha

Uma senha a ser usada para autenticação no proxy ProxyServer.

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 o proxy HTTP.

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

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

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

ProxySSLType

O tipo de 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. Esse valor pode ser AUTO, SEMPRE, NUNCA ou TÚNEL. Os valores aplicáveis são os seguintes:

ProxyExceptions

Uma lista separada por ponto-e-vírgula de nomes de host ou IPs de destino que estão isentos de conexão por meio 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 as entradas.

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

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

corda

Valor Padrão

"%APPDATA%\ ServiceNow 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. A propriedade Location só é necessária se você quiser personalizar as definições (por exemplo, alterar o nome de uma 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%\ ServiceNow 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

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, Tabelas=TabelaA,TabelaB,TabelaC.

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.

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

corda

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.

IncludeDatabaseViews

Controla se as exibições do banco de dados devem ser expostas ou não.

Tipo de Dados

bool

Valor Padrão

falso

Observações

Controla se as exibições do banco de dados devem ser expostas ou não. Se 'True', o conector enviará várias chamadas de metadados adicionais para obter os metadados das exibições de banco de dados.

IncludeSystemTables

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

Tipo de Dados

bool

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 administrativa têm acesso a essas tabelas. Definir essa propriedade como false fará com que eles não sejam listados nas chamadas de metadados.

Cache

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

AutoCache

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

Tipo de Dados

bool

Valor Padrão

falso

Observações

Quando AutoCache = verdadeiro, 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 de forma incremental, 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. Depois que o cache é atualizado, a consultar é executada nos dados armazenados em cache.

Definindo o Banco de Dados de Cache

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

• Localização do Cache: Especifica o caminho para o armazenamento de arquivos.
• CacheDriver e Conexão de Cache: Especifica um driver para um banco de dados e a string de conexão.

Veja Também

• CacheTolerance: Esta propriedade controla a tolerância para dados obsoletos no cache.
• CacheMetadados: essa propriedade reduz a quantidade de metadados que cruza a rede ao persistir os esquemas de tabela recuperados dos metadados do ServiceNow. Os metadados precisam ser recuperados apenas uma vez em vez de cada conexão.
• REPLICAR declarações: Quando você executa uma instrução SELECT com AutoCache = true, o conector chama internamente a instrução REPLICATE. A instrução REPLICATE permite atualizações incrementais em vez de primeiro descartar a tabela em cache.
• Cache de dados explicitamente: Esta seção fornece mais exemplos de uso do AutoCache em Offline modo.
• Declarações CACHE: Você pode usar a instrução CACHE para persistir qualquer consultar SELECT, bem como gerenciar o cache; por exemplo, esquemas de atualização.

Cache Driver

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 armazenar em cache 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 incluir o arquivo JAR CacheDriver no classpath.

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

Derby e JavaDB

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, depois de adicionar derby.jar ao caminho de classe:

jdbc:servicenow:CacheLocation='c:/Temp/cachedir';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;User=MyUser;Password=MyPassword;Url=https://MyInstance12345.service-now.com/;

Para personalizar a URL JDBC do Derby, use CacheDriver e CacheConnection. Por exemplo, para armazenar em cache um banco de dados na memória, use um URL JDBC como o 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 SQLite JDBC:

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 para MySQL incluído:

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

A 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/;

NOTA: Se estiver usando uma versão do Oracle anterior à 9i, o driver de cache será oracle.jdbc. driver.OracleDriver.

PostgreSQL

A seguinte URL JDBC usa o driver PostgreSQL JDBC oficial:

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/;

CacheConnection

A string de conexão para o banco de dados de cache. Essa 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 do 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 de banco de dados de cache comuns podem ser encontrados abaixo. Para obter mais informações sobre como configurar o driver do banco de dados de cache, consulte CacheDriver.

A string de conexão especificada na propriedade CacheConnection é passada diretamente para o CacheDriver. 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 de seu aplicativo.

Derby e JavaDB

O driver simplifica o armazenamento em cache no Derby, exigindo apenas que você defina o CacheLocation 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 de URL JDBC do Derby:

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

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

jdbc:derby:memory

SQLite

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

jdbc:sqlite:dataSource

• Data Source: 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 driver JDBC para MySQL. Veja a seguir um exemplo de URL JDBC:

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

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

• 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

A URL JDBC para o Microsoft JDBC Driver for 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 se conectar a uma instância nomeada em vez da instância padrão, essa propriedade pode ser usada para especificar o nome do hospedar e a instância, separados por uma barra invertida.

• Porta: A porta em que o SQL Server está sendo executado.

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

• Segurança integrada: Defina esta opção como verdadeira 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. O número de bits do assembly deve corresponder ao número de bits de sua JVM.

• User ID: O nome de 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 de URL JDBC convencional para o driver Oracle JDBC Thin:

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

Por exemplo:

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

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

• Data Source: 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.

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

PostgreSQL

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

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

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

jdbc:postgresql:postgres

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

• 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 do usuário: O ID do usuário fornecido para autenticação com o banco de dados PostgreSQL. Você pode especificar isso na URL JDBC com o parâmetro "user".
• Senha: A senha fornecida para autenticação com o banco de dados PostgreSQL.

CacheLocation

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

Tipo de Dados

corda

Valor Padrão

"%APPDATA%\ Provedor de Dados 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 Java DB JAR ao caminho de classe. 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 é "%APPDATA%\ ServiceNow Data Provider" com %APPDATA% sendo definido como o diretório de configuração do usuário:

Veja Também

• AutoCache: Defina para criar e manter implicitamente um cache para uso offline posterior.
• CacheMetadados: Defina para manter o catálogo ServiceNow em CacheLocation.

CacheTolerance

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

Tipo de Dados

int

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 recentes depois que o intervalo de tolerância expira. Caso contrário, ele retorna os dados diretamente do cache.

Desligada

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

Tipo de Dados

bool

Valor Padrão

falso

Observações

Quando Offline = verdadeiro, todas as consultas são executadas no cache, e não na fonte de dados ativa. Neste modo, determinadas consultas como INSERT, UPDATE, DELETE e CACHE não são permitidas.

CacheMetadados

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

Tipo de Dados

bool

Valor Padrão

falso

Observações

À medida que você executa consultas com esse conjunto de propriedades, 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 inicial 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 pela primeira vez os metadados de uma tabela ou exibição e, portanto, CacheMetadata geralmente não é necessário. CacheMetadata torna-se útil quando as operações de metadados são caras, como quando você está trabalhando com grandes quantidades de metadados ou quando você tem muitas conexões de curta duração.

Quando Não Usar CacheMetadata

• Quando você está trabalhando com metadados voláteis: Os metadados de uma tabela só são recuperados na primeira vez que a conexão com a tabela é feita. Para selecionar colunas novas, alteradas ou excluídas, você precisa excluir e reconstruir o cache de metadados. Portanto, é melhor confiar no cache na memória para casos em que os metadados mudam com frequência.
• 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 Conexão de Cache, use AutoCache para armazenar em cache implicitamente. Ou use REPLICAR declarações ou Declarações CACHE para armazenar em cache explicitamente.

Diversos

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

Tamanho do Batch

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

Tipo de Dados

int

Valor Padrão

0

Observações

Quando BatchSize for definido com 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 enviados ao servidor individualmente. Isso é útil quando o servidor tem limitações quanto ao tamanho da solicitação que pode ser enviada.

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

ConnectionLifeTime

O tempo de vida máximo de uma conexão em segundos. Depois de decorrido o tempo, o objeto de conexão é descartado.

Tipo de Dados

int

Valor Padrão

0

Observações

O tempo de vida máximo de uma conexão em segundos. Depois de decorrido o tempo, o objeto de conexão é descartado. O padrão é 0, o que indica que não há limite para o tempo de vida da conexão.

ConnectOnOpen

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

Tipo de Dados

bool

Valor Padrão

falso

Observações

Quando definido como verdadeiro, uma conexão será estabelecida com o ServiceNow quando a conexão for aberta. Esta propriedade ativa 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 nada dessa conexão inicial é mantido.

Definir essa propriedade como false pode fornecer melhorias de desempenho (dependendo do número de vezes que uma conexão é aberta).

DisplayValue

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, TODOS

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 às limitações da API.

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

ExcluirReferenceLink

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

Tipo de Dados

bool

Valor Padrão

falso

Observações

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

GetColumnsMetadata

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

Valores Possíveis

OnStart, OnUse

Tipo de Dados

corda

Valor Padrão

"OnStart"

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íficos da tabela na primeira vez que a tabela for referenciada, desde que os metadados da tabela ainda não estejam armazenados em cache.

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

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

Integração e Formatação

Tamanho da Página

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

Tipo de Dados

int

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. Definir um valor mais alto pode resultar em melhor desempenho ao custo de memória adicional consumida por página consumida.

PoolIdleTimeout

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

Tipo de Dados

int

Valor Padrão

60

Observações

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

PoolMaxSize

O máximo de conexões no pool.

Tipo de Dados

int

Valor Padrão

100

Observações

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

PoolMinSize

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

Tipo de Dados

int

Valor Padrão

1

Observações

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

PoolWaitTime

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

Tipo de Dados

int

Valor Padrão

60

Observações

O máximo de segundos para aguardar a disponibilidade de uma conexão. Se uma nova solicitação de conexão estiver aguardando uma conexão disponível e exceder esse tempo, um erro será lançado. Por padrão, novas solicitações aguardam indefinidamente por uma conexão disponível.

Pseudocolunas

Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.

Tipo de Dados

corda

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

Somente Leitura

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

Tipo de Dados

bool

Valor Padrão

falso

Observações

Se esta propriedade estiver configurada para true, o conector permitirá apenas consultas SELECT. INSERT, UPDATE, DELETE e procedimento armazenado* fará com que um erro seja lançado.

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. Consulte o arquivo de licenciamento incluído para saber como definir essa propriedade. A chave de tempo de execução está disponível apenas se você adquiriu uma licença OEM.

Mostrar Descrições

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

Valores Possíveis

NONE, TableLabels, ColumnLabels, TableAndColumnLabels, ColumnComments

Tipo de Dados

corda

Valor Padrão

"NENHUM"

Observações

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

SupportEnhancedSQL

Essa propriedade aprimora a funcionalidade SQL além do que pode ser suportado diretamente pela API, permitindo o processamento na memória do lado do cliente.

Tipo de Dados

bool

Valor Padrão

verdadeiro

Observações

Quando SupportEnhancedSQL = true, o conector descarrega o máximo possível do processamento da instrução SELECT para o ServiceNow e, em seguida, processa o restante da consultar na memória. Dessa forma, o conector pode executar predicados, uniões e agregações não suportados.

Quando SupportEnhancedSQL = false, o conector limita a execução do SQL ao que é compatível com a API do ServiceNow.

Execução de Predicados

O conector determina quais das cláusulas são suportadas pela fonte de dados e, em seguida, as envia para a fonte para obter o menor superconjunto de linhas que satisfaria a consultar. Em seguida, ele filtra o restante das linhas localmente. A operação de filtro é transmitida, o que permite que o conector filtre efetivamente até mesmo conjuntos de dados muito grandes.

Execução de Junções

O conector usa várias técnicas para ingressar na memória. O conector compensa a utilização da memória com o requisito de ler a mesma tabela mais de uma vez.

Execução de Agregados

O conector recupera todas as linhas necessárias para processar a agregação na memória.

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 expirar e a operação ainda não estiver concluída, o conector lançará uma exceção.

UseConnectionPooling

Essa propriedade ativa o pool de conexões.

Tipo de Dados

bool

Valor Padrão

falso

Observações

Essa propriedade ativa o pool de conexões. O padrão é falso. Consulte Pool de conexão para obter informações sobre como usar 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

bool

Valor Padrão

falso

Observações

Por padrão, as tabelas são expostas usando os nomes das tabelas internas.

Se essa propriedade for definida como true, o provedor exporá as tabelas usando os nomes de exibição da GUI do ServiceNow.