Workiva Support Center

Übersicht

Diese "Leading Practice"-Reihe skizziert empfohlene allgemeine Praktiken für verschiedene Artefakte innerhalb der Data Management Suite in der Workiva-Plattform. Beachten Sie, dass es sich hierbei um allgemeine Richtlinien handelt, die je nach Anwendungsfall angepasst werden müssen. Diese Empfehlungen sollen Ihnen helfen, die Organisation in Ihren Arbeitsbereichen zu verbessern. Beginnen wir mit der Erforschung dieser Namenskonventionen.

Namenskonventionen für Verbindungen, Ketten und Umgebungen

Verbindungen in Ketten

Bei der Erstellung von Connections in Chains ist es wichtig, optimale Namenskonventionen festzulegen, um Klarheit und Unterscheidung zwischen Umgebungen zu gewährleisten:

• Name des Konnektors: Geben Sie einen beschreibenden Namen für den Connector an, der seinen Zweck und seine Funktion klar angibt.
• Typ des Arbeitsbereichs: Geben Sie den Arbeitsbereich oder das Projekt an, in dem der Connector verwendet wird.
• Umgebung des Konnektors: Geben Sie die Umgebung (z. B. Entwicklung, Produktion), der der Connector entspricht, eindeutig an.

Beispiel:

• SFTP-Verbindung | SEC-Berichterstattung | NON-PROD
  • Beschreibung: Stellt eine Verbindung zum SFTP-Server für eine SEC-Reporting-Workspace-Lösung in einer Nicht-Produktionsumgebung wie Entwicklung, QA, Sandbox usw. her.
• SFTP-Verbindung | SEC-Berichterstattung | PROD
  • Beschreibung: Stellt eine Verbindung zum SFTP-Server für die SEC Reporting Workspace-Lösung innerhalb der Produktionsumgebung her.

Diese Namenskonvention erleichtert die Identifizierung und Verwaltung von Verbindungen in verschiedenen Umgebungen. Es stellt sicher, dass Ketten in bestimmten Umgebungen nur mit den richtigen Quellen interagieren, was die Sicherheit und Zuverlässigkeit erhöht. Eine Non-Prod Verbindung kann in Non-Prod-, Entwicklungs- und Testumgebungen genutzt werden.

Diese Namenskonvention sollte konsequent auf alle Verbindungen angewendet werden, unabhängig davon, ob es sich um Haupt- oder Premium-Verbindungen handelt. Indem Sie die einheitliche Benennung von Verbindungen in verschiedenen Umgebungen beibehalten, können Sie den Prozess der Kettenförderung rationalisieren und eine nahtlose Ausführung von Ketten über Arbeitsbereiche hinweg ermöglichen.

Chain-Generator

Bei der Erstellung von Ketten in der Workiva-Plattform ist die Einhaltung einer gut organisierten Namenskonvention entscheidend. Eine klare und konsistente Benennungsstrategie hilft dabei, die Ketten effizienter zu navigieren, insbesondere wenn die Zahl der Arbeitsabläufe zunimmt. In diesem Abschnitt werden die führenden Praktiken für die Benennung von Ketten auf der Grundlage ihres Zwecks, des Quellsystems, der Häufigkeit und der Workflow-Hierarchie beschrieben.

Zweck und Quellensystem

Bestimmung des Zwecks der Kette

Beachten Sie die folgenden Fragen, um den Zweck einer Kette zu definieren:

• Welche Art von Daten wird innerhalb der Kette verwendet?
• Kann die Kette über mehrere Prozesse hinweg genutzt werden (d. h. handelt es sich um eine Dienstleistungskette)?
• Aus welchem Quellsystem werden die Daten bezogen?

Häufigkeit

Festlegen der Frequenz der Kette

Bei der Benennung der Kette ist es wichtig, ihre Häufigkeit anzugeben, insbesondere wenn sie automatisch ausgeführt werden soll. Wir schlagen die folgenden Leitlinien vor:

• Geben Sie an, ob die Kette auf einer Ad-hoc-Basis ausgeführt werden soll.
• Geben Sie an, ob die Kette auf täglicher, wöchentlicher, vierteljährlicher oder jährlicher Basis läuft.

Hierarchie

Organisieren komplexer Kettenaufbauten

Bei der Erstellung von Ketten, die aus mehreren Arbeitsabläufen bestehen, gibt es in der Regel eine Top-Level-Kette mit mehreren Unterketten, die nacheinander ausgeführt werden. Organisieren Sie diese Ketten, indem Sie ihnen eine nummerierte Namenskonvention voranstellen.

Beispiel für eine nummerierte Namenskonvention:

• 1.0 Oberste Ebene der Kette
• 1.1 Datensatz ausführen
• 1.2 Daten in die Tabelle Wdata laden
• 1.3 Eingehende Verbindungen aktualisieren

Dieser Ansatz hilft den Anwendern, die Reihenfolge der Vorgänge innerhalb eines Arbeitsablaufs schnell zu erkennen und organisiert die Ketten innerhalb des Arbeitsbereichs automatisch auf der Grundlage der numerischen Reihenfolge.

Praktische Beispiele für Kettenbenennungskonventionen

Utility-Ketten

