fpt_launch_app
Launch a DCC application scoped to a ShotGrid entity, using Toolkit for context injection or falling back to direct open. Supports Maya, Flame, and others.
Instructions
Launch a DCC application scoped to a ShotGrid entity.
Discovery is OS-first: if the app is not installed on this machine the
tool fails immediately without consulting ShotGrid. When the owning
project has an Advanced Setup PipelineConfiguration whose tank CLI
is reachable on disk, the launch is routed through tank so Toolkit
pre-launch hooks run and the app opens in the correct context.
Otherwise the tool falls back to a direct open -a launch and
surfaces a warning — the app still opens, but without context
injection from Toolkit.
Version selection: the FPT-selected version (SG Software
version_names) is authoritative over "newest installed"; a
warning names both when the selected one is not installed locally.
MAYA / Sequence: a bare Sequence launch is step-LESS (no work
templates); the tank route resolves it to its Step Task (step
param, default Layout) so Maya boots the sequence_layout env.
FLAME (route='auto'/'direct'): composes startApplication --start-project=<name> ... --closed-libs — SG name slugified via
tk-flame's convention and validated against the local Stone+Wire
project list; no Toolkit/SSO needed. Refusals to relay: "does not
exist on this workstation" (direct route cannot create projects —
offer route='toolkit', which pre-creates via Wiretap) and "already
running" (single-instance + project locks; close it or force=true).
Common failure modes to explain to the user if they surface:
error: "... is not installed ..."— the DCC binary is not under the expected install path. Tell the user to install it and retry.Popen succeeds but the launched process dies immediately with a tank message like
EOF when reading a lineorAuthentication ... expired. This means the ToolkittankCLI lost its cached session. The user must run<PipelineConfiguration>/tank <Entity> <id>once in an interactive terminal, authenticate via the browser, and retry. The tool cannot do this because it cannot deliver the browser approval step.Popen succeeds but tank errors with
does not exist on diskfor an engine (e.g.tk-shell v0.10.2). The pipeline config expects bundles under<config>/install/which are absent. Suggest the user addbundle_cache_fallback_rootspointing to~/Library/Caches/Shotgun/bundle_cachein the config'spipeline_configuration.yml.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |