Developer Guide
From AlfrescoWiki
Back to Main Page
[edit] Introduction
Welcome to the Alfresco Developer Guide.
[edit] Development Environments
Alfresco SDK - A pre-bundled Software Development Kit for developing against Alfresco. This option provides all you need to develop against Alfresco, including pre-built libraries, packaged source code & Javadoc, Eclipse projects and samples. It's the easiest and quickest route to developing custom Alfresco plug-ins and clients. An Alfresco SDK bundle is provided with each Alfresco release.
Alfresco SVN - Direct raw access to all of Alfresco's source and build artifacts. Use this route if you wish to extend the Alfresco core framework or work on Alfresco bug fixes as it allows you to perform full re-builds of Alfresco itself. The Alfresco SVN provides access to the latest work-in-progress developments.
Developer Runtime Configuration - Common Alfresco configuration options.
(Owner: DC)
[edit] The Basics
Terminology Guide - Alfresco Terminology.
Alfresco Repository Architecture - Introductory overview of the Alfresco Repository Architecture. (Owner: DC)
Alfresco JavaDoc - Index of available JavaDoc
[edit] Developing against the Alfresco Repository
Foundation Services API - An in-process Java API providing full access to the capabilities of the Alfresco Repository. (Owner: DH)
JCR API - An in-process Java API providing full JSR-170 Level 1 & 2 compliant access to the Alfresco Repository. (Owner: DC)
JCR RMI - An RMI bridge providing remote access to the Alfresco Repository via the JSR-170 Level 1 & 2 compliant API. The implementation is provided by the Apache Jackrabbit project. See also Alfresco JCR-RMI_Extension (Owner: DC)
Web Services API - A WSDL based API providing standard remote access to the Alfresco Repository from any client environment e.g. PHP, .NET, Java. (Owner: RW)
REST API - Alfresco services via simple URIs, HTTP requests and responses. (Owner: DC)
PHP SDK - The PHP SDK provides native and remote access to the repository via a PHP API. This also includes PHP templating and scripting capabilties in the repository. (Owner: RW)
JavaScript API - Scripting the Alfresco repository via a rich object-oriented JavaScript API. Alfresco can be scripted via rules, actions and REST URLs and via direct Java API calls to the script services. (Owner: KR)
[edit] Creating new Content Models
Data Dictionary Guide - Step by Step guide to defining and extending Content Types.
Integrity Checks - Describes the various configuration options around model integrity and the types of tests performed.
Constraints - Description of constraints and their applications to content model integrity. This section provides a walkthrough on configuring the existing set of constraint classes. It also covers writing your own custom constraint classes and utilizing them within your own custom content models.
There's a great tutorial on creating content models at ecmarchitect.com
(Owner: DH)
[edit] Creating new Workflows
Workflow Administration - Describes how to define and deploy your own custom "advanced" workflow. Please note: This capability is available from v1.4 onwards.
(Owner: DC)
[edit] Extending the Alfresco Web Client
Web Client Configuration Guide - Configuring the Web Client, config file structure and examples. (Owner: GC)
Web Client Customisation Guide - Examples of how the Web Client can be customised to meet your requirements. (Owner: GC)
Externalised Client Actions - Explanation of the configurable actions framework. (Owner: KR)
Template Guide - Writing templates for the client and repository templating components. (Owner: KR)
URL Addressability - Content, space and document details client pages made available through direct URL access. (Owner: KR)
User Configurable Dashboards - How to define views within Alfresco Dashboards. (Owner: KR)
Desktop Actions - Extend functionality on the Windows desktop. (Owner: GS)
Dialog And Wizard Framework - Explanation of the dialog and wizard framework added in 1.3. (Owner: GC)
Component Generator Framework - Explanation of the component generator framework used by the PropertySheet component. (Owner: GC)
Component Library - JSF Component Reference Guide. (Owner: GC)
AJAX Support - Explanation of the AJAX support present in the Web Client. (Owner: GC)
Sidebar - Explanation of the Sidebar and how to implement & configure sidebar plugins. (Owner: GC)
[edit] Extending the Alfresco Repository
Repository Configuration - Repository Configuration. (Owner: DH)
I18N - I18N'ing repository code. (Owner: RW)
Custom Actions - How to create custom actions. (Owner: RW)
Returning Values From Actions - Details on how to return values from actions. (Owner: RW)
Scheduled Actions - How to schedule actions. (Owner: AH)
Content Transformations - Writing and configuring a ContentTransformer (Owner: DH)
Metadata Extraction Configuration (Owner: DH)
[edit] Alfresco Module Packages
AMP Files - What is an AMP file?
Module Management Tool - Managing installed modules in a WAR file.
Developing an Alfresco Module - Guidelines on how to develop your own Alfresco modules.
(Owner: RW)
[edit] Specifications (XML Schema, WSDL etc)
(Owner: DC)
[edit] WCM Development
WCM Development Resources <math>Insert formula here</math>
