easyClean

• API
• Plans
• Zones
• Surfaces
• Procédures
• Tâches
• Fréquences
• Images
• Documents

API

Plans

Comment ca marche ?

Les plans sont divisé en 2 grandes catégorie : 

Bibliothéque :

Quand on veut insérer un plan pour la bibliothéque :

Il faut les respecter certaines condition :

• clientFamilleCode = Rempli 
• clientFamilleCodeDefaut = Rempli 
• clientDesignation =  null 
• clientCode = null 

Quand on insère dans la bibliothéque, il faut aussi passer la bibliothéque a true pour les enfants (zone, surface, procédure) 

Client : 

Quand on veut insérer un plan pour un client :

Il faut les respecter certaines condition : 

• clientFamilleCode = null 
• clientFamilleCodeDefaut = null 
• clientDesignation = Rempli ou null 
• clientCode = Rempli ou null 

Question :

• On peut update tout les champs genre même ceux inutile telle que zoneMaxNiveau ?
  • Non, ca sert a rien 
• Peut t'on update d'un plan clôturé / soumis ? Peut t'on rajouter des zones et autres dans un plan clôture / soumis ? 
  • Clôturé (status: 1) = fini , c'est intangible et définitif , on ne peut plus rien faire dans le plan a pars le dupliquer.
    
  • Soumis / Refuser, on peut réaliser tout les actions sans aucune restriction. C
    • soumission (status: 2) et refusé (status: 3) c'est uniquement des "suppléments" à "en cours" (status: 0)

      
      
• Peut t'on supprimer un plan clôturé
  • Oui, c'est la seule action autorisé sur un plan clôturé

• Peut t'on créer un plan sans aucune informations ?

  •   Non, il faut obligatoirement une désignation non vide pour créer un plan, cependant on peut créer zone ou autre ressources vide.
• Peut t'on update un plan pour le mettre dans la bibliothéque ? Ou l'enlever de la bibliothéque ? 
  • Non, quand il est dans la bibliothéque, on peut seulement le supprimer ou l'editer en lui rajoutant des sous enfant (zones, surfaces…). Il sera toujours avec le status = 0 (en cours)
• Dans le cas, ou j'ai des ID et aussi des informations en plus (ex : client_id et client_designation) ? 
  • Il ne peut pas éditer le champs désignations, c'est de mon coté je vais récupère par rapport a l'ID de l'user la désignation et update les champs en conséquences . 

Zones

Question : 

• Peut t’on déplacer une zone dans un autres plan ?
  • Non, quand on souhaite déplacer une zone dans un autre plan. on doit la dupliquer. 
• Peut-on mettre à jour en masse avec une requête ? Par exemple, changer les positions et les noms de différentes zones.

  • Oui, on peut ? Voici la requete SQL pour le faire

    UPDATE plan_zone SET pos = CASE id WHEN 3641 THEN 8 WHEN 3640 THEN 88 ELSE pos END, nom = CASE id WHEN 3641 THEN 'Valeur1' WHEN 3640 THEN 'Valeur2' ELSE nom END WHERE id IN (3641, 3640);

Surfaces

Question 

• Peut t’on modifier le parent (zone) ou le plan ?
  • Oui on peut pour le parent. Cela permet de changer le parent (zone) de la surfaces. Cependant comme pour tout les enfant d'un plan, il est impossible de changer d'un plan avec une update de idplan.

  • Attention, il faudra aussi changer les liens dans la table plan_lk_zone_zone de la BDD. Comme pour procédures on pourra le faire seulement sur eCare Cleaning.

Procédures

Comment ca fonctionne :

Les procédures sont divisé en 3 grandes catégorie : 

Client:

La procédures fait partie d'un plan d'un client. 

Bibliothéque :

La procédures fait partie d'un plan qui est dans la bibliothéque. 

Défaut :

La procédures fait partie des bibliothéque de procédures. Elle sera visible dans le panier du client. 

Doit avoir true sur la variable bibliothèque et défaut en même temps.

 

Lors de la création d'un plan bibliothéque seuls zone surface et procédures sont avec le champs bibliothèque a true. Les enfants de procédures n'ont pas le champs bibliothéque a true. (dosage, temperature, frequences, taches...)

Question :

• Update des champs idzone et idplan ?
  • Cela permet de changer le parent (surface) de la procédure. Mais on ne peut pas update l'idplan afin de changer de plan.

  • Cette action, peut ce faire sur eCare Cleaning, mais pas sur easyClean. Cela signifie qu'on va devoir le faire plus tard, mais ce n'est pas une tâche à faire rapidement.

Tâches

Comment ca marche ?

Client:

La taches fait partie d'un plan d'un client. 

Bibliothéque :

La taches fait partie des bibliothéque de taches.

Cependant, ceci est un vieux code donc ignorer et deprecated 

Question :

• C'est quoi les taches bibliothéque ? C'est le plan de la taches est dans la bibliothèque ou c'est pour être dans la bibliothèque des tache ?

Fréquences

Comment ca fonctionne ?

Cela fonctionne comme les tâches ou les surfaces, c'est un sous-objet de procédures. On va donc créer une fréquence associée à la procédure, et compléter l'ID dans la colonne correspondante dans la table des procédures. Attention, coté API, il faut générer la fréquences avant la génération de la procédures, afin de pouvoir avoir l'ID de la procédures. 

FUTUR : Deviendra surement comme les dosage, cela deviendra un champs texte, et dans la table plan_frequences de la BDD, il y aura plus que les fréquences de la bibliothèque

API : Quand on utilisera l'API sur la collection de fréquences, cela sera uniquement pour les fréquences de la bibliothèque. Cela signifie que nous devrons fournir les données des fréquences dans l'API des procédures afin de pouvoir créer ou mettre à jour une fréquence. Par exemple, avec le champ frequences_designation.

FUTUR API coté user : Rien ne changera, il devra fournir les informations de la fréquence comme s'il voulait fournir les informations du dosage.

Attention : Le fonctionnement du système de bibliothèque est différent de celui des zones ou des surfaces, il est plutôt similaire au système de dosage. Les fréquences associées au champ bibliothèque font partie des fréquences disponibles sur la page suivante : https://plan.paris.ecare.pro/Bibliotheques/Frequences.

Question : 

• saut jourSemaine momentJour c'est ignorer ?
  • Oui champs vieux donc inutile
    
• C'est quoi la couleur par défaut ?
  • C'est le bleu marine : #2a3f54
• Peut t'on update une fréquence pour la mettre dans la bibliothéque ?

Images

Comment ca marche ?

Elles sont appelées par une autre BDD et par une autre API

De mon côté, je n'attends que l'ID de l'image. Je vérifie uniquement si c'est un entier qui m'est envoyé, je ne vérifie pas si l'image existe.

Question :

• Le champs Photo dans la BDD des taches ?
  • Il est inutile, c’est une ancienne version.

Documents

Comment ca marche ?

L'API des documents ne sert qu'a lister des documents de leur bibliothéque. C'est sur l'api plan qu'on gère les liaison et les ajout / suppression / update des liaison plan documents.

 

Question :

• Comment supprimer un documents ?
  • On ne peut pas supprimer un documents, on peut seulement supprimer la liason plna / document. Pour se faire il faut update les documents des plan en lui envoyant rien. 
• Puis je insérer un liaison plan / document a la création d'un plan ?
  • Oui, pour se faire, il faut envoyer l'ID des documents et leur postions. Dans un Array de documents