CEE Web Services APIs
CEE is extensible through a set of SOAP XML based Web Services APIs. These Web Services provide access to some of the major capabilities of CEE:
- Project & User Administration Framework (HELM): Implement external authentication and permissions and capture user/project based site metrics. The HELM API was introduced in CEE 5.0.
- Project Tracker: Integrate with CEE’s Change Management tool, Project Tracker and use it as an artifact hub to consolidate and synchronize with other artifact types (requirements, defects etc) from other tools/desktops and to connect with other stakeholders (e.g. HP QC & QA Engineers). The PT API was introduced in CEE 4.5.
CEE Core Service
The core CEE web service is Dispatcher. The Dispatcher service provides a generic interface that can take
any
XML document as input and produce an XML document
as the result. This web
service is ideal for scenarios where the XML schema
of the documents is not
static.
The Project Tracker API
CEE's Project Tracker web services API provides programmatic access to Project Tracker functionality allowing you to integrate CEE with other tools in use in the development lifecycle. For example:
- Sales automation: Use data from a customer support ticket entered into Salesforce.com and automatically create a Project Tracker defect artifact to manage the issue through to closure.
- Requirements management: Create requirements and automatically generate Project Tracker action item artifacts so developers can track requirements through to completion.
- QA testing: Write test cases in your test automation tool and automatically create Project Tracker defect artifacts and test case artifacts to track your test results through to resolution.
- Corporate reporting: Pull key data from a variety of business applications for management analysis and decision support.
The HELM API
With the release of CollabNet Enterprise Edition 5.0, basic access to domain, project and membership data is available through the framework API:
- Domain and Project automation: Manage tasks related to the CEE domain and projects. Get the list of current users for a project, search for users and verify which projects they have what permissions in. You can also manage projects, for example moving them from one category to another.
- Membership automation: Combine regular tasks to manage project membership with the Domain and Project automation methods to grant and revoke roles and permissions for users.
Getting the Software
If you are a CollabNet customer you can develop your integration by directly accessing the web services of your CEE instance. However, CollabNet advices you install the 15 user version of CollabNet Enterprise Edition on a separate server and use that environment to develop and test your integration. The 15-user download is available as a VMware image or a full installation. Installation support for the 15-user download is available in the dedicated onSite support project.
Download the 15 user version of CollabNet Enterprise Edition
Resources on openCollabNet
openCollabNet provides you with all the resources you need to build a CEE Integration:
You can access all these resources from the Build a CEE Integration page on openCollabNet.
Start a community project
You want to integrate CEE with a tool your developers use daily. Other CollabNet customers might have the same need. Why not start a joint project then? You can request a project workspace on openCollabNet and together with others develop extended functionality around the CollabNet platform. If you want to start your own project, send us an email with your ideas.
Partnering with CollabNet
Independent software vendors building extensions to CollabNet Enterprise Edition can join the CollabNet Partner Program. The CollabNet Partner Program provides technical, business and marketing resources to successfully develop and market your integration with the CollabNet platform.
Learn about the CollabNet Partner Program
The collabXchange
The collabXchange is CollabNet's marketplace for tools that integrate with the CollabNet platform or Subversion. If you built a tool that extends CEE, get it listed for others to discover, download and use.
Learn more about getting listed on the collabXchange
