Tópico anterior: Objetos de lógica de negócios

Próximo tópico: Objeto do evento

Objeto de contexto

Fornece informações sobre a métrica calculada, como segue:

ClusterItem

Retorna o nome do item de agrupamento atual (se a métrica atual estiver agrupada) ou uma sequência de caracteres vazia (se a métrica atual não estiver agrupada).

ClusterItemId

Retorna a ID do item de agrupamento atual (se a métrica atual estiver agrupada) ou 0 (se a métrica atual não estiver agrupada).

ClusterSize

Retorna o tamanho do agrupamento para métricas agrupadas. Se a métrica não estiver agrupada, 1 é retornado.

ConsumptionUnit

Retorna o nome da unidade de consumo da métrica atual, conforme definido na página de detalhes da métrica. A unidade é definida em Design, Entidades base, Unidades. Este valor pode ser deixado sem definição, caso em que uma sequência de caracteres vazia é retornada. Isso faz parte do recurso Tipos de métrica.

Exemplo:

Dim Unit
Unit = Context.ConsumptionUnit

ConsumptionUnitSymbol

Retorna o símbolo da unidade de medidas da métrica atual, conforme definido na página de detalhes da métrica. A unidade é definida em Design, Entidades base, Unidades. Este valor pode ser deixado sem definição, caso em que uma sequência de caracteres vazia é retornada. Isso faz parte do recurso Tipos de métrica.

Exemplo:

Dim Sym
Sym = Context.MeasurementUnitSymbol

Contrato

O nome do contrato que contém a métrica que gerou o evento. Se um conector gerou o evento, é retornada uma sequência de caracteres vazia.

ContractEffectiveFrom

Retorna a data a partir da qual o contrato (não somente a versão atual) estará vigente.

ContractEffectiveTo

Retorna a data até a qual o contrato (não somente a versão atual) estará vigente.

ContractId

A ID do contrato que contém a métrica que gerou o evento. Se foi um conector que gerou o evento, o valor da propriedade é 0.

ContractParty

O nome da parte contratual que possui o contrato. Este contrato contém a métrica que gerou o evento. Se um conector gerou o evento, é retornada uma sequência de caracteres vazia.

ContractPartyId

A ID da parte contratual que possui o contrato. Este contrato contém a métrica que gerou o evento. Se foi um conector que gerou o evento, o valor da propriedade é 0.

ContractType

Retorna o valor do tipo de contrato atual, conforme definido na página Geral da página Detalhes do contrato. (Esse valor faz parte do recurso De ponta a ponta.)

Exemplo:

Dim CType
CType = Context.ContractType

CorrectionsApply

Retorna Verdadeiro se o cálculo atual leva em conta correções.

CorrectionsFolded

Retorna Verdadeiro se não houver correções. O cálculo atual é executado para os modos WithCorrections e WithoutCorrections.

DomainCategoryRelation

Retorna a relação da categoria do domínio (NMT ou NLT), conforme definido nos detalhes da categoria do domínio para a métrica.

Dump

Retorna uma sequência de caracteres que contém o conteúdo do objeto de contexto em formato legível.

EntryPoint

Retorna o nome do último manipulador de eventos chamado no script de fora do script. Os valores possíveis incluem:

Qualquer outra função chamada como resultado de um evento.

ExceptionsApply

Retorna Verdadeiro se o cálculo atual leva em conta exceções.

ExceptionsFolded

Retorna Verdadeiro se não houver exceções. O cálculo atual é executado para os modos WithExceptions e WithoutExceptions.

Field("Price Per Unit")

Retorna um mapeamento da tabela Preço por unidade definida na página detalhes da métrica. Esse mapeamento permite ao usuário pesquisar preço na tabela para uso em lógica de negócios. Ele faz parte do módulo Finanças.

Exemplo:

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

Para cada elemento no mapa
   x = elemento
Next

Fórmula

Retorna o nome da fórmula.

FormulaId

Retorna a ID da fórmula.

GetRegistrations

Retorna um mapa de mapas que, durante o tempo de execução, fornece uma lista de registros definidos na métrica de cálculo atual.

Estrutura do método Context.GetRegistration

Observação: o mapa geral é apenas um recipiente contendo os mapas que, na verdade, detém as informações de registro.

