MODIFY_SYSTEM

Verwenden Sie die Script-Funktion MODIFY_SYSTEM, um die Aktionen eines mit dem AE-System verbundenen ServiceManager-Elements zu verarbeiten, Queue-Objekte zu ändern, die Schritte in einem Zero Downtime Upgrade-Szenario zu steuern und Centralized Agent Upgrade (CAU)-Aktionen zu verarbeiten. Welche Aktionen diese Script-Funktion ausführen soll, hängt von den von Ihnen definierten Parametern ab.

Wichtig! Damit Sie mithilfe dieses Script-Elements Serverprozesse und Agenten starten können, muss ein ServiceManager verfügbar sein, der richtig konfiguriert wurde und mit dem AE-System verbunden ist. Weitere Informationen finden Sie in den Einstellungen auf der Seite Attribute von Agenten- oder Server-Objekten. Weitere Informationen finden Sie auf der Seite Die Seite Attribute definieren.

Queue-Objekte

Verwenden Sie die Script-Funktion MODIFY_SYSTEM, um die Werte oder Zustände von Queue-Objekten (GO/STOP) zu ändern.

Syntax

MODIFY_SYSTEM (Aktion, Queue, Wert)

Parameter

• MODIFY_SYSTEM
  Verarbeitet Service Manager-Aktionen oder Queue-Änderungen
• Action
  Definiert die in Queue-Objekten vorzunehmenden Änderungen
  Format: Script-Literal oder Script-Variable
  Zulässige Werte:
  • MODE
    Queue-Status, Start/Stopp der Ausführung von Queue-Aufgaben
    Hinweis: Wenn mithilfe dieses Script-Elements in der Aktion MODE der Status der Queue-Objekte mit Start oder Stopp geändert wird, wirkt sich dies insofern aus als der neue Status gültig bleibt, bis eine neue Änderung vorgenommen wird.
  • MAX_SLOTS
    Maximale Anzahl der Aufgaben, die gleichzeitig ausgeführt werden können (max. Slots)
    Hinweis: Änderungen an den maximalen Queue-Slots bleiben gültig, bis diese Werte infolge einer Ausnahme oder durch eine manuelle Änderung durch einen Benutzer geändert werden. Entsprechende Informationen finden Sie unter Berücksichtigen der ERT in Queue-Objekten.
  • PRIORITY
    Aufgabenpriorität
    Hinweis: Änderungen an der Priorität bleiben gültig, bis diese Werte infolge einer Ausnahme oder durch eine manuelle Änderung durch einen Benutzer geändert werden. Entsprechende Informationen finden Sie unter Berücksichtigen der ERT in Queue-Objekten.
• Queue
  Name des Queue-Objekts, das geändert werden soll.
  Format: Script-Literal oder Script-Variable
• Value
  Wert für die Einstellung oder den Status, die bzw. der geändert werden soll (Action)
  Format: Script-Literal oder Script-Variable
  Zulässige Werte:
  • Für den Typ Action von MODE
    GO oder STOP
  • Für den Typ Action MAX_SLOTS
    Eine beliebige Zahl zwischen 0 und 99999 oder UNLIMITED
    Hinweis: Die Anzahl der gleichzeitig ausgeführten Aufgaben ist unbegrenzt, falls die maximalen Slots der Queue-Objekte in UNLIMITED geändert werden.
  • Für den Typ Action von PRIORITY
    Eine beliebige Zahl zwischen 0 und 255

Beispiel

Das folgende Beispiel setzt den Status des Queue-Objekts QUEUE.JOBS auf GO:

: SET &RET# = MODIFY_SYSTEM("MODE", "QUEUE.JOBS", "GO")
:IF &RET# = "0"
: PRINT " Verarbeitung des Queue-Objekts QUEUE.JOBS wurde erfolgreich aktiviert."
:ELSE
: PRINT "QUEUE.JOBS: Fehler bei der Änderung des Status auf GO."
:ENDIF

Rückgabewerte

• 0
  Die für diese Script-Funktion definierte Aktion wurde erfolgreich ausgeführt.
