Upgrading From a Previous Version of Toon Boom Harmony

This procedure assumes that the USAnimation, Opus or Toon Boom Harmony binaries (program files) are installed on the Toon Boom Harmony server and are mounted by all of the Linux clients. When you update the installation on the server; all clients will load the new binaries from the central mount point

When upgrading previous installations of USAnimation, Opus or Toon Boom Harmony, you should pick a time when Toon Boom Harmony production is slow or stopped. During the upgrade, no users can run any of the USAnimation, Opus or Toon Boom Harmony modules and all rendering jobs must be complete.

Restore the files that were previously backed-up
Edit usabatch's .cshrc
Edit other users .cshrc
Edit the /etc/skel/.cshrc
Configuring the License Server
Restart the Harmony Services
Updating the nfs export
Updating the smb.conf
Verify the parameters required in the smb.conf

To update previous installations:

1. Make sure that no one is running any versions of USAnimation, Opus or Toon Boom Harmony. All USAnimation, Opus or Toon Boom Harmony modules must be closed on the server and on all of the clients.
2. Make sure that all batch rendering and vectorizing is complete 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 Queues to open the Vectorize and Rendering Queue for all environments. The queues should either be empty or the status of all jobs should be Completed.
3. Stop all services running on the server and the clients. Depending on the services you have running, type the following commands, in the order presented, in a shell while logged in as the root user:

/etc/init.d/USAnimation_queues stop

/etc/init.d/USAnimation_link_srv stop

/etc/init.d/USAnimation_dbserver stop

/etc/init.d/USAnimation_flexlm stop

You must be sure to stop the queues on all rendering machines. If the queues are running, those binaries will be locked and the installer won't be able to update them.

Note: It is not required to delete the startup scripts from /etc/init.d/ as the Harmony install script will update them automatically.

You must be sure to stop the queues on all rendering machines. If the queues are running, those binaries will be locked and the installer won't be able to update them.

4. Backing up configuration files:

Back up Harmony's configuration files by copying them to a location where you will be able to recover them later on. Go to the folder where the previous version of Harmony is installed and backup configuration files that are in the etc folder:

7.5 and earlier: /usa/etc
7.8: /usr/local/ToonBoomAnimation/harmony_7.8/etc
9.2: /usr/local/ToonBoomAnimation/harmony_9.2/etc
10.0: /usr/local/ToonBoomAnimation/harmony_10.0/etc

Back up the following configuration files:

Manager.conf

Scan.conf (If a scanner was configured to run with the Harmony Scan module on this computer)

server.ini (If the server is configure to receive connections from Windows clients)

VectOptions.conf (If vectorization preset had been added to it)

If any plug-ins have been added to the Harmony installation, backup these files as well. The plug-ins are located in:

7.5 and earlier: /usa/lnx86/plugins
7.8: /usr/local/ToonBoomAnimation/harmony_7.8/lnx86/plugins
9.2: /usr/local/ToonBoomAnimation/harmony_9.2/lnx86/plugins
10.0: /usr/local/ToonBoomAnimation/harmony_10.0/lnx86_64/plugins

You can back up the entire Harmony folder by renaming it to make sure all config files are kept.

Delete or backup the Harmony Installation by renaming the folder where it is installed. Default install location for 7.5 and earlier is /usa.

5. Cleaning the KDE menu.

Shortcut to launch the previous application should be removed from the KDE menu. There are two ways of doing this:

Using the KDE Menu Editor that can be started from the KDE menu. The location will vary depending on the version of Linux installed.

By deleting them from the command line. Change to /usr/share/applnk/

$ cd /usr/share/applnk/

Delete the old shortcuts:

Versions 7.8,9.2 and 10.0:

$ rm ToonBoom-Harmony_*

 

Earlier versions:

$ rm USAnimation-*

 

The shortcuts will be removed from the KDE menu the next time you log in.

6. Uncompress the distribution file.

tar xvfz [path_to_distribution_file]/[filename].tar.gz

7. Change to the directory that was extracted from the tar.gz file.
8. While logged in as the root user, run the install script specifying the options required for your server.
$ ./install -b -d -l -p -u -“kde
-b: mandatory. This will install the binaries required to run Harmony.
-d: configures the tbdbserver for auto startup. Required when installing a server.
-l: configures the Link_srv for auto-startup. Required if the server has window clients.
-p: Configures the tbprocess for auto-startup. Required if the server will be performing batch processing.
-u: Updates the dict files in the USA_DB/dicts. This is mandatory when upgrading a server from a version previous to Harmony 10. This option will only work if -d is also selected.
-kde: installs Harmony menu shortcuts in the KDE menu.

Restore the files that were previously backed-up

Copy the server.ini, Manager.conf and any other files you must backup to the new installation. From the backup location to /usr/local/ToonBoomAnimation/harmony_10.0/etc/.

Edit usabatch's .cshrc

Before being able to start the Harmony services, you will need to make modification to the .cshrc that is in usabatch's home.

1. If you are not logged in as usabatch, do so by typing the following:

$ su -€ usabatch

2. Once logged in, open the .cshrc file in usabatch's home using your favourite text editor. I use vi:

$ vi .cshrc

The file used for Harmony 9.2 contains the following:

if ( -f /usr/local/ToonBoomAnimation/harmony_9.2/etc/usa_cshrc ) then

source /usr/local/ToonBoomAnimation/harmony_9.2/etc/usa_cshrc

endif

 

umask 0

The file used for Harmony 7.8 contains the following:

if ( -f /usr/local/ToonBoomAnimation/harmony_7.8/etc/usa_cshrc ) then

source /usr/local/ToonBoomAnimation/harmony_7.8/etc/usa_cshrc

endif

 

umask 0

The file used for Harmony 7.3 contains the following:

if ( -f /usa/etc/usa_cshrc ) then

source /usa/etc/usa_cshrc

endif

 

umask 0

 

3. Change /usa/etc/usa_cshrc to /usr/local/ToonBoomAnimation/harmony_10.0/etc/usa_cshrc, so that it looks like this:

 

if ( -f /usr/local/ToonBoomAnimation/harmony_10.0/etc/usa_cshrc ) then

source /usr/local/ToonBoomAnimation/harmony_10.0/etc/usa_cshrc

endif

 

umask 0

 

4. Save and quit.

Edit other users .cshrc

The.cshrc of the all other users of Harmony should be edited to remove the lines that are used to source the usa_cshrc file. It is not required to source this file anymore as the path to the application is now added to the PATH variable via the files in /etc/profile.d.

For version 9.2:

 

if ( -f /usr/local/ToonBoomAnimation/harmony_9.2/etc/usa_cshrc ) then

source /usr/local/ToonBoomAnimation/harmony_9.2/etc/usa_cshrc

endif

 

umask 0

 

For version 7.8:

if ( -f /usr/local/ToonBoomAnimation/harmony_7.8/etc/usa_cshrc ) then

source /usr/local/ToonBoomAnimation/harmony_7.8/etc/usa_cshrc

endif

 

umask 0

 

For version 7.3:

if ( -f /usa/etc/usa_cshrc ) then

source /usa/etc/usa_cshrc

endif

 

umask 0

Edit the /etc/skel/.cshrc

Open the files /etc/skel/.cshrc with your favourite text editor and remove the lines that source the usa_cshrc file from it as well.

Configuring the License Server

1. To launch the License Wizard go to: /usr/local/ToonBoomAnimation/harmony_10.0/lnx86_64/bin/ in the terminal.

cd /usr/local/ToonBoomAnimation/harmony_10.0/lnx86_64/bin/

Logged as root user, type:

./LicenseWizard.

2. Click on Activate License.

The Activation Options screen appears:

3. Click on Internet Activation.

The Internet Activation Options screen appears:

4. Click on Network License.

The Internet Activation - Network License screen appears:

 

5. Type or copy/paste the Product Code and type in the number of licenses this product code grants you.
Once activated, server licenses can only be returned to the activation server once. A previously returned licensed cannot be re-activated. Make sure you are activating the license on the correct computer.
6. Click on Next.

The Install License Server screen appears:

7. Click on Install License Server.
This step will create the license.dat file and place it in /usr/local/flexlm/licenses/license.dat

The license.dat created contains the following information:

SERVER this_host 0 ANY

VENDOR toonboom

USE_SERVER

Both these steps can be done manually if need be. To configure the License Server service to start automatically at boot, use the following command:

$ /sbin/chkconfig USAnimation_flexlm on

To start the license server manually, type the following as the root user:

$ /etc/init.d/USAnimation_flexlm restart

The Activation Successful screen appears:

8. Click on Finish to exit the wizard.
9. Verify that the FlexLM license is working properly by using the lmutil lmstat -a command.

$ lmutil lmstat -a

You can also look at the log:

$ less /tmp/lmgrd.log

If the FlexLM service needs to be restarted, use the following command:

$ /etc/init.d/USAnimation_flexlm restart

Restart the Harmony Services

10. Once the license is properly configured, and started, start the Harmony services that are required on your server. They should be started in the following order:

$ /etc/init.d/USAnimation_dbserver restart

 

$ /etc/init.d/USAnimation_link_srv restart

 

$ /etc/init.d/USAnimation_queues restart

11. Once the services are started, check the logs to make sure that they have been started properly. Check all the logs to see if the services are running properly. Logs are located in /tmp.

/tmp/lmgrd.log

 

/tmp/tbdbserver.log

 

/tmp/tbprocess.log

 

/tmp/Link_srv.log

12. Start Harmony and open a scene to see if the server works properly.

Updating the nfs export

If the Linux server has Linux or Mac OS X clients, the nfs exports need to be updated with the path of the new Harmony binaries.

$ vi /etc/exports

1. Change the path of /usa to /usr/local/ToonBoomAnimation/harmony_10.0

/USA_DB *(rw,sync)

/usadata000 *(rw,sync)

/usr/local/ToonBoomAnimation/harmony_10.0 *(rw,sync)

2. For this change to take effect, you will need to run the following command:

$ /usr/sbin/exportfs -r

3. You should then test the exports using the showmount command:

[root@chewy etc]$ /usr/sbin/showmount -e

Export list for chewy.toonboom.com:

/USA_DB *

/usadata000 *

/usr/local/ToonBoomAnimation/harmony_10.0 *

Updating the smb.conf

1. When upgrading a Linux server, a small modification must be made to the usa share path to point to the new install. "vi /etc/samba/smb.conf" and change the path under the [usa] share to the path of the new Harmony install.

[usa]

comment = Harmony binaries & stuff

browseable = yes

read only = no

guest ok = no

create mask = 0777

directory mask = 0777

path = /usr/local/ToonBoomAnimation/harmony_10.0

2. Once the file is saved, run the "testparm" command to check that you have not made any basic syntactic errors.

[root@chewy samba]$ testparm

Load smb config files from /etc/samba/smb.conf

Processing section "[homes]"

Processing section "[printers]"

Processing section "[USA_DB]"

Processing section "[usa]"

Processing section "[usadata000]"

Processing section "[tmp]"

Loaded services file OK.

Server role: ROLE_STANDALONE

3. Press Enter to see a dump of your service definitions.

If the smb.conf was configured according to the 7.3 documentation, the testparm command might return the following error:

Level II oplocks can only be set if oplocks are also set.

To get rid of this error, you need to add the level2 oplocks = No parameter in the global section of the smb.conf.
See the next section for all the parameters that are required in the smb.conf.

4. Then, restart smb:

$/etc/init.d/smb restart

Verify the parameters required in the smb.conf

1. Verify the configuration of the smb.conf.

It is always safe to verify the configuration of the smb.conf.

$ vi /etc/samba/smb.conf

Parameters needed in the [global] section.

encrypt passwords = no

 

blocking locks = no

oplocks = no

level2 oplocks = no

 

follow symlinks = yes

unix extensions = no

wide links = yes

Default parameters for the shares.

[USA_DB]

comment = Harmony Database

browseable = yes

read only = no

guest ok = no

create mask = 0777

directory mask = 0777

path = /USA_DB

 

[usa]

comment = Harmony binaries & stuff

browseable = yes

read only = no

guest ok = no

create mask = 0777

directory mask = 0777

path = /usr/local/ToonBoomAnimation/harmony_10.0

 

[usadata000]

comment = Harmony data 000

browseable = yes

read only = no

guest ok = no

create mask = 0777

directory mask = 0777

path = /usadata000

2. Remember to always perform a testparm after making changes to the smb.conf.

$ testparm

3. Restart the smb service.

$ /sbin/service smb restart

4. Reboot the server.

If possible, reboot the server to verify that all the services are properly started.

5. Once the server is booted, check all the logs to see if the services are running properly. Logs are located in /tmp.

/tmp/lmgrd.log

 

/tmp/tbdbserver.log

 

/tmp/tbprocess.log

 

/tmp/Link_srv.log