Vue d’ensemble

La série des pratiques de référence décrit les pratiques générales recommandées pour divers artefacts de la suite de gestion des données de la plateforme Workiva. N'oubliez pas qu'il s'agit de lignes directrices générales et qu'il peut être nécessaire de les adapter en fonction de cas d'utilisation spécifiques et uniques. Ces recommandations visent à aider les utilisateurs à améliorer l'organisation de leur espace de travail.  Commençons par explorer ces conventions d'appellation.

Conventions d'appellation pour Connexions, Chaînes et Environnements

Connexions en chaîne

Lors de la création de connexions en chaîne, il est essentiel d'établir des conventions de dénomination optimales afin de garantir la clarté et la distinction entre les environnements :

• Nom du connecteur : Fournir un nom descriptif pour le connecteur qui indique clairement son objectif et sa fonction.
• Type d'espace de travail : Indiquez l'espace de travail ou le projet dans lequel le connecteur est utilisé.
• Environnement du connecteur : Identifier clairement l'environnement (par exemple, développement, production) auquel correspond le connecteur.

Exemple :

• Connexion SFTP | Rapports SEC | NON-PROD
  • Description : Etablit une connexion au serveur SFTP pour une solution d'espace de travail SEC Reporting dans un environnement non-prod tel que Development, QA, Sandbox etc.
• Connexion SFTP | Rapports SEC | PROD
  • Description : Etablit une connexion au serveur SFTP pour la solution d'espace de travail de reporting SEC dans l'environnement de production.

Cette convention d'appellation facilite l'identification et la gestion des connexions dans différents environnements. Il garantit que les chaînes qui se trouvent dans des environnements spécifiques n'interagissent qu'avec les sources appropriées, ce qui renforce la sécurité et la fiabilité. Une connexion Non-Prod pourrait être utilisée dans les environnements Non-Prod, Dev et UAT.

Cette convention de dénomination doit être appliquée de manière cohérente à toutes les connexions, qu'il s'agisse de connecteurs de base ou de connecteurs premium. En maintenant l'uniformité des noms de connexion dans les différents environnements, vous pouvez rationaliser le processus de promotion des chaînes et permettre une exécution transparente des chaînes dans les espaces de travail.

Générateur de chaînes

Lors de la création de chaînes dans la plateforme Workiva, il est essentiel de maintenir une convention de dénomination bien organisée. Une stratégie de dénomination claire et cohérente permet de naviguer plus efficacement dans les chaînes, en particulier lorsque le nombre de flux de travail augmente. Cette section présente les principales pratiques pour nommer les chaînes en fonction de leur objectif, du système source, de la fréquence et de la hiérarchie du flux de travail.

Objectif et système source

Déterminer l'objectif de la chaîne

Réfléchissez aux questions suivantes pour définir l'objectif d'une chaîne :

• Quel type de données est utilisé au sein de la chaîne ?
• La chaîne peut-elle être utilisée dans le cadre de plusieurs processus (s'agit-il d'une chaîne utilitaire) ?
• Quel est le système source utilisé pour extraire les données ?

Fréquence

Spécification de la fréquence de la chaîne

Lorsque vous nommez la chaîne, il est essentiel d'indiquer sa fréquence, en particulier si elle est programmée pour s'exécuter automatiquement. Utilisez les lignes directrices suivantes :

• Indiquez si la chaîne doit être gérée sur une base ad hoc.
• Indiquez si la chaîne s'exécute sur une base quotidienne, hebdomadaire, trimestrielle ou annuelle.

Hiérarchie

Organiser la construction de chaînes complexes

Dans la construction d'une chaîne composée de plusieurs flux de travail, il y a généralement une chaîne de niveau supérieur avec plusieurs sous-chaînes exécutées en séquence. Organisez ces chaînes en les faisant précéder d'une convention d'appellation numérotée.

Exemple de convention d'appellation numérotée :

1.0 Chaîne de haut niveau
1.1 Exécuter l'ensemble de données
1.2 Charger les données dans la table Wdata
1.3 Actualiser les connexions entrantes

Cette approche aide les utilisateurs à identifier rapidement l'ordre des opérations dans un flux de travail et organise automatiquement les chaînes dans l'espace de travail en fonction de l'ordre numérique.

Exemples pratiques de conventions de dénomination des chaînes

Chaînes d'utilité publique

Les chaînes d'utilité sont des flux de travail communs exécutés par plusieurs autres flux de travail, tels que Charger des données dans une table Wdata. Pour s'assurer que les chaînes d'utilité sont affichées de manière visible en haut de l'espace de travail, il convient de respecter les conventions de dénomination suivantes: :

0.0 - [Nom de la chaîne d'utilité] | [Processus] | Chaîne d'utilité

0.1 - [Nom de la chaîne d'utilité] | [Processus] | Chaîne d'utilité

0.2 - [Nom de la chaîne d'utilité] | [Processus] | Chaîne d'utilité

Systèmes sources

Le terme "systèmes sources" fait référence à l'origine des données, qui peuvent inclure divers systèmes tels que les systèmes ERP (Enterprise Resource Planning), EPM (Enterprise Performance Management), HR (Human Resources) et comptables, ou peuvent être des fichiers, comme les données provenant d'un SFTP /FTP.

L'exemple suivant illustre l'organisation de trois systèmes sources :

1. Jour ouvrable

   • 1.0 - [Nom de la chaîne/processus] | Jour ouvrable | [Fréquence]
   • 1.1 - [Nom de la chaîne/processus] | Jour ouvrable | [Fréquence]
   • 1.2 - [Nom de la chaîne/processus] | Jour ouvrable | [Fréquence]

2. SAP

   • 2.0 - [Nom de la chaîne/processus] | SAP | [Fréquence]
   • 2.1 - [Nom de la chaîne/processus] | SAP | [Fréquence]
   • 2.2 - [Nom de la chaîne/processus] | SAP | [Fréquence]

3. Netsuite

   • 3.0 - [Nom de la chaîne/processus] | Netsuite | [Fréquence]
   • 3.1 - [Nom de la chaîne/processus] | Netsuite | [Fréquence]
   • 3.2 - [Nom de la chaîne/processus] | Netsuite | [Fréquence]

Pour un espace de travail comportant un grand nombre de chaînes, utilisez les exemples de conventions d'appellation suivants pour plus de clarté et d'organisation :

Cette structure garantit des conventions de dénomination et une organisation claires et cohérentes, ce qui facilite l'identification et la gestion des chaînes de services publics et des chaînes de systèmes sources en fonction de leur processus et de leur fréquence d'exécution.

Convention d'appellation de l'environnement

Les environnements permettent à l'équipe de planifier, de tester et de déployer le flux de travail sans effort. Cette fonction rationalise l'application des meilleures pratiques du cycle de développement logiciel (SDLC) aux processus d'automatisation. Lors de la création d'environnements, utilisez les conventions de dénomination simplifiées suivantes pour identifier clairement l'objectif de chaque environnement . Cela permet aux utilisateurs de comprendre rapidement l'utilisation prévue de chaque environnement.

Types d'environnement et conventions d'appellation

1. DEV (Développement)

   • Finalité : Développement de nouvelles chaînes et de nouveaux processus. Les constructeurs peuvent créer et expérimenter en toute sécurité dans l'environnement de développement (DEV).

   • Exemple : DEV

2. UAT (User Acceptance Testing) ou Sandbox (bac à sable)

   • Objet : consacré aux processus d'essai et d'assurance qualité. Les équipes d'assurance qualité peuvent examiner et tester dans l'environnement de test d'acceptation par l'utilisateur (UAT).
   • Exemple : NON-PROD

3. PROD (Production)

   • Objectif : Pour les processus qui ont été testés, affinés et qui sont prêts à être déployés dans l'environnement de production (PROD). 
   • Exemple : PROD

Note: Plusieurs chaînes peuvent avoir des noms identiques, mais chacune est distinguée par un identifiant unique connu sous le nom de GUID.

Résumé

L'utilisation de ces conventions de dénomination simplifiées permet de maintenir une configuration d'environnement structurée et facilement navigable. Il garantit que l'objectif de chaque environnement est clair, ce qui réduit la confusion et améliore l'efficacité au cours des phases de développement, de test et de déploiement.