Variablen und VARA-Objekte

Mit Variablen und VARA-Objekten können Sie Platzhalter für Werte definieren, die in ausführbaren Objekten verwendet werden sollen. In diesem Thema werden die verschiedenen Arten von Variablen und VARA-Objekten unterschieden, die Sie in der Automation Engine finden können. Als Entwickler und Objektdesigner erstellen Sie Variablen und VARA-Objekte und verwenden sie in ausführbaren Objekten. Als Systemadministrator pflegen Sie Mandanten- und Systemvariablen sowie VARA-Objekte.

Überblick

Wenn eine Aufgabe generiert wird, löst das System Variablen und Referenzen auf VARA-Objekte auf, um Werte aus verschiedenen Quellen abzurufen. Die Werte von Variablen und VARA-Objekten werden bei Aktivierung oder zur Laufzeit aufgelöst, wie auf der Seite Attribute in der Objektdefinition definiert. Weitere Informationen finden Sie unter Generierung zum Aktivierungszeitpunkt oder zur Laufzeit.

VARA-Objekte

VARA-Objekte sind Entities mit eigenen Attributen wie jedes andere Objekt in der Automation Engine. Die folgenden Arten von VARA-Objekten sind verfügbar:

• Vordefinierte VARA-Objekte für System- und Mandantenwerte
• Benutzerdefinierte VARA-Objekte

Als Administrator definieren Sie Systemeinstellungen, die festlegen, was passieren soll, wenn VARA-Objekte nicht aufgelöst werden können. Weitere Informationen finden Sie unter VARA_ERROR_ON_REPLACEMENT in den UC_CLIENT_SETTINGS .

Vordefinierte VARA-Objekte für System- und Mandantenwerte

Die Automation Engine stellt im Mandanten 0 vordefinierte VARA-Objekte zur Verfügung, die System- und Mandantenwerte speichern. Diese Objekte steuern das Verhalten des Systems und der Mandanten. Der Zugriff auf diese Art von VARA-Objekten ist in der Regel auf Administratoren beschränkt.

VARA-Objekte, die systemweite Parameter enthalten, müssen im Mandanten 0 verbleiben.

VARA-Objekte, die das Verhalten von Mandanten und deren Prozessen steuern, können in den jeweiligen Mandanten gespeichert werden.

Weitere Informationen finden Sie unter Liste der VARA-Objekte für System- und Mandantenwerte.

Hinweis: In Job-Formularen können Sie keine vordefinierten VARA-Objekte verwenden.

Benutzerdefinierte VARA-Objekte

Als Entwickler und Objektdesigner erstellen Sie VARA-Objekte, um Werte zu speichern und zu verwenden. Ihre VARA-Objekte können Werte aus verschiedenen Quellen (Datenbanken, Verzeichnissen usw.) dynamisch abrufen. Sie können ihnen auch statische Werte zuweisen. Benutzerdefinierte VARA-Objekte werden bei der Installation nicht mitgeliefert. Die Automation Engine stellt jedoch Templates für verschiedene Arten von benutzerdefinierten VARA-Objekten zur Verfügung. Weitere Informationen finden Sie unter VARA-Objekte.

Virtuelle Agenten-VARA-Objekte

Agentenvariablen speichern Agenteninformationen und -einstellungen. Als virtuelle VARA-Objekte sind sie entweder im Mandanten 0 oder in der Datenbank verfügbar. Eine Liste aller verfügbaren Agentenvariablen finden Sie unter Liste der Agentenvariablen.

Hinweis: Sie können keine Werte in Agentenvariablen per Script setzen.

Geben Sie als Administrator alle Agentenvariablen im Abschnitt [VARIABLES] der INI-Datei des Agenten an. Auf diese Weise stellen Sie sicher, dass die Variablenwerte entsprechend der Umgebung gesetzt werden. Zum Beispiel:

[VARIABLES]

UC_HOST_CODE=UC_CODE

UC_HOST_JCL_VAR=NSK

UC_EX_PATH_BIN=$data01.uc4

UC_EX_PATH_CACHE=c:\AE11\agents\windows\CACHE\0100\
UC_EX_PATH_JOBREPORT=$data01.
UC_EX_JOB_MD=$data01.uc4.ucxjns1r

