Module Espaces Collaboratifs 6.5.1
Description
Le module Espaces Collaboratifs fournit un système permettant d'ouvrir, de gérer et de travailler dans des espaces collaboratifs.
Un espace collaboratif est un portail de services dédiés à un ensemble de membres.
Captures d'écran
1.
Exemple d'espace collaboratif |
2.
Formulaire d'ouverture d'un espace collaboratif |
3.
Accès aux liens d'administration |
4.
Gestion des membres |
5.
Gestion des services |
6.
Statistiques de l'espace |
7.
Gestion du paramétrage |
8.
Gestion de l'habillage |
9.
Informations de l'espace |
10.
Recommandation à rejoindre l'espace |
11.
Création d'espace depuis la topbar |
12.
Accès à un espace privé |
13.
Une application |
Installation
Présentation des fonctionnalités
En supplément des services fonctionnels (calendrier, wiki, explorateur de Documents), d'autres services sont réservés aux administrateurs d'espace :
- gestion des membres : ajouter des membres, envoyer des invitations, et valider les demandes d'inscriptions
- gestion des services : ajouter et supprimer des services
- analyse des usages : voir l'utilisation et les statistiques de l'Espace Collaboratif
- paramétrage: modifier le comportement et l'affichage de l'Espace Collaboratif
Un Espace Collaboratif dispose d'un tableau de bord qui est composé d'un ensemble de services. Il peut également proposer une colonne latérale, qui sera dans ce cas toujours affichée.
Les services sont des portlets avec l'aptitude Application ou Tableau de bord.
Un service Tableau de bord peut être positionné dans la vue Tableau de bord, ou dans la colonne latérale. Un service Application dispose d'un onglet dédié, et est affiché en vue détaillé lorsqu'il est sélectionné.
Un Espace Collaboratif :
- dispose d'une politique d'accès (soit public, privé ou secret)
- dispose d'une politique d'inscription
- peut avoir des sous Espaces Collaboratifs
- peut être catégorisé sous une Typologie
Le module Espace Collaboratif introduit le compte invité, un compte utilisateur avec des droits restreints.
Installation
- Suivre les instructions du gestionnaire de modules
- Redémarrer le site
- Au premier démarrage, le module va initialiser certaines données, dont un modèle par défaut
- Aller dans l'espace d'administration, puis cliquer sur le lien Ouvrir un nouvel espace collaboratif afin de créer votre premier Espace Collaboratif
Détail des fonctionnalités
Modèle
Un Espace Collaboratif est créé à partir d'un modèle. Un modèle pré définit un ensemble de services, et un paramétrage par défaut.
Une fois installé, le module fournit un modèle par défaut. Des modèles supplémentaires peuvent être facilement créés.
Un modèle est un Espace Collaboratif dont l'Espace de travail est déclaré comme modèle.
Les modèles sont également l'entrepôt des services communs. Un administrateur d'espace choisit les services à activer parmi ceux des modèles, ou ceux de l'espace.
Politiques d'accès et d'inscription
3 politiques d'accès sont disponibles :
- Public
- Privé
- Secret
Seuls les membres qui appartiennent à un espace privé ou secret peuvent en lire les contenus.
Les espaces privés sont visibles par tous les membres. En revanche, un membre qui n'appartient pas à un espace secret n'aura même pas connaissance de l'existence de cet espace.
La politique d'inscription est asservie sur la politique d'accès.
| Public | Privé | Secret | |
| Inscriptions libres | x | x | |
| Demandes d'inscriptions validées par les animateurs | x | x | |
| Inscriptions gérées par les animateurs | x | x | x |
De plus, depuis la version 5.2 (CSP-62), il est possible de restreindre les choix possibles de ces politiques d'accès et d'inscription.
Par défaut, tous les choix décrits ci dessus sont disponibles :
Création d'espace : politiques par défaut
Mais, il est possible de limiter (par exemple) à deux politiques d'accès et une politique d'inscription unique :
Création d'espace : politiques restreintes
Il est également envisageable de n'autoriser que les espaces publics, avec la politique d'inscription libre. La modale de création ne proposant alors plus ces deux options.
Création d'espace : politiques pré définies
Portlet Mes Espaces Collaboratifs
La portlet Mes Espaces Collaboratifs liste tous les Espaces Collaboratifs du membre, ainsi que les autres espaces publics & privés auxquels le membre n'appartient pas. Elle fournit également un formulaire pour ouvrir un nouvel Espace Collaboratif, ou faire une demande d'ouverture.
Portlet Mes Espaces Collaboratifs - Mes Espaces
La portlet Mes Espaces Collaboratifs fournit également un gabarit sous espaces. Ce gabarit affiche les sous espaces de l'Espace Collaboratifs courant. Il ne fonctionne que lorsqu'il est visualisé depuis le Front Office d'un Espace Collaboratif.
Portlet Mes Espaces Collaboratifs - Sous Espaces
Typologie
Un Espace Collaboratif peut être catégorisé par le biais d'une typologie. Cette typologie est définie par une branche dédiée de Catégories. Si les typologies sont définies, la portlet Mes Espaces Collaboratifs fournit un filtre par typologie. Dans ce cas, les Espaces Collaboratifs modèles doivent également être catégorisés sous cette branche de typologies. Il doit y avoir au moins un modèle associé à la racine des typologies.
Pour activer les typologies, vous devez créer une branche de catégories dédiées, et la déclarer dans la propriété du module Racine de la typologie des EC.
Création
Un nouvel Espace Collaboratif peut être créé soit à partir de la portlet Mes Espaces Collaboratifs soit depuis l'interface d'administration via le lien Ouvrir un nouvel Espace Collaboratif.
Si le membre a les droits de création d'Espace Collaboratif, l'Espace est immédiatement créé.
Sinon, la demande doit être validée au travers d'un Workflow. Une fois la demande validée, l'Espace est créé, et les administrateurs et les membres peuvent être notifiés par e-mail.
Note: L'ACL Collaborative Space - Creation est fournit afin de permettre aux membres non administrateurs d'ouvrir de nouveaux Espaces.
Comptes invités
Que sont les comptes invités ?
Un compte invité est un compte utilisateur appartenant au Groupe des invités.
Ce compte n'a accès qu'aux Espaces Collaboratifs dans lesquels il a été invité.
Les comptes invités n'ont de sens que dans un site privé. Si le site est public, la limitation des droits est levée, et le compte redevient un compte normal. (Depuis les versions 4.4 et 5.2 du module)
Cette fonctionnalité permet d'inviter des personnes externes à l'entreprise, uniquement dans un ou des Espaces Collaboratifs. Ce membre peut être un simple lecteur, ou un rédacteur avec plus de droits.
Les restrictions suivantes s'appliquent à un invité :
- il ne peut pas appartenir à un Espace de Travail non Collaboratif
- il ne peut pas créer de Contact
- il ne doit être utilisé que dans le cas d'un site privé
- il ne peut pas être administrateur d'espace (à partir de la version 6.5 et CSP-414)
- Confidentialité :
- il ne voit que les Publications de ses Espaces
- il ne voit que les membres avec qui il partage au moins un Espace
- il ne peut pas voir les membres Contacts
- voir aussi § Policy Filter spécialisé
Comment activer cette fonctionnalité ?
- activer la fonctionnalité dans les propriétés du module
- créer un Groupe dédié (par exemple nommé "Invités")
- déclarer ce Groupe dans la propriété Groupe des comptes invités
Droits requis pour initialiser un invité
Pour initialiser un compte invité, il faut la somme des droits suivants :
- droits de gérer les membres d'un espace collaboratif
- avoir l'ACL de Gestion des invités
Ces droits peuvent être portés par un seul membre (une étape), ou par un demandeur et un valideur (deux étapes avec validation).
Vous pouvez donc permettre à un membre de demander l'intialisation de comptes invités, demandes qui seront validées par un autre membre.
| Action souhaitée | Droits requis | ||
|---|---|---|---|
| Nombre d'étapes requises | Gérer les membres de l'espace | Gérer les invités | |
| 2 | Demander l'initialisation d'un invité (*) | x | |
| Valider une demande | x | x | |
| 1 | Initialiser un invité (*) | x | x |
Le droit de Gérer les membres de l'espace peut être donné par les droits suivants :
- être animateur (administrateur) de l'espace collaboratif,
- et :
- avoir l'ACL d'espace d'Édition des membres dans l'espace collaboratif
- OU, avoir l'ACL globale de gestion des membres
(*) Initialiser un invité correspond à la création d'un nouveau compte, ou la transformation d'un contact existant en invité.
Rôles et workflow
L'initialisation d'un invité nécessite la mise en place de formulaires.
Deux types de formulaires permettent l'initialisation d'un invité :
- formulaire de création d'un compte invité (un nouveau Membre est créé)
- formulaire de transformation d'un contact existant (un contact existant est transformé en compte utilisateur)
Le workflow "Compte invité - Workflow de demande d'ouverture" doit être paramétré sur ces types de formulaires dans l'espace de stockage des soumissions.
Cet espace est paramétrable dans les propriétés du module. Par défaut, c'est l'Espace de Travail par défaut qui sera utilisé.
Policy Filter spécialisé
RightPolicyFilter des comptes invités : tous les types de Publications sont contrôlés par un RPF spécifique pour les invités. Une Publication ne peut être lue par un invité que si ce dernier appartient à l'Espace de la Publication.
Vous pouvez modifier comment ce filtre fonctionne :
Si vous souhaitez qu'un type de Publication particulier ne soit pas contrôlé, vous devez déclarer une nouvelle propriété de module selon la syntaxe :
jcmsplugin.collaborativespace.guestaccounts-rpf.ignore-publication-type.{ClassShortName}: {ClassFullQualifiedName}
Exemple : le module Newsletter empêche le type NewsletterContent d'être contrôlé, via la propriété :
jcmsplugin.collaborativespace.guestaccounts-rpf.ignore-publication-type.NewsletterContent: generated.NewsletterContent
Cela veut dire qu'un invité aura le droit de voir un NewsletterContent, même s'il n'appartient pas à l'Espace de la Publication.
ACL & délégation de droits
Le module Espaces Collaboratifs permet de déléguer les droits d'administration fonctionnelle à d'autres membres, grâce aux ACL.
Gestion des membres
Les ACLs Membres globale et d'Espace permettent de gérer les membres de votre Espace Collaboratif. Vous pouvez également donner l'ACL Groupes afin de donner le droit de gérer les Groupes de votre Espace Collaboratif.
Gestion des services
L'ACL d'Espace Espace Collaboratif - Services donne le droit de gérer les services de l'Espace.
Accès aux statistiques
Les ACLs Analyse des usages globale et d'Espace permettent de consulter l'usage et les statistiques de l'Espace.
Gestion du paramétrage
L'ACL d'Espace Espace Collaboratif - Paramétrage donne le droit de gérer les autres paramétrages de l'Espace.
Comment configurer votre modèle ?
Si vous devez déléguer ces droits d'administration, il peut être utile de préparer les groupes supportant ces ACLs directement dans le modèle. Pour ceci :
- en tant qu'administrateur, créer une nouvelle ACL d'Espace, nommée "EC - gestion des services", avec le droit "Espace Collaboratif - Services"
- créer un groupe nommé "Gestion des services de l'EC" ou "$NAME$ - Gestion des services de l'EC", et l'associe au modèle. ($NAME$ sera remplacé par le titre l'Espace créé)
- lorsque que vous créerez un nouvel Espace Collaboratif depuis ce modèle, un groupe supplémentaire "Mon Espace - Gestion des Services de l'EC" devrait être créé
- répétez ces étapes si vous devez déléguer d'autres droits
Analyse des usages (Analytics)
Le module Espaces Collaboratifs fournit des nouvelles métriques pour l'analyse des usages.
Typologie
Cette métrique indique la répartition des espaces collaboratifs selon leur typologie (Espace projet, départementaux, communautés, ...). Il s'agit de moyennes sur la période analysée.
La typologie est une branche de catégorie dédiée dans laquelle les espaces collaboratifs sont classés.
Politique d'accès
Les espaces collaboratifs peuvent être déclarés comme public (contenus visibles de tous), privés (connu de tous mais contenus réservés aux inscrits) ou secret (connu uniquement des inscrits).
Cette métrique indique la répartition des espaces collaboratifs selon leur politique d'accès (public, privé, secret). Il s'agit de moyennes sur la période analysée.
Membres
Cette métrique établie le palmarès des espaces collaboratifs en fonction du nombre d'inscrit. Le nombre d'inscrit est la moyenne du nombre de membre de l'espace sur la période analysée.
Taux de contribution
Cette métrique établie le palmarès des espaces collaboratif en fonction du nombre de contribution. Une contribution correspond à une écriture (création, mise à jour ou suppression) sur une publication de l'espace collaboratif.
Personnalisation & limites
La personnalisation du style des espaces collaboratifs doit être très limitée.
Il existe une limite connue sur l'utilisation d'une Portlet héritant de AbstractCollection en tant que "fils" d'une Portlet Espace Collaboratif. En effet, le drag&drop d'un service de l'espace provoque alors un effet de bord sur le paramétrage (des fils et références) de l'autre portlet collection.
Aussi, vous ne devez pas utiliser de Portlet AbstractCollection comme fils d'une Portlet Espaces Collaboratifs.
FAQ
Si vous utilisiez une version antérieure à la 6.4 et que vous souhaitez passer à la version 6.4 ou supérieure, lisez attentivement ce qui suit.
Si de plus, vous êtes passés directement à la 6.4 sans passer par la 6.3, appliquez également la procédure Comment migrer vers la version 6.3 ?
Valeur par défaut de propriétés
Si votre application ne dispose pas du correctif JCMS-5326, il vous faudra définir les valeurs par défaut des propriétés suivantes dans votre custom.prop (pour ne pas rencontrer le bug JCMS-5326) (Voir CSP-254) :
$id.CSRequest.formAuthor: j_2 $id.CSRequest.workspace: j_4
Le cas échéant, vous risquez de rencontrer ce warning dans les logs :
... [CreateSpaceHandler] - formAuthor is not a valid Member. Please check property "$id.CSRequest.formAuthor"
Abonnement à un espace collaboratif
Cette version apporte une nouvelle fonctionnalité : l'abonnement à un Espace Collaboratif. (Voir CSP-373)
 Suivre un espace collaboratif |
La portlet Espace Collaboratif dispose d'un nouveau champ "Groupe des abonnés". Lorsque ce groupe est défini, les membres peuvent s'abonner à l'espace (depuis les méta données en Front). Ils recevront alors par email les nouveaux contenus créés dans cet espace, une fois par jour (Modifiable via paramétrage de la notification sur le groupe des abonnés).
Pour proposer l'abonnement dans un environnement existant (c'est-à-dire, avec un ou des modèles et des espaces créés avant la version 6.4), il vous faudra :
- initialiser le groupe des abonnés sur votre ou vos modèles (afin de proposer l'abonnement dans les futurs espaces)
- (optionnel) initialiser le groupe des abonnés pour les espaces existants. Pour ce faire, une JSP est mise à votre disposition en pièce jointe de l'issue JIRA.
Mise à jour de pstatus
Afin de bénéficier d'un meilleur rendu des demandes d'inscription et des demandes d'ouverture d'Espace Collaboratif, les pstatus initiaux des types de formulaires CSRequest et CSSignupRequest ont évolué de -200 à -201 (afin de devenir un "état visible").
Le module effectuera une migration automatique au 1er démarrage s'il trouve des instances de ces formulaires dans l'ancien pstatus.
Pour plus de renseignement, consultez :
Identifiant (login) d'un compte invité
A partir de cette version (et CSP-386), le login d'un nouvel invité sera son adresse email. Ainsi, il est plus facile pour cette personne de mémoriser son identifiant.
Il est toutefois possible de définir votre propre façon de générer le login d'un compte invité. (Voir CSP-387)
Si vous utilisiez une version antérieure à la 6.3 et que vous souhaitez passer à la version 6.3 ou supérieure, il vous faudra effectuer une mise à jour de la base de données.
Procédure :
- consultez l'issue CSP-353
- téléchargez le fichier
.sqladapté à votre base de données - suivez la description dans le champ FIX de l'issue CSP-353
- pensez à noter et restaurer le paramétrage des 2 types de formulaires de compte invité dans l'espace de stockages des demandes
Cette procédure consiste à renommer les tables liées aux comptes invités avec des noms plus courts, afin d'éviter un conflit sur le nom des index générés.
Depuis la version 6.4 et l'issue CSP-387, il est possible de définir la manière dont le login / identifiant d'un nouveau compte invité est calculée.
Depuis cette version, et ce par défaut, le module définit le login d'un compte invité comme étant son adresse e-mail.
Il est toutefois possible de définir sa propre manière de calculer un nouveau login. Pour cela, il faut :
- créer une classe qui implémente l'interface
MemberLoginBuilder - définir cette classe en surchargeant la propriété dont la clé est
GuestAccountsConstants.GUEST_LOGIN_BUILDER_CLAZZ
Exemple d'implémentation personnalisée:
package com.foo.bar;
public class CustomLoginBuilder implements MemberLoginBuilder() {
/**
* @see com.jalios.jcmsplugin.collaborativespace.MemberLoginBuilder#buildLogin(com.jalios.jcms.Member)
*/
@Override
public String buildLogin(Member guest) {
return guest.getFirstName() + "." + guest.getName();
}
}
Définition associée dans le custom.prop :
jcmsplugin.collaborativespace.guestaccounts.login-builder.clazz: com.foo.bar.CustomLoginBuilder
Le builder custom aura en charge de retourner un login unique (Voir channel.getMemberFromLogin(String login)
But
- promouvoir des espaces collaboratifs
- faciliter la navigation de l'utilisateur vers ses espaces ou d'autres espaces auxquels il n'appartient pas encore
Il existe plusieurs manières de lister les espaces collaboratifs.
Portlet Mes Espaces Collaboratifs
Il s'agit d'un type de portlet dédié apporté par le module CSP. Cette portlet liste les espaces collaboratifs que l'utilisateur courant a le droit de voir. Si l'utilisateur est authentifié, elle présente alors deux onglets :
- les espaces auquel le membre appartient
- les autres espaces auxquels il n'appartient pas
Cette portlet doit être insérée dans un portail existant.
Si la notion de typologie est utilisée, elle permet de filtrer la liste des espaces sur une typologie.
Cette portlet propose également un gabarit alternatif permettant de lister les sous espaces d'un espace collaboratif. Ce gabarit n'a de sens que si la portlet est présentée au sein d'un espace collaboratif.
Portlet recommandation d'espaces
Le module CSP fournit le type de portlet Portlet Suggestion d'Espaces Collaboratifs (PortletCollaborativeSpaceSuggestion). Cette portlet liste les espaces visibles par le membre courrant, auxquels il n'appartient pas encore, et pour lesquels il a la possibilité de s'inscire.
Les espaces sont triés par affinité. L'affinité est basée sur le nombre de membres de son réseau qui participent déjà à ces espaces.
L'utilisateur a la possibilité de masquer une suggestion, et de restaurer les suggestions masquées.
Liste des espaces par typologies
Si vous utilisez la notion de typologie (catégorisation d'espace co.), il est possible de lister les espaces par typologie.
Pour cela, il faut :
- créer une portlet JSP de chemin
plugins/CollaborativeSpacePlugin/jsp/doCSTypologyList.jsp - inclure cette portlet dans un portail existant
On peut ainsi proposer une PortletNavigation, listant les typologies, et dont le clic renverra vers la liste des espaces collaboratifs correspondants à cette typologie.
Pour cela :
- avoir un portail dédié à l'affichage des espaces collaboratifs par typologies
- dont la portlet Sélection inclue la portlet JSP créée auparavant
- brancher le portail sur la catégorie parente des catégories de typologies
- avoir une portlet navigation qui liste les typologies
Un exemple de ce comportement peut être consulté sur cette page de la démo Agora. Les espaces collaboratifs listés sont ceux utilisant la typologie Projets.
But
- Partir d'un modèle d'espace existant, pour en faire un modèle adapté à votre utilisation.
- Créer autant de modèles différents que vous avez d'usages
Note: le module CSP est livré avec un modèle configuré par défaut. Ce modèle est initialisé lors du premier démarrage du module.
Procédure
Pour dupliquer un Modèle d'Espace Collaboratif :
- Vous devez d'abord créer un Espace Collaboratif sur le Modèle à dupliquer
- Puis dans Espace d'Administration / Espace de travail, éditez l'Espace de Travail (créé en même temps et avec le même nom que l'Espace Co) pour en faire un Espace Modèle.
- renommez la catégorie du modèle pour inclure "$NAME$" dans son nom
- enfin renommez les groupes de l'espace pour inclure "$NAME$" dans leurs noms
Français