翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

送信フック

送信フックを使用すると、Deadline Cloud ジョブ送信ワークフロー中にカスタムスクリプトを実行できます。フックは、ジョブが Deadline Cloud サービスに到達する前に、ジョブを送信しているワークステーションでローカルに実行されます。フックはワーカーや AWS クラウドでは実行されません。フックはマシンで実行されるため、送信するユーザーが利用できるローカルファイル、環境変数、ネットワークリソースにアクセスできます。

フックを使用して、ジョブ設定の検証、追加のアセットの検出、送信パラメータの変更、本番追跡ソフトウェアなどの外部システムとの統合を行うことができます。ワーカーまたはクラウドで実行されるその他の統合ポイントについては、「」を参照してくださいジョブのフック、イベント、統合ポイント。

フックを設定する方法は 2 つあります。

両方のソースを同時にアクティブにできます。両方が存在する場合、環境フックが最初に実行され、次にバンドルフックが実行されます。

フックタイプ

Deadline Cloud は、送信ワークフローの異なるポイントに対応する 3 つのフックタイプをサポートしています。

事前 GUI フック

事前 GUI フックは、送信ダイアログが開く前に実行されます。以下のタスクには、事前 GUI フックを使用できます。

事前 GUI フックは、失敗した場合にダイアログが開くのをブロックします (ゼロ以外の終了コードまたはタイムアウト）。

JSON を stdout に出力して、最初のダイアログ状態を変更します。次の例は、出力形式を示しています。

import json

output = {
    "name": "My Render - v042",
    "description": "Submitted via pipeline",
    "parameters": {
        "SceneFile": "/resolved/path/to/scene.ma",
        "OutputPath": "/shots/sh010/renders/",
        "deadline:priority": 75,
        "deadline:maxFailedTasksCount": 5,
        "deadline:maxRetriesPerTask": 3,
        "deadline:maxWorkerCount": 10,
        "deadline:targetTaskRunStatus": "READY"
    }
}
print(json.dumps(output))

次の表に、GUI 以前のフックの出力フィールドを示します。

次の表は、 parameters オブジェクトの deadline: プレフィックスで設定できる共有ジョブプロパティを示しています。

送信前フック

ジョブアタッチメントがハッシュされてアップロードされる前に、送信前フックが実行されます。次のタスクには、送信前フックを使用できます。

送信前フックは、失敗した場合に送信をブロックします (ゼロ以外の終了コードまたはタイムアウト）。

JSON を stdout に出力して送信を変更します。フック出力は、ネストされたキーレベルでアセット参照を置き換えます。フックが を出力する場合inputFilenames、フック出力はinputFilenamesリスト全体を置き換えます。Deadline Cloud は、出力に含めないキーを保持します。

次の の例では、検出されたテクスチャファイルを 送信に追加します。

import json
import os
import sys

metadata = json.load(sys.stdin)
bundle_dir = metadata["jobBundleDir"]

textures = []
for root, _, files in os.walk(bundle_dir):
    for f in files:
        if f.endswith(('.exr', '.png', '.jpg', '.tx')):
            textures.append(os.path.join(root, f))

if textures:
    print(json.dumps({
        "attachments": {
            "assetReferences": {
                "inputFilenames": textures
            }
        }
    }))

送信前フックは、stdout にparametersマップを発行することでジョブテンプレートのパラメータ値を変更することもできます。

print(json.dumps({"parameters": {"SceneFile": "/resolved/scene.ma", "Quality": "high"}}))

パラメータキーはジョブテンプレートのパラメータ名です。フックの値はバンドルのパラメータ値の上に適用されますが、CLI で指定された--parameter値は、フックで指定された値よりも優先されます。

送信後のフック

送信後フックは、CreateJobAPI コールが正常に返された後に実行されます。この時点で、ジョブは Deadline Cloud によって承認されています。次のタスクには、送信後フックを使用できます。

送信後のフックの失敗は警告として記録されますが、送信されたジョブには影響しません。

送信フックを設定する

hooks.yaml または hooks.json ファイルでフックを定義します。ファイルを と一緒にジョブバンドルディレクトリに配置するかtemplate.yaml、 で指定されたディレクトリに配置しますDEADLINE_HOOKS_DIR。両方の形式が同じディレクトリに存在する場合、送信者はエラーを報告します。

version フィールドは必須であり、 である必要があります"1.0"。

次の例は、hooks.yaml設定を示しています。

version: "1.0"
preGUI:
  - command: python3
    args: [scripts/prefill_from_shotgrid.py]
    timeout: 10

preSubmission:
  - command: python3
    args: [scripts/validate_assets.py]
    timeout: 60
    env:
      VALIDATION_LEVEL: strict

  - command: python3
    args: [scripts/discover_textures.py]

postSubmission:
  - command: python3
    args: [scripts/notify_slack.py]
    timeout: 15
    env:
      SLACK_WEBHOOK: https://hooks.slack.com/...

フック定義フィールド

各フックエントリは、次のフィールドを受け入れます。

パスの解決

フックスクリプトは、次のルールに従って解決されます。

フック入力

フックは、stdin の JSON と便利な環境変数を介してジョブメタデータを受け取ります。

環境変数

次の環境変数は、すべてのフックで使用できます。

stdin の JSON

完全なメタデータは stdin で JSON として提供されます。次の例は、 構造を示しています。

{
  "jobName": "My Render Job",
  "priority": 50,
  "farmId": "farm-abc123",
  "queueId": "queue-def456",
  "jobBundleDir": "/path/to/bundle",
  "parameters": {"SceneFile": "/path/to/scene.ma"},
  "submitterName": "Maya",
  "assetReferences": {
    "inputFilenames": ["/path/to/texture.exr"],
    "inputDirectories": [],
    "outputDirectories": ["/path/to/output"],
    "referencedPaths": []
  },
  "submissionPayload": {}
}

セキュリティ

フックはデフォルトで無効になっています。各フックソースには、有効にする必要がある独自の設定があります。

バンドルフックの有効化

ジョブバンドルhooks.yaml内で で定義されたフックを許可するには、バンドルフック設定を有効にします。

環境フックの有効化

で指定されたディレクトリからのフックを許可するにはDEADLINE_HOOKS_DIR、環境フック設定を有効にしてディレクトリパスを設定します。

確認プロンプト

フックを有効にすると、フックを実行する前に送信者から確認を求められます。事前 GUI フックは、ダイアログが開く前にプロンプトを表示します。送信前と送信後のフックは、送信を選択するとプロンプトを表示します。

プロンプトには実行するコマンドが表示され、先に進む前に確認することができます。

This job bundle contains submission hooks that will execute on your machine:

  Pre-GUI hooks:
    [1] python3 prefill_from_shotgrid.py

  Pre-submission hooks:
    [1] python3 validate_assets.py

  Post-submission hooks:
    [1] python3 notify.py

  Bundle: /path/to/bundle

Do you want to run these hooks? [Y/n]

CI/自動化ワークフローの確認プロンプトをスキップするには、次のコマンドを実行します。

deadline config set settings.auto_accept true

設定の概要

Studio のデプロイ

パイプラインのテクニカルディレクターは、ワークステーション間で環境フックをデプロイすることで、すべてのアーティストに対して自動的に実行されるようにフックを設定できます。この手順は、スタジオにフックスクリプトの共有ネットワークロケーションがあり、アーティストワークステーションを設定するための管理アクセス権がある場合に使用します。

エラー処理

送信前または GUI 前フックが失敗した場合、エラー出力には次の情報が含まれます。

送信者は、問題を解決するまで送信をブロックします。送信後のフックの失敗は警告として記録されますが、送信されたジョブには影響しません。

ベストプラクティス

送信方法

フックは、次の送信方法で動作します。

スタンドアロン GUI はジョブ履歴バンドルhooks.yamlにコピーし、元のバンドルディレクトリへのスクリプトパスを解決します。

その他のリソース

統合ポイントおよび関連トピックの詳細については、以下を参照してください。