UiPath Documentation
uipath-cli
latest
false
Guía del usuario de UiPath CLI
Importante :
Este contenido se ha traducido mediante traducción automática. La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.

UIP p. m.

Comandos para gestionar aplicaciones de proceso de Process Mining, ingestión de datos, transformaciones y análisis utilizando la herramienta `uip pm`.

uip pm es la herramienta Process Mining: crea y gestiona aplicaciones de proceso (modelos de proceso extraídos creados a partir de datos de registro de eventos), carga e ingiere datos de origen, ejecuta transformaciones dbt y analiza el resultado (conformidad con un modelo de referencia, desviaciones aceptadas , consultas ad hoc). pm es el prefijo del comando; el paquete subyacente es @uipath/pm-tool.

Una aplicación de proceso se mueve a través de una etapa dev (donde creas su estructura) y una etapa published (lo que ven los paneles/consumidores): la mayoría de los verbos toman --stage dev|published (predeterminado dev). Cada comando requiere uip login primero.

Este recurso abarca cuatro páginas​

  • Esta página : conceptos, apps (crear/enumerar/obtener/eliminar/publicar), app-types, files, simulations.
  • apps model : la superficie de edición del modelo estructural/semántico protegido por ETag: apps data-model, apps model (get/update/fields/dashboards/metrics).
  • ingestions y transformations : desencadenar e inspeccionar cargas de datos y compilaciones de dbt.
  • conformance, deviations y query : analiza una aplicación minada: tasa de conformidad, desviaciones aceptadas, consultas de datos ad hoc.

Conceptos​

  • Escrituras protegidas por ETag. Cada escritura en el modelo de datos de una aplicación, modelo semántico o un archivo de transformación requiere un --etag de un get anterior (o es en sí mismo una lectura-modificación-escritura que recupera su propia base). Una ETag obsoleta falla con un conflicto; la solución es volver a leer, rehacer la edición y volver a intentarlo: nunca vuelvas a recuperar una ETag nueva solo para forzar la escritura, ya que eso elimina silenciosamente cualquier cambio en el medio.
  • Desarrollador frente a publicado. Las ediciones, la ingestión y las transformaciones estructurales/semánticas solo se aplican a dev. apps publish envía el modelo actual del desarrollador a la capa publicada/del panel; apps changes muestra una vista previa de lo que se movería.
  • --wait sondeo. ingestions create y transformations apply/run aceptan --wait (--timeout, 1800predeterminados; --poll-interval, 5predeterminados) para bloquear hasta que la ejecución alcance un estado terminal, imprimiendo el dbt real /loader en caso de fallo en lugar de simplemente salir.

Sinopsis​

uip pm apps list [--stage dev|published]
uip pm apps get <app-id> [--stage dev|published]
uip pm apps create <name> --type <app-type-key> [--type-version <v>] [--miner directly-follows|inductive|bpmn] [--description <text>] [--data-mapping <json-file>]
uip pm apps delete <app-id> -y
uip pm apps publish <app-id>
uip pm apps changes <app-id>
uip pm apps publications <app-id> [--limit <n>] [--since-version <v>]
uip pm app-types list
uip pm app-types get <app-type-key> <app-type-version>
uip pm files upload <app-id> <file-path> [--stage dev|published] [--input-table <name>]
uip pm simulations list <app-id> [--stage dev|published]
uip pm apps list [--stage dev|published]
uip pm apps get <app-id> [--stage dev|published]
uip pm apps create <name> --type <app-type-key> [--type-version <v>] [--miner directly-follows|inductive|bpmn] [--description <text>] [--data-mapping <json-file>]
uip pm apps delete <app-id> -y
uip pm apps publish <app-id>
uip pm apps changes <app-id>
uip pm apps publications <app-id> [--limit <n>] [--since-version <v>]
uip pm app-types list
uip pm app-types get <app-type-key> <app-type-version>
uip pm files upload <app-id> <file-path> [--stage dev|published] [--input-table <name>]
uip pm simulations list <app-id> [--stage dev|published]

lista de aplicaciones uip pm​

Enumerar aplicaciones de proceso.

Opciones​

LargoValorPredeterminadoDescripción
--stage <stage>dev | publisheddevEtapa de la aplicación a la lista.

Ejemplo​

uip pm apps list
uip pm apps list

Forma de datos (--json de salida)​

{ "Code": "PmAppsList", "Data": [{ "Id": "9c46289e", "Name": "Sample dataset" }] }
{ "Code": "PmAppsList", "Data": [{ "Id": "9c46289e", "Name": "Sample dataset" }] }

uip pm apps get​

Obtener una aplicación de proceso: su estado, última ingestión y estado de compilación.

Argumentos​

