Esta guía ofrece instrucciones paso a paso para implementar la plantilla « : Ejecutar consulta y descargar resultados con hoja de control» . Esta plantilla sirve como alternativa al comando « » de «Run Query» , que anteriormente obligaba a los usuarios a introducir manualmente los parámetros en cadena antes de la implementación y la ejecución.
Mediante el uso de una hoja de control de « » ( ), los usuarios pueden añadir varios ID de consulta y definir parámetros, como « » (Lista de selección) ( ) o « » (Selección múltiple) ( ), de forma dinámica. Esta plantilla suele integrarse en cadenas ya existentes, pero también puede utilizarse en cualquier flujo de trabajo que requiera resultados de consultas en formato CSV de .
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
- Configurar el conector de solicitudes HTTP « »
- Configurar el conector de transformación tabular de
Debes 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 «Workiva Chains» de la pantalla «Plantillas de » ( ).
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 nivel superior en la esquina 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 |
Introduce la URL base de la API según tu región:
|
| Variable Espacio de trabajo. | wsv_Client ID |
Introduce el ID de cliente que recibes al configurar una autorizació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 la API accediendo a la pestaña «Seguridad» de tu perfil de usuario y, a continuación, haciendo clic en la opción «Regenerar» en el menú desplegable «Acciones» situado 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 |
Introduce la URL base de 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 nivel superior» y « » 0.1 «Ejecutar una consulta» | «Descargar resultados» . Cuando se implementa la cadena principal en tu espacio de trabajo, la cadena «chain» se implementa automáticamente junto con ella.
- de orquestación de primer nivel: A partir de la información de la hoja de control, esta cadena determina si una consulta utiliza un único 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 utilizando los parámetros especificados y recupera los datos correspondientes. Una vez ejecutada la consulta, los resultados se descargarán en formato CSV para su posterior análisis o uso.
Una vez configurada la hoja de control « » ( ) e implementada la plantilla de cadena « » ( ) en tu espacio de trabajo, solo necesitarás el ID de la hoja de cálculo « » ( ) y el ID de la hoja « » ( ) de la hoja de control.
Estos valores deben añadirse como entradas de tiempo de ejecuci : para la cadena de orquestación de nivel superior de : .
Configuración de la hoja de control por tipo de parámetro
La forma de configurar la hoja de control depende de los tipos de parámetros definidos en tu consulta Wdata. Si una consulta incluye varios tipos de parámetros (por ejemplo, tanto una lista de selección como una selección múltiple ), cada parámetro debe definirse en una fila independiente utilizando el mismo ID de consulta . Si una consulta utiliza un único tipo de parámetro , la hoja de control requiere una sola fila para dicha consulta.
Los ejemplos que figuran a continuación ilustran ambos casos.
Ejemplo: Consulta con varios tipos de parámetros
En el caso de una consulta que requiera tanto el parámetro « » (Lista de selección) como el parámetro « » (Selección múltiple) , la hoja de control debe incluir filas separadas para cada parámetro , todas ellas con el mismo ID de consulta .
Nota: La columna « » (Clave) hace referencia al nombre del parámetro « » (Nombre) definido en la consulta 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 único valor por defecto (por ejemplo, 2023 ). |
| ID de consulta de Wdata | Parámetros de selección múltiple | Tipo de cuenta | Introduce varios valores válidos, separados por comas (por ejemplo, Asset, Expense, Equity, Revenue ). |
Ejemplo: consulta con un único tipo de parámetro
En el caso de una consulta que utilice únicamente 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 utiliza 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 único valor por defecto (por ejemplo, 1 de enero ). |
Asegúrate de que la hoja de control esté configurada correctamente, ya que una configuración incorrecta puede provocar problemas posteriores.
Carga de datos en una tabla
Puedes automatizar el proceso de cargar los resultados directamente en una tabla. Para cargar los datos de salida en una tabla, te recomendamos que utilices la plantilla « » «Load Data to Wdata» « ». Esto se puede activar como parte de tu proceso añadiendo un evento « » de la cadena de ejecución ( ) 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 ha generado un error o no ha podido descargar el resultado de una consulta, realiza las siguientes comprobaciones:
- Comprueba 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 introducir el ID de consulta de , el tipo de , las claves y el valor en la hoja de control , asegúrate de que se ha introducido el ID completo y de que no hay espacios en blanco al principio ni al final. Además, comprueba que las claves y los valores coincidan correctamente con los parámetros utilizados en Wdata.
- Asegúrate de que la concesión OAuth2 de asociada a la conexión con Workiva disponga de los permisos de acceso adecuados.
- Asegúrate de que todos los parámetros utilizados en una consulta figuren 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