Información general

La serie de prácticas líderes describe las prácticas generales recomendadas para varios artefactos dentro de Data Management Suite en la plataforma Workiva. Tenga en cuenta que estas son pautas generales y es posible que sea necesario adaptarlas en función de casos de uso específicos y únicos. Estas recomendaciones tienen como objetivo ayudar a los usuarios a mejorar la organización dentro de sus espacios de trabajo.Comencemos explorando estas convenciones de nomenclatura.

Convenciones de nombres para Conexiones, Cadenas y Entornos

 

Conexiones en cadenas

Al crear conexiones en cadenas, es esencial establecer convenciones de nomenclatura óptimas para garantizar la claridad y la distinción entre Entornos:

• Nombre del conector: Proporcione un nombre descriptivo para el conector que indique claramente su propósito y función.
• Tipo de espacio de trabajo: Especifique el espacio de trabajo o proyecto donde se está utilizando el Conector.
• Entorno del Conector: Identifique claramente el Entorno (p. ej. Desarrollo, Producción) al que corresponde el Conector.

Ejemplo:

• Conexión SFTP | Informes SEC | NO PRODUCCIÓN
  • Descripción: Establece una conexión con el servidor SFTP para una solución de espacio de trabajo de informes SEC dentro de un entorno que no es de producción, como desarrollo, control de calidad, sandbox, etc.
• Conexión SFTP | Informes SEC | PROD
  • Descripción: Establece una conexión con el servidor SFTP para la solución del espacio de trabajo de informes SEC dentro del entorno de producción.

Esta convención de nomenclatura facilita la identificación y gestión de conexiones en diferentes entornos. Garantiza que las cadenas dentro de entornos específicos interactúen solo con las fuentes adecuadas, lo que mejora la seguridad y la confiabilidad. Se podría aprovechar una conexión Non-Prod en entornos No-Prod, Dev y UAT.

Esta práctica de convención de nombres se debe aplicar de manera uniforme a todas las conexiones, ya sean conectores principales o premium. Al mantener la uniformidad en los nombres de las conexiones en diferentes entornos, puede optimizar el proceso de promoción de cadenas y permitir la ejecución sin inconvenientes de cadenas en todos los espacios de trabajo.

Generador de cadenas

Al crear cadenas en la plataforma Workiva, es crucial mantener una convención de nomenclatura bien organizada. Una estrategia de nombres clara y consistente ayuda a navegar por las cadenas de manera más eficiente, especialmente a medida que crece el número de flujos de trabajo. Esta sección describe las principales prácticas para nombrar cadenas en función de su propósito, sistema de origen, frecuencia y jerarquía de flujo de trabajo.

Propósito y sistema de origen

Determinar el propósito de la cadena

Considere las siguientes preguntas para definir el propósito de una cadena:

• ¿Qué tipo de datos se utilizan dentro de la Cadena?
• ¿Se puede utilizar la cadena en múltiples procesos (es decir, es una cadena de utilidad)?
• ¿Qué sistema fuente se está utilizando para extraer datos?

Frecuencia

Especificación de la frecuencia de la cadena

Al nombrar la Cadena, es esencial indicar su frecuencia, particularmente si está programada para ejecutarse automáticamente. Utilice las siguientes pautas:

• Indique si la cadena se ejecutará de forma ad hoc.
• Especifique si la cadena se ejecuta de forma diaria, semanal, trimestral o anual.

Jerarquía

Organización de cadenas complejas

En una compilación en cadena que consta de múltiples flujos de trabajo, normalmente hay una cadena de nivel superior con múltiples subcadenas ejecutadas en una secuencia. Organice estas cadenas prefijándolas con una convención de nombres numerada.

Ejemplo de una convención de nombres numerados:

1.0 Cadena de nivel superior
1.1 Ejecutar conjunto de datos
1.2 Cargar datos en la tabla Wdata
1.3 Actualizar conexiones entrantes

Este enfoque ayuda a los usuarios a identificar rápidamente el orden de las operaciones dentro de un flujo de trabajo y organiza automáticamente las cadenas dentro del espacio de trabajo según el orden numérico.

Ejemplos prácticos de convenciones de nombres de cadenas

Cadenas de utilidad

Las cadenas de utilidades son flujos de trabajo comunes ejecutados por varios otros flujos de trabajo, como Cargar datos en una tabla Wdata. Para garantizar que las cadenas de utilidades se muestren de forma destacada en la parte superior del espacio de trabajo, tenga en cuenta las siguientes convenciones de nomenclatura:

0.0 - [Nombre de la cadena de utilidad] | [Proceso] | Cadena de utilidad

0.1 - [Nombre de la cadena de utilidad] | [Proceso] | Cadena de utilidad

0.2 - [Nombre de la cadena de utilidad] | [Proceso] | Cadena de utilidad

Sistemas fuente

El término "Sistemas fuente" se refiere al origen de los datos, que puede incluir varios sistemas como ERP (Planificación de recursos empresariales), EPM (Gestión del rendimiento empresarial), RR.HH. (Recursos humanos) y sistemas de contabilidad, o puede estar basado en archivos, como datos que provienen de un SFTP/FTP.

El siguiente ejemplo demuestra la organización de tres sistemas fuente a modo de ejemplo:

1. Jornada laboral

   • 1.0 - [Nombre de la cadena/proceso] | Jornada laboral | [Frecuencia]
   • 1.1 - [Nombre de la cadena/proceso] | Jornada laboral | [Frecuencia]
   • 1.2 - [Nombre de la cadena/proceso] | Jornada laboral | [Frecuencia]

2. SAVIA

   • 2.0 - [Nombre de la cadena/proceso] | SAP | [Frecuencia]
   • 2.1 - [Nombre de la cadena/proceso] | SAP | [Frecuencia]
   • 2.2 - [Nombre de la cadena/proceso] | SAP | [Frecuencia]

3. Netsuite

   • 3.0 - [Nombre de la cadena/proceso] | Netsuite | [Frecuencia]
   • 3.1 - [Nombre de la cadena/proceso] | Netsuite | [Frecuencia]
   • 3.2 - [Nombre de la cadena/proceso] | Netsuite | [Frecuencia]

Para un espacio de trabajo con una gran cantidad de cadenas, utilice los siguientes ejemplos de convención de nomenclatura para mayor claridad y organización:

Esta estructura garantiza convenciones de nomenclatura y organización claras y consistentes, lo que facilita la identificación y gestión de cadenas de utilidades y cadenas de sistemas fuente en función de su proceso y frecuencia de ejecución.

Convención de nomenclatura del entorno

Los entornos permiten al equipo planificar, probar e implementar el flujo de trabajo sin esfuerzo. Esta función optimiza la aplicación de las mejores prácticas del ciclo de vida del desarrollo de software (SDLC) a los procesos de automatización. Al crear entornos, utilice las siguientes convenciones de nombres simplificadas para identificar claramente el propósito de cada entorno. Esto ayuda a los usuarios a comprender rápidamente el uso previsto de cada entorno.

Tipos de entorno y convenciones de nomenclatura

1. DEV (Desarrollo)

   • Propósito: Se utiliza para desarrollar nuevas cadenas y procesos. Los desarrolladores pueden crear y experimentar de forma segura en el entorno de desarrollo (DEV).

   • Ejemplo: DEV

2. UAT (Prueba de aceptación del usuario) o Sandbox

   • Propósito: Dedicado a procesos de pruebas y control de calidad. Los equipos de control de calidad pueden revisar y probar en el entorno de pruebas de aceptación del usuario (UAT).
   • Ejemplo: NO PROD

3. PROD (Producción)

   • Propósito: Para procesos que han sido probados, refinados y están listos para su implementación en el entorno de producción (PROD). 
   • Ejemplo: PROD

Nota: Varias cadenas pueden tener nombres idénticos, pero cada una se distingue por un identificador único conocido como GUID 

 

Resumen

El uso de estas convenciones de nombres simplificadas ayuda a mantener una configuración de entorno estructurada y de fácil navegación. Asegura que el propósito de cada entorno sea claro, reduciendo la confusión y mejorando la eficiencia durante las fases de desarrollo, prueba e implementación.