Mejores prácticas para el desarrollo de estudios analíticos
Los scripts de estudios analíticos admiten la mayoría de los comandos que puede utilizar en un script común. Sin embargo, debe asegurarse de que los scripts de estudios analíticos se ejecuten sin interacción del usuario y no incluyan comandos no admitidos por el motor que procesa los scripts de estudios analíticos en la aplicación Robots de Diligent One.
Los scripts de estudios analíticos admiten todas las funciones de ACLScript.
Prácticas recomendadas generales
Utilizar un proyecto de Analytics por robot
Cree un nuevo proyecto de Analytics para cada robot. El proyecto debe contener todos los scripts de estudios analíticos que conforman el robot, así como todos los subscripts necesarios.
Probar de manera local
Pruebe todos los scripts de estudios analíticos localmente antes de implementarlos en la aplicación Robots. Asegúrese de que los scripts de estudios analíticos se ejecuten tal como se espera y que no sea necesaria la intervención del usuario.
Si desea obtener más información, consulte Desarrollo de scripts de estudios analíticos.
Utilizar conexiones de datos coherentes para las pruebas
Para probar un script de estudio analítico localmente si utiliza un origen de datos ODBC, debe configurar una conexión ODBC en su computadora local que sea idéntica a la conexión del entorno donde se ejecutará el script de estudio analítico.
Evitar rutas de archivos absolutas
Evite utilizar rutas de archivo absolutas en los scripts de estudios analíticos (por ejemplo: C:\resultados) a menos que esté seguro de que existen rutas de archivo idénticas en donde se ejecutará el script de estudio analítico.
El uso de rutas de archivo relativas (por ejemplo: \resultados) le permite desarrollar y probar scripts de estudios analíticos de manera local y después implementarlos en otro entorno sin necesidad de que ese entorno tenga una estructura de directorios idéntica.
Utilizar SET para los ajustes de las preferencias
Utilice el comando SET para especificar cualquier configuración de preferencias necesaria para el script de estudio analítico. Si no especifica preferencias en el script de estudio analítico, se utilizarán las preferencias predeterminadas de Analytics. Coloque el comando SET después del encabezado del estudio analítico, pero antes de cualquier lógica del script del estudio analítico.
No utilizar campos calculados en las tablas de salida de datos o resultados
No utilice campos calculados en las tablas de salida que tenga pensado conservar después de la sesión en la cual se ejecuta el script de estudio analítico.
Las tablas de datos o resultados que se conservan para ser utilizadas en interpretaciones o como valores de entrada para scripts posteriores pueden mostrar valores inesperados si contienen campos calculados. Los valores calculados dependen de la configuración que se define en el archivo de preferencias (.prf) o con el comando SET y, por lo tanto, los entornos diferentes pueden generar valores diferentes.
Si necesita conservar los valores de un campo calculado, use el comando EXTRACT con la opción FIELDS o la opción ALL para convertir el campo en un campo físico en la tabla de datos o resultados. Si desea obtener más información, consulte Comando EXTRACT.
Encriptar las contraseñas de conexión de datos
Para evitar tener una contraseña de origen de datos en texto sin formato en un script de estudio analítico, utilice la etiqueta de estudio analítico //PASSWORD. Esta etiqueta le pide una contraseña al usuario antes de ejecutar el script de estudio analítico y encripta el valor que se introduce.
Usar una contraseña al importar desde Diligent One o al exportar a Diligent One
El parámetro PASSWORD es obligatorio en cualquier comando que importa desde Diligent One o que exporta a Diligent One:Diligent One
- IMPORT GRCRESULTS
- IMPORT GRCPROJECT
- EXPORT... ACLGRC
- EXPORT... HBDATA
Sin el parámetro PASSWORD, el comando no se puede ejecutar correctamente en Robots.Robots
Al usar el parámetro PASSWORD en un comando, también debe especificar una etiqueta //PASSWORD asociada en el encabezado del estudio analítico. Si desea obtener más información, consulte Etiqueta PASSWORD.
Nota
El parámetro PASSWORD no es obligatorio al ejecutar los comandos de importación y exportación en Analytics, porque se utiliza automáticamente el token de acceso de Diligent One, almacenado localmente en el registro de Windows, del usuario actual.AnalyticsHighBond access token
Evitar la intervención del usuario
Los scripts de estudios analíticos deben poder ejecutarse sin intervención del usuario. Si un comando de un script de estudio analítico intenta crear un cuadro de diálogo, el motor del entorno de implementación detiene el procesamiento del script de estudio analítico y se introduce un error en el log.
Reemplazar los comandos que requieran la intervención del usuario por etiquetas de estudio analítico
No usar comandos de Analytics que requieran la intervención del usuario Reemplácelos por etiquetas de estudio analítico equivalentes en el encabezado del estudio analítico. Las etiquetas de estudio analítico les permiten a los usuarios proporcionar valores de entrada antes de ejecutar el script de estudio analítico.
| No utilizar | Reemplazar por |
|---|---|
| DIALOG | //PARAM, //TABLE, //FIELD |
| ACCEPT | //PARAM, //TABLE, //FIELD |
| PASSWORD | //PASSWORD |
| PAUSE | no hay equivalente |
Pautas
- Comandos interactivos Para evitar errores de procesamiento del script de estudio analítico, quite todos los comandos interactivos
- SET SAFETY Para asegurarse de que sea posible sobrescribir los archivos, según sea necesario, sin mostrar un cuadro de diálogo de confirmación, agregue el comando SET SAFETY OFF al principio de un script de estudio analítico.
Agregue el comando SET SAFETY ON al final del script de estudio analítico para restablecer el comportamiento predeterminado.
- Parámetro OK Para evitar que los diálogos de confirmación detengan el script de estudio analítico, agregue el parámetro OK después de los comandos que normalmente muestran un cuadro de diálogo de confirmación:
- RENOMBRAR
- ELIMINAR
Comprobación de la sintaxis del script
Analytics ofrece una herramienta para detectar problemas de sintaxis del script que hacen que los scripts de estudios analíticos no se puedan completar o que necesitan una coincidencia exacta entre el entorno local y el entorno donde se implementan los estudios analíticos. La herramienta ofrece solo una advertencia y usted tiene la posibilidad de confirmar y enviar o importar los scripts de estudios analíticos que tienen advertencias.
Qué comprueba la herramienta
La herramienta comprueba todos los scripts del proyecto en busca de los siguientes elementos:
- comandos que requieren la intervención del usuario
- todas las rutas de archivo absolutas
- las invocaciones a un script externo
Cuándo se realiza la comprobación
La comprobación de la sintaxis del script se realiza de manera automática al confirmar y enviar scripts a Robots.
La comprobación de la sintaxis automática está activada por valor predeterminado. Si desea desactivarla, seleccione Desactivar la comprobación de la sintaxis del script antes de confirmar y enviar scripts en el cuadro de diálogo Opciones (Herramientas > Opciones > Interfaz).
Realizar la comprobación manualmente
Puede comprobar la sintaxis del script manualmente. Es posible que primero deba agregar el botón Comprobar scripts
a la barra de herramientas de Analytics.
- Si es necesario, agregue el botón Comprobar scriptsa la barra de herramientas de Analytics:
- 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.
- En la lista Botones disponibles de la barra de herramientas, seleccione el botón Comprobar scripts y haga clic en Agregar.
- 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.
Haga clic en Cerrar para guardar sus cambios.
- En la barra de herramientas, haga clic en Comprobar scripts
.Aparece un mensaje que indica que la sintaxis del script del proyecto es válida o que especifica una o más advertencias.
- Realice una de las siguientes acciones:
- Corrija la sintaxis de todos los scripts que generen una advertencia y haga clic en Comprobar scripts
nuevamente para asegurarse de que ya no aparezcan advertencias. - Asegúrese de que el entorno de implementación contenga una estructura de directorios o scripts externos que coincida con las rutas o los scripts externos que se especifican en el script de estudio analítico.
- Corrija la sintaxis de todos los scripts que generen una advertencia y haga clic en Comprobar scripts