Exemplo:

Dim rMap
Set rMap = Context.GetRegistrations

HasService

Retorna um valor booleano que determina se a métrica tem um serviço associado (alguns tipos de métrica, por exemplo, KPI, não têm serviço). (Esse valor faz parte do recurso de métricas sem serviço.)

Exemplo:

Dim WithService
WithService = Context.HasService

IntervalLength

A duração do intervalo (nas unidades localizadas na propriedade TimeUnit) do cálculo que gerou o evento. Se um conector gerou o evento, essa propriedade contém 0. Se uma métrica gerou o evento, e não o cálculo do período de monitoramento, o valor desta propriedade será sempre 1. Se o período de monitoramento da métrica gerou o evento, seu valor será o número de TimeUnits no período de monitoramento.

IsInForecast

Retorna um valor booleano que determina se o cálculo atual está sendo feito para a previsão da métrica. (Esse valor faz parte do recurso de previsão.)

Exemplo:

Dim Forecasting

Forecasting = Context.IsForecast

IsTargetDynamic

Retorna um valor booleano que determina se a métrica atual é dinâmica. Esse valor faz parte do recurso Destino dinâmico.

Exemplo:

Dim IsDynamic
IsDynamic = Context.IsTargetDynamic

IsTrackingPeriod

Se o cálculo do período de monitoramento de algumas métricas enviou o evento, o valor é true. Se o conector enviou o evento, o valor é false.

IsWithinTimeSlot

Retorna Verdadeiro se o evento tiver ocorrido durante o período de atividade da métrica.

MainIndicator

Retorna o valor da métrica Indicador principal atual, conforme definido na página de detalhes da métrica. Isso faz parte do recurso Tipos de métrica.

Exemplo:

Dim Indicator
Indicator = Context.MainIndicator

MainMode

Retorna Verdadeiro se Exceptions Apply ou ExceptionsFolded for Verdadeiro e CorrectionsApply ou CorrectionsFolded for Verdadeiro. Em outras palavras, o MainMode retorna Verdadeiro se o cálculo atual se aplica ao modo WithCorrections e WithExceptions.

MeasurementUnit

Retorna o nome da unidade de medida da métrica atual, conforme definido na página de detalhes da métrica. A unidade é definida em Design, Entidades base, Unidades. Se este valor for deixado sem definição, é retornada uma sequência de caracteres vazia. Isso faz parte do recurso Tipos de métrica.

Exemplo:

Dim Unit
Unit = Context.MeasurementUnit

MeasurementUnitSymbol

Retorna o símbolo da unidade de medidas da métrica atual, conforme definido na página de detalhes da métrica. A unidade é definida em Design, Entidades base, Unidades. Se este valor for deixado sem definição, é retornada uma sequência de caracteres vazia. Esse valor faz parte do recurso Tipos de métrica.

Exemplo:

Dim Sym
Sym = Context.MeasurementUnitSymbol

RegistrationTime

Retorna a última vez que o procedimento OnRegistration foi chamado.

Como o OnRegistration, ao contrário de outros manipuladores de eventos, não inclui um parâmetro de hora, use o RegistrationTime para obter a hora atual.

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

Os parâmetros fornecidos filtram a lista de recursos:

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

Semelhante a ResourcesOfType, exceto pelo fato de que retorna apenas os recursos aos quais estão conectados:

Exemplo:

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

ResourceDisplayNameById (resourceId)

Retorna o nome de exibição de um recurso para a ID de um determinado recurso.

Exemplo:

Dim resourceDisplayNameById
resourceDisplayNameById = context. resourceDisplayNameById(1000)

ResourceDisplayNameByName ("resourceName")

Retorna o nome de exibição de um recurso para o nome de um determinado recurso.

Exemplo:

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

ResourcesOfContractParty(<resourceType>)

Semelhante a ResourcesOfType, exceto pelo fato de que este método retorna apenas os recursos conectados à parte contratual do contrato atual.

ResourcesOfContractParty(resourceType, time)

Semelhante a ResourcesOfType, exceto pelo fato de que ele retorna apenas os recursos conectados à parte contratual do contrato atual na data e hora especificadas.

Exemplo:

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

