Skip to main content

Instructions sur la création d’applications

Une application analytique Alteryx est un programme autonome qui effectue une fonction spécifique pour le compte de l'utilisateur. L'interface doit être simple et l'application conçue avec un objectif unique. L'application doit effectuer un nombre limité de tâches focalisées sur une expérience utilisateur optimale. Dans la mesure où les applications que vous créez seront exécutées dans un navigateur Web, les éléments de conception principaux doivent être astucieux, élégants et efficaces.

Jeu de données Version la plus récente

Lorsque vous créez une application utilisant un jeu de données spécifique, celui-ci doit être défini pour utiliser la version la plus récente. Cela signifie qu'Alteryx Designer exploitera automatiquement la dernière version du jeu de données installée sur l'ordinateur de l'utilisateur. Cela s'applique aux outils Analyse démographique (Allocate), aux outils Analyse comportementale (Solocast), aux outils Calgary et aux fonctions Temps de trajet, Géocodeur et Carte de référence dans les outils de cartographie. Pour définir le jeu de données, dans Designer, sélectionnez Options > Paramètres utilisateur > Modifier les paramètres utilisateur > Outils et utilisez la section Valeurs par défaut des jeux de données pour effectuer vos sélections.

Onglet Méta-infos

Les informations renseignées dans l'onglet Méta-infos de la fenêtre Configuration du workflow s'affichent dans les détails de l'application sur le Web.

  • Utiliser le nom de fichier  : cette option indique le nom du fichier.

  • Personnalisé  : sélectionnez cette option pour donner un nom convivial à l'application. Par exemple, si le fichier de l'application s'appelle Télécharger_données_météo, le nom personnalisé peut reprendre cette base, mais sans les traits de soulignement : Télécharger les données météo.

  • Description  : la description saisie ici apparaît sur le Web pour définir l'application. Vous devez donc vous assurer qu'elle est précise et conviviale.

  • URL  : le champ URL permet d'inclure un lien vers un site Web externe.

  • Texte d'affichage (facultatif)  : utilisez ce champ pour indiquer le texte d'affichage de l'URL.

  • Paramètres de l'outil  (Macros uniquement) : ces paramètres ne s'appliquent qu'aux macros. Pour plus d'informations sur le référentiel de macro, consultez la section Macros sous l'onglet Outils des Paramètres utilisateur . Ces paramètres permettent de créer plusieurs versions d'une macro. Les macros enregistrées dans le référentiel de macros apparaissent dans la palette d’outils.

    • Nom de l'outil racine  : entrez un nom pour l'outil. Plusieurs outils peuvent être associés au même nom racine. Toutefois, un seul outil est affiché dans la palette d'outils.

    • Version de l'outil  : saisissez le numéro de version de l'outil. La version la plus récente d'un outil s'affiche dans la palette d'outils. Pour afficher un menu à partir duquel vous pouvez accéder aux versions antérieures d'un outil Macro, faites glisser l'outil dans le canevas, puis cliquez dessus avec le bouton droit.

    • Outil En base de données ?  : sélectionnez cette option si l'outil peut être utilisé dans un workflow avec des outils en base de données.

  • (Macros uniquement) Palette d'outils : les paramètres s'appliquent uniquement aux workflows macros. Pour plus d'informations sur le référentiel de macro, consultez la section Macros sous l'onglet Outils des Paramètres utilisateur . Ces paramètres déterminent le mode d’affichage des macros dans la palette d'outils. Les macros enregistrées dans le référentiel de macros apparaissent dans la palette d’outils.

    • Nom de catégorie  : saisissez le nom de la catégorie dans laquelle la macro doit apparaître dans la palette d'outils.

    • Balises de recherche  : saisissez les termes qu'un utilisateur peut utiliser pour rechercher et identifier la macro. Par défaut, Nom de fichier, Nom personnalisé, Nom de l'auteur et Nom de l'entreprise sont inclus comme des balises de recherche.

  • Auteur  : fournit des renseignements sur le créateur de l’application analytique.

    • Nom  : saisissez le nom de l'auteur.

    • Entreprise  : saisissez l'entreprise à laquelle l'auteur est associé.

    • Copyright  : saisissez les informations de droits d'auteur.

  • Récupérer les valeurs par défaut  : sélectionnez cette option pour annuler votre travail et utiliser le texte par défaut.

  • Se souvenir par défaut  : permet d'enregistrer le texte que vous avez saisi en tant que texte par défaut.

Extension .yxwz

Lorsque vous créez une application, veillez à enregistrer le fichier au format YXWZ même si vous avez attribué au workflow le type « Application analytique ». Si vous gardez l'extension de fichier .yxmd, celui-ci s'ouvre en tant que workflow et non en tant qu'application.

Les applications créées dans la version 9.0 ne peuvent plus être enregistrées au format de fichier YXMD.

Entrée de carte

L' outil Entrée de carte permet de sélectionner un emplacement ou de dessiner un polygone ou une ligne. Les questions de carte doivent être brèves mais descriptives et une carte de référence doit toujours être utilisée. Lorsque vous sélectionnez une carte de référence, assurez-vous de choisir la Version la plus récente .

Enfin, si le mode Dessiner est sélectionné, assurez-vous que le paramètre L'utilisateur peut associer une étiquette aux fonctions est toujours coché. L’utilisateur pourra ainsi ajouter un nom à chacun de ses polygones personnalisés.

Sortie de rapport

Lorsque vous enregistrez une application dans Server, si la sortie du rapport est rendue au format PCXML, l'application permet aux utilisateurs non seulement de prévisualiser le rapport sur le web, mais aussi de le télécharger dans l'un des formats pris en charge. Formats des rapports pris en charge : PDF, Microsoft Word, Microsoft Excel et HTML.

Lorsque vous créez une application, la sortie peut correspondre à l'un de nos formats de rapport pris en charge. Pour utiliser PCXML définissez le mode de sortie dans Outil Rendu pour Sélectionner un fichier de sortie spécifique et pour le fichier de sortie , utilisez NOM_APP.pcxml .

Lorsque vous prévisualisez un rapport au format PCXML, les pieds de page ne sont pas visibles, mais ils sont présents lorsque vous téléchargez le document au format PDF, Word ou Excel.

Lecture et écriture de fichiers : macros dans une application

Pour les applications Web, vous pouvez uniquement lire et écrire dans les fichiers se trouvant dans le même dossier que votre application ou dans un dossier inférieur ; en d'autres termes, tout dossier qui se trouve dans le dossier contenant l'application (le sous-dossier peut être situé plusieurs niveaux sous le dossier de l'application). Cette règle s'applique également aux macros que vous souhaitez utiliser pour votre application, sauf s'il s'agit d'une macro standard faisant partie du programme d'installation du produit Alteryx ou d'un programme d'installation de données.

%temp%

N'utilisez pas %temp% pour écrire dans le répertoire temporaire lorsque vous développez des workflows ou des applications à enregistrer dans Server. Conservez tous les chemins de fichiers dans le workflow. Si vous développez une application chaînée, utilisez uniquement le nom de fichier plutôt que n'importe quel chemin de fichier, par exemple, Sortiedefichier.yxdb et pas %temp%\Sortiedefichier.yxdb ou tout autre nom similaire. Accédez à un fichier pour le sélectionner et remplacez le chemin de ses dépendances en un chemin relatif à l'aide de la fenêtre Dépendances du workflow .

Événements et outils interdits

Ces outils et événements Alteryx Designer sont interdits dans l'espace Galerie de la Communauté, également appelé Analytics Gallery, en raison des nombreuses configurations et actions possibles :

Si votre workflow utilise l'un des outils ou événements interdits en toute sécurité, vous pouvez demander une exemption pour exécuter le workflow dans la galerie. Pour demander une exemption...

  1. Envoyez un e-mail à l’adresse curator@alteryx.com et expliquez comment et pourquoi chaque outil interdit est utilisé, ainsi que l’objectif général du workflow.

  2. Publiez le workflow dans votre espace Studio privé et activez l’option Les autres utilisateurs peuvent télécharger ce workflow.

  3. Ajoutez le workflow à une collection et partagez-le avec un agent Alteryx Curator à l’adresse curator@alteryx.com.

  4. Votre workflow sera alors examiné dans les deux jours ouvrables et un administrateur Alteryx vous enverra par e-mail l’état de votre demande.

Les macros prédictives incluses avec Designer qui utilisent l'outil R sont autorisées dans la Galerie de la Communauté Alteryx .

Fonctionnalités d'applications non prises en charge pour le Web

Les éléments suivants ne sont pas pris en charge dans l'environnement Web de la Galerie de la communauté.

  • Explorateur de dossiers

  • Explorateur de fichiers (Enregistrer sous), le téléchargement fonctionne bien sur le Web.

  • Si une application génère des erreurs dans l'environnement de Desktop, vous ne pouvez pas l'enregistrer sur Server.

  • Les chaînes d'applications de plus de 7 applications ne fonctionnent pas sur Server.

Meilleures pratiques pour la création d’applications

Mettre à jour des actions

Lorsque vous utilisez l' outil Action pour mettre à jour/modifier la valeur, n'utilisez pas l'option Remplacer une chaîne spécifique  : sauf si vous n'avez pas le choix. Si vous modifiez la configuration de l'outil au sein de votre workflow dans le cadre d'un processus de développement continu, vous pouvez éliminer cet outil Action, car il se peut que cette chaîne n'existe plus. Évidemment, à certains moments vous devez utiliser cette option. Mais n'oubliez pas que, si vous modifiez cette chaîne dans l'outil, vous risquez de devoir également mettre à jour l'outil Action.

Mettre à jour des détours

Si vous utilisez un outil Action pour mettre à jour un outil Détour , essayez d'être complet et de mettre à jour le détour pour les deux cas possibles, c'est-à-dire le détour gauche et le détour droit. Si vous ne mettez à jour que l'un de ces choix et si vous modifiez le workflow au cours du développement, vous n'aurez pas anticipé les moments où le workflow devra emprunter un autre chemin.

Finaliser des détours

Tous les détours doivent être finalisés, particulièrement avant de joindre les flux de données d’un détour à un autre endroit du workflow. Un outil Fin du détour n'a pas besoin d'être configuré, ce qui le rend très simple d'emploi. N'oubliez pas de les utiliser ou de finaliser le détour avec un outil de sortie.

Utiliser l'outil Message d'erreur

Lorsque vous écrivez des questions, pensez à vos utilisateurs en anticipant les erreurs les plus courantes. Vous pouvez créer des avertissements au moyen d'un outil Message d'erreur . Par exemple, si l'utilisateur doit sélectionner une option, affichez un message d'erreur lorsqu'il ne sélectionne rien. Cela peut éviter que le moteur n'indique des erreurs trop complexes pour que l'utilisateur puisse comprendre comment les corriger. Dans l'idéal, vous devez prévoir un message d'erreur pour chaque question destinée à l'utilisateur. Vous pouvez également prévoir des conditions plus complexes pour vous assurer que le contenu sera correctement renseigné. Par exemple, si l’utilisateur doit indiquer dans une zone de texte jusqu’à 5 zones de chalandise séparées par virgules (par exemple 1, 2, 3, 4, 5), vous pouvez utiliser une expression régulière pour vérifier qu’il n’y a pas plus de 4 virgules dans la zone de texte.

Créer des messages à l'aide de l'outil Message d'erreur

Vous pouvez également tenter d'anticiper les cas où l'application peut avoir un problème même lorsqu'elle est correctement configurée. Par exemple, l'utilisateur peut saisir une adresse qui n'est pas géocodable et qui ne renvoie aucun résultat. Vous pouvez aisément gérer les messages dans votre application en filtrant les géocodes erronés puis en utilisant l' outil Message pour informer l'utilisateur : « L'adresse saisie n'est pas géocodable. Vérifiez que l’adresse est valide et apportez les modifications nécessaires ou indiquez une autre adresse et relancez l’exécution. »

Mettre à jour le XML brut et échapper les métacaractères HTML

Si vous mettez à jour le XML brut pour un outil ou si vous utilisez des caractères spéciaux dans vos applications, n'oubliez pas que sur le Web, le résultat ne sera pas forcément celui attendu. Par exemple, une sélection de l' outil Liste déroulante ou l' outil Zone de liste sur le moteur peut contenir du texte tel que : Age By Sex Summary Report:<Report Type=”summary”>Age By Sex Summary Report</Report>

Pourtant, sur le Web la question ne s'affiche pas correctement. Par conséquent, pour une action vous n'obtenez probablement pas l'effet souhaité. Pour corriger ce problème, vous pouvez modifier le texte : Age By Sex Summary Report:&lt;Report Type=&quot;summary&quot;&gt;Age By Sex Summary Report&lt;/Report&gt;

Alors, si vous utilisez la réponse à la question dans une action, vous devrez la mettre à jour comme suit : EscapeXMLMetacharacters([AllocateSummaryReport])

La fonction d'échappement des métacaractères XML a été ajoutée à la bibliothèque de formules dans la version 8.0. Vous pouvez y accéder depuis la catégorie spécialisée. Cette fonction remplace tous les métacaractères XML par les versions avec échappement.

Arborescences de variables d'Allocate

Le Web et le moteur renvoient des valeurs différentes si une arborescence des variables d'Allocate est laissée vide. Si l'application possède un type de question Arborescence des variables d'Allocate, vous pouvez écrire une condition qui vérifie si l'utilisateur a effectué une sélection ou s'il a vraiment laissé l'arborescence vide. Pour le moteur, vous pouvez écrire quelque chose comme :

[AllocateVariables] == "<Variables />"

Si aucune sélection n'est effectuée pour l'arborescence des variables, <Variables /> est renvoyé. Toutefois, sur le Web, la valeur renvoyée ne correspond en fait à rien, vous devez donc utiliser la condition suivante :

isempty([AllocateVariables])

Évidemment, les applications doivent fonctionner aussi bien sur le Web que sur le l'ordinateur de bureau. Ainsi, la condition doit être en réalité :

[AllocateVariables] == "<Variables />" or isempty([AllocateVariables])

Si l'utilisation sur le Web des caractères <, > et / pose problème, la condition peut être modifiée comme suit :

REGEX_CountMatches([AllocateVariables], "Variables") == 1 ou isempty([AllocateVariables])

Outil Union

Il est préférable de ne pas ajouter l' outil Union configuré manuellement dans les applications. En effet, dans la plupart des cas, le workflow change au moment de l'exécution. Au lieu de configurer l’outil Union en mode manuel, insérez des outils Sélectionner dans chaque connexion alimentant l'outil Union. Lorsque vous configurez l'outil Sélectionner, renommez et réorganisez les champs à votre convenance en prenant soin de ne pas inclure les champs de type Dynamique/Inconnu. Configurez l’outil Union à l’aide de la fonction Configuration auto par nom ou Configuration auto par position.

Conteneurs d’outils et organisation des applications

L’organisation de l’application est effectuée en partie à l’aide de plusieurs conteneurs d’outils pour les différentes sections de l’application. Par exemple, tous les outils de génération de rapports figurent généralement dans la dernière section d'une application et peuvent être placés dans un conteneur d'outils appelé « Génération de rapports ».

Un outil Conteneur d'outils peut être être codé par couleur suivant la fonction qu'il met en évidence. Le codage couleur des conteneurs d'outils permet de comprendre plus facilement ce que fait une application, en particulier lorsqu'elle est visualisée avec un petit zoom. Il s'avère utile pour dépanner ou déboguer une application créée par un tiers.

Les outils Interface doivent être placés dans leurs propres conteneurs et identifiés comme il se doit avec des couleurs. Pour les applications contenant plusieurs onglets, il est utile de placer les outils composant chaque onglet dans leur propre conteneur.

Annotations pour workflows et applications

Les annotations sont des zones de texte associées à un outil spécifique. Elles peuvent être très utiles pour décrire le rôle de chaque outil. Il est très intéressant de noter que, si vous déplacez l’outil, l’annotation se déplace également. Sous Configuration du workflow , définissez les annotations  sur Afficher.

Si nécessaire, vous pouvez placer des annotations en haut ou en bas d'un outil.  Pour modifier l' annotation , cliquez sur l'outil , sélectionnez l'onglet Annotation et sélectionnez ou désélectionnez Placer l'annotation en haut .

Instructions spécifiques des macros

Toutes les instructions précédentes s’appliquent aux macros et aux applications, à l’exception des paragraphes suivants qui ne concernent que les macros.

Entrées de macro

Un outil Entrée de macro doit inclure des données. L’ajout des données est très important pour faciliter le dépannage ou le débogage des problèmes. Une saisie de texte est intégrée à l’outil Entrée de macro. Il s’agit de la méthode recommandée pour l’entrée des macros. Si vous avez besoin d’un fichier plus volumineux pour l’entrée de données, vous devez l’incorporer à la macro dans la mesure du possible. Les dépendances des fichiers de données pour les macros doivent être nommées selon le modèle suivant :

Nomdelamacro.Nomdufichierdedonnées.yxdb

Les noms d’entrées et de sorties ne doivent pas être associés à un numéro d’outil. Dans l’onglet Propriétés de l’outil Entrée de macro, vérifiez que le nom est suffisamment descriptif. Le nom que vous spécifiez ici est visible par les utilisateurs lorsqu'ils configurent l'outil macro.

Lorsqu'il existe plusieurs entrées et sorties, l'ajout d'une abréviation du connecteur aide l'utilisateur à configurer l'outil en fournissant une étiquette sur l'ancrage d'outil lorsque l'outil est placé sur le canevas. Pour plus d'informations, consultez la section Outil Entrée de macro ou Outil Sortie de macro .

Dénomination des onglets

Les noms d’onglets doivent être descriptifs pour aider l’utilisateur à configurer l’outil Macro. Les onglets sont visibles par l'utilisateur au moment de la configuration. Le nom d'onglet par défaut est « Questions ». Il n'est pas très descriptif et il est généralement laissé tel quel lors du développement de macros (ou d'applications) ne contenant qu'un seul onglet. Voir Fenêtre Concepteur d'interface .

Macros connexes

Les macros connexes utilisées dans un workflow parent doivent être enregistrées avec la macro parente ou dans un répertoire annexe et nommées ainsi : Nomduparent.Nomconnexe.yxmc .