服务水平管理 › 业务逻辑范围 › 如何使用业务逻辑 › 业务逻辑对象 › 工具对象

工具对象

包含某些有用方法的全局对象。

AddEventAnnotation(<Info>, <EventId>)

将事件标注保存到指定事件中。 此信息在稍后查看原始数据（事件）时非常有用。 已保存标注可解释在特定时刻执行业务逻辑公式期间发生的某些特殊情况。

Information 参数指定应当编写的标注文本。

它还接受指定所标注事件的 EventId 参数。

AddRootCauseComment(<Info>, <Timestamp>, <ResourceId>)

保存根本原因注释。 此信息稍后在生成的报告中非常有用。 已保存根本原因注释可解释在特定时刻执行业务逻辑公式期间发生的某些特殊情况。

Information 参数指定应当编写的注释。

此方法接收要与注释一起保存的时间戳。 它还接受指定与方法上下文相关的资源的 ResourceId 参数。 （此参数为可选项，可以省略。）

GetCustomAttributeForResource(resourceName, timestamp, customAttributeName)

在指定时间从指定资源中返回指定自定义属性的值。

如果事件发生时此属性不存在，则会发生错误。

示例：

Dim AttribVal
AttribVal = Tools. GetCustomAttributeForResource. "MyResource", #12/12/2006 12:34:56#, "MyAttribute"

GetExternalData (connectionString, query)

此方法基于指定查询返回从由连接字符串指定的数据库中获取的记录集。

这两个字符串都必须以分号 (;) 结尾。

然后，用户即可使用此记录集，如下所示：

• Recordset.MoveNext - 移动到记录集中的下一个记录。
• Recordset.MovePrev - 移动到记录集中的上一个记录。
• Val = RecordSet("Field1") - 从记录集的当前记录中获取 Field1 的值。
• Do Until ruleNames.EOF - 在当前记录为文件结尾时停止循环。
• Do Until ruleNames.BOF - 在当前记录为文件开头时停止循环。
• RecordSet.Close - 关闭数据库连接。

示例：

Dim rs
Set rs = Tools.GetExternalData(
"dsn=oblicore;uid=oblicore;pwd=oblicore;", "select * from t_rules")
Do Until rs.EOF
  Out.Log "Name=" & rs("RULE_NAME"), "I"
  rs.MoveNext
Loop
rs.Close 

GetLocaleTime(<utcTime>)

该方法将 UTC 中给定的时间转换为当前度量标准的时区。

GetUtcTime(<localeTime>)

该方法将当前度量标准的时区中给定的时间转换为 UTC。

HasCustomAttributeForResource(resourceName, timestamp, customAttributeName)

返回在指定时间指定资源中指定是否存在指定的属性。

示例：

Dim AttribExistsNow
AttribExistsNow = Tools. HasCustomAttributeForResource "MyResource", #12/12/2006 12:34:56#, "MyAttribute"

NetTime(<Begin time>, <End time>)

接受两个表示时间段的参数。

该方法计算和返回时间段中期间开始到结束的时间量（以秒为单位）。

如果开始时间晚于结束时间，则结果为负数。

SaveFields(<tableName>, <Key>, fieldName1, fieldValue1, fieldName2, fieldValue2,…)

与 SaveRecord 类似，只是此方法提供几对字段名称和相关字段值，而不是枚举所有值。 字段编号可代替字段名称。 （第一个值字段的编号是 1。）

注意：此方法仅可通过跟踪期代理执行。

SaveRecord <tableName>, <key>, <val1>, <val2>,…

在用户表中保存记录。 用户表用于在服务水平计算期间输出信息。 此信息可稍后用于生成报告。 可能存在多个用户表。

tableName 参数指定应当将信息写入的表。 用户表中的每条记录都具有唯一键，该键指定应当将信息写入的记录。 每条记录还具有多个字符串类型的值字段。 在实施期间，定义每个用户表中的确切值字段数以及字段名称。

SaveRecord 方法接收用户表名称和键。 它还接受用户表中的所有值字段。 （这些值参数为可选项，可以省略。）如果具有相同键的记录已存在，则会更新此记录。 （仅更新作为参数传输的值字段。）如果具有此键的记录不存在，则会创建此记录。

注意：此方法仅可通过跟踪期代理执行。

SendEvent(<eventName>, <resourceName>, <Timestamp>, <TimeUnit>, <args>)

此方法创建新度量标准事件。 参数定义如下所示：

• EventTypeName - 此事件的事件类型的名称。
• ResourceName - 为其发送此事件的资源的名称。 此参数是可选的。 如果不提供此参数，则在所有资源上发送事件。 该名称还可以包含资源组名称。 如果出现这种情况，则在此资源组上发送事件。 系统可自行识别指定的名称是资源名称还是资源组名称。 可以将其替换为 ResourceGroup 名称。 使用组名称代替资源名称时，其他值没有任何变化。
• Timestamp - 其为此事件的时间戳。 此参数是可选的。 如果不提供此参数，则时间戳为由度量标准接收的最后事件的时间戳。
• TimeUnit - 其为要发送的时间单位。 用户可以发送的时间单位的类型如下：
  • 全部
  • 跟踪
  • 小时
  • 日
  • 周
  • 月
  • 季度
  • 年

  时间单位参数为强制性参数，如果未定义或未正确定义该参数，则不发送任何事件。

  该参数不区分大小写。

  如果未在业务逻辑中正确定义时间单位，则会在日志中写入错误。

• Val_1, Val_2... - 事件的值字段。 值字段数取决于事件类型。 如果所提供参数的数目多于事件类型中数据字段的数目，则会在执行此行时报告运行时错误。 如果所提供参数的数目少于数据字段的数目，则会在最后参数中放置默认值。 默认值取决于字段类型。 如果传递的值与事件中值的类型不一致，且未进行适当的转换，则会生成错误。

示例：

Tools.SendEvent "OnEvent", "MyResource", #1/2/2006 13:46:00#, "All", 1, 2