Ce guide fournit des instructions détaillées pour la mise en œuvre du modèle « Exécuter une requête et télécharger les résultats avec une feuille de contrôle » ( ) disponible à l'adresse suivante : . Ce modèle constitue une alternative à la commande « Exécuter une requête » ( ) , qui obligeait auparavant les utilisateurs à saisir manuellement les paramètres en chaîne avant le déploiement et l'exécution.
Grâce à la feuille de contrôle « » ( ), les utilisateurs peuvent ajouter plusieurs identifiants 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é à des 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êtes HTTP « »
- Configurer le connecteur de transformation tabulaire d'
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 « Workiva Chains » de l’écran « Modèles d’analyse de données » ( ) .
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 de premier niveau » en haut à droite, puis 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 de l'API correspondant à votre région :
|
| Variable de l'espace de travail | wsv_Client ID |
Saisissez l'identifiant client qui vous est attribué lors de la configuration d'une autorisation API. Consultez la page « » à l'adresse pour obtenir plus d'informations sur l'API Workiva. |
| Variable de l'espace de travail | wsv_Client Secret |
Pour consulter votre secret d'autorisation API, rendez-vous dans l'onglet « Sécurité » de votre profil utilisateur, puis cliquez sur l'option « Régénérer » dans le menu déroulant « Actions » situé à côté de l'autorisation. Consultez la page « » (API Workiva) à l'adresse pour obtenir plus d'informations sur l'API Workiva. |
| Variable de l'espace de travail | wsv_API URL de base - Wdata |
Saisissez l'URL de base de l'API correspondant à 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 fiche de contrôle. | Texte | Oui |
Configurer le modèle
Ce modèle se compose de deux chaînes : « 0.0 Exécuter une requête | Orchestration de niveau supérieur » et « 0.1 Exécuter une requête | Télécharger les résultats » . Lorsque la chaîne principale est déployée dans votre espace de travail, la chaîne « chain » est automatiquement déployée en même temps.
- d’orchestration de haut niveau : en fonction des informations issues de la fiche de contrôle, cette chaîne détermine si une requête utilise un seul type de paramètre (soit « Liste de sélection » , soit « 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 indiqué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 en vue d'une analyse ou d'une utilisation ultérieure.
Une fois la feuille de contrôle « » ( ) configurée et le modèle de chaîne « » ( ) déployé dans votre espace de travail, il vous suffit de disposer de l'identifiant de la feuille de calcul « » ( ) et de l'identifiant de la feuille « » ( ) de la feuille de contrôle.
Ces valeurs doivent être ajoutées en tant que paramètres d'exécution d' 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 dont vous configurez la feuille de contrôle dépend des types de paramètres définis dans votre requête Wdata. Si une requête comprend plusieurs types de paramètres (par exemple, à la fois une liste de sélection et une 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 ces deux cas de figure.
Exemple : requête avec plusieurs types de paramètres
Pour une requête nécessitant à la fois les paramètres « » (Liste de sélection) et « » (Sélection multiple) , la feuille de contrôle doit comporter des lignes distinctes pour chaque paramètre , toutes utilisant le même identifiant de requête .
Remarque : La colonne « Key » 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 de la liste de sélection | Année | Indiquez une seule valeur par défaut (par exemple, 2023 ). |
| ID de requête Wdata | Sélection multiple de paramètres | Type de compte | Saisissez plusieurs valeurs valides, séparées par des virgules (par exemple : Actif, Dépense, Capitaux propres, Chiffre d'affaires ). |
Exemple : requête avec un seul type de paramètre
Pour une requête qui utilise uniquement un type de paramètre , la feuille de contrôle doit contenir une seule ligne pour cet identifiant de requête.
Par exemple, si la requête utilise uniquement un paramètre de liste de sélection « » ( ) :
| ID de la requête | Type | Clé | Valeurs |
|---|---|---|---|
| ID de requête Wdata | Paramètres de la liste de sélection | Année | Indiquez une seule valeur par défaut (par exemple, janvier ). |
Assurez-vous que la fiche de contrôle est correctement configurée, car une configuration erronée pourrait entraîner des problèmes en aval.
Chargement de données dans une table
Vous pouvez automatiser le processus de chargement de vos résultats directement dans un tableau. Pour charger les données de sortie dans une table, pensez à utiliser le modèle « » « Load Data to Wdata » « ». Cette opération peut être déclenchée dans le cadre de votre processus en ajoutant un événement « Run Chain » ( ) 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 généré une erreur ou n'a pas réussi à télécharger le résultat d'une requête, procédez aux vérifications suivantes :
- Vérifiez que les deux chaînes ont bien é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 bien mise à jour vers la dernière version.
- Lorsque vous saisissez l'identifiant de requête « » , ainsi que le type « », les clés et la valeur dans la feuille de contrôle , assurez-vous que l'identifiant a été saisi dans son intégralité et qu'il ne comporte ni espace avant ni espace après. Vérifiez également que les clés et les valeurs correspondent bien aux paramètres utilisés dans Wdata.
- Assurez-vous que l'autorisation OAuth2 de associée à la connexion Workiva dispose des droits d'accès appropriés.
- Assurez-vous que tous les paramètres utilisés dans une requête figurent dans la fiche 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