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
How To videos
How to customize your personal dashboard
How to edit your personal profile
How to join a collaboration site
How to create a collaboration site
How to add content to a site library
Getting Started tutorials
Getting Started with Alfresco
Logging in
Personalizing Alfresco
Customizing your dashboard
Updating your profile
Building a site
Creating your first collaboration site
Customizing the site dashboard
Adding pages to a site
Working with content
Adding content items
Updating content
Creating site content
Making content visible
Being social
Scheduling events
Inviting members to your site
Engaging with content
Engaging with users
Sharing content externally
Linking your site to the cloud
Sharing your content on the cloud
Removing your content from the cloud
Do great work
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
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
Installing
Installing Alfresco Community
Alfresco Community installation files
Installing Alfresco Community using the setup wizards
Installing Alfresco Community on Linux
Installing Linux libraries manually
Installing Alfresco Community on Linux (text mode)
Installing Alfresco Community on Windows
Installing Alfresco Community on Mac
Installing software required for Alfresco
Installing and Configuring ImageMagick
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 Records Management
Applying the Records Management AMP files
Adding the Records Management dashlet
Creating the Records Management site
Installing and configuring Alfresco WCM
Web Quick Start
About Web Quick Start
Installing Alfresco and Web Quick Start
Manually installing Web Quick Start
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
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 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 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
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
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
Managing Alfresco using the Admin Console
Opening the Admin Console
Admin Console tools in the More menu
Specifying application preferences
Changing the look and feel theme
Changing the logo
Managing categories
Using the Node Browser
Managing tags
Emptying deleted files from the Trashcan
Managing social content publishing
Create a new channel
Creating a Facebook channel
Creating a Flickr channel
Creating a LinkedIn channel
Creating a SlideShare channel
Creating a Twitter channel
Creating a YouTube channel
Changing a channel permission
Authorizing a channel
Deleting a channel
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
Managing users
Creating a new user
Uploading multiple users
Searching for and viewing 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
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
Configuring databases
Configuring a PostgreSQL database
Configuring the MySQL database
Optimizing MySQL to work with Alfresco
Configuring Alfresco subsystems
Subsystem categories
Subsystem configuration files
Subsystem properties
Mounting a subsystem
Mounting a subsystem with composite properties
Extension classpath
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 CIFS on Windows Server 2008 R2
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
Controlling Indexes
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
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
Kerberos client configuration
Debugging Kerberos
Configuring Share Kerberos SSO
Configuring external authentication
External configuration properties
Configuring Alfresco Share to use an external SSO
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
Public services
Public services configuration
Method-level security definition
Implementation and services
Person service
Authority service
Permission service
Ownable service
Configuring Search (Solr)
Solr Overview
Advantages of Solr search over Lucene search
When not to use Solr
Configuring Solr
Installing and Configuring Solr
Generating Secure Keys for Solr Communication
Solr Directory Structure
Solr Configuration Files
Solrcore Configuration Properties
Solr Subsystem
Activating Solr
Eventual Consistency
Solr troubleshooting for SSL configurations
Solr Security
Repository SSL key stores
Solr SSL key stores
Connecting to the SSL-protected Solr web application
Generating Repository SSL Keystores
Generating a Certificate Authority (CA) Key and Certificate
Solr Monitoring and Troubleshooting
Unindexed Solr Transactions
Troubleshooting Solr Index
Solr Backup and Restore
Backing up Solr
Restoring Solr Indexes
Full text search configuration properties
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
Using the Bulk Import tool
Preparing the filesystem
Importing via the user interface
Bulk Import diagnostics
Creating and managing workflows
What is a workflow?
Workflow Architecture
Workflow instances
Workflow artifacts
Workflow tools
The Activiti workflow console
Process definitions
Events
Sequence flows
Tasks
Gateways
Parallel gateways
Exclusive gateways
Variables
Node objects
Listeners
Task listeners
Execution listeners
Task model
Specifying the task type
Setting up Activiti Designer
Installing Eclipse
Installing Activiti designer
Deploying the task model
Deploying a process definition
Configuring templated nodes
Setting files as templates
Migrating
Migrating servers
Backing up Alfresco Server 1
Restoring to Server 2
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
Configuring the File System Transfer Receiver
Setting up the File System Transfer Receiver
Start File System Transfer Receiver
File System Transfer Receiver launcher properties
File System Transfer Receiver custom properties
File System Transfer Receiver log file properties
Auditing Alfresco
Audit configuration and environment
Audit filters
Example rootPath and auditMap
Example filter
Redirected properties
Debug information
Audit filter customizations
Content auditing
Content auditing technical overview
Example audit trail
Using Alfresco Explorer to view the example audit trail
Enabling auditing of content
Default audit filter settings
Audit data generated by AccessAuditor
Persisted audit data
Content auditing customizations
Custom audit filter
Custom audit configuration
Sample files
Enabling 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
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
Administering Records Management
Management Console
Accessing the Records Management Console
Records Management Auditing
Accessing the Audit tool
Starting and stopping the audit log
Filtering the log entries
Filing the audit log as a record
Exporting the audit log
Viewing the full log
Clearing the audit log
Auditing actions
Creating custom metadata
Accessing the Custom Metadata tool
Creating custom metadata
Editing custom metadata
Defining roles and capabilities
Roles
Capabilities
Accessing the Define Roles tool
Viewing the capabilities for a role
Adding new roles
Editing a role
Deleting a role
Mapping emails
Accessing the Email Mappings tool
Default email mappings
Adding an email map
Deleting an email map
Managing events
Accessing the Events tool
Creating a new event
Editing an event
Deleting an event
Creating a list of values
Accessing the List of Values tool
Creating a list of values
Editing a list of values
Renaming a list of values
Managing relationships
Accessing the Relationships tool
Creating a new relationship
Deleting a relationship
Viewing the User Rights report
Using Alfresco
Using Alfresco Community
Finding your way around
Getting to know your toolbar
Your personal dashboard
Customizing your home page
Alfresco sites: Where collaboration begins
Creating a site
Finding a site
Joining a site
Deleting a site
Reviewing a user's profile
Searching for people
Repository
Managing permissions in the Repository library
More menu
Working with your task list
Viewing tasks and workflows
Editing a task
Managing your workflows
Viewing a workflow
Cancelling an active workflow
Deleting a completed workflow
User menu
Telling people what you're up to
Viewing your user profile
Viewing your full profile
Updating your personal and professional information
Following people
Changing your password
Controlling your email notifications
Searching for content
Performing a basic search
Performing an advanced search
Search examples
What can I do with my dashlets?
My Sites dashlet
My Tasks dashlet
My Profile dashlet
My Activities dashlet
My Documents dashlet
Configuring the RSS Feed dashlets
My Discussions dashlet
Site Search dashlet
Saved Search dashlet
Configuring the Saved Search dashlet
My Meeting Workspaces and My Document Workspaces dashlets
Web View dashlet
Configuring the Web View dashlet
Subscribing to an RSS feed
Entering a site
Understanding the site dashboard
Making the site easy to access
Customizing a site
Customizing the site dashboard
Editing the site details
Using the site dashlets
Site Members dashlet
Site Content dashlet
Site Activities dashlet
Wiki dashlet
Configuring the Wiki dashlet
Site Notice dashlet
Configuring the Site Notice dashlet
Image Preview dashlet
Site Data Lists dashlet
Site Links dashlet
Tagging site content
Selecting a component
Working with content in a library
Entering a site library
Exploring the library
About the Gallery view
Creating an organizational structure
Adding content to the library
Adding items to the library
Creating content
Creating Google Docs content in the library
Working with folders
Viewing folder details
Automating repetitive tasks
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
Manually 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
Editing content in Google Docs
Saving content to your computer
Share library content publicly
Cancel a shared link
Updating an item with content from your computer
Drag and drop content
Starting a workflow
Publishing content
Allowable content types
Removing published content
Managing aspects
Changing the content type
Renaming library content
Tagging library content
Specifying favorites
Giving positive feedback
Editing basic content details
Editing the content properties
Managing your comments
Leaving 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
Browsing the calendar
Viewing an event
Adding an event
Editing the event details
Changing the event date and time
Deleting an event
The wiki
Accessing the wiki
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 discussions forum
Accessing the discussion forum
Browsing the discussion topics
Viewing a topic
Creating a new topic
Editing a topic
Deleting a topic
Creating a reply
Editing a reply
The blog
Accessing the blog
Browsing the blog posts
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
Managing externally published blog posts
Updating an external blog post
Removing an external blog post
Working with comments
Adding a comment to a post
Editing a comment
Deleting a comment
Site links
Accessing the site links
Browsing the site 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
Data lists
Accessing the Data Lists 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 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
Managing pending invitations
Reference
Search Reference
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
Search query syntax APIs
Search query templates
Search query literals
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
Using Records Management
Records Management site dashboard
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 category
Adding a record folder
Adding items to the File Plan
Filing an electronic record
Filing a non-electronic record
Adding record metadata
Editing record metadata
Declaring a record
Managing the File Plan
Managing record categories
Viewing record category details
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
Exporting and importing records
Exporting content
Importing content
Disposition schedules
Defining the disposition schedule
Disposition schedule rules
Searching records
Accessing Records Search
Criteria tab
Results tab
Creating a search
Using a saved search
Records Management 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
Search fields
Search special record types
Printing the search results
Exporting the search results
Saving a search
Deleting a saved search
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
Specifying the notification recipient
Creating multi-lingual websites
Preparing a section for translation
Translating an asset within a translated section
Translating an asset that is not in a translated section
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 Alfresco outside of the Alfresco interface
Add a file to Alfresco from outside the Alfresco interface
Check out files from outside Alfresco
View item details from a mapped drive
Open Alfresco in a browser window
Open Alfresco Share in a browser window
Customizing
Customizing and extending Alfresco Share
Customizing Alfresco Share configuration items
Share repository document library
Configuring the Share repository document library
Hiding the Share repository document library
Configuring the Share default port
Configuring the RSS Feed Dashlet with HTTP authentication
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
NodeLocator service
Creating node locators
NodeLocator Service Java API
NodeLocator Service REST API
NodeLocator service startLocation
Available Node Locators
Share Extensibility
Customizing Share targeting existing files
Customizing Share through Advanced Component configuration
Creating an Extension module
Example - creating an Extension module
SurfBug
Tutorials
1. Add content to an Alfresco Share page
2. Control rendering of content on an Alfresco Share page
3. Sub-Component Evaluations
4. Customize Alfresco Share i18n properties
5. Customize Alfresco Share JavaScript controllers
6. Customize Alfresco Share FreeMarker templates
About FreeMarker extensibility directives
7. Auto-Readme extensions example
8. Add a new page to Alfresco Share
9. Override Alfresco Share login page
Extending the Alfresco Share Document Library
Alfresco Share Document Library repository tier
Alfresco Share Document Library web tier
Override and extension examples
Client-side template and action extensions
Reference
jsNode reference
Predefined Evaluators
EXIF renderer source code
Customizing Alfresco Explorer
Customizing Alfresco Explorer configuration items
Alfresco Explorer configuration settings
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
Programming
Integrating your application with Alfresco
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
Designing your application
Programming with CMIS
Using CMIS with Alfresco
CMIS requirements
CMIS repository
CMIS query
CMIS services
CMIS object model
The Alfresco OpenCMIS Extension
Using the Alfresco OpenCMIS Extension
Building the Alfresco OpenCMIS Extension with maven
Creating a document or folder with aspects
Adding, removing and discovering aspects
Programming with the repository
Alfresco repository extension points
Content models
Content behavior
Process definitions
Workflow models
Actions
Customizing content transformations
Programming with 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
Programming with Surf
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
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
Invoking web scripts
Working with client limitations
Tunneling HTTP methods
Forcing success response status
JSON callbacks
Caching
Runtime cache controls
Descriptor cache controls
Authenticating web scripts
Custom client authentication
Forms and web scripts
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
Tutorials
Listing pre-built web scripts
Invoking a web script using cURL
Developing a Hello World web script
Locating the Hello World example
How Hello World works
Debugging a controller script
Creating a Hello User web script with authentication
Returning a JSON response format
Selecting a response format
How Hello User works
Specifying user identity
Using the JSON callback
Understanding how the JSON callback works
Processing complex HTTP requests
Configuring a web script
Creating a web script using cache controls
Processing multipart forms
Testing the upload web script
Creating request processing web scripts
Extending the request processing web script
Creating a photo search script
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
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
Testing the new kind of web script
Web script reference
Web script description language reference
webscript
shortname
description
url
format
authentication
transaction
family
cache
negotiate
lifecycle
formdata
args
responses
requests
Root objects available in all web scripts
Root objects available in repository tier web scripts
Root objects available in all templates
Root objects available in repository tier templates
Root objects reference
atom
cache
config
crossRepoCopy
format
formdata
json
jsonUtils
requestbody
server
status
url
webscript
FreeMarker template methods
API References
Alfresco API Reference
Repository JavaScript API
About script files
Scripting API
Root objects
ScriptNode Object API
childByNamePath
childrenByXPath
childFileFolders
getActiveWorkflows
isScriptContent
hasAspect
isSubType
Security API
hasPermission
getPermissions
inheritsPermissions
setInheritsPermissions
setPermission
removePermission
Ownership API
setOwner
getOwner
takeOwnership
Modifying and creating API
createFolder
createFile
createNode
addNode
removeNode
createAssociation
removeAssociation
remove
copy
move
addAspect
removeAspect
specializeType
revert
save
Check In/Check Out API
checkout
checkin
cancelCheckout
checkoutForUpload
Versions API
Script Version Object
getVersion
createVersion
ensureVersioningEnabled
getVersionHistory
Content API
ScriptContentData API
write
guessMimetype
guessEncoding
getInputStream
getReader
Transformation API
transformDocument
transformImage
processTemplate
Thumbnail API
createThumbnail
getThumbnail
getThumbnails
getThumbnailDefinitions
ScriptThumbnail Object
update
Tagging API
clearTags
addTag
addTags
removeTag
removeTags
getTagScope
childrenByTags
Search API
luceneSearch
findNode
savedSearch
xpathSearch(xpath)
ISO9075Encode
ISO9075Decode
tagSearch
query
isValidXpathQuery
selectNodes
People API
createPerson
deletePerson
createGroup
deleteGroup
getMembers
addAuthority
removeAuthority
getContainerGroups
isAdmin
isGuest
changePassword
setPassword
enableAccount
disableAccount
isAccountEnabled
setQuota
getPeople
getPerson
getGroup
getCapabilities
getImmutableProperties
Actions API
create
ScriptAction API
execute()
executeAsynchronously()
Logging API
log
warn
info
error
Session API
Classification API
getAllCategoryNodes
getAllClassificationAspects
getRootCategories
getCategory
getCategoryUsage
createRootCategory
CategoryNode Object API
createSubCategory
removeCategory
rename
AVM API
lookupStore
lookupStoreRoot
lookupNode
getModifiedItems
stagingStore
userSandboxStore
websiteStagingUrl
websiteUserSandboxUrl
assetUrl
AVM Store API
lookupNode
luceneSearch
AVM Node API
rename
copy
move
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
moduleInstalled
toISO8601(long)
toISO8601(Date)
fromISO8601
toBoolean
createPaging
getLocale
setLocale
disableRules
enableRules
Services API
Site service
Site service object
createSite
listSites
listSiteRoles
listUserSites
getSite
getSites
findSites
hasCreateSitePermissions
isSiteManager
cleanSitePermissions
Site object
save
deleteSite
listMembers
isMember
getMembersRole
inviteNominated (new user)
inviteNominated (existing user)
setMembership
removeMembership
getContainer
createContainer
hasContainer
setPermissions
resetAllPermissions
getCustomProperty
getCustomProperties
inviteModerated
getInvitation
listInvitations
createAndSaveContainer
Activities service
postActivity
setFeedControl
unsetFeedControl
getFeedControls
Tagging service
getTags
getTag
createTag
deleteTag
TagScope object
getTopTags
getCount
refresh
Thumbnail service
isThumbnailNameRegistered
getPlaceHolderResourcePath
getMimeAwarePlaceHolderResourcePath
Rendition service
createRenditionDefinition
render
getRenditions
getRenditionsByName
Rendition Definition
getRenditionName
getRenderingEngineName
Authority service
createRootGroup
getGroup
getGroupForFullAuthorityName
getGroups
getGroupsInZone
searchGroups
searchGroupsInZone
searchRootGroups
searchRootGroupsInZone
getAllRootGroups
getAllRootGroupsInZone
getUser
searchUsers
ScriptGroup object
createGroup
deleteGroup
removeGroup
removeUser
addAuthority
removeAuthority
getChildUsers
getChildGroups
getChildAuthorities
getParentGroups
getAllParentGroups
ScriptUser object
Workflow service
Workflow Manager
getDefinitionByName
getDefinition
getInstance
getPooledTasks
getTask
getTaskById
createPackage
JscriptWorkflowDefinition
startWorkflow
JscriptWorkflowInstance
cancel
delete
JscriptWorkflowNode
JscriptWorkflowPath
signal
JscriptWorkflowTask
endTask
JscriptWorkflowTransition
RESTful API reference
Module
Wcmquickstart
Get Asset
Get Asset
Get Asset Collection
Search Assets
Fix Web Assets 1
Fix Web Assets 2
Load web site date.
Get Section(s)
Get Section(s)
Translations for Web Asset
Update web site renditions
Preview Webasset
Get secondary information about a given website
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
Admin
JMXDump
Alfresco Repo Restrictions
Alfresco Repo Usage
Alfresco Repo Usage Update
Archive
PUT a restore request to an archived NodeRef
DELETE permanently (purge) a node or nodes from the archive.
GET archived (deleted) items
Audit
Alfresco Audit Service Clear
Alfresco Audit Service Control
Alfresco Audit Service Control
Alfresco Audit Service Query
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
Category
Category Management
Category Management
Category Management
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 remote dictionary 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
Googledocs
Get GoogleDocs Integration Status Information
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
Delete link
Get all links
Metadata
Node metadata bulk retrieval service
Node metadata retrieval service
Node metadata storage service
Nodelocator
Node Locator
Person
Update user password
Get People
Add Person
Delete Person
Get Person
Update Person
Get sites
Information on Creating Users via CSV
Create Users via uploading of a CSV
Preference
Delete preferences
Get preferences
Set preferences
Publishing
Authorisation Callback
Channel Authorisation Form
Channel Authorisation Form
Reauthorise the specified publishing channel
Get channel type icon
Get Publishing Channels
Update Channel
Delete specified publishing channel
Get Publishing Channels
Create a publishing channel
Get Publishing Events For Node
Post Content to Publishing Queue
Rating
DELETE rating
POST a rating to a NodeRef
GET rating scheme definitions
GET rating
Replication
Delete a persisted replication definition
Get replication definition
Update a persisted replication definition
List persisted replication definitions
Create a new persisted replication definition
Gets status information on the Replication Service
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
Export Web 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
Solr
Get ACL ChangeSets
Get ACLs
Get ACLs readers
Get Model
Get Model Diffs
Get node property content as text
Get the nodes in the given transactions
Get the metadata for the specified nodes
Get transactions
Subscriptions
Follow
Followers
Followers Count
Following
Following Count
Follows
Private Following List
Private Following List
Unfollow
Tagging
Get node tags
Add tag
Delete existing tag
Create new tag
edit tag
List all tags
Get nodes for tag
Get tagscope tags
Thumbnail
Delete thumbnail
Thumbnails
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
Get Workflow Definition
List Deployed Workflow Definitions
Get Workflow Instance Diagram
Delete or Cancel Workflow Instance
Get Workflow Instance
Get Workflow Instance Collection for NodeRef
Get Workflow Instance Collection
Vti
Vti Server Details
Vti WebScript placeholder
Extensions
Webscripts
Javascript Debugger
Javascript Debugger Maintenance
Repository FreeMarker Template reference
Template framework architecture
Template files
Template models
Default model
TemplateNode API
getChildByAssocsByType
VersionHistoryNode API
hasAspect
Classification API
getAllCategoryNodes
getRootCategories
CategoryTemplateNode
Workflow API
getTaskById
WorkflowTaskItem API
People API
getCapabilities
getContainerGroups
getGroup
getMembers
getPerson
isAccountEnabled
isAdmin
isGuest
Default Model Methods
cropContent
dateCompare
hasAspect
hasPermission
incrementDate
message
shortQName
xmldate
Current Date
JSP Page
Surf Platform API reference
Surf platform
Root-scoped objects
context
user
save
getUser
content
page
template
config
theme
instance
sitedata
getObjectTypeName
getObjectTypeDescription
getObjects
getObjectsMap
newObject
newChrome
newComponent
newComponentType
newConfiguration
newContentAssociation
newPage
newPageAssociation
newPageType
newTemplate
newTemplateType
newTheme
newPreset
findComponents
findWebScripts
findChildPageAssociations
findPageAssociations
findChildPages
findParentPages
findContentAssociations
findComponentsMap
findPageAssociationsMap
findContentAssociationsMap
findTemplatesMap
findConfiguration
findTemplate
removeTemplate
bindComponent
unbindComponent
associateTemplate
unassociateTemplate
associatePage
unassociatePage
associateContent
unassociateContent
associateContentType
unassociateContentType
Helper methods
encode
decode
logout
reloadUser
getCredentialVault
getChrome
getComponent
getComponentType
getConfiguration
getContentAssociation
getPage
getPageType
getPageAssociation
getTemplate
getTemplateType
getTheme
newGUID
getFormatIds
getFormatTitle
getFormatDescription
remote
setConfigService
setConnectorProvider
connect
call
getEndpointName
getEndpointDescription
getEndpointUrl
isEndpointPersistent
locale
htmlid
url
head
app
getContext
include
msg
Return types
ScriptModelObject
save
remove
delete
toXML
touch
getBooleanProperty
getProperty
setProperty
removeProperty
getModelObject
clone
ScriptRemoteConnector
call
get
post
put
del
Response
ResponseStatus
setCode
setHeader
getHeaders
Rendering objects
templates
components
Troubleshooting
Debugging an Alfresco installation
Debugging an upgrade
Setting log levels
Error messages
Troubleshooting an upgrade
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
Troubleshooting schema-related problems
Performing schema dumps
Automatic dumps
Performing schema validation
Differencing
Validation
Reference
Search Reference
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
Search query syntax APIs
Search query templates
Search query literals
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
How To videos
How to customize your personal dashboard
How to edit your personal profile
How to join a collaboration site
How to create a collaboration site
How to add content to a site library
Getting Started tutorials
Getting Started with Alfresco
Logging in
Personalizing Alfresco
Customizing your dashboard
Updating your profile
Building a site
Creating your first collaboration site
Customizing the site dashboard
Adding pages to a site
Working with content
Adding content items
Updating content
Creating site content
Making content visible
Being social
Scheduling events
Inviting members to your site
Engaging with content
Engaging with users
Sharing content externally
Linking your site to the cloud
Sharing your content on the cloud
Removing your content from the cloud
Do great work
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
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
Installing
Installing Alfresco Community
Alfresco Community installation files
Installing Alfresco Community using the setup wizards
Installing Alfresco Community on Linux
Installing Linux libraries manually
Installing Alfresco Community on Linux (text mode)
Installing Alfresco Community on Windows
Installing Alfresco Community on Mac
Installing software required for Alfresco
Installing and Configuring ImageMagick
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 Records Management
Applying the Records Management AMP files
Adding the Records Management dashlet
Creating the Records Management site
Installing and configuring Alfresco WCM
Web Quick Start
About Web Quick Start
Installing Alfresco and Web Quick Start
Manually installing Web Quick Start
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
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 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 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
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
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
Managing Alfresco using the Admin Console
Opening the Admin Console
Admin Console tools in the More menu
Specifying application preferences
Changing the look and feel theme
Changing the logo
Managing categories
Using the Node Browser
Managing tags
Emptying deleted files from the Trashcan
Managing social content publishing
Create a new channel
Creating a Facebook channel
Creating a Flickr channel
Creating a LinkedIn channel
Creating a SlideShare channel
Creating a Twitter channel
Creating a YouTube channel
Changing a channel permission
Authorizing a channel
Deleting a channel
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
Managing users
Creating a new user
Uploading multiple users
Searching for and viewing 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
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
Configuring databases
Configuring a PostgreSQL database
Configuring the MySQL database
Optimizing MySQL to work with Alfresco
Configuring Alfresco subsystems
Subsystem categories
Subsystem configuration files
Subsystem properties
Mounting a subsystem
Mounting a subsystem with composite properties
Extension classpath
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 CIFS on Windows Server 2008 R2
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
Controlling Indexes
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
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
Kerberos client configuration
Debugging Kerberos
Configuring Share Kerberos SSO
Configuring external authentication
External configuration properties
Configuring Alfresco Share to use an external SSO
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
Public services
Public services configuration
Method-level security definition
Implementation and services
Person service
Authority service
Permission service
Ownable service
Configuring Search (Solr)
Solr Overview
Advantages of Solr search over Lucene search
When not to use Solr
Configuring Solr
Installing and Configuring Solr
Generating Secure Keys for Solr Communication
Solr Directory Structure
Solr Configuration Files
Solrcore Configuration Properties
Solr Subsystem
Activating Solr
Eventual Consistency
Solr troubleshooting for SSL configurations
Solr Security
Repository SSL key stores
Solr SSL key stores
Connecting to the SSL-protected Solr web application
Generating Repository SSL Keystores
Generating a Certificate Authority (CA) Key and Certificate
Solr Monitoring and Troubleshooting
Unindexed Solr Transactions
Troubleshooting Solr Index
Solr Backup and Restore
Backing up Solr
Restoring Solr Indexes
Full text search configuration properties
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
Using the Bulk Import tool
Preparing the filesystem
Importing via the user interface
Bulk Import diagnostics
Creating and managing workflows
What is a workflow?
Workflow Architecture
Workflow instances
Workflow artifacts
Workflow tools
The Activiti workflow console
Process definitions
Events
Sequence flows
Tasks
Gateways
Parallel gateways
Exclusive gateways
Variables
Node objects
Listeners
Task listeners
Execution listeners
Task model
Specifying the task type
Setting up Activiti Designer
Installing Eclipse
Installing Activiti designer
Deploying the task model
Deploying a process definition
Configuring templated nodes
Setting files as templates
Migrating
Migrating servers
Backing up Alfresco Server 1
Restoring to Server 2
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
Configuring the File System Transfer Receiver
Setting up the File System Transfer Receiver
Start File System Transfer Receiver
File System Transfer Receiver launcher properties
File System Transfer Receiver custom properties
File System Transfer Receiver log file properties
Auditing Alfresco
Audit configuration and environment
Audit filters
Example rootPath and auditMap
Example filter
Redirected properties
Debug information
Audit filter customizations
Content auditing
Content auditing technical overview
Example audit trail
Using Alfresco Explorer to view the example audit trail
Enabling auditing of content
Default audit filter settings
Audit data generated by AccessAuditor
Persisted audit data
Content auditing customizations
Custom audit filter
Custom audit configuration
Sample files
Enabling 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
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
Administering Records Management
Management Console
Accessing the Records Management Console
Records Management Auditing
Accessing the Audit tool
Starting and stopping the audit log
Filtering the log entries
Filing the audit log as a record
Exporting the audit log
Viewing the full log
Clearing the audit log
Auditing actions
Creating custom metadata
Accessing the Custom Metadata tool
Creating custom metadata
Editing custom metadata
Defining roles and capabilities
Roles
Capabilities
Accessing the Define Roles tool
Viewing the capabilities for a role
Adding new roles
Editing a role
Deleting a role
Mapping emails
Accessing the Email Mappings tool
Default email mappings
Adding an email map
Deleting an email map
Managing events
Accessing the Events tool
Creating a new event
Editing an event
Deleting an event
Creating a list of values
Accessing the List of Values tool
Creating a list of values
Editing a list of values
Renaming a list of values
Managing relationships
Accessing the Relationships tool
Creating a new relationship
Deleting a relationship
Viewing the User Rights report
Using Alfresco
Using Alfresco Community
Finding your way around
Getting to know your toolbar
Your personal dashboard
Customizing your home page
Alfresco sites: Where collaboration begins
Creating a site
Finding a site
Joining a site
Deleting a site
Reviewing a user's profile
Searching for people
Repository
Managing permissions in the Repository library
More menu
Working with your task list
Viewing tasks and workflows
Editing a task
Managing your workflows
Viewing a workflow
Cancelling an active workflow
Deleting a completed workflow
User menu
Telling people what you're up to
Viewing your user profile
Viewing your full profile
Updating your personal and professional information
Following people
Changing your password
Controlling your email notifications
Searching for content
Performing a basic search
Performing an advanced search
Search examples
What can I do with my dashlets?
My Sites dashlet
My Tasks dashlet
My Profile dashlet
My Activities dashlet
My Documents dashlet
Configuring the RSS Feed dashlets
My Discussions dashlet
Site Search dashlet
Saved Search dashlet
Configuring the Saved Search dashlet
My Meeting Workspaces and My Document Workspaces dashlets
Web View dashlet
Configuring the Web View dashlet
Subscribing to an RSS feed
Entering a site
Understanding the site dashboard
Making the site easy to access
Customizing a site
Customizing the site dashboard
Editing the site details
Using the site dashlets
Site Members dashlet
Site Content dashlet
Site Activities dashlet
Wiki dashlet
Configuring the Wiki dashlet
Site Notice dashlet
Configuring the Site Notice dashlet
Image Preview dashlet
Site Data Lists dashlet
Site Links dashlet
Tagging site content
Selecting a component
Working with content in a library
Entering a site library
Exploring the library
About the Gallery view
Creating an organizational structure
Adding content to the library
Adding items to the library
Creating content
Creating Google Docs content in the library
Working with folders
Viewing folder details
Automating repetitive tasks
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
Manually 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
Editing content in Google Docs
Saving content to your computer
Share library content publicly
Cancel a shared link
Updating an item with content from your computer
Drag and drop content
Starting a workflow
Publishing content
Allowable content types
Removing published content
Managing aspects
Changing the content type
Renaming library content
Tagging library content
Specifying favorites
Giving positive feedback
Editing basic content details
Editing the content properties
Managing your comments
Leaving 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
Browsing the calendar
Viewing an event
Adding an event
Editing the event details
Changing the event date and time
Deleting an event
The wiki
Accessing the wiki
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 discussions forum
Accessing the discussion forum
Browsing the discussion topics
Viewing a topic
Creating a new topic
Editing a topic
Deleting a topic
Creating a reply
Editing a reply
The blog
Accessing the blog
Browsing the blog posts
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
Managing externally published blog posts
Updating an external blog post
Removing an external blog post
Working with comments
Adding a comment to a post
Editing a comment
Deleting a comment
Site links
Accessing the site links
Browsing the site 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
Data lists
Accessing the Data Lists 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 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
Managing pending invitations
Reference
Search Reference
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
Search query syntax APIs
Search query templates
Search query literals
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
Using Records Management
Records Management site dashboard
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 category
Adding a record folder
Adding items to the File Plan
Filing an electronic record
Filing a non-electronic record
Adding record metadata
Editing record metadata
Declaring a record
Managing the File Plan
Managing record categories
Viewing record category details
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
Exporting and importing records
Exporting content
Importing content
Disposition schedules
Defining the disposition schedule
Disposition schedule rules
Searching records
Accessing Records Search
Criteria tab
Results tab
Creating a search
Using a saved search
Records Management 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
Search fields
Search special record types
Printing the search results
Exporting the search results
Saving a search
Deleting a saved search
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
Specifying the notification recipient
Creating multi-lingual websites
Preparing a section for translation
Translating an asset within a translated section
Translating an asset that is not in a translated section
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 Alfresco outside of the Alfresco interface
Add a file to Alfresco from outside the Alfresco interface
Check out files from outside Alfresco
View item details from a mapped drive
Open Alfresco in a browser window
Open Alfresco Share in a browser window
Customizing
Customizing and extending Alfresco Share
Customizing Alfresco Share configuration items
Share repository document library
Configuring the Share repository document library
Hiding the Share repository document library
Configuring the Share default port
Configuring the RSS Feed Dashlet with HTTP authentication
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
NodeLocator service
Creating node locators
NodeLocator Service Java API
NodeLocator Service REST API
NodeLocator service startLocation
Available Node Locators
Share Extensibility
Customizing Share targeting existing files
Customizing Share through Advanced Component configuration
Creating an Extension module
Example - creating an Extension module
SurfBug
Tutorials
1. Add content to an Alfresco Share page
2. Control rendering of content on an Alfresco Share page
3. Sub-Component Evaluations
4. Customize Alfresco Share i18n properties
5. Customize Alfresco Share JavaScript controllers
6. Customize Alfresco Share FreeMarker templates
About FreeMarker extensibility directives
7. Auto-Readme extensions example
8. Add a new page to Alfresco Share
9. Override Alfresco Share login page
Extending the Alfresco Share Document Library
Alfresco Share Document Library repository tier
Alfresco Share Document Library web tier
Override and extension examples
Client-side template and action extensions
Reference
jsNode reference
Predefined Evaluators
EXIF renderer source code
Customizing Alfresco Explorer
Customizing Alfresco Explorer configuration items
Alfresco Explorer configuration settings
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
Programming
Integrating your application with Alfresco
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
Designing your application
Programming with CMIS
Using CMIS with Alfresco
CMIS requirements
CMIS repository
CMIS query
CMIS services
CMIS object model
The Alfresco OpenCMIS Extension
Using the Alfresco OpenCMIS Extension
Building the Alfresco OpenCMIS Extension with maven
Creating a document or folder with aspects
Adding, removing and discovering aspects
Programming with the repository
Alfresco repository extension points
Content models
Content behavior
Process definitions
Workflow models
Actions
Customizing content transformations
Programming with 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
Programming with Surf
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
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
Invoking web scripts
Working with client limitations
Tunneling HTTP methods
Forcing success response status
JSON callbacks
Caching
Runtime cache controls
Descriptor cache controls
Authenticating web scripts
Custom client authentication
Forms and web scripts
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
Tutorials
Listing pre-built web scripts
Invoking a web script using cURL
Developing a Hello World web script
Locating the Hello World example
How Hello World works
Debugging a controller script
Creating a Hello User web script with authentication
Returning a JSON response format
Selecting a response format
How Hello User works
Specifying user identity
Using the JSON callback
Understanding how the JSON callback works
Processing complex HTTP requests
Configuring a web script
Creating a web script using cache controls
Processing multipart forms
Testing the upload web script
Creating request processing web scripts
Extending the request processing web script
Creating a photo search script
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
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
Testing the new kind of web script
Web script reference
Web script description language reference
webscript
shortname
description
url
format
authentication
transaction
family
cache
negotiate
lifecycle
formdata
args
responses
requests
Root objects available in all web scripts
Root objects available in repository tier web scripts
Root objects available in all templates
Root objects available in repository tier templates
Root objects reference
atom
cache
config
crossRepoCopy
format
formdata
json
jsonUtils
requestbody
server
status
url
webscript
FreeMarker template methods
API References
Alfresco API Reference
Repository JavaScript API
About script files
Scripting API
Root objects
ScriptNode Object API
childByNamePath
childrenByXPath
childFileFolders
getActiveWorkflows
isScriptContent
hasAspect
isSubType
Security API
hasPermission
getPermissions
inheritsPermissions
setInheritsPermissions
setPermission
removePermission
Ownership API
setOwner
getOwner
takeOwnership
Modifying and creating API
createFolder
createFile
createNode
addNode
removeNode
createAssociation
removeAssociation
remove
copy
move
addAspect
removeAspect
specializeType
revert
save
Check In/Check Out API
checkout
checkin
cancelCheckout
checkoutForUpload
Versions API
Script Version Object
getVersion
createVersion
ensureVersioningEnabled
getVersionHistory
Content API
ScriptContentData API
write
guessMimetype
guessEncoding
getInputStream
getReader
Transformation API
transformDocument
transformImage
processTemplate
Thumbnail API
createThumbnail
getThumbnail
getThumbnails
getThumbnailDefinitions
ScriptThumbnail Object
update
Tagging API
clearTags
addTag
addTags
removeTag
removeTags
getTagScope
childrenByTags
Search API
luceneSearch
findNode
savedSearch
xpathSearch(xpath)
ISO9075Encode
ISO9075Decode
tagSearch
query
isValidXpathQuery
selectNodes
People API
createPerson
deletePerson
createGroup
deleteGroup
getMembers
addAuthority
removeAuthority
getContainerGroups
isAdmin
isGuest
changePassword
setPassword
enableAccount
disableAccount
isAccountEnabled
setQuota
getPeople
getPerson
getGroup
getCapabilities
getImmutableProperties
Actions API
create
ScriptAction API
execute()
executeAsynchronously()
Logging API
log
warn
info
error
Session API
Classification API
getAllCategoryNodes
getAllClassificationAspects
getRootCategories
getCategory
getCategoryUsage
createRootCategory
CategoryNode Object API
createSubCategory
removeCategory
rename
AVM API
lookupStore
lookupStoreRoot
lookupNode
getModifiedItems
stagingStore
userSandboxStore
websiteStagingUrl
websiteUserSandboxUrl
assetUrl
AVM Store API
lookupNode
luceneSearch
AVM Node API
rename
copy
move
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
moduleInstalled
toISO8601(long)
toISO8601(Date)
fromISO8601
toBoolean
createPaging
getLocale
setLocale
disableRules
enableRules
Services API
Site service
Site service object
createSite
listSites
listSiteRoles
listUserSites
getSite
getSites
findSites
hasCreateSitePermissions
isSiteManager
cleanSitePermissions
Site object
save
deleteSite
listMembers
isMember
getMembersRole
inviteNominated (new user)
inviteNominated (existing user)
setMembership
removeMembership
getContainer
createContainer
hasContainer
setPermissions
resetAllPermissions
getCustomProperty
getCustomProperties
inviteModerated
getInvitation
listInvitations
createAndSaveContainer
Activities service
postActivity
setFeedControl
unsetFeedControl
getFeedControls
Tagging service
getTags
getTag
createTag
deleteTag
TagScope object
getTopTags
getCount
refresh
Thumbnail service
isThumbnailNameRegistered
getPlaceHolderResourcePath
getMimeAwarePlaceHolderResourcePath
Rendition service
createRenditionDefinition
render
getRenditions
getRenditionsByName
Rendition Definition
getRenditionName
getRenderingEngineName
Authority service
createRootGroup
getGroup
getGroupForFullAuthorityName
getGroups
getGroupsInZone
searchGroups
searchGroupsInZone
searchRootGroups
searchRootGroupsInZone
getAllRootGroups
getAllRootGroupsInZone
getUser
searchUsers
ScriptGroup object
createGroup
deleteGroup
removeGroup
removeUser
addAuthority
removeAuthority
getChildUsers
getChildGroups
getChildAuthorities
getParentGroups
getAllParentGroups
ScriptUser object
Workflow service
Workflow Manager
getDefinitionByName
getDefinition
getInstance
getPooledTasks
getTask
getTaskById
createPackage
JscriptWorkflowDefinition
startWorkflow
JscriptWorkflowInstance
cancel
delete
JscriptWorkflowNode
JscriptWorkflowPath
signal
JscriptWorkflowTask
endTask
JscriptWorkflowTransition
RESTful API reference
Module
Wcmquickstart
Get Asset
Get Asset
Get Asset Collection
Search Assets
Fix Web Assets 1
Fix Web Assets 2
Load web site date.
Get Section(s)
Get Section(s)
Translations for Web Asset
Update web site renditions
Preview Webasset
Get secondary information about a given website
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
Admin
JMXDump
Alfresco Repo Restrictions
Alfresco Repo Usage
Alfresco Repo Usage Update
Archive
PUT a restore request to an archived NodeRef
DELETE permanently (purge) a node or nodes from the archive.
GET archived (deleted) items
Audit
Alfresco Audit Service Clear
Alfresco Audit Service Control
Alfresco Audit Service Control
Alfresco Audit Service Query
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
Category
Category Management
Category Management
Category Management
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 remote dictionary 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
Googledocs
Get GoogleDocs Integration Status Information
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
Delete link
Get all links
Metadata
Node metadata bulk retrieval service
Node metadata retrieval service
Node metadata storage service
Nodelocator
Node Locator
Person
Update user password
Get People
Add Person
Delete Person
Get Person
Update Person
Get sites
Information on Creating Users via CSV
Create Users via uploading of a CSV
Preference
Delete preferences
Get preferences
Set preferences
Publishing
Authorisation Callback
Channel Authorisation Form
Channel Authorisation Form
Reauthorise the specified publishing channel
Get channel type icon
Get Publishing Channels
Update Channel
Delete specified publishing channel
Get Publishing Channels
Create a publishing channel
Get Publishing Events For Node
Post Content to Publishing Queue
Rating
DELETE rating
POST a rating to a NodeRef
GET rating scheme definitions
GET rating
Replication
Delete a persisted replication definition
Get replication definition
Update a persisted replication definition
List persisted replication definitions
Create a new persisted replication definition
Gets status information on the Replication Service
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
Export Web 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
Solr
Get ACL ChangeSets
Get ACLs
Get ACLs readers
Get Model
Get Model Diffs
Get node property content as text
Get the nodes in the given transactions
Get the metadata for the specified nodes
Get transactions
Subscriptions
Follow
Followers
Followers Count
Following
Following Count
Follows
Private Following List
Private Following List
Unfollow
Tagging
Get node tags
Add tag
Delete existing tag
Create new tag
edit tag
List all tags
Get nodes for tag
Get tagscope tags
Thumbnail
Delete thumbnail
Thumbnails
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
Get Workflow Definition
List Deployed Workflow Definitions
Get Workflow Instance Diagram
Delete or Cancel Workflow Instance
Get Workflow Instance
Get Workflow Instance Collection for NodeRef
Get Workflow Instance Collection
Vti
Vti Server Details
Vti WebScript placeholder
Extensions
Webscripts
Javascript Debugger
Javascript Debugger Maintenance
Repository FreeMarker Template reference
Template framework architecture
Template files
Template models
Default model
TemplateNode API
getChildByAssocsByType
VersionHistoryNode API
hasAspect
Classification API
getAllCategoryNodes
getRootCategories
CategoryTemplateNode
Workflow API
getTaskById
WorkflowTaskItem API
People API
getCapabilities
getContainerGroups
getGroup
getMembers
getPerson
isAccountEnabled
isAdmin
isGuest
Default Model Methods
cropContent
dateCompare
hasAspect
hasPermission
incrementDate
message
shortQName
xmldate
Current Date
JSP Page
Surf Platform API reference
Surf platform
Root-scoped objects
context
user
save
getUser
content
page
template
config
theme
instance
sitedata
getObjectTypeName
getObjectTypeDescription
getObjects
getObjectsMap
newObject
newChrome
newComponent
newComponentType
newConfiguration
newContentAssociation
newPage
newPageAssociation
newPageType
newTemplate
newTemplateType
newTheme
newPreset
findComponents
findWebScripts
findChildPageAssociations
findPageAssociations
findChildPages
findParentPages
findContentAssociations
findComponentsMap
findPageAssociationsMap
findContentAssociationsMap
findTemplatesMap
findConfiguration
findTemplate
removeTemplate
bindComponent
unbindComponent
associateTemplate
unassociateTemplate
associatePage
unassociatePage
associateContent
unassociateContent
associateContentType
unassociateContentType
Helper methods
encode
decode
logout
reloadUser
getCredentialVault
getChrome
getComponent
getComponentType
getConfiguration
getContentAssociation
getPage
getPageType
getPageAssociation
getTemplate
getTemplateType
getTheme
newGUID
getFormatIds
getFormatTitle
getFormatDescription
remote
setConfigService
setConnectorProvider
connect
call
getEndpointName
getEndpointDescription
getEndpointUrl
isEndpointPersistent
locale
htmlid
url
head
app
getContext
include
msg
Return types
ScriptModelObject
save
remove
delete
toXML
touch
getBooleanProperty
getProperty
setProperty
removeProperty
getModelObject
clone
ScriptRemoteConnector
call
get
post
put
del
Response
ResponseStatus
setCode
setHeader
getHeaders
Rendering objects
templates
components
Troubleshooting
Debugging an Alfresco installation
Debugging an upgrade
Setting log levels
Error messages
Troubleshooting an upgrade
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
Troubleshooting schema-related problems
Performing schema dumps
Automatic dumps
Performing schema validation
Differencing
Validation
Reference
Search Reference
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
Search query syntax APIs
Search query templates
Search query literals
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