CodeX Script のパラメーター

CodeX Script のパラメーター

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

CodeXスクリプトでは、SDKを通じてQntrlのパラメーターに対してCRUD（作成、読み取り、更新、削除）操作を実行できます。URLなどの値をCodeXスクリプト内で直接定義する代わりに、ConfigStoreで定義し、CodeXでパラメーター名を使用してそれらの値を参照できます。この方法により、再利用性が高まり、更新が簡単になります。CodeXスクリプトの詳細をご確認ください。

CodeXスクリプトでのConfigStoreの使用方法

  • ConfigStoreでのパラメーターの定義：URLやAPIキーなど、必要なパラメーターを作成して保存します。
  • CodeXスクリプトでのパラメーターの参照：パラメーター名またはリンク名を使用して、ConfigStoreに保存されている値を参照します。たとえば、api_url パラメーターは、CodeXスクリプトで{{api_url}}を使用して参照します。
  • CRUD操作：SDKを使用して、ConfigStoreに保存されているパラメーターに対する作成、読み取り、更新、削除の各操作をCodeXスクリプトから直接実行します。


パラメーターの呼び出し方法

  1. パラメーター名の使用：パラメーター名とグループ名の両方が必要です。

    • QntrlParam.ofName(paramName, paramGroupName)

  1. パラメーターリンク名の使用：パラメーターリンク名が必要です。

    • QntrlParam.ofLinkName(paramLinkName)

  1. パラメーターIDの使用：パラメーターIDが必要です。

    • QntrlParam.of(paramID)

 

例

// URLをハードコードする代わりに、ConfigStoreから参照します
let apiUrl = QntrlParam.ofLinkName('api_url'); 
// 参照したURLをCodeXスクリプトで使用します
let httpReq = new HttpRequest(); 
httpReq.url(apiUrl);
httpReq.method('GET');
httpReq.headers('{ 'Content-Type': 'application/json' } ');
let httpRes = httpReq.execute();

 

CodeXでのCRUD操作

パラメーターの作成

パラメーターを作成するには、名前と値が必須です。グループを指定しない場合、初期値は'none'になります。スコープを指定しない場合、初期値は'global'になります。暗号化パラメーターの初期値はfalseです。     
構文
QntrlParam.create('<param name>', '<group name>', true/false, QntrlParam.Scope.<GLOBAL/ENV>, '<param value>', '<初期値>');

パラメーターの読み取り

パラメーター名、リンク名、またはIDを使用して、パラメーターの詳細を取得できます。これにより、名前、ID、スコープなど、パラメーターのすべての詳細を取得できます。

名前によるパラメーターの取得  

構文
var param = QntrlParam.ofName('<param name>', '<group name>');

Notes
名前でパラメーターを取得する場合は、グループ名を指定する必要があります。グループ名を指定しない場合、デフォルトグループが使用されます。指定したグループにパラメーターが見つからない場合、エラーが発生します。

IDによるパラメーターの取得  

構文
var param = QntrlParam.of('<param ID>');

 

構文
var param = QntrlParam.ofLinkName('<link name>');

 

パラメーターの更新     

構文
param.update('<param name>', '<param value>', false, QntrlParam.Scope.<scope>, '<初期値>');

 

パラメーターの削除     

​構文
param.destroy();