Installation Guide - Canto

Workgroup 8.1 

Installation Guide

Copyright 2010, Canto GmbH. All rights reserved. 

Canto, the Canto logo, the Cumulus logo, and Cumulus are registered trademarks 

of Canto, registered in the U.S. and other countries. 

Apple, Mac, Macintosh and QuickTime are registered trademarks of Apple Computer, 

Inc. , registered in the U.S. and other countries. 

Microsoft, Windows, Windows Vista, and Windows NT are either trademarks or 

registered trademarks of the Microsoft Corporation in the U.S. and other countries. 

Other third-party product and company names mentioned in this document are 

trademarks or registered trademarks of their respective holders. 

Feedback 

Tell us what you think about this manual. We welcome all of your 

comments and suggestions. 

Please e-mail comments to techdoc@canto.com 

or via fax at +49-30-390 48 555. 

CU-WI-813-MN-Z-1

TABLE OF CONTENTS 3 

Table of Contents 

Install 5 

System Requirements . . . . . . . . . . . . . 6 

Cumulus Server System Requirements. . . . . . . . . . . . . . . . . 6 

Cumulus Client System Requirements . . . . . . . . . . . . . . . . . 6 

Installation Overview . . . . . . . . . . . . . . 7 

Installing the Cumulus Server. . . . . . 7 

Installing under Windows or Mac OS X . . . . . . . . . . . . . . . . 8 

Installing under UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 

Registering Cumulus . . . . . . . . . . . . . . 13 

Purchasing Additional Licenses. . . . . . . . . . . . . . . . . . . . . . 14 

Registering And Activating Additional Licenses . . . . . . 15 

Installing Cumulus Clients . . . . . . . . . 16 

Technical Note on EJaPs and Assigned Memory . . . . . 19 

Installing Cumulus Scheduler . . . . . . 19 

Installing the Scheduler Server Application . . . . . . . . . . 19 

Configuring the Scheduler Server Application . . . . . . . 23 

Index 25

4 CUMULUS® WORKGROUP - INSTALLATION GUIDE

This guide describes how to install the Cumulus Server and 

Cumulus Clients. It covers the Cumulus Workgroup system 

requirements as well as the installation of the Cumulus Workgroup 

software. In it, you’ll find out how to register your software 

and obtain your license information – a requirement for integrating 

Cumulus Clients into the system. This chapter also provides 

information on adding additional Cumulus Options, Clients or 

Servers. 

Install

6 CUMULUS® WORKGROUP - INSTALLATION GUIDE 

System Requirements 

Canto provides two levels of system requirements: minimum and recommended. 

Using the program on a system that falls beneath the minimum 

requirements may be possible, but it will most likely yield unfavorable 

results and is not recommended. 

Cumulus Server System Requirements 

This section lists the minimum and (in parentheses) recommended system 

requirements to install and run the Cumulus Server on the following systems. 

Windows 

• Windows 7, Windows Vista (and latest patches), Windows XP (SP2 

and latest patches), Windows Server 2003 (SP1 and latest patches), 

or Windows Server 2008 – all including Microsoft Windows 

Installer 3.1 

• 700 MB free hard disk space for installation 

• 256 MB minimum of available RAM 

• TCP/IP protocol running 

Mac OS X 

• Mac OS X version 10.4/10.5/10.6 (latest patches recommended) or 

Mac OS X Server version 10.4/10.5/10.6 (latest patches recommended) 




UNIX 

• Oracle Solaris 9 (or later) for SPARC processors or 

Linux x86 (libc version 6, kernel version 2.4 or 2.6, libstdc++ version 5) 

Tested on: openSUSE 10; openSUSE 11; Red Hat Enterprise 5 

Not supported: Red Hat Linux 8.x; SuSE Linux 8.x and lower 




Cumulus Client System Requirements 

This section lists the minimum and (in parentheses) recommended system 

requirements to install and run Cumulus Clients under Windows 

and/or Mac OS X operating environments. 

Windows 

• Windows 7, Windows Vista (and latest patches), Windows XP (SP2 

and latest patches), Windows Server 2003 (SP1 and latest patches), 

or Windows Server 2008 – all including Microsoft Windows 

Installer 3.1 

• 1024 x 768 video display 



• TCP/IP network access 

• QuickTime 7 (or later), standard installation, required for certain features

INSTALLATION OVERVIEW 7 

Mac OS X 

• Mac OS X version 10.4/10.5/10.6 (latest patches recommended) or 

Mac OS X Server version 10.4/10.5/10.6 (latest patches recommended) 

• 1024 x 768 video display 



• TCP/IP network access 

• QuickTime 7 (or later), standard installation, required for certain features 

Installation Overview 

A Cumulus Workgroup installation consists of different software components: 

the Cumulus Server and its Remote Admin utility and the Cumulus 

Client. 

Installing Cumulus Workgroup requires several steps: 

• First, you have to install the Cumulus Server application on the network 

computer that is to serve the Clients. 

• Next you should register your Cumulus installation. If you have any 

optional add-ons to install—such as Web Publisher Pro—do that 

before you register. Then you can register your entire Cumulus system. 

• Last but not least, the Cumulus Client software has to be installed on 

each individual workstation. The connection between each Client 

and the Server is handled via TCP/IP. 

On workstations that are used for performing administrative tasks, 

the Server Console application should be installed along with the 

Cumulus Client software. This is offered as an option when installing. 

NOTE >>> Installing under Windows 2003 

If you are installing under Windows 2003, you have to include the Cumulus 

installer in the exception list of the DEP (Data Execution Prevention). 

You open this exception list by right-clicking on the Computer Properties 

and selecting Advanced > Performance/Settings > Data Execution 

Prevention.


• Cumulus catalog files Users.ccf, Statistics.ccf and Sample.ccf 

– The Users catalog is used for the user management. This catalog 

manages the users and user permissions for your Cumulus Workgroup. 

It contains the users that are allowed to access the catalogs 

managed by the Cumulus Server. 

– The Statistics catalog is required for generating time related 

reports. 

– The Sample catalog is just a sample of a catalog. 

By default, the three catalogs are included in the list of catalogs managed 

by the Cumulus Server, while the Users and Statistics catalog 

are only displayed when the Cumulus Administrator logs in. 

The sections that follow describe the procedures for installing the Cumulus 

Server under Windows, Mac OS X and UNIX. 

Cumulus provides an installer application which guides you through the 

installation process. With Windows and Mac OS X, this application is a 

double-click installation. With UNIX versions, it is a CONSOLE mode installation. 

For special purposes, such as remote or update installation, this 

CONSOLE mode installation is provided for Mac OS X as well. 

If you experience problems installing or using Cumulus, be sure to review 

“Common Problems and Solutions” in the Administrator Guide. 

Installing under Windows or Mac OS X 

To install the Cumulus Server under Windows or Mac OS X: 

1. Log on to the Windows server machine as the Administrator 

for the local machine. 

Log on to the Mac OS X server machine. 

2. Double-click Install Cumulus_W_Server.exe. 

Under Windows Vista/7 you may be requested to allow the start 

of the installer. 

Double-click Install Cumulus_W_Server and authenticate 

yourself as an administrator. 

The installation resources are extracted and you are asked to 

select a language. This language is used for the installation process 

as well as for the application being installed. And the 

selected language also defines the names of any of the pre-configured 

sets installed with the software (the contents are the same 

for all languages but the names vary according to the selected 

language).

INSTALLING THE CUMULUS SERVER 9 

3. Select a language and click OK. The installer is launched. 

NOTE >>> If you get a message that the Cumulus default port numbers 

are used, you may continue with the installation and then see 

“Different Port Numbers” in the Administrator Guide, for a description 

on how to proceed after the installer has finished. Should you really 

want to use different port numbers, click Proceed.


The Choose Install Set dialog opens. 

8. Choose the features you want to install: 

• Cumulus Server – installs the Cumulus Server software including 

all pre-configured sets and templates. 

• Show Case – installs a show case which includes a Cumulus 

sample catalog, appropriate sets and the assets cataloged. 

9. Click Next to continue. 

10. If you are updating from a previous version of Cumulus 8 and 

have chosen the same installation folder, the installer will recognize 

the previous Cumulus installation and will offer you an update 

installation. Click Update to continue. 

If you are installing the Cumulus Server 8 for the first time, you will 

be asked to enter a user name and password for the Cumulus 

Administrator. 

Enter the required login information and click Next to continue. 

The Pre-Installation Summary is displayed.

INSTALLING THE CUMULUS SERVER 11 

11. Click Install to start the installation. The installer begins copying 

files. 

When the installation is complete, the Install Complete window is 

displayed. 

Also the Remote Admin utility is started in a separate window for 

registering your Cumulus configuration. 

12. In the Install Complete window, click Done to end the installation 

and close the window. 

If you have any optional add-ons to install – such as Web Publisher Pro – 

do that now. You will then be ready to register and activate your entire 

Cumulus system. NOTE >>> Please note that you can only install Cumulus 

Options available for Cumulus 8. > Restarting the Machine after Installation! 

Under Mac OS X, you have to restart the machine after installation if you 

were logged in as superuser (in most cases the superuser is called root) 

for performing the installation. Otherwise the Cumulus Server will be 

stopped as soon as the superuser logs out.


Installing under UNIX 

With UNIX versions, Cumulus provides a CONSOLE mode installation. For 

special purposes, such as remote installation, this CONSOLE mode installation 

is provided for Mac OS X as well. 

The CONSOLE mode installation guides you through all steps necessary 

to install the Cumulus Server. To accept the default values [shown in 

square brackets] press the Enter key. 

To install the Cumulus Server under UNIX: 

1. Open a UNIX shell and change your identity to superuser (enter 

su for super user and then the password; in most cases the superuser 

is called root). The CONSOLE mode installation is started 

manually by typing the script name at the command prompt. 

2. Start the CONSOLE mode installation by entering: 

sh W8Server.bin 

3. When the Introduction is displayed, press the Enter key to continue. 

The software license agreement is displayed. 

4. Read the displayed license agreement and enter y to accept. 

The Choose Install Folder dialog opens. 

5. To accept the default installation location, press the Enter key to 

continue. Or, if you do not want to accept the default location, 

enter the absolute path for the desired installation folder and 

press the Enter key to continue. 

If you are installing the Cumulus Server for the first time, you will 

be asked to enter a user name and password for the Cumulus 


The Pre-Installation Summary is displayed. 

6. Press the Enter key to start the installation. 

The installer begins copying files. When the installation is complete, 

the Install Complete information is displayed. 

7. Press the Enter key to end the installation and exit. 

If you have any optional add-ons to install – such as Web Publisher Pro – 

do that now. You will then be ready to register and activate your entire 

Cumulus system. NOTE >>> Please note that you can only install Cumulus 

Options available for Cumulus 8.

REGISTERING CUMULUS 13 

Registering Cumulus 

Registering Cumulus is required in order to have your Cumulus system 

running in normal mode. It also entitles you to technical support from 

your distributor free of charge via e-mail. When you register with Canto, 

you receive a license information text block (including an Activation Key) 

that you need to enter in order to activate your Cumulus Workgroup system. 

The fastest and easiest way to register your copy of Cumulus and obtain 

your license information is on the World Wide Web. If you do not want to 

use a Web connection, you can print the registration form out and fax it 

to Canto. 

To register a Cumulus installation: 

1. If it is not open, open the Remote Admin window with a common 

Web Browser. (Note that you should use a current version of a 

common Web browser, e.g. Mozilla Firefox, Microsoft Internet 

Explorer, Safari.) The default URL is: http://:8954/login.html 

(For a detailed description, see chapter “Remote Admin via Web 

Browser,” in the Administrator Guide.) 

You are prompted to enter the name and password of the Cumulus 


2. Enter name and password of the Cumulus Administrator. 

If Remote Admin is started for the first time after installing a 

Cumulus Server, you are also asked to enter registration information. 

The Cumulus Server is installed with a demo version serial number that 

is displayed when you are asked to enter registration information. You 

have to enter your serial number later on in the Edit License window. 

3. Enter your name and company in the fields provided and click 

Submit.


The Cumulus Remote Admin window opens and displays your 

current Cumulus Server license information and settings. The 

information on your current license status is displayed on the left 

hand side. Without registration your Cumulus configuration is 

running in demo mode. Available Cumulus Options are also preconfigured 

as demo versions. 

4. Click Edit License.The Edit License window opens. Immediately 

after installation, it contains the serial number for demo versions. 

5. Insert the serial number(s) you received from Canto, your local 

distributor or dealer and click Submit to confirm. 

6. Depending on the way you wish to register with Canto click 

either WWW or PDF. 

If registering via WWW, fill out the online registration form and 

submit it. 

If registering via PDF, fill out the PDF registration form and print 

the form, then fax or mail it to the address listed for your region. 

Once you’ve registered your Cumulus software and received your 

license information, you need to enter this information to activate 

your entire Cumulus system. 

7. Click Edit License.The Edit License window opens. 

8. Replace the text in this window with the current license information 

text block (including an Activation Key) you received from 

Canto and click Submit to confirm. 

The Edit License window closes. When opening the window 

again, you will see that the license information text block was 

transformed to just display the serial number(s) and Activation 

Key. 

If you registered any optional Cumulus add-on products along with your 

Cumulus Edition, they will be listed under Options. The changed status of 

your Cumulus Edition also appears under Status. To make them all available 

for Cumulus Clients, start and stop your Cumulus Server before any 

Cumulus Client connects. 

The license information you receive from Canto is valid for your entire Cumulus 

system. It enables all of the components you registered to work together. 

Every time you purchase and register a new component, you receive license 

information that applies to your existing system plus the new component(s). 

Purchasing Additional Licenses 

Each copy of Cumulus Workgroup is limited to a certain number of concurrent 

users (Cumulus Clients that can access the Cumulus Server at the 

same time). You can view the specifics of your license with Remote 

Admin. (See “License,” p. 74 for details.) 

Each copy of Cumulus Workgroup is licensed to run on only one server at 

a time. If you want to install multiple servers, you must purchase a separate 

Server License for each additional Cumulus Server for your Cumulus 

Workgroup Edition. No special installation steps are required to install 

additional servers.

REGISTERING CUMULUS 15 

If you need to purchase an extension of your license for additional Cumulus 

Clients or Servers, please contact your software dealer, local software 

distributor, or Canto (www.canto.com). 

To extend the number of Clients allowed, you will have to get a new 

license information text block (including an Activation Key). This will be 

valid for your entire Cumulus Workgroup system, meaning both your 

existing installation and the new components you’re adding to it. 

Registering And Activating Additional Licenses 

For adding any new Cumulus Options or add-on products, we recommend 

you to register via WWW with Canto and then use the possibility 

provided there to edit your license information 

1. In Remote Admin, click Register via WWW. The Cumulus Registration 

page opens. 

2. Under Your Configuration, click on the here link. A dialog for 

entering serial numbers opens. 

3. Add the serial number(s) you received from Canto or from your 

distributor and click Register. 

4. Fill in or check the required fields of the registration page and 

click Submit. 

You will receive your updated license information from Canto. 

Copy this information as you need to enter this information to 

activate your updated Cumulus system. 

5. In Remote Admin, click Edit License.The Edit License window 

opens. 

6. Replace the text in this window with the current license information 

text block for your new configuration you received from 

Canto – via e-mail or Web. Be sure to paste in the entire text block 

(first line “### Begin of Serial Numbers ...” until last line “### End of 

Serial Numbers...”). 

7. Click Submit to confirm. The Edit License window closes. 

8. Stop your Cumulus Server and start it again using the provided 

buttons/links. 

The license information you receive from Canto is valid for your entire Cumulus 

Workgroup system. It enables all of the components you registered to 

work together. Every time you purchase and register a new component, you 

receive license information that applies to your existing system plus the new 

component(s). 

WARNING >>> 

If you use the Edit License window of Remote Admin for adding new 

serial numbers for Cumulus Options instead of the here link under Your 

Configuration on the Cumulus Registration Web page, be aware of the 

following: 

The status of your entire configuration will default to demo version as 

soon as you have added the serial numbers. It will remain in demo version


until you have entered the current license information text block for your 

new configuration. In demo mode, your version will be limited to 5 Clients 

and 2 catalogs with 100 records each until the license info is entered. 

Afterwards your configuration will be back to normal without limitations. 

It is therefore very important that you consider the best time to add a 

new Option so that your workflow is not disrupted. When adding Options 

this way no clients should be connected.

INSTALLING CUMULUS CLIENTS 17 

4. When the Introduction screen is displayed, click Next to continue. 


5. Read the displayed license agreement and activate the I accept 

the terms of the License Agreement option. 

6. Click Next to continue. The Choose Install Folder dialog opens. 

7. To accept the default installation location, click Next to continue. 

Or, if you do not want to accept the default location, click Choose 

to choose a different location. The Browse For Folder dialog 

opens. Select the folder of your choice and click OK to return to 

the previous dialog. Then click Next to continue. 

The Choose Install Set dialog opens. 

The default installation will install the application, the help files of 

all languages available for the Cumulus user interface and the 

Server Console module. The Server Console is needed on workstations 

that are used for performing administrative tasks (see 

“Server Console,” p. 67 for further information on those modules). 

If you don’t want all components of a default installation installed, 

deactivate the corresponding check boxes.


A Cumulus PowerPoint Add-In will be installed by default. The 

Cumulus PowerPoint Add-In enhances your Microsoft PowerPoint 

application with additional functions. It enables you to import 

cataloged slides, pictures and media from Cumulus into Microsoft 

PowerPoint presentations. 

8. To accept the default installation, click Next to continue. Or, if you 

don’t want to run Cumulus in all offered languages or don’t need 

the Server Console module, disable the options you don’t need 

and then click Next to continue. 

9. If you are updating from a previous version of Cumulus 8 and 

have chosen the same installation folder, the installer will recognize 

the previous Cumulus installation and will offer you an update 

installation. Click Update to continue. 



files. 


displayed.

INSTALLING CUMULUS SCHEDULER 19 



Technical Note on EJaPs and Assigned Memory 

Depending on the number of EJaPs you employ and the number of 

records or assets you perform these EJaPs on, you may need to configure 

the memory size assigned to the Java VM of the EJaPs. By default this is set 

to 128 MB. For example, when using the “Find Duplicates” function on collections 

with more than 25,000 records you should increase the memory. 

To increase the assigned memory, you have to add a line to the JVMConfig.xml 

file (found in the conf folder inside the Cumulus Client installation 

folder). 

Example for this line increasing the memory to 256 MB: 

-Xmx256m 

Note that the value may not be bigger than the physical memory and always 

has to be 2 to the power of n. We recommend a value smaller than 1024. 

Installing Cumulus Scheduler 

The Cumulus Scheduler enables you to define and schedule tasks to be 

automatically performed by Cumulus. If you want to make use of this feature, 

you must install separate software. 

The Cumulus Scheduler consists of the Scheduler Manager and the 

Scheduler Server Application. The Scheduler Manager utility is included 

in Cumulus Server Console. The Scheduler Server Application must be 

installed separately. It has to be installed on the computer that you want 

to perform the tasks on. This can be any computer with TCP/IP network 

access to the Cumulus Server. It is a Cumulus Java Classes application that 

communicates with the Cumulus Server just like a Cumulus Client does. 

The system requirements are the same as for Cumulus Java Classes. 

If one of the tasks performed by the Scheduler Server Application 

requires certain software to be installed (e.g. a Cumulus or third-party 

option), this software must be installed on the computer running the 

Scheduler Server Application. 

Installing the Scheduler Server Application 

The installation differs depending on the operating system. 

Installing under Windows or Mac OS X 

To install the Scheduler Server Application under Windows or Mac OS X: 

1. Log on to the local machine as the Administrator for the 

machine. 

Log on to local machine. 

2. Double-click Install Cumulus_Scheduler.exe. 

Under Windows Vista/7 you may be requested to allow the start 

of the installer.


Double-click Install Cumulus_Scheduler and authenticate 

yourself as an administrator. 

The installation resources are extracted and you are asked to 

select a language. This language is used for the installation process 

as well as for the application being installed. And the 

selected language also defines the names of any of the pre-configured 

sets installed with the software (the contents are the 

same for all languages but the names vary according to the 

selected language). 

3. Select a language and click OK. The installer is launched. 

4. When the Introduction screen is displayed, click Next to continue. 


5. Read the displayed license agreement and activate the I accept 

the terms of the License Agreement option.


6. Click Next to continue. The Choose Install Folder dialog opens. 

7. To accept the default installation location, click Next to continue. 

Or, if you do not want to accept the default location, click Choose 

to choose a different location. The Browse For Folder dialog 

opens. Select the folder of your choice and click OK to return to 

the previous dialog. Then click Next to continue. 



files.



displayed. 



Installing under UNIX 

With UNIX versions, Cumulus provides a CONSOLE mode installation. For 

special purposes, such as remote installation, this CONSOLE mode installation 

is provided for Mac OS X as well. 

The CONSOLE mode installation guides you through all steps necessary 

to install the Cumulus Server. To accept the default values [shown in 

square brackets] press the Enter key. 

To install the Scheduler Server Application under UNIX: 

1. Open a UNIX shell and change your identity to superuser (enter 

su for super user and then the password; in most cases the superuser 

is called root). The CONSOLE mode installation is started 

manually by typing the script name at the command prompt. 

2. Start the CONSOLE mode installation by entering: 

sh C8Sched.bin 

3. When the Introduction is displayed, press the Enter key to continue. 


4. Read the displayed license agreement and enter y to accept. 

The Choose Install Folder dialog opens. 

5. To accept the default installation location, press the Enter key to 

continue. Or, if you do not want to accept the default location, 

enter the absolute path for the desired installation folder and 

press the Enter key to continue. 


6. Press the Enter key to start the installation. 

The installer begins copying files. When the installation is complete, 

the Install Complete information is displayed. 

7. Press the Enter key to end the installation and exit.


Running the Scheduler Server Application as a Service 

For installing the Scheduler Server Application as a service, Canto provides 

following scripts: 

• InstallCumulusScheduler.bat for Windows 

• InstallCumulusSchedulerService.sh for Mac OS X and UNIX (Solaris, 

Linux, etc.) 

These scripts can be found in the Cumulus Scheduler installation folder, 

e.g. C:\Program Files\Canto\Cumulus Scheduler 

NOTE>>> The script has to be executed with administrator permissions. 

Use right-click to invoke them.> Make sure the user you employ for the connection to the 

Cumulus Server has sufficient permissions for all functions necessary to 

fulfill the tasks. In any case the Cumulus Administrator has all permissions 

that could be required.

24 CUMULUS® WORKGROUP - INSTALLATION GUIDE

INDEX 25 

Index 

A 

Adding Cumulus Options 15 

C 

Configuring 

Scheduler Server Application 23 

Copyright 2 

Cumulus Clients 

adding 14 

installing 16 

limit per server 14 

system requirements 6 

Cumulus Options, adding 15 

Cumulus Server 

adding 14 

installing 

under Mac OS X 8 

under UNIX 12 

under Windows 8 

limits 14 

requirements 6 

I 

Installing 

Cumulus Client 16 

Cumulus Scheduler 19 

Cumulus Server 


under UNIX 12 


Scheduler Server Application 19 

show case 10 

L 

License 

Edit License window 14 

purchasing additional 14 

registering 13 

system requirements 

Clients 7 

Server 6 

Memory 

assigned to Java VM 19 

Client requirements 6 

Server requirements 6 

R 

Registering Cumulus 13 

S 

Scheduler Server Application 

configuring 23 

installing 19 


under UNIX 22 


running as a service 23 

Show Case 

installing 10 

System requirements 

for Clients 6 

for Server 6 

U 

UNIX 

installing 

Cumulus Server under 12 

Scheduler Server Application under 22 

system requirements 6 

W 

Windows 

installing 

Cumulus Client under 16 


Scheduler Server Application under 19 

M 

Mac OS X 

installing 

Cumulus Client under 16 


Scheduler Server Application under 19

Installation Guide - Canto

Create successful ePaper yourself

Delete template?

Save as template?