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 -> [email protected] Rest of World -> [email protected] 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: [email protected] 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

38 38 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE Log Logging activated (=true) or not Example: Log=false Server Name or IP address of the Cumulus Server. Example: Server=localhost Password Displays the encrypted password for user access. Do not edit this value manually. If you use the telnet addwatcher [- p <password>] command, the entered password will be added encrypted. (If Guest is set to true, this parameter has no value.) User Name of a registered Cumulus user. (If Guest is set to true, this parameter has no value.) Example: User=Companion StartAuto Automatic start of watching or not. Example: StartAuto=true Subfolders Watching includes subfolders or not. Example: Subfolders=true PathExcludePattern Files can be excluded from being cataloged by using a regular expression pattern on the full pathname. This regular expression conforms with Perl 5. The default excludes files that should never be cataloged (and were not cataloged with HELIOS Companion 1.x). Do not change this default. If you want to exclude more files append your exclusions to the default. Note that all exclusions have to be in one line; use the disjunction: For more information on regular expressions, we recommend: TypeCreatorExcludePattern Files can be excluded from being cataloged by using a regular expression pattern on file type and creator. This regular expression conforms with Perl 5. The default is empty. The pattern consists of 8 characters. The first 4 characters are the Mac OS file type and the last 4 characters refer to the creator. Example: TIFF8BAM To connect the patterns with or use:

39 THE HELIOS SYNCHRONIZER 39 You may use use. (period) as wild card for one character. For example: The expression to exclude all files of the Mac OS file type TIFF is TIFF... The expression to exclude all files created by XXXX is...xxxx NOTE: Escaped Characters with Regular Expressions! A number of characters have special meanings to regular expressions. A symbol with a special meaning can be matched by a pattern, but to do so it must be prefixed with a backslash. This includes the backslash character itself: to match one backslash in the target, your regular expression should include \\. A colon must not be prefixed. To check your regular expression pattern included in a. conf file, change any one of the properties of the corresponding Synchronize Setup in the Watch Folder Properties window and then save this change. When opening the. conf file again check whether your regular expression pattern is correct. Creating a New Synchronize Setup.conf File If you want to create a new.conf file for a new Synchronize Setup, it is recommended to copy an existing one and name it as the new Synchronize Setup and change the Folder and FolderName parameters accordingly. Logging Actions Each Synchronize Setup can have its own log file(s). The log files log all HELIOS Synchronizer actions. They are named using the name of the Synchronize Setup and a number. Only one log file is written per session. If a session lasts longer than one day, a new log file will be created (indicated by increasing numbers: 0-6; 0 for Sunday, 1 for Monday and so on). If a session lasts longer than a week, the first log file will be overwritten, then the second one on the next day and so on. Take this into account for all backup routines. The log files are located in the following subdirectory of your HELIOS Companion installation:../helioscompanion2/var/log/helioscompanion

40 40 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE Each action recorded in the log files consists of a single line with the following tab-separated strings: Date The date of the action in the format YYYY-MM-DD. Time The time of day of the action in the format HH-MM-SS using 24-hour clock. Action This is A for added files, U for updated records, D for deleted records, and E for errors. ID The ID of the record affected or an error message for error. Path The full path name of the file affected (in case of renaming: the new path). The HELIOS Companion Setup The HELIOS Companion Setup application manages the Synchronize Setups for the HELIOS Synchronizer. You can also use HELIOS Companion Setup application to start and stop the HELIOS Synchronizer and to invoke resynchronization processes. Language of the HELIOS Companion Setup The user interface of the HELIOS Companion Setup application is available in three languages: English, French and German Under Linux and SOLARIS, the user interface language of the HELIOS Companion Setup depends on the language set for the machine that the software is running on. Under Mac OS X, the HELIOS Companion Setup application will be started in the language that is set in the Language Settings of the System Preferences if you start it via the Applications folder. If the language set in the Language Settings is not available with HELIOS Companion, English is chosen as default. If you start the HELIOS Companion Setup application employing the synchronizeroptions.sh shell script and you want any other language than English, you have to change the script. To have a French version change the variable to: USER_LANGUAGE=fr To have a German version, change the variable to: USER_LANGUAGE=de

41 THE HELIOS COMPANION SETUP 41 Starting the HELIOS Companion Setup Application To start the HELIOS Companion Setup application under Mac OS X: 1. Navigate to the Applications folder. 2. Launch the HELIOS_Companion2_Setup. To start the HELIOS Companion Setup application under Linux or SOLARIS: 1. Navigate to the installation directory of the HELIOS Companion. 2. Enter the command: sh synchronizer-options.sh The HELIOS Companion Setup window has two sections: Preferences Watch Folders And it provides buttons to start and stop the entire HELIOS Synchronizer. Preferences In the Preferences section you define the time a file has to remain unchanged in the monitored folders before the HELIOS Synchronizer will start the automatic cataloging. Watch Folders In the Watch Folders section you manage the Synchronize Setups and define their properties. You can also start and stop the monitoring for selected Synchronize Setups. And in case of any disturbance you can evoke a resynchronizing run for a selected Synchronize Setup or for all Synchronize Setups. See Overview: The HELIOS Companion Setup Window, below, for details., for an overview of all options available from this window.

42 42 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE Overview: The HELIOS Companion Setup Window The HELIOS Companion Setup window has two sections that provide access to each of its options. The options that are set from this window affect the HELIOS Synchronizer behavior. Watch Folders 1. Displays a list with the names of the Synchronize Setups (set of properties defined for a certain watched folder). Green marks a Synchronize Setup that is started and active. Red marks a Synchronize Setup that is not started. Yellow marks a Synchronize Setup that is paused or started but not properly running: e.g. the configured catalog is not available because the Cumulus Server is not started or the HELIOS Companion licensing is not correct. TIP: To update the markings just toggle to the Preferences section and back again. 2. Opens a dialog to set up a new watched folder. 3. Open the properties for the selected Synchronize Setup. NOTE: Only available for editing, if the monitoring is stopped. 4. Removes the selected Synchronize Setup. 5. Starts the monitoring for the selected Synchronize Setup. (Only available for a new or stopped Synchronize Setup.) 6. Stops the monitoring for the selected Synchronize Setup. (Only available for a started Synchronize Setup.) 7. Interrupts the watching process for the selected 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. As the queue is stored in the RAM the possible duration depends on the machine). We recommend using this function only when there is not much traffic on the machine or for a short period. (Only available for a started Synchronize Setup.) 8. Resumes the interrupted watching process for the selected Synchronize Setup again. Events in the queue will be processed. (Only available for a pausing Synchronize Setup.) 9. Starts a resynchronize process for the selected Synchronize Setup. (How the resynchronize process works is defined in the Resynchronize Option in the Preference section of this window.) 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 Starts a resynchronize process for all Synchronize Setups. (How the resynchronize process works is defined in the Resynchronize Option in the Preference section of this window.) NOTE: Resynchronizing will always synchronize the catalogs with the current status of the monitored folders. Any manually made changes concerning automatic directory categories in the catalogs will be overwritten. 11. Starts HELIOS Synchronizer. NOTE: If you have included HELIOS Synchronizer in the HELIOS Service Controller, don t start or stop it manually with the HELIOS Companion Setup application. In case you had to stop it manually, use the HELIOS Service Controller to start it again. 12. Stops HELIOS Synchronizer

43 THE HELIOS COMPANION SETUP 43 Preferences 1. Defines the seconds a file has to remain unchanged in the watched folder before the HELIOS Synchronizer starts the automatic cataloging. (Default: 30 seconds If you have more than 20 Synchronize Setups running with your Cumulus installation we recommend increasing the value for delay to 90 seconds.) 2. Activates logging. 3. Defines the file that contains the log entries. 4. Opens a dialog for selecting a log file. 5. Activates a limitation for the log file size. 6. The Resynchronize Options define how the resynchronize process works. The options can be combined. By default all four options are activated. 7. The resynchronize process will go through the catalog directory categories: if the corresponding folder does not exist, the category will be removed from the catalog(s). 8. The resynchronize process will check the volume folders: If there is a folder without corresponding catalog categories, it will be created. 9. The resynchronize process will check all the catalog records: If the corresponding file is removed from the disk, the record is removed from the catalog and if a file has been moved, the record will also be moved & renamed in the corresponding directory category. 10. The resynchronize process will check the files of a volume (defined in the selected Synchronize Setup) or all volumes defined in Synchronize Setups: If the corresponding record does not exist, it will be created (with the corresponding directory category), existing records are also updated if the file content has changed. Watch Folder Properties 1. Displays the name of the Synchronize Setup; also used to enter the name. 2. Displays path and name of the watched folder; also used to enter path and name. 3. Opens a browse dialog to set or change the watched folder. 4. If activated, all subfolders of the watched folder will be watched as well and files stored in one of the subfolders will also be cataloged. TIP: The decision whether to include subfolders or create new Synchronize Setups for subfolders depends on your working environment. In most cases including the subfolders will result in better performance but will block the possibility to take any advantage of multiprocessing. NOTE: The HELIOS Companion only deals with the high resolution files. Therefore any Layout subfolders will be ignored. 5. If activated, the watching will be started automatically when the HELIOS Synchronizer is started (and as soon as this dialog will be closed). 6. If activated, a log file logging all cataloging actions will be written. (For more details see Logging Actions, p. 39.) 7. Displays name or IP address of the Cumulus Server (and optionally the port number); also used to enter name or IP address of the Cumulus Server (and if necessary the port number) Activates the defined preferences. 12. Starts the HELIOS Synchronizer. NOTE: If you have included HELIOS Synchronizer in the HELIOS Service Controller, don t start or stop the HELIOS Synchronizer manually with the HELIOS Companion Setup application. In case you had to stop it manually, use the HELIOS Service Controller to start it again. 13. Stops the HELIOS Synchronizer Select either Guest or Registered User. 9. Displays the user name, if connecting as a registered user; also used to enter the user name. 10. Used to enter the user password, if connecting as a registered user. 11. Displays the name of the catalog that is to manage the files of the watched folder. 12. Opens a browse dialog to select the catalog. 13. Displays the name of the Asset Handling Set used for cataloging. 14. Opens a browse dialog to select an Asset Handling Set. For information on Asset Handling Sets to be used see Asset Handling Sets for HELIOS Companion, p Cancels all changes made in this windows after it was last saved. 16. Saves and activates the properties displayed in the window

44 44 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE Creating a Synchronize Setup A Synchronize Setup assigns a monitored folder to a Cumulus catalog including a catalog user and individually defined cataloging options. TIP: If you are just about to start working with HELIOS Companion for the first time, you should first read the Getting Started section starting on page 63. To create a Synchronize Setup: 1. Open the HELIOS Companion Setup window. 2. Click Watch Folders. 3. Click the New button. This opens the Watch Folder Properties window. 4. Enter a name for the Synchronize Setup in the field Name. The name of a Synchronize Setup must not contain special characters. The following characters are allowed: a-z, A-Z, 0-9, and +, -, 5. Enter the path of the folder to be monitored in the field Folder or click the Browse button to select a folder. Under Folder Options, you can define the handling of the monitored folder. Enable Watch Subfolders, if you want all subfolders of the watched folder to be watched as well. All files stored in one of the subfolders will also be cataloged. TIP: The decision whether to include subfolders or create new Synchronize Setups for subfolders depends on your working environment. In most cases including the subfolders will result in better performance but will block the possibility to take any advantage of multiprocessing. NOTE: The HELIOS Companion only deals with the high resolution files. Therefore any Layout subfolders will be ignored. Also all OPI AssetStore settings will be ignored. Enable Start Watching Automatically, if you want the watching to be started automatically when the HELIOS Synchronizer is started.

45 THE HELIOS COMPANION SETUP 45 Enable Enable Logging, if you want log files written for the Synchronize Setup. (For more details see Logging Actions, p. 39.) Under Connect To, you can define the catalog and the catalog user for the automatically cataloged files from the monitored folder. 6. Enter the name or IP address of the Cumulus Server into the Server field. (If necessary, you can also enter the port number in this field: IP address : port number) 7. Select either Guest or Registered User access to the Cumulus Server. If selecting guest access, you don t need a user name or password. NOTE: Do not use the Cumulus Administrator s login as registered user because a Cumulus Administrator is dismissed when a second Cumulus Administrator logs on. 8. If connecting as a registered user, enter the Cumulus user name into the Name field. 9. If connecting as a registered user, enter the user password into the Password field. 10. Enter the name of the catalog that you want to manage the files of the watched folder with into the Catalog field or click the button to select a catalog. 11. Enter the name of the Asset Handling Set to be used for cataloging the files of the watched folder into the Asset Handling Set field or click the button to select an Asset Handling Set. (For information on Asset Handling Sets to be employed with HELIOS Companion, see Asset Handling Sets for HELIOS Companion, p. 49.) 12. Select the Asset Handling Set to be used for cataloging with the Synchronize Setup and click OK. 13. Click OK to save and activate the Synchronize Setup. TIP: Create a Companion User If you create a special user for HELIOS Companion and define this user within all Synchronize Setups, you can easily find all automatically cataloged assets: You simply search for all assets cataloged by this user.

46 46 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE Pre-filling Records In addition to the information captured by Cumulus while cataloging, record fields can be pre-filled while cataloging and updating records. A XML file containing the values has to be stored in the monitored folder. The record fields of all files cataloged from this folder or its subfolders will be pre-filled. Multiple values are supported. For files cataloged and residing in subfolders, the values of the pre-fill XML file residing in the same folder will be taken together with the values of any pre-fill XML files in folders above. When cataloging a file the information to be stored in the record fields will first be filled with the information be captured by the filters and then with the information from the XML files. Note that this is only possible if the Field Linking for the fields to be pre-filled is set to Read All under When Adding Assets and When Updating Assets. If Read One is activated the values from the XML file are taken only in case the filters did not capture any information. The name of the XML file used for pre-filling is:.cumulusprefill.xml Note that a file which has a name beginning with the period (.) character is invisible under UNIX and might be invisible under Mac OS X check your file display options. An example file containing the XML structure to be used can be found in your HELIOS Companion installation folder. Use this file as a template. Change it according to your needs and save it to the monitored folder where you want the files to be cataloged with the pre-filled values. The file itself will not be cataloged. TIP: Under Windows you cannot rename a file to a name beginning with the period (.) character but you can use the Save As function of your editor to save a file which has a name that starts with the period character. The XML file contains the entries for the fields to be pre-filled. In the structure <Field> <Name></Name> <Value></Value> </Field> you have to enter the name of the field (between <Name></Name>) you want have pre-filled and the value that will be used (between <Value></Value>).

47 PRE-FILLING RECORDS 47 You may also identify a field by its UID (Unique Identifier). Then the structure is <Field> <UID></UID> <Value></Value> </Field> and you have to enter the UID of the field (between <UID></UID>) The value you enter for a String field may have more than one line. These additional lines must not be indented if you use an editor that does not support XML structure, ensure that no tabs or spaces are included that may lead to pre-filled values you don t want. You can even enter an empty line to separate text sections. Information on values for specific fields: Field Type String List Field To use a term of a String List field as a pre-filling value, you have to enter the ID of the term (to be found on the String List Editor tab of the Field Properties window). Record Field: Categories By entering values for the Categories field you assign the cataloged asset to the category. However, you can also create new entries on the Category tabs. Include the $ sign to identify the category tab and use the colon (:) for setting hierarchal levels. For example: <Field> <Name>Categories</Name> <Value>$Categories:Animals:Insects</Value> </Field> will create a subcategory Insects nested in a category named Animals in the Categories tab and assign the record to this category. If you want a colon (:) to be part of a category name, you have to enter a colon before the colon (e.g.: 1::2 for a category named 1:2).

48 48 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE Example of a.cumulusprefill.xml file: In this example, the Notes field will be filled as follows: My pre-filled notes second line of my pre-filled notes my pre-filled notes after an empty line To edit this file you should use an XML supporting editor. If you do not use an XML supporting editor, you must ensure that the syntax structure is correct. The HELIOS Filter The HELIOS Filter accesses the current HELIOS ImageServer version installed on your system (Mac OS X or UNIX). So the supported asset formats always depend on the HELIOS ImageServer version and options (e.g. PDF HandShake) currently installed on your system. For more information about supported formats, see your HELIOS ImageServer documentation. The HELIOS Filter supports XPPV files for Adobe InDesign and QuarkXPress.

49 THE HELIOS FILTER 49 NOTE: Additional Record Field The HELIOS Filter retrieves the HELIOS Open Image information and can store it in a special record field named HELIOS Image Information. This field is not included in catalogs by default. To include this information in a catalog, you have to add this record field named HELIOS Image Information provided by the HELIOS Filter to the Record Fields of the catalog in the Catalog Settings of the Properties dialog before cataloging documents. (For information on how to do this, see "Adding a Record Field" in the Administrator Guide.) Asset Handling Sets for HELIOS Companion The Asset Handling Sets selected for a HELIOS Companion Synchronize Setup affects how Cumulus deals with your assets during the automatic cataloging processes. You can assign an Asset Handling Set individually to each Synchronize Setup. Asset Handling Sets in general are described in the Client User Guide. The following provides specific information on Asset Handling Sets to be used with HELIOS Companion. For configuring the Asset Handling Sets you employ a Cumulus Client that was updated with the current HELIOS Companion Client software. Connect to the Cumulus Server as a user who has the appropriate rights for changing or creating Asset Handling Sets. We recommend defining specific Asset Handling Sets to be used with HELIOS Companion. To create a new Asset Handling Set: 1. Select Cumulus / Edit Preferences. 2. Click Asset Handling Sets. 3. Under Set, select the set to use as a basis for the new one. 4. Click the Copy button. The Set Name dialog opens. 5. Enter a name for the new set and then activate the Share Set option to make it available to other users. 6. Click OK.

50 50 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE 7. Define the new set. For information on the special configurations for Asset Handling Sets used with HELIOS Companion, see below. 8. Click Apply to save your changes or click OK to save your changes and close the Preferences window. Special configurations for Asset Handling Sets used with HELIOS Companion have to be made on the following tabs: Cataloging Tab Under When Cataloging the option Add and Update must be activated. Assets Formats Tab On this tab the entries of the HELIOS Filter are of special interest. The HELIOS Filter is only running on the machine where HELIOS Synchronizer is installed. As you configure the Asset Handling Sets with a Cumulus Client on another machine the entries for this filter may not work when employed for this Client machine. However, set up the Asset Handling Set as you want it to be used on the machine where HELIOS Synchronizer is installed. For most installations, we recommend that the HELIOS Filter entry for the EPS format should have a lower entry number than the Cumulus EPS Filter. NOTE: HELIOS PDF HandShake For HELIOS PDF HandShake, the HELIOS Filter provides an additional entry for the PDF format. This filter entry should have a lower entry number than the Cumulus PDF Filter. HELIOS PDF Hand- Shake must be installed on the machine running the HELIOS Synchronizer in order to make use of this format. Modules Tab Make sure that the Unix File System AssetStore is activated for the Asset Handling Set. Adding Own Formats Cumulus can catalog any digital asset. If Catalog Unknown Formats (below the list of asset formats) is activated and Cumulus encounters an asset for which no specific filter is available, then it

51 THE HELIOS FILTER 51 uses the Generic Filter. You can expand the Cumulus Generic Filter s capabilities to create your own formats. For assets that don t have a specific format provided by Cumulus, you can define a thumbnail for the asset format by using the Generic Filter. If you use formats that you ve created on your own, check the Canto Website from time to time to see if a filter that supports this format has been developed and is one that you could use. To set up a new format: 1. Select Cumulus / Edit Preferences and then Asset Handling Sets. 2. Click on the Modules tab and then on the Filter icon to see the list of installed filters. 3. Select the Generic Filter in the list and click Properties. The window to set up the properties for the new format opens. 4. Enter your format s file name extension in the File Extension field. Do not enter the period. 5. Type a name for the format in the File Format field. If your system is aware of the asset type, its name may be entered for you. 6. Enter the Mac OS file type in the Mac OS File Type field. The file type will always be 4 characters in length. 7. Choose the thumbnail you want displayed for the asset. You can use either the asset s Finder / Windows Explorer icon or an image that you specify. If you want to specify a thumbnail image to be used for your assets of your format, activate the Static Thumbnail option, which enables the Browse button. Then click the Browse button to select an image. You can use any JPEG file as a static thumbnail. The image is resized, if necessary, and pasted into the thumbnail image area. Each asset cataloged with this format will use this image as its thumbnail. 8. Click OK to save your new format.

52 52 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE To have the new format available for Asset Handling Sets, you have to add it to the Asset Formats list: 1. Click on the Asset Formats tab and click Add.The Add Format dialog opens. 2. Expand the Generic Filter entry by clicking on the plus sign on its left. The formats available are displayed. 3. Select the format you want to add and click OK. New formats are placed at the end of the list by default. Use the arrow buttons to the right of the list to move the format, if necessary. The 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. Considering the ICC (International Color Consortium) profile you can select different color spaces and compressions supported by the OPI system. Rotation, flipping and cropping are also possible. The conversion produces a new file that can be stored wherever you want. The HELIOS AssetProcessor can be used with Cumulus Clients under Windows or Mac OS X as well as with Cumulus Web Publisher Pro or Internet Client Pro and additional EJaPs or applications based on the Cumulus Java Classes. Using the AssetProcessor from a Cumulus Client The process to use the HELIOS AssetProcessor with a Cumulus Client is simple: 1. Launch a Cumulus Client application and open the catalog managing the asset(s) to be converted. 2. Select the record(s) representing the asset(s) to be converted.

53 THE HELIOS ASSETPROCESSOR 53 NOTE: If you have selected multiple assets' records, the chosen settings will be applied to convert all selected assets. 3. Select Asset Convert To. 4. If you have activated multiple AssetStores, select the respective AssetStore to manage the converted destination asset. 5. Choose a destination for the converted asset(s). 6. If you have activated multiple Asset Converters, select the HELIOS AssetProcessor as Asset Converter. 7. Select the parameters for the conversion. Under Image Size you can decide whether to use pixel dimensions or resolution. If you choose Pixel Dimensions, you can enter values for width and height (the proportions will be constrained). To enter values as percentages of the current dimensions, choose Percent as the unit of measurement. If you choose Resolution, you can enter a value in pixel per inch or per centimeter just choose the desired unit of measurement. Under Crop Area, enter values for cropping the asset image left-top and right-bottom. You can choose differ-

54 54 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE ent measurement units. To enter values as percentages of the original asset s dimensions, choose Percent as the unit of measurement. Under Format, you can select the file format, compression technique and color space for the converted asset. Under Orientation, you can select to flip or/and rotate the entire asset. Horizontal to flip the image horizontally, along the vertical axis. Vertical to flip the image vertically, along the horizontal axis. 0 not to rotate the asset 180 to rotate the asset by a half-turn 90 to rotate the asset clockwise by a quarter-turn 270 to rotate the asset counterclockwise by a quarterturn To use an assigned ICC (International Color Consortium) profile for the conversion, select Use ICC Profile. If you want to embed an ICC profile with the converted asset, select Include ICC Profile. Then you must select an ICC profile from the ICC Profiles drop down list. This list displays all ICC profiles that are available for the selected color space on your HELIOS ICC Profile volume. To load or update this list click the Update ICC Profile List button. NOTE: Combination of Parameters Not all combinations make sense and will work. For details on combing parameters see the description of the layout command in the HELIOS ImageServer documentation. 8. Click OK. The selected asset(s) will be converted and stored under the name of the original asset in the selected destination. The HELIOS AssetProcessor will automatically add the correct file extension to the file name. This process may last quite a long time as it invokes the HELIOS Layout command.

55 THE HELIOS ASSETPROCESSOR 55 Logging HELIOS AssetProcessor Parameters The HELIOS AssetProcessor logs all parameters of a conversion that are transferred to the HELIOS ImageServer in a log file. This log file is called HeliosProcessor. log. It contains the parameters of the conversions of the current day only, as it will be recreated every day (at 00:00 h). When working with a Cumulus Edition, it is stored in the var/log subdirectory of the Cumulus Server installation directory. When working with Web Publisher Pro, it is stored in the var/log subdirectory of the Cumulus Java Classes installation directory. Using the AssetProcessor from Cumulus Internet Solutions or Additional Applications The HELIOS AssetProcessor can also be used with one of the Cumulus Internet solutions (Web Publisher Pro or Internet Client Pro) and with additional EJaPs or applications based on the Cumulus Java Classes. Employ the Cumulus User Manager to set up a rendition that uses the HELIOS AssetProcessor. An example for using the HELIOS AssetProcessor in a rendition is provided with the Cumulus User Manager: When you set up a new rendition, you have to choose the UID for the HELIOS AssetProcessor in the field Rendition Module. This is: {C69AA321-68D2-11D6-B BAEBA6C7} When editing the field Rendition Parameter you can use the following parameters: Format=<value> (possible values as string: TIFF, JPEG, BMP, EPSF, PNG, PICT,..CT, 8BPS) Compression=<value> (possible values as string: None, LZW, CCITTRLE, CCITTG3, CCITTG4, JPEG, PackBits, NextRLE, Thunder, Berthold Lineart, Pixar, Flate, RLE) Colorspace=<value> (possible values as string: None, Spot, Bilevel, Grayscale, Indexed, RGB, HSV, HLS, CMY, CMYK, Multi, Duotone, YCbCr, CIELab, CIEXYZ, CIELuv, CIEYxy, YCC)

56 56 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE Resolution=<value> (value in dpi - dots per inch - as real, e.g. 72.0) Width=<value> (value for width in pixel as integer, e.g. 640) Height=<value> (value for height in pixel as integer, e.g. 480) UseProfile=<value> (possible values as integer: 1 or 0; as string: TRUE or FALSE) IncludeProfile=<value> (possible values as integer: 1 or 0; as string: TRUE or FALSE) ProfilePath=<value> (value as string) e.g.: ICC-Profiles:Printer:HELIOS:CromalinEuro 1.0 GCR50 UCR370 NOTE: If a value contains a space, it must be placed in inverted commas. FlipHorizontal=<value> (possible values as integer: 1 or 0; as string: TRUE or FALSE) FlipVertical=<value> (possible values as integer: 1 or 0; as string: TRUE or FALSE) PageNumber=<value> (value as integer, e.g. 1) Rotate=<value> (possible values as integer: 0, 90, 180, 270) CropLeft=<value> (value in pixel as integer, e.g. 10, from the left side of the original) CropTop=<value> (value in pixel as integer, e.g. 10, from the top of the original) CropRight=<value> (value in pixel as integer, e.g. 10, from the right side of the original) CropBottom=<value> (value in pixel as integer, e.g. 10, from the bottom of the original) NOTE: Width, Height, CropLeft, CropTop, CropRight or CropBottom can also be Defined in Percentage! You can also define the values for Width, Height, CropLeft, Crop- Top, CropRight or CropBottom in percentage of the original image pixel size. To do so, enter the percentage character at the end of the integer number of the parameter, e.g. "Width=50%", "Height=25%", or "CropLeft=10%"

57 The first two sections of this appendix offer some recommendations on what to do before you install HELIOS Companion and start working with it. The next section is about migration and tells you what do if you want to use existing catalogs with HELIOS Companion or to migrate from the previous version of HELIOS Companion. The last section offers troubleshooting information to help you solve common problems fast. Appendix

58 58 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE Considerations Before Installing HELIOS Companion components may be installed on different computers depending on where you installed your HELIOS ImageServer and your Cumulus Server software. However, for the full range of HELIOS Companion s features to be available, the Cumulus Server has to run on the same computer as the HELIOS ImageServer. If HELIOS Companion is running on a different machine from the Cumulus Server, Cumulus Clients and other applications cannot make use of HELIOS AssetProcessor and they can only preview those assets that employ the Cumulus Filters for the preview function. However, if you have to decide where to install the software components, you should know the differences there are when the components are either running on the same machine or on different machines. Depending on how the users will work with HELIOS Companion, you may even want to change your existing configuration. The graphics in this section will help you understand how HELIOS Companion works. Automatic Cataloging When performing automatic cataloging it doesn t make a difference whether the HELIOS ImageServer and the Cumulus Server are running on the same or on different machines. When cataloging automatically, certain HELIOS Companion components take over the task that when cataloging manually is performed by the native Cumulus Client. As these components have to communicate directly with the HELIOS ImageServer, they have to be installed on the same machine. For the communication with the Cumulus Server, TCP/IP is employed and therefore the Cumulus Server can reside on a different machine.

59 CONSIDERATIONS BEFORE INSTALLING 59 For each file put into a monitored folder the HELIOS ImageServer sends a message (a so called OPI event). The HELIOS Synchronizer receives this message and reacts on it by cataloging this file. For cataloging, it employs the filters installed on the machine. The HELIOS Synchronizer hands over the thumbnail and metadata to the Cumulus Server and then they are added to the catalog as a new record.

60 60 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE Accessing Assets When accessing assets, it doesn t make a difference whether the HELIOS ImageServer and the Cumulus Server are running on the same machine or on different machines. When accessing assets (e.g. search, drag & drop) the Clients (Cumulus Clients or Web Clients) only communicate with the Cumulus Server. Previewing Assets Depending on the filters employed for previewing it can make a difference if the HELIOS ImageServer and the Cumulus Server are running on the same machine or on different machines when previewing assets. If only Cumulus Filters are employed for previewing, the HELIOS ImageServer and the Cumulus Server can run on different machines.

61 CONSIDERATIONS BEFORE INSTALLING 61 If you require the Cumulus HELIOS Filter when an equivalent Cumulus Filter is not available (e.g. for PDF assets), the HELIOS ImageServer and the Cumulus Server must run on the same machine as the Cumulus HELIOS Filter has to communicate with the HELIOS ImageServer directly.

62 62 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE Converting Assets If you want Cumulus Clients or a Cumulus Internet solution( Web Publisher Pro or Internet Client Pro) to make use of the HELIOS AssetProcessor for converting assets, the Cumulus Server must run on the same computer as the HELIOS ImageServer software. This is because the HELIOS AssetProcessor has to communicate directly with the HELIOS ImageServer software. Considerations Before Using The purpose of Cumulus HELIOS Companion s automatic synchronizing process is quite different from what you do manually with a Cumulus Client. Mixing these two approaches cannot be recommended. New Catalogs In order not to interfere with the individual way of working with Cumulus employing the Cumulus Client, we recommend that you create new catalogs for the automatic cataloging with Cumulus HELIOS Companion. One reason is that the resynchronizing pro-

63 GETTING STARTED 63 cess will add deleted records again (if the asset still exists in the watched folder). Special Companion User We also recommend that you create a special companion user. If you create a special user for HELIOS Companion and define this user within all Synchronize Setups, you can easily find all automatically cataloged assets: You simply search for all assets cataloged by this user. Cumulus Internet Solutions If you want to make use of Cumulus Web Publisher Pro or Internet Client for distributing data to customers, we recommend that you create one catalog for each customer. Let s assume you offer your customers the service of direct access via Internet to the production data stored on one of your computers. You have created a folder for each customer or project. In this case, we recommend that you create a Cumulus catalog for each customer and define a HELIOS Companion Setup for each customer (respectively for each of his catalogs). This way the data can be easily accessed via Internet and are always up to date. Getting Started When you start working with HELIOS Synchronizer, you should perform the following steps: 1. Log on as a Cumulus Administrator to the Cumulus Server by employing a Cumulus Client. 2. Create the new catalog(s) for automatic cataloging. NOTE: If you want to use existing catalogs, take the migration considerations into account. (See Migration, p. 64, for details.) 3. Activate the Share Catalog option for the new catalog(s). NOTE: A catalog that is not activated for sharing won t be listed in the HELIOS Companion s Catalog Access window. 4. Open the new catalog(s).

64 64 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE 5. Add the record field named HELIOS Image Information (provided by the HELIOS Filter module) to the Record Fields in the Catalog Settings of the Properties dialog if you want to store the HELIOS Open Image information retrieved by the HELIOS Filter. (See The HELIOS Filter, p. 48, for further details.) 6. Configure the Asset Handling Set(s) to be used with HELIOS Companion. (See Asset Handling Sets for HELIOS Companion, p. 49, for details.) 7. Close the Cumulus application you started as Cumulus Administrator. 8. Create the desired Synchronize Setup(s). (See Creating a Synchronize Setup, p. 44, for details.) 9. Make sure that the HELIOS Synchronizer is started. Otherwise start it by clicking the Startup button in the HELIOS Companion Setup window. 10. If the watched folder defined for a Synchronize Setup already contains assets, start the resynchronize process for this folder. 11. Select the Synchronize Setup and click Start Watching to start the watching process. Migration Most of the following describes tasks that have to be performed with a Cumulus Client. Before you start, the most current Cumulus Client for HELIOS Companion installer should have been run on the machine you use to perform these tasks. If you use HELIOS Companion for the first time and want to use your existing catalogs with HELIOS Companion, see Using Existing Catalogs for Automatic Cataloging with HELIOS Companion, below, for a description on what to do. If you migrate from HELIOS Companion to HELIOS Companion 2.0, see Migrating from HELIOS Companion 1.0.2, p. 68, for a description on what to do.

65 MIGRATION 65 Using Existing Catalogs for Automatic Cataloging with HELIOS Companion If you want to use a catalog you already worked with and manually cataloged assets to for automatic cataloging with HELIOS Companion, you should be aware of the following: Folders To Be Monitored Contain Cataloged Assets If the catalog already contains assets that are stored in folders that will be monitored by the HELIOS Synchronizer, some preparations are required. If the catalog only contains the metadata for these assets that are captured automatically by Cumulus and if you did not spend a lot of time on assigning categories, you should create a new catalog and resynchronize the folders.(for details see Getting Started, p. 63) TIP: To keep the catalog s properties, use the Cumulus function New Empty Copy for creating the new catalog. Then go on with step 3 as described under Getting Started, p. 63. It might be best to delete the old source catalog and rename the copy to the name of the source catalog. You should rename the catalog name (via Preferences Catalog Settings) so the users can access it under the known name. In case the catalog is included in any automation, you should also rename the catalog file name. If the catalog contains a lot of metadata for these assets that are entered manually (including category assignments) and you want to keep the metadata, you have to prepare your catalog and the assets already cataloged for automatic cataloging under UNIX. See below for details. Preparing Existing Catalogs To prepare an existing catalog and already cataloged assets for automatic cataloging under UNIX: 1. Connect to the Cumulus Server with a Cumulus Client as Cumulus Administrator. 2. Make sure that the Share Catalog option for the catalog is activated.

66 66 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE NOTE: A catalog that is not activated for sharing won t be listed in the HELIOS Companion s Catalog Access window. 3. Open the catalog. 4. Open the Catalog Settings for the catalog ( Cumulus / Edit Preferences Catalog Settings). The Field Linking for the record field Categories should be set to Automatically Activate Matching Field from Newly Installed Modules. If it is not set to activate automatically, you have to add Categories field of the Unix File AssetStore to Also Link the Following Fields. The fields File Type and File Creator are now also supported by the Unix File AssetStore. If you want to make use of this, you have to add the Unix File AssetStore to the Field Linking of these fields. If the catalog was created with a Cumulus version prior to 6: Add the record field named Unix File Identifier (provided by the Unix File System module) to the Record Fields of the Catalog Settings in the Preferences dialog. Activate this field for indexing. If you want to store the HELIOS Open Image information retrieved by the HELIOS Filter: Add the record field named HELIOS Image Information (provided by the HELIOS Filter) to the Record Fields of the Catalog Settings in the Preferences dialog. (See The HELIOS Filter, p. 48, for further details on the information stored in this field.) 5. Click OK to save your changes and close the Properties window. 6. Select the records and invoke the function File Update Asset Reference. 7. Delete the automatic directory categories (found on the Sources tab) for those folders that will be monitored by the HELIOS Synchronizer. (When resynchronizing the folders, the directory categories will be automatically added again.) 8. Close the catalog. 9. Create the desired Synchronize Setup. (See Creating a Synchronize Setup, p. 44, for details.)

67 MIGRATION Make sure that the HELIOS Synchronizer has started. Otherwise, start it by clicking the Startup button in the HELIOS Companion Setup window. 11. Start the resynchronize process for the folder. 12. Select the Synchronize Setup and click Start Watching to start the watching process. If you prefer the deleted records to be recoverable, then we recommend that you compress the catalog before you employ it for automatic cataloging. Catalog Property for Recoverable Records When records are deleted from catalogs, they can optionally remain a part of the catalog in case you want to retrieve them. You can delete these records permanently by compressing the catalog. Especially when catalogs employ HELIOS Companion (it automatically deletes records!) you may want to have the option activated so that records are recoverable. If you activate this option for a catalog working with HELIOS Companion, it is wise to compress this catalog before HELIOS Companion automatically cataloged assets to it. That way you have a defined status of the catalog when you start using HELIOS Companion. To compress a catalog: 1. Open the catalog with a Cumulus Client as Cumulus Administrator. 2. Select File Administration Compress. (If the Compress menu option is disabled, the catalog is already compressed as much as possible.) You are warned that compressing the catalog will permanently remove the deleted records. 3. Click OK to compress the catalog.

68 68 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE Migrating from HELIOS Companion When migrating from HELIOS Companion version that you used with a Cumulus 6 installation, the following adjustments are necessary for your catalogs: The Field Linking for the record field Categories should be set to Automatically Activate Matching Field from Newly Installed Modules. If it is not set to activate automatically, you have to add the Categories field of the Unix File AssetStore to Also Link the Following Fields. The fields File Type and File Creator are now also supported by the Unix File AssetStore. If you want to make use of this, you have to add the Unix File AssetStore to the Field Linking of these fields. The categories that were automatically created by HELIOS Companion on the All tab only and that are on the same level as the $Sources category have to be moved into the the $Sources category. If you have copied the config folder containing the Synchronize Setup configuration files of your old installation to your new installation, you have to edit these Synchronize Setups and assign Asset Handling Sets. If you made use of the Cumulus feature for the Generic Filter under Mac OS X and UNIX to assign JPEG images as default thumbnails for file formats (image named as the file extension of a file format), copy the folder Generic_Filter_Thumbnails from your old installation into the folder../helioscompanion2/etc of your new installation. The Generic Filter will then still access these image files. Troubleshooting This section offers troubleshooting information to help you solve common problems fast. Resynchronizing 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 all Synchronize Setups are started again.

69 TROUBLESHOOTING 69 If resynchronizing a folder fails, try rebuilding the HELIOS Desktop database. To rebuild the HELIOS Desktop database, change to the subdirectory sbin of your HELIOS installation directory (e.g. usr/ local/helios/sbin) and enter the command:./rebuild <path of watched folder> If this yields no results, you may use the -f parameter for this command. See your HELIOS documentation for details. This process can last quite a long time. When it is finished, start the resynchronization again. HELIOS DT Commands If you employ the HELIOS DT commands, HELIOS Synchronizer does not get any messages and therefore cannot react. You have to perform an opitouch command (with the -e parameter) to get an event HELIOS Companion can work with. For details on the opitouch utility see the HELIOS documentation. HELIOS opitouch Utility / HELIOS Script Server If you employ the HELIOS opitouch utility with the -e parameter to create events, keep in mind that these may also be used by HELIOS Companion. As HELIOS Companion does not check events for syntactical and semantic correctness, you must ensure that these events are valid. Valid in this case meaning: could have been produced by afpsrv (afpsrv = Apple filing protocol service). If you include the opitouch -e command in any of your own scripts, make sure that the created events are syntactically and semantically correct. For example: The OPI Event Listener port adds a / at the end of any renamedir event. If your script s event ends with an / itself, this would result in a // at the end and HELIOS Companion cannot interpret this notation as a rename directory event and will not react. Moving Folders within the Data Volume Managed by EtherShare If you move a non-monitored folder from the data volume managed by EtherShare as a subfolder into a monitored folder, allow HELIOS Synchronizer to have enough time to perform all synchronizing processes before you rename this folder or move it again.

70 70 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE HELIOS Synchronizer Already Running Only one HELIOS Synchronizer can be running at the same time. If you cannot start the HELIOS Synchronizer, check whether the log file for the HELIOS Companion (.../var/log/helioscompanion/heliossynchronizer.log) contains the error message A HELIOS Synchronizer is already running... If not, please remove the lock file. If you got this error message, you have to remove the lock file named.companion.lock found in the following subdirectory of your HELIOS Companion installation:../helioscompanion2/etc/helioscompanion/config Before you remove this file, it is best to try to stop HELIOS Synchronizer to avoid interrupting any running processes. HELIOS Synchronizer not Started Automatically We recommend including the HELIOS Synchronizer with the HELIOS Service Controller. This way it should automatically be started and stopped along with other HELIOS services. If it is not started automatically, you should create a symbolic link for the Java Executable of your system. Create this link in the following subdirectory of your HELIOS Companion installation:../helioscompanion2/ bin High and Low Resolution Files HELIOS Companion only catalogs the high resolution files. Therefore any Layout subfolders and.lay files as well as all OPI AssetStore settings will be ignored. Accessing OPI Low Resolution Files Accessing OPI Low Resolution Files is done by the Cumulus Client s OPI AssetStore and not by the HELIOS Companion. However, as always questions always arise about accessing OPI files along with HELIOS Companion. Here are some explanations. Even if you have deactivated the OPI AssetStore option Silent OPI Access, the access will take place silently (with no further dialogs) if a Drag & Drop action is performed (as Drag & Drop does not allow any further dialogs). The Drag & Drop action is always performed with the cataloged file no matter what you defined in the OPI settings. low resolution files do not exist. In this case the high resolution files are accessed.

71 TROUBLESHOOTING 71 low resolution files cannot be accessed. In this case the high resolution files are accessed. If you merely use Cumulus to place low resolution files via Drag & Drop in your layout application, we recommend that you activate the option Silent OPI Access along with the option Low Resolution File. Note however, that in this case it is also recommended not to rely on the Server/Client Asset Transfer but instead mount the volume as the original asset reference (of the high resolution file) has to be resolved in order to access the low resolution file. If you only want to work with the cataloged high resolution files, this is irrelevant.

72 72 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE

73 INDEX 73 Index A Activating HELIOS Companion 19 Administrator Guide organization of 8 Asset Handling Sets configuring for HELIOS Companion 49 creating a new one 49 selecting for Synchronize Setup 45 Assets already cataloged 65 converting with the HELIOS AssetProcessor 52 excluding 38 AssetStores OPI 44 accessing assets 70 settings 70 Unix File System 50 C Catalogs polling interval 37 using existing with HELIOS Companion 65 Configuration files 36 Configuring HELIOS Synchronizer 32 HELIOS Synchronizer via application 40 HELIOS Synchronizer via shell commands 32 HELIOS Synchronizer via telnet 34 Creating Asset Handling Set 49 Synchronize Setups 44 D Delay for automatic cataloging 43 E EJaPs, HELIOS AssetProcessor using with 55 Exclude pattern 38 F Filters Generic Filter 51 HELIOS Filter 48 H HELIOS AssetProcessor installing 21 logging parameters 55 using with a Cumulus Client 52 using with Cumulus Internet solution 55 using with EJaPs 55 HELIOS Companion activating 19 configuration files 36 installing Client software 21 installing Server software 14 installing with Internet Client Pro 25 installing with Web Publisher Pro 25 HELIOS Companion Setup start application 41 user interface language 40 window overview 42 HELIOS Filter 48 EPS format 50 PDF format 50 supported formats 7 HELIOS Service Controller 17

74 74 CUMULUS HELIOS COMPANION ADMINISTRATOR GUIDE HELIOS Synchronizer configuring 32 via application 40 via shell commands 32 via telnet 34 starting/stopping 42 I Installing HELIOS AssetProcessor 21 HELIOS Companion Client software 21 HELIOS Companion Server software 14 HELIOS Companion with Internet Client Pro 25 HELIOS Companion with Web Publisher Pro 25 think upon before 58 Internet Client Pro HELIOS AssetProcessor with 55 HELIOS Companion installing with 25 installation aspects for converting assets 62 using with HELIOS Companion 63 L License activating HELIOS Companion 19 Edit License window 20 locale 17 Log files 39 Logging activating 38, 43 HELIOS AssetProcessor parameters 55 M Mac OS X installing HELIOS Companion Client software under 21 installing HELIOS Companion Server Software under 14 Migration 64 Monitoring pausing/resuming 42 pausing/resuming via telnet 36 starting/stopping 42 starting/stopping via telnet 34 O opitouch 69 P PCShare 12 PDF HandShake and HELIOS Filter 7 format entry 50 version 12 Pre-filling records 46 R Resynchronizing 42 options 43 troubleshooting 68 S Shell commands configuring HELIOS Synchronizer via 32 Synchronize Setups creating 44 listing 43 naming conventions 44 properties 43 System requirements 12 T Technical Support 10 Telnet configuring HELIOS Synchronizer via 34 port number 37 Time out for Cumulus Tool 37 U Uninstalling HELIOS Companion 1.x Server software 26 HELIOS Companion 1.x under Mac OS X 26 HELIOS Companion 1.x under UNIX 28

75 INDEX 75 UNIX, installing HELIOS Companion Server software under 14 Updating from prior versions 26 User Guide, conventions used 9 User Interface HELIOS Companion Setup window 42 Watch Folder Properties 43 Using getting started 63 think upon before 62 W Watch Folders listing 43 properties 43 Web Publisher Pro HELIOS AssetProcessor with 55 installation aspects for converting assets 62 installing HELIOS Companion with 25 using with HELIOS Companion 63 Windows, installing HELIOS Companion Client software under 21