Editing a Script Packaged with Harmony

Harmony comes pre-installed with a lot of scripts. These scripts are stored in a read-only location among other files that are packaged by Harmony. Hence, by default, they cannot be edited.

To edit a script that was installed with Harmony, you must copy it to a location where it can be edited. This can easily be done by using the Make Editable button of the Script Editor view. This button creates a copy of the script and stores it in a location where you can make changes to it. Meanwhile, the original copy of the script remains untouched, and it is possible to revert to it later if you want.

IMPORTANT
  • Some buttons and menu items in the Harmony user interface run scripts that are packaged with Harmony. Hence, making changes to scripts packaged with Harmony may impact its functionality.
    • NOTE If you make unwanted changes to a script that was packaged with Harmony, you can restore its original version—see Restoring a Harmony Script

    1. In the File list of the Script Editor, select any of the scripts that are packaged with Harmony.

      TIP Scripts that are packaged with Harmony have Application Resources as their location.

    2. Under the script editor, click on the Make Editable button.

      A dialog prompts you to select the location in which to copy the script.

    1. In the drop-down menu, select the location in which you want to copy the script:

      • User: Saves the script to a directory in your user preferences directory. You will be able to run and edit the script from any scene as long as you are logged in as the same user.

        NOTE If you are using Harmony Stand Alone, the script will be saved to the preferences for your account on your computer. if you are using Harmony Server, the script will be saved to the preferences for your Harmony database user.
      • Global: If you are using Harmony Server, select this option to save the script to the Harmony database's global script directory. Anyone who is logged in to the database will be able to edit and run this script.
      • Environment: If you are using Harmony Server, select this option to save the script to the current scene's environment. Anyone will be able to edit and run the script as long as they are working on a scene inside this environment.
      • Job: If you are using Harmony Server, select this option to save the script to the current scene's job. Anyone will be able to edit and run the script as long as they are working on a scene inside this job.
      • Scene: Save the script to the scene's scripts sub-folder. Anyone will be able to edit and run the script when working on this specific scene.
      • System Variable: Save the script to the directory in the TOONBOOM_GLOBAL_SCRIPT_LOCATION environment variable. This option is only available if this environment variable is set.

    2. Click on OK.

      In the File list, the location of the selected script is updated to the one you selected.

      Under the script editor, the Make Editable button is replaced with the Save button. This means that you can make changes to the script and save those changes.