Exporter et importer des intégrations et des micro-apps

Le service de micro-apps vous permet d’exporter et d’importer facilement des intégrations et des micro-apps.

La fonction d’exportation vous permet d’effectuer les opérations suivantes :

• Exporter une intégration unique avec toutes les micro-apps ou avec des micro-apps sélectionnées
• Exporter des micro-apps individuellement à partir d’une intégration existante

La fonction d’importation vous permet d’effectuer les opérations suivantes :

• Importer une intégration avec toutes les micro-apps
• Importer des micro-apps individuellement à partir d’un fichier d’exportation existant en plus des nouvelles versions des micro-apps actuelles

Avantages

L’importation et l’exportation d’intégrations et de micro-apps peuvent être utilisées pour les scénarios suivants :

• Sauvegarder et restaurer des intégrations et des micro-apps existantes
• Réduire le temps nécessaire pour développer des micro-apps supplémentaires avec des intégrations
• Tester de nouvelles configurations sans affecter les intégrations de production
• Résoudre les problèmes en vous permettant de développer des moyens sûrs de tester les solutions proposées
• Collaborer avec d’autres développeurs de micro-apps au sein de votre organisation ou avec la communauté de développeurs de la plate-forme de micro-apps Citrix

Fonctionnalité d’exportation

La fonctionnalité d’exportation stocke les différents paramètres et configurations dans un fichier avec une extension .mapp. Ce fichier peut être importé dans la console d’administration de micro-apps. Il existe deux types de fichiers .mapp : un fichier pour les intégrations et un fichier pour les micro-apps.

Remarque

Aucune donnée sensible n’est contenue dans le fichier d’exportation, y compris les ID utilisateur, les mots de passe, les ID client OAUTH et les clés secrètes client.

Les fichiers de configuration .mapp d’intégration de modèle contiennent les éléments suivants :

• Programmation et configurations de synchronisation
• Tables
  • Options de modification du schéma
  • Attributs sélectionnés
  • Filtres et requêtes de filtre
• Relations
• Actions
• Configuration
  • Nom de l’intégration
  • Paramètres du connecteur
    • Adresse URL du service
  • Authentification du service
    • Nom d’utilisateur
    • Mot de passe
  • Méthode d’authentification utilisateur
  • Autres paramètres
  • Configuration locale
  • Journalisation

Remarque

Les micro-apps sont exportées, mais n’incluent pas les abonnés précédemment configurés. Les abonnés doivent être reconfigurés une fois la micro-app importée. Pour plus d’informations, consultez la section Attribuer des abonnés.

Les fichiers de configuration .mapp d’intégration HTTP contiennent les éléments suivants :

• Chargement des données
  • Points de terminaison de données (y compris les points de terminaison enfants de chaîne)
• Tables
• Relations
• Actions de service
• Configuration
  • Nom de l’intégration
  • Paramètres du connecteur
    • URL de base
  • Icône
  • Instance locale
  • Authentification du service
    • Méthode d’authentification
  • Authentification des actions de service
    • Utiliser authentification utilisateur distincte dans Actions
    • Méthode d’authentification
  • Journalisation

Les fichiers de configuration .mapp de micro-app contiennent les éléments suivants :

• Propriétés
  • Name
  • Description
  • Icône
  • Action
  • (page Action)
• Notifications
  • Name
    • Déclencheur
  • Bouton Activer/désactiver
  • Contenu
    • Boutons d’action
  • Page cible
  • Paramètres
    • Conditions
  • Conditions d’expiration
• Pages
  • Toutes les propriétés et actions de la page
  • Mise en forme de toutes les pages
  • Tous les composants et paramètres de page
  • Toutes les actions appelées
• Localisation
  • Tous les paramètres de localisation
• Métadonnées
  • Identification de l’intégration utilisée pour créer votre micro-app.
  • Une structure de mappage des composants de la micro-app à la couche de cache de données d’intégration ; doit correspondre correctement à la nouvelle intégration.
  • Aucun paramètre d’abonnement n’est exporté.

Exporter une configuration

Pour exporter un fichier de configuration, procédez comme suit :

1. Ouvrez la console de gestion des micro-apps et recherchez l’intégration que vous souhaitez exporter.
2. Cliquez sur le menu des points de suspension pour l’intégration et sélectionnez Exporter intégration.
3. Saisissez les valeurs facultatives pour les champs Fournisseur et Description.
4. Sélectionnez ou désélectionnez les micro-apps que vous souhaitez inclure dans le fichier d’exportation.
5. Sélectionnez Exporter.
6. Enregistrez le fichier .mapp obtenu dans un emplacement sûr. Le fichier de configuration pour l’intégration sélectionnée est exporté au format de fichier .mapp vers votre machine locale.

Exporter une micro-app

Pour exporter un fichier de micro-app, procédez comme suit :

1. Ouvrez la console de gestion des micro-apps et recherchez l’intégration à partir de laquelle vous souhaitez exporter la micro-app.
2. Cliquez sur le menu des points de suspension de la micro-app à exporter, puis sélectionnez Exporter.
3. Enregistrez le fichier .mapp obtenu dans un emplacement sûr. Le fichier de configuration pour l’intégration sélectionnée est exporté au format de fichier .mapp vers votre machine locale.

Fonction d’importation

Lorsque vous importez des configurations d’intégration et de micro-apps, tenez compte des points suivants avant de commencer votre workflow d’exportation/d’importation :

• Vérifiez l’état de l’intégration après l’importation.
• Selon le type d’intégration exporté et les paramètres configurés, la configuration d’intégration doit être mise à jour.
• Après l’importation, l’état de l’intégration peut afficher l’avertissement Configuration de l’authentification requise. Vous devrez à nouveau configurer les informations d’identification de l’authentification pour que l’importation soit réussie.
• Aucune synchronisation, mise en cache ou action ne sont possibles tant que les informations d’identification du service ne sont pas mises à jour.

OAuth

Lors de l’exportation et de l’importation de micro-apps et d’intégrations qui utilisent OAuth, tenez compte des points suivants avant de commencer votre workflow d’exportation/importation :

• Pour les intégrations avec OAuth configuré pour les comptes de service ou les actions de service, l’intégration est exportée sans clé secrète client.
• Cela entraîne des problèmes pour tous les schémas d’authentification utilisant OAuth qui peuvent inclure le schéma d’authentification de service et le schéma d’authentification d’action de service.
• Aucune synchronisation ou aucune action n’est possible tant que les informations d’identification du service ne sont pas mises à jour.
• Une réauthentification est nécessaire pour obtenir des jetons d’accès mis à jour à partir du système d’enregistrement.

Pour remplir les informations d’identification OAUTH, procédez comme suit :

1. À partir de la console d’administration de micro-apps, recherchez l’intégration nouvellement importée.
2. Cliquez sur le menu des points de suspension en regard de l’intégration et choisissez Modifier.
3. Cliquez sur Propriétés à gauche
4. Remplissez les mots de passe manquants, les clés secrètes et réauthentifiez OAuth.

Limitations liées à l’importation de micro-apps

Les micro-apps sont créées dans les intégrations. L’intégration qui est le parent d’une micro-app est appelée intégration source. Lorsque vous importez une micro-app, vous pouvez l’importer dans la même intégration source ou dans une autre intégration ou intégration cible. Il existe des limitations importantes qui doivent être comprises lors de l’importation de micro-apps dans des intégrations cibles.

Impacts connus de l’importation de micro-apps :

• Toutes les notifications existantes (fiches de flux) sont supprimées lorsque la micro-app d’origine est supprimée.
• De nouvelles fiches de flux et notifications push sont générées à partir de la prochaine synchronisation (complète ou incrémentielle) de la nouvelle intégration.
• Les micro-apps ne peuvent être importées que dans une intégration cible qui correspond au même type d’intégration (intégration de modèle ou HTTP) que l’intégration source.

Remarque

Même si la structure de données sous-jacente (schéma) correspond pour les intégrations source et cible, la fonctionnalité d’importation de micro-app n’est pas en mesure de faire correspondre la structure de données de la micro-app à un autre type d’intégration.

L’intégration cible a une structure de base de données correspondant à l’intégration source :

• Si certaines tables mises en cache sont absentes dans l’intégration cible (schéma différent), la micro-app importée sera configurée incorrectement.
• Pour éviter ce problème, assurez-vous que le schéma des intégrations source et cible correspond.
• Accédez aux schémas d’intégration pour vérifier que les tables requises par la micro-app sont incluses dans le schéma.

Schéma de modèle de micro-app

Pour afficher le schéma d’une intégration de modèle, procédez comme suit :

1. Connectez-vous à la console d’administration des micro-apps et recherchez l’intégration que vous souhaitez afficher.
2. Cliquez sur le menu des points de suspension et choisissez Modifier.
3. Choisissez Tables dans le menu de gauche et cliquez sur le bouton pour modifier le schéma.
4. Passez en revue les tables et comparez les schémas source et cible. Cela garantit que les tables et entités identiques sont synchronisées avec le cache de données des micro-apps.

État de la micro-app après l’importation

Lorsque les micro-apps sont importées, les conditions suivantes se produisent :

• La micro-app n’a pas d’abonnés. Les abonnés doivent être recréés manuellement.
• Aucune notification ne sera créée sur cette micro-app tant que tous les abonnés n’auront pas été définis et que la prochaine synchronisation aura lieu.
• Les notifications sont générées automatiquement en fonction des préférences de déclenchement de notification (généralement après la prochaine synchronisation).

Étapes de configuration d’importation

Pour importer une configuration, procédez comme suit :

1. Ouvrez la console de gestion des micro-apps et cliquez sur Ajouter une intégration en haut de la console de gestion.
2. Sélectionnez le type d’intégration que vous souhaitez ajouter.
3. Cliquez sur le bouton Continuer en regard de l’option Importer une intégration précédemment configurée.
4. Faites glisser votre fichier .mapp d’intégration ou choisissez Parcourir pour sélectionner le fichier à partir d’un emplacement spécifique.
5. Si le fichier incorrect a été sélectionné, vous pouvez choisir de le supprimer en cliquant sur le lien Supprimer. Sinon, cliquez sur Importer.
6. L’intégration est affichée à côté de toutes les autres intégrations dans la console d’administration.

Étapes suivantes :

• Ajoutez les informations d’identification manquantes à la nouvelle intégration.
• Ajoutez des abonnés aux nouvelles micro-apps.
• Supprimez l’intégration d’origine dans l’environnement cible.

Importer une micro-app dans une intégration existante

Remarque

Les micro-apps contiennent des références à la structure de données de l’intégration qui a été utilisée pour les créer. Par conséquent, les micro-apps ne doivent être importées que dans une intégration cible compatible.

Pour importer une nouvelle micro-app dans une intégration cible existante, procédez comme suit :

1. Ouvrez la console d’administration de micro-apps et localisez l’intégration cible.
2. Sélectionnez le menu des points de suspension pour l’intégration cible et choisissez Importer micro-app.
3. Faites glisser votre fichier .mapp d’intégration ou choisissez Parcourir pour sélectionner le fichier à partir d’un emplacement spécifique.
4. Si le fichier incorrect a été sélectionné, vous pouvez choisir de le supprimer en cliquant sur le lien Supprimer. Sinon, cliquez sur Importer.
5. La micro-app est affichée à côté de toutes les autres micro-apps pour l’intégration.

Étapes suivantes :

• Ajoutez des abonnés aux nouvelles micro-apps.

Importer une nouvelle version de micro-app

Vous pouvez mettre à jour une micro-app vers une version plus récente à partir du menu d’options de la micro-app (points de suspension).

1. Sélectionnez Importer une nouvelle version en regard de la micro-app de votre choix sur l’écran Intégrations de micro-apps.

2. Faites glisser votre nouvelle micro-app et sélectionnez Importer.

   (Facultatif) Sélectionnez Supprimer fiches de flux existantes si vous souhaitez supprimer complètement l’ancienne version de votre micro-app du système. Si vous ne sélectionnez pas cette option, votre ancienne micro-app reste sur le système et est marqué d’un indicateur de fin de vie (EOL). Votre nouvelle version est définie en tant que micro-app active. Il est recommandé de ne pas supprimer vos anciennes micro-apps pour que vos fiches de flux créées puissent fonctionner correctement.

3. Cliquez sur Importer.

Votre nouvelle micro-app est importée.

Étapes suivantes :

• Ajoutez des abonnés aux nouvelles micro-apps.
• Fin de vie : vous pouvez définir manuellement la fin de vie d’une micro-app. Pour accéder à cette option, cliquez sur la micro-app pour la modifier et sélectionnez Propriétés.

Mettre à niveau une intégration

Pour mettre à niveau une intégration, procédez comme suit :

1. Ouvrez la console de gestion des micro-apps et cliquez sur Mise à niveau de l’intégration en haut de la console de gestion.
2. Sélectionnez le type d’intégration que vous souhaitez ajouter.
3. Faites glisser votre fichier .mapp d’intégration ou choisissez Parcourir pour sélectionner le fichier à partir d’un emplacement spécifique.
4. Si le fichier incorrect a été sélectionné, vous pouvez choisir de le supprimer en cliquant sur le lien Supprimer. Sinon, cliquez sur Mettre à niveau.
5. L’intégration est affichée à côté de toutes les autres intégrations dans la console d’administration.

Considérations concernant la mise à niveau de l’intégration

• Seules les intégrations HTTP sont prises en charge.
• Les structures de données acceptées incluent de nouveaux tableaux, de nouvelles colonnes dans des tableaux existants et de nouvelles relations. Aucune modification n’est autorisée pour les éléments suivants :
  • Tableaux (suppression d’un tableau ou modification des noms de tableau, clés primaires).
  • Colonnes (suppression d’une colonne ou modification des noms de colonne, de types de données, de clés primaires, de contraintes uniques, de valeurs NULL).
  • Relations (aucune suppression ni aucun changement n’est possible).
• Si des parties de l’ancienne structure ne sont plus nécessaires, vous pouvez garder des structures de données vides ou utiliser des scripts pour définir des valeurs.
• Aucune suppression des actions de service cible n’est autorisée. La validation s’applique à une action de service sur l’identificateur unique universel (UUID) et sa définition, y compris les paramètres, etc.
  • Si des modifications doivent être apportées aux actions de service, vous devez configurer ces actions de service en tant que nouvelles actions, puis mettre à jour chaque micro-app pour appeler l’action de service mise à jour.

Lorsqu’une mise à niveau de l’intégration réussit, les éléments suivants sont entièrement remplacés :

• Points de terminaison de données et définitions de webhook
• Actions de service (équivaut à conserver les anciennes actions lors de l’ajout des actions nouvellement configurées)
• Tous les scripts préparés dans le cadre du script d’intégration HTTP.

Après la mise à niveau :

• Une synchronisation complète est nécessaire pour mettre en cache les tables et colonnes nouvellement incluses. Tant qu’elle n’est pas synchronisée, l’application peut ne pas fonctionner correctement (en raison de données manquantes).
• Uniquement les entités d’intégration, les relations, les points de terminaison de données, les scripts et les actions de service sont importés et disponibles pour la mise à niveau de l’intégration (aucune propriété, autorisation, etc.).