Información general

La serie de prácticas líderes describe las prácticas generales recomendadas para varios artefactos dentro de la Suite de Gestión de Datos en la Plataforma Workiva. Tenga 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 de sus espacios de trabajo. Empecemos por explorar estas convenciones de nombres.

Convenciones de nomenclatura para Conexiones, Cadenas y Entornos

 

Conexiones en cadena

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: Especifica el espacio de trabajo o PROYECTO donde se está utilizando el Conector.
• Entorno del Conector: Borrar 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 de 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 Conexiones en diferentes Entornos. Garantiza que las Cadenas dentro de Entornos específicos interactúen sólo con los Orígenes apropiados, mejorando la seguridad y la fiabilidad. Una conexión Non-Prod podría aprovecharse en los entornos Non-Prod, Desarrollo y UAT.

Esta práctica de convención de nombres debe aplicarse de forma coherente a todas las Conexiones, ya sean Core o Premium Connectors. Al mantener la uniformidad en los nombres de las Conexiones en los distintos Entornos, puede agilizar el proceso de Promover cadenas y Habilitar 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 nombres bien organizada. Una estrategia de nombres clara y coherente ayuda a navegar por las cadenas de forma más eficaz, sobre todo a medida que aumenta el número de flujos de trabajo. En esta sección se describen las principales prácticas para dar nombre a las Cadenas en función de su Propósito, Sistema de Orígenes, Frecuencia y Jerarquía del Flujo de Trabajo.

Finalidad y Sistema de Orígenes

Determinar el objetivo de la cadena

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

• ¿Qué tipo de datos se utilizan en la cadena?
• ¿Puede utilizarse la cadena en múltiples procesos (es decir, es una cadena de utilidad)?
• ¿De qué Orígenes se extraen los datos?

Frecuencia

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:

• Indique si la cadena va a funcionar de forma ad hoc.
• Especifique si la Cadena se ejecuta diaria, semanal, trimestral o anualmente.

Jerarquía

Organización de construcciones en cadena complejas

En la construcción de Cadenas que consisten en múltiples flujos de trabajo, típicamente hay una Cadena de nivel Arriba con múltiples Sub-Cadenas ejecutadas en una secuencia. Organice estas Cadenas anteponiéndoles una convención de nombres numerados.

Ejemplo de convención de nombres numerados:

1.0 Cadena Arriba
1.1 Ejecutar Conjunto de Datos
1.2 Cargar datos a 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 basándose en el orden numérico.

Ejemplos prácticos de convenciones de nombres de cadenas

Cadenas portacables

Las Cadenas de Utilidades son flujos de trabajo comunes ejecutados por otros múltiples flujos de trabajo, como Cargando 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 servicios públicos] | [Proceso] | Cadena de servicios públicos

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

0.2 - [Nombre de la cadena de servicios públicos] | [Proceso] | Cadena de servicios públicos.

Sistemas de Orígenes

El término "Sistemas de origen" se refiere al origen de los datos, que puede incluir varios sistemas como ERP (Enterprise Resource Planning), EPM (Enterprise Performance Management), HR (Human Resources) y sistemas de contabilidad, o puede estar basado en archivos, como los datos procedentes de un SFTP /FTP.

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

1. Workday

   • 1.0 - [Nombre de la cadena/proceso] | Día laborable | [Frecuencia].
   • 1.1 - [Nombre de la cadena/proceso] | Día laborable | [Frecuencia].
   • 1.2 - [Nombre de la cadena/proceso] | Día laborable | [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, utilice 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, lo que facilita la identificación y gestión de las Cadenas de Utilidades y las Cadenas de Sistemas de Origen en función de su proceso y Frecuencia de ejecución.

Convención de nombres de 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 de desarrollo de software (SDLC) a los procesos de automatización. Cuando cree Entornos, utilice las siguientes convenciones simplificadas de nomenclatura 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)

   • Finalidad: Se utiliza para desarrollar nuevas cadenas y procesos. Los creadores pueden crear y experimentar con seguridad en el Entorno de Desarrollo (DEV).

   • Ejemplo: DESARROLLO

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

   • Objeto: Dedicado a las 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: NON-PROD

3. PROD (Producción)

   • Finalidad: Para procesos que han sido probados, refinados 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

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