拡張機能オプションは、開発者が拡張機能に対して定義する設定項目です。ユーザーはこれらのオプションを設定して、異なるワークスペースでの拡張機能の動作をカスタマイズできます。たとえば、開発者は、ユーザーが SQL 文の最大長をコントロールできるオプションを作成できます。これにより、ワークスペースごとに異なる長さの制限を設けることができます。
背景情報
開発者は登録時に拡張機能オプションを定義します。その後、ユーザーは特定のワークスペース内で拡張機能のこれらのオプションを設定できます。
拡張機能の登録方法の詳細については、「拡張機能の開発とデプロイ: 自己構築サービス」をご参照ください。
ワークスペースで拡張機能を有効にする前に、ユーザーは次の図に示すようにオプションを設定できます。
開発者は GetOptionValueForProject API を呼び出して、ワークスペース管理者などのユーザーが特定のワークスペースで設定したオプション構成を取得できます。
使用上の注意
拡張機能の開発者は、オプション構成と関連テキストを提供します。プラットフォームは、コンテンツによってもたらされるセキュリティ上の脅威について責任を負いません。
サポートされているコンポーネント
オプション構成は、テキスト、単一行入力ボックス、複数行入力ボックス、単一選択ドロップダウンリスト、複数選択ドロップダウンリスト、チェックボックスグループ、ラジオボタングループの 7 種類のコンポーネントをサポートしています。次の図にこれらのコンポーネントを示します。
オプション構成
拡張機能を登録する際、開発者は [オプション構成] フィールドにオプションを JSON 文字列として定義する必要があります。
{
"type": "object",
"properties": {
"コンポーネント名 (一意である必要があります)": {
"type": "string",
"title": "以下の表をご参照ください",
"x-decorator": "パラメーター解析の表をご参照ください",
"x-component": "パラメーター解析の表をご参照ください",
"x-decorator-props": {
"tooltip": "説明"
},
"x-component-props": {
"dataSource": "パラメーター解析の表をご参照ください",
"mode": "multiple"
}
}
}
}構成については、次のリソースをご参照ください。
コンポーネントパラメーターの詳細については、「パラメーター解析」をご参照ください。
構成例については、「構成例: SQL タスクの CU リソースしきい値の設定」および「構成例: 7 種類のコンポーネントタイプの使用」をご参照ください。
拡張機能の登録と管理の詳細については、「拡張機能の開発とデプロイ: 自己構築サービス」をご参照ください。
パラメーターの解析
フィールド | コンポーネントタイプ | 値 |
title | テキスト | テキスト |
単一行入力ボックス | 単一行入力ボックス | |
複数行入力ボックス | 複数行入力ボックス | |
単一選択ドロップダウンリスト | 単一選択ドロップダウンリスト | |
複数選択ドロップダウンリスト | 複数選択ドロップダウンリスト | |
チェックボックスグループ | チェックボックスグループ | |
ラジオボタングループ | 単一選択 | |
x-decorator | テキスト | FormItem |
単一行入力ボックス | FormItem | |
複数行入力ボックス | FormItem | |
単一選択ドロップダウンリスト | FormItem | |
複数選択ドロップダウンリスト | FormItem | |
チェックボックスグループ | FormItem | |
ラジオボタングループ | FormItem | |
x-component | テキスト | PreviewText.Input |
単一行入力ボックス | Input | |
複数行入力ボックス | Input.TextArea | |
単一選択ドロップダウンリスト | Select | |
複数選択ドロップダウンリスト | Select | |
複数選択 | Checkbox.Group | |
単一選択 | Radio.Group | |
dataSource | テキスト | オプション |
単一行入力ボックス | オプション | |
複数行入力ボックス | オプション | |
単一選択ドロップダウンリスト | オプション。必要に応じて設定します。配列内の各オブジェクトは一意のオプションです。value と label は重複できません。label は UI に表示するテキストを指定します。value はテキストの識別子を指定し、定義できます。以下はコードサンプルです。 | |
複数選択ドロップダウンリスト | オプション。必要に応じて設定します。配列内の各オブジェクトは一意のオプションです。value と label は重複できません。label は UI に表示するテキストを指定します。value はテキストの識別子を指定し、定義できます。以下はコードサンプルです。 | |
チェックボックスグループ | オプション。必要に応じて設定します。配列内の各オブジェクトは一意のオプションです。value と label は重複できません。label は UI に表示するテキストを指定します。value はテキストの識別子を指定し、定義できます。以下はコードサンプルです。 | |
単一選択 | オプション。必要に応じて設定します。配列内の各オブジェクトは一意のオプションです。value と label は重複できません。label は UI に表示するテキストを指定します。value はテキストの識別子を指定し、定義できます。以下はコードサンプルです。 |
構成例: SQL タスクの CU リソースしきい値の設定
次の図は、SQL タスクの CU 消費量のしきい値を設定する方法の例と、その結果を示しています。
次のコードは、オプションの JSON 構成を示しています。
{
"type": "object",
"properties": {
"cuNumber": {
"type": "string",
"title": "CU しきい値",
"x-decorator": "FormItem",
"x-component": "Input",
"x-decorator-props": {
"tooltip": "SQL タスクの CU 消費量のしきい値を入力します。"
}
}
}
}構成例: 7 種類のコンポーネントタイプの使用
次の図は、7 種類のコンポーネントタイプを使用した構成プロセスと結果の例を示しています。
次のコードは、オプションの JSON 構成を示しています。
7 つのコンポーネントすべてを一度に使用するには、次の JSON をコピーし、必要に応じてデータを変更します。
{
"type":"object",
"properties":{
"text":{
"type":"string",
"title":"テキスト",
"x-decorator":"FormItem",
"x-component":"PreviewText.Input",
"x-decorator-props":{
"tooltip":"説明ファイル"
},
"default":"これはテキスト情報です"
},
"input":{
"type":"string",
"title":"単一行入力ボックス",
"x-decorator":"FormItem",
"x-component":"Input",
"x-decorator-props":{
"tooltip":"説明ファイル"
},
"x-component-props":{
},
"default":"これはデフォルト値です"
},
"textarea":{
"type":"string",
"title":"複数行入力ボックス",
"x-decorator":"FormItem",
"x-component":"Input.TextArea",
"x-decorator-props":{
"tooltip":"説明ファイル"
},
"x-component-props":{
},
"default":"これはデフォルト値です"
},
"select":{
"type":"string",
"title":"単一選択ドロップダウンリスト",
"x-decorator":"FormItem",
"x-component":"Select",
"x-decorator-props":{
"tooltip":"説明ファイル"
},
"x-component-props":{
"dataSource":[
{
"value":"10001",
"label":"opt1"
},
{
"value":10002,
"label":"opt2"
},
{
"value":10003,
"label":"opt3",
"disabled":true
}
]
},
"default":"10001"
},
"selectmore":{
"type":"string",
"title":"複数選択ドロップダウンリスト",
"x-decorator":"FormItem",
"x-component":"Select",
"x-decorator-props":{
"tooltip":"説明ファイル"
},
"x-component-props":{
"dataSource":[
{
"value":"10001",
"label":"opt1"
},
{
"value":10002,
"label":"opt2"
},
{
"value":10003,
"label":"opt3",
"disabled":true
}
],
"mode":"multiple"
},
"default":["10001","10002"]
},
"checkbox":{
"type":"array",
"title":"チェックボックスグループ",
"x-decorator":"FormItem",
"x-component":"Checkbox.Group",
"x-decorator-props":{
"tooltip":"説明ファイル"
},
"x-component-props":{
"dataSource":[
{
"value":"10001",
"label":"opt1"
},
{
"value":10002,
"label":"opt2"
},
{
"value":10003,
"label":"opt3",
"disabled":true
}
],
"mode":"multiple"
},
"default":["10001","10002"]
},
"radio":{
"type":"number",
"title":"ラジオボタングループ",
"x-decorator":"FormItem",
"x-component":"Radio.Group",
"x-decorator-props":{
"tooltip":"説明ファイル"
},
"x-component-props":{
"dataSource":[
{
"value":"10001",
"label":"opt1"
},
{
"value":10002,
"label":"opt2"
},
{
"value":10003,
"label":"opt3",
"disabled":true
}
],
"mode":"multiple"
},
"default":"10001"
}
}
}詳細については、「ベストプラクティス: (高度な機能) MAX_PT 関数の使用を禁止する」をご参照ください。