Module d'export CSV
Choisissez les données que vous souhaitez exploiter et exportez les en toute simplicité !
Themes : Administration, Sauvegarde
Version 2.0.1
Compatibility : JCMS 6, 7, 8, 9, 10
Documentation
Les bénéfices
Ce module permet aux utilisateurs de sélectionner et d'exporter avec facilité une partie ou la totalité des contenus, contenus utilisateur, formulaires et portlets de votre plateforme dans un fichier au format CSV. Si vous souhaitez conserver les liens entre vos publications, récupérer les catégories associées ou encore les fihiers atttachés à vos contenus, quelques paramètres à activer et le tour est joué.
En offrant une interface d'exportation avancée et intuitive, ce module offre ainsi une solution complète pour extraire et structurer vos données en vue d'une utilisation ultérieure.
Les fonctionnalités
Les fonctionnalités clés de ce module sont :
- Exportation polyvalente : ce module permet l'exportation de contenus variés, tels que les contenus et contenus utilisateurs, les formulaires, les portlets, ainsi que les fichiers associés ;
- Exportation au format CSV : les données sont exportées dans un format CSV (Comma-Separated Values), largement reconnu et compatible avec de nombreux logiciels. Les fichiers CSV exportés peuvent être ouverts et traités dans des applications de tableur, des bases de données et d'autres outils ;
- Génération d'arborescence de dossiers : l'exportation de documents génère une arborescence de dossier basée sur la structure de catégories du document ;
- Gestion complète des fichiers : exportez en toute confiance les fichiers associés en conservant l'intégrité de la structure d'arborescence ;
- Interface d'export avancée : ce module offre une interface d'exportation conviviale et intuitive, permettant aux utilisateurs de sélectionner les données à exporter avec précision ;
- Définition de template d'export : il vous est possible de définir un modèle d'export par type de contenu qui reprendra automatiquement votre configuration d'export
- Accès depuis back office et front office : les contributeurs et administrateurs habilités peuvent accéder à l'interface d'export depuis l'espace d'administration ou le front office.
Le module intègre également plusieurs paramètres permettant notamment :
- de définir le positionnement du lien d’export
- de définir les utilisateurs habilités à exporter
- de définir la données à exporter pour certains types de champ, exemples :
- pour l'état de worklow : possiblité d'exporter l'ID ou le libellé
- pour un rédacteur : possiblité d'exporter le prénom et nom ou l'identifiant
- pour les catégories : possibilité d'exporter l'ID ou le titre
- d'exporter les fichiers attachés à vos contenus (média et document)
- de nettoyer automatiquement les zones de texte riches (wysiwyg)
L'interface d'export est accessible pour tout contributeur et/ou administrateur habilité depuis le back office et front office de JPlatform à différents niveaux de votre plateforme :
- Depuis l’espace d’administration pour les administrateurs
- Depuis les espaces de travail pour les contributeurs
- Depuis vos explorateurs de documents (portlet explorer) pour tout membre habilité
Captures d'écran
Export depuis l'espace de travail (back office) :
L’export s’appliquera sur la liste de résultats qui vous est affichée, et donc tient compte des filtres utilisés
Export depuis un explorateur de document :
L'export s'effectue sur les documents affichés dans l'explorateur et tenant compte des filtres en cours (catégorie et/ou recherche textuelle). L'archive exportée a l'avantage de contenir l'arborescence telle qu'elle est dans votre explorateur et restituée sous forme de dossiers.
Interface de personnalisation du fichier d'export :
Les clients aiment
Les clients apprécient tout particulièrement :
- la simplicité d'utilisation du module ;
- la nouvelle interface d'export intuitive et innovante.
Installation
Prérequis techniques
Compatibilité JSync
Ce module est compatible jSync, il fonctionnera sans problème sur un environnement à plusieurs réplicas.
En revanche, il est important de noter que la configuration du module ne sera pas répliquée et sera à faire sur chaque nœud.
Compatibilité JDK
Ce module est compatible avec la version 1.7 de JDK (Java Development Kit). Si vous êtes sur la version 1.6 de JDK, contactez-nous.
Configuration du module
Ajouter ce module avec le gestionnaire de modules depuis l’administration technique et redémarrer JPlatform.
Une fois le module installé, assurez-vous que les propriétés du module sont correctement paramétrées pour votre plateforme :
| Propriété |
Nom technique |
Description |
| Paramètres globaux |
||
| Groupe autorisé à faire les exports |
|
Permet de sélectionner un groupe unique autorisé à effectuer les exports (dans le cas où les exports de contenus doivent être accessibles que pour certains utilisateurs). |
| Adresse mail par défaut de l'émetteur |
|
Il s’agit de l’adresse mail de l’émetteur pour les envois par mail des exports CSV. |
| Lancer plusieurs exports par session |
|
Permet de lancer plusieurs exports CSV par session pour limiter la charge du serveur dans le cas d’export complexe. |
| Nombre maximum de lignes par fichier |
|
Permet de limiter le nombre de lignes par fichier CSV avant de passer à un autre fichier. |
| Séparateur de champ multivalué |
|
Permet de préciser le séparateur de champ à valeur multiple utilisé dans le fichier d’export CSV. |
| Nettoyage des caractères spéciaux |
|
Si activé, permet de retirer du fichier tous les caractères spéciaux qui ne sont pas autorisés suivant ce qui est renseigné dans le champ suivant « Caractères ASCII à conserver ». |
| Caractères ASCII à conserver |
|
Permet de préciser les caractères spéciaux à conserver dans le fichier. Il est possible d’indiquer des intervalles de caractères à conserver en les séparant par des espaces. Exemple : 32|255 = les caractères 32 à 255 inclus seront conservés dans le fichier. |
| Séparateur du fichier CSV |
|
Valeur par défaut « ; » |
| Fenêtre de l'export - Hauteur automatique |
|
Permet de laisser la fenêtre de l’interface d’export en back office s’ajuster automatiquement (en hauteur) à la fenêtre de l’utilisateur. |
| Fenêtre de l'export - Hauteur maximum (en pixels) |
|
Permet de figer la hauteur de la fenêtre de l’interface d’export en pixels. |
| Accessibilité - Taille des champs et boutons |
|
Permet d’augmenter la taille des champs et des boutons utilisés dans l’interface d’export (pour répondre à des contraintes d’accessibilité notamment). |
| Paramétrage du format de fichier en sortie |
||
| Modèle par défaut de tous les types |
|
Permet d’indiquer le modèle par défaut du fichier d’export pour tous les types de contenu. Il suffit d’indiquer les noms techniques ou noms java des champs à intégrer dans le modèle par défaut. |
| Catégorie d'une publication : exporter le nom ou l'id |
|
Permet de choisir, pour les champs de type catégorie, de récupérer dans le fichier d’export le nom ou l’identifiant de la catégorie. |
| Groupe d'une publication : exporter le nom ou l'id |
|
Permet de choisir, pour les champs de type groupe, de récupérer dans le fichier d’export le nom ou l’identifiant du groupe. |
| Publication liée : exporter l'url, le titre ou l'id |
|
Permet de choisir, pour les publications liées à la publication que vous souhaitez exporter, de récupérer dans le fichier d’export l’url, le titre ou l’identifiant de ces publications. |
| Membre d'une publication : exporter le nom + prénom ou l'id |
|
Permet de choisir, pour les membres des publications, de récupérer dans le fichier d’export le nom et prénom ou l’identifiant de chaque membre. |
| Etat de workflow : exporter le nom de l'état ou son numéro |
|
Permet de choisir, pour les états de workflow, de récupérer dans le fichier d’export le nom de l’état ou le numéro de chaque état. |
| Exporter les valeurs booléens au format humain |
|
Permet de choisir, pour les booléens, le format d'export. Si oui, la valeur exportée sera OUI ou NON suivant la langue de l'utilisateur. Si non, ce sera la valeur technique TRUE ou FALSE |
| Paramétrages sur les champs Wysiwyg/Wiki |
||
| Nettoyage automatique des champs wiki / wysiwyg |
|
Permet de nettoyer les champs wysiwyg automatiquement pour récupérer uniquement le texte brut (retrait des mises en forme, image, lien, etc.). |
| Réécrire les liens des champs wiki / wysiwyg |
|
Permet de remplacer les liens vers des contenus JPlatform paramétrés dans les champs wiki et wysiwyg par des liens intégrant l’URL complète vers ces contenus. Ce paramètre ne s’applique pas si « Nettoyage automatique des champs wiki / wysiwyg » est activé. |
| Supprimer les liens des champs wiki / wysiwyg qui ne pointent pas vers un contenu JCMS (liens cassés) |
|
Permet de supprimer tous les liens des champs wiki et wysiwyg qui ne pointent pas vers un contenu JCMS. Cette option est liée à "Réécrire les liens des champs wiki / wysiwyg". Les liens externes ne seront pas supprimés. Ce paramètre ne s’applique pas si « Nettoyage automatique des champs wiki / wysiwyg » est activé. |
| Découper les zones WIKI / WYSIWYG en plusieurs colonnes |
|
Permet de découper les zones wiki et wysiwyg en plusieurs colonnes pour limiter le nombre de caractères par cellule dans Excel. |
| Nombre de caractères avant découpe des zones WIKI / WYSIWYG en plusieurs colonnes |
|
Permet de définir le nombre de caractères avant chaque découpage des champs wiki et wysiwyg (affichage dans la colonne suivante à chaque découpe). Ce paramètre s’applique si « Découper les zones WIKI / WYSIWYG en plusieurs colonnes » est activé. |
| Paramétrage de l'export physique des documents |
||
| Exporter physiquement les documents |
|
Permet de récupérer les fichiers physiques (word, excel, power point, pdf…) attachés aux FileDocument et liés aux publications exportées. |
| Ajouter START_PATH au début du chemin d'accès au fichier des FileDocument |
|
Ce paramètre s’applique si « Exporter physiquement les documents » est activé. Le start_path est un exécutable déployé dans le fichier compressé. Pour qu’il s’exécute correctement, vous devrez préalablement dé-zipper le dossier. Il permet de générer des liens d’accès valides et utilisables dans le fichier csv vers les fichiers physiques (word, excel, power point, pdf…) attachés aux FileDocument et liés aux publications exportées. |
| Ajouter file:// au tout début du chemin d'accès au fichier des FileDocument (hors WIKI / WISYWYG) |
|
Ce paramètre s’applique si « Exporter physiquement les documents » est activé. |
| Paramétrage du lien d'export |
||
| Lien d'export - Activer le déplacement |
|
Si activé, le lien d'export standard JCMS est remplacé par le nouveau lien d’export CSV. Si désactivé, un onglet supplémentaire est ajouté dans l’espace de travail. Les administrateurs peuvent toujours accéder au lien dans l’administration technique de JCMS. |
| Lien d'export standard JCMS - Masquer |
|
Permet de masquer le lien d’export standard affiché dans la liste des contenus. Cette option est applicable si "Lien d'export - Activer le déplacement" est désactivée. |
| Paramétrage export depuis portlet explorer |
||
| Groupe autorisé à faire des exports de documents depuis une portlet explorer | jcmsplugin.exportcsvplugin.fa.export.from.explorer.grp.id.jsp |
Permet de sélectionner un groupe unique autorisé à effectuer des exports depuis l'explorateur de document. |
Exemple de paramétrage
Avec les paramétrages ci-dessous :
| N° |
DESCRIPTION |
| 1 |
Sélection du type de publication à exporter (visible uniquement à l’utilisation du lien disponible dans l’administration technique) |
| 2 |
Liste des données sélectionnées et ordre d’affichage de ces données dans le fichier csv (ordre modifiable via un glisser & déposer) |
| 3 |
Adresse email réceptionnant le fichier d’export |
| 4 |
Choix de ne pas exporter l’historique des publications |
| 5 |
Choix de ne pas mettre à jour le modèle paramétré par défaut par celui-ci |
| 6 |
Sélection des champs du contenu à récupérer dans le fichier csv |
| 7 |
Sélection des dates du contenu à récupérer dans le fichier csv |
| 8 |
Sélection des données de workflow à récupérer dans le fichier csv |
| 9 |
Sélection des métadonnées du contenu à récupérer dans le fichier csv |
Vous obtiendrez dans votre fichier csv généré le format d’affichage suivant :
FAQ
Le bouton d’export du module n’est visible qu’après avoir sélectionner un type de publication particulier dans votre espace de travail.
Notez qu’en fonction du paramétrage du module effectué, le lien d’export peut être affiché à la place du lien d’export natif JCMS dans l’en-tête de liste des contenus, ou en tant qu’onglet complémentaire dans votre espace.
Notez également que vous exporterez la liste des contenus de votre espace de travail qui vous est affichée après avoir sélectionné un type de contenu, et éventuellement après avoir filtrer sur un état du workflow et/ou sur une recherche textuelle :
Dans ce cas, seuls les administrateurs techniques auront accès à l’export (depuis l’administration techniques de JCMS).
Il permet d’exporter les types de publication suivants : contenu, contenu utilisateur, portlet, formulaire.
Non, le lien de téléchargement n’est valable qu’une seule fois. Après votre premier téléchargement, le fichier est automatiquement supprimé, ceci afin d’éviter de surcharger votre serveur.
Pour obtenir le code ASCII d'un caractère ou inversement, un convertisseur est intégré dans le module accessible depuis l'administration fonctionnelle :
Vous avez la possibilité de retrouver le code ASCII associé à un caractère et vice versa :
Change logs
Possibilité de personnalisation du format des dates exportées.
Correctif pour que le résultat de l'export soit téléchargeable qu'on soit redirigé vers le Leader ou le Réplica.
Possibilité de personnalisation du format d'export des booléens
Possibilité de personnalisation du séparateur du fichier CSV
Ajout de la fonctionnalité d'export des fichiers associés aux Documents jPlatform par espace de travail
Correctif pour les types héritant de FileDocument.
Ajout de la personnalisation pour la donnée Espace de travail
Ajout de la possibilité d'exporter les documents depuis l'explorateur de documents.
Le fichier d'export conserve l'ensemble de l'arborescence de catégorie de cet explorateur généré sous forme de dossiers.
- Possibilité de faire des exports de documents depuis le nouveau gabarit des portlets explorateur (style application)
- Possibilité de restreindre l'export des publications à certains pstatus (non plis en compte pour l'export depuis les portlets explorateur)
- Renommer les fichiers exportés avec le nom du FileDocument depuis l'export de documents du backoffice d'un espace de travail ainsi que depuis les portlets explorateur
Ajout de 3 nouveaux champs à l’export :
- Nombre de vues
- Nombre de commentaires
- Nombre de votes.
Cette version ajoute la fonctionnalité :
- Exporter les sous-catégories depuis le PortletExplorer avec son nouveau gabarit suivant le paramétrage du champ "Navigation par catégories exactes"
- Navigation par catégories exactes == OUI
- Export uniquement de la catégorie courante
- Navigation par catégories exactes == NON
- Export de la catégorie courante et de ses sous-categories
- Navigation par catégories exactes == OUI
Cette version améliore la fonctionnalité :
- Export via la sélection d'une ou plusieurs catégories
Ajout d'un nouveau champ à l’export :
- Nombre de vues
Renommage d'un champ :
- Nombre de vues DEVIENT Nombre de lecteurs
Correction anomalie (noSuchMethodException au démarrage de certaines application en fonction des versions de JDK installées) provoquée par ExportCsvUtil --> Méthodes appelées avec un paramètre de type Boolean (objet) alors que c'est un boolean (primitif) qui était attendu.
- Retrait de la limitation du nombre de contenus exportés depuis un PortletExplorer pour les contenus stockés en base de données
- Prise en compte de l'ordre d'affichage du PortletExplorer lors de l'export
- Prise en compte de l'ordre d'affichage du back-office lors de l'export
Glossary
A
ACSII
L'American Standard Code for Information Interchange (Code américain normalisé pour l'échange d'information), plus connu sous l'acronyme ASCII ([askiː]) est une norme de codage de caractères en informatique ancienne. Le jeu de caractères codés ASCII est le principal système qui a permis l'échange de textes en anglais à un niveau mondial, limitant ainsi l'usage des langues locales au travers d'extensions régionales.
ACSII ·
Actions entrantes & actions sortantes
Ces actions sont paramétrables dans les workflows. Elles définissent l’entrée ou la sortie d’un état de workflow. Une action entrante signifie l’arrivée dans un état du workflow (ex : une publication qui est planifié). Une action sortante signifie la sortie d’un état vers un autre (ex : une publication qui passe de l’état planifié vers l’état publié).
Actions entrantes & actions sortantes ·
C
Classe
En programmation orientée objet, une classe définie un ensemble d’objets ayant des attributs communs, et le même ensemble d'opérations.
Classe ·
J
Jsync
Jsync est un moteur de réplication des données et des fichiers. La tâche principale de JSync est de synchroniser les données d'un groupe de serveurs JCMS (aussi appelés réplicas), et de répartir la charge de ces serveurs. Ainsi, toute création, modification ou suppression de données (catégorie, membre, contenu, …) sur l'un des réplicas sera propagée par le réplica leader aux réplicas membres du groupe. JSync assure ainsi la cohérence globale des données d'un groupe de serveur JCMS. Ajouter un lien vers la fiche jsync sur jalios.com.
Jsync ·
L
LOG
Correspond à un historique d’évènements stockés dans un fichier, appelé fichier de log (diminutif de logging), permettant de suivre et repérer toutes activités du site. Les évènements sont horodatés et ordonnés en fonction du temps.
LOG ·
LOG4J
Log4j est une bibliothèque de log en Java. Elle permet entre autres de gérer plusieurs niveaux de log :
- FATAL: utilisé pour journaliser une erreur grave pouvant mener à l'arrêt prématuré de l'application
- ERROR: utilisé pour journaliser une erreur qui n'empêche cependant pas l'application de fonctionner
- WARN: utilisé pour journaliser un avertissement, il peut s'agir par exemple d'une incohérence dans la configuration, l'application peut continuer à fonctionner mais pas forcément de la façon attendue
- INFO: utilisé pour journaliser des messages à caractère informatif (nom des fichiers, etc.)
- DEBUG: utilisé pour générer des messages pouvant être utiles au débogage
- TRACE: utilisé par exemple pour journaliser l'entrée ou la sortie d'une méthode
LOG4J ·
M
MailPolicyFilter
Il s’agit d’un point de débranchement (hook) intervenant lors de l’envoi d’un e-mail dans JCMS. Plus détails ici.
MailPolicyFilter ·
Modale
Fenêtre s'ouvrant dynamiquement généralement pour une action précise : déposer un document, initier une conversation, planifier un événement,... fenêtre appelant une action de l'utilisateur.
Modale ·
N
Notifications email
Il s’agit de notifications transmises par email à un ou plusieurs utilisateurs JCMS. Ces emails permettent d’alerter, informer ou d’envoyer un rappel aux utilisateurs concernant un évènement passé ou à venir, d’une action traitée ou à traiter. Sous JCMS, il existe 3 types de notification : INFO, ACTION, ALERTE.
Notifications email ·
P
Portail
Un portail permet d’agréger et de personnaliser des informations de provenances multiples pour en offrir une vision unique. On distingue les portails documentaires étroitement liés à la gestion de contenu, et les portails d’infrastructure liés à des problématiques d’intégration d’applications.
Portail ·
Portlet
Elément de portail. Il existe différents types de portlets :
- portlets de construction de page
- portlets de contenu (en charge de récupérer et de formater l'information),
- portlets de navigation,
- portlets fonctionnelles,
- portlets de log.
L'assemblage des différents types de portlets permet de construire des gabarits de page portail.
Portlet ·
S
SEO
Le SEO (Search Engine Optimization) signifie en français "Optimisation pour les moteurs de recherche". Ce terme défini l'ensemble des techniques mises en oeuvres pour améliorer la position d'un site web sur les pages de résultats des moteurs de recherche.
SEO ·
Store
Fichier .xml stockant des données sur les publications, les portlets, les espaces de travails, et d'autres fonctionnalités propres à JCMS.
Certaines données de l'application peuvent aussi être stockées en base.
Voir les contenus liés :
- Fiche "Utiliser le store" (fiche Jalios ou Wisen)
- Fiche "Nettoyer le store" (fiche Jalios ou Wisen)
- Autre entrée de glossaire
Store ·
T
Top-bar
La top-bar ou super-header correspond à la barre de menu affichée en haut de page :
Top-bar ·
W
Wiki
Le wiki est une site Web ou page web collaborative dont le contenu peut être modifié par les internautes autorisés.
Wiki ·