• 11901
  Das angegebene Queue-Objekt konnte im Mandanten nicht gefunden werden.
• 20836
  Es wurde ein ungültiger Wert für die Priorität des Queue-Objekts oder die maximalen Slots angegeben.
• 20837
  Für den Parameter MOD wurde ein ungültiger Wert angegeben.

ServiceManager

Verwenden Sie die Script-Funktion MODIFY_SYSTEM, um die Aktionen eines mit dem AE-System verbundenen ServiceManager-Elements zu verarbeiten.

Syntax

MODIFY_SYSTEM (Action, Name [,Servermodus])

Parameter

• MODIFY_SYSTEM
  Verarbeitet Service Manager-Aktionen oder Queue-Änderungen

• Action
  Definiert die für Agenten, Serverprozesse oder das AE-System vorzunehmende Aktion
  Format: Script-Literal oder Script-Variable
  Zulässige Werte:

  • STARTUP
    Startet einen Agenten oder Serverprozess
    Hinweis: Diese Aktion kann nur verwendet werden, falls ein ServiceManager verfügbar und der zu startende Agent oder Serverprozess richtig konfiguriert ist. Weitere Informationen finden Sie in den Einstellungen auf der Seite Attribute von Agenten- oder Server-Objekten. Weitere Informationen finden Sie auf der Seite Die Seite Attribute definieren.
  • TERMINATE
    Beendet einen Agenten oder einen Serverprozess
    
  • SHUTDOWN
    Fährt das gesamte AE-System herunter
    Hinweis: Damit Sie das AE-System mithilfe von SHUTDOWN herunterfahren können, müssen Sie UC4 als den Wert für den Parameter Name festlegen. Weitere Informationen finden Sie unter :SHUTDOWN.
  • CHANGE_MODE
    Ändert den Modus des Arbeitsprozesses (WP) eines Servers.
  • DISCONNECT
    Trennt die Agentenverbindung und stellt sie wieder her
• Name
  Name des Agenten oder Serverprozesses, der gestartet oder beendet oder dessen Modus geändert werden soll
  Format: Script-Literal oder Script-Variable
• Server mode
  (Optional) Modus, in den das angegebene WT-Element geändert werden soll
  Wichtig! Verwenden Sie diesen Parameter nicht zusammen mit den Aktionen STARTUP, TERMINATE, DISCONNECT und SHUTDOWN.
  Format: Script-Literal oder Script-Variable
  Zulässige Werte:
  • D
    Dialogprozess
  • W
    Arbeitsprozess

Beispiel

Im folgenden Beispiel wird der Agent WIN01 heruntergefahren:

: SET &ACT# = MODIFY_SYSTEM("TERMINATE", "WIN01")

Rückgabewerte

• 11677
  Der ServiceManager-Aufruf konnte nicht verarbeitet werden. Es wird kein CP gestartet
• 11678
  Server oder Agent wurde nicht gestartet
• 11679
  Erfolgreiche ServiceManager-Abfrage
• 11680
  Die Verbindung mit ServiceManager konnte nicht hergestellt werden, oder der angegebene Prozess konnte nicht im ServiceManager gefunden werden
• 11681
  Ein ServiceManager-Aufruf ist nicht möglich, da der angegebene Host-Typ nicht unterstützt wird
• 11682
  Ein ServiceManager-Aufruf ist nicht möglich, da der angegebene Agenten-/Serverprozess nicht gefunden werden konnte
• 11683
  Ein ServiceManager-Aufruf wird nicht verarbeitet, da der Server nicht mit dem angegebenen ServiceManager verknüpft ist oder die gleiche Abfrage bereits bearbeitet wurde
  

Zero Downtime Upgrade

Verwenden Sie die Script-Funktion MODIFY_SYSTEM, um die Verarbeitungsrichtung in einem Zero Downtime Upgrade-Szenario (ZDU) oder beim Abschließen der Zero Downtime Upgrade-Phase umzuschalten.

Wichtig!

