Trabajo con encabezados de estudios analíticos

Un encabezado de estudio analítico es una serie de etiquetas de estudio analítico encerradas en un bloque de comentario al principio de un script. Las etiquetas especifican entradas de script o salidas de script.

Si desea ver una descripción general y visual de las entradas y salidas de un script de estudio analítico y las etiquetas asociadas, consulte Entradas y salidas de scripts: Visión general.

Las etiquetas que especifican los parámetros de entrada orientados al usuario le permiten a un usuario especificar los valores de entrada del script por adelantado, lo que significa que un script de estudio analítico puede ejecutarse sin supervisión, ya sea de forma inmediata o en un momento programado.

Después de desarrollar scripts en un proyecto de Analytics, debe agregar un encabezado de estudio analítico a al menos un script antes de poder confirmar y enviar los scripts a Robots.

Usar el Diseñador de encabezado de estudio analítico es la forma más fácil de agregar o modificar un encabezado de estudio analítico. También puede agregar o modificar un encabezado de estudio analítico manualmente.

Note

Version 16 of Analytics, and all subsequent versions, are not intended for use with Analytics Exchange (AX). Diligent ended support for Analytics Exchange on January 1, 2023. Learn more or upgrade to Robots.

For information about using Analytics in conjunction with Analytics Exchange, see Analytics and ACLScript 15.1 Help.

El Diseñador de encabezado de estudio analítico

El Diseñador de encabezado de estudio analítico tiene una interfaz intuitiva para agregar progresivamente las etiquetas del estudio analítico que conforman un encabezado de estudio analítico. Puede agregar, modificar o eliminar etiquetas libremente a medida que crea un encabezado de estudio analítico.

La comprobación automática de errores y la orientación integrada en el Diseñador ayudan a asegurar que el encabezado que crea sea válido y funcione correctamente.

Cuando hace clic en Guardar en el Diseñador, las etiquetas que ha configurado se traducen automáticamente en un encabezado de estudio analítico en la parte superior del script. Puede editar manualmente el encabezado de estudio analítico si lo desea, pero el enfoque recomendado es reabrir el Diseñador para realizar ediciones.

Encabezado del estudio analítico de muestra

El encabezado de estudio analítico que se muestra a continuación, para un script de estudio analítico que identifica cheques faltantes, se creó utilizando las etiquetas que se muestran en el Diseñador de encabezado de estudio analítico anterior. Para ahorrar espacio, la captura de pantalla del Diseñador se dimensiona para mostrar solo un subconjunto de las etiquetas del encabezado de estudio analítico.

COMMENT
//ANALYTIC TYPE ANALYSIS Identificar cheques faltantes
  Este script de estudio analítico identifica los números de cheques faltantes
//TABLE v_tabla_pagos Tabla Pagos
  Seleccione una tabla que enumere pagos e incluya una columna de número de cheque.
//FIELD v_núm_cheque CN Número de cheque
  Seleccione el campo que contiene los números de cheque
//PARAM v_fecha_de_inicio D OPTIONAL Fecha de inicio (opcional)
  Introduzca la fecha de inicio para el análisis
//PARAM v_fecha_de_finalización D OPTIONAL Fecha de finalización (opcional)
  Introduzca la fecha de finalización para el análisis
//PARAM v_región C MULTI SEPARATOR , QUALIFIER ' VALUES |Noreste|Sureste|Central|Oeste|Costa oeste|Regiones
  Introduzca una o más regiones a incluir en el análisis
//RESULT TABLE Cheques_faltantes
//RESULT FILE Cheques_faltantes.xls
//RESULT LOG
END

COMMENT El cuerpo del script comienza aquí.
SET SAFETY OFF
OPEN %v_tabla_pagos%
,
,
,
SET SAFETY ON

Cómo se ven las entradas del script en Robots

Las etiquetas de entrada en el encabezado de estudio analítico de muestra anterior crean parámetros de entrada que un usuario debe completar al programar o ejecutar el script de estudio analítico en Robots.

A continuación se muestra cómo se visualizan los parámetros de entrada en Robots.

Qué hace cada etiqueta

Cada etiqueta de estudio analítico en el encabezado de estudio analítico de muestra anterior realiza una tarea específica cuando un usuario programa o ejecuta el script de estudio analítico asociado en Robots.

Sintaxis del encabezado de estudio analítico	Descripción
COMMENT . . . END	Encierra el bloque de etiquetas de estudio analítico. Cada encabezado de estudio analítico debe estar encerrado por un comando COMMENT que comienza en la primera línea del script.
//ANALYTIC	Crea la configuración básica del encabezado de estudio analítico, incluido el tipo de script de estudio analítico y el nombre. Todo encabezado de estudio analítico debe comenzar con una etiqueta //ANALYTIC.
//TABLE v_tabla_pagos	Crea un parámetro de entrada que le permite a un usuario seleccionar una tabla de pagos. Como los nombres de las tablas varían, el nombre de la tabla seleccionada por el usuario se almacena en la variable v_tabla_pagos.
//FIELD v_núm_cheque	Crea un parámetro de entrada que le permite a un usuario seleccionar un campo de número de cheque de la tabla de pagos. Como los nombres de los campos varían, el nombre del campo seleccionado por el usuario se almacena en la variable v_núm_cheque.
//PARAM v_fecha_de_inicio	Crea un parámetro de entrada que le permite a un usuario especificar una fecha de inicio para el rango de registros que se están analizando. Como los usuarios especificarán diferentes fechas de inicio, la fecha real especificada por el usuario se almacena en la variable v_fecha_de_inicio.
//PARAM v_fecha_de_finalización	Crea un parámetro de entrada que permite al usuario especificar una fecha de finalización para el rango de registros que se están analizando. Como los usuarios especificarán diferentes fechas de finalización, la fecha real especificada por el usuario se almacena en la variable v_fecha_de_finalización.
//PARAM v_región	Crea un parámetro de entrada que le permite a un usuario especificar qué región o regiones se incluyen en el análisis. Como los usuarios especificarán diferentes regiones, las regiones reales especificadas por el usuario se almacenan en la variable v_región.
//RESULT TABLE Cheques_faltantes	Crea un parámetro de salida que especifica que la tabla de resultados Cheques_faltantes está disponible para los usuarios en Robots. Los resultados de salida de los scripts, aun cuando existen, no están disponibles de forma automática. La disponibilidad debe especificarse en el encabezado de estudio analítico.
//RESULT FILE Cheques_faltantes.xls	Crea un parámetro de salida que especifica que el archivo de resultados Cheques_faltantes.xls está disponible para los usuarios en Robots. Los resultados de salida de los scripts, aun cuando existen, no están disponibles de forma automática. La disponibilidad debe especificarse en el encabezado de estudio analítico.
//RESULT LOG	Especifica que se genera un archivo de log de salida para los scripts que se ejecutan correctamente. Se genera automáticamente un archivo de log si falla un script.

Crear un encabezado de estudio analítico

Para crear un encabezado de estudio analítico, debe saber de antemano qué entradas y salidas de script necesita. Si desea obtener más información, consulte Identificar las entradas y salidas del script.

Definir la configuración básica del encabezado de estudio analítico

Abra una script nuevo o existente en el Editor de scripts.
Haga clic en Editar el encabezado de estudio analítico .
Se abre el Diseñador de encabezado de estudio analítico.
Seleccione un Tipo de estudio analítico.
Los scripts de estudios analíticos se agrupan por tipo en Robots. El agrupamiento guía a los usuarios en la secuencia de scripts.
- IMPORT: un script que recupera datos de un origen de datos.
- PREPARE: un script que transforma datos sin procesar del modo que resulte necesario para que sean aptos para el análisis.
- ANALYSIS: un script que realiza análisis de datos.
Especifique un Nombre de estudio analítico.
Nota
Los nombres de los scripts de estudios analíticos en el mismo proyecto de Analytics deben ser únicos.
El nombre identifica el script de estudio analítico en Robots. El nombre del script de estudio analítico no es el mismo que el nombre del script que usted especifica en Analytics al crear inicialmente el script.
Elija si desea conservar un archivo de log para scripts que se completan correctamente:
- Activar Conservar el archivo de log se genera un archivo de log automáticamente cuando el script se ejecuta correctamente
- Desactivar Conservar el archivo de log no se genera un archivo de log cuando el script se ejecuta correctamente
Independientemente de la configuración de Conservar archivo de log, se genera automáticamente un archivo de log si el script falla.
Consejo
Si desea personalizar el nombre del archivo de log para scripts que se completan correctamente, utilice la etiqueta RESULT LOG.

