Sobre Etapas

Uma etapa é um componente de um projeto. Quando o projeto é executado como uma tarefa, cada etapa é emitida na ordem. Uma etapa contém um ou mais comandos e possui propriedades de etapa que afetam seu comportamento.

Nota: É necessário limpar as tarefas antigas regularmente. Isso acontece porque um grande número de linhas de log em uma única etapa afeta o desempenho do mecanismo, do agente e do banco de dados devido ao custo de processo de E/S. Além disso, as linhas de log podem não ser exibidas normalmente quando o número de linhas de log em uma única etapa excede 5000. Para assegurar que as linhas de log sejam exibidas normalmente, também é possível reduzir a saída da etapa ou redirecionar a saída da etapa para um arquivo separado.

Sobre o Painel Etapas

Guia Detalhes

As propriedades da etapa especificam como executar uma etapa, tratar sua saída e o que fazer quando a etapa for concluída. Uma etapa pode também executar outro projeto ou biblioteca.

Para visualizar propriedades da etapa, selecione uma etapa dentro de um projeto. A guia Detalhes é mostrada por padrão. Ela exibe as propriedades da etapa.

Se uma propriedade da etapa não estiver configurada explicitamente, seu valor é herdado do projeto. As propriedades da etapa são definidas para que uma etapa substitua os valores herdados.

As propriedades da etapa incluem:
Nome
O nome da etapa. Ele é utilizado como um rótulo da etapa no sistema e no log.
Ativo
Especifica se a etapa é executada. Por padrão, uma etapa é Ativada. Selecione Desativar para evitar que a etapa seja executada. Uma etapa desativada não está disponível para ser executada em uma tarefa.
Diretório
Configura o local em que os comandos da etapa são executados. O sistema cria automaticamente um diretório exclusivo para cada tarefa. O campo Diretório oferece uma forma conveniente para a execução de comandos em diretórios que o projeto construiu durante uma tarefa. (O Build Forge não constrói os diretórios mencionados no campo Diretório.)
Caminho
Especifica se Diretório é um caminho absoluto ou relativo.
  • Relativo: Os comandos da etapa são executados em um caminho localizado, incluindo os diretórios do servidor, do projeto, da tarefa e da etapa.
  • Absoluto: Os comandos da etapa são executados em um caminho localizado, incluindo os diretórios do servidor e da etapa. Essa opção permite acessar diretórios que não estão na estrutura de diretórios do projeto. Exemplo: Ela pode ser utilizada para iniciar aplicativos permanentemente instalados no servidor.
Tipo de Etapa
Determina como a etapa é executada. Essa propriedade afeta o conteúdo de Comando e o projeto especificado em Sequencial, se houver.
  • Regular: A etapa é executada uma vez.
  • Condicional: A etapa será executada uma vez se a expressão da propriedade Condição for avaliada como true. Selecionar condicional faz com que as propriedades Condição, Outro Sequencial e Outro Comando sejam mostradas. Se a propriedade Condição for avaliada como false, então Comando e Sequencial não serão executados. Em vez disso, Outro Comando e Outro Sequencial serão executados se forem especificados.
  • Loop While: A etapa pode ser executada diversas vezes. Ela é executada até que a expressão na propriedade Condição seja falsa ou até que o número máximo de iterações seja atingido. Selecionar Durante o Loop faz com que as propriedades Condição e Máx. de Iterações sejam mostradas.

    O seletor é avaliado a cada iteração do Loop While para determinar o servidor a ser usado para a iteração.

Sequencial
Especifica um projeto ou uma biblioteca para executar em sequência com o projeto atual. As etapas do projeto ou da biblioteca são executadas usando o ambiente e a maioria das propriedades do projeto atual. Entretanto, o sistema usa o seletor do projeto sequencial como o seletor padrão para as etapas do sequencial. O comportamento é como se as etapas no projeto especificado fossem copiadas após a etapa atual.
Acesso
Escolha um grupo de acesso para definir quais usuários têm permissão para utilizar a etapa. Você pode utilizar esta propriedade para restringir o acesso a etapas específicas em um projeto. Quando um usuário, que não é membro do grupo de acesso de uma etapa, ativa o projeto que contém a etapa, ela é ignorada.

A escolha do Padrão do Projeto faz com que a etapa herde as propriedades de acesso do projeto.

Provedor de Etapa
A implementação da execução do comando da etapa. O provedor da etapa padrão é o MJC Step Provider. Ela fornece comportamento legado conforme esperado de executar o texto de comando na máquina do agente de terminal
Máx. de Iterações
Mostrada apenas se Tipo de Etapa for Durante o Loop. Especifica o número máximo de iterações que a etapa pode ser executada em um loop. O padrão imposto pelo sistema é 100. A etapa é mostrada como concluída com êxito (aprovada) no log da etapa. Utilize Falha da etapa se o máximo for atingido, para fazer com que a etapa falhe quando Máx. de Iterações for atingido.

Quando as tarefas são executadas, a variável somente leitura BF_ITERATION contém o número de iterações digitadas com êxito. Se uma tarefa for interrompida e depois reiniciada, ela será reiniciada na iteração BF_ITERATION.

Falha da etapa se o máximo for atingido
Se Sim, uma etapa Durante o Loop falhará se Máx. de Iterações for atingido. Se Não, a etapa será aprovada.
Outro Sequencial
Mostrada apenas se Tipo de Etapa for condicional. Especifica um projeto para ser executado em sequência se a condição especificada for falsa. O padrão é Não.
Comando

Um ou mais comandos. Os comandos podem ser comandos do sistema operacional, comandos com ponto ou uma combinação de ambos. Consulte o Como as Etapas São Executadas.

