Exemple d'importation d'une famille avec ses documents associés
Exemple d'importation d'une famille avec ses documents associés
But de ce document
Le but de ce document est de montrer comment créer dans Freedom une famille avec ses documents associés par importation d'un fichier OOo.
Au final, nous allons créer tous ces documents automatiquement en important un simple fichier OOo :
Pré-requis
- Avoir lu le chapitre concernant l'importation/exportation de documents et de familles .
- Savoir créer manuellement et utiliser les documents importés
Conseils pour apprendre à importer des documents
Le plus facile pour apprendre à importer des documents est encore de les créer manuellement dans Freedom et d'utiliser l'outil d'exportation de documents. Ensuite il suffit en général dans OOo de :
- Supprimer les données superflues.
- Remplacer les ID numériques par des ID alphanumériques pour que l'importation soit utilisable sur différentes installations de Freedom.
Créer une famille
Dans ce document, nous allons créer une famille toute simple. Voici sa définition :
| héritage | titre | id | class | name | |||||
|---|---|---|---|---|---|---|---|---|---|
| BEGIN | 0 | Importation famille complète | IMPFAM | ||||||
| TYPE | C | ||||||||
| DFLDID | IMPDIRRACINE | ||||||||
| CVID | IMPCV | ||||||||
| // | idattr | idframe | label | T | A | type | ord | vis | need |
| ATTR | imp_fr | Importation famille complète | N | N | frame | 10 | W | N | |
| ATTR | imp_title | imp_fr | Titre | Y | N | text | 20 | W | Y |
| ATTR | imp_commentaire | imp_fr | Commentaire | N | N | text | 30 | W | N |
Remarques :
- Pour le moment, le contrôle de vue (IMPCV) et le dossier racine (IMPDIRRACINE) n'existent pas, mais nous allons les créer dans les chapitres suivants.
- Il est important de bien renseigner le champ “name”, car le nom de notre famille (IMPFAM) sera utilisé lors de la création des documents liés à la famille dans les chapitres suivants.
Créer un dossier contenant les documents liés à la famille
| dossier(DIR) | <specid> | <fldid> | titre | |
|---|---|---|---|---|
| ORDER | DIR | ba_title | ||
| DOC | DIR | IMPDIR | FLDHOME_1 | Importation famille complète |
Remarques :
- Le seul but de ce dossier est d'y placer tous les documents que nous allons créer pour les retrouver plus facilement.
- Ce dossier sera placé à la racine du dossier “Freedom Master” (FLDHOME_1).
- Il est important d'indiquer l'ID spécifique “IMPDIR” pour pouvoir l'utiliser dans les autres documents.
Attention : Les ID spécifiques indiqués doivent être uniques dans tous les documents de Freedom.
Créer un dossier contenant les documents par défaut de la famille
| dossier(DIR) | <specid> | <fldid> | titre | |
|---|---|---|---|---|
| ORDER | DIR | ba_title | ||
| DOC | DIR | IMPDIRRACINE | IMPDIR | racine de Importation famille complète |
Remarques :
- Il est possible de créer ce dossier automatiquement en mettant “auto” au paramètre “DFLDID” de la famille. Cependant, il est intéressant de créer le dossier manuellement avec un ID spécifique pour pouvoir y placer des documents automatiquement après (ex : les recherches).
- Pour que ce dossier soit bien le dossier par défaut de la famille, il ne faut pas oublier son ID (IMPDIRRACINE) dans le paramètre “DFLDID” de la famille.
- J'ai choisi de placer ce dossier à l'intérieur du dossier précédent mais cela n'est absolument pas obligatoire.
- Une fois ce dossier créé avec la famille correctement paramétrée, il doit être possible d'utiliser notre famille dans le module “ONEFAM”.
Ajouter une référence au document famille dans notre dossier IMPDIR
Le seul but étant d'avoir accès rapidement à notre famille depuis notre dossier :
| () | <specid> | <fldid> | |
|---|---|---|---|
| DOC | IMPFAM | IMPDIR |
Créer des documents pour cette nouvelle famille
Dans certains cas, il peut être intéressant d'avoir quelques documents disponibles dés la création de la famille. Dans notre cas, nous allons créer 3 documents avec chacun un ID spécifique :
| IMPFAM | <specid> | <fldid> | Titre | Commentaire | |
|---|---|---|---|---|---|
| ORDER | IMPFAM | imp_title | imp_commentaire | ||
| DOC | IMPFAM | IMPDOC1 | IMPDIR | Test 1 | Commentaire 1 |
| DOC | IMPFAM | IMPDOC2 | IMPDIR | Test 2 | Commentaire 2 |
| DOC | IMPFAM | IMPDOC3 | IMPDIR | Toto et tutu | Pas de commentaire |
Remarque : Si aucun ID spécifique n'est précisé, à chaque importation du fichier nous aurons 3 nouveaux documents.
Créer une recherche permettant de retrouver les documents de la famille
| recherche(SEARCH) | <specid> | <fldid> | titre | mot-clef | révision | mode | fid amille | |
|---|---|---|---|---|---|---|---|---|
| ORDER | SEARCH | ba_title | se_key | se_latest | se_case | se_famid | ||
| DOC | SEARCH | IMPSEARCH | IMPDIR | Les documents de la famille Importation famille complète | yes | no | IMPFAM |
Remarque : Dans cette recherche, nous avons précisé :
- Un ID spécifique dans la colonne ”<specid>”
- Le dossier ou sera enregistré cette recherche dans la colonne ”<fldid>”
- l'ID spécifique de la famille concernée par la recherche dans la colonne ”<se_famid>”
Attention : Tous ces attributs sont obligatoires pour que l'importation se passe correctement.
Créer des recherches pour le module ONEFAM
Pour qu'une recherche soit disponible dans ONEFAM, il suffit de la placer dans le dossier racine de la famille (IMPDIRRACINE) :
| recherche(SEARCH) | <specid> | <fldid> | titre | mot-clef | révision | mode | fid amille | |
|---|---|---|---|---|---|---|---|---|
| ORDER | SEARCH | ba_title | se_key | se_latest | se_case | se_famid | ||
| DOC | SEARCH | IMPSEARCH2 | IMPDIRRACINE | Titre contient test | test | yes | no | IMPFAM |
Créer un rapport
Il est souvent plus intéressant d'utiliser des rapports à la place des requêtes car il est possible d'indiquer un ordre de tri.
Remarques :
- Je n'ai pas placé l'exemple d'importation des rapports dans le Wiki, car il comporte trop de colonnes pour être lisible. Vous le trouverez dans le fichier OOo indiqué à la fin de ce document.
- Après avoir créé le rapport dans Freedom et l'avoir exporté dans OOo, il faut supprimer les colonnes inutiles et la colonne contenant la requête SQL pour que l'importation fonctionne correctement. Ensuite, il faut remplacer les ID numériques par les ID spécifiques correspondants.
Créer un service portail
Quand nous avons des recherches associées à une famille, il est intéressant de créer des services-portails associés à ces recherches.
Remarques :
- Je n'ai pas placé l'exemple d'importation des services-portails dans le Wiki, car il comporte trop de colonnes pour être lisible. Vous le trouverez dans le fichier OOo indiqué à la fin de ce document.
- Une fois le service-portail et sa recherche associée importés dans Freedom, celui-ci sera disponible sur le portail.
Créer des masques de saisies
Pour notre exemple, nous allons créer deux masque d'éditions et deux masques de consultations :
| masque de saisie(MASK) | <specid> | <fldid> | titre | id familles | attrid | visibilité | obligatoire | |
|---|---|---|---|---|---|---|---|---|
| ORDER | MASK | ba_title | msk_famid | msk_attrids | msk_visibilities | msk_needeeds | ||
| DOC | MASK | IMPMASKV1 | IMPDIR | Masque vue complète | IMPFAM | imp_fr\nimp_title\nimp_commentaire | R\nR\nR | |
| DOC | MASK | IMPMASKV2 | IMPDIR | Masque vue titre | IMPFAM | imp_fr\nimp_title\nimp_commentaire | R\nR\nH | |
| DOC | MASK | IMPMASKE1 | IMPDIR | Masque édition complète | IMPFAM | imp_fr\nimp_title\nimp_commentaire | -\n-\n- | -\n-\n- |
| DOC | MASK | IMPMASKE2 | IMPDIR | Masque édition Titre | IMPFAM | imp_commentaire | H | - |
Remarques :
- Il est possible de créer les masques dans Freedom et de les exporter mais il ne faut pas oublier de remplacer les ID numériques par des ID spécifiques dans les colonnes “FLDID” et “id familles”.
- Il est important d'indiquer des ID spécifiques dans la colonne ”<specid>” pour pouvoir les utiliser dans le contrôle de vues que nous allons créer au chapitre suivant.
Créer un contrôle de vue
Remarque :
- Je n'ai pas placé l'exemple d'importation du contrôle de vues dans le Wiki, car il comporte trop de colonnes pour être lisible. Vous le trouverez dans le fichier OOo indiqué à la fin de ce document.
- Comme pour les autres documents, il est possible de créer le contrôle de vues dans Freedom avant de l'exporter dans OOo mais ensuite il ne faut pas oublier de remplacer tous les ID numériques par des ID spécifiques.
- Pour associer ce contrôle de vues à notre famille, il faut indiquer son ID spécifique au paramètre “CVID” de la famille.
Fichier OOo contenant tous les exemples de ce document
Ce fichier OOo contient tous les exemples d'importation de ce document.
L'importation de ce fichier doit créer automatiquement tous les documents indiqués.
Pour importer des documents en utilisant la ligne de commandes, il est conseillé de lire ce chapitre pour avoir plus d'explications sur l'utilisation de scripts dans Freedom.
Mais en résumé, voici la commande qu'il faut utiliser pour importer des documents dans Freedom :
/usr/share/what/wsh.php --api=freedom_import --file=VotreFichier.ods
Remarque : Vous pouvez importer directement un fichier OpenOffice.org .ods ou un fichier .csv
