Welcome to the release notes for this App. Below you will find an overview of all the changes we did for each release. We try to be as detailed as possible and include all bugs we have fixed, features we have added and things that may have changed. If you have questions about a particular release, don't hesitate to contact our support team!

2024-Dec-16

The context cache (_CONTEXT_CAHE) updates correctly after saving a file.

2024-Oct-22

Fix PySide UI sources

2024-Sep-9

New build resources

2024-May-8

Add task status filter dropdown

2024-Mar-26

Rebranding component for Flow Production Tracking

2024-Mar-11

• Use ShotgunMenu instead of QMenu for consistent style

2023-Dec-14

• Fixes a SyntaxError ocurring in older versions of Houdini and Nuke that still rely on Python2.

2023-Oct-27

• Updates to the App UI.

Details

• Added view mode buttons to toggle between a grid and list view.
• Added filter menu button to provide additional filtering capabilities.
• Documentation link updates
• Add support for Python 3.10

2023-Jun-19

• Removed Alias and VRED Engines to make them controlled via the config moving forward

2023-Apr-20

• Update string replacement to be compatible with Nuke 13+ on Windows
• Change string interpolation syntax to be backwards compatible

2023-Mar-06

• Improve sorting on workfiles versions
• Apply search text filter on finished editing, instead of each keystroke
• Update minimum qtwidgets framework to v2.10.6 for search widget update
• Get the current system login as hook to allow for better user display on all platforms

2023-Jan-05

• Fix crash issue when saving a new shot on Nuke 13.
• Fix issue on Nuke 13 crashing on saving with a custom shot_root path.
• Ensure that the overlay is hidden on shut down.

2022-Oct-13

• Add checkbox option next to "All Versions" to indicate if references should be checked on file open
• Formalizing Python 2.6 deprecation.
• Fixing some rebranding loose ends.

2021-Dec-1

• Replacing shotgunsoftware urls with Autodesk Knowledge Network and ShotGrid Developer Documentation pages.
• Removing deprecated Softimage engine.

2021-Jun-09

Rebranded to ShotGrid

2020-Dec-8

Switches from using the support email alias to pointing to the support site. Does some cleanup

Details:

• Switched to using support_url from tk-core instead of the hard-coded email address. Also using TKMessageBox from tk-core to make sure hyperlinks are clickable and styled
• Updated build_resources to use local PySide
• Added core_api files to make sure testing is done with the local tk-core instead of the latest app_store version

2020-Oct-12

Added a change context dialog.

Details:

• A new context change dialog has been added, in which the user can select a task or entity and set the current engine context.
• Support for Mari has been added, however it is intended that only the context change dialog will be used in Mari.
• New show_context_change, show_file_open, and show_file_save app configurations options have been added so that the three different dialogs can be individually configured to show or not.

2020-Oct-07

Added a parameter to open the dialogs as modal windows.

2020-Jul-09

Increases the maximum save version spinner value to 9999999.

2020-Apr-02

Updated the Houdini scene operation hook to work in Python 3.

2020-Mar-16

Small bug fix and updated the list of supported engines.

Details:

• Fixes rgb Qt styling warnings.
• Adds Alias and Vred to the supported engines list.

2020-Feb-11

Adds Python 3 support.

2019-Dec-11

The application does not ship with the Blur Python based hooks for 3dsMax anymore.

Details:

The tk-3dsmax engine implementation has been upgraded to use pymxs. As such, the old Blur Python based hooks are not compatible anymore with the engine. They can be downloaded from here.

2019-Oct-14

Workfile2 will no longer be initialized if it's being run in an environment where there isn't a UI present.

2019-Sep-27

Bug fix, you can now use the filter_publishes.py and filter_work_files.py hooks to modify a file's display name in the UI. Previously if you modified an item's "name", it was ignored.

2019-Sep-16

Adds hooks to allow the specification of a custom badge for Publishes and Versions. This badge is shown as an overlaid icon, similar to the "publish" and "locked" icons.

2019-Jun-04

Resolves an issue with the custom_actions hook when running in some PySide2 environments.

2019-Apr-15

Improved logging around failed context changes.

2019-Feb-06

Minor tweak to correct a PyQt5 incompatibility.

2018-Aug-08

fixes text cutoff issues in workfile display

2018-Aug-08

ability to configure the tabs displayed in the app

2018-Jun-14

We now hide the "my tasks" checkbox in entity tree views when deferred queries are in use.

Details:

This feature didn't function properly when deferred queries are used, so it's no longer shown when the app is configured to make use of them. This also hides that same checkbox when script-key authentication is in use and no Shotgun human user can be determined.

2018-May-08

Fix for new file action hanging.

Details

Fixes a bug where workfiles2 would cause the whole DCC to hang when the user ran the new file action, and had a version folder in the work file template path.

2018-Mar-25

Fix for deferred mode hanging.

Details

Fix a problem with a deferred setup where expanding items in the tree view could trigger lot of unnecessary requests to Shotgun, causing the app to hang.

2018-Mar-05

Improved performances: Step filtering for Tasks and deferred queries.

Details

