Referência de Variáveis do Ativador

O sistema controla os nomes de variáveis a seguir. Quando um ambiente da etapa contiver um deles (especificamente ou herdado de um projeto ou servidor), as ações serão executadas.

Variável

Índice

_CI_BUILD_DELETE

Configure essa variável para qualquer valor, para excluir o build e os dados associados do build depois que a tarefa for executada. (A variável tag será reconfigurada para seu valor inicial, anterior à construção excluída, se nenhuma outra construção do projeto for executada.)

_CI_BUILD_KEEP

Configure essa variável para qualquer valor, para manter o build e os dados associados do build depois que a tarefa for executada. Por exemplo, se a sua tarefa incluir um link de adaptador e a etapa de adaptador falhar, as outras etapas do projeto não serão executadas. Talvez você queira manter uma cópia dos registros do build para a tarefa, por exemplo, para depuração.

CLEARCASE_VIEW

Inicia a visualização do ClearCase. A visualização especificada nesta variável deve existir e a etapa que usa essa variável deve ser configurada para "absoluta". Em sistemas executando Microsoft Windows, essa variável deve ser usada com a opção de configuração cc_suppress_server_root para o agente em bfagent.conf.

_CLEARCASE_VIEWS

Especifica uma lista de visualizações ClearCase, para iniciar antes da execução do comando. Configure o valor para uma lista de visualizações separadas por vírgula; por exemplo, "Visualização1,Visualização2,Visualização3".

_CLEARCASE_VOBS

Especifica uma lista de VOBs ClearCase, para montagem antes da execução do comando. Configure o valor para uma lista de VOBs separados por vírgula; por exemplo, "\Vob1,\Vob2,\Vob3".

_CONTEXT_LOG_RANGE

Utilize essa variável para limitar a saída de log a linhas próximas a correspondências de filtro. Ela tem um valor de número inteiro positivo e faz com que o sistema omita a saída de log, exceto para um intervalo de linhas ao redor de cada ocorrência de cadeia de filtros cujo tamanho é igual ao valor da variável. Por exemplo, se você definir a variável como 5, seu registro mostrará linhas com correspondências de filtro, mais as 5 linhas anteriores e as 5 linhas após essas correspondências.

_ERROR_THRESHOLD

Estabelece o número máximo de erros (capturados pelos filtros Configurar Falha que você definiu) permitidos. Usando esta variável, é possível estabelecer os limites de falha e de mensagens para etapas individuais ou para um projeto.

Use um das seguintes formas:

  • Um valor 5 ou F5 indica que a tarefa deve falhar se mais de 5 erros ocorrerem.
  • Um valor N7 indica que o sistema deve incluir uma mensagem às notas da tarefa quando mais de 7 erros ocorrerem. A mensagem indica que este limite foi atingido.

Quando você utiliza a variável em uma etapa, o sistema conta os erros na etapa individual. Formulários adicionais estão disponíveis:

  • Um valor como W9 indica que após 9 erros, a etapa será colocada em estado de aviso, independentemente de erros futuros capturados pelos filtros.
  • Um valor como C8 indica que após 8 erros, a etapa será configurada como status com falha, mas qualquer filtro Limpar Falhar poderá limpar a falha.

NOTA: Os erros contados por essa variável são definidos como cadeias que correspondem a filtros com ações Configurar Falha e que são atribuídos a etapas no projeto. Cada cadeia identificada como uma falha por um filtro conta como um erro em relação ao total da etapa e um em relação ao total do projeto.

_EXITCODE_MAP

Especifica uma lista de números (separados por vírgulas, espaços, pontos-e-vírgulas ou dois pontos) que o sistema deve aceitar como indicadores de sucesso da etapa. Por padrão, um código de saída 0 indica sucesso; quando essa variável é especificada, qualquer valor listado nela também indica sucesso.

_InterfaceLoggingLevel

Controla quantos dados do log o Build Forge registra quando executa uma etapa de adaptador. Crie uma variável de ambiente (em seu ambiente de adaptador) com o nome _InterfaceLoggingLevel. Atribua a ela um valor inteiro de 0 a 8. Níveis de criação de log são inclusivos, por exemplo, nível 2 inclui informações a partir dos níveis 1 e 0.
  • 0: Linha exec mais erros de conexão do servidor ou notificação de cancelamento; nada mais
  • 1: Comandos analisados (comandos como serão enviados ao servidor)
  • 2: Comandos não analisados (comandos antes de ter suas variáveis locais configuradas)
  • 3: Linhas SET de variável de ambiente e build
  • 4: Linhas SET de variável interna e temporária
  • 5: Avaliações do ambiente, inclusões do grupo de e-mail, linhas de criação de log de texto do BOM
  • 6: Linhas de início/final de bloco & sub-bloco
  • 7: (Nível de criação de log padrão) A saída do agente é verificada em relação aos padrões de correspondência, mais as linhas que corresponderam aos padrões.
  • 8: Todas as saídas do agente

_LOG

Especifica um nome do caminho para criar um arquivo de log contendo a saída bruta do Build Forge Agent.

Nota: Esse log não inclui registros de data e hora, a menos que _LOG_TIMESTAMP também seja especificado. Os dados do log nesse arquivo geralmente são formatados desta forma: código do agente, depósito de log e mensagem.

Utilize essa variável para salvar uma cópia do log de tarefa no servidor. Se o arquivo existir, o sistema se conecta a ele.

_LOG_TIMESTAMP

Prefixa cada linha de saída de _LOG com um registro de data e hora. O valor dessa variável deve ser uma sequência de formatações na mesma sintaxe de strftime usada pelos comandos de ambiente .date e .gmdate.

Nota: Requer _LOG.

_MAP

Consulte Mapeando Unidades do Windows, para uma discussão de como utilizar essa variável.

_NO_PREPARSE_COMMAND

O sistema normalmente tenta resolver os valores de variáveis de ambiente antes de enviar comandos a agentes. Quando a variável _NO_PREPARSE_COMMAND é definida (com qualquer valor), o sistema envia variáveis para agentes sem resolvê-las. Utilize essa variável para assegurar que o shell do sistema operacional trate das variáveis.

_PRISM_DIR_POSTCMD

Utilizada com plug-ins para IDEs. Especifica um comando a ser executado nos diretórios após a execução da etapa do projeto. Consulte o Variáveis Especiais para Projetos de Teste.

_PRISM_DIR_PRECMD

Utilizada com plug-ins para IDEs. Especifica um comando a ser executado nos diretórios antes de serem copiados no servidor para uma etapa do projeto. Consulte o Variáveis Especiais para Projetos de Teste.

_PRISM_FILE_POSTCMD

Utilizada com plug-ins para IDEs. Especifica um comando a ser executado nos arquivos após a execução da etapa do projeto. Consulte o Variáveis Especiais para Projetos de Teste.

_PRISM_FILE_PRECMD

Utilizada com plug-ins para IDEs. Especifica um comando a ser executado nos arquivos antes de serem copiados no servidor para uma etapa do projeto. Consulte o Variáveis Especiais para Projetos de Teste.

_SUPPRESS_ENV_OUTPUT

Especifica que o sistema omite as mensagens de ambiente do log. Por padrão, essa variável não está configurada e todos os valores das variáveis no ambiente são impressos antes de um comando de etapa ser executado. Os valores aparecem como entradas ENV no log de etapa. A variável pode ser configurada para os seguintes valores:
  • ALWAYS: sempre omite as mensagens ENV
  • Qualquer outro valor: omite as mensagens ENV. No entanto, se o comando falhar, as mensagens ENV serão impressas após a mensagem de comando. Essas informações podem ser úteis na depuração da falha de execução do comando.

_SUPPRESS_AGENT_LOG_OUTPUT

Quando configurado como 1, evita que o agente envie dados do log para o mecanismo. Compare com _SUPPRESS_LOG_OUTPUT, em que os dados do log são enviados do agente, mas descartados pelo mecanismo.

Nota: O uso dessa variável evita a correspondência de filtros.

_SUPPRESS_LOG_OUTPUT

Quando configurado como 1, faz com que o mecanismo descarte quase toda a saída de log recebida do agente. Algumas mensagens de log do console permanecem. As correspondências do filtro são mostradas.

_TIMEOUT

Um valor que substitui a propriedade de Tempo Limite para uma ou todas as etapas em seu projeto.

_TRAP

Uma sequência a ser executada se a etapa atual falhar; a sequência pode ser configurada para o nome de um arquivo ou comando executável. NOTA: A saída do comando não é retornada ao console porque a conexão entre o console e o agente é encerrada quando a etapa falha. Se você desejar reter a saída de um comando emitido por meio _TRAP, faça o comando gravar sua saída em um arquivo, para uma recuperação posterior.

_USE_BFCREDS

Quando configurado como 1, o sistema utiliza as credenciais de login do usuário para efetuar login em servidores, em vez das credenciais armazenadas na autorização do servidor anexada ao servidor. O sistema usa as credenciais de login do Console de Gerenciamento do usuário que iniciou o projeto para executar os comandos no projeto. É possível configurar essa variável para uma única etapa ou para um projeto inteiro.
Nota: Se você estiver utilizando a autenticação de LDAP/Active Directory, a configuração do sistema Armazenar Autenticação do Usuário Localmente deverá ser definida como Sim (o valor padrão) para que a função _USE_BFCREDS funcione. Quando a configuração for Sim, o sistema armazenará em cache as informações sobre autenticação de usuário de forma criptografada e poderá então acessar as informações sobre autenticação de usuário para uso com _USE_BFCREDS.
Dica: No Windows, considere configurar também a variável _USE_BFCREDS_DOMAIN.

_USE_BFCREDS_DOMAIN (somente Windows)

Quando definido para 1, o sistema usa o domínio user's além das credenciais de login que _USE_BFCREDS usa para efetuar login nos servidores.

_XSTREAM_PROTOCOL type

Ativa transferências diretas de arquivos entre os agentes.
Importante: Os agentes em alguns sistemas operacionais possuem suporte limitado ou nenhum suporte para transferência direta de arquivos. Consulte o Configurando a Transferência Direta de Arquivos entre Agentes.

O mecanismo, o agente de envio e o agente de recebimento devem suportar transferências diretas de arquivos. Se algum deles não suportar, _XSTREAM_PROTOCOL será ignorado sem aviso e o método normal de transferência de arquivos será usado.

Os agentes de recebimento deverão poder criar conexões TCP no host do agente de envio. Se existirem, firewalls devem ser configurados para permitir conexões.

O tipo de protocolo determina o método de codificação de dados e é um dos seguintes:

AES-CBC
São usados algoritmos criptograficamente fortes para codificar os dados. Os dois agentes devem ser compilados com OpenSSL e usar SSL na comunicação com o mecanismo. A chave de criptografia é obtida do mecanismo.
PRNG
É usado um gerador de número pseudo-aleatório para ocultar o conteúdo do arquivo.
PLAIN
Os arquivos são transferidos no estado em que se encontram sem codificação.

Feedback