ConfigStore: 一元的な設定管理

ConfigStore: 一元的な設定管理

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

ConfigStoreでは、Qntrl内の設定データを一元的かつ安全に整理して管理できます。パラメーター値を定義し、Qntrlのさまざまなモジュールや環境から動的に利用できるため、柔軟性、再利用性、セキュリティが向上します。複数のパラメーターを1つのグループにまとめることで、効率的に管理できます。

ConfigStoreの主なメリット

  • 一元管理：設定データを1か所に保存できるため、複数のスクリプトや関数に値を直接記述する必要がありません。
  • 動的なアクセス：さまざまな環境からパラメーター値に動的にアクセスできるため、手動で更新する手間を削減できます。
  • 柔軟性：各スクリプトや関数を個別に変更することなく、設定値を簡単に更新できます。
  • セキュリティの強化：パスワードやAPIキーなどの機密データをConfigStoreで一元的かつ安全に管理できます。パラメーター値の暗号化に対応しているため、機密データを暗号化された値として安全に保存できます。
  • 再利用性：Qntrlで対応しているモジュールや環境から、一意のリンク名を使用してパラメーターを参照できるため、一貫性が向上し、重複を削減できます。

利用例

複数のリクエストでAPIキーを使用する場合は、キーを直接記述せず、ConfigStoreにapi_keyという名前のパラメーターとして保存します。その後、パラメーターを使用するモジュールに応じて、リクエスト内で{{api_key}}またはリンク名${<link-name of parameter>}を使用して、このパラメーターを参照できます。

キーが変更された場合は、ConfigStoreのパラメーター値を更新すると、そのパラメーターを使用しているすべての箇所に変更が反映されます。この方法により、リクエスト内で繰り返し使用するデータを一元管理できるため、更新が簡単になり、ワークフロー全体の一貫性が向上します。

パラメーターとグループの上限

  • 各グループには最大25件のパラメーターを追加できます。
  • 各組織には最大100件のグループを作成できます。

パラメーターの作成

新しいパラメーターを作成するには、
  1. Qntrlにログインします。
  2. 「 （設定）→［詳細設定］→［ConfigStore］」に移動し、［ConfigStore］を選択します。
  3. ［新しいパラメーター］ボタンをクリックします。
  4. パラメーターの詳細を入力します。
    • ［名前］：パラメーターの名前を入力します。
    • ［値］：パラメーターの値を入力します。この値は、パラメーターが呼び出されるすべての箇所で使用されます。
    • ［初期値］：初期値を指定します。いずれの環境インスタンスにもパラメーター値が定義されていない場合は、この初期値が使用され、パラメーター値が空であることによる処理の失敗を防ぎます。
    • ［種類］：パラメーター値をデータベースに保存する形式を選択します。
      • ［標準文字列］：文字列の値は書式なしテキストとして保存されます。
      • ［暗号化文字列］：文字列の値は暗号化して保存されます。
    • ［表示設定］：ConfigStore変数にアクセスできる範囲を指定します。
      • ［内部］：Qntrl内（スクリプト、自動処理、差し込み項目）でのみ使用できます。
      • ［外部］：内部での使用に加えて、クライアントスクリプトやAPIからもアクセスできます。
    • ［グループ］：ドロップダウンから既存のグループを選択するか、［+］アイコンをクリックして新しいグループを作成します。グループを選択しなかった場合、パラメーターは初期設定のグループに保存されます。グループの詳細を確認できます。
    • ［適用範囲］：サンドボックス環境内のパラメーター値の適用範囲を指定します。
      • ［グローバル］
      • ［環境］
Notes
  • 環境の適用範囲は、サンドボックス機能が有効な場合にのみ利用でき、環境ごとにパラメーター値を定義できます。サンドボックス機能が無効な場合は、グローバルの適用範囲のみ利用できます。
  • サンドボックスプロジェクトで［表示設定］を［内部］から［外部］に変更して展開すると、設定もそれに応じて更新されます。
環境固有のパラメーター値の管理については、環境の適用範囲のセクションをご参照ください。
  1. 新しいパラメーターを保存するには、［保存］をクリックします。 
  1. パラメーターを保存すると、［リンク名］欄にリンク名が自動生成され、パラメーターが左側の欄に表示されます。

Config Store – クライアントスクリプトでのZDKサポート    

各環境から動的にアクセスできる外部パラメーターは、クライアントスクリプトのZDKメソッドを使用して取得できます。これにより、機密データや環境固有のデータをハードコードせずに、環境に応じたスクリプトを作成できます。

クライアントスクリプトを作成する際、APIキー、トークン、その他の環境固有の設定値が必要になる場合があります。これらをスクリプトに直接埋め込む代わりに、Config Storeに安全に保存し、実行時にZDKを使用して取得できます。

メリット。  

  • スクリプトを簡潔かつ安全で、保守しやすい状態に維持

  • スクリプトを更新せずに設定を変更可能

  • 環境に応じた柔軟な対応が可能

Alert
クライアントスクリプトのZDKを使用してアクセスできるのは、Config Storeの外部パラメーターのみです。

クライアントスクリプトでサポートされているZDKメソッド   

外部パラメーターを取得するためにクライアントスクリプトで使用できるZDKメソッドは、次のとおりです。

メソッド

説明

ZDK.QntrlParamAPI.getParamByLinkName(array)

リンク名を使用してパラメーターを取得します。

ZDK.QntrlParamAPI.getParamById(array)

一意のIDを使用してパラメーターを取得します。

ZDK.QntrlParamAPI.getAllParams()

現在の環境で使用できるすべての外部パラメーターを取得します。

これらのメソッドは、スクリプトが実行される環境に関連付けられた現在の値を返します。クライアントスクリプト向けのConfig Store ZDKについて、詳しくはこちらをご参照ください。

Notes
  • これらのメソッドがサポートされるのは、クライアントスクリプト内のみです。
  • Config Storeで外部として設定されたパラメーターのみ、これらのメソッドを使用してアクセスできます。

パラメーターの編集

  1. 左側のペインでパラメーター名をクリックします。
  2. 詳細ページで、必要な変更を行います。
  3. 変更を適用するには、［保存］をクリックします。

パラメーターの削除

  1. 左側のペインでパラメーター名の横にカーソルを合わせます。

  2. 削除アイコンをクリックします。

  3. 削除を確定します。