Skip to content

Index

Overview

services: # optional
    shotgrid # (Optional): Autodesk Flow (Shotgrid) integration settings.
    temporal # (Optional): Temporal service options.
    aws      # (Optional): Amazon AWS service options.
    aspera   # (Optional): Aspera service options.
    box      # (Optional): Box.com service options.
timezone: America/Los_Angeles
webhooks: None # optional
sg_ami: None # optional
ingest: None # optional
ShowConfigModel is the main configuration model for managing all Show settings. It has the following properties:

  • services: Specifies options for integrated services like Shotgrid, AWS, Aspera, Box, and Temporal.
  • timezone: Sets the default timezone for the show. (1)
  • webhooks: Manages webhook configurations for automated entity updates.
  • sg_ami: Contains configuration for the Action Menu Item (AMI) module for Shotgrid.
  • ingest: Manages ingestion configurations for file types, inputs, and pipelines.
  1. This affects things like the $datetime template variable.

Updating a Show's Configuration

Applying new changes

Configuration changes will go into effect right away for webhooks and sg_ami.

For ingest changes, you will need to restart the show inputs to apply the new settings.

Requeued Packages

New settings will take effect immediately for completed packages that are re-queued.

In-progress Packages

Currently processing packages will continue processing with the old settings until all finishers have run and the package processing workflow completes.

This is true even if you have restarted the inputs and even if new files are added.

Warning

Newly added packages will process with the old settings until you restart the show inputs.

Re-parsing files after a configuration change

Requeueing files from the items page will re-parse the filename, allowing any file_type configuration changes to be applied to the item(s).

Requeueing entire packages from the packages page does not re-parse any individual file in the package.

Properties

TODO: Organize me

1. services (Object)

  • Description: Specifies options for services such as Shotgrid, AWS, Aspera, Box, and Temporal.
  • Type: Object
  • Default: { "shotgrid": null, "temporal": { "task_queue_override": null }, "aws": null, "aspera": null, "box": null }
  • Schema: Refer to ServicesOptions.

ServicesOptions Properties

2. timezone (String)

  • Description: Specifies the timezone for the configuration.
  • Type: String (format: zoneinfo)
  • Default: America/Los_Angeles

4. sg_ami (Object)

  • Description: Configuration for the Action Menu Item (AMI) for Shotgrid.
  • Type: Object
  • Default: { }
  • Schema: Refer to AMIModuleMap.

AMIModuleMap Properties

  • list_entities (null): Lists entities, if available.
  • get_thumbnails (null): Retrieves thumbnails.
  • lineup_creator: Configuration for creating lineups.
  • redirect_to: Redirection settings for entities.
  • copy_files: Settings to handle file copying.

5. ingest (Object)

  • Description: Configurations related to the ingestion process for files.
  • Type: Object
  • Default: { "file_types": [], "inputs": [], "pipelines": { } }
  • Schema: Refer to IngestConfigModel.

IngestConfigModel Properties

  • file_types (Array): Specifies configurations for different file types.
  • inputs (Array): Defines different inputs for file ingestion.
  • pipelines (Object): Contains pipelines for processing files.

Additional Definitions

ActionCleanup Properties

  • module: Constant value cleanup.
  • delete_source_item (Boolean): If true, deletes the source item.
  • delete_downloaded_item (Boolean): If true, deletes the downloaded item.

ActionDownload Properties

  • module: Constant value download.
  • operation: Specifies the operation (e.g., download, copy).
  • overwrite_existing_files: Overwrite or rename existing files.
  • set_local_path: If true, sets local path to the destination.
  • paths: Mapping of file types to download or copy paths.
  • more?

ActionRemoteCopy Properties

  • module: Constant value remote_copy.
  • service (String): Specifies the file storage service to use, e.g., s3, box.
  • set_remote_path (Boolean): If true, sets the remote path to the destination path.
  • paths (Object): Maps file types to paths for copying.
  • overwrite_existing_files (Boolean): Determines whether existing files should be overwritten or raise an error.

ActionShotgrid Properties

  • module: Constant value add_to_shotgrid.
  • file_types (Object): Configuration options for each item type, with properties defined in TypeConfig.

ActionShotgridDelivery Properties

  • module: Constant value add_to_shotgrid_delivery.
  • sg_delivery_entity (String): The Shotgrid entity used for delivery (default: Delivery).
  • sg_name_field (String): Field used for package name (default: title).
  • sg_versions_field (String): Field to add version link (default: version_sg_deliveries_versions).
  • sg_summary_field (String|null): Text field for status updates.
  • extra_data (Object|null): Extra metadata for Shotgrid delivery.

ActionShotgridFile Properties

  • module: Constant value add_to_shotgrid_file.
  • file_types (Object): Configuration options for each item type, as specified in TypeConfig.

ActionShotgridPlaylist Properties

  • module: Constant value add_to_shotgrid_playlist.
  • playlist_name (String): Name of the playlist to create.
  • extra_data (Object|null): Additional metadata for the playlist.

ActionTest Properties

  • module: Constant value test.
  • status_message (String): Status message to display (default: Test).
  • delay_seconds (Number): Delay before completing (default: 0).

AsperaOnCloudOptions Properties

  • user_email (String): Email address for Aspera on Cloud account.
  • org_subdomain (String): Aspera on Cloud organization subdomain.
  • private_key (String): Private key for Aspera on Cloud (write-only).

AwsOptions Properties

  • region_name (String): AWS region name.
  • access_key_id (String): AWS access key ID.
  • secret_access_key (String): AWS secret access key (write-only).

BoxOptions Properties

  • event_stream_position (String|null): Position in the event stream to start from.

CopyFilesConfig Properties

  • Configurations (Object): Contains configurations for file copy parameters.

CopyFilesPathModel Properties

  • from (String): Source path, with support for variables and wildcards.
  • to (String): Destination directory, supports variable substitution.
  • is_from_path_frames (Boolean): If true, treats from as a multi-frame path.
  • rename (String|null): Optionally rename files.
  • method (String): File operation method, e.g., copy, hardlink, move.
  • service (String): File storage service to use (default: local).
  • create_shared_link (Boolean): If true, generates a shared link.
  • path_substitutions (Object): Maps substitutions, typically for cross-platform path mapping.

FileType Properties

  • name (String): Name of the file type.
  • regex (String|null): Regular expression to match filenames.
  • parent_folders_regex (String|null): Regular expression for parent folder names.
  • extensions (Array of Strings): Supported file extensions.
  • priority (Integer): Priority of the file type (values: 0, 5, 9).
  • default_task (String|null): Default task associated with this file type.
  • var_map (Object|null): Mapping for variables specific to the file type.

FinishCleanup Properties

  • module: Constant value cleanup.
  • delete_package_folder_if_empty_from (String): Path to delete if empty.
  • delete_additional_package_files (Array of Strings): Files to delete before empty check (default: [".DS_Store"]).

FinishFrameCheck Properties

  • module: Constant value frame_check.
  • frame_types (Array of Strings): List of file types treated as frames.
  • sg_frame_in_field (String): Shotgrid field for first frame number (default: sg_head_in).
  • sg_frame_out_field (String): Shotgrid field for last frame number (default: sg_tail_out).
  • sg_check_field (String): Shotgrid Version field for frame check results.
  • sg_check_results_field (String|null): Text field for error details if check fails.
  • service (String): Storage service to use, e.g., local, s3.

FinishShotgridDelivery Properties

  • module: Constant value finish_shotgrid_delivery.
  • sg_delivery_entity (String): Shotgrid delivery entity (default: Delivery).
  • sg_name_field (String): Field for package name (default: title).
  • sg_summary_field (String): Text field for summary (default: sg_contents).
  • sg_finished_status (String|null): Status on successful delivery.
  • sg_failure_status (String|null): Status on failed delivery.

FinishTest Properties

  • module: Constant value finish_test.
  • delay_seconds (Number): Delay before completion (default: 0).

IngestConfigModel Properties (continued)

  • file_types (Array): Specifies different file types.
  • inputs (Array): Defines various inputs, including Aspera, AWS SQS, and Box.
  • pipelines (Object): Configures processing pipelines for ingestion.

InputAspera Properties

  • module: Constant value aspera.
  • workspaces (Array of Strings): List of Aspera workspaces to monitor.
  • regexes (Array): Regular expressions to match package names.
  • include_dropbox_packages (Boolean): If true, includes Dropbox packages.

InputAwsSqs Properties

  • module: Constant value aws_sqs.
  • sqs_queue (String): SQS queue to subscribe to.
  • regexes (Array): Regex patterns to monitor S3 keys.

InputBox Properties

  • module: Constant value box.
  • regexes (Array): Box paths to monitor.

Continuing with the documentation for additional configurations within ShowConfigModel:

Additional Definitions (continued)

InputConfigModel Properties

The InputConfigModel allows for setting up configurations for monitoring and processing files.

  • polling_interval (Integer): Time interval (in seconds) for polling new items (default: 60).
  • use_override_task_queue (Boolean): If true, overrides the task queue for inputs.
  • input (Object): Configures input source, supporting different modules (Aspera, AWS SQS, Box, etc.).

InputConfigModel - Supported Input Modules

InputAspera
  • module: Constant value aspera.
  • workspaces (Array of Strings): List of Aspera workspaces to monitor.
  • regexes (Array): Regular expressions for matching package names.
  • include_dropbox_packages (Boolean): True to include Dropbox packages, or False to include only individual packages.
InputAwsSqs
  • module: Constant value aws_sqs.
  • sqs_queue (String): AWS SQS queue to subscribe to.
  • regexes (Array): Regex patterns to monitor S3 keys for incoming packages.
InputBox
  • module: Constant value box.
  • regexes (Array): Box paths to monitor for incoming packages.
InputTest
  • module: Constant value test.
  • pipeline (String|Array of Strings): The pipeline or list of pipelines to run.
  • number_of_packages (Integer): Number of unique packages to generate (default: 10).
  • max_items_returned (Integer): Maximum items to return per package on each call (default: 10).
  • no_items_returned_percentage (Integer): Percentage of times no items will be returned (default: 33).
InputWatchfolder
  • module: Constant value watchfolder.
  • watch_path (String): Path to monitor for new files.
  • pipeline (String): Pipeline to run files through.
  • package_regex (String|null): Optional regex for parsing values from package names.

InputRegexModel Properties

  • package_regex (String): Regex pattern to match files for processing.
  • pipeline (String): Pipeline to route matched files through.

LineupBox Properties

  • title (String|Number|Null): Title for the lineup box.
  • contents (Any type): Content details for the lineup box.

LineupConfig Properties

  • sg_turnover_entity (String): Shotgrid turnover entity type (default: Launch).
  • sg_turnover_shots_field (String): Turnover entity field with shot data (default: shots).
  • sg_shot_turnovers_field (String): Field for shot turnovers (default: launches).
  • extra_shot_fields (Array of Strings): Additional shot fields for results.
  • sg_element_entity (String|null): Shotgrid entity for elements (e.g., Version or Scan).
  • sg_shot_elements_field (String): Shot field for lineup elements (default: sg_versions).
  • include_element_task_names (Array of Strings|null): Only elements in these tasks are included.
  • include_element_statuses (Array of Strings|null): Only elements with these statuses are included.
  • sg_vendors_field (String): Field containing vendor entities (default: sg_vendors).
  • sg_turnover_date_field (String): Field for turnover date (default: updated_at).
  • template (Object): Lineup template configuration, default options included.

LineupElement Properties

  • name (String): Name for the lineup element (default: $code).
  • detail1 (Object|null): Optional additional details for element.
  • detail2 (Object|null): Optional additional details for element.
  • boxes (Array of LineupBox): Boxes to display within the element.

LineupTemplateConfig Properties

  • show_name (String): Display name in the top header.
  • header_center (String): Subtitle text in the center header.
  • col1 (Array of LineupBox): Boxes to display in the left column.
  • col2 (Array of LineupBox): Boxes to display in the right column.
  • elements (LineupElement): Display options for each element, default provided.

LinkModel Properties

  • sg_link_entity (String): Entity type to link.
  • sg_link_entity_code_is (String): Entity code filter for linking.

LinkedEntityFilterModel Properties

  • field (String): Field to filter by.
  • is_entity (String): Entity type as a filter condition.
  • where (Array of Strings): Conditions to apply to the field.

Pipeline Properties

  • finish_timeout (String): Timeout duration for pipeline completion (default: PT10M).
  • actions (Array): List of actions within the pipeline, configured using a module-based discriminator.
  • finishers (Array): List of finisher actions, default options included.

Pipelines Properties

  • Default: { }
  • Additional Properties: Each pipeline is defined by a Pipeline object, with keys as pipeline identifiers.

Priority Enum

  • Description: Indicates the priority of file types or tasks.
  • Values: 0, 5, 9.

ProcessCSVConfig Properties

  • create_if_no_exist (Boolean): If true, creates missing files.
  • version_start_row (Integer): Row to start versioning from (default: 1).
  • column_field_map (Object): Maps column names to field names.

RedirectToConfig Properties

  • Description: Configuration for entity redirection in Shotgrid.
  • Additional Properties: Each configuration is defined by a RedirectToOption object.

RedirectToOption Properties

  • name (String): Name for AMI entry in Shotgrid.
  • entities (Array of Strings): List of entities to attach the AMI to.
  • redirect_to_field (String): URL field for redirection.

ServicesOptions Properties (continued)

  • shotgrid (Object|null): Options for Shotgrid.
  • temporal (TemporalOptions): Settings for Temporal, default task queue override is null.
  • aws (Object|null): Options for AWS.
  • aspera (Object|null): Options for Aspera on Cloud.
  • box (Object|null): Options for Box integration.

ShotgridComplexFilter Properties

  • logical_operator (String): Logical operator for conditions (default: and).
  • conditions (Array): List of nested conditions for filtering.

ShotgridFilter Properties

  • field (String): Field name to filter.
  • relation (String): Relation operator, e.g., is, contains, starts_with.
  • value (Any type): Value to match, allowing for various types.

ShotgridOptions Properties

  • api_server_path (String): API server path.
  • api_script_name (String): Script name (default: slingshot).
  • api_script_key (String): API key (write-only).
  • secret_token (String): Secret token (write-only). Omit this entirely to have a secret_token be auto-generated
  • default_project (String|null): Default project for actions.
  • user_find_order (Array of Strings): Order for user matching (default: ["email", "group", "group.sg_vendor_code", "name"]).

TemporalOptions Properties

  • task_queue_override (String|null): Override value for task queue.

app__modules__ingest__actions__shotgrid__TypeConfig Properties

  • sg_link_entity (String|null): Link entity type.
  • sg_link_entity_code_is (String): Code for the link entity (default: ${name}).
  • sg_link_filters (Array): Filters for linked entities.
  • sg_link_status_field (String): Field for link status.
  • sg_link_status (String|null): Link status.
  • exempt_link_statuses (Array): Statuses to exempt from linking.
  • sg_task_status (String|null): Task status.
  • exempt_task_statuses (Array): Task statuses to exempt.
  • sg_version_status (String|null): Version status.
  • sg_new_task_step_id (Integer|null): New task step ID.
  • sg_new_task_extra_data (Object|null): Extra data for new task.
  • set_path_to_movie (Enum): Path for movie, local or remote.
  • sg_link_to_movie_field (String|null): Field for the movie link in Shotgrid.
  • set_path_to_frames (Enum): Determines the frame path (local, remote, or null).
  • sg_link_to_frames_field (String|null): Field for the frames link in Shotgrid.
  • filename_inclusions (Array of Strings): Specifies filename patterns to include.
  • filename_exclusions (Array of Strings): Specifies filename patterns to exclude.
  • is_image_sequence (Boolean): True if the file type is an image sequence (default: False).
  • sg_version_extra_data (Object|null): Additional data for Shotgrid version.
  • upload_media (Boolean): Determines if media should be uploaded (default: True).
  • process_csv (ProcessCSVConfig|Null): Configuration for processing CSV files, with default null.

app__modules__ingest__actions__shotgrid_file__TypeConfig Properties

This configuration is specific to Shotgrid file actions.

  • sg_link_entities (Array of LinkModel): List of entities to link in Shotgrid.
  • sg_file_status (String|null): Status of the file in Shotgrid.
  • sg_file_extra_data (Object|null): Additional data for Shotgrid file.
  • sg_file_link_type (Enum): Specifies the link type, either local or upload.

ProcessCSVConfig Properties

Defines configurations for CSV processing within Shotgrid.

  • create_if_no_exist (Boolean): If true, creates a new CSV file if it doesn't exist.
  • version_start_row (Integer): Row number to start versioning from (minimum: 1, default: 1).
  • column_field_map (Object): Maps CSV columns to Shotgrid fields.