Centro assistenza di Workiva

Panoramica

Questa serie di "leading practice" illustra le pratiche generali raccomandate per vari artefatti all'interno della Data Management Suite della piattaforma Workiva. Tieni presente che si tratta di linee guida generali e che possono essere adattate in base a casi d'uso specifici e particolari. Questi consigli hanno lo scopo di aiutarvi a migliorare l'organizzazione dei vostri spazi di lavoro. Cominciamo ad esplorare queste convenzioni di denominazione.

Convenzioni di denominazione per Connessioni, Catene e Ambienti

Connessioni a catena

Quando si creano connessioni a catena, è essenziale stabilire convenzioni di denominazione ottimali per garantire chiarezza e distinzione tra ambienti:

• Nome del connettore: Fornisci un nome descrittivo del connettore che ne indichi chiaramente lo scopo e la funzione.
• Tipo di spazio di lavoro: Specifica l'area di lavoro o il progetto in cui viene utilizzato il connettore.
• Ambiente del connettore: Identifica chiaramente l'ambiente (ad es. sviluppo, produzione) a cui corrisponde il connettore.

Esempio:

• Connessione SFTP | SEC Reporting | NON-PROD
  • Descrizione: Stabilisce una connessione al server SFTP per una soluzione di workspace SEC Reporting in un ambiente non di produzione come Sviluppo, QA, Sandbox ecc.
• Connessione SFTP | SEC Reporting | PROD
  • Descrizione: Stabilisce una connessione al server SFTP per la soluzione SEC reporting workspace nell'ambiente di produzione.

Questa convenzione di denominazione facilita l'identificazione e la gestione delle connessioni in diversi ambienti. Garantisce che le catene all'interno di ambienti specifici interagiscano solo con le fonti appropriate, migliorando la sicurezza e l'affidabilità. Una connessione Non-Prod può essere sfruttata in ambienti Non-Prod, Dev e Test.

Questa convenzione di denominazione deve essere applicata in modo coerente a tutte le connessioni, siano esse Connettori Core o Premium. Mantenendo l'uniformità dei nomi delle connessioni nei diversi ambienti, puoi semplificare il processo di promozione delle catene e consentirne l'esecuzione senza interruzioni in tutti gli spazi di lavoro.

Generatore di catene

Quando si creano catene nella piattaforma Workiva, è fondamentale mantenere una convenzione di denominazione ben organizzata. Una strategia di denominazione chiara e coerente aiuta a navigare nelle catene in modo più efficiente, soprattutto quando il numero di flussi di lavoro aumenta. Questa sezione illustra le migliori pratiche per nominare le catene in base al loro scopo, al sistema di origine, alla frequenza e alla gerarchia dei flussi di lavoro.

Scopo e sistema sorgente

Determinare lo scopo della catena

Considera le seguenti domande per definire lo scopo di una Catena:

• Che tipo di dati vengono utilizzati nella catena?
• La catena può essere utilizzata in più processi (ad esempio, è una catena di utilità)?
• Da quale sistema di origine vengono estratti i dati?

Frequenza

Specificare la frequenza della catena

Quando si assegna un nome alla catena, è importante indicare la sua frequenza, soprattutto se è programmata per essere eseguita automaticamente. Suggeriamo le seguenti linee guida:

• Indica se la Catena deve essere eseguita ad hoc.
• Specifica se la Catena viene eseguita su base giornaliera, settimanale, trimestrale o annuale.

Gerarchia

Organizzazione di catene complesse

Nella creazione di catene composte da più flussi di lavoro, di solito c'è una catena di primo livello con più sottocatene eseguite in sequenza. Organizza queste Catene anteponendo loro una convenzione di denominazione numerata.

Esempio di convenzione di denominazione numerica:

• 1.0 Catena di primo livello
• 1.1 Eseguire il set di dati
• 1.2 Caricare i dati nella tabella Wdata
• 1.3 Aggiornare le connessioni in entrata

Questo approccio aiuta gli utenti a identificare rapidamente l'ordine delle operazioni all'interno di un flusso di lavoro e organizza automaticamente le catene all'interno dell'area di lavoro in base all'ordine numerico.

Esempi pratici di convenzioni di denominazione delle catene

Catene di utilità

Le catene di utilità sono flussi di lavoro comuni eseguiti da più flussi di lavoro, come ad esempio Caricamento dei dati in una tabella Wdata. Per fare in modo che le Catene di utilità vengano visualizzate in modo evidente nella parte superiore dell'area di lavoro, considera le seguenti convenzioni di denominazione::

