Konfiguration zurücksetzen

Das Zurücksetzen der Konfiguration ist nur in der Assistentenphase möglich und kann durch den Aufruf der Prozedur PUBLIC.RESET_CONFIGURATION() erfolgen. Dieser Vorgang setzt alle Voraussetzungen als nicht abgeschlossen zurück, löscht die zuvor gespeicherte Konfiguration und setzt den Status des Konnektors auf INSTALLED. Sie kann verwendet werden, wenn der Konnektor neu konfiguriert werden muss (d. h. wenn Sie den Schritt Voraussetzungen, Verbindungskonfiguration oder Konnektorkonfiguration erneut durchführen müssen). Konnektoren können nur neu konfiguriert werden, wenn Sie den Schritt Konfiguration abschließen nicht abgeschlossen haben. Die Rekonfiguration von Konnektoren kann mit SQL oder ResetConfigurationHandlerBuilder angepasst werden.

Nur Benutzer, denen die Anwendungsrolle ADMIN zugewiesen wurde, können die Prozedur PUBLIC.RESET_CONFIGURATION() aufrufen.

Das Zurücksetzen der Konfiguration besteht aus den folgenden konfigurierbaren Phasen, die standardmäßig keine Auswirkungen haben:

  1. Validierung des Status

  2. Validierung des Zustands

  3. Interner Callback

  4. SDK-Callback

  5. Aktualisierung des Status

Anforderungen

Das Zurücksetzen der Konfiguration erfordert die Ausführung der folgenden SQL-Dateien während der Installation der nativen App:

  • core.sql

  • configuration/app_config.sql

  • configuration/prerequisites.sql

  • configuration/connector_configuration.sql

  • configuration/connection_configuration.sql

  • configuration/reset_configuration.sql

Validierung des Status

Um die Konfiguration zurückzusetzen, muss sich der Konnektor im Status CONFIGURING befinden. Der Konfigurationsstatus muss einem der folgenden Werte entsprechen: INSTALLED, PREREQUISITES_DONE, CONFIGURED oder CONNECTED. Das vollständige Diagramm der Statusübergänge finden Sie unter Konnektorablauf.

Die Validierung kann nicht durch ResetConfigurationHandlerBuilder oder durch Überschreiben einer gespeicherten Prozedur überschrieben werden. Es ist jedoch möglich, einen kundenspezifischen Handler zu implementieren, der diese Art der Validierung nicht durchführt.

Validierung des Zustands

Die Phase der Validierung des Zustands ist anpassbar und führt standardmäßig die Prozedur PUBLIC.RESET_CONFIGURATION_VALIDATE() aus, die 'response_code': 'OK' zurückgibt. Diese Prozedur kann angepasst werden, indem die Prozedur durch SQL ersetzt wird oder indem die ResetConfigurationValidator-Weboberfläche implementiert wird.

Interner Callback

Die interne Callback-Phase ist anpassbar und führt standardmäßig die Prozedur PUBLIC.RESET_CONFIGURATION_INTERNAL() aus, die 'response_code': 'OK' zurückgibt. Diese Prozedur unterstützt die Ausführung der benutzerdefinierten Logik, die beim Zurücksetzen der Konfiguration erforderlich ist. Zum Beispiel das Löschen einer benutzerdefinierten Konfiguration. Diese Prozedur kann angepasst werden, indem die Prozedur durch SQL ersetzt wird oder indem die ResetConfigurationCallback-Weboberfläche implementiert wird.

SDK-Callback

Der SDK-Callback wird verwendet, um die SDK-gesteuerten Komponenten zu aktualisieren. Dieser Schritt besteht aus den folgenden Prozessen, die als eine einzige Transaktion ausgeführt werden:

  1. Setzen Sie alle Voraussetzungen als nicht erfüllt

  2. Konnektorkonfiguration löschen

  3. Verbindungskonfiguration löschen

Setzen Sie alle Voraussetzungen als nicht erfüllt

Bei diesem Schritt wird die Spalte IS_COMPLETED für alle Datensätze in der internen Tabelle PREREQUISITES auf „false“ gesetzt.

Konnektorkonfiguration löschen

Bei diesem Schritt wird connector_configuration aus der internen Tabelle APP_CONFIG gelöscht.

Konnektorkonfiguration löschen

Bei diesem Schritt wird connection_configuration aus der internen Tabelle APP_CONFIG gelöscht.

Der SDK-Callback kann nicht über ResetConfigurationHandlerBuilder oder durch Überschreiben der gespeicherten Prozedur überschrieben werden. Es ist möglich, einen eigenen Handler zu implementieren, der diesen Callback nicht hat.

Bemerkung

Die Ansicht PUBLIC.CONNECTOR_CONFIGURATION liefert die aktuelle Konfiguration aus der internen Tabelle APP_CONFIG. Die Ansicht PUBLIC.PREREQUISITES liefert die Voraussetzungen aus der internen Tabelle PREREQUISITES. Beide Ansichten sind für die Anwendungsrollen ADMIN und VIEWER verfügbar.

Aktualisierung des Status

Wenn dieser Schritt abgeschlossen ist, wird der interne Status des Konnektors auf gesetzt:

{
    "status": "CONFIGURING",
    "configurationStatus": "INSTALLED"
}
Copy

Antwort

Erfolgreiche Antwort

Wenn die Prozedur erfolgreich abgeschlossen wird, wird ein Antwortcode OK zurückgegeben, wie unten gezeigt:

{
  "response_code": "OK"
}
Copy

Fehlerantwort

Bei einem Fehler wird die folgende Antwort zurückgegeben:

{
  "response_code": "<ERROR_CODE>",
  "message": "<error message>"
}
Copy

Mögliche Fehlercodes sind:

  • INVALID_CONNECTOR_STATUS – Ungültiger Konnektorstatus. Erwarteter Status: [CONFIGURING]

  • INVALID_CONNECTOR_CONFIGURATION_STATUS – Ungültiger Konnektorstatus. Erwartete Zustände: [INSTALLED, PREREQUISITES_DONE, CONFIGURED, CONNECTED].

  • INTERNAL_ERROR – Es gibt intern ein Problem; die Meldung sollte beschreibend sein.

  • PROCEDURE_NOT_FOUND – Die aufgerufene Prozedur existiert nicht.

  • UNKNOWN_SQL_ERROR – Dieser Fehler tritt auf, wenn beim Aufruf interner Prozeduren etwas Unerwartetes passiert.

  • INVALID_RESPONSE – Dieser Fehler tritt auf, wenn die von der internen Prozedur empfangene Antwort nicht response_code enthält oder eine Fehlerantwort nicht message enthält, sondern response_code.

  • UNKNOWN_ERROR – Dies bedeutet, dass etwas Unerwartetes passiert ist (die Meldung der ausgelösten Ausnahme wird weitergeleitet).

  • Benutzerdefinierte Fehlercodes, die von den Prozeduren RESET_CONFIGURATION_INTERNAL und RESET_CONFIGURATION_VALIDATE empfangen werden – definiert durch den Entwickler des Konnektors.