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

コンテキスト オブジェクト

以下のとおり、計算されたメトリックに関する情報を提供します。

ClusterItem

現在のクラスタ項目の名前（現在のメトリックがクラスタ化されている場合）、または空の文字列（現在のメトリックがクラスタ化されていない場合）を返します。

ClusterItemId

現在のクラスタ項目の ID（現在のメトリックがクラスタ化されている場合）、または 0（現在のメトリックがクラスタ化されていない場合）を返します。

ClusterSize

クラスタ化メトリックのクラスタのサイズを返します。 メトリックがクラスタ化されていない場合は 1 を返します。

ConsumptionUnit

［メトリックの詳細］ページで定義されているとおり、現在のメトリックの消費単位名を返します。 単位自体は［デザイン］、［ファンデーション エンティティ］、［単位］で定義されています。 この値は、空の文字列が返された場合、設定解除されたままになる可能性があります。 この値はメトリック タイプ機能の一部です。

例：

Dim Unit
Unit = Context.ConsumptionUnit

ConsumptionUnitSymbol

［メトリックの詳細］ページで定義されているとおり、現在のメトリックの測定単位記号を返します。 単位自体は［デザイン］、［ファンデーション エンティティ］、［単位］で定義されています。 この値は、空の文字列が返された場合、設定解除されたままになる可能性があります。 この値はメトリック タイプ機能の一部です。

例：

Dim Sym
Sym = Context.MeasurementUnitSymbol

契約

イベントを生成したメトリックが含まれる契約の名前。 アダプタがイベントを生成した場合、空の文字列が返されます。

ContractEffectiveFrom

契約（現在のバージョンに限らず）の有効開始日を返します。

ContractEffectiveTo

契約（現在のバージョンに限らず）の有効終了日を返します。

ContractId

イベントを生成したメトリックが含まれる契約の ID。 アダプタがイベントを生成した場合、プロパティ値は 0 です。

ContractParty

契約を所有する契約関係者の名前。 この契約には、イベントを生成したメトリックが含まれます。 アダプタがイベントを生成した場合、空の文字列が返されます。

ContractPartyId

契約を所有する契約関係者の ID。 この契約には、イベントを生成したメトリックが含まれます。 アダプタがイベントを生成した場合、プロパティ値は 0 です。

ContractType

［契約の詳細］ページの全般ページで定義されているとおり、現在の契約タイプの値を返します （この値はエンド ツー エンド機能の一部です）。

例：

Dim CType
CType = Context.ContractType

CorrectionsApply

現在の計算が修正を考慮に入れる場合、True を返します。

CorrectionsFolded

修正がない場合、True を返します。 現在の計算は WithCorrections モードと WithoutCorrections モードの両方で実行されます。

DomainCategoryRelation

ドメイン カテゴリの詳細で定義されているとおり、メトリックのドメイン カテゴリの関係（NMT または NLT）を返します。

Dump

コンテキスト オブジェクトの内容が含まれる文字列を、読み取り可能な形式で返します。

EntryPoint

スクリプトの外部からコールされた、スクリプト内の最後のイベント ハンドラの名前を返します。 有効な値には以下が含まれます。

• OnLoad
• OnRegistration
• OnPeriodStart
• OnTimeSlotEnter
• OnTimeSlotExit

イベントの結果としてコールされた、その他の関数

ExceptionsApply

現在の計算が例外を考慮に入れる場合、True を返します。

ExceptionsFolded

例外がない場合、True を返します。 現在の計算は WithExceptions モードと WithoutExceptions モードの両方で実行されます。

Field("Price Per Unit")

［メトリックの詳細］ページで定義されている単価テーブルのマップを返します。 このマップによってユーザは、ビジネス ロジックで使用するテーブルから単価の値を調べることができます。 このマップは会計モジュール機能の一部です。

例：

Dim PPUMap
Set PPUMap = Context.Field("Price Per Unit")

For Each element in map
   x = element
Next

Formula

計算式の名前を返します。

FormulaId

計算式の ID を返します。

GetRegistrations

ランタイム中に現在の計算メトリックで定義された登録のリストを提供するマップのうち 1 つのマップを返します。

注： 高レベル マップは、実際に登録情報を保持するマップを保持しているコンテナにすぎません。

例：

Dim rMap
Set rMap = Context.GetRegistrations

HasService

現在のメトリックに関連付けられているサービス（KPI など、一部のメトリック タイプにはサービスがないなど）があるかどうかに関するブール型を返します （この値はサービスレス メトリック機能の一部です）。

例：

Dim WithService
WithService = Context.HasService

IntervalLength

イベントを生成した計算の間隔（TimeUnit プロパティにある単位）です。 アダプタがイベントを生成した場合、このプロパティには 0 が含まれます。 トラッキング期間の計算ではなくメトリックによってイベントが生成された場合、このプロパティの値は常に 1 です。 メトリックのトラッキング期間によってイベントが生成された場合、その値はトラッキング期間の TimeUnit の数です。

IsInForecast

現在の計算がメトリック予測のために実行されているかどうかに関するブール型を返します （この値は予測機能の一部です）。

例：

Dim Forecasting
Forecasting = Context.IsForecast

IsTargetDynamic

現在のメトリックが動的であるかどうかに関するブール型を返します。 この値は動的ターゲット機能の一部です。

例：

Dim IsDynamic
IsDynamic = Context.IsTargetDynamic

IsTrackingPeriod

何らかのメトリックのトラッキング期間の計算がイベントを送信した場合、この値は true です。 アダプタがイベントを送信した場合、この値は false です。

IsWithinTimeSlot

イベントがメトリックのタイムスロット中に発生した場合、true を返します。

MainIndicator

［メトリックの詳細］ページで定義されているとおり、現在のメトリックのメイン インジケータの値を返します。 この値はメトリック タイプ機能の一部です。

例：

Dim Indicator
Indicator = Context.MainIndicator

MainMode

ExceptionsApply または ExceptionsFolded が True であり、かつ CorrectionsApply または CorrectionsFolded が True である場合、True を返します。 つまり、現在の計算が WithCorrections モードおよび WithExceptions モードの両方に適用される場合、MainMode は True を返します。

MeasurementUnit

［メトリックの詳細］ページで定義されているとおり、現在のメトリックの測定単位の名前を返します。 単位自体は［デザイン］、［ファンデーション エンティティ］、［単位］で定義されています。 この値が設定解除されたままである場合、空の文字列が返されます。 この値はメトリック タイプ機能の一部です。

例：

Dim Unit
Unit = Context.MeasurementUnit

MeasurementUnitSymbol

［メトリックの詳細］ページで定義されているとおり、現在のメトリックの測定単位記号を返します。 単位自体は［デザイン］、［ファンデーション エンティティ］、［単位］で定義されています。 この値が設定解除されたままである場合、空の文字列が返されます。 この値はメトリック タイプ機能の一部です。

例：

Dim Sym
Sym = Context.MeasurementUnitSymbol

RegistrationTime

OnRegistration プロシージャが最後にコールされた時間を返します。

OnRegistration には、他のイベント ハンドラと異なり時間パラメータが含まれないので、現在の時刻を取得するには RegistrationTime を使用します。

Resources(<resourceGroup>, <resourceType>, <withContractParty>, <withService>)

提供されたパラメータによって、リソースのこのリストが以下のように絞り込まれます。

• resourceGroup パラメータが提供される場合、このグループ内のリソースのみが返されます。
• resourceType パラメータが提供される場合、このタイプのリソースのみが返されます。
• withContractParty が True である場合、現在の契約関係者に属するリソースのみが返されます。
• withService が True である場合、現在のサービスに属するリソースのみが返されます。

Resources(resourceGroup, resourceType, withContractParty, withService, time)

ResourcesOfType に似ていますが、接続されている以下のリソースのみを返す点が異なります。

• リソース グループ
• 指定した時間における現在の契約の現在のメトリックのリソース タイプ

• resourceGroup パラメータが提供される場合、このグループ内のリソースのみが返されます。
• resourceType パラメータが提供される場合、このタイプのリソースのみが返されます。
• DirectDescendantsOnly パラメータが true として指定される場合、現在のオブジェクトの直接の子孫のみが返されます。

例：

Dim map
Set map = Context.Resources "ThisResourceGroup", "ThisResourceType", True, False, #1/1/2006 12:45:00#

ResourceDisplayNameById (resourceId)

指定されたリソース ID のリソースの表示名を返します。

例：

Dim resourceDisplayNameById
resourceDisplayNameById = context. resourceDisplayNameById(1000)

ResourceDisplayNameByName ("resourceName")

指定されたリソースリ名のリソースの表示名を返します。

例：

Dim resourceDisplayNameByName
resourceDisplayNameByName = context. resourceDisplayNameByName("London")

ResourcesOfContractParty(<resourceType>)

ResourcesOfType と似ていますが、このメソッドは現在の契約の契約関係者に、今現在接続されているリソースのみを返す点が異なります。

ResourcesOfContractParty(resourceType, time)

ResourcesOfType と似ていますが、現在の契約の契約関係者に、指定した時間に接続されているリソースのみを返す点が異なります。

例：

Dim map
Set map = Context.ResourcesOfContractParty
"ThisResourceType", #1/1/2006 12:45:00#

ResourcesOfContractPartyAndService(<resourceType>)

ResourcesOfType に似ていますが、このメソッドは、以下のリソースのみを返す点が異なります。

• 現在のメトリックのサービスに接続されているもの
• 現在の契約の現時点での契約関係者

ResourcesOfContractPartyAndService(resourceType, time)

ResourcesOfType に似ていますが、以下のリソースのみを返す点が異なります。

• リソース グループ
• 現在のルールのサービスに接続されている場合の、指定した時間における現在のルールのリソース タイプ
• 指定された時間における現在の契約の契約関係者

例：

Dim map
Set map = Context.ContractPartyAndService "ThisResourceType", #1/1/2006 12:45:00#

ResourcesOfResourceGroup (resourceGroup, resourceType, time, DirectDescendantsOnly)

ResourcesOfType に似ていますが、以下に接続されているリソースのみを返す点が異なります。

• リソース グループ
• 指定した時間における現在の契約の現在のルールのリソース タイプ

• resourceGroup パラメータが提供される場合、このグループ内のリソースのみが返されます。
• resourceType パラメータが提供される場合、このタイプのリソースのみが返されます。
• DirectDescendantsOnly パラメータが true として指定される場合、現在のオブジェクトの直接の子孫のみが返されます。

例：

Dim map
Set map = Context.ResourcesOfResourceGroup "ThisResourceGroup", "ThisResourceType", #1/1/2006 12:45:00#, True

ResourcesOfService (<resourceType>)

ResourcesOfType に似ていますが、このメソッドは現在の契約のサービスに今現在接続されているリソースのみを返す点が異なります。

ResourcesOfService (<resourceGroup>, <resourceType>)

ResourcesOfType に似ていますが、このメソッドは定義されたリソース グループに、今現在（間接的および非間接的の両方）含まれているリソースのみを返す点が異なります。

ResourcesOfService(resourceGroup, resourceType, time)

ResourcesOfType に似ていますが、このメソッドは定義されたリソース グループに、指定した時間に（間接的および非間接的の両方）含まれているリソースのみを返す点が異なります。

例：

Dim map
Set map = Context.ResourcesOfService
"ThisResourceGroup", "ThisResourceType", #1/1/2006 12:45:00#

ResourcesOfService(resourceType, time)

ResourcesOfType に似ていますが、現在の契約のサービスに指定された時間に接続されているリソースのみを返す点が異なります。

例：

Dim map
Set map = Context.ResourcesOfService
 "ThisResourceType", #1/1/2006 12:45:00#

ResourcesOfType、ResourcesOfContractParty、ResourcesOfService、ResourcesOfResourceGroup、Resources、ResourcesOfContractPartyAndService

これらの関数にはすべて、新しいオプションとしてパラメータにコールされた時間があります。 パラメータが指定されない場合、現在の時刻が使用されます。

• ResourcesOfType(resourceType, time)

  リソース ID のマップを返します。 返されたマップ内の各エントリには、リソース ID のキーおよび値が含まれます。

  • resourceType パラメータが提供される場合、このメソッドは、以下のすべてのリソースを返します。
    • 表示された時間に存在していて、指定されたリソースに接続されているもの。
  • resourceType パラメータが提供される場合、このメソッドは、次のすべてのリソースのリストを返します。
    • 指定された時間に存在しているもの。
  • 時間パラメータが提供されない場合、現在の時刻が使用されます。

  例：

  Dim map
  Set map = Context.ResourcesOfType "ThisResourceType", #1/1/2006 12:45:00#
  

• ResourcesOfContractParty(resourceType, time)

  ResourcesOfType と似ていますが、現在の契約の契約関係者に、指定した時間に接続されているリソースのみを返す点が異なります。

  例：

  Dim map
  Set map = Context.ResourcesOfContractParty
   "ThisResourceType", #1/1/2006 12:45:00#
  

• ResourcesOfService(resourceType, time)

  ResourcesOfType に似ていますが、現在の契約のサービスに指定された時間に接続されているリソースのみを返す点が異なります。

  例：

  Dim map
  Set map = Context.ResourcesOfService
   "ThisResourceType", #1/1/2006 12:45:00#
  

