Cumulus 6 HELIOS Companion 2.0. Administrator Guide

Transcription

1 Cumulus 6 HELIOS Companion 2.0 Administrator Guide

2 Copyright 2004, 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. Corel image viewers copyright (c) 1999 Corel Corporation. All rights reserved. Corel DRAW and Corel Photo Paint are registered trademarks of Corel Corporation. Apple, Mac, Macintosh and QuickTime are registered trademarks of Apple Computer, Inc., registered in the U.S. and other countries. Microsoft, Windows and Windows NT are either trademarks or registered trademarks of the Microsoft Corporation in the U.S. and other countries. Sun, Sun Microsystems, the Sun Logo, iforce, Solaris, and the Java logo are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States 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 comments to or via fax at CU-HC-200-MN-Z-1

3 TABLE OF CONTENTS 3 Table of Contents Intro 5 Cumulus HELIOS Companion HELIOS Synchronizer HELIOS Filter HELIOS AssetProcessor HELIOS Companion Setup This Guide Assumptions Organization User Interface Item Conventions Cumulus Step by Step Finding Help Canto Online Technical Support Install 11 System Requirements Server Requirements Cumulus Client System Requirements Cumulus Internet Solutions Requirements Installation Overview Installing the Server Software Installing under Mac OS X and UNIX Pre-requisite for Locale under Linux and SOLARIS Using the HELIOS Service Controller Different HELIOS and Cumulus Server Machines Activating HELIOS Companion Installing the Client Software Installing under Windows or Mac OS X Installing HELIOS Companion with Cumulus Internet Solutions Uninstalling the Server Software Uninstalling HELIOS Companion Version 1.x under Mac OS X Uninstalling HELIOS Companion Version 1.x under UNIX Use 31 The HELIOS Synchronizer Configuring via Shell Commands Configuring via Telnet Working with the Configuration Files Logging Actions The HELIOS Companion Setup Language of the HELIOS Companion Setup Starting the HELIOS Companion Setup Application.. 41 OVERVIEW: THE HELIOS COMPANION SETUP WINDOW - 42 Creating a Synchronize Setup Pre-filling Records The HELIOS Filter Asset Handling Sets for HELIOS Companion Adding Own Formats The HELIOS AssetProcessor Using the AssetProcessor from a Cumulus Client Logging HELIOS AssetProcessor Parameters Using the AssetProcessor from Cumulus Internet Solutions or Additional Applications Appendix 57 Considerations Before Installing Automatic Cataloging Accessing Assets Previewing Assets Converting Assets User Interface Visual Overview Page

4 4 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE Considerations Before Using New Catalogs Special Companion User Cumulus Internet Solutions Getting Started Migration Using Existing Catalogs for Automatic Cataloging with HELIOS Companion Migrating from HELIOS Companion Troubleshooting Resynchronizing HELIOS DT Commands HELIOS opitouch Utility / HELIOS Script Server Moving Folders within the Data Volume Managed by EtherShare HELIOS Synchronizer Already Running HELIOS Synchronizer not Started Automatically High and Low Resolution Files Accessing OPI Low Resolution Files Index 73

5 This chapter offers a brief introduction to Cumulus HELIOS Companion. This Cumulus Option automatically synchronizes Cumulus catalogs and HELIOS EtherShare/PCShare volumes. Many HELIOS EtherShare users want to catalog their files automatically into Cumulus when these are stored and changed in the server directories. Frequently production data is offered for reviewing or download via the Internet. With Cumulus HELIOS Companion, you don t have to waste time cataloging files manually any more. Changes in the file system are reflected immediately in the Cumulus catalogs regardless of whether new directories or files are created or existing ones are renamed, moved, edited or deleted. Intro

6 6 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE Cumulus HELIOS Companion Cumulus HELIOS Companion consists of different components: HELIOS Synchronizer HELIOS Filter HELIOS AssetProcessor HELIOS Companion Setup application HELIOS Synchronizer HELIOS Synchronizer provides the automatic synchronization between monitored folders and Cumulus catalogs. As a background process, HELIOS Synchronizer automatically compares the contents of monitored folders and Cumulus catalogs. Therefore it uses individual configuration files called Synchronize Setups. These Synchronize Setups are created and managed with the HELIOS Companion Setup application. A Synchronize Setup assigns a monitored folder to a Cumulus catalog including individual cataloging options, e.g. filter settings. The Synchronize Setup configuration files are stored in text format and can be modified with a text editor even from remote machines. HELIOS Synchronizer can be started and controlled by the HELIOS Companion Setup application as well as per shell or telnet commands. It interprets all messages on changes of hard drive contents transmitted by HELIOS ImageServer and carries out the corresponding Cumulus actions according to the Synchronize Setups. Files that are new in the monitored folder are automatically cataloged into Cumulus catalogs and new directory categories are applied, if necessary. If directories or files are changed, renamed, moved or deleted, the related Cumulus records or categories will be updated accordingly. NOTE: If you employ the HELIOS DT commands, HELIOS Synchronizer does not get any messages and therefore cannot react.

7 CUMULUS HELIOS COMPANION 7 Any files from any computer put via EtherShare or PCShare in a monitored folder on the UNIX computer running the HELIOS ImageServer is cataloged via the Cumulus Server to Cumulus catalogs. Once the files are cataloged, they can be accessed with a Cumulus Client (Windows or Mac OS X) and if a Cumulus Internet solution is installed with any Internet browser. HELIOS Filter The cataloging process of the files is directly carried out by the Cumulus Filters at the Cumulus Server. In addition the HELIOS Filter creates thumbnails and previews for all files with file formats that are supported by HELIOS ImageServer and extracts further metadata. Supplemental information can be added afterwards with a Cumulus Client or Internet Client. The HELIOS Filter accesses the current HELIOS installation on your system. So the supported formats always depend on the HELIOS ImageServer version currently installed on your system and whether PDF HandShake is installed. For more information about supported formats, see your HELIOS documentation. HELIOS AssetProcessor The HELIOS AssetProcessor enables you to convert cataloged assets into the following file formats: TIFF, JPEG, EPS, PNG, BMP, Scitex CT, Photoshop (PSD), and Macintosh PICT ICC (International Color Consortium) profiles are also supported. Rotation, flipping and cropping are possible, too. With the Cumu-

8 8 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE lus Options, Web Publisher Pro and Internet Client Pro all functions are also available in the Internet, e.g. prior to a download. HELIOS Companion Setup The HELIOS Companion Setup application manages the configuration files of HELIOS Synchronizer. The Synchronize Setup configuration files assign monitored folders to Cumulus catalogs including individually defined cataloging options. You can also use the HELIOS Companion Setup application to start and stop HELIOS Synchronizer and to invoke resynchronization processes. This Guide This guide covers the functionality of Cumulus HELIOS Companion. It was written for administrators of the Cumulus Option HELIOS Companion. It covers both installing and configuring the components as well as using the HELIOS AssetProcessor component with a Cumulus Client. Assumptions Since the scope of this guide is limited to one particular Cumulus Option, some assumptions have been made about your knowledge. Specifically, it has been assumed that you know how to administer the base Cumulus and HELIOS ImageServer software. If you have a clear idea of how to manage and configure HELIOS ImageServer and Cumulus, then keep reading. If you don t fit this description, you may want to review the Cumulus Administrator Guide, Cumulus Client User Guide or the HELIOS ImageServer documentation before returning to this manual. Organization This Administrator Guide covers the following topics: Installation Describes how to install the Cumulus HELIOS Companion Server and Client software. (See Install chapter, starting on page 11.) Use Describes how to use the components of the Cumulus HELIOS Companion Option. (See Use chapter, starting on page 31.) Appendix gives some recommendations on what to do before installing and using HELIOS Companion. It also offers

9 FINDING HELP 9 troubleshooting information. (See Appendix chapter, starting on page 57.) User Interface Item Conventions To differentiate user interface items buttons, menus, text fields, etc. from surrounding text, these items are displayed in bold. For example: Click the Open button. To differentiate menu hierarchies, the character is used. For example: Select File Open to open a file. This example means selecting the Open item from the File menu. Cumulus Step by Step Instructional steps are identified by the following structure: 1. This would be the first instruction. The mouse icon makes it easy to identify. 2. The final instruction has a border beneath it, indicating that there are no further steps. Finding Help If you have a question that is not answered in this guide, there are a number of additional resources to check: Canto Online The Canto website ( contains many resources of value to you as a Cumulus user. Among them Canto's User 2 User Support Forums. These forums are non-moderated bulletin boards hosted on the Canto website. Canto support does not answer questions here, the forums are user to user only. Feel free to use the forums to discuss any problems you may be having using Cumulus and receive help from other Cumulus users.

10 10 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE Technical Support To provide you with easily accessible, first-class assistance, Canto has partnerships with numerous distributors and resellers around the world. Technical support from your distributor via is free of charge for registered Cumulus users. For information on how to contact the distributor or reseller in your area, inquire where you purchased Cumulus or see Canto's Website ( Before submitting your question, please review the support form in the documentation folder on your Cumulus CD-ROM to make sure that you provide the technical support team with the appropriate information. If you are a registered Cumulus user and your distributor does not provide support for Cumulus, you may address questions to: The Americas -> support@canto.com Rest of World -> support@canto.de Additionally, you have the option of purchasing a Canto Service Agreement, which not only includes priority technical support by telephone, but also supplemental benefits, such as access to new filters and a monthly bulletin full of helpful tips, technical news and further information on Canto products. Please visit Canto's Website to find out how to register for a Service Agreement and receive extra support.

11 This chapter describes how to install Cumulus HELIOS Companion. It covers the system requirements as well as installation of the Cumulus HELIOS Companion components. Install

12 12 CUMULUS HELIOS COMPANION ADMINISTRATOR 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. Recommended requirements are listed below in parentheses and provide acceptable performance. Server Requirements SUN Microsystems UltraSPARC Workstation running SOLARIS 8 or later or Linux x86 (libc6, SuSE Linux 6.4, Red Hat Linux 6.2, or higher; not supported: Red Hat Linux 9 and SuSE Linux 9.0 or higher) or Mac OS X version or later or Mac OS X Server version or later HELIOS Companion requires a UTF-8 locale. HELIOS EtherShare 3.1 (and optional additionally for connecting Windows computers to the server: PCShare 3.1). Follow the HELIOS recommendations for using an AFP 3.1 compatible version to support long file names. NOTE: Due to space this manual only refers to EtherShare, however the descriptions also apply to PCShare. NOTE: HELIOS Volumes containing the monitored folders have to be configured to UTF-8. HELIOS ImageServer 2.5 with current updates (minimum u0313; u411 or higher recommended) PDF HandShake 2.1 (optional) Cumulus Server or later SUN Java (with latest updates) or later 50 MB hard disk space for installation 20 MB RAM minimum for the Cumulus HELIOS Companion components TCP/IP protocol running CD-ROM drive for installation from CD

13 INSTALLATION OVERVIEW 13 Cumulus Client System Requirements If you want a Cumulus Client under Windows or Mac OS X to use the HELIOS AssetProcessor for converting assets: The Cumulus Client has to be version or later Note that employing a Cumulus 6 Server with a Cumulus 5 Client and a previous HELIOS AssetProcessor version (1.x) is not supported with this version of HELIOS Companion. Cumulus Internet Solutions Requirements If you want to use the HELIOS Filter and the HELIOS AssetProcessor with a Cumulus Internet solution: Web Publisher Pro has to be version 2.0 or later Internet Client Pro has to be version 2.0 or later Installation Overview Installing Cumulus HELIOS Companion is a multiple step process: Firstly, you have to install the complete HELIOS Companion software on the computer that runs the HELIOS ImageServer software. NOTE: If you want Cumulus Clients to make use of the HELIOS AssetProcessor for converting assets, the Cumulus Server must run on the same computer as the HELIOS ImageServer software. Secondly, you have to install the HELIOS Filter and the HELIOS AssetProcessor on the computer that runs the Cumulus Server into the installation directory of the Cumulus Server (even if it is the same machine you installed the HELIOS Companion on). NOTE: Cumulus Internet Solutions If you want the HELIOS Filter and the HELIOS AssetProcessor with a Web Publisher Pro 2.0 or Internet Client Pro 2.0 installation, you have to install these components on that computer as well. (See Installing HELIOS Companion with Cumulus Internet Solutions, p. 25, for further details.) Thirdly, if you want Cumulus Clients to make use of the HELIOS AssetProcessor for converting assets, you have to install the HELIOS Companion Client software on the computers that run the Cumulus Client software. And you also have to install the

14 14 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE HELIOS Companion Client software on the computer you will use to prepare the catalogs and set up Asset Handling Sets for automatic cataloging with HELIOS Companion. To successfully install and run your HELIOS Companion Option, you must have both: your serial number (found in your Cumulus Options package) NOTE: Your Cumulus HELIOS Companion serial number must correspond with the numbers of clients of your HELIOS Ether- Share and PCShare installation (0 to 20 clients: 20, 0 to 40 clients: 40, or any number of clients: unlimited). license information including an Activation Key, which must be requested from Canto (after installation) NOTE: Multiple Cumulus Servers If you want to use Cumulus HELIOS Companion with catalogs administered by different Cumulus Servers you need a HELIOS Companion license for each Cumulus Server. Installing the Server Software Cumulus HELIOS Companion must be installed on the computer running the HELIOS ImageServer software. In order to have the full range of the HELIOS Companion features available, the Cumulus Workgroup or Enterprise Server has to run on the same computer. If the Cumulus Server is running on a different machine from the Cumulus HELIOS Companion, Cumulus Clients and other applications cannot make use of the HELIOS AssetProcessor and they can only preview those assets that employ the Cumulus Filters for the preview function. (You can find more information on this topic in the section Considerations Before Installing, starting on page 58.) The sections that follow describe the procedures for installing HELIOS Companion under Mac OS X and UNIX (SOLARIS and Linux). Installing under Mac OS X and UNIX Cumulus provides a CONSOLE mode installation for HELIOS Companion Server software. The CONSOLE mode installation can also be started with a graphical user interface. The CONSOLE mode installation guides you through all steps necessary to install the HELIOS Companion Server software. To accept the default values [shown in square brackets] press the Enter key.

15 INSTALLING THE SERVER SOFTWARE 15 To go back to the previous step of the installation process type previous and then press the Enter key. NOTE: If you want to install the HELIOS Filter and AssetProcessor with a Cumulus Server, you have to stop this Cumulus Server before you start the installation. Otherwise it will be stopped by the installer. To install the HELIOS Companion server software: 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. Change to the folder where the installer is stored. 3. Start the CONSOLE mode installation by entering: sh C6HC.bin Under Linux and SOLARIS, a list of available languages will be displayed and you will be asked to enter the number of the language of choice for the installation process. Enter the number of the desired language. The installer language will be changed to the selected language. Under Mac OS X, the installer is provided in English only. For all platforms the installer will install the HELIOS Companion user interface software in all available languages (English, French, German). For a description on how to set the user interface language, see Language of the HELIOS Companion Setup, p When the Introduction is displayed, press the Enter key to continue. The software license agreement is displayed. 5. Read the displayed license agreement. Use the Enter key to page through, then enter y to accept and press the Enter key to continue. The Choose Install Set dialog opens. The different sets you can choose are: 1 Cumulus HELIOS Companion 2 Cumulus HELIOS Filter and AssetProcessor 3 Both of the Listed Sets above

16 16 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE You can either install the HELIOS Companion software or the HELIOS Filter and AssetProcessor or both by entering the corresponding number. If you want HELIOS Companion running on the same computer as the Cumulus Server, select 3. If you want HELIOS Companion running on a different computer from the Cumulus Server, you have to start the installer on this machine and then select 1 to install HELIOS Companion. Next, you have to start the installer on the machine running the Cumulus Server and select 2 to install the HELIOS Filter and AssetProcessor with the Cumulus Server. If you want to install the HELIOS Filter and AssetProcessor with a Cumulus Internet solution, select Enter the number for the desired install set and press the Enter key to continue. The Choose Install Folder dialog opens. 7. 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(s) and press the Enter key to continue. The default folder for HELIOS Companion is: /usr/local/helioscompanion2 We recommend using the default installation folder. The HELIOS AssetProcessor and the HELIOS Filter have to be installed to an existing Cumulus installation. The default directory is /usr/local/cumulus_6_workgroup_server Depending on the Cumulus component, the installation folder could be: Enterprise Server: /usr/local/cumulus_6_enterprise_server Web Publisher Pro: /usr/local/cumulus_6_web_publisher_pro Internet Client Pro: /usr/local/cumulus_6_internet_client_pro The Pre-Installation Summary is displayed. 8. Press the Enter key to start the installation. The installer begins copying files. When the installation is complete, the Install Complete information is displayed.

17 INSTALLING THE SERVER SOFTWARE Press the Enter key to end the installation and exit. The next step is to enter the HELIOS Companion Option serial number and activate your new configuration. For a description on how to do this, see Activating HELIOS Companion, p. 19. However, firstly you should have a look at the following sections that may be relevant to you. Pre-requisite for Locale under Linux and SOLARIS A locale is the definition of the subset of a user's environment that depends on language and cultural conventions (for more information on locale, refer to any UNIX manual). HELIOS Companion requires a UTF-8 locale. We recommend using en_us.utf-8 to avoid any problems with special characters. You may use any other UTF-8 locale but then it either has to be set for the LC_CTYPE of the root user environment or you have to set the LC_CTYPE environment variable of certain HELIOS Companion scripts to this locale. Before you start HELIOS Companion for the first time, check whether a UTF-8 locale is installed for your operating system (the locale can be found in the folder usr/lib/locale). If no UTF-8 locale is installed at all, we recommend installing en_us.utf-8. With en_us.utf-8 installed, HELIOS Companion will use it automatically. If any other UTF-8 locale is installed but not set for the LC_CTYPE of the root user environment, you have to set the LC_CTYPE environment variable to this locale in following HELIOS Companion scripts: start-synchronizer stop-synchronizer resynchronize synchronizer-options These scripts reside in your HELIOS Companion installation folder. Adjust the scripts before you start HELIOS Companion for the first time. Using the HELIOS Service Controller We recommend including the HELIOS Synchronizer with the HELIOS Service Controller. This way it will automatically be started and stopped along with other HELIOS services. You can also use

18 18 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE the HELIOS Service Controller to start and stop individual services manually. To include the HELIOS Synchronizer with HELIOS Service Controller you simply have to add the HELIOS Synchronizer to the HELIOS Service Controller. Use the file companion.prefs (found in the HELIOS Companion installation directory) and install it with the command prefrestore from the bin subdirectory of the HELIOS product directory. Change to the the directory: <HELIOS product directory path>/bin Then enter:./prefrestore <HELIOS Companion installation directory path>/ companion.prefs NOTE: With the file companion.prefs installed, the HELIOS Synchronizer is started after the OPI server and the script server are started. If you have an environment where the script server is not started, you have to adapt this file before you install it. Check your HELIOS documentation for details on the prefrestore command. If you make use of this utility, don t start or stop the HELIOS Synchronizer manually with the HELIOS Companion Setup application, with shell commands or with telnet. NOTE: In case you had to stop HELIOS Synchronizer manually with the HELIOS Companion Setup application, with shell commands or with telnet, use the HELIOS Service Controller to start it again. To uninstall this utility use the command: prefvalue -k Services/companion -d -r Check your HELIOS documentation for details on the prefvalue command, especially for the backup notes. Different HELIOS and Cumulus Server Machines If the HELIOS ImageServer and Cumulus Server are running on different machines, the data volume managed by EtherShare must be mounted by the machine running the Cumulus Server so the Cumulus Server has access to these files in the shared volume and can resolve the references properly. If both servers are running under UNIX, the mount point of the data volume must be identical. If that is not possible, you have to create a symbolic link on the machine where the Cumulus Server resides. You create a symbolic link with: ln -s <directory to be linked> <path and name of link>

19 ACTIVATING HELIOS COMPANION 19 Example: Your HELIOS ImageServer is running under SOLARIS and your shared EtherShare volume is /home/demouser. Your Cumulus Server is running under Mac OS X and the shared EtherShare volume is mounted as /Volumes/demouser. In this case you have to create a symbolic link on the Cumulus Server machine that reflects home/demouser on /Volumes/demouser. Such as: ln -s /Volumes/demouser /home/demouser If both servers are running under UNIX, we recommend using the NFS protocol. NOTE: If you employ one of the Cumulus Internet solutions or Server/ Client asset transfer, you have to adjust the Filesharing.info file. Activating HELIOS Companion Activating the HELIOS Companion Option is a necessary step. If you do not activate the Option, it will not be able to communicate with your Cumulus Edition. So be sure to activate it first, before you start configuring it. Activating a Cumulus Option is simply a matter of registering it with Canto and then entering the license information you receive. The fastest and easiest way to register the Option and obtain your license information is on the World Wide Web. It is very important that you consider the best time to add a new Option. This is because, as soon as you have added the serial number license information of the new Cumulus Option, the status of your entire configuration will default to demo version. (In demo mode, your version will be limited to 5 Clients and 2 catalogs with 50 records each until the license info is entered.) It will remain in demo version until you have entered the current license information text block for your new configuration. 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. We recommend adding Options when no clients are connected. To add a new Option: 1. If it is not open, open the Remote Admin window with your Web Browser. The default URL is:

20 20 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE IP Address:8954/login.html (For a detailed description, see the Remote Admin chapter of your Cumulus Edition s Administrator Guide.) The information on your current license status is displayed on the left side. 2. Click Edit License.The Edit License window opens. It contains the current license information for your entire Cumulus installation. 3. Add the serial number license information you received from Canto or from your distributor, e.g: abc-def-abc-def-ghi-abc 4. Click Submit. 5. 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 if possible, save the form and send it as an attachment: registration@canto.de OR 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 installation. 6. Click Edit License. The Edit License window opens. 7. Replace the text in this window with the current license information text block for your new configuration you received from Canto either on the Web reply page or via e- mail. Be sure to paste in the entire text block (first line ### Begin of Serial Numbers... until last line ### End of Serial Numbers... ). 8. Click Submit to confirm and your Cumulus Option will be activated and ready for use.

21 INSTALLING THE CLIENT SOFTWARE 21 Installing the Client Software The HELIOS Companion Client software can be installed with Cumulus Clients under Windows and Mac OS X. It will install the HELIOS AssetProcessor module and a HELIOS Filter component. The HELIOS AssetProcessor enables a Cumulus Client to convert assets between all formats, color spaces and compression techniques supported by the HELIOS ImageServer system. Rotation, flipping and cropping the assets is also possible. NOTE: To make use of the HELIOS AssetProcessor with a Cumulus Client, the complete Cumulus HELIOS Companion software and the Cumulus Server must be installed on the machine running the HELIOS ImageServer software. This stems from the fact that the Cumulus Server performs the conversion and needs the HELIOS ImageServer software. The HELIOS Companion Client software has to be installed on each workstation running a Cumulus Client where the HELIOS AssetProcessor is to be used. Asset Handling Sets for HELIOS Companion are to be configured. Catalogs for HELIOS Companion are to be configured. Installing under Windows or Mac OS X To install the HELIOS Companion Client software under Windows or Mac OS X: 1. Log on as administrator user for the local machine. 2. If you are installing from a CD, insert the Cumulus CD-ROM into the CD-ROM drive. All software for Mac OS X is located in the sub-directory named Mac OS X. All software for Windows is located in the sub-directory named Windows. 3. Double-click Install Cumulus Options.exe. Double-click Install Cumulus Options.

22 22 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE The installation resources are extracted and you are asked to select a language for the installation process. 4. Select a language and click OK. The installer is launched. 5. When the Introduction screen is displayed, click Next to continue. The software license agreement is displayed. 6. Read the displayed license agreement and activate the I accept the terms of the License Agreement option.

23 INSTALLING THE CLIENT SOFTWARE 23 The Choose Install Set dialog opens. It offers different Cumulus Options that can be installed. 7. Select HELIOS Companion Client. 8. Click Next to continue. The Choose Install Folder dialog opens. 9. Click Choose to choose the installation location of your Cumulus Client. The Browse For Folder dialog opens. Select the folder of your Cumulus Client installation and click OK to return to the previous dialog. 10. Click Next to continue.

24 24 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE The Pre-Installation Summary is displayed. 11. Click Install to start the installation. The installer begins copying files. When the installation is complete, the Install Complete window is displayed.

25 INSTALLING HELIOS COMPANION WITH CUMULUS INTERNET SOLUTIONS In the Install Complete window, click Done to end the installation and close the window. The next time you start your Cumulus Client, the HELIOS AssetProcessor will be active and ready to go. Installing HELIOS Companion with Cumulus Internet Solutions If you want to use the HELIOS Filter and the HELIOS AssetProcessor with a Web Publisher Pro 2.0 or Internet Client Pro 2.0 installation, you have to install these components to the installation folder of your Cumulus Internet solution (e.g. Cumulus 6 Web Publisher Pro or Cumulus 6 Internet Client Pro). The installer to use for this installation depends on the operating system of the machine where your Cumulus Internet solution is running. If your Cumulus Internet solution is running under UNIX: use the console mode installer for the Server software and install the Cumulus HELIOS Filter and AssetProcessor option only. Default installation folder for Web Publisher Pro: /usr/local/cumulus_6_web_publisher_pro Internet Client Pro: /usr/local/cumulus_6_internet_client_pro Mac OS X: you can use the console mode installer for the Server software and install the Cumulus HELIOS Filter and AssetProcessor option only. However, we recommend using the Client software installer. Default installation folder for Web Publisher Pro: /Applications/Cumulus 6 Web Publisher Pro Internet Client Pro: /Applications/Cumulus 6 Internet Client Pro Windows: use the Client software installer. Default installation folder for Web Publisher Pro:../Canto/Cumulus 6 Web Publisher Pro Internet Client Pro:../Cumulus 6 Internet Client Pro For details on how to use the console mode installer for the Server software, see Installing under Mac OS X and UNIX, p. 14, and for details, on how to use the Client software installer, see Installing under Windows or Mac OS X, p

26 26 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE Uninstalling the Server Software This section is for users, who need to remove a HELIOS Companion version 1.x before installing the current version. Uninstalling Cumulus HELIOS Companion is a two step process: Firstly, you have to uninstall the HELIOS Companion components and its Java Classes Runtime environment on the computer that runs the HELIOS ImageServer software. Secondly, you have to uninstall the HELIOS Filter and the HELIOS AssetProcessor from the installation directory of the Cumulus Server (regardless of whether it is the same machine you installed HELIOS Companion on or not). For both steps you use the command: uninstall Before you start uninstalling the Server software you have to stop HELIOS Companion and ensure that nobody is working on the volumes monitored by HELIOS Companion. If you are updating to a new version of HELIOS Companion, we recommend installing the new version first and then copying the conf folder containing your current Synchronize Setup configuration files to your new installation. Test your new installation before you uninstall your old HELIOS Companion version. If you had your HELIOS Synchronizer included with the HELIOS Service Controller, check this for your new installation. (For details on how to include, see Using the HELIOS Service Controller, p. 17.) Uninstalling HELIOS Companion Version 1.x under Mac OS X To uninstall HELIOS Companion version 1.x under Mac OS X, the first step is as follows: 1. On the computer running the HELIOS Companion, open the Terminal application (via Go Applications Utilities). A shell environment is started. 2. Change your identity to root (enter su for super user and then the password). The command prompt for root is displayed: root#

27 UNINSTALLING THE SERVER SOFTWARE At the command prompt, change to the HELIOS Companion folder. (Default directory is /usr/local/helioscompanion.) 4. Enter the command: sh uninstall A menu is displayed. 5. Enter the number for the menu option Uninstall Cumulus HELIOS Companion. The HELIOS Companion components will be deleted. NOTE: The configuration and log files will not be deleted. If you want to remove them from your computer you have to do that manually. 6. Enter the number for the menu option Uninstall Cumulus Java Classes Runtime. NOTE: HELIOS Service Controller If you have the HELIOS Synchronizer included with the HELIOS Service Controller, use this command to uninstall: prefvalue -k Services/companion -d -r To uninstall HELIOS Companion version 1.x under Mac OS X, the second step is as follows: 1. On the computer running the Cumulus Server, open the Terminal application (via Go Applications Utilities). A shell environment is started. 2. Change your identity to root (enter su for super user and then the password). The command prompt for root is displayed: root# 3. At the command prompt, change to the Cumulus Server folder. Default directory with Cumulus 5 is: /usr/local/cumulus5 Default directory with Cumulus 6 is: /usr/local/cumulus_6_workgroup_server or /usr/local/cumulus_6_enterprise_server 4. Enter the command: sh uninstall A menu is displayed.

28 28 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE 5. Enter the number for the menu option Uninstall HELIOS Filter, HELIOS Processor. This process will stop the Cumulus Server. 6. Restart the Cumulus Server after the uninstall has been successfully performed. Uninstalling HELIOS Companion Version 1.x under UNIX To uninstall the HELIOS Companion version 1.x under UNIX, the first step is as follows: 1. On the computer running HELIOS Companion, log in as the Administrator (log in as root) and open a UNIX shell. 2. At the command prompt, change to the HELIOS Companion folder. (Default directory depending on the platform SOLARIS: /opt/helioscompanion, Linux: /usr/local/helioscompanion) 3. Enter the command: sh uninstall A menu is displayed. 4. Enter the number for the menu option Uninstall Cumulus HELIOS Companion. The HELIOS Companion components will be deleted. NOTE: The configuration and log files will not be deleted. If you want to remove them from your computer you have to do that manually. 5. Enter the number for the menu option Uninstall Cumulus Java Classes Runtime. NOTE: HELIOS Service Controller If you have the HELIOS Synchronizer included with the HELIOS Service Controller, use this command to uninstall: prefvalue -k Services/companion -d -r

29 UNINSTALLING THE SERVER SOFTWARE 29 To uninstall HELIOS Companion version 1.x under UNIX, the second step is as follows: 1. On the computer running the Cumulus Server, log in as the Administrator (log in as root) and open a UNIX shell. 2. At the command prompt, change to the Cumulus Server folder. Default directory with Cumulus 5 depending on the platform SOLARIS: /opt/cumulus5, Linux: /usr/local/cumulus5) Default directory with Cumulus 6 is: /usr/local/cumulus_6_workgroup_server or /usr/local/cumulus_6_enterprise_server 3. Enter the command: sh uninstall A menu is displayed. 4. Enter the number for the menu option Uninstall HELIOS Filter, HELIOS Processor. This process will stop the Cumulus Server. 5. Restart the Cumulus Server after the uninstall has been successfully performed.

30 30 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE

31 This chapter covers the facts and details you need to know for configuring and operating your Cumulus HELIOS Companion. In it, you will learn how to set up monitored folders and how to configure Asset Handling Sets for these folders and how to add new file formats based upon the Generic Filter. The last section of this chapter describes how to use the HELIOS AssetProcessor with a Cumulus Client under Windows or Mac OS or with a Cumulus Internet solution or an external application. Use

32 32 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE The HELIOS Synchronizer The HELIOS Synchronizer can run as a background process on the HELIOS ImageServer machine. If it is active, all files newly applied to the monitored folders are automatically cataloged to the assigned Cumulus catalogs. Records as well as automatic directory categories are created. If files are changed, renamed, moved, or deleted, the related Cumulus records will be updated accordingly. If the names of subfolders in the monitored folders are changed, the names of the corresponding automatic directory categories are also changed. NOTE: HELIOS Volumes containing the monitored folders have to be configured to UTF-8. You can configure the HELIOS Synchronizer via the HELIOS Companion Setup application, via shell commands or via telnet. The most convenient way is to use the HELIOS Companion Setup (see The HELIOS Companion Setup, p. 40). However, the shell command scripts can be included in your automation files and telnet allows a remote administration of the HELIOS Synchronizer. You can login remotely and edit the configuration files and then have them activated via telnet. The shell and telnet commands as well as the configuration files are described below, but for an overview on the configuration possibilities you can skip the next pages and resume reading from page 40 where the section on the HELIOS Companion Setup starts. The HELIOS Synchronizer can also be started and stopped manually with the HELIOS Companion Setup application, with shell commands or with telnet. However, starting and stopping it automatically via the HELIOS Service Controller is recommended. (See Using the HELIOS Service Controller, p. 17, for details.) Configuring via Shell Commands The shell commands provided with HELIOS Synchronizer can be found in your HELIOS Companion installation directory. The following shell commands can be used: start-synchronizer.sh starts the HELIOS Synchronizer NOTE: You must be a superuser to perform this command. stop-synchronizer.sh stops the HELIOS Synchronizer NOTE: You must be a superuser to perform this command.

33 THE HELIOS SYNCHRONIZER 33 resynchronize.sh This command accepts arguments: <Synchronize Setup name> synchronizes the folder defined in the Synchronize Setup -recs <Synchronize Setup name> resynchronizes only the records of the catalog defined in the Synchronize Setup. The records will be removed or renamed and (re)assigned to the automatic directory categories -files <Synchronize Setup name> resynchronizes only the files in the folder defined in the Synchronize Setup. New records are added to the catalog defined in the Synchronize Setup and may be the corresponding automatic directory categories if they were not included in the catalog. -cats <Synchronize Setup name> resynchronizes only the automatic directory categories of the catalog defined in the Synchronize Setup. If any file system subfolders (of the watched folder) were deleted the corresponding automatic categories will be deleted as well. -folders <Synchronize Setup name> adds only new automatic directory categories, if new folders are found on the volume. These categories will be empty. NOTE: The arguments -recs, -files, -cats, and - folders can be combined; e.g. resynchronize.sh -recs -files <Synchronize Setup Name> resynchronize -all resynchronizes all monitored folders IMPORTANT NOTE: All Synchronize Setups must be stopped when you start any resynchronizing process we even recommend stopping the HELIOS Synchronizer. Before you start any resynchronizing process, make sure that the contents of the included volumes and folders will not change during the process. Furthermore, the contents of the included volumes and folders should not be changed before the the HELIOS Synchronizer and all Synchronize Setups are started again. synchronizer-options.sh opens the HELIOS Companion Setup application (For details on how to use the HELIOS Companion Setup application see The HELIOS Companion Setup, p. 40.) How to configure the HELIOS Synchronizer via telnet, see below.

34 34 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE Configuring via Telnet You can connect to a started HELIOS Synchronizer. To connect to the HELIOS Synchronizer via telnet: 1. Start a telnet session. 2. Establish a telnet session to the machine running the HELIOS server using a telnet port number (default: 9090). For example: under Mac OS X: open localhost 9090 and under other UNIX machines: telnet localhost 9090 whereas localhost is the machine name and 9090 is the default port number of the HELIOS Synchronizer telnet service. NOTE: The telnet port number can be configured in the HELIOS Synchronizer configuration file HeliosSynchronizer.cf located in../helioscompanion2/etc/helioscompanion/config) 3. Enter the commands listed below for the functions you want to perform. 4. Enter quit to close the connection to the HELIOS Synchronizer. Available commands are: help lists the available commands setdelay <delay> sets the delay for HELIOS Synchronizer (the time a file has to remain unchanged in the monitored folders before the automatic cataloging starts). Enter the value in seconds. shutdown stops the HELIOS Synchronizer quit closes connection to the HELIOS Synchronizer startwatcher <Synchronize Setup name> starts the monitoring of the specified Synchronize Setup

35 THE HELIOS SYNCHRONIZER 35 stopwatcher <Synchronize Setup name> stops the monitoring of the specified Synchronize Setup status prints information about the synchronizer queue Sync started: whether the synchronizer is started or stopped Last processed event: the last event from the queue that was processed Queue size: The size of the queue (events not yet processed) the two numbers should be equal (for internal purposes only) status -v: prints verbose info (similar to the single status command but it also lists the content of the queues) NOTE: Debugging For debugging purposes only, the information on events appears as follows: Operation (file name)[xxx,#x,p/np,d/nd] xxx is the number of seconds elapsed since the event occurred #x is the number of Synchronize Setups to which this event has been sent P or NP indicates if the event was processed or not D or ND indicates if the event was deleted or not status <Synchronize Setup name> prints the status of the specified Synchronize Setup listwatchers lists all managed Synchronize Setups addwatcher <Synchronize Setup name> [- p <password>] adds the specified Synchronize Setup to the list of managed Synchronize Setups (The *.conf and *.opts files for the Synchronize Setup must exist. Only if the *.conf defines a registered user access, you have to enter the corresponding password. The addwatcher command will add the encrypted version of this password to the *.conf file you can only add a new password this way but not replace an existing one.) (For details on the *.conf and *.opts configuration files, see Working with the Configuration Files, below.)

36 36 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE removewatcher <Synchronize Setup name> removes the entered Synchronize Setup files from the file system (*.conf and *.opts) resynchronize <Synchronize Setup name> resynchronizes the monitored folder of the entered Synchronize Setup resynchronizeall resynchronizes all monitored folders IMPORTANT NOTE: All Synchronize Setups must be stopped when you start any resynchronizing process. Before you start any resynchronizing process, make sure that the contents of the included volumes and folders will not change during the process. Furthermore, the contents of the included volumes and folders should not be changed before the the HELIOS Synchronizer and all Synchronize Setups are started again. pausewatcher <Synchronize Setup name> interrupts the watching process for the Synchronize Setup and lets you do maintenance work on the assigned catalogs or servers. The queue is continuously updated so working on the file system can go on. However, this interruption should not last too long as the queue will then become much too large. We recommend using this function only when there is not much traffic on the machine or for a short period. resumewatcher <Synchronize Setup name> resumes the interrupted watching process for the selected Synchronize Setup again. Events in the queue will be processed. Working with the Configuration Files The HELIOS Companion configuration files are stored in text format. This way they can easily be modified with a simple text editor even from remote machines. They can be found in the following subdirectory of your HELIOS Companion installation:../helioscompanion2/etc/helioscompanion/config There are two different types of configuration files. The file called HeliosSynchronizer.cf is a special file that exists once and contains the properties of the HELIOS Synchronizer. Files with extension.conf exist for each Synchronize Setup and contain the properties of a Synchronize Setup (example: Sales.conf ).

37 THE HELIOS SYNCHRONIZER 37 The Helios Synchronizer Configuration File The HeliosSynchronizer.cf file contains the properties of the HELIOS Synchronizer: Delay Seconds to wait before the automatic cataloging is started. Example: Delay=30 Port Port number of the HELIOS Synchronizer telnet service. Example: Port=9090 CumulusToolTimeout Time out for the Cumulus Tool in seconds (default 15 min.). If you leave this default or even increase it, the time needed for cataloging seems to take longer but avoiding the time out for the cataloging process for a large EPS file means that this file will be cataloged in sequence (even if this takes up to 15 min.). CatalogPollInterval Space of time between the polling attempts in seconds. Polling the catalog avoids being disconnected by the server. Note that a short polling interval can slow down performance if you have many Synchronize Setups running. Synchronize Setup Configuration Files A file with the extension.conf contains the properties of the Synchronize Setup with this name (example: Sales.conf). The parameters are: FolderName Name of the Synchronize Setup. This name must match the file name of the.conf file) Example: FolderName=Sales Folder Full path and name of the folder to be monitored. Example: Folder=/usr/local/helios/sales_dir Catalog Name of the catalog the assets are to be added to. NOTE: The catalog must be administered by the Cumulus Server that means listed in the Catalog Access window. Example: Catalog=myCatalog Guest Guest access (=true) or not. Example: Guest=true