• Wird nur dann zum Vornehmen eines Zero Downtime Upgrades verwendet, falls der Schlüssel ZERO_DOWNTIME_UPGRADE der Variablen UC_SYSTEM_SETTINGS auf „Y“ festgelegt ist.
• Das Datenbank-Upgrade muss zuvor erfolgreich durchgeführt werden. Mindestens ein CP und ein WP der neuen Version müssen einsatzbereit sein.
• Weitere Informationen über Zero Downtime Upgrades finden Sie unter Aktualisierungsprozess.

Syntax

MODIFY_SYSTEM (Aktion, Wert)

Parameter

• MODIFY_SYSTEM
  Schaltet in einem ZDU
  die Verarbeitungsrichtung um
• Action
  Zulässiger Wert:
  • ZERO_DOWNTIME_UPGRADE
    Zero Downtime Upgrade-Steuerung
• Value
  Dieser Parameter gilt für Routing-Nachrichten, die von neuen oder alten WPs/CPs verarbeitet werden.
  Zulässige Werte:
  • BEGIN
    Legt den Schlüssel ZERO_DOWNTIME_UPGRADE der Variablen UC_SYSTEM_SETTINGS auf „Y“ fest
  • END
    Legt den Schlüssel ZERO_DOWNTIME_UPGRADE der Variablen UC_SYSTEM_SETTINGS auf „N“ fest. Dies ist nur möglich, bevor Sie Schritte im Upgrade-Prozess ausführen.
  • UPGRADE
    Definiert den Upgrade-Modus. Der zu den neuen CPs und WPs gehörende Meldungs-Queue-Satz ist auf aktiv festgelegt. Die PWP-Rolle wechselt zu einem neuen WP. Meldungen werden an die neue Verarbeitung weitergeleitet, während die alte Verarbeitung ausläuft.
  • ROLLBACK
    Definiert den Rollback-Modus. Der zu den alten CPs und WPs gehörende Meldungs-Queue-Satz ist auf aktiv festgelegt. Meldungen werden zurück zur alten Verarbeitung geleitet, während die neue Verarbeitung ausläuft.
  • FINALIZE
    Schließt die Zero Downtime Upgrade-Phase ab, indem die aktuell aktive Meldungs-Queue als Basis festgelegt und UC_SYSTEM_SETTINGS / ZERO_DOWNTIME_UPGRADE auf „N“ zurückgesetzt wird

Beispiel

Dieses Beispiel zeigt die Einstellungen, die für den Start des Rollbacks notwendig sind:

:SET &RET # = MODIFY_SYSTEM("ZERO_DOWNTIME_UPGRADE", "ROLLBACK")

Rückgabewerte

• 0
  Die für diese Script-Funktion definierte Aktion wurde erfolgreich ausgeführt.
• 11895
  Warnung für Zero_Downtime_Upgrade: Kein aktiver CP oder WP für aktive Version gefunden. [Festgelegter] Modus wurde aktiviert.
• 20833
  Laufzeitfehler in Objekt [angegeben]: MODIFY_SYSTEM mit Opcode ZERO_DOWNTIME_UPGRADE nicht gültig. ZERO_DOWNTIME_UPGRADE in UC_SYSTEM_SETTINGS nicht gesetzt.
• 20846
  Laufzeitfehler in Objekt [angegeben]: MODIFY_SYSTEM (ZERO_DOWNTIME_UPGRADE) nicht gültig mit Opcode [angegeben]. Upgrade-Version nicht in der DB gefunden. Bitte laden Sie zuerst die Version mit DB-Load.
• 20890
  Laufzeitfehler im Objekt [angegeben]: Fehler in MODIFY_SYSTEM. Funktion [angegebene Aktion] für Opcode 'ZERO_DOWNTIME_UPGRADE' nicht zulässig.
• 20891
  Laufzeitfehler in Objekt [angegeben]: ZERO_DOWNTIME_UPGRADE - ROLLBACK nicht möglich. Es gibt noch Agenten [specified], die mit der Version [specified] verbunden sind
• 20892
  Laufzeitfehler in Objekt [angegeben]: ZERO_DOWNTIME_UPGRADE - ROLLBACK nicht möglich. Es gibt noch [angegeben] aktive Aufgaben mit der Version > [angegeben].
