Wiki: DeveloperDocumentation

Edit this page | Links to this page | Page information | Attachments | Refresh page


Return to Wiki FrontPage

Developer Documentation

  • Overview: Overview for developers

  • RestApi: REST API Documentation Introduced with CCF 2.0

  • Developer Guide through available Documentation: Read this guide in order to find out when and how to read the available documentation

  • HowToWriteYourOwnConnector: Find out which steps to do in order to integrate a new system with CCF

  • GraphicalMapping: Find out how to use graphical data mapping, how to customize its behavior and how to use your own graphical data mapper

  • The_Purpose_of_the_Project: Detailed goals and purposes of the CCF

  • The_Client,_the_Customer,_and_Other_Stakeholders: Anticipated customers, stakeholders and clients for the CCF

  • Users_of_the_Product: User categories of the CCF

  • Mandated_Constraints: Constraints of the environment, the CCF was designed for

  • Requirements: see project goals, project scope, functional and non-functional requirements, customers, definitions and ideas around the CCF

  • OpenAdaptor Whitepaper: White paper about openadaptor, the framework, CCF is based on

  • OpenAdaptor Article: Excellent article dealing with openadaptor

  • ExampleScenarios: see some pre-configured scenarios the CCF can solve for you

  • Graphical wirings for all CCF scenarios: Take a look at the visualization of all wirings that are shipped with CCF

  • Generic Artifact Format: XML Schema based specification of the common message format of the CCF

  • Naming_Conventions_and_Definitions: Glossary of terms for the CCF

  • SupportedSystems: Collects information about the available reader and writer components for the CCF. In particular it explains the meaning of the generic CCF terms system, system kind, repository, repository kind and artifact type in the concrete terminology of the supported system and informs how system specific artifact data is represented in the generic artifact format. This information is particularly important for you if you are still unsure what to put in the synchronization status table of the CCF data base or how to process a generic artifact. It also helps to create the XSLT mapping scripts.

  • PlanningFoldersParentArtifactsAndGenericArtifacts: TF tracker items can have a parent tracker item and can be assigned to a planning folder at the same time. Find out how the generic artifact format reflects that.

  • OtherDatabase: See how to use your favorite DBMS to host CCF's synchronization tables

  • Javadocs: Generated documentation for CCF's core classes

  • Dependency proposal: Proposal how to handle dependencies and associations

  • Streaming Algorithm: See how most reader components do their artifact polling job in detail

  • PushSupport: See and participate on our thoughts how to implement support pushing for the CCF

  • CCFDependencies: Take a look at the software libraries, the CCF relies on

  • Release notes: Take a look which issues have been fixed since the last release

  • CCF License: Read the Apache 2.0 license, used for CCF

  • ContactData: see how to best reach the people working in the project

DeveloperDocumentation (last edited 2011-12-19 12:03:48 -0800 by jonico)