Utility Chains sind allgemeine Workflows, die von mehreren anderen Workflows ausgeführt werden, wie z. B. Laden von Daten in eine Wdata-Tabelle. Um sicherzustellen, dass die Dienstleistungsketten im oberen Bereich des Arbeitsbereichs angezeigt werden, sollten Sie die folgenden Namenskonventionen beachten::

• 0.0 - [Name der Dienstleistungskette] | [Prozess] | Dienstleistungskette
• 0.1 - [Name der Dienstleistungskette] | [Prozess] | Dienstleistungskette
• 0.2 - [Name der Dienstleistungskette] | [Prozess] | Dienstleistungskette

Quellsysteme

Der Begriff "Quellsysteme" bezieht sich auf den Ursprung der Daten, zu denen verschiedene Systeme wie ERP (Enterprise Resource Planning), EPM (Enterprise Performance Management), HR (Human Resources) und Buchhaltungssysteme gehören können, oder sie können dateibasiert sein, wie Daten, die von einem SFTP /FTP kommen.

Das folgende Beispiel zeigt die Organisation für drei Quellsysteme als Beispiel:

1. Workday
   • 1.0 - [Kettenname/Prozess] | Arbeitstag | [Häufigkeit]
   • 1.1 - [Kettenname/Prozess] | Arbeitstag | [Häufigkeit]
   • 1.2 - [Kettenname/Prozess] | Arbeitstag | [Häufigkeit]
2. SAP
   • 2.0 - [Kettenname/Prozess] | SAP | [Häufigkeit]
   • 2.1 - [Kettenname/Prozess] | SAP | [Häufigkeit]
   • 2.2 - [Kettenname/Prozess] | SAP | [Häufigkeit]
3. Netsuite
   • 3.0 - [Kettenname/Prozess] | Netsuite | [Häufigkeit]
   • 3.1 - [Kettenname/Prozess] | Netsuite | [Häufigkeit]
   • 3.2 - [Kettenname/Prozess] | Netsuite | [Häufigkeit]

Für einen Arbeitsbereich mit einer großen Anzahl von Ketten sollten Sie die folgenden Beispiele für Namenskonventionen verwenden, um die Übersichtlichkeit und Organisation zu verbessern:

Diese Struktur gewährleistet klare, konsistente Namenskonventionen und eine Organisation, die die Identifizierung und Verwaltung von Versorgungsketten und Quellsystemketten auf der Grundlage ihres Prozesses und der Häufigkeit ihrer Ausführung erleichtert.

Umgebungsnamenskonvention

Mit Umgebungen können Sie Arbeitsabläufe mühelos planen, testen und bereitstellen. Dadurch wird die Anwendung von Best Practices des Software Development Lifecycle (SDLC) auf Ihre Automatisierungsprozesse optimiert. Bei der Erstellung von Umgebungen wird empfohlen, die folgenden vereinfachten Namenskonventionen zu verwenden, um den Zweck jeder Umgebung eindeutig zu identifizieren. Dies hilft den Benutzern, den Verwendungszweck der einzelnen Umgebungen schnell zu verstehen.

Umgebungstypen und Benennungskonventionen

1. DEV (Entwicklung)
   • Zweck: Einsatz bei der Entwicklung neuer Ketten und Verfahren. Entwickler können in der Entwicklungsumgebung (DEV) sicher erstellen und experimentieren.
   • Beispiel: DEV
2. Test (oder Sandbox)
   • Zweck: Einsatz für Test- und QS-Prozesse. QA-Teams können in der Testumgebung (Test) prüfen und testen.
   • Beispiel: TEST
3. PROD (Produktion)
   • Zweck: Für Prozesse, die getestet und verfeinert wurden und für den Einsatz in der Produktionsumgebung bereit sind. 

   • Beispiel: PROD

     

Hinweise

• Mehrere Ketten können identische Namen haben, aber jede wird durch einen eindeutigen Bezeichner unterschieden, der als GUID bekannt ist.

• Jeder Workspace hat eine eindeutige ID (siehe in der URL), so dass mehrere Workspaces denselben Namen haben können. Wir raten jedoch davon ab, da dies zu Verwirrung bei den Benutzern führen könnte.
• Ketten-, Arbeitsbereichs- und Arbeitsbereich-Umgebungsnamen unterstützen alle Leerzeichen und den Workiva-Standardzeichensatz.
• Der Name ist lang:
  • Der Name der Kette hat eine maximale Länge von 100 Zeichen.
    Achtung: beim Kopieren von Ketten werden automatisch die Zeichen "-- Copy" hinzugefügt. Ergibt dies einen Namen, der länger als 100 Zeichen ist, wird die Kette nicht kopiert.
  • Der Name des Kettenbefehls (Knoten) darf maximal 255 Zeichen lang sein. 
  • Die Namen von Arbeitsbereichen haben eine maximale Länge von 50 Zeichen.
  • Die Namen der Arbeitsbereichsumgebung dürfen maximal 25 Zeichen lang sein.

Zusammenfassung

Die Verwendung dieser vereinfachten Namenskonventionen trägt dazu bei, eine strukturierte und leicht zu navigierende Umgebung einzurichten. Es stellt sicher, dass der Zweck jeder Umgebung klar ist, wodurch Verwirrung vermieden und die Effizienz während der Entwicklungs-, Test- und Bereitstellungsphasen verbessert wird.