Ir para o conteúdo

Atividade de Busca no Jira

Introdução

Uma atividade de Busca no Jira, utilizando sua conexão Jira, recupera dados de objetos de um projeto Jira e é destinada a ser usada como uma fonte para fornecer dados em uma operação.

Criar uma atividade de Busca no Jira

Uma instância de uma atividade de Busca no Jira é criada a partir de uma conexão Jira usando seu tipo de atividade Busca.

Para criar uma instância de uma atividade, arraste o tipo de atividade para a tela de design ou copie o tipo de atividade e cole-o na tela de design. Para detalhes, veja Criar uma instância de atividade ou ferramenta em Reutilização de componentes.

Uma atividade de Busca no Jira existente pode ser editada a partir destes locais:

Configurar uma atividade de Busca no Jira

Siga estas etapas para configurar uma atividade de Busca no Jira:

Etapa 1: Insira um nome e selecione um projeto

Neste passo, forneça um nome para a atividade e selecione um projeto. Cada elemento da interface do usuário deste passo é descrito abaixo.

Configuração da atividade de busca do Jira

  • Nome: Insira um nome para identificar a atividade. O nome deve ser único para cada atividade de Busca do Jira e não deve conter barras / ou dois pontos :.

  • Selecionar um Projeto: Esta seção exibe os projetos disponíveis no endpoint do Jira.

    • Projeto Jira Selecionado: Após um projeto ser selecionado, ele é listado aqui.

    • Buscar: Insira o valor de qualquer coluna na caixa de busca para filtrar a lista de projetos. A busca não diferencia maiúsculas de minúsculas. Se os projetos já estiverem exibidos na tabela, os resultados da tabela são filtrados em tempo real a cada tecla pressionada. Para recarregar os projetos do endpoint ao buscar, insira os critérios de busca e, em seguida, atualize, conforme descrito abaixo.

    • Atualizar: Recarrega os projetos do endpoint do Jira. Isso pode ser útil se projetos foram adicionados ao Jira. Esta ação atualiza todos os metadados usados para construir a tabela de projetos exibida na configuração.

    • Selecionando um projeto: Dentro da tabela, clique em qualquer lugar de uma linha para selecionar um projeto. Apenas um projeto pode ser selecionado. As informações disponíveis para cada projeto são obtidas do endpoint do Jira:

      • Nome: O nome do projeto.

      • Descrição: A descrição do projeto.

    Dica

    Se a tabela não for preenchida com projetos disponíveis, a conexão com o Jira pode não ter sido bem-sucedida. Certifique-se de que você está conectado reabrindo a conexão e testando novamente as credenciais.

  • Configurações opcionais: Clique para expandir esta configuração opcional:

    • Falhar a operação em caso de erro: Selecione para forçar uma operação a retornar um Erro status da operação quando o payload de resposta da API do Jira contiver um código de status não bem-sucedido. Quando não selecionado (padrão), o payload de resposta deve ser verificado para determinar seu sucesso no Jira.

  • Salvar e Sair: Se ativado, clique para salvar a configuração para esta etapa e fechar a configuração da atividade.

  • Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.

  • Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Etapa 2: Selecionar um objeto

Nesta etapa, selecione um objeto. Cada elemento da interface do usuário desta etapa é descrito abaixo.

Configuração da atividade de pesquisa do Jira

  • Selecionar um Objeto: Esta seção exibe os objetos disponíveis no endpoint do Jira.

    • Projeto Jira Selecionado: O projeto Jira selecionado na etapa anterior é listado aqui.

    • Objeto Jira Selecionado: Após um objeto ser selecionado, ele é listado aqui.

    • Pesquisar: Insira o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de objetos. A pesquisa não diferencia maiúsculas de minúsculas. Se os objetos já estiverem exibidos na tabela, os resultados da tabela são filtrados em tempo real a cada tecla pressionada. Para recarregar objetos do endpoint ao pesquisar, insira os critérios de pesquisa e, em seguida, atualize, conforme descrito abaixo.

    • Atualizar: Recarrega objetos do endpoint do Jira. Isso pode ser útil se objetos foram adicionados ao Jira. Esta ação atualiza todos os metadados usados para construir a tabela de objetos exibida na configuração.

    • Selecionando um objeto: Dentro da tabela, clique em qualquer lugar em uma linha para selecionar um objeto. Apenas um objeto pode ser selecionado. As informações disponíveis para cada objeto são obtidas do endpoint do Jira:

      • Nome: O nome do objeto.

      • Descrição: A descrição do objeto.

    Dica

    Se a tabela não for preenchida com objetos disponíveis, a conexão do Jira pode não ter sido bem-sucedida. Certifique-se de que você está conectado reabrindo a conexão e retestando as credenciais.

  • Voltar: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.

  • Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.

  • Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 3: Especificar configurações

Nesta etapa, especifique os critérios de busca. Cada elemento da interface do usuário desta etapa é descrito abaixo.

Configuração da atividade de busca do Jira

