Detalhes da Conexão do Jira Service Management

Introdução

Versão do conector

Esta documentação é baseada na versão 21.0.8454 do conector.

Começando

Suporte à versão do Jira Service Desk

O conector utiliza a API do Jira Service Desk para permitir o acesso bidirecional ao Jira Service Desk.

O conector funciona com contas do Jira Service Desk Cloud e instâncias do Jira Service Desk Server.

O Atlassian Jira Service Management era conhecido anteriormente como * Jira Service Desk* e recebeu seu novo nome a partir da versão 4.14. No entanto, há muitas referências ao Service Desk nesta documentação, na documentação da Atlassian e nas APIs REST da Atlassian. Consulte as Notas de versão do Atlassian Service Management 4.14.x para detalhes.

Estabelecendo uma Conexão

Conectando-se ao Jira Service Desk

Você pode estabelecer uma conexão com qualquer conta do Jira Service Desk Cloud ou instância do Jira Service Desk Server. Para conectar, defina a seguinte propriedade:

• URL (por exemplo: https://yoursitename.atlassian.net).

Autenticação no Jira Service Desk

Autenticação Básica

Autenticando com uma conta na nuvem

Para se conectar a uma conta Cloud, primeiro você precisa recuperar um APIToken. Para gerar um, faça login na sua conta da Atlassian e navegue até API tokens > Create API token. O token gerado será exibido.

Forneça o seguinte para se conectar aos dados:

• AuthScheme: Defina este Básico.
• User: Defina como o nome de usuário do usuário autenticado.
• APIToken: Defina isso para o token de API encontrado anteriormente.

Autenticando com uma conta de servidor local

Para autenticar com uma conta de servidor local, você precisará fornecer as seguintes propriedades de conexão:

• AuthScheme: Defina este Básico.
• User: Defina como o nome de usuário do usuário autenticado.
• Password: Defina isso como a senha do usuário autenticado.
• URL: Defina isso como o URL associado ao endpoint do Jira Service Desk. Por exemplo, https://yoursitename.atlassian.net.

Observação: A senha foi obsoleta para conectar-se a uma conta de nuvem e agora é usada apenas para conectar-se a uma instância do servidor.

Autenticar com um Aplicativo OAuth Personalizado (3lo)

Você pode aproveitar o suporte OAuth 2.0 (3LO) "de três pernas" do Jira Service Desk para se conectar aos dados sem fornecer suas credenciais de login. Consulte Usando autenticação OAuth para obter um guia de autenticação.

Autenticar Usando OAuth1.0

Para se conectar ao Jira Service Desk, você precisará seguir as etapas abaixo:

• Em primeiro lugar, gere um par de chaves públicas/privadas RSA. No seu terminal, execute os seguintes comandos:
  -openssl genrsa -out jira_privatekey.pem 1024
  -openssl req -newkey rsa:1024 -x509 -key jira_privatekey.pem -out jira_publickey.cer -days 365
  -openssl pkcs8 -topk8 -nocrypt -in jira_privatekey.pem -out jira_privatekey.pcks8
  -openssl x509 -pubkey -noout -in jira_publickey.cer -out jira_publickey.pem
  
• Crie links de aplicativos em sua conta. Vá para Configurações -> Aplicações -> Links de aplicativos.
• Insira um URL de teste para o campo URL, clique em 'Criar novo link'.
• Ignore o erro e clique em continuar. Queremos apenas configurar as chamadas recebidas (do aplicativo para o Jira Service Desk).
• Na janela 'Vincular aplicativos', preencha os campos que desejar, pois não são relevantes. Mas certifique-se de marcar 'Criar link de entrada'. Clique em Continuar para ir para a próxima página.
• Preencha os campos obrigatórios:
  -Chave do Consumidor: Preencha como quiser. Você usará isso como OAuthClientId mais tarde.
  -Nome do Consumidor: Preencha como quiser.
  -Public key: Insira a chave no arquivo 'jira_publickey.pem' gerado anteriormente. E clique em continuar.
  

Para conectar, defina as seguintes propriedades:

• URL (por exemplo: https://yoursitename.atlassian.net).
• OAuthClientId à chave do consumidor de sua aplicação.
• OAuthClientSecret a qualquer valor (como 'testClientSecret').
• OAuthJWTCert para o local do seu arquivo de chave privada.
• OAuthJWTCertType para a opção apropriada com base no arquivo de chave privada que está sendo usado. Se estiver usando o arquivo de chave PEM gerado, defina OAuthJWTCertType para PEMKEY_FILE.
• InitiateOAuth para GETANDREFRESH.

Autenticação com Multidão

Colocou o AuthScheme para Crowd. As seguintes propriedades de conexão são usadas para se conectar ao Crowd:

• User: A conta de usuário CROWD.
• Password: A senha associada à conta Crowd.
• SSOLoginURL: A URL de login associada à conta Crowd. Você pode encontrar o URL do IDP navegando para your application -> SSO -> SSO information -> Identity provider single sign-on URL.
• SSOAppName: O nome do aplicativo no qual o SSO está ativado.
• SSOAppPassword: A senha do aplicativo no qual o SSO está habilitado.
• SSOExchangeUrl: A URL usada para trocar o token SAML por cookies JiraServiceDesk. Este URL pode ter os seguintes formatos:
  • https://<authority da instância do JiraServiceDesk>/plugins/servlet/samlconsumer
  • https://<authority da instância do JiraServiceDesk>/plugins/servlet/samlsso

Veja a seguir um exemplo de string de conexão:

AuthScheme=Crowd;Url=https://yoursitename.atlassian.net;SSOLoginURL='https://<authority>/crowd/console/secure/saml/sso.action';User=crowdUserName;Password=crowdPassword;SSOExchangeUrl=https://<authority of JiraServiceDesk instance>/plugins/servlet/samlconsumer;SSOAppName=CrowdAppName;SSOAppPassword=CrowdAppPassword;

Autenticação com Okta

Colocou o AuthScheme para Okta. As seguintes propriedades de conexão são usadas para se conectar ao Okta:

• User: Defina isso para o usuário Okta.
• Password: Defina como senha Okta para o usuário.
• SSOLoginURL: Defina isso para a URL de login usada pelo provedor SSO.
• SSOExchangeUrl: A URL usada para trocar o token SAML por cookies JiraServiceDesk. Este URL pode ter os seguintes formatos:
  • https://<authority da instância do JiraServiceDesk>/plugins/servlet/samlconsumer
  • https://<authority da instância do JiraServiceDesk>/plugins/servlet/samlsso

A seguir SSOProperties são necessários para autenticar no Okta:

• APIToken (opcional): defina como o API Token que o cliente criou a partir da organização Okta. Ele deve ser usado ao autenticar um usuário por meio de um aplicativo ou proxy confiável que substitui o contexto de solicitação do cliente OKTA.
• MFAType (opcional): Defina isso apenas caso você tenha configurado o fluxo de MFA. Atualmente suportamos apenas os seguintes tipos: OktaVerify, E-mail e SMS.
• MFAPassCode (opcional): Defina isso apenas caso você tenha configurado o fluxo de MFA. Se estiver definido como vazio/inválido, o driver emitirá inicialmente um desafio de MFA que acionará a plataforma para enviar a você uma senha de uso único em seu dispositivo ou e-mail, com base no tipo de MFA configurado. Você precisa reemitir outra conexão em que o valor da senha única recuperada é passado para a propriedade de conexão MFAPassCode.

Veja a seguir um exemplo de string de conexão:

AuthScheme=Okta;Url=https://yoursitename.atlassian.net;SSOLoginURL='https://example.okta.com/home/appType/0bg4ivz6cJRZgCz5d6/46';User=oktaUserName;Password=oktaPassword;SSOExchangeUrl=https://<authority of JiraServiceDesk instance>/plugins/servlet/samlconsumer;

Acessando Campos Personalizados

Por padrão, o conector mostra apenas os campos do sistema. Para acessar os campos personalizados para problemas, defina IncludeCustomFields.

Usando Autenticação OAuth

OAuth requer que o usuário autenticado interaja com o Jira Service Desk usando o navegador. O conector facilita isso de várias maneiras, conforme descrito abaixo.

Credenciais Personalizadas

Depois de criar seu aplicativo, você pode se conectar com Credenciais personalizadas.

Criando um Aplicativo OAuth Personalizado

Consulte Criando um aplicativo OAuth personalizado para o procedimento. Seu novo aplicativo conterá o OAuthClientId e OAuthClientSecret necessário para estabelecer uma conexão.

Credenciais Personalizadas

Esta seção descreve a autenticação da área de trabalho usando as credenciais para seu aplicativo OAuth personalizado. Consulte Criando um aplicativo OAuth personalizado Para maiores informações.

Obtenha um Token de Acesso OAuth

Depois de definir o seguinte, você está pronto para se conectar:

• OAuthClientId: Defina o ID do cliente nas configurações do aplicativo.
• OAuthClientSecret: Defina o segredo do cliente nas configurações do aplicativo.
• CallbackURL: Defina como URL de redirecionamento nas configurações do aplicativo.
• OAuthVersion: Definido como 2.0.
• URL: A URL para o endpoint do JIRA Service Desk; por exemplo, https://yoursitename.atlassian.net.
• InitiateOAuth: Definido como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken.

Quando você se conecta, o conector abre o endpoint OAuth em seu navegador padrão. Faça login e conceda permissões ao aplicativo. O conector conclui o seguinte processo OAuth:

1. Extrai o token de acesso do URL de retorno de chamada e autentica as solicitações.
2. Obtém um novo token de acesso quando o antigo expira.
3. Salva valores OAuth em OAuthSettingsLocation para ser persistido nas conexões.

Máquinas Sem Cabeça

Para criar fontes de dados do Jira Service Desk em servidores headless ou outras máquinas nas quais o conector não pode abrir um navegador, você precisa se autenticar em outra máquina. A autenticação é um processo de duas etapas.

1. Ao invés de instalar o conector em outra máquina, você pode seguir os passos abaixo para obter o OAuthVerifier valor. Ou você pode instalar o conector em outra máquina e transferir os valores de autenticação OAuth, depois de autenticar por meio do fluxo normal baseado em navegador.
2. Em seguida, você pode configurar o conector para atualizar automaticamente o token de acesso da máquina sem periféricos.

Você pode seguir o fluxo de autenticação OAuth headless usando as credenciais OAuth incorporadas do conector ou usando as credenciais OAuth para seu aplicativo OAuth personalizado.

Usando as Credenciais para um Aplicativo OAuth Personalizado

Crie um Aplicativo OAuth Personalizado

Consulte Criando um aplicativo OAuth personalizado para um procedimento. Esta seção descreve o procedimento para autenticar e conectar-se aos dados.

OAuth 2.0

Obtenha um Código Verificador

Primeiro, defina as seguintes propriedades na máquina sem periféricos:

• InitiateOAuth: Definido como OFF.
• OAuthClientId: Defina o ID do aplicativo nos detalhes do aplicativo.
• OAuthClientSecret: Defina o segredo do aplicativo nos detalhes do aplicativo.
• OAuthVersion: Definido como 2.0.

Em seguida, autentique-se em outra máquina e obtenha o OAuthVerifier propriedade da conexão:

1. Chame o GetOAuthAuthorizationURL procedimento armazenado* com o parâmetro de entrada CallbackURL definido para o URI de redirecionamento exato que você especificou nos detalhes do aplicativo em APIS AND FEATURES -> OAuth 2.0 (3LO).
2. Abra o URL retornado em um navegador. Faça login e conceda permissões ao conector. Você será redirecionado para o URL de retorno de chamada, que contém o código do verificador.
3. Salve o valor do código do verificador. Você precisa definir isso no OAuthVerifier propriedade de conexão.

Por fim, na máquina sem periféricos, defina as seguintes propriedades de conexão para obter os valores de autenticação OAuth:

• OAuthClientId: Defina a chave do consumidor nos detalhes do seu aplicativo.
• OAuthClientSecret: Defina como o segredo do consumidor nos detalhes do seu aplicativo.
• OAuthVerifier: Defina para o código do verificador.
• OAuthSettingsLocation: Defina para manter os valores de autenticação OAuth criptografados no arquivo especificado.
• InitiateOAuth: Definido como REFRESH.

OAuth 1.0

Obtenha um Código Verificador

Primeiro, defina as seguintes propriedades na máquina sem periféricos:

• InitiateOAuth: Definido como OFF.
• OAuthClientId: Defina o ID do aplicativo nos detalhes do aplicativo.
• OAuthClientSecret: Defina o segredo do aplicativo nos detalhes do aplicativo.
• OAuthVersion: Definido como 1.0.
• Salve o valor do AuthToken e AuthKey retornados. Eles serão usados na próxima etapa.
• Abra o URL retornado em um navegador. Faça login e conceda permissões ao conector. Você será redirecionado para o URL de retorno de chamada, que contém o código do verificador.

Em seguida, autentique-se em outra máquina e obtenha o OAuthVerifier propriedade da conexão:

1. Chame o GetOAuthAuthorizationURL procedimento armazenado* com o parâmetro de entrada CallbackURL definido para o URI de redirecionamento exato que você especificou nos detalhes do aplicativo em APIS AND FEATURES -> OAuth 2.0 (3LO).
2. Abra o URL retornado em um navegador. Faça login e conceda permissões ao conector. Você será redirecionado para o URL de retorno de chamada, que contém o código do verificador.
3. Salve o valor do código do verificador. Você precisa definir isso no OAuthVerifier propriedade de conexão.

Por fim, na máquina sem periféricos, defina as seguintes propriedades de conexão para obter os valores de autenticação OAuth:

• OAuthClientId: Defina a chave do consumidor nos detalhes do seu aplicativo.
• OAuthClientSecret: Defina como o segredo do consumidor nos detalhes do seu aplicativo.
• OAuthVerifier: Defina para o código do verificador.
• AuthToken: Defina isso para o AuthToken.
• AuthKey: Defina isso para o AuthKey.
• OAuthSettingsLocation: Defina para manter os valores de autenticação OAuth criptografados no arquivo especificado.
• InitiateOAuth: Definido como REFRESH.

Conectar aos Dados

Depois que o arquivo de configurações OAuth for gerado, defina as seguintes propriedades para se conectar aos dados:

• OAuthSettingsLocation: Defina como o arquivo que contém os valores de autenticação OAuth criptografados. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao provedor para ativar a atualização automática do token de acesso.
• InitiateOAuth: Definido como REFRESH.
• OAuthVersion: Definido como 2.0.
• URL: A URL para o endpoint do JIRA Service Desk; por exemplo, https://yoursitename.atlassian.net.

Transferir Configurações de OAuth

Para instalar o conector em outra máquina, autentique e transfira os valores OAuth resultantes:

1. Em uma segunda máquina, instale o conector e conecte-se com o seguinte conjunto de propriedades:
   • OAuthSettingsLocation: Defina como um arquivo de texto gravável.
   • InitiateOAuth: Definido como GETANDREFRESH.
   • OAuthClientId: Defina o ID do cliente nos detalhes do seu aplicativo.
   • OAuthClientSecret: Defina o segredo do cliente nos detalhes do aplicativo.
   • CallbackURL: Defina o URL de retorno de chamada nos detalhes do aplicativo em APIS AND FEATURES -> OAuth 2.0 (3LO).
2. Teste a conexão para autenticar. Os valores de autenticação resultantes são gravados, criptografados, no caminho especificado por OAuthSettingsLocation. Depois de testar a conexão com sucesso, copie o arquivo de configurações OAuth para sua máquina sem periféricos. Na máquina sem periféricos, defina as seguintes propriedades de conexão para se conectar aos dados:
   • InitiateOAuth: Definido como REFRESH.
   • OAuthSettingsLocation: Defina como o caminho para o arquivo de configurações OAuth. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao conector para habilitar a atualização automática do token de acesso.
   • OAuthVersion: Definido como 2.0.
   • URL: A URL para o endpoint do JIRA Service Desk; por exemplo, https://yoursitename.atlassian.net.

Criando um Aplicativo OAuth Personalizado

Se você não tiver acesso ao nome de usuário e ao token da API ou não quiser exigi-los, poderá usar a autenticação OAuth. O Jira Service Desk usa o padrão de autenticação OAuth, que exige que o usuário autenticado interaja com o Jira Service Desk por meio do navegador. O conector facilita a troca OAuth de várias maneiras, conforme descrito nesta seção. Please note OAuth 2.0 is only supported for Jira Service Desk Cloud.

Criar um Aplicativo OAuth

Para obter as credenciais do cliente OAuth, a chave do consumidor e o segredo do consumidor:

1. Faça login no site do JIRA Service Desk Cloud.
2. Navegue até o gerenciamento do aplicativo ( desenvolvedor).
3. Selecione Create new app e nomeie o aplicativo. O aplicativo agora será criado.
4. Se estiver faltando, adicione a funcionalidade OAuth 2.0 ao seu aplicativo navegando para APIS AND FEATURES -> + Add -> Add OAuth 2.0 (3LO).
5. De APIS AND FEATURES -> + Add, Adicione o JIRA Service Desk platform REST API para o seu aplicativo. Observe que você também precisa adicionar o aplicativo JIRA para obter todas as funcionalidades do driver.
6. De APIS AND FEATURES -> + JIRA Service Desk platform REST API, adicione os escopos desejados ao seu aplicativo.
7. Além disso, você precisará configurar seu URL de retorno de chamada. Navegar para APIS AND FEATURES -> OAuth 2.0 (3LO). Insira um URL acessível para seu aplicativo e salve as alterações.

Autenticar no Jira Service Desk a Partir de um Aplicativo de Desktop

Depois de definir as seguintes propriedades de conexão, você está pronto para se conectar:

• OAuthClientId: Defina a chave do consumidor nos detalhes do seu aplicativo.
• OAuthClientSecret: Defina como o segredo do consumidor nos detalhes do seu aplicativo.
• CallbackURL: Defina o URL de retorno de chamada encontrado nos detalhes do aplicativo em APIS AND FEATURES -> OAuth 2.0 (3LO).
• InitiateOAuth: Definido como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken propriedade de conexão.
• OAuthVersion: Definido como 2.0.
• URL: A URL para o endpoint do JIRA Service Desk; por exemplo, https://yoursitename.atlassian.net.

Quando você se conecta, o conector abre o endpoint OAuth em seu navegador padrão. Faça login e conceda permissões ao aplicativo. O conector conclui o seguinte processo OAuth:

1. Obtém o URL de retorno de chamada e define o token de acesso e oauthserverurl para autenticar solicitações.
2. Salva valores OAuth em OAuthSettingsLocation para ser persistido nas conexões.
3. Troca o token de atualização retornado por um novo token de acesso válido.

Autenticar no Jira Service Desk a Partir de um Aplicativo da Web

Para obter o token de acesso, defina as seguintes propriedades de conexão:

• OAuthClientId: Defina a chave do consumidor nos detalhes do seu aplicativo.
• OAuthClientSecret: Defina como o segredo do consumidor nos detalhes do seu aplicativo.
• CallbackURL: Defina o URL de retorno de chamada nos detalhes do aplicativo em APIS AND FEATURES -> OAuth 2.0 (3LO).
• URL: A URL para o endpoint do JIRA Service Desk; por exemplo, https://yoursitename.atlassian.net.
• OAuthVersion: Definido como 2.0.

Ao conectar por meio de um aplicativo da Web ou se o conector não estiver autorizado a abrir uma janela do navegador, você precisará trocar os valores de verificação temporários pelo token de acesso:

1. Chame GetOAuthAuthorizationURL. O procedimento armazenado* retorna a URL para o endpoint OAuth.
2. Faça login e autorize o aplicativo. Você é redirecionado de volta para o URL de retorno de chamada. Se você definir o parâmetro GrantType como Implicit, o callbackURL contém o OAuthAccessToken e oauthserverurl em um parâmetro de string de consultar. Se você definir o parâmetro GrantType como code, o URL de retorno de chamada contém o código do verificador no parâmetro da string de consultar denominado "código". Extraia o código do verificador e chame GetOAuthAccessToken.

Para se conectar aos dados, defina as seguintes propriedades de conexão:

• OAuthAccessToken
• OAuthVersion
• OAuthClientId
• OAuthClientSecret
• OAuthAccessToken
• URL

Acesso a Dados de Ajuste Fino

Acesso a Dados de Ajuste Fino

Você pode usar as seguintes propriedades para obter mais controle sobre os dados retornados do Jira Service Desk:

• ServiceDeskID: O ID do service desk específico ao qual você gostaria de se conectar.
  Por padrão, obtemos o primeiro ID retornado de uma chamada extra para obter todas as centrais de atendimento. Você pode obter o ServiceDeskId executando uma consultar Select para a exibição ServiceDesks.
• IncludeCustomFields: Incluir ou não campos personalizados nas consultas à tabela de Pedidos.
• RequestLanguage: Defina para qualquer idioma instalado no Jira para traduzir os nomes das colunas de exibição no idioma especificado.
  Especifique uma tag de idioma IETF BCP 47 conforme descrito aqui: https://tools.ietf.org/html/bcp47.

Características Avançadas

Esta seção detalha uma seleção de recursos avançados do conector do Jira Service Desk.

Visualizações definidas pelo usuário

O conector permite definir tabelas virtuais, denominadas visualizações definidas pelo usuário, cujo conteúdo é decidido por uma consultar pré-configurada. Essas exibições são úteis quando você não pode controlar diretamente as consultas enviadas aos drivers. Consulte Visualizações definidas pelo usuário para obter uma visão geral da criação e configuração de exibições personalizadas.

Configuração SSL

Use Configuração SSL para ajustar como o conector lida com as negociações de certificado TLS/SSL. Você pode escolher entre vários formatos de certificado; Veja o SSLServerCert propriedade em "Opções de cadeia de conexão" para obter mais informações.

Procurador

Para configurar o conector usando configurações de proxy do Agente Privado, selecione os Use Proxy Settings caixa de seleção na tela de configuração da conexão.

Visualizações Definidas pelo Usuário

O Jitterbit Connector for Jira Service Desk permite definir uma tabela virtual cujo conteúdo é decidido por uma consultar pré-configurada. Elas são chamadas de Visualizações Definidas pelo Usuário, que são úteis em situações onde você não pode controlar diretamente a consultar que está sendo emitida para o driver, por exemplo, ao usar o driver do Jitterbit. As Visualizações Definidas pelo Usuário podem ser usadas para definir predicados que são sempre aplicados. Se você especificar predicados adicionais na consultar para a visualização, eles serão combinados com a consultar já definida como parte da visualização.

Há duas maneiras de criar exibições definidas pelo usuário:

• Crie um arquivo de configuração em formato JSON definindo as visualizações desejadas.
• declarações DDL.

Definindo Visualizações Usando um Arquivo de Configuração

As visualizações definidas pelo usuário são definidas em um arquivo de configuração formatado em JSON chamado UserDefinedViews.json. O conector detecta automaticamente as visualizações especificadas neste arquivo.

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

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

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

Por exemplo:

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

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

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

Esquema para Exibições Definidas pelo Usuário

As visualizações definidas pelo usuário são expostas no UserViews esquema por padrão. Isso é feito para evitar que o nome da exibição entre em conflito com uma entidade real no modelo de dados. Você pode alterar o nome do esquema usado para UserViews definindo o UserViewsSchemaName propriedade.

Trabalhando com Exibições Definidas pelo Usuário

Por exemplo, uma instrução SQL com uma Visualização Definida pelo Usuário chamada UserViews.RCustomers lista apenas clientes em Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

Exemplo de consultar ao driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resultando na consultar efetiva à fonte:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

Esse é um exemplo muito simples de uma consultar a uma exibição definida pelo usuário que é efetivamente uma combinação da consultar de exibição e da definição de exibição. É possível compor essas consultas em padrões muito mais complexos. Todas as operações SQL são permitidas em ambas as consultas e são combinadas quando apropriado.

Configuração SSL

Personalizando a Configuração SSL

Por padrão, o conector tenta negociar SSL/TLS verificando o certificado do servidor em relação ao armazenamento de certificados confiáveis do sistema.

Para especificar outro certificado, consulte o SSLServerCert propriedade para os formatos disponíveis para fazê-lo.

Certificados SSL do Cliente

O conector do Jira Service Desk também oferece suporte à configuração de certificados de cliente. Defina o seguinte para se conectar usando um certificado de cliente.

• SSLClientCert: O nome do armazenamento de certificados para o certificado do cliente.
• SSLClientCertType: O tipo de armazenamento de chaves que contém o certificado de cliente TLS/SSL.
• SSLClientCertPassword: A senha para o certificado do cliente TLS/SSL.
• SSLClientCertSubject: O assunto do certificado de cliente TLS/SSL.

Modelo de Dados

Visão geral

Esta seção mostra os objetos de API disponíveis e fornece mais informações sobre a execução de SQL para APIs do Jira Service Desk.

Características principais

• O conector modela as entidades do Jira Service Desk, como documentos, pastas e grupos como exibições relacionais, permitindo que você escreva SQL para consultar os dados do Jira Service Desk.
• Procedimentos armazenados* permitem que você execute operações no Jira Service Desk
• A conectividade ao vivo com esses objetos significa que quaisquer alterações em sua conta do Jira Service Desk são refletidas imediatamente ao usar o conector.

Mesas

Tabelas descreve as tabelas disponíveis. As tabelas são definidas estaticamente para modelar as entidades do Jira Service Desk, como RequestApprovals, RequestComments e RequestParticipants.

Visualizações

Visualizações descreve as exibições disponíveis. As visualizações são definidas estaticamente para modelar as entidades do Jira Service Desk, como Usuários, Organizações e ServiceDesks.

Procedimentos armazenados

NOTE: Procedimentos armazenados não são suportados atualmente. Veja a nota para detalhes.

Procedimentos armazenados são interfaces semelhantes a funções para o Jira Service Desk. Procedimentos armazenados* permitem que você execute operações no Jira Service Desk, incluindo download de documentos e movimentação de envelopes.

Processamento de consulta colaborativa

O conector transfere o máximo possível do processamento da instrução SELECT para o Jira Service Desk e processa o restante da consultar na memória. Limitações e requisitos da API "também estão documentados nesta seção.

Ver SupportEnhancedSQL para obter mais informações sobre como o conector contorna as limitações da API com processamento na memória do lado do cliente.

Tabelas

O conector modela os dados no Jira Service Desk em uma lista de tabelas que podem ser consultadas usando instruções SQL padrão.

Geralmente, consultar tabelas do Jira Service Desk é o mesmo que consultar uma tabela em um banco de dados relacional. Às vezes, há casos especiais, por exemplo, incluir uma determinada coluna na cláusula WHERE pode ser necessário para obter dados para determinadas colunas na tabela. Isso geralmente é necessário para situações em que uma solicitação separada deve ser feita para cada linha para obter determinadas colunas. Esses tipos de situações estão claramente documentados na parte superior da página da tabela vinculada abaixo.

Conector Jitterbit para Tabelas do Jira Service Desk

Transições do Cliente

Retorna uma lista de transições que os clientes podem realizar na solicitação.

Selecione

O conector usará a API do Jira Service Desk para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

• RequestID suporta o = operador.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM CustomerTransitions WHERE RequestID = '10001'

Colunas

Pedido de Aprovações

Este recurso representa uma aprovação de solicitação.

Selecione

Observação: Este recurso está marcado como EXPERIMENTAL e pode ser alterado sem aviso prévio.

O conector usará a API do Jira Service Desk para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

• Id suporta o seguinte operador: =.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM RequestApprovals WHERE RequestID = '10001' AND ID = '10002'

Colunas

PedidoComentários

Este recurso representa comentários de solicitação.

Selecione

O conector usará a API do Jira Service Desk para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

• Id, Public suporta o seguinte operador: =.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM RequestComments WHERE RequestID = '10001' AND Id = '10002'
SELECT * FROM RequestComments WHERE RequestID = '10001' AND Public = 'true'

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Solicitar Participantes

Este recurso representa os participantes da solicitação.

Selecione

O conector usará a API do Jira Service Desk para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

• RequestID suporta o = operador.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM RequestParticipants WHERE RequestID = '10001'

Colunas

Visualizações

As exibições são compostas por colunas e pseudocolunas. As exibições são semelhantes às tabelas na forma como os dados são representados; no entanto, as exibições não oferecem suporte a atualizações. Entidades que são representadas como exibições são normalmente entidades somente leitura. Frequentemente, um procedimento armazenado* está disponível para atualizar os dados se tal funcionalidade for aplicável à fonte de dados.

As consultas podem ser executadas em uma exibição como se fosse uma tabela normal, e os dados retornados são semelhantes nesse aspecto. Para saber mais sobre tabelas e procedimentos armazenados, navegue até as entradas correspondentes neste documento de ajuda.

Conector Jitterbit para Exibições do Jira Service Desk

ClientesCloud

Este recurso representa um cliente.

Colunas

Artigos da Base de Conhecimento

Os artigos que correspondem à string de consultar fornecida em todas as centrais de atendimento.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Organizações

Este recurso representa uma organização.

Selecione

Observação: Este recurso está marcado como EXPERIMENTAL e pode ser alterado sem aviso prévio.

Colunas

FilaInterna

Este recurso representa um usuário.

Colunas

Pedidos Internos

Este recurso representa uma solicitação.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

RequestSLACycles

Este recurso representa os SLAs (contratos de nível de serviço) em uma solicitação do cliente.

Colunas

RequestStatusChangelog

Este recurso representa as transições de status para uma solicitação do cliente.

Selecione

O conector usará a API do Jira Service Desk para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

• RequestID suporta o = operador.
• RequestKey suporta o = operador.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM RequestStatusChangelog WHERE RequestID = '10001'
SELECT * FROM RequestStatusChangelog WHERE RequestKey = 'TEST-1'

Colunas

RequestTypeFields

Os campos para o tipo de solicitação do cliente de uma central de atendimento.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

RequestTypeGroups

Este recurso representa um grupo de tipo de solicitação.

Selecione

O conector usará a API do Jira Service Desk para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

• ServiceDeskId suporta o = operador.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM RequestTypeGroups WHERE ServiceDeskId = '1'

Observação: Este recurso está marcado como EXPERIMENTAL e pode ser alterado sem aviso prévio.

Colunas

RequestTypes

Este recurso representa um tipo de solicitação.

Selecione

O conector usará a API do Jira Service Desk para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

• ServiceDeskId suporta o = operador.
• ID suporta o = operador.
• GroupIds suporta o = operador.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM RequestTypes WHERE ServiceDeskId = '1'
SELECT * FROM RequestTypes WHERE Id = '10012'
SELECT * FROM RequestTypes WHERE GroupIds = '12'

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

ServiceDesks

Este recurso representa um service desk. Uma central de serviços é baseada em um projeto na plataforma JIRA e é usada para gerenciar solicitações de clientes.

Selecione

O conector usará a API do Jira Service Desk para processar as condições da cláusula WHERE criadas com as seguintes colunas e operadores. O restante do filtro é executado no lado do cliente dentro do conector.

• Id suporta o = operador.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM ServiceDesks WHERE ID = '1'

Colunas

Usuários

Este recurso representa um usuário.

Selecione

Observação: Este recurso está marcado como EXPERIMENTAL e pode ser alterado sem aviso prévio.

Colunas

Procedimentos Armazenados

Procedimentos armazenados* estão disponíveis para complementar os dados disponíveis no Modelo de Dados. Pode ser necessário atualizar os dados disponíveis em uma exibição usando um procedimento armazenado* porque os dados não fornecem atualizações bidirecionais diretas, semelhantes a tabelas. Nessas situações, a recuperação dos dados é feita usando a visualização ou tabela apropriada, enquanto a atualização é feita chamando um procedimento armazenado. Procedimentos armazenados* pega uma lista de parâmetros e retorna um conjunto de dados que contém a coleção de tuplas que constituem a resposta.

Conector Jitterbit para Procedimentos Armazenados do Jira Service Desk

Juntar Anexo

Cria um anexo temporário ou atribui um temporário a uma solicitação.

Entrada

Colunas do Conjunto de Resultados

AnexarArquivo Temporário

Este método adiciona um ou mais anexos temporários a um service desk, que pode então ser anexado permanentemente a uma solicitação do cliente usando o procedimento armazenado AddAttachment.

Entrada

Colunas do Conjunto de Resultados

CriarCliente

Cria um novo cliente.

Entrada

Colunas do Conjunto de Resultados

Criar Esquema

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

Entrada

Colunas do Conjunto de Resultados

GetOAuthAccessToken

Obtém um token de autenticação do JIRA.

Entrada

Colunas do Conjunto de Resultados

GetOAuthAuthorizationURL

Obtém a URL de autorização que deve ser aberta separadamente pelo usuário para conceder acesso ao seu aplicativo. Necessário apenas ao desenvolver aplicativos da Web. Você solicitará o token de autenticação deste URL.

Entrada

Colunas do Conjunto de Resultados

RefreshOAuthAccessToken

Atualiza o token de acesso OAuth usado para autenticação com JiraServiceDesk.

Entrada

Colunas do Conjunto de Resultados

Tabelas do Sistema

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

Tabelas de Esquema

As tabelas a seguir retornam os metadados do banco de dados para o Jira Service Desk:

• sys_catalogs: Lista os bancos de dados disponíveis.
• sys_schemas: Lista os esquemas disponíveis.
• sys_tables: Lista as tabelas e exibições disponíveis.
• sys_tablecolumns: Descreve as colunas das tabelas e exibições disponíveis.
• sys_procedures: Descreve os procedimentos armazenados disponíveis.
• sys_procedureparameters: Descreve procedimento armazenado* parâmetros.
• sys_keycolumns: Descreve as chaves primárias e estrangeiras.
• sys_indexes: Descreve os índices disponíveis.

Tabelas de Fonte de Dados

As tabelas a seguir retornam informações sobre como se conectar e consultar a fonte de dados:

• sys_connection_props: Retorna informações sobre as propriedades de conexão disponíveis.
• sys_sqlinfo: Descreve as consultas SELECT que o conector pode descarregar para a fonte de dados.

Consultar Tabelas de Informações

A tabela a seguir retorna estatísticas de consultar para consultas de modificação de dados:

• sys_identity: Retorna informações sobre operações em lote ou atualizações únicas.

Sys_catalogs

Lista os bancos de dados disponíveis.

A consultar a seguir recupera todos os bancos de dados determinados pela string de conexão:

SELECT * FROM sys_catalogs

Colunas

Sys_schemas

Lista os esquemas disponíveis.

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

SELECT * FROM sys_schemas

Colunas

Sys_tables

Lista as tabelas disponíveis.

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

SELECT * FROM sys_tables

Colunas

Sys_tablecolumns

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

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

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

Colunas

Sys_procedures

Lista os procedimentos armazenados disponíveis.

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

SELECT * FROM sys_procedures

Colunas

Sys_procedureparameters

Descreve procedimento armazenado* parâmetros.

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

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

Colunas

Sys_keycolumns

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

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

Colunas

Sys_foreignkeys

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

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Colunas

Sys_indexes

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

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

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Colunas

Sys_connection_props

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

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

jdbc:cdata:jiraservicedesk:config:

Esta string de conexão permite que você consultar esta tabela sem uma conexão válida.

A consultar a seguir recupera todas as propriedades de conexão que foram definidas na string de conexão ou definidas por meio de um valor padrão:

SELECT * FROM sys_connection_props WHERE Value <> ''

Colunas

Sys_sqlinfo

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

Processamento de Consultas Colaborativas

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

Descobrindo os Recursos SELECT da Fonte de Dados

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

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

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

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

Colunas

Sys_identity

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

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

SELECT * FROM sys_identity

Colunas

Propriedades de Configurações Avançadas

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

Autenticação

SSO

OAuth

SSL

Esquema

Diversos

Autenticação

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

AuthScheme

O tipo de autenticação a ser usado ao se conectar ao Jira Service Desk.

Valores Possíveis

Auto, OAuth, Basic, Crowd

Tipo de Dados

string

Valor Padrão

"Auto"

Observações

• Auto: permite que o driver decida automaticamente com base nas outras propriedades de conexão que você definiu.
• OAuth: Defina para executar a autenticação OAuth.
• Básico: Defina para usar usuário/senha BASIC ou autenticação de usuário/ApiToken.
• Crowd: Defina isso para executar a autenticação Crowd SSO.

URL

A URL para o endpoint do JIRA Service Desk.

Tipo de Dados

string

Valor Padrão

""

Observações

A URL para o endpoint do JIRA Service Desk; por exemplo, https://yoursitename.atlassian.net.

Do Utilizador

A conta de usuário do Jira Service Desk usada para autenticação.

Tipo de Dados

string

Valor Padrão

""

Observações

Juntamente com Senha, este campo é usado para autenticação no servidor Jira Service Desk.

Senha

A senha usada para autenticar o usuário.

Tipo de Dados

string

Valor Padrão

""

Observações

O usuário e Password são usados juntos para autenticar com o servidor.

APIToken

APIToken do usuário autenticado no momento.

Tipo de Dados

string

Valor Padrão

""

Observações

APIToken do usuário autenticado no momento. Você pode recuperar um API Token neste link: https://id.atlassian.com/manage/api-tokens

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

string

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

string

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.

SSOExchangeUrl

A URL usada para consumir a resposta SAML e trocá-la com credenciais específicas do Jira Service Desk.

Tipo de Dados

string

Valor Padrão

""

Observações

O conector Jitterbit para Jira Service Desk usará a URL especificada aqui para consumir uma resposta SAML e recuperar credenciais específicas do Jira Service Desk. As credenciais recuperadas são a parte final durante a conexão SSO que são usadas para se comunicar com o Jira Service Desk.

SSOAppName

Nome do aplicativo usado com SSO para IdPs que o exigem.

Tipo de Dados

string

Valor Padrão

""

Observações

Junto com SSOAppPassword, pode ser especificado para identificar e autenticar seu aplicativo configurado no SSO IdP. Atualmente, apenas o Crowd o suporta.

SSOAppSenha

Senha do aplicativo usada com SSO para IdPs que a exigem.

Tipo de Dados

string

Valor Padrão

""

Observações

Junto com SSOAppName, pode ser especificado para identificar e autenticar seu aplicativo configurado no SSO IdP. Atualmente, apenas o Crowd o suporta.

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

string

Valor Padrão

"OFF"

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á tratado pelo conector. Se nenhum token existir atualmente, 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 manipular a obtenção do OAuthAccessToken e OAuthRefreshToken inicialmente.

OAuthVersion

A versão do OAuth que está sendo usada.

Valores Possíveis

1.0, 2.0

Tipo de Dados

string

Valor Padrão

"1.0"

Observações

A versão do OAuth que está sendo usada. As seguintes opções estão disponíveis: 1.0,2.0

OAuthClientId

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

Tipo de Dados

string

Valor Padrão

""

Observações

Como parte do registro de um aplicativo OAuth, você receberá o OAuthClientId valor, à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

string

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 no OAuthClientSecret propriedade.

OAuthAccessToken

O token de acesso para conexão usando OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

O OAuthAccessToken propriedade é 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.

Escopo

Isso determina os escopos que o aplicativo OAuth solicita do Jira Service Desk.

Tipo de Dados

string

Valor Padrão

""

Observações

Especifique o escopo para obter o acesso inicial e o token de atualização.

Por padrão, o conector solicitará que o usuário autorize todos os escopos disponíveis. Se você deseja substituir isso, pode definir essa propriedade como uma lista separada por espaços de escopos OAuth.

CloudId

O Cloud ID do site da Atlassian que foi autorizado.

Tipo de Dados

string

Valor Padrão

""

Observações

Isso será determinado automaticamente durante a autenticação OAuth 2.0 e retornado do GetOAuthAccessToken procedimento armazenado. Não defina um valor para CloudId ao usar InitiateOAuth.

OAuthVerifier

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

Tipo de Dados

string

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 para obter o OAuthVerifier valor.

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

Depois que o arquivo de configurações OAuth for gerado, você poderá remover OAuthVerifier nas propriedades de conexão e conecte-se com OAuthSettingsLocation definir.

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

AuthToken

O token de autenticação usado para solicitar e obter o token de acesso OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

Essa propriedade é necessária apenas ao executar a autenticação headless no OAuth 1.0. Ele pode ser obtido do procedimento armazenado GetOAuthAuthorizationUrl.

Ele pode ser fornecido juntamente com a AuthKey no GetOAuthAccessToken procedimento armazenado* para obter o OAuthAccessToken.

Chave de Autenticação

O segredo de autenticação usado para solicitar e obter o token de acesso OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

Essa propriedade é necessária apenas ao executar a autenticação headless no OAuth 1.0. Ele pode ser obtido do procedimento armazenado GetOAuthAuthorizationUrl.

Ele pode ser fornecido juntamente com o AuthToken no GetOAuthAccessToken procedimento armazenado* para obter o OAuthAccessToken.

OAuthRefreshToken

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

Tipo de Dados

string

Valor Padrão

""

Observações

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

OAuthExpiresIn

O tempo de vida em segundos do OAuth AccessToken.

Tipo de Dados

string

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

string

Valor Padrão

""

Observações

Emparelhe com OAuthExpiresIn para determinar quando o AccessToken expirará.

CertificateStoreType

O tipo de armazenamento de certificado usado com a autenticação do aplicativo privado do Jira Service Desk.

Valores Possíveis

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_BLOB, P10BFILE, SSHPUBLIC_KEY_FILE, PPKFILE, XMLFILE, XMLBLOB

Tipo de Dados

string

Valor Padrão

"USER"

Observações

O nome do armazenamento de certificados para o certificado do cliente usado na autenticação do aplicativo privado do Jira Service Desk. A autenticação de aplicativo privado do Jira Service Desk usa autenticação de cliente SSL com certificados digitais.

Especificando o Tipo de Armazenamento de Certificados

O CertificateStoreType a propriedade pode assumir um dos seguintes valores:

Propriedades de Conexão Relacionadas

Para especificar o certificado privado, pode ser necessário definir as seguintes propriedades além de CertificateStoreType:

• CertificateStore: Defina como o nome do armazenamento de certificados. Por exemplo, "MY" para um armazenamento de certificados do Windows ou o nome do arquivo de um armazenamento de arquivos.
• CertificateStorePassword: Se a loja for protegida por senha, forneça a senha aqui.
• CertificadoAssunto: Defina isso como o assunto do certificado. Para localizar o certificado no armazenamento, o conector executa uma pesquisa com base no assunto especificado. Consulte o CertificadoAssunto para obter detalhes.

CertificateStore

O armazenamento de certificados usado para autenticação do JIRA Service Desk.

Tipo de Dados

string

Valor Padrão

""

Observações

O local do armazenamento de certificados para o certificado do cliente usado na autenticação do aplicativo Jira Service Desk.

CertificateStorePassword

A senha do armazenamento de certificados usado com a autenticação do Jira Service Desk.

Tipo de Dados

string

Valor Padrão

""

Observações

Se o armazenamento de certificados for de um tipo que requer uma senha, essa propriedade será usada para especificar essa senha para abrir o armazenamento de certificados.

Assunto do Certificado

O assunto do certificado usado com a autenticação do aplicativo privado do Jira Service Desk.

Tipo de Dados

string

Valor Padrão

""

Observações

O assunto do certificado do cliente usado na autenticação do aplicativo privado do Jira Service Desk.

Sobre o Fluxo de Autenticação SSL do Cliente do Jira Service Desk

A autenticação de aplicativo privado do Jira Service Desk usa autenticação de cliente SSL com certificados digitais.

Carregando um Certificado

Ao carregar um certificado, o assunto é usado para localizar o certificado na loja.

• Caso não seja encontrada uma correspondência exata, busca-se na loja os assuntos que contenham o valor do imóvel.
• Se uma correspondência ainda não for encontrada, nenhum certificado será selecionado.
• O valor especial "*" seleciona o primeiro certificado no armazenamento de certificados.

Especificando o Assunto

O assunto do certificado é uma lista separada por vírgulas de campos e valores de nomes distintos. Por exemplo, "CN=www.server.com, OU=test, C=US, E=support@jitterbit.com". Os campos comuns e seus significados são exibidos abaixo.

Observação: Se um valor de campo contiver uma vírgula, ela deve ser colocada entre aspas.

Propriedades Adicionais de Conexão

Para especificar o certificado privado, você precisa definir CertificateSubject e as seguintes propriedades adicionais:

• CertificateStore
• CertificateStoreType
• CertificateStorePassword

SSL

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

SSLClientCert

O armazenamento de certificados de cliente TLS/SSL para autenticação de cliente SSL (SSL bidirecional).

Tipo de Dados

string

Valor Padrão

""

Observações

O nome do armazenamento de certificados para o certificado do cliente.

O SSLClientCertType campo especifica o tipo de armazenamento de certificado especificado por SSLClientCert. Se o armazenamento estiver protegido por senha, especifique a senha em SSLClientCertPassword.

SSLClientCert é usado em conjunto com o SSLClientCertSubject para especificar os certificados do cliente. Se SSLClientCert tem um valor e SSLClientCertSubject for definido, uma pesquisa por um certificado será iniciada. Consulte SSLClientCertSubject Para maiores informações.

As designações de armazenamentos de certificados dependem da plataforma.

A seguir estão as designações dos armazenamentos de certificados de Usuário e Máquina mais comuns no Windows:

Em Java, o armazenamento de certificados normalmente é um arquivo contendo certificados e chaves privadas opcionais.

Quando o tipo de armazenamento de certificado for PFXFile, essa propriedade deverá ser configurada para o nome do arquivo. Quando o tipo é PFXBlob, a propriedade deve ser configurada para o conteúdo binário de um arquivo PFX (por exemplo, armazenamento de certificados PKCS12).

SSLClientCertType

O tipo de armazenamento de chaves que contém o certificado do cliente TLS/SSL.

Valores Possíveis

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB

Tipo de Dados

string

Valor Padrão

"USER"

Observações

Esta propriedade pode assumir um dos seguintes valores:

SSLClientCertPassword

A senha para o certificado de cliente TLS/SSL.

Tipo de Dados

string

Valor Padrão

""

Observações

Se o armazenamento de certificados for de um tipo que requer uma senha, essa propriedade será usada para especificar essa senha para abrir o armazenamento de certificados.

SSLClientCertSubject

O assunto do certificado de cliente TLS/SSL.

Tipo de Dados

string

Valor Padrão

"\*"

Observações

Ao carregar um certificado, o assunto é usado para localizar o certificado na loja.

Se uma correspondência exata não for encontrada, a loja é pesquisada em busca de assuntos que contenham o valor da propriedade. Se uma correspondência ainda não for encontrada, a propriedade será definida como uma string vazia e nenhum certificado será selecionado.

O valor especial "*" seleciona o primeiro certificado no armazenamento de certificados.

O assunto do certificado é uma lista separada por vírgulas de campos e valores de nomes distintos. Por exemplo, "CN=www.server.com, OU=test, C=US, E=support@company.com". Os campos comuns e seus significados são mostrados abaixo.

Se um valor de campo contiver uma vírgula, ela deverá ser colocada entre aspas.

SSLServerCert

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

Tipo de Dados

string

Valor Padrão

""

Observações

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

Esta propriedade pode assumir as seguintes formas:

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

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

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

Esquema

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

Localização

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

Tipo de Dados

string

Valor Padrão

"%APPDATA%\\\JiraServiceDesk Data Provider\\Schema"

Observações

O caminho para um diretório que contém os arquivos de esquema para o conector (arquivos .rsd para tabelas e exibições, arquivos .rsb para procedimentos armazenados). A localização da pasta pode ser um caminho relativo a partir da localização do executável. O Location a propriedade só é necessária se você quiser personalizar definições (por exemplo, alterar um nome de coluna, ignorar uma coluna e assim por diante) ou estender o modelo de dados com novas tabelas, exibições ou procedimentos armazenados.

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

Esquemas Navegáveis

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

Tipo de Dados

string

Valor Padrão

""

Observações

Listar os esquemas de bancos de dados pode ser caro. Fornecer uma lista de esquemas na string de conexão melhora o desempenho.

Tabelas

Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tabelas=TabelaA,TabelaB,TabelaC.

Tipo de Dados

string

Valor Padrão

""

Observações

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

Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria 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

string

Valor Padrão

""

Observações

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

Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitos para trabalhar.

Especifique as exibições desejadas em uma lista separada por vírgulas. Cada exibição deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.

Diversos

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

IncludeCustomFields

Um booleano que indica se você gostaria de incluir campos personalizados na listagem de colunas.

Tipo de Dados

bool

Valor Padrão

false

Observações

Definir como true fará com que os campos personalizados sejam incluídos na listagem de colunas. Para incluir os campos personalizados precisamos fazer uma requisição individualizada por campo personalizado e isso pode causar um baixo desempenho ao listar os metadados.

MaxRows

Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.

Tipo de Dados

int

Valor Padrão

-1

Observações

Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.

Outro

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

Tipo de Dados

string

Valor Padrão

""

Observações

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

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

Integração e Formatação

Pseudocolunas

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

Tipo de Dados

string

Valor Padrão

""

Observações

Essa configuração é particularmente útil no Entity Framework, que não permite definir um valor para uma pseudocoluna, a menos que seja uma coluna de tabela. O valor dessa configuração de conexão está no formato "Table1=Column1, Table1=Column2, Table2=Column3". Você pode usar o caractere "*" para incluir todas as tabelas e todas as colunas; por exemplo, "*=*".

Idioma da Solicitação

Use o requestLanguage para que os nomes das colunas sejam traduzidos em um idioma específico.

Tipo de Dados

string

Valor Padrão

""

Observações

Use o requestLanguage para que os nomes das colunas sejam traduzidos em um idioma específico. Por padrão, os nomes das colunas são traduzidos com base na preferência de idioma do usuário solicitante ou no idioma padrão do site do Jira, se for anônimo. Os idiomas disponíveis são baseados nos idiomas instalados no Jira. Forneça uma tag de idioma IETF BCP 47 conforme descrito neste link: https://tools.ietf.org/html/bcp47.

ServiceDeskID

ID do Service Desk do usuário autenticado no momento.

Tipo de Dados

string

Valor Padrão

""

Observações

ID do Service Desk do usuário autenticado no momento. Por padrão, obtemos o primeiro ID retornado de uma chamada extra para obter todas as centrais de atendimento. Você pode obter o ServiceDeskId executando uma consultar Select para a exibição ServiceDesks.

Tempo Esgotado

O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

Tipo de Dados

int

Valor Padrão

60

Observações

Se Timeout = 0, as operações não expiram. As operações são executadas até serem concluídas com êxito ou até encontrarem uma condição de erro.

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