Elements

Organize and tag your offloads with custom metadata elements – like Location or Project – to review your added transfers.

Use any elements you create alongside automatically populated elements – such as Source Name, Date, and Counter – to create folder paths, rename files, and set Labels. OffShoot logs all elements and their values in the Transfer Log, Event Log, and Media Hash List.

How to use

Go to Settings > Organize.
Use the ➕ button to create a custom element.
Drag elements to Auto Label, Rename Files, and Create Folders.
Set up a Source and Destination, review your elements, then start your Transfer.

You can also create elements by typing curly brackets { } (e.g. {Project}), then pressing [Enter].

OffShoot lets you review all used elements when you set up a transfer. If you used any custom elements, OffShoot automatically displays the Review panel before a transfer. Didn't use any custom elements? You can still access the Review panel before a transfer. In the Disks menu Command-1, click the up arrow button (⌃) in the lower-right corner to review any auto-populated elements.

Clicking an Auto Label also opens the Review pane.

If you're using presets, you can toggle the Review panel by choosing Review Preset from the Preset dropdown.

By default, all entered information is saved until you quit OffShoot. Want to start fresh? Right-click anywhere in the Review Preset panel and choose Clear.

Logging & Integrations

All elements and their values are logged in the Transfer Log, Event Log, and Media Hash List. They can also be used in the Foolcat, iconik, and SCRATCH integrations.

OffShoot 23.2 (1481) - macOS 14.0.0

Source: /Untitled
Destination: /T1/Project X/2021_12_24/Amsterdam/A001

Preset: 22.1 CAM A | Review
Counter: 001
Date: 24/12/2021
Location: Amsterdam
Project: PRX

Started: 24/12/2021, 09:15:11
...

24/12/2021, 09:15 - File copy completed: {
    "FileCopyCompleted_bytesCopied" = 232656229;
    "FileCopyCompleted_destinationPath" = "/Volumes/T1/PRX/Amsterdam/2021-12-24/A001";
    "FileCopyCompleted_duration" = "1.180007";
    "FileCopyCompleted_checkpointMode" = Off;
    "FileCopyCompleted_presetName" = "22.1 CAM A | Review";
    "FileCopyCompleted_sourceInfo" = { 
	"Counter" = "001", 
	"Date" = "20211224", 
        "Location" = "Amsterdam", 
        "Project" = "PRX" };
    "FileCopyCompleted_sourcePaths" = "/Volumes/Untitled";
    "FileCopyCompleted_startedAt" = 20211224113108;
    "FileCopyCompleted_state" = Success;
}

<?xml version="1.0" encoding="UTF-8"?>
<hashlist version="1.1">
    <hedge>
        <rootPath>/Volumes/T1</rootPath>
    </hedge>
    <sourceInfo preset="22.1 CAM A | Review">
	<sourceinfofield name="Counter">001</sourceinfofield>
	<sourceinfofield name="Date">2021-12-24</sourceinfofield>
        <sourceinfofield name="Location">Amsterdam</sourceinfofield>
        <sourceinfofield name="Project">PRX</sourceinfofield>
    </sourceInfo>

Pro Preset

This feature requires an OffShoot Pro license. Upgrade via the License Manager, or via OffShoot > Settings > License. Check out all Pro features here.

Preset Builder

Create more powerful presets, with custom elements and settings, using the online Preset Builder.

An OffShoot Pro license is required to use presets created by the Preset Builder.

Pro presets let you:

Add Clip Review elements (Beta - not available in OffShoot 23.2 or newer)
Add iconik settings elements
Control the order in which elements appear
Use dropdown elements
Use hidden elements
Create one file with multiple presets
Give elements default values
Save entered values in the preset

Clip Review (beta)

When clipReviewElements are defined in a preset, a Clip Review form is presented per clip.

By default, any entered values are cleared from the Clip Review form. However, you can choose which values will persist by pinning them with 📌. Like Source Review, Clip Review data is logged in the Transfer Log and the (ASC) MHL.

-- Transferred files --
#1: Clip0001.MXF
Path: 2021-09-09__0002_201908231232_000001.MXF
Size: 13729840 bytes
Source hash:	b09fa6763fbd1cf6
Copy hash:	b09fa6763fbd1cf6

Subject: Test shot
Tags: OffShoot, Demo 
Rating: ⭐️⭐️⭐️⭐️⭐️
Info: this is awsome

 <hash>
        <file>2021-09-09__0002_201908231232_000001.MXF</file>
        <size>13729840</size>
        <lastmodificationdate>2019-08-22T11:44:05Z</lastmodificationdate>
        <clipinfo>
            <clipinfofield name="Subject">Test shot</clipinfofield>
            <clipinfofield name="Tags">OffShoot, Demo </clipinfofield>
            <clipinfofield name="Rating">⭐️⭐️⭐️⭐️⭐️</clipinfofield>
            <clipinfofield name="Info">this is awsome</clipinfofield>
        </clipinfo>
        <xxhash64be>b09fa6763fbd1cf6</xxhash64be>
        <xxhash64>f61cbd3f76a69fb0</xxhash64>
        <hashdate>2021-09-09T18:48:03Z</hashdate>
