Paramétrage
Une fois le module mFI installé, l'interface de paramétrage est accessible depuis Configuration > APIs myfab (tout en bas de la liste déroulante sur la gauche de l'écran.
Paramétrage Exports fichiers
1. Configuration générale Export
La première étape consiste à créer un nouvel Export. Pour cela cliquer sur le bouton "Créer".
À l’arrivée sur la vue formulaire de l’export, on distingue de haut en bas deux parties distinctes :
- La zone de configuration, qui contient les champs permettant d’indiquer quels enregistrements on souhaite exporter, dans quel dossier, sous quel format, etc.
- La zone de monitoring, qui permet d’avoir une visualisation des fichiers présents dans le dossier d’export (une fois celui-ci configuré), ainsi qu’un historique des exports réalisés.
On peut désormais saisir un nom pour l'Export.
Puis, créer le répertoire dans lequel les exports vont se déverser. Ce répertoire correspond à un dossier physique sur la machine virtuelle Open-Prod. S’il n’existe pas, il sera créé.
2. Configuration fichier d'export
Dans l'onglet "Fichier" on peut paramétrer :
- Le format d’export (entre JSON, CSV et TXT).
- Le caractère de séparation (uniquement en CSV).
- Le caractère de quoting (uniquement en CSV et TXT).
- Une extension personnalisée (ex : si on échange des fichiers avec un MES, celui-ci attend du CSV avec pour extension .xcsv, il faut donc configurer une extension personnalisée xcsv).
- La génération physique des fichiers ou non (pour tester sans générer de fichiers sur le serveur).
Ne pas oublier d'activer la génération physique des fichiers si l'on souhaite aller au delà des tests.
3. Configuration du modèle à exporter
De retour dans la configuration principale, ajouter un modèle à exporter. Choisir le modèle désiré (dans notre exemple, "res.partner", puis comme indiqué, cliquer sur "Sauvegarder & fermer", puis sauvegarder le formulaire en entier avant d’aller plus loin.
4. Configuration des champs du modèle à exporter
Retourner en modification de l'export, puis cliquer sur le modèle à exporter. Le formulaire ci-dessous s'affiche. Il permet de modifier le modèle et les champs du modèle ainsi que les modèles enfants (cf paramétrage avancé). Cliquer sur le bouton "Ajouter un élément" pour ajouter un champ à exporter.
Un nouveau formulaire s'affiche. Il liste tous les champs du modèle choisi. Sélectionner le ou les champ(s) à exporter puis cliquer sur le bouton "Sélectionner". Sauvegarder à nouveau l'entièreté de l'export pour valider les modifications.
A ce stade le module est prêt pour réaliser des exports de données.
5. Paramétrage de l'exécution automatique des exports
Se référer au paramétrage avancé.
6. Options de filtrage
6.1. Filtrage des enregistrements à exporter
Une fois les modèles et champs à exporter sélectionnés, il est possible d'appliquer des filtres qui s'appliqueront lors de l'export. Pour cela, retourner en modification sur le modèle à exporter puis cliquer sur l'onglet "Filtrage".
Deux solutions de filtrage sont possibles :
-
- Affecter une limite de nombre d’enregistrements à exporter (exemple : je ne veux exporter que dix éléments).
- Affecter un filtre spécifique sur un champ du modèle (exemple : je ne veux exporter que les enregistrements qui ont pour nom "Toto").
6.2. Filtrage sur champ
Pour ajouter un filtre sur un champ du modèle, cliquer sur "Ajouter un élément".
Cliquer sur "Chercher plus" dans la liste déroulante pour afficher la liste des champs. Dans le formulaire "Champ à filtrer", sélectionner le ou les champs qui vont servir à appliquer un filtre.
6.3. Opérateurs de comparaison
Quand le champ à filtrer est sélectionné, choisir parmi la liste déroulante l'opérateur de comparaison et noter la valeur de comparaison. Dans l'exemple qui suit, le filtre permettra de ne sélectionner que les partenaires ayant pour nom "toto", sans tenir compte de la casse (c'est à dire qu'il ne tient pas compte de la majuscule). Attention à bien sauvegarder l'entièreté des formulaires avant de poursuivre.
Voir ci-dessous une description des opérateurs de comparaison disponibles.
| Opérateur de comparaison | Usage | Description |
|---|---|---|
| like | [('input', 'like', 'open')] | Renvoie les résultats contenant le texte recherché - sensible à la casse (caractères génériques - '%open%'). Ex : open, opensource, openerp, Odooopenerp |
| not like | [('input', 'not like', 'open')] | Renvoie les résultats ne contenant pas le texte recherché - sensible à la casse (caractères génériques - '%open%'). Ex : Openerp, Opensource, Open, Odoo, odoo, OdooOpenerp |
| =like | [('name', '=like', 'open')] | Renvoie les résultats contenant exactement le texte recherché (='open') - sensible à la casse Ex : open |
| ilike | [('name', 'ilike', 'open')] | Renvoie les résultats contenant le texte recherché - insensible à la casse (caractères génériques - '%open%'). Ex : Openerp, openerp, Opensource, opensource, Open, open, Odooopenerp, OdooOpenerp |
| not ilike | [('name', 'not ilike', 'open')] | Renvoie les résultats ne contenant pas le texte recherché - insensible à la casse (caractères génériques - '%open%'). Ex : Odoo, odoo |
| =ilike | [('name', '=ilike', 'open')] | Renvoie les résultats contenant exactement le texte recherché (='open') - insensible à la casse Ex : Open, open |
| in | [('value1', 'in', ['value1', 'value2'])] | L'opérateur "in" vérifiera que la valeur1 est présente ou non dans la liste des termes de droite |
| not in | [('value1', 'not in', ['value2'])] | L'opérateur "not in" vérifiera que la valeur1 est absente dans la liste des termes de droite |
| = | [('input', '=', 'open')] | Renvoie les résultats contenant exactement la valeur recherchée (='open') - sensible à la casse Ex : open |
| != | [('input', '!=', 'open')] | Renvoie les résultats qui ne correspondent pas à l'entrée donnée (autre que - 'open'). Ex : tous les autres enregistrements que 'open' |
| > | [('input', '>', '10')] | Renvoie tous les résultats plus grands que la valeur entrée (toutes les valeurs plus grandes que la valeur - '10'). Ex : 11, 12, 13... |
| >= | [('input', '>=', '10')] | Renvoie tous les résultats plus grands ou égaux que la valeur entrée. Ex : 10, 11, 12, 13 |
| < | [('input', '<', '10')] | Renvoie tous les résultats plus petits que la valeur entrée (toutes les valeurs plus petites que la valeur - '10'). Ex : 9, 8, 7… |
| <= | [('input', '<=', '10')] | Renvoie tous les résultats plus petits ou égaux que la valeur entrée Ex : 10, 9, 8, 7… |
Paramétrage Imports Fichiers
1. Configuration générale Import
La première étape consiste à créer un nouvel Import. Pour cela cliquer sur le bouton "Créer".
Comme pour l'export, on peut voir les deux parties "Configuration" et "Monitoring".
- Saisir un nom pour l'Import.
- Puis, sélectionner ou créer le répertoire dans lequel seront déposés les fichiers à importer. Ce répertoire correspond à un dossier physique sur la machine virtuelle Open-Prod. S’il n’existe pas, il sera créé.
2. Configuration fichier d'export
Dans l'onglet "Fichier" on peut paramétrer :
- Le format ou l'extension du fichier d’import (entre JSON, CSV et TXT).
- Le type d'encodage entre UTF-8 ou CP1252.
Une application tierce ou un utilisateur peuvent désormais déposer sur ce répertoire des fichiers à importer dans Open-Prod. Les imports seront réalisés en cliquant sur le bouton "Lancer" ou par l'exécution automatique via un cron.
3. Paramétrage de l'exécution automatique des imports
Se référer au paramétrage avancé.