• 20893
  Laufzeitfehler in Objekt [angegeben]: ZERO_DOWNTIME_UPGRADE - UPGRADE nicht möglich. Kein Arbeitsprozess mit aktiver Upgrade-Version aktiv.
  20894 - Laufzeitfehler in Objekt [angegeben]: ZERO_DOWNTIME_UPGRADE - ROLLBACK nicht möglich. Der Rollback-Modus ist bereits aktiv.
• 20895
  Laufzeitfehler in Objekt [angegeben]: ZERO_DOWNTIME_UPGRADE - UPGRADE nicht möglich. Der Upgrade-Modus ist bereits aktiv.
• 20896
  Laufzeitfehler in Objekt [angegeben]: ZERO_DOWNTIME_UPGRADE - FINALIZE nicht möglich. Der Upgrade-Modus ist nicht aktiv.
• 20897
  Laufzeitfehler in Objekt [angegeben]: MODIFY_SYSTEM (ZERO_DOWNTIME_UPGRADE) nicht gültig mit Opcode [angegeben]. Aktuelle (Basis-)Version nicht in der Datenbank gefunden.
• 20898
  Laufzeitfehler in Objekt [angegeben]: MODIFY_SYSTEM (ZERO_DOWNTIME_UPGRADE) nicht gültig mit Opcode [angegeben]. ZERO_DOWNTIME_UPGRADE bereits auf "Y" gesetzt.
• 20899
  Laufzeitfehler in Objekt [angegeben]: ZERO_DOWNTIME_UPGRADE - FINALIZE_ROLLBACK nicht möglich. Rollback-Modus nicht aktiv.
• 20900
  Laufzeitfehler in Objekt [angegeben]: ZERO_DOWNTIME_UPGRADE - END nicht möglich. Der Upgrade-Modus ist weiterhin aktiv. Verwenden Sie zuerst FINALIZE.
• 20901
  Laufzeitfehler im Objekt [angegeben]: ZERO_DOWNTIME_UPGRADE - [angegebene Aktion] nicht möglich. Alte CPs der Version haben noch offene Verbindungen.
• 20902
  Laufzeitfehler im Objekt [angegeben]: ZERO_DOWNTIME_UPGRADE - [angegebene Aktion] nicht möglich. Es gibt noch Einträge in MQWP.
• 20903
  Laufzeitfehler im Objekt [angegeben]: ZERO_DOWNTIME_UPGRADE - [angegebene Aktion] nicht möglich. Es gibt noch Einträge in MQJWP.
• 29177
  UCUDB: ZERO_DOWNTIME_UPGRADE - Das Caching der Tabellenstruktur wird nicht mehr verwendet.
• 29178
  UCUDB: ZERO_DOWNTIME_UPGRADE - Caching der Tabellenstruktur ist aktiviert.
• 38276
  ZERO_DOWNTIME_UPGRADE = 'Y' ist nur erlaubt bei einem laufenden System.

Centralized Agent Upgrade (CAU)

Verwenden Sie die Script-Funktion MODIFY_SYSTEM, um Aktionen für die Verarbeitung eines Centralized Agent Upgrade (CAU) auszuführen.

Wichtig!

• Sie müssen den Import von Upgrade-Paketen für das CAU im Systemmandanten 0 durchführen.
• Das CAU kann von jedem Mandanten Ihres Systems aus ausgeführt werden, falls die zu aktualisierenden Agenten und die Benutzer über die entsprechenden Berechtigungen dafür verfügen.
• Der Benutzer, der diese Scripts ausführt, benötigt die Berechtigung Agenten aktualisieren (CAU).
• Weitere Informationen finden Sie unter CAU - Aktualisierungsprozess.

Syntax

MODIFY_SYSTEM (Action, Subfunction, Agent(s), Version[,FORCED][,Custom text])

Parameter

• MODIFY_ACTION
  Verarbeitet Aktionen für ein CAU
• Action
  Zulässiger Wert:
  • AGENT_UPGRADE
    Centralized Agent Upgrade (CAU)
