Macromedia Version Cue - CS3 Getting Started

GETTING STARTED WITH ADOBE VERSION CUE CS3 DEVELOPMENT

Getting Started with Adobe Version Cue CS3 Development

Technical note #10300

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 Microsoft Corporation in the United States and/or other countries. Java is a trademark or registered trademark of Sun Microsystems, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.

The information in this document is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Adobe Systems Incorporated. Adobe Systems Incorporated assumes no responsibility or liability for any errors or inaccuracies that may appear in this document. The software described in this document is furnished under license and may only be used or copied in accordance with the terms of such license.

Contents

Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Development Platforms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Setting up your Development Platform. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Installation and Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Stopping Version Cue CSx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Stopping the MySQL Database Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Preparing to Start Version Cue Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Running Version Cue Server for the First Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Starting Version Cue Server from the IDE of Version Cue SDK . . . . . . . . . . . . . . . . . . . . . 15

Launching Version Cue Server Through the IDE Versus Normal Operation . . . . . . . . . . . . . 16

Obtaining Debug Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Stopping Version Cue Server from the IDE of Version Cue SDK . . . . . . . . . . . . . . . . . . . . 20

Checking that Version Cue Server is Running . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Exploring the Version Cue SDK Samples and Documentation . . . . . . . . . . . . . . . . . . . . . 22

Creating your First Plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Creating a new Version Cue plug-in project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Adding an Extension to the Manifest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Defining a Class for the Listener Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Associating the Listener Extension to its Implementation Class . . . . . . . . . . . . . . . . . . . . 30

Running the Hello World plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Deploying the Hello World plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Frequently Asked Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Why is Version Cue Server the Target Platform for Plug-in Development? . . . . . . . . . . . . . 34

Why is there a full launch/debug configuration category for Version Cue Server? . . . . . . . . 34

Where do I find the Error Log for Version Cue SDK itself? . . . . . . . . . . . . . . . . . . . . . . . . 35

How can I have my plug-in contribute entries to the Version Cue Server log file? . . . . . . . . 35

Contents

4 Getting Started with Adobe Version Cue CS3 Development

Getting Started with Adobe Version Cue CS3 Development

This document describes how to get started with development using the Adobe® Version Cue® CS3 SDK. The target audience for this document is systems integrators who need to develop plug-ins for Adobe Version Cue Server™.

Terminology

The following terms are used throughout this document:

z Eclipse — An integrated development environment (IDE) for Java™ (and other languages)

and a run-time environment for applications. Eclipse-based products, like Version Cue Server, use the Eclipse run-time. The Eclipse run-time starts the Eclipse platform base, and it dynamically discovers and loads (on-demand) plug-ins that make up the Eclipse-based product. Version Cue SDK is another Eclipse-based product, based on the Eclipse workbench.

Ter mi no lo gy

z Target platform — The platform for which plug-ins are developed, namely Ver sion Cue

Server.

z <vcsdk> — The path to the folder where you installed Version Cue SDK.

z Version Cue SDK — The SDK used to develop plug-ins for Version Cue Server, which also

has resources to help in developing server-driven scripts for Version Cue clients. This is a pre-configured version of Eclipse, branded by Adobe. It has an integrated development environment (IDE) for developing Version Cue Server plug-ins; it includes custom Adobe plug-ins that provide wizards, samples, Help documentation, and additional features to support development of Version Cue Server plug-ins.

z Version Cue Server — The server component of Version Cue CS3.

Introduction

To start developing plug-ins for Version Cue Server, perform these steps:

1. Check that your machine meets the basic requirements specified in “Development Plat-

forms” on page 6.

2. Set up your machine for development; follow the instructions in “Setting up your Develop-

ment Platform” on page 7.

Getting Started with Adobe Version Cue CS3 Development 5

Getting Started with Adobe Version Cue CS3 Development

Development Platforms

3. Examine the documentation: inspect the Samples guide (accessible from the Welcome page), import the samples from the Welcome page, and compile and run them. See

“Exploring the Version Cue SDK Samples and Documentation” on page 22.

4. Write a plug-in by following the instructions in “Creating your First Plug-in” on page 24.

Development Platforms

Platforms supported for Version Cue plug-in development, and required components, are listed in Ta bl e 1 :

TABLE 1 Supported Development Platforms and Required Components

Platform Component Note

Mac OS

10.4 or later

Mac OS 10.4 or later

Versio n Cue Server (3.1.0)

Versio n Cue SDK (1.1.0)

JRE 1.5 You must have JRE 1.5 installed on your machine;

Mac OS 10.3 and earlier are not supported. You must use 10.4 or later as your development platform on the Mac. Both MacTel and PPC are supported.

Install Version Cue Server from an installer; the SDK expects the Server to be located in the fixed install location.

This is based on Eclipse 3.2 Final (29 June 2006), configured with Adobe plug-ins, preferences, and other features to help developing plug-ins for Version Cue Server. You should install the SDK from the installer.

this is the Java run-time environment required to launch Version Cue SDK. If you have been accepting software updates from Apple, this should be installed.

Getting Started with Adobe Version Cue CS3 Development

Platform Component Note

Setting up your Development Platform

Windows XP or later (Vista)

XP: Service Pack 1 or higher

Versio n Cue Server (3.1.0)

Versio n Cue SDK (1.1.0)

JRE 1.5 You must have JRE 1.5 installed on your machine,

Version Cue Server must be installed on a local NTFS-formatted drive, not a FAT/FAT32 drive. We recommend you do not install on a mapped network drive.

Install Version Cue Server from an installer; the SDK expects the Server to be located in the fixed install location.

which is the Java run-time environment required to launch the Version Cue SDK; visit http://java.sun.com/downloads/ if you do not have this already. Note that JDK 1.6 is not currently a supported development environment.

Other components you will need to work with the Version Cue SDK are listed in Ta bl e 2 :

TABLE 2 Other Required Components

Component Note

Adobe Reader 7.0 or later This is required to view Adobe PDF documentation.

Adobe Creative Suite® 3 point products

Use point products such as Adobe Bridge™ CS3, Adobe Photoshop® CS3, and Adobe InDesign® CS3 to create and work with content in Version Cue CS3 Server. You must use versions compatible with the Version Cue CS3 Server you are using.

Setting up your Development Platform

Installation and Configuration

Before you Begin

z You will need a Suite installer, which will enable you to install Version Cue CS3 Server.

Please run this Suite installer (to install the Version Cue Server) before installing the Version Cue SDK. If you do not do this, then you must update your target platform manually from within the IDE of Version Cue SDK.

Getting Started with Adobe Version Cue CS3 Development 7

Getting Started with Adobe Version Cue CS3 Development

Setting up your Development Platform

z It is recommended to use the latest installer for Version Cue SDK (1.1.0 at the time of writ-

ing). If you already have installed Version Cue SDK 1.0.0 (GM), then you should be able to update to Version Cue SDK 1.1.0 by running the latest installer and upgrading your existing SDK.

z You should be sure that your Version Cue Server is upgraded to 3.1.0, which is the version

required for Version Cue SDK 1.1.0. This also requires you to upgrade your Adobe Bridge CS3 application to 2.1 and be sure that Version Cue client libraries are upgraded to 3.1.0.

z You must have at least one point product in Creative Suite CS3 installed, such as Adobe

Bridge CS3, and it should be a build that is known to work with the Version Cue Server you have installed. It is recommended that you have Version Cue SDK 1.1.0, Version Cue Server 3.1.0, Version Cue Client 3.1.0 and Adobe Bridge CS3 2.1.

If you already have Adobe Creative Suite 1 installed, you must remove it, since it is not compatible with Version Cue CS3. Before removing Adobe Creative Suite 1, export any valuable files stored in Version Cue CS1 to another computer, using the Administration user interface.

If you already have Adobe Creative Suite 2 installed, export any valuable files stored in Version Cue CS2 to another computer and stop Version Cue CS2 (see “Stopping Version Cue CSx” on

page 12).

Installing the Version Cue SDK

You already should have installed Creative Suite CS3, and downloaded Version Cue SDK installer for your platform. To start working with the SDK, follow these steps:

1. It is recommended to upgrade Version Cue Server and Client components to 3.1.0 (the latest at the time of writing), and Adobe Bridge CS3 to version 2.1. In this case, you must use Version Cue SDK 1.1.0 (dot release). Note that some of the new samples (sample.remoteproject, for instance) added between Version Cue SDK 1.0.0 and 1.1.0 depend on using Version Cue Server 3.1.0, since there were some additions the API for Version Cue Server 3.1.0.

2. Install Version Cue SDK 1.1.0 (dot release). If you already have installed Version Cue SDK

1.0.0 (GM), then you should be able to update to Version Cue SDK 1.1.0 by simply running the latest installer and choosing the option to update your existing SDK.

3. Install the SDK to a drive with at least 500 MB of free space (and preferably more). On Windows, use an NTFS-formatted drive (not FAT/32 nor a network drive).

4. For the rest of this document, we refer to the folder path containing the installed Version Cue SDK and other components as <vcsdk>. Note that the installer will by default install into these folders:

c:\Program Files\Adobe\Adobe Version Cue CS3 SDK\ (Windows) /Applications/Adobe/Adobe Version Cue CS3 SDK/ (Mac OS)

5. Examine the <vcsdk> folder- its contents are shown Table 3 . Note the PDF documentation is in the sdk.docs folder. Conceptual documentation can also be found under Version Cue SDK Help, along with reference documentation like the server Java API Reference, Extension Point Reference and Client Scripting Reference.

Getting Started with Adobe Version Cue CS3 Development

Setting up your Development Platform

TABLE 3 Version Cue SDK Content

Folder/ file name Description

“VersionCueSDK” Folder containing the IDE for Version

Cue SDK, which contains Adobe branding and plug-ins that customize the base Eclipse IDE. Sample plug-ins must be imported from the Welcome page (or mini-Welcome page) via a wizard.

sdk.docs Folder containing conceptual

documentation, such as the PDF documentation in this table. This content also is in the documentation under Versio n Cue SDK > H e lp.

Readme.txt The Readme file for this SDK.

legal Folder containing End-User License

Agreements, as shown by the SDK installer.

sdk.docs/getting-started.pdf This document.

sdk.docs/programmers-guide.pdf Adobe Version Cue CS3 Server

Programmer’s Guide; this is the Version Cue Server guide for this SDK.

sdk.docs/connecting-external-system.pdf Case Study: Connecting to an External

System through Adobe Version Cue CS3. This is based on the reference implementation CustomProject.

sdk.docs/client-programmers-guide.pdf Version Cue CS3 Client Programmers

Guide. Describes the extensibility features at the client enabled by this SDK and working with the scripting interface to Version Cue CS3 clients.

Running Version Cue SDK for the First Time

To run Version Cue SDK initially, follow these steps:

1. Make sure that you have installed Version Cue SDK from the installer, as described above. If you have updated from Version Cue SDK 1.0.0 (GM) to 1.1.0 (dot release), then you should delete the Eclipse workspace you were using previously and start with a clean, fresh Eclipse workspace.

2. Run the Version Cue SDK application in the <vcsdk>/VersionCueSDK folder. During start-up, you should see an Adobe-branded splash-screen.

Getting Started with Adobe Version Cue CS3 Development 9

Getting Started with Adobe Version Cue CS3 Development

Setting up your Development Platform

3. When prompted to select a workspace, choose a new folder, <vcsdk>/workspace, and check “Use this as the default…”.

4. Note that you should look in the "VersionCue.log" created on first startup to confirm there are no errors; if everything is set up correctly, the only information in the log should be that the target platform has been changed correctly. You can find this log file in the Eclipse workspace you choose, in the folder <vcsdk>/workspace/vc-data/logs.

5. From the Welcome screen, you can import sample plug-ins. They are organized into functional categories; a sample can fall into multiple categories. Choose one or more categories, and one or more sample plug-ins is imported into your workspace. If you already imported a sample plug-in, you are given the chance to replace it. In Figure 1, samples related to notification will be imported.

6. Verify that you can browse the Version Cue SDK programming documentation from both the Welcome screen and the Help system. To check within the Help system, select Help > Help Contents > Adobe Version Cue SDK Help.

FIGURE 1 ImportingSamples from the Welcome Screen via the Wizard

Version Cue SDK sets up the target platform to refer to the Version Cue Server it expects to find in the default installation location for Creative Suite CS3. If you install the Version Cue Server after the SDK, you need to set the target platform manually ; see “Plug-in Development

Target Platform Preferences” on page 10.

Plug-in Development Target Platform Preferences

If you install Version Cue Server and then the SDK, you should not need to change settings related to the target platform, as they are set up automatically by Version Cue SDK. However, if you inadvertently install Version Cue Server after the SDK, then you will need these steps.

To set preferences for the plug-in development target platform, follow these steps:

Getting Started with Adobe Version Cue CS3 Development

Setting up your Development Platform

1. Select Window > Preferences > Plug-in Development > Target Platform. The preferences dialog for the target platform opens.

2. Verify the Location field is set to refer to the installed Version Cue Server. Change it to this path if needed- for instance, if you have installed the Server after the SDK and the target platform is not defined. The installation paths are as follows:

/Library/Application Support/Adobe/Adobe Version Cue CS3/Server/ (Mac OS) C:\Program Files\Common Files\Adobe\Adobe Version Cue CS3\Server\ (Win)

Java Compiler Preferences

This section is for information only. You should not need to change settings related to compiler preferences, as they already are set up for you within the Version Cue SDK IDE.

To set Java compiler preferences, follow these steps:

1. Select Window > Preferences > Java > Compiler,. The preferences dialog for the Java compiler opens.

2. Verify the option for JDK compliance level is set to 5.0, meaning JDK 1.5.

3. Verify the option “Generated .class files compatibility” is set to 5.0.

4. Verify the option “Source compatibility” is set to 5.0.

From within the IDE, you can switch to the Java perspective by selecting Window > Open Perspective > Java.

Java Installed JREs Preferences

N OTE: Windows: before you can launch Version Cue SDK for the first time, you must have

JRE 1.5 installed on your machine. Once you launch Version Cue SDK, you can switch the JRE preference to the one supplied with the installed Version Cue Server.

1. Select Window > Preferences > Java > Installed JREs. The Installed JREs dialog for the Java compiler opens.

2. Choose the JRE for your platform: On Windows, add the JRE that Version Cue Server uses, in a subfolder “jre” of the installation folder. If you have other JREs installed, they also are listed. Check the box for the Version Cue Server JRE; see Figure 2. On Mac OS, verify you are using the Mac OS JRE 1.5; see Figure 3.

3. The IDE may ask whether you want to do a full rebuild. Answer Yes.

Getting Started with Adobe Version Cue CS3 Development 11

+ 25 hidden pages