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

Context 对象

提供关于已计算度量标准的信息，如下所示：

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("单价")

返回一张在度量标准的详细信息页面中所定义“单价”表的图。 此图允许用户从业务逻辑用途表中查找价格值。 该图为“财务模块”功能的一部分。

示例：

Dim PPUMap
Set PPUMap = Context.Field("单价")

For Each element in map
   x = element
Next

Formula

返回公式的名称。

FormulaId

返回公式的 ID。

GetRegistrations

返回一张在运行时期间为您提供在当前计算度量标准中定义的注册列表的映射图。

注意：高级图只是用于保存实际保存注册信息的映射的容器。

示例：

Dim rMap
Set rMap = Context.GetRegistrations

HasService

返回指示当前度量标准是否具有关联服务的布尔值（某些度量标准类型（如 KPI）不具有服务）。 （该值为“无服务度量标准”功能的一部分。）

示例：

Dim WithService
WithService = Context.HasService

IntervalLength

生成事件的计算的间隔长度（采用在 TimeUnit 属性中找到的单位）。 如果事件由适配器生成，则此属性包含 0。 如果事件由度量标准而不是其跟踪期计算生成，则此属性的值始终为 1。 如果事件由度量标准的跟踪期生成，则其值为跟踪期中 TimeUnits 的数目。

IsInForecast

返回指示是否正在为度量标准的预测执行当前计算的布尔值。 （该值为“预测”功能的一部分。）

示例：

Dim Forecasting

Forecasting = Context.IsForecast

IsTargetDynamic

返回指示当前度量标准是否为动态的布尔值。 （该值为“动态目标”功能的一部分。）

示例：

Dim IsDynamic
IsDynamic = Context.IsTargetDynamic

IsTrackingPeriod

如果某些度量标准的跟踪期的计算发送事件，则该值为 true。 如果适配器发送事件，则该值为 false。

IsWithinTimeSlot

如果在度量标准的时间段中发生事件，则返回 True。

MainIndicator

返回当前度量标准主指标的值，如在度量标准的详细信息页面中所定义。 该值为“度量标准类型”功能的一部分。

示例：

Dim Indicator
Indicator = Context.MainIndicator

MainMode

如果 Exceptions Apply 或 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", #"1/1/2006 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

返回度量标准的跟踪期的时间单位。 如果度量标准的跟踪期是一个月，当前时间单位是年，则返回值是月。

服务

返回服务的名称。

ServiceId

返回服务的 ID。

目标

返回度量标准的目标；如果度量标准没有目标，则返回 null。

ThresholdRed

返回在度量标准的“阈值”选项卡中设置的红色阈值。 如果未设置值，则返回 -1。

示例：

Dim RedThreshold
RedThreshold = Context.ThresholdRed

ThresholdYellow

返回在度量标准的“阈值”选项卡中设置的黄色阈值。 如果未设置值，则返回 -1。

示例：

Dim YellowThreshold
YellowThreshold = Context.ThresholdYellow

TimeOfLastEvent

返回发送给业务逻辑的最后事件（原始数据和度量标准事件）的值。 换句话说，它返回导致执行当前行（包含对此属性的调用）的事件的时间戳。 该值为“事件可重用性”功能的一部分。

示例：

Dim EventTime
EventTime = Context.TimeOfLastEvent

时间段

返回时间段的名称。

TimeSlotId

返回时间段的 ID。

TimeslotDescription

返回度量标准使用的时间段的描述。 如果描述字段为空，则返回值为时间段名称。

TimeUnit

如果事件由度量标准生成，则此属性包含计算的时间单位。 该值可以是：“小时”、“天”、“周”、“月”、“季度”、“年”。 该值也可以是空字符串，这意味着事件由适配器生成。