UC_CALLBACK_SETTINGS - Anpassung der REST-Callback-Anforderung

Mit diesem Variablen (VARA)-Objekt können Sie das Verhalten der REST-Callback-Anforderung und den Inhalt der Nutzdatenantwort anpassen.

UC_CALLBACK_SETTINGS wird mit dem Systemmandanten 0 geliefert und kann auf die relevanten Mandanten kopiert werden. Wenn die Variable im Mandanten 0 definiert ist, verwenden alle Ihre Mandanten die gleiche Konfiguration. Sie können die Definition im Mandanten 0 jedoch überschreiben, indem Sie die Variable in den jeweiligen Mandanten kopieren und die Konfiguration ändern. Das System prüft zuerst, ob die Variable im aktuellen Mandanten definiert wurde. Wenn nicht, prüft das System Mandant 0. Wenn kein Mandant eine spezifische Definition enthält, verwendet das System die Standardwerte.

Die Variable enthält die folgenden Schlüssel:

CALLBACK_ATTEMPTS

  • Beschreibung: Maximale Anzahl von Callback-Versuchen nach dem ersten Versuch

  • Erlaubte Werte: 1 (erster Versuch), 2 - N (Anzahl erneuter Versuche nach dem ersten Versuch)

  • Standardwert: 3

  • Neustart erforderlich: Nein

CALLBACK_INTERVAL

  • Beschreibung: Intervall in Sekunden zwischen Callback-Versuchen, wenn der anfängliche Versuch fehlschlägt

  • Erlaubte Werte: 30-N

  • Standardwert: 30

  • Neustart erforderlich: Nein

CALLBACK_INTERVAL_EXP

  • Beschreibung: Hier können Sie weiter definieren, wie das Intervall zwischen Callback-Versuchen berechnet wird.

  • Erlaubte Werte: 0 (konstant), 1 (linear), 2 (quadratisch)

    • Konstante: Das System verwendet den im CALLBACK_INTERVAL-Schlüssel definierten Wert

    • Linear: Das System multipliziert den im Schlüssel CALLBACK_INTERVAL mit der Anzahl der fehlgeschlagenen Versuche.

      Beispiel

      Sie haben ein Intervall von 30 Sekunden definiert und möchten den linearen Modus verwenden.

      Wenn der erste Versuch fehlschlägt, findet der erste Callback-Versuch nach 30 Sekunden (1 fehlgeschlagener Versuch * 30 Sekunden), der zweite nach 60 Sekunden (2 fehlgeschlagene Versuche* 30 Sekunden) und so weiter statt.

    • Quadratisch: Das System berechnet exponentiell das Intervall aus der Definition des CALLBACK_INTERVAL-Schlüssels und der Anzahl der fehlgeschlagenen Versuche.

      Beispiel

      Sie haben ein Intervall von 30 Sekunden definiert und möchten den quadratischen Modus verwenden.

      Wenn der erste Versuch fehlschlägt, findet der erste Rückrufversuch nach 30 Sekunden (1 fehlgeschlagener Versuch: 12 * 30 Sekunden) statt, der zweite nach 120 Sekunden (2 fehlgeschlagene Versuche: 22 * 30 Sekunden), der dritte nach 270 Sekunden (3 fehlgeschlagene Versuche: 32 * 30 Sekunden) usw.

  • Standardwert: 2

  • Neustart erforderlich: Nein

ENFORCE_HTTPS

  • Beschreibung: Ermöglicht es Ihnen, das HTTPS-Protokoll für Callback-Anforderungen durchzusetzen

  • Erlaubte Werte: Y (nur HTTPS) und N (HTTP und HTTPS)

  • Standardwert: N

    Wenn dieser Wert auf Y gesetzt ist und das Callback-Protokoll HTTP verwendet, wird der Callback nicht ausgeführt und eine Fehlermeldung wird in die Logdatei des JWP geschrieben. Der Callback-Eintrag wird auch in der Aufgabenliste in der Process Monitoring-Perspektive mit dem Status FAULT_OTHER angezeigt. Der Bereich Details für den jeweiligen Eintrag weist darauf hin, dass Sie HTTPS-URLs für diesen REST-Callback verwenden müssen und dass die angegebene URL ungültig ist.

  • Neustart erforderlich: Nein

TEMPLATE_EXECUTION

  • Beschreibung: Nutzdatenvorlage mit Platzhaltern, die ersetzt werden müssen, bevor die Nutzdatenantwort an den Callback-Abonnenten zurückgeschickt wird. Standardmäßig deckt die Vorlage nur einen Minimalsatz von Ausführungsattributen ab. Jedoch können Sie die Nutzdatenantwort Ihren Anforderungen entsprechend anpassen.

    Beispiel 

    {
   "runid": "&$RUNID#",
   "object_type": "&$OBJECT_TYPE#",
   "execution_status": "&$EXECUTION_STATUS#",
   "execution_status_text": "&$EXECUTION_STATUS_TEXT#",
   "ae_system": "&$SYSTEM#",
   "client_number": "&$CLIENT#",
   "client_description": "&$CLIENT_DESC#",
   "user_department": "&$USER#/&$DEPARTMENT#",
   "archive_key1": "&$ARCHIVE_KEY1#",
   "last_error_message": "&$LAST_ERROR_MESSAGE#",
   "last_error_code": "&$LAST_ERROR_CODE#",
   "last_error_insert": "&$LAST_ERROR_INSERT#",
   "object_variable1": "&VAR1#",
   "object_variable2": "&VAR2#"
}

    HTTP 200-Antwort: 

    {
  "runid": "0001005016",
  "object_type": "SCRI",
  "execution_status": "1900",
  "execution_status_text": "ENDED_OK - ended normally",
  "ae_system": "AUTOMIC",
  "client_number": "0100",
  "client_description": "Test client",
  "user_department": "CD/CD",
  "archive_key1": "Category17",
  "last_error_message": "",
  "last_error_code": "00000000",
  "last_error_insert": "",
  "object_variable1": "17842312",
  "object_variable2": "a text value"
}

    Weitere Informationen finden Sie unter Polling- und Callback-Anforderungen.

    Um die Nutzlast anzupassen, können Sie eine oder mehrere der folgenden Optionen verwenden:

    • Variablen, die für jedes ausführbare Objekt gültig und im gesamten System konsistent sind, finden Sie unter Liste der Systemeigenschaften
    • Variablen, die für ein Objekt spezifisch sind, finden Sie auf Seite "Variablen"
    • Vorlagenplatzhalter, die für Callbacks spezifisch sind:

      • &$EXECUTION_STATUS#

      • &$EXECUTION_STATUS_TEXT#

      • &$LAST_ERROR_MESSAGE#

      • &$LAST_ERROR_CODE#

      • &$LAST_ERROR_INSERT#

  • Neustart erforderlich: Nein

Siehe auch:

Liste der VARA-Objekte für System- und Mandantenwerte