MACROMEDIA CONTRIBUTE 3-CONTRIBUTE PUBLISHING SERVER User manual

CONTRIBUTE



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.

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

CONTENTS

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

4 Contents

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

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

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

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

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.

6 Chapter 1: Using Contribute Publishing Server

To access the CPS Console from Contribute:

In Contribute, select Edit > Administer Websites (Windows) or Contribute > Administer

Websites (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.

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

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 Website 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.

8 Chapter 1: Using Contribute Publishing Server

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:

<Site>

<URI>http://contribute-staging/teamwebsite</URI>

<FileSystemPath>c:\\contributestaging\teamwebsite</FileSystemPath>

</Staging>

<Live>

<URI>http://contribute.macromedia.com/teamwebsite</URI>

<FileSystemPath>\\contribute\teamwebsite</FileSystemPath>

Using the Simple File Deployment service 9

</Live>

</Site>

<Site>

</Site>

</SiteList>

Make sure that your server is running 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.

10 Chapter 1: Using Contribute Publishing Server

To access and use the Simple File Deployment service:

In a browser, enter the address for the Simple File Deployment service.

The default install path is https://server:8900/contribute/customservices/

filedeployer/.

The Simple File Deployment service shows a list of files that have been published, deleted, or

rolled back on the staging server.

Select the check box beside each file you want to deploy to the live server.

Tip: Click the Select All button to select all the files at once. You can click the Deselect All button

if you decide that you don’t want to deploy all the file changes.

The following icons indicate the type of change made to the file on the staging server.

Click the Deploy button to deploy the selected file changes to the live server.

Contribute updates your live server with the new files.

Using the RSS Activity Feed service

Contribute Publishing Server (CPS) provides an RSS Activity Feed service that adds a syndication

feed to your website to report changes that occur on the website.

The RSS Activity Feed service converts Publish, Delete, and Roll Back events into a syndication

feed based on the Atom specification. Atom is an XML-based web content and metadata

syndication format that creates lists of information, or feeds. Feeds contain a number of items, or

entries, and are typically viewed with a news reader or aggregator.

Note: For more information on the Atom specification, see www.atomeanbled.org.

Changes to pages in specified folders on your websites appear as individual entries in the

syndication feed. You can use this information to monitor activity on your websites managed by

CPS. To use the service, you need to perform some set-up tasks, and then use a news reader or

aggregator to view the output from the service.

Note: You can use the compiled version of this service as is, or you can extend the uncompiled

version to meet your specific needs. For information about extending the service, see “About

extending the RSS Activity Feed service” on page 22.

Icon Change to file

Published

Deleted

Rolled back to a previous version

This manual suits for next models

Table of contents

Other MACROMEDIA Software manuals

MACROMEDIA

MACROMEDIA FLASH 8-LEARNING ACTIONSCRIPT 2.0 IN FLASH User manual

MACROMEDIA

MACROMEDIA DIRECTOR MX 2004-USING DIRECTOR Mounting instructions

MACROMEDIA

MACROMEDIA COLFUSION MX 7-CFML Service manual

MACROMEDIA

MACROMEDIA FREEHAND MX 11 Mounting instructions

MACROMEDIA

MACROMEDIA STUDIO 8-EXPLORING STUDIO 8 User manual

MACROMEDIA

MACROMEDIA COLFUSION MX 7-MIGRATING APPLICATIONS TO COLDFUSION MX... User manual

MACROMEDIA

MACROMEDIA DREAMWEAVER MX 2004-DREAMWEAVER API Service manual

MACROMEDIA

MACROMEDIA CONTRIBUTE 3 - USING AND ADMINISTERING... Mounting instructions

MACROMEDIA

MACROMEDIA BREEZE 5-MANAGER User manual

MACROMEDIA

MACROMEDIA FLASH 8-USING FLASH VIDEO ENCODER Mounting instructions

MACROMEDIA

MACROMEDIA FLASH 8-COMPONENTS LANGUAGE Service manual

MACROMEDIA

MACROMEDIA DIRECTOR MX 2004-USING DIRECTOR Mounting instructions

MACROMEDIA

MACROMEDIA FLEX - DEVELOPING COMPONENTS AND THEMES User manual

MACROMEDIA

MACROMEDIA FLASH 8-LEARNING FLASH LITE 1.X ACTIONSCRIPT User manual

MACROMEDIA

MACROMEDIA FLEX-FLEX ACTIONSCRIPT LANGUAGE Service manual

MACROMEDIA

MACROMEDIA BREEZE-USING THE BREEZE PLUG-IN FOR MICROSOFT... Mounting instructions

MACROMEDIA

MACROMEDIA COLDFUSION STUDIO 4.5-USING COLDFUSION... Mounting instructions

MACROMEDIA

MACROMEDIA FLASH MX 2004-FLASH JAVASCRIPT DICTIONARY User manual

MACROMEDIA

MACROMEDIA BREEZE-CLUSTERING BREEZE PRESENTATION... User manual

MACROMEDIA

MACROMEDIA COLDFUSION 4.5-DEVELOPING WEB User manual

MACROMEDIA

MACROMEDIA BREEZE PRESENTER User manual

MACROMEDIA

MACROMEDIA DIRECTOR MX 2004-USING DIRECTOR Mounting instructions

MACROMEDIA

MACROMEDIA FIREWORKS 8-EXTENDING FIREWORKS User manual

MACROMEDIA

MACROMEDIA COLFUSION MX 7 - INSTALLING AND USING COLDFUSION... User manual

Popular Software manuals by other brands

COMPRO

COMPRO COMPROFM manual

Muratec

Muratec OFFICEBRIDGE ONLINE user guide

Oracle

Oracle Contact Center Anywhere 8.1 installation guide

Adobe

Adobe 65007312 - Photoshop Lightroom Programmer's guide

Avaya

Avaya NULL One-X for RIM Blackberry user guide

HP ProLiant BL420c user guide

PS Audio

PS Audio PowerPlay Programming manual

Brady

Brady LOCKOUT PRO 3.0 Administrator's guide

Avaya

Avaya Interaction Center user guide

Texas Instruments

Texas Instruments TI-83 Plus Silver Edition Guide book

Novell

Novell GROUPWISE 8 - INTERNET AGENT manual

Oracle

Oracle Application 9i Configuration guide

Acer

Acer RDM user guide

Canon

Canon Vixia HF21 instruction manual

Canon

Canon ZR950 instruction manual

Samsung

Samsung Auto Backup user manual

Polycom

Polycom Vortex EF2201 Application note

Brocade Communications Systems

Brocade Communications Systems Brocade 8/12c user manual