Ir para o conteúdo

Atividade de pesquisa do Jira

Introdução

Uma atividade Jira Search, usando sua conexão Jira, recupera dados de objeto de um projeto Jira e deve ser usado como uma fonte para fornecer dados em uma operação.

Criar uma atividade de pesquisa do Jira

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

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

Uma atividade existente do Jira Pesquisa pode ser editada nestes locais:

Configurar uma atividade de pesquisa do Jira

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

Etapa 1: insira um nome e selecione um projeto

Nesta etapa, forneça um nome para a atividade e selecione um projeto. Cada elemento da interface do usuário desta etapa é descrito abaixo.

Etapa 1 da configuração da atividade do Jira Search

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

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

    • Projeto Jira selecionado: Depois que um projeto é selecionado, ele é listado aqui.

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

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

    • Selecionando um projeto: Na 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 Jira pode não ser bem-sucedido. Certifique-se de estar conectado reabrindo a conexão e testando as credenciais novamente.

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

    • Falha na operação em caso de erro: Selecione para forçar uma operação a retornar um Error status da operação quando a payload de resposta da API do Jira contém um código de status sem sucesso. Quando desmarcado (padrão), o payload de resposta deve ser verificado para determinar seu sucesso no Jira.

  • Salvar e sair: Se habilitado, clique para salvar a configuração desta etapa e fechar a configuração da atividade.

  • Próximo: Clique para armazenar temporariamente a configuração desta etapa e prosseguir para a próxima. 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicitará que você confirme se deseja descartar as alterações.

Etapa 2: Selecione um objeto

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

Etapa 2 da configuração da atividade do Jira Search

  • Selecione 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: Depois que um objeto é selecionado, ele é listado aqui.

    • Pesquisa: 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 serão filtrados em tempo real a cada pressionamento de tecla. Para recarregar objetos do endpoint durante a pesquisa, insira os critérios de pesquisa e atualize, conforme descrito abaixo.

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

    • Selecionando um objeto: Dentro da tabela, clique em qualquer lugar de 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 Jira pode não ser bem-sucedido. Certifique-se de estar conectado reabrindo a conexão e testando as credenciais novamente.

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

  • Avançar: Clique para armazenar temporariamente a configuração desta etapa e prosseguir para a próxima. 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicitará que você confirme se deseja descartar as alterações.

Etapa 3: especifique as configurações

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

Etapa 3 da configuração da atividade do Jira Search

Dica

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

  • JQL: Insira os critérios de pesquisa usando linguagem de consultar Jira Sintaxe (JQL). variáveis globais são suportados na instrução JQL.

    Nota

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

  • Expandir (usado apenas para problemas e projetos): Insira uma lista separada por vírgulas de entidades 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 valores de campo renderizados em formato HTML.
    names Retorna o nome de exibição 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, classificadas por data, começando pela mais recente.

    Importante

    Ao especificar uma entidade neste campo, você deve editar o esquema de resposta (na etapa 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 somente ao interagir com projetos ou problemas do Jira (especificados na etapa 2).

  • Máximo de resultados: 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 serão retornados sem paginação.

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

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

  • Próximo: Clique para armazenar temporariamente a configuração desta etapa e prosseguir 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicitará que você confirme se deseja descartar as alterações.

Etapa 4: Revise os esquemas de dados

Todos os esquemas de solicitação ou resposta são exibidos. Cada elemento da interface do usuário desta etapa é descrito abaixo.

Etapa 4 da configuração da atividade do Jira Search

  • 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 Jira usa a Jira REST API v3 para o tipo de instância Jira Cloud e 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.

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

  • Editar: Permite que você acesse o 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 consulta à documentação disponível para o endpoint. Após fazer edições no esquema, a data da última edição é exibida na parte superior do esquema aplicável para indicar que o esquema passou por edições manuais. Atualizar os esquemas os redefinirá para suas estruturas padrão.

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

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

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

Próximos passos

Após configurar uma atividade de Pesquisa do Jira, conclua 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 estejam no mesmo fluxo de trabalho ou em workflows diferentes.

As ações de menu de uma atividade podem ser acessadas no painel do projeto e na quadro de design. Para obter detalhes, consulte menu de ações da atividade em Noções básicas do conector.

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

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

Quando estiver pronto, implantar e executar a operação e validar o comportamento verificando os logs de operação.