Tutorial NOUTOnline

Comment utiliser le webservice de NOUTOnline.

Liste / Recherche

Pour une action liste ou recherche, il faut utiliser les opérations List ou Search respectivement. L'opération Search se gère de manière identique à l'opération List. Les paramètres sont :

Table

L'identifiant du formulaire à afficher

ParamXML

Les paramètres de l'action. Si ce paramètre est vide, ce sont les valeurs par défauts qui sont utilisées. La description des paramètres est fournie dans la réponse du serveur.

Paramètre spécifique aux listes :

SpecialParamList

Les paramètres qui permettent de gérer la pagination. La balise ChangePage permet d'indiquer que c'est juste un changement de page et non pas un changement de paramètre ; cela à pour effet de ne pas recalculer la liste mais de juste retourner la page demandée.

Le serveur renvoit une réponse de type List. Les informations à traiter sont :

ActionContext

Le contexte d'action courant, necessaire pour fermer la liste via les opérations validate/Cancel.

Form

Le formulaire courant, libellé et identifiant.

XSDSchema

Le schema qui décrit l'élément courant. En conjonction avec le xml contenu dans la réponse, cela permet d'afficher la liste. Attention, ce XSD est différent que celui pour l'affichage d'un enregistrement.

Action

L'action courante, libellé et identifiant ; le libellé sera utilisé pour le titre de la fenêtre

Filter

La description des filtres de la liste avec un XSD et un XML.
Lors d'une modification des filtres par l'utilisateur, c'est le XML mis à jour qu'il faut mettre dans le paramètre ParamXML.

Count

Le compteur avec :

  • NbFiltered : Le nombre d'enregistrement qui correspondent aux filtres
  • NbCalculation : Le nombre de ligne dans la partie calcul de fin de liste
  • NbLine : somme de NbFiltered et NbCalculation
  • NbTotal : Le nombre d'enregistrement sans prendre en compte les filtes.
.

PossibleDisplayMode

La liste des modes d'affichage possibles pour cette liste.

DefaultDisplayMode

Le mode d'affichage par défaut.

Pour fermer la liste, il faut valider ou annuler la dernière action du contexte avec les opérations validate ou Cancel respectivement.

Si le but de n'est pas d'afficher la liste à l'utilisateur, il est possible de se dispenser de l'opération Validate ou Cancel en ajoutant l'entête AutoValidate à 1 ou -1 respectivement. Cela signifie que la liste ne sera plus en mémoire et donc inaccessible.

Calcul de fin de liste

Les calculs de fin de liste sont sur la dernière page quand tous les enregistrements ont été chargés. Pour forcer les calculs et obtenir le résultat, il faut utiliser l'opération GetCalculation. Cette opération prend en paramètre :

ColList

Une liste d'identifiant de colonnes.

DefaultDisplayMode

Une liste de calculs à effectuer.

Le serveur retourne une réponse de type ListCalculation qui est une liste de calculs. Cette liste fonctionne comme une liste d'enregistrement. Les entêtes Filter et Count en moins.