Agregar etiquetas de estudios analíticos adicionales

Después de establecer la configuración básica del encabezado de estudio analítico, puede agregar tantas etiquetas de estudios analíticos adicionales como necesite.

Puede agregar etiquetas en cualquier orden.

En el Diseñador de encabezado de estudio analítico, haga clic en Agregar etiqueta.
Seleccione un Tipo de etiqueta.
Para configurar la etiqueta, complete todos los campos obligatorios en la sección de configuración de la etiqueta y todos los campos opcionales que necesite.
La guía para configurar etiquetas está integrada en la sección de configuración de cada etiqueta.
Si desea obtener información detallada acerca de la sintaxis del encabezado de estudio analítico y una lista completa de etiquetas de estudios analíticos, consulte Etiquetas y encabezados de estudios analíticos.
Repita el proceso para cada etiqueta adicional que necesite en el encabezado de estudio analítico.
Haga clic en Guardar cuando haya terminado.

Validar encabezados de estudios analíticos

Después de agregar un encabezado de estudio analítico a uno o más scripts, utilice las herramientas de Analytics para validar la sintaxis del encabezado a fin de asegurarse de que sea correcta. Realice la validación antes de confirmar y enviar los scripts a Robots de manera que los scripts de estudios analíticos no fallen durante la ejecución.

Una herramienta valida los encabezados de estudio analítico individuales a nivel del script. La otra herramienta valida todos los encabezados de estudio analítico del proyecto de manera simultánea. Los dos tipos de validaciones se centran en diferentes aspectos.

Validar un encabezado de estudio analítico individual

La validación de un encabezado de estudio analítico a nivel del script se centra en la sintaxis de las etiquetas de estudio analítico individuales e informa de los errores con los números de línea correspondientes.

Abra el script que contiene el encabezado del estudio analítico.
En la barra de herramientas del Editor de scripts, haga clic en Validar el encabezado del estudio analítico .
Aparece un mensaje que indica que el encabezado del estudio analítico es válido o que especifica un error y el número de línea donde ocurre el error.
Si el encabezado de estudio analítico contiene un error, corríjalo y haga clic en Validar el encabezado del estudio analítico nuevamente para asegurarse de que no existan más errores.
Consejo
Si la naturaleza del error no resulta obvia por el mensaje de error, revise el tema de Ayuda de la etiqueta de estudio analítico asociada. Compare cuidadosamente la sintaxis del tema con la sintaxis de la línea del encabezado del estudio analítico. Los errores se pueden deber a discrepancias mínimas en la sintaxis del encabezado del estudio analítico.

Validar todos los encabezados de estudio analítico de un proyecto

La validación de los encabezados de estudio analítico a nivel del proyecto comprueba dos cosas:

existe al menos un encabezado de estudio analítico en el proyecto
los nombres de los diferentes scripts de estudios analíticos son exclusivos
Nota
El nombre del script de estudio analítico es el nombre especificado en la etiqueta ANALYTIC, no el nombre del script que figura en la ficha Panorama del Navegador.

La validación a nivel del proyecto se realiza de forma automática al comprobar y enviar scripts a Robots. También puede realizar la validación manualmente si agrega el botón Comprobar scripts a la barra de herramientas de Analytics.

Si es necesario, agregue el botón Comprobar scripts a la barra de herramientas de Analytics:
1. Haga doble clic en un espacio vacío de la barra de herramientas para abrir el cuadro de diálogo Personalizar la barra de herramientas.
2. En la lista Botones disponibles de la barra de herramientas, seleccione el botón Comprobar scripts y haga clic en Agregar.
3. En la lista Botones de la barra de herramientas actual, seleccione el botón Comprobar scripts y haga clic en Mover hacia arriba o en Mover hacia abajo para cambiar la ubicación del botón.
  El orden de los botones de arriba hacia abajo corresponde a su ubicación de izquierda a derecha en la barra de herramientas.
4. Haga clic en Cerrar para guardar sus cambios.
En la barra de herramientas, haga clic en Comprobar scripts .
Aparece un mensaje que indica que los encabezados de estudio analítico del proyecto son válidos o que especifica uno o más errores.
Si los encabezados de estudio analítico contienen un error, corríjalo y haga clic en Comprobar scripts nuevamente para asegurarse de que no haya más errores.