• 0.0 - [Nome della catena di utilità] | [Processo] | Catena di utilità
• 0.1 - [Nome della catena di utilità] | [Processo] | Catena di utilità
• 0.2 - [Nome della catena di utilità] | [Processo] | Catena di utilità

Sistemi di origine

Il termine "Sistemi di origine" si riferisce all'origine dei dati, che può includere vari sistemi come ERP (Enterprise Resource Planning), EPM (Enterprise Performance Management), HR (Human Resources) e sistemi di contabilità, oppure può essere basato su file, come i dati provenienti da un SFTP /FTP.

L'esempio seguente mostra l'organizzazione di tre sistemi sorgente come esempio:

1. Workday
   • 1.0 - [Nome della catena/processo] | Workday | [Frequenza]
   • 1.1 - [Nome della catena/processo] | Giorno lavorativo | [Frequenza]
   • 1.2 - [Nome della catena/processo] | Giorno lavorativo | [Frequenza]
2. SAP
   • 2.0 - [Nome della catena/processo] | SAP | [Frequenza]
   • 2.1 - [Nome della catena/processo] | SAP | [Frequenza]
   • 2.2 - [Nome della catena/processo] | SAP | [Frequenza]
3. Netsuite
   • 3.0 - [Nome della catena/processo] | Netsuite | [Frequenza]
   • 3.1 - [Nome della catena/processo] | Netsuite | [Frequenza]
   • 3.2 - [Nome della catena/processo] | Netsuite | [Frequenza]

Per un'area di lavoro con un gran numero di catene, usa i seguenti esempi di convenzione di denominazione per chiarezza e organizzazione:

Questa struttura garantisce convenzioni di denominazione e organizzazione chiare e coerenti, facilitando l'identificazione e la gestione delle catene di utilità e delle catene di sistemi sorgente in base al loro processo e alla loro frequenza di esecuzione.

Convenzione di denominazione degli ambienti

Gli ambienti consentono di pianificare, testare e distribuire i flussi di lavoro senza alcuno sforzo. Questo semplifica l'applicazione delle migliori pratiche del ciclo di vita dello sviluppo del software (SDLC) ai vostri processi di automazione. Quando si creano gli ambienti, si consiglia di utilizzare le seguenti convenzioni di denominazione semplificate per identificare chiaramente lo scopo di ogni ambiente . Questo aiuta gli utenti a capire rapidamente l'uso previsto per ogni Ambiente.

Tipi di ambiente e convenzioni di denominazione

1. DEV (Sviluppo)
   • Scopo: viene utilizzato per lo sviluppo di nuove catene e processi. I costruttori possono creare e sperimentare in sicurezza nell'ambiente di Sviluppo (DEV).
   • Esempio: DEV
2. Test (o Sandbox)
   • Scopo: Dedicato ai processi di test e QA. I team QA possono rivedere e testare nell'ambiente di test (Test).
   • Esempio: TEST
3. PROD (Produzione)
   • Scopo: Per i processi che sono stati testati, perfezionati e pronti per essere distribuiti nell'ambiente di produzione. 

   • Esempio: PROD

     

Note

• Più catene possono avere nomi identici, ma ognuna è contraddistinta da un identificatore unico noto come GUID.

• Ogni spazio di lavoro ha un ID univoco (vedi URL), quindi più spazi di lavoro possono avere lo stesso nome. Si consiglia di non farlo, tuttavia, a causa della potenziale confusione dell'utente.
• I nomi delle catene, degli spazi di lavoro e degli ambienti di lavoro supportano tutti gli spazi e il set di caratteri standard di Workiva.
• Lunghezza del nome:
  • I nomi delle catene hanno una lunghezza massima di 100 caratteri.
    Attenzione: quando si copiano le catene, vengono aggiunti automaticamente i caratteri "-- Copia". Se si ottiene un nome più lungo di 100 caratteri, la catena non verrà copiata.
  • I nomi dei comandi di catena (nodi) hanno un massimo di 255 caratteri. 
  • I nomi degli spazi di lavoro hanno una lunghezza massima di 50 caratteri.
  • I nomi dell'ambiente di lavoro hanno una lunghezza massima di 25 caratteri.

Riepilogo

L'uso di queste convenzioni di denominazione semplificate aiuta a mantenere un ambiente strutturato e facilmente navigabile. Assicura che lo scopo di ogni ambiente sia chiaro, riducendo la confusione e migliorando l'efficienza durante le fasi di sviluppo, test e distribuzione.