Les actions tracées dans l’historisation sont listées dans l’objet eventtype.
- Création de contenu
-
Ajouter l’étiquette wxm/historize dans la configuration de l’objet adéquat
- Modification de contenu
-
Ajouter l’étiquette wxm/historize dans la configuration de l’objet adéquat
- Changement de statut
-
Ajouter l’étiquette wxm/historize dans la configuration de l’objet adéquat
- Demande de la version PDF d’un monodoc
-
Ajouter l’étiquette wxm/historize dans la configuration de l’objet monodoc
- Demande de la version INDD d’un monodoc
-
Ajouter l’étiquette wxm/historize dans la configuration de l’objet monodoc
- Imposition / Proposition d’une mise à jour d’un contenu dans un projet
-
Ajouter l’étiquette wxm/historize dans la configuration de l’objet mediasharing
- Acceptation d’une proposition de mise à jour d’un contenu dans un projet
-
Ajouter l’étiquette wxm/historize dans la configuration de l’objet mediasharing
- Checkin
-
Ajouter l’étiquette wxm/historize dans la configuration de l’objet qui doit
lui-même avoir un champ ischeckedout
- Checkout
-
(Ajouter l’étiquette wxm/historize dans la configuration de l’objet qui doit
lui-même avoir un champ ischeckedout
- Création / Modification / Suppression d’un post-it
-
Ajouter l’étiquette wxm/historize dans la configuration de l’objet stickynote
- Création / Modification / Suppression d’un commentaire
-
Ajouter l’étiquette wxm/historize dans la configuration de l’objet contentcomments
|
Tip
|
Pour ne pas tracer une de ces actions dans l’historisation, il suffit de
désactiver l’instance de l’objet eventtype qui lui correspond
OU de supprimer l’étiquette wxm/historize dans la configuration
de l’objet concerné.
|
Exemples
L’objet monodoc doit avoir l’étiquette wxm/historize dans sa configuration
et l’étiquette wxm/historize/archive sur son champ compofile.
L’objet creativedoc doit avoir l’étiquette wxm/historize dans sa
configuration et l’étiquette wxm/historize/archive sur son champ file.
Les objets stickynote, contentcomments et mediasharing se
contenteront de l’étiquette wxm/historize dans leurs configurations.
Plugin WXM_History
Les paramètres de ce plugin sont :
- enableForActions
-
Actions pour lesquelles l’onglet "Historique" s’affiche
- enableForObjects
-
Objets pour lesquelles l’onglet "Historique" s’affiche (liste des objets concernés par les événements)
- typeOfRepresentation
-
Type d’affichage de l’historique. L’historique peut s’afficher en mode "liste paginée", "timeline", ou dans les deux modes au choix.
- pagination
-
Nombre d’événements par page dans l’affichage en mode "liste paginée".
- typeOfArchive
-
Type des archives pour les documents de type .indd ou .wedia.
Etiquettes
Plusieurs étiquettes sont utilisées :
- wxm/historize
-
A ajouter dans la configuration d’un objet. Permet de tracer l’objet.
- wxm/historize/text
-
A ajouter sur un seul champ de type "word" ou "sentence" de l’objet tracé. C’est ce champ qui sera stocké dans l’événement. Depuis la version 10.5.0, il est possible d’ajouter cette étiquette à plusieurs champs, quel que soit leur type (SAUF collection). Dans le cas d’un champ internationalisé, il faudra placer l’étiquette sur tous les champs et pas seulement sur le champ principal.
- wxm/historize/archive
-
A ajouter sur un seul champ de type "file" ou "image" de l’objet tracé. Si le champ "keepanarchive" de l’événement est à "oui", alors le fichier sera stocké dans l’événement.
- wxm/historize/stop
-
A ajouter sur un seul champ de type "child" sur "activated" (Depuis la version 11.4.2 du moteur). Si la valeur de ce champ est égale à 1, l’historisation sera stoppée sur l’instance concernée.
Object Event
C’est dans cet objet que sont stockées toutes les actions tracées pour l’historisation.
Les champs principaux sont les suivants :
- type
-
Type de l’événement
- object
-
Nom de l’objet tracé
- archive
-
Fichier archivé lors de la création de l’événement
- objectname
-
Nom de l’objet concerné par l’événement
- objectid
-
ID de l’objet concerné par l’événement
- workflowname
-
Nom du workflow de l’objet tracé
- statusbefore
-
Statut précédent de l’objet tracé (stocké en cas de modification de statut)
- statusafter
-
Statut courant de l’objet tracé
- media
-
Media de l’événement
- date
-
Date de l’événement
- mediagroup
-
Mediagroup de l’événement (depuis la 10.5.0)
- updates
-
flux json des champs modifiés (depuis la 10.5.0)
Object Eventtype
Cet objet liste les types d’action tracées pour l’historisation.
Les champs sont les suivants :
- name
-
Code de l’action
- icon
-
Icône de l’action
- keepanarchive
-
Dans certains cas, on veut pouvoir conserver (dans le champ "archive" de l’objet "event") une archive du document concerné
Tracer un nouvel événement dans le cadre d’un projet
Pour tracer un événement qui n’est pas dans la liste des événements tracés par le produit, voici la marche à suivre :
-
Ajouter et activer une instance dans l’objet eventtype :
-
Attention : le champ name ne doit contenir ni espaces, ni caractères spéciaux
-
Il est possible de garder une archive d’un objet lors de l’enregistrement d’un événement de ce type, pour cela, il suffit de cocher la case keepenarchive -→ dans l’objet concerné par ce type d’événements, il faut ajouter l’étiquette wxm/historize/archive à un seul champ de type file ou image dans la structure
-
Ajouter les traductions de l’intitulé de cette nouvelle instance dans des fichiers bundles spécifiques au projet, avec la clef pln_historize_event_<eventtype_name>.
-
Ajouter le nom de l’objet concerné par l’événement dans le paramètre enableForObjects du plugin
-
Ajouter l’étiquette wxm/historize sur l’object concerné par l’événément
-
Faire appel à com.wedia.wxm.services.interfaces.IWxmHistorize et com.wedia.wxm.services.WxmHistorize. Il existe plusieurs méthodes createEvent (cf Javadoc)
Considérations techniques
Il faut faire une différence entre objet tracé et objet concerné
par l’événement.
L’objet tracé est celui sur lequel on se base pour créer un événement,
alors que l'`objet concerné par l’événement` est l’objet dans lequel
apparaîtra l’événement.
Souvent, il s’agit du même objet.
