sphix-poc Documentation
Release 1.0.0
eXoPlatform
User Guide
1 Introduction 3
2 Getting started 5
2.1 Glossary . . . 6
2.2 Welcome to eXo Platform . . . 8
3 Managing Your Personal Applications 11
4 Working With Tasks 13
5 Discussing in Chat 15
6 Working With Spaces 17
7 Working With Wikis 19
8 Managing Your Documents 21
9 Building your forum 23
10 Managing your calendars 25
11 Managing your websites 27
12 Searching In eXo Platform 29
13 Administering eXo Platform 31
14 All about eXo 33
15 Manage Applications 35
16 Indices and tables 37
sphix-poc Documentation, Release 1.0.0
The main guides in eXo Platform documentation: • User Guide • admin-docs • dev-docs • addons-docs • mobile-docs • reference-JCR-docs • reference-eXo-foundations-docs • reference-platform-docs User Guide 1
CHAPTER
1
Introduction
This user guide covers all the basic and advanced features/functions that are available in eXo Platform. Throughout a series of in-depth examples and clear explanations, users will easily realize benefits when implementing eXo Platform.
This guide assumes that you are using the defaults (for example, user interface and functions) provided in eXo Platform. To make easy for readers when approaching eXo Platform, this guide is organized into the following chapters:
Getting Started
All the most basic things you need to know when approaching eXo Platform for the first time, for example, commonly used glossaries, interface of eXo Platform, sign-in/sign-out, management of your accounts and language.
Managing Your Personal Applications
Introduction you to accessing personal applications that allow you to manage your profiles, activity stream, connections, dashboard and email notification and to work with Wiki quickly.
Working With Tasks
Instructions on how to work with the Task Management application, including capturing a task and man-aging projects effectively.
Discussing in Chat
Instructions on how to use eXo Chat: Create chat room, send messages, add task in chat room and much more.
Working With Spaces
All related to a space, including accessing, creating/editing, joining/leaving/deleting a space, and accept-ing/denying invitations.
Working With Wikis
How to build a wiki, to manage the Wiki content, and to do advanced settings supported in Wiki.
Managing Your Documents
Introduction to the Documents Management system of eXo Platform, working with basic actions on folders and documents, organizing content, sharing documents, and extending actions.
Building your forum
All actions that a user can perform. These actions are classified to user roles (including regular users, moderators and administrators).
Managing your calendars
Introduction to Calendar interface, creating/edting/exporting/importing/sharing a calendar, scheduling events, making changes on Calendar settings, generating RSS, and managing categories.
Managing your websites
All actions that allow you to contribute and manage content (for example, creat-ing/editing/publishing/deleting content) in your site effectively.
Searching In eXo Platform
How to search for any content without accessing each application in eXo Platform, and for specific content types within separate applications.
Administering eXo Platform
All advanced features that are designed for administrators, for example: branding eXo Platform, admin-istering content, managing organization/permissions/sites in eXo Platform.
CHAPTER
2
Getting started
This chapter covers the following topics: • Glossary
Terms which are commonly used in eXo Platform applications. • Welcome to eXo Platform
Introduction to what you need to do for the first startup of eXo Platform. • Social Intranet Homepage
Introduction to the Social Intranet homepage, the Social Intranet applications and how to change your language.
• Signing in/Signing out Social Intranet How to sign in and sign out Social Intranet.
• Changing your account settings
How to change your account profile and password. • Forgot Password
How to request a link to reset your password. • Using the Activity Stream
How to post status updates, share links and documents, delete activities/comments, comment on activities, or like/unlike activities.
Note
According to your roles, not all features described in this guide are available to you. Check with your administrator to assure which features are for your account or ask for more appropriate rights.
2.1 Glossary
This section provides a number of terms that you will encounter when implementing eXo Platform. Site
A web-based environment which is used for aggregating and personalizing information via specific applications with an interactive and consistent look and feel. Users and administrators are able to integrate information, people and processes via a web-based user interface.
Portlet
An applicative component pluggable to a site through which users can access some specific information, including supports, updates, or mini-applications. The portlet produces fragments of a markup code that are aggregated into a page. Typically, a page is displayed as a non-overlapping portlet windows collection, where each portlet window displays a portlet. Content generated by a portlet can be customized, depending on the configuration set by each user. Portlets can be divided into two following types:
• Functional portlets which support all functions of a site. They are built into the site and accessed via toolbar links when the site-related tasks are performed.
• Interface portlets which constitute the eXo Platform interface as front-end components of the site. Super-user
A super-user is a special user who has full privileges and used for the administration. In eXo Platform, this account is configured with Root, Root,root@localhostand its memberships are member:/organization/management/executive-board, *:/platform/administrators, *:/platform/users, *:/platform/web-contributors, *:/organization/employees. A super-user has all permissions on all features of eXo Platform.
Navigation
A set of menus (sometimes so-called node tree) that contains hyperlinks to other parts of a site. The default navigation menus in eXo Platform are located in the top navigation bar:
Space
A collaboration workspace where you can share documents, tasks, events, wikis and more. A space can be open or closed, private or public and space administrators can manage members and applications that are available.
Connection
A bond among people in a network. By connecting to other people, you will be able you to track their activities through the activity stream.
Activity
An activity is published on the Activity Stream and allows you to follow what your connections are sharing, such as links to documents or just moods. An activity can be made out of different parts:
• The author • The author’s avatar • The space
• The type of the activity (for instance Documents, Wiki, Forums, Spaces or Connections) • The activity message
sphix-poc Documentation, Release 1.0.0
• The action bars including the buttons Comment and Like • The like section
• The comment section Gadget
A mini web application which is run on a platform and can be integrated and customized in the website. You can add these gadgets to your dashboards by yourself.
Modes
eXo Platform offers two access modes by default:
• Public mode is for guest users (visitors) who are not registered. In this mode, you are not required to sign in, but limited to public pages in the site. After being registered successfully, you can use the private mode, but must contact the site administrators to get more rights or the group manager to become the member and gain the access to the group.
• Private mode is for registered users who will apply their usernames and passwords to sign in. This mode sup-ports users in taking many actions, such as creating private pages, editing or deleting them, “borrowing” pages from others by creating hyperlinks, changing languages to their individual needs, managing private information. Permission
Permission settings control actions of a user within the site and are set by the administrators. See Managing permis-sionsfor more details.
Repository
A locus where content or digital data are maintained. Users can access without traveling across a network. Drive
A shortcut to a specific location in the content repository that enables administrators to limit visibility of each workspace for groups of users. It is also a simple way to hide the complexity of the content storage by showing only the structure that is helpful for business users.
In details, a drive consists of:
• A configured path where the user will start when browsing the drive.
• A set of allowed views that will allow the user to limit the available actions, such as editing or creating content while being in the drive.
• A set of permissions which limits the access and view of the drive to a specified number of people. • A set of options to describe the behavior of the drive when the users browse it.
Node
An abstract unit used to build linked data structures, such as linked lists and trees, and computer-based representation of graphs. Nodes contain data and/or links to another nodes. Links between nodes are often implemented by pointers or references.
Also, a node can be defined as a logical placeholder for data. It is a memory block which contains some data units, and optionally a reference to some other data. By linking one node with other interlinked nodes, very large and complex data structure can be formed.
WebDAV
This term stands for Web-based Distributed Authoring and Versioning. In eXo Platform, it is used as a mean to access the content repository directly from the Sites Explorer.
Symlink
A special file which contains a reference to a document or a folder. By using symlinks, you can easily access specific nodes (target) to which symlinks point. In Documents, a symlink has a small chain symbol next to its icon.
2.2 Welcome to eXo Platform
eXo Platform is a full-featured application for users to have many experiences in building and deploying transactional websites, authoring web and social content, creating gadgets and dashboards with reliable capabilities of collaboration and knowledge. When you initialize eXo Platform for the first time, the Terms and Conditions Agreement screen is
displayed as follows: Note
The Terms and Conditions Agreement screen appears in the Commercial editions only. In the Commu-nity edition, the‘Account Setup‘_form appears for the first time.
This agreement contains all terms and conditions that you need to read carefully before deciding to use eXo Platform. By ticking the checkbox at the screen bottom, you totally agree with the eXo Platform’s terms and conditions. Next, click Continue to move to the Account Setup form.
This agreement contains all terms and conditions that you need to read carefully before deciding to use eXo Platform. By ticking the checkbox at the screen bottom, you totally agree with the eXo Platform’s terms and conditions. Next, click Continue to move to the Account Setup form.
sphix-poc Documentation, Release 1.0.0
images/platform/Unlock-ACCOUNTSETUP.jpg
CHAPTER
3
Managing Your Personal Applications
CHAPTER
4
Working With Tasks
CHAPTER
5
Discussing in Chat
CHAPTER
6
Working With Spaces
CHAPTER
7
Working With Wikis
CHAPTER
8
Managing Your Documents
CHAPTER
9
Building your forum
CHAPTER
10
Managing your calendars
CHAPTER
11
Managing your websites
CHAPTER
12
Searching In eXo Platform
CHAPTER
13
Administering eXo Platform
Contents:
CHAPTER
14
All about eXo
eXo is an open source collaboratif Solution It provides a set of tools to help employees
• Messaging system • Tasks Management • Social feature
CHAPTER
15
Manage Applications
To manage categories, portlets and gadgets in a portal, you first need to go to the Manage Applications page by
clicking on the top navigation bar, and select Applications. The Manage Applications page will appear. In which:
• Tab bar consists of two items, including Portlet and Gadget.
• Action bar consists of actions related to adding a category and importing applications.
• Left pane lists all categories and portlets/gadgets of each category.
• Breadcrumb bar is the path from a specific category to a specific portlet/gadget in that category.
•
CHAPTER
16
Indices and tables
• genindex • modindex
• Searching In eXo Platform
