The ToonBoom Harmony Submit Script




Index

Introduction

    Use this script to render Toonboom's Harmony software.

    To use this script properly, a copy should be installed on your file server, and is normally configured for use from within Toonboom's 'Stage' and 'Pix2vec' software via Toonboom's USA_EXTERNAL_QUEUE environment variable (described below), though it can also be invoked directly like the other Rush submit scripts.

    This script will manage both 'stage' compositing and 'pix2vec' vectorization of drawings for ink + paint.

Installing Harmony Submit Scripts

    These steps are for your company's systems administrator to set up.

    TDs and artists should skip this section to either configuring your desktop shortcuts, and if that's already been setup for you as well, skip to using Harmony with Rush.

  1. Install the Rush submit scripts on your file server.

    2. This should have already been done as part of the initial Rush setup:

    Assuming you've copied the entire rush/examples directory to your file server as e.g. //yourserver/jobs/rushscripts/, then you will find the Harmony startup scripts in //yourserver/jobs/rushscripts/harmony/{windows,linux}/*.

    A description of these scripts:

    Harmony Scripts
    Find these in //yourserver/jobs/rushscripts/harmony/.. directory
    Windows Unix Description
    windows/harmony-with-rush.bat linux/harmony-with-rush Brings up Harmony's 'Stage' interface
    windows/controlcenter-with-rush.bat linux/controlcenter-with-rush Brings up Harmony's 'Control Center'
    windows/scan-with-rush.bat linux/scan-with-rush Brings up Harmony's 'Scan' interface

    The most common technique is to make desktop shortcuts for the users to these 'startup scripts' so that they can bring up Harmony's tools to use Rush automatically, in place of Toonboom's own queue. (This, as opposed to invoking the submit-harmony.pl script directly, which is how Rush submit scripts are usually invoked)

    The 'startup scripts' don't do much, other than set critical Harmony environment variables (USA_EXTERNAL_QUEUE and USA_EXTERNAL_QUEUE_CHUNK) which tell Harmony how to invoke Rush in place of Toonboom's own render queue, and then starts Harmony's interface. For example, in the case of 'Stage': 

    
# WINDOWS
set USA_EXTERNAL_QUEUE=//yourserver/jobs/rushscripts/perl/submit-harmony.pl
set USA_EXTERNAL_QUEUE_CHUNK=on
stage

# UNIX
setenv USA_EXTERNAL_QUEUE //yourserver/jobs/rushscripts/perl/submit-harmony.pl
setenv USA_EXTERNAL_QUEUE_CHUNK on
stage

  2. Configure your server's pathnames in the Harmony startup scripts

    3. Modify the scripts so that they reference the absolute pathname to the submit-harmony.pl script on your file server. So when editing the files, modify the red items:

    Windows
    Harmony Startup Script

    a) Edit the Harmony startup scripts in the harmony\windows directory on your server

      Use 'edit' or 'wordpad', or whatever non-formatting 'plain' text editor you're comfortable with.

      edit \\yourserver\jobs\rushscripts\harmony\windows\harmony-with-rush.bat
      edit \\yourserver\jobs\rushscripts\harmony\windows\controlcenter-with-rush.bat
      edit \\yourserver\jobs\rushscripts\harmony\windows\scan-with-rush.bat

    b) Customize the appropriate pathnames in these scripts as needed, e.g.

    Rem ** The following settings tell the Harmony software to use Rush.
Rem ** Modify this path to your server accordingly..
Rem **          |____________________
Rem **                              |
Rem **                             \|/
Rem **                              v
set USA_EXTERNAL_QUEUE="perl //yourserver/jobs/rushscripts/perl/submit-harmony.pl"   
set USA_EXTERNAL_QUEUE_CHUNK="on"

Rem ** Invoke the Harmony 'Stage' software.
stage




    Unix
    Harmony Startup Script

    a) Edit the Harmony startup scripts in the harmony/linux directory on your server

      pico //yourserver/jobs/rushscripts/harmony/linux/harmony-with-rush
      pico //yourserver/jobs/rushscripts/harmony/linux/controlcenter-with-rush
      pico //yourserver/jobs/rushscripts/harmony/linux/scan-with-rush

    b) Customize the appropriate pathnames in these scripts as needed, e.g.

    #!/bin/csh -f

# The following settings tell the Harmony software to use Rush.
#     Modify this path to your server accordingly..
#             |_____________________________
#                                          |
#                                         \|/
#                                          v
setenv USA_EXTERNAL_QUEUE       "perl //yourserver/jobs/rushscripts/perl/submit-harmony.pl"   
setenv USA_EXTERNAL_QUEUE_CHUNK "on"

# Invoke the Harmony 'Stage' software.
/usa/lnx86/bin/Stage &

    Preserved Values

    When submitted through Harmony, the submit form will remember these fields between submits if you change them: 

        "Main" Page
    -----------
    Cpus, MaxTime, MaxTimeState.
    
    "Stage" Page
    ------------
    (No "Stage" settings are preserved)
    
    "Rush" Page
    -----------
    (All "Rush" settings are preserved)

    DOCUMENTATION: WORK IN PROGRESS


    This shows the 'advanced options' of the generic submit form.
    Just scroll down or resize the submit window to access them.