API RF VALZN

Version ACE : 5.0-00

Package : Standard

Sous-programme Basic : Fct_Valzn

Nom de la gnc : gnc_rf_valzn

Fonctionnalité :Général

Schémas d’entrée et de sortie :

voir en fin de document.

Cette API permet de consulter et de mettre à jour une zone paramétrée d'une table définie en entrée d'API : PRO, TIE, LREE, LMODINV, LMVTSTK, OST ou LOP.

API imbriquées : aucune.

Contraintes et limites de fonctionnement (hors périmètre)

RAS.

Paramétrage (PPE)

RAS.

Prototype de la fonction Basic

Retour_Fct_Valzn=Fct_Valzn(mode, nom_table ,cle_table , text, num)

Messages en entrée

VALZN~mode~nom_table~cle_table~text~num

Messages en sortie

Retour~text

Valeurs restituées par l’API

VALEUR	REMARQUE
1	La lecture de l’entité s’est correctement effectuée
0	Erreur de lecture de l’entité

Processus, contrôles et règles de gestion

ETAPE	DESCRIPTION DU PROCESSUS
1	Identification de l’entité dans la base de données.
2	Recherche de la Nième zone paramétrée de l’entité.
3	En mode écriture, mise à jour de la Nième zone paramétrée de l’entité.
Détail :	If the nom_table parameter is equal to ‘pro’. The table PRO is read with the input parameter cle_tab(pro.codpro = cle_tab). If the nom_table parameter is equal to ‘tie’ and the length of the cle_table parameter is larger than 3. The cle_table parameter is decomposed to typtie and sigtie parameters. The table TIE is read with the decomposed parameters. If the nom_table parameter is equal to ‘ree’ and the length of the cle_table parameter is larger than 15. The cle_table parameter is decomposed to typtie, sigtie and numrec parameters. The table LREE is read with the decomposed parameters. If the nom_table parameter is equal to ‘lmi’ and the length of the cle_table parameter is larger than 15. The cle_table parameter is decomposed to typtie, sigtie and modinv parameters. The table LMODINV is read with the decomposed parameters. If the nom_table parameter is equal to ‘mvt’ and the length of the cle_table parameter is larger than 15. The cle_table parameter is decomposed to typtie, sigtie, typmvt, sensmvt and idmvt parameters. The table LMVTSTK is read with the decomposed parameters. If the nom_table parameter is equal to ‘ost’ and the length of the cle_table parameter is larger than 16. The cle_table parameter is decomposed to codpro and numlot parameters. The table OST is read with the decomposed parameters. If the nom_table parameter is equal to ‘lop’ and the length of the cle_table parameter is larger than 16. The cle_table parameter is decomposed to typtie, sigtie and idop parameters. The table LOP is read with the decomposed parameters. Call the function gnc_zone_gere as so to read the value from the given field or to write the data to it. If the action mode is 1 (write mode) The table data is modified (PRO, TIE, LREE, LMODINV, LMVTSTK , OST or LOP) .

Erreurs possibles

CAUSE	EFFET
Le nom de table n’existe pas	Retour valeur 0
La clé de la table n’existe pas	Retour valeur 0

Exemple(s) d’utilisation

Retour_Fct_Valzn=Fct_Valzn(« 2 », »pro « , « LBR911 », text, 1)

Lecture de la premiere zone complémentaire de l’article LBR911. la valeur est retournée dans la variable text.

Paramètres en entrée

NOM DU PARAMÈTRE	TYPE	FORMAT	TAILLE	OBL O/N	REMARQUE
mode	Long		1	O	1 = modification 2 = lecture
nom_table	Char		49	O	nom de la relation à lire ou modifier : spro : fiche article sree : en-tête de réception stie : tiers slmi : mode d'inventaire smvt : mouvement de stock sost : objet lot slop : en-tête d'op
cle_table	Char		49	O	Identifiant de la relation à lire ou modifier.
					pro : code produit
					tie : type de tiers position 1 à 3 sigle tiers position 4 à 15
					ree : type tiers dépôt position 1 à 3 sigle dépôt position 4 à 15 numéro de réception
					lmi : type tiers dépôt position 1 à 3 sigle dépôt position 4 à 15 mode d'inventaire position 16 à 17
					mvt : type tiers dépôt position 1 à 3 sigle dépôt postion 4 à 15 type de mouvement position 16 sens du mouvement position 17 numéro de mouvement lop : type tiers dépôt position 1 à 3 sigle dépôt postion 4 à 15 numero d'OP
cle_table			49	O	Identitiant de la relation à lire ou modifier. pro : code produit
					tie : type de tiers position 1 à 3 sigle tiers position 4 à 15
					ree : type tiers dépôt position 1 à 3 sigle dépôt position 4 à 15 numéro de réception
					lmi : type tiers dépôt position 1 à 3 sigle dépôt position 4 à 15 mode d'inventaire position 16 à 17
					mvt : type tiers dépôt position 1 à 3 sigle dépôt position 4 à 15 type de mouvement position 16 sens du mouvement position 17 numéro de mouvement lop : type tiers dépôt position 1 à 3 sigle dépôt position 4 à 15 numéro d'OP
text	Char		49	N	Dans le cas d'une mise à jour, valeur à mettre à jour dans la Nième zone paramétrée de l'entité.
num	Long		1	O	Numéro de la zone complémentaire à lire ou modifier.

API RF VALZN

Paramètres en entrée

Paramètres en sortie