構成をリセットする

構成のリセットはウィザード段階でのみ可能で、 PUBLIC.RESET_CONFIGURATION() プロシージャを呼び出すことで実行できます。このプロシージャでは、すべての前提条件が未完了としてリセットされ、以前に保存した構成が削除され、コネクタのステータスが INSTALLED にセットされます。コネクタを再設定する必要がある場合（つまり、 前提条件、 接続構成、 コネクタ構成 のステップを再度実行する）に使用できます。コネクターは、 最終構成 ステップが完了していない場合にのみ再設定できます。コネクターの再構成は、 SQL または ResetConfigurationHandlerBuilder を使用してカスタマイズできます。

ADMIN アプリケーション・ロールが割り当てられているユーザーのみが、 PUBLIC.RESET_CONFIGURATION() プロシージャを呼び出すことができます。

構成のリセットは、デフォルトでは効果のない、以下の構成可能なフェーズで構成されています。

  1. ステータスの検証

  2. 状態の検証

  3. 内部コールバック

  4. SDK コールバック

  5. ステータスの更新

要件

構成のリセットには、Native Appのインストール中に以下の SQL ファイルを実行する必要があります。

  • core.sql

  • configuration/app_config.sql

  • configuration/prerequisites.sql

  • configuration/connector_configuration.sql

  • configuration/connection_configuration.sql

  • configuration/reset_configuration.sql

ステータスの検証

構成をリセットするには、コネクタを CONFIGURING ステータスにする必要があります。構成ステータスは以下のいずれかに等しい必要があります。 INSTALLED、 PREREQUISITES_DONE、 CONFIGURED、 または CONNECTED です。ステータス遷移の完全な図については、 コネクタフロー を参照してください。

ResetConfigurationHandlerBuilder を使用したり、ストアドプロシージャを上書きしたりすることはできません。ただし、この種の検証を実行しないカスタムハンドラーを実装することはできます。

状態の検証

状態検証フェーズはカスタマイズ可能で、デフォルトでは PUBLIC.RESET_CONFIGURATION_VALIDATE() プロシージャを実行し、 'response_code': 'OK' を返します。このプロシージャは、 SQL を使用してプロシージャを置き換えるか、 ResetConfigurationValidator インターフェイスを実装することでカスタマイズできます。

内部コールバック

内部コールバックフェーズはカスタマイズ可能で、デフォルトでは PUBLIC.RESET_CONFIGURATION_INTERNAL() プロシージャを実行し、 'response_code': 'OK' を返します。このプロシージャは、構成をリセットする際に必要なカスタムロジックの実行をサポートします。例えば、カスタム構成の削除などです。このプロシージャは、 SQL を使用してプロシージャを置き換えるか、 ResetConfigurationCallback インターフェイスを実装することでカスタマイズできます。

SDK コールバック

SDK コールバックは、 SDK-制御コンポーネントを更新するために使用されます。このステップは以下のプロセスで構成され、1つのトランザクションとして実行されます。

  1. すべての前提条件を未完了にセット

  2. コネクタ構成の削除

  3. 接続構成の削除

すべての前提条件を未完了にセット

このステップでは、内部の PREREQUISITES テーブルのすべての記録について、 IS_COMPLETED 列が false にセットされます。

コネクタ構成の削除

このステップでは、 connector_configuration が APP_CONFIG テーブルから削除されます。

コネクタ構成の削除

このステップでは、 connection_configuration が APP_CONFIG テーブルから削除されます。

ResetConfigurationHandlerBuilder を使用して SDK コールバックを上書きしたり、ストアド プロシージャを上書きしたりすることはできません。このコールバックを持たないカスタムハンドラーを実装することも可能です。

注釈

PUBLIC.CONNECTOR_CONFIGURATION 表示は、内部 APP_CONFIG テーブルから現在の構成を返します。 PUBLIC.PREREQUISITES 表示は、内部の PREREQUISITES テーブルから前提条件を返します。どちらの表示も、 ADMIN および VIEWER アプリケーションロールが使用可能です。

ステータスの更新

完了すると、このステップはコネクターの内部ステータスを次のようにセットします。

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

応答

正常な応答

プロシージャが正常に完了すると、以下のように OK 応答コードが返されます。

{
  "response_code": "OK"
}
Copy

エラーの応答

エラーの場合、以下のレスポンスが返されます。

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

考えられるエラーコードは次のとおりです。

  • INVALID_CONNECTOR_STATUS - コネクタのステータスが無効です。期待されるステータス： [CONFIGURING]

  • INVALID_CONNECTOR_CONFIGURATION_STATUS - コネクタのステータスが無効です。予想されるステータス： [INSTALLED, PREREQUISITES_DONE, CONFIGURED, CONNECTED]。

  • INTERNAL_ERROR - 内部で問題が発生しました。メッセージには説明が必要です。

  • PROCEDURE_NOT_FOUND - 呼び出されたプロシージャが存在しません。

  • UNKNOWN_SQL_ERROR - このエラーは、内部プロシージャを呼び出すときに予期しない事態が発生したときに発生します。

  • INVALID_RESPONSE - このエラーは、内部プロシージャから受信した応答に response_code が含まれていない場合、またはエラーの応答に message が含まれていないが、 response_code が含まれている場合に発生します。

  • UNKNOWN_ERROR - 予期しない問題が発生したことを意味します（スローされた例外のメッセージが転送されます）。

  • RESET_CONFIGURATION_INTERNAL および RESET_CONFIGURATION_VALIDATE プロシージャから受信したカスタムエラーコード - コネクタ開発者が定義。

言語: 日本語