Condição
Mostrada apenas se você selecionou um tipo de etapa Condicional ou Durante o Loop.
  • Condicional: o comando será executado se a condição for avaliada como verdadeira.
  • Loop While: o comando pode ser executado diversas vezes desde que a condição seja avaliada como verdadeira. É possível definir o limite utilizando Máx. de Iterações.

Uma condição pode ser uma função ou um comando a ser executado no recurso do servidor selecionado.

  • Uma função, se for utilizada, deve ser utilizada no início do campo Condição. Ela é avaliada pelo mecanismo Build Forge. Ela não é enviada para o recurso do servidor. Para obter uma lista das funções e das instruções sobre como usá-las, consulte Funções de Condição.
  • Um comando é executado no servidor selecionado. Qualquer comando utilizado aqui deve ser válido no ambiente shell do agente. O código de retorno da execução determina se a condição é aprovada ou com falha.

As variáveis do Build Forge do projeto estão disponíveis para serem utilizadas em uma expressão de condição. Consulte Interpretação de Variáveis em Etapas para obter informações adicionais sobre como as variáveis podem ser expressas e como elas são avaliadas.

Outro Comando
Mostrada apenas se você selecionou um tipo de etapa Condicional. Especifica um comando a ser executado se a condição for avaliada como falsa.
Ambiente

Especifica um ambiente a ser aplicado antes de executar os comandos. Os valores neste ambiente substituem quaisquer valores herdados do ambiente do servidor, do ambiente do projeto e das variáveis de etapas.

Seletor
Especifica um seletor a ser utilizado para escolher um servidor desta etapa. Se mantida como Padrão, a etapa será executada no servidor determinado pelo seletor do projeto.
Transmissão
Se selecionado, executa a etapa em cada servidor correspondente ao seletor atual (o seletor da etapa se especificado; caso contrário, o seletor do projeto). No tempo de execução, o sistema substitui uma etapa de transmissão por uma série de etapas, uma para cada servidor, e as executa em série ou em paralelo, dependendo da propriedade Encadeamento da etapa de transmissão.

Comportamento da etapa de transmissão nas reinicializações: Quando uma etapa de transmissão é reiniciada, ela não transmite. Essa configuração se aplica apenas a novos inícios da etapa. Na reinicialização, o mecanismo escolhe um único servidor aleatoriamente para a etapa.

Tempo Limite em Minutos
Especifica quantos minutos o sistema aguarda para que o comando atual produza saída (o padrão é 5 minutos). Um valor de 0 significa que a etapa não alcançou o tempo limite se a etapa se conectar adequadamente ao agente. Se o valor de tempo limite for atingido,o sistema falhará na etapa. O projeto também falhará, a menos que a etapa seja definida como Continuar em Com Falha.
Resultado
A propriedade Resultado determina como o sistema julga se uma etapa for bem-sucedida ou não. Utilize o valor padrão do Código de Saída para determinar o êxito com base em um código de saída retornado pelo shell do comando. Você pode escolher também um Filtro de Log que examina a saída do comando. Para selecionar um Filtro de Log, você deve primeiro criá-lo.
Com Falha
Especifica se você deve interromper ou continuar a tarefa se a etapa falhar. Por padrão, o sistema interrompe a tarefa.
Encadeamento
Se Sim, executa essa etapa em paralelo com outras etapas. Se esta propriedade for definida como Sim para permitir o encadeamento desta etapa (executando a etapa paralelamente com outras etapas). Defina a propriedade como Não para evitar o encadeamento. Defina a propriedade como Juntar para separar blocos de etapas encadeadas. O primeiro conjunto de etapas deve ser concluído antes do início do próximo conjunto de etapas encadeadas seguintes à etapa Juntar.
Notificação de Aprovação
Especifica o grupo de acesso a ser notificado se a etapa for aprovada.
Cadeia de Aprovação
Especifica um projeto a ser ativado se a etapa atual for aprovada. (Uma etapa com um status "Aviso" é contada como aprovação e ativará uma sequência de aprovação.)
Espera de Aprovação
Se selecionada, o sistema suspenderá o projeto atual até que o projeto encadeado aprovado seja concluído. Se esta etapa (ou seu projeto) for cancelada, o projeto encadeado também será cancelado. Se não estiver selecionado, o projeto encadeado será iniciado assincronamente e o projeto atual continuará na próxima etapa.
Notificação de Falha
Especifica o grupo de acesso a ser notificado se a etapa falhar.
Cadeia com Falha
Especifica um projeto a ser ativado no caso de falha da etapa atual. (Uma etapa configurada para continuar em caso de falha é contada como falha e ativará todas as cadeias de falha designadas para a etapa.)
Falha na Espera
Se selecionada, o sistema suspenderá o projeto atual até que o projeto encadeado aprovado seja concluído. Se esta etapa (ou seu projeto) for cancelada, o projeto encadeado também será cancelado.

Guia Notas

A guia Notas contém uma lista com registro de data e hora das notas feitas sobre a etapa. Você cria notas manualmente. Ela não registra edições automaticamente para a própria etapa. A guia mostra o número atual de notas, por exemplo, Notas (2).

Para incluir uma nota:
  1. Clique na guia Notas.
  2. Digite a nova nota no campo de texto.
  3. Clique em Enviar.
Para editar uma nota:
  1. Clique na guia Notas.
  2. Clique no ícone Editar Ícone editar ao lado da nota que você deseja editar. Faça suas edições.
  3. Clique em Enviar.
Para excluir uma nota:
  1. Clique na guia Notas.
  2. Clique no ícone Lixeira Ícone lixeira. Um prompt pergunta se você tem certeza de que deseja excluir a nota.
  3. Clique em OK.

Feedback