Atividade Get Job do Jenkins
Introdução
Uma atividade Get Job do Jenkins, utilizando sua conexão do Jenkins, recupera um job de um servidor de automação Jenkins e é destinada a ser usada como uma fonte para fornecer dados em uma operação.
Criar uma atividade Get Job do Jenkins
Uma instância de uma atividade é criada a partir de uma conexão usando um tipo de atividade.
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 existente pode ser editada a partir destes locais:
- A tela de design (veja Menu de ações do componente em Tela de design).
- A aba Componentes do painel do projeto (veja Menu de ações do componente em Aba Componentes do painel do projeto).
Configurar uma atividade Get Job do Jenkins
Siga estas etapas para configurar uma atividade Get Job do Jenkins:
-
Etapa 1: Insira um nome e especifique um job
Forneça um nome para a atividade e especifique um job. -
Etapa 2: Revise os esquemas de dados
Quaisquer esquemas de solicitação ou resposta são exibidos.
Etapa 1: Insira um nome e especifique um job
Nesta etapa, forneça um nome para a atividade e especifique um job. Cada elemento da interface do usuário desta etapa é descrito abaixo.
A interface utilizada nesta etapa da configuração de uma atividade Get Job do Jenkins depende da opção Fornecer Nome do Job selecionada:
-
Fornecer nome do trabalho usando lista de objetos: Esta opção preenche uma lista de trabalhos da instância do Jenkins.
-
Fornecer URL do trabalho usando campo de texto: Para esta opção, você irá inserir manualmente a URL do trabalho.
-
Fornecer parâmetros usando transformação de solicitação: Para esta opção, você fornece os dados para o trabalho em uma transformação de solicitação.
Fornecer nome do trabalho usando lista de objetos
Se Fornecer Nome do Trabalho Usando Lista de Objetos for selecionado para Fornecer Nome do Trabalho, esta interface é apresentada:
-
Nome: Insira um nome para identificar a atividade. O nome deve ser único para cada atividade Get Job do Jenkins e não deve conter barras
/
ou dois pontos:
. -
Fornecer Nome do Trabalho: Selecione uma dessas opções para fornecer o nome do trabalho:
-
Fornecer Nome do Trabalho Usando Lista de Objetos: Esta opção preenche uma lista de trabalhos da instância do Jenkins.
-
Fornecer URL do Trabalho Usando Campo de Texto: Para esta opção, você irá inserir manualmente a URL do trabalho.
-
Fornecer Parâmetros Usando Transformação de Solicitação: Para esta opção, você fornece os dados para o trabalho em uma transformação de solicitação.
-
-
Selecionar um Objeto: Esta seção exibe uma tabela de trabalhos disponíveis no endpoint do Jenkins. Dentro da tabela, clique em qualquer lugar em uma linha para selecionar um trabalho. Apenas um trabalho pode ser selecionado.
- Objeto Selecionado: Após um trabalho ser selecionado, ele é listado aqui.
-
Continuar em Caso de Erro: Esta configuração é funcional apenas ao usar a opção Fornecer parâmetros usando transformação de solicitação.
-
Salvar & Sair: Se habilitado, 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 Finalizado 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.
Fornecer URL do trabalho usando campo de texto
Se Fornecer URL do Trabalho Usando Campo de Texto for selecionado para Fornecer Nome do Trabalho, esta interface é apresentada:
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.
-
Nome: Insira um nome para identificar a atividade. O nome deve ser exclusivo para cada atividade Get Job do Jenkins e não deve conter barras
/
ou dois pontos:
. -
Fornecer Nome do Trabalho: Selecione uma das opções para fornecer o nome do trabalho:
-
Fornecer Nome do Trabalho Usando Lista de Objetos: Esta opção preenche uma lista de trabalhos da instância do Jenkins.
-
Fornecer URL do Trabalho Usando Campo de Texto: Para esta opção, você irá inserir manualmente a URL do trabalho.
-
Fornecer Parâmetros Usando Transformação de Solicitação: Para esta opção, você fornece os dados para o trabalho em uma transformação de solicitação.
-
-
URL do Trabalho: Insira a URL do trabalho.
-
Continuar em Caso de Erro: Esta configuração é funcional apenas ao usar a opção Fornecer parâmetros usando transformação de solicitação.
-
Salvar & 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 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 mudanças feitas em qualquer etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.
Fornecer parâmetros usando transformação de solicitação
Se Fornecer Parâmetros Usando Transformação de Solicitação estiver selecionado para Fornecer Nome do Trabalho, esta interface é apresentada:
-
Nome: Insira um nome para identificar a atividade. O nome deve ser exclusivo para cada atividade Get Job do Jenkins e não deve conter barras
/
ou dois pontos:
. -
Fornecer Nome do Trabalho: Selecione uma das opções para fornecer o nome do trabalho:
-
Fornecer Nome do Trabalho Usando Lista de Objetos: Esta opção preenche uma lista de trabalhos da instância do Jenkins.
-
Fornecer URL do Trabalho Usando Campo de Texto: Para esta opção, você irá inserir manualmente a URL do trabalho.
-
Fornecer Parâmetros Usando Transformação de Solicitação: Para esta opção, você fornece os dados para o trabalho em uma transformação de solicitação.
-
-
Continuar em Caso de Erro: Selecione para continuar a execução da atividade se um erro for encontrado para um conjunto de dados em uma solicitação em lote. Se algum erro for encontrado, ele será registrado no log de operações.
-
Salvar & 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 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 mudanças feitas em qualquer etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.
Etapa 2: Revisar os esquemas de dados
Quaisquer esquemas de solicitação ou resposta são exibidos. Cada elemento da interface do 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 Jenkins utiliza a API de Acesso Remoto do Jenkins. Os esquemas de solicitação e resposta são estáticos e são fornecidos internamente pelo próprio conector.
A atividade Get Job utiliza XML em seu esquema de solicitação e retorna JSON em seu esquema de resposta.
Os esquemas de dados de solicitação e resposta consistem nos seguintes nós e campos:
Nó/Campo do Esquema de Solicitação Descrição jobProperties
Nó representando o trabalho jobUrl
A URL do trabalho Nó/Campo do Esquema de Resposta Descrição getJobResponse
Nó representando a resposta do Jenkins response
Nó representando a resposta item
Nó representando cada trabalho retornado job
Nó representando o trabalho _class
String contendo a classe do trabalho displayName
String contendo o nome exibido do trabalho fullDisplayName
String contendo o nome completo exibido do trabalho url
String contendo a URL do trabalho builds
Nó representando as compilações do trabalho item
Nó representando cada propriedade da compilação _class
String contendo a classe da compilação duration
A duração (em milissegundos) da compilação id
String contendo o ID da compilação number
O número da compilação result
O resultado da compilação, seja Success
ouFailure
url
String contendo a URL da compilação healthReport
Nó representando o relatório de saúde do trabalho item
Nó representando cada propriedade do relatório de saúde description
String contendo uma descrição do relatório de saúde do trabalho score
A pontuação do relatório de saúde do trabalho lastBuild
Nó representando a última compilação do trabalho _class
String contendo a classe da compilação number
O número da compilação url
String contendo a URL da compilação lastCompletedBuild
Nó representando a última compilação concluída _class
String contendo a classe da compilação number
O número da compilação url
String contendo a URL da compilação lastFailedBuild
Nó representando a última compilação falhada _class
String contendo a classe da compilação number
O número da compilação url
String contendo a URL da compilação lastStableBuild
Nó representando a última compilação estável _class
String contendo a classe da compilação number
O número da compilação url
String contendo a URL da compilação lastSuccessfulBuild
Nó representando a última compilação bem-sucedida _class
String contendo a classe da compilação number
O número da compilação url
String contendo a URL da compilação property
Nó representando a propriedade do trabalho item
Nó representando cada propriedade do trabalho _class
String contendo a classe do trabalho parameterDefinitions
Nó representando as definições de parâmetros item
Nó representando cada definição de parâmetro do trabalho _class
Campo contendo a classe da definição de parâmetro defaultParameterValue
Nó representando o valor padrão do parâmetro _class
String contendo a classe para o valor padrão do parâmetro name
String contendo o nome do valor do parâmetro type
String contendo o tipo do valor do parâmetro errors
Nó representando quaisquer erros item
Nó representando cada erro (se aplicável) message
String contendo a mensagem de resposta para o trabalho status
Código de status da resposta HTTP retornado url
String contendo a URL do trabalho -
Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para regenerar esquemas do endpoint do Jenkins. 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.
-
Voltar: Clique para armazenar temporariamente a configuração para esta 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 qualquer etapa. Uma mensagem solicita que você confirme se deseja descartar as alterações.
Próximas etapas
Após configurar uma atividade Obter Trabalho do Jenkins, 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 do 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 do conector.
As atividades Obter Trabalho do Jenkins 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 (como a primeira fonte apenas)
- Padrão de arquivo HTTP de dois alvos (como a primeira fonte apenas)
- Padrão de duas transformações (como a primeira ou segunda fonte)
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.