User manual MACROMEDIA CONTRIBUTE 3-CONTRIBUTE PUBLISHING SERVER

[. . . ] 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. [. . . ] Select the website you want to use this service from the Website pop-up menu. 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 for your service in the Add Forwarding Service dialog box, and then click OK. Tip: The URL for the Simple File Deployment service is: https://localhost:8900/contribute/ customservices/filedeployer/events. cfm. The URL for the RSS Activity Feed service is: https:// localhost:8900/contribute/customservices/rssfeed/events. cfm. To stop forwarding website events to a custom service, select the URL in the Service URL list, and then click the Delete button above the list. Note: If you're using an Secure Sockets Layer (SSL) server, you need to import the server's certificate to the CPS certificate store. 6. Related topics: · "Creating a custom publishing service" on page 17 · "Setting up the Simple File Deployment service" on page 8 · "Setting up the RSS Activity Feed service" on page 11 14 Chapter 1: Using Contribute Publishing Server 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. 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. 15 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 Website Contribute Publishing Services 1 Contribute publishes a page to website. Website E-mail Service and Log Service CPS Server 2 Contribute sends publish event to CPS server. 4 Forwarding Service sends event to custom services. Simple File Deployment Service RSS Activity Feed Service Your Custom Service Figure 1. How a publish event is posted to CPS and forwarded to a custom service. As much as possible, a single user interface operation results in a single event. If multiple files are published when a user clicks the Publish button, Contribute sends a single event but describes all files. If a user interface event affects multiple websites, Contribute sends a single event for each website that is configured to receive events. 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 e-mail of the user who caused the event. Some events provide additional information, such as dependent files published along with a page or users who were sent a draft for review. Note: Timestamps are not included because the server can easily use its own time when the event is received. 16 Chapter 2: Extending Contribute Publishing Server 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. For example, with the CPS API you can make the following types of server-side capabilities possible: · Logging changes to a database for auditing You can write a server-side script to record all site activity against an inventory database. · Automated page-checking at the time of publication You can write a script to check content before it's published. [. . . ] 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. makeDirectory Description Invoked when a user 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 the directory. [. . . ]