API RF API_FIN

Version ACE : ACE 1.3

Package : Standard

Sous-programme Basic :

Fonctionnalité : Préparation

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

voir en fin de document.

Cette API permet de valider l’OP en cours pour les mouvements validés et de génèrer un OP reliquat pour les mouvements non validés.

API imbriquées : aucune.

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

Aucune.

Paramétrage (PPE)

Aucun.

Prototype de la fonction Basic

Messages en entrée

Messages en sortie

Valeurs restituées par l’API

VALEUR	REMARQUE
0	L’ordre de prélèvement n’existe pas dans le dépôt.
1	L’OP est soldé.
2	Le transfert de déchargement est généré.
10	Impossible de générer un OP reliquat.
63	Aucune ligne de prélèvement n’a été validée.

Processus, contrôles et règles de gestion

ETAPE

DESCRIPTION DU PROCESSUS

Si Mode_fin_OP = ‘1’

Si l’OP n’est pas un OP circuit mono colis, alors retour 10,

Sinon :

Création d’un colis détail,
Création d’un OP reliquat mono colis ayant les mêmes caractéristiques que l’OP origine : mode de préparation, indicateur circuit, type d’OP,
Attachement des mouvements de prélèvement de l’OP origine au nouveau colis détail et à l’OP reliquat,
Passage du statut de l’OP soldé à « 9 »,
Modification du statut du colis origine,
Le statut du colis origine sera modifié en fonction du paramétrage du mode de préparation de l’OP.

Erreurs possibles

Exemple(s) d’utilisation

Autres remarques…

Paramètres en entrée

NOM DU PARAMÈTRE	TYPE	FORMAT	TAILLE	OBL O/N	REMARQUE
typdep	Char		3	O	Type de dépôt
sigdep	Char		12	O	Sigle dépôt
idop	Long		10	O	N° d’ordre de prélèvement
Mode_Fin_OP	Char		1	O	‘1’ : Génération d’un OP reliquat ‘0’ : Pas de génération d’un OP reliquat
mode_ramasse	Char		1	O	‘1’ : Génération d’un transfert de déchargement ‘0’ : Pas de génération transfert de déchargement

NOM DU PARAMÈTRE	TYPE	FORMAT	TAILLE	REMARQUE
idtrf	LONG			Identifiant du transfert généré (si mode_ramasse = ‘1’