Historique

28/03/2018

Historique de composant

L’historique permet d’afficher les modifications qui ont été effectué sur un composant depuis sa création. Cet historique est composé de faits qui comprennent un ensemble des attribuées. Ces faits peuvent être personnalisé dans les deux cotés: par les fichiers de propriétés dans le coté de Core ou par Javascript dans le coté de Gui.

Configuration dans Core

Par défaut, les champs (Field) affichés dans chaque fait comprennent la date de création, la date de modification et le nom de component concerné. Afin d’enrichir les contenus de l’historique, les valeurs des autres champs peuvent être configurées pour afficher dans chaque fait.

Pour cela, il suffit d’ajouter les valeurs de nom des Fields souhaitées à afficher grâce à la propriété facts.fields.classid=field1,field2... dans le fichier de la propriété de côté core.

Exemple: Afficher les valeurs de champs Commentaire et RefClient dans l’historique pour le component de type CourrierEntrant. Il faut ajouter la ligne ci-dessous dans la fichier de propriété de core.

facts.fields.CourrierEntrant=Commentaire,RefClient

Configuration dans Gui

Dans le coté gui, les utilisateurs peuvent personaliser les fait par Javascript (Js). C’est également possible d’ajouter ou supprimer les faits. Grâce à Js, les faits peuvent être modifié à l’aide des fonctions suivantes :

Fonctions Description
Fact(component) Création d’un fait à partir d’un composant
setUser(user) Change l’utilisateur du fait
getUser() Récupère le conteneur d’user du fait
setAction(action) Change l’action du fait
getAction() Récupère le conteneur d’action du fait
setDescription(description) Change la description du fait
getDescription() Récupère la description du fait
setCreationDate(date) Change la date de création du fait
getCreationDate() Récupère la date de création du fait
setUpdatedFields(updatedFields) Change les champs mis à jour du fait
getUpdatedFields() Récupère les mis à jour du fait
addUpdatedField(updatedField) Ajouter le champ mis à jour du fait
addUpdatedFields(resultFields) Ajouter les champs mis à jour du fait

Les types d’action supportés pour les faits sont :

  • CREATE : Création d’un composant
  • UPDATE : Mise à jour d’un composant
  • VERSION : Création d’un composant
  • ADD_CONTENT : Uniquement pour les tâches, ajout d’une pièce jointe
  • DELETE_CONTENT : Uniquement pour les tâches, suppression d’une pièce jointe

Exemple: Créer deux faits par Js

        
        var fact1 = new Fact(component);
        var date1 = new Date("January 15, 2017 11:13:00");
        fact1.setUser(JSAPI.get().getUserAPI().getUserId());
        fact1.setCreationDate(date1.getTime());
        fact1.setAction("UPDATE");
        var field1 = new ResultField();
        field1.setName("RefClient");
        field1.setValue("2018-01-01 12:01:07.006 +0100");
        fact1.addUpdatedField(field1);
        
        var fact2 = new Fact(component);
        var date2 = new Date("January 16, 2017 11:13:00");
        fact2.setCreationDate(date2.getTime());
        fact2.setDescription("Description for fact2");
	 });
	});	

Afin de modifier l’historique d’un composant, il faut s’abonner à son ouverture par le biais de l’API factAPI. La fonction à utiliser est factAPI.register(id, callback), les détails sont dans document.