NombreObligatorioPropósito
<app-id>SíID de la aplicación de proceso.

Opciones​

LargoValorPredeterminadoDescripción
--stage <stage>dev | publisheddevEtapa de la aplicación para leer.

Ejemplo​

uip pm apps get 9c46289e
uip pm apps get 9c46289e

Forma de datos (--json de salida)​

{
  "Code": "PmAppsGet",
  "Data": {
    "Id": "9c46289e",
    "Name": "Sample dataset",
    "AppStatus": "CREATED",
    "LastIngestion": { "Id": "1d7e1421", "Status": "SUCCESS" }
  }
}
{
  "Code": "PmAppsGet",
  "Data": {
    "Id": "9c46289e",
    "Name": "Sample dataset",
    "AppStatus": "CREATED",
    "LastIngestion": { "Id": "1d7e1421", "Status": "SUCCESS" }
  }
}

uip pm apps create​

Crea una aplicación de proceso a partir de una plantilla de aplicación (ver app-types list).

Argumentos​

NombreObligatorioPropósito
<name>SíNombre de la aplicación.

Opciones​

LargoValorObligatorioDescripción
--type <app-type-key>StringSíClave de plantilla de aplicación, por ejemplo uipath.custom.
--type-version <version>StringNoVersión de la plantilla. El valor predeterminado es el último disponible.
--miner <miner>directly-follows | inductive | bpmnNoMinero de procesos. Predeterminado directly-follows. Solo inductive/bpmn producen un modelo de referencia, que conformance/deviations necesitan.
--description <text>StringNoDescripción de la aplicación.
--data-mapping <json-file>RutaNoArchivo JSON con la asignación de datos de entrada (tablas/campos). Los IsNotNull/IsUnique/DataTypeSettings faltantes por campo se establecen automáticamente de forma predeterminada.

Ejemplo​

uip pm apps create "Sample dataset" --type uipath.custom --data-mapping ./mapping.json
uip pm apps create "Sample dataset" --type uipath.custom --data-mapping ./mapping.json

Forma de datos (--json de salida)​

{
  "Code": "PmAppsCreate",
  "Data": { "AppId": "9c46289e-e2e3-4da4-a2ea-95c98f719ff7", "Name": "Sample dataset", "Type": "uipath.custom" }
}
{
  "Code": "PmAppsCreate",
  "Data": { "AppId": "9c46289e-e2e3-4da4-a2ea-95c98f719ff7", "Name": "Sample dataset", "Type": "uipath.custom" }
}

eliminación de aplicaciones uip pm​

Eliminar una aplicación de proceso.

Argumentos​

NombreObligatorioPropósito
<app-id>SíID de la aplicación de proceso.

Opciones​

LargoValorDescripción
-y, --yesMarcaConfirme esta operación irreversible. Obligatorio: la CLI nunca solicita.

Ejemplo​

uip pm apps delete 9c46289e --yes
uip pm apps delete 9c46289e --yes

Forma de datos (--json de salida)​

{ "Code": "PmAppsDelete", "Data": { "AppId": "9c46289e", "Status": "Deleted" } }
{ "Code": "PmAppsDelete", "Data": { "AppId": "9c46289e", "Status": "Deleted" } }

publicación de aplicaciones uip pm​

Publicar cambios de desarrollo en los paneles/capa de consulta.

Argumentos​

NombreObligatorioPropósito
<app-id>SíID de la aplicación de proceso.

Ejemplo​

uip pm apps publish 9c46289e
uip pm apps publish 9c46289e

Forma de datos (--json de salida)​

{ "Code": "PmAppsPublish", "Data": { "AppId": "9c46289e", "Changes": {}, "IngestionNeeded": true, "Hint": "Published changes need data — run 'uip pm ingestions create <app> --wait' to load them into the dashboards." } }
{ "Code": "PmAppsPublish", "Data": { "AppId": "9c46289e", "Changes": {}, "IngestionNeeded": true, "Hint": "Published changes need data — run 'uip pm ingestions create <app> --wait' to load them into the dashboards." } }

Hint está presente solo cuando IngestionNeeded es true.

cambios en las aplicaciones uip pm​

Muestra qué partes de desarrollo aún no se han publicado (paneles, transformaciones, BPMN).

Argumentos​

NombreObligatorioPropósito
<app-id>SíID de la aplicación de proceso.

Ejemplo​

uip pm apps changes 9c46289e
uip pm apps changes 9c46289e

Forma de datos (--json de salida)​

{ "Code": "PmAppsChanges", "Data": { "AppId": "9c46289e", "ModelVersion": 3, "Changes": {}, "IngestionNeeded": false } }
{ "Code": "PmAppsChanges", "Data": { "AppId": "9c46289e", "ModelVersion": 3, "Changes": {}, "IngestionNeeded": false } }

