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

Objet Tools

Objet global contenant des méthodes utiles.

AddEventAnnotation(<Info>, <EventId>)

Enregistre une annotation d'événement à l'événement spécifié. Cette information peut s'avérer utile lors de la consultation des données brutes (événements). L'annotation enregistrée peut expliquer une situation spécifique pendant l'exécution de la formule de logique applicative à un moment spécifique.

Le paramètre Information spécifie le texte d'annotation à écrire.

Accepte également un paramètre EventId spécifiant l'événement annoté.

AddRootCauseComment(<Info>, <Timestamp>, <ResourceId>)

Enregistre un commentaire sur les causes initiales. Ces informations peuvent être utiles ultérieurement dans des rapports générés. Le commentaire de cause première explique une situation spécifique pendant l'exécution de la formule de logique applicative à un moment spécifique.

Le paramètre Information spécifie le commentaire à écrire.

La méthode reçoit un horodatage à enregistrer avec le commentaire. Elle accepte également un paramètre ResourceId qui spécifie une ressource associée au contexte de méthode. (Ce paramètre est facultatif et peut être ignoré.)

GetCustomAttributeForResource(resourceName, timestamp, customAttributeName)

Renvoie la valeur de l'attribut personnalisé spécifié, à partir de la ressource spécifiée, à l'heure indiquée.

Si l'attribut n'existe pas au moment de l'événement, une erreur se produit.

Exemple :

Dim AttribVal
AttribVal = Tools. GetCustomAttributeForResource. "MyResource", #12/12/06 12:34:56#, "MyAttribute"

GetExternalData (connectionString, query)

Cette méthode renvoie un ensemble d'enregistrements provenant de la base de données spécifiée par la chaîne de connexion, en fonction de la requête spécifiée.

Les deux chaînes doivent se terminer par un point virgule (;).

L'utilisateur peut utiliser cet ensemble d'enregistrements comme suit :

• Recordset.MoveNext : accède à l'enregistrement suivant dans l'ensemble d'enregistrement.
• Recordset.MovePrev : accède à l'enregistrement précédent dans l'ensemble d'enregistrement.
• Val = RecordSet("Field1"): permet d'obtenir la valeur de Field1 à partir de l'enregistrement actuel dans l'ensemble d'enregistrement.
• Do Until ruleNames.EOF : interrompt la boucle lorsque l'enregistrement actuel se trouve à la fin du fichier.
• Do Until ruleNames.BOF : interrompt la boucle lorsque l'enregistrement actuel se trouve au début du fichier.
• RecordSet.Close : ferme la connexion à la base de données.

Exemple :

Dim rs
Set rs = Tools.GetExternalData(
"dsn=oblicore;uid=oblicore;pwd=oblicore;", "select * from t_rules")
Do Until rs.EOF
  Out.Log "Name=" & rs("RULE_NAME"), "I"
  rs.MoveNext
Loop
rs.Close 

GetLocaleTime(<utcTime>)

La méthode convertit une heure donnée en UTC (temps universel coordonné) dans le fuseau horaire de la métrique actuelle.

GetUtcTime(<localeTime>)

La méthode convertit une heure donnée dans le fuseau horaire de la métrique actuelle en UTC (temps universel coordonné).

HasCustomAttributeForResource(resourceName, timestamp, customAttributeName)

Indique si l'attribut existe dans la ressource spécifiée à l'heure indiquée.

Exemple :

Dim AttribExistsNow
AttribExistsNow = Tools. HasCustomAttributeForResource "MyResource", #12/12/2006 12:34:56#, "MyAttribute"

NetTime(<Begin time>, <End time>)

Accepte deux paramètres signifiant une période.

La méthode calcule et renvoie la durée (en secondes) entre le début et la fin de la période comprise dans les intervalles de temps.

Si l'heure de début est ultérieure à l'heure de fin, le résultat est un nombre négatif.

SaveFields(<tableName>, <Key>, fieldName1, fieldValue1, fieldName2, fieldValue2,…)

