Production Settings

On this page we will first have a look at the API calls involved in working with production settings. Next we will look at what settings actually exist.

Note that the following things are not part of production settings but have their own API and models:

categories of a production
custom fields (clip / eo) of a production
roles that exist in a production
service integrations
custom workflows

Production settings API

Get production settings

GET /production/{prId}/settings

_Get all the settings for a particular production. _

Details

Description

Getting production settings with the production ID and no-defaults option selected.

Parameters

Path Parameters

Name Description Required Type

Name	Description	Required	Type
`prId`	ID of the production.	✔	Long

prId

ID of the production.

✔

Long

Query Parameters

Name Description Required Type

Name	Description	Required	Type
`noDefaults`	By default, the settings that are returned are merged with the default production's settings. Append the `noDefaults` parameter if you don't want this to happen.	✘	Boolean

noDefaults

By default, the settings that are returned are merged with the default production's settings. Append the `noDefaults` parameter if you don't want this to happen.

✘

Boolean

Return Type

Object

Content Type

application/json

Responses

Table 1. http response codes
Code	Description	Datatype
200	The request was successful.	`Object`
403	The user needs PRODUCTION_VIEW rights.	`ForbiddenError`
404	The production was not found.	`NotFoundError`

Note that the default values of all the settings are automatically merged into the response of this call, unless the noDefaults query parameter is included. See the section on Default Production Settings.

If you want to get only one specific setting, you can append the key to the previous call. For example, if it’s edgeDriveTypes that interest you, use the following call:

GET /api/production/{prId}/settings/edgeDriveTypes

which would return something like this:

{
  "shared": "shared",
  "system": "system",
  "storage": "backup",
  "volatile": "source"
}

Alternative: get production settings via includeSettings

If you need to load the production data and the settings together, you can use the includeSettings parameter when fetching the production.

GET /api/production/{prId}?includeSettings=true

For more info on includeSettings parameters, check out this page.

Update production settings

Patch settings

You can use JSON Patch. to change particular production settings by using the following call:

PATCH /production/{prId}/settings

Patch the production settings providing a production ID and updated setting.

Details

Description

Advised vay is via the Flow UI. User has to be authorized.

Parameters

Path Parameters

Name Description Required Type

Name	Description	Required	Type
`prId`	ID of the production.	✔	Long

prId

ID of the production.

✔

Long

Body Parameters

Name Description Required Type

Name	Description	Required	Type
`body`	Patch object	✔	Object

body

Patch object

✔

Object

body

Field Name

Required

Type

Description

Format

Query Parameters

Name Description Required Type

Name	Description	Required	Type
`version`	Version number used to verify the optimistic lock. Not required, but highly advisable parameter. Leaving it out will disable optimistic locking and you could overwrite other people’s changes.	✘	Long

version

Version number used to verify the optimistic lock. Not required, but highly advisable parameter. Leaving it out will disable optimistic locking and you could overwrite other people’s changes.

✘

Long

Return Type

Object

Content Type

application/json

Responses

Table 2. http response codes
Code	Description	Datatype
200	The request was successful.	`Object`
403	The user needs PRODUCTION_MANAGE rights.	`ForbiddenError`
404	The production was not found.	`NotFoundError`
409	The version in the update object does not match with the version stored causing an optimistic lock	`ConflictError`

An example of the body of such a request:

{
    "patch": [
        {
            "op": "add",
            "path": "/prependAudioInfo",
            "value": false
        },
        {
            "op": "add",
            "path": "/libraryDefaultSort",
            "value": "score desc"
        }
    ]
}

Default production settings

Some production settings have a default value, which is defined on the system level. If the setting can not be found on the production level, a default value defined on the system level will be used if it is available.

These default settings are automatically merged into the response when requesting production settings over the API, unless the noDefaults query parameter is included.

Settings on a production

Editorial Objects

Collections and other Editorial Objects

Change the color of the icon of a collection / subcollection in the library sidebar, based on the status it has.

{
  "eoStatusColors": {
    "CHECK-IN": {
        "fgIconColor": "orange",
        "bgIconColor": "transparent",
        "fgIconColorHover": "white",
        "bgIconColorHover": "orange"
    },
    "ERROR": {
        "fgIconColor": "white",
        "bgIconColor": "#CD6766",
        "fgIconColorHover": "white",
        "bgIconColorHover": "#CD6766"
    }
  }
}

EO Visibility Filters

These filters are applied when requesting Editorial Objects in the sidebar. It allows filtering out certain Editorial Objects which shouldn’t be shown in the Limecraft Flow UI.

The following filter will result in EO's with status CLEANED_UP to not be shown in the UI.

  "eoVisibilityFilters": [
    {
      "key": "status",
      "modifiers": [
        "NOT"
      ],
      "values": [
        "CLEANED_UP"
      ]
    }
  ]

Export

exportFormats and subtitleExportFormats

Configure which formats are shown in the export dialog.

{
    "exportFormats": {
        "edit-aaf": true,
        "edit-fcp": true,
        "edit-fcpx": true,
        "edit-adobe": true,
        "export-pdf": true,
        "export-doc": true,
        "export-csv": true,
        "export-subclips-subtitles": true,
        "export-subtitles": true,
        "export-transcript": true
    },
    "subtitleExportFormats": {
        "srt": true,
        "stl": true,
        "ebuttd.xml": true,
        "vtt": true
    }
}

exportBins

Bin Organization in Edit Suite (FCP7 / Adobe Premiere only) Put the clips in bins based on clip metadata.

{
    "exportBins": [
        {
          "value": "scene",
          "label": "Scene"
        },
        {
          "value": "shot",
          "label": "Shot"
        }
      ]
}

exportClipNameParts

Clip Name in Edit Suite (FCP7 / Adobe Premiere only)

How would you like the clips to be named in your edit suite?

{
    "exportClipNameParts": [
                             "mediaObjectName",
                             "scene"
                           ]

}

exportPathResolveLocation

(FCP7 / Adobe Premiere only)

Which media location information should be used during export.

A value different from FILENAME will not show the Location and Folder Structure options in the export dialog.

exportExtraIncludeAnnotations

(AAF / FCP7 / Adobe Premiere only)

The export dialog shows some options to export markers. In some specific cases you might want to show extra options or hide some built-in option. This can be done with this setting.

{
    "exportExtraIncludeAnnotations": [
        {
            "label": "logger thingies",
            "funnel": "ClipAnnotation",
            "defaultValue": false,
            "visible": true
        },
        {
            "label": "the shot list",
            "funnel": "ShotList",
            "defaultValue": true,
            "visible": true
        }
    ]
}

funnel: the Annotation funnel property
label: the label to show in the export dialog. It will be prepended with 'Include '
defaultValue: check or uncheck the marker checkbox by default in the dialog?
visible: set false to hide in the dialog (useful for hiding built-in funnels)

The built-in annotation funnels will be appended to these funnels, unless they are present already in the exportExtraIncludeAnnotations list.

Library Settings

prependAudioInfo, Clip name prefix in library

If the episode, scene, shot or take information is present on your clip, this information is used as a prefix for the clip name in the library.

Use episode, scene, shot, take as a prefix for the clip name.

{
    "prependAudioInfo": true
}

libraryGroupings

Group library search results to visually see which results belong together.

{
    "libraryGroupings": "%5B%7B%22name%22%3A%22configured%22%2C%22label%22%3A%22Configured%22%2C%22fields%22%3A%5B%22mediaObjectId-3%22%5D%7D%5D"
}

libraryDefaultSort

By default, your library clips will be sorted using this field within a group.

{
    "libraryDefaultSort": "%22score%20desc%22",

}

sidebarGroupsComparator

Choose how you want the collection groups, stories and screenplays in the left sidebar to be sorted.

{
    "sidebarGroupsComparator": "title" //created|title
}

libraryAdditionalSelectionActions (deprecated)

Deprecated. Use the ExternalLink command in productionActions or clipActions.

librarySavedStates (has no UI)

The quick views in the library sidebar.

Subtitle Settings

The subtitle settings are defined in the subtitlePresets, spottingRules, and subtitleSettings keys.These are explained in detail in the section on Language and Subtitle Presets.

Font definitions

Key fontDefinitions.At the moment this is only used to load custom fonts for subtitles.

{
  "fontDefinitions": [
    {
      "files": [
        {
          "filename": "SharpGroteskBold15.otf",
          "productionId": 29004,
          "fileResourceId": 29826,
          "fontType": "opentype"
        }
      ],
      "fontFamily": "SharpGroteskBold15",
      "extraFontFaceCss": "" // e.g. "font-style: italic;"
    }
  ]
}

When a subtitle uses "SharpGroteskBold15", the definition above would result in the following font-face css to be created:

@font-face {
    font-family: "SharpGroteskBold15";
    // extraFontFaceCss would be inserted at this point
    src: url("https://bla/production/29004/file/29826/download") format("opentype");
}

Multiple files can be set on a fontDefinition to represent multiple formats. They would result in multiple urls in the src.

The same fontFamily can be used in multiple fontDefinitions. By combining this with extraFontFaceCss, it is possible to use a particular font file for styling bold text and another for styling italic text, for instance.

Review settings

reviewDefaultCommentVisibility

An object which sets the default visibility of new comments created via the UI.

{
    "reviewDefaultCommentVisibility": {
        "securityClasses": [
          "VIEW_COMMENT_INTERNAL"
        ],
        "markForUnrestricted": true
    }
}

Transcript settings

defaultLanguage

This sets the default value for the language of a clip. When set, new clips in the production will automatically get their language set to this value. The impact is that the wizard in the transcriber will assume the language is a particular value and omit some suggestions of creating the transcript (e.g. not suggest speech-to-text to generate a French transcript if the clip language is English).

transcriptConfiguration

An object with settings that have to do with running the automatic transcription service.

defaultEngine

Valid values are:

VOLDEMORT2 - Vocapia
KALDI - Kaldi
VOLDEMORT3 - Speechmatics
VOLDEMORT4 - Google

{
    "transcriptConfiguration": {
        "defaultEngine": "VOLDEMORT2"
    }
}

A legacy way of setting the default engine is via the transcriptSpeechEngine production setting (not under the transcriptConfiguration object). When both are set, the transcriptConfiguration.defaultEngine is preferred.