Verwenden Sie Script-Sprachmittel wie GET_VAR, um Werte aus der Agentenvariable abzurufen.

Syntax

GET_VAR (Agent variable,Agent name)

Variablen

Die Automation Engine verwendet verschiedene Arten von Variablen, um Werte zu speichern und zu übergeben. Einige Variablen sind vordefiniert und können von Benutzern nicht gesetzt werden, während Sie andere frei erstellen können. Variablen werden bei der Generierung der Aufgabe aufgelöst. Im Gegensatz zu VARA-Objekten werden Variablen in Scripts gespeichert und sind keine eigenständigen Objekte.

Vordefinierte Variablen für System- und Objektwerte

Die Automation Engine stellt vordefinierte Variablen zur Verfügung, um Werte von System- und Objekteigenschaften abzurufen. Sie können diese vordefinierten Variablen in Scripts und Objektdefinitionen verwenden. In Scripts werden Variablen aufgelöst und durch Werte ersetzt, wenn das Script verarbeitet wird. In Objektdefinitionen werden die Werte dieser Variablen nach der Verarbeitung des Scripts ersetzt. Sie können vordefinierte Variablen verwenden, um Objektattribute zu modifizieren.

Hinweise:

• Verwenden Sie keine System- oder Objektvariable in ihrem eigenen Objektattribut. Wenn Variablen in ihrem eigenen Attribut verwendet werden, werden sie bei der Verarbeitung des Scripts nicht ersetzt.
• Definieren Sie keine Attribute, die sich über Variablen aufeinander beziehen. Attribute, die sich über Variablen aufeinander beziehen, werden bei der Verarbeitung des Scripts nicht ersetzt.

Weitere Informationen finden Sie unter Liste der Variablen für System- und Objektwerte.

Script-Variablen

Erstellen Sie Script-Variablen, um Werte in den Scripts zu speichern und zu übergeben, die Sie auf den Script-Seiten von ausführbaren Objekten definieren. Sie können auch einige Objekteigenschaften mit Script-Variablen definieren. Verwenden Sie Script-Sprachmittel, um Script-Variablen zu setzen und zu deklarieren, und weisen Sie Werte einer Script-Variable zu. Script-Variablen spielen eine grundlegende Rolle beim Schreiben von Scripts.

Mehr Informationen:

• Funktionale Logik mit Scripts
• Script-Sprachmittel und Syntax
• Scripts schreiben
• Seiten „Script“
• Automation Engine Script-Referenz

Objektvariablen

Definieren Sie objektspezifische Variablen, um Werte aus Objekteigenschaften (Werte in den Eingabefeldern) oder aus der Laufzeitinstanz des Objekts (der Aufgabe) abzurufen. Definieren Sie Objektvariablen auf der Seite Variablen eines ausführbaren Objekts oder verwenden Sie ein :PSET-Script-Statement auf den Script-Seiten. Diese Objektvariablen werden in der Objektdefinition gespeichert. Child-Aufgaben können Objektvariablen von Parent-Objekten erben.

Mehr Informationen:

• Seite „Variablen“
• :PSET
• Objekt- und PromptSet-Variablen erben

PromptSet-Variablen

Wenn Sie in einem PromptSet Werte definiert haben, werden diese Werte als PromptSet-Variablen gespeichert. Wenn das PromptSet einem Objekt zugewiesen wird, werden diese Werte während der Ausführung verwendet. Sie können jedoch auf eine der folgenden Arten überschrieben werden:

• Manuell bei der Objektausführung

  Sie können beim Aufruf des PromptSets verschiedene Werte angeben.

Durch die Definition verschiedener Werte auf der Objektseite PromptSet

Wenn das Objekt aus einem Workflow oder einer Schedule heraus ausgeführt wird

Mehr Informationen:

• PromptSets (PRPT)
• Objekt- und PromptSet-Variablen erben
• Beispiele: Objektvariablen vererben

Variablen im Read-Buffer ablegen

Der Read-Buffer speichert Werte auf Zeit, damit andere Aufgaben diese Werte verwenden können. Die im Read-Buffer gespeicherten Werte werden nach dem Verbrauch gelöscht. Wenn ein Prozess mehrere Aufgaben enthält, speichern die Read-Buffer-Variablen ihre Werte in chronologischer Reihenfolge. Diese Werte werden auch in chronologischer Reihenfolge verwendet. Beispielsweise werden in einem Prozess mit drei Aufgaben die Werte bei der ersten Verwendung der Funktion ACTIVATE_UC_OBJECT durch die erste verwendete Aufgabe gespeichert.

Verwenden Sie Script-Statements, um Werte von Script-Variablen oder PromptSet-Variablen im Read-Buffer zu speichern, wenn Sie ein Objekt über ein Script mithilfe von ACTIVATE_UC_OBJECT aktivieren.

Die Automation Engine beinhaltet vordefinierte Variablen (UC_CAUSE*-Variablen), die Details einer Aufgabe abrufen und die Werte im Read-Buffer zwischenspeichern. Werte werden im Read-Buffer gespeichert, wenn Sie Folge- oder Alternativ-Aktionen (die Ausführung eines anderen Objekts) angeben, wenn eine Bedingung oder ein Status nicht erfüllt ist.

• Für ausführbare Objekte:
  • Wenn der Status einer Aufgabe nicht in dem Bereich liegt, der im Abschnitt Behandlung des Rückgabewertes auf der Seite Seite „Laufzeit“ der Objektdefinition festgelegt wurde
  • Wenn der Status einer Aufgabe nicht derjenige ist, der im Abschnitt Aufgaben-Ergebnisauswertung auf der Seite Seite „Attribute“ festgelegt wurde.
• Workflows:
  • Wenn eine Aufgabe zu dem Zeitpunkt, der durch den Kontrollpunkt angegeben ist, nicht ausgeführt werden kann, siehe Zeit & Abhängigkeiten
  • Wenn die im Abschnitt Abhängigkeiten (Tab Zeit & Abhängigkeiten) für eine Aufgabe definierten Bedingungen nicht erfüllt sind
  • Wenn die Laufzeit einer Aufgabe vom Erwartungswert abweicht, wie im Tab Laufzeit-Eigenschaften definiert

• Für Schedules:

  • Wenn die Laufzeit einer Aufgabe vom Wert abweicht, der in den Laufzeiteigenschaften der Aufgabe definiert ist
  • Wenn der Status einer Aufgabe vom Status abweicht, der in den Ergebniseinstellungen angegeben ist, siehe Schedule-Objekte definieren

• ALARM- oder STANDARD-Benachrichtigungen:

  • Wenn das Objekt durch Ausführen eines anderen CALL-Objekts eskaliert, siehe Benachrichtigung (CALL)

Mehr Informationen:

• :PUT_READ_BUFFER, :PUT_PROMPT_BUFFER
• Liste der vordefinierten Read-Buffer-Variablen

Variablennamen

Variablen haben die folgende Syntax:

• Variablennamen haben ein führendes kaufmännisches Und-Zeichen (&).
• Das zweite Zeichen nach dem führenden kaufmännischen „Und“ darf keine Zahl oder ein Dollarzeichen ($) sein.
Ausnahme: Variablen für vordefinierte System- und Objektwerte beginnen mit &$.
• Variablennamen können bis zu 32 Zeichen lang sein. Das führende kaufmännische Und-Zeichen zählt nicht zum Limit. Die Länge des zurückgegebenen Wertes ist nicht begrenzt.
• Variablennamen können alle Buchstaben des Alphabets, Zahlen von 0 bis 9 und die folgenden Sonderzeichen enthalten: $, _, @, § und #.
• Verwenden Sie keine Akzentzeichen.
• Bei Variablennamen wird nicht zwischen Groß- und Kleinschreibung unterschieden.

Beispiele:

• Variablen für System- und Objektwerte: &$CLIENT#, &$DATE_format#, &$DATABASE_NAME#
• Variablen: &HEADER#, &ROW#, &parentname#

Werte ermitteln

Rufen Sie in ausführbaren Objekten Werte aus Variablen und VARA-Objekten auf folgende Weise ab:

• Wählen Sie die Option Variable aus der Dropdown-Liste Quelle im Abschnitt Datenbank-Ereignis bei der Definition von DB-Ereignisse.
• Geben Sie den Variablennamen in Eingabefelder und Comboboxen ein, sofern unterstützt.

• Klicken Sie auf das Variablensymbol, um den Dialog zur Variablen-Auswahl zu öffnen, in dem die Variablen wie folgt gruppiert sind:

  • Systemeigenschaften

    System- und Mandanten-Variablen, die Werte des Automation Engine-Systems abrufen. Eine vollständige Liste finden Sie unter Systemeigenschaften.

  • Objekteigenschaften

    Objektvariablen, die Werte abrufen, die entweder in den Objekteigenschaften angegeben sind oder die von ihrer Laufzeitinstanz (der Aufgabe) abgeleitet sind.

  • Automation-Variablen

    Liste der System- und Mandanten-VARA-Objekte.

  • Variablenobjekte

    Liste der benutzerdefinierten VARA-Objekte, die im aktuellen Mandanten verfügbar sind.

Um Objekteigenschaften mit Werten aus VARA-Objekten zu definieren, geben Sie den Namen des VARA-Objekts in geschweiften Klammern ein. Geben Sie optional Key- und Spaltenparameter an, um einen bestimmten Wert im VARA-Objekt auszuwählen.

Syntax

{ Variablenobjekt [, Key [, Spaltennummer ]] }.

Beispiel

Der folgende Ausdruck wird bei der Generierung der Aufgabe durch einen Wert aus einem VARA-Objekt ersetzt:

{MONITOR_SP1, 2, 3}

wobei

• MONITOR_SP1 ist der Name des VARA-Objekts
• 2 ist der Key
• 3 ist die Spalte

Die Parameter Key und Spalte sind optional. Wenn Sie die Parameter nicht angeben, wählt das System den Wert je nach Typ des VARA-Objekts wie folgt aus.

• Statische VARA-Objekte: Der Ausdruck wird durch den Wert ersetzt, der in der ersten Spalte des VARA-Objekts definiert ist.
• Dynamische VARA-Objekte: Die Spaltennummer wird durch den Wert in der Spalte Ergebnisse ersetzt.

Rufen Sie in Scripts Werte aus Variablen und VARA-Objekten auf die folgende Weise ab:

• Rufen Sie Script-Variablen auf, lesen Sie Read-Buffer-Variablen, PromptSet-Variablen und vordefinierte System- und Objektvariablen direkt in Ihren Scripts. Weitere Informationen finden Sie unter Script-Sprachmittel und Syntax und Script-Sprachmittel für Variablen und VARA-Objekte.

• Verwenden Sie Script-Funktionen wie GET_VAR, um in VARA-Objekten gespeicherte Werte abzurufen. Im Gegensatz zu Script-Variablen können Sie vordefinierte VARA-Objekte in Automation Engine-Scripts nicht direkt aufrufen. Weitere Informationen finden Sie unter Script-Sprachmittel für Variablen und VARA-Objekte.
  Beispiel: 
  Das folgende Script bezieht den Pfad zum Verzeichnis in dem der Agent (WIN01) Job-Reports speichert.
  :SET &jobreport# = GET_VAR('UC_EX_PATH_JOBREPORT','WIN01')

• Verwenden Sie die Script-Funktion GET_ATT, um den Wert eines Objektattributs abzurufen. Wenn das Objektattribut eine Variable wie beispielsweise eine Objektvariable enthält, löst das System die Variable auf und ruft den Wert ab. Diese Funktion ändert oder ersetzt die Variable selbst nicht.
  Beispiel:
  Verwenden Sie GET_ATT-Script-Funktionen, um Werte abzurufen, die im Read-Buffer gespeichert sind.
  :SET&MYINTERNALACCT# = GET_ATT(&$INT_ACCOUNT#)

• Verwenden Sie :READ-Script-Statements, um im Read-Buffer gespeicherte Werte abzurufen. Weitere Informationen finden Sie unter :READ und :PUT_READ_BUFFER, :PUT_PROMPT_BUFFER.

Siehe auch: