🎉
Helmut4
v4.7.1
v4.7.1
  • 👋Welcome to the official Helmut4 documentation
  • GETTING STARTED
    • Overview
      • How to start
      • Helmut4 Modules
      • Deployment Options
    • Tech Specs
      • Helmut4 Server
      • Helmut4 Clients
    • Installation Guide
      • Helmut4 Server
        • Helmut4 Single Server
        • Helmut4 Cluster System
      • Helmut4 Client
    • Upgrade Guide
      • Helmut4 Client
      • Helmut4 Server
    • Release Cycles
    • Supported Adobe Versions
      • Known Adobe Issues
    • Open API
    • Additional Configurations
      • Define mongobackup volume
      • Enable https / set SSL certificate
        • Custom p12 certificate
      • Commonly used ports
      • Dynamic share mount into docker
  • 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
      • Languages
      • Metadata
        • Metadata Group
        • Date-Time-Datetime
      • 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
      • Users
      • Profiles
        • Add CO Profile
      • Preferences
      • Languages
      • Metadata
        • Custom Metadata
      • Streams
        • CO Event Triggers
          • ADDED_ASSET
          • 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
        • Save
        • Snapshots
        • Screenshot
        • Test
        • Reload
        • Exchange
        • Variables
        • Debug (in a stream)
        • Settings
        • Edit Panel
        • Node Panel
        • Shortcuts
      • Nodes
        • Actions
          • Project
            • Project Create Action
            • Project File 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 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 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 FFMEPG Action
            • Job Start Premiere 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 File Copy Action
            • Job Folder Copy Action
            • Job RClone Actions
              • Job RClone Copy 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)
          • Premiere
            • Premiere Generate UUID Action
            • Premiere Alert Dialog 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
          • 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
          • After Effects
            • After Effects OS Path Mapper Action
            • After Effects Alert Dialog Action
            • After Effects Open Choose Dialog Action
            • After Effects Prompt Dialog Action
            • After Effects Start Helmut Panel Action
            • Job Execute ExtendScript In After Effects Action
            • Job Start After Effects Action
          • Third Party
            • Editshare
              • 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
                • Flow Create Path Action
                • Flow Add Asset To Project Action
                • Flow Delete Path Action
                • Flow Toggle Private Project 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
            • Medialoopster
              • Medialoopster Add Asset To Project Action
              • Medialoopster Create Project Action
              • Medialoopster Delete Asset From Project Action
              • Medialoopster Delete Project 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
            • RevApp
              • 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
            • 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
              • 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 Trigger Workflow
              • VPMS
                • VPMS Check-in Action
                • VPMS Metadata Update Action
          • 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
          • User
            • Send Message to User
            • Send Notification to User
          • OS
            • Commandline Execute Action
            • Unmount A Share Action
          • MISC
            • Execute Javascript Action
            • Fail Action
            • HTTP Request Action
            • JSON Extract 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
        • Conditions
          • Project
            • 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
            • User Displayname Condition
            • User Group Condition
            • User Role Condition
            • User Name Condition
          • File and Folder
            • 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
            • Operating System Condition
          • Media Info
            • 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
            • Empty String Condition
            • IP Condition
            • Regex Match Condition
            • Wildcard Condition
            • Match Multiple Patterns Condition
        • Outputs
          • File and Folder
            • Write File Output
          • OS
            • macOS System Notification Output
          • User
            • Send Message to User
            • Send Notification to User
          • MISC
            • Send Email Output
            • Telegram Output
            • Send Message To Teams Channel
      • 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 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 ()
          • Job metadata ?
          • Job custom ?
          • Job Tries
          • Job Destination Wildcard
          • Job Proxy Wildcard
          • Job Breadcrumb Wildcard
        • Local Environment-related Wildcards (6)
          • 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 Name
          • Project Source Path
          • 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 (9)
          • User Client
          • User Display_Name
          • User Email
          • User Groups
          • User IP
          • User Last Login
          • User Name
          • User OS
          • User Role
        • Variable-related Wildcards (3)
          • Stream Variable ?
          • Helmut Variable ?
          • Store Variable ?
        • Result | Return Wildcards (2)
          • Node Result ?
          • Stream Last_Result
        • Misc wildcards (x3)
          • Generate UUID
          • Stream Log
          • Stream Resolve_ID
        • 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
    • Known Issues
  • Support
    • Requesting Support
    • Response and Resolution Times
    • Debug | Log collection
      • Helmut4 client
        • Retrieve the helmut4 client log
        • Check if ports are used by other apps
        • Check existence of MoovIT authority certificate on windows client
        • Run helmut4 client in debug mode
        • Panel debug ports
        • Check installed Helmut extensions
      • Helmut4 server
        • Stack already exists
Powered by GitBook
On this page
  • Important changes from version 4.6.0 onwards
  • Node description
  • Configuration / parameter of the Cosmo Project File Index Action
  • Advanced indexing
  • INDEXED_ASSET
  • UNINDEXED_ASSET
  1. Helmut4 components
  2. Stream Designer
  3. Nodes
  4. Actions
  5. Cosmo

Cosmo Project File Index Action

PreviousCosmo Change Project Asset ActionNextCosmo Get Project Sequences Action

Important changes from version 4.6.0 onwards

Changes in Cosmo Project File Index Action from V3: starting with v4.6.0 and onwards

With the introduction of the V3 file index action, it is now possible to assign the indexing to either the client or server, depending on the host type of the stream.

With the previous V2 version of the node, indexing was always performed by the Cosmo server container.

===> Replacing the old one should be consider as soon as possible! <===

We advise checking the streams for all Cosmo Project File Index Action, especially in the following product triggers:

  • FX: Post_Create_Project, Unlock_Project and Custom_FX [(Re)-index Project]

  • HK - depending on your existing profile-workflows

Please consider that an unlock project trigger should not be executed by a client, as the indexing might result in an issue if the user closes the Helmut3 website or client connection before it has finished the task.

Node description

With the help of the Project File Index Action, it is possible to index a project file (Premiere Pro or After Effects).

This implies, the project file will be read and it's structure (bin, assets and sequences/compositions) will be forwarded to the Cosmo project, to highlight a virtual duplicate of the project*.

*This requires an appropriate configuration of the indexing workflow / node.

It is recommended to index projects only those are closed.

Indexing an opened project might end up in a wrong result - if the project has been saved 5 minutes ago but eg in the meantime new bins and sequences have been created, those informations would be ignored, as Premiere Pro / After Effects is working form the RAM until a manual or automatic save trigger (from Adobe) will be executed.

The indexing extracts all information from the project.

These information include:

  • Bin structures and bin names

  • Assets and dedicated asset metadata

  • Sequences or compositions

All changes that are detected during indexing compared to the status in Cosmo are changed/reflected in Cosmo.

Configuration / parameter of the Cosmo Project File Index Action

The configuration of the node is highly dependent on your workflow requirements. Using the three options: advanced mode, INDEXED_ASSET, and UNINDEXED_ASSET should be checked in alignment to meet the expected result.

Setting all three options to 'enabled' should not be considered the default choice.

Advanced indexing

Within the node, it is possible to define advanced indexing for the project file. Indexing a project in advanced mode will take more time to finish because more information will be extracted.

If checked, the following information about sequences will also be extracted:

  • Source and destination time code of all assets on the timeline

  • Track that was used per asset

  • Metadata of the assets

This information is not visualised in Cosmo but is available in the database.

An example use case for this advanced index mode would involve utilizing the Cosmo Asset Report Action or Cosmo Sequence Report Action.

INDEXED_ASSET

It is possible to specify that the "INDEXED_ASSET" trigger is activated for newly discovered assets.

This function might be helpful if assets haven't been added to the project using the Cosmo Add Asset To Project Action action, or if the Helmut4 panel was not running/connected or when an asset was imported by another 3rd-party API (bypassing the Autoimport profile).

If the switch for this option is disabled, the asset will be registered with no further actions.

By setting the switch to enable, it is possible to trigger an event-based stream for new/unknown assets; this stream can be configured in the Cosmo Streams section using the INDEXED_ASSET trigger.

Keeping this option disabled will prevent triggering any additional logic.

Newly added assets (bypassing the Cosmo logic) will be forwarded to the Cosmo project, but the Cosmo trigger endpoint will be skipped.

UNINDEXED_ASSET

In addition, the "UNINDEXED_ASSET" trigger is activated for assets that have been removed from the project.

If the switch for this option is disabled, the asset reference will be removed with no further actions.

By setting the switch to enable, it is possible to trigger an event-based stream on removed assets; this stream can be configured in the Cosmo Streams section using the UNINDEXED_ASSET trigger.

As an example within this stream, which is triggered by this event, it is possible to check whether the removed asset is still referenced/used in other projects. Every asset that is removed from a project and is no longer available in any other project is recorded in the database as an orphaned clip.

This designation means it will be delisted and can't be accessed anymore via Helmut4!"

Keeping this option disabled will not trigger any additional logic.

Removed assets (bypassing the Cosmo logic) will be passed on to the Cosmo project, but the Cosmo trigger endpoint will be skipped.

Cosmo Project File Index Action
Stream event trigger