Alfresco Documentation
Overview
Conventions
System paths
Alfresco applications
Content applications
Alfresco web tier and Surf
Alfresco programming models
Guiding design principles
Architecture
Alfresco content application server
Alfresco content repository
Alfresco content services
APIs
Embedded API
Remote API
Content modeling
Protocols
Modularity
Alfresco web application framework
Deployment options
Installing
Alfresco Simple Installs
Installing Alfresco on Linux
Installing Alfresco on Windows
Installing Alfresco
Production environment checklist
Validating the architecture
Validating the environment
Installation files
Alfresco setup wizards
Alfresco WAR installation files
SharePoint Protocol Support installation files
Alfresco WCM installation files
Microsoft Office Add-ins installation files
Alfresco Records Management installation files
Alfresco SDK AND APIs installation files
Alfresco Web Service client installation files
Downloading Enterprise installation files
Supported stacks
Software requirements
Installing Alfresco on Tomcat
Installing Tomcat application server
Installing the Alfresco WAR
Deploying Share into a separate Tomcat instance
Configuring Alfresco as a Windows service
Installing Alfresco on JBoss
Configuring JBoss for Alfresco
Installing Alfresco on WebLogic
Enabling Google Docs with Alfresco (Lucene enabled) deployed on WebLogic
Installing Alfresco on WebSphere
Enabling Google Docs with Alfresco (Lucene enabled) deployed on WebSphere
Enabling YouTube with Alfresco (Lucene enabled) deployed on WebSphere
Enabling SlideShare with Alfresco (Lucene enabled) deployed on WebSphere
Installing a new license
Installing software required for Alfresco
Installing OpenOffice
Installing ImageMagick
Installing Ghostscript
Installing Flash Player
Installing SWF Tools
Installing SWF Tools on Windows
Installing SWF Tools on Linux
Installing TinyMCE language packs
Installing an Alfresco Module Package
Installing the Firefox extension
Installing and configuring Alfresco WCM
Web Quick Start
About Web Quick Start
Installing Alfresco and Web Quick Start
Manually installing Web Quick Start
Installing Web Quick Start on an existing Alfresco Enterprise install
Creating the Web Quick Start site
Importing Web Quick Start demo data
Configuring Web Quick Start
Configuring the web application host name, port, and context
Disabling AWE on the Live environment
Alfresco Web Editor
Alfresco Web Editor deployment
Deploying the Alfresco Web Editor
Deploying the Alfresco Web Editor to a Spring Surf application
Configuring Alfresco Web Editor
Configuring the tag library
Configuring the servlet filter
Configuring Web Editor forms
Sample web application using Alfresco Web Editor
Alternative Versioning Model (AVM)
About Alternative Versioning Model (AVM)
Installing AVM
Installing AVM to an existing instance of Alfresco
Verifying the AVM installation
Installing the standalone deployment receiver
Deployment receiver subsystem properties
Configuring AVM
Configuring the virtualization server
Using ip.alfrescodemo.net
Configuring wildcard DNS on a nameserver
Installing Records Management
Applying the Records Management AMP files
Adding the Records Management dashlet
Creating the Records Management site
Installing and configuring Alfresco Kofax Release script
System requirements and prerequisites
Installing Kofax Release script
Installing the Alfresco Kofax Release script AMP
Installing the Alfresco Kofax Capture Release script binaries
Configuring the Alfresco Kofax Release script
Associating the Alfresco Kofax Release script with a document class
Alfresco Kofax Release script configuration tabs
Repository tab
Index tab
General tab
Publishing a batch class
Releasing batches
Advanced configuration: custom types, aspects, and properties
Removing the Alfresco Kofax Release script
Troubleshooting the Kofax Release script
Installing and configuring IBM Lotus Quickr integration
Installing the Lotus Quickr AMP
Publishing content from Quickr to Alfresco
Configuring Quickr to browse Alfresco as the Enterprise library
Accessing Alfresco as a Team Place using Quickr connectors
Installing and configuring Alfresco XAM Connector
Software prerequisites for XAM Connector module
Setting up the Centera test environment
Configuring the XAM connection
Alfresco XAM Connector module properties
Testing the XAM connection
Installing the XAM Connector module
Testing the XAM Connector module
Setting up the XAMContentStore as the primary store
Installing and configuring the Alfresco Jive Toolkit
Alfresco Jive integration overview
Alfresco Jive Toolkit architecture
Alfresco Jive Toolkit full text indexing
Alfresco Jive Toolkit access control and identity
Alfresco Jive Toolkit installation
Installing the Jive Toolkit on Alfresco
Installing the Jive Toolkit on Jive
Configuring authentication for the Jive Toolkit
Using the Alfresco Jive Toolkit
Socializing a document from Alfresco to Jive
Uploading a file from Jive to Alfresco
Linking a file from Jive to Alfresco
Deleting a document in Jive and Alfresco
Installing and configuring Alfresco DocLib Portlets
DocLib Portlets capabilities
Configuring Liferay
Configuring Alfresco
Configuring the Liferay Share web application
Creating Liferay users
Adding portlets to Liferay
Installing Microsoft Office Add-ins
Setting up Microsoft Office Add-ins to work with HTTPS
Installing and configuring Microsoft Office SharePoint Protocol Support
Installing the SharePoint Protocol Support AMP
Prerequisites for using SharePoint Protocol
Configuring SharePoint Protocol Support
Configuring SharePoint Protocol for Online Editing
Setting up SharePoint Protocol Support to work with Office 2010
Setting up sticky sessions with SharePoint Protocol Support
Setting up SharePoint Protocol Support to work with HTTPS
Installing and configuring the Alfresco Transformation Server
Transformation server overview
Transformation Server prerequisites
Standalone Transformation Server prerequisites
Alfresco Transformation Client prerequisites
Transformation Server License
Installing the Alfresco Transformation Server
Installing the standalone Transformation Server
Installing the Transformation Server on Alfresco
Configuring the Alfresco Transformation Server
Configuring the Standalone Transformation Server
Configuring the Transformation Client
Using the Transformation Server
Using the Transformation Server Web Console
Integrating with monitoring tools
Upgrading
Upgrading Alfresco
Alfresco upgrade paths
Configuring an upgrade
Upgrading configurations
Validating an upgrade
WCM-specific upgrade
Upgrading an Alfresco runtime
Upgrading a cluster
Upgrading multi-tenancy
Administering
Starting and stopping
Starting the Alfresco server
Stopping the Alfresco server
Starting Alfresco Share
Starting Alfresco Explorer
Starting the Alfresco virtualization server
Stopping the Alfresco virtualization server
Starting the standalone deployment engine
Stopping the standalone deployment engine
Configuring Alfresco
Configuration overview
Runtime administration with a JMX client
Connecting to Alfresco through JMX client
Disabling JMX
Configuring Alfresco with JConsole
Global properties file
Modifying the global properties file
Setting composite properties in the global properties file
Java command line
Setting properties on the Java command line
Modifying Spring bean definition files
Modifying system configuration files
Repository system configuration files
Customizing individual configuration items
Customizing properties files
Customizing configuration files
Configuration files
Customizing bean files
Configuring databases
Configuring a PostgreSQL database
Configuring an Oracle database
Configuring a SQL Server database
Configuring the MySQL database
Optimizing MySQL to work with Alfresco
Configuring a DB2 database
Configuring Alfresco subsystems
Subsystem categories
Subsystem configuration files
Subsystem properties
Mounting a subsystem
Mounting a subsystem with composite properties
Extension classpath
Configuring OpenOffice
Changing the OpenOffice subsystem
OOoDirect subsystem configuration properties
OOoJodconverter subsystem configuration properties
Configuring synchronization
Synchronization deletion
Collision resolution
Synchronization configuration properties
Configuring file servers
Configuring SMB/CIFS server
CIFS file server properties
Java-based SMB properties
Windows native SMB
Running SMB/CIFS from a normal user account
SMB/CIFS advanced Spring overrides
Configuring the FTP file server
FTP file server properties
FTP advanced Spring overrides
Configuring the NFS file server
NFS file server properties
NFS advanced Spring overrides
Configuring email
OutboundSMTP configuration properties
InboundSMTP configuration properties
Configuring the RMI email service
Handling messages by target node type
Groups and permissions for email
Configuring IMAP Protocol support
Enabling the IMAP Protocol
IMAP subsystem properties
IMAP mount points
Virtual view email format
Marking sites as IMAP favorites
Configuring system properties
sysAdmin subsystem properties
Configuring the repository
Tuning the JVM
JVM settings
Low end machines
Effects of NewSize
Command line configuration
Setting properties on the JVM
Mixing global properties and system property settings
Configuring the repository cache
Individual cache settings
Tracing the caches
Adding a MIME type
Configuring metadata extraction
About aspects
About versioning
Making all content versionable
Disabling the auto-versioning feature
Setting up database replication
Setting up MySQL replication
Configuring the connection pool
Database Configuration Properties
Customizing content transformations
Setting up Alfresco authentication and security
Alfresco security
Authentication subsystems
Authentication subsystem types
Authentication subsystem components
Authentication chains
Authentication chain functions
Chained functions
Pass-through functions
Configuring authentication
Default authentication chain
Configuring the authentication chain
Authentication chain example with JConsole
Alfresco authentication chain
Example of disabling the Guest user login page
Removing the login page
Configuring alfrescoNtlm
NTLM
alfrescoNtlm configuration properties
Configuring Alfresco Share SSO to use NTLM
Share SSO login bypass
Configuring pass-through
Pass-through configuration properties
Domain level properties
Other pass-through properties
Domain mappings
Example: customizing the pass-through subsystem
Applying the Pass-through example
Configuring LDAP
LDAP configuration properties
Checking the supported SASL authentication mechanisms
Example: authentication and synchronization with one ldap-ad subsystem
Applying the ldap-ad example
Example: authentication and synchronization with two ldap-ad subsystems
Configuring Kerberos
Kerberos configuration properties
Configuring Kerberos against Active Directory
Configuring Share Kerberos SSO
Kerberos client configuration
Debugging Kerberos
Configuring external authentication
External configuration properties
Using Alfresco with CAS authentication through Apache mod_auth_cas
Overview of using Alfresco with CAS authentication
Install supporting tools
Install required packages
Set up Certificate Authority and issue Server and Client Certificates
Build and install mod_auth_cas
Configure mod_auth_cas
Configure, Build and Install Jasig CAS Server
Configure mod_proxy_ajp
Configure Alfresco and Share to use SSO external authentication
Test it out
Authorities
Dynamic authorities and roles
People and users
Groups
Zones
Application-related zones
Authorization-related zones
Defining permissions
Access Control Lists
ACL ordering and evaluation
An ACL example
Modifying access control
Access Control Extension
Public services
Public services configuration
Method-level security definition
Implementation and services
Person service
Authority service
Permission service
Ownable service
Setting up high availability systems
High availability components
Content store replication
Index synchronization
Database synchronization
Level 2 cache replication
High availability scenario
Initiating clustering
Configuring JGroups
Clustering through shared content stores
Using EHCache multicast discovery
Verifying the cluster
Testing cache clustering
Index clustering
Testing content replication and sharing
Testing WCM clustering
Testing web project creation
Testing web project data node synchronization
Testing web project user invite
Configuring Share clustering
Configuring the cache peer URLs
Tracking clustering issues
Backing up and restoring
Backing up and restoring the repository
Performing a cold backup
Performing a hot backup
Refreshing the backup Lucene indexes (optional)
Backing up the database
Backing up the file system
Backing up and restoring Lucene indexes
Changing the scheduled Lucene back up time
Specifying the Lucene backup directory
Restoring the Lucene indexes
Performing a full hot reindex on a cluster
Restoring the repository
Exporting and importing
Alfresco Content Package files
Exporting spaces in Explorer
Importing spaces in Explorer
Using rules to import to a space
Creating and managing workflows
What is workflow?
Advanced workflow artifacts
Administration features
Implementation
Creating a process definition
Process definition methods
Creating a skeleton process definition manually
Setting up JBoss jBPM Process Designer
Installing the Process Designer package
Deploying Eclipse
Deploying JBoss jBPM 3.1.2
Creating a task model
Deploying the task model
Using the workflowDeployer bean
Deploying as a content model
Adding behavior to a process definition
Configuring UI workflow dialogs
Process definition deployment
Deploying a process definition manually
Deploying a process definition
Managing the content store
Content store selector configuration example
Using the new content store
Content Store Selector full configuration example
Migrating
Migrating servers
Backing up Alfresco Server 1
Restoring to Server 2
Monitoring Alfresco
JMX monitoring and management extensions
Coexistence with other MBeans
Activating the Sun JMX agent and local JMX connectivity
Installing Alfresco Enterprise plug in for Hyperic
Scheduled jobs
Setting up Alfresco multi-tenancy
Enabling multi-tenancy
Managing tenants
Multi-tenancy administration
Multi-tenancy export and import
Multi-tenancy implementation
Features not currently supported in a multi-tenant environment
Setting up replication jobs
Configuring Share to open locked content in the source repository
Creating a new transfer target for replication jobs
Auditing Alfresco
Audit configuration and environment
Sample files
Disabling auditing
Auditing examples
Audit configuration files
Built-in data producers
DataExtractors and DataGenerators
Locating the audit code
Defining the audit application
Simple audit query
Advanced audit query
Understanding PathMappings
Audit recording values
Using values that have changed in a post method call
Deploying from AVM
Deployment targets
Filesystem deployment target
Single web project deployed to Tomcat
Single web project deployed to two Tomcat webapps
Filesystem deployment target properties and metadata
Filesystem deployment target configuration
avm deployment target
AVM deployment target properties
DM deployment target
DM deployment target properties
Standalone deployment receiver
Configuring the standalone deployment receiver
Deployment Service Configuration
Administering Explorer from the Administration Console
Managing users
Creating a user
Editing user details
Changing a user's password
Deleting a user
Managing user groups
Creating a user group
Deleting a user group
Adding a user to a user group
Removing a user from a user group
Managing categories
Adding a category
Deleting a category
Editing a category
Importing the ACP file into a space
Exporting a space and its contents
Viewing System Information
Using the Node Browser
Share Admin Console
Specifying application preferences
Selecting a theme
Managing groups
Browsing the user groups
Searching for a group
Creating a new group
Editing an existing group
Deleting an existing group
Managing group membership
Managing replication jobs
Viewing a replication job
Creating a new replication job
Managing existing jobs
Editing a replication job
Manually running a replication job
Cancelling a replication job
Deleting a replication job
Viewing replication job reports
Performing a repository dump
Managing users
Searching for and viewing a user account
Creating a user account
Editing a user account
Deleting a user account
Disabling a user account
Changing a user's password
Managing the user's group membership
Alfresco Explorer administrative tasks
Administering Records Management
Management Console
Accessing the Records Management Console
Records Management Auditing
Accessing the audit tool
Starting and stopping the audit log
Specifying the user
Filing the audit log as a record
Exporting the audit log
Auditing actions
Creating custom metadata
Accessing custom metadata
Creating custom metadata
Editing custom metadata
Deleting custom metadata
Defining roles and capabilities
Roles
Capabilities
Viewing the capabilities for a role
Adding new roles
Mapping emails
Accessing email mapping
Default email mappings
Adding an email map
Managing events
Accessing events
Creating a new event
Editing an event
Deleting an event
Creating a list of values
Accessing list of values
Creating a list of values
Editing a list of values
Renaming a list of values
Deleting a list of values
Getting Started tutorials
Getting Started with Alfresco Explorer Document Management
Important notes
Starting with Explorer
Toolbar
Sidebar
Working area
Logging in
Adding new users
Creating spaces and content
Creating a space
Creating and editing content in a space
Managing content item details
Working with space templates
Building smart spaces
Creating content rules
Adding a content versioning rule
Adding simple workflow rules
Requesting draft approval
Publishing the approved content
Moving content using the clipboard
Collaborating with other users
Editing content in a collaborative space
Checking out a content item
Checking in a content item
Version history
Sending content for review
Uploading and transforming content
Categorizing content and advanced search
Searching for categorized content
Forums and discussions
Creating a forum
Creating a topic
Discussions
Summary
Getting Started with Alfresco Share Collaboration
Scenario
Log in
About dashlets
Set up your personal dashboard
Publish your credentials
Create your collaboration site
Set up your site
Customize the site dashboard
Customize the site content
Prepare your site for collaboration
Create an introduction
Add the introduction to the site dashboard
Add marketing material
Update a document
Schedule a webinar
Invite members to your site
View activities within your site
Use SharePoint Protocol (SPP) Support with your MS Office documents
Getting Started with Records Management
Scenario
Log in
Accessing the Records Management site
Records Management site
Records Management dashlets
Records Management functions
Designing the File Plan
Creating the File Plan
Browsing the File Plan
Preparing disposition schedules
Disposition schedules
Creating a disposition schedule
Filing items to the File Plan
Filing an electronic record
Filing a non-electronic record
Declaring a record
Editing metadata
Declaring a record
Managing record folders
Managing records
Searching for records
Accessing Records Search
Criteria tab
Results tab
Creating a simple search
Creating advanced searches
Search using wildcards
Searching for multiple fields
Searching for phrases
Searching for dates
Searching for date ranges
Search query examples
Saving a search
Managing the Records Management system
Accessing the Records Management Console
Managing lists of values
Accessing list of values
Auditing Records Management
Accessing the audit tool
Auditing tasks
Using the AVM to Manage Web Content
System requirements and prerequisites
Scenario
Log in
Set up the web project
Create web forms
Create the web project
Add content to the web project
Import the sample dynamic website
Create web content: Company Profiles
Create web content: Press Releases
Manage web project content
Approve content
Submit content
Publish the website
Roll back to a previous snapshot
Summary
Managing Alfresco Content from within Microsoft Office
System requirements and prerequisites
Scenarios
Manage a document
Create a Document Workspace
Edit a Document Workspace document
Check out the document
Check in the document
Work with document versions
View a previous version of the document
Manage the document versions
Add content to the Document Workspace
Collaborate with colleagues on a document
Save a document to the Document Workspace
Customize the Document Workspace
Edit the site name
Change the site settings
Manage the Document Workspace membership
Add users to the site
View and edit user profiles
Change a site member's role
Work with a Document Workspace document locally
Download document updates from the site
Update the Document Workspace copy
Save an updatable copy locally
Manage document updates
Delete the Document Workspace
Collaborate with colleagues around a meeting
Create a Meeting Workspace
View the Meeting Workspace
Edit the meeting attendees
Workspace dashlets in Share
Features not supported in this release
Using Alfresco
Using Alfresco Share
Getting Started
Becoming familiar with the user interface
My dashboard
Customizing your personal dashboard
Sites
Creating a site
Searching for a site
Managing your site membership
Deleting a site
People
Searching for a user
Repository
Managing permissions in the Repository Document Library
More menu
My Tasks
Viewing tasks and workflows
Editing a task
Workflows I've Started
Viewing a workflow
Cancelling a workflow
User menu
Updating your status
My Profile
Viewing your full profile
Editing your profile
Changing your password
Searching for content
Performing a basic search
Performing an advanced search
Search examples
Your personal dashboard
Entering a site
Specifying favorite sites
Configuring the personal dashboard RSS feed
Viewing scheduled events
Managing site membership requests
Using the Alfresco Network
Configuring the Web View personal dashlet
Site Dashboards
Marking the current site as a favorite
Customizing a site
Customizing a site dashboard
Editing the site details
Configuring the site dashboard RSS feed
Configuring the Wiki site dashlet
Subscribing to an RSS feed
Configuring the Web View site dashlet
Tagging site content
Selecting a page component
The Wiki page component
Accessing the Wiki page component
Browsing the wiki pages
Creating the wiki main page
Creating a new wiki page
Editing a wiki page
Renaming a wiki page
Deleting a wiki page
Viewing the wiki page details
The blog
Accessing the Blog page component
Browsing the blog
Configuring the external blog
Viewing a blog post
Creating a blog post
Editing a blog post
Deleting a blog post
Publishing a post to an external blog
Working with comments
Adding a comment to a post
Editing a comment
Deleting a comment
The library
Accessing the Document Library page component
Browsing the library
Creating a folder structure
Adding content to the library
Adding items to the library
Creating content in the library
Working with folders
Viewing folder details
Viewing a folder in Alfresco Explorer
Using rules
Defining rules for a folder
Creating a new rule from scratch
Linking to an existing rule set
Managing rules
Working with a defined rule set
Creating a new rule
Editing a rule
Deleting a rule
Reordering the rules in the rule set
Running rules
Working with linked rules
Linking to a different rule set
Breaking the link to a rule set
Creating a simple workflow
Working with individual library items
Viewing an item
Viewing an item in a browser
Editing library content
Editing an item offline
Editing an item inline
Editing your Microsoft Office documents online
Downloading content to your computer
Updating content
Starting a workflow
Managing aspects
Changing the content type
Specifying favorites
Editing folder or item details
Editing folder or item metadata
Using comments
Adding a comment
Editing a comment
Deleting a comment
Locating items and folders
Copying content
Moving content
Managing content permissions
Deleting content
Working with replicated content
Working with multiple library items
Selecting multiple items
Performing actions on multiple items and folders
The calendar
Accessing the Calendar page component
Browsing the calendar
Viewing an event
Adding an event
Editing an event
Editing the event date and time
Deleting an event
Browsing the site events
Site links
Accessing the Links page component
Browsing the links
Viewing a link
Creating a new link
Editing a link
Deleting a link
Deleting multiple links
Adding a comment to a link
Editing a link comment
Deleting a link comment
The discussions forum
Accessing the Discussions page component
Browsing the topics
Viewing a topic
Creating a new topic
Editing a topic
Deleting a topic
Creating a reply
Editing a reply
Data lists
Accessing the Data Lists page component
Viewing a list
Creating a new list
Editing the list details
Deleting a list
Working with list items
Creating a list item
Editing a list item
Duplicating a list item
Deleting a list item
Working with multiple list items
Selecting multiple list items
Performing actions on multiple list items
Managing members
Accessing the Members page component
Viewing site members
Inviting users to a site
Viewing site groups
Adding groups to a site
Changing the role of a site member or site group
Removing a site member or site group
Viewing and managing the invited users
Reference
Search syntax
Search for a single term
Search for a phrase
Search for an exact term
Search for term expansion
Search for conjunctions
Search for disjunctions
Search for negation
Search for optional, mandatory, and excluded elements of a query
Search for fields
Search for wildcards
Search for ranges
Search for fuzzy matching
Search for proximity
Search for boosts
Search for grouping
Search for spans and positions
Escaping characters
Mixed FTS ID behavior
Search for order precedence
Permissions
Dashboards
Site page components
Using Alfresco Explorer Enterprise Content Management
Getting Started
Mapping an Alfresco space to a drive
Setting user options
Changing your password
Editing user details
Recovering deleted items
Removing deleted items
Specifying your preferences
User interface
Toolbar
Sidebar
Navigator
Shelf
OpenSearch
Categories
Working area
Space header
Browse Spaces pane
Content Items pane
My Alfresco Dashboard
Configuring the dashboard layout and contents
Working with dashboard tasks
Managing a task
Reassigning a task
Viewing a completed task
Cancelling workflow for a task
Getting around in Alfresco
Navigating spaces
Changing the space appearance
Using the clipboard
Removing items from the clipboard
Using shortcuts
Creating a shortcut to a space
Creating a shortcut to a content item
Removing a shortcut from a space or content item
Finding content and spaces
Performing a basic search
Performing an advanced search
Loading a saved search
General search tips
Using Alfresco
Working with spaces
Creating spaces
Creating a space
Creating a space from a template
Customizing a space view
Previewing a space in a template
Applying a template to a space
Changing or removing a template applied to a space
Deleting a content space
Moving and copying a space
Inviting users to a space for collaboration
Managing space users
Changing users' roles for a space
Removing users from a space
Emailing space users
Taking ownership of a space
Running an action on a space
Viewing space details
Editing space details
Working with content
Adding content to spaces
Uploading content from your computer
Creating content in a space
Viewing content
Editing content
Editing content online
Editing content offline
Adding versioning to content
Downloading content to your computer
Updating content
Approving and rejecting a content item
Understanding working copies
Checking out content
Checking in content
Discussing content
Exporting and importing content
Exporting a space and its contents
Importing the ACP file into a space
Inviting users to a content item for collaboration
Managing content item users
Changing users' roles for a content item
Removing users from a content item
Taking ownership of content
Using multilingual content
Viewing content item details
Viewing content properties and a preview
Viewing full content item details
Editing content item details
Using categories
Viewing the categories linked to a content item
Adding a category link to a content item
Removing a category link from a content item
Working with smart spaces and content rules
Creating a content rule
Deleting a content rule
Editing a content rule
Viewing content rules
Managing content rules
Reapplying rules
Ignoring inherited rules
Including inherited rules
Working with workflows
Implementing a simple workflow
Implementing an advanced workflow
Viewing the workflow steps for a content item
Working with forum spaces
Creating a forum space
Deleting a forum space
Creating a forum
Creating a topic
Replying to a posted topic
Posting a message to a topic
Deleting a forum
Deleting a topic
Deleting a posted message
Editing a posted message
Managing multilingual content
Adding a translation
Adding a translation without content
Creating new editions of the translated content
Viewing the translated content editions
Reference
Installing the Firefox extension
User roles and permissions
WCM roles and tasks
Using Records Management
Getting started
Accessing the Records Management site
Records Management site
Records Management functions
The File Plan component
Accessing the File Plan
Browsing the File Plan
File Plan structure
Adding a new record series
Adding a new record category
Adding a record folder
Adding items to the File Plan
Filing an electronic record
Filing a non-electronic record
Editing record metadata
Declaring a record
Managing the File Plan
Managing record series
Viewing record series
Editing a record series
Deleting a record series
Managing record category
Viewing record categories
Editing a record category
Deleting a record category
Managing record folders
Viewing record folders
Editing a record folder
Deleting a record folder
Closing a record folder
Freezing record folders
Managing records
Disposition schedules
Creating disposition schedules
Disposition schedule rules
Searching records
Accessing Records Search
Criteria tab
Results tab
Creating a search
Search query syntax
Search for text
Search using wildcards
Searching for multiple fields
Searching for phrases
Searching for exact term
Searching for dates
Searching for date ranges
Searching for special types
Searching for empty strings
Searching for components
Searching using special operators
Search query examples
Printing the search results
Search fields
Search special record types
Saving a search
Administering Records Management
Management Console
Accessing the Records Management Console
Records Management Auditing
Accessing the audit tool
Starting and stopping the audit log
Specifying the user
Filing the audit log as a record
Exporting the audit log
Auditing actions
Creating custom metadata
Accessing custom metadata
Creating custom metadata
Editing custom metadata
Deleting custom metadata
Defining roles and capabilities
Roles
Capabilities
Viewing the capabilities for a role
Adding new roles
Mapping emails
Accessing email mapping
Default email mappings
Adding an email map
Managing events
Accessing events
Creating a new event
Editing an event
Deleting an event
Creating a list of values
Accessing list of values
Creating a list of values
Editing a list of values
Renaming a list of values
Deleting a list of values
Using the Microsoft Office Add-In
Accessing the Microsoft Office Add-In
Setting up the panel
Working with spaces
Browsing spaces
Creating a new space
Uploading a document to a space
Managing documents
Checking out a document
Modifying documents
Viewing document details
Tagging a document
Making a document versionable
Checking in a document
Transforming a document to PDF
Inserting a file into the current document
Starting a new workflow against a document
Deleting a document
Managing your document tasks
Viewing document tags
Accessing Alfresco Explorer
Searching
Using Web Content Management (WCM)
Using Alfresco Web Quick Start
Getting Started
Before you begin
Becoming familiar with the content
Home page
Specifying a template
Configuring the navigation links
Configuring the Home page carousel
News
Writing a news article
Selecting an image to accompany an article
Selecting articles for the landing page
Configuring a static asset collection
Configuring a dynamic asset collection
Publications
Creating and publishing PDF content
Working with visitor feedback
Managing comments on blog posts
Editing reported blog comments
Deleting a comment
Responding to Contact page submissions
Publishing content
Reference
Templates
homepage
sectionpage1
sectionpage2
sectionpage3
sectionpage4
sectionpage5
articlepage1
articlepage2
publicationpage1
contactpage1
Breaking down the Web Quick Start site structure
Alfresco Quick Start folders
Sections
Subsections
Collections
Using Alfresco Web Editor
Customizing the interface
Editing web content
Creating web content
Deleting web content
Using the AVM
Setting up a Web Project
Creating a web form
Creating a web project
Working with Web Project Content
Viewing a web project and its contents
Viewing the web project details
Displaying the Sandbox view
Viewing the sandbox contents
Adding content to a web project
Creating web content
Uploading content from your computer
Importing content
Creating a folder
Maintaining web project content
Editing web content
Editing content not generated from a web form
Updating web content
Rolling back changes
Previewing web content
Previewing a folder or individual file
Previewing the web project
Submitting content items
Resolving conflicts
Comparing snapshots
Managing content awaiting launch
Comparing versions
Overriding the launch
Cancelling the launch
Publishing a Web Project
Deploying a snapshot
Viewing deployment reports
Deleting the deployment reports
Rolling back to a previous snapshot
Maintaining web forms
Editing a web form
Deleting a web form
Maintaining a web project
Editing the web project settings
Inviting users to a web project
Deleting a sandbox from a web project
Deleting a web project
WCM roles and tasks
Customizing and extending
Alfresco API Reference
Alfresco Repository JavaScript API
About script files
Scripting API
Root-scoped objects
ScriptNode API
childByNamePath
childrenByXPath
activeWorkflows
isScriptContent
hasAspect
specializeType
isSubType
Modifying and creating API
createFolder
createFile
createNode
addNode
removeNode
createAssociation
removeAssociation
remove
copy
move
addAspect
removeAspect
ScriptContent API
write
guessMimetype
guessEncoding
Permission and Security API
hasPermission
getPermissions
inheritsPermission
setInheritsPermissions
setPermission
removePermission
setOwner
getOwner
takeOwnership
Check In/Check Out API
checkout
checkin
cancelCheckout
Versions API
getVersion
createVersion
Transformation API
transformDocument
transformImage
processTemplate
Search API
luceneSearch
findNode
savedSearch
xpathSearch(xpath)
ISO9075Encode
ISO9075Decode
tagSearch
query
People API
createPerson
deletePerson
createGroup
deleteGroup
getMembers
addAuthority
removeAuthority
getContainerGroups
isAdmin
changePassword
setPassword
Actions API
registered
create
ScriptAction API
execute
Logging API
isLoggingEnabled
log
Session API
Classification API
getAllCategoryNodes
getAllClassificationAspects
getRootCategories
CategoryNode Object API
createSubCategory
removeCategory
AVM API
avm.lookupStore
avm.lookupStoreRoot
avm.lookupNode
AVM Store API
store.lookupNode
store.luceneSearch
AVM Node API
node.rename
WCM Web Projects
createWebProject
getWebProject
listWebProjects
WebProjects Object API
getRoles
save
deleteWebProject
addMembership
removeMembership
listMembers
createSandbox
Sandbox Object API
deleteSandbox
submitAll
submitAllWebApp
submitAssets
submit
revertAll
revert
revertAssets
revertAllWebApp
getModifiedAssets
getModifiedAssetsWebApp
getAssetWebApp
getAsset
WCM Asset Object API
rename
move
Utility methods
pad
getNodeFromString
shortQName
longQName
createQName
moduleInstalled
toISO8601(long)
toISO8601(Date)
fromISO8601
toBoolean
Services API
Site service
Site service object
createSite
listSites
listSiteRoles
listUserSites
getSite
Site object
save
deleteSite
listMembers
isMember
getMembersRole
inviteNominated (new user)
inviteNominated (existing user)
setMembership
removeMembership
getContainer
createContainer
hasContainer
setPermissions
resetAllPermissions
denyAllAccess
getCustomProperty
getCustomProperties
inviteModerated
getInvitation
listInvitations
allowAllMembersCollaborate
Activities service
postActivity
FeedControl object
setFeedControl
unsetFeedControl
getFeedControls
Tagging service
getTags
TagScope object
tags
getTopTags
getCount
refresh
TagDetails object
Extensions
clearTags
addTag
addTags
removeTag
removeTags
childrenByTag
tagSearch
Thumbnail services
createThumbnail
getThumbnail
getThumbnails
isThumbnailNameRegistered
getPlaceHolderResourcePath
getThumbnailDefinitions
updateThumbnail
Rendition services
createRenditionDefinition
render
getRenditions
getRenditionsByName
Rendition Definition
getRenditionName
getRenderingEngineName
Authority service
searchGroupsInZone
searchGroups
createRootGroup
getAllRootGroupsInZone
getAllRootGroups
getGroup
Group object
createGroup
removeGroup
removeUser
addAuthority
removeAuthority
User object
Workflow service
Workflow Manager
getDefinitionByName
getDefinition
getInstance
getPooledTasks
getTask
createPackage
JscriptWorkflowDefinition
startWorkflow
JscriptWorkflowInstance
cancel
delete
JscriptWorkflowNode
JscriptWorkflowPath
signal
JscriptWorkflowTask
endTask
JscriptWorkflowTransition
Alfresco RESTful API reference
Repository
Authentication
Login
Login (POST)
Logout
Validate Login Ticket
Server version metadata
Action
Cancel a Running Action
Get Running Action Details
List Running Actions
Start a new Action Executing
List Running Replication Actions
Start a new Replication Action Executing
Activities
Activity type template
Activity template paths
Feed
Activities site feed
Activities admin user feed
Activities user feed
Control
Unset activity user feed control
Set activity user feed control
Get activity user feed controls
Blogs
Blog
Get blog
Put blog
Post
Blog post publishing
Delete blog post
Get all blogs
Update blog post
Posts
Get blog posts (draft)
Get blog posts (published)
Get blog posts for a number of days
Get blog posts per month
Get all externally published posts
Get blog posts
Create blog post
Comments
Delete comment
Get comment
Update comment
Get all comments
Add comment
Dictionary
Get association definitions
Get association definitions for classname
Get class definitions for classname
Get class definitions
Get property definitions
Get property definitions for classname
Get subclasses definitions
Discussions
Forum
Get hot forum posts
Get my forum posts
Get new forum posts
Get forum posts
Add forum post
Posts
Get forum post replies
Add forum post reply
Delete topic
Get topic details
Update topic
Forms
Form Persistence
Form Definitions
PickerList
PickerItems
Groups
Remove an authority from a group
Get the list of child authorities for a group.
Add group or user to a group
Get the details of a group
Update the details of a group
Delete a group
List groups
Get the list of parent authorities for a group.
Delete a root group
List all root groups
Add a root group
Invitation
List invitations
Invite
Get invite by ticket
Process invite
Accept invite
Get invites
Links
Delete link
Get all links
post
Update link
Link
Get all links
Metadata
Node metadata bulk retrieval service
Node metadata retrieval service
Node metadata storage service
Person
Update user password
Get People
Add Person
Delete Person
Get Person
Update Person
Get sites
Preference
Delete preferences
Get preferences
Set preferences
Replication
Delete a persisted replication definition
Get replication definition
Update a persisted replication definition
List persisted replication definitions
Create a new persisted replication definition
Rule
Get action constraint
Get action constraint collection
Post action queue
Get action condition definition collection
Get action definition collection
Get inherited rules collection
Delete rule
Get rule
Create rule
Update rule
Get rules collection
Get rule set
Get rule type collection
Site
Delete site
Get Web site
Update Web site
Get sites
Create Web site
Query site collection
Invitation
Cancel invitation
Get invitation
Create invitation for web site
List invitations
Membership
Delete Web Project Membership
Get Membership
Update Web site membership
List Memberships
Add user to web project
List potential Web site members
Roles
Get roles
Tagging
Get node tags
Add tag
Create new tag
List all tags
Get nodes for tag
Get tagscope tags
Thumbnail
Delete thumbnail
Get thumbnail
Update thumbnail
Get thumbnail definitions
Get thumbnails
Create thumbnail
Transfer
Alfresco transfer service
Upload
File upload
Version
Revert Version Info
Node Version Info
Wcm
Delete Web Project
Get Web Project
Create Web Project
Update Web Project
Web Projects
Membership
Delete Web Project Membership
Get Membership
List Memberships
Add user to web project
Sandbox
Delete Sandbox
Get Web Project Sandbox
Create user sandbox
Web Project Sandboxes
Asset
Delete the specified asset.
Get the details of the specified asset within the specified web project and sandbox.
Create a new WCM asset.
Update a WCM asset.
Get the content of the specified asset within the specified web project and sandbox.
Get modified assets within the specified sandbox.
Update a WCM asset
Revert modified assets within the specified author sandbox.
Submit modified assets from within the specified author sandbox.
Workflow
End Workflow Task
Gets Workflow Task Instance
Updates Workflow Task Instance
List Workflow Tasks
List Deployed Workflow Definitions
Delete Workflow Instance
Get Workflow Instance
Get Workflow Instance Collection for NodeRef
Get Workflow Instance Collection
Extensions
Webscripts
Javascript Debugger
Javascript Debugger Maintenance
Alfresco Repository FreeMarker Template reference
Template framework architecture
Template files
Template models
Default model
TemplateNode Model API
Advanced TemplateNode API
Version History API
Classification API
XML Content Processing API
Workflow API
WorkflowTaskItem API
People API
Default Model Methods
Current Date
JSP Page
Alfresco Surf Platform API reference
Surf platform
Root-scoped objects
context
user
content
page
template
config
theme
instance
sitedata
remote
locale
htmlid
url
head
app
msg
Return types
Model objects
connectors
response
response status
Rendering objects
templates
components
Customizing Alfresco Explorer
Customizing Alfresco Explorer configuration items
Alfresco Explorer configuration settings
Customizing and extending Alfresco Share
Customizing Alfresco Share configuration items
Share repository document library
Hiding the Share repository document library
Configuring the Share default port
Configuring the RSS Feed Dashlet with HTTP authentication
Enabling Google Docs integration
Share themes
Selecting themes
Creating a new theme
Editing a theme
Forms
Use of forms in Share
Forms architecture
Forms event sequence
Configuring forms
Customizing forms controls
Customizing the validation handler
Displaying Type metadata
Displaying aspect metadata
Configuring a form control
Grouping fields
Changing the default set label
Providing a custom form control
Changing the field label position
Providing a custom form template
Building a custom Knowledge Base application
Getting started
Defining a content model for metadata
Defining a Knowledge Base space
Defining Knowledge Base articles
Applying property constraints
Configuring Alfresco Explorer extensions
Property sheets
Wizards and icons
Smart spaces and scripting
Space templates
Stopping the Alfresco server
Adding the Knowledge Base content model
Adding Alfresco Explorer configuration
Adding the Knowledge Base Search web script
Starting the Alfresco server
Signing on to Alfresco Explorer
Adding a script to the Data Dictionary
Creating a Knowledge Base space template
Adding an archived space
Setting up content rules
Creating a Knowledge Base
Creating and contributing an article
Editing a Knowledge Base article
Viewing content in JSON
Customizing Alfresco Share (basic)
Building custom dashlets
Configuring a dashlet as an option on the site dashboard
Configuring custom site pages
Adding Knowledge Base site components
Designing for browser dependencies
Configuring for Internationalization
Configuring Alfresco Share
Defining custom site presets
Overriding the default message bundle
Stopping the Alfresco server
Adding the custom dashlet code
Adding the custom site page code
Adding the common library code
Configuring a custom site preset
Adding a custom message bundle
Overriding the message bundle bootstrap component
Adding files to the Tomcat ROOT web application
Starting the Alfresco server
Creating a new Alfresco Share site
Adding a custom dashlet to your site
Adding a custom page to a Share site
Creating a Knowledge Base site
Customizing Alfresco Share (advanced)
Setting aspects
Defining actions in the document library
Configuring workflows
Configuring forms in Alfresco Share
Creating articles using JavaScript
Stopping the Alfresco server
Customizing Document Library services
Adding a custom workflow to the Alfresco repository
Adding an archive action handler
Setting up the kb:article aspect
Adding Alfresco Share customizations
Adding an archive action to the document library
Enabling a custom workflow
Configuring the Alfresco Share form
Adding the Alfresco Share form template
Adding a custom message bundle
Overriding the message bundle bootstrap component
Adding files to the Tomcat ROOT web application
Starting the Alfresco server
Setting up a Knowledge Base
Adding and editing content
Approving content
Archiving content in the Knowledge Base
Developing against the Alfresco repository
Alfresco repository extension points
Content models
Content behavior
Process definitions
Workflow models
Actions
Customizing content transformations
Content modeling
Content metadata model
Deploying a content model
Deploying a content model - bootstrap approach
Deploying a content model - dynamic approach
Content metamodel
Metadata XML schema
Model Header
Model namespaces
Model types
Properties
Associations
Constraints
Inheritance
Aspects
Out-of-the-box models
Defining a custom model for Knowledge Base articles
Creating content with JavaScript
Localizing models
Alfresco content models and CMIS
Building applications with Content Management Interoperability Services (CMIS)
Using CMIS with Alfresco
CMIS requirements
CMIS repository
CMIS query
CMIS services
CMIS object model
Configuring and extending Alfresco services
Using Embedded APIs
Using the Java API to create new content
Using the JavaScript API to create new content
Using the Template API to display properties
Using Remote APIs
Using the RESTful API to retrieve document tags
Configuring and extending existing services
Extending RuntimeExecutableContentTransformer
Building Alfresco services
Building a simple service
Alfresco content services
Content repository services
File Folders service
Versioning service
Check Out / Check In service
Audit service
Authority service
Permission service
Person service
Dictionary service
Search service
Content application services
Content services
Rules and actions
Transformation service
Metadata extraction
Thumbnailing service
Control services
Workflow service
Web Projects service
Sandbox service
Assets
Collaboration services
Sites service
Invite service
Activity service
Tagging service
Commenting service
Working with the Surf framework
Surf content
Content delivery services
Content applications
Spring framework plug-in
Model-View-Controller
Spring Web MVC
Rendering a Surf page
Using an annotated controller
Surf View Composition framework
Pages
Templates and regions
Components
Presentation content
Surf objects
Templates and Surf
Web scripts and Surf
Connectors and credentials
Connectors and endpoints
Credentials
Authenticators
Remote API
Creating a reusable Java-backed web script
Modifying a web script using the Surf Remote API
Working with Alfresco web scripts
Web script types
Data web scripts
Presentation web scripts
Web Script Framework
Web script components
Web script description document
Web script controller script
Web script response template
Naming conventions
File locations
URI anatomy
URI template
Format readers
Response status code templates
Response status codes
Developing a Hello World web script
Locating the Hello World example
How Hello World works
Listing pre-built web scripts
Invoking web scripts
Invoking a web script using cURL
Creating a Hello User web script with authentication
Returning a JSON response format
Selecting a response format
How Hello User works
Developing a Folder Listing web script
Creating a description document
Creating a controller script
Parsing the web script URI
Calling Alfresco services
Constructing the model
Creating a response template
Accessing the model
Accessing Alfresco services
Registering and testing web scripts
Creating multiple response templates
Adding a response status code template
Working with client limitations
Tunneling HTTP methods
Forcing success response status
JSON callbacks
Using the JSON callback
Understanding how the JSON callback works
Caching
Runtime cache controls
Descriptor cache controls
Creating a web script using cache controls
Authenticating web scripts
Specifying user identity
Custom client authentication
Configuring web scripts
Creating a Knowledge Base Search web script
Testing Knowledge Base Search
How Knowledge Base Search works
Processing complex HTTP requests
Debugging a controller script
Forms and web scripts
Processing multipart forms
Testing the upload web script
Creating request processing web scripts
Extending the request processing web script
Internationalization (I18N)
Creating resource bundles supporting I18N
Adding resource bundles for additional languages
Overriding the default message bundle
Java-backed web scripts
Java approach to web scripts
Creating a Folder Listing Java-backed web script
Creating the scripted components of a Folder Listing web script
Developing a controller for a Folder Listing Java-backed web script
Parsing the URI
Calling Alfresco services
Setting the response status code
Constructing the model
Registering a Java-backed web script
Declaring service dependencies
Creating a new kind of web script
Using a new kind of web script
Creating a reusable Java-backed web script
Modifying a web script using the Surf Remote API
Web script reference
Form Data API
formdata
formfield
JSON Object API
JSONObject
JSONArray
FreeMarker methods
Root objects
url
status
cache
format
webscript
server
Advanced descriptor options
Lifecycle
Family
Run As
Integrating with other applications
Content management integration patterns
Content Service Mappers
Property View
Article
Query view
Browser view
Librarian
Catalog view
Attachment
Annotation
Archive
Project Space
Review and Approval workflow
Feed
Portlet view
Environment considerations
Troubleshooting
Debugging an Alfresco installation
Debugging an upgrade
Setting log levels
Testing and debugging links
Error messages
Troubleshooting an upgrade
Troubleshooting clustering
Troubleshooting OpenOffice subsystems
Troubleshooting the JMX Dumper
Troubleshooting NFS
Troubleshooting CIFS
OpenLDAP tips
Active Directory tips
Troubleshooting SMTP inbound email using StartTLS
Handling a higher rate of outbound TCP connections
Troubleshooting IMAP
Reference
Properties available in a JMX client
JMX bean categories reference
JMX read-only monitoring beans
JMX configuration beans
JMX editable management beans
Search syntax
Search for a single term
Search for a phrase
Search for an exact term
Search for term expansion
Search for conjunctions
Search for disjunctions
Search for negation
Search for optional, mandatory, and excluded elements of a query
Search for fields
Search for wildcards
Search for ranges
Search for fuzzy matching
Search for proximity
Search for boosts
Search for grouping
Search for spans and positions
Escaping characters
Mixed FTS ID behavior
Search for order precedence
Forms reference
Frequently occurring tasks
Opening a Windows command prompt
Adding folder paths to the Windows path variable
Changing the default shell (Unix/Linux/Solaris) for shell scripts
Setting file limits for Linux
Administrator best practices
Tips for getting the most out of Alfresco
Common mistakes made by Alfresco administrators
Eight shortcuts every Alfresco administrator should know
Glossary
Copyright
Overview
Conventions
System paths
Alfresco applications
Content applications
Alfresco web tier and Surf
Alfresco programming models
Guiding design principles
Architecture
Alfresco content application server
Alfresco content repository
Alfresco content services
APIs
Embedded API
Remote API
Content modeling
Protocols
Modularity
Alfresco web application framework
Deployment options
Installing
Alfresco Simple Installs
Installing Alfresco on Linux
Installing Alfresco on Windows
Installing Alfresco
Production environment checklist
Validating the architecture
Validating the environment
Installation files
Alfresco setup wizards
Alfresco WAR installation files
SharePoint Protocol Support installation files
Alfresco WCM installation files
Microsoft Office Add-ins installation files
Alfresco Records Management installation files
Alfresco SDK AND APIs installation files
Alfresco Web Service client installation files
Downloading Enterprise installation files
Supported stacks
Software requirements
Installing Alfresco on Tomcat
Installing Tomcat application server
Installing the Alfresco WAR
Deploying Share into a separate Tomcat instance
Configuring Alfresco as a Windows service
Installing Alfresco on JBoss
Configuring JBoss for Alfresco
Installing Alfresco on WebLogic
Enabling Google Docs with Alfresco (Lucene enabled) deployed on WebLogic
Installing Alfresco on WebSphere
Enabling Google Docs with Alfresco (Lucene enabled) deployed on WebSphere
Enabling YouTube with Alfresco (Lucene enabled) deployed on WebSphere
Enabling SlideShare with Alfresco (Lucene enabled) deployed on WebSphere
Installing a new license
Installing software required for Alfresco
Installing OpenOffice
Installing ImageMagick
Installing Ghostscript
Installing Flash Player
Installing SWF Tools
Installing SWF Tools on Windows
Installing SWF Tools on Linux
Installing TinyMCE language packs
Installing an Alfresco Module Package
Installing the Firefox extension
Installing and configuring Alfresco WCM
Web Quick Start
About Web Quick Start
Installing Alfresco and Web Quick Start
Manually installing Web Quick Start
Installing Web Quick Start on an existing Alfresco Enterprise install
Creating the Web Quick Start site
Importing Web Quick Start demo data
Configuring Web Quick Start
Configuring the web application host name, port, and context
Disabling AWE on the Live environment
Alfresco Web Editor
Alfresco Web Editor deployment
Deploying the Alfresco Web Editor
Deploying the Alfresco Web Editor to a Spring Surf application
Configuring Alfresco Web Editor
Configuring the tag library
Configuring the servlet filter
Configuring Web Editor forms
Sample web application using Alfresco Web Editor
Alternative Versioning Model (AVM)
About Alternative Versioning Model (AVM)
Installing AVM
Installing AVM to an existing instance of Alfresco
Verifying the AVM installation
Installing the standalone deployment receiver
Deployment receiver subsystem properties
Configuring AVM
Configuring the virtualization server
Using ip.alfrescodemo.net
Configuring wildcard DNS on a nameserver
Installing Records Management
Applying the Records Management AMP files
Adding the Records Management dashlet
Creating the Records Management site
Installing and configuring Alfresco Kofax Release script
System requirements and prerequisites
Installing Kofax Release script
Installing the Alfresco Kofax Release script AMP
Installing the Alfresco Kofax Capture Release script binaries
Configuring the Alfresco Kofax Release script
Associating the Alfresco Kofax Release script with a document class
Alfresco Kofax Release script configuration tabs
Repository tab
Index tab
General tab
Publishing a batch class
Releasing batches
Advanced configuration: custom types, aspects, and properties
Removing the Alfresco Kofax Release script
Troubleshooting the Kofax Release script
Installing and configuring IBM Lotus Quickr integration
Installing the Lotus Quickr AMP
Publishing content from Quickr to Alfresco
Configuring Quickr to browse Alfresco as the Enterprise library
Accessing Alfresco as a Team Place using Quickr connectors
Installing and configuring Alfresco XAM Connector
Software prerequisites for XAM Connector module
Setting up the Centera test environment
Configuring the XAM connection
Alfresco XAM Connector module properties
Testing the XAM connection
Installing the XAM Connector module
Testing the XAM Connector module
Setting up the XAMContentStore as the primary store
Installing and configuring the Alfresco Jive Toolkit
Alfresco Jive integration overview
Alfresco Jive Toolkit architecture
Alfresco Jive Toolkit full text indexing
Alfresco Jive Toolkit access control and identity
Alfresco Jive Toolkit installation
Installing the Jive Toolkit on Alfresco
Installing the Jive Toolkit on Jive
Configuring authentication for the Jive Toolkit
Using the Alfresco Jive Toolkit
Socializing a document from Alfresco to Jive
Uploading a file from Jive to Alfresco
Linking a file from Jive to Alfresco
Deleting a document in Jive and Alfresco
Installing and configuring Alfresco DocLib Portlets
DocLib Portlets capabilities
Configuring Liferay
Configuring Alfresco
Configuring the Liferay Share web application
Creating Liferay users
Adding portlets to Liferay
Installing Microsoft Office Add-ins
Setting up Microsoft Office Add-ins to work with HTTPS
Installing and configuring Microsoft Office SharePoint Protocol Support
Installing the SharePoint Protocol Support AMP
Prerequisites for using SharePoint Protocol
Configuring SharePoint Protocol Support
Configuring SharePoint Protocol for Online Editing
Setting up SharePoint Protocol Support to work with Office 2010
Setting up sticky sessions with SharePoint Protocol Support
Setting up SharePoint Protocol Support to work with HTTPS
Installing and configuring the Alfresco Transformation Server
Transformation server overview
Transformation Server prerequisites
Standalone Transformation Server prerequisites
Alfresco Transformation Client prerequisites
Transformation Server License
Installing the Alfresco Transformation Server
Installing the standalone Transformation Server
Installing the Transformation Server on Alfresco
Configuring the Alfresco Transformation Server
Configuring the Standalone Transformation Server
Configuring the Transformation Client
Using the Transformation Server
Using the Transformation Server Web Console
Integrating with monitoring tools
Upgrading
Upgrading Alfresco
Alfresco upgrade paths
Configuring an upgrade
Upgrading configurations
Validating an upgrade
WCM-specific upgrade
Upgrading an Alfresco runtime
Upgrading a cluster
Upgrading multi-tenancy
Administering
Starting and stopping
Starting the Alfresco server
Stopping the Alfresco server
Starting Alfresco Share
Starting Alfresco Explorer
Starting the Alfresco virtualization server
Stopping the Alfresco virtualization server
Starting the standalone deployment engine
Stopping the standalone deployment engine
Configuring Alfresco
Configuration overview
Runtime administration with a JMX client
Connecting to Alfresco through JMX client
Disabling JMX
Configuring Alfresco with JConsole
Global properties file
Modifying the global properties file
Setting composite properties in the global properties file
Java command line
Setting properties on the Java command line
Modifying Spring bean definition files
Modifying system configuration files
Repository system configuration files
Customizing individual configuration items
Customizing properties files
Customizing configuration files
Configuration files
Customizing bean files
Configuring databases
Configuring a PostgreSQL database
Configuring an Oracle database
Configuring a SQL Server database
Configuring the MySQL database
Optimizing MySQL to work with Alfresco
Configuring a DB2 database
Configuring Alfresco subsystems
Subsystem categories
Subsystem configuration files
Subsystem properties
Mounting a subsystem
Mounting a subsystem with composite properties
Extension classpath
Configuring OpenOffice
Changing the OpenOffice subsystem
OOoDirect subsystem configuration properties
OOoJodconverter subsystem configuration properties
Configuring synchronization
Synchronization deletion
Collision resolution
Synchronization configuration properties
Configuring file servers
Configuring SMB/CIFS server
CIFS file server properties
Java-based SMB properties
Windows native SMB
Running SMB/CIFS from a normal user account
SMB/CIFS advanced Spring overrides
Configuring the FTP file server
FTP file server properties
FTP advanced Spring overrides
Configuring the NFS file server
NFS file server properties
NFS advanced Spring overrides
Configuring email
OutboundSMTP configuration properties
InboundSMTP configuration properties
Configuring the RMI email service
Handling messages by target node type
Groups and permissions for email
Configuring IMAP Protocol support
Enabling the IMAP Protocol
IMAP subsystem properties
IMAP mount points
Virtual view email format
Marking sites as IMAP favorites
Configuring system properties
sysAdmin subsystem properties
Configuring the repository
Tuning the JVM
JVM settings
Low end machines
Effects of NewSize
Command line configuration
Setting properties on the JVM
Mixing global properties and system property settings
Configuring the repository cache
Individual cache settings
Tracing the caches
Adding a MIME type
Configuring metadata extraction
About aspects
About versioning
Making all content versionable
Disabling the auto-versioning feature
Setting up database replication
Setting up MySQL replication
Configuring the connection pool
Database Configuration Properties
Customizing content transformations
Setting up Alfresco authentication and security
Alfresco security
Authentication subsystems
Authentication subsystem types
Authentication subsystem components
Authentication chains
Authentication chain functions
Chained functions
Pass-through functions
Configuring authentication
Default authentication chain
Configuring the authentication chain
Authentication chain example with JConsole
Alfresco authentication chain
Example of disabling the Guest user login page
Removing the login page
Configuring alfrescoNtlm
NTLM
alfrescoNtlm configuration properties
Configuring Alfresco Share SSO to use NTLM
Share SSO login bypass
Configuring pass-through
Pass-through configuration properties
Domain level properties
Other pass-through properties
Domain mappings
Example: customizing the pass-through subsystem
Applying the Pass-through example
Configuring LDAP
LDAP configuration properties
Checking the supported SASL authentication mechanisms
Example: authentication and synchronization with one ldap-ad subsystem
Applying the ldap-ad example
Example: authentication and synchronization with two ldap-ad subsystems
Configuring Kerberos
Kerberos configuration properties
Configuring Kerberos against Active Directory
Configuring Share Kerberos SSO
Kerberos client configuration
Debugging Kerberos
Configuring external authentication
External configuration properties
Using Alfresco with CAS authentication through Apache mod_auth_cas
Overview of using Alfresco with CAS authentication
Install supporting tools
Install required packages
Set up Certificate Authority and issue Server and Client Certificates
Build and install mod_auth_cas
Configure mod_auth_cas
Configure, Build and Install Jasig CAS Server
Configure mod_proxy_ajp
Configure Alfresco and Share to use SSO external authentication
Test it out
Authorities
Dynamic authorities and roles
People and users
Groups
Zones
Application-related zones
Authorization-related zones
Defining permissions
Access Control Lists
ACL ordering and evaluation
An ACL example
Modifying access control
Access Control Extension
Public services
Public services configuration
Method-level security definition
Implementation and services
Person service
Authority service
Permission service
Ownable service
Setting up high availability systems
High availability components
Content store replication
Index synchronization
Database synchronization
Level 2 cache replication
High availability scenario
Initiating clustering
Configuring JGroups
Clustering through shared content stores
Using EHCache multicast discovery
Verifying the cluster
Testing cache clustering
Index clustering
Testing content replication and sharing
Testing WCM clustering
Testing web project creation
Testing web project data node synchronization
Testing web project user invite
Configuring Share clustering
Configuring the cache peer URLs
Tracking clustering issues
Backing up and restoring
Backing up and restoring the repository
Performing a cold backup
Performing a hot backup
Refreshing the backup Lucene indexes (optional)
Backing up the database
Backing up the file system
Backing up and restoring Lucene indexes
Changing the scheduled Lucene back up time
Specifying the Lucene backup directory
Restoring the Lucene indexes
Performing a full hot reindex on a cluster
Restoring the repository
Exporting and importing
Alfresco Content Package files
Exporting spaces in Explorer
Importing spaces in Explorer
Using rules to import to a space
Creating and managing workflows
What is workflow?
Advanced workflow artifacts
Administration features
Implementation
Creating a process definition
Process definition methods
Creating a skeleton process definition manually
Setting up JBoss jBPM Process Designer
Installing the Process Designer package
Deploying Eclipse
Deploying JBoss jBPM 3.1.2
Creating a task model
Deploying the task model
Using the workflowDeployer bean
Deploying as a content model
Adding behavior to a process definition
Configuring UI workflow dialogs
Process definition deployment
Deploying a process definition manually
Deploying a process definition
Managing the content store
Content store selector configuration example
Using the new content store
Content Store Selector full configuration example
Migrating
Migrating servers
Backing up Alfresco Server 1
Restoring to Server 2
Monitoring Alfresco
JMX monitoring and management extensions
Coexistence with other MBeans
Activating the Sun JMX agent and local JMX connectivity
Installing Alfresco Enterprise plug in for Hyperic
Scheduled jobs
Setting up Alfresco multi-tenancy
Enabling multi-tenancy
Managing tenants
Multi-tenancy administration
Multi-tenancy export and import
Multi-tenancy implementation
Features not currently supported in a multi-tenant environment
Setting up replication jobs
Configuring Share to open locked content in the source repository
Creating a new transfer target for replication jobs
Auditing Alfresco
Audit configuration and environment
Sample files
Disabling auditing
Auditing examples
Audit configuration files
Built-in data producers
DataExtractors and DataGenerators
Locating the audit code
Defining the audit application
Simple audit query
Advanced audit query
Understanding PathMappings
Audit recording values
Using values that have changed in a post method call
Deploying from AVM
Deployment targets
Filesystem deployment target
Single web project deployed to Tomcat
Single web project deployed to two Tomcat webapps
Filesystem deployment target properties and metadata
Filesystem deployment target configuration
avm deployment target
AVM deployment target properties
DM deployment target
DM deployment target properties
Standalone deployment receiver
Configuring the standalone deployment receiver
Deployment Service Configuration
Administering Explorer from the Administration Console
Managing users
Creating a user
Editing user details
Changing a user's password
Deleting a user
Managing user groups
Creating a user group
Deleting a user group
Adding a user to a user group
Removing a user from a user group
Managing categories
Adding a category
Deleting a category
Editing a category
Importing the ACP file into a space
Exporting a space and its contents
Viewing System Information
Using the Node Browser
Share Admin Console
Specifying application preferences
Selecting a theme
Managing groups
Browsing the user groups
Searching for a group
Creating a new group
Editing an existing group
Deleting an existing group
Managing group membership
Managing replication jobs
Viewing a replication job
Creating a new replication job
Managing existing jobs
Editing a replication job
Manually running a replication job
Cancelling a replication job
Deleting a replication job
Viewing replication job reports
Performing a repository dump
Managing users
Searching for and viewing a user account
Creating a user account
Editing a user account
Deleting a user account
Disabling a user account
Changing a user's password
Managing the user's group membership
Alfresco Explorer administrative tasks
Administering Records Management
Management Console
Accessing the Records Management Console
Records Management Auditing
Accessing the audit tool
Starting and stopping the audit log
Specifying the user
Filing the audit log as a record
Exporting the audit log
Auditing actions
Creating custom metadata
Accessing custom metadata
Creating custom metadata
Editing custom metadata
Deleting custom metadata
Defining roles and capabilities
Roles
Capabilities
Viewing the capabilities for a role
Adding new roles
Mapping emails
Accessing email mapping
Default email mappings
Adding an email map
Managing events
Accessing events
Creating a new event
Editing an event
Deleting an event
Creating a list of values
Accessing list of values
Creating a list of values
Editing a list of values
Renaming a list of values
Deleting a list of values
Getting Started tutorials
Getting Started with Alfresco Explorer Document Management
Important notes
Starting with Explorer
Toolbar
Sidebar
Working area
Logging in
Adding new users
Creating spaces and content
Creating a space
Creating and editing content in a space
Managing content item details
Working with space templates
Building smart spaces
Creating content rules
Adding a content versioning rule
Adding simple workflow rules
Requesting draft approval
Publishing the approved content
Moving content using the clipboard
Collaborating with other users
Editing content in a collaborative space
Checking out a content item
Checking in a content item
Version history
Sending content for review
Uploading and transforming content
Categorizing content and advanced search
Searching for categorized content
Forums and discussions
Creating a forum
Creating a topic
Discussions
Summary
Getting Started with Alfresco Share Collaboration
Scenario
Log in
About dashlets
Set up your personal dashboard
Publish your credentials
Create your collaboration site
Set up your site
Customize the site dashboard
Customize the site content
Prepare your site for collaboration
Create an introduction
Add the introduction to the site dashboard
Add marketing material
Update a document
Schedule a webinar
Invite members to your site
View activities within your site
Use SharePoint Protocol (SPP) Support with your MS Office documents
Getting Started with Records Management
Scenario
Log in
Accessing the Records Management site
Records Management site
Records Management dashlets
Records Management functions
Designing the File Plan
Creating the File Plan
Browsing the File Plan
Preparing disposition schedules
Disposition schedules
Creating a disposition schedule
Filing items to the File Plan
Filing an electronic record
Filing a non-electronic record
Declaring a record
Editing metadata
Declaring a record
Managing record folders
Managing records
Searching for records
Accessing Records Search
Criteria tab
Results tab
Creating a simple search
Creating advanced searches
Search using wildcards
Searching for multiple fields
Searching for phrases
Searching for dates
Searching for date ranges
Search query examples
Saving a search
Managing the Records Management system
Accessing the Records Management Console
Managing lists of values
Accessing list of values
Auditing Records Management
Accessing the audit tool
Auditing tasks
Using the AVM to Manage Web Content
System requirements and prerequisites
Scenario
Log in
Set up the web project
Create web forms
Create the web project
Add content to the web project
Import the sample dynamic website
Create web content: Company Profiles
Create web content: Press Releases
Manage web project content
Approve content
Submit content
Publish the website
Roll back to a previous snapshot
Summary
Managing Alfresco Content from within Microsoft Office
System requirements and prerequisites
Scenarios
Manage a document
Create a Document Workspace
Edit a Document Workspace document
Check out the document
Check in the document
Work with document versions
View a previous version of the document
Manage the document versions
Add content to the Document Workspace
Collaborate with colleagues on a document
Save a document to the Document Workspace
Customize the Document Workspace
Edit the site name
Change the site settings
Manage the Document Workspace membership
Add users to the site
View and edit user profiles
Change a site member's role
Work with a Document Workspace document locally
Download document updates from the site
Update the Document Workspace copy
Save an updatable copy locally
Manage document updates
Delete the Document Workspace
Collaborate with colleagues around a meeting
Create a Meeting Workspace
View the Meeting Workspace
Edit the meeting attendees
Workspace dashlets in Share
Features not supported in this release
Using Alfresco
Using Alfresco Share
Getting Started
Becoming familiar with the user interface
My dashboard
Customizing your personal dashboard
Sites
Creating a site
Searching for a site
Managing your site membership
Deleting a site
People
Searching for a user
Repository
Managing permissions in the Repository Document Library
More menu
My Tasks
Viewing tasks and workflows
Editing a task
Workflows I've Started
Viewing a workflow
Cancelling a workflow
User menu
Updating your status
My Profile
Viewing your full profile
Editing your profile
Changing your password
Searching for content
Performing a basic search
Performing an advanced search
Search examples
Your personal dashboard
Entering a site
Specifying favorite sites
Configuring the personal dashboard RSS feed
Viewing scheduled events
Managing site membership requests
Using the Alfresco Network
Configuring the Web View personal dashlet
Site Dashboards
Marking the current site as a favorite
Customizing a site
Customizing a site dashboard
Editing the site details
Configuring the site dashboard RSS feed
Configuring the Wiki site dashlet
Subscribing to an RSS feed
Configuring the Web View site dashlet
Tagging site content
Selecting a page component
The Wiki page component
Accessing the Wiki page component
Browsing the wiki pages
Creating the wiki main page
Creating a new wiki page
Editing a wiki page
Renaming a wiki page
Deleting a wiki page
Viewing the wiki page details
The blog
Accessing the Blog page component
Browsing the blog
Configuring the external blog
Viewing a blog post
Creating a blog post
Editing a blog post
Deleting a blog post
Publishing a post to an external blog
Working with comments
Adding a comment to a post
Editing a comment
Deleting a comment
The library
Accessing the Document Library page component
Browsing the library
Creating a folder structure
Adding content to the library
Adding items to the library
Creating content in the library
Working with folders
Viewing folder details
Viewing a folder in Alfresco Explorer
Using rules
Defining rules for a folder
Creating a new rule from scratch
Linking to an existing rule set
Managing rules
Working with a defined rule set
Creating a new rule
Editing a rule
Deleting a rule
Reordering the rules in the rule set
Running rules
Working with linked rules
Linking to a different rule set
Breaking the link to a rule set
Creating a simple workflow
Working with individual library items
Viewing an item
Viewing an item in a browser
Editing library content
Editing an item offline
Editing an item inline
Editing your Microsoft Office documents online
Downloading content to your computer
Updating content
Starting a workflow
Managing aspects
Changing the content type
Specifying favorites
Editing folder or item details
Editing folder or item metadata
Using comments
Adding a comment
Editing a comment
Deleting a comment
Locating items and folders
Copying content
Moving content
Managing content permissions
Deleting content
Working with replicated content
Working with multiple library items
Selecting multiple items
Performing actions on multiple items and folders
The calendar
Accessing the Calendar page component
Browsing the calendar
Viewing an event
Adding an event
Editing an event
Editing the event date and time
Deleting an event
Browsing the site events
Site links
Accessing the Links page component
Browsing the links
Viewing a link
Creating a new link
Editing a link
Deleting a link
Deleting multiple links
Adding a comment to a link
Editing a link comment
Deleting a link comment
The discussions forum
Accessing the Discussions page component
Browsing the topics
Viewing a topic
Creating a new topic
Editing a topic
Deleting a topic
Creating a reply
Editing a reply
Data lists
Accessing the Data Lists page component
Viewing a list
Creating a new list
Editing the list details
Deleting a list
Working with list items
Creating a list item
Editing a list item
Duplicating a list item
Deleting a list item
Working with multiple list items
Selecting multiple list items
Performing actions on multiple list items
Managing members
Accessing the Members page component
Viewing site members
Inviting users to a site
Viewing site groups
Adding groups to a site
Changing the role of a site member or site group
Removing a site member or site group
Viewing and managing the invited users
Reference
Search syntax
Search for a single term
Search for a phrase
Search for an exact term
Search for term expansion
Search for conjunctions
Search for disjunctions
Search for negation
Search for optional, mandatory, and excluded elements of a query
Search for fields
Search for wildcards
Search for ranges
Search for fuzzy matching
Search for proximity
Search for boosts
Search for grouping
Search for spans and positions
Escaping characters
Mixed FTS ID behavior
Search for order precedence
Permissions
Dashboards
Site page components
Using Alfresco Explorer Enterprise Content Management
Getting Started
Mapping an Alfresco space to a drive
Setting user options
Changing your password
Editing user details
Recovering deleted items
Removing deleted items
Specifying your preferences
User interface
Toolbar
Sidebar
Navigator
Shelf
OpenSearch
Categories
Working area
Space header
Browse Spaces pane
Content Items pane
My Alfresco Dashboard
Configuring the dashboard layout and contents
Working with dashboard tasks
Managing a task
Reassigning a task
Viewing a completed task
Cancelling workflow for a task
Getting around in Alfresco
Navigating spaces
Changing the space appearance
Using the clipboard
Removing items from the clipboard
Using shortcuts
Creating a shortcut to a space
Creating a shortcut to a content item
Removing a shortcut from a space or content item
Finding content and spaces
Performing a basic search
Performing an advanced search
Loading a saved search
General search tips
Using Alfresco
Working with spaces
Creating spaces
Creating a space
Creating a space from a template
Customizing a space view
Previewing a space in a template
Applying a template to a space
Changing or removing a template applied to a space
Deleting a content space
Moving and copying a space
Inviting users to a space for collaboration
Managing space users
Changing users' roles for a space
Removing users from a space
Emailing space users
Taking ownership of a space
Running an action on a space
Viewing space details
Editing space details
Working with content
Adding content to spaces
Uploading content from your computer
Creating content in a space
Viewing content
Editing content
Editing content online
Editing content offline
Adding versioning to content
Downloading content to your computer
Updating content
Approving and rejecting a content item
Understanding working copies
Checking out content
Checking in content
Discussing content
Exporting and importing content
Exporting a space and its contents
Importing the ACP file into a space
Inviting users to a content item for collaboration
Managing content item users
Changing users' roles for a content item
Removing users from a content item
Taking ownership of content
Using multilingual content
Viewing content item details
Viewing content properties and a preview
Viewing full content item details
Editing content item details
Using categories
Viewing the categories linked to a content item
Adding a category link to a content item
Removing a category link from a content item
Working with smart spaces and content rules
Creating a content rule
Deleting a content rule
Editing a content rule
Viewing content rules
Managing content rules
Reapplying rules
Ignoring inherited rules
Including inherited rules
Working with workflows
Implementing a simple workflow
Implementing an advanced workflow
Viewing the workflow steps for a content item
Working with forum spaces
Creating a forum space
Deleting a forum space
Creating a forum
Creating a topic
Replying to a posted topic
Posting a message to a topic
Deleting a forum
Deleting a topic
Deleting a posted message
Editing a posted message
Managing multilingual content
Adding a translation
Adding a translation without content
Creating new editions of the translated content
Viewing the translated content editions
Reference
Installing the Firefox extension
User roles and permissions
WCM roles and tasks
Using Records Management
Getting started
Accessing the Records Management site
Records Management site
Records Management functions
The File Plan component
Accessing the File Plan
Browsing the File Plan
File Plan structure
Adding a new record series
Adding a new record category
Adding a record folder
Adding items to the File Plan
Filing an electronic record
Filing a non-electronic record
Editing record metadata
Declaring a record
Managing the File Plan
Managing record series
Viewing record series
Editing a record series
Deleting a record series
Managing record category
Viewing record categories
Editing a record category
Deleting a record category
Managing record folders
Viewing record folders
Editing a record folder
Deleting a record folder
Closing a record folder
Freezing record folders
Managing records
Disposition schedules
Creating disposition schedules
Disposition schedule rules
Searching records
Accessing Records Search
Criteria tab
Results tab
Creating a search
Search query syntax
Search for text
Search using wildcards
Searching for multiple fields
Searching for phrases
Searching for exact term
Searching for dates
Searching for date ranges
Searching for special types
Searching for empty strings
Searching for components
Searching using special operators
Search query examples
Printing the search results
Search fields
Search special record types
Saving a search
Administering Records Management
Management Console
Accessing the Records Management Console
Records Management Auditing
Accessing the audit tool
Starting and stopping the audit log
Specifying the user
Filing the audit log as a record
Exporting the audit log
Auditing actions
Creating custom metadata
Accessing custom metadata
Creating custom metadata
Editing custom metadata
Deleting custom metadata
Defining roles and capabilities
Roles
Capabilities
Viewing the capabilities for a role
Adding new roles
Mapping emails
Accessing email mapping
Default email mappings
Adding an email map
Managing events
Accessing events
Creating a new event
Editing an event
Deleting an event
Creating a list of values
Accessing list of values
Creating a list of values
Editing a list of values
Renaming a list of values
Deleting a list of values
Using the Microsoft Office Add-In
Accessing the Microsoft Office Add-In
Setting up the panel
Working with spaces
Browsing spaces
Creating a new space
Uploading a document to a space
Managing documents
Checking out a document
Modifying documents
Viewing document details
Tagging a document
Making a document versionable
Checking in a document
Transforming a document to PDF
Inserting a file into the current document
Starting a new workflow against a document
Deleting a document
Managing your document tasks
Viewing document tags
Accessing Alfresco Explorer
Searching
Using Web Content Management (WCM)
Using Alfresco Web Quick Start
Getting Started
Before you begin
Becoming familiar with the content
Home page
Specifying a template
Configuring the navigation links
Configuring the Home page carousel
News
Writing a news article
Selecting an image to accompany an article
Selecting articles for the landing page
Configuring a static asset collection
Configuring a dynamic asset collection
Publications
Creating and publishing PDF content
Working with visitor feedback
Managing comments on blog posts
Editing reported blog comments
Deleting a comment
Responding to Contact page submissions
Publishing content
Reference
Templates
homepage
sectionpage1
sectionpage2
sectionpage3
sectionpage4
sectionpage5
articlepage1
articlepage2
publicationpage1
contactpage1
Breaking down the Web Quick Start site structure
Alfresco Quick Start folders
Sections
Subsections
Collections
Using Alfresco Web Editor
Customizing the interface
Editing web content
Creating web content
Deleting web content
Using the AVM
Setting up a Web Project
Creating a web form
Creating a web project
Working with Web Project Content
Viewing a web project and its contents
Viewing the web project details
Displaying the Sandbox view
Viewing the sandbox contents
Adding content to a web project
Creating web content
Uploading content from your computer
Importing content
Creating a folder
Maintaining web project content
Editing web content
Editing content not generated from a web form
Updating web content
Rolling back changes
Previewing web content
Previewing a folder or individual file
Previewing the web project
Submitting content items
Resolving conflicts
Comparing snapshots
Managing content awaiting launch
Comparing versions
Overriding the launch
Cancelling the launch
Publishing a Web Project
Deploying a snapshot
Viewing deployment reports
Deleting the deployment reports
Rolling back to a previous snapshot
Maintaining web forms
Editing a web form
Deleting a web form
Maintaining a web project
Editing the web project settings
Inviting users to a web project
Deleting a sandbox from a web project
Deleting a web project
WCM roles and tasks
Customizing and extending
Alfresco API Reference
Alfresco Repository JavaScript API
About script files
Scripting API
Root-scoped objects
ScriptNode API
childByNamePath
childrenByXPath
activeWorkflows
isScriptContent
hasAspect
specializeType
isSubType
Modifying and creating API
createFolder
createFile
createNode
addNode
removeNode
createAssociation
removeAssociation
remove
copy
move
addAspect
removeAspect
ScriptContent API
write
guessMimetype
guessEncoding
Permission and Security API
hasPermission
getPermissions
inheritsPermission
setInheritsPermissions
setPermission
removePermission
setOwner
getOwner
takeOwnership
Check In/Check Out API
checkout
checkin
cancelCheckout
Versions API
getVersion
createVersion
Transformation API
transformDocument
transformImage
processTemplate
Search API
luceneSearch
findNode
savedSearch
xpathSearch(xpath)
ISO9075Encode
ISO9075Decode
tagSearch
query
People API
createPerson
deletePerson
createGroup
deleteGroup
getMembers
addAuthority
removeAuthority
getContainerGroups
isAdmin
changePassword
setPassword
Actions API
registered
create
ScriptAction API
execute
Logging API
isLoggingEnabled
log
Session API
Classification API
getAllCategoryNodes
getAllClassificationAspects
getRootCategories
CategoryNode Object API
createSubCategory
removeCategory
AVM API
avm.lookupStore
avm.lookupStoreRoot
avm.lookupNode
AVM Store API
store.lookupNode
store.luceneSearch
AVM Node API
node.rename
WCM Web Projects
createWebProject
getWebProject
listWebProjects
WebProjects Object API
getRoles
save
deleteWebProject
addMembership
removeMembership
listMembers
createSandbox
Sandbox Object API
deleteSandbox
submitAll
submitAllWebApp
submitAssets
submit
revertAll
revert
revertAssets
revertAllWebApp
getModifiedAssets
getModifiedAssetsWebApp
getAssetWebApp
getAsset
WCM Asset Object API
rename
move
Utility methods
pad
getNodeFromString
shortQName
longQName
createQName
moduleInstalled
toISO8601(long)
toISO8601(Date)
fromISO8601
toBoolean
Services API
Site service
Site service object
createSite
listSites
listSiteRoles
listUserSites
getSite
Site object
save
deleteSite
listMembers
isMember
getMembersRole
inviteNominated (new user)
inviteNominated (existing user)
setMembership
removeMembership
getContainer
createContainer
hasContainer
setPermissions
resetAllPermissions
denyAllAccess
getCustomProperty
getCustomProperties
inviteModerated
getInvitation
listInvitations
allowAllMembersCollaborate
Activities service
postActivity
FeedControl object
setFeedControl
unsetFeedControl
getFeedControls
Tagging service
getTags
TagScope object
tags
getTopTags
getCount
refresh
TagDetails object
Extensions
clearTags
addTag
addTags
removeTag
removeTags
childrenByTag
tagSearch
Thumbnail services
createThumbnail
getThumbnail
getThumbnails
isThumbnailNameRegistered
getPlaceHolderResourcePath
getThumbnailDefinitions
updateThumbnail
Rendition services
createRenditionDefinition
render
getRenditions
getRenditionsByName
Rendition Definition
getRenditionName
getRenderingEngineName
Authority service
searchGroupsInZone
searchGroups
createRootGroup
getAllRootGroupsInZone
getAllRootGroups
getGroup
Group object
createGroup
removeGroup
removeUser
addAuthority
removeAuthority
User object
Workflow service
Workflow Manager
getDefinitionByName
getDefinition
getInstance
getPooledTasks
getTask
createPackage
JscriptWorkflowDefinition
startWorkflow
JscriptWorkflowInstance
cancel
delete
JscriptWorkflowNode
JscriptWorkflowPath
signal
JscriptWorkflowTask
endTask
JscriptWorkflowTransition
Alfresco RESTful API reference
Repository
Authentication
Login
Login (POST)
Logout
Validate Login Ticket
Server version metadata
Action
Cancel a Running Action
Get Running Action Details
List Running Actions
Start a new Action Executing
List Running Replication Actions
Start a new Replication Action Executing
Activities
Activity type template
Activity template paths
Feed
Activities site feed
Activities admin user feed
Activities user feed
Control
Unset activity user feed control
Set activity user feed control
Get activity user feed controls
Blogs
Blog
Get blog
Put blog
Post
Blog post publishing
Delete blog post
Get all blogs
Update blog post
Posts
Get blog posts (draft)
Get blog posts (published)
Get blog posts for a number of days
Get blog posts per month
Get all externally published posts
Get blog posts
Create blog post
Comments
Delete comment
Get comment
Update comment
Get all comments
Add comment
Dictionary
Get association definitions
Get association definitions for classname
Get class definitions for classname
Get class definitions
Get property definitions
Get property definitions for classname
Get subclasses definitions
Discussions
Forum
Get hot forum posts
Get my forum posts
Get new forum posts
Get forum posts
Add forum post
Posts
Get forum post replies
Add forum post reply
Delete topic
Get topic details
Update topic
Forms
Form Persistence
Form Definitions
PickerList
PickerItems
Groups
Remove an authority from a group
Get the list of child authorities for a group.
Add group or user to a group
Get the details of a group
Update the details of a group
Delete a group
List groups
Get the list of parent authorities for a group.
Delete a root group
List all root groups
Add a root group
Invitation
List invitations
Invite
Get invite by ticket
Process invite
Accept invite
Get invites
Links
Delete link
Get all links
post
Update link
Link
Get all links
Metadata
Node metadata bulk retrieval service
Node metadata retrieval service
Node metadata storage service
Person
Update user password
Get People
Add Person
Delete Person
Get Person
Update Person
Get sites
Preference
Delete preferences
Get preferences
Set preferences
Replication
Delete a persisted replication definition
Get replication definition
Update a persisted replication definition
List persisted replication definitions
Create a new persisted replication definition
Rule
Get action constraint
Get action constraint collection
Post action queue
Get action condition definition collection
Get action definition collection
Get inherited rules collection
Delete rule
Get rule
Create rule
Update rule
Get rules collection
Get rule set
Get rule type collection
Site
Delete site
Get Web site
Update Web site
Get sites
Create Web site
Query site collection
Invitation
Cancel invitation
Get invitation
Create invitation for web site
List invitations
Membership
Delete Web Project Membership
Get Membership
Update Web site membership
List Memberships
Add user to web project
List potential Web site members
Roles
Get roles
Tagging
Get node tags
Add tag
Create new tag
List all tags
Get nodes for tag
Get tagscope tags
Thumbnail
Delete thumbnail
Get thumbnail
Update thumbnail
Get thumbnail definitions
Get thumbnails
Create thumbnail
Transfer
Alfresco transfer service
Upload
File upload
Version
Revert Version Info
Node Version Info
Wcm
Delete Web Project
Get Web Project
Create Web Project
Update Web Project
Web Projects
Membership
Delete Web Project Membership
Get Membership
List Memberships
Add user to web project
Sandbox
Delete Sandbox
Get Web Project Sandbox
Create user sandbox
Web Project Sandboxes
Asset
Delete the specified asset.
Get the details of the specified asset within the specified web project and sandbox.
Create a new WCM asset.
Update a WCM asset.
Get the content of the specified asset within the specified web project and sandbox.
Get modified assets within the specified sandbox.
Update a WCM asset
Revert modified assets within the specified author sandbox.
Submit modified assets from within the specified author sandbox.
Workflow
End Workflow Task
Gets Workflow Task Instance
Updates Workflow Task Instance
List Workflow Tasks
List Deployed Workflow Definitions
Delete Workflow Instance
Get Workflow Instance
Get Workflow Instance Collection for NodeRef
Get Workflow Instance Collection
Extensions
Webscripts
Javascript Debugger
Javascript Debugger Maintenance
Alfresco Repository FreeMarker Template reference
Template framework architecture
Template files
Template models
Default model
TemplateNode Model API
Advanced TemplateNode API
Version History API
Classification API
XML Content Processing API
Workflow API
WorkflowTaskItem API
People API
Default Model Methods
Current Date
JSP Page
Alfresco Surf Platform API reference
Surf platform
Root-scoped objects
context
user
content
page
template
config
theme
instance
sitedata
remote
locale
htmlid
url
head
app
msg
Return types
Model objects
connectors
response
response status
Rendering objects
templates
components
Customizing Alfresco Explorer
Customizing Alfresco Explorer configuration items
Alfresco Explorer configuration settings
Customizing and extending Alfresco Share
Customizing Alfresco Share configuration items
Share repository document library
Hiding the Share repository document library
Configuring the Share default port
Configuring the RSS Feed Dashlet with HTTP authentication
Enabling Google Docs integration
Share themes
Selecting themes
Creating a new theme
Editing a theme
Forms
Use of forms in Share
Forms architecture
Forms event sequence
Configuring forms
Customizing forms controls
Customizing the validation handler
Displaying Type metadata
Displaying aspect metadata
Configuring a form control
Grouping fields
Changing the default set label
Providing a custom form control
Changing the field label position
Providing a custom form template
Building a custom Knowledge Base application
Getting started
Defining a content model for metadata
Defining a Knowledge Base space
Defining Knowledge Base articles
Applying property constraints
Configuring Alfresco Explorer extensions
Property sheets
Wizards and icons
Smart spaces and scripting
Space templates
Stopping the Alfresco server
Adding the Knowledge Base content model
Adding Alfresco Explorer configuration
Adding the Knowledge Base Search web script
Starting the Alfresco server
Signing on to Alfresco Explorer
Adding a script to the Data Dictionary
Creating a Knowledge Base space template
Adding an archived space
Setting up content rules
Creating a Knowledge Base
Creating and contributing an article
Editing a Knowledge Base article
Viewing content in JSON
Customizing Alfresco Share (basic)
Building custom dashlets
Configuring a dashlet as an option on the site dashboard
Configuring custom site pages
Adding Knowledge Base site components
Designing for browser dependencies
Configuring for Internationalization
Configuring Alfresco Share
Defining custom site presets
Overriding the default message bundle
Stopping the Alfresco server
Adding the custom dashlet code
Adding the custom site page code
Adding the common library code
Configuring a custom site preset
Adding a custom message bundle
Overriding the message bundle bootstrap component
Adding files to the Tomcat ROOT web application
Starting the Alfresco server
Creating a new Alfresco Share site
Adding a custom dashlet to your site
Adding a custom page to a Share site
Creating a Knowledge Base site
Customizing Alfresco Share (advanced)
Setting aspects
Defining actions in the document library
Configuring workflows
Configuring forms in Alfresco Share
Creating articles using JavaScript
Stopping the Alfresco server
Customizing Document Library services
Adding a custom workflow to the Alfresco repository
Adding an archive action handler
Setting up the kb:article aspect
Adding Alfresco Share customizations
Adding an archive action to the document library
Enabling a custom workflow
Configuring the Alfresco Share form
Adding the Alfresco Share form template
Adding a custom message bundle
Overriding the message bundle bootstrap component
Adding files to the Tomcat ROOT web application
Starting the Alfresco server
Setting up a Knowledge Base
Adding and editing content
Approving content
Archiving content in the Knowledge Base
Developing against the Alfresco repository
Alfresco repository extension points
Content models
Content behavior
Process definitions
Workflow models
Actions
Customizing content transformations
Content modeling
Content metadata model
Deploying a content model
Deploying a content model - bootstrap approach
Deploying a content model - dynamic approach
Content metamodel
Metadata XML schema
Model Header
Model namespaces
Model types
Properties
Associations
Constraints
Inheritance
Aspects
Out-of-the-box models
Defining a custom model for Knowledge Base articles
Creating content with JavaScript
Localizing models
Alfresco content models and CMIS
Building applications with Content Management Interoperability Services (CMIS)
Using CMIS with Alfresco
CMIS requirements
CMIS repository
CMIS query
CMIS services
CMIS object model
Configuring and extending Alfresco services
Using Embedded APIs
Using the Java API to create new content
Using the JavaScript API to create new content
Using the Template API to display properties
Using Remote APIs
Using the RESTful API to retrieve document tags
Configuring and extending existing services
Extending RuntimeExecutableContentTransformer
Building Alfresco services
Building a simple service
Alfresco content services
Content repository services
File Folders service
Versioning service
Check Out / Check In service
Audit service
Authority service
Permission service
Person service
Dictionary service
Search service
Content application services
Content services
Rules and actions
Transformation service
Metadata extraction
Thumbnailing service
Control services
Workflow service
Web Projects service
Sandbox service
Assets
Collaboration services
Sites service
Invite service
Activity service
Tagging service
Commenting service
Working with the Surf framework
Surf content
Content delivery services
Content applications
Spring framework plug-in
Model-View-Controller
Spring Web MVC
Rendering a Surf page
Using an annotated controller
Surf View Composition framework
Pages
Templates and regions
Components
Presentation content
Surf objects
Templates and Surf
Web scripts and Surf
Connectors and credentials
Connectors and endpoints
Credentials
Authenticators
Remote API
Creating a reusable Java-backed web script
Modifying a web script using the Surf Remote API
Working with Alfresco web scripts
Web script types
Data web scripts
Presentation web scripts
Web Script Framework
Web script components
Web script description document
Web script controller script
Web script response template
Naming conventions
File locations
URI anatomy
URI template
Format readers
Response status code templates
Response status codes
Developing a Hello World web script
Locating the Hello World example
How Hello World works
Listing pre-built web scripts
Invoking web scripts
Invoking a web script using cURL
Creating a Hello User web script with authentication
Returning a JSON response format
Selecting a response format
How Hello User works
Developing a Folder Listing web script
Creating a description document
Creating a controller script
Parsing the web script URI
Calling Alfresco services
Constructing the model
Creating a response template
Accessing the model
Accessing Alfresco services
Registering and testing web scripts
Creating multiple response templates
Adding a response status code template
Working with client limitations
Tunneling HTTP methods
Forcing success response status
JSON callbacks
Using the JSON callback
Understanding how the JSON callback works
Caching
Runtime cache controls
Descriptor cache controls
Creating a web script using cache controls
Authenticating web scripts
Specifying user identity
Custom client authentication
Configuring web scripts
Creating a Knowledge Base Search web script
Testing Knowledge Base Search
How Knowledge Base Search works
Processing complex HTTP requests
Debugging a controller script
Forms and web scripts
Processing multipart forms
Testing the upload web script
Creating request processing web scripts
Extending the request processing web script
Internationalization (I18N)
Creating resource bundles supporting I18N
Adding resource bundles for additional languages
Overriding the default message bundle
Java-backed web scripts
Java approach to web scripts
Creating a Folder Listing Java-backed web script
Creating the scripted components of a Folder Listing web script
Developing a controller for a Folder Listing Java-backed web script
Parsing the URI
Calling Alfresco services
Setting the response status code
Constructing the model
Registering a Java-backed web script
Declaring service dependencies
Creating a new kind of web script
Using a new kind of web script
Creating a reusable Java-backed web script
Modifying a web script using the Surf Remote API
Web script reference
Form Data API
formdata
formfield
JSON Object API
JSONObject
JSONArray
FreeMarker methods
Root objects
url
status
cache
format
webscript
server
Advanced descriptor options
Lifecycle
Family
Run As
Integrating with other applications
Content management integration patterns
Content Service Mappers
Property View
Article
Query view
Browser view
Librarian
Catalog view
Attachment
Annotation
Archive
Project Space
Review and Approval workflow
Feed
Portlet view
Environment considerations
Troubleshooting
Debugging an Alfresco installation
Debugging an upgrade
Setting log levels
Testing and debugging links
Error messages
Troubleshooting an upgrade
Troubleshooting clustering
Troubleshooting OpenOffice subsystems
Troubleshooting the JMX Dumper
Troubleshooting NFS
Troubleshooting CIFS
OpenLDAP tips
Active Directory tips
Troubleshooting SMTP inbound email using StartTLS
Handling a higher rate of outbound TCP connections
Troubleshooting IMAP
Reference
Properties available in a JMX client
JMX bean categories reference
JMX read-only monitoring beans
JMX configuration beans
JMX editable management beans
Search syntax
Search for a single term
Search for a phrase
Search for an exact term
Search for term expansion
Search for conjunctions
Search for disjunctions
Search for negation
Search for optional, mandatory, and excluded elements of a query
Search for fields
Search for wildcards
Search for ranges
Search for fuzzy matching
Search for proximity
Search for boosts
Search for grouping
Search for spans and positions
Escaping characters
Mixed FTS ID behavior
Search for order precedence
Forms reference
Frequently occurring tasks
Opening a Windows command prompt
Adding folder paths to the Windows path variable
Changing the default shell (Unix/Linux/Solaris) for shell scripts
Setting file limits for Linux
Administrator best practices
Tips for getting the most out of Alfresco
Common mistakes made by Alfresco administrators
Eight shortcuts every Alfresco administrator should know
Glossary
Copyright