Dica

Campos com um ícone de variável suportam o uso de variáveis globais, variáveis de projeto e variáveis Jitterbit. Comece digitando um colchete aberto [ no campo ou clicando no ícone de variável para exibir uma lista das variáveis existentes para escolher.

  • JQL: Insira os critérios de busca usando a sintaxe da linguagem de consulta do Jira (JQL). Variáveis globais são suportadas na declaração JQL.

    Nota

    Você pode usar o campo JQL para especificar múltiplos projetos (além do projeto especificado na Etapa 1).

  • Expandir (usado apenas para problemas e projetos): Insira uma lista de entidades separadas por vírgula que você deseja incluir na resposta. Essas entidades não são retornadas por padrão e podem ser especificadas:

    Entidade Descrição
    renderedFields Retorna os valores dos campos renderizados em formato HTML.
    names Retorna o nome exibido de cada campo.
    schema Retorna o esquema que descreve um tipo de campo.
    transitions Retorna todas as transições possíveis para o problema.
    operations Retorna todas as operações possíveis para o problema.
    editmeta Retorna informações sobre como cada campo pode ser editado.
    changelog Retorna uma lista de atualizações recentes de um problema, ordenadas por data, começando pela mais recente.

    Importante

    Ao especificar uma entidade neste campo, você deve editar o esquema de resposta (no passo 4) para incluir cada entidade como um campo no esquema. Caso contrário, os dados da entidade não serão incluídos na resposta.

    Nota

    Este campo funciona apenas ao interagir com projetos ou problemas do Jira (especificados no passo 2).

  • Resultados máximos: Insira o número máximo de resultados a serem retornados em uma página. Se não especificado, todos os registros do objeto selecionado são retornados sem paginação.

  • Começar em: Insira o índice do primeiro item a ser retornado na página.

  • Voltar: Clique para armazenar temporariamente a configuração para este passo e retornar ao passo anterior.

  • Próximo: Clique para armazenar temporariamente a configuração para este passo e continuar para o próximo passo. A configuração não será salva até que você clique no botão Concluído no último passo.

  • Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer passo. Uma mensagem pede que você confirme que deseja descartar as alterações.

Passo 4: Revisar os esquemas de dados

Qualquer esquema de solicitação ou resposta é exibido. Cada elemento da interface do usuário deste passo é descrito abaixo.

Configuração da atividade de pesquisa do Jira

  • Esquemas de dados: Esses esquemas de dados são herdados por transformações adjacentes e são exibidos novamente durante o mapeamento de transformação.

    Nota

    Os dados fornecidos em uma transformação têm precedência sobre a configuração da atividade.

    O conector do Jira utiliza a Jira REST API v3 para o tipo de instância Jira Cloud e a Jira REST API v2 para o tipo de instância Jira On-premise. Consulte a documentação da API para obter informações sobre os nós e campos do esquema.

    Informação

    Para instâncias do Jira Cloud, a Atlassian descontinuou seu endpoint da API JQL (POST). A partir do lançamento do Harmony 11.50, a atividade Search agora utiliza a busca aprimorada JQL (POST). Consulte o changelog da Atlassian para diferenças entre os novos e antigos endpoints da API.

  • Atualizar: Regenera esquemas a partir do endpoint do Jira. Esta ação também regenera um esquema em outros locais ao longo do projeto onde o mesmo esquema é referenciado, como em uma transformação adjacente.

  • Editar: Permite que você entre no editor do esquema de dados. O editor permite adicionar, excluir e reorganizar nós e campos, além de alterar seus tipos de dados. Todos os nós e campos recém-adicionados são definidos como [0, 1] cardinalidade. As alterações feitas nos esquemas de dados devem ser aceitáveis para o endpoint e devem ser feitas somente após consultar qualquer documentação disponível para o endpoint. Após fazer edições no esquema, uma data de última edição é exibida na parte superior do esquema aplicável para indicar que o esquema teve edições manuais. Atualizar os esquemas irá redefini-los para suas estruturas padrão.

  • Voltar: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.

  • Finalizado: Clique para salvar a configuração de todas as etapas e fechar a configuração da atividade.

  • Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede que você confirme que deseja descartar as alterações.

Próximas etapas

Após configurar uma atividade de Search do Jira, complete a configuração da operação adicionando e configurando outras atividades ou ferramentas como etapas da operação. Você também pode configurar as configurações da operação, que incluem a capacidade de encadear operações que estão no mesmo ou em diferentes fluxos de trabalho.

As ações de menu para uma atividade estão acessíveis a partir do painel do projeto e da tela de design. Para detalhes, veja o menu de ações da atividade em Conceitos básicos de conectores.

As atividades de Busca do Jira podem ser usadas como fonte com esses padrões de operação:

Para usar a atividade com funções de script, escreva os dados em um local temporário e, em seguida, use esse local temporário na função de script.

Quando estiver pronto, implante e execute a operação e valide o comportamento verificando os logs da operação.