background image

15

CHAPTER 2

Extending Contribute Publishing Server 

Macromedia Contribute Publishing Server (CPS) includes logging, e-mail notification, and user 
management services. There are also two other services that you can use as they are, or you can 
extend to meet your needs. 

Using the CPS API, you can extend an existing service, or you can write custom services to add 
more server-side functionality.

This chapter contains the following sections:

“Contribute Publishing Server API overview” on page 15

“Creating a custom publishing service” on page 17

“About extending the Simple File Deployment service” on page 20

“About extending the RSS Activity Feed service” on page 22

“API data types” on page 22

“Web service methods” on page 23

Contribute Publishing Server API overview

Contribute Publishing Server has components of a server application that run on a server. When 
you enable a website to use CPS, you specify the address of this server. This instructs all the 
Contribute clients that interact with that website to send a stream of event data to CPS. These 
events (editing, publishing, sending for review, and so on) represent users’ actions and are 
transmitted as Simple Object Access Protocol (SOAP) web service messages. 

CPS is built on these events. For example, the Logging service logs the event data to a file on the 
server, and the E-mail Notification service e-mails users about pages sent for review. The User 
Directory service uses a separate web service API for extending how Contribute selects, 
authenticates, and retrieves connections for users.

Summary of Contents for CONTRIBUTE 3-CONTRIBUTE PUBLISHING SERVER

Page 1: ...CONTRIBUTE 3 Contribute Publishing Server...

Page 2: ...a Software ASA and its suppliers All rights reserved Copyright 2005 Macromedia Inc All rights reserved This manual may not be copied photocopied reproduced translated or converted to any electronic or...

Page 3: ...anging 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...

Page 4: ...4 Contents tempPosting 27 undoCheckOut 28 undoSend 28 INDEX 29...

Page 5: ...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...

Page 6: ...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 1 In a web browser enter the URL for the CPS Console T...

Page 7: ...e Help To enable or disable the E mail or Log service 1 Open the CPS Console see Accessing the Contribute Publishing Server Console on page 5 The CPS Console appears 2 If the Website Settings options...

Page 8: ...mplementation 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 1 Open the set...

Page 9: ...k 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 5 Synchronize your staging and live servers The...

Page 10: ...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...

Page 11: ...atchURI indicates the folder the RSS Activity Feed service monitors for changes Any Publish Delete or Roll Back events that occur to pages in this folder or any subdirectory produces an entry in the s...

Page 12: ...nd Roll Back events in specified folders You can use a news reader or aggregator such as the one in Macromedia Central to view your syndication feed To install Macromedia Central to access the RSS Act...

Page 13: ...CPS Console password at any time The password is for logging in to console it is not specific to any website connection Be sure to record your password somewhere so you don t forget it Tip If you forg...

Page 14: ...ite pop up menu 4 Click the Other Services tab The Other Services options appear 5 Do either of the following To start forwarding website events to a custom service click the Add button enter the URL...

Page 15: ...types on page 22 Web service methods on page 23 Contribute Publishing Server API overview Contribute Publishing Server has components of a server application that run on a server When you enable a web...

Page 16: ...has a method for each type of event Every type of event has a location and a user defined as follows Location describes the site URI and file path related to the event User describes the username and...

Page 17: ...or the title author or date of documents Enhancing the draft review process You can write a server side script to create more detailed reports or to trigger more e mail notifications such as one that...

Page 18: ...services_code simplelogger Examples for the CPS WAR File Installation are located at C Program Files Macromedia Contribute Publishing Server customservices_code simplelogger For each language the exam...

Page 19: ...protocol HTTP isn t encrypted and is faster than HTTPS which is the protocol you d have to use to protect the security of event data if the applications were on two computers Note If you decide to ins...

Page 20: ...e finished viewing the log click Close About extending the Simple File Deployment service You can use the Simple File Deployment service as a starting point for creating a service that meets your spec...

Page 21: ...of the following files as desired 3 After you extend the Simple File Deployment service and are ready to use it see Accessing and using the Simple File Deployment service on page 9 Note If you have n...

Page 22: ...ever is not sufficient for extending the service You must have the full version of the ColdFusion server running to extend the uncompiled code To find the RSS Activity Feed service files for extending...

Page 23: ...y refers to a website Web service methods The following methods are web service procedures that the Contribute client call when certain events occur All these methods must be implemented in the web se...

Page 24: ...s a Location object that specifies the site for which administration has been removed The user argument is a User object that describes the user who removed administration of the site cancel Descripti...

Page 25: ...n of the temporary file containing the edited version of the page The recipient argument is an array of User objects that specifies the users who received the draft for review The comments argument is...

Page 26: ...creates a site directory Arguments location user The location argument is a Location object that specifies the location of the site The user argument is the name of the person who requests creation of...

Page 27: ...a Location object that specifies the location of the document for review The user argument is a User object that describes the user who is sending the document for review The draftLocation argument i...

Page 28: ...e checkout is to be undone The user is a User object that describes the user who is undoing the checkout The draftLocation argument is a list of Location objects that specifies the WIP version of the...

Page 29: ...ting 17 examples 17 D delete 25 E edit 25 events content 16 extending CPS API to create a custom service 17 F file management methods 23 I inbox edit 23 inbox edit methods 23 inboxEdit 26 L Location n...

Page 30: ...28 User notification object 22 W web service methods 23 adminChange 24 adminRemove 24 cancel 24 cancelIndboxEdit 24 changeOwner 25 delete 25 edit 25 file management 23 inboxEdit 26 makeDirectory 26 p...

Reviews: