Hedge
  • Welcome 👋
  • Arctic
    • Requirements
    • Upgrades
    • Releases
    • Questions
    • Need help?
  • Canister
    • Installation
      • macOS
      • Windows
    • Tape Media
    • Features
      • Formatting
      • Archiving
      • Spanning
      • Retrieving
      • Queuing
      • Catalogs
      • Tape Library Manager
      • Connect
      • Logs & Manifests
    • Licensing
    • Firmware
    • Releases
    • Requirements
    • Troubleshooting
    • Questions
    • Beta Track
    • Need help?
  • Connect
  • EditReady
    • Installing
    • Supported Formats
    • Getting Started
    • Previewing Files
    • Metadata
    • Converting Media
      • Additional Features
      • Custom Presets
      • Trimming Clips
      • Joining Files
      • Naming Your Files
      • Rewrapping
    • Connect
    • Settings
      • General
      • Advanced
    • Automation
    • Upgrades
    • Requirements
    • Releases
    • Questions
      • How can EditReady prep my source media for immediate use in Media Composer?
    • Need help?
  • EditReady Server
    • Releases
  • FoolCat
    • Overview
    • Color Conversion
    • Supported Formats
    • Automation
    • Offload Report Creator
    • Questions
    • Requirements
    • Releases
  • Hedge
    • Releases
    • Moving From Hedge to OffShoot
  • Mimiq
    • Getting Started
    • Bin Locking
    • Workspaces
      • Installing macFUSE
      • StorNext permissions
    • Deployment Options
    • Media Composer & Mojave
    • Requirements
      • Avid's Requirements
    • Releases
    • Troubleshooting
    • Questions
    • Beta Track
    • Need help?
  • OffShoot
    • Overview
    • Features
      • Verification
      • Ingest Browser
      • Labels
      • Elements
      • Organization
      • Duplicate Detection
      • Queuing
      • Stop & Resume
      • Cascading Copies
      • S3 Transfers
        • Configuring Connections
      • Logging
      • Connect
      • Date & Time
      • Floating Licenses
      • Automation
        • Scripting
          • Event Log
          • Events
            • OffShoot Started
            • Disk Added
            • Disk Removed
            • Disk Busy
            • Disk Idle
            • Disks Idle
            • Transfers Added
            • File Copy Completed
            • Verification Issue
        • API
        • OffShoot Helper
          • Set Window Layout
        • Example Scripts
          • Transfer Reports
          • Move Transfer Logs
          • Move Foolcat PFD reports
          • Auto-set Destinations
          • Auto-set Preferences
          • Automated Transfers
          • Delete MHL files
          • Slack Notifications
          • Send Email Notifications
          • ZCAM video stitcher
          • Cascading copy
          • Watch Folder
          • Set Finder Tags
    • Integrations
      • Codex
      • EditReady
      • Finder & Explorer
      • FoolCat
      • Frame.io
      • iconik
      • ParaShoot
      • ProGrade
      • Scratch
    • Requirements
    • Releases
    • Questions
    • Need help?
    • Beta Track
    • Solo
  • PostLab
    • Getting Started
    • Supported Apps
    • Supported Storage
    • Features
      • Team Bundles
      • Collections
      • Versioning
    • Requirements
    • Releases
    • Troubleshooting
    • Questions
    • Need help?
    • Beta Track
  • ScopeBox
    • Installing
    • Application Overview
    • Sources
    • ScopeLink
      • Installation and Configuration
      • Troubleshooting
    • Palette Overview
    • Palette Types
      • Audio Meters
      • Channel Plot
      • CIE Plot
      • HML Balance
      • Luma and RGB TimeTrace
      • Luma Histogram
      • Preview
      • RGB Histogram
      • RGB Parade
      • Surround Meters
      • Timecode
      • Vectorscope
      • Waveform
      • YCbCr Parade
    • Stills and Targets
    • Layouts
    • Licensing
    • Upgrades
    • Releases
    • Questions
  • General
    • Downloads
    • Trials
    • Demo Mode
    • Purchasing
      • Students and Non Profits
      • Quotes, POs, and Invoices
      • Refunds
      • Professional Services
    • Licenses
      • The License Manager
      • License Types
      • Local License Server
      • Activating
      • Deactivating
      • Extending
      • Merging
      • OS Updates
      • Licensee Changes
      • VMs & Hypervisors
      • Root Certificates
      • Network Adapters
      • Network Requirements
      • Questions
    • Hedge Funds
    • Certifications
    • Policies
      • Sharing Files
    • Company Details
      • Terms & Conditions
      • Privacy Policy
      • EULA
    • Press
  • Need help?
Powered by GitBook
On this page
  • Getting Started
  • Workspace actions
  • Clear Sources and Destinations
  • Set Destinations
  • Set Sources
  • Restore Default Preferences
  • Set Preferences
  • Run bash commands
  • Run AppleScript
  • Autostart
  • Auto start workspace
  • Change workspaces folder
Export as PDF
  1. OffShoot
  2. Features
  3. Automation

OffShoot Helper

Automatically set up OffShoot workflows with the OffShoot Helper menu bar app.

Last updated 8 months ago

OffShoot Helper is a small menu bar app (macOS only) that enables you to automatically set up OffShoot with a specific configuration called Workspaces.

This feature requires an OffShoot Pro license.

Getting Started

  1. Download .

  2. Open the app and click the OffShoot Helper icon in the menu bar.

  3. Select Example Workspace.

  4. OffShoot will open, setting a Source and Destination.

Workspace files are stored in ~/Library/Preferences/Hedge/Workspaces/. You can quickly get to this location by selecting Manage Workspaces...

A Workspace is a JSON file that specifies how to set up OffShoot. A separate menu item is created for each JSON file in the Workspaces folder.

Workspace actions

A workspace file contains an array with one JSON object that can define the following actions:

[
  { 
    "clearSourcesAndDestinations": true,
    "setSources": ["/Users/hedge/Desktop"],
    "setDestinations": ["/Users/hedge/Desktop"],
    
    "setPreferencesToDefault": true,
    "setPreferences": {"keyword": "value"},
    
    "runBashCommands": ["say 'Hello'"],
    "runAppleScript" : "/path/to/scriptfile.scpt"
  }
]

Clear Sources and Destinations

When set to true, OffShoot clears all Sources and Destinations.

"clearSourcesAndDestinations": true

Set Destinations

Sets one or multiple Destinations e.g. ["/path/to/destinationOne","/path/to/destinationTwo"]

"setDestinations": ["/Volumes/X1"],

Set Sources

Sets one or multiple Sources as a collection e.g:["/path/to/source1","/path/to/source2"]

"setSources": ["/Volumes/Z1", "/Volumes/Z2"]

Restore Default Preferences

When set to true, OffShoot's preferences are reset to their default setting (except for Connect, Cloud, and License preferences).

"setPreferencesToDefault": true,

Set Preferences

Set any preference by using the dictionary below.

"setPreferences": {
            "general_auto_source_recents": "0",
            "general_auto_source_name_enabled": "1",
            "general_auto_source_name_pattern": "UNTITLED;ARRI UDF;A*_*;B*_*",
            "general_auto_recognize_destinations_enabled": "1",
            "general_auto_eject_sources": "0",
            "general_date_tomorrow_starts": "0",
            
            "transfers_queue_mode": "0",
            "transfers_verification_mode": "Transfer", // e.g "Transfer", "Source", "SourceAndDestination"
            "transfers_logs_on_destination_enabled": "1",
            "transfers_logs_on_destination_mhl_per_file_enabled": "0",
            "transfers_extra_log_location": "",
            "transfers_force_underscores": "0",
            
            "connect_enable": "0",
            
            "integrations_foolcat_enable": "0",
            "integrations_foolcat_match_destination": "",
            "integrations_foolcat_report_location": "",
            "integrations_foolcat_report_name": "{Source Name}",
            "integrations_foolcat_report_description": "",
            
            "integrations_frameio_enable": "0",
            
            "integrations_parashoot_enable": "0",
            
            "integrations_scratch_enable": "0",
            "integrations_scratch_match_destination": "",
            "integrations_scratch_match_extension": ".mov; .mp4",
            "integrations_scratch_project": "",
            "integrations_scratch_group": "{YYYY}-{MM}-{DD}",
            "integrations_scratch_timeline": "{Source Name}",
            "integrations_scratch_watchfolder": "/Library/Application Support/Assimilator/Watch",
            
            "scripting_opt_in": "0",
            "scripting_events_checkpoint_issue": "",
            "scripting_events_disk_added": "",
            "scripting_events_disk_busy": "",
            "scripting_events_disk_idle": "",
            "scripting_events_disk_removed": "",
            "scripting_events_disks_idle": "",
            "scripting_events_file_copy_completed": ""
        }

Run bash commands

"runBashCommands": ["say 'Hello'"]

Run AppleScript

"runAppleScript" : "/path/to/scriptfile.scpt"

It's also possible to use a relative path

Autostart

By default, OffShoot Helper is set to automatically start at computer login.

Terminal command to disable:

defaults write nl.syncfactory.Hedge.Mac.Helper launchAtLogin 0

Terminal command to enable:

defaults write nl.syncfactory.Hedge.Mac.Helper launchAtLogin 1

Terminal command to check the current autostart setting:

defaults read nl.syncfactory.Hedge.Mac.Helper launchAtLogin

Auto start workspace

OffShoot Helper can launch a workspace automatically on system startup: Terminal command to enable a startup workspace:

defaults write nl.syncfactory.Hedge.Mac.Helper launchWorkspaceAtStart "filename.json"

Terminal command to disable the startup workspace:

defaults delete nl.syncfactory.Hedge.Mac.Helper launchWorkspaceAtStart 

Terminal command to check the current startup workspace:

defaults read nl.syncfactory.Hedge.Mac.Helper launchWorkspaceAtStart 

Change workspaces folder

You can set a custom workspaces folder with this Terminal command:

defaults write nl.syncfactory.Hedge.Mac.Helper CustomWorkspaceDirectory "/the/path/to/the/custom/dir"

Not all Preferences are built-in, we're adding them on a need-to-have basis. Missing one that is required in your workflow? .

The example below loads a workspace and uses to set two Finder windows on the right side of the OffShoot main window.

Let us know
this script
OffShoot Helper
10KB
Setup-Hedge-and-Finder.zip
archive