16
Chapter 2: Extending Contribute Publishing Server
Note:
Custom services are supported through the Forwarding service, which passes along the event
data through additional web service invocations.
Figure 1. How a publish event is posted to CPS and forwarded to a custom service.
Contribute sends events after an operation completes. 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.
The CPS API 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 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.
CPS
Server
CPS server sends
event to CPS services
for the website.
3
Forwarding Service
sends event to custom
services.
4
An Example Publish Event
Contribute
Contribute publishes
a page to website.
1
Contribute sends
publish event to CPS
server.
2
and
Contribute Publishing
Services
Simple File
Deployment
Service
Your Custom
Service
RSS Activity
Feed Service
Service
Log
Service
Website
Website
