Workiva supportcenter

Översikt

Denna serie om "ledande praxis" beskriver rekommendationer och allmänna metoder för olika artefakter inom Data Management Suite i Workiva-plattformen. Tänk på att detta är allmänna riktlinjer och att de kan behöva anpassas utifrån specifika, unika användningsfall. Dessa rekommendationer syftar till att hjälpa dig att förbättra organisationen inom dina arbetsytor. Låt oss börja med att utforska dessa namngivningskonventioner.

Namngivningskonventioner för Connections, Chains och Miljöer

Förbindelser i kedjor

När du skapar Connections in Chains är det viktigt att upprätta optimala namnkonventioner för att säkerställa tydlighet och åtskillnad mellan Miljöer:

• Namn på Connector: Ange ett beskrivande namn på anslutningen som tydligt anger dess syfte och funktion.
• Typ av arbetsyta: Ange den arbetsyta eller det projekt där Connector används.
• Miljö för anslutningsdonet: Identifiera tydligt den miljö (t.ex. utveckling, produktion) som Connector motsvarar.

Exempel:

• SFTP-anslutning | SEC-rapportering | NON-PROD
  • Beskrivning: Upprättar en anslutning till SFTP-servern för en lösning med arbetsyta för SEC-rapportering i en icke-produktionsmiljö som utveckling, QA, sandlåda etc.
• SFTP-anslutning | SEC-rapportering | PROD
  • Beskrivning: Upprättar en anslutning till SFTP-servern för lösningen SEC Reporting arbetsyta i produktionsmiljön.

Denna namngivningskonvention underlättar identifiering och hantering av Connections i olika miljöer. Det säkerställer att kedjor inom specifika miljöer endast interagerar med lämpliga källor, vilket ökar säkerheten och tillförlitligheten. En Icke-producerad -anslutning kan utnyttjas i icke-producerade, utvecklande och testmiljöer.

Denna namngivningspraxis bör tillämpas konsekvent på alla anslutningar, oavsett om de är Core- eller Premium-anslutningar. Genom att upprätthålla enhetlighet i Connection-namngivningen i olika miljöer kan du effektivisera Chain Promotion-processen och möjliggöra sömlöst genomförande av kedjor på olika arbetsytor.

Chain Builder

När du bygger kedjor i Workiva-plattformen är det viktigt att upprätthålla en välorganiserad namngivningskonvention. En tydlig och konsekvent namngivningsstrategi gör det lättare att navigera i kedjorna, särskilt när antalet arbetsflöden ökar. Detta avsnitt ger en översikt över ledande praxis för namngivning av kedjor baserat på deras syfte, källsystem, frekvens och arbetsflödeshierarki.

Syfte och källsystem

Fastställande av kedjans syfte

Fundera på följande frågor för att definiera syftet med en kedja:

• Vilken typ av data används inom kedjan?
• Kan kedjan användas i flera olika processer (dvs. är det en användbar kedja)?
• Vilket källsystem används för att hämta data från?

Frekvens

Ange kedjans frekvens

När man namnger kedjan är det viktigt att ange dess frekvens, särskilt om den är schemalagd att köras automatiskt. Vi föreslår följande riktlinjer:

• Ange om kedjan ska drivas på ad hoc-basis.
• Ange om kedjan körs dagligen, veckovis, kvartalsvis eller årligen.

Hierarki

Organisering av komplexa kedjebyggen

I en kedjebildning som består av flera arbetsflöden finns det vanligtvis en toppnivåkedja med flera underkedjor som körs i en sekvens. Organisera dessa kedjor genom att förse dem med en numrerad namnkonvention.

Exempel på en numrerad namngivningskonvention:

• 1.0 Toppnivåkedja
• 1.1 Kör dataset
• 1.2 Ladda data till Wdata-tabellen
• 1.3 Uppdatera inkommande anslutningar

Detta tillvägagångssätt hjälper användarna att snabbt identifiera arbetsordningen i ett arbetsflöde och organiserar automatiskt kedjorna i arbetsytan baserat på den numeriska ordningen.

Praktiska exempel på konventioner för kedjenamn

Verktygskedjor

Utility Chains är vanliga arbetsflöden som utförs av flera andra arbetsflöden, t.ex. Läser in data i en Wdata-tabell. För att se till att verktygskedjorna visas tydligt högst upp på arbetsytan bör du överväga följande namnkonventioner::

• 0.0 - [Namn på elkedja] | [Process] | Elkedja
• 0.1 - [Namn på elkedja] | [Process] | Elkedja
• 0.2 - [Namn på elkedja] | [Process] | Elkedja

Källsystem

Termen "Källsystem" avser ursprunget till data, vilket kan inkludera olika system som ERP (Enterprise Resource Planning), EPM (Enterprise Performance Management), HR (Human Resources) och redovisningssystem, eller så kan det vara filbaserat, som data som kommer från en SFTP /FTP.

Följande exempel visar organisationen för tre Source Systems som ett exempel:

1. Arbetsdag
   • 1.0 - [kedjans namn/process] | arbetsdag | [frekvens]
   • 1.1 - [kedjans namn/process] | arbetsdag | [frekvens]
   • 1.2 - [kedjans namn/process] | arbetsdag | [frekvens]
2. SAP
   • 2.0 - [Kedjans namn/process] | SAP | [Frekvens]
   • 2.1 - [Kedjans namn/process] | SAP | [Frekvens]
   • 2.2 - [Kedjans namn/process] | SAP | [Frekvens]
3. Netsuite
   • 3.0 - [kedjans namn/process] | Netsuite | [frekvens]
   • 3.1 - [kedjans namn/process] | Netsuite | [frekvens]
   • 3.2 - [kedjans namn/process] | Netsuite | [frekvens]

För en arbetsyta med ett stort antal kedjor kan du använda följande exempel på namngivningskonventioner för tydlighetens och organisationens skull:

Denna struktur säkerställer tydliga och konsekventa namnkonventioner och organisation, vilket gör det lättare att identifiera och hantera Utility Chains och Source System Chains baserat på deras process och exekveringsfrekvens.

Konvention för namngivning av miljöer

Miljöer låter dig enkelt planera, testa och distribuera arbetsflöden. Detta effektiviserar tillämpningen av bästa praxis för programvaruutvecklingslivscykeln (SDLC) i dina automatiseringsprocesser. När du skapar miljöer föreslår vi att du använder följande förenklade namngivningskonventioner för att tydligt identifiera syftet med varje miljö. Detta hjälper användarna att snabbt förstå den avsedda användningen av varje miljö.

Miljötyper och namngivningskonventioner

1. DEV (utveckling)
   • Syfte: Används för att utveckla nya kedjor och processer. Byggare kan skapa och experimentera på ett säkert sätt i utvecklingsmiljön (DEV).
   • Exempel: DEV
2. Test (eller sandlåda)
   • Syfte: Dedikerad till test- och QA-processer. QA-team kan granska och testa i testmiljön (Test).
   • Exempel: TEST
3. PROD (Produktion)
   • Syfte: För processer som har testats, förfinats och är redo för driftsättning i produktionsmiljön. 

   • Exempel: PROD

     

Anteckningar

• Flera kedjor kan ha identiska namn, men varje kedja kännetecknas av en unik identifierare som kallas GUID.

• Varje arbetsyta har ett unikt ID (se i URL:en), så flera arbetsytor kan ha samma namn. Vi avråder dock från att göra det på grund av risken för användarförvirring.
• Kedjor, arbetsyta och arbetsytemiljö namnger alla stödytor och Workivas standardteckenuppsättning.
• Namnlängder:
  • Kedjenamn har en maximal längd på 100 tecken.
    Varning: när du kopierar kedjor läggs tecknen "-- Kopiera" till automatiskt. Om detta resulterar i ett namn som är längre än 100 tecken kommer kedjan inte att kopieras.
  • Kedjekommandon (nodnamn) kan ha maximalt 255 tecken. 
  • Arbetsytenamn har en maximal längd på 50 tecken.
  • Namn på arbetsytemiljöerhar en maximal längd på 25 tecken.

Sammanfattning

Att använda dessa förenklade namnkonventioner bidrar till att upprätthålla en strukturerad och lättnavigerad miljöinstallation. Det säkerställer att syftet med varje miljö är tydligt, vilket minskar förvirringen och förbättrar effektiviteten under utvecklings-, test- och driftsättningsfaserna.