It is now possible to reduce the amount of data which is fetched from Shotgun for Tasks by only retrieving Tasks for a given set of pipeline Steps. Step filtering is controlled by a small piece of UI under Entity tabs, is saved in user settings when closing the application, and restored when opening it.

A new sub_hierarchy setting is now available to run two steps queries, the second query being deferred until fetching children from Shotgun is really needed, typically as the user expand the tree view. This can allow to greatly improve performances by not systematically fetching a huge amount of data from Shotgun when the application is started. It must contain the following keys:

• entity_type: the target Entity type for the deferred query.
• filters: some optional filters to use for the deferred query.
• link_field: the Shotgun field name to use to run the deferred query for a given Entity retrieved from the primary query.
• hierarchy: A list of Shotgun field names defining the hierarchy to use when showing results from deferred queries in a tree view. Step filtering will be enabled in the UI if a step field name is included in this list.

For example, retrieving Shots grouped by Sequences and deferring Tasks retrieval could be defined with the following settings:

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

An additional optional step_filter_on is now available when not using deferred queries and retrieving Tasks, allowing to only display in the UI pipeline Steps linked to a particular Entity type. For example, when retrieving Tasks for Assets with classic queries:

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

Please note that tk-framework-shotgunutils v5.3.5 or higher is now required for this app.

2017-Dec-22

Eliminates some noise when opening the app in Photoshop.

Details:

Fixes some improper exception handling to prevent some noisy output being sent to the console/logs on launch of the app in Photoshop.

2017-Dec-06

Updated metrics logged

2017-Nov-27

Fixes a bug with versioning up work files in user sandboxes.

Details

• If the project was setup to use user sandbox work areas, and the user opens a file belonging to a different user's work area, but did not have any files in their own area, then it would fail to work out the next version for the copied file. This is now fixed

2017-Sept-27

Modify the file widget layout to account for long file names.

Details:

• The filename, version are no longer truncated in the file browser if too long. The work file name now displays an ellipsis to indicate that it is longer than it appears to be.
• The version is now listed on the following line (instead of comma-separated name, v001).

2017-Jun-09

Revert default my tasks tab filter behaviour. Now doesn't filter out tasks with fin and omt statuses by default.

2017-Jun-08

Improves app usability with large amounts of tasks

Details:

• Added an option to disable auto expansion of root level nodes in the tree views. They are now set to be collapsed by default.
• Tree view search box behaviour changed so that it only performs the search after hitting enter, rather than after every character entered.
• A tooltip has been added to the search box to inform users they must press enter to complete the search.
• The My Tasks tab filters can now be configured in the same way the custom tabs can. Users can now use the following config option to customise the filters. Example:

my_tasks_filters:
      - [task_assignees, is, '{context.user}']
      - [sg_status_list, not_in, [fin,omt]]

2017-Mar-14

Removes problematic profiles from png files used as icons.

Details:

This will silence libpng warnings from Qt when the png files are loaded as pixmaps. This is a second attempt as this profile stripping, and uses ImageMagick's "mogrify" command to achieve the desired result, which maintains color consistency.

2017-Mar-09

[minor] No longer disables context changes for Photoshop CC on file load.

Details:

The tk-photoshopcc engine now handles this case without the need to explicitly disable the active-document monitoring via the previously-used context manager.

2017-Feb-09

Workaround for Hiero not updating save menus

2017-Jan-30

Adds support for tk-photoshopcc.

2017-Jan-5

Updated to use v5 of the shotgun utils framework with improved data loading performance.

2016-Nov-28

Left hand side tree view is now ordered in a case insensitive fashion.

2016-Nov-25

This fixes an issue with publishes without a path set.

2016-Nov-21

Left hand tree view is now sorted alphabetically.

2016-Oct-25

The open operation on a file can now be cancelled and exceptions are better handled during file operations.

Details:

If the execute method in the scene_operation_<tk-engine>.py returns False during the open operation, the dialog will not be dismissed and the current context won't change.

2016-Oct-19

Adds support for the alternative Shotgun filter syntax.

Details:

The alternative filter syntax can be found here.

2016-Oct-14

Fixes an issue with user sandboxes.

Details:

Configuring user sandboxes to use a task's name in a template instead of step's name would cause the file list to refresh multiple times before settling on a fixed set of files.

2016-Jun-30

Uses change_context rather than doing a full engine restart.

Details:

This will speed up operations that require a change of context, such as creating a new file via Workfiles2. Note that it is advised that tk-multi-publish, tk-nuke-writenode, and tk-nuke-quickdailies also be updated when moving to v0.7.39 of tk-multi-workfiles2.

2016-Jun-30

Clicking on a project in Hiero or Nuke Studio will now retrieve only the publishes on that entity and not the publishes for all the project.

2016-Jun-15

The application now uses the engine instance name instead of engine name when creating deferred folders. This may require an update to your project's schema.

Details:

When using deferred folder creation, the engine instance name will be used instead of the engine name. For example, the engine tk-nuke configured under the tk-nukestudio section in asset_step.yml will use tk-nukestudio as the token for comparison when evaluating a deferred folder.

2016-Jun-08

