Integração com Jira Software Cloud

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 11 min. de leitura

    • Você pode integrar sua instância [ ServiceNow com o Atlassian Jira Software Cloud para rastrear suas assinaturas de software e recuperar licenças não utilizadas.

    Nota:
    Atualmente, esta integração oferece suporte a apenas uma integração de site por perfil.

    Usando autenticação básica

    Integre a instância [ ServiceNow e Jira usando uma chave de API para autenticar solicitações ServiceNow.

    Você pode integrar uma instância ServiceNow com várias instâncias Jira. Para esta integração, crie um registro de alias de conexão e credencial e um registro de conexão para cada instância Jira.

    Criar um token de API de conta Jira

    Crie um token de API em Jira para autenticar solicitações.

    Antes de Iniciar

    Jira Função necessária: administrador

    Procedimento

    1. Navegue até Atlassian API Tokens.
    2. Clique em Criar token de API.
    3. Insira um nome para o token da API e clique em Criar.
    4. Copie o token da API e salve-o.
      Você usará o token mais tarde.

    Configurar a conexão e o registro de credencial

    Configure o registro de alias de conexão e credencial padrão para autenticar as solicitações de ServiceNow.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Conexões e Credenciais > Aliases de conexão e credencial.
    2. Abra o registro de alias para Jira que é enviado com o spoke.
    3. Clique no link relacionado Criar nova conexão e credencial.
    4. No formulário, preencha os campos.
      Tabela 1. Criar Conexão e Credencial
      Campo Descrição
      URL de Conexão URL da sua instância Jira em https:// <provider-domain-name> Formato .atlassian.net .
      Nome de usuário Insira o endereço de e-mail do usuário.
      Chave de API Insira o token de API que você gerou para Jira.
    5. Clique em Criar.

    Usando a autenticação OAuth

    Integre a instância ServiceNow à sua conta Jira usando OAuth para autenticar ServiceNow solicitações.

    Criar uma integração OAuth 2.0 na conta Jira

    Crie uma integração OAuth 2.0 no console do desenvolvedor Atlassian para autenticar as solicitações.

    Antes de Iniciar

    Função necessária: admin

    Procedimento

    1. Faça login no Atlassian Developer console.
    2. Em Minhas aplicações, clique em Criar e selecione Integração OAuth 2.0.
    3. No formulário, forneça um nome para a integração e clique em Criar.

      A integração é criada e o valor do ID do app é exibido.

    4. Clique em Autorização.
      1. Clique em Adicionar em Ação.
      2. Em URL de retornode chamada , forneça o URL da sua instância da ServiceNow neste formato: https://<ServiceNow-Instance-Name> .service-now.com/oauth_redirect.do .
        Por exemplo, https://example.service-now.com/oauth_redirect.do.
      3. Clique em Salvar mudanças.
    5. Clique em “Configurações”.
    6. Em Detalhes de autenticação, copie os valores de ID de cliente e Segredo do cliente.
    7. Clique em Permissões.
      1. Em Escopos granulares, selecione os escopos a seguir.
        • read:application-role:jira
        • read:group:jira
        • ler: usuário: jira
        • ler:avatar:jira
        • read:audit-log:jira
        • read:issue-details:jira
        • read:field-configuration:jira
        • read:issue-meta:jira
        • write:group:jira
        Você pode configurar outros escopos de acordo com seus requisitos.

    Obter o valor do ID da nuvem

    Obtenha o valor do ID de nuvem da instância de nuvem Jira. Este valor é necessário durante a configuração do registro de conexão na sua instância ServiceNow.

    Antes de Iniciar

    Função necessária: admin

    Procedimento

    1. Faça login na Administração do Atlassian.
    2. Clique em Selecionar na organização necessária.
    3. No produto de software Jira, clique em Gerenciar acesso ao produto.

      O URL está no seguinte formato em uma nova janela: https://admin.atlassian.com/s/<Cloud-ID> /apps .

    4. Copie o valor do ID da nuvem para uso posterior.

    Criar um registro de aplicação na instância ServiceNow

    Use as informações geradas ao criar a integração do OAuth 2.0 para criar um registro de aplicação em sua instância ServiceNow.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > OAuth de Sistema > Registro de aplicações.
    2. Clique em Nova.
      O sistema exibe uma mensagem como Que tipo de aplicação OAuth?.
    3. Selecione Conectar a um provedor OAuth de terceiros.
    4. No formulário, preencha estes valores.
      Tabela 2. Registros das aplicações
      Campo Descrição
      Nome Nome para identificar o registro da aplicação.
      ID de cliente ID do cliente gerado quando a integração do OAuth 2.0 foi criada no console do desenvolvedor Atlassian.
      Segredo do cliente Segredo do cliente gerado quando a integração do OAuth 2.0 foi criada no console do desenvolvedor Atlassian.
      Tipo de concessão padrão Tipo de concessão usado para estabelecer o token. Selecione Código de autorização.
      URL de Autorização Endpoint do código de autorização do OAuth. Insira https://auth.atlassian.com/authorize.
      URL do token Endpoint do token do servidor OAuth. Insira https://auth.atlassian.com/oauth/token.
      Redirecional URL Endpoint de retorno de chamada do OAuth. O sistema gera o URL ao salvar o registro da aplicação.
      Atualizar URL do Token URL para atualizar um token. Insira https://auth.atlassian.com/oauth/token.
      Nota:
      Este campo está oculto no layout do formulário. Configure o layout do formulário para mostrar este campo.
    5. Clique com o botão direito no cabeçalho do formulário e, em seguida, clique em Salvar.
      Um registro de perfil de entidade OAuth padrão é criado na guia Perfis de entidade OAuth.
    6. Em Escopos de entidade OAuth, crie os seguintes registros de escopo de entidade.
      Nome Escopo de OAuth
      read:application-role:jira read:application-role:jira
      read:group:jira read:group:jira
      ler: usuário: jira ler: usuário: jira
      ler:avatar:jira ler:avatar:jira
      read:audit-log:jira read:audit-log:jira
      read:issue-details:jira read:issue-details:jira
      read:field-configuration:jira read:field-configuration:jira
      read:issue-meta:jira read:issue-meta:jira
      write:group:jira write:group:jira
      offline_access offline_access

    Resultado

    Um registro de aplicação é criado na sua instância ServiceNow.

    Criar um registro de credencial para Jira

    Crie um registro de credencial para a conta Jira. O alias de conexão e credencial do spoke Jira usa essa credencial para autorizar ações.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Conexões e Credenciais > Credenciais.
    2. Clique em Nova.
      O sistema exibe uma mensagem como Que tipo de credenciais você deseja criar?.
    3. Selecione Credenciais OAuth 2.0.
    4. No formulário, preencha estes valores.
      Tabela 3. Credenciais de OAuth 2.0
      Campo Descrição
      Nome Nome para identificar o registro de credencial do spoke Jira. Por exemplo, Credencial do Jira OAuth.
      Perfil de Entidade OAuth Registro de perfil de entidade OAuth padrão criado quando o registro da aplicação é configurado.
    5. Clique em Enviar.

    Criar um registro de conexão para Jira

    Crie um registro de conexão para a conta Jira. O alias de conexão e credencial usa esta conexão para executar ações em Jira.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Conexões e Credenciais > Aliases de conexão e credencial.
    2. Abra o registro de alias para Jira que é enviado com o spoke.
    3. Na guia Conexões, selecione Novo.
      O sistema exibe um formulário de conexão HTTP(s) vazio.
    4. No formulário, preencha os seguintes campos.
      Tabela 4. Conexão HTTP(s)
      Campo Descrição
      Nome Insira um nome exclusivo para identificar o registro da conexão. Por exemplo, insira Jira Conexão OAuth.
      Credencial Selecione o registro de credencial criado para o Jira. Por exemplo, selecione Jira Credenciais OAuth.
      Alias de conexão Pesquise e selecione sn_jira_spoke.Jira alias.
      URL de Conexão Insira o URL da sua instância Jira em https://api.atlassian.com/ex/jira/ <Cloud-ID> formato.

      Para obter informações sobre como obter o valor do Cloud ID, consulte Obter o valor do ID da nuvem.
    5. Na lista relacionada Atributos, forneça esses valores.
      1. Insira o valor 2 para api_version.
      2. Insira a nuvem de valor para server_type.
    6. Selecione Enviar.
    7. Navegar até Todos > Conexões e Credenciais > Credenciais.
    8. Abra o registro de credencial que você criou para o spoke Jira.
      Por exemplo, Jira Credencial OAuth.
    9. Selecione o link relacionado Obter token OAuth.
      Em uma nova janela, o sistema solicitará acesso à sua conta Atlassian.
    10. Selecione Aceitar.
      O acesso é concedido à conta Atlassian e uma mensagem de confirmação é exibida na sua instância ServiceNow de que o token de atualização está disponível.

    Criar um perfil de integração do Software Cloud Jira

    Crie um perfil de integração para rastrear assinaturas de software e otimizar o licenciamento para Atlassian Jira Software Cloud.

    Antes de Iniciar

    Para criar um perfil de integração Jira, solicite o plug-in Gestão de ativos de software - Gestão de licenças de SaaS (com.sn_sam_saas_int) na ServiceNow Store.

    Para habilitar o perfil de integração para recuperar e atualizar a atividade do usuário por meio do subfluxo Atualizar atividade do usuário Jira, defina o valor da propriedade do sistema com.glide.transform.json.max-partial-length como 32768.

    Atlassian Função necessária: administrador do site

    ServiceNow Função necessária:

    • Começando com a versão 5.0.1 de Gestão de ativos de software - Gestão de licenças de SaaS e a versão 3.0.4 do spoke Jira, a seguinte função ServiceNow é necessária: sam_integrator e sn_jira_spoke.jira_admin ou admin.

    • Antes da versão 5.0.1 de Gestão de ativos de software - Gestão de licenças de SaaS e da versão 3.0.4 do spoke Jira, a seguinte função ServiceNow é necessária: sam_integrator ou admin

    Por Que e Quando Desempenhar Esta Tarefa

    Se você estiver usando o Software Asset Workspace, a opção para criar o perfil de integração Jira na IU principal ficará inativa.

    Procedimento

    1. Navegue até o perfil de integração.
      InterfaceAção
      IU principal
      1. Navegar até Todos > Ativo de Software > Licença de SaaS > Perfis de Integração Direta.
      2. Selecione Novo.
      3. Selecione Perfil de integração do Jira.
      Espaço de ativo do software
      1. Navegar até Operações de licença > Assinaturas de Usuário > Perfis de integração direta.
      2. Selecione Novo.
      3. Selecione Jira na lista suspensa.
      4. Selecione Continuar.
    2. No formulário, preencha os campos.
      Tabela 5. Formulário de perfil de integração
      Campo Valor
      Nome de visualização Nome à sua escolha. Por exemplo, integração Jira.
      Conexão e Credencial sn_jira_spoke.Jira. Este campo é preenchido automaticamente.
      Status Status do perfil de integração. As opções são Rascunho e Publicado. Este campo é preenchido automaticamente.
      Tipo de perfil Jira Assinatura. Este campo é preenchido automaticamente.
    3. Na seção do formulário Calcular subfluxo de atividade, escolha um valor para o campo Analisar a atividade do usuário de.
      Você também pode selecionar a data e a hora a partir das quais deseja analisar a atividade do usuário no campo Analisar a atividade do usuário a partir de. Por padrão, você pode analisar a atividade do usuário até 60 dias antes da data atual e exibir eventos realizados por usuários individuais a partir do momento em que cria este perfil.
      Nota:
      Gestão de ativos de software extrai os eventos a partir do momento em que você começa a analisar a atividade do usuário, independentemente da data de criação do perfil.
      Você pode modificar este valor no campo Último limite de atividade das regras de recuperação de software. Para obter mais informações, consulte Revisar uma regra de recuperação de software.
      Nota:
      Depois de salvar o perfil de integração, o campo Analisar atividade do usuário de se torna somente leitura.
    4. Clique em Salvar.
      Um perfil de integração de rascunho é criado. O perfil de integração usa os subfluxos Jira Baixar assinaturas, Jira Atualizar atividade do usuário e Jira Recuperar assinatura para obter dados do usuário da aplicação de software Jira.
    5. Especifique os grupos que têm acesso a Jira produtos.
      Importante:
      Esta etapa é aplicável somente a partir da versão 5.0.1 das integrações Gestão de ativos de software - Gestão de licenças de SaaS e a versão 3.0.4 do Jira spoke.
      Ao especificar esses grupos em sua instância ServiceNow, você pode recuperar dados e gerenciar licenças somente para os usuários desses grupos.
      1. Em uma nova guia, abra o portal de administração da Atlassian.
      2. Faça login na sua conta de administrador do site.
      3. Navegar até CONFIGURAÇÕES DO LOCAL > Acesso ao produto.
      4. Na seção Jira, exiba a lista de grupos que têm acesso ao Jira Software.
        Anote essas informações para uso posterior.
      5. Retorne à sua instância ServiceNow e navegue até Jira > Grupos do Jira.
      6. No formulário Grupos Jira, clique no link relacionado Adicionar grupos.
        A caixa de diálogo Adicionar grupos Jira é aberta.
      7. Na lista Disponível, selecione os grupos que têm acesso a Jira produtos.
        Dica:
        A lista Disponível inclui todos os grupos associados à sua conta Atlassian. Selecione somente os grupos que têm acesso a Jira produtos.
      8. Clique no botão de seta para a direita para mover os grupos da lista Disponível para a lista Selecionado.
      9. Clique em OK.
    6. Retorne ao seu perfil de integração navegando até Licença de SaaS > Administração > Perfis de Integração Direta e, em seguida, selecionando o perfil na lista Perfis de integração.
    7. Clique em Publicar.
      A caixa de diálogo Confirmação de publicação é aberta.
    8. Na caixa de diálogo, clique em OK.

    O que Fazer Depois

    Depois que a integração se conecta, sua instância ServiceNow cria automaticamente modelos de software, regras de recuperação e assinaturas de usuário que são atualizadas diariamente.

    Revise todas as regras de recuperação geradas automaticamente para recuperar assinaturas de usuário. Para obter mais informações, consulte Revisar uma regra de recuperação de software.

    Crie direitos de software para os modelos de software gerados automaticamente para rastrear o software usado em relação ao software de sua propriedade.
    A reconciliação também é executada em suas assinaturas como um trabalho programado ou sob demanda. Você pode exibir os resultados da reconciliação no Workbench de licença (Gestão de ativos de software aplicação clássica) ou na exibição de uso de licença (Software Asset Workspace). Use esses resultados para determinar sua posição de conformidade de licença e para corrigir qualquer não conformidade.