Installing and Getting Started with Alfresco

© 2009, OpenThink Labs. All Rights Reserved

Installing and Getting Started with Alfresco Doc. v. 0.2 - 05/05/09

Wildan [email protected]

http://wildan.negeripelangi.com

mailto:[email protected]

http://wildan.negeripelangi.com/


After The Presentation You Will Have Learned How To :

● Determine what is the right installation option for you

● Install Alfresco and all the required software

● Log in to the Alfresco web client application

● Use the administration console and perform system administration tasks

● Use Alfresco for basic document management


Installing Alfresco


Out-of-the Box Installation Architecture


Where is Your Content Stored● The content in Alfresco is stored in persistent

back-end systems such as a database and file system.

● The database is used to store metadata, includes information like :● The format of the content● Date created● Language ● Security settings


What are the Components of Alfresco Application Server ?

● The Alfresco Application Server houses :● Alfresco application, also known as the web

client● Alfresco repository

– The Alfresco repository provides a set of reusable cross-cutting content management services such as content storage, query, versioning, and transformation, which may be utilized by one or more applications


How can You Access The Application ?

● Using Web Browser

● File Transfer Protocol (FTP) : This is useful to transfer files from your local file system to the remote server

● WWW Distributed Authoring and Versioning (WebDAV) : This is primarily designed for editing and managing files on remote web server in a structured way. For example, an application like Adobe Photoshop can directly open and edit a file in the Alfresco content repository. This gives you the flexibility of using your own favorite editor to edit the content on the Alfresco server.

● Common Internet File System (CIFS) : This helps you to map Alfresco as your local file system folder


Which installtion Option is Suitable for You ?

● Enterprise and Labs Family● Alfresco Labs Family ● Alfresco Enterprise Family


Operating Systems● Windows ● Linux ● UNIX● MacOS


Databases● MySQL ● Oracle● MS SQL Server


Application Servers● Tomcat

● JBoss

● Info :

● Alfresco uses Spring framework and not EJB framework.

● Alfresco utilizes JBoss cache's ability to distribute and maintain data caches, making it possible to build large-scale systems that outperform traditional enterprise content management systems

● Alfresco also utilizes the clustering, failover, and load-balancing facilities of the JBoss application server to increase scalability

● Alfresco's business process management features are powered by the JBoss jBPM tool.


Portals (Optional)● JBoss Portal● Liferay

NOTE : On Alfresco 3, Portal solution can be replaced by Alfresco Share


Choose the Suitable Software for Your Installation

Case Study : Installing on Ubuntu 8.10 Linux


Install The Dependencies Packages

● sudo apt-get install imagemagick mysql-server 'openoffice.org-headless' xvfb swftools sun-java6-jdk sun-java6-jre nfs-common portmap

● Create ImageMagick symlink :sudo ln -s /usr/bin/convert /usr/local/bin/convert

● Create pdf2swf symlink :sudo ln -s /usr/bin/pdf2swf /alfresco/bin/pdf2swf

● NOTE (for compiling the newest swftools you must install):zlib1g-dev, libjpeg62-dev, libgif-dev, libfreetype6-dev packages


Downlod The Software● wget -c

http://us.dl.alfresco.com/release/labs/build-1526/Alfresco-Labs-3Stable-Linux-x86-Install?dl_file=release/labs/build-1526/Alfresco-Labs-3Stable-Linux-x86-Install● chmod +x Alfresco-Labs-3Stable-Linux-x86-Install ● sudo ./Alfresco-Labs-3Stable-Linux-x86-Install

http://us.dl.alfresco.com/release/labs/build-1526/Alfresco-Labs-3Stable-Linux-x86-Install?dl_file=release/labs/build-1526/Alfresco-Labs-3Stable-Linux-x86-Install


Language Selection


Confirmation


Welcome Message


Setup Type


Destination Location


Start Copying Files


Installing


OpenOffice Location


Complete


Set up Alfresco Environtment

● cd /alfresco

● Change ALF_HOME and JAVA_HOME#!/bin/sh# Start or stop Alfresco server# Set the following to where Tomcat is installedALF_HOME=/alfrescocd "$ALF_HOME"APPSERVER="${ALF_HOME}/tomcat"export JAVA_HOME="/usr/lib/jvm/java-6-sun-1.6.0.10/"# Set any default JVM valuesexport JAVA_OPTS='-Xms128m -Xmx512m -XX:MaxPermSize=128m -server'# Following only needed for Sun JVMs before to 1.5 update 8export JAVA_OPTS="${JAVA_OPTS} -XX:CompileCommand=exclude,org/apache/lucene/index/IndexReader\$1, doBody -XX:CompileCommand=exclude,org/alfresco/repo/search/impl/lucene/index/IndexInfo\$Merger, mergeIndexes -XX:CompileCommand=exclude,org/alfresco/repo/search/impl/lucene/index/IndexInfo\$Merger, mergeDeletions"#if [ "$1" = "start" ]; then "${APPSERVER}/bin/startup.sh"# if [ -r ./virtual_start.sh ]; then# sh ./virtual_start.sh# fi# if [ -r "$ALF_HOME"/start_oo.sh ]; then# sh "$ALF_HOME"/start_oo.sh# fielif [ "$1" = "stop" ]; then "${APPSERVER}/bin/shutdown.sh"# if [ -r ./virtual_start.sh ]; then# sh ./virtual_stop.sh# fi# if [ -r "$ALF_HOME"/start_oo.sh ]; then# killall soffice.bin# fifi


Set up Virtual Alfresco Environment

● Only have to change ALF_HOME and export JAVA_HOME

● sudo jed virtual_alf.sh

#!/bin/sh# Start or stop Alfresco server# Set the following to where Tomcat is installedALF_HOME=/alfrescocd "$ALF_HOME"APPSERVER="$ALF_HOME"/virtual-tomcatexport JAVA_HOME="/usr/lib/jvm/java-6-sun-1.6.0.10/"

# Start virtual-tomcat#if [ "$1" = "start" ]; then "$APPSERVER"/bin/startup.shelif [ "$1" = "stop" ]; then "$APPSERVER"/bin/shutdown.shfi


Change Derby Database to MySQL Database

● This process will wipe out all your data, be very very careful.

#sudo mysql -p < /alfresco/extras/databases/mysql/db_setup.sql

● See if the database is there :


Change Derby Database to MySQL Database (1)

● Change setting from Derby to MySQL :

cd tomcat/shared/classes/alfresco/extension/

● Locate and open the following two files :

sudo jed custom-repository.properties

● Change the dir.root to the absoulte path of the data folder :

# Sample custom content and index data location

#

dir.root=/alfresco/alf_data

dir.indexes=/alfresco/alf_data/lucene-indexes



● Change setting from Derby to MySQL :

cd tomcat/shared/classes/alfresco/extension/

● Locate and open the following two files :

sudo jed custom-repository.properties

● Change the dir.root to the absoulte path of the data folder :

# Sample custom content and index data location

#

dir.root=/alfresco/alf_data

dir.indexes=/alfresco/alf_data/lucene-indexes



● We need to change one more file :

sudo jed custom-hibernate-dialect.properties

## Derby dialect##hibernate.dialect=org.hibernate.dialect.DerbyDialect

## HSQL dialect##hsql#hibernate.dialect=org.hibernate.dialect.HSQLDialect

## MySQL dialect (default)#hibernate.dialect=org.hibernate.dialect.MySQLInnoDBDialect

## PostgreSQL dialect##postgresql#hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect#postgresql#hibernate.query.substitutions=true TRUE, false FALSE


Error : TO FIX21:54:02,245 ERROR [org.alfresco.repo.content.transform.magick.AbstractImageMagickContentTransformer] ImageMagickContentTransformer not available: Failed to perform ImageMagick transformation:

Execution result:

os: Linux

command: [/usr/local/bin/convert, /opt/Alfresco/tomcat/temp/Alfresco/ImageMagickContentTransformer_init_source_62025.gif, /opt/Alfresco/tomcat/temp/Alfresco/ImageMagickContentTransformer_init_target_62026.png]

succeeded: false

exit code: 1

out:

err: Cannot run program "/usr/local/bin/convert": java.io.IOException: error=2, No such file or directory

21:54:04,407 INFO [org.alfresco.config.xml.XMLConfigService$PropertyConfigurer] Loading properties file from class path resource [alfresco/file-servers.properties]

21:54:08,877 ERROR [org.alfresco.repo.content.transform.RuntimeExecutableContentTransformer] Failed to start a runtime executable content transformer:

Execution result:

os: Linux

command: [/opt/Alfresco/bin/pdf2swf, -V]

succeeded: false

exit code: 1

out:

err: Cannot run program "/opt/Alfresco/bin/pdf2swf": java.io.IOException: error=2, No such file or directory

Solution :

apt-get install swftools


Give it a go● Share Website

sudo /alfresco/alfresco.sh start

http://HOSTNAME:8080/share

user : admin password :admin

http://HOSTNAME:8080/share


Share Web Sites Login Page


Share Web Sites Dashboard Page


Give it a go● Web Interface

sudo /alfresco/alf_start.sh start

http://HOSTNAME:8080/alfresco



Web Client Login Page


Web Client Dashboard Page


Give it a goSMB Interface

● For SMB Interface try :

\\HOST_IP_ADDRESS\alfresco





● For SMB Interface try :

\\HOST_IP_ADDRESS\alfresco





● Test it using smbclient :


Give it a goFTP Access

● For FTP access try :ftp : HOST_IP_ADDRESS

● Login as :

user: admin pass: admin


Give it a goFTP Access


Give it a goWebDAV Access

● For WebDAV access try this in a browser: The browser has read only permissions.

http://HOST_IP_ADDRESS:8080/alfresco/webdav

user : adminpass : admin

● You can also access this through a Windows Mapped drive or Nautilus File Manager to have read/write permission.






Start Alfresco at Boot Up● Create a file :

sudo jed initialize.sh

● Add these lines :

● Lets make it executable :

chmod 777 initialize.sh

● Run it : sudo ./initialize.sh

● Reboot and see what happens

#!/bin/shALF_HOME=/alfrescoecho "Creating init.d links"ln -s $ALF_HOME/alfresco.sh /etc/init.d/alfrescoln -s $ALF_HOME/virtual_alf.sh /etc/init.d/virtual_alfupdate-rc.d alfresco defaultsln -s $ALF_HOME/alfresco.sh /etc/init.d/alfrescoln -s $ALF_HOME/virtual_alf.sh /etc/init.d/virtual_alfupdate-rc.d alfresco defaultsupdate-rc.d virtual_alf defaults


Introduction to The Web Client

● Alfresco web client is the web-based application bundled and shipped along with the Alfresco repository. Using any web browser you can connect to the web client application. You will be able to manage users, security, content, business rules, and everything related to your enterprise content stored in Alfresco through the web client.


Log in to Alfresco as Administrator

● Login to the default url of alfresco :

http://<ip-or-servername>:8080/alfresco

● User : admin Pass : admin


Screen Layout● Tool bar

● Shelf

● Breadcumbs

● Header

● Detail


Administration Console

● User and Group Management

● Category Management

● Data Management

● System Information


Getting Started with Content Creation

● Create Space● Create Content● Create a Link to Content


Create Space● An Alfresco space is a folder with additional properties

such as business rules and security


Create Space (2)


Create Content

● In Alfresco content is any kind of document, such as a Microsoft Office file, Open Office file, PDF, HTML, XML, text, image, audio, or video file.

● Each content item is made of two main elements, the content itself and the information about the content, called metadata or properties. By default each content item will have properties such as title, description, author, and audit

trail information such as creator, creation date, modifier, and modification date.


Create a Link to Content● Identify the target document and click on the Copy action (as

shown in the

screenshot on the previous page).

● The document will be placed in the clipboard as shown in the screenshot below.

● Go to the space where you would like to create the link to the content.

● Click on the Paste Content as Link icon shown in the screenshot below.


Create a Link to Content


Introduction to Alfresco Share


About Dashlet● Dashlet is a summary component that may or may not have an equivalent page

component. If there is a complementary page component, the related dashlet displays the information generated from it. Dashlets only appear on the personal or site dashboards.


Available Dashlet -1● Getting Started

The Getting Started dashlet gives you options to get started when you access Share for the first time. Once you are familiar with Share, you can remove it. This dashlet displays by default.

● My Calendar

Your My Calendar personal dashlet contains a rolled up view of events that you have created, as well as events for each site of which you are a member, providing quick access to each of them. This dashlet displays by default.

● RSS FeedBy default, the RSS Feed personal dashlet displays all Global Alfresco RSS feeds. You can configure it to personalize your feeds. You can also add and configure as many instances of this dashlet as you want. This dashlet displays by default.


Available Dashlet -2● Alfresco Network

The Alfresco Network dashlet is the portal for Alfresco customers to get all the latest news and views, as well as the following:

● A knowledge base

● Ability to track your tickets

● Check in notices

● Documentation

● Downloads

● Alfresco Calendar

It provides a feed to the latest activities on the Network.

● My Sites' ActivitiesYour My Sites’ Activities personal dashlet tracks the most recent activities that have been performed in any site of which you are a member.


Available Dashlet -3● My Profile

Your My Limited Profile personal dashlet contains summary personal details about you, based on your detailed profile.

● My SitesYour My Sites personal dashlet lists all sites that you have created or of which you are a member, providing quick access to each of them.

● Documents I'm EditingYour Documents I’m Editing personal dashlet lists all the documents you have checked out in all the sites of which you are a member, providing quick access to Editing them.

● CMIS Feed Your CMIS Feed dashlet displays links specific to the Content Management Interoperability Services (CMIS) specification and implementation.


Available Dashlet -4● My Workspaces

Your My Workspaces dashlet displays all Document Workspace sites of which you are a member, providing quick access to each of them.


Set Up Your Personal Dashboard

● You can set up your personal dashboard to tailor the view you have, depending on your requirements.You Can :

● Modify the dashboard appearance – view as one, two, three, or four columns

● Add and remove personal dashlets

DEMO


Publish Your Credential● As part of the site, you want to publish your

credentials for all site members to view. You publish your credentials via your My Profile page component. It enables you to:● Edit your profile● Change your password● Specify your settings

DEMO


Create your Collaboration Site

● The next step in the scenario is to create a collaboration site for your team. From here, your team will be able to :

● Share and manage content

● Schedule and manage meeting events

● Have group discussions

● Write blogs

● Author content online and share with others via a wiki


Create The Site● In the application toolbar, click My Dashboard to return to your personal

dashboard.

● Click Create Site in the My Sites personal dashlet.



Set Up Your Site

● The site dashboard displays all information and activities associated with the site. It is customized by

the site owner.

● You can set up your new site to meet your team’s requirements. You can:

● Customize the site dashboard using site dashlets

● Customize the site by adding or removing page components on the site


Available Dashlets on The Site

● Getting StartedThe Getting Started site dashlet gives you options to get started when you access Share for the first time. Once you are familiar with Share, you can remove it.

● Recently Modified DocumentsYour Recently Modified Documents site dashlet lists all documents that you have created or modified in the last 7 days, providing quick access to each of them.

● Site ActivitiesYour Site Activities site dashlet tracks the most recent activities that have been performed in the current site.

● Site ProfileYour Site Profile site dashlet displays summary details about the current site.

● Site ColleaguesThe Site Colleagues site dashlet displays all members of this site and their assigned role. This dashlet displays by default.


Available Dashlets on The Site -2

● Site CalendarYour Site Calendar site dashlet contains a rolled up view of events that you have created, as well as events for each site of which you are a member, providing quick access to each of them.

● Site WikiYour Site Wiki site dashlet enables you to display content from the Wiki page component. You can configure this dashlet to select the page you want it to

display.

● RSS FeedBy default, the RSS Feed site dashlet displays all Global Alfresco RSS feeds. You can configure this dashlet to personalize your feeds. You can also add and configure as many instances of this dashlet on the site dashboard as you want

● Site LinksThe Site Links site dashlet displays the web links relevant to the current site.


Customize the Site Dahboard● You can add and reorder the site dashlets on the site dashboard the same as

you do with personal dashlets on your personal dashboard.

● Ensure you are in your new site and click Customize Dashboard on the banner. The Customize Site Dashboard page where you add and remove site dashlets appears.

● Click Add Dashlets and add Site Wiki to your site dashboard.

● Click OK. The configuration is saved and you return to the updated site dashboard.


Customize the Site Content● Alfresco Share has the concept of page components which you can add to your site as

customized functionality. A page component has rich functionality and is URL addressable.

● Ensure you are within your new site and click Customize Site on the banner. On the Customize Site page, you can add and remove page components. The available page components are:

– Wiki

– Blog

– Document Library

– Calendar : The Calendar page component enables you to schedule and track events for all sites you own or of which you are a member.

– Links

– Discussions

● Click Cancel to return to the site dashboard


Prepare Your Site for Collaboration

● To make the new site as collaborative as possible, you should prepare the following before inviting any users:

● An introduction and explanation for the site (Wiki)

● A set of marketing material documents (Document Library)

● A scheduled webinar introducing everyone to the site (Calendar)


Create an Introduction● You use the Wiki page component within your site to write your introduction.

Once it is written, you

add it to the Wiki dashlet on your site dashboard.

● Within your site, click Wiki on the banner. The Wiki page component opens.

● Click New Page and give the page the title Welcome to our collaboration site.

● Add the following contentThe purpose of this collaboration site is to share information for the project and ensure that communication is as easy as possible.

● Add the tag collaboration

● Click Save. The new page displays


Add the Introduction to Your Site Dashboard

● Within your site, click Site Dashboard on the banner. This returns you to the site dashboard for the current site.

● Click Configure in the Wiki dashlet. The Select Wiki Page page displays.

● Click OK to accept the page you have just created. The text from this wiki page displays in the Wiki dashlet.


Add Marketing Material or Any Other Document

● Within your site, click Document Library on the banner. The Document Library page component opens.

● Click Upload to load your three content items. The Upload File(s) page opens.

● Click the browse button to locate any three pieces of content on your computer to upload. The Upload File(s) page displays the three content items as a list.

● Click Upload File(s). The content items display their upload status.

● Click OK when all content is 100% complete. The page closes and the Document Library displays the selected content items.


Document Library Upload Issue

● Multiple file upload using flash only works on Internet Explore (on Labs 3 Final)

● As workaround, we will completely disable this feature and using traditional HTML upload.

● Reference : http://forums.alfresco.com/en/viewtopic.php?f=9&t=15501


Update a document

● In the Document Library item list, highlight one of the content items you have uploaded.

● Click the Edit Offline action associated with this content from the dynamic menu. The content moves to the Documents I’m Editing view, indicating that the document is checked out to you.

● Choose to save the file and click OK to save the content item in a location from which you can edit it.

Note The content name will be appended with (Working Copy) in the location in which you save it.

● Navigate to this content item on your personal computer, change a word, and save it.

● In the browsing pane, ensure I’m Editing is the selected view under Documents.

● In the item list, select the document you modified and click the Upload New Version action. The Update File page displays.


Update a document -2

● Screenshoot


Update a document -3

● Click the browse icon to locate your modified file. Remember that it is appended with (Working Copy). Once you select it, it displays in the Update File page.

● Specify whether it is a minor or major version, type any comments you have, and click Upload File(s).

● Click OK when all content is 100% complete. The updated content item displays in its original location in the library.


Document Preview Issues● Reference : http://forums.alfresco.com/en/viewtopic.php?f=9&t=14380

● Solution : Install and compile the newest package (0.9)

http://forums.alfresco.com/en/viewtopic.php?f=9&t=14380


Schedule a webinar● As part of promoting this collaboration site, you want to schedule a

webinar to welcome the new users and discuss the purpose of the site.


To schedule a webinar● Within your site, click Calendar on the banner. The Calendar page component opens.

● Select the date you want to have the webinar and click Add within that date. The Add Event page displays.

Screenshoot

● Enter the webinar details and click OK. You return to the calendar with your new webinar displayed on the date you scheduled it.


Invite members to your site● After you have set up your collaborative site, you

can invite people to join it.


To Invite People ● Within your site, click Invite on the banner. The

Invite page displays.

Screenshoot


To Invite People -2● In the Search for People section, type the full or partial name of an internal user you

want to invite and click Search.

Important :

If you do not have any users for this installation add them in Alfresco Explorer.

● Click Add associated with the user you want to add. The user displays in the Invite Users list.

● In the Add External Users section, type the first name, last name, and email for the external user you want to invite, then click Add.


To Invite People -3● In the Invite Users list, select a role from the Select Role menu for each user.

NOTE : If you want to assign all users the same role, select a role from the Set All Roles to menu to apply to all of the users listed. The role displays in the menu.

Screenshoot

● Click Invite. You are notified that the invite has been sent via email to each member invited.


View activities within your site

● Recenlty Modified Dashlet

● Site Activities Dashlet


Use SharePoint Protocol (SPP) Support with Your MS Office Documents

● TODO , Refer to the Alfresco Tutorial Getting Started with SharePoint Protocol Support


Reference● Alfresco, Enterprise Content Management Implementation, Munwar

Sharif, PACKT Publishing

● Installing Alfresco Lab 3 Stable on Ubuntu 8.10, http://wiki.alfresco.com/wiki/Installing_Alfresco_Lab_3_Stable_on_Ubuntu_8.10

● Alfresco Labs 3 Stable - Getting Started with Alfresco Share, Alfresco Software Inc

http://wiki.alfresco.com/wiki/Installing_Alfresco_Lab_3_Stable_on_Ubuntu_8.10


Q&A

Thanks! ^_^

Technology

Installing and Getting Started with Alfresco