• ResourcesOfService(resourceGroup, resourceType, time)

  ResourcesOfType に似ていますが、このメソッドは定義されたリソース グループに、指定した時間に（間接的および非間接的の両方）含まれているリソースのみを返す点が異なります。

  例：

  Dim map
  Set map = Context.ResourcesOfService
   "ThisResourceGroup", "ThisResourceType", #"06/01/01 12:45:00#
  

• ResourcesOfContractPartyAndService(resourceType, time)

  ResourcesOfType に似ていますが、以下のサービスに接続されているリソースのみを返す点が異なります。

  • 現在のルール
  • 指定された時間における現在の契約の契約関係者

  例：

  Dim map
  Set map = Context.ContractPartyAndService "ThisResourceType", #1/1/2006 12:45:00#
  

• ResourcesOfResourceGroup (resourceGroup, resourceType, time, DirectDescendantsOnly)

  ResourcesOfType に似ていますが、以下に接続されているリソースのみを返す点が異なります。

  • リソース グループ
  • リソース タイプ
  • 現在のルール
  • 指定された時間における現在の契約
  • resourceGroup パラメータが提供される場合、このグループ内のリソースのみが返されます。
  • resourceType パラメータが提供される場合、このタイプのリソースのみが返されます。
  • DirectDescendantsOnly パラメータが true として指定される場合、現在のオブジェクトの直接の子孫のみが返されます。

  例：

  Dim map
  Set map = Context.ResourcesOfResourceGroup "ThisResourceGroup", "ThisResourceType", #1/1/2006 12:45:00#, True
  

• Resources(resourceGroup, resourceType, withContractParty, withService, time)

  提供されたパラメータによって、リソースのこのリストが以下のように絞り込まれます。

  • resourceGroup パラメータが提供される場合、このグループ内のリソースのみが返されます。
  • resourceType パラメータが提供される場合、このタイプのリソースのみが返されます。
  • withContractParty が True である場合、現在の契約関係者に属するリソースのみが返されます。
  • withService が True である場合、現在のサービスに属するリソースのみが返されます。
  • 時間が定義されている場合、指定された日付のリストが生成されます。 提供されていない場合、現在の時刻が使用されます。

  例：

  Dim map
  Set map = Context.Resources "ThisResourceGroup", "ThisResourceType", True, False, #1/1/2006 12:45:00#
  

ResourceNameById

特定のリソース ID のリソースまたはリソース グループの名前を返します。

例：

Dim MyResourceName
MyResourceName = Context. ResourceNameById (1234)

ResourceIdByName

指定された ID と共に、リソースまたはリソース グループの ID を返します。

例：

Dim MyResourceId
MyResourceId = Context. ResourceIdByName (“MyResource”)

Rule

メトリックの名前を返します。

RuleId

メトリックの ID を返します。

RulePeriodTimeUnit

メトリックのトラッキング期間の時間単位を返します。 メトリックのトラッキング期間が月単位で、現在の時間単位が年である場合、戻り値は月です。

Service

サービスの名前を返します。

ServiceId

サービスの ID を返します。

Target

メトリックにターゲットがない場合、メトリックのターゲットまたは NULL を返します。

ThresholdRed

メトリックの［しきい値］タブで設定された、赤のしきい値を返します。 値が設定されなかった場合、-1 が返されます。

例：

Dim RedThreshold
RedThreshold = Context.ThresholdRed

ThresholdYellow

メトリックの［しきい値］タブで設定された、黄色のしきい値を返します。 値が設定されなかった場合、-1 が返されます。

例：

Dim YellowThreshold
YellowThreshold = Context.ThresholdYellow

TimeOfLastEvent

ビジネス ロジックに送信された最後のイベント（raw データとメトリック イベントの両方）の値を返します。 つまり、このプロパティへのコールが含まれる現在の行を実行する原因となったイベントのタイムスタンプを返します。 この値はイベント再利用性機能の一部です。

例：

Dim EventTime
EventTime = Context.TimeOfLastEvent

TimeSlot

タイムスロットの名前を返します。

TimeSlotId

タイムスロットの ID を返します。

TimeslotDescription

メトリックで使用するタイムスロットの説明を返します。 説明フィールドが空の場合、戻り値はタイムスロット名です。

TimeUnit

イベントがメトリックを生成した場合、このプロパティには計算の時間単位が含まれます。 この値には、「HOUR」、「DAY」、「WEEK」、「MONTH」、「QUARTER」、「YEAR」を設定できます。 また、この値は、アダプタがイベントを生成したことを意味する、空の文字列にもなりえます。