Anwenderhandbuch › Service Level-Management › Business-Logik-Umfang › Verwenden von Business-Logik › Business-Logik-Objekte › Context-Objekt

Context-Objekt

Liefert folgendermaßen Informationen zur berechneten Metrik:

ClusterItem

Gibt den Namen des aktuellen Cluster-Objekts (wenn die aktuelle Metrik geclustert ist) oder eine leere Zeichenfolge (wenn es sich nicht um eine geclusterte Metrik handelt) zurück.

ClusterItemId

Gibt die ID des aktuellen Cluster-Objekts (wenn die aktuelle Metrik geclustert ist) oder 0 (wenn es sich nicht um eine geclusterte Metrik handelt) zurück.

ClusterSize

Gibt die Größe des Clusters für geclusterte Metriken zurück. Wenn die Metrik nicht geclustert ist, dann wird 1 zurückgegeben.

ConsumptionUnit

Gibt den auf der Seite "Metrikdetails" definierten Namen der Verbrauchseinheit der aktuellen Metrik zurück. Die Einheit selbst wird unter "Design", "Basisentitäten", "Einheiten" festgelegt. Dieser Wert kann offen bleiben; in diesem Fall wird eine leere Zeichenfolge zurückgegeben. Dieser Wert ist Teil der Funktion "Metriktypen".

Beispiel:

Dim Unit
Unit = Context.ConsumptionUnit

ConsumptionUnitSymbol

Gibt das auf der Seite "Metrikdetails" definierte Symbol der Maßeinheit der aktuellen Metrik zurück. Die Einheit selbst wird unter "Design", "Basisentitäten", "Einheiten" festgelegt. Dieser Wert kann offen bleiben; in diesem Fall wird eine leere Zeichenfolge zurückgegeben. Dieser Wert ist Teil der Funktion "Metriktypen".

Beispiel:

Dim Sym
Sym = Context.MeasurementUnitSymbol

Vertrag

Der Name des Vertrags, der die Metrik enthält, die das Event generiert hat. Wenn das Event von einem Adapter generiert wurde, dann wird eine leere Zeichenfolge zurückgegeben.

ContractEffectiveFrom

Gibt das Datum zurück, ab dem der Vertrag (nicht nur in seiner aktuellen Version) gültig ist.

ContractEffectiveTo

Gibt das Datum zurück, bis zu dem der Vertrag (nicht nur in seiner aktuellen Version) gültig ist.

ContractId

Die Kennung des Vertrags, der die Metrik enthält, die das Event generiert hat. Wenn das Event von einem Adapter generiert wurde, dann ist der Eigenschaftswert 0.

ContractParty

Der Name der Vertragspartei, die Eigentümer des Vertrags ist. Dieser Vertrag enthält die Metrik, die das Event generiert hat. Wenn das Event von einem Adapter generiert wurde, dann wird eine leere Zeichenfolge zurückgegeben.

ContractPartyId

Die ID der Vertragspartei, die Eigentümer des Vertrags ist. Dieser Vertrag enthält die Metrik, die das Event generiert hat. Wenn das Event von einem Adapter generiert wurde, dann ist der Eigenschaftswert 0.

ContractType

Gibt den auf der Seite "Allgemein" der Seite "Vertragsdetails" vorgegebenen Wert des aktuellen Vertragstyps zurück. (Dieser Wert ist Teil der Funktion "Durchgängig").

Beispiel:

Dim CType
CType = Context.ContractType

CorrectionsApply

Gibt True zurück, wenn die aktuelle Berechnung Korrekturen berücksichtigt.

CorrectionsFolded

Gibt True zurück, wenn keine Korrekturen vorliegen. Die aktuelle Berechnung wird sowohl für den Modus WithCorrections als auch den Modus WithoutCorrections durchgeführt.

DomainCategoryRelation

Gibt die Domänenkategoriebeziehung (NMT oder NLT) für die Metrik zurück. Sie wird auf der Seite mit den Details für die Domänenkategorie festgelegt.

Dump

Gibt eine Zeichenfolge zurück, die den Inhalt des Context-Objekts in einem lesbaren Format enthält.

EntryPoint

Gibt den Namen des letzten Event-Handlers zurück, der im Skript und von außerhalb des Skripts aufgerufen wurde. Mögliche Werte sind:

• OnLoad
• OnRegistration
• OnPeriodStart
• OnTimeSlotEnter
• OnTimeSlotExit

