Atividade de pesquisa do Jira
Introdução
Uma atividade Jira Search, usando sua conexão Jira, recupera dados de objetos de um projeto Jira e se destina a 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 Pesquisar.
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 Criando uma instância de atividade em Reutilização de componentes.
Uma atividade existente do Jira Search pode ser editada nestes locais:
- A quadro de design (veja menu de ações do componente em Tela de design).
- A aba Componentes do painel do projeto (consulte menu de ações do componente na aba Componentes do painel Projeto).
Configurar uma atividade do Jira Search
Siga estas etapas para configurar uma atividade do Jira Search:
-
Etapa 1: Insira um nome e selecione um projeto
Forneça um nome para a atividade e selecione um projeto. -
Etapa 2: Selecione um objeto
Selecione um objeto. -
Etapa 3: Especifique as configurações
Especifique os critérios de pesquisa. -
Etapa 4: Revise os esquemas de dados
Quaisquer esquemas de solicitação ou resposta são exibidos.
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.
-
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 qualquer valor de 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 ao pesquisar, insira os critérios de pesquisa e atualize, conforme descrito abaixo.
-
Refresh: Recarrega 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 em 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 que você está conectado reabrindo a conexão e testando novamente as credenciais.
-
-
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 não bem-sucedido. Quando não selecionado (padrão), o payload de resposta deve ser verificado para determinar seu sucesso no Jira.
- Falha na operação em caso de erro: Selecione para forçar uma operação a retornar um
-
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 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 nenhuma etapa. Uma mensagem pede para você confirmar que 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.
-
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.
-
Pesquisar: Insira qualquer valor de 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 ao pesquisar, insira os critérios de pesquisa e atualize, conforme descrito abaixo.
-
Refresh: 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 Jira pode não ser bem-sucedido. Certifique-se de que você esteja conectado reabrindo a conexão e testando novamente as credenciais.
-
-
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 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 nenhuma etapa. Uma mensagem solicita que você confirme que 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.
Dica
Campos com um í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 de 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 declaração JQL.
Nota
Você pode usar o campo JQL para especificar vários projetos (além do projeto especificado em Etapa 1).
-
Resultados máximos: Insira o número máximo de resultados retornados em uma página na resposta. Se um valor máximo não for fornecido, todos os registros do objeto selecionado serão retornados e a paginação não será aplicada.
-
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 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 nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.
Etapa 4: Revise os esquemas de dados
Quaisquer esquemas de solicitação ou resposta são exibidos. Cada elemento de interface de usuário desta etapa é descrito abaixo.
-
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.
-
Refresh: Regenera esquemas 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 para o esquema de dados. O editor permite que você adicione, exclua e reorganize nós e campos e altere 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. -
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 alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.
Próximos passos
Após configurar uma atividade Jira Search, conclua a configuração da operação adicionando e configurando outras atividades, transformações ou scripts 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 para uma atividade são acessíveis a partir do painel do projeto e da quadro de design. Para obter detalhes, consulte menu de ações de 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:
- Padrão de Transformação
- Padrão de arquivo de dois alvos (apenas como primeira fonte)
- Padrão de arquivo HTTP de dois alvos (apenas como primeira fonte)
- Padrão de duas transformações (como primeira ou segunda fonte)
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.