すべてのプロダクト
Search

このプロダクト

    DataWorks:詳細設定：拡張パラメーターの設定

    ドキュメントセンター

    DataWorks:詳細設定：拡張パラメーターの設定

    最終更新日:Jun 22, 2026

    拡張機能のコードを開発する際、DataWorks は開発効率を向上させるために、組み込みパラメーターとカスタムパラメーターを提供します。例えば、パラメーターを使用して、特定のワークスペースでのみ拡張機能をアクティブにすることができます。

    背景情報

    拡張パラメーターを使用してコードを開発する場合、拡張機能の登録情報でパラメーターを定義する必要があります。コード開発プロセス中に必要となる可能性のある組み込みパラメーターまたはカスタムパラメーターを登録情報に追加します。拡張機能の開発者は、GetExtension API を呼び出すことで、拡張機能のパラメーター設定を取得できます。[拡張機能の登録] ダイアログボックスでは、左側でイベント (コード実行前のイベント、ファイル削除前のイベント、テーブルが開発環境にコミットされる前のイベント、テーブルが本番環境にコミットされる前のイベント、ファイル公開前のイベントなど) を選択できます。右側では、関連イベント、適用モジュール、所有者、テストワークスペース、拡張機能詳細 URL、拡張機能ドキュメント URL、拡張機能パラメーター設定、説明などの情報をフォームに入力する必要があります。拡張機能パラメーター設定のテキストエリアに、パラメーターを key=value フォーマットで 1 行に 1 つずつ入力します。

    組み込みパラメーター 1：extension.project.disabled — ワークスペースブロックリスト

    • 利用シーン：

      このパラメーターを使用して、指定されたワークスペースで拡張機能を無効にします。

    • パラメーターの説明：

      extension.project.disabled=projectId1,projectId2,projectId3

      projectId は、拡張機能が無効になるワークスペースの ID です。ID は、ListProjects API を呼び出すか、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 API を呼び出すか、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 API を呼び出すか、DataWorks コンソールのワークスペース設定ページで表示することで取得できます。

        説明

        1 つのパラメーターに複数のワークスペース 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 で定義されたリストを上書きせずに、ワークスペースを拡張ポイントブロックリストに追加します。拡張機能は、指定された拡張ポイントで、両方のパラメーターで指定されたワークスペースで無効になります。

    • パラメーターの説明：

      extension.project.{eventCode}.disabled.append=projectId1,projectId2,projectId3

      ここで：

      • eventCode：無効にする拡張ポイントのイベントタイプ。有効な値のリストについては、「付録：イベント詳細 (eventType)」をご参照ください。

      • projectId：拡張機能が無効になるワークスペースの ID。ID は、ListProjects API を呼び出すか、DataWorks コンソールのワークスペース設定ページで表示することで取得できます。

        説明

        1 つのパラメーターに複数のワークスペース 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 API を呼び出して、ノードタスクのタイプコードを取得できます。

      • eventCode：無効にする拡張ポイントのイベントタイプ。有効な値のリストについては、「付録：イベント詳細 (eventType)」をご参照ください。

    • コード例：

      以下の例は、ODPS SQL ノードタスク (タイプ 10) と ODPS MR ノードタスク (タイプ 11) の拡張機能の設定方法を示しています。

      • 指定されたすべてのファイルタイプが true に設定されている場合、設定されていないファイルタイプはデフォルトで false になります。

        extension.fileType.10.run-file.enabled=true
extension.fileType.11.run-file.enabled=true

        • 拡張機能は、ODPS SQL ノードタスク (10) と ODPS MR ノードタスク (11) でアクティブになります。これらのタスクが実行されると、拡張機能がトリガーされます。

        • バッチ同期 DI ノードタスクなど、他のノードタスクは拡張機能をトリガーしません。

      • 指定されたすべてのファイルタイプが false に設定されている場合、設定されていないファイルタイプはデフォルトで true になります。

        extension.fileType.10.run-file.enabled=false
extension.fileType.11.run-file.enabled=false

        • 拡張機能は、ODPS SQL ノードタスク (10) または ODPS MR ノードタスク (11) ではアクティブになりません。これらのタスクが実行されても、拡張機能はトリガーされません。

        • バッチ同期 DI ノードタスクなど、他のすべてのノードタスクは拡張機能をトリガーします。

      • 少なくとも 1 つのファイルタイプが true に設定されている混合設定を使用する場合、設定されていないファイルタイプはデフォルトで false になります。

        extension.fileType.10.run-file.enabled=false
extension.fileType.11.run-file.enabled=true

        • 拡張機能は、ODPS MR ノードタスク (11) でアクティブになります。このタスクが実行されると、拡張機能がトリガーされます。

        • 拡張機能は、ODPS SQL ノードタスク (10) や、バッチ同期 DI ノードタスクなどの他のノードタスクではアクティブになりません。これらのタスクは拡張機能をトリガーしません。