Ce guide fournit des instructions étape par étape pour mettre en œuvre le modèle Exécuter une requête et télécharger les résultats avec une feuille de contrôle. Ce modèle constitue une alternative à la commande Exécuter une requête, qui exigeait auparavant que les utilisateurs entrent manuellement les paramètres dans les chaînes avant le déploiement et l’exécution.
Grâce à l’utilisation d’une feuille de contrôle, les utilisateurs peuvent ajouter plusieurs ID de requête et définir des paramètres, tels que Liste de sélection ou Sélection multiple, de manière dynamique. Ce modèle est généralement intégré aux chaînes existantes, mais peut également être utilisé dans tout flux de travail nécessitant des résultats de requête au format CSV.
Conditions préalables
Les connecteurs suivants doivent être activés et configurés dans votre espace de travail.
- Configurer le connecteur Workiva
- Configurer le connecteur JSON de
- Configurer le connecteur du guidon
- Configurer le connecteur de requête HTTP
- Configurez le connecteur de transformation tabulaire
Les variables d’espace de travail suivantes doivent être créées dans votre espace de travail :
- wsv_API URL de base - IAM
- wsv_Client ID
- wsv_Client Secret
- wsv_API URL de base - Wdata
Trouver le modèle
Le modèle Exécuter une requête et télécharger les résultats avec une feuille de contrôle se trouve dans la section Chaînes Workiva de l’écran Modèles.
Voici comment le trouver :
- Dans Chain Builder, allez dans l’onglet Templates .
- Sélectionnez Workiva Chains dans le menu du haut.
- Recherchez 0.0 Exécuter une requête | Orchestration niveau supérieur en haut à droite et ouvrez le modèle.
-
Après avoir localisé le modèle, cliquez sur New Chain pour le déployer dans votre espace de travail.
Note : Une fois configurée, chaque chaîne de ce modèle doit être publiée dans l’espace de travail.
Variables
| Type de variable | Nom de la variable | Description |
|---|---|---|
| Variable de l'espace de travail | wsv_API URL de base - IAM |
Saisissez l’URL de base pour l’API en fonction de votre région :
|
| Variable de l’espace de travail | wsv_Client ID |
Saisissez l’ID client que vous recevez lors de la configuration d’un accord d’accès à l’API. Consultez ici pour plus d’instructions concernant l’API Workiva. |
| Variable de l’espace de travail | wsv_Client Secret |
Vous pouvez afficher le secret de votre accord d’accès à l’API en accédant à l’onglet Sécurité de votre profil utilisateur, puis en cliquant sur l’option Régénérer dans le menu déroulant Actions en regard de l’accord. Consultez ici pour plus d’instructions concernant l’API Workiva |
| Variable de l’espace de travail | wsv_API URL de base - Wdata |
Saisissez l’URL de base pour l’API en fonction de votre région : |
Entrées en cours d’exécution
| Entrée de durée d’exécution | Objectif | Type de champ | Obligatoire |
|---|---|---|---|
| ID de la feuille de calcul | C’est ici que se trouve la feuille de calcul de contrôle. | Texte | Oui |
| ID de la feuille | C’est ici que se trouve la feuille de contrôle. | Texte | Oui |
Configurer le modèle
Ce modèle comprend deux chaînes, 0.0 Execute a Query | Top-Level Orchestration et 0.1 Execute a Query | Download Results. Lorsque la chaîne principale est déployée dans votre espace de travail, la chaîne est automatiquement déployée avec elle.
- Orchestration de niveau supérieur : d’après les informations de la feuille de contrôle, cette chaîne détermine si une requête utilise un seul type de paramètre (Liste de sélection ou Sélection multiple) ou plusieurs types de paramètres (à la fois Liste de sélection et Sélection multiple).
- Exécuter une requête | Télécharger les résultats : cette chaîne exécute une requête à l’aide des paramètres spécifiés et récupère les données correspondantes. Une fois la requête exécutée, les résultats seront téléchargés au format CSV pour une analyse ou une utilisation ultérieure.
Une fois que la feuille de contrôle est configurée et que le modèle de chaîne est déployé dans votre espace de travail, il vous suffit d’avoir l’ID de la feuille de calcul et l’ID de la feuille de la feuille de contrôle.
Ces valeurs doivent être ajoutées en tant qu’entrées de durée d’exécution pour la chaîne d’orchestration de niveau supérieur.
Configuration de la feuille de contrôle par type de paramètre
La manière de configurer la feuille de contrôle dépend des types de paramètres définis dans votre requête Wdata. Si une requête inclut plusieurs types de paramètres (par exemple, à la fois Liste de sélection et Sélection multiple), chaque paramètre doit être défini sur une ligne distincte en utilisant le même ID de requête. Si une requête utilise un seul type de paramètre, la feuille de contrôle nécessite une seule ligne pour cette requête.
Les exemples ci-dessous illustrent les deux scénarios.
Exemple : requête avec plusieurs types de paramètres
Pour une requête nécessitant à la fois des paramètres de type Liste de sélection et Sélection multiple, la feuille de contrôle doit inclure une ligne distincte pour chaque paramètre, toutes utilisant le même ID de requête.
Remarque : la colonne Clé fait référence au Nom du paramètre défini dans la requête Wdata.
Exemple de configuration :
| ID de la requête | Type | Clé | Valeurs |
|---|---|---|---|
| ID de requête Wdata | Paramètres-Liste-de-sélection | Année | Spécifiez une seule valeur par défaut (par exemple, 2023). |
| ID de requête Wdata | Paramètres-Sélection-multiple | Type de compte | Entrez plusieurs valeurs acceptables, séparées par des virgules (par exemple, Actif, Charge, Équité, Revenu). |
Exemple : requête avec un seul type de paramètre
Pour une requête qui utilise seulement un seul type de paramètre, la feuille de contrôle doit contenir une seule ligne pour cet ID de requête.
Par exemple, si la requête utilise uniquement un paramètre Liste de sélection :
| ID de la requête | Type | Clé | Valeurs |
|---|---|---|---|
| ID de requête Wdata | Paramètres-Liste-de-sélection | Année | Spécifiez une seule valeur par défaut (par exemple, Janvier). |
Assurez-vous que la feuille de contrôle est configurée correctement, car une configuration incorrecte peut entraîner des questions en aval.
Chargement des données dans un tableau
Vous pouvez automatiser le processus de chargement de votre sortie directement dans un tableau. Pour charger les données de sortie dans un tableau, envisagez d’utiliser le modèle "Charger les données vers Wdata". Cela peut être déclenché dans le cadre de votre processus en ajoutant un événement Exécuter la chaîne au niveau du connecteur HTTP qui télécharge les résultats.
Dépannage
Pour consulter l'historique de l'exécution de la chaîne, y compris les erreurs :
- Allez sur l'onglet Monitor dans Chain Builder.
-
Survolez le point d’interrogation pour afficher l’état de l’exécution de la chaîne.
Si votre chaîne a déclenché une erreur ou n’a pas réussi à télécharger un résultat de requête, effectuez les vérifications suivantes :
- Vérifiez que les deux chaînes ont été publiées dans votre espace de travail. Chaque chaîne doit être publiée séparément.
- Assurez-vous que la requête dans Wdata est mise à jour vers la dernière version.
- Lors de la saisie de l’ID de requête, du type, des clés et de la valeur dans la feuille de contrôle, assurez-vous que l’ID complet a été entré et qu’il n’y a pas d’espaces en début ou en fin. Confirmez également que les Clés et les Valeurs correspondent correctement aux paramètres utilisés dans Wdata.
- Assurez-vous que la subvention OAuth2 associée à la connexion Workiva dispose d’un accès approprié.
- Assurez-vous que tous les paramètres utilisés dans une requête sont inclus dans la feuille de contrôle.
Ressources supplémentaires
- Connecteur Workiva
- Connecteur Utilitaires de fichiers
- Connecteur JSON
- Connecteur Transformation tabulaire
- Exécuter une chaîne à l'intérieur d'une autre chaîne ("Run Chain events")
- Octrois OAuth2
- Fonctions de Wdata et limites de l’API