ACT_LIS-ENTITE
BUT
Cette fonction permet de gérer le contenu d’une liste sur entité à partir d’une clé donnée d’une entité. Elle permet de rattacher une clé d’une entité à une liste, de supprimer une clé d’une entité à une liste, de modifier les informations rattachées d’une clé à une entité (statut, mots directeurs), de consulter le statut d’une clé sur entité.
Cette fonction est disponible dans tous les types de requête.
TYPE
CARACTERE
SYNTAXE
Variable_Résultat = ACT_LIS-ENTITE( ENTITE= Référence_Entite,
CLE1 ENTITE = Référence_Clé_1_Entité,
CLE2 ENTITE = Référence_Clé_2_Entité,
CLE3 ENTITE = Référence_Clé_3_Entité,
CLE4 ENTITE = Référence_Clé_4_Entité,
CLE5 ENTITE = Référence_Clé_5_Entité,
ACTION = EXISTE / CREATION / MODIFICATION / SUPPRESSION /
INTEGRITE,
STATUT=Valeur_Statut,
CARACTERISTIQUES=Liste_Caractéristique )
PARAMETRES
Paramètre | E/S | O | Type | Description |
Entité | E | Oui | Caractère | Référence entité pour laquelle la clé va être donnée dans les 5 paramètres suivants (voir valeurs possibles ci-dessous). Cette référence peut être donnée par une variable locale, une constante globale, une constante locale ou bien la valeur d’une variable contextuelle. |
Liste | E | Oui | Caractère | Référence liste sur entité gérée, définie dans la bibliothèque des listes sur entités. Cette référence peut être donnée par une variable locale, une constante globale, une constante locale ou bien la valeur d’une variable contextuelle. |
Clé1 Entité | E | Oui | Caractère | Valeur de la clé 1 identifiant l’élément de l’entité à traiter (voir principes valeurs ci-dessous). Cette référence peut être donnée par une variable locale, une constante globale, une constante locale ou bien la valeur d’une variable contextuelle. |
Clé2 Entité | E | Oui | Caractère | Valeur de la clé 2 identifiant l’élément de l’entité à traiter (voir principes valeurs ci-dessous). Cette référence peut être donnée par une variable locale, une constante globale, une constante locale ou bien la valeur d’une variable contextuelle. |
Clé3 Entité | E | Oui | Caractère | Valeur de la clé 3 identifiant l’élément de l’entité à traiter (voir principes valeurs ci-dessous). Cette référence peut être donnée par une variable locale, une constante globale, une constante locale ou bien la valeur d’une variable contextuelle. |
Clé4 Entité | E | Oui | Caractère | Valeur de la clé 4 identifiant l’élément de l’entité à traiter (voir principes valeurs ci-dessous). Cette référence peut être donnée par une variable locale, une constante globale, une constante locale ou bien la valeur d’une variable contextuelle. |
Clé5 Entité | E | Oui | Caractère | Valeur de la clé 5 identifiant l’élément de l’entité à traiter (voir principes valeurs ci-dessous). Cette référence peut être donnée par une variable locale, une constante globale, une constante locale ou bien la valeur d’une variable contextuelle. |
Action | E | Oui | Caractère | Action à déclencher pour la clé de l’entité précédemment précisée ; les valeurs possibles sont : CREATION : permet de rattacher la clé de l’entité donnée dans les paramètres précédents à la liste sur entité précisée ; la valeur éventuelle du statut (si gestion de statut) est définie dans le paramètre suivant STATUT; les valeurs des autres informations (les 5 mots directeurs) sont définie dans le paramètre CARACTERISTIQUES. MODIFICATION : permet de modifier les caractéristiques de la clé de l’entité donnée sur la liste sur entité précisée; la valeur éventuelle du statut (si gestion de statut) est définie dans le paramètre suivant STATUT; les valeurs des autres informations (les 5 mots directeurs) sont définie dans le paramètre CARACTERISTIQUES. SUPPRESSION : permet de supprimer la clé de l’entité donnée dans les paramètres précédents à la liste sur entité précisée. EXISTE : si aucune clé n’est définie, DIAPASON vérifie si la liste précisée existe ; si une clé est définie et aucun statut n’est définie, DIAPASON vérifie que la clé donnée existe bien sur la liste précisée ; si une clé et un statut sont définis, DIAPASON vérifie que la clé donnée existe bien sur la liste et le statut précisés. INTEGRITE : intégrité des listes pour une entité et un élément passé en paramètre (clés 1 à 5). |
Caractérist. | E | Oui | Caractère | Paramètre utilisé pour les actions de création et modification ; permet de passer les valeurs des mots directeurs associés à une clé d’une liste sur entité ; le paramètre doit être fourni sous la forme SEP=<séparateur><séparateur>MD1=<valeur_mot_directeur1><séparateur>MD2=<valeur_mot_directeur2><séparateur>MD3=<valeur_mot_directeur3><séparateur>MD4=<valeur_mot_directeur4><séparateur>MD5=<valeur_mot_directeur5> Remarque : la valeur du séparateur doit être définie sous la forme d’un seul caractère et est utilisé pour décrypter les débuts et fins des valeurs des mots directeurs. |
Cette fonction retourne dans la variable résultat le retour de l’exécution de la fonction (vide : exécution OK, non vide : problème).
EXEMPLE
L’instruction qui suit permet de vérifier si l’article standard dont la référence est définie dans la variable locale VLO.GenRefArt est bien défini dans la liste sur entité dont la référence est Art_Cde :
VLO.Fonction = ACT_LIS-ENTITE( ENTITE= CLO.’GAD’ , LISTE= CLO.’Art_Cde’ , CLE1 ENTITE= CLO.’R’ , CLE2 ENTITE= VLO.GenRefArt , CLE3 ENTITE= CLO.’’ , CLE4 ENTITE= CLO.’’, CLE5 ENTITE= CLO.’’, ACTION= EXISTE , STATUT= CLO.’’, CARACTERISTIQUES= CLO.’’)
Les instructions qui suivent permettent de rattacher l’article standard dont la référence est définie dans la variable locale VLO.GenRefArt à la liste sur entité dont la référence est Art_Cde, en précisant dans la variable caractéristique les valeurs des mots directeurs souhaités (mot directeur 1 : famille générale article, mot directeur 2 : sous famille d’approvisionnement article) :
VLO.Caracteristiques = CLO."SEP=,,MD1=" + SAS.GenFamArt + CLO.",MD2=" + SAS.AppSFa
VLO.Fonction = ACT_LIS-ENTITE( ENTITE= CLO.’GAD’ , LISTE= CLO.’Art_Cde’ , CLE1 ENTITE= CLO.’R’ , CLE2 ENTITE= VLO.GenRefArt , CLE3 ENTITE= CLO.’’ , CLE4 ENTITE= CLO.’’, CLE5 ENTITE= CLO.’’, ACTION= CREATION, STATUT= CLO.’’, CARACTERISTIQUES= VLO.Caracteristiques)
NOTES
Les valeurs possibles du paramètre entité sont les suivantes :
AFO : Fournisseurs
AL-ART-FOU : Liens Articles -> Fournisseurs
APE : Commandes Fournisseurs
APL : Lignes de Commandes Fournisseurs
ARE : Retours Fournisseurs
ARL : Lignes de Retours Fournisseurs
FACE : Entête de facture client
FACL : Ligne de Facture Client
GAD : Articles Standards
GANOD : Nomenclatures de Définition
GCAF : Affaires
GCDE : Commandes Commerciales
GCDL : Lignes Cde. Commerciales
GCEX : Evènements d'Expéditions
GCLIENT : Clients Diapason
GCO : Commerciaux
GCPE : Besoins de Gestion
GCPL : Lignes Besoins de Gestion
GCRE : Retours Clients
GCRL : Lignes de Retours Clients
GLA : Séries
GLL : OFs
GRESS : Ressources
GVAD : Vari-Articles DIAPASON
Sur l’action CREATION, si la clé donnée est déjà rattachée à la liste sur entité, l’action se comporte comme l’action modification.
Sur les actions MODIFICATION et INTEGRITE, si la clé donnée n’est pas rattachée à la liste sur entité, il n’y a pas de mise à jour (retour erreur fonction : *CLE).
Sur les actions CREATION et MODIFICATION, si la gestion des statuts est active sur une liste sur entité et qu’aucun statut n’est renseigné dans le paramètre correspondant, il n’y a pas de mise à jour (retour erreur fonction : *STA).
Si la fonction renvoie "*PRG", il faut recompiler la requête utilisant la fonction.