Elements
Last updated
Last updated
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.
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
.
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.
This feature requires an OffShoot Pro license. Upgrade via the License Manager, or via OffShoot > Settings > License. Check out all Pro features here.
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
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.
Control per preset which file extensions and metadata elements should end up in iconik sidecar files.
Read more about the iconik integration here.
A .hedge
preset is formatted as a JSON file and can be opened in any text or code editor.
To install the preset, double-click the .hedge
file. OffShoot will launch, and install the preset in ~/Library/Preferences/Hedge/Presets/
.
A .hedge
preset file consists of one array with one or more preset objects (in JSON format).
The sourceReviewElements
array contains all elements that will appear in the Review pane when adding a source.
The clipReviewElements
array contains all elements that will appear in the Clip Review pane when adding the transfer.
Element properties
Element types
There are five Element types:
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..
select
Elements have an extra options
property that holds all the dropdown options.
Tip: Leave the first option blank to make selecting a value an active choice.
You can define the following organize settings in a preset:
It is also possible to create one .hedge
file with multiple presets. See the example below.
Name | Required | Description |
---|---|---|
Name | Required | Description |
---|---|---|
Type | Description |
---|---|
Setting | Type | Required | Description and example |
---|---|---|---|
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
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.
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.
number
A text input field that accepts only numerical values.
hidden
A hidden field that does not show up in the form.
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.