Esta guía proporciona instrucciones paso a paso para implementar la plantilla Ejecutar consulta y descargar resultados con hoja de control. Esta plantilla sirve como alternativa al comando Ejecutar consulta, que anteriormente requería que los usuarios ingresaran manualmente los parámetros en las cadenas antes de implementar y ejecutar.
Con el uso de una hoja de control, los usuarios pueden agregar varios ID de consulta y definir parámetros, como Lista de selección o Selección múltiple, de forma dinámica. Esta plantilla se integra comúnmente en cadenas existentes, pero también se puede usar en cualquier flujo de trabajo que requiera resultados de consultas en formato CSV.
Requisitos previos
Los siguientes conectores deben estar habilitados y configurados en tu espacio de trabajo.
- Configurar el conector de Workiva
- Configurar el conector de JSON
- Configurar el conector de asas
- Configura el Conector de solicitud HTTP
- Configura el Conector de transformación tabular
Se deben crear las siguientes variables de espacio de trabajo dentro de tu espacio de trabajo:
- wsv_API URL base - IAM
- wsv_Client ID
- wsv_Cliente Secreto
- wsv_API URL base - Wdata
Buscar la plantilla
La plantilla Ejecutar consulta y descargar resultados con hoja de control se encuentra en la sección Cadenas de Workiva de la pantalla Plantillas.
Aquí te explicamos cómo encontrarlo:
- En Generador de cadenas, ve a la pestaña Plantillas .
- Selecciona Cadenas de Workiva desde el menú de la parte superior.
- Busca 0.0 Ejecutar una consulta | Orquestación de primer nivel en la parte superior derecha y abre la plantilla.
-
Tras localizar la plantilla, haz clic en Nueva Cadena para desplegarla en tu espacio de trabajo.
Nota: Una vez configurada, cada cadena de esta plantilla debe publicarse en el espacio de trabajo.
Variables
| Tipo de variable | Nombre de variable | Descripción |
|---|---|---|
| Variable Espacio de trabajo. | wsv_API URL base - IAM |
Ingresa la URL base para la API según tu región:
|
| Variable Espacio de trabajo. | wsv_Client ID |
Ingresa el ID de cliente que recibes al configurar una concesión de API. Consulta aquí para obtener más instrucciones sobre la API de Workiva. |
| Variable Espacio de trabajo. | wsv_Cliente Secreto |
Puedes ver el secreto de concesión de tu API yendo a la pestaña Seguridad en tu perfil de usuario, y luego haciendo clic en la opción Regenerar en el menú desplegable Acciones junto a la concesión. Consulta aquí para obtener más instrucciones sobre la API de Workiva |
| Variable Espacio de trabajo. | wsv_API URL base - Wdata |
Ingresa la URL base para la API según tu región: |
Entradas en tiempo de ejecución
| Entrada en tiempo de ejecución | Propósito | Tipo de campo | Obligatorio |
|---|---|---|---|
| ID de hoja de cálculo | Aquí es donde se encuentra la hoja de cálculo de control. | Texto | Sí |
| ID de hoja | Aquí es donde se encuentra la hoja de control. | Texto | Sí |
Configurar la plantilla
Esta plantilla consta de dos cadenas, 0.0 Ejecutar una consulta | Orquestación de primer nivel y 0.1 Ejecutar una consulta | Descargar resultados. Cuando la cadena principal se implementa en tu espacio de trabajo, la cadena secundaria se implementa automáticamente con ella.
- Orquestación de primer nivel: según la información de la hoja de control, esta cadena determina si una consulta usa un solo tipo de parámetro (ya sea Lista de selección o Selección múltiple) o varios tipos de parámetros (tanto Lista de selección como Selección múltiple).
- Ejecutar una consulta | Descargar resultados: esta cadena ejecuta una consulta usando los parámetros especificados y recupera los datos correspondientes. Una vez que se ejecuta la consulta, los resultados se descargarán en formato CSV para su análisis o uso posterior.
Una vez que se configura la hoja de control y se implementa la plantilla de cadena en tu espacio de trabajo, todo lo que necesitas es el ID de la hoja de cálculo y el ID de la hoja de la hoja de control.
Estos valores se deben agregar como entradas en tiempo de ejecución para la cadena Orquestación de primer nivel.
Configuración de la hoja de control por tipo de parámetro
La forma en que configuras la hoja de control depende de los tipos de parámetros definidos en tu consulta de Wdata. Si una consulta incluye varios tipos de parámetros (por ejemplo, tanto Lista de selección como Selección múltiple), cada parámetro debe definirse en una fila separada usando el mismo ID de consulta. Si una consulta usa solo un tipo de parámetro, la hoja de control requiere una sola fila para esa consulta.
Los ejemplos a continuación ilustran ambos escenarios.
Ejemplo: consulta con varios tipos de parámetros
Para una consulta que requiere parámetros tanto de Lista de selección como de Selección múltiple, la hoja de control debe incluir filas separadas para cada parámetro, todas usando el mismo ID de consulta.
Nota: la columna Clave hace referencia al nombre del parámetro definido en la consulta de Wdata.
Ejemplo de configuración:
| ID de consulta | Tipo | Clave | Valores |
|---|---|---|---|
| ID de consulta de Wdata | Parámetros de la lista de selección | Año | Especifica un solo valor predeterminado (por ejemplo, 2023). |
| ID de consulta de Wdata | Parámetros de selección múltiple | Tipo de cuenta | Ingresa varios valores aceptables, separados por comas (por ejemplo, Activo, Gasto, Patrimonio, Ingresos). |
Ejemplo: consulta con un solo tipo de parámetro
Para una consulta que usa solo un tipo de parámetro, la hoja de control debe contener una sola fila para ese ID de consulta.
Por ejemplo, si la consulta solo usa un parámetro de Lista de selección:
| ID de consulta | Tipo | Clave | Valores |
|---|---|---|---|
| ID de consulta de Wdata | Parámetros de la lista de selección | Año | Especifica un solo valor predeterminado (por ejemplo, enero). |
Asegúrate de que la hoja de control esté configurada correctamente, ya que una configuración incorrecta puede generar problemas posteriores.
Cargar datos en una tabla
Puedes automatizar el proceso de cargar tu salida directamente en una tabla. Para cargar los datos de salida en una tabla, considera usar la plantilla "Cargar datos en Wdata". Esto se puede activar como parte de tu proceso agregando un evento Ejecutar cadena en el conector HTTP que descarga los resultados.
Solución de problemas
Para ver el historial de ejecución de tu cadena, incluidos los errores:
- Ve a la pestaña Monitor del Generador de cadenas.
-
Pasa el ratón por encima del signo de interrogación para ver el estado de la cadena ejecutada.
Si tu cadena generó un error o falló al descargar un resultado de consulta, realiza las siguientes comprobaciones:
- Verifica que ambas cadenas se hayan publicado en tu espacio de trabajo. Cada cadena debe publicarse por separado.
- Asegúrate de que la consulta en Wdata esté actualizada a la última versión.
- Al ingresar el ID de consulta, tipo, claves y valor en la hoja de control, asegúrate de que se haya ingresado el ID completo y de que no haya espacios en blanco al principio o al final. Además, confirma que las claves y los valores coincidan correctamente con los parámetros usados en Wdata.
- Asegúrate de que la concesión OAuth2 asociada a la conexión Workiva tiene el acceso adecuado.
- Asegúrate de que todos los parámetros usados en una consulta estén incluidos en la hoja de control.
Recursos adicionales
- Conector de Workiva
- Conector de utilidades de archivo
- Conector JSON
- Conector de transformación de tablas
- Ejecutar una cadena dentro de otra cadena ("Ejecutar eventos en cadena")
- Concesiones de OAuth2
- Función de Wdata y límites de API