Fixes an issue where the application sometimes switches context without any user intervention.

2016-May-17

Toned down some warnings that seemed like errors when templates were not configured.

Details:

It was brought to our attention that the new messages we introduced in v0.7.31 when templates were missing or an app missing form the environment were giving off the impression that these were grave errors that should be fixed in a user's configuration. Therefore, we've introduced messages that are much more neutral in tone, since most of these should have been considered as informational and not issues to fix.

There has been a slight change in behaviour for the application. It used to be that when a template was missing the file tabs would be working, but with only partial results being shown. The new behaviour is such that a missing template will always show a message to the user.

2016-May-13

The behaviour of the user filtering button is now more consistent.

Details:

The user filtering button will be visible as soon as user sandboxes are detected in templates.yml file, after which the GUI will disable the button if the feature is not available for a given context and will provide informative tooltips.

2016-Apr-26

Errors while scanning for files are more accurately reported.

2016-Apr-21

The app will not refresh the task views as often as before.

Details:

The app cached data that was not necessary for the task views. Changing that data on the server would cause the task views to be rebuilt uselessly. The app is now only caching the fields that are required for it to function.

2016-Feb-26

Fixed an issue when switching context.

2016-Feb-25

Fixes issues when an engine is configured multiple times in the same environment.

Details:

The new behaviour is as follows:

1. When looking for settings in another environment, the application will always look for application settings in the same engine instance name. This avoids cross talk between engine instances, e.g. tk-nuke vs tk-nukestudio in the default config.

2. If there is only one set of application settings for the app, it will be used automatically, regardless of the application instance name.

3. If there is more than one set of application settings, only the one with the same application instance name will be used. If none matches, no settings will be used and a warning will be logged to the console.

2016-Feb-19

Added user activity metrics for particular actions

2016-Feb-12

Adds support for on-the-fly context changes.

2016-Feb-10

Adds Nuke Studio support.

2016-Feb-05

Task creation is now delegated to a hook.

Details:

The hook is responsible for validating and then creating the task in Shotgun in the create_new_task method. A developper can optionally provide a QValidator for the task name field through the create_task_name_validator.

2016-Feb-04

Entity tree views do not display entity type names anymore.

Details:

In order to reduce the noise and accommodate longer entity names in the entity tree, they will not prefix their name with their type anymore. The type will now be displayed in a tooltip.

2016-Feb-02

The default tab when using the Shotgun Engine for Hiero is Project.

2016-Jan-29

Increased app stability in multiple DCCs.

2016-Jan-07

File dialogs are not modal anymore.

Details:

File dialogs are not modal anymore, except in Nuke 6 where there seems to be memory deallocation issues with PySide in a background thread. In this version of Nuke, the dialog is modal and the automatic garbage collection from Python is disabled and replaced with one that runs periodically from the main thread while the dialog is on screen.

2016-Jan-04

Added previous versions sub-menus to the list of right click actions on versions.

Details:

Each sub-menu entry displays the list of actions that would be displayed if you had right-clicked on that specific version in All Versions mode.

2015-Dec-09

The path cache is now updated when loading the file manager or refreshing it.

2015-Nov-27

Upgraded to use Shotgun Utils Framework v4.x

Save As no longer overwrites previous versions.

Details:

Clicking on the Save button before file scanning was completed would sometimes overwrite a previous version.

Removed the grid and list view buttons since only grid view is implemented.

Fixed issue where no files are found if the current user isn't known

Bug fixes

Details

• Fixed issue where an exception would be raised if a Shotgun user matching a login can't be found
• Fixed PyQt compatibility issue with My Tasks view

Various fixes, code tidy-up and updated to use the latest version of the shotgunutils framework

Details

• Folder icon is now used correctly for non-file child items in the list view
• Double-clicking in the list view is now only recognised for the left mouse button
• Fixed issue where file modified/publish times between 12-1pm were being displayed as being between 0-1am (they were still sorted correctly though)
• Added tooltip for files that provides more information including the publish description
• Fix to allow the project to be specified in the entity tree for Hiero/Project based workflows
• Updated My Tasks model so that thumbnails are loaded in background threads (using the new features from the latest tk-framework-shotgunutils)
• Lots of code tidy-up and miscellaneous fixes

Removed some debug code that was causing odd behaviour

New preview release containing fixes and tweaks.

Details

• Includes a number of stability improvements and performance improvements

New preview release containing fixes and tweaks.

New preview release containing tweaks to the Save UI.

New preview release containing numerous fixes and tweaks.

Initial pre-release version of the File Manager v2 for QA. Changes over v1 include:

Details

• Completely new File-Open dialog:
  • My Tasks & Entity trees for navigating the Work Area.
  • File grid view written using the Qt model-view system to improve performance.
  • Ability to open a file from another Work Area into the current Work Area.
  • Ability to define Custom actions for files/publishes through a new hook
• Enhanced Save-As dialog:
  • Added ability to navigate to and save in a different Work Area
  • If the file extension in the template is defined with options then those options are presented as a drop-down list to the user
  • Changing the version is now built into the Save-As dialog.
• Removed Switch Work Area and Version Up dialogs