拡張機能の開発者は、拡張機能を登録する際に、拡張機能のオプションを定義できます。拡張機能のユーザーは、ビジネス要件に基づいてオプションを設定し、異なるワークスペースでカスタムプロセス管理を実装できます。たとえば、拡張機能の開発者は、SQL ステートメントの最大長を指定するオプションを定義できます。拡張機能のユーザーは、異なるワークスペースで異なる SQL ステートメントの最大長を指定するようにオプションを設定できます。
背景情報
拡張機能のオプションは、拡張機能の登録時に拡張機能の開発者によって定義されます。拡張機能のユーザーは、ビジネス要件に基づいて、異なるワークスペースでオプションを設定できます。
開発者が拡張機能を登録する方法の詳細については、「準備 2: 拡張機能の登録」をご参照ください。
拡張機能のユーザーは、拡張機能を有効にする前に、次の図に示すように、拡張機能の設定ページの操作列にある拡張オプションの設定をクリックして、拡張機能のオプションを設定できます。
ワークスペース管理者ロールが割り当てられているユーザーなどの拡張機能ユーザーがワークスペースで拡張機能のオプションを設定した後、拡張機能の開発者は GetOptionValueForProject オペレーションを呼び出して、オプションの設定を取得できます。
使用上の注意
拡張機能のオプションと関連する UI テキストは、拡張機能の開発者によって定義されます。DataWorks は、オプションの内容によって発生する可能性のあるリスクについて責任を負いません。
サポートされているコンポーネント
拡張機能の開発者は、次のコンポーネントを使用して拡張機能のオプションを定義できます。テキスト、単一行テキストフィールド、複数行テキストフィールド、単一選択ドロップダウンボックス、複数選択ドロップダウンボックス、チェックボックス、ラジオボタン。次の図は、コンポーネントを示しています。
拡張機能のオプションの定義
開発者が拡張機能の登録ダイアログボックスで拡張機能を登録する場合、開発者は [拡張機能のオプション] フィールドに JSON 形式で拡張機能のオプションを定義できます。
{
"type": "object",
"properties": {
"Unique component name": {
"type": "string",
"title": "このパラメーターの設定方法の詳細については、「パラメーターの解析」セクションの表を参照してください。", // 翻訳済
"x-decorator": "このパラメーターの設定方法の詳細については、「パラメーターの解析」セクションの表を参照してください。", // 翻訳済
"x-component": "このパラメーターの設定方法の詳細については、「パラメーターの解析」セクションの表を参照してください。", // 翻訳済
"x-decorator-props": {
"tooltip": "説明" // 翻訳済
},
"x-component-props": {
"dataSource": "このパラメーターの設定方法の詳細については、「パラメーターの解析」セクションの表を参照してください。", // 翻訳済
"mode": "multiple"
}
}
}
}参照:
コンポーネント関連のパラメーターの詳細については、「パラメーターの解析」をご参照ください。
コンポーネント設定例の詳細については、「設定例: SQL タスクが消費する最大 CU 数を指定するオプションを定義する」および「設定例: 7 つのタイプのコンポーネントをすべて使用する」をご参照ください。
拡張機能の登録と管理の方法の詳細については、「準備 2: 拡張機能の登録」をご参照ください。
パラメーターの解析
パラメーター | コンポーネントタイプ | 値 |
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 フィールドは、UI テキストの ID を示します。サンプルコード: | |
複数選択ドロップダウンボックス | オプション。ビジネス要件に基づいてこのコンポーネントをカスタマイズします。各中かっこ {} 内の value フィールドと label フィールドの内容が一意であることを確認します。 label フィールドは、表示される UI テキストを示します。 value フィールドは、UI テキストの ID を示します。サンプルコード: | |
チェックボックス | オプション。ビジネス要件に基づいてこのコンポーネントをカスタマイズします。各中かっこ {} 内の value フィールドと label フィールドの内容が一意であることを確認します。 label フィールドは、表示される UI テキストを示します。 value フィールドは、UI テキストの ID を示します。サンプルコード: | |
ラジオボタン | オプション。ビジネス要件に基づいてこのコンポーネントをカスタマイズします。各中かっこ {} 内の value フィールドと label フィールドの内容が一意であることを確認します。 label フィールドは、表示される UI テキストを示します。 value フィールドは、UI テキストの ID を示します。サンプルコード: |
設定例: 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"
}
}
}