触发器变量引用

系统监视以下变量名称。当步骤的环境包含这些变量的其中之一(特意包含或者从项目或服务器继承)时,系统将执行操作。

变量

目录

_CI_BUILD_DELETE

将此变量设置为任意值以在作业运行后删除构建以及关联的构建数据。(如果未运行其他项目构建,标记变量将复位为已删除构建之前的初始值。)

_CI_BUILD_KEEP

将此变量设置为任意值将在作业运行后保留构建以及关联的构建数据。例如,如果作业包含适配器链接并且适配器步骤失败,那么其他项目步骤将不会运行。您可能想保留该作业的构建记录副本以作它用,例如用于调试。

CLEARCASE_VIEW

启动指定的 ClearCase 视图。此变量中指定的视图必须存在,而且必须将使用此变量的步骤设置为“absolute”。在运行 Microsoft Windows 的系统上,该变量必须与 bfagent.conf 中代理程序的 cc_suppress_server_root 配置选项一起使用。

_CLEARCASE_VIEWS

指定要在命令执行之前启动的 ClearCase 视图的列表。请将其值设置为视图的逗号分隔列表;例如,“View1,View2,View3”。

_CLEARCASE_VOBS

指定要在命令执行之前挂装的 ClearCase VOB 的列表。请将其值设置为 VOB 的逗号分隔列表;例如,“\Vob1,\Vob2,\Vob3”。

_CONTEXT_LOG_RANGE

使用此变量将日志输出限制为过滤器匹配项前后的那几行。它接受一个正整数值,并使系统只输出每一个过滤字符串命中项前后的一系列行(行数范围等于该变量的值),而忽略其他日志输出。例如,如果将变量设置为 5,日志中仅显示含有过滤器匹配项的行,以及这些匹配行的前后各 5 行。

_ERROR_THRESHOLD

确定允许的最大错误(由已定义的“设置失败”过滤器捕获的错误)数量。使用此变量,您可以为各个步骤或一个项目建立失败或消息阈值。

使用以下某种格式:

  • 值 5 或 F5 表示如果出现的错误多于 5 个,该作业应失败。
  • 值 N7 表示出现的错误多于 7 个时,系统应向作业说明添加一条消息。该消息表示已满足该阈值。

当在一个步骤中使用该变量时,系统将统计该单个步骤中的错误数。有其他形式可用:

  • 类似 W9 的值表示在 9 次错误之后,不管过滤器以后是否捕获到错误,都会将该步骤置于警告状态。
  • 类似于 C8 的值表示在 8 次错误之后,会将该步骤设为故障状态,但是任何“清除故障”过滤器都可清除该故障。

注:此变量统计的错误数定义为将过滤器与“设置失败”操作进行匹配的字符串,并且该字符串将分配给项目中的步骤。由过滤器标识为故障的每一个字符串将作为一个错误计入步骤错误总计以及项目错误总计。

_EXITCODE_MAP

指定一个数字列表(用逗号、空格、分号或冒号分隔),系统应接受这些数字作为步骤成功的指示符。缺省情况下,退出代码 0 表示成功;当指定了此变量时,该变量中列出的任何值也都将表示成功。

_InterfaceLoggingLevel

控制 Build Forge 在运行适配器步骤时应记录多少日志数据。(在适配器环境中)创建名为 _InterfaceLoggingLevel 的环境变量。赋予其 0 到 8 之间的某个整数值。日志记录级别包含下级级别,例如,级别 2 包含级别 1 和 0 的信息。
  • 0:Exec 行以及服务器连接错误或取消通知;没有其他内容
  • 1:解析过的命令(将发送到服务器的命令)
  • 2:未解析的命令(设置其局部变量之前的命令)
  • 3:构建和环境变量 SET 行
  • 4:临时和内部变量 SET 行
  • 5:环境求值,电子邮件组添加,BOM 文本记录行
  • 6:锁和子锁开始/结束行
  • 7:(缺省记录级别)针对匹配模式进行检查的代理程序输出,以及与模式匹配的行。
  • 8:所有代理程序输出

_LOG

指定一个路径名,以创建包含 Build Forge 代理程序原始输出的日志文件。

注: 该日志不包含时间戳记,除非还指定了 _LOG_TIMESTAMP。 该文件中的日志数据的格式通常如下:代理程序代码、日志存储区和消息。

使用此变量在服务器上保存作业日志的副本。如果文件已存在,系统会将日志追加到其中。

_LOG_TIMESTAMP

_LOG 的每一行输出都以时间戳记为前缀。此变量值应当为 .date 和 .gmdate 环境命令使用的同一 strftime 语法中的格式字符串。

注: 需要 _LOG。

_MAP

有关如何使用此变量的讨论,请参阅 映射 Windows 驱动器

_NO_PREPARSE_COMMAND

系统在向代理程序发送命令之前通常会尝试解析环境变量的值。当定义了 _NO_PREPARSE_COMMAND 变量时(定义为任何值),系统将向代理程序直接发送这些环境变量,而不进行解析。使用此变量可确保操作系统 shell 处理那些环境变量。

_PRISM_DIR_POSTCMD

用于 IDE 插件。指定在运行项目步骤后要对目录运行的命令。请参阅测试项目的特殊变量

_PRISM_DIR_PRECMD

用于 IDE 插件。指定在为项目步骤将目录复制到服务器之前对目录运行的命令。请参阅测试项目的特殊变量

_PRISM_FILE_POSTCMD

用于 IDE 插件。指定在运行项目步骤后要对文件运行的命令。请参阅测试项目的特殊变量

_PRISM_FILE_PRECMD

用于 IDE 插件。指定在为项目步骤将文件复制到服务器之前对文件运行的命令。请参阅测试项目的特殊变量

_SUPPRESS_ENV_OUTPUT

指定系统忽略日志中的环境消息。缺省情况下,不会设置该变量,环境中的所有变量值都会在运行步骤命令前打印出来。值显示为步骤日志中的 ENV 条目。可将变量设置为以下值:
  • ALWAYS:始终忽略 ENV 消息
  • 任何其他值:忽略 ENV 消息。然而,如果命令失败,将在命令消息后打印 ENV 消息。在调试命令执行失败时,此信息可能非常有用。

_SUPPRESS_AGENT_LOG_OUTPUT

如果设置为 1,将阻止代理程序向引擎发送日志数据。这与 _SUPPRESS_LOG_OUTPUT 不同,后者允许从代理程序发送日志数据,但由引擎丢弃。

注: 使用此变量可防止过滤器匹配项。

_SUPPRESS_LOG_OUTPUT

如果设置为 1,会导致引擎丢弃几乎所有从代理程序接收的日志输出。某些控制台日志消息会保留。会显示过滤器匹配项。

_TIMEOUT

该值覆盖项目中的一个或全部步骤的“超时”属性。

_TRAP

当前步骤失败时要运行的字符串;该字符串可设置为可执行文件或命令的名称。注:命令的输出不会返回到控制台,因为当步骤失败时,控制台和代理程序之间的连接将关闭;如果要保留通过 _TRAP 发出的命令的输出,请使命令将其输出写入文件,以备以后检索。

_USE_BFCREDS

当设置为 1 时,系统使用用户的登录凭证来登录到服务器,而不是附加于服务器的服务器授权中存储的凭证。系统使用启动项目的用户的管理控制台登录凭证来运行项目中的命令。可以为单个步骤设置此变量,也可为整个项目设置。
注: 如果使用 LDAP/Active Directory 认证,本地存储用户认证系统设置必须设置为“是”(其缺省值),这样 _USE_BFCREDS 函数才能起作用。当该设置设为“是”时,系统会以加密形式高速缓存用户认证信息,然后可以访问用户认证信息来与 _USE_BFCREDS 一起使用。
提示: 在 Windows 上,也考虑设置变量 _USE_BFCREDS_DOMAIN。

_USE_BFCREDS_DOMAIN(仅限于 Windows)

设置为 1 时,系统使用用户的域,以及 _USE_BFCREDS 用于登录服务器的登录凭证。

_XSTREAM_PROTOCOL type

启用代理程序之间的直接文件传输。
要点: 某些操作系统上的代理程序对于直接文件传输存在限制或者不支持。请参阅配置代理程序之间的直接文件传输

引擎、发送方代理程序和接收方代理程序都必须支持直接文件传输。如果任何一方不支持,那么会忽略 _XSTREAM_PROTOCOL ,而不发出警告,并且会使用普通的文件传输方法。

接收方代理程序必须能够在发送方代理程序主机上创建 TCP 连接。如果它们都存在,那么必须配置防火墙以允许连接。

协议的 type 确定编码数据的方法,采用以下类型之一:

AES-CBC
使用强加密算法进行数据编码。 必须通过 OpenSSL 编译两个代理程序,并且使用 SSL 与引擎进行通信。加密密钥从引擎处获取。
PRNG
使用伪随机数生成器来掩盖文件内容。
PLAIN
不进行编码,按原样传输文件。

反馈