Alle anderen Funktionen, die als Ergebnis eines Events aufgerufen wurden.

ExceptionsApply

Gibt True zurück, wenn die aktuelle Berechnung Ausnahmen berücksichtigt.

ExceptionsFolded

Gibt "True" zurück, wenn keine Ausnahmen vorliegen. Die aktuelle Berechnung wird sowohl für den Modus WithExceptions als auch den Modus WithoutExceptions durchgeführt.

Field("Price Per Unit")

Gibt eine Zuordnung der Tabelle "Preis pro Einheit" zurück, die auf der Seite "Metrikdetails" definiert ist. Diese Zuordnung ermöglicht es dem Anwender, Preise in der Tabelle nachzuschlagen, um sie in der Business-Logik zu verwenden. Diese Zuordnung ist Teil der Funktion "Finanzmodul".

Beispiel:

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

For Each element in map
   x = element
Next

Formula

Gibt den Namen der Formel zurück.

FormulaId

Gibt die ID der Formel zurück.

GetRegistrations

Gibt ein Verzeichnis mit Zuordnungen zurück, das Ihnen zur Laufzeit eine Liste der Registrierungen zur Verfügung stellt, die in der aktuellen Berechnungsmetrik definiert sind.

Hinweis: Die Zuordnung der oberen Ebene ist nichts weiter als ein "Behälter" für die Zuordnungen, welche die tatsächlichen Registrierungsinformationen enthalten.

Beispiel:

Dim rMap
Set rMap = Context.GetRegistrations

HasService

Gibt einen booleschen Wert zurück, der angibt, ob die aktuelle Metrik mit einem Service verknüpft ist (einige Metriktypen, z. B. "KPI", haben keinen Service). Dieser Wert ist Teil der Funktion "Metriken ohne Service".

Beispiel:

Dim WithService
WithService = Context.HasService

IntervalLength

Die Intervalllänge (in den in der TimeUnit-Eigenschaft gefundenen Einheiten) der Berechnung, die das Event generiert hat. Wenn das Event von einem Adapter generiert wurde, dann enthält diese Eigenschaft den Wert 0. Wenn das Event von einer Metrik generiert wurde, jedoch nicht durch die entsprechende Kontrollzeitraumberechnung, dann ist der Wert dieser Eigenschaft stets 1. Wurde das Event vom Kontrollzeitraum der Metrik generiert, ist der Wert gleich der Anzahl der Zeiteinheiten im Kontrollzeitraum.

IsInForecast

Gibt einen booleschen Wert zurück, der angibt, ob die aktuelle Berechnung für die Prognose der Metrik vorgenommen wird. Dieser Wert ist Teil der Funktion "Prognose".

Beispiel:

Dim Forecasting
Forecasting = Context.IsForecast

IsTargetDynamic

Gibt einen booleschen Wert zurück, der angibt, ob die aktuelle Metrik dynamisch ist. Dieser Wert ist Teil der Funktion "Dynamisches Ziel".

Beispiel:

Dim IsDynamic
IsDynamic = Context.IsTargetDynamic

IsTrackingPeriod

Wenn die Berechnung des Kontrollzeitraums einiger Metriken das Event gesendet haben, dann ist dieser Wert "true". Wenn der Adapter das Event gesendet hat, dann ist dieser Wert "false".

IsWithinTimeSlot

Gibt "True" zurück, wenn das Event innerhalb des Zeitfensters der Metrik eingetreten ist.

MainIndicator

Gibt den auf der Seite "Metrikdetails" definierten Wert des Hauptindikators der aktuellen Metrik zurück. Dieser Wert ist Teil der Funktion "Metriktypen".

Beispiel:

Dim Indicator
Indicator = Context.MainIndicator

MainMode

Gibt "True" zurück, wenn "ExceptionsApply" oder "ExceptionsFolded" und "CorrectionsApply" oder "CorrectionsFolded" zu "True" ausgewertet werden. Mit anderen Worten: "MainMode" gibt "True" zurück, wenn die aktuelle Berechnung sowohl für den Modus "WithCorrections" als auch für den Modus "WithExceptions" gilt.

MeasurementUnit

Gibt den auf der Seite "Metrikdetails" definierten Namen der Maßeinheit der aktuellen Metrik zurück. Die Einheit selbst wird unter "Design", "Basisentitäten", "Einheiten" festgelegt. Wenn dieser Wert nicht festgelegt wird, dann wird eine leere Zeichenfolge zurückgegeben. Dieser Wert ist Teil der Funktion "Metriktypen".

Beispiel:

Dim Unit
Unit = Context.MeasurementUnit

MeasurementUnitSymbol

Gibt das auf der Seite "Metrikdetails" definierte Symbol der Maßeinheit der aktuellen Metrik zurück. Die Einheit selbst wird unter "Design", "Basisentitäten", "Einheiten" festgelegt. Wenn dieser Wert nicht festgelegt wird, dann wird eine leere Zeichenfolge zurückgegeben. Dieser Wert ist Teil der Funktion "Metriktypen".

Beispiel:

Dim Sym
Sym = Context.MeasurementUnitSymbol

RegistrationTime

Gibt den letzten Zeitpunkt zurück, an dem die Prozedur OnRegistration aufgerufen wurde.

Da OnRegistration im Gegensatz zu anderen Event-Handlern keinen Zeitparameter enthält, müssen Sie zur Ermittlung der aktuellen Zeit RegistrationTime verwenden.

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

Die angegebenen Parameter filtern diese Liste der Ressourcen:

• Ist der Parameter resourceGroup angegeben, werden nur die Ressourcen aus dieser Gruppe zurückgegeben.
• Ist der Parameter resourceType angegeben, werden nur die Ressourcen dieses Typs zurückgegeben.
• Wenn ContractParty True ist, werden nur die Ressourcen zurückgegeben, die zur aktuellen Vertragspartei gehören.
• Wenn withService True ist, werden nur die Ressourcen zurückgegeben, die zum aktuellen Service gehören.

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

Ähnelt "ResourcesOfType", nur dass lediglich die Ressourcen zurückgegeben werden, zu denen Verknüpfung besteht:

• Die Ressourcengruppe
• Der Ressourcentyp der aktuellen Metrik des aktuellen Vertrags zur angegebenen Zeit.

• Ist der Parameter resourceGroup angegeben, werden nur die Ressourcen aus dieser Gruppe zurückgegeben.
• Ist der Parameter resourceType angegeben, werden nur die Ressourcen dieses Typs zurückgegeben.
• Wird der Parameter DirectDescendantsOnly auf True gesetzt, werden nur die direkten Abkömmlinge des aktuellen Objekts zurückgegeben.

Beispiel:

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

ResourceDisplayNameById (resourceId)

Gibt den Anzeigenamen einer Ressource für eine bestimmte Ressourcen-ID zurück.

Beispiel:

Dim resourceDisplayNameById
resourceDisplayNameById = context. resourceDisplayNameById(1000)

ResourceDisplayNameByName ("resourceName")

Gibt den Anzeigenamen einer Ressource für einen bestimmten Ressourcennamen zurück.

Beispiel:

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

ResourcesOfContractParty(<resourceType>)

Ähnelt "ResourcesOfType", nur dass diese Methode lediglich die Ressourcen zurückgibt, die derzeit mit der Vertragspartei des aktuellen Vertrags verbunden sind.

ResourcesOfContractParty(resourceType, time)

Entspricht "ResourcesOfType", außer dass nur die Ressourcen zurückgegeben werden, die zur angegebenen Zeit mit der Vertragspartei des aktuellen Vertrags verbunden sind.

Beispiel:

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

ResourcesOfContractPartyAndService(<resourceType>)

Ähnelt "ResourcesOfType", außer dass diese Methode nur folgende Ressourcen zurückgibt:

• Ressourcen, die mit dem Service der aktuellen Metrik verbunden sind.
• Die Vertragspartei des derzeit aktuellen Vertrags.

ResourcesOfContractPartyAndService(resourceType, time)

Ähnelt "ResourcesOfType", außer dass diese Methode nur folgende Ressourcen zurückgibt:

• Die Ressourcengruppe
• Der Ressourcentyp der aktuellen Regel zur angegebenen Zeit, wenn sie mit dem Service der aktuellen Regel verbunden sind.
• Die Vertragspartei des aktuellen Vertrags zur angegebenen Zeit.

Beispiel:

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

ResourcesOfResourceGroup (resourceGroup, resourceType, time, DirectDescendantsOnly)

Ähnelt "ResourcesOfType", außer dass diese Methode nur Ressourcen zurückgibt, die mit Folgendem verbunden sind:

• Die Ressourcengruppe
• Der Ressourcentyp der aktuellen Regel des aktuellen Vertrags zur angegebenen Zeit.

• Ist der Parameter resourceGroup angegeben, werden nur die Ressourcen aus dieser Gruppe zurückgegeben.
• Ist der Parameter resourceType angegeben, werden nur die Ressourcen dieses Typs zurückgegeben.
• Wird der Parameter DirectDescendantsOnly auf True gesetzt, werden nur die direkten Abkömmlinge des aktuellen Objekts zurückgegeben.

Beispiel:

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

ResourcesOfService (<resourceType>)

Ähnelt "ResourcesOfType", nur dass diese Methode lediglich die Ressourcen zurückgibt, die derzeit mit dem Service des aktuellen Vertrags verknüpft sind.

ResourcesOfService (<resourceGroup>, <resourceType>)

Ähnelt "ResourcesOfType", nur dass diese Methode lediglich die Ressourcen zurückgibt, die derzeit direkt oder indirekt in der definierten Ressourcengruppe enthalten sind.

ResourcesOfService(resourceGroup, resourceType, time)

Ähnelt ResourcesOfType, außer dass diese Methode lediglich die Ressourcen zurückgibt, die zur angegebenen Zeit (direkt oder indirekt) in der definierten Ressourcengruppe enthalten sind.

Beispiel:

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

ResourcesOfService(resourceType, time)

Entspricht "ResourcesOfType", außer dass nur die Ressourcen zurückgegeben werden, die zur angegebenen Zeit mit dem Service des aktuellen Vertrags verbunden sind.

Beispiel:

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

ResourcesOfType, ResourcesOfContractParty, ResourcesOfService, ResourcesOfResourceGroup, Resources, ResourcesOfContractPartyAndService

Diese Funktionen haben alle einen neuen optionalen Parameter: time (Zeit). Ist der Parameter nicht angegeben, wird die aktuelle Zeit benutzt.

• ResourcesOfType(resourceType, time)

  Gibt eine Zuordnungsgrafik von Ressourcenkennungen zurück. Jeder Eintrag in der zurückgegebenen Zuordnungsgrafik enthält den Schlüssel und den Wert, die für die Ressourcenkennung definiert sind.

  • Wenn der Parameter "resourceType" angegeben ist, dann gibt diese Methode folgende Ressourcen zurück:
    • Alle Ressourcen, die vorhanden und zur angezeigten Zeit mit einem bestimmten Ressourcentyp verbunden sind.
  • Wenn der Parameter "resourceType" angegeben ist, dann gibt diese Methode eine Liste folgender Ressourcen:
    • Alle Ressourcen, die zur angegebenen Zeit vorhanden sind.
  • Ist der Parameter nicht angegeben, wird die aktuelle Zeit benutzt.

  Beispiel:

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

• ResourcesOfContractParty(resourceType, time)

  Entspricht "ResourcesOfType", außer dass nur die Ressourcen zurückgegeben werden, die zur angegebenen Zeit mit der Vertragspartei des aktuellen Vertrags verbunden sind.

  Beispiel:

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

• ResourcesOfService(resourceType, time)

  Entspricht "ResourcesOfType", außer dass nur die Ressourcen zurückgegeben werden, die zur angegebenen Zeit mit dem Service des aktuellen Vertrags verbunden sind.

  Beispiel:

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

• ResourcesOfService(resourceGroup, resourceType, time)

  Ähnelt ResourcesOfType, außer dass diese Methode lediglich die Ressourcen zurückgibt, die zur angegebenen Zeit (direkt oder indirekt) in der definierten Ressourcengruppe enthalten sind.

  Beispiel:

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

• ResourcesOfContractPartyAndService(resourceType, time)

  Ähnelt "ResourcesOfType", außer dass diese Methode nur Ressourcen zurückgibt, die mit dem Service verbunden sind:

  • Von der aktuellen Regel
  • Von der Vertragspartei des aktuellen Vertrags zur angegebenen Zeit.

  Beispiel:

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

• ResourcesOfResourceGroup (resourceGroup, resourceType, time, DirectDescendantsOnly)

  Ähnelt "ResourcesOfType", außer dass diese Methode nur Ressourcen zurückgibt, die mit Folgendem verbunden sind:

  • Mit der Ressourcengruppe
  • Mit dem Ressourcentyp
  • Von der aktuellen Regel
  • Vom aktuellen Vertrag zur angegebenen Zeit.
  • Ist der Parameter resourceGroup angegeben, werden nur die Ressourcen aus dieser Gruppe zurückgegeben.
  • Ist der Parameter resourceType angegeben, werden nur die Ressourcen dieses Typs zurückgegeben.
  • Wird der Parameter DirectDescendantsOnly auf True gesetzt, werden nur die direkten Abkömmlinge des aktuellen Objekts zurückgegeben.

  Beispiel:

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

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

  Die angegebenen Parameter filtern diese Liste der Ressourcen:

  • Ist der Parameter resourceGroup angegeben, werden nur die Ressourcen aus dieser Gruppe zurückgegeben.
  • Ist der Parameter resourceType angegeben, werden nur die Ressourcen dieses Typs zurückgegeben.
  • Wenn ContractParty True ist, werden nur die Ressourcen zurückgegeben, die zur aktuellen Vertragspartei gehören.
  • Wenn withService True ist, werden nur die Ressourcen zurückgegeben, die zum aktuellen Service gehören.
  • Wenn die Zeit angegeben ist, wird die Liste für das angegebene Datum erstellt. Ist der Parameter nicht angegeben, wird die aktuelle Zeit benutzt.

  Beispiel:

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

ResourceNameById

Gibt den Namen einer Ressource oder Ressourcengruppe für eine bestimmte Ressourcen-ID zurück.

Beispiel:

Dim MyResourceName
MyResourceName = Context. ResourceNameById (1234)

ResourceIdByName

Gibt die ID für die Ressource oder Ressourcengruppe mit der angegebenen ID zurück.

Beispiel:

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

Regel

Gibt den Namen der Metrik zurück.

RuleId

Gibt die Kennung der Metrik zurück.

RulePeriodTimeUnit

Gibt die Zeiteinheit des Kontrollzeitraums der Metrik zurück. Wenn der Kontrollzeitraum der Metrik ein Monat ist und die aktuelle Zeiteinheit ein Jahr, dann ist der zurückgegebene Wert ein Monat.

Service

Gibt den Namen des Service zurück.

ServiceId

Gibt die Kennung des Service zurück.

Target (Ziel)

Gibt das Ziel der Metrik oder Null zurück, wenn kein Ziel für die Metrik definiert wurde.

ThresholdRed

Gibt den roten Grenzwert zurück, der auf der Registerkarte "Grenzwert" der Metrik eingetragen wurde. Wurde kein Wert eingestellt, wird -1 zurückgegeben.

Beispiel:

Dim RedThreshold
RedThreshold = Context.ThresholdRed

ThresholdYellow

Gibt den gelben Grenzwert zurück, der auf der Registerkarte "Grenzwert" der Metrik eingetragen wurde. Wurde kein Wert eingestellt, wird -1 zurückgegeben.

Beispiel:

Dim YellowThreshold
YellowThreshold = Context.ThresholdYellow

TimeOfLastEvent

Gibt den Wert des letzten zur Business-Logik gesendeten Events (sowohl Rohdaten- als auch Metrik-Event) zurück. Mit anderen Worten: Zurückgegeben wird der Zeitstempel des Events, das die Ausführung der aktuellen Zeile mit dem Aufruf dieser Eigenschaft verursachte. Dieser Wert ist Teil der Funktion "Event-Wiederverwendung".

Beispiel:

Dim EventTime
EventTime = Context.TimeOfLastEvent

Zeitfenster

Gibt den Namen des Zeitfensters zurück.

TimeSlotId

Gibt die Kennung des Zeitfensters zurück.

TimeslotDescription

Gibt die Beschreibung des von der Metrik verwendeten Zeitfensters zurück. Wenn das Beschreibungsfeld leer ist, ist der zurückgegebene Wert der Zeitfenstername.

TimeUnit

Wenn das Event von der Metrik generiert wurde, dann enthält diese Eigenschaft die Zeiteinheit der Berechnung. Dieser Wert kann wie folgt lauten: "HOUR" (Stunde), "DAY" (Tag), "WEEK" (Woche), "MONTH" (Monat), "QUARTER" (Quartal), "YEAR" (Jahr). Dieser Wert kann auch eine leere Zeichenfolge sein, was bedeutet, dass das Event von einem Adapter generiert wurde.