Zoom Plug-ins for Adobe

Transcription

1 = Zoom Plug-ins for Adobe User Guide Copyright 2010 Evolphin Software. All rights reserved.

2 Table of Contents Table of Contents Chapter 1 Preface Document Revision Audience Pre-requisite Additional Resources Convention Feedback... 4 Chapter 2 Installing And Setting up Adobe Plug-ins Adobe CS Verify Zoom plug-in installation Check from inside the tool Check from Extension manager Manual Install Running the panel Uninstalling the CS5 Plug-in... 7 Chapter 3 Working with Zoom CS5 Plug-in About Zoom Using Zoom Install and setup Zoom server Create project, assign users, setup security Import files to project Create Workflow Tasks, setup review... 9 Zoom Plug-ins for Adobe User Guide v2.1 9/24/

3 Table of Contents Open, save revisions of project files Perform work assignments Perform reviews... 9 Chapter 4 Migrating from Version Cue Working Copy notion in Zoom Rich set of Version Control Command Chapter 5 Importing Assets Import Wizard Add new files Chapter 6 Checking out Projects Locking files Automatic locking on checkout Explicit Locking Chapter 7 Committing or Checking-in changes Chapter 8 Updating to latest changes Single file update Changeset based update Change notification View change table Incoming changes in a tree view Chapter 9 Visual history or timeline of changes Chapter 10 More Resources Zoom Plug-ins for Adobe User Guide v2.1 9/24/

4 CHAPTER 1 PREFACE Evolphin Zoom is a cross-platform Version Control System with a built-in Workflow engine. This user guide illustrates and explains how to use the Zoom plug-ins for Adobe products. 1.1 DOCUMENT REVISION Current revision of this user guide is 2.2, last modified on September 24, AUDIENCE This document is written for end-users working with the Adobe software on their desktop. 1.3 PRE-REQUISITE Knowledge of version control or workflow concepts is not a pre-requisite. However, familiarity with Adobe tools is necessary. 1.4 ADDITIONAL RESOURCES We have made every effort to address the issues that a typical user might face when working with Zoom, in this document. For the most up to date version of this document, please visit the customer portal on our web-site. There, you will find additional resources such as technical bulletins and the product knowledgebase. 1.5 CONVENTION Anything marked with this symbol in this manual requires particular attention. Many of the product screenshots are taken on a Microsoft Windows system. The Zoom user interface on MacOS is similar, except it will have a MacOS native window border around it. Exact same functionality is available on either operating system. 1.6 FEEDBACK To report any errors or omissions in the manual please us at: <[email protected]> Zoom Plug-ins for Adobe User Guide v2.1 9/24/

5 CHAPTER 2 INSTALLING AND SETTING UP ADOBE PLUG-INS Zoom installer will try to automatically install all supported Adobe plug-ins provided the Adobe tools are installed in standard location or Zoom can infer the path to Adobe tools. In the rare event, Zoom is unable to locate the Adobe distribution, plug-ins can be manually installed as described in this chapter. 2.1 ADOBE CS5 For Adobe Creative Suite 5 (CS5) tools, Zoom ships with a zxp plug-in. The plug-in opens as a panel inside the supported CS5 tool. It provides short cuts to the commonly used Zoom functions like check-in, checkout, update and more. The installer will register the plug-in automatically with the Adobe CS5 Extension manager VERIFY ZOOM PLUG-IN INSTALLATION There are two ways to verify if the plug-in was successfully installed: CHECK FROM INSIDE THE TOOL Launch any CS5 tool like Photoshop for example and look for an extension named "Evolphin Zoom" under the Windows menu: Figure 1 - Zoom Extension CHECK FROM EXTENSION MANAGER Zoom Plug-ins for Adobe User Guide v2.1 9/24/

6 Launch the Adobe CS5 Extension manager from the applications menu. Click on any CS5 tool on the left pane. The Zoom plug-in will show up as "com.zoom.plugin" under the list of extensions. If a lot of extensions have been installed, it may be necessary to scroll down to spot the Zoom plug-in. Figure 2 - Adobe CS5 Extension Manager MANUAL INSTALL If for some reason you cannot find the Zoom plug-in installed inside the Adobe tool or in the extension manager, please install the plug-in manually by clicking on the Install button inside the Adobe Extension manager and browse the file system to locate the ZoomAdobePlugin.zxp file in the Zoom plug-in folder: Windows: c:\program Files\Evolphin\DAM\plug-ins or c:\program Files (x86)\evolphin\dam\plug-ins MacOS: /Applications/Evolphin/zoom/Resources/plug-ins RUNNING THE PANEL From inside the CS5 tool like InDesign, click on the Windows -> Extensions -> Evolphin Zoom to launch the Zoom panel. Once launched it can be docked anywhere inside your CS5 application. Next time the application is started, the Zoom panel will dock at the same location. Zoom Plug-ins for Adobe User Guide v2.1 9/24/

7 Figure 3 - Zoom CS5 Panel inside Photoshop UNINSTALLING THE CS5 PLUG-IN From within the Adobe CS5 Extension Manager, if you click the REMOVE button to the left of zoom plugin for any one of the tool, it would cause the plug-in to be removed for all the CS5 tools. Zoom Plug-ins for Adobe User Guide v2.1 9/24/

8 CHAPTER 3 WORKING WITH ZOOM CS5 PLUG-IN Designers can use the Zoom plug-in to track and manipulate revisions of digital assets from with-in their Adobe tool. They can also access their workflow tasks and associated files using the plug-in. For more advanced options, designers can also use the Zoom universal clients from outside the Adobe tool. Documentation and help on the universal clients can be found in the Zoom Reference Manual. 3.1 ABOUT ZOOM Zoom acts as a central digital asset server that lets designers work collaboratively on a set of common assets. Designers can easily track and manipulate multiple revisions of files. Zoom consists of two modules: the Version Cue Server and Workflow. The Zoom Server can be installed locally or on a dedicated computer, and it hosts Zoom projects. 3.2 USING ZOOM Below is a list of typical set of tasks, administrators and end-users will encounter when using Zoom INSTALL AND SETUP ZOOM SERVER Before you begin using Zoom, you will need to install and setup the Zoom Server. For installation please refer to the Zoom Installation guide for your platform (Windows/Mac/Linux). When you install Zoom Server either locally on your desktop or on a dedicated server machine, a default project and admin user account are automatically created. These can be used to test the Zoom server CREATE PROJECT, ASSIGN USERS, SETUP SECURITY The super administrator can create new projects beyond the default project (defproj) and assign project administrator to each project. As a project administrator, you can take control of your project by assigning users to your project. Every command in Zoom is project aware to facilitate easy mapping of your real life project to the Zoom project. To constraint access within a project, project administrator can specify or create new security roles. Roles carry permissions and can be used to restrict users to read-only mode, ability to write new versions without the ability to remove files and much more. Please refer the Zoom Reference Manual for more details. These tasks are not performed from the Adobe plug-in which is meant for the end users. Zoom Plug-ins for Adobe User Guide v2.1 9/24/

9 3.2.3 IMPORT FILES TO PROJECT Once your administrator has created and granted access to a project, you can start importing your digital assets to the Zoom server. Imported assets can be checked out by other users, who can then modify and check-in revisions. For batch import of assets you can drag assets from Windows Explorer or Mac Finder to the remote repository browser. Individual assets can be directly imported from within your Adobe CS5 tool as described in section CREATE WORKFLOW TASKS, SETUP REVIEW While you can do the version control operations without setting up the Zoom Workflow, to experience the full benefits of Zoom it is highly recommended you setup workflow tasks. Workflow tasks are setup using the web based administration console. Please refer to the Zoom Reference Manual for more details. You can assign tasks to specific users, create dependencies between tasks, setup hierarchical reviews, monitor task progress using the web based workflow administration tool OPEN, SAVE REVISIONS OF PROJECT FILES From the CS5 Evolphin Zoom panel inside the CS5 tool, automatically save and check-in changes to your files. With Photoshop, Illustrator, InDesign and InCopy Zoom is aware of the current document being edited and provides one button automation to command commands like check-in, update, add, revert and import. See Chapter 7 for more details PERFORM WORK ASSIGNMENTS Once the project lead has assigned tasks to you, Zoom will notify you via Windows system tray or MacOS Menu bar Extra icon about upcoming tasks. From within your CS5 tool, you can click on My Tasks button to browse your tasks, drag assigned files to the CS5 tool to automatically check them out. See Zoom Workflow Reference Manual for more details PERFORM REVIEWS Zoom allows reviews to be performed on any digital asset not just text or PDF files. If you are a assigned a review and the asset changes become ready to be approved, you will be notified via the Windows system tray or MacOS Menu bar Extra icon about pending reviews. From within your CS5 tool, you can click on My Tasks button to browse your review tasks as well. See Zoom Workflow Reference Manual for more details. Zoom Plug-ins for Adobe User Guide v2.1 9/24/

10 CHAPTER 4 MIGRATING FROM VERSION CUE 4.1 WORKING COPY NOTION IN ZOOM As a Version Cue users, most of the version control concepts will be familiar to you. One of the key difference with Version Cue is the notion of working copy in Zoom. Unlike Version Cue, when you check out a project or a folder to your local desktop, Zoom designates the local desktop directory as a working copy. It automatically maps and track any changes to a working copy to the remote Zoom server from which you checked out. This approach has number of advantages over the naked import-commit model used by Version Cue: 1. You will not lose versions in the repository if you accidently import without checking out again. Zoom will prevent over-writing of versions 2. You can commit or check-in all your changes by just invoking commit on the root folder of the working copy. No need to remember every modified file and commit it explicitly. 3. You can schedule changes to be committed in the working copy and at a future time. Check-in all of them at once to the server 4. Most version control operations can be performed offline without the need of a connected Adobe Drive 5. Zoom can automatically notify you of any changes on the server that pertain to your checked out project, without examining individual files for status change on the server. 6. You can move/rename files and still track the history without causing a new file to be versioned 4.2 RICH SET OF VERSION CONTROL COMMAND With Adobe Drive and Version Cue, you could do limited operations like check-in/check-out/commit from Adobe Drive/Bridge. With Zoom, over 20+ version control operations are available from Windows Explorer or Mac Finder. The menu screen shots below illustrate the differences: Zoom Plug-ins for Adobe User Guide v2.1 9/24/

11 Figure 4 - Limited version operations in Version Cue The Zoom context menu has a rich set of version control and workflow commands as shown: Figure 5 - Extensive Version Control in Zoom Zoom Plug-ins for Adobe User Guide v2.1 9/24/

12 CHAPTER 5 IMPORTING ASSETS IMPORT WIZARD Click on the button in the Zoom panel to bring up the import wizard: Zoom Plug-ins for Adobe User Guide v2.1 9/24/

13 By default it selects the currently open document as the source document to import. To import an entire folder, simply click on browse button and select it for import. Alternatively, files and folders from Windows Explorer or Mac Finder can be dragged and dropped into the Zoom remote drive/repository browser. To launch the remote drive, click on the button in the Zoom panel. It will open as: In the left pane all the projects you have access to will be listed. You can drag and drop assets from Windows Explorer or Mac Finder, into the project of your choice to trigger an implicit import. During import you will be prompted for comments or annotations. These will be applied to all the imported assets ADD NEW FILES Unlike version control systems like Adobe Version Cue, Zoom supports scheduled operations. You can batch up the changes you need to version on your desktop and when you are ready, just click on commit to send the changes to the server. Use the add option, once you have checked out a project or a folder. See Chapter 6 for more details on checking out a project. If it is a new file, please save the file on local disk before, Zoom will activate the Add button. Zoom Plug-ins for Adobe User Guide v2.1 9/24/

14 Click on the project: button in the Zoom panel to schedule the current document for addition to the Figure 6 - Schedule files for add to server Please remember to click the commit button to send the changes to the server. Zoom Plug-ins for Adobe User Guide v2.1 9/24/

15 CHAPTER 6 CHECKING OUT PROJECTS There is no need to mount a drive, to start working on a project, simply click the checkout menu option in the Evolphin panel menu: This will bring up the checkout dialog, where you can simply select the project you wish to work on and specify the working copy directory location on your local desktop. Unlike Version Cue, Zoom uses an explicit working copy model to ensure an error free version experience for the end user. The working copy if your local mirror of the folders you elect to check out. Zoom Plug-ins for Adobe User Guide v2.1 9/24/