</hash>

iconik

Control per preset which file extensions and metadata elements should end up in iconik sidecar files.

"iconikSidecarElements" : [ "{ProjectID}", "{Project}", "{Season}", "{Date}", "{Camera}", "{Card}", "{Type}" ],
"iconikSidecarExtensions" : [".R3D",".MOV"],
"iconikSidecarDestinations" : ["Backup 1","Backup 2"]

Read more about the iconik integration here.

Pro preset file

A .hedge preset is formatted as a JSON file and can be opened in any text or code editor.

1KB

Production_X_CAM_A.hedge.zip

Structure

A .hedge preset file consists of one array with one or more preset objects (in JSON format).

[{
    "name" : "Production X - CAM A",
    "description": "",
    "version" : "1.0",
}]

Name Required Description

Name	Required	Description
`name`	Single preset: no Multiple presets: yes	If you don't specify a `name`, OffShoot will use the file name as the preset name. Required when defining multiple presets in one file.
`description`	no	Currently unexposed in OffShoot.
`version`	yes	Should always be set to `1.0`

name

Single preset: no Multiple presets: yes

If you don't specify a name, OffShoot will use the file name as the preset name. Required when defining multiple presets in one file.

description

Currently unexposed in OffShoot.

version

yes

Should always be set to 1.0

Elements

The sourceReviewElements array contains all elements that will appear in the Review pane when adding a source.

"sourceReviewElements": [
  { "name": "{Project Name}", "type": "text", "defaultValue": "" },
  { "name": "{Project ID}", "type": "text", "defaultValue": "" },
]

The clipReviewElements array contains all elements that will appear in the Clip Review pane when adding the transfer.

"clipReviewElements": [ 
    { "name": "{Subject}", "type": "text", "defaultValue": "" }, 
    { "name": "{Notes}", "type": "text", "defaultValue": "" }, 
]

Element properties

Name Required Description

Name	Required	Description
`name`	yes	The name of the Element. Must be unique and enclosed in curly brackets `{ }`.
`type`	yes	The type of the Element: `text`, `date`, `select`, `counter`, or `hidden.`
`defaultValue`	yes	The default value of the Element.
`value`	no	Holds the value that has been entered in OffShoot when adding tranfers.
`options`	required for `select` elements	Holds an array of select objects.

name

yes

The name of the Element. Must be unique and enclosed in curly brackets { }.

type

yes

The type of the Element: text, date, select, counter, or hidden.

defaultValue

yes

The default value of the Element.

value

Holds the value that has been entered in OffShoot when adding tranfers.

options

required for select elements

Holds an array of select objects.

Element types

There are five Element types:

Type Description

Type	Description
text	A normal text input field.
date	A date picker. Uses the Language & Region set in System Preferences. The value will be formatted as {YYYY}-{MM}-{DD}. To use a different format in `labelPattern` , `renamePattern` or `folderPattern` use `{YYYY}`,`{MM}` and `{DD}` elements.
select	A dropdown with multiple values.
counter	A text input field with a number that auto increments every time the preset is used.
hidden	A hidden field that does not show up in the form.

text

A normal text input field.

date

A date picker. Uses the Language & Region set in System Preferences. The value will be formatted as {YYYY}-{MM}-{DD}. To use a different format in labelPattern , renamePattern or folderPattern use {YYYY},{MM} and {DD} elements.

select

A dropdown with multiple values.

counter

A text input field with a number that auto increments every time the preset is used.

hidden

A hidden field that does not show up in the form.

    "sourceReviewElements" : [
      { "name" : "{Project Name}", "type" : "text", "defaultValue" : ""},
      { "name" : "{Date}", "type": "date", "defaultValue" : ""},
      { "name" : "{Location}", "type" : "select", "defaultValue" : "",
        "options" : [
          { "name" : "", "value" : "" },
          { "name" : "Adam", "value" : "Adam" },
          { "name" : "Rome", "value" : "Rome" }
        ]
      },
      { "name" : "{Reel}", "type" : "counter", "defaultValue" : "0001" },
      { "name" : "{Preset ID}", "type" : "hidden", "defaultValue" : "0293840293" }
    ],

All Element types can have a defaultValue set, with the exception of date . The defaultValue displays when the Source Review form's first used or when clearing the form. By default, the date element uses the date set in Preferences > General > Date:.

Values entered when tranfers are added are saved as a value property in the preset file..

{ "name" : "{Project Name}", "type" : "text", "value": "Project X, "defaultValue" : ""},

select Elements have an extra options property that holds all the dropdown options.

  { "name" : "{Location}", "type" : "select", "defaultValue" : "", "value" : "",
    "options" : [
      { "name" : "", "value" : "" },
      { "name" : "Adam", "value" : "Adam" },
      { "name" : "NY", "value" : "030" }
    ]

Tip: Leave the first option blank to make selecting a value an active choice.

Organize settings

You can define the following organize settings in a preset:

Setting Type Required Description and example

Setting	Type	Required	Description and example
`doNotCopyFiles`	Array	no	Files with these file extensions will be transferred. e.g. `[".thumbs", "XML"]` cannot be combined with `copyOnlyFiles`.
`copyOnlyFiles`	Array	no	Only files with these file extensions will be transferred. e.g. `[".mp4", "mov"]` cannot be combined with `doNotCopyFiles`. When both properties are defined, `doNotCopyFiles` will be used.
`ignoreEmptyFolders`	Boolean	no	When `true`, empty folders will not be transferred.
`ignoreBundles`	Array	no	Bundles with these names have their file size checked. If the name matches and they're larger or smaller than the size specified, they won't be transferred. e.g. `[ "AVCHD<2MB" ]`
`flattenFolders`	Boolean	no	When `true`, the Source's folder structure is flattened. Duplicate filenames will be renamed with a counter.
`labelPattern`	String	no	Sets the Auto Label pattern for this preset. `{Metadata}` elements, excluding `{Filename}` and `{File date}` elements, can be used. This label will be used in the transfer log name and picked up by the `{Source Name}` element.
`renamePattern`	String	no	Renames all files with the specified format. `{Metadata}` elements including `{Filename}` can be used here.
`folderPattern`	String	no	Create destination folders with a specified format. `{Metadata}` elements, excluding `{Filename} and {File date}`elements, can be used. Use `/` to create a folder path.
`dontAllowRepetitionAndTrim`	Array	no	Specify characters that should be trimmed and checked for repetition in `labelPattern`, `renamePattern`, and `folderPattern`. Especially useful when not all elements have a value.

doNotCopyFiles

Array

Files with these file extensions will be transferred. e.g. [".thumbs", "XML"] cannot be combined with copyOnlyFiles.

copyOnlyFiles

Array

Only files with these file extensions will be transferred. e.g. [".mp4", "mov"] cannot be combined with doNotCopyFiles. When both properties are defined, doNotCopyFiles will be used.

ignoreEmptyFolders

Boolean

When true, empty folders will not be transferred.

ignoreBundles

Array

Bundles with these names have their file size checked. If the name matches and they're larger or smaller than the size specified, they won't be transferred. e.g. [ "AVCHD<2MB" ]

flattenFolders

Boolean

When true, the Source's folder structure is flattened. Duplicate filenames will be renamed with a counter.

labelPattern

String

Sets the Auto Label pattern for this preset. {Metadata} elements, excluding {Filename} and {File date} elements, can be used. This label will be used in the transfer log name and picked up by the {Source Name} element.

renamePattern

String

Renames all files with the specified format. {Metadata} elements including {Filename} can be used here.

folderPattern

String

Create destination folders with a specified format. {Metadata} elements, excluding {Filename} and {File date}elements, can be used. Use / to create a folder path.

dontAllowRepetitionAndTrim

Array

Specify characters that should be trimmed and checked for repetition in labelPattern, renamePattern, and folderPattern. Especially useful when not all elements have a value.

    "doNotCopyFiles": ["xml", ".thumb"],
    "copyOnlyFiles": ["mov", "mp4", "mxf"],

    "ignoreEmptyFolders" : false,
    "ignoreBundles": ["AVCHD<1MB"],
    "flattenFolders" : true,
    
    
    "labelPattern" : "{Location}_{Card}",
    "renamePattern" : "{Project Name}_{Date}__{Location}_{Card}__{Clip Location}_{Rating}_{File YYYY}{File MM}{File DD}{File hh}{File ss}__{File Counter}",
    "folderPattern" : "{Project Name}/{Date}/{Location}/{Card}",
    
    "dontAllowRepetitionAndTrim" : ["_", "/"],

Multiple presets in one file

It is also possible to create one .hedge file with multiple presets. See the example below.

[
    {
        "name": "preset 1",
        ...
    },
    {
        "name": "preset 2",
        ...
    },
    {
        "name": "preset 3",
        ...
    }
]

Last updated 3 months ago

How to use

Logging & Integrations

Pro Preset

Preset Builder

Clip Review (beta)

iconik

Pro preset file

Structure

Elements

Dropdown

Organize settings

Multiple presets in one file