Información general

La serie de prácticas recomendadas describe las prácticas generales recomendadas para varios artefactos de la Suite de Gestión de Datos de la Plataforma Workiva. Ten en cuenta que se trata de directrices generales y que puede ser necesario adaptarlas en función de casos de uso específicos y únicos. Estas recomendaciones pretenden ayudar a los usuarios a mejorar la organización dentro de sus Espacios de trabajo.  Empecemos explorando estas convenciones de nomenclatura.

Convenciones de nomenclatura para Conexiones, Cadenas y Entornos

Conexiones en Cadenas

Cuando se crean Conexiones en Cadenas, es esencial establecer unas convenciones de nombres óptimas para garantizar la claridad y la distinción entre Entornos:

• Nombre del Conector: Proporciona un nombre descriptivo para el Conector que indique claramente su finalidad y función.
• Tipo de Espacio de trabajo: Especifica el espacio de trabajo o proyecto en el que se está utilizando el Conector.
• Entorno del Conector: Identifica claramente el Entorno (por ejemplo, Desarrollo, Producción) al que corresponde el Conector.

Ejemplo:

• Conexión SFTP | Informes SEC | NON-PROD
  • 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 no productivo como Desarrollo, QA , 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 nombres facilita la identificación y gestión de las Conexiones en distintos Entornos. Garantiza que las Cadenas de entornos específicos interactúen solo con los Orígenes adecuados, mejorando la seguridad y la fiabilidad. Una conexión Non-Prod podría aprovecharse en entornos Non-Prod, Dev y UAT.

Esta práctica de convención de nombres debe aplicarse sistemáticamente a todas las Conexiones, ya sean Conectores principales o Conectores premium. Si mantienes la uniformidad en los nombres de las Conexiones en los distintos Entornos, puedes agilizar el proceso de promoción de Cadenas y permitir la ejecución fluida de Cadenas en los distintos espacios de trabajo.

Generador de cadenas

Cuando se construyen Cadenas en la plataforma Workiva, es crucial mantener una convención de nomenclatura bien organizada. Una estrategia de nombres clara y coherente ayuda a navegar por las Cadenas con más eficacia, sobre todo a medida que aumenta el número de flujos de trabajo. Esta sección describe las principales prácticas para nombrar Cadenas en función de su Finalidad, Sistema de Orígenes, Frecuencia y Jerarquía del Flujo de Trabajo.

Finalidad y Sistema de Origen

Determinar la finalidad de las Cadenas

Considera las siguientes preguntas para definir la finalidad de una Cadena:

• ¿Qué tipo de datos se utilizan en la Cadena?
• ¿Puede utilizarse la Cadena en varios procesos (es decir, es una Cadena de Utilidad)?
• ¿Qué sistema de origen se está utilizando para extraer datos?

Frecuencia

Especificar la frecuencia de la cadena

Al dar nombre a la Cadena, es esencial indicar su frecuencia, sobre todo si está programada para ejecutarse automáticamente. Utiliza las siguientes directrices:

• Indica si la Cadena se va a ejecutar ad hoc.
• Especifica si la Cadena se ejecuta diaria, semanal, trimestral o anualmente.

Jerarquía

Organización de construcciones complejas en cadena

En la construcción de Cadenas formadas por múltiples flujos de trabajo, suele haber una Cadena de nivel superior con múltiples Subcadenas ejecutadas en una secuencia. Organiza estas Cadenas anteponiéndoles un prefijo con una convención de nombres numerados.

Ejemplo de Convención de Numeración:

1.0 Cadenas de nivel superior
1.1 Ejecutar conjuntos de datos
1.2 Subir datos a la tabla de 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 basándose en el orden numérico.

Ejemplos Prácticos de Convenciones para Nombrar Cadenas

Cadenas Utilitarias

Las Cadenas de Utilidades son flujos de trabajo comunes ejecutados por otros flujos de trabajo múltiples, como Cargando datos en una Tabla de Wdata. Para garantizar que las Cadenas de utilidad se muestren de forma destacada en la parte superior del espacio de trabajo, ten en cuenta las siguientes convenciones de nomenclatura:

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

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

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

Sistemas de origen

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), RRHH (Recursos humanos) y sistemas contables, o puede estar basado en archivos, como los datos procedentes de un SFTP /FTP.

El siguiente ejemplo muestra la organización de tres Sistemas de Orígenes a modo de ejemplo:

1. Workday

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

2. SAP

   • 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 un gran número de Cadenas, utiliza los siguientes ejemplos de convención de nomenclatura para mayor claridad y organización:

Esta estructura garantiza unas convenciones de nomenclatura y una organización claras y coherentes, que facilitan la identificación y gestión de las Cadenas de Utilidades y las Cadenas de Sistemas de Orígenes en función de su proceso y frecuencia de ejecución.

Convención de Nombres del Entorno

Los entornos permiten al equipo planificar, probar y desplegar el flujo de trabajo sin esfuerzo. Esta función agiliza 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, utiliza las siguientes convenciones simplificadas de nomenclatura para identificar claramente la finalidad 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)

   • Finalidad: Se utiliza para desarrollar nuevas Cadenas y Procesos. Los Generadores pueden crear y experimentar con seguridad en el entorno de desarrollo (DEV).

   • Ejemplo: DEV

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

   • Propósito: Dedicado a pruebas y procesos de 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)

   • Finalidad: Para procesos que se han evaluado, perfeccionado y están listos para su despliegue 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

Utilizar estas convenciones de nomenclatura simplificada ayuda a mantener una configuración del entorno estructurada y fácilmente navegable. Garantiza que el propósito de cada Entorno esté claro, reduciendo la confusión y mejorando la eficacia durante las fases de Desarrollo, Pruebas e Implantación.