eXo Platform 3.5 Documentation

The following topics are covered:

User Guide
About this guide
1. Get Started
1.1. Glossary
1.2. eXo Platform 3.5 interface
1.3. Manage accounts
1.3.1. Register new account
1.3.2. Sign in & Sign out
1.3.3. Change account settings
1.3.4. Retrieve account and password
1.4. Manage language
1.4.1. Change the display language permanently
1.4.2. Change the display language for another user
2. Manage Your Organization
2.1. Add a user
2.2. Manage users
2.2.1. Search for users
2.2.2. Edit user information
2.2.3. Delete a user
2.3. Manage groups
2.3.1. Add a new group
2.3.2. Edit a group
2.3.3. Delete a group
2.3.4. Add a user to a group
2.3.5. Edit a user membership in a group
2.4. Manage memberships
2.4.1. Add a new membership type
2.4.2. Edit a membership type
2.4.3. Delete a membership type
3. Manage Your Portals
3.1. Manage permissions
3.1.1. Set permissions on a portal
3.1.2. Set permissions on a page
3.1.3. Set Access permission on a category
3.1.4. Set Access permission on a portlet
3.2. Manage sites
3.2.1. Create a new portal
3.2.2. Switch between portals
3.2.3. Edit a portal
3.2.4. Delete a portal
3.3. Manage a sample accessible website
3.4. Manage navigation nodes
3.4.1. Add a new node
3.4.2. Edit a node
3.4.3. Copy/Paste a node
3.4.4. Clone a node
3.4.5. Cut a node
3.4.6. Delete a node
3.4.7. Change nodes order
3.5. Manage pages
3.5.1. Add a new page using Page Creation Wizard
3.5.2. Add a new page using Page Management
3.5.3. Edit a page
3.5.4. Delete a page
3.5.5. Manage page navigation
3.6. Manage applications
3.6.1. Inside a portal
3.6.2. Use Gadgets in your dashboards
3.6.3. Inside Desktop
4. Organize Your Content
4.1. Structure content
4.1.1. Access Sites Explorer
4.1.2. Drives
4.1.3. Views
4.1.4. Functions on action tabs
4.1.5. Actions on folders and documents
4.1.6. Content Administration
4.2. Manage content
4.2.1. Contribute content
4.2.2. Manage content list viewer by query
4.2.3. Create content inside a category
4.2.4. Manage content in Sites Explorer
4.2.5. Manage content with WebDAV
4.2.6. Manage content with Fast Content Creator
4.2.7. Create content templates with Form Builder
4.2.8. Manage CLV templates in Sites Explorer
4.2.9. Manage Category Navigation
4.2.10. Manage SEO
4.2.11. Search content in a site
4.2.12. Print content
4.3. Manage newsletters
4.3.1. Newsletter viewer
4.3.2. Newsletter Manager
4.4. Manage workflows
4.4.1. Holiday process
4.4.2. Pay raise process
4.4.3. Upload a process
4.4.4. View process detail
5. Collaborate With Your Colleagues
5.1. Manage your calendar
5.1.1. Calendar views
5.1.2. Manage a calendar group
5.1.3. Create a calendar
5.1.4. Edit a calendar
5.1.5. Export/Import a calendar
5.1.6. Share a personal calendar
5.1.7. Schedule an event
5.1.8. Schedule a task
5.1.9. Search for events/tasks
5.1.10. More actions
5.1.11. Add My Agenda gadget to your page
5.1.12. Add My Tasks gadget to your page
5.2. Manage your contacts
5.2.1. View contacts
5.2.2. Create a new contact
5.2.3. Edit contact details
5.2.4. Tag a contact
5.2.5. Edit a tag
5.2.6. Delete a tag
5.2.7. Send a mail to a contact
5.2.8. Copy/Paste a contact
5.2.9. Move a contact
5.2.10. Delete a contact
5.2.11. Export contacts
5.2.12. Import contacts
5.2.13. Print contacts
5.2.14. Print an Address Book
5.2.15. Share contacts
5.2.16. Search for contacts
5.2.17. Manage Address Books
5.3. Email your contacts
5.3.1. Create a Mail account
5.3.2. Get mails
5.3.3. Mail views
5.3.4. Read an email
5.3.5. Compose a new message
5.3.6. Reply to a message
5.3.7. Forward a message
5.3.8. Print a message
5.3.9. Export a message
5.3.10. Import a message
5.3.11. Categorize messages by folders/tags/filters
5.3.12. Search for messages
5.3.13. Add an event
5.3.14. Manage Address Book in Mail
5.3.15. Change Mail settings
5.4. Chat with your contacts
5.4.1. Add contacts to your friend list
5.4.2. Remove a contact
5.4.3. Chat with a contact
5.4.4. Create a chat room
6. Organize Your Knowledge
6.1. About user roles
6.2. Access Knowledge applications
6.3. Build a wiki
6.3.1. Work with Wiki pages
6.3.2. Work with attachments
6.3.3. Use the WYSIWYG Editor (Rich Text editor)
6.3.4. Syntax Help
6.3.5. Work with Macros
6.3.6. Work with page versions
6.3.7. Work with Spaces
6.3.8. Search
6.3.9. WebDAV support in Wiki
6.3.10. Wiki Administration
6.4. Build a forum
6.4.1. Administrator
6.4.2. Regular users
6.4.3. Moderator
6.5. Build an Answers & FAQs system
6.5.1. Administrator
6.5.2. Moderator
6.5.3. Regular user
7. Build Social Network
7.1. Manage your profile
7.1.1. Edit your information
7.1.2. Upload your profile avatar
7.1.3. Update your current position
7.2. Manage spaces
7.2.1. Create a space
7.2.2. Edit a space
7.2.3. Join/Leave a space
7.2.4. View details of a space
7.2.5. Delete a space
7.2.6. Search for spaces
7.2.7. Accept/Ignore invitations
7.3. Manage connections
7.3.1. Search for contacts
7.3.2. View profiles of other contacts
7.3.3. Send connection requests
7.3.4. Revoke a connection request
7.3.5. Accept/Deny a connection request
7.3.6. Disconnect from your contacts
7.4. Follow activities in your organization
7.4.1. Update status
7.4.2. Share a link
7.4.3. Share a file
7.4.4. Delete activities/comments
7.4.5. Comment on activities
7.4.6. Like/Unlike activities
7.4.7. Create rich activities with allowed HTML tags
Administrator Guide
About this guide
1. Installation and Startup
1.1. System requirements
1.2. Install the Tomcat bundle
1.3. Install JBoss EARs
1.4. Profiles of eXo Platform
2. Configuration
2.1. eXo Platform configuration
2.2. Database configuration
2.2.1. Connect to a production database
2.2.2. FAQs of database configuration
2.3. File system paths
2.4. JCR system and default Workspaces
2.5. Transaction Service
2.6. Mail server
2.7. Email-notification configuration for watching a document
2.8. WebDAV cache control
2.9. Chat server
2.9.1. XMPPMessenger
2.9.2. Chat server configuration
2.10. Office server
2.11. Log-in
2.12. JCR
2.13. Cache configuration
2.13.1. Portal Cache Configuration
2.13.2. Social Cache Configuration
2.13.3. ECMS Cache Configuration
2.14. Users configuration
2.14.1. Super-user configuration
2.14.2. Default users list definition of eXo Platform
2.14.3. Grant users access to toolbar
2.15. Gadget configuration
2.16. Other properties
3. Management
3.1. Introduction to eXo Platform management
3.1.1. JMX interface
3.1.2. REST interface
3.2. Management views of eXo Platform
3.2.1. PortalContainer management view
3.2.2. Cache management view
3.2.3. Content management view
3.2.4. JCR management view
3.2.5. Portal management view
3.2.6. Knowledge management view
3.2.7. Collaboration management view
4. Security
4.1. Change the JAAS realm
4.1.1. Tomcat
4.1.2. Common changes
4.2. Gadget proxy configuration
4.2.1. Overview
4.2.2. Configure the ProxyFilterServie
4.2.3. How does it work?
4.3. HTTPS configuration
5. Backup and Restore
5.1. Pre-backup
5.2. Back up eXo Platform
5.3. Restore
5.4. Third-party tools
6. Clustering
6.1. About clustering in eXo Platform
6.2. Set up the eXo Platform cluster
6.2.1. Shared file system
6.2.2. Set up eXo Platform cluster
6.2.3. Advanced configuration
6.2.4. Local JCR index in cluster
6.3. FAQs of clustering
7. Deployment
7.1. Remove sample portals
7.1.1. Remove Acme website/Acme Social Intranet
7.1.2. Remove Crash
7.2. Deploy a custom extension
7.3. Set up Apache front-end
7.3.1. Base configuration for Apache
7.3.2. Connect via HTTP protocol (Apache mod_proxy)
7.3.3. Connect via AJP protocol
7.4. Configure the session timeout for the web server
7.4.1. Tomcat server
7.4.2. JBoss server
8. Organization Integration
8.1. Terminology
8.2. Synchronize eXo Platform with an existing directory
8.2.1. Activate the service
8.2.2. Sync at startup
8.2.3. Sync at login time
8.2.4. Sync on demand
8.2.5. Scheduled/Periodic sync
8.3. Use Legacy Organization Models
Developer Guide
About this guide
1. Get Started
1.1. Glossary
1.2. Set up Maven settings
1.3. eXo Architecture Primer
1.3.1. Kernel
1.3.2. GateIn extensions
1.3.3. Java Content Repository
2. Create Your Own Portal
2.1. Create your extension project
2.2. Define a default portal
2.3. Structure of portal, pages and menus
2.3.1. Portal navigation
2.3.2. Visibility of pages
2.3.3. Page access permission
2.4. Enable/Disable a drive creation during the portal creation
2.5. Add/Remove a language
2.5.1. Add a new language
2.5.2. Remove a language
2.6. Create a custom look and feel
2.6.1. Platform skin elements
2.6.2. Override skins with extension
2.6.3. Create new skins
2.6.4. Skin the portlet
2.6.5. Configure Platform skin
2.6.6. Configure skin in WCM
2.6.7. Customize Document's skin
2.6.8. Best practices to customize a skin
2.7. Add JavaScript to your portal
2.8. Create custom templates for pages
3. Work With Content
3.1. Node type
3.2. WCM template
3.3. Document type
3.4. Dialog Syntax
3.4.1. Interceptors
3.4.2. Hidden fields
3.5. Customize CKEditor
3.5.1. Installation
3.5.2. File and Folder Structure
3.5.3. Configuration in CKEditor
3.6. Taxonomy
3.7. Manage Template service
3.8. Manage Navigation By Content
3.8.1. Actual content navigation
3.8.2. Add content to the navigation
3.8.3. Actions on Navigation By Content
3.8.4. Examples of creating data for Navigation By Content
4. Work With Applications
4.1. Integrate an application
4.2. Develop your own application
4.2.1. Gadget vs Portlet
4.2.2. Develop a gadget for eXo Platform
4.2.3. Portlet Bridges
5. System Integration
5.1. Authentication
5.1.1. Single-Sign-On (SSO)
5.1.2. Central Authentication Service (CAS)
5.1.3. Kerberos SSO on Active Directory
5.2. Users integration
5.2.1. Organization Service
5.2.2. Memberships, Groups and Users
5.2.3. Organization API
5.3. LDAP Integration
5.3.1. Connection Settings
5.3.2. Organization Service Configuration
5.3.3. Active Directory sample configuration
5.3.4. Picketlink IDM
5.4. Email
6. eXo Platform 3.5 APIs
6.1. Definitions of API Levels
6.2. Platform APIs
6.2.1. Java APIs
6.2.2. JavaScript APIs
6.2.3. Web Services
6.3. Provisional APIs
7. Cookbook
7.1. How to Copy a Site
8. Upgrade eXo Platform
8.1. Prerequisites
8.2. Prepare your extension project
8.3. What needs to be adapted in eXo Platform extension
8.4. Update project Maven dependencies
8.5. Update configurations
8.6. Update components
8.7. Update extension
8.7.1. Update Kernel XML Schema
8.7.2. Update portal
8.7.3. Update APIs
IDE User Guide
About eXo IDE
1. Basic Operations
1.1. eXo IDE Interface
1.2. Select a workspace
1.3. Open a folder
1.4. Open a file
1.5. Refresh a selected folder
1.6. View and Copy a file's URL
1.7. Copy/Cut/Paste files and folders
2. Operations With Folder
2.1. Create a folder
2.2. Delete a folder
2.3. Rename a folder
2.4. Download a zipped folder
3. Operations With File
3.1. Create a file
3.2. Save/Save As... a file
3.3. Save all files
3.4. Delete a file
3.5. Rename a file
3.6. Change the MIME type of a file
3.7. Lock a file
3.8. Open a file with the non-default editor
3.9. Go to a folder
3.10. Download a file from Server
3.11. Open a local file
3.12. Upload a file
3.13. Upload a zipped folder
3.14. Open a file by path
3.15. Use a file template
3.15.1. Save a file as template
3.15.2. Create a file from a template
3.15.3. Remove a non-default file template
3.16. Use a project template
3.16.1. Create a project template
3.16.2. Modify the project template structure
3.16.3. Create new project from template
3.16.4. Remove a project template
3.17. Open/Select/Close/Browse tabs
3.18. Undo/Redo editing
3.19. Edit files in the Code Editor
3.19.1. Format a file
3.19.2. Show/Hide Line Numbers
3.19.3. Go to a line
3.19.4. Watch the cursor position in the Status bar
3.19.5. Delete a line
3.19.6. Find/Replace
3.19.7. Code auto-complete
3.19.8. Code outline
3.20. Edit a file in the WYSIWYG Editor
3.21. Preview file properties
3.22. Preview HTML Files
4. Search Files
5. REST Service Operations
5.1. Validate a REST Service
5.2. Deploy/Undeploy a REST Service
5.3. Use Autoload property
5.4. Launch a REST Service with set parameters and Preview Server Console Messages in the Output Tab
5.5. Get URL of a REST Service
5.6. Review the response headers from REST Service
5.7. Deploy to Sandbox, Undeploy from Sandbox, Run in Sandbox
5.8. REST Service Discovery
5.9. Configure classpath
5.9.1. Add sources to classpath
5.9.2. Remove sources from classpath
5.10. Sample REST Service with complex media types output preview
6. Operations With POGO File
7. Operations With Google Gadget
7.1. Create a Google Gadget
7.2. Preview a Google Gadget
8. Operations With Templates
8.1. Create and Edit a template
8.2. View template's properties
8.3. Preview a template
9. Operations With Netvibes Widget
9.1. Create Netvibes widget
9.2. Preview Netvibes widget
9.3. Deploy Netvibes widget to Netvibes Ecosystem
9.4. View Netvibes documentation
10. Chromattic Data Object Usage
10.1. Create a Data Object
10.2. Preview a Node Type
10.3. Create a Node Type
11. Versioning
11.1. View version history
11.2. Version navigation
11.3. Restore a file to the older version
12. Miscellaneous and Tips
12.1. View information about eXo IDE
12.2. Customize the toolbar
12.3. Customize hotkeys
13. Related References
Copyright ©2012. All rights reserved. eXo Platform SAS