Installing Toon Boom Harmony
Now that you have verified the minimum requirements and configured your hardware and software, you are ready to install Toon Boom Harmony.
You will perform the following tasks:
| 1. | Upgrading from a Previous Installation |
| 2. | Creating the usabatch User |
| 3. | Installing Harmony |
Upgrading from a Previous Installation
If you are performing an upgrade, pick a time when Toon Boom Harmony production is slow or stopped. During the upgrade, no users can run any of the Toon Boom Harmony modules and all rendering jobs must be stopped or completed.
How to update previous installations
- Make sure that no one is running any versions of Harmony or Opus. All Harmony or Opus nodes must be closed on the server and on all the clients.
- Verify that all batch rendering and vectorizing are completed or that the queues are empty. You can check the status of Vectorize and Render queues from the Control Center module.
| ‣ | In the Control Center module, use the Queue menu, Environment > Vectorize Queue or Render Queue to open the Vectorize queue or Rendering queue for each environment. The queue should either be empty or the status of all jobs should be Completed. |
Be sure to stop the queues on all rendering machines. If the queues are running, those binaries will be locked and the installer cannot update them.
- Stop all services running on the server and the clients.
| ‣ | If you are upgrading from version 12, type in the Terminal: |
sudo launchctl unload /Library/LaunchDaemons/com.toonboom.LicenseServer.plist
sudo launchctl unload /Library/LaunchDaemons/com.toonboom.DatabaseServer.plist
sudo launchctl unload /Library/LaunchDaemons/com.toonboom.LinkServer.plist
sudo launchctl unload /Library/LaunchDaemons/com.toonboom.QueueServer.plist
sudo launchctl unload /Library/LaunchDaemons/com.toonboom.WebCCServer.plist
| ‣ | If you are upgrading from version 7.3 to 11.1, type in the Terminal: |
sudo /sbin/SystemStarter stop ToonBoomQueueServer
sudo /sbin/SystemStarter stop ToonBoomLinkServer
sudo /sbin/SystemStarter stop ToonBoomDatabaseServer
sudo /sbin/SystemStarter stop ToonBoomLicense
| ‣ | If you are upgrading from Harmony or Opus 7.2, type in the Terminal: |
sudo /sbin/SystemStarter stop USAnimation_queues
sudo /sbin/SystemStarter stop USAnimation_link_srv
sudo /sbin/SystemStarter stop USAnimation_dbserver
sudo /sbin/SystemStarter stop USAnimation_flexlm
- Go to the applicable folder:
| ‣ | Version 12 and later: /Applications/Toon Boom Harmony [version] [edition]/tba/etc |
| ‣ | Version 7.8 to 11.2: /Applications/Toon Boom Harmony [version]/tba/etc |
| ‣ | Version 7.3: /Applications/Toon Boom Harmony/usa.bundle/etc |
| ‣ | Version 7.2: /usa/etc |
- Back up any necessary configuration files:
| ‣ | manager.conf |
| ‣ | server.ini if this server is configured to have Windows clients. |
| ‣ | Scan.conf if this workstation is configured to be a scanning station. |
| ‣ | VectOptions.conf from any machine (including the server) that is doing batch vectorization. |
| ‣ | Any other configuration file that is required to be used later. |
| ‣ | You can back up the entire application folder to ensure that no configuration file is missed. |
- From the Terminal, go to the /usr/local/flexlm/licenses/ folder. If you are upgrading from version 7.2, go to the /usa/etc/flexlm folder. Back up the license.dat file.
- Delete the /Applications/Toon Boom Harmony
[version][edition]folder or rename it to keep as a backup.
- If you are upgrading from a previous version of Harmony or Opus, you must delete Startup Items from the previous installation. For example:
| ‣ | Version 12 and later: |
| ‣ | Version 7.3 to 11.2: From /Library/StartupItems, delete any folders that begin with ToonBoom, such as ToonBoomDatabaseServer. |
| ‣ | Version 7.2 and earlier: From /Library/StartupItems/, delete any folders that begin with USAnimation, such as USAnimation_dbserver. |
Deleting Files in Each User's Home
If you are upgrading from Harmony or Opus, you must also delete extra files that are located in each user's home.
How to delete files in each user's home
- Open the Terminal:
/Application/Utilities/Terminal
- Go to a user's home that was configured to work with Harmony. Using the
usabatchaccount as an example:
cd /Users/usabatch
- List all the files in usabatch's home:
ls -lsa
- Look for a folder named .MacOSX in the list of files and folders that appear.
- If the folder is there, delete it:
sudo rm -rf .MacOSX
- Repeat these steps for each user that was configured to work with a previous version of Harmony.
Creating the usabatch User
Before you install Harmony, you must create the usabatch user account on the server and on all the workstations that will performing batch processing (computers that will be part of the batch rendering or vectorizing farm). A number of services, including the tbdbserver, license server, batch processing and Web Control Center service are started using the usabatch account.
The usabatch account must have administrator rights on the computer.
How to create the usabatch user account
- Open System Preferences. By default, there is a shortcut for System Preferences in the Dock.
- In the System panel of the System Preferences dialog box, click Users & Groups.
The Password tab of the Accounts window opens.
- To make changes to the accounts on a Mac OS X, click the lock icon at the bottom of the window. Enter your username and password for an account that has administrator privileges.
- Click the plus (+) sign button to add a new user.
- Give the new user the following name, account name and password:
usabatch
The usabatch account name and password must be in all lower-case letters.
- Select Administrator from the menu next to New Account.
- Click Create User.
- Once the account is created, open the Terminal and log in as the usabatch user:
su -l usabatch
- Make sure you're in the home folder of
usabatch, then edit or create the .profile for usabatch:
vi .profile
- Make sure the file contains the following lines:
#!/bin/bash
umask 0
- Save and exit the file.
Installing Harmony
In a client-server network or in a standalone setup, you must install Harmony, as well as the following services on the server or the standalone computer:
| tbdbserver | Controls access to the database. |
| License service | Controls the number of licenses and features available to Harmony users. |
| Batch processing | Controls batch vectorizing and rendering queues. |
| Web Control Center | Allows download and upload of scenes from the database. |
| Link server | If you are installing Harmony on a Mac OS X server that will support Windows clients, you must install the Link server. |
To install Harmony programs and services, you must run the installation package. Before you start the installation, make sure you are currently logged in the system with administrator rights on your local computer.
How to get administrator privileges
- Open System Preferences. By default, there is a shortcut for System Preferences in the Dock.
- In the System Preferences dialog box, click Users & Groups.
The Password tab of the Accounts window opens.
- Select your user login account and verify if the Allow user to administer this computer option is selected. To make changes to the accounts on a Mac OS X, click the lock icon at the bottom of the window. Enter your username and password for an account that has administrator privileges.
How to install Harmony
- Double-click the Harmony .dmg file.
- Drag the Toon Boom Harmony 12.2.1 folder from the .dmg file to the Applications folder.
- In the window that opens, click Accept.