| API / APIs Radiofréquence | |
| Version ACE : 1.3 | |
|
Package : Standard Nom de la gnc : gnc_rf_lect_gen |
Fonctionnalité : Préparation RF |
| Schémas d’entrée et de sortie : | voir en fin de document. |
Cette API permet, pour un profil d'activité en particulier, d’obtenir des informations sur la mission et le paramétrage de départ. Elle est appelée par une autre API : RECHMISS.
API imbriquées : aucune
Contraintes et limites de fonctionnement (hors périmètre)
| RAS. |
Paramétrage (PPE)
| LPRELV - |
Processus, contrôles et règles de gestion
| ETAPE | DESCRIPTION DU PROCESSUS |
|
La zone N1 du paramètre LPRELV précise le nom de la table utilisateur contenant le nom de la vue générale associée au profil d’activité. Dans cette vue figurent les informations suivantes :
|
|
| Détail : |
Read the depot (TIE table) for the current user. If the parameter ‘LPRELV’ is active and the parameter field N1 is in the interval (0, 999] (0 < N1 <= 999). Look for generalized information for the RF preparation module . (Read the table (TBL) with a code equal to the parameter field N1 (codtbl = N1) and an access key equal to the input profile ID of the activity in progress (cletbl = idprfac)). If the information is found. Get the parameterize view name (tbl.lib1). Otherwise. The API returns an error code 0 and an error message “ELT_PASTRO”. Otherwise. The API returns an error code 0 and an error message “RFPIK02002”. Read the data from the found view with the input parameters (typdep ,sigdep, idprfact). If data is found. Fill the output parameters with the information found. Copy the depot information (info_depot) to the first output parameter (ParamOut1). Copy the affected flag (flg_affecte) to the second output parameter (ParamOut2). Copy the mission in progress ID (id_mission_enc) to the third output parameter (ParamOut3). Copy the mission view name (nom_vue_mission) to the fourth output parameter (ParamOut4). Copy the order (gen_order) to the fifth output parameter (ParamOut5). Copy the data separator used in the view (gen_separateur) to the sixth output parameter (ParamOut6). Copy the activity type (ltypact) to the seventh output parameter (ParamOut7). Copy the event settings code (codpev) to the eight output parameter (ParamOut8). Otherwise. Copy the error message “ELT_PASTRO” in the output parameter. Return the result code of the reading. |
Exemple(s) d’utilisation
| Cette API est appelée par l’API RECHMISS. |
Cas d'erreur
| CODE | PARAMÈTRES | DESCRIPTION |
|---|---|---|
| 0/ELT_PASTRO | codtbl, cletbl | The generalized information is not found. |
| 0/ RFPIK02002 | ‘LPRELV’ | Parameter non-existent or not well parameterized. |
| ELT_PASTRO | ‘view name’ (tbl.lib1) | The information from the view is not found. |
| NOM DU PARAMÈTRE | TYPE | FORMAT | TAILLE | OBL O/N | REMARQUE |
| sigage | Char | 12 | O | Sigle de l’agent | |
| typdep | Char | 3 | O | Type tiers dépôt | |
| sigdep | Char | 18 | O | Dépôt | |
| idprfact | Long | O | Identifiant du profil d’activité en cours |
| NOM DU PARAMÈTRE | TYPE | FORMAT | TAILLE | OBL O/N | REMARQUE |
| ParamOut1 | Char | 20 | Information dépôt ex :libellé (Info_depot) | ||
| ParamOut2 | Char | 1 |
Indicateur sur le mode d’affectation des missions (déclarative ou imposée) (Flg_affecte) |
||
| ParamOut3 | long | identifiant de la mission à reprendre (Id_mission_enc) | |||
| ParamOut4 | char | 20 | nom de la vue pour recherche de mission (Nom_vue_mission) | ||
| ParamOut5 | Char | 1 | (Gen_ordre) | ||
| ParamOut6 | Char | 1 | (separateur) | ||
| ParamOut7 | long | (ltypact) | |||
| ParamOut8 | Char | 8 | (Event settings code) |