Enabling a custom entity

  1. Shotgun Support
  2. Shotgun Admin Guide
  3. Getting started

Video transcript

If you need to track something new, which doesn’t exist in Shotgun by default, then you’ll want to enable a Custom Entity. For example, you might want to track Seasons for your TV series.

Seasons entity

To enable a Custom Entity, first head to Site Preferences under the Admin menu.

Site preferences

Expand the Entities section and choose one which isn’t enabled. The available entities will appear as a light grey.

Enable it by selecting “Yes, use custom entity...” Then give it a new name, such as "Seasons."

Next, decide if that entity needs to have Tasks, Versions, or Pipeline Toolkit/File Publishes. Save the changes and you’re done!

Note: If you choose to enable Tasks, once the new preferences are saved, two things will happen: Tasks will be linkable to the newly configured entity type, and it will support the use of Task Templates.

Custom entity enable

Seasons will now appear under Projects > Other. And you can add it to the Project Navigation bar if you need to.

Project navigation bar

To learn how to link your new custom entity, see part 2 of the video: "Linking a custom entity."

Article Last Updated::
Follow

5 Comments

Date Votes
  • 0
    Avatar
    Chris Burgess

    What if we need to delete (reset) or modify a Custom Entity after we've created it? It disappears from the Site Preferences > Entities page, so how can we reset a Custom Entity if we no longer need it, or edit the Custom Entity if we want to make changes to it?

  • 1
    Avatar
    Daniel STEIN

    The Custom Entity shouldn't (and most likely won't) disappear from the Site Preferences > Entities section. It will be sorted alphabetically by whatever you've chosen as the Display Name though.

    For example, if you activate CustomEntity04 and give it a Display Name of PreProduction, it will appear later in the Entities tab as PreProduction (CustomEntity04) sorted with the other entities that begin with 'P'. Hope that helps.

  • 0
    Avatar
    Chris Burgess

    Ohh I see it now :) thanks Daniel!

  • 0
    Avatar
    Christopher Stack

    Can an entity be edited to change it into a multi-entity? We started with a field that we thought would just have one entry, but now we need it to have multiples.

  • 0
    Avatar
    Christopher Stack

    To answer my own question - No.

    From SG Support:
    "Unfortunately, there's no way to change a Field from entity to multi-entity. The best way to go about this would be to create a new multi-entity field and then export your data from the old entity field and re-import it into the new one. Then you can retire or delete the old field (it's also worth noting that if you need the new field named identically to the old field, you'll have to fully delete the old field before creating the new one)."

Please sign in to leave a comment.