Triggervariablen - Referenz

Das System sucht nach den Namen der folgenden Umgebungsvariablen. Wenn eine dieser Variablen in der Umgebung eines Schritts enthalten ist, entweder dort angegeben oder von einem Projekt oder Server übernommen, werden Aktionen ausgeführt.

Variable

Inhalt

_CI_BUILD_DELETE

Legen Sie für diese Variable einen beliebigen Wert fest, um den Build und die zugeordneten Builddaten nach der Ausführung des Vorgangs zu löschen. (Die Tagvariable wird auf ihren Anfangswert zurückgesetzt, den sie vor dem gelöschten Build hatte, wenn keine anderen Projektbuilds ausgeführt werden.)

_CI_BUILD_KEEP

Legen Sie für diese Variable einen beliebigen Wert fest, um den Build und die zugeordneten Builddaten nach der Ausführung des Vorgangs beizubehalten. Wenn Ihr Vorgang beispielsweise eine Adapterverknüpfung enthält und der Adapterschritt fehlschlägt, werden die anderen Projektschritte nicht ausgeführt. Es empfiehlt sich, eine Kopie der Builddatensätze für den Vorgang aufzubewahren, beispielsweise für Debugging.

CLEARCASE_VIEW

Startet die angegebene ClearCase-Ansicht. Die in dieser Variablen angegebene Ansicht muss vorhanden sein und der Schritt, in dem diese Variable verwendet wird, muss auf "absolut" gesetzt sein. Auf Systemen mit Microsoft Windows muss diese Variable mit der Konfigurationsoption cc_suppress_server_root für den Agenten in bfagent.conf verwendet werden.

_CLEARCASE_VIEWS

Gibt eine Liste der ClearCase-Ansichten an, die vor der Ausführung des Befehls gestartet werden müssen. Legen Sie für diesen Wert eine durch Kommas getrennte Liste von Ansichten fest, beispielsweise "Sicht1,Sicht2,Sicht3".

_CLEARCASE_VOBS

Gibt eine Liste der ClearCase-VOBs an, für die vor der Ausführung des Befehls ein Mount durchgeführt werden muss. Legen Sie für diesen Wert eine durch Kommas getrennte Liste von VOBs fest, beispielsweise "VOB1,VOB2,VOB3".

_CONTEXT_LOG_RANGE

Verwenden Sie diese Variable zur Begrenzung der Protokollausgabe auf Zeilen neben den Filterübereinstimmungen. Sie nimmt eine positive Ganzzahl als Wert an und bewirkt, dass das System die Protokollausgabe übergeht, mit Ausnahme eines Zeilenbereichs im Umfeld der einzelnen Treffer der Filterzeichenfolge, dessen Größe gleich dem Wert der Variablen ist. Wenn Sie beispielsweise für die Variable den Wert 5 festlegen, werden in den Protokollen nur Zeilen mit Filterübereinstimmungen plus je fünf Zeilen vor bzw. nach diesen Übereinstimmungen angezeigt.

Anmerkung: Diese Variable wird nur für Projekte mit der Perl-Steuerkomponente verwendet.

_ERROR_THRESHOLD

Legt die maximal zulässige Fehlerzahl fest (die von den von Ihnen definierten Filtern 'Als Fehlschlag festlegen' erkannt werden). Mit dieser Variablen können Sie Fehlschlage- und Nachrichtenschwellenwerte für einzelne Schritte oder für ein Projekt definieren.

Verwenden Sie eines der folgenden Formate:

  • Der Wert 5 oder F5 gibt an, dass der Vorgang fehlschlagen soll, wenn mehr als fünf Fehler auftreten.
  • Der Wert N7 gibt an, dass das System den Vorgangshinweisen eine Nachricht hinzufügen soll, wenn mehr als sieben Fehler auftreten. Die Nachricht gibt dass, dieser Schwellenwert erreicht wurde.

Wenn Sie die Variable in einem Schritt verwenden, zählt das System die Fehler in einem einzelnen Schritt. Es sind weitere Formate verfügbar:

  • Ein Wert wie W9 gibt an, dass der Schritt nach neun Fehlern in einen Warnungsstatus versetzt wird, unabhängig von künftigen Fehlern, die von den Filtern erkannt werden.
  • Ein Wert wie C8 gibt an, dass der Schritt nach acht Fehlern in einen Fehlschlagstatus versetzt wird. Dieser Fehlschlag kann jedoch mit jedem Filter des Typs "Fehlschlag löschen" gelöscht werden.

HINWEIS: Die von dieser Variablen gezählten Fehler werden als Zeichenfolgen definiert, die mit Filtern mit Aktionen des Typs "Als Fehlschlag festlegen" übereinstimmen und die Schritten im Projekt zugewiesen sind. Jede von einem Filter als Fehlschlag erkannte Zeichenfolge wird als ein Fehler bezüglich der Summe der Schritte und als ein Fehler bezüglich der Summe der Projekte gezählt.

_EXITCODE_MAP

Gibt eine Liste von (durch Kommas, Leerzeichen, Semikola oder Doppelpunkte) getrennten Zahlen an, die das System als Anzeiger für den Erfolg eines Schritts akzeptieren sollte. Standardmäßig zeigt der Exit-Code 0 Erfolg an. Wenn diese Variable angegeben wird, zeigen alle darin aufgeführten Werte ebenfalls Erfolg an.

_InterfaceLoggingLevel

Steuert, wie viele Protokolldaten Build Forge bei der Ausführung eines Adapterschritts protokolliert. Erstellen Sie (in Ihrer Adapterumgebung) eine Umgebungsvariable namens _InterfaceLoggingLevel. Weisen Sie ihr einen ganzzahligen Wert zwischen 0 und 8 zu. Die Protokollebenen sind inklusive, z. B. schließt Ebene 2 Angaben der Ebenen 1 und 0 ein.
  • 0: Exec-Zeile plus Fehler bei der Serververbindung oder Benachrichtigung über Abbruch; sonst nichts
  • 1: Geparste Befehle (Befehle in der Form, in der sie an den Server gesendet werden)
  • 2: Ungeparste Befehle (Befehle vor dem Festlegen von deren lokalen Variablen)
  • 3: SET-Zeilen für Build- und Umgebungsvariablen
  • 4: SET-Zeilen für temporäre und interne Variablen
  • 5: Umgebungsauswertungen, neu hinzugefügte E-Mail-Gruppen, Zeilen mit protokolliertem Stücklistentext
  • 6: Start- und Endzeilen von Blöcken & Teilblöcken
  • 7: (Standardprotokollebene) Agentenausgabe, die anhand eines Vergleichsmusters überprüft wird, sowie die Zeilen, die mit den Mustern übereinstimmen
  • 8: Gesamte Ausgabe des Agenten

_LOG

Gibt einen Pfadnamen für die Erstellung einer Protokolldatei an, die die unformatierte Ausgabe des Build Forge-Agenten enthält.

Anmerkung: Dieses Protokoll enthält nur dann Zeitmarken, wenn auch _LOG_TIMESTAMP angegeben wird. Die Protokolldaten in dieser Datei sind normalerweise wie folgt formatiert: Agentencode, Protokollbereich und Nachricht.

Speichern Sie mithilfe dieser Variablen eine Kopie des Vorgangsprotokolls auf dem Server. Wenn die Datei vorhanden ist, hängt das System Informationen daran an.

_LOG_TIMESTAMP

Hiermit kann jede Ausgabezeile von _LOG ein Zeitmarkenpräfix erhalten. Der Wert dieser Variablen muss eine Formatierzeichenfolge mit derselben strftime-Syntax sein, die auch von den Umgebungsbefehlen .date und .gmdate verwendet wird.

Anmerkung: Hierfür ist _LOG erforderlich.

_MAP

Im Abschnitt Windows-Laufwerke zuordnen finden Sie eine Beschreibung der Verwendung dieser Variablen.

_NO_PREPARSE_COMMAND

In der Regel versucht das System, die Werte von Umgebungsvariablen aufzulösen, bevor Befehle an Agenten gesendet werden. Wenn die Variable _NO_PREPARSE_COMMAND (mit einem beliebigen Wert) definiert wird, sendet das System Variablen an Agenten, ohne sie aufzulösen. Stellen Sie mit dieser Variablen sicher, dass die Shell Ihres Betriebssystems die Variablen verarbeitet.

_PRISM_DIR_POSTCMD

Wird bei Plug-ins für IDEs verwendet. Kennzeichnet einen Befehl, der auf Verzeichnissen ausgeführt werden soll, nachdem der Projektschritt ausgeführt wurde. Siehe Spezielle Variablen für Testprojekte.

_PRISM_DIR_PRECMD

Wird bei Plug-ins für IDEs verwendet. Kennzeichnet einen Befehl, der auf Verzeichnissen ausgeführt werden soll, bevor diese auf den Server für einen Projektschritt kopiert werden. Siehe Spezielle Variablen für Testprojekte.

_PRISM_FILE_POSTCMD

Wird bei Plug-ins für IDEs verwendet. Kennzeichnet einen Befehl, der auf Dateien ausgeführt werden soll, nachdem der Projektschritt ausgeführt wurde. Siehe Spezielle Variablen für Testprojekte.

_PRISM_FILE_PRECMD

Wird bei Plug-ins für IDEs verwendet. Kennzeichnet einen Befehl, der auf Dateien ausgeführt werden soll, bevor diese auf den Server für einen Projektschritt kopiert werden. Siehe Spezielle Variablen für Testprojekte.

_SUPPRESS_ENV_OUTPUT

Gibt an, dass das System die Umgebungsnachrichten im Protokoll übergehen soll. Diese Variable ist standardmäßig nicht definiert und alle Variablenwerte in der Umgebung werden ausgegeben, bevor ein Schrittbefehl ausgeführt wird. Die Werte erscheinen als ENV-Einträge im Schrittprotokoll. Gültige Werte für diese Variable:
  • ALWAYS: ENV-Nachrichten immer übergehen.
  • Alle anderen Werte: Die ENV-Nachrichten übergehen. Wenn der Befehl jedoch fehlschlägt, werden die ENV-Nachrichten hinter den Befehlsnachrichten ausgegeben. Diese Informationen können für die das Debugging des Befehlsausführungsfehlers nützlich sein.

_SUPPRESS_AGENT_LOG_OUTPUT

Auf 1 gesetzt, verhindert dieser Wert, dass der Agent Protokolldaten an die Engine schickt. Vergleichen Sie _SUPPRESS_LOG_OUTPUT, bei der Protokolldaten vom Agenten gesendet, aber von der Engine gelöscht werden.

Anmerkung: Durch Verwendung dieser Variable werden Filterübereinstimmungen verhindert.

_SUPPRESS_LOG_OUTPUT

Wird der Wert auf 1 gesetzt, löscht die Engine beinahe die gesamte vom Agenten empfangene Protokollausgabe. Einige Konsolenprotokoll-Nachrichten bleiben erhalten. Filterübereinstimmungen werden angezeigt.

_TIMEOUT

Ein Wert, der die Eigenschaft "Zeitlimit" für einen oder alle Schritte in Ihrem Projekt überschreibt.

_TRAP

Eine Zeichenfolge, die beim Fehlschlagen des aktuellen Schritts ausgeführt werden soll. Für die Zeichenfolge kann der Name einer ausführbaren Datei oder eines Befehls festgelegt werden. HINWEIS: Die Ausgabe des Befehls wird nicht an die Konsole zurückgegeben, weil die Verbindung zwischen der Konsole und dem Agenten beim Fehlschlagen des Schritts unterbrochen wird. Wenn Sie die Ausgabe des ausgeführten Befehls mithilfe von _TRAP beibehalten wollen, müssen Sie sicherstellen, dass die Ausgabe des Befehls zum späteren Abruf in eine Datei geschrieben wird.

_USE_BFCREDS

Wenn für diese Variable der Wert 1 festgelegt wird, verwendet das System für die Serveranmeldung die Anmeldeberechtigungen des Benutzers, nicht jedoch die Berechtigungen, die in der an den Server angehängten Serverberechtigung gespeichert sind. Das System verwendet die Managementkonsole-Anmeldeberechtigungen des Benutzers, der das Projekt gestartet hat, um die Befehle in dem Projekt auszuführen. Sie können diese Variable für einen einzelnen Schritt oder für ein ganzes Projekt festlegen.
Anmerkung: Wenn Sie LDAP/Active Directory-Authentifizierung verwenden, müssen Sie für die Systemeinstellung Benutzerauthentifizierung lokal speichern deren Standardwert "Ja" festlegen, damit die Funktion _USE_BFCREDS funktioniert. Wenn die Einstellung "Ja" lautet, stellt das System die Informationen zur Benutzerauthentifizierung in verschlüsselter Form in den Cache und kann sie später von dort zur Verwendung mit _USE_BFCREDS abrufen.
Tipp: Unter Windows sollten Sie auch die Variable _USE_BFCREDS_DOMAIN berücksichtigen.

_USE_BFCREDS_DOMAIN (nur Windows)

Wenn für diese Variable der Wert 1 festgelegt wird, verwendet das System für die Serveranmeldung neben den von _USE_BFCREDS verwendeten Anmeldeberechtigungen die Domäne des Benutzers.

_XSTREAM_PROTOCOL Typ

Aktiviert direkte Dateiübertragungen zwischen Agenten.
Wichtig: Unter einigen Betriebssystemen werden Agenten bei direkter Dateiübertragung nur eingeschränkt unterstützt. Siehe Direkten Dateitransfer zwischen Agenten konfigurieren.

Die Engine, der sendende und der empfangende Agent - alle müssen direkte Dateiübertragungen unterstützen. Anderenfalls wird _XSTREAM_PROTOCOL ohne Warnung ignoriert und die normale Dateiübertragungsmethode verwendet.

Der empfangende Agent muss TCP-Verbindungen auf dem sendenden Agentenhost erstellen können. Die Firewalls, so vorhanden, müssen so konfiguriert sein, dass sie Verbindungen zulassen.

Der Protokoll- Typ bestimmt die Methode der Datenverschlüsselung, und muss einer der folgenden sein:

AES-CBC
Es werden kryptografisch starke Algorithmen zur Datenverschlüsselung verwendet. Beide Agenten müssen mit OpenSSL kompiliert werden und SSL für die Kommunikation mit der Engine verwenden. Der Verschlüsselungsschlüssel wird von der Engine angefordert.
PRNG
Ein Zufallszahlgenerator wird verwendet, um Dateiinhalte unkenntlich zu machen.
PLAIN
Dateien werden auf „as-is“-Basis ohne Verschlüsselung übertragen.