Fonctions communes:API - SELECT - GRID CONFIG

API - SELECT - GRID CONFIG

Version imprimable

---

Récupérer la configuration d'une grille

Cette opération permet de récupérer la liste des vues, des filtres et des boutons de filtre rapide pour une grille précise.

DemAction : SELECT
DemCat : GRID_CONFIG
DemOptions :

• GridCode : Code pour identifier la grille. Voir la liste des codes de grille
• NomSession : Même nom de session utilisé lors de l'envoi d'une requête sous forme de JSON.
• SearchValue : Filtre de la barre de recherche. Pour chercher le texte « abc » sur toutes les colonnes, il faut inscrire ceci <Search Field="" Value="abc">. Pour chercher sur une colonne en particulier, il faut documenter l'attribut Field avec le nom du champ sur lequel on souhaite chercher. Il est aussi possible de chercher sur plusieurs champs à la fois en ajoutant plusieurs node <Search>. Il n'est pas possible de combiner la recherche sur toutes les colonnes et sur des colonnes en particulier.
• RangeStart : Indique la plage d'élément à sélectionner. Par exemple, pour retourner uniquement les 25 premières lignes, saisir 1.
• RangeEnd : Indique la plage d'élément à sélectionner. Par exemple, pour retourner uniquement les 25 premières lignes, saisir 25.
• Params : XML contenant une liste de paramètres nécessaire pour l'exécution de la requête. (Ex: <Param Name="CliNo" Value="123">)

Informations retournées

{  
  "Options":[
    {
      "ShowView":"1",
      "ShowFilter":"1",
      "ShowSearchBar":"1",
      "ShowFooter":"1"
    }
  ],
  "View":[  
    {  
      "ViewUID":"382",
      "ViewName":"Ma vue",
      "ViewDesc":"[«Cie?» est \"vrai\"]",
      "ViewSelected":"1"
    },
    {  
      "ViewUID":"5468",
      "ViewName":"Multi-trans",
      "ViewDesc":"",
      "ViewSelected":"0"
    },
    {  
      "ViewUID":"4253",
      "ViewName":"Pr\u00E9nom / Nom",
      "ViewDesc":"",
      "ViewSelected":"0"
    },
    {  
      "ViewUID":"5411",
      "ViewName":"Toutes les colonnes de Pr\u00E9nom / Nom",
      "ViewDesc":"",
      "ViewSelected":"0"
    },
    {  
      "ViewUID":"5524",
      "ViewName":"Vue largeurs colonnes",
      "ViewDesc":"",
      "ViewSelected":"0"
    }
  ],
  "Filter":[  
    {  
      "FilterUID":"372",
      "FilterName":"Clients anglophones",
      "FilterDesc":"[«Langue code» est égal à \"AN\"]",
      "FilterSelected":"0"
    },
    {  
      "FilterUID":"374",
      "FilterName":"Clients avec le lien Conjoint/Conjointe",
      "FilterDesc":"",
      "FilterSelected":"0"
    },
    {  
      "FilterUID":"375",
      "FilterName":"Clients avec le lien Employ\u00E9/Employeur",
      "FilterDesc":"",
      "FilterSelected":"0"
    },
    {  
      "FilterUID":"376",
      "FilterName":"Clients francophones",
      "FilterDesc":"[«Langue code» est égal à \"FR\"]",
      "FilterSelected":"0"
    }
  ],
  "PushButton":[  
    {  
      "Name":"pbActif",
      "Label":"Actif",
      "GroupIndex":"1",
      "ButtonIndex":"1",
      "Down":"1"
    },
    {  
      "Name":"pbInactif",
      "Label":"Inactif",
      "GroupIndex":"1",
      "ButtonIndex":"2",
      "Down":"0"
    }
  ]
}

Options : Options concernant la grille.

• ShowView : À 0, la liste des vues est cachée.
• ShowFilter : À 0, la liste des filtres sauvegardés est cachée.
• ShowSearchBar : À 0, la barre de recherche est cachée.
• ShowFooter : À 0, le pied de page affichant le nombre d'enregistrement est cachée.

View : Liste des vues pour cette grille et visibles par l'utilisateur.

• ViewUID : ID de la vue. Utilisé dans le BROWSE_DATA.
• ViewName : Nom de la vue.
• ViewSelected : Vue sélectionnée par défaut.

Filter : Liste des filtres sauvegardés pour cette grille et visibles par l'utilisateur.

• FilterUID : ID du filtre. Utilisé dans le BROWSE_DATA.
• FilterName : Nom du filtre.
• FilterSelected : Filtre sauvegardé par défaut.

PushButton : Liste des boutons de filtre rapide.

• Name : Nom du bouton. Utilisé dans le BROWSE_DATA.
• Label : Libellé affiché sur le bouton.
• GroupIndex : ID du groupe. Les boutons d'un même groupe sont collés les uns sur les autres. Les différents groupes sont séparés par un espace.
• ButtonIndex : Ordre des boutons à l'intérieur d'un groupe.
• Down : 0 = Bouton inactif, 1 = Bouton actif

Le SELECT / GRID_CONFIG lance automatiquement un BROWSE / DATA pour la grille demandée avec la vue, le filtre et les boutons de filtre rapide par défaut.

---

Nom du document : Fonctions communes:API - SELECT - GRID CONFIG

Version imprimable