How to

[resplin]

Obsolete Pages{{Obsolete}}

The official documentation is at: http://docs.alfresco.com

Overview Developer GuideExamples Cookbook 3.04.0
This is a summary of features that you, happy developer, want to create. If you have others good links, please add in this place.
You can add some links. For that, click on 'Edit', create user, and update this page... or go at the end of this page, follow link to the forum and post

right

Table of Contents

• 1 General
  
  
  
  • 1.1 Show custom information
  
  
  • 1.2 Documentation/Examples
  
  
  • 1.3 Installation/Configuration
    
    
    
    • 1.3.1 Audit
    
    
    • 1.3.2 Language
    
    
    • 1.3.3 Eclipse
    
    
  
  
  • 1.4 Migration
  
  
  • 1.5 Content Model
    
    
    
    • 1.5.1 Check data
    
    
  
  
  • 1.6 Office
  
  
  • 1.7 Dashlet
  
  
  • 1.8 Webscripts
  
  
  • 1.9 Webservices
  
  
  • 1.10 Module
  
  
  • 1.11 Java Code
  
  
  • 1.12 JavaScript Code
  
  


• 2 Document Management
  
  
  
  • 2.1 Web interface
  
  
  • 2.2 Actions
  
  
  • 2.3 Workflows
  
  
  • 2.4 See also
  
  


• 3 Share
  
  
  
  • 3.1 See also
  
  


• 4 Web sites


• 5 Comments/Questions ?

General

• Know the difference between Alfresco Labs and Entreprise
  

Show custom information

How I can generate information myself?

• Webscript : Showing a page using freemarker, rss, html, xml, atom, json, ...
  
• Dashlet : Using a webscript to show a little page inside the dashboard
  
• Templates : Using template to mix with a document to change the output
  
• Showing custom JSP page in Alfresco
  
• Share : Proposing a collaborative content management (wiki, blog, calendar, ...)
  
• Webstudio and WCM : Proposing  some sites (inside Alfresco)
  
• Surf : Creating an external war and can develop some pages (new site) Getting start
  
• Change the presentation
  
  • Developer Guide : Extending the Alfresco Web Client
    
  • Change a JSP page. Look in Workflow : Show the workflow history for a file It create a custom page like /jsp/content/document-details.jsp
    
• ...
  

Documentation/Examples

• Developer Guide
  
• on Share Alfresco
  
