Page Comparison

Le module d’historisation permet de tracer divers types d’actions et de les visualiser sous forme de liste paginée ou bien de timeline.

Onglet historique

Image Removed

Qu’est-ce qui peut être tracé ?

les objets
les modifications de propriétés
les événements

Note	les valeurs avant et après sont enregistrées uniquement lorsqu’elles sont tagguées. Si ce n’est pas le cass seule une information générale de modification sera signalée.

Activer l’historisation

S’assurer de la présence des objets event et eventtype, et activer/désactiver les instances souhaitées de eventtype
Ouvrir la page de configuration des plugins
1. Activer le plugin WXM_Historize
2. Onglet paramètres : indiquer les objets à historiser dans le champs "EnableforObjects"
  Image Removed
Aller sur la structure de l’objet (Administration > Gestion des structures)
1. Choisir une propriété
2. Cliquer sur l’onglet étiquettes
3. Ajouter l’étiquette wxm/historize/text
  Image Removed
4. Répéter l’opération sur les autres propriétés à historiser.
  → les champs localisés (i18n) doivent également être étiquettés.

Actions tracées

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é

.pdf OU .wedia dans le cas d’un fichier de type .indd ou .wedia
format d’origine dans les autres cas

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

...

The historization module allows you to trace various types of actions and to record them in the following ways view as a paginated list or as a timeline.

Tab History

Image Added

What can be tracked?

Objects
Properties
Events

Note	The values before and after are logged, if the requested properties are tagged. Otherwise there is general information about a modification only.

Enable historiography

Ensure that the event and eventtype objects are present, and enable/disable the desired instances of eventtype.
Open the administration view and click on Plug-in Manager
1. Activate the plug-in WXM_Historize
2. Parameters tab: Define in the EnableforObjects field the relevant objects
  Image Added
Go to object (Administration > Object Management)
1. Choose property
2. Click on tab tags
3. Add wxm/historize/text tag
  Image Added
4. Repeat the steps for each other property that should be tracked
  ⇒ every localized field has to be tagged as well

Types of events tracked in the system

Actions plotted in the history are listed in the eventtype object.

Content creation	Add the `wxm/historize` label to the proper object configuration
Content modification	Add the `wxm/historize` label to the proper object configuration
Change of status	Add the `wxm/historize` label to the proper object configuration
Request a PDF version of a monodoc	Add the `wxm/historize` label to the `monodoc` object configuration
Request INDD version of a monodoc	Add the `wxm/historize` label to the `monodoc` object configuration
Imposition / Proposal to update content in a project	Add the `wxm/historize` label to the `mediasharing` object configuration
Acceptance of a proposal to update content in a project	Add the `wxm/historize` label to the `mediasharing` object configuration
Checkin	Add the `wxm/historize` label to the object configuration that must itself have an `ischeckedout` field
Checkout	Add the `wxm/historize` label in the configuration of the object that should itself have an `ischeckedout` field
Creating / Editing / Deleting a Post-it	Add the `wxm/historize` label to the `stickynote` object configuration
Creating / Editing / Deleting a comment	Add the `wxm/historize` label to the `contentcomments` object configuration

Tip	To avoid tracing one of these actions in the history, it is enough to disable the instance of the `eventtype` object corresponding to it OR to delete the `wxm/historize` label in the configuration of the object concerned.

Examples

The monodoc object must have the wxm/historize label in its configuration and the wxm/historize/archive label on its compofile field.

The creativedoc object must have the wxm/historize label in its tag and the wxm/historize/archive label on its file field.

The stickynote, contentcomments and mediasharing objects are used in the following ways will contain the wxm/historize label in their configurations.

WXM_History plugin

The parameters for this plugin are:

enableForActions	Actions for which the "History" tab is displayed
enableForObjects	Objects for which the "History" tab appears (list of objects concerned by events)
typeOfRepresentation	Type of history display. The history can be displayed in "paginated list","timeline"mode, or in both modes.
pagination	Number of events per page in the display in "paginated list"mode.
typeOfArchive	Type of archive for .indd or .wedia documents.

Labels

Several labels are used:

wxm/historize	To be added in the configuration of an object. Allows you to trace the object.
wxm/historize/text	To be added on a single field of type "word" or "sentence" of the plotted object. This is the field that will be stored in the event. Since version 10.5.0, it is possible to add this label to several fields, regardless of their type (EXCEPT collection). In the case of an internationalized field, the label should be placed on all fields, not just the main field.
wxm/historize/archive	To be added on a single field of type "file" or "image" of the plotted object. If the "keepanarchive" field of the event is "yes", then the file will be stored in the event.
wxm/historize/stop	To be added on a single field of type "child" on "activated" (Since version 11.4.2 of the engine). If the value of this field is equal to 1, the historization will be stopped on the concerned instance.

Object Event

It is in this object that all the actions traced for the historization are stored.

The main fields are as follows:

type	Type of event
object	Name of the plotted object
archive	Archived file when creating the event
objectname	Name of the object concerned by the event
objectid	ID of the object concerned by the event
workflowname	Workflow name of the plotted object workflow
statusbefore	Previous status of the trace object (stored if status change occurs)
statusafter	Current status of the plotted object
media	Media of the event
date	Date of the event
mediagroup	Mediagroup of the event _ (since 10.5.0)_
updates	json flux of modified fields _ (since 10.5.0)_

Object Event type

This object lists the action types drawn for historizing.

The fields are as follows:

name	Action Code
icon	Icon of the action
keepanarchive	In some cases, you want to be able to keep (in the "archive" field of the "event"object) an archive of the document concerned. `.pdf` or `.wedia` in the case of a .indd or .wedia file. Original format in other cases

Track a new project event

To track an event that is not in the list of events plotted by the product, follow the steps below:

Add and enable an instance in the eventtype object:
- Warning: the name field must not contain spaces or special characters.
- It is possible to keep an archive of an object when recording an event of this type, for that, it is enough to check the box keepenarchive ⇒ in the object concerned by this type of events, it is necessary to add the label wxm/historize/archive to a single field of type file or image in the structure
- Add translations of the title of this new instance in bundle files specific to the project, with the key 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.wediaAdd the name of the object concerned by the event in the enableForObjects parameter of the plugin
Add the wxm/historize label to the object concerned by the event.
Use com.wedia.wxm.wxm.services.interfaces.IWxmHistorize et and com.wedia.wxm.services.WxmHistorize. Il existe plusieurs méthodes There are several methods createEvent (cf see 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

Technical considerations

A distinction must be made between traced object and object concerned by the event.

The traced object is the one on which we base ourselves to create an event, whereas the object concerned by the event is the object in which will appear the event.

Often, it is the same object.

Versions Compared

Old Version 3

New Version 4

Key

Onglet historique

Activer l’historisation

Actions tracées

Plugin WXM_History

Etiquettes

Object Event

Object Eventtype

Tracer un nouvel événement dans le cadre d’un projet

Tab History

Enable historiography

Types of events tracked in the system

WXM_History plugin

Labels

Object Event

Object Event type

Track a new project event

Considérations techniques

Technical considerations