• Subfunction
  Zulässige Werte:

  • DEPLOY
    Stellt einen Agenten bereit, der durch den Parameter Version angegeben ist.

  • SKIP_WAITING
    Überspringt ein registriertes Deployment für aktuell inaktive oder beschäftigte Agenten

• Agent(s)
  Bezieht sich auf eine Datensequenz oder auf einen Filter für einen Agentennamen, worauf die Action angewendet werden soll
  Format: Script-Literal oder Script-Variable
• Version
  Vollsemantische Version, auf die der Agent aktualisiert werden soll, oder der Name des Storage-Objekts oder das Literal LATEST
  Beispiel:
  "12.0.0+BUILD.2112" oder LATEST für die neueste verfügbare Version des Agenten, repräsentiert durch ein APM-Paket in Mandant 0 des aktuellen Systems.
  Format: Script-Literal oder Script-Variable
  Wichtig! Verwenden Sie diesen Parameter nur zusammen mit dem Wert DEPLOY des Parameters Subfunction.
• FORCED
  (Optional) Fixwert: FORCED
  Hinweis: Falls dieser Parameter festgelegt ist, wird die Prüfung, ob ein Agent über eine aktive ServiceManager-Verbindung verfügt, übersprungen (nur mit DEPLOY verwenden).
• Custom text
  (Optional) Freitext
  Maximale Länge: 20
  Zulässige Zeichen: Identisch mit denen auf der Seite „Allgemein“ von Workflows. Weitere Informationen finden Sie auf der Registerkarte Konfigurieren der allgemeinen Eigenschaften einer Aufgabe in einem Workflow.
  Hinweis: Falls dieser Parameter festgelegt ist, wird der Text als ein Namenspräfix für den obersten Statistikdatensatz (statt der ausschließlichen CAU -Verwendung bei DEPLOY) verwendet.
  

Beispiele

Beispiel-Script, das neue Agenten bereitstellt:

: SET &HND# = PREP_PROCESS_AGENTGROUP("AGENTGROUP_WINDOWS")
:SET &RUNID# = MODIFY_SYSTEM (AGENT_UPGRADE, DEPLOY, &HND#, "LATEST", FORCED, "MYHOTFIXUPGRADE" )
!OR
!:SET &RUNID# = MODIFY_SYSTEM (AGENT_UPGRADE, DEPLOY, &HND#, "12.0.0+BUILD.2112", FORCED, "MYHOTFIXUPGRADE" )
:IF &RUNID# = 0
:SET &MSGNR# = SYS_LAST_ERR_NR()
:SET &MSGINSERT# = SYS_LAST_ERR_INS()
:SET &MSG# = GET_MSG_TXT(&MSGNR#, &MSGINSERT#)
:SEND_MSG &$USER#, &$DEPARTMENT#, &MSG#
:ENDIF

Beispiel-Script, das definiert, dass das Aktualisieren von wartenden Agenten übersprungen wird:

: SET &SKIPCOUNT# = MODIFY_SYSTEM (AGENT_UPGRADE, SKIP_WAITING, "AGENTNAMEORFILTER")
:SET &MSGNR# = SYS_LAST_ERR_NR()
:IF &MSGNR# > 0
: SET &MSGINSERT# = SYS_LAST_ERR_INS()
: SET &MSG# = GET_MSG_TXT(&MSGNR#, &MSGINSERT#)
: SEND_MSG &$USER#, &$DEPARTMENT#, &MSG#
:ENDIF

Rückgabewerte

Aktion DEPLOY für AGENT_UPGRADE

• 0
  Der Upgrade-Prozess konnte nicht gestartet werden. Überprüfen Sie die Ursache(n), unter Verwendung von SYS_LAST_ERR_NR() und SYS_LASR_ERR_INS()

• >0
  RunID für den gesamten Upgrade-Prozess, der für jeden verarbeiteten Agenten eine Berichtszeile hat.

Aktion SKIP_WAITING für AGENT_UPGRADE

• >=0
  AGENT_UPGRADE - Anzahl der erfolgreich übersprungenen Upgrades

Siehe auch: