- Información general
- CLI de Uipath
- Acerca de la CLI de UiPath
- Descarga de la CLI de UiPath
- Matriz de compatibilidad
- Ejecutar la CLI de UiPath
- Gestionar fuentes NuGet
- Acerca de las tareas de la CLI de UiPath
- Empaquetar proyectos en un paquete
- Analizar un proyecto
- Implementar un paquete en Orchestrator
- Ejecutar un trabajo dentro de Orchestrator
- Probar un paquete o ejecutar un conjunto de pruebas
- Probar un paquete o ejecutar un conjunto de pruebas en Test Manager
- Probar varios paquetes
- Parámetros de entrada Formato JSON
- Implementar activos en Orchestrator
- Eliminar activos de Orchestrator
- Ejecutar tareas utilizando la configuración JSON
- Restaurar dependencias de automatización
- Solución de problemas de la CLI de UiPath
- Extensión de Azure DevOps
- Complemento de Jenkins
Guía del usuario de integraciones de CI/CD
Prerequisites:
- Crear un proyecto.
- Ejecuta el archivo CLI
exe(para Windows) odll(para Linux). - Añade los ámbitos de aplicación de acceso a la API de Orchestrator necesarios.
Para analizar un proyecto, sigue los siguientes pasos:
- Ejecuta la tarea
package, utilizandouipcli package. Puedes ver una lista de las subtareas disponibles. - Especifica los parámetros necesarios y ejecuta la subtarea
analyze. La siguiente tabla describe los parámetros necesarios.
La validación del proyecto no se realiza de forma predeterminada. Para habilitar la validación estructural XAML, utiliza el marcador --validate .
Leyenda: (*): opcional, recomendado cuando se utilizan fuentes de paquetes adicionales.
| Parámetro | Descripción |
|---|---|
|
| Elija qué tipos de mensajes generar después de analizar:
|
|
| El trabajo falla cuando se incumple cualquier regla. |
|
| Habilita la validación estructural XAML (por ejemplo, faltan los argumentos de actividad necesarios). La validación está desactivada de forma predeterminada. Cuando se habilita, los errores de validación provocan un código de salida distinto de cero. |
|
| Tratar las advertencias como errores. |
|
| La ruta completa a un archivo JSON donde desea almacenar los resultados. Si no agrega esto como argumento, los resultados se imprimirán solo en la consola estándar. |
|
| Pasar políticas de control que contengan las reglas del Analizador de flujo de trabajo. Las políticas pueden descargarse o extraerse del archivo zip comprimido exportado desde Studio . La tarea falla si especifica utilizar una política pero el archivo de política no está en la ruta mencionada. |
|
| Una lista de reglas que desea ignorar durante el análisis, separadas por comas. |
-u , --orchestratorUsername (*) (necesario cuando utilizas la Autenticación básica, a través de un nombre de usuario y una contraseña) | El nombre de usuario utilizado para autenticarse en Orchestrator. Debe emparejarlo con la contraseña correspondiente. |
-p , --orchestratorPassword (*) (necesario cuando utilizas la Autenticación básica, a través de un nombre de usuario y una contraseña) | La contraseña utilizada para autenticarse en Orchestrator. Debes emparejarlo con el nombre de usuario correspondiente. |
-t , -orchestratorAuthToken (*) (Necesario si utilizas la autenticación basada en token) | El token de actualización OAuth2 utilizado para autenticarse en Orchestrator. Debes emparejarlo con el Nombre de cuenta y el ID de cliente . |
-a , --orchestratorAccountName (*) (Necesario si utilizas la autenticación basada en token) | El nombre de la cuenta de Orchestrator CloudRPA. Debes emparejarlo con el token de actualización OAuth2 y el ID de cliente . |
-A , --orchestratorAccountForApp (*) | El nombre de la cuenta de Orchestrator CloudRPA (nombre de la organización). Debes emparejarlo con el ID de la aplicación, el Secreto de la aplicación y el Ámbito de la aplicación para aplicaciones externas. |
-I , --orchestratorApplicationId (*) ( Obligatorio si utilizas la autenticación de aplicación externa ) | El ID de aplicación externo. Debes emparejarlo con la **Cuenta de la aplicación, el Secreto de la aplicación y el Ámbito de la aplicación. |
-S , --orchestratorApplicationSecret (*) ( Obligatorio si utilizas la autenticación de aplicación externa ) | El Secreto de la aplicación externo. Debes emparejarlo con la Cuenta de la aplicación, ID de la aplicación y Ámbito de la aplicación. |
--orchestratorApplicationScope (*) ( Obligatorio si utilizas la autenticación de aplicación externa ) | La lista de ámbitos de aplicación, separados por espacios individuales. Debes emparejarlo con la Cuenta de la aplicación, ID de la aplicación y el Secreto de la aplicación para aplicaciones externas. |
--orchestratorFolder (*) | El nombre de la carpeta de Orchestrator de destino. AccountingTeam\TeamJohnusa . |
--orchestratorUrl (*) | La URL de la instancia de Orchestrator. |
--orchestratorTenant (*) | El tenant de la instancia de Orchestrator donde desea eliminar la máquina. |
-l , --language | El lenguaje de Orchestrator. |
|
| Mostrar el seguimiento de los eventos. |
--identityUrl ( Obligatorio para las implementaciones de PaaS o MSI | La URL de su servidor de identidad. |
|
| Deshabilitar las fuentes nuget integradas. |
Project(s) Path (pos.0) ( Obligatorio ) | La ruta del archivo project.json o la ruta de la carpeta que contiene varios archivos project.json . |
Códigos de salida
El código de salida del comando analyze depende de los marcadores que utilices:
| Banderas | Código de salida 0 (correcto) | Código de salida distinto de cero (fallo) |
|---|---|---|
| Sin marcas | Siempre | Nunca |
--stopOnRuleViolation | Sin infracciones de reglas | Infracciones de la regla detectadas |
--validate | Sin errores de validación | Errores de validación detectados |
--validate --stopOnRuleViolation | Sin infracciones de reglas ni errores de validación | Infracciones de reglas o errores de validación detectados |
Uso:
uipcli package analyze <project_path> [--analyzerTraceLevel <analyzer_trace_level>] [--stopOnRuleViolation] [--validate] [--treatWarningsAsErrors] [--resultPath <result_path>] [--governanceFilePath <governance_file_path>] [--ignoredRules <rule_id_1,rule_id_2>] [--orchestratorUrl <orchestrator_url> --orchestratorTenant <orchestrator_tenant>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --orchestratorApplicationScope <application_scope>] [--orchestratorFolder <folder_name>] [-l <language>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>] [--disableBuiltInNugetFeeds]
uipcli package analyze <project_path> [--analyzerTraceLevel <analyzer_trace_level>] [--stopOnRuleViolation] [--validate] [--treatWarningsAsErrors] [--resultPath <result_path>] [--governanceFilePath <governance_file_path>] [--ignoredRules <rule_id_1,rule_id_2>] [--orchestratorUrl <orchestrator_url> --orchestratorTenant <orchestrator_tenant>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --orchestratorApplicationScope <application_scope>] [--orchestratorFolder <folder_name>] [-l <language>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>] [--disableBuiltInNugetFeeds]
Ejemplos de comandos mínimos:
uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json"uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --orchestratorTenant "TenantName" -u "orchestratorUsername" -p "********" --orchestratorFolder "FolderName"uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --orchestratorTenant "TenantName" -A "organizationName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S "********" --orchestratorApplicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --orchestratorFolder "FolderName" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity"uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://automation-suite.base.url.com/" --orchestratorTenant "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --orchestratorApplicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --orchestratorFolder "FolderName"uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://cloud.uipath.com/" --orchestratorTenant "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --orchestratorApplicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --orchestratorFolder "FolderName"