Summary of the content on the page No. 1
ADOBE VERSION CUE CS3
CLIENT PROGRAMMER’S GUIDE
Summary of the content on the page No. 2
© 2007 Adobe Systems Incorporated. All rights reserved. Adobe Version Cue CS3 Client Programmer’s Guide Technical note #10306 Adobe, the Adobe logo, Bridge, Creative Suite, Version Cue, and Version Cue Server are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. Mac OS is a trademark of Apple Computer, Inc., registered in the United States and other countries. Windows is either a registered trademark or a trademark of Microsof
Summary of the content on the page No. 3
Contents Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Key Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Summary of the content on the page No. 4
Contents 4 Adobe Version Cue CS3 Client Programmer’s Guide
Summary of the content on the page No. 5
Adobe Version Cue CS3 Client Programmer’s Guide Terminology Adobe Version Cue CS3 Client Programmer’s Guide This document describes the Adobe® Version Cue® client from a programmer’s perspective. It is intended for system integrators integrating with Version Cue, who are already writing plug- ins for Version Cue Server™. This document describes the extensibility features enabled by Version Cue SDK at the Version Cue clients such as Adobe Bridge® CS3, and how you can extend Version Cue clients t
Summary of the content on the page No. 6
Adobe Version Cue CS3 Client Programmer’s Guide Introduction Version Cue Server — The server component of Version Cue CS3. Version Cue Server plug-in — A plug-in developed in Java™ using the Version Cue SDK, conforming to the pattern required to be loaded and called by Version Cue Server. NOTE: Unless noted otherwise, references to any Adobe product always mean the CS3 product. Introduction Version Cue clients, such as Adobe Bridge CS3 or Adobe InDesign® CS3, are integrated with the Version C
Summary of the content on the page No. 7
Adobe Version Cue CS3 Client Programmer’s Guide Key Operations mon User Interface also let you customize how assets appear in the user interface of Adobe Bridge CS3, which is tightly integrated with Version Cue. To see the the Adobe File > Open dialog from the Adobe Common User Interface, using a cli- ent such as Adobe InDesign CS3. If the normal operating-system file-open dialog appears instead of the Adobe dialog when you are trying this for the first time or after deleting prefer- ences, clic
Summary of the content on the page No. 8
Adobe Version Cue CS3 Client Programmer’s Guide Key Operations The custom project icon in Figure 1 is provided by a sample plug-in for Version Cue Server named sample.customproject; this sample plug-in is the reference implementation for con- necting to an external system and provides a model of how you would implement an adapter between your external system and the Adobe Creative Suite CS3 point products. Selecting projects in the Content pane of Bridge or the Adobe File > Open dialog and doubl
Summary of the content on the page No. 9
Adobe Version Cue CS3 Client Programmer’s Guide Key Operations Custom Metadata Version Cue clients can display custom metadata provided by your Version Cue Server plug- ins, in contexts such as the Inspector Panel of Adobe Bridge CS3 or the File Info area of the Adobe File > Open dialog. The Inspector Panel in Adobe Bridge CS3 is a read-only metadata view component of the Bridge user interface, which lets per-asset metadata be visualized; it is entirely different from the standard Bridge Metada
Summary of the content on the page No. 10
Adobe Version Cue CS3 Client Programmer’s Guide Key Operations used to remove menu items from the context-sensitive menu shown when an asset is selected in one of your custom projects, if some operations are not supported. Figure 4 shows context-sensitive menu items when a file in a standard Version Cue project is selected in Adobe Bridge CS3. Note how there are nearly twenty menu items shown for this context-sensitive menu. FIGURE 4 Context-sensitive Menu for Standard Version Cue Project Figure
Summary of the content on the page No. 11
Adobe Version Cue CS3 Client Programmer’s Guide Key Operations FIGURE 5 Context-sensitive Menu for Custom Project This is achieved by restricting the project capabilities that sample.customproject provides. See the ProjectCapabilities class in that sample to discover why there are fewer menu items for the context-sensitive menu on the custom project compared to the standard project. For More Information See VersionCueSDK IDE Help > Version Cue SDK Help > Samples Guide > CustomProject To find out
Summary of the content on the page No. 12
Adobe Version Cue CS3 Client Programmer’s Guide Key Operations Your Version Cue Server plug-in can use this external reference to propagate any changes to a syndicated asset in the standard Version Cue project back to the external system. For example, if your external DAM system supports versioning, you may want to create a new version of the original asset in the external system when a Creative Suite end user saves a new version of the syndicated asset to the standard project. This extensibilit
Summary of the content on the page No. 13
Adobe Version Cue CS3 Client Programmer’s Guide Key Operations FIGURE 6 An Asset Syndicated from a Custom Project In the CustomProject sample plug-in, the external asset and the asset in the standard (WIP) project are kept in synchronization, using a storeContent listener. When a new version of the asset in the standard project is saved, the external asset in the custom project from which it was downloaded also is updated. To verify that the external asset— in the contentroot folder of this Cust
Summary of the content on the page No. 14
Adobe Version Cue CS3 Client Programmer’s Guide Key Operations Restrictions The following restrictions apply to asset syndication through drag-and-drop or copy/paste in the user interface of Adobe Bridge CS3: Both source and target projects must be mounted before starting the drag-and-drop (or copy/paste) operation. Both source and target projects must have authentication switched off; that is, no login should be required for either project to complete the gesture. No conflict handling is im
Summary of the content on the page No. 15
Adobe Version Cue CS3 Client Programmer’s Guide Key Operations FIGURE 7 Custom Check-in Dialog on Ingest To test the metadata capture enforcement feature and make the customized check-in dialog appear, you need to open a file, modify it, and check in the modified version to a Version Cue project. 1. Ensure Version Cue Server is running with a plug-in like sample.customdialog loaded for the custom check-in dialog to appear. 2. Make sure you have at least one standard Version Cue project on the
Summary of the content on the page No. 16
Adobe Version Cue CS3 Client Programmer’s Guide Key Operations FIGURE 8 Custom Check-in Dialog Figure 8 shows a custom check-in dialog provided by the sample plug-in for Version Cue Server named sample.customdialog. The custom check-in dialog shows fields that include the name of the user responsible for the check-in, status, a check-in comment, and a check box indicating an operation that should be performed on check-in. The OK button is enabled when data is entered into the name and check-in
Summary of the content on the page No. 17
Adobe Version Cue CS3 Client Programmer’s Guide Key Operations For More Information See Help within the IDE of VersionCueSDK: Help > Version Cue SDK Help > Samples Guide > CustomDialog Customizing Menus Version Cue extensibility enables you to contribute custom submenus and custom menu items in the following contexts: Tools menu in the Adobe File > Open dialog: Use the VersionCue.TOOLSMENU symbolic constant for the menu base path in your scripts. When a file is selected in contexts like the Ad
Summary of the content on the page No. 18
Adobe Version Cue CS3 Client Programmer’s Guide Key Operations FIGURE 9 Custom Menus within Adobe Bridge CS3 Content pane The Version Cue client receives JavaScript code— using a JavaScript library from Adobe named ScriptUI— that enables custom menus to be created when first visiting a Version Cue project. To see the scripts associated with creating the user interface, see the data/scripts folder of the sample.custommenu SDK sample. Note that you can add custom menu elements to both standard Ver
Summary of the content on the page No. 19
Adobe Version Cue CS3 Client Programmer’s Guide Key Operations Restrictions Support for custom menus has some limitations: The Version Cue client receives the custom menu information from the Version Cue Server when you enter the project for the first time; for instance, by double-clicking the project in the File > Open dialog. Before entering the project, the custom menu informa- tion is not available, which means that you are not able to contribute custom menu items to the context-sensitive m
Summary of the content on the page No. 20
Adobe Version Cue CS3 Client Programmer’s Guide Key Operations “Special Metadata”. The former is of type “enum”; the latter, “string.” You can select one of those new categories and retrieve search results from the Version Cue Server. FIGURE 10 Project Search over Sample Custom Project If you have the plug-in loaded, to see this dialog, navigate within the Adobe Bridge CS3 to “Sample Custom Project” and execute Edit > Find once the root folders of the project are visi- ble in the Content pane of
