GetFieldsOnLayout
Renvoie une liste des rubriques d’un modèle sous forme de données JSON.
Format
GetFieldsOnLayout ( nomModèle )
Paramètres
nomModèle
: une expression de texte représentant le nom du modèle. Si nomModèle
est une chaîne vide (""), le modèle actuel est utilisé.
Résultat
Texte
Provient de la version
22.0
Description
Cette fonction renvoie un objet JSON contenant des informations sur les rubriques du modèle spécifié, accessibles dans le cadre d'une recherche.
Les rubriques qui répondent à l'un des critères suivants sont exclues :
-
L'objet de la rubrique se trouve en dehors de la zone du modèle (consultez la section Placement et suppression de rubriques dans un modèle).
-
La condition Masquer objet quand est respectée et Appliquer en mode Recherche est sélectionné (consultez la section Masquage ou affichage des objets de modèle).
-
Pour Saisie de rubrique, Mode Recherche n'est pas sélectionné (consultez la section Autorisation ou interdiction de la saisie dans une rubrique).
-
Inclure la rubrique dans la recherche rapide n'est pas sélectionné (consultez la section Configuration de la recherche rapide).
-
Le jeu de privilèges du compte actuel ne dispose pas d'accès en lecture (consultez la section Modification des privilèges d'accès aux enregistrements).
-
La rubrique est une rubrique de type Statistique, Global ou Conteneur (consultez les sections Définition de rubriques de type Statistique, Définition de rubriques de type Global (rubriques avec stockage global) et À propos des rubriques Conteneur).
L'objet JSON renvoyé présente la structure suivante :
{
"layout_name": "NomModèle",
"fields": {
"OccurrenceTable::NomRubrique1": {
"type": "string",
"description": "Commentaire de la rubrique (facultatif)"
},
"OccurrenceTable::NomRubrique2": {
"type": "number"
}
}
}
-
La clé
layout_name
contient le nom du modèle. -
L'objet
fields
contient des paires clé-valeur pour chaque rubrique accessible. -
La clé de chaque rubrique correspond à son nom complet (par exemple, OccurrenceTable::NomRubrique).
-
La valeur de chaque rubrique est un objet avec une clé
type
(number
si le type de données de la rubrique est un nombre ; sinon,string
). -
Une clé
description
facultative est incluse si la rubrique est dotée d'un commentaire dans la boîte de dialogue Gérer la base de données. Si un commentaire de rubrique dans la table commence par[LLM]
, alors seuls les commentaires commençant par[LLM]
sont affichés. Le préfixe[LLM]
est supprimé de la valeurdescription
.
Remarques
-
Cette fonction utilise les mêmes critères pour déterminer quelles rubriques sont accessibles dans le cadre d'une recherche et quelles informations de rubrique sont renvoyées, comme avec l'action de script Effectuer une recherche en langage naturel .
Exemple 1
Renvoie un objet JSON décrivant les rubriques accessibles dans le cadre d'une recherche sur le modèle des produits.
JSONFormatElements ( GetFieldsOnLayout ( "Produits" ) )
Si le modèle Produits contient ces rubriques :
Nom de rubrique | Commentaire |
---|---|
Date de création |
[LLM] Date de création du produit |
Prix |
[LLM] Prix du produit en EUR |
ID du produit |
[LLM] Clé primaire qui identifie un produit de manière unique |
Nom du produit |
[LLM] Nom descriptif du produit |
État |
État du produit en inventaire. Les valeurs sont En stock, Sur commande |
g_FavorisUtilisateur |
Rubrique de type Global contenant les produits préférés de l'utilisateur actuel |
La fonction renvoie :
{
"fields" :
{
"Produits::Date de création" :
{
"description" : "Date de création du produit",
"type" : "string"
},
"Produits::Prix" :
{
"description" : "Prix du produit en EUR",
"type" : "number"
},
"Produits::ID du produit" :
{
"description" : "Clé primaire qui identifie un produit de manière unique",
"type" : "number"
},
"Produits::Nom du produit" :
{
"description" : "Nom descriptif du produit",
"type" : "string"
},
"Produits::État" :
{
"type" : "string"
}
},
"layout_name" : "Produits"
}
Notez que parce qu'au moins un commentaire de rubrique commence par la balise [LLM]
, seules les rubriques avec la balise [LLM]
incluent une description. La rubrique g_FavorisUtilisateur est entièrement omise car il s'agit d'une rubrique de type Global, qui n'est pas accessible dans le cadre d'une recherche.
Exemple 2
Renvoie une liste de toutes les rubriques du modèle actuel et une liste de toutes les rubriques du modèle actuel qui sont accessibles dans le cadre d'une recherche. Cela peut indiquer des rubriques que vous ne saviez pas inaccessibles à la recherche.
Definir (
[
rubriquesModèle = NomsRubriques ( Obtenir ( NomFichier ) ; Obtenir ( NomModèle ) ) ;
rubriquesRecherche = JSONListKeys ( GetFieldsOnLayout ( Obtenir ( NomModèle ) ) ; "fields" ) ;
rubriquesModèleTriées = SortValues ( rubriquesModèle ; 1 ) ;
rubriquesRechercheTriées = SortValues ( rubriquesRecherche ; 1 ) ;
$$resultat = "Toutes les rubriques du modèle actuel :" & ¶ & rubriquesModèleTriées & ¶ &
"Parmi elles, celles accessibles dans le cadre d'une recherche sont :" & ¶ & rubriquesRechercheTriées
] ;
$$resultat
)
Résultat possible stocké dans $$resultat pour le modèle Produits :
Toutes les rubriques du modèle actuel :
Date de création
Photo
Prix
ID du produit
Nom du produit
État
Parmi elles, celles accessibles dans le cadre d'une recherche sont :
Produits::Date de création
Produits:: Prix
Produits::ID du produit
Produits::Nom du produit
Produits::État