ConfigStore: 一元的な設定管理

ConfigStore: 一元的な設定管理

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

Alert
早期アクセス
この機能は、すべてのユーザーに対して有効になっているわけではありません。試用をご希望の場合は、早期アクセスについてサポートチームにメールでお問い合わせください。

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

ConfigStoreの主なメリット

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

使用例

複数のリクエストでAPIキーを使用する必要がある場合は、ハードコードせずに、api_keyという名前のパラメーターとしてConfigStoreに保存します。その後、パラメーターを使用するタブに応じて、リクエスト内で {{api_key}} またはリンク名${<link-name of parameter>}を使用して、このパラメーターを参照できます。

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

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

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

パラメーターの作成

新しいパラメーターを作成するには、
  1. Qntrlにログインします。
  2.  (設定)→[詳細設定][ConfigStore]に移動し、[ConfigStore]を選択します。
  3. 新しいパラメーター]ボタンをクリックします。
  4. パラメーターの詳細を入力します。
    • [名前]:パラメーター名を入力します。
    • [値]:パラメーターの値を入力します。この値は、パラメーターが呼び出されるすべての場所で使用されます。
    • [初期値]:初期値を指定します。どの環境インスタンスにもパラメーター値が定義されていない場合は、空のパラメーター値によるエラーを防ぐため、この初期値が使用されます。
    • [種類]:パラメーター値をデータベースに保存する方法を選択します。
      • 既定の文字列- 文字列値は書式なしテキストとして保存されます。
      • 暗号化された文字列- 文字列値は暗号化して保存されます。
    • [表示設定]:ConfigStore変数にアクセスできる場所を定義します。
      • 内部:Qntrl内でのみ使用されます(スクリプト、自動処理、プレースホルダー)。
      • 外部:内部での使用に加えて、クライアントスクリプトやAPIからもアクセスできます。
    • [グループ]ドロップダウンから既存のグループを選択するか、+アイコンをクリックして新しいグループを作成します。グループを選択しない場合、パラメーターは既定のグループに保存されます。グループについては、詳細はこちらをご参照ください。
    • [スコープ]:サンドボックス環境内でパラメーター値を定義します。
      • グローバル
      • 環境
Notes
  • 環境スコープは、サンドボックス機能が有効な場合にのみ適用され、環境ごとにパラメーター値を定義できます。サンドボックス機能が無効な場合は、グローバルスコープのみ使用できます。
  • サンドボックスプロジェクトで表示設定を内部から外部に変更し、デプロイすると、設定がそれに応じて更新されます。
環境固有のパラメーター値の管理について詳しくは、環境スコープのセクションをご参照ください。
  1. 新しいパラメーターを保存するには、[保存]をクリックします。
  1. パラメーターを保存すると、[リンク名]項目にリンク名が自動生成され、パラメーターが左ペインに一覧表示されます。

Config Store:Client ScriptでのZDKサポート    

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

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

メリット  
  • スクリプトをシンプルかつ安全で、保守しやすい状態に保てます

  • スクリプトを更新せずに設定を変更できます

  • 環境ごとの柔軟な運用に対応できます

Alert
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の詳細をご確認ください。

Notes
  • これらのメソッドは、Client Scripts内でのみサポートされています。
  • Config Storeで外部としてマークされているパラメーターのみ、これらのメソッドでアクセスできます。

パラメーターの編集

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

パラメーターの削除

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

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

  3. 削除操作を確認します。 










    • Related Articles

    • CodeX Script のパラメーター

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

      お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 早期アクセス この機能は、すべてのユーザーに有効化されているわけではありません。試用をご希望の場合は、早期アクセスについてサポートチームにメールでお問い合わせください。 ...
    • パラメーターのサンドボックスにおける環境スコープ

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

      お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 Circuitのパラメーターを使用すると、自動ワークフローで動的な値を利用できます。これにより、プロセスの各部分をカスタマイズして制御しやすくなります。これらのパラメーターはConfigStoreで作成され、差し込み項目の値を使用してCircuitのさまざまな状態で参照できます。 ...
    • 追加コンポーネントの設定

      お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 早期アクセス Qntrl StudioのCircuitテンプレートは、すべてのユーザーには有効になっていません。お試しになりたい場合は、早期アクセスについてサポートチームにメールでお問い合わせください。 Webhook ...