Publier des modèles

La publication d’un modèle permet de créer un élément d’outil hébergé qui peut être exécuté comme un outil Web personnalisé.

La procédure suivante permet de publier un modèle :

1. Créez un modèle.
2. Ajoutez des variables pour les entrées qui doivent être configurables pour l’outil Web.
3. Définissez les variables en tant que paramètres de modèle.
4. Gérez les paramètres pour personnaliser la manière dont ils s’affichent dans l’outil Web personnalisé.
5. Exécutez et enregistrez le modèle.
6. Publiez le modèle.

Licences requises

La publication d’un modèle requiert les licences et les configurations permettant d’utiliser ModelBuilder, ainsi que le privilège Publish web tools (Publier des outils Web).

Définir les variables en tant que paramètres de modèle.

Les variables définies en tant que paramètres de modèle s’affichent comme des paramètres d’outil lorsque le modèle est publié et ouvert en tant qu’outil Web personnalisé, ce qui permet de spécifier des données ou des valeurs différentes de celles indiquées lors de la création du modèle.

Les variables de données hébergées sont automatiquement définies en tant que paramètres de modèle, tandis que les variables de valeur et de données en entrée doivent être définies manuellement en tant que paramètres. Les variables de données intermédiaires en sortie ne peuvent pas être définies en tant que paramètres de modèle.

Pour définir des données en entrée et des variables de valeur, procédez comme suit :

1. Suivez les étapes permettant de créer ou ouvrir un modèle et de vous connecter à une session d’analyse.
2. Ajoutez des données, des outils et des variables si nécessaire.
3. Cliquez sur un élément de variable pour le sélectionner.

   La barre d’outils de l’élément apparaît au-dessus de la variable sélectionnée.

4. Cliquez sur Add or remove parameter (Ajouter ou supprimer un paramètre) .

   Une icône de paramètre apparaît sur la variable pour indiquer qu’elle est définie en tant que modèle de paramètre.

Une fois que les variables nécessaires sont définies comme paramètres de modèle, vous pouvez gérer les paramètres de l’outil Web.

Gérer les paramètres de l’outil Web

La fenêtre Manage web tool parameters (Gérer les paramètres de l’outil Web) permet de réorganiser et de mettre à jour les paramètres dans l’outil Web personnalisé.

Pour gérer les paramètres de l’outil Web, procédez comme suit :

1. Procédez comme indiqué ci-dessous pour créer ou ouvrir un modèle contenant des données, des outils, des variables et des paramètres de modèle.
2. Si ce n’est déjà fait, connectez-vous à une session d’analyse.
3. Dans la barre d’outils des actions, cliquez sur Manage web tool parameters (Gérer les paramètres de l’outil Web) .

   La fenêtre Manage web tool parameters (Gérer les paramètres de l’outil Web) s’ouvre. Les paramètres du modèle sont présentés dans l’ordre dans lequel ils ont été ajoutés. Chaque paramètre porte un nom et un alias. L’alias est lié au paramètre Parameter label (Étiquette du paramètre).

   Remarque :

   Vous ne pouvez pas ajouter ou supprimer de paramètres depuis la fenêtre Manage web tool parameters (Gérer les paramètres de l’outil Web). Pour plus d’informations sur l’ajout et la suppression de paramètres, reportez-vous à la rubrique Définir des variables en tant que paramètres de modèle.

4. Cliquez sur Expand (Développer) pour afficher les paramètres.
5. Le cas échéant, mettez à jour les paramètres suivants :
   • Parameter label (Étiquette du paramètre) : étiquette courte du paramètre de l’outil. Ce texte apparaît comme nom du paramètre dans le volet de l’outil Web personnalisé. L’étiquette doit être courte et décrire l’objectif du paramètre en termes clairs.
   • Pop-up help text (Texte d’aide de la fenêtre contextuelle) : brève description du paramètre de l’outil. Ce texte s’affiche lorsque vous cliquez sur le bouton d’aide en regard du paramètre dans la fenêtre de l’outil Web personnalisé. Ajoutez une description de la fonction du paramètre, de la façon dont différentes valeurs affectent les résultats de l’outil, des entrées prises en charge et des valeurs par défaut si nécessaire.
   • Required (Obligatoire) : indique si le paramètre est obligatoire pour valider et exécuter l’outil. Si le paramètre de modèle est connecté à un ou plusieurs paramètres d’outil obligatoires, cette valeur est activée et ne peut pas être modifiée. Si tous les paramètres d’outil connectés sont facultatifs, le paramètre de modèle peut être activé pour rendre le paramètre obligatoire ou désactivé pour le rendre facultatif. Le fait de rendre un paramètre obligatoire force l’utilisateur à fournir une entrée avant de pouvoir exécuter l’outil Web.
   • Data type (Type de données) : indique les entrées compatibles avec le paramètre. Cette valeur est fonction du type de données de variable et ne peut pas être modifiée.
   • Filter (Filtre) : détermine des limites ou restreint les valeurs ou données en entrée qui peuvent être spécifiées pour le paramètre. Les options dépendent du type de données comme suit :
     • Double : valeurs minimale et maximale
     • Feature layer (Couche d’entités) : liste les types d’entités admis, y compris le multipoint, le point, la ligne et le polygone.
     • Field (Champ) : liste des types de champs admis
     • Integer (Entier) : valeurs minimale et maximale
     • String (Chaîne) : liste de valeurs uniques.
     Les filtres sont réinitialisés pour un paramètre de modèle si une nouvelle connexion est créée entre la variable et un outil dans le diagramme du modèle. Les filtres doivent être revus et mis à jour après modification des connexions du modèle.
   • Include default value (Inclure une valeur par défaut) : indique si le paramètre de l’outil doit comporter une valeur par défaut. Si cette option est activée, le paramètre utilise une valeur par défaut en fonction de la valeur de la variable. Si cette option est désactivée, le paramètre est vide par défaut. Une valeur par défaut peut permettre de guider les saisies de l’utilisateur ou de simplifier l’exécution de l’outil Web car l’utilisateur n’a pas besoin de mettre à jour manuellement le paramètre. Cette option doit être utilisée pour les paramètres comportant un menu de valeurs acceptées (des unités, par exemple) et pour les paramètres dans lesquels il est prévu d’utiliser souvent la même valeur en entrée sans avoir besoin de la mettre à jour.

     Remarque :

     Les valeurs par défaut ne sont pas appropriées pour la plupart des entrées de texte, de nombre ou de couche d’entités.

     De plus, n’utilisez pas de valeurs par défaut pour les paramètres que vous souhaitez peut-être laisser vides, par exemple une entrée facultative de couche d’entités. La valeur par défaut est utilisée lors de l’exécution de l’outil, même si la valeur est effacée manuellement dans la fenêtre de l’outil Web publié.

   • Default value (Valeur par défaut) : indique la valeur par défaut du paramètre de l’outil. Pour modifier la valeur par défaut, mettez à jour la valeur de la variable dans le diagramme du modèle. La valeur par défaut doit être une valeur qui donnera un résultat précis ou préféré dans la plupart des cas. Ce paramètre est disponible uniquement si le paramètre Include default value (Inclure une valeur par défaut) est activé.
6. Cliquez sur Collapse (Réduire) pour masquer les paramètres.
7. Répétez les trois étapes précédentes pour chacun des paramètres restants.

   Vous pouvez également changer l’ordre des paramètres, le cas échéant.

8. Cliquez sur Reposition (Repositionner) en regard du nom d’un paramètre et faites glisser le paramètre vers une autre position.

   Vous pouvez également cliquer sur Reposition (Repositionner) et choisir une option dans le menu. Selon la position du paramètre, les options proposent Move up (Remonter), Move down (Descendre), Move to top (Déplacer vers le haut) et Move to bottom (Déplacer vers le bas).

9. Cliquez sur Save (Enregistrer).

Les paramètres de l’outil Web sont enregistrés et la fenêtre Manage web tool parameters (Gérer les paramètres de l’outil Web) se ferme. Vous êtes désormais prêt à publier le modèle.

Publier un modèle

La publication d’un modèle permet de créer un élément d’outil qui peut être partagé et exécuté en tant qu’outil Web personnalisé.

Pour publier un modèle, procédez comme suit :

1. Procédez comme suit pour créer ou ouvrir un modèle contenant des données, des outils, des variables et des paramètres.

   Remarque :

   Les modèles qui satisfont tous les critères de publication requis peuvent être publiés sans devoir se connecter à une session d’analyse. Si votre modèle est prêt à être publié, ouvrez-le et passez à l’étape 6.

2. Si ce n’est déjà fait, connectez-vous à une session d’analyse.
3. Exécutez le modèle.

   L’exécution du modèle n’est pas obligatoire, mais permet de s’assurer que l’outil Web va fonctionner correctement.

4. Enregistrez le modèle.

   L’outil Web publié est basé sur l’élément de modèle d’analyse enregistré. Le modèle doit être enregistré avant de pouvoir être publié. Si des modifications sont apportées au modèle, vous devez à nouveau l’enregistrer.

   Avant de publier le modèle, affichez l’aperçu de l’outil Web pour vérifier que ses paramètres ont été correctement définis.

5. Sur la barre d’outils du modèle, cliquez sur Preview web tool (Prévisualiser l’outil Web) .

   Un aperçu de l’outil Web s’affiche dans le volet Analysis (Analyse). Si des modifications doivent être apportées à l’outil Web, retournez aux flux de travail pour définir et gérer les paramètres. Cliquez à nouveau sur Preview web tool (Prévisualiser l’outil Web) pour mettre à jour l’aperçu.

   Dès que l’aperçu affiche tous les paramètres et configurations de votre choix dans l’outil Web, vous pouvez publier le modèle.

6. Dans la barre d’outils du modèle, cliquez sur Publish (Publier) .

   La fenêtre Publish as web tool (Publier en tant qu’outil Web) s’ouvre. Si les conditions requises pour la publication ne sont pas satisfaites, examinez les exigences restantes, fermez la fenêtre Publish as web tool (Publier en tant qu’outil Web) et effectuez les actions requises pour satisfaire à toutes les exigences avant de revenir à ce processus.

   En savoir plus sur les exigences pour la publication

   Si les critères de publication sont satisfaits et que vous êtes connecté à une session d’analyse, vous pouvez fermer la fenêtre Publish as web tool (Publir en tant qu’outil Web), vous déconnecter de la session d’analyse et répéter cette étape en mode lecture seule.

7. Procédez comme suit pour le nouvel élément :
   • Indiquez un titre.

     Le titre ne doit pas contenir d’espace. Vous pouvez mettre à jour le titre de l’élément d’outil une fois qu’il a été publié depuis la page de l’élément.

   • Dans My content (Mon contenu), choisissez un dossier dans lequel l’élément doit être enregistré.
   • Indiquez des balises et un résumé décrivant l’élément.
8. Cliquez sur Publish (Publier).

   Le modèle est publié et un élément d’outil est créé.

9. Cliquez sur Open web tool item (Ouvrir l’élément d’outil Web) pour ouvrir les détails de l’élément d’outil ou fermez la fenêtre Publish as web tool (Publier en tant qu’outil Web).

Vous pouvez ouvrir l’outil Web personnalisé à partir de la fenêtre Tool (Outil) en cliquant sur Open custom web tool (Ouvrir un outil Web personnalisé). Vous pouvez également partager l’élément d’outil avec votre organisation ou vos groupes à partir de la page des détails.

Remarque :

Vous ne pouvez pas partager des éléments d’outil avec le public.

Remplacer l’outil Web

Lorsqu’un modèle a déjà été publié, le bouton Publish (Publier) est remplacé par le bouton Overwrite (Remplacer). Vous pouvez apporter des modifications à l’outil Web existant, mettre à jour le modèle et suivre les étapes permettant de publier le modèle à l’aide du bouton Overwrite (Remplacer).

Conditions requises de la publication

Toutes les conditions requises décrites ci-dessous doivent être remplies pour activer la publication d’un modèle d’analyse en tant qu’outil Web.

Privilèges utilisateur de publication

Votre compte d’utilisateur doit satisfaire les conditions requises relatives aux licences pour publier des modèles d’analyse en tant qu’outils Web. Si votre compte ne remplit pas les conditions requises relatives aux licences, le bouton Publish (Publier) n’est pas disponible.

Pour mettre à jour les privilèges de votre compte d’utilisateur, contactez l’administrateur de votre organisation.

Créer une sortie hébergée

Un modèle d’analyse doit créer une sortie sous forme de couche tabulaire ou de couche d’entités hébergée avant de pouvoir être publié en tant qu’outil Web. Par défaut, tous les outils ajoutés à un modèle créent des sorties intermédiaires plutôt que des sorties hébergées.

Pour répondre à ces exigences, assurez-vous que le paramètre Result layer (Couche de résultat) d’un outil est défini sur Create hosted layer (Créer une couche hébergée) ou sur Overwrite existing layer (Remplacer la couche existante). Les sorties hébergées sont définies en tant que paramètres de modèle et ajoutées à la carte Web après l’exécution du modèle ou de l’outil Web. Créez une couche hébergée pour la sortie que vous souhaitez visualiser comme résultat de l’analyse, par exemple le dernier outil du modèle. Pour optimiser les résultats, ne créez des sorties hébergées que pour un seul outil du modèle.

En savoir plus sur les sorties de modèle

Gérer les paramètres de l’outil Web

Les erreurs liées aux paramètres de l’outil Web doivent être résolues dans la fenêtre Manage web tool parameters (Gérer les paramètres de l’outil Web).

Le message The default value is outside the filter range (La valeur par défaut se trouve en dehors de la plage du filtre) s’affiche si la valeur par défaut et la plage du filtre ne sont pas compatibles (par exemple, si les valeurs du filtre sont des nombres entre 1 et 10 et que la valeur par défaut est 11). La valeur par défaut du paramètre de modèle dépend du paramètre de variable et les valeurs de filtre sont définies dans la fenêtre Manage web tool parameters (Gérer les paramètres de l’outil Web). Pour résoudre l’erreur, mettez à jour les valeurs de filtre dans la fenêtre Manage web tool parameters (Gérer les paramètres de l’outil Web) ou modifiez la valeur de la variable afin de mettre à jourr la valeur par défaut du paramètre.

Les outils sont prêts pour l’exécution

Tous les outils et les entrées et sorties requises doivent être à l’état Prêt à être exécuté ou Déjà exécuté. Si un ou plusieurs éléments ne sont pas prêts à être exécutés, cette condition requise n’est pas satisfaite. Pour résoudre ce problème, ouvrez l’élément d’outil pour passer les erreurs en revue ou définissez les paramètres requis. Vous devez être connecté à une session d’analyse et le modèle doit être actif pour que vous puissiez mettre à jour le modèle.

Enregistrer les modifications apportées au modèle

Les modifications apportées au modèle qui sont en attente doivent être enregistrées. L’outil Web publié est basé sur l’élément de modèle d’analyse enregistré. Si le modèle comporte des modifications non enregistrées, la publication n’est pas activée.

Exécution du modèle

Il est recommandé d’exécuter le modèle terminé jusqu’au bout avant de le publier en tant qu’outil Web afin de s’assurer que celui-ci fonctionnera correctement et créera les résultats attendus.

Limitations

Il n’est pas possible d’obtenir des informations sur les champs pour les paramètres de l’outil Web créés à partir de variables de champs si le jeu de données en entrée est une sortie d’un outil d’analyse ou lorsque la même variable de champ est utilisée pour plusieurs jeux de données en entrée. En conséquence, les limitations suivantes s’appliquent au paramètre de l’outil Web :

• Le paramètre de l’outil Web ne présentera pas de menu d’options des champs. À la place, le nom du champ peut être saisi dans une zone de texte.
• Les filtres de type de champ définis dans la fenêtre Manage web tool parameters (Gérer les paramètres de l’outil Web) ne seront pas respectés.