Similaire à SaveRecord, sauf que cette procédure n'énumère pas toutes les valeurs mais fournit des paires de noms de champ et les valeurs de champs connexes. Vous pouvez remplacer les numéros de champ par les noms de champ. (Le numéro du premier champ de valeur est 1).

Remarque : Cette méthode est exécutée uniquement par l'agent de période de suivi.

SaveRecord <tableName>, <key>, <val1>, <val2>,…

Enregistre un enregistrement dans une table utilisateur. Les tables utilisateur permettent de sortir des informations pendant le calcul du niveau de service. Cette information peut s'avérer utile ultérieurement pour générer des rapports. Il peut y avoir plusieurs tables utilisateur.

Le paramètre tableName spécifie la table dans laquelle les informations doivent être écrites. Chaque enregistrement dans la table utilisateur possède une clé unique qui spécifie l'enregistrement dans lequel les informations doivent être écrites. Chaque enregistrement possède également plusieurs champs de valeur de type chaîne. Le nombre exact de champs de valeur dans chaque table utilisateur, ainsi que le nom des champs, sont définis pendant l'implémentation.

La méthode SaveRecord reçoit le nom de la table utilisateur et une clé. Elle accepte également tous les champs de valeur dans la table utilisateur. (Ces paramètres de valeur sont facultatifs, et peuvent être ignorés.) Si un enregistrement avec la même clé existe déjà, il est mis à jour. (Seuls les champs de valeur transférés en tant que paramètres sont mis à jour.) Si aucun enregistrement possédant cette clé n'existe, il est créé.

Remarque : Cette méthode est exécutée uniquement par l'agent de période de suivi.

SendEvent(<eventName>, <resourceName>, <Timestamp>, <TimeUnit>, <args>)

Cette méthode crée un nouvel événement de métrique. Les paramètres sont définis comme suit :

• EventTypeName : Nom du type d'événement de cet événement.
• ResourceName : Nom de la ressource pour laquelle cet événement est envoyé. Ce paramètre est facultatif. S'il n'est pas fourni, l'événement est envoyé à toutes les ressources. Le nom peut également contenir le nom du groupe de ressources. Le cas échéant, l'événement est envoyé à ce groupe de ressources. Le système reconnaîtra lui-même si le nom spécifié est celui d'une ressource ou d'un groupe de ressources. Cet élément peut être remplacé par un nom de groupe de ressources. Aucune autre valeur ne change si vous utilisez un nom de groupe de ressources plutôt qu'un nom de ressource.
• Timestamp : horodatage de cet événement. Ce paramètre est facultatif. Si ce paramètre n'est pas fourni, l'horodatage correspond à celui du dernier événement reçu par la métrique.
• TimeUnit : unité de temps à envoyer. Les types d'unité de temps que l'utilisateur peut envoyer sont les suivants :
  • Tout
  • Suivi
  • Heure
  • Jour
  • Semaine
  • Mois
  • Trimestre
  • Année

  Le paramètre d'unité de temps est obligatoire. Aucun événement n'est envoyé si ce paramètre n'est pas défini ou s'il n'est pas correctement défini.

  Ce paramètre n'est pas sensible à la casse.

  Une erreur est ajoutée au journal si l'unité de temps n'est pas correctement définie dans la logique applicative.

• Val_1, Val_2…: champs de valeur de l'événement. Le nombre de champs de valeur dépend du type d'événement. Si le nombre de paramètres fournis est supérieur au nombre de champs de données dans le type d'événement, une erreur d'exécution est signalée à l'exécution de cette ligne. Si le nombre de paramètres fournis est inférieur au nombre de champs de données, une valeur par défaut est attribuée aux derniers paramètres. La valeur par défaut dépend du type de champ. Si les valeurs transmises ne sont pas cohérentes avec le type de valeur de l'événement et en l'absence de diffusion, une erreur est générée.

Exemple :

Tools.SendEvent "OnEvent", "MyResource", #1/2/2006 13:46:00#, "All", 1, 2