Workiva-ondersteuningscentrum

Overzicht

Deze reeks 'beste praktijken' beschrijft aanbevolen algemene werkwijzen voor diverse artefacten binnen de Data Management Suite van het Workiva-platform. Houd er rekening mee dat dit algemene richtlijnen zijn en mogelijk moeten worden aangepast aan specifieke, unieke gebruikssituaties. Deze aanbevelingen zijn bedoeld om u te helpen de organisatie binnen uw werkruimtes te verbeteren. Laten we beginnen met het onderzoeken van deze naamgevingsconventies.

Naamgevingsconventies voor Verbindingen, Ketens en Omgevingen

Verbindingen in ketens

Bij het creëren van verbindingen in ketens is het essentieel om optimale naamgevingsconventies vast te stellen om duidelijkheid en onderscheid tussen omgevingente garanderen:

• Naam van de connector: Geef een beschrijvende naam voor de connector die het doel en de functie ervan duidelijk aangeeft.
• Type werkruimte: Specificeer de werkruimte of het project waarin de connector wordt gebruikt.
• Omgeving van de connector: Geef duidelijk aan bij welke omgeving (bijv. ontwikkeling, productie) de connector hoort.

Voorbeeld:

• SFTP-verbinding | SEC-rapportage | Niet-productie
  • Beschrijving: Legt een verbinding tot stand met de SFTP-server voor een SEC-rapportageoplossing in een niet-productieomgeving zoals ontwikkeling, QA, sandbox, enz.
• SFTP-verbinding | SEC-rapportage | PROD
  • Beschrijving: Legt een verbinding tot stand met de SFTP-server voor de SEC-rapportagewerkruimteoplossing binnen de productieomgeving.

Deze naamgevingsconventie maakt het eenvoudig om verbindingen in verschillende omgevingen te identificeren en te beheren. Het zorgt ervoor dat ketens binnen specifieke omgevingen alleen met de juiste bronnen communiceren, waardoor de veiligheid en betrouwbaarheid worden verbeterd. Een Non-Prod verbinding kan worden gebruikt in niet-productie-, ontwikkel- en testomgevingen.

Deze naamgevingsconventie moet consequent worden toegepast op alle verbindingen, of het nu Core- of Premium-connectoren zijn. Door uniformiteit in de naamgeving van verbindingen in verschillende omgevingen te handhaven, kunt u het promotieproces van ketens stroomlijnen en een naadloze uitvoering van ketens in verschillende werkruimten mogelijk maken.

Kettingbouwer

Bij het bouwen van ketens in het Workiva-platform is het van cruciaal belang om een ​​goed georganiseerde naamgevingsconventie te hanteren. Een duidelijke en consistente naamgevingsstrategie helpt om efficiënter door de ketens te navigeren, vooral naarmate het aantal workflows toeneemt. In dit gedeelte worden de beste werkwijzen beschreven voor het benoemen van ketens op basis van hun doel, bronsysteem, frequentie en workflowhiërarchie.

Doel en bronsysteem

Het doel van de keten bepalen

Overweeg de volgende vragen om het doel van een keten te definiëren:

• Welke soorten gegevens worden er binnen de keten gebruikt?
• Kan de keten in meerdere processen worden gebruikt (is het dus een hulpketen)?
• Welk bronsysteem wordt gebruikt om de gegevens op te halen?

Frequentie

De frequentie van de keten specificeren

Bij het benoemen van de keten is het belangrijk om de frequentie aan te geven, vooral als deze automatisch moet worden uitgevoerd. Wij stellen de volgende richtlijnen voor:

• Geef aan of de keten op ad-hocbasis moet worden uitgevoerd.
• Geef aan of de keten dagelijks, wekelijks, per kwartaal of jaarlijks actief is.

Hiërarchie

Het organiseren van complexe ketenopbouw

Bij een ketenopbouw die uit meerdere workflows bestaat, is er doorgaans een keten op het hoogste niveau met meerdere subketens die in een bepaalde volgorde worden uitgevoerd. Organiseer deze ketens door ze te voorzien van een genummerd voorvoegsel volgens een bepaalde naamgevingsconventie.

Voorbeeld van een genummerde naamgevingsconventie:

• 1.0 Top-level keten
• 1.1 Dataset uitvoeren
• 1.2 Gegevens laden in de Wdata-tabel
• 1.3 Inkomende verbindingen vernieuwen

Deze aanpak helpt gebruikers snel de volgorde van bewerkingen binnen een workflow te identificeren en organiseert de ketens in de werkruimte automatisch op basis van de numerieke volgorde.

Praktische voorbeelden van naamgevingsconventies voor ketens

Nutsketens

Utility Chains zijn veelvoorkomende workflows die door meerdere andere workflows worden uitgevoerd, zoals Gegevens laden in een Wdata-tabel. Om ervoor te zorgen dat hulpprogrammaketens prominent bovenaan de werkruimte worden weergegeven, kunt u de volgende naamgevingsconventies overwegen:

• 0.0 - [Naam van de hulpprogrammaketen] | [Proces] | Hulpprogrammaketen
• 0.1 - [Naam van de hulpprogrammaketen] | [Proces] | Hulpprogrammaketen
• 0.2 - [Naam van de hulpprogrammaketen] | [Proces] | Hulpprogrammaketen

Bronsystemen

De term 'bronsystemen' verwijst naar de oorsprong van de gegevens, waaronder diverse systemen zoals ERP (Enterprise Resource Planning), EPM (Enterprise Performance Management), HR (Human Resources) en boekhoudsystemen, of het kan gaan om bestanden, zoals gegevens afkomstig van een SFTP/FTP-server.

Het volgende voorbeeld illustreert de organisatie van drie bronsystemen:

1. Werkdag
   • 1.0 - [Kettingnaam/Proces] | Werkdag | [Frequentie]
   • 1.1 - [Kettingnaam/Proces] | Werkdag | [Frequentie]
   • 1.2 - [Kettingnaam/Proces] | Werkdag | [Frequentie]
2. SAP
   • 2.0 - [Kettingnaam/Proces] | SAP | [Frequentie]
   • 2.1 - [Ketennaam/Proces] | SAP | [Frequentie]
   • 2.2 - [Ketennaam/Proces] | SAP | [Frequentie]
3. Netsuite
   • 3.0 - [Kettingnaam/Proces] | Netsuite | [Frequentie]
   • 3.1 - [Kettingnaam/Proces] | Netsuite | [Frequentie]
   • 3.2 - [Kettingnaam/Proces] | Netsuite | [Frequentie]

Voor een werkruimte met een groot aantal ketens kunt u de volgende naamgevingsconventies gebruiken voor meer duidelijkheid en overzicht:

Deze structuur zorgt voor duidelijke en consistente naamgevingsconventies en organisatie, waardoor het gemakkelijker wordt om hulpketens en bronsysteemketens te identificeren en te beheren op basis van hun proces en uitvoeringsfrequentie.

Conventie voor het benoemen van omgevingen

Omgevingen stellen u in staat om workflows moeiteloos te plannen, te testen en te implementeren. Dit stroomlijnt de toepassing van best practices voor de softwareontwikkelingslevenscyclus (SDLC) op uw automatiseringsprocessen. Bij het aanmaken van omgevingen raden we aan de volgende vereenvoudigde naamgevingsconventies te gebruiken om het doel van elke omgevingduidelijk te identificeren. Dit helpt gebruikers snel te begrijpen waarvoor elke omgeving bedoeld is.

Omgevingstypen en naamgevingsconventies

1. DEV (Ontwikkeling)
   • Doel: Gebruikt voor het ontwikkelen van nieuwe ketens en processen. Ontwikkelaars kunnen veilig creëren en experimenteren in de ontwikkelomgeving (DEV).
   • Voorbeeld: DEV
2. Test (of Sandbox)
   • Doel: Speciaal voor test- en kwaliteitsborgingsprocessen. QA-teams kunnen beoordelingen uitvoeren en tests uitvoeren in de testomgeving (Test).
   • Voorbeeld: TEST
3. PROD (Productie)
   • Doel: Voor processen die zijn getest, verfijnd en klaar zijn voor implementatie in de productieomgeving. 

   • Voorbeeld: PROD

     

Notities

• Meerdere ketens kunnen identieke namen hebben, maar elke keten wordt onderscheiden door een unieke identificatiecode

  , een zogenaamdeGUID

  .
• Elke werkruimte heeft een unieke ID (zie de URL), dus meerdere werkruimtes kunnen dezelfde naam hebben. We raden dit echter af vanwege de mogelijke verwarring bij de gebruiker.
• Chains, Workspace en Workspace Environment zijn de namen van alle ondersteunende ruimtes en de standaardtekenset van Workiva.
• Naamlengtes:
  • Kettingnamen hebben een maximale lengte van 100 tekens.
    Let op: Bij het kopiëren van ketens worden de tekens "-- Kopie" automatisch toegevoegd. Als dit resulteert in een naam die langer is dan 100 tekens, wordt de keten niet gekopieerd.
  • Kettingopdracht (knooppunt)namen hebben een maximum van 255 tekens. 
  • Werkruimtenamen hebben een maximale lengte van 50 tekens.
  • Werkruimteomgeving namen hebben een maximale lengte van 25 tekens.

Samenvatting

Het gebruik van deze vereenvoudigde naamgevingsconventies helpt bij het behouden van een gestructureerde en gemakkelijk navigeerbare omgeving. Het zorgt ervoor dat het doel van elke omgeving duidelijk is, waardoor verwarring wordt verminderd en de efficiëntie tijdens de ontwikkelings-, test- en implementatiefasen wordt verbeterd.