¿Cómo crear una hoja de control de la cadena?

Fondo

Cuando orquestamos procesos de elaboración de informes utilizando Data Management Suite, a menudo nos encontramos con escenarios de flujo de trabajo complejos. Por ejemplo, una aplicación puede necesitar ejecutarse:

• Un mismo flujo de trabajo varias veces con entradas variadas
• Varios flujos de trabajo distintos
• Varios flujos de trabajo simultáneos, cada uno con entradas específicas
• Flujos de trabajo de integración del sistema fuente que requieren parámetros específicos, como fechas, nombres de archivos o nombres de reglas

Para automatizar y gestionar eficazmente estos intrincados requisitos del flujo de trabajo, el concepto de hoja de control resulta inestimable. Una Hoja de Control actúa como una herramienta de gestión centralizada que permite predefinir las entradas para cada ejecución del flujo de trabajo. Al aprovechar las hojas de control, los usuarios pueden especificar los parámetros y las condiciones en las que debe funcionar cada flujo de trabajo, lo que facilita un proceso automatizado y sin fisuras que ejecuta todos los flujos de trabajo necesarios con las entradas adecuadas sin necesidad de intervención manual en cada paso.

Al crear y aprovechar una Hoja de Control, los usuarios pueden:

• Definir los valores de entrada que se pasarán a una cadena en cada ejecución
• Definir Banderas que determinarán si una cadena debe realizar ciertas operaciones
• Pasar valores, como parámetros de consulta, nombres de reglas o filtros de fechas, al flujo de trabajo del sistema cuando se ejecuta una cadena o se ejecuta una regla.
• Realizar piezas de operaciones de Roll-forward
• Gestione el ID de para artefactos dentro de Workiva
• Registrar el estado de ejecución de un flujo de trabajo

Este artículo guiará a los usuarios a través del proceso de creación de una hoja de control sencilla. Esta hoja permitirá a los usuarios ejecutar el mismo flujo de trabajo con varios conjuntos de entradas.

Requisitos previos

• Configure el conector Workiva
• Configure el conector JSON de
• Configure el conector del manillar

Paso 1: Crear una hoja de control

• Crear una hoja de cálculo en la plataforma Workiva
• Asigna permisos de propiedad al usuario asociado a la concesión OAuth2.
• Cambie el nombre de la hoja de cálculo y de la hoja como
  • Hoja de cálculo de control
  • Hoja de control

Paso 2: Establecer cabeceras (claves) para la hoja de control

Establezca cabeceras para cada valor que vaya a ser procesado por el flujo de trabajo Cadena. En este ejemplo, se configuran las siguientes cabeceras:

• Active_Flag: Para determinar si esta fila debe procesarse o no
• Nombre_archivo: Nombre del fichero a procesar
• Table_ID: ID de la tabla Wdata donde se importará el fichero

Paso 3: Asignar valores a las cabeceras de la hoja de control

• En este ejemplo, se han definido tres valores para cada par Clave/Valor. Por lo tanto, a medida que se lee cada línea, se introducen los siguientes datos:

Paso 4: Crear una cadena para recuperar los datos de la hoja de control

Para recuperar los datos de la hoja de control de la hoja de cálculo, se debe crear una Cadena para leer la Hoja de Cálculo. 

• Navegue hasta el módulo Cadenas y cree una nueva Cadena
• Vaya a la configuración de la cadena y titule su nueva cadena Obtener datos de la hoja de control
• Añade dos variables Chain :
  • cv-SpreadsheetID
  • cv-SheetName
• Rellene cada variable con los valores correspondientes de SpreadsheetID y SheetName de su hoja de control.

   

Paso 5: Obtener datos de la hoja

Para utilizar los datos dentro de su hoja de control, debe utilizar el comando Get Sheet Data. El comando lee el contenido de una hoja de una hoja de cálculo y produce una salida .csv. 

• Arrastre y suelte el comando Workiva Get Sheet Data en la sección START del lienzo
• Configurar el mando
  • Cambie el nombre a Obtenga los datos de la hoja de control
  • Utilice la variable de cadena cv-SpreadsheetID para el campo Spreadsheet ID
  • Utilice la variable de cadena cv-SheetName para el campo ID/Nombre de la hoja
  • Introduzca A1: para la región
  • Deje el estilo de valor y la revisión como Calculado y -1
  • Haga clic en Guardar

Paso 6: Convertir los datos de la hoja en JSON

Tras recuperar con éxito los datos de la hoja de control en formato .csv, el siguiente paso es convertirlos a JSON. Esta conversión garantiza que las cabeceras y los valores de las columnas se reformateen correctamente en la estructura JSON Clave-Valor. Este formato es crucial para los pasos siguientes.

• Arrastre el comando CSV to JSON al lienzo
• Vincule el comando Get Control Sheet Data al comando CSV to JSON
• Edite el comando CSV to JSON
  • En el campo Input File, utilice la salida Data del desplegable Get Control Sheet Data
  • Deje el campo Delimitador como Coma (,)
  • Haga clic en Guardar

Paso 7: Iterar a través de los datos JSON

Ahora que los datos de la Hoja de Control están en formato JSON, se puede utilizar un Grupo de Comandos para iterar a través de cada fila de datos dentro de su hoja de control

• Añadir Grupo de comandos al lienzo
• Conecte el comando CSV to JSON a la parte En del grupo de comandos
• Edite el Grupo de Comandos y nómbrelo JSON Iterator
  • Haga clic en el símbolo de iteración situado a la derecha de la pestaña Información básica
  • Habilitar el iterador
  • Deje el Seleccionar Tipo de Modificador como Lista
  • Para la sección Iteraciones, seleccione la salida <> Archivo JSON del menú desplegable del comando CSV a JSON
• Haga clic en Guardar

Paso 8: Vista previa de cada iteración de datos

Con la cadena ahora capaz de iterar a través de cada fila de su hoja de control, se puede utilizar un comando Handlebars para previsualizar la salida de la información.

Nota: El comando Handlebars sirve como marcador de posición para revisar los valores en este artículo, pero también se pueden utilizar otros comandos para procesar los valores.

• Arrastre y suelte un comando Render Text Template al lienzo
• Vincule el Inicio de Grupo del Grupo de Comandos al comando Renderizar Plantilla de Texto
• Edite el comando y nómbrelo Preview Control Sheet Data
• En el campo Plantilla, introduzca lo siguiente:

Nombre de archivo Indicador activo ID de tabla 

• Para obtener los valores de la hoja de control, debe aplicarse una transformación de variables para cada iteración JSON
• Junto a Nombre de archivo, elija Iteración de archivo JSON en la barra lateral, situada bajo el desplegable Iterador de grupo.
  • • Haga clic en la iteración del archivo JSON, seleccione Obtener valor de JSON
    • En el campo Valor, introduzca la cabecera File_Name de su hoja de control
      • Nota: Una buena práctica es copiar la cabecera de su hoja de control directamente en el campo de valor
  • Pulse Intro y Aceptar
• Repita los pasos anteriores para Active_Flag & Table_ID encabezados de la hoja de control
• Una vez completado, el campo de la plantilla debe tener el siguiente aspecto:

• Guardar el comando

Paso 9: Ejecutar la cadena y previsualizar

Ahora que la Cadena y la Hoja de Control están configuradas, es importante asegurarse de que cada iteración de la salida del Manillar contiene datos para cada fila de la hoja de control.

• Haga clic en Publique y luego Ejecute la cadena
• Corre la cadena
• Una vez que la cadena se haya ejecutado correctamente, haga clic en el comando Preview Control Sheet Data y vaya a la pestaña Log
  • En "Start Rendered Text", debería aparecer un resultado de la primera iteración.
  • Cambie a Valor 2 en la opción situada encima de la pestaña Registro para ver los resultados de la segunda iteración
  • Por último, cambie al valor 3 para ver los resultados de la tercera iteración
• Cada iteración debe aparecer como sigue:

Valor 1:

Valor 2:

Valor 3:

Aprovechar la bandera activa

Incorporar una lógica Condicional que utilice el valor de la Bandera Activa es el siguiente paso, utilizando la misma cadena que se ha construido.

• Edite la Cadena y elimine el enlace entre el Iterador JSON y los Datos de la Hoja de Control de la Vista Previa
• Añada un comando Condicional y conecte el Inicio de Grupo del Grupo de Comandos al nuevo comando
• Vincule el comando Condicional al comando Vista previa de los datos de la hoja de control
• Editar el comando Condicional
  • Nombra el comando Active Flag?
  • Haga clic en el botón + Regla
  • En el campo de valor, haga clic en <> JSON File Iteration del desplegable del Iterador de grupo
  • Añadir una transformación variable y utilizar el Active_Flag encabezado de la hoja de control como el valor
    • Haga clic en Aceptar
  • Cambie la condición de "Is Blank" a "="
  • Introduzca la palabra "true" en el campo de expresión
  • Haga clic en Guardar

• Dado que el Active_Flag para dos de las iteraciones se fijó en "FALSE", el comando Preview Control Sheet Data se ejecutó sólo para la tercera iteración.
• Los comandos que siguen al comando condicional "¿Bandera activa?" se omitirán si su iteración en la hoja de control tiene el valor "FALSE".

Casos de uso adicionales

La Hoja de Control ofrece una forma muy eficaz de centralizar, gestionar y automatizar los valores utilizados en la ejecución del flujo de trabajo. Puede aplicarse en varios escenarios, entre ellos:

• Un eje central para gestionar los identificadores de un Sistema Fuente, Workiva y elementos Wdata
• Utilización de un indicador para filtrar y decidir si debe ejecutarse un proceso específico
• Especificación de puntos finales de URL para ejecutar informes desde un sistema fuente
• Definición de fechas y convenciones de nomenclatura para archivos específicos
• Identificación de directorios de archivos para que un SFTP recupere archivos designados