ResourcesOfContractPartyAndService(<resourceType>)

Semelhante a ResourcesOfType, exceto pelo fato de que esse método retorna apenas os seguintes recursos:

ResourcesOfContractPartyAndService(resourceType, time)

Semelhante a ResourcesOfType, exceto pelo fato de que retorna apenas os seguintes recursos:

Exemplo:

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

ResourcesOfResourceGroup (resourceGroup, resourceType, time, DirectDescendantsOnly)

Semelhante a ResourcesOfType, exceto pelo fato de que retorna apenas os recursos conectados ao seguinte:

Exemplo:

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

ResourcesOfService (<resourceType>)

Semelhante a ResourcesOfType, exceto pelo fato de que este método retorna apenas os recursos conectados ao serviço do contrato atual no momento.

ResourcesOfService (<resourceGroup>, <resourceType>)

Semelhante a ResourcesOfType, exceto pelo fato de que este método retorna apenas os recursos contidos (direta e indiretamente) no grupo de recursos definidos no momento.

ResourcesOfService(resourceGroup, resourceType, time)

Semelhante a ResourcesOfType, exceto pelo fato de que ele retorna somente os recursos contidos (direta e indiretamente) no grupo de recursos definido na hora especificada.

Exemplo:

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

ResourcesOfService(resourceType, time)

Semelhante a ResourcesOfType, exceto pelo fato de que ele retorna apenas os recursos conectados ao serviço do contrato atual na data e hora especificadas.

Exemplo:

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

ResourcesOfType, ResourcesOfContractParty, ResourcesOfService, ResourcesOfResourceGroup, Resources, ResourcesOfContractPartyAndService

Todas essas funções têm um novo parâmetro opcional chamado hora. Se o parâmetro não estiver especificado, a hora atual será usada.

ResourceNameById

Retorna o nome de um recurso ou grupo de recursos para a ID de um recurso específico.

Exemplo:

Dim MyResourceName

MyResourceName = Context. ResourceNameById (1234)

ResourceIdByName

Retorna a ID do recurso ou grupo de recursos, com a ID especificada.

Exemplo:

Dim MyResourceId

MyResourceId = Context. ResourceIdByName (“MyResource”)

Regra

Retorna o nome da métrica.

RuleId

Retorna a ID da métrica.

RulePeriodTimeUnit

Retorna a unidade de tempo do período de monitoramento da métrica. Se o período de monitoramento da métrica for um mês e a unidade de tempo atual for um ano, o valor retornado será um mês.

Serviço

Retorna o nome do serviço.

ServiceId

Retorna a ID do serviço.

Destino

Retorna o objetivo da métrica ou nulo, se a métrica não tiver um objetivo.

ThresholdRed

Retorna o valor de limite vermelho que foi definido na guia Limites da métrica. Se nenhum valor tiver sido definido, -1 será retornado.

Exemplo:

Dim RedThreshold
RedThreshold = Context.ThresholdRed

ThresholdYellow

Retorna o valor de limite amarelo que foi definido na guia Limites da métrica. Se nenhum valor tiver sido definido, -1 será retornado.

Exemplo:

Dim YellowThreshold
YellowThreshold = Context.ThresholdYellow

TimeOfLastEvent

Retorna o valor do último evento (dados brutos e evento de métrica) enviado para a lógica de negócios. Em outras palavras, retorna a marca de data e hora do evento que causou a execução da linha atual que contém a chamada para esta propriedade. Esse valor faz parte do recurso Capacidade de reutilização do evento.

Exemplo:

Dim EventTime
EventTime = Context.TimeOfLastEvent

Período de atividade

Retorna o nome do período de atividade.

TimeSlotId

Retorna a ID do período de atividade.

TimeslotDescription

Retorna a descrição do período de atividade usado pela métrica. Se o campo de descrição estiver vazio, o valor retornado será o nome do período de atividade.

TimeUnit

Se o evento gerou a métrica, essa propriedade contém a unidade de tempo do cálculo. O valor pode ser “HOUR”, “DAY”, “WEEK”, “MONTH”, “QUARTER” ou “YEAR”. O valor também pode ser uma sequência de caracteres vazia, o que significa que um conector gerou o evento.