Publicaciones de uip pm apps​

Enumerar el historial de publicación de una aplicación de proceso.

Argumentos​

NombreObligatorioPropósito
<app-id>SíID de la aplicación de proceso.

Opciones​

LargoValorDescripción
--limit <number>EnteroMáximo de publicaciones para devolver.
--since-version <model-version>EnteroDevolver solo las publicaciones más recientes que esta versión del modelo.

Forma de datos (--json de salida)​

{ "Code": "PmAppsPublications", "Data": [] }
{ "Code": "PmAppsPublications", "Data": [] }

Tipos de aplicación de uip pm​

Descubre las plantillas de aplicación de proceso. Sin ámbito de etapa: las plantillas son globales para tenant.

lista de tipos de aplicaciones de uip pm​

Enumera las plantillas de aplicación disponibles en su versión más reciente.

uip pm app-types list
uip pm app-types list
{ "Code": "PmAppTypesList", "Data": [{ "AppTypeKey": "uipath.custom", "Version": "2604.192.1-ci.5" }] }
{ "Code": "PmAppTypesList", "Data": [{ "AppTypeKey": "uipath.custom", "Version": "2604.192.1-ci.5" }] }

uip pm tipos-aplicación get​

Obtenga el modelo de aplicación completo de una versión de plantilla.

NombreObligatorioPropósito
<app-type-key>SíClave de plantilla de aplicación.
<app-type-version>SíVersión de la plantilla.
uip pm app-types get uipath.custom 2604.192.1-ci.5
uip pm app-types get uipath.custom 2604.192.1-ci.5
{ "Code": "PmAppTypesGet", "Data": {} }
{ "Code": "PmAppTypesGet", "Data": {} }

Carga de archivos uip pm​

Carga un archivo de datos a una aplicación de proceso a través de la carga de blob fragmentado (5 MB partes, 4 simultáneas).

Argumentos​

NombreObligatorioPropósito
<app-id>SíID de la aplicación de proceso.
<file-path>SíRuta local al archivo de datos.

Opciones​

LargoValorPredeterminadoDescripción
--stage <stage>dev | publisheddevEtapa de la aplicación a la que cargar.
--input-table <name>String—Tabla de entrada de destino a la que pertenece el archivo (por ejemplo Event_log).

Ejemplo​

uip pm files upload 9c46289e ./Event_log.csv --input-table Event_log
uip pm files upload 9c46289e ./Event_log.csv --input-table Event_log

Forma de datos (--json de salida)​

{
  "Code": "PmFilesUpload",
  "Data": { "Filename": "Event_log/.../Event_log.csv", "UploadId": "...", "Size": 12345, "Parts": 1, "InputTable": "Event_log" }
}
{
  "Code": "PmFilesUpload",
  "Data": { "Filename": "Event_log/.../Event_log.csv", "UploadId": "...", "Size": 12345, "Parts": 1, "InputTable": "Event_log" }
}

lista de simulaciones de uip pm​

Lee las simulaciones de proceso (escenarios hipotéticos) guardadas en una aplicación de proceso. Solo lectura: no hay create/update/delete; las simulaciones se crean en otro lugar y solo se enumeran aquí. Servido por una API diferente (PMT con ámbito de aplicación, intercambio de tokens) que el resto de esta herramienta.

Argumentos​

NombreObligatorioPropósito
<app-id>SíID de la aplicación de proceso.

Opciones​

LargoValorPredeterminadoDescripción
--stage <stage>dev | publisheddevEtapa de la aplicación.

Ejemplo​

uip pm simulations list 9c46289e
uip pm simulations list 9c46289e

Forma de datos (--json de salida)​

{
  "Code": "PmSimulationsList",
  "Data": [
    {
      "DefinitionMetadata": { "Name": "Two more approvers", "SimulationId": "bfd3d274-...", "IngestionId": "7792c4cd-...", "ProcessId": "Process" },
      "RunMetadata": { "Status": "successWithWarnings", "NumberOfCases": 1000, "NumberOfRuns": 40 }
    }
  ]
}
{
  "Code": "PmSimulationsList",
  "Data": [
    {
      "DefinitionMetadata": { "Name": "Two more approvers", "SimulationId": "bfd3d274-...", "IngestionId": "7792c4cd-...", "ProcessId": "Process" },
      "RunMetadata": { "Status": "successWithWarnings", "NumberOfCases": 1000, "NumberOfRuns": 40 }
    }
  ]
}

Ver también​

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte

¿Quiere aprender? UiPath Academy

¿Tiene alguna pregunta? Foro de UiPath

Manténgase actualizado