SG Developer
Our Developer documentation has relocated and this site will be discontinued soon. Visit our new Developer Help Center here.

オフラインでの使用と自動更新のオフ

自動更新

自動更新の対象となる部分

既定では、ShotGrid Desktop は更新の有無を自動的に確認し、更新がある場合はローカル マシンにインストールします。

次の 2 つのコンポーネントの更新が検索されます。

  • tk-framework-desktopstartup: ShotGrid Desktop の起動を支援するフレームワーク。
  • tk-config-basic: 既定のサイト設定。

この設定は、ShotGrid Desktop で使用する必要があるアプリン、エンジン、フレームワークのバージョン、およびコア バージョンのマニフェストとして機能します。 設定を更新すると、これらのコンポーネントも更新される可能性があります。検索された更新はダウンロードされ、ユーザのローカル キャッシュに保存されます。元の ShotGrid Desktop インストール ファイルは変更されません。

アプリケーションとして機能する ShotGrid Create には、ShotGrid Desktop とは別の独自の更新メカニズムがあります。このメカニズムについては、ここでは説明しません。 ただし、ShotGrid Create に用意されている統合機能の動作は同様であり、tk-config-basic を自動更新して同じユーザ キャッシュに格納する動作も行います。

自動更新の対象ではない部分

  • サイト設定を引き継いだ場合、tk-config-basic の新しい更新は検索されません。詳細については、後述します。

  • 既定のサイト設定を使用していないプロジェクト(Toolkit の詳細設定ウィザードが実行されているプロジェクト)の設定は、自動更新されません。

  • ShotGrid Desktop にバンドルされた Python や Qt などのリソースは自動更新されません。 これらのパーツを更新する必要がある場合は、新しい ShotGrid Desktop インストーラがリリースされることがあります。

統合オフラインを実行する

初期設定

スタジオでインターネット アクセスが制限されている場合や、インターネットにアクセスできない場合は、必要なすべてのパーツがローカルにキャッシュされていることを確認する必要があります。ShotGrid Create または ShotGrid Desktop をダウンロードするには、インターネットに接続できるマシンが 1 台必要になります。

ShotGrid Desktop には、基本的な統合の実行に必要なすべての依存関係が事前にパッケージ化されています。 ShotGrid Create にも依存関係がバンドルされていますが、「更新を管理する」に記載されている手順に従うことも必要になります。

いずれかを起動すると自動的に更新が検索されますが、ShotGrid App Store に接続できない場合は、ローカルに存在する最新のバージョンが実行されます。

インストーラにバンドルされたコンポーネントは最新でない可能性があるため、ShotGrid Desktop をインストールした後に、以下の「更新を管理する」の手順に従うことをお勧めします。

注 : ネットワーク設定によっては、更新にアクセスできない場合でも、オンラインで更新を探すことができない場合があります。この場合、環境変数 SHOTGUN_DISABLE_APPSTORE_ACCESS を "1" に設定すると、検索の試行を停止することができます。

注 : その後も、ShotGrid サイトに接続可能である必要があります。オフラインという用語は、Autodesk App Store に接続して更新をダウンロードできない状態を意味します。

更新を管理する

tk-framework-desktopstartup コンポーネントを更新するには、最新バージョンをダウンロードし、ディスク上の場所を指すように環境変数 SGTK_DESKTOP_STARTUP_LOCATION を設定する必要があります(これは ShotGrid Desktop にのみ適用されます)。

tk-config-basic コンポーネントの場合は、依存関係があるため、少し面倒です。

  1. インターネットに接続されたワークステーションで ShotGrid Desktop または ShotGrid Create を実行します。これらを起動すると、最新のアップグレードが自動的にダウンロードされます。(このマシンで SHOTGUN_DISABLE_APPSTORE_ACCESS が設定されていないことを確認してください。)
  2. バンドル キャッシュを、すべてのマシンがアクセスできる共有場所にコピーします。
  3. オフライン マシンの SHOTGUN_BUNDLE_CACHE_FALLBACK_PATHS 環境変数がこの場所を指すように設定します。
  4. オフライン マシンで ShotGrid Desktop または ShotGrid Create が起動すると、バンドル キャッシュにある利用可能な最新のアップグレードが取得されます。

警告 : ネットワーク設定によっては、更新にアクセスできない場合でも、オンラインで更新を探すことができない場合があります。この場合、環境変数 SHOTGUN_DISABLE_APPSTORE_ACCESS を "1" に設定すると、検索の試行を停止することができます。

自動更新をオフにする

プロジェクトまたはサイト レベルで更新をオフにする

注 : 可能であれば、新しい機能やバグ修正をインストールし忘れることがないよう、自動更新を有効にしておくことをお勧めします。

