Manuel de l'utilisateur › Gestion du niveau de service › Cadre de logique applicative › Utilisation de la logique applicative › Objets de logique applicative › Objet Context

Objet Context

Cet objet fournit des informations sur la métrique calculée, comme suit :

ClusterItem

Renvoie le nom de l'élément de groupe actuel (si la métrique actuelle est groupée) ou une chaîne vide (si la métrique n'est pas groupée).

ClusterItemId

Renvoie l'identifiant de l'élément de groupe actuel (si la métrique actuelle est groupée) ou 0 (si la métrique n'est pas groupée).

ClusterSize

Renvoie la taille du groupe des métriques groupées. Si la métrique n'est pas groupée, 1 sera renvoyée.

ConsumptionUnit

Renvoie le nom de l'unité de consommation de la métrique actuelle, tel que défini dans la page Détails de la métrique. L'unité proprement dite est définie sous Conception, Entités Foundation, Unités. Il n'est pas nécessaire de définir cette valeur. Une chaîne vide sera alors renvoyée. Cette valeur est intégrée à la fonction Types de métrique.

Exemple :

Dim Unit
Unit = Context.ConsumptionUnit

ConsumptionUnitSymbol

Renvoie le symbole de l'unité de consommation de la métrique actuelle, tel que défini dans la page Détails de la métrique. L'unité proprement dite est définie sous Conception, Entités Foundation, Unités. Il n'est pas nécessaire de définir cette valeur. Une chaîne vide sera alors renvoyée. Cette valeur est intégrée à la fonction Types de métrique.

Exemple :

Dim Sym
Sym = Context.MeasurementUnitSymbol

Contrat

Nom du contrat contenant la métrique qui a généré l'événement. Si un adaptateur a généré l'événement, une chaîne vide sera renvoyée.

ContractEffectiveFrom

Renvoie la date à partir de laquelle le contrat (et pas seulement la version actuelle) entre en vigueur.

ContractEffectiveTo

Renvoie la date jusqu'à laquelle le contrat (et pas seulement la version actuelle) est en vigueur.

ContractId

Identifiant du contrat contenant la métrique qui a généré l'événement. Si un adaptateur a généré l'événement, la valeur de la propriété sera 0.

ContractParty

Nom du contractant qui détient le contrat. Ce contrat contient la métrique qui a généré l'événement. Si un adaptateur a généré l'événement, une chaîne vide sera renvoyée.

ContractPartyId

ID du contractant qui détient le contrat. Ce contrat contient la métrique qui a généré l'événement. Si un adaptateur a généré l'événement, la valeur de la propriété sera 0.

ContractType

Renvoie la valeur du type de contrat actuel, telle qu'elle a été définie sur la page générale des détails du contrat. Cette valeur appartient à la fonction De bout en bout.

Exemple :

Dim CType
CType = Context.ContractType

CorrectionsApply

Renvoie la valeur True si le calcul actuel tient compte des corrections.

CorrectionsFolded

Renvoie la valeur True s'il n'y a aucune correction. Le calcul actuel est exécuté en mode WithCorrections et WithoutCorrections.

DomainCategoryRelation

Renvoie la relation de catégorie de domaine (NMT ou NLT), comme définie dans les détails de catégorie de domaine, pour la métrique.

Dump

Renvoie une chaîne contenant le contenu de l'objet Context dans un format lisible.

EntryPoint

Renvoie le nom du dernier gestionnaire d'événements appelé dans le script. Les valeurs possibles comprennent notamment:

• OnLoad
• OnRegistration
• OnPeriodStart
• OnTimeSlotEnter
• OnTimeSlotExit

Toute autre fonction appelée en tant que résultat d'un événement.

ExceptionsApply

Renvoie la valeur True si le calcul actuel tient compte des exceptions.

ExceptionsFolded

Renvoie la valeur True s'il n'y a aucune exception. Le calcul actuel est exécuté en mode WithExceptions et WithoutExceptions.

Field("Prix par unité")

Renvoie un plan de la table Prix par unité, définie dans la page Détails de la métrique. Ce plan permet à l'utilisateur de rechercher les valeurs de prix dans la table pour les utiliser au niveau de la logique applicative. Il appartient à la fonction Module financier.

Exemple :

Dim PPUMap
Set PPUMap = Context.Field("Prix par unité")

For Each element in map
   x = element
Next

Formula

Renvoie le nom de la formule.

FormulaId

Renvoie l'identifiant de la formule.

GetRegistrations

Lors de l'exécution, renvoie un mappage des plans qui fournit une liste des enregistrements définis dans la métrique de calcul actuelle.

Remarque : Le plan de niveau supérieur constitue uniquement un conteneur qui contient les plans contenant les informations d'enregistrement.

Exemple :

Dim rMap
Set rMap = Context.GetRegistrations

HasService

Renvoie une valeur booléenne indiquant si un service est associé à la métrique actuelle (certains types de métrique comme l'indicateur clé de performance ne possèdent pas de service). Cette valeur est intégrée à la fonction Métriques sans service.

Exemple :

Dim WithService
WithService = Context.HasService

IntervalLength

Longueur de l'intervalle (conformément aux unités présentes dans la propriété TimeUnit) du calcul qui a généré l'événement. Si un adaptateur a généré l'événement, cette propriété contiendra 0. S'il a été généré par une métrique, non par le calcul de sa période de suivi, la valeur de cette propriété sera toujours 1. S'il a été généré par la période de suivi de la métrique, sa valeur correspondra au nombre de TimeUnits contenues dans la période de suivi.

IsInForecast

Renvoie une valeur booléenne indiquant si le calcul actuel est exécuté pour la prévision de la métrique. Cette valeur est intégrée à la fonction Prévision.

Exemple :

Dim Forecasting

Forecasting = Context.IsForecast

IsTargetDynamic

Renvoie un booléen indiquant si la métrique actuelle est dynamique. Cette valeur est intégrée à la fonction Cible dynamique.

Exemple :

Dim IsDynamic
IsDynamic = Context.IsTargetDynamic

IsTrackingPeriod

Si le calcul de la période de suivi d'une métrique a envoyé l'événement, cette valeur sera True. Si l'adaptateur a envoyé l'événement, cette valeur sera False.

IsWithinTimeSlot

Renvoie True si l'événement s'est produit pendant la période d'application de la métrique.

MainIndicator

Renvoie la valeur de l'indicateur principal de métrique actuel, telle que définie dans la page Détails de la métrique. Cette valeur est intégrée à la fonction Types de métrique.

Exemple :

Dim Indicator
Indicator = Context.MainIndicator

MainMode

Renvoie True si la valeur de Exceptions Apply ou de ExceptionsFolded, ou de CorrectionsApply ou CorrectionsFolded est True. En d'autres termes, MainMode renvoie la valeur True si le calcul actuel s'applique aux modes WithCorrections et WithExceptions.

MeasurementUnit

Renvoie le nom de l'unité de mesure de la métrique actuelle, tel que défini dans la page Détails de la métrique. L'unité proprement dite est définie sous Conception, Entités Foundation, Unités. Si cette valeur n'est pas définie, une chaîne vide sera renvoyée. Cette valeur est intégrée à la fonction Types de métrique.

Exemple :

Dim Unit
Unit = Context.MeasurementUnit

MeasurementUnitSymbol

Renvoie le symbole de l'unité de consommation de la métrique actuelle, tel que défini dans la page Détails de la métrique. L'unité proprement dite est définie sous Conception, Entités Foundation, Unités. Si cette valeur n'est pas définie, une chaîne vide sera renvoyée. Cette valeur est intégrée à la fonction Types de métrique.

Exemple :

Dim Sym
Sym = Context.MeasurementUnitSymbol

RegistrationTime

Renvoie la dernière heure à laquelle la procédure OnRegistration a été appelée.

Comme OnRegistration, contrairement aux autres gestionnaires d'événement, ne comprend pas de paramètre temporel, utilisez RegistrationTime pour obtenir l'heure actuelle.

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

Les paramètres fournis filtrent cette liste de ressources :

• Si le paramètre resourceGroup est fourni, seules les ressources de ce groupe sont renvoyées.
• Si le paramètre resourceType est fourni, seules les ressources de ce type sont renvoyées.
• Si withContractParty a la valeur True, seules les ressources appartenant au contractant actuel sont renvoyées.
• Si withService a la valeur True, seules les ressources appartenant au service actuel sont renvoyées.

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

Similaire à ResourcesOfType, hormis le fait que seules les ressources auxquelles ils sont reliés sont renvoyées :

• Groupe de ressources
• Type de ressource de la métrique actuelle du contrat actuel à l'heure spécifiée

• Si le paramètre resourceGroup est fourni, seules les ressources de ce groupe sont renvoyées.
• Si le paramètre resourceType est fourni, seules les ressources de ce type sont renvoyées.
• Si le paramètre DirectDescendantsOnly a la valeur True, seuls les descendants directs de l'objet actuel sont renvoyés.

Exemple :

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

ResourceDisplayNameById (resourceId)

Renvoie le nom d'affichage d'une ressource pour un ID de ressource donné.

Exemple :

Dim resourceDisplayNameById
resourceDisplayNameById = context. resourceDisplayNameById(1000)

ResourceDisplayNameByName ("resourceName")

Renvoie le nom d'affichage d'une ressource pour un nom de ressource donné.

Exemple :

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

ResourcesOfContractParty(<resourceType>)

Similaire à ResourcesOfType, hormis le fait que cette méthode renvoie uniquement les ressources connectées au contractant du contrat actuel au moment présent

ResourcesOfContractParty(resourceType, time)

Similaire à ResourcesOfType, hormis le fait que cette méthode renvoie uniquement les ressources connectées au contractant du contrat actuel à l'heure spécifiée

Exemple :

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

ResourcesOfContractPartyAndService(<resourceType>)

Similaire à ResourcesOfType, hormis le fait que cette méthode renvoie uniquement les ressources suivantes :

• Ressources reliées au service de la métrique actuelle
• Contractant du contrat actuel au moment présent

ResourcesOfContractPartyAndService(resourceType, time)

Similaire à ResourcesOfType, hormis le fait que seules les ressources suivantes sont renvoyées :

• Groupe de ressources
• Type de ressource de la règle actuelle à l'heure spécifiée lorsqu'elles sont reliées au service de la règle actuelle
• Contractant du contrat actuel à l'heure spécifiée

Exemple :

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

ResourcesOfResourceGroup (resourceGroup, resourceType, time, DirectDescendantsOnly)

Similaire à ResourcesOfType, hormis le fait que seules sont renvoyées les ressources connectées aux éléments suivants :

• Groupe de ressources
• Type de ressource de la règle actuelle du contrat actuel à l'heure spécifiée

• Si le paramètre resourceGroup est fourni, seules les ressources de ce groupe sont renvoyées.
• Si le paramètre resourceType est fourni, seules les ressources de ce type sont renvoyées.
• Si le paramètre DirectDescendantsOnly a la valeur True, seuls les descendants directs de l'objet actuel sont renvoyés.

Exemple :

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

ResourcesOfService (<resourceType>)

Similaire à ResourcesOfType, hormis le fait que cette méthode renvoie uniquement les ressources connectées au service du contrat actuel au moment présent

ResourcesOfService (<resourceGroup>, <resourceType>)

Similaire à ResourcesOfType, hormis le fait que cette méthode renvoie uniquement les ressources contenues (directement et indirectement) dans le groupe de ressources défini au moment présent

ResourcesOfService(resourceGroup, resourceType, time)

Similaire à ResourcesOfType, sauf que cette méthode renvoie uniquement les ressources contenues (directement et indirectement) dans le groupe de ressources défini à l'heure spécifiée.

Exemple :

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

ResourcesOfService(resourceType, time)

Similaire à ResourcesOfType, hormis le fait que cette méthode renvoie uniquement les ressources connectées au service du contrat actuel à l'heure spécifiée

Exemple :

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

ResourcesOfType, ResourcesOfContractParty, ResourcesOfService, ResourcesOfResourceGroup, Resources, ResourcesOfContractPartyAndService

Toutes ces fonctions intègrent un nouveau paramètre facultatif appelé time. Si ce paramètre n'est pas spécifié, l'heure actuelle est utilisée.

• ResourcesOfType(resourceType, time)

  Renvoie un mappage des identifiants de ressource. Chaque entrée du mappage renvoyé comprend la clé et la valeur définies pour l'ID de la ressource.

  • Si un paramètre resourceType est fourni, cette méthode renverra toutes les ressources :
    • existantes et reliées au type de ressource spécifié à l'heure affichée
  • Si le paramètre resourceType est fourni, cette méthode renverra une liste de toutes les ressources :
    • existantes à l'heure spécifiée
  • Si le paramètre time n'est pas fourni, l'heure actuelle est utilisée.

  Exemple :

  Dim map

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

• ResourcesOfContractParty(resourceType, time)

  Similaire à ResourcesOfType, hormis le fait que cette méthode renvoie uniquement les ressources connectées au contractant du contrat actuel à l'heure spécifiée

  Exemple :

  Dim map

  Set map = Context.ResourcesOfContractParty

  "ThisResourceType", #1/1/2006 12:45:00#

• ResourcesOfService(resourceType, time)

  Similaire à ResourcesOfType, hormis le fait que cette méthode renvoie uniquement les ressources connectées au service du contrat actuel à l'heure spécifiée

  Exemple :

  Dim map

  Set map = Context.ResourcesOfService

  "ThisResourceType", #1/1/2006 12:45:00#

• ResourcesOfService(resourceGroup, resourceType, time)

  Similaire à ResourcesOfType, sauf que cette méthode renvoie uniquement les ressources contenues (directement et indirectement) dans le groupe de ressources défini à l'heure spécifiée.

  Exemple :

  Dim map

  Set map = Context.ResourcesOfService

  "ThisResourceGroup", "ThisResourceType", #"1/1/2006 12:45:00#

• ResourcesOfContractPartyAndService(resourceType, time)

  Similaire à ResourcesOfType, hormis le fait que seules sont renvoyées les ressources connectées au service :

  • de la règle actuelle
  • du contractant du contrat actuel à l'heure spécifiée

  Exemple :

  Dim map

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

• ResourcesOfResourceGroup (resourceGroup, resourceType, time, DirectDescendantsOnly)

  Similaire à ResourcesOfType, hormis le fait que seules sont renvoyées les ressources connectées aux éléments suivants :

  • Groupe de ressources
  • Type de ressources
  • Règle actuelle
  • Contrat actuel à l'heure spécifiée
  • Si le paramètre resourceGroup est fourni, seules les ressources de ce groupe sont renvoyées.
  • Si le paramètre resourceType est fourni, seules les ressources de ce type sont renvoyées.
  • Si le paramètre DirectDescendantsOnly a la valeur True, seuls les descendants directs de l'objet actuel sont renvoyés.

  Exemple :

  Dim map

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

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

  Les paramètres fournis filtrent cette liste de ressources :

  • Si le paramètre resourceGroup est fourni, seules les ressources de ce groupe sont renvoyées.
  • Si le paramètre resourceType est fourni, seules les ressources de ce type sont renvoyées.
  • Si withContractParty a la valeur True, seules les ressources appartenant au contractant actuel sont renvoyées.
  • Si withService a la valeur True, seules les ressources appartenant au service actuel sont renvoyées.
  • Si le paramètre time est défini, la liste sera créée pour la date spécifiée. Si ce paramètre n'est pas fourni, l'heure actuelle est utilisée.

  Exemple :

  Dim map

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

ResourceNameById

Renvoie le nom d'une ressource ou d'un groupe de ressources pour un ID de ressource spécifique.

Exemple :

Dim MyResourceName

MyResourceName = Context. ResourceNameById (1234)

ResourceIdByName

Renvoie l'ID pour la ressource ou le groupe de ressources, avec l'ID spécifié.

Exemple :

Dim MyResourceId

MyResourceId = Context. ResourceIdByName ('MyResource')

Rule (Règle)

Renvoie le nom de la métrique.

RuleId

Renvoie l'identifiant de la métrique.

RulePeriodTimeUnit

Renvoie l'unité de temps de la période de suivi de la métrique. Par exemple, si la période de suivi de la métrique est d'un mois et l'unité de temps actuelle une année, la valeur renvoyée sera un mois.

Service

Renvoie le nom du service.

ServiceId

Renvoie l'identifiant du service.

Target

Renvoie la cible de la métrique ou une valeur nulle si la métrique ne possède pas de cible.

ThresholdRed

Renvoie la valeur de seuil Rouge qui a été définie dans l'onglet Seuils de la métrique. Si aucune valeur n'a été définie, -1 est renvoyé.

Exemple :

Dim RedThreshold
RedThreshold = Context.ThresholdRed

ThresholdYellow

Renvoie la valeur de seuil Jaune qui a été définie dans l'onglet Seuils de la métrique. Si aucune valeur n'a été définie, -1 est renvoyé.

Exemple :

Dim YellowThreshold
YellowThreshold = Context.ThresholdYellow

TimeOfLastEvent

Renvoie la valeur du dernier événement (données brute et événement de métrique) envoyée à la logique applicative. En d'autres termes, cette fonction renvoie l'horodatage de l'événement à l'origine de l'exécution de la ligne actuelle qui contient l'appel à cette propriété. Cette valeur est intégrée à la fonction Réutilisabilité des événements.

Exemple :

Dim EventTime
EventTime = Context.TimeOfLastEvent

Période d'application

Renvoie le nom de la période d'application.

TimeSlotId

Renvoie l'identifiant de la période d'application.

TimeslotDescription

Renvoie la description de la période d'application utilisée par la métrique. Si le champ de description est vide, la valeur renvoyée est le nom de la période d'application.

Unité de temps

Si l'événement a généré la métrique, cette propriété contiendra l'unité de temps du calcul. Il peut s'agir de l'une des valeurs suivantes : "Heure", "Jour", "Semaine", "Mois", "Quartier", "Année". Il peut également s'agir d'une chaîne vide, ce qui signifie qu'un adaptateur a généré l'événement.