16 See the Zoom Reference Manual for more details on the checkout dialog. Once checkout is complete you will use the checkout destination directory for saving, adding, modifying files and folders. You will be able to batch commit the project folder by using the commit from Window Explorer/Mac Finder or from within the Zoom panel inside the CS5 application. 6.1 LOCKING FILES To prevent other users from editing files you are modifying, an exclusive lock can be set AUTOMATIC LOCKING ON CHECKOUT From the web administration console, turn on the lockable flag on the digital assets that require automatic locking on checkout using the Manage Lock Policy tab: The first user to checkout the unlocked files will get the lock. Lock can be released on commit or explicitly by clicking Release Lock from the Windows Eplorer or Mac Finder context menu. See the Zoom Reference Manual for more details. Zoom Plug-ins for Adobe User Guide v2.1 9/24/

17 6.1.2 EXPLICIT LOCKING From the Windows Explorer or Mac Finder, click on the Get Lock menu option for either a folder or a file: If you do it on a folder, you will have a chance to toggle out files or sub-folders you do not wish to lock. Zoom Plug-ins for Adobe User Guide v2.1 9/24/

18 CHAPTER 7 COMMITTING OR CHECKING-IN CHANGES After modifying a document in the CS5 application, clicking on the dialog: button brings up the commit If you wish to continue holding the locks after checking in the changes, just select the Keep file locked checkbox at the bottom left. Otherwise Zoom will automatically release the file locks on a successful commit. For Photoshop, InDesign and Illustrator, Zoom is able to directly check-in the current active document. For other CS5 applications, Adobe does not yet provide a direct document access API, so you have to go through one extra step to select the folder or file to check-in - Zoom Plug-ins for Adobe User Guide v2.1 9/24/

19 The dialog shows all the working copies that have been checked out by you in the right side pane. This provides quick access to the project whose files/folders you wish to check-in. Zoom Plug-ins for Adobe User Guide v2.1 9/24/

20 CHAPTER 8 UPDATING TO LATEST CHANGES Zoom supports two methods for updating to the latest changes on the server: SINGLE FILE UPDATE From within the CS5 application if you click on from the Zoom server if there are pending changes. button, it will cause the current file to be updated If the file is locked by you then by definition, there cannot be updates from other users. Only for unlocked files, updates can exists. If you have modified an unlocked file, Zoom may detect a conflict while updating and will prompt you to resolve the conflict by showing you several applicable proposals (discard server changes, discard your changes, merge changes). See the Zoom Reference Manual for more details on Zoom conflict resolution mechanism CHANGESET BASED UPDATE This methods provides more control and a much more sophisticated user interface for viewing and managing changes. Changeset is the set of all the changes that were atomically checked-in when a user clicked on commit on their desktop. Zoom bunches up all the changes by a commit transaction in a bag called changeset. This makes it easy to rollback an entire changeset or view changes by multiple users CHANGE NOTIFICATION Whenever designers in your project, check-in changes to the project or folder you have checked out in a working copy on your desktop, Zoom will notify you via the system tray icon on Windows or the Menu bar Extra icon on MacOS: Zoom Plug-ins for Adobe User Guide v2.1 9/24/

21 The Zoom change monitoring agent icon will turn red with a download arrow indicating pending updates VIEW CHANGE TABLE Clicking on the red icon or left click on the icon followed by click on View Details brings up a table with a list of changes for each Working Copy being monitored. Note - you can turn off working copy monitoring via the Settings dialog. At this point you can left click on the working copy to view the context menu. To see incoming changes just select Show incoming changeset. To update the entire working copy, you can click on Update working copy menu option INCOMING CHANGES IN A TREE VIEW Zoom shows all the changes relevant to your project in a changeset table. Each changeset corresponds to an atomic group of assets that were modified by a commit from another user. You can browse and view incoming changes before actually modifying your working copy. Zoom Plug-ins for Adobe User Guide v2.1 9/24/

22 Zoom Plug-ins for Adobe User Guide v2.1 9/24/

23 CHAPTER 9 VISUAL HISTORY OR TIMELINE OF CHANGES As changes are checked-in, Zoom automatically extracts and saves thumbnails/previews of supported file formats in the Zoom repository. To view the visual timeline of changes, simply click on the button. This will bring up the visual history window as below: Zoom Plug-ins for Adobe User Guide v2.1 9/24/

24 CHAPTER 10 MORE RESOURCES The Zoom plug-in for Adobe supports many more options that were not covered by this guide. All these options are simply short-cuts to Zoom's universal user interface dialogs. Zoom provides integration plugins that essentially all launch the same set of universal user interface dialogs. See the Zoom Reference Manual for more details on these additional dialogs. Zoom Plug-ins for Adobe User Guide v2.1 9/24/