Installation Guide Windows Operating Systems
Installation Guide Windows Operating Systems
Disclaimer
The content of this manual is covered by a specific limited warranty and exclusions and limit of liability under the
applicable License Agreement as supplemented by the special terms and conditions for Adobe® Flash® File Format
(SWF). Please refer to the License Agreement and to those special terms and conditions for details.
The content of this manual is the property of Toon Boom Animation Inc. and is copyrighted. Any reproduction in whole
or in part is strictly prohibited.
For additional copies of this manual, please contact Toon Boom Animation Inc. at the Corporate Headquarters
address.
Copyright © 2009 by Toon Boom Animation Inc. All rights reserved.
Trademarks
Toon Boom Harmony is a trademark owned by Toon Boom Animation Inc. All other trademarks are the property of
their respective owners.
Credits
Documentation Development: Toon Boom Animation Inc.
Content Development: Marie-Eve Chartrand, Anouk Whissell
Publication Date
November 2009
Contents
Installing on Windows ............................................................................................................................................... 3
Pre-installation ............................................................................................................................................................ 4
Check Your Minimum Requirements ...................................................................................................................... 4
Prerequisites for Harmony Installation .................................................................................................................... 4
Product Code ..................................................................................................................................................... 4
Additional Network Settings .............................................................................................................................. 4
Windows 2003 Server ......................................................................................................................................... 4
Pre-installation Configuration ................................................................................................................................. 5
Turn off Anti-Virus Software ............................................................................................................................... 5
Turn off the Firewall ............................................................................................................................................ 5
Turn Off Use Simple File Sharing - Windows XP Professional ............................................................................ 6
Turn Off Use Simple File Sharing - Windows Vista ............................................................................................. 6
Get the License File ............................................................................................................................................ 6
Toon Boom Harmony Installation ............................................................................................................................... 7
Upgrading from a Previous Installation .................................................................................................................. 7
Stop Services Affecting Harmony ....................................................................................................................... 7
Stop the License Server ...................................................................................................................................... 8
Removing Harmony Related Environment Variables .......................................................................................... 9
Backing up any necessary configuration files: .................................................................................................... 9
Uninstalling the Previous Version of Toon Boom Harmony or Opus ............................................................... 10
Installing Toon Boom Harmony ............................................................................................................................ 10
Configuration ............................................................................................................................................................ 12
Configure Toon Boom Harmony .......................................................................................................................... 12
Set Up the Database Server ............................................................................................................................. 13
Set Up the Database Client .............................................................................................................................. 15
Sharing Toon Boom Harmony Related Directories .............................................................................................. 16
Configure the License ........................................................................................................................................... 18
Setting up the License on Client Workstations ................................................................................................ 22
Reactivating the Firewall and the Anti-virus Software .......................................................................................... 24
Turn on the Anti-Virus Software ....................................................................................................................... 24
Turn on the Firewall .......................................................................................................................................... 24
Troubleshooting ........................................................................................................................................................ 26
Problem: License Error When Starting Any Toon Boom Harmony Module ......................................................... 26
Problem: Unable to Import Sample Scene (Errors with the tbdbserver) .............................................................. 26
Problem: Unable to Open Sample Scene on Clients ........................................................................................... 27
Problem: resolution.conf Error Message .............................................................................................................. 27
1
Harmony Installation Guide - Windows Operating Systems
2
Installing on Windows
This document explains how to install Toon Boom Harmony on Windows.
There are three stages required to install Toon Boom Harmony 7.8, these are covered in the following topics:
1. Pre-installation, on page 4
2. Toon Boom Harmony Installation, on page 7
3. Configuration, on page 12
After completing these stages, you can verify the integrity of the installation and resolve any configuration issues.
• Troubleshooting, on page 26
3
Harmony Installation Guide - Windows Operating Systems
Pre-installation
Before installing Toon Boom Harmony, you must perform the following task:
• Pre-installation Configuration, on page 5
Product Code
You must have your Harmony Product Code (license key) in front of you before you begin the installation.
4
Installing on Windows
Wait for the changes to take effect or restart the Server. It can take several minutes for the domain controller to
update and use the new settings.
Once this is done you will be able to create the user usabatch, this user should be inside of the Harmony user
group.
Pre-installation Configuration
Configure your computer before installation by performing the following tasks:
1. Turn off Anti-Virus Software, on page 5
2. Turn off the Firewall, on page 5
3. Turn Off Use Simple File Sharing - Windows XP Professional, on page 6.
NOTE:
Inform your System Administrator before proceeding with these tasks.
2. Double-click the Security Center icon in the Control Panel window. The Windows Security Center dialog
box opens.
Vista users must turn off Malware Protection.
3. If your anti-virus software is not detected, open all anti-virus software applications on your computer and disable
each one manually.
a From the Security Center window, click the Windows Firewall icon on the left side panel.
b Click the Start menu, and select Control Panel to open the Control Panel. Double-click the Windows
Firewall icon.
5
Harmony Installation Guide - Windows Operating Systems
6
Installing on Windows
7
Harmony Installation Guide - Windows Operating Systems
During this process, you will be able to stop the tbdbserver on the server and tbprocess on workstations
that are set as a batch render.
5. Turn off all of the client machines and the render farm.
8
Installing on Windows
d In the Config Services tab, click the Remove Service button to remove the license service.
9
Harmony Installation Guide - Windows Operating Systems
On Windows Vista
1. Click the Start menu and select Control Panel. The Control Panel opens.
2. Double-click Program and Features and choose Harmony or Opus from the program list. And then, click
Uninstall from the top menu.
3. Reboot the machine.
NOTE: Backup the database
For the server upgrading process, please backup the database by exporting the whole database. This will prevent
you from losing any data during the upgrading process. You can, however, back up current /usa_db and /usadata
by renaming them (this procedure can only be used when installing on the same server). But this will require extra
caution, if you are at all unsure contact your system administrator or Toon Boom Animation Support.
On Windows XP
1. Click the Start menu, and select Settings > Control Panel. The Control Panel opens.
2. Double-click Add or Remove Programs and choose Harmony or Opus from the change or remove program list.
And then, click the Change/Remove button to uninstall.
3. Reboot the machine.
10
Installing on Windows
10. If you don’t want to configure Toon Boom Harmony right away, you can:
Uncheck the Run Toon Boom Harmony Configuration Wizard and click the Finish button to close the
installer.
OR
Click Exit on the Toon Boom Harmony Configuration dialog box if you are already in the configuration
window.
11
Harmony Installation Guide - Windows Operating Systems
Configuration
After installing Toon Boom Harmony, you need to configure database parameters depending on your machine’s setup
and third-party software, and reinstate your anti-virus settings.
1. Configure Toon Boom Harmony, on page 12
2. Configure the License, on page 18
3. Reactivating the Firewall and the Anti-virus Software, on page 24
12
Installing on Windows
3. Select the location of the database from the drop-list and select a username and a password for the user that
will be running the database services.
The default account is usabatch. If the account specified does not exist, it will be created by the wizard.
NOTE: Make sure to take note of the account name and password if an account other than the default one is
used. This information will be required later on for client workstations to connect to the server.
4. Click Next.
The configuration program creates the database, /USA_DB, in the location you select. The /USA_DB tracks the
location of the scene data on the file system. You can have multiple file systems, but only one /USA_DB.
NOTE:
If you are upgrading from a previous version of Harmony or Opus and you have renamed
/usa_db for back-up, you need to create new usa_db at the same location where the previous /usa_db was
located.
13
Harmony Installation Guide - Windows Operating Systems
5. In the Scene Data Location window, you create the storage locations for the database.
From the File system drop-list, you select the file system you want to add. The first File system is already
created for you. If you want to create additional file systems, you must click Add. For example, if you want
to store scene data across multiple drives or computers, you can create them here.
From the Drive drop-list, select the drive where you want to create the file system.
In the Share field is the name of the file system that will be created. You can change this value. However, it is
recommended to leave the default name, which increments from usadata000.
In the Host Computer field, enter the name of the computer on which this file system will be created. By
default, the current computer’s name will appear here. You can create file systems on other computers if
necessary.
Specify the username and the password that will be used to connect to that file system. It is recommended
to use the same username and password as the one used for the database, in the previous step.
6. Click Next. The Toon Boom Harmony: Review window opens.
14
Installing on Windows
3. Enter the name of the Toon Boom Harmony server and click Next. The Review window opens.
4. Verify the database changes and click Finish.
A message will appear when the client computer is successfully connected to the database server.
NOTE:
It is possible to change the user account used to connect to the USA_DB or the different file systems using the Toon
Boom Control Panel, which can be started from
Start > Programs > Toon Boom Harmony 7.8 > Tools > Control Panel.
15
Harmony Installation Guide - Windows Operating Systems
16
Installing on Windows
8. Set all permissions in the Everyone group to Allow and click OK to save the settings and close the dialog box.
9. Click the Security tab.
17
Harmony Installation Guide - Windows Operating Systems
18
Installing on Windows
5. Type or copy/paste the Product Code and type in the number of licenses this product code grants you.
NOTE: Once activated, server license cannot be returned to the activation server. Make sure you are activating
the license on the correct computer with the proper license count.
6. Click on Next.
19
Harmony Installation Guide - Windows Operating Systems
20
Installing on Windows
9. Once finished with the License Wizard, take a look at the lmgrd.log to make sure it was started properly.
C:\flexlm\lmgrd.log
10. You can now go in LMTOOLS to verify that the License server has been configured properly and that it is
running.
Below are the default parameters for the license service.
11. It is good practice to verify that the license service it properly running by going in the Server Status tab and
clicking Perform Status Enquiry.
21
Harmony Installation Guide - Windows Operating Systems
22
Installing on Windows
4. Click on Use License Server. The Server Activation Options screen appears.
5. Click on Connect to Server. The Server Activation - Shared License dialog appears.
6. Enter the hostname or the IP Address in the License Server address field.
7. Click Connect. You will be prompted for a password.
8. Enter the password and click ok. The Activation Successful screen appears.
9. Click Finish to close the License Wizard.
23
Harmony Installation Guide - Windows Operating Systems
On Windows Vista
1. Click the Start menu, and select Settings > Control Panel to open the Control Panel.
24
Installing on Windows
2. Click on Turn Windows Firewall on or off. The Windows Firewall Setting dialog box appears.
On Windows XP
1. Open the Windows Firewall dialog box.
a From the Security Center window, click the Windows Firewall icon on the left side panel.
b Click the Start menu, and select Control Panel to open the Control Panel. Double-click the Windows
Firewall icon.
c In the Windows Firewall window, click on the Change settings link.
4. Select the On option to turn the firewall on.
5. Click on Apply to activate the option.
6. Click OK to complete the procedure.
25
Harmony Installation Guide - Windows Operating Systems
Troubleshooting
If you have any outstanding issues running Toon Boom Harmony after installation, review the installation and
configuration instructions to make sure you have followed them completely. If you continue to have problems, consult
the following list to troubleshoot common installation and configuration problems.
• Problem: License Error When Starting Any Toon Boom Harmony Module, on page 26
• Problem: Unable to Import Sample Scene (Errors with the tbdbserver), on page 26
• Problem: Unable to Open Sample Scene on Clients, on page 27
• Problem: resolution.conf Error Message, on page 27
2. Double-click the Toon Boom Harmony Control Panel icon. The Toon Boom Harmony Control Panel dialog
box opens.
26
Installing on Windows
If you continue to have problems with the database server, locate the tbdbserver.log file and send it to
[email protected]. This file is usually in C:\Program Files\Toon Boom
Animation\Harmony7.8\nt.
You can also run the Dbserver from the command shell in debug mode to receive additional information about the
process.
To run the tbdserver in debug mode:
1. Open Dbserver.conf.
2. Add the following line to the file:
debug_port 5681
3. Stop the tbdbserver service. Click the Start menu and select Programs > Toon Boom Harmony7.8 >
Configuration Tools > Control Panel. When the Toon Boom Harmony Control Panel window opens, select the
tbdbserver from the Process Starter drop-list and then click Stop.
4. Open a command prompt by selecting Start > Programs > Accessories > Command Prompt.
5. Type the following:
tbdbserver -debug
NOTE:
While you are running the tbdbserver in debug mode, messages will be written to the shell for each operation the
tbdbserver performs. This is additional information to what is written to the tbdbserver.log file.
To output this information to a new file, type the following:
tbdbserver -debug > "C:\Program Files\Toon Boom
Animation\Harmony7.8\nt\tbdbserver_debug.log"
If you still cannot determine the nature of the problem, send this file to support@ toonboom.com with a detailed
description of the problem.
27