DataWorks は、拡張コードをより効率的かつ効果的に開発するために、組み込みパラメーターとカスタムパラメーターを提供します。例えば、パラメーターを使用して、特定のワークスペースにのみ拡張機能を適用できます。この Topic では、拡張パラメーターの使用方法について説明します。
背景情報
コードで拡張パラメーターを使用するには、まず拡張機能の登録情報でそれらを定義する必要があります。開発中に必要となる可能性のある、任意の組み込みパラメーターまたはカスタムパラメーターを追加できます。開発者は GetExtension API を呼び出して、拡張機能のパラメーター構成を取得できます。
複数のパラメーターを追加できます。各パラメーターは改行して記述する必要があります。
組み込みパラメーターを追加する場合：
組み込みパラメーターは
key=valueフォーマットを使用します。以下の組み込みパラメーターがサポートされています。組み込みパラメーター 2：extension.project.disabled.append、ワークスペースのブラックリストへの追加
組み込みパラメーター 3：extension.project.{eventCode}.disabled、拡張ポイントのブラックリスト構成
組み込みパラメーター 4：extension.project.{eventCode}.disabled.append、拡張ポイントのブラックリストへの追加
組み込みパラメーター 5：extension.fileType.{fileType}.{eventCode}.enabled
組み込みパラメーター 6：
extension.manualPass.enabled。このパラメーターは、拡張機能に対して手動の [合格としてマーク] ボタンを有効にするかどうかを決定します。extension.manualPass.enabled=trueこのパラメーターを設定すると、拡張機能の右側にある [操作] 列に [合格としてマーク] ボタンが表示されます。
カスタムパラメーターを追加する場合：
key=valueフォーマットを使用します。
組み込みパラメーター 1：extension.project.disabled、ワークスペースのブラックリスト構成
利用シーン：
このパラメーターを使用して、特定のワークスペースに対して拡張機能を無効にできます。
パラメーターの説明：
extension.project.disabled=projectId1,projectId2,projectId3このパラメーターでは、projectId は拡張機能を無効にするワークスペースの ID を指定します。ID は、ListProjects 操作を呼び出すか、DataWorks コンソールのワークスペース構成ページで見つけることで取得できます。
説明1 つのパラメーターに複数のワークスペース ID を指定できます。ID はカンマ (,) で区切ります。
例：
extension.project.disabled=projectId1注意：
同じキーを複数回設定しないでください。同じキーを複数回設定した場合、最後の設定のみが有効になります。
組み込みパラメーター 2：extension.project.disabled.append、ワークスペースのブラックリストへの追加
利用シーン：
extension.project.disabledパラメーターがすでに設定されている場合、このパラメーターを使用してブラックリストにさらにワークスペースを追加できます。追加されたワークスペースでは拡張機能が無効になります。パラメーターの説明：
extension.project.disabled.append=projectId1,projectId2,projectId3このパラメーターでは、projectId で、拡張機能が無効化されるワークスペースの ID を指定します。ID は、ListProjects 操作を呼び出すか、DataWorks コンソールのワークスペース構成ページで確認することで取得できます。
説明1 つのパラメーターに複数のワークスペース ID を指定できます。ID はカンマ (,) で区切ってください。
例：
extension.project.disabled.append=projectId1
組み込みパラメーター 3：extension.project.{eventCode}.disabled、拡張ポイントのブラックリスト構成
利用シーン：
このパラメーターを使用して、特定のワークスペースの特定の拡張ポイントに対して拡張機能を無効にできます。
パラメーター：
extension.project.{eventCode}.disabled=projectId1,projectId2,projectId3各パラメーターの説明は次のとおりです。
eventCode：無効にする拡張ポイントのイベントタイプ。詳細については、「付録：イベント詳細 (eventType)」をご参照ください。
projectId：拡張機能を無効にするワークスペースの ID。ID は、ListProjects 操作を呼び出すか、DataWorks コンソールのワークスペース構成ページで見つけることで取得できます。
説明このパラメーターには複数のワークスペース ID を指定できます。ID はカンマ (,) で区切ります。
例：
extension.project.commit-file.disabled=projectId1 extension.project.delete-file.disabled=projectId2,projectId3注意：
同じキーを複数回設定しないでください。同じキーを複数回設定した場合、最後の設定のみが有効になります。
組み込みパラメーター 4：extension.project.{eventCode}.disabled.append、拡張ポイントのブラックリストへの追加
利用シーン：
extension.project.{eventCode}.disabled.appendパラメーターに単一の値が含まれている場合 (つまり、その値がカンマで区切られた複数のワークスペース ID のリストではない場合)、このパラメーターを使用してワークスペースを追加し、そのワークスペースで拡張機能の拡張ポイントを無効にできます。パラメーターの説明：
extension.project.{eventCode}.disabled.append=projectId1,projectId2,projectId3各プレースホルダーの説明は次のとおりです。
eventCode：無効にする拡張ポイントのイベントタイプ。詳細については、「付録：イベント詳細 (eventType)」をご参照ください。
projectId：拡張機能を無効にするワークスペースの ID。ID は、ListProjects 操作を呼び出すか、DataWorks コンソールのワークスペース構成ページで見つけることで取得できます。
説明このパラメーターには複数のワークスペース ID を指定できます。ID はカンマ (,) で区切ります。
例：
extension.project.commit-file.disabled.append=projectId1 extension.project.delete-file.disabled.append=projectId2,projectId3
組み込みパラメーター 5：extension.fileType.{fileType}.{eventCode}.enabled
利用シーン：
このパラメーターを使用して、特定のタイプのノードタスクに対して拡張機能を有効または無効にできます。
パラメーターの説明：
extension.fileType.{fileType}.{eventCode}.enabled各プレースホルダーの説明は次のとおりです。
fileType：ノードタスクタイプのタイプコードを指定します。タイプコードは ListFileType 操作を呼び出すことで取得できます。
eventCode：無効にする拡張ポイントのイベントタイプ。詳細については、「付録：イベント詳細 (eventType)」をご参照ください。
例：
次の例は、ノードタスクタイプ 10 (ODPS SQL タスク) とノードタスクタイプ 11 (ODPS MR タスク) に対してこのパラメーターを設定する方法を示しています。
両方のタスクタイプに対してパラメーターを `true` に設定した場合、設定されていない `fileType` はデフォルトで `false` になります。
extension.fileType.10.run-file.enabled=true extension.fileType.11.run-file.enabled=true拡張機能は ODPS SQL タスクと ODPS MR タスクで有効になります。これらのタスクが実行されると、拡張機能がトリガーされます。
データ統合 (DI) バッチ同期タスクなど、他のノードタスクでは拡張機能はトリガーされません。
両方のタスクタイプに対してパラメーターを `false` に設定した場合、設定されていない `fileType` はデフォルトで `true` になります。
extension.fileType.10.run-file.enabled=false extension.fileType.11.run-file.enabled=false拡張機能は ODPS SQL タスクまたは ODPS MR タスクでは有効になりません。これらのタスクが実行されても、拡張機能はトリガーされません。
データ統合 (DI) バッチ同期タスクなど、他のすべてのノードタスクでは拡張機能がトリガーされます。
混在モードでは、設定されていない `fileType` はデフォルトで `false` になります。
extension.fileType.10.run-file.enabled=false extension.fileType.11.run-file.enabled=true拡張機能は ODPS MR タスクで有効になります。このタイプのタスクが実行されると、拡張機能がトリガーされます。
拡張機能は ODPS SQL タスクや、データ統合 (DI) バッチ同期タスクなどの他のノードタスクでは有効になりません。これらのタスクが実行されても、拡張機能はトリガーされません。