Macromedia CONTRIBUTE 3 User Manual

CONTRIBUTE3

Contribute Publishing Server

Trademarks

1 Step RoboPDF, ActiveEdit, ActiveTest, Authorware, Blue Sky Software, Blue Sky, Breeze, Breezo, Captivate, Central, ColdFusion, Contribute, Database Explorer, Director, Dreamweaver, Fireworks, Flash, FlashCast, FlashHelp, Flash Lite, FlashPaper, Flex, Flex Builder, Fontographer, FreeHand, Generator, HomeSite, JRun, MacRecorder, Macromedia, MXML, RoboEngine, RoboHelp, RoboInfo, RoboPDF, Roundtrip, Roundtrip HTML, Shockwave, SoundEdit, Studio MX, UltraDev, and WebHelp are either registered trademarks or trademarks of Macromedia, Inc. and may be registered in the United States or in other jurisdictions including internationally. Other product names, logos, designs, titles, words, or phrases mentioned within this publication may be trademarks, service marks, or trade names of Macromedia, Inc. or other entities and may be registered in certain jurisdictions including internationally.

Third-Party Information

This guide contains links to third-party websites that are not under the control of Macromedia, and Macromedia is not responsible for the content on any linked site. If you access a third-party website mentioned in this guide, then you do so at your own risk. Macromedia provides these links only as a convenience, and the inclusion of the link does not imply that Macromedia endorses or accepts any responsibility for the content on those third-party sites.

Copyright © 2005 Macromedia, Inc. All rights reserved. This manual may not be copied, photocopied, reproduced, translated, or converted to any electronic or machine-readable form in whole or in part without written approval from Macromedia, Inc. Notwithstanding the foregoing, the owner or authorized user of a valid copy of the software with which this manual was provided may print out one copy of this manual from an electronic version of this manual for the sole purpose of such owner or authorized user learning to use such software, provided that no part of this manual may be printed out, reproduced, distributed, resold, or transmitted for any other purposes, including, without limitation, commercial purposes, such as selling copies of this documentation or providing paid-for support services.

Acknowledgments

Project Management: Jennifer Rowe

Writing: Chris Bedford, Jennifer Rowe

Managing Editor: Rosana Francescato

Editing: Mary Kraemer, Barbara Milligan, Lisa Stanziano, Anne Szabla

Production Management: Patrice O’Neill

Media Design and Production: Adam Barnett, Aaron Begley, John Francis, Mario Reynoso

Special thanks to Ken Sundermeyer, Eric Lerner, Chris Denend, Joel Huff, Lawson Hancock, Erik Larson, Sheila McGinn, Emilio Passi, Yoko Bayer, Scott Richards, Melissa Baerwald, Deb Galdes, Kimberly Oslob, Dennis Griffin, Jon Varese, Brady Kroupa, Josh Margulis, Gavin Anderson, Deeje Cooley, Vickie Chapman, Kaori McLister, and the Contribute engineering and QA teams.

Fourth Edition: July 2005

Macromedia, Inc. 601 Townsend St.

San Francisco, CA 94103

CHAPTER 1: Using Contribute Publishing Server . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Accessing the Contribute Publishing Server Console . . . . . . . . . . . . . . . . . . . . . . . . 5

Enabling or disabling E-mail and Log services for a website. . . . . . . . . . . . . . . . . . . 7

Using the Simple File Deployment service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Setting up the Simple File Deployment service. . . . . . . . . . . . . . . . . . . . . . . . . . 8

Accessing and using the Simple File Deployment service . . . . . . . . . . . . . . . . . . 9

Using the RSS Activity Feed service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Setting up the RSS Activity Feed service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Accessing the RSS Activity Feed service file . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Viewing the events log for a website . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Changing your CPS Console password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Forwarding website events to a custom service. . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

CHAPTER 2: Extending Contribute Publishing Server . . . . . . . . . . . . . . . . . . . . . 15

Contribute Publishing Server API overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Creating a custom publishing service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Write a web service that implements the CPS API . . . . . . . . . . . . . . . . . . . . . . 18

Installing the custom service on a server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Testing and troubleshooting your custom service . . . . . . . . . . . . . . . . . . . . . . . 19

About extending the Simple File Deployment service . . . . . . . . . . . . . . . . . . . . . . 20

About extending the RSS Activity Feed service . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

API data types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Web service methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

adminChange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

adminRemove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

cancel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

cancelInboxEdit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

changeOwner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

inboxEdit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

makeDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

publish . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

removeDirectory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

rollBack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

sendForReview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

tempPosting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

undoCheckOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

undoSend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

INDEX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

4 Contents

CHAPTER 1

Using Contribute Publishing Server

Macromedia Contribute Publishing Server (CPS) is a user management and publishing solution that lets Contribute administrators manage large groups of Contribute users and monitor what those users do on the website.

CPS has an administration console that enables you to view settings for the User Directory, Log, and E-mail services, and to view settings for each website you’ve enabled CPS for.

CPS also has the Simple File Deployment and RSS Activity Feed services, which are not available through the console, but you can use them as they are or extend to meet your needs.

This chapter contains the following sections:

• “Accessing the Contribute Publishing Server Console” on page 5

• “Enabling or disabling E-mail and Log services for a website” on page 7

• “Using the Simple File Deployment service” on page 8

• “Using the RSS Activity Feed service” on page 10

• “Viewing the events log for a website” on page 12

• “Changing your CPS Console password” on page 13

• “Forwarding website events to a custom service” on page 14

Accessing the Contribute Publishing Server Console

The Contribute Publishing Server (CPS) Console enables you to configure the User Directory service, specify an SMTP mail server to use with the E-mail Notification service, and configure the Log service settings. You can also use the console to configure your CPS settings for your website.

You can access the console from Contribute, or from an external web browser.

Note: The CPS Console requires that you have Flash Player 7 installed on your computer.

To access the CPS Console from Contribute:

In Contribute, select Edit > Administer Websites (Windows) or Contribute > Administer Web si te s (Macintosh), and then select the website you want to administer from the submenu.

If the website has no administrator, click Yes when a dialog box asks whether you want to become the website administrator. Then enter and confirm an administrator password for the website, and click OK.

The Administer Website dialog box appears.

Select the Publishing Server category from the list on the left.

The Publishing Server options appear.

Click the Publishing Server Console link.

The Log In dialog box appears.

Enter the CPS administrator password, and then click Login to log in to the CPS Console.

The Website Settings options of the CPS Console appear.

To access the CPS Console from a web browser:

In a web browser, enter the URL for the CPS Console.

The URL for the CPS Console is https://hostname:port/contribute/admin/server.cfm, and uses the following variables:

hostname is the server computer’s DNS name or IP address.

port is the network port number used by the CPS.

Tip: If you used the CPS Simple Installation (the version that includes a pre-configured Java application server) the URL for the CPS Console is https://localhost:8900/contribute/admin/. If you used the CPS WAR File Installation within an existing Java application server, the port number will vary with your application server’s configuration

The Log In dialog box appears.

Enter the CPS administrator password, and then click Login to log in to the CPS Console.

The Overview section of the CPS Console appears.

6 Chapter 1: Using Contribute Publishing Server

Tip: To easily open the CPS Console, try adding a bookmark in your browser.

Enabling or disabling E-mail and Log services for a website

You can enable or disable the E-mail and Log services for any website you’ve enabled Contribute Publishing Server (CPS) for.

The E-mail service automatically sends e-mail messages to users notifying them status of drafts sent for review. The Log service monitors website activity.

If you want to disable the User Directory service for a website, you need to do so from Contribute. For more information, see Administering Contribute in Contribute Help.

To enable or disable the E-mail or Log service:

Open the CPS Console (see “Accessing the Contribute Publishing Server Console” on page 5).

The CPS Console appears.

If the Website Settings options are not showing, select Website Settings from the Service Settings list on the left.

The Website Settings options appear in the CPS Console.

Select a website from the Web si te pop-up menu.

For the E-mail service, select or deselect the following options:

■ The Notify users when they receive a draft for review option sends an e-mail message when

a user receives a draft for review.

■ The Notify users when their sent drafts change in status option sends an e-mail message

when a user’s draft change status.

For the Log service, select or deselect the Maintain a log of website changes check box.

Click Save Settings to save your settings.

Enabling or disabling E-mail and Log services for a website 7

Using the Simple File Deployment service

Contribute Publishing Server (CPS) provides an extensible framework for a Simple File Deployment service that you can modify to meet your needs for moving files from a staging or testing server to a live server.

You can use the compiled version of this service as is, but it is intended to be a starting point for you to extend the functionality for your specific needs. You can extend the uncompiled version of the service.

Note: For information about extending the service, see “About extending the Simple File

Deployment service” on page 20.

Whether you extend the service or decide to use it as is, you should complete the set-up tasks before you start using the service.

Setting up the Simple File Deployment service

Before you use the Simple File Deployment service, you need to complete some set-up tasks.

Note: If you extended the service, you might not need to complete all the set-up steps, but you should review the set-up procedure to make sure you complete any necessary steps for your implementation.

After you complete the set-up tasks, you can start using the service to move files from your staging server to your live server.

To set up the Simple File Deployment service:

Open the settings.xml file, which is located in the following directory:

C:/Program Files/Macromedia/Contribute Publishing Server/jrun4/servers/

contribute-wps/contribute/customservices/filedeployer

Note: If you plan to extend the service, open the settings.xml file for the uncompiled version of the code in C:/Program Files/Macromedia/Contribute Publishing Server/jrun4/servers/contribute- wps/contribute/customservices_code/filedeployer.

In the settings.xml file, add the URI (web addresses) and FileSystemPath for the staging and live servers for each website you want to use this service, and then save and close the file.

Note: The staging server URI must match the web address (URL) of a website you’ve connected to in Contribute for the event notifications to work properly between Contribute and the Simple File Deployment service.

For example:

<Staging> <URI>http://contribute-staging/teamwebsite</URI> <FileSystemPath>c:\\contributestaging\teamwebsite</FileSystemPath>

</Staging>

<Live> <URI>http://contribute.macromedia.com/teamwebsite</URI> <FileSystemPath>\\contribute\teamwebsite</FileSystemPath>

8 Chapter 1: Using Contribute Publishing Server

</Live>

</Site>

<Site>

</Site>

</SiteList>

Make sure that you r server is runni ng with a user that has sufficient network permissions to copy files on the staging and live servers.

If you are using Windows, many servers run, by default, with the local system user (which probably has limited network access). To change a server’s user on Windows, do the following:

Right-click My Computer, and then select Manage.

The Computer Management dialog box appears.

Expand the Services and Applications node, and then select Services.

In the right pane, double-click Macromedia Contribute Publishing Server.

The Properties dialog box appears.

Select the Log On tab, and then select the Select this Account option.

Enter your user name and password, and then click OK.

The user name and password you enter must have permission to copy files between the staging and the live servers.

Now you need to forward client notifications to your Simple File Deployment service, so that the service knows about publish, delete, and roll back actions that occur on the website.

Complete the procedure in “Forwarding website events to a custom service” on page 14, and then return to this procedure.

Synchronize your staging and live servers.

The file structure and content on your staging and live servers must match exactly before you can start using the Simple File Deployment service.

Now you can start using the Simple File Deployment service (see “Accessing and using the

Simple File Deployment service” on page 9), or you can extend the service before you use it (see “About extending the Simple File Deployment service” on page 20

Note: Macromedia recommends that you extend the functionality of this service; you should at least add authentication functionality before you use it.

Accessing and using the Simple File Deployment service

After you set up the Simple File Deployment service (see “Setting up the Simple File Deployment

service” on page 8), you can start using the service to move files from your staging server to your

live server.

Note: This procedure is for using the service as is. Macromedia recommends that you extend the service to meet your specific needs (see “About extending the Simple File Deployment service”

on page 20). If you extend the service, you should modify the steps for accessing and using the

service accordingly.

Using the Simple File Deployment service 9

+ 21 hidden pages