統合の自動更新をオフにするには、次の手順を実行します。

  1. 引き続き使用するバージョンを決定します。統合リリースはこちらにあります。

  2. ShotGrid で、プロジェクトまたはグローバル ページのいずれかにパイプライン設定エンティティを作成し、次のフィールドを入力します(この例では、v1.0.36 の統合を使用するように環境設定をロックしています)。

    1. 名前: Primary
    2. プロジェクト: すべてのプロジェクトで更新をオフにする場合は、空のままにします。特定のプロジェクトのみをロックする場合は、特定のプロジェクトを選択します。
    3. プラグインの ID: basic.*
    4. 記述子: sgtk:descriptor:app_store?name=tk-config-basic&version=v1.0.36

    特定のプロジェクトで更新がオフに設定されたパイプライン設定エンティティ

  3. ShotGrid Desktop を起動します。プロジェクト フィールドを空のままにした場合、ShotGrid Desktop はこのバージョンを使用するように切り替わります(まだ切り替わっていない場合)。

    ShotGrid Desktop のバージョン情報

    プロジェクトを設定した場合は、設定したプロジェクトのみが影響を受け、ShotGrid Desktop の[バージョン情報] (About)ウィンドウは変更されません。

  4. [オプション] tk-framework-desktopstartup のバージョンをロックするには、最新バージョンをダウンロードし、ディスク上の場所を指すように環境変数 SGTK_DESKTOP_STARTUP_LOCATION を設定する必要があります(これは ShotGrid Desktop にのみ適用されます)。

大部分の機能は、以前の手順でロックできる環境設定によってコントロールされます。ただし、「自動更新の対象となる部分」セクションに記載されているように、コンポーネントも更新され、環境設定とは別に処理されます。これは ShotGrid Desktop にのみ適用されます。

知っておきたい情報

  • 環境設定のリリースを手動でダウンロードする必要はありません。ShotGrid Desktop を起動するか、プロジェクトを開始すると、自動的に処理されます。
  • basic.* は、基本設定のすべてのプラグインがこのオーバーライドを取得することを意味します。たとえば、Nuke と Maya の統合のみをフリーズする場合は、basic.maya、basic.nuke を指定します。
  • テストするには、このパイプライン設定エンティティの複製を作成し、User Restrictions フィールドに自分のユーザ名を追加します。これにより、自分のみが使用できるようにエンティティが制限され、他のユーザには影響を与えなくなります。この複製した環境設定から Maya などのソフトウェアを起動して、予想される統合バージョンが実行されていることを確認することができます。

  • プロジェクト フィールドを空白のままにすると、「サイト設定」が適用されます。 ShotGrid Desktop はプロジェクト外で動作するため、サイト設定が使用されます。ShotGrid Desktop でプロジェクトを選択すると、プロジェクト設定もロードされます。

  • Flame 統合のネームスペースは basic.flame であり、basic.* の一部であることが暗示されています。 しかし Flame 統合は、実際には基本設定に含まれていません。そのため、プロジェクトに Flame を使用してこのオーバーライドを実装すると、Flame 統合が機能しなくなります。 解決策は、Flame 専用の追加のパイプライン設定オーバーライドを作成することです。
    • 名前: Primary
    • プロジェクト: ロックするプロジェクト(すべてのプロジェクトの場合はなし)
    • プラグインの ID: basic.flame
    • 記述子: sgtk:descriptor:app_store?name=tk-config-flameplugin

1 つ以外のすべてのプロジェクトの更新をオフにする

上記の例の手順に従ってすべてのプロジェクトの更新をオフにした場合に、特定のプロジェクトの更新を有効にするには、次の操作を実行します。

  1. 上記のセクションで説明したように、サイトの更新をオフにします。
  2. 例外にするプロジェクトのパイプライン設定エンティティに、次のフィールド値を設定します。
    • 名前: Primary
    • プロジェクト: ロックしないプロジェクト
    • プラグインの ID: basic.*
    • 記述子: sgtk:descriptor:app_store?name=tk-config-basic 2 つのパイプライン設定(1 つはサイト全体の更新をオフにし、もう 1 つは単一プロジェクトの更新を有効にする) [記述子] (Descriptor)フィールドでバージョン番号を省略すると、プロジェクトは基本設定の最新リリースをトラックします。

アップグレード

設定を更新する場合は、すべてのユーザに展開する前に、新しいバージョンをテストしなければならないことがあります。

  1. ShotGrid でパイプラインの設定エンティティを右クリックし、[選択した項目を複製] (Duplicate Selected)を選択して複製します。
  2. クローン作成した設定に「update test」という名前をつけて、自分を[ユーザ制限] (User Restrictions)フィールドに割り当てます。
  3. このパイプライン設定を使用するようになります。
  4. テストするバージョンを指すように記述子を変更します。
  5. テストに参加させるユーザは、User Restrictions フィールドに追加して招待できます。
  6. 問題なくテストが完了したら、そのバージョンを使用するようにメインのパイプライン設定を更新するだけです。
  7. ユーザが ShotGrid Desktop を再起動し、現在開いているソフトウェアと実行中の ShotGrid の統合を再起動すると、更新が選択されます。

Edit this document