Acerca del analizador de flujo de trabajo

El Analizador de flujo de trabajo es un analizador de códigos estático que garantiza que tu proyecto cumple estrictas normas de calidad y fiabilidad. Un analizador de códigos estático comprueba las incoherencias sin ejecutar el proyecto, a diferencia de los analizadores dinámicos, que intervienen durante la ejecución.

El Analizador de flujo de trabajo usa un conjunto de reglas para comprobar si existen inconsistencias no relacionadas con la ejecución del proyecto. Las reglas se basan en las prácticas recomendadas de automatización y tienen en cuenta la denominación de variables y argumentos, las secuencias o flujos de trabajo vacíos, las restricciones de los paquetes, etc. El analizador no identifica errores de ejecución o compilación.

Está disponible en la pestaña de cinta Diseño, en los botones Analizar archivo y Analizar proyecto. El primero realiza un análisis del archivo centrado en el panel Diseñador, mientras que el segundo analiza todos los archivos del proyecto de automatización.

Studio viene con un conjunto de reglas integrado, identificables por el prefijo ST- . UIAutomation.Activities, Excel.Activities, Testing Activitiesy Mail.Activities también tienen sus propias reglas, identificables por el prefijo.

También puede crear reglas personalizadas. Para obtener más información, consulta Crear reglas de analizador de flujo de trabajo en la guía para desarrolladores.

Nota: Las reglas integradas de Studio no pueden portarse a versiones de Studio más antiguas. Sin embargo, las reglas de paquetes de actividades compatibles se pueden usar en versiones de Studio más antiguas que incorporan el Analizador de flujo de trabajo.

Convención de denominación de reglas

Cada regla tiene un ID, un nombre, una descripción y una recomendación. La ID contiene el origen, la categoría y el número. Por ejemplo, la convención de denominación de variables tiene el ID ST-NMG-001 :

• ST: revela que la regla está integrada en Studio.
• NMG : muestra que la regla forma parte de la categoría Reglas de nomenclatura . La parte de las reglas de la categoría de anatomía del proyecto tiene la abreviatura ANA , la parte de las prácticas recomendadas de diseño la DBP, y así sucesivamente.
• 001: es el número de la regla.
  
  

  

  
  

Ámbito

Cada regla tiene un ámbito de aplicación:

• Actividad: las reglas se aplican a nivel de actividad, comprobando variables, argumentos y propiedades. La convención de denominación de variables es una de esas reglas.
• Flujo de trabajo: las reglas realizan comprobaciones en un único archivo de proyecto, por ejemplo, Variables no utilizadas.
• Proyecto: se realizan comprobaciones a escala de proyecto.

Acción

Las reglas tienen una serie de acciones que se pueden establecer:

• Error: genera un error en el panel Lista de errores.
• Advertencia: genera una advertencia en el panel Lista de errores.
• Información: genera un mensaje en el panel Lista de errores.
• Detallado: crea archivos de registro grandes.

Consulta la página Niveles de registro para obtener más información sobre el registro con Studio.

Administrar reglas

El proyecto o el archivo se analizan sobre la base de un conjunto de reglas disponibles en la ventana Configuración del proyecto:

• En el panel Proyecto, haz clic en el icono y, a continuación, selecciona Analizador de flujo de trabajo.
• En la cinta, haz clic en el botón Analizar archivo, a continuación, selecciona Configuración del Analizador de flujo de trabajo del menú desplegable.

Las reglas se pueden filtrar por ámbito y acción. Desmarca la casilla situada junto a cada regla para definir una configuración específica para tu proyecto. De forma predeterminada, las reglas están ordenadas por código en la ventana, y las reglas habilitadas se muestran primero.

Restablecer al valor predeterminado

Después de realizar los cambios en los valores predeterminados de las reglas, ya sean valores Regex o de umbrales, los valores pueden volver al estado predeterminado haciendo clic derecho en la regla y seleccionando Restablecer valores predeterminados.

Validación

La validación del archivo o proyecto se realiza cada vez que se lanza el Analizador de flujo de trabajo. Las opciones de validación están disponibles en el botón de cinta Analizar archivo, Validar archivo y Validar proyecto.

Esta acción comprueba si las variables, los argumentos, las expresiones y las importaciones están bien configurados. La acción Validar archivo se puede lanzar utilizando el atajo F8, mientras que para la acción Validar proyecto se utiliza el atajo Mayús + F8. La validación se puede cancelar en cualquier momento.

Los archivos que contienen errores se marcan en el panel Proyecto con un punto rojo, y los errores se muestran en los paneles Lista de errores y Salida.

Al hacer doble clic en un elemento del panel Lista de errores, se abre el .xaml y se destacan los elementos que lanzaron el error, ya sea una actividad, un argumento o una variable.

El proyecto solo se podrá depurar, ejecutar o publicar si todos los archivos .xaml están validados. No se evalúan las condiciones de punto de interrupción.

Administrar errores

Al lanzarlo, el Analizador de flujo de trabajo utiliza el conjunto de reglas configurado para comprobar el proyecto o el archivo, y registra los errores hallados en el panel Lista de errores, de acuerdo con la acción de la regla.

El panel Lista de errores filtra elementos por Errores, Advertencias y Mensajes. El menú desplegable del ámbito resulta útil para filtrar errores por proyecto, archivo actual o un archivo específico en la automatización. Además, los elementos se pueden filtrar por identificador de la regla.

Haz clic en una advertencia o error hallado para mostrar la recomendación de las reglas y un enlace a la página de documentación para cada regla.

Además de las violaciones de las reglas, en el panel Lista de errores se muestran también los errores que se pueden producir en la ejecución del análisis del flujo de trabajo. Cuando el Analizador de flujo de trabajo o una de las reglas configuradas no se ejecuta, se registra un error con detalles sobre la causa del mismo en la descripción.

Soporte en línea de comandos

La interfaz de usuario de línea de comandos UiPath.Studio.CommandLine.exe contiene un conjunto de parámetros para comprobar los archivos o proyectos en función de determinadas reglas, incluso en configuraciones de procesos CI/CD.

UiPath.Studio.CommandLine.exe está disponible en la carpeta de instalación:

• Para las instalaciones por máquina, la ruta predeterminada es %ProgramFiles%\UiPath\Studio\.
• Para las instalaciones por usuario, la ruta predeterminada es %LocalAppData%\Programs\UiPath\Studio.

Configurar reglas

De forma predeterminada, todas las reglas del Analizador del flujo de trabajo están habilitadas al instalar Studio, a excepción de las siguientes:

• Valores predeterminados del argumento
• Propiedades de salida no definidas

Puedes configurar las reglas:

• En la ventana Configuración del analizador de flujo de trabajo, habilita o deshabilita reglas haciendo clic en la casilla de verificación situada junto a cada una de ellas.
• Desde el archivo RuleConfig.json, ruta %LocalAppData%\UiPath\Rules. Busca una regla específica, modifica sus parámetros, cambia el parámetro IsEnabled a false para deshabilitar la regla. Si la ruta no es accesible, puedes colocar el archivo RuleConfig.json en una ubicación personalizada e incluir la ruta al archivo en el comando. Para obtener más información, consulta Analizar archivos y proyectos.

Las reglas se organizan de acuerdo a su identificador único, visible también en la ventana Configuración del Analizador de flujo de trabajo.

Por ejemplo, en la imagen siguiente solo se habilitó la regla Convención de denominación de variables y se recibió la expresión Regex ([A-Z]) . Esto significa que los nombres de variables deben estar en mayúsculas. Todas las demás reglas se deshabilitaron en este ejemplo.

Analizar archivos y proyectos

Después de configurar las reglas, accede a la interfaz de usuario de línea de comandos UiPath.Studio.CommandLine.exe.

Están disponibles los siguientes comandos del Analizador de flujo de trabajo:

• analyze: analiza todo el proyecto. Requiere la ruta al archivo project.json.
• analyze-file: analiza un único archivo. Requiere la ruta al archivo .xaml.

Están disponibles los siguientes argumentos para los comandos del Analizador de flujo de trabajo:

Argumento	Descripción
-p, --project-path	Para analizar un archivo, proporciona la ruta al archivo .xaml. Para analizar el proyecto completo, especifica la ruta al archivo project.json.
-c, --config-path	La ruta del archivo RuleConfig.json. Especifica esta ruta solo si el archivo de configuración de la regla no se encuentra en la ubicación predeterminada (%LocalAppData%\UiPath\Rules).
--help	Ver los argumentos disponibles para cada comando.
--version	Comprobar la versión de UiPath.Studio.CommandLine.exe.

Por ejemplo, el comando UiPath.Studio.CommandLine.exe analyze-file -p "C:\BlankProcess\Main.xaml" solo analiza un archivo de un proyecto, Main.xaml. La salida del comando devuelve un diccionario codificado en JSON con la siguiente información para cada violación de una regla:

• FilePath: la ruta al archivo analizado.
• ErrorCode: el identificador de la regla.
• ActivityDisplayName: el nombre para mostrar de la actividad (null si no se aplica).
• Item: el nombre y el tipo del elemento (por ejemplo, actividad o variable) en el que se generó el mensaje de error.
• ErrorSeverity: el valor del parámetro DefaultAction, que es el mensaje de registro configurado para cada regla, ya sea Advertencia, Error, Información o Detallado.
• Description: la descripción de la regla.
• Recommendation y URL: los cambios recomendados para resolver el problema, junto con el enlace a la documentación en la que se recoge más información.
  
  

  

  
  

Para utilizar un archivo RuleConfig.json colocado en una ubicación personalizada, añade la ubicación al comando. Si utilizamos el comando anterior como ejemplo, para configurar las reglas con el archivo ubicado en C:\CustomFolder\RuleConfig.json, ejecuta el comando de la siguiente manera: UiPath.Studio.CommandLine.exe analyze-file -c "C:\CustomFolder\RuleConfig.json" -p "C:\BlankProcess\Main.xaml".

Para devolver al código de salida del comando, ejecuta echo %errorlevel% después de ejecutarlo. Si no hay mensajes con el error ErrorSeverity, se devuelve el código 0. De lo contrario, se devuelve 1.

Ten en cuenta que algunas de las entradas pueden no estar asociadas con una regla, sino que pueden ser errores generados por el Analizador de flujo de trabajo. Por ejemplo, si se detecta un archivo .xaml vacío, se muestra un error.

Los identificadores únicos globales (GUID) utilizados como prefijos para una entrada se generan en cada ejecución y se aplican solamente al resultado actual.

Exportar resultados del analizador de flujo de trabajo

Para configurar Studio para exportar los resultados de cada análisis de flujo de trabajo a la carpeta del proyecto, ve a Vista Backstage de Studio > Configuración > Diseño y habilita la opción Exportar resultados del analizador.

Cuando esta opción está habilitada, los resultados de cada análisis de flujo de trabajo se guardan en la subcarpeta \.local\.analysis\ de la carpeta del proyecto en un archivo con nombre y con la marca de tiempo del análisis seguido de project_analysis_results.json (cuando se utiliza la opción Analizar proyecto) o de file_analysis_results.json (cuando se utiliza la opción Analizar archivo).

Nota: La carpeta .local está oculta. Puedes habilitar la visualización de elementos ocultos desde la configuración del explorador de archivos de Windows.

Los archivos contienen la siguiente información sobre cada regla habilitada:

• RuleId: el identificador de la regla.
• RuleName: el nombre de la regla.
• Parameters: los parámetros personalizables de la regla, en su caso.
• Severity: la acción de la regla, si se incumple la regla.
• ErrorsDescription: una lista de mensajes de error generada por la regla, en su caso.

Aplicar el Analizador de flujo de trabajo antes de ejecutar o publicar

Puedes impedir la ejecución o la publicación de proyectos que contienen errores del Analizador del flujo de trabajo habilitando las siguientes opciones desde la vista Backstage de Studio > Configuración > Diseño:

• Aplicar Analizador antes de ejecutar: cada vez que se inicia la ejecución/depuración de un archivo o proyecto, el Analizador de flujo de trabajo comprueba todas las reglas con la acción Error y la ejecución solo se permite si no se detecta ningún error.
• Aplicar Analizador antes de publicar: cada vez que se inicia el proceso de publicación, el Analizador comprueba todas las reglas habilitadas, con independencia de su acción, y la publicación solo se permite si no se viola ninguna regla con la acción Error.

Cuando se habilita la opción Aplicar Analizador antes de publicar, si se realiza la publicación (no se viola ninguna regla con la acción Error), los resultados del análisis del flujo de trabajo se incluyen en el paquete .nupkg publicado en el archivo project_analysis_results.json ubicado en \lib\net45\.analysis\. El archivo contiene la siguiente información sobre cada regla habilitada:

• RuleId: el identificador de la regla.
• RuleName: el nombre de la regla.
• Parameters: los parámetros personalizables de la regla, en su caso.
• Severity: la acción de la regla (si se incumple la regla).
• ErrorsDescription: una lista de mensajes de error generada por la regla, en su caso.