• A very helpful documentation (It is not free, but I think that it is necessary to have( Iam not a re...
  
  • Examples
    

Installation/Configuration

• Install Alfresco on Ubuntu 8.04
  
• Install Alfresco Labs 3.0 with Ingres database
  
  • Install Alfresco Community 3.2 and Ingres 10
    
  • Add some modules with Alfreco/Ingres Bundle
    
• Backup and restore
  
• Upgrade Alfresco
  
• JVM (Java Virtual Machine) Tuning
  
• Start Alfresco at boot time (RedHat)
  
• Monitor Alfresco by JMX Access to the JVM to see memory, ...
  
• See which process of alfresco is using the CPU HotThreads Need help to the command ?
  
  • On the Console (Windows) : CTRL+Break
    
• Get older versions of Alfresco
  
• Configure Alfresco 3.2 with LDAP Do it if you have problems
  
  • LDAP Browser Useful to check the userformat
    
• Alfresco HA Cluster on Amazon EC2
  
• Run Alfresco 34d as user Alfresco
  
• Login Links to change user when SSO is enable (explorer and share)
  

Audit

Information about : users connected, number of created/read/updated documents displayed by hour/day/week/month, etc

• AuditSurf made by Atolcd. This is a module to add (amp and war) to Alfresco
  
  • Download
    

Language

• Add new language to Alfresco In French.
  
• Change the default language of the server (and also the language of the login page) ! Keep space between the two arguments (-Duser.language=fr -Duser.region=FR)
  
• ...
  

Eclipse

• Use the debug
  
• ...
  

Migration

• Alfresco Content Migration using Open Migrate at Peter Monks bulk import tool.
  

Content Model

Model to structure the documents

• Best practices to create a custom content model
  
• Discussion about the creation of a content model for differents types of documents.
  
• How to test the models validation without starting Alfresco server : Use this command :
  
  • java -cp '.;C:\Alfresco\tomcat\webapps\alfresco\WEB-INF\lib\*;C:\Alfresco\tomcat\webapps\alfresco\WEB-INF\classes' org.alfresco.repo.dictionary.TestModel alfresco/extension/exampleModel.xml
    
  • Note : 'alfresco/extension/exampleModel.xml' is the relative path to the file
    
• Access the content model from Java to get values : Obtain a List with a constraint list allowed values
  

Check data

• Check there is not same files (check hashsum)
  

Office

Integration for offices softwares

• Use a plugin from MS-Office to access Alfresco
  

Dashlet

Windows in the dashboard (for example : 'Tasks to do').

• Create a simple dashlet (with JSP and Freemaker)
  
• Create a dashlet showing the weather
  
• Create a dashlet configurable A link in the dashlet able to change the information writing by this dashlet. (Need to be register)
  
• ...
  

Webscripts

Access to your Alfresco code by a URL call(details about Webscripts).

• Examples using Javascripts
  
• Examples using Java
  
• Debug a webscript : Activate here http://youralfresco:8080/alfresco/service/api/javascript/debugger
  
• Get the message bundle (I18N) in the Javascript code (server side) The other languages files need to be named like this : yourwebscript.get_fr.properties (the position of _fr is important). Don't forget to refresh webscript to see changement.
  
• Invoke a Java class from WebScripts
  
• ...
  

Webservices

Manage Alfresco by a third software

• Upload/Delete/Move/... the space content from a third software (in Java)
  
• ...
  

Module

This is a container in which you store all your code (details about module AMP).

• Developer Guide : Module
  
• Add your own config file in your module
  
• Build your project for Alfresco, Share and WQS
  
• ...
  

Java Code

Some features that you perhaps need

• Write one or several transactions in your code
  
• Know if a property (value undefined) is apply on a document
  
• Java API Cookbook
  
• Working with NodeRef (add, remove, categorie, rules, permissions, ...
  
• Send a simple mail
  
• Send a mail with template
  
• Start a scheduled action
  
• Call a javascript Webscript from Javacode (in French)
  
• ...
  

JavaScript Code

Some features that you perhaps need

• JavaScript API CookBook
  
• ...
  

Document Management

Web interface

What the user see

• Disable some default features in a properties page like 'Custom View', 'Multilingual Content Info', ...
  
• Disable action button in the content items like 'Edit Offline', 'Check Out', ...
  
• ...
  

Actions

Generate an action (access to code) when a document is add/change/delete in a repository.

• Developing custom action
  
• Return value from an action
  
• Having a second 'Folders Selector' in the config rules When click on 'Setting values and add' during the configuration of a rule, we can configure two 'Folders Selectors'.
  
• ...
  

Workflows

Generate a way to a document (advertise user, access to code, ...).

• Create a advanced workflow
  
• Start an advanced Workflow from JavaScript
  
• Start an advanced Workflow from Java
  
• Get link to the documents attached in a Workflow in the java code
  
• Customize Workflow UI
  
• Show the workflow history for a file
  
  • If any problems with the faces-config.xml to indicate the /jsp/extension/document-details.jsp : Post help
    
• See tutorial about complete workflow project In French
  
• Send a mail using wf-email.html template from Javascript
  
• Exclude workflows from the list in Share
  
• ...
  

See also

• Dashlet
  
• Webscripts
  
• Java Code
  

Share

The community plateform.

• Extending Share 1 - Creating a Share Extension project
  
• Extending Share 2 - Adding a Create content button to Document Library
  
• Extending Share 3 - Adding a new Page to Share
  
• Have more info about Surf Plateform
  
• Creating calculated datalist columns in Alfresco Share 3.3
  
• Creating calculated datalist columns in Alfresco Share 3.4b
  
• Using Jar deployment to solve conflicts with multiple customizations in Alfresco Share
  
• A collection of add-ons for Alfresco Share
  
• Displays text property as datatable inside Alfresco Share's meta-data form
  
• Field validation in a form
  
• Customise the upload file dialog box
  
• Disable the mail notifications by default
  

See also

• Dashlet
  
• Webscripts
  
• Java Code
  

Web sites

• Use Web Studio
  
• ...
  

Comments/Questions ?

Forum Write comments here... (new tutorials to add ? Better link to a feature)