Helmut4
v4.10.0
v4.10.0
  • 👋Welcome to the official Helmut4 documentation
  • GETTING STARTED
    • Overview
      • How to start
      • Helmut4 Modules
      • Deployment Options
    • Tech Specs
      • Helmut4 Clients
      • Helmut4 Server
      • Commonly used ports
    • Installation Guide
      • Helmut4 Client
      • Helmut4 Server
        • Helmut4 Single Server
        • Helmut4 Cluster System
    • Upgrade Guide
      • Helmut4 Client
      • Helmut4 Server
        • Docker & Portainer Update
        • Server Host Update & Upgrade
    • Release Cycles
    • Supported Adobe Versions
      • Known Adobe Issues
    • Supported Avid Versions
    • Open API
    • Additional Configurations
      • Define mongodb_backup volume
      • Restore mongodb_backup
      • Dynamic share mount into docker
      • Enable https / set SSL certificate
        • Custom p12 certificate
        • Create Local SSL Certificate (Untrusted)
      • Limit docker container RAM usage
      • Define timezone for containers
      • Change HTTP/HTTPS Ports
      • Docker & Ubuntu Proxy
  • Helmut4 components
    • HelmutFX
      • Dashboard
      • Projects
        • Add Project
        • Project Status
      • Users
      • Templates
      • Preferences
        • Helmut Variables
        • Job Database Cleanup
        • Modules
          • Flow Module
          • QScan Module
          • ActiveDirectory Module
          • MediaLoopster Module
          • HUE Lamp Module
          • CatDV Module
          • SwatIO Module
          • Grass Valley Stratus Module
          • Active Directory Auto Module
          • Editshare Module
          • RevApp Module
          • Hue Bridges Module
          • Okta Module
      • Languages
      • Metadata
        • Metadata Group
        • Date-Time-Datetime
        • iFrame - Third Party Metadata
      • Streams
        • FX Event Triggers
          • CONNECTED
          • CREATE_CATEGORY
          • CREATE_GROUP
          • CREATE_PROJECT
          • CREATE_USER
          • CUSTOM_FX
          • CUSTOM_USER
          • DELETE_CATEGORY
          • DELETE_GROUP
          • DELETE_PROJECT
          • DELETE_TEMPLATE
          • DELETE_USER
          • DISCONNECTED
          • DUPLICATE_PROJECT
          • EDIT_PROJECT
          • IMPORT_PROJECT
          • OPEN_PROJECT
          • POST_CREATE_PROJECT
          • RESTORE_SAVE
          • UNASSIGNED
          • UNLOCK_PROJECT
          • UPLOAD_TEMPLATE
        • Export Streams
        • Import Streams
        • Debug Streams
        • Add Stream
      • License
    • HelmutIO
      • Dashboard
      • Users
      • Profiles
        • Add IO Profile
      • Watchfolder
        • Add Watchfolder
      • Preferences
      • Languages
      • Metadata
        • Metadata Set
      • Streams
        • IO Event Triggers
          • AUTOIMPORT
          • CUSTOM_IO
          • EXPORT
          • IMPORT
          • PANEL_IMPORT
          • PRESTREAM
          • WATCHFOLDER
      • License
    • HelmutCO
      • Dashboard
      • Projects
        • Cosmo-Project View
        • MIME Type
      • Assets
      • Users
      • Profiles
        • Add CO Profile
      • Preferences
      • Languages
      • Metadata
        • Custom Metadata
      • Streams
        • CO Event Triggers
          • ADDED_ASSET
          • CUSTOM_CO
          • INDEXED_ASSET
          • INDEXED_PROJECT
          • UNINDEXED_ASSET
          • WEB_EXPORT
          • WEB_IMPORT
          • WEB_UPLOAD
      • License
    • HelmutHK
      • Dashboard
      • Projects
      • Tasks
        • Add Task
        • Action Button
      • Cron
        • Add Cron Job
      • Users
      • Profiles
        • Add HK Profile
      • Preferences
      • Languages
      • Metadata
      • Streams
        • HK Event Triggers
          • ARCHIVE
          • BACKUP
          • CONSOLIDATE
          • COPY
          • DELETE
          • MOVE
          • RESTORE
      • License
    • Stream Designer
      • Layout
      • Nodes
        • Conditions
          • Project (8)
            • Project Category Condition
            • Project Creator Condition
            • Project Extension Condition
            • Project Group Condition
            • Project Name Condition
            • Project Personal Condition
            • Project Template Condition
            • Project Version of Premiere Condition
          • User (4)
            • User Displayname Condition
            • User Group Condition
            • User Role Condition
            • User Name Condition
          • File and Folder (10)
            • File Appearing Condition
            • File Content Condition
            • File Exists Condition
            • File Growing Condition
            • File Name Condition
            • File Size Condition
            • Folder Appearing Condition
            • Folder Empty Condition
            • Folder Exists Condition
            • Folder Name Condition
          • OS (1)
            • Operating System Condition
          • Media Info (8)
            • Audio Channel Condition
            • Audio Streams Condition
            • Bitrate Codec Condition
            • FPS Condition
            • Media Codec Condition
            • Media Color Space Condition
            • Media Length Condition
            • Media Resolution Condition
          • Misc (5)
            • Empty String Condition
            • IP Condition
            • Regex Match Condition
            • Wildcard Condition
            • Match Multiple Patterns Condition
        • Actions
          • Helmut (8)
            • Helmut Add Users To Group Action
            • Helmut Confirm Dialog Action
            • Helmut Choose Dialog Action
            • Helmut Input Dialog Action
            • Helmut Remove Users From Group Action
            • Helmut Select Dialog Action
            • Helmut User Displayname Resolve Action
            • Helmut User Email Resolve Action
          • Project (21)
            • Project Create Action
            • Project File Copy Action
            • Project Metadata Changer Action
            • Project File Download Action
            • Project File Upload Action
            • Project Metadata Remove Action
            • Project Set Category Action
            • Project Set Group Action
            • Project Set Name Action
            • Project Set Path Action
            • Project Set Tag Action
            • Project Tag Delete Action
            • Project Set Template Action
            • Project As JSON
            • Project Delete Action
            • Project from JSON Action
            • Project Import Action
            • Project Import to External Helmut Action
            • Project Lock Action
            • Project Status Update Action
            • Project Update Modification Date Action
            • Project Duplicate Action
          • Job Action
            • Job Download Web Content Action
            • Job Metadata Remove Action
            • Job Metadata Changer Action
            • Job Priority Action
            • Job QScan Action
            • Job Render AAF In Premiere Action
            • Job Render in AME Action
            • Job Render Proxy in AME Action
            • Job Render In Premiere Action
            • Job Render with FFmpeg Action
            • Job Shutdown Adobe After Effects Action
            • Job Shutdown Adobe Media Encoder Action
            • Job Shutdown Adobe Premiere Pro Action
            • Job Start Adobe After Effects Action
            • Job Start Adobe Media Encoder Action
            • Job Start AdobePremiere Pro Action
            • Job Status Update Action
            • Job As JSON Action
            • Job From JSON Action
            • Job Set Project ID Action
            • Job Create Job Action
            • Job Delete Action
            • Job Execute Extendscript in Premiere Action
            • Job Execute Extendscript in After Effects Action
            • Job File Copy Action
            • Job Folder Copy Action
            • Job RClone Actions
              • Job RClone Copy Action
              • Job RClone Cmd Action
              • Job RClone MkDir Action
              • Job RClone Move Action
              • Job RClone Purge Action
              • Job RClone RmDir Action
            • Job Export FCP XML in Premiere
            • Job Create Split Jobs Action (BETA)
            • Job Stitch Splits Action (BETA)
            • Job Demo Action
          • Adobe DVA/General
            • Adobe DVA Media Cache Settings
          • Adobe After Effects
            • After Effects Check Status Of Invisible Panel Action
            • After Effects OS Path Mapper Action
            • After Effects Alert Dialog Action
            • After Effects Confirm Dialog Action
            • After Effects Open Choose Dialog Action
            • After Effects Prompt Dialog Action
            • After Effects Start Helmut Panel Action
            • After Effects Set GPU Acceleration Action
            • After Effects Enable Panel Network Access Action
            • After Effects Save Application Settings Action
            • After Effects Purge Cache Action
            • After Effects Set Cache Settings Action
            • After Effects Set Auto Save Settings Action
            • Job Execute ExtendScript In After Effects Action
            • Job Start After Effects Action
          • Adobe Premiere Pro
            • Premiere Pro Check Status of Invisible Panel Action
            • Premiere Generate UUID Action
            • Premiere Alert Dialog Action
            • Premiere Pro Add Motion Graphic Template Library Action
            • Premiere Confirm Dialog Action
            • Premiere Force Native Lock Action
            • Premiere Native Lock Action
            • Premiere OS Path Mapper Action
            • Premiere Open Choose Dialog Action
            • Premiere Path Settings Action
            • Premiere Prompt Dialog Action
            • Premiere Start Helmut Panel Action
            • Premiere Version Converter Action
          • Avid Pro Tools
            • (Beta) Open Pro Tools Session
            • (Beta) Pro Tools Bounce Session Action
          • Cosmo
            • Cosmo Add Asset To Project Action
            • Cosmo Add Info To Sequence Action
            • Cosmo Add Proxy To Project Action
            • Cosmo Change Asset Action
            • Cosmo Get Project Assets Action
            • Cosmo Change Project Asset Action
            • Cosmo Project File Index Action
            • Cosmo Get Project Sequences Action
            • Cosmo Asset Report Action
            • Cosmo Sequence Report Action
            • Cosmo Change Asset Metadata Action
            • Cosmo Delete Asset Metadata Action
            • Cosmo Get Asset Metadata Action
            • Cosmo Update Asset Size and Date
          • Third Party
            • MoovIT / MSP
              • helmut.cloud (2)
                • Helmut Cloud Trigger Webhook Action
                • Job Helmut Cloud Execute Stream Action
              • RevApp (5)
                • RevApp Share Asset By Email Action
                • RevApp Share Asset Public Link Action
                • RevApp Share Asset with Internal Group Action
                • RevApp Upload Asset To Namespace Action
                • RevApp Delete Asset From Namespace Action
            • Editshare (2)
              • Editshare File System
                • Editshare Set ACL Action
                • Editshare Delete ACL Action
                • EFS Create User Action
                • EFS Delete User Action
                • EFS Add Users To Group Action
                • EFS Remove User From Group Action
                • EFS Add Users To Media Space Action
                • EFS Remove Users From Media Space Action
                • EFS Create Group Action
                • EFS Remove Group Action
                • EFS Add Group To Media Space Action
                • EFS Remove Group From Media Space Action
                • EFS Create Media Space Action
                • EFS Delete Media Space Action
                • EFS Update Media Space Action
                • EFS Get Media Space DATA Action
                • EFS Get Free Space Of Media Space Action
                • Mount EFS Volume (macOS) Action
                • Mount EFS Volume (Windows) Action
              • Editshare Flow (7)
                • Flow Create Path Action
                • Flow Add Asset To Project Action
                • Flow Delete Path Action
                • Flow Toggle Private Project Action
                • Flow Get Project Asset Breadcrumb Action
                • Flow Resolve Folder Name To Id Action
                • Flow Update Project Location Action
            • Philips Hue
              • Hue Bridge Group On Action
              • Hue Bridge Group Change Action
              • Hue Bridge Group Off Action
              • Hue Bridge Lamp On Action
              • Hue Bridge Lamp Change Action
              • Hue Bridge Lamp Off Action
            • Quantum
              • CatDV
                • CatDV Add Asset to Catalog Action
                • CatDV Create Catalog Path Action
                • CatDV Delete Catalog Path Action
                • SwatIO Job Upload Action
            • Nachtblau (1)
              • Medialoopster (6)
                • Medialoopster Add Asset To Project Action
                • Medialoopster Create Project Action
                • Medialoopster Delete Asset From Project Action
                • Medialoopster Delete Project Action
                • Medialoopster Update Asset Delete Date Action
                • Medialoopster Update Project Delete Date Action
            • Grassvalley
              • Stratus | Framelight X
                • Stratus Create Asset Action
                • Stratus Create Project Action
                • Stratus Generate Unique ID Action
                • Stratus Patch Asset Action
                • Stratus Project Indexed Action
                • Stratus Project Status Action
                • Stratus Transfer Asset Action
                • Stratus Trigger Momentum Action
                • Stratus Add Asset to Folder Action
                • Stratus Get All Folders Action
                • Stratus Create Folder Action
                • Stratus Update Project Path Action
                • Stratus Asset Add Folder Membership Action
                • Stratus Change Project Metadata Action
            • Telestream
              • Aurora
                • Aurora Submit Job Action
              • Diva
                • Diva Archive Content Action
                • Diva Delete Content Action
                • Diva Restore Content Action
              • Vantage
                • Vantage Submit Job Action
                • Vantage Remove Job Action
            • Hiscale
              • Hiscale Jobs Start Process Action
            • Elements
              • Elements Add Permissions To Workspace Action
              • Elements Add Users To Groups Action
              • Elements Compare To Helmut User Action
              • Elements Copy Files Action
              • Elements Create API token Action
              • Elements Create Groups Action
              • Elements Create Directories Action
              • Elements Create Media Root Action
              • Elements Create Production Action
              • Elements Create Share Action
              • Elements Create Users Action
              • Elements Create Workspace Action
              • Elements Delete Files Action
              • Elements Delete Files From Media Library Action
              • Elements Delete Groups Action
              • Elements Delete Directories Action
              • Elements Delete Media Root Action
              • Elements Delete Production Action
              • Elements Delete Share Action
              • Elements Delete Users Action
              • Elements Delete Workspaces Action
              • Elements Get Client Key Action
              • Elements Get Free Space Of Workspace Action
              • Elements HTTP Request Action
              • Elements Mount Workspaces On Client Action
              • Elements Move Files Action
              • Elements Remove Permissions From Workspace Action
              • Elements Remove Users From Groups Action
              • Elements Start Job Action
              • Elements Unmount Workspaces From Client Action
              • Elements Update Workspace Quota Action
              • Elements Upload File Into Media Library Action
            • Arvato
              • VPMS
                • VPMS Check-in Action
                • VPMS Metadata Update Action
            • Vidispine
              • Vidicore
                • VidiCore Add Collection To Collection Action
                • VidiCore Add Deletion Lock To Collection Action
                • VidiCore Add Deletion Lock To File Action
                • VidiCore Add Deletion Lock To Item Action
                • VidiCore Add External ID To Item Action
                • VidiCore Add Item To Collection Action
                • VidiCore Add Key Value Metadata To File Action
                • VidiCore Add Key Value Metadata To Library Action
                • VidiCore Add Library To Collection Action
                • VidiCore Add Metadata Field Values To Collection Action
                • VidiCore Add Metadata Field Values To Item Action
                • VidiCore Create Collection Action
                • VidiCore Delete Collection Action
                • VidiCore Delete Item Action
                • VidiCore Get Item ID By File Path Action
                • VidiCore Get Token
                • VidiCore Import File Into New Item Action
                • VidiCore Remove Collection From Collection Action
                • VidiCore Remove Deletion Lock From Collection Action
                • VidiCore Remove Deletion Lock From File Action
                • VidiCore Remove Deletion Lock From Item Action
                • VidiCore Remove Item From Collection Action
                • VidiCore Remove Key Value Metadata From File Action
                • VidiCore Remove Key Value Metadata From Library Action
                • VidiCore Remove Library From Collection Action
                • VidiCore Remove Metadata Field Values From Collection Action
                • VidiCore Remove Metadata Field Values From Item Action
              • Vidiflow
                • VidiFlow Trigger Workflow
          • File and Folder
            • File Copy Action
            • File Create Action
            • File Delete Action
            • File Increment Name Action
            • File Move Action
            • File Open Action
            • File Rename Action
            • File Replace Content Action
            • Folder Content Delete Action
            • Folder Copy Action
            • Folder Create Action
            • Folder Delete Action
            • Folder Increment Name Action
            • Folder Move Action
            • Folder Rename Action
            • XSquare File Check In Action
            • 7-Zip Archive Action
            • 7-Zip Extract Action
            • 7-Zip CLI Action
            • Get Files From Folder Action
            • Get Folder From Folder Action
          • OS
            • Commandline Execute Action
            • Unmount A Share Action
          • MISC
            • JSON Related-Nodes (2)
              • JSON Extract Action
              • JSON Escape Action
            • Execute Javascript Action
            • Fail Action
            • HTTP Request Action
            • Metadata Auto Mapper Action
            • Regex Apply Action
            • Sleep Action
            • Split Stream Action
            • Stream Execute Generic Stream Action
            • Stream Set Temporary Variable Action
            • Stream Set Store Variable Action
            • Stream Get Store Variable Action
            • Stream Delete Store Variable Action
            • Success Action
            • XPath Action
          • Mediainfo
            • FFprobe as Json Action
            • Mediainfo As Json Action
        • Outputs
          • File and Folder (1)
            • Write File Output
          • OS (1)
            • macOS System Notification Output
          • Misc (3)
            • Send Email Output
            • Telegram Output
            • Send Message To Teams Channel
          • User (2)
            • Send Message to User
            • Send Notification to User
      • Wildcards
        • Helmut Wildcards (9)
          • Helmut Groups
          • Helmut Profile
          • Helmut Projects
          • Helmut Templates
          • Helmut Profiles
          • Helmut User Displaynames
          • Helmut User Emails
          • Helmut User IPs
          • Helmut Usernames
        • Date & Time (21)
          • Calendar Week
          • Date Day ?
          • Date Day
          • Date Day Of Week Textual
          • Date Day Of Week Textual Short
          • Date Month ?
          • Date Month
          • Date Month Textual
          • Date Month Textual ?
          • Date Month Textual Short
          • Date Month Textual Short ?
          • Date Year ?
          • Date Year
          • Date Shortyear ?
          • Date Shortyear
          • Convert Date To Timestamp ?
          • Convert Timestamp To Date ?
          • Convert Timestamp To Datetime ?
          • Date Decrement Days ?
          • Date Increment Days ?
          • Time Hour
          • Time Minute
          • Time Second
        • File-related Wildcards (5)
          • File Content ?
          • File Exists ?
          • File MD5 ?
          • File Modified ?
          • File Size ?
        • Folder-related Wildcards (4)
          • Folder Content ?
          • Folder Exists ?
          • Folder Modified ?
          • Folder Size ?
        • Job-related Wildcards (32)
          • Job AssetID
          • Job AssetNodeID
          • Job AssetObjectUUID
          • Job Breadcrumb
          • Job Current_Asset
          • Job Custom ?
          • Job Destination
          • Job ID
          • Job In_To_Out
          • Job Last Proxy
          • Job Last Source
          • Job Metadata ?
          • Job MimeType ?
          • Job MimeType
          • Job Name
          • Job Profile
          • Job Progress
          • Job ProjectItemID
          • Job Proxy
          • Job Sequences
          • Job Source Type
          • Job Source
          • Job Status_Message
          • Job Total_Assets
          • Job Tries
          • Job Unique
          • Job User Displayname
          • Job User Email
          • Job User ID
          • Job User Name
          • Job User Role
          • Job Watchfolder
        • Local Environment-related Wildcards (6)
          • Local AE Preferences ?
          • Local Environment ?
          • Local Home
          • Local OS
          • Local Profile ?
          • Local Registry ?
          • Local Username
        • Path-related Wildcards (9)
          • Path Basename ?
          • Path Extension ?
          • Path Map Auto ?
          • Path Map To Unix ?
          • Path Map To Win ?
          • Path Map To JSON ?
          • Path Name ?
          • Path Parent ?
          • Path Split ?
        • Project-related Wildcards (27)
          • Project Category
          • Project Create_Date
          • Project Creator
          • Project Custom ?
          • Project Extension
          • Project Group
          • Project ID
          • Project Last_Modified_Date
          • Project Locked Status
          • Project Locked
          • Project Metadata ?
          • Project Modified_By
          • Project Name
          • Project Parent
          • Project Path
          • Project Savepath
          • Project Source Category
          • Project Source Custom ?
          • Project Source Extension
          • Project Source Group
          • Project Source ID
          • Project Source Locked
          • Project Source Metadata ?
          • Project Source Name
          • Project Source Path
          • Project Source Tag
          • Project Source Template
          • Project Tag
          • Project Template
        • String-related Wildcards (9)
          • String Split ?
          • String length ?
          • String Case To Camel ?
          • String Case To Kebab ?
          • String Case To Lower ?
          • String Case To Pascal ?
          • String Case To Snake ?
          • String Case To Upper ?
          • String Words Count
        • User-related Wildcards (10)
          • User Client
          • User Display_Name
          • User Email
          • User Groups
          • User IP
          • User Last Login
          • User Name
          • User OS
          • User Password
          • User Role
        • Variable-related Wildcards (3)
          • Stream Variable ?
          • Helmut Variable ?
          • Store Variable ?
        • Result | Return Wildcards (2)
          • Node Result ?
          • Stream Last_Result
        • Misc wildcards (5)
          • Generate UUID
          • Stream Log
          • Stream Resolve_ID
          • Stream Name
          • Profile Name
        • Undocumented Wildcards (1)
          • Environment Variable Bypass Wildcard
      • Deprecation warning
      • Stream Debugger
      • Stream Variable Store
    • Streaming Engine
    • Helmut4 Client
    • Helmut4 Panel
      • Panel-Dashboard
      • Panel-Export
      • Panel-Cosmo
      • Panel Debugging
  • Release Notes
    • What's New
    • Changelog
      • Docker Image Version History
  • Support
    • Requesting Support
    • Response and Resolution Times
    • Debug | Log collection
      • Helmut4 client
        • Retrieve the helmut4 client log
        • Retrieve the ame panel log
        • Retrieve the project log
        • Check installed Helmut extensions
        • Check if ports are used by other apps
        • Panel debug ports
        • Local Client API
        • Check existence of MoovIT authority certificate on windows client
        • Run helmut4 client in debug mode
        • Modifying Helmut4 Client Environment Parameters
      • Helmut4 server
        • Retrieve helmut4 container log
        • Stack already exists
        • Check RAM & CPU usage of containers
        • Verify RSA keys for SSL certificate
        • Docker Housekeeping | Container not starting
        • Resolving Port Conflicts
        • Purge Docker & Components
Powered by GitBook
On this page

Welcome to the official Helmut4 documentation

Last updated 1 month ago

Helmut4 is a web-based workflow management software designed for professional video productions and post-productions.

It manages projects and their linked assets in Adobe , , and , automating project-based workflows and handling project assets that typically require attention from assistant editors and technical personnel. Additionally, Helmut4 can manage audio authoring in Avid Pro Tools, providing an integrated solution for both video and audio production workflows.

Helmut4 can handle your , user settings, rendering distribution, workflows, and much more.

To meet your specific needs, Helmut4 is running and is highly customizable. It seamlessly integrates with various storages and third-party software through REST APIs, and it allows you to create your own ''—workflows that can be visually programmed using Helmut4's .

Whether you require a standard setup, a customized configuration, or you're eager to start designing tailored workflows for your environment, this is the perfect place to begin.

👋
Premiere Pro
After Effects
Audition
project templates
import and export
on-premise
streams
stream designer
Helmut4 and its four modules: FX, IO, CO & HK
Page cover image