早期アクセス
この機能は、すべてのユーザーに対して有効になっているわけではありません。試用をご希望の場合は、早期アクセスについてサポートチームにメールでお問い合わせください。
ConfigStore は、Qntrl内の設定データを一元的かつ安全に整理して管理する方法を提供します。パラメーター値を定義し、Qntrl内のさまざまなタブや環境で動的にアクセスできるため、柔軟性、再利用性、セキュリティが向上します。複数のパラメーターを1つのグループにまとめることで、管理しやすくなります。
ConfigStoreの主なメリット
-
一元管理:設定データを1か所に保存できるため、複数のスクリプトや関数に値をハードコードする必要がなくなります。
-
動的アクセス:さまざまな環境でパラメーター値に動的にアクセスできるため、手動更新の手間を減らせます。
-
柔軟性:各スクリプトや関数を個別に変更せずに、設定値を簡単に更新できます。
-
セキュリティの強化:パスワードやAPIキーなどの機密データをConfigStore内で一元的に安全に管理できます。パラメーター値の暗号化に対応しているため、機密データを暗号化された値として安全に保存できます。
-
再利用性:Qntrlで対応しているタブや環境から、一意のリンク名でパラメーターを参照できるため、一貫性を保ち、重複を減らせます。
使用例
複数のリクエストでAPIキーを使用する必要がある場合は、ハードコードせずに、api_keyという名前のパラメーターとしてConfigStoreに保存します。その後、パラメーターを使用するタブに応じて、リクエスト内で {{api_key}} またはリンク名${<link-name of parameter>}を使用して、このパラメーターを参照できます。
キーが変更された場合は、ConfigStoreでパラメーター値を更新すると、そのパラメーターが使用されているすべての場所に変更が反映されます。この方法により、リクエスト内で繰り返し使用されるデータを一元管理でき、更新が簡単になり、ワークフロー全体の一貫性が向上します。
パラメーターとグループの上限
パラメーターの作成
新しいパラメーターを作成するには、
-
-
(設定)→[詳細設定]→[ConfigStore]に移動し、[ConfigStore]を選択します。
-
[新しいパラメーター]ボタンをクリックします。
-
パラメーターの詳細を入力します。
-
[名前]:パラメーター名を入力します。
-
[値]:パラメーターの値を入力します。この値は、パラメーターが呼び出されるすべての場所で使用されます。
-
[初期値]:初期値を指定します。どの環境インスタンスにもパラメーター値が定義されていない場合は、空のパラメーター値によるエラーを防ぐため、この初期値が使用されます。
-
[種類]:パラメーター値をデータベースに保存する方法を選択します。
-
[表示設定]:ConfigStore変数にアクセスできる場所を定義します。
-
[グループ]:ドロップダウンから既存のグループを選択するか、+アイコンをクリックして新しいグループを作成します。グループを選択しない場合、パラメーターは既定のグループに保存されます。グループについては、詳細はこちらをご参照ください。
-
[スコープ]:サンドボックス環境内でパラメーター値を定義します。
環境固有のパラメーター値の管理について詳しくは、環境スコープのセクションをご参照ください。
-
新しいパラメーターを保存するには、[保存]をクリックします。
Config Store:Client ScriptでのZDKサポート
異なる環境間で動的にアクセスできる外部パラメーターは、Client ScriptのZDKメソッドを使用して取得できます。これにより、機密データや環境固有のデータをハードコードせずに、環境に応じたスクリプトを作成できます。
Client Scriptsを作成する際、APIキー、トークン、その他の環境固有の設定などの値が必要になる場合があります。これらをスクリプトに直接埋め込む代わりに、Config Storeに安全に保存し、実行時にZDKを使用して取得できます。
メリット
Config Storeの外部パラメーターのみ、Client Script ZDKを通じてアクセスできます。
Client ScriptでサポートされているZDKメソッド
外部パラメーターの取得に使用できる、Client ScriptsでサポートされているZDKメソッドは次のとおりです。
|
メソッド |
説明 |
|
ZDK.QntrlParamAPI.getParamByLinkName(array) |
リンク名を使用してパラメーターを取得します。 |
|
ZDK.QntrlParamAPI.getParamById(array) |
一意のIDを使用してパラメーターを取得します。 |
|
ZDK.QntrlParamAPI.getAllParams() |
現在の環境で利用可能なすべての外部パラメーターを取得します。 |
これらのメソッドは、スクリプトが実行される環境に関連付けられている現在の値を返します。Client Scripts向けConfig Store ZDKの詳細をご確認ください。