Introduction
Le modèle Data Dictionary Chain permet aux utilisateurs de capturer et d'exporter dans une feuille de calcul des détails de haut niveau sur des tables spécifiques de leur espace de travail. Les utilisateurs peuvent spécifier un mot-clé pour localiser les tables, définir le nom de la feuille de calcul d'exportation et créer une table dans l'espace de travail pour stocker le schéma de chaque table.
Pour plus de détails, voir la documentation sur Load Data to Wdata Process pour une vue d'ensemble complète. Il est recommandé de consulter cette documentation avant d'utiliser le modèle de dictionnaire de données : .
Conditions préalables
Ce modèle suppose que les objets suivants sont déjà configurés dans votre application Workiva :
- Octroi d’API
- Afin d'exploiter les API de Workiva, un utilisateur doit établir un OAuth API Grant dans son espace de travail. Veuillez vous référer à cet article pour leading practices pour la gestion de la subvention OAuth.
- Les connecteurs suivants doivent être activés et configurés dans votre espace de travail :
Note : Certaines valeurs variables peuvent contenir des informations sensibles telles que des noms d'utilisateur et des mots de passe. Nous recommandons d'utiliser l'option "Encrypt" pour les variables sensibles à l'information et de définir les autorisations appropriées pour votre feuille de calcul.
- Configurer les variables
- Pour que la sous-chaîne Load Data to Wdata du modèle fonctionne comme prévu, une variable workspace intitulée wsv-WdataLoadWarningThreshold doit être créée.
Note : La meilleure pratique consiste à fixer la valeur par défaut de cette variable à 50 (représentant 50MB), bien qu'elle puisse être ajustée si nécessaire.
-
- En outre, quatre autres variables de l'espace de travail doivent être créées avant d'utiliser la chaîne du dictionnaire de données.
Vous trouverez ci-dessous une ventilation de chaque variable qui doit être configurée et renseignée :
Construisez votre chaîne
Le modèle Data Dictionary | ALL | Primary Chain se trouve dans la section Workiva Chains de l'écran Templates.
Voici comment le trouver :
- Dans Chain Builder, allez dans l'onglet Templates .
- Sélectionnez Workiva Chains dans le menu du haut.
- Recherchez Data Dictionary | ALL | Primary Chain Template en haut à droite et ouvrez le modèle.
Lorsque le dictionnaire de données | ALL | chaîne primaire est déployé dans un espace de travail, il déploie automatiquement six sous-chaînes supplémentaires.
Les utilisateurs doivent s'assurer que les sept chaînes ont été déployées et publiées dans le même espace de travail :
- Dictionnaire de données | ALL | Primaire
- Dictionnaire de données | Création de documents et de sous-sections | Création de feuilles de calcul
- Dictionnaire de données | Créer un document et des sous-sections | Création de fiches
- Dictionnaire de données | Créer une table
- Charger les données dans Wdata | Primary Chain
- Charger des données dans Wdata | Remplacer l'ensemble de données
- Charger des données dans Wdata | Ajouter un nouveau jeu de données
Après avoir localisé votre modèle, le configure pour votre espace de travail à l'aide des variables créées dans la section ci-dessus.
Note : Pour des instructions détaillées sur la création d'une chaîne à partir d'un modèle, voir l'article Créer et gérer des chaînes.
Entrées en cours d'exécution
Lors de l'exécution de cette chaîne primaire (Data Dictionary | ALL | Primary), les données d'entrée suivantes devront être complétées ou transmises par l'intermédiaire d'une chaîne appelante :
| Entrée en cours d'exécution | Description | Type de champ | Nécessaire ? |
|---|---|---|---|
| Nom de la feuille de calcul | Spécifie le nom de la feuille de calcul dans laquelle le schéma de la table sera écrit. | Texte | Oui |
| Valeur de la recherche | Cette entrée est utilisée pour localiser les tables contenant le mot-clé spécifié. | Texte | Oui |
| Nom de la table Wdata | Spécifie le nom de la table du dictionnaire de données créée lors de l'exécution initiale du modèle. | Texte | Oui |
Tableau Wdata
Pour utiliser cette chaîne, une table Dictionnaire de données Wdata doit exister dans l'espace de travail. La chaîne créera automatiquement cette table, en utilisant la convention d'appellation "Table du dictionnaire de données", à moins que l'utilisateur ne spécifie un nom de table différent.
Le schéma de table suivant sera utilisé pour construire la table du dictionnaire de données :
| Nom de la colonne | Description de la colonne | ID de la colonne | Type de colonne |
|---|---|---|---|
| Nom du tableau | S.O. | nom_de_table | texte |
| Alias | S.O. | alias | texte |
| Mode | S.O. | mode | texte |
| Nom | S.O. | nom | texte |
| Type | S.O. | type | texte |
Ajustements personnalisés Avertissement : Si les utilisateurs rencontrent des problèmes de non-concordance des en-têtes de colonnes lors de l'importation de leurs données dans une table Wdata, ils peuvent utiliser la préparation des données ou d'autres commandes pour corriger ce problème. Toutefois, si un utilisateur ajoute des ajustements personnalisés à ce modèle, il est recommandé d'en faire une copie avant de le faire. Toute modification du modèle empêchera sa réutilisation. Cela s'applique également à l'application d'une configuration de balise au modèle.
Dépannage
Les étapes suivantes peuvent être utilisées pour résoudre les problèmes liés au modèle de chaîne :
Erreurs d'exécution de la chaîne
- Vérifier que toutes les chaînes sont publiées.
- Assurez-vous que les informations d'identification OAuth2 (
wsv-Client IDetwsv-Client Secret) sont valides et à jour. - Vérifier les autorisations de l'espace de travail pour l'utilisateur qui exécute la chaîne.
Erreurs d'importation de données
- Confirmez que les en-têtes de colonne de votre fichier source correspondent au schéma de la table Wdata.
- Pour les opérations de remplacement des jeux de données, assurez-vous que les noms de fichiers correspondent aux jeux de données existants dans la table.
- Pour les opérations d'ajout d'un nouveau jeu de données, assurez-vous que les noms de fichiers sont uniques dans la table.
Création d'un tableau ou d'une feuille de calcul en double
- Utilisez des noms cohérents pour
Wdata Table NameetSpreadsheetNamed'une exécution à l'autre.
Écran de contrôle
- Les utilisateurs peuvent diagnostiquer la cause d'une erreur en se rendant sur l'écran de leur moniteur.
- La variable DCV_Chain Result capture le statut de la chaîne sur la base du résultat final. En cas d'erreur, la raison de l'échec sera appliquée au texte de sortie de la chaîne dans l'écran du moniteur.
Les utilisateurs peuvent également utiliser l'écran de contrôle pour déterminer si leur fichier a été importé avec succès
Meilleures pratiques
-
Éviter de personnaliser le modèle original:
Créer une copie si des ajustements sont nécessaires. Les modifications apportées au modèle peuvent entraver sa réutilisation. -
Balisage pour un contexte amélioré:
Ajouter des entrées d'exécution (Tag-KeyetTag-Value) aux ensembles de données de balisage, si nécessaire. Mettre à jour les nœuds de la chaîne pour transmettre ces entrées. -
Gestion de la taille des fichiers:
Surveillez la taille des ensembles de données à l'aide de la variablewsv-WdataLoadWarningThreshold. Envisagez de diviser les grands ensembles de données si des avertissements sont déclenchés.