Shotgun Workfiles

このアプリを使用すると、作業ファイルとパブリッシュの閲覧、表示、保存が可能です。
最新バージョン: v0.12.2 (製品)
バージョン番号は、セマンティックバージョニング基準に従っています。
システム名: tk-multi-workfiles2

注: このドキュメントは、Toolkit の設定を管理するユーザのみが使用可能な機能について説明します。詳細については、『Shotgun 統合ユーザガイド』を参照してください。

概要
ドキュメント
            File Open ダイアログ
                  作業領域を移動する
                  ファイルを検索する
                  以前のバージョンにアクセスする
                  ユーザサンドボックス
                  結果を絞り込む
            File Save ダイアログ
                  異なるコンテキストで保存する
                  ファイル拡張子ドロップダウンを追加する
            ステップフィルタ
            遅延クエリー
            既知の問題
インストール、更新、開発
設定オプション

このアプリケーションは、Shotgun Pipeline Toolkit でファイルを管理する場合の基礎部分を構成します。これにより、さまざまな Shotgun エンティティ間をすばやく移動し、作業をすばやく開始することが可能になります。アプリケーションがシーンの裏でパスを管理するため、パスを指定する必要はありません。このアプリケーションを使用すると、作業領域内の作業ファイルを管理し、他のユーザと作業を簡単に共有できます。

ドキュメント

File Open ダイアログ

作業領域を移動する

メインダイアログは半分ずつに分かれています。左側には一連のタブがあります。最初のタブは「My Tasks」と呼ばれ、現在のユーザに割り当てられているすべてのタスクが表示されます。Shotgun の Web サイトの[マイタスク](My Tasks)ページに非常によく似ています。

エンティティのタブを使用して Shotgun エンティティを参照することもできます。既定では、作業ファイルアプリケーションにより、それぞれのタブを確認することでショットまたはアセットに関連したタスクを参照できます。

一連のタブは、環境ファイルの entities 設定を利用して完全に設定可能です。

ファイルを検索する

右側には、左側で選択した内容に関連する作業ファイルとパブリッシュが表示されます。作業ファイルとパブリッシュは、「All」、「Working」、「Publishes」の各タブを使用して一緒に表示したり、別々に表示したりできます。

以前のバージョンにアクセスする

以前のバージョンにアクセスする方法は 2 つあります。1 つ目の方法では、ブラウザ上部の「All versions」ボックスをクリックしてバージョンを展開し、ブラウザですべてのバージョンを個別に表示します。もう 1 つの方法では、ファイルを右クリックし、最新 10 件のバージョンにアクセスします。

ユーザサンドボックス

パイプライン設定でユーザサンドボックスを使用する場合、既定で表示されるのは現在のユーザのファイルのみです。他のユーザのサンドボックスにあるファイルを表示する場合は、上部のボタンをクリックすると、サンドボックスを選択して元のファイルを表示できます。

結果を絞り込む

文字を入力すると、表示の結果を絞り込むことができます。検索は項目の名前と一致します。

File Save ダイアログ

既定では、「File Save」ダイアログを使用すると、現在のコンテキストでファイルを保存できます。シーン名、バージョン番号、およびオプションのファイル拡張子(該当する場合)の入力が要求されます。「Save」ボタンはグレー表示されます。いったんアプリケーションでシーン名として次に利用可能なバージョン番号が確認されると、右下の「Save」ボタンが有効になります。

異なるコンテキストで保存する

異なるコンテキストでファイルを保存するためにダイアログの左上にある展開ボタンをクリックすると、「File Save」ダイアログが展開し、保存先として別のコンテキストを選択できます。

ファイル拡張子ドロップダウンを追加する

新しい File Save ダイアログで、保存するファイルの拡張子を選択できます。これを有効にするためには、パイプライン設定の templates.yml ファイルを調整する必要があります。最初に、templates.yml 内のトークンリストでトークンを定義する必要があります。

maya_extension:
    type: str
    choices:
        ma: Maya Ascii (.ma)
        mb: Maya Binary (.mb)
    default: ma
    alias: extension

maya_extension はトークン名です。choices は、ドロップダウンに表示されるファイルタイプのディクショナリです。キー(ma と mb)は、このテンプレートトークンに指定できる有効な値です。値(Maya Ascii (.ma) と Maya Binary (.mb))は、Toolkit アプリケーションで使用できる UI に適した説明です。alias は作業ファイルアプリケーションで必要なヒントです。このトークンが拡張子であり、ドロップダウンウィジェットに表示されるということがアプリケーションに通知されます。

その後、このトークンは Maya 固有のテンプレートに追加できます。

maya_shot_work:
    definition: '@shot_root/work/maya/{name}.v{version}.{maya_extension}'
    root_name: 'primary'

ステップフィルタ

タスクを取得するときに、階層に step が含まれている場合は、パイプラインステップのフィルタを使用して、Shotgun から取得されるデータの量を減らすことができます。取得されるのは、選択したステップリストにリンクされているタスクのみです。

タブに表示されるステップのリストは、step_filter_on 設定によってコントロールされます。設定しない場合は、すべての既存のパイプラインステップが表示されます。

次の例では、アセットおよびショットのタスクをそれぞれ表示する 2 つのタブを定義します。

  - caption: Assets Tasks
    entity_type: Task
    step_filter_on: Asset
    filters:
    - [entity, type_is, Asset]
    hierarchy: [entity.Asset.sg_asset_type, entity, step, content]
  - caption: Shots Tasks
    entity_type: Task
    step_filter_on: Shot
    filters:
    - [entity, type_is, Shot]
    hierarchy: [entity.Shot.sg_sequence, entity, step, content]

遅延クエリー

パフォーマンスを高めるために、エンティティツリーの構築を 2 つのステップクエリーに分割して行うことができます。最初のクエリーは、Shotgun からレコードを取得して、ツリーの最上部に入力するために使用します。2 番目のクエリーは、ユーザがツリーを展開するときに子を取得するために使用します。

次の設定では、アプリを起動するときに Shotgun からアセットおよびショットを取得します。特定のアセットまたはショットを選択した場合、またはツリービューで展開した場合は、このアセットまたはショットにリンクされたタスクのみが取得されます。

  entities:
  - caption: Assets
    entity_type: Asset
    hierarchy: [sg_asset_type, code]
    filters:
    sub_hierarchy:
      entity_type: Task
      filters:
      link_field: entity
      hierarchy: [step]
  - caption: Shots
    entity_type: Shot
    filters:
    hierarchy: [sg_sequence, code]
    sub_hierarchy:
      entity_type: Task
      filters:
      link_field: entity
      hierarchy: [step]

既知の問題

3ds Max と Motionbuilder サポート: Maya や Nuke と比較すると、Windows の DCC ではファイルパフォーマンスが低下します。
Perforce/バージョンレスファイル: アプリケーションで Perforce ワークフローを使用したテストをまだ実行する必要があるため、適切に動作しない可能性が高いです。

Loader

Shotgun の Loader を使用すると、Shotgun にパブリッシュしたファイルの概要確認と参照をすばやく行うことができます。検索可能なツリービューナビゲーションシステムを採用しているため、探しているタスク、ショット、またはアセットにすばやく、簡単にアクセスできます。ローダーには、その項目のパブリッシュすべてについてサムネイルベースの概要が表示されます。その後は、設定可能なフックを利用して、パブリッシュを参照したり、現在のシーンに簡単に読み込んだりできます。

Publish

アーティストは Publish アプリを使用して作品をパブリッシュすることにより、下流工程に関わるアーティストが自分の作品を使用できるようにすることができます。アーティストのコンテンツ作成ソフトウェア内における従来のパブリッシュワークフローと、ディスク上にある任意のファイルのスタンドアロンパブリッシュがサポートされます。コンテンツ作成ソフトウェアで作業し、基本的な Shotgun の統合を使用すると、このアプリはアーティストがパブリッシュする項目を自動的に探して表示します。さらに高度な制作上のニーズがある場合は、アーティストのワークフローを操作するカスタムパブリッシュプラグインを作成することもできます。

Scene Snapshot

Shotgun Snapshot は簡単な差分バックアップ機能であるため、他のユーザと共有しなくても、作業の差分をバージョン付けしたり、管理することができます。スナップショットの作成、説明やサムネイルの追加、後でいつでも復帰できるポイントの作成、および復元が可能です。これは、大きな変更を行う際に以前のバージョンのシーンをバックアップしておく必要がある場合に役立ちます。

Shotgun パイプラインのチュートリアル

このドキュメントには、Shotgun 統合および Toolkit プラットフォームを使用してシンプルなエンドツーエンドのパイプラインをセットアップするテクニカルディレクタ(TD)を対象とした、段階的なチュートリアルを用意しています。このチュートリアルの目標は、統合およびプラットフォームの基本的な側面や、スタジオの具体的なニーズに合わせて Shotgun ベースのパイプラインを作成およびカスタマイズする方法について理解できるようにすることです。

インストールと更新

Shotgun Pipeline Toolkit にこのアプリを追加する

Project XYZ にこのアプリを追加するには、asset という名前の環境で次のコマンドを実行します。


                > tank Project XYZ install_app asset tk-maya tk-multi-workfiles2

コラボレーションと発展

Shotgun Pipeline Toolkit にアクセスできる場合は、すべてのアプリ、エンジン、およびフレームワークのソースコードにも Github からアクセスできます。これらは Github を使用して格納および管理しています。これらの項目は自由に発展させてください。さらなる独立した開発用の基盤として使用したり、変更を加えたり(その際はプルリクエストを送信してください)、いろいろと研究してビルドの方法やツールキットの動作を確認してください。このコードリポジトリには、https://github.com/shotgunsoftware/tk-multi-workfiles2 からアクセスできます。

特殊な要件

上記の操作を行うには、Shotgun Pipeline Toolkit Core API バージョン v0.19.1 以降が必要です。

環境設定

以下に、使用するすべての環境設定の概要を示します。これらの設定は、このアプリまたはエンジンを有効にするための環境設定ファイルで定義する必要があります。

launch_at_startup

タイプ: bool

説明: アプリケーションの開始時に UI を起動するかどうかを決めるフラグです。一部のプラットフォームでは起動方法が異なるため、このオプションはすべてのエンジンでサポートされているわけではありません。現在、Maya Nuke と 3ds Max のみでこのオプションがサポートされています。

create_new_task_hook

タイプ: hook

既定値: {self}/create_new_task.py

説明: タスクを作成して必要な入力の検証を行うフックを指定します。

show_my_tasks

タイプ: bool

既定値: True

説明: [マイタスク](My Tasks)ビューが表示されるかどうかを定義します。

file_browser_tabs

タイプ: list

既定値: [u'All', u'Working', u'Publishes']

説明: メインブラウザに表示されるタブ名のリストです。「All」、「Working」、および「Publishes」のタブ名を任意に組み合わせた値を指定できます。指定した値の順序で、アプリに表示されるタブの順番が決まります。

custom_actions_hook

タイプ: hook

既定値: {self}/custom_actions.py

説明: すべてのカスタムアクションメソッドが含まれるフックです。

auto_expand_tree

タイプ: bool

説明: ツリービューのルートレベルを自動的に展開します。

saveas_default_name

タイプ: str

既定値: scene

説明: save-as コマンドを使用して作業ファイルを保存する場合に使用される既定の名前です。

saveas_prefer_version_up

タイプ: bool

説明: save-as コマンドが使用する既定の名前を決定する方法を制御します。True に設定すると、現在のシーンの名前が使用され、バージョンが増分されます。False の場合は、新しい固有の名前が使用され、バージョンがリセットされます。

hook_copy_file

タイプ: hook

既定値: {self}/copy_file.py

説明: 「source_path」から「target_path」にファイルをコピーするのに使用されるフックを指定します。

entities

タイプ: list

既定値: [{u'hierarchy': [u'entity.Asset.sg_asset_type', u'entity', u'step', u'content'], u'caption': u'Assets', u'step_filter_on': u'Asset', u'filters': [[u'entity', u'type_is', u'Asset']], u'entity_type': u'Task'}, {u'hierarchy': [u'entity.Shot.sg_sequence', u'entity', u'step', u'content'], u'caption': u'Shots', u'step_filter_on': u'Shot', u'filters': [[u'entity', u'type_is', u'Shot']], u'entity_type': u'Task'}]

説明: この設定は左側に表示されるさまざまなタブを定義します。各タブは、ツリーを形成するいくつかの Shotgun フィールドでグループ化された Shotgun クエリーを表します。この設定はディクショナリのリストです。リスト内の各ディクショナリで 1 つのタブを定義し、次のキーを指定する必要があります。caption はタブの名前を指定し、entity_type は表示する Shotgun のエンティティタイプを指定します。 filters は、標準フォーマットまたは複雑なフォーマットによる標準的な API Shotgun フィルタのリストです。hierarchy はエンティティタイプに関連する Shotgun フィールドのリストで、ツリーグループを定義します。オプションの sub_query キーは、遅延クエリーを定義する場合に使用できます。遅延クエリーは、ツリービューでエンティティ(通常はショットまたはアセットのタスク)を展開するときに、子を収集するために実行されます。これは、entity_type キー(収集する子エンティティのタイプを指定する)、link_field (エンティティを親にリンクするために使用される Shotgun フィールド名)、filters (標準 Shotgun API フィルタのリスト)、hierarchy (サブツリー内のグループ化を定義するフィールドのリスト)を含むディクショナリです。オプションの step_filter_on 設定はエンティティタイプです。ステップのリストを制限して、指定したエンティティタイプのステップのみが表示されるようフィルタする場合に使用できます。

template_work_area

タイプ: template

説明: ディスク上の作業ディレクトリを特定するテンプレートのリファレンスです。

hook_scene_operation

タイプ: hook

既定値: {self}/scene_operation_{engine_name}.py

説明: アプリケーションが実行する必要があるアプリケーション固有のすべてのシーン操作(表示や保存など)は、このフックにすべて集約されています。

hook_get_badge

タイプ: hook

既定値: {self}/get_badge.py

説明: 必要に応じて、パブリッシュファイルまたは作業ファイルを表示するときにユーザインタフェースに含めるバッジアイコンを提供するフックを指定します。

my_tasks_filters

タイプ: list

既定値: [[u'task_assignees', u'is', u'{context.user}']]

説明: [マイタスク](My Tasks)タブのタスクに適用するフィルタのリストです。

allow_task_creation

タイプ: bool

既定値: True

説明: アプリから新しいタスクを作成できるかどうかを制御します。

version_compare_ignore_fields

タイプ: list

説明: 同一ファイルの別バージョンであるかどうかを判断するためにファイルを比較するときに無視する必要のあるフィールドのリストです。空の場合は、バージョンフィールドのみが無視されます。Toolkit はフィールドの値が異なるファイル間のバージョンは固有であると考えており、これに該当しない場合はエラーになるため、無視するフィールドを指定する場合には注意が必要です。

template_publish

タイプ: template

説明: ディスク上のパブリッシュファイルを特定するテンプレートのリファレンスです。

template_publish_area

タイプ: template

説明: ディスク上のパブリッシュディレクトリを特定するテンプレートのリファレンスです。

hook_filter_work_files

タイプ: hook

既定値: {self}/filter_work_files.py

説明: 必要に応じて、現在の作業領域で見つけた作業ファイルの未修正のリストをフィルタリングできるフックを指定します。

file_extensions

タイプ: list

説明: 作業ファイルビューで表示されるファイル拡張子のリストです。空の場合は、テンプレートと一致するすべてのファイルが表示されます。

template_work

タイプ: template

説明: ディスク上の作業ファイルを特定するテンプレートのリファレンスです。

hook_filter_publishes

タイプ: hook

既定値: {self}/filter_publishes.py

説明: 必要に応じて、現在の作業領域で Shotgun から返されたパブリッシュの未修正のリストをフィルタリングできるフックを指定します。

my_tasks_extra_display_fields

タイプ: list

説明: [マイタスク](My Tasks)リストのタスクに表示する追加フィールドのリストです。

作業ファイル

Shotgun Workfiles

ドキュメント

File Open ダイアログ

作業領域を移動する

ファイルを検索する

以前のバージョンにアクセスする

ユーザ サンドボックス

結果を絞り込む

File Save ダイアログ

異なるコンテキストで保存する

ファイル拡張子ドロップダウンを追加する

ステップ フィルタ

遅延クエリー

既知の問題

関連するアプリとドキュメント

Loader

Publish

Scene Snapshot

Shotgun パイプラインのチュートリアル

インストールと更新

Shotgun Pipeline Toolkit にこのアプリを追加する

最新バージョンに更新する

コラボレーションと発展

特殊な要件

環境設定

launch_at_startup

create_new_task_hook

show_my_tasks

file_browser_tabs

custom_actions_hook

auto_expand_tree

saveas_default_name

saveas_prefer_version_up

hook_copy_file

entities

template_work_area

hook_scene_operation

hook_get_badge

my_tasks_filters

allow_task_creation

version_compare_ignore_fields

template_publish

template_publish_area

hook_filter_work_files

file_extensions

template_work

hook_filter_publishes

my_tasks_extra_display_fields

ユーザサンドボックス

ステップフィルタ