Ajout d'un champ sur un objet

Description

Ce module permet de définir un champ à ajouter dans un formulaire.

Paramétrage

Les paramètres suivants doivent être définis :

Les paramètres suivants sont optionnels:

Nom du champ

Le nom du champ correspond au paramètre field_name. Par défaut il prend la valeur 'extra_data'.

Attention à l'unicité de la valeur !

La descriptionp

Par défaut, la description du champ dynamique correspond au Nom du champ précédée de la mention 'extra_data:'' . Il est possible d'en spécifier un différent via le paramètre description.

Type de la valeur

Le type du champ correspond au paramètre type. Par défaut il prend la valeur 'text' et déterine la méthode de stockage en BDD. On peut choisir 'int', 'float', text, 'date'.

Type du champ

Le type du champ correspond au paramètre field_type. Par défaut il prend la valeur 'text' et déterine le type du champ afficher à l'utilisateur dans le formulaire. On peut choisir 'int', 'float', 'text', 'date'.

Alias du champ de fusion

Par défaut, le champ de fusion dans les lettres types correspond au Nom du champ. Il est possible d'en spécifier un différent via le paramètre alias_champ_fusion.

Longueur maximale

La longueur maximale de l'élément saissisable dans le champ dynamique. Par défault 255 caractère dans le cadre d'un 'text', ou 5 chiffre dans le carde d'un 'int'. Il est possible d'en spécifier un différent via le paramètre max_length.

Afficher dans le listing

Par défaut, le champ afficher dans le listing est à FALSE. Il est possible de le spécifier via le paramètre show_in_listing. Le champ apparaitra, alors dans le listing.

Afficher dans la recherche

Par défaut, le champ afficher dans la recherche est à FALSE. Il est possible de le spécifier via le paramètre searchable. Le champ apparaitra, alors dans les options de la recherche sur l'objet.

Objet auquel ajouter le champ

Il est possible de le spécifier via le paramètre object_name. Si ce nom est défini dans les paramètres du module, alors il à la précédence. Ensuite si un objet métier (om_dbform) a été associé à ce module, alors celui-ci est revoyé. Enfin, si un objet "lien" est associé à ce module, alors c'est le nom de l'objet défini dans l'objet "lien" qui est utilisé.

Validation de la valeur

Il est possible de le spécifier via le paramètre validator_cb. ['module/object', 'fucntion_name']

Ordre

Sur le formulaire de paramétrage dans le champ ordre, il est possible de saisir un nombre. Ce nombre représente l'ordre de priorité de déclenchement du module. Ainsi un module d'ordre 1 sera traité avant un module d'ordre 2.

Exemple de paramétrage :

            field_name=Test Field A\n
            alias_champ_fusion=test_field_A\n
            description=Extra data Test Field A\n
            type=text\n
            field_type=text\n
            max_length=50\n
            show_in_listing=false\n
            searchable=false\n
        

Exemple de paramétrage :

            field_name=Test Field B\n
            type=int\n
            field_type=int\n
            show_in_listing=true\n
            searchable=true\n
        

Usage

Fonctionnement

Exemple d'utilisation

Cas d'usage

Paramétrage

Je me rend dans le menu paramétrage dossiers > workflows > événement, je cherche l'événement Notification et j'accède à sa page de consultation. Depuis cette page, je clique sur l'onglet Modules.

Je paramètre ensuite le module Ajout d'un champ sur un objet en lui donnant pour ordre 1 et en remplissant les paramètres :

                    field_name=Test Field A\n
                    alias_champ_fusion=test_field_A\n
                    description=Extra data Test Field A\n
                    type=text\n
                    field_type=text\n
                    max_length=50\n
                    show_in_listing=false\n
                    searchable=false\n
                

Lettre Type

Je me rend dans le menu paramétrage dossiers > éditions > lettre type, je cherche la lettre type arrêté et j'accède à sa page de modification.

J'ajoute ensuite le champ de fusion [test_field_A] dans la lettre type.

Formulaire

J'ajoute sur mon dossier à l'instruction Notification. Et je constate la présence du champ.

Visualisation du document

J'accède ensuite sur mon dossier à l'instruction Notification. Et j'ouvre le document édité.