ツールオブジェクト

ユーザガイド › サービスレベル管理 › ビジネスロジックスコープ › ビジネスロジックを使用する方法 › ビジネスロジックオブジェクト › ツールオブジェクト

ツールオブジェクト

いくつかの有用なメソッドが含まれるグローバルオブジェクトです。

AddEventAnnotation(<Info>, <EventId>)

イベント注釈を指定されたイベントに保存します。この情報は、後で raw 生データ（イベント）を表示するときに有用です。保存された注釈は、ビジネスロジック計算式の実行中における特定の状況について、特定の瞬間に説明します。

情報パラメータは、注釈テキストを書き込む必要があることを指定します。

また、注釈付のイベントを指定する EventId パラメータを受諾します。

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

根本原因コメントを保存します。この情報は後で、生成されたレポートに有用となります。保存された根本原因コメントは、ビジネスロジック計算式の実行中における特定の状況について、特定の瞬間に説明します。

情報パラメータは、コメントを書き込む必要があることを指定します。

メソッドは、コメントと併せて保存するタイムスタンプを受信します。また、メソッドコンテキストに関連するリソースを指定する 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>)

期間を示す 2 つのパラメータを受諾します。

メソッドは、タイムスロット内の期間の開始時点から終了時点までの時間数（秒）を計算して返します。

開始時間が終了時間より後である場合、結果は負の数です。

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 name と置き換えることができます。リソース名の代わりにグループ名を使用する場合、他の値は変わりません。
Timestamp - このイベントのタイムスタンプです。このパラメータはオプションです。このパラメータが提供されない場合、タイムスタンプはメトリックが受信した最後のイベントのタイムスタンプとなります。
TimeUnit - 送信される時間単位です。ユーザが送信することができる時間単位のタイプは次のとおりです。
- すべて
- トラッキング
- 時間
- 日
- 週
- 月
- 四半期
- 年
時間単位パラメータは必須パラメータです。パラメータが定義されていない、または誤って定義されている場合、イベントは送信されません。

パラメータで大文字と小文字は区別されません。

ビジネスロジックで時間単位が誤って定義されている場合、エラーがログに書き込まれます。
Val_1, Val_2… - イベントの値フィールドです。値フィールドの数はイベントタイプに依存します。提供されたパラメータの数がイベントタイプ内のデータフィールド数を越える場合、この行の実行時にランタイムエラーがレポートされます。提供されたパラメータの数がデータフィールドの数より小さい場合、最後のパラメータにデフォルト値が配置されます。デフォルト値は、フィールドのタイプに依存します。渡された値がイベント内の値のタイプと一致しておらず、適切なキャスティングがない場合、エラーが生成されます。

例：

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

ツール オブジェクト

ツールオブジェクト