Uploader une vue
Uploader une vue
La commande views up permet dâuploader une vue de maniĂšre interactive.
Elle est destinée aux équipes qui souhaitent publier ou mettre à jour une vue afin de la rendre disponible dans le registre des vues OIP.
Utilisation
Fonctionnement général
La commande fonctionne en mode interactif.
Elle guide lâutilisateur Ă travers plusieurs prompts afin de collecter les informations nĂ©cessaires Ă la publication de la vue.
Les informations demandées peuvent notamment concerner :
- le nom de la vue ;
- lâidentifiant de la vue ;
- la description de la vue ;
- les tags associés ;
- le nom alternatif du module oip-core, si nécessaire.
Processus dâupload
Lors de lâupload, OIP Tools analyse la vue et prĂ©pare les Ă©lĂ©ments nĂ©cessaires Ă sa publication.
Le processus peut notamment inclure les Ă©tapes suivantes :
- analyse des imports utilisés par la vue ;
- analyse des dépendances locales et externes ;
- identification des entités utilisées ;
- identification des propriétés utilisées ;
- identification des enums utilisées ;
- identification des features utilisées ;
- génération du fichier manifest.yml ;
- assemblage de lâarchive de la vue ;
- soumission de lâarchive Ă lâAPI.
Prérequis projet
Avant dâexĂ©cuter la commande, le projet doit contenir les Ă©lĂ©ments nĂ©cessaires Ă lâanalyse et Ă la publication de la vue.
Les éléments attendus sont notamment :
RĂ©sultat de la commande
Une fois le traitement terminĂ©, la commande soumet la vue Ă lâAPI.
Selon le fonctionnement du registre, elle peut retourner une confirmation, une Pull Request ou une URL permettant de suivre la publication.
Exemple
La commande dĂ©marre alors le processus interactif dâupload de la vue.
Remarques
La commande nĂ©cessite un accĂšs rĂ©seau Ă lâOIP API.
Les variables dâenvironnement nĂ©cessaires Ă lâauthentification doivent ĂȘtre correctement renseignĂ©es, notamment OIP_TOOLS_CLIENT_SECRET.
Avant dâuploader une vue, il est recommandĂ© de vĂ©rifier :
- la cohérence de la configuration de la vue ;
- la présence des fichiers nécessaires ;
- les dépendances déclarées dans le projet ;
- les features utilisées par la vue ;
- les entités, propriétés et enums réellement exploitées.