VARA-Objekte vom Typ EXEC

Benutzerdefinierte VARA-Objekte sind leistungsstarke dynamische Ausführungstools. Sie sind Platzhalter für Werte, die sie aus verschiedenen Quellen abrufen, abhängig vom Typ des VARA-Objekts. VARA-Objekte werden ausführbaren Objekten zugeordnet. Wenn diese ausführbaren Objekte verarbeitet werden, werden die VARA-Objekte durch deren Werte ersetzt. Als Entwickler und Objektdesigner erstellen und verwenden Sie VARA-Objekte in den Attributen und Scripts von ausführbaren Objekten. Als Administrator erstellen Sie im Mandanten 0 VARA-Objekte, die von anderen Benutzern in anderen Mandanten verwendet werden können.

Verwenden Sie EXEC-VARA-Objekte als Mittler, die die von anderen ausführbaren Objekten zurückgegebenen Werte lesen und weitergeben. Diese Werte können die nachfolgende Ausführung von Objekten beeinflussen oder die Ausführung von Objekten auslösen. Die ausgelesenen Werte speichern Sie in den Script-Variablen, die im EXEC-VARA-Objekt definiert sind. Das VARA-Objekt selbst hat keine Eingabeparameter.

Die Namen der Parameter im EXEC-VARA-Objekt und im PromptSet des ausführbaren Objekts, das die Rückgabewerte liefert, müssen identisch sein.

Verwenden Sie hier PromptSet-Variablen, wenn Sie die Funktion Dynamisch aktualisieren für Kombinationsfeld-Eingabeaufforderungen verwenden. Die PromptSet-Variablen werden aufgelöst, wenn das Objekt, das die Eingabeaufforderung enthält, ausgeführt wird.

Wie alle anderen Objekte haben EXEC-VARA-Objekte mehrere verschiedene Definitionsseiten. Allgemein, Versionsmanagement und Dokumentation existieren für alle Objekte. Hier wird die Seite Variablen beschrieben, die für EXEC-VARA-Objekte spezifisch ist.

Ein EXEC VARA-Objekt definieren

  1. Geben Sie im Abschnitt Variableneinstellungen an, wie das VARA-Objekt auf das Zielsystem zugreifen soll, von dem es die Werte abruft.

    • Typ ist ein schreibgeschütztes Feld. Sie legen den Variablentyp fest, wenn Sie das Objekt erstellen, und können ihn nicht ändern, sobald die Variable definiert ist.

    • Wählen Sie unter Ausführbares Objekt den Namen des ausführbaren Objekts aus, aus dem dieses VARA-Objekt vom Typ EXEC die Werte liest. Geben Sie es ein oder klicken Sie auf das Symbol, um einen Dialog zu öffnen und danach zu suchen.

      Hinweis: Schedule-Objekte dürfen für EXEC VARA-Objekte nichtverwendet werden.

    • Geben Sie unter Ergebnis-Variable den Namen der Script-Variablen ein, die für den Rückgabewert des ausführbaren Objekts verwendet werden soll.

  2. Geben Sie im Abschnitt Parameter die Liste der Parameter und Variablen an, die im ausführbaren Objekt verfügbar sind. Die Werte können sein:

    • Direkte Werte, z. B. 5342
    • Referenzvariablen, wie z. B. &reftext#

      Nachfolgende Leerzeichen am Ende von Werten werden beim Speichern von EXEC-Variablen entfernt

      Wenn Sie die Funktion für das dynamische Aktualisieren für Kombinationsfeld-Prompts verwenden, können Sie hier PromptSet-Variablen hinzufügen. Wenn Sie PromptSet-Variablen in einem dynamischen VARA-Objekt verwenden, gibt die Funktion Vorschau einen Fehler zurück. Der Grund hierfür ist, dass PromptSet-Variablen im dynamischen VARA-Objekten nicht existieren. Die PromptSet-Variablen werden jedoch aufgelöst, wenn Objekte, die PromptSet beinhalten, ausgeführt werden.

    Behandeln Sie diese Parameter so als wären sie Prompt Set-/Read-Buffer-Werte. Wenn ein VARA-Objekt das ausführbare Objekt aufruft, verwendet es :PUT_PROMPT_BUFFER, um die angegebenen Parameter einzustellen. Um diese Werte im aufgerufenen ausführbaren Objekt zu lesen und zu verwenden, müssen Sie den Befehl :READ verwenden. Dieser Befehl liest die Werte von Variablen mit demselben Namen auf. Die Werte hängen von den Parametern ab, die im aufrufenden EXEC-Variablenobjekt festgelegt werden.

    Wichtig! Es reicht nicht aus, die Variablen nur auf der Seite Variablen unter Variablen & Prompts für das aufgerufene ausführbare Objekt zu definieren.

    Weitere Informationen finden Sie unter :PUT_READ_BUFFER, :PUT_PROMPT_BUFFER.

  3. Im Abschnitt Daten & Formatierung legen Sie das Datenformat des Werts fest, der vom VARA-Objekt gerendert wird. Führen Sie folgende Schritte durch:

    • Datentyp

      • Für Text

        • Wählen Sie Textlänge limitieren aus, um ein Limit für die Länge des Zeichen-Strings festzulegen.

        • Geben Sie unter Max. Textlänge die maximale Länge an. Mögliche Werte: 1 bis 1024.

        • Wählen Sie Großschreibung erzwingen aus, wenn Sie den Text der ersten Wertspalte in Großbuchstaben konvertieren möchten.

      • Für Zahl

        Ganzzahl mit Vorzeichen, mögliche Werte: beliebige Zahl von 0 bis 2147483647.

        Standardformat: 16 Stellen

      • Für Zeit

        Möglich sind dabei die folgenden Formate:

        • HHMMSS
        • HH:MM:SS
        • HHMM
        • HH:MM
        • MMSS
        • MM:SS

        Standardformat: HHMMSS

        Der Wert für diesen Datentyp muss eine vier- oder sechsstellige Zahl sein. Kommastellen werden entfernt. Eine vierstellige Zahl wird dabei in Stunden und Minuten konvertiert.

        Beispiel:

        Ausgabeformat: HH:MM:SS

        Wert des Benutzers oder der Datenquelle: 1234, 1234.5, 123400, 12:34, 12:34:00

        Resultierender Variablenwert: 12:34:00

      • Für Datum

        Möglich sind dabei die folgenden Formate:

        • DD-MON-YYYY
        • DD-MON-RR
        • MM-DD-YYYY
        • YYYYMMDD
        • MMDDRR
        • DDMMRR
        • MM-DD-RR
        • MM/DD/RR
        • YYMMDD
        • YY.MM.DD
        • YY-MM-DD
        • YYYYMMDD
        • YYYY.MM.DD
        • YYYY-MM-DD
        • DDMMYY
        • DD.MM.YY
        • DD-MM-YY
        • DDMMYYYY
        • DD.MM.YYYY
        • DD-MM-YYYY
        • MMDDYY
        • MMDDYYYY
        • MM/DD/YY
        • MM/DD/YYYY

        Standardformat: YYMMDD

        Hinweis: Manche Datumsformate enthalten RR als Platzhalter für das abgekürzte Jahr. Der Unterschied zwischen "YY" und "RR" ergibt sich durch die unterschiedlichen Arten, Jahrhunderte zu zählen (erste zwei Stellen der abgekürzten Jahreszahl).

        • YY - Das aktuelle Jahrhundert gilt für Zahlen von 00 bis 80. Im Bereich 81 - 99 das vorherige.
        • RR - Das aktuelle Jahrhundert gilt für Zahlen von 00 bis 49. Im Bereich 50 - 99 das vorherige.

        Beispiele:

        • Datumsformat TTMMJJ und die daraus resultierenden Daten:

          010305 - entspricht dem 01. März 2005
          010365 - entspricht dem 01. März 2065
          010380 - entspricht dem 01. März 2080
          010385 - entspricht dem 01. März 1985

        • Datumsformat TTMMRR und die daraus resultierenden Daten:

          010305 - entspricht dem 01. März 2005
          010365 - entspricht dem 01. März 1965
          010380 - entspricht dem 01. März 1980
          010385 - entspricht dem 01. März 1985

      • Für Zeitstempel

        Mögliche Formate:

          YYYYMMDDHH24MISS

          YYYY-MM-DD HH:MM:SS

        Standardformat: YYYY-MM-DD HH:MM:SS

        Der Wert für diesen Datentyp muss eine vier- oder sechsstellige Zahl sein. Kommastellen werden entfernt. Eine vierstellige Zahl wird dabei in Stunden und Minuten konvertiert.

        Beispiel:

        Ausgabeformat: YYYY-MM-DD HH:MM:SS
        Wert des Benutzers oder der Datenquelle: 20110325 2201, 20110325 2201.5, 20110325 220100
        Resultierender Variablenwert: 2011-03-25 22:01:00

    • Minimum festlegen / Min. Wert und Maximum festlegen / Max. Wert (Alle VARA-Typen)

      Legt einen Minimal-/Maximalwert fest.

      Mögliche Werte für Zahl: Maximal 16 Stellen vor und 16 Stellen nach dem Dezimalpunkt

  4. Alle VARA-Objekte haben den Abschnitt Script-Zugriff auf ihren Definitionsseiten, der die Fehlerbehandlung festlegt, wenn Scripts das VARA-Objekt lesen. In diesem Bereich entscheiden Sie, was passieren soll, wenn Scripts auf das VARA-Objekt zugreifen und der Schlüssel, auf den sie verweisen, nicht verfügbar ist.

    Folgende Optionen stehen zur Verfügung:

    • Fehler zurückliefern

      Das Script wird nicht ordnungsgemäß beendet, und auf der Meldungen-Konsole wird eine Laufzeitfehlermeldung angezeigt.

    • Anfangswerte zurückgeben (Standard)

      Das Script wird weiterhin ausgeführt, obwohl der Schlüssel nicht verfügbar ist. Es wird kein Laufzeitfehler angezeigt. Der Report enthält einen leeren String, woran zu erkennen ist, dass kein Schlüssel gefunden wurde.

      Tipp: Stellen Sie sicher, dass die Schlüssel von VARA-Objekten immer einen Wert zurückgeben, wenn Sie diese Option verwenden möchten.

  5. Klicken Sie auf die Schaltfläche Vorschau, um eine Vorschau der gespeicherten oder übertragenen Ergebniswerte anzuzeigen.

  6. Um den Inhalt der Vorschautabelle in eine CSV-Datei zu exportieren, klicken Sie auf Tabelle exportieren. Alle Zeilen und Spalten werden exportiert. Verwenden Sie diese Funktion, wenn Sie den Inhalt der CSV-Datei weiter verarbeiten müssen (ihn in eine andere Anwendung zur weiteren Verarbeitung einfügen usw.).

  7. Um eine oder mehrere Zeilen in der Vorschautabelle zu kopieren, wählen Sie die Schaltfläche Kopieren aus. Die ausgewählten Zeilen werden in die Zwischenablage kopiert und Sie können sie in ein Drittanbieter-Tool (Google, Sheets, Excel, Texteditor usw.) einfügen.

    Hinweis: Diese Funktion ist nur verfügbar, wenn https in der Automic Web Interface verwendet wird.

  8. Speichern Sie Ihre Änderungen.

Ein EXEC VARA-Objekt in einer Vorbedingung verwenden

  1. Fügen Sie in einem ausführbaren Objekt einen Code ähnlich dem folgenden ein:
  2. :SET &RET# = "Y"

  3. Erstellen Sie eine EXEC-Variable, die auf das ausführbare Objekt verweist.
  4. Greifen Sie auf die EXEC-Variable zu, und zwar entweder in:
    • Script mit dem folgenden Code:SET &TEST# = GET_VAR(VARA.EXEC)
    • Eingabeaufforderung oder Vorbedingung mit {VARA.EXEC}

Ein EXEC VARA-Objekt als Datensequenz verwenden

Wenn die EXEC-Variable verwenden möchten, um eine Liste von Werten weiterzugeben (z. B. für die Verwendung des Ergebnisses in einem PromptSet-Dropdownfeld), gehen Sie wie folgt vor:

  • Zu diesem Zweck können Sie Datensequenzen verwenden (:CREATE_PROCESS, ....).
  • Die erste Zeile ist immer eine Kopfzeile.
  • Sie müssen die gespeicherte Datensequenz mit SAVE_PROCESS() zurückgeben.
  • Der Prozess muss direkt in dem Objekt gespeichert werden, das für die EXEC-Variable verwendet wird (Workflows mit JOBS und erstellte JOBS, die die Datensequenz gespeichert und veröffentlicht haben, funktionieren nicht).

Um in einem ausführbaren Objekt eine Liste von Werten zurückzugeben, müssen Sie etwas analog dem Folgenden eingeben:

:SET &HND# = CREATE_PROCESS(NEW)

! die Kopfzeile hinzufügen

:SET &CHECK# = PUT_PROCESS_LINE(&HND#, "Header A;Header B; Header C", ";")

! Füllen Sie den Prozess mit einem anderen aus!

:PROCESS &HND_SOURCE#

:   SET &CHECK# = PUT_PROCESS_LINE(&HND#, "Wert 1;Wert 2; Wert 3", ";")

:ENDPROCESS

! Prozess speichern

:SET &RET# = SAVE_PROCESS(&HND#)

:PUBLISH &RET#,,TOP

:CLOSE_PROCESS(&HND#)

Verweisen Sie in dem ausführbaren Objekt VARA.EXEC auf das Objekt mit dem Inhalt. Der Rückgabewert würde auf &RET# gesetzt.

Siehe auch: