Guía del usuario › Gestión del nivel de servicio › Ámbito de la lógica de negocios › Uso de la lógica de negocios › Objetos de lógica de negocios › Context Object

Context Object

Ofrece información acerca de la métrica calculada, como la siguiente:

ClusterItem

Devuelve el nombre del elemento de clúster actual (si la métrica actual está agrupada) o una cadena vacía (si la métrica actual no está agrupada).

ClusterItemId

Devuelve el ID del elemento de clúster actual (si la métrica actual está agrupada) o 0 (si la métrica actual no está agrupada).

ClusterSize

Devuelve el tamaño del clúster para métricas en clúster. Si la métrica no se agrupa, devuelve 1.

ConsumptionUnit

Devuelve el nombre de la unidad de consumo de la métrica actual, según esté definida en la página de detalles de la métrica. La unidad misma se define en Diseño, Entidades de la fundación, Unidades. Este valor puede dejarse sin definir, en cuyo caso devolverá una cadena vacía. Este valor forma parte de la función Tipos de métrica.

Ejemplo:

Dim Unit
Unit = Context.ConsumptionUnit

ConsumptionUnitSymbol

Devuelve el símbolo de la unidad de medida de la métrica actual, según esté definida en la página de detalles de la métrica. La unidad misma se define en Diseño, Entidades de la fundación, Unidades. Este valor puede dejarse sin definir, en cuyo caso devolverá una cadena vacía. Este valor forma parte de la función Tipos de métrica.

Ejemplo:

Dim Sym
Sym = Context.MeasurementUnitSymbol

Contrato

El nombre del contrato que contiene la métrica que generó el evento. Si el evento lo genera un adaptador, se devuelve una cadena vacía.

ContractEffectiveFrom

Devuelve la fecha a partir de la cual el contrato (no solamente la versión actual) está vigente.

ContractEffectiveTo

Devuelve la fecha hasta la cual el contrato (no solamente la versión actual) está vigente.

ContractId

El ID del contrato que contiene la métrica que generó el evento. Si el evento lo genera un adaptador, el valor de la propiedad es 0.

ContractParty

El nombre de la parte contratante que posee el contrato. Este contrato contiene la métrica que generó el evento. Si el evento lo genera un adaptador, se devuelve una cadena vacía.

ContractPartyId

El ID de la parte contratante que posee el contrato. Este contrato contiene la métrica que generó el evento. Si el evento lo genera un adaptador, el valor de la propiedad es 0.

ContractType

Devuelve el valor del tipo de contrato actual, como está definido en la página General de la página Detalles del contrato. (Este valor es parte de la función Integral).

Ejemplo:

Dim CType
CType = Context.ContractType

CorrectionsApply

Devuelve True si el cálculo actual tiene en cuenta las correcciones.

CorrectionsFolded

Devuelve True si no hay ninguna corrección. El cálculo actual se realiza para los modos WithCorrections y WithoutCorrections.

DomainCategoryRelation

Devuelve la relación de la categoría del dominio (NMT o NLT), como aparece definida en los detalles de categoría del dominio, para la métrica.

Dump

Devuelve una cadena que contiene el objeto de contexto en un formato legible.

EntryPoint

Devuelve el nombre del último identificador de eventos llamado en el script, desde fuera del script. Entre los posibles valores, se incluyen:

• OnLoad
• OnRegistration
• OnPeriodStart
• OnTimeSlotEnter
• OnTimeSlotExit

Cualquier otra función llamada como resultado de un evento.

ExceptionsApply

Devuelve True si el cálculo actual tiene en cuenta las excepciones.

ExceptionsFolded

Devuelve True si no hay ninguna excepción. El cálculo actual se realiza para los modos WithExceptions y WithoutExceptions.

Field("Price Per Unit")

Devuelve una asignación de la tabla de precio por unidad que se define en la página de detalles de la métrica. Esta asignación permite al usuario buscar valores de precios de la tabla para utilizar la lógica de negocios. Esta asignación forma parte de la función de módulo financiero.

Ejemplo:

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

For Each element in map
   x = element
Next

Fórmula

Devuelve el nombre de la fórmula.

FormulaId

Devuelve el ID de la fórmula.

GetRegistrations

Devuelve una asignación de asignaciones que durante el tiempo de ejecución, le ofrece una lista de los registros definidos en la métrica de cálculo actual.

Nota: La asignación de nivel alto es solamente un contenedor que conserva las asignaciones que realmente contienen la información de registro.

Ejemplo:

Dim rMap
Set rMap = Context.GetRegistrations

HasService

Devuelve un booleano si la métrica actual tiene un servicio asociado (algunos tipos de métrica, como el indicador clave de rendimiento, no tienen ningún servicio). (Este valor forma parte de la función Métricas sin servicios).

Ejemplo:

Dim WithService
WithService = Context.HasService

IntervalLength

La longitud del intervalo (en las unidades que se encuentran en la propiedad TimeUnit) del cálculo que generó el evento. Si el evento lo genera un adaptador, el valor de la propiedad es 0. Si el evento lo generó una métrica, pero no por su cálculo de período de seguimiento, el valor de la propiedad siempre es 1. Si el evento lo generó el período de seguimiento de la métrica, su valor es el número de TimeUnit del período de seguimiento.

IsInForecast

Devuelve un booleano si el cálculo actual se realiza para la previsión de la métrica. (Este valor forma parte de la función Previsión).

Ejemplo:

Dim Forecasting
Forecasting = Context.IsForecast

IsTargetDynamic

Devuelve un booleano si la métrica actual es dinámica. Este valor forma parte de la función Destino dinámico.

Ejemplo:

Dim IsDynamic
IsDynamic = Context.IsTargetDynamic

IsTrackingPeriod

Si el cálculo del período de seguimiento de alguna métrica envió el evento, el valor es verdadero. Si el adaptador envió el evento, el valor es falso.

IsWithinTimeSlot

Devuelve True si el evento se produjo durante la ranura de tiempo de la métrica.

MainIndicator

Devuelve el valor actual del indicador principal de la métrica, según esté definida en la página de detalles de la métrica. Este valor forma parte de la función Tipos de métrica.

Ejemplo:

Dim Indicator
Indicator = Context.MainIndicator

MainMode

Devuelve True si ExceptionsApply o ExceptionsFolded son True y CorrectionsApply o CorrectionsFolded son True. Dicho de otra manera, MainMode devuelve True si el cálculo actual se aplica tanto al modo WithCorrections como al modo WithExceptions.

MeasurementUnit

Devuelve el nombre de la unidad de medida de la métrica actual, según esté definida en la página de detalles de la métrica. La unidad misma se define en Diseño, Entidades de la fundación, Unidades. Si no se establece este valor, devolverá una cadena vacía. Este valor forma parte de la función Tipos de métrica.

Ejemplo:

Dim Unit
Unit = Context.MeasurementUnit

MeasurementUnitSymbol

Devuelve el símbolo de la unidad de medida de la métrica actual, según esté definida en la página de detalles de la métrica. La unidad misma se define en Diseño, Entidades de la fundación, Unidades. Si no se establece este valor, devolverá una cadena vacía. Este valor forma parte de la función Tipos de métrica.

Ejemplo:

Dim Sym
Sym = Context.MeasurementUnitSymbol

RegistrationTime

Devuelve la última vez que se llamó al procedimiento OnRegistration.

Ya que OnRegistration, a diferencia de los demás controladores de eventos, no incluye ningún parámetro de hora, utilice RegistrationTime para obtener la hora actual.

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

Los parámetros proporcionados filtran esta lista de recursos:

• Si se proporciona el parámetro de resourceGroup, solamente se devuelven los recursos de este grupo.
• Si se proporciona el parámetro de resourceType, solamente se devuelven los recursos de este tipo.
• Si withContractParty es True, se devuelven solamente los recursos que pertenecen a la parte contratante actual.
• Si withService es True, se devuelven solamente los recursos que pertenecen al servicio actual.

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

Parecido a ResourcesOfType, salvo que solamente devuelve aquellos recursos a los cuales se conectan:

• Ser el grupo de recursos.
• El tipo de recurso de la métrica actual del contrato actual en el tiempo especificado.

• Si se proporciona el parámetro de resourceGroup, solamente se devuelven los recursos de este grupo.
• Si se proporciona el parámetro de resourceType, solamente se devuelven los recursos de este tipo.
• Si el parámetro DirectDescendantsOnly se especifica como True, solamente se devuelven los descendientes directos del objeto actual.

Ejemplo:

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

ResourceDisplayNameById (resourceId)

Devuelve el nombre para mostrar de un recurso para un ID de recurso determinado.

Ejemplo:

Dim resourceDisplayNameById
resourceDisplayNameById = context. resourceDisplayNameById(1000)

ResourceDisplayNameByName ("resourceName")

Devuelve el nombre para mostrar de un recurso para un nombre de recurso determinado.

Ejemplo:

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

ResourcesOfContractParty(<resourceType>)

Parecido a ResourcesOfType, salvo por el hecho de que este método devuelve solamente los recursos conectados a la parte contratante del contrato actual en ese momento.

ResourcesOfContractParty(resourceType, time)

Parecido a ResourcesOfType, salvo por el hecho de que devuelve solamente aquellos recursos conectados a la parte contratante del contrato actual en el momento especificado.

Ejemplo:

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

ResourcesOfContractPartyAndService(<resourceType>)

Parecido a ResourcesOfType, salvo que este método devuelve solamente aquellos recursos que cumplen lo siguiente:

• Estar conectado al servicio de la métrica actual.
• Ser la parte contratante del contrato actual en ese momento.

ResourcesOfContractPartyAndService(resourceType, time)

Parecido a ResourcesOfType, salvo que devuelve solamente aquellos recursos que cumplen lo siguiente:

• Ser el grupo de recursos.
• Ser el tipo de recurso de la regla actual en el tiempo especificado en que se conectan al servicio de la regla actual.
• Ser la parte contratante del contrato actual en el tiempo especificado.

Ejemplo:

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

ResourcesOfResourceGroup (resourceGroup, resourceType, time, DirectDescendantsOnly)

Parecido a ResourcesOfType, salvo que devuelve solamente aquellos recursos que están conectados con lo siguiente:

• El grupo de recursos.
• El tipo de recurso de la regla actual del contrato actual en el tiempo especificado.

• Si se proporciona el parámetro de resourceGroup, solamente se devuelven los recursos de este grupo.
• Si se proporciona el parámetro de resourceType, solamente se devuelven los recursos de este tipo.
• Si el parámetro DirectDescendantsOnly se especifica como True, solamente se devuelven los descendientes directos del objeto actual.

Ejemplo:

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

ResourcesOfService (<resourceType>)

Parecido a ResourcesOfType, salvo por el hecho de que este método devuelve solamente aquellos recursos conectados al servicio del contrato actual en ese momento.

ResourcesOfService (<resourceGroup>, <resourceType>)

Parecido a ResourcesOfType, salvo por el hecho de que este método devuelve solamente aquellos recursos contenidos (tanto directa como indirectamente) en el grupo de recursos definidos en este momento.

ResourcesOfService(resourceGroup, resourceType, time)

Similar a ResourcesOfType, salvo por el hecho de que devuelve solamente los recursos contenidos (tanto directa como indirectamente) en el grupo de recursos definidos en un momento especificado.

Ejemplo:

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

ResourcesOfService(resourceType, time)

Parecido a ResourcesOfType, salvo por el hecho de que devuelve solamente los recursos conectados al servicio del contrato actual en el momento especificado.

Ejemplo:

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

ResourcesOfType, ResourcesOfContractParty, ResourcesOfService, ResourcesOfResourceGroup, Resources, ResourcesOfContractPartyAndService

Todas estas funciones tienen un nuevo parámetro opcional llamado time. Si no se especifica el parámetro, se utiliza la hora actual.

• ResourcesOfType(resourceType, time)

  Devuelve una asignación de ID del recurso. Cada entrada de la asignación devuelta incluye la clave y el valor establecido en el ID de recurso.

  • Si se proporciona un parámetro de resourceType, este método devuelve todos los recursos:
    • Que existen y se conectan al tipo de recurso dado en el tiempo mostrado.
  • Si se proporciona un parámetro de resourceType, este método, devuelve una lista de todos los recursos:
    • Que existen en el tiempo especificado.
  • Si no se especifica el parámetro de hora, se utiliza la hora actual.

  Ejemplo:

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

• ResourcesOfContractParty(resourceType, time)

  Parecido a ResourcesOfType, salvo por el hecho de que devuelve solamente aquellos recursos conectados a la parte contratante del contrato actual en el momento especificado.

  Ejemplo:

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

• ResourcesOfService(resourceType, time)

  Parecido a ResourcesOfType, salvo por el hecho de que devuelve solamente los recursos conectados al servicio del contrato actual en el momento especificado.

  Ejemplo:

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

• ResourcesOfService(resourceGroup, resourceType, time)

  Similar a ResourcesOfType, salvo por el hecho de que devuelve solamente los recursos contenidos (tanto directa como indirectamente) en el grupo de recursos definidos en un momento especificado.

  Ejemplo:

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

• ResourcesOfContractPartyAndService(resourceType, time)

  Parecido a ResourcesOfType, salvo que devuelve solamente aquellos recursos que están conectados al servicio:

  • De la regla actual.
  • De la parte contratante del contrato actual en el tiempo especificado.

  Ejemplo:

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

• ResourcesOfResourceGroup (resourceGroup, resourceType, time, DirectDescendantsOnly)

  Parecido a ResourcesOfType, salvo que devuelve solamente aquellos recursos que están conectados con lo siguiente:

  • Al grupo de recursos.
  • Al tipo de recurso.
  • De la regla actual.
  • Del contrato actual en el tiempo especificado.
  • Si se proporciona el parámetro de resourceGroup, solamente se devuelven los recursos de este grupo.
  • Si se proporciona el parámetro de resourceType, solamente se devuelven los recursos de este tipo.
  • Si el parámetro DirectDescendantsOnly se especifica como True, solamente se devuelven los descendientes directos del objeto actual.

  Ejemplo:

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

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

  Los parámetros proporcionados filtran esta lista de recursos en los casos siguientes:

  • Si se proporciona el parámetro de resourceGroup, solamente se devuelven los recursos de este grupo.
  • Si se proporciona el parámetro de resourceType, solamente se devuelven los recursos de este tipo.
  • Si withContractParty es True, se devuelven solamente los recursos que pertenecen a la parte contratante actual.
  • Si withService es True, se devuelven solamente los recursos que pertenecen al servicio actual.
  • Si se define la hora, la lista se crea para la fecha indicada. Si no se proporciona, se utiliza la hora actual.

  Ejemplo:

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

ResourceNameById

Devuelve el nombre de un recurso o un grupo de recursos para un ID de recurso específico.

Ejemplo:

Dim MyResourceName
MyResourceName = Context. ResourceNameById (1234)

ResourceIdByName

Devuelve el ID del recurso o grupo de recursos, con el ID especificado.

Ejemplo:

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

Regla

Devuelve el nombre de la métrica.

RuleId

Devuelve el ID de la métrica.

RulePeriodTimeUnit

Devuelve la unidad de tiempo del período de seguimiento de la métrica. Si el período de seguimiento de la métrica es un mes y la unidad de tiempo actual es un año, el valor devuelto es un mes.

Servicio

Devuelve el nombre del servicio.

ServiceId

Devuelve el ID del servicio.

Destino

Devuelve el destino de la métrica o nulo si la métrica no tiene ningún destino.

ThresholdRed

Devuelve el valor del umbral rojo que se estableció en la ficha Umbrales de la métrica. Si no se ha establecido ningún valor, se devuelve -1.

Ejemplo:

Dim RedThreshold
RedThreshold = Context.ThresholdRed

ThresholdYellow

Devuelve el valor del umbral amarillo que se estableció en la ficha Umbrales de la métrica. Si no se ha establecido ningún valor, se devuelve -1.

Ejemplo:

Dim YellowThreshold
YellowThreshold = Context.ThresholdYellow

TimeOfLastEvent

Devuelve el valor del último evento (tanto datos sin procesar como eventos de métrica) que se envió a la lógica de negocios. Dicho de otra forma, devuelve la marca de tiempo del evento que provocó la ejecución de la línea actual que contiene la llamada a esta propiedad. Este valor forma parte de la función Reutilización de evento.

Ejemplo:

Dim EventTime
EventTime = Context.TimeOfLastEvent

TimeSlot

Devuelve el nombre de la ranura de tiempo.

TimeSlotId

Devuelve el ID de la ranura de tiempo.

TimeslotDescription

Devuelve la descripción de la ranura de tiempo que utiliza la métrica. Si el campo de descripción está vacío, el valor devuelto es el nombre de la ranura de tiempo.

TimeUnit

Si el evento generaba la métrica, esta propiedad contiene la unidad de tiempo del cálculo. Este valor puede ser: “HORA”, “DÍA”, “SEMANA”, “MES”, “TRIMESTRE” o “AÑO”. También puede ser una cadena vacía, lo que significa que el evento lo generó un adaptador.