# myFAB Tools Bibliothèque de fonctions et de méthodes packagées par 1Life à mettre en œuvre pour votre paramétrage avancé d'Open-Prod. # Règle générale Globalement, et pour chaque méthode utilisable et présente dans **myfab Tools**, il faut passer par une instance du modèle **mf.tool** pour pouvoir appeler et utiliser ces méthodes. Par exemple : self.env\["mf.tools"\].mf\_get\_file\_name\_extension(file\_to\_convert\_name) Dans le cas où il y a besoin d'utiliser plusieurs fois les "tools" dans la même méthode ou la même action serveur, on peut mettre l'instance dans une variable. Par exemple : tools = self.env\["mf.tools"\] if self.mf\_protocol == "ftp": return tools.mf\_login\_to\_ftp(mf\_ftp\_adress,mf\_login,mf\_password) elif self.mf\_protocol == "sftp": return tools.mf\_login\_to\_sftp(mf\_ftp\_adress,mf\_login,mf\_password Les pages suivantes présentent des exemples d'utilisation des différents outils mis à disposition dans le module **myfab Tools**. # Gestion de fichier Le tableau ci-dessous reprend les différentes méthodes utilisables, avec un exemple et une description ainsi que les données d'entrée et de sortie attendues.
**Méthode / Exemple****Données d'entrée****Données de sortie**
**mf\_get\_file\_name\_extension(file\_name)** if self.env\["mf.tools"\].mf\_get\_file\_name\_extension(file\_to\_convert\_name) in \['CSV','TXT'\]: *Dans ce cas-là on s’en sert pour vérifier si l’extension du fichier est CSV ou TXT pour faire un traitement spécifique pour ces fichiers.* Prend une chaine de caractères en entrée qui est un nom de fichier. Retourne une chaine de caractères qui a pour valeur l’extension de nom de fichier qui a été passé en entrée.
**mf\_get\_file\_name\_without\_extension (file\_name)** xlsx\_file\_name = self.env\["mf.tools"\].mf\_get\_file\_name\_without\_extension(file\_to\_convert\_name) + '.XLSX' Prend une chaine de caractères en entrée qui est un nom de fichier.Retourne une chaine de caractères qui a pour valeur le nom de fichier sans l’extension.
**create\_then\_go\_to (folder)** *Créer le dossier si besoin puis déplace le curseur dedans.* Prend une chaine de caractères en entrée qui est un chemin absolu ou relatif vers un dossier qui existe ou non.Ne retourne rien.
**save\_file (file\_name,file\_content)** *Créer le fichier avec le nom et le contenu fourni.* Prend en entrée une chaine de caractères qui représente le nom du fichier avec son extension et une chaine caractères avec le contenu du fichier.Ne retourne rien.
**save\_file\_as\_document (file\_name,file\_content,record)** *Crée un document Open-Prod puis le lie avec la donnée passée en paramètre s’il y a un champ vers le modèle document.openprod.* Prend en entrée une chaine de caractères qui représente le nom du fichier avec son extension et une chaine de caractères avec le contenu du fichier et la donnée sur laquelle lier le document (non obligatoire).Retourne l’objet document qui a été créé.
**Exemple action serveur pour imprimer un BL dans un fichier (avec le modèle jasper ayant l'ID=100)** [![image.png](https://docs.myfab.fr/uploads/images/gallery/2024-09/scaled-1680-/hhqimage.png)](https://docs.myfab.fr/uploads/images/gallery/2024-09/hhqimage.png) # Gestion FTP / SFTP / FTS TLS #### 1. Protocole FTP Standard Toutes les méthodes FTP fonctionnent globalement sur le même principe, aussi seules les méthodes pour le FTP standard sont explicitées ci-dessous.
**Méthode / Exemple****Données d'entrée****Données de sortie**
**mf\_login\_to\_ftp(ftp\_adress,login,password)** Prend en entrée une adresse FTP, le login et le mot de passe qui sont tous des chaines de caractères. Retour une instance de la connexion ftp qui sera utilisée par les méthodes suivantes.
**mf\_ftp\_move\_to\_folder(ftp,folder)** Prend en entrée une instance de connexion FTP et une chaine de caractères qui représente le dossier dans lequel on souhaite déplacer le curseur.Ne retourne rien.
**mf\_send\_file\_to\_ftp(ftp,file\_name,delete)** Prend en entrée une instance de connexion FTP, une chaine de caractères qui représente le nom fichier local que l’on souhaite envoyer sur le serveur distant et un booléen qui sert à indiquer si l’on souhaite supprimer le fichier une fois l’envoi fait.Ne retourne rien.
**mf\_quit\_ftp(ftp)** *Ferme la connexion FTP.* Prend en entrée une instance de connexion FTP.Ne retourne rien.
**mf\_ftp\_get\_all\_files(ftp,delete)** *Crée un document openprod puis le lie avec la donnée passée en paramètre s’il y a un champ vers le modèle document.openprod.* Prend en entrée une instance de connexion FTP et un booléen qui sert à indiquer si l’on souhaite supprimer les fichiers du serveur distant une fois qu’ils ont été récupérés.Retourne une liste avec tous les noms des fichiers récupérés.
Exemple d'utilisation d'une connexion FTP : ftp = tools.mf\_login\_to\_ftp(adress,login,password) tools.mf\_ftp\_move\_to\_folder(ftp,folder) tools.mf\_send\_file\_to\_ftp(ftp, str(self.number)+".csv",True) #### 2. Protocole FTP TLS Le protocole FTP TLS utilise les mêmes méthodes que le FTP standard sauf pour le login : **mf\_login\_to\_ftp\_tls(ftp\_adress,login,password)** #### 3. Protocole SFTP Variantes de méthodes propres au protocole SFTP : - **mf\_login\_to\_sftp(sftp\_adress,login,password)** - **mf\_sftp\_move\_to\_folder(sftp,folder)** - **mf\_send\_file\_to\_sftp(sftp,file\_name,delete)** - **mf\_sftp\_get\_all\_files(sftp,delete)** - **mf\_sftp\_get\_file\_by\_name(sftp,file\_name, delete)** # Impressions Jasper Via la méthode ci-dessous, on peut manipuler l'impression de documents Jasper :
**Méthode / Exemple****Données d'entrée****Données de sortie**
**mf\_print\_report(report\_id,record)** Prend en entrée un enregistrement du modèle jasper.report et la donnée à partir de laquelle on veut imprimer le document. Retourne le contenu du rapport PDF en chaine de caractère, le format du document imprimé (PDF) et le nom du modèle du rapport.
Combiné avec la méthode de sauvegarde de fichier ci-dessus on peut créer un fichier pdf sur le serveur local. Exemple d'utilisation : report\_file, report\_format, model\_report = tools.mf\_print\_report(config.mf\_invoice\_report\_to\_print,invoice) tools.save\_file(invoice.number.replace("/","\_")+".pdf",report\_file) **Exemple action serveur pour imprimer un BL dans un fichier (avec le modèle jasper ayant l'ID=100)** [![image.png](https://docs.myfab.fr/uploads/images/gallery/2024-09/scaled-1680-/hhqimage.png)](https://docs.myfab.fr/uploads/images/gallery/2024-09/hhqimage.png) # Création/Manipulation de fichier XML Les méthodes suivantes permette de créer et manipuler les fichiers XML . Cela peut par exemple servir pour exporter un fichier XML à partir de données d'Open-Prod depuis une action serveur par exemple.
**Méthode / Exemple****Données d'entrée****Données de sortie**
**mf\_get\_lxml\_libary()** Exemple : lxml = env\['mf.tools'\].mf\_get\_lxml\_libary() etree=lxml.etree -- Retourne la librairie lxml
**lxml\_element\_get\_text(xml)** Objet Element de la la librairie etreeTexte de l'objet Element donnée en paramétre
**lxml\_element\_get\_tag(xml)** Objet Element de la la librairie etreeNom de l'objet Element donnée en paramétré
**lxml\_element\_set\_text(xml,text)** Objet Element de la la librairie etree ,Texte à mettre dans la balise Objet Element modifié
**lxml\_element\_set\_ta(xml,tag)** Objet Element de la la librairie etree ,Nom à affecter à la balise Objet Element modifié
Exemple : dans une action serveur ```python tools = env['mf.tools'] etree = tools.mf_get_lxml_libary().etree data_xml_de_base=""" OPP QUBES 2010-07-22T11:20:33 ItemsDefinition Material classes and material definitions for all the items 2010-07-22T11:20:33 """ xml=etree.fromstring(data_xml_de_base) #incrément auto à chaque export : sequence code ITEM_QUBES res=env['ir.sequence'].next_by_code('ITEM_QUBES') BODID=etree.SubElement(xml,'BODID') # crée balise BODID dans la balise root du xml tools.lxml_element_set_text(BODID,res) #affecte valeur texte à la balise créé #Ajoute une balise article pour chaque produit en vie avec une sous balise id et description MaterialInformations= xml.xpath("//MaterialInformation") article_rcs=env['product.product'].search([('state','=','lifeserie')]) for MaterialInformation in MaterialInformations: for article_rc in article_rcs: # créer une sous balise MaterialDefinition dans MaterialInformation MaterialDefinition=etree.SubElement(MaterialInformation,'MaterialDefinition')# crée balise MaterialDefinition # Créer balise ID avec la valeur -> code codep=etree.SubElement(MaterialDefinition,'ID') tools.lxml_element_set_text(codep,article_rc.code) # Créer balise Description avec la valeur -> name codep=etree.SubElement(MaterialDefinition,'Description') tools.lxml_element_set_text(codep,article_rc.name) #Récupère le contenu en texte file_content=etree.tostring(xml) #sauvegarde le text dans fichier sur le serveur env['mf.tools'].save_file("/home/openprod/Documents/toto.xml",file_content) #affiche le contenu #raise Warning(etree.tostring(xml)) ``` # Traitement BL mf_do_partial_picking Cette méthode permet de traite un picking en précisant les ids des lignes à traiter ainsi que les quantités pour chaque ligne. Les lignes de mouvements du picking qui ne seront forcées avec une quantité à 0.
**Méthode / Exemple****Données d'entrée****Données de sortie**
**mf\_do\_partial\_picking(picking\_id, move\_ids, qtys)** *Traitement ddes lignes 614 et 615 du picking d'id 68 avec quantité 5 et 3.* env\["mf.tools"\].**mf\_do\_partial\_picking**(68,\[614,615\],\[5,3\]) exemple utilisation API openprod : ```json URL : {{url serveur}} /web/api/endpoint { "db":{{base}}, "token":{{token}}, "model":"mf.tools", "method": "call_kw", "call_method": "mf_do_partial_picking", "args":[], "kwargs":[["picking_id",68],["move_ids",[614,615]],["qtys",[5,3]]] } ``` picking\_id : id du picking a traiter move\_ids : liste des id des mouvements à traiter qtys : liste des quantités à traiter (correspondant au mouvements de la liste move\_ids) True sur l'opération à réussi.
# Recalcule des taxes de vente mf_recompute_sale_info() Cette méthode permet de recalculer les taxes d'une vente (elle peut par exemple être appelé depuis un appel API.
**Méthode / Exemple****Données d'entrée****Données de sortie**
**mf\_recompute\_sale\_info()** sale\_order\_id.**mf\_recompute\_sale\_info**() exemple utilisation API openprod : ```json URL : {{url serveur}} /web/api/endpoint { "db":{{base}}, "token":{{token}}, "model":"sale.order", "method": "call_kw", "call_method": "mf_recompute_sale_info", "ids":[521], "kwargs":[] } ``` Vente en cours True sur l'opération à réussi.