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 tradema
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 . . . . . . . . . . . . . . . . . . . . . . . . . .
tempPosting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 undoCheckOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 undoSend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 INDEX 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
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.
To access the CPS Console from Contribute: 1. 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. 2.
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.
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.
3. 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: a Right-click My Computer, and then select Manage.
To access and use the Simple File Deployment service: 1. 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. 2. 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.
Setting up the RSS Activity Feed service The RSS Activity Feed service produces a syndication feed that lists Publish, Delete, and Roll Back events that occur to pages in any folder on your website. Before you use the RSS Activity Feed service, you need to complete some set-up tasks. To set up the RSS Activity Feed service: 1. Open the settings.
c In the right pane, double-click Macromedia Contribute Publishing Server. The Properties dialog box appears. d Select the Log On tab, and then select the Select this Account option. e 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. 5.
The log file is written to the following directory: C:\Program Files\Macromedia\Contribute Publishing Server\jrun4\servers\default\contribute\WEBINF\pubserver\sites\siteID\logs\events.log Where siteID is an identifier assigned to each site. To view the events log for a website: 1. Open the CPS Console (see “Accessing the Contribute Publishing Server Console” on page 5). The CPS Console appears. 2.
Forwarding website events to a custom service After you write and install a custom service, or after you set up the Simple File Deployment or RSS Activity Feed service, you need to configure the Forwarding service to send events for each website to the new service. You can stop forwarding events at any time. To configure the Forwarding service to send events to another service: 1. Open the CPS Console, if it’s not already open (see “Accessing the Contribute Publishing Server Console” on page 5).
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.
Note: Custom services are supported through the Forwarding service, which passes along the event data through additional web service invocations. An Example Publish Event Contribute Contribute Publishing Services Website 1 Website Contribute publishes a page to website. E-mail Service Log Service and CPS Server 2 Contribute sends publish event to CPS server. 3 4 CPS server sends event to CPS services for the website. Forwarding Service sends event to custom services.
Related topics: • “About extending the Simple File Deployment service” on page 20 • “API data types” on page 22 • “Web service methods” on page 23 Creating a custom publishing service The Contribute Publishing Server (CPS) API enables you to write custom services to add more server-side functionality.
Related topics • • • • “Contribute Publishing Server API overview” on page 15 “About extending the Simple File Deployment service” on page 20 “API data types” on page 22 “Web service methods” on page 23 Write a web service that implements the CPS API The first step in creating a custom service for CPS is to write a web service that implements the CPS API. You can write the service in any language that supports web services, such as Macromedia ColdFusion MX. Note: CPS is supported by ColdFusion MX 6.
To use the adapter file, place a copy of it in the same directory as the CFC file you wish to adapt, and then rename the CFML file to match the CFC filename. For example, to adapt CustomService1.cfc, copy the ContributeService.cfm file into the folder that contains the CFC, and then rename it to CustomService1.cfm. Be sure to use CustomService1.cfm for the URL of the web service instead of the CFC.
Viewing the CPS Error Log You can view the CPS Error Log to see errors that occur when CPS starts or when CPS invokes the Log service, E-mail Notification service, or a custom service. The log is located in the following locations: • For the Simple Installation of CPS: C:\Program Files\Macromedia\Contribute Publishing Server\jrun4\servers\contribute-wps\contribute\WEBINF\pubservices\logs\error.
• Detection of file changes by other applications You can add functionality so that the service is aware when files have been changed by applications other than Contribute, such as Macromedia Dreamweaver. • Removal of extra files You can enable the service to remove certain extraneous file types, including image references on a page. • A hierarchal view of files You can enhance the file viewer so that it’s easier to see which files have been changed and need to be deployed to the live server.
Related topics: • “Creating a custom publishing service” on page 17 • “API data types” on page 22 • “Web service methods” on page 23 About extending the RSS Activity Feed service You can use the RSS Activity Feed service to produce a syndication feed that lists changes that occur in any folder on your website. Then, you can use a news reader or aggregator to view the output of the syndication feed.
• clientID is the same as the username. Location The Location object describes where the file or directory can be found. It has the following elements: • siteURI is the URL of the website where the file resides. An example of a siteURI value is "http://www.myserver.com/mysite". • itemURI is the URL of the specific file. An example of an itemURI value is "http:// www.myserver.com/mysite/page1/moviestars.htm". • itemPath is the file system path to the file.
adminChange Description Invoked when the user changes the administration settings, after clicking the Close button. Arguments location, user The location argument is a Location object that specifies the site on which administration is being changed. The user argument is a User object that describes the person who is changing the administration settings. adminRemove Description Invoked when the Remove Administration option is invoked, so that the site is no longer managed by Contribute.
The draftLocation argument is a Location object that specifies the location of the temporary file containing the edited version of the page. changeOwner Description Invoked when an administrator clicks the Change Owner button in the Managed Drafts panel. Arguments location, user, draftLocation, recipient, comments The location argument is a Location object that specifies the file on which to change ownership.
inboxEdit Description Invoked when a user initiates an edit on a draft in his or her mailbox. Arguments location, user, draftLocation The location argument is a Location object that specifies the target location of the file being edited. The user argument is a User object that describes the user who is editing the draft. The draftLocation argument is a Location object that specifies the location of the temporary draft that is has been sent for review.
The location argument is a Location object that specifies the location of the directory to be removed. The user is a User object that describes the person who is deleting the directory. rollBack Description Invoked when a user rolls back a published page to obtain the previous version. Arguments location, user The location argument is a Location object that specifies the file to be rolled back. The user argument is a User object that describes the person is rolling back the web page.
The draftLocation is a Location object that specifies the location of the temporary file containing the edited version of the page. undoCheckOut Description Invoked when an administrator deletes from review in the Manage Draft panel a draft that has been sent for review. Arguments location, user, draftLocation The location argument is a Location object that specifies the file for which the checkout is to be undone. The user is a User object that describes the user who is undoing the checkout.
INDEX A adminChange() 24 administration 23 administration methods 23 adminRemove() 24 API about 15 events content 16 architecture, CPS 15 C cancel() 24 cancelIndboxEdit() 24 changeOwner() 25 Contribute Publishing Server about 15 API 16 architecture 15 creating a custom service 17 events content 16 Contribute Publishing Server Console password 13 CPS See Contribute Publishing Server custom service creating 17 examples 17 D delete() 25 E edit() 25 events, content 16 extending CPS API to create a custom servi
S sendForReview() 27 server notifications about 17 objects 22 T tempPosting() 27 U undoCheckOut() 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 publish() 26 removeDirectory() 26 rollback() 27 sendForReview() 27 tempPosting() 27 undoCheckOut() 28 undoSend() 28 30 Index
