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

Objekt "Tools"

Ein globales Objekt, das etliche nützliche Funktionen bietet.

AddEventAnnotation(<Info>, <EventId>)

Speichert eine Anmerkung zu dem angegebenen Event. Diese Information kann beim Anzeigen der Rohdaten (Events) nützlich sein. Die gespeicherte Anmerkung kann eine bestimmte Situation bei der Ausführung der Business-Logik-Formel in einem bestimmten Moment erklären.

Der Informationsparameter gibt den Anmerkungstext an, der ausgegeben werden soll.

Außerdem wird der Parameter "EventId" angenommen, der das Event mit der Anmerkung definiert.

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

Speichert einen Kommentar zur Ursache. Diese Informationen können später in generierten Berichten nützlich sein. Der gespeicherte Kommentar zur Ursache erklärt eine bestimmte Situation bei der Ausführung der Business-Logik-Formel in einem bestimmten Moment.

Der Informationsparameter legt den zu schreibenden Kommentar fest.

Sie können für die Methode einen Zeitstempel eingeben, der zusammen mit dem Kommentar gespeichert wird. Darüber hinaus wird der Parameter ResourceId akzeptiert, der die auf den Methodenkontext bezogene Ressource festlegt. (Dieser Parameter ist optional und kann weggelassen werden.)

GetCustomAttributeForResource(resourceName, timestamp, customAttributeName)

Gibt den Wert des angegebenen anwenderspezifischen Attributs der angegebenen Ressource zur angegebenen Zeit zurück.

Wenn das Attribut zum Zeitpunkt des Events nicht vorhanden ist, kommt es zu einem Fehler.

Beispiel:

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

GetExternalData (connectionString, query)

Diese Methode gibt einen Aufzeichnungssatz aus der durch den Verbindungsstring angegebenen Datenbank auf Basis der angegebenen Abfrage zurück.

Beide Zeichenfolgen müssen mit einem Semikolon enden (;).

Der Anwender kann diesen Aufzeichnungssatz folgendermaßen benutzen:

• Recordset.MoveNext - zur nächsten Aufzeichnung des Aufzeichnungssatzes verschieben.
• Recordset.MovePrev - zur vorherigen Aufzeichnung des Aufzeichnungssatzes verschieben.
• Val = RecordSet("Field1") - Wert von Field1 aus der aktuellen Aufzeichnung des Aufzeichnungssatzes abrufen.
• Do Until ruleNames.EOF - stoppt die Schleife, wenn die aktuelle Aufzeichnung das Dateiende ist.
• Do Until ruleNames.EOF - stoppt die Schleife, wenn die aktuelle Aufzeichnung der Dateianfang ist.
• RecordSet.Close - Datenbankverbindung beenden.

Beispiel:

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>)

Die Methode wandelt eine Zeitangabe in UTC in die Zeitzone der aktuellen Metrik um.

GetUtcTime(<localeTime>)

Die Methode wandelt eine Zeitangabe in der Zeitzone der aktuellen Metrik in UTC um.

HasCustomAttributeForResource(resourceName, timestamp, customAttributeName)

Gibt zurück, ob das angegebene Attribut zur angegebenen Zeit in der angegebenen Ressource existiert.

Beispiel:

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

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

Kann zwei Parameter enthalten, die einen Zeitraum definieren.

Die Methode berechnet die Zeit in Sekunden von Beginn bis Ende des Zeitraums, also innerhalb des Zeitfensters, und gibt sie zurück.

Wenn die Anfangszeit später als die Endzeit ist, ist das Ergebnis ein negativer Wert.

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

Ähnlich wie SaveRecord, zählt die Werte jedoch nicht auf, sondern stellt Feldnamen und die zugehörigen Feldwerte paarweise bereit. Die Feldnamen können durch Feldnummern ersetzt werden. (Die Nummer für das erste Feld ist 1.)

Hinweis: Diese Methode wird nur vom Kontrollzeitraum-Agenten ausgeführt.

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

Speichert einen Eintrag in einer Benutzertabelle. Mit Benutzertabellen können während der Service Level-Berechnung Informationen ausgegeben werden. Diese Informationen lassen sich anschließend für die Berichterstellung verwenden. Es kann viele Benutzertabellen geben.

Der Parameter tableName legt fest, in welche Tabelle die Information geschrieben wird. Jeder Datensatz in der Benutzertabelle hat einen einmaligen Schlüssel, der festlegt, in welchen Datensatz die Informationen geschrieben werden sollen. Jeder Datensatz verfügt zudem über zahlreiche Wertefelder vom Typ String. Die genaue Anzahl der Wertefelder pro Benutzertabelle und die Feldnamen werden bei der Implementierung festgelegt.

Bei der Methode SaveRecord werden ein Anwendertabellenname und ein -schlüssel empfangen. Darüber hinaus werden alle Wertfelder in der Benutzertabelle akzeptiert. (Diese Wertparameter sind optional und können entfallen.) Wenn bereits ein Datensatz mit dem gleichen Schlüssel vorhanden ist, wird er aktualisiert. (Es werden nur die als Parameter übertragenen Wertefelder aktualisiert.) Existiert kein Datensatz mit diesem Schlüssel, wird einer angelegt.

Hinweis: Diese Methode wird nur vom Kontrollzeitraum-Agenten ausgeführt.

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

Diese Methode legt ein neues Metrik-Event an. Die Parameterdefinitionen sind:

• EventTypeName – Name des Event-Typs dieses Events.
• ResourceName – Name der Ressource, für die dieses Event gesendet wird. Dieser Parameter ist optional. Wenn er nicht angegeben ist, wird das Event auf allen Ressourcen gesendet. Der Name kann ebenfalls den Namen der Ressourcengruppe enthalten. In diesem Fall wird das Event auf dieser Ressourcengruppe gesendet. Das System erkennt von selbst, ob der angegebene Name der Name der Ressource oder der Ressourcengruppe ist. Er kann durch den Namen einer Ressourcengruppe ersetzt werden. Wenn der Gruppenname anstatt des Ressourcennamens verwendet wird, ändern sich keine anderen Werte.
• Timestamp – der Zeitstempel dieses Events. Dieser Parameter ist optional. Ist dieser Parameter nicht vorhanden, ist der Zeitstempel der Zeitstempel des letzten von der Metrik erhaltenen Events.
• TimeUnit - die zu sendende Zeiteinheit. Sie können folgende Zeiteinheitentypen senden:
  • Alle
  • Kontrollzeitraum
  • Stunde
  • Tag
  • Woche
  • Monat
  • Quartal
  • Jahr

  Der Zeiteinheitsparameter ist obligatorisch. Ist der Parameter überhaupt nicht oder falsch definiert, werden keine Events gesendet.

  Bei diesem Parameter spielen Groß- bzw. Kleinschreibung keine Rolle.

  Bei falscher Definition der Zeiteinheit in der Business-Logik wird ein Fehler ins Business-Protokoll eingetragen.

• Val_1, Val_2… – die Wertefelder des Events. Die Anzahl der Wertefelder ist vom Event-Typ abhängig. Übersteigt die Anzahl der angegebenen Parameter die Anzahl der Datenfelder im Event-Typ, wird bei der Bearbeitung dieser Zeile ein Laufzeitfehler ausgegeben. Liegt die Anzahl der angegebenen Parameter unter der Anzahl der Datenfelder, werden die letzten Parameter mit einem Standardwert aufgefüllt. Der Standardwert richtet sich nach dem Feldtyp. Stimmen die übergebenen Werte nicht mit den Wertetypen im Event überein und findet keine passende Auswahl statt, wird ein Fehler generiert.

Beispiel:

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