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.

proceso uip maestro bpmn y procesos uip maestro bpmn

Sintaxis y opciones para `uip maestro bpmn process` y `uip maestro bpmn processs`, que cubren las operaciones de proceso Maestro BPMN publicadas por carpeta y en todo el tenant.

Una vez que un paquete de Maestro BPMN se publica en Orchestrator, se convierte en un proceso de tipo ProcessOrchestration. Los dos grupos de comandos siguientes están registrados en la rama bpmn. Esta página cubre dos grupos de comandos relacionados:

  • uip maestro bpmn process — operaciones por carpeta en una sola definición de proceso (enumerar en una carpeta, obtener su esquema, ejecutarlo, empaquetarlo y publicarlo).
  • uip maestro bpmn processes (plural) : resúmenes de todo el tenant, búsqueda incidentes por proceso y diagnósticos.

Sinopsis​

# Singular — per-folder, operational
uip maestro bpmn process list    -f <folder-key> [--filter <odata>] [--login-validity <minutes>]
uip maestro bpmn process get     <process-key> <feed-id> -f <folder-key> [--login-validity <minutes>]
uip maestro bpmn process run     <process-key> <folder-key> --release-key <key>
                                  [-i, --inputs <json>] [--feed-id <id>] [--robot-ids <ids>]
                                  [--login-validity <minutes>]
uip maestro bpmn process publish <project-path> [output-path] -f <folder-key>
                                  [-n, --name <name>] [--process-name <name>] [-v, --version <version>]
                                  [-i, --inputs <json>] [--feed-id <id>] [--entry-point <path>]
                                  [--wait [--timeout <seconds>] [--poll-interval <seconds>]] [--login-validity <minutes>]

# Plural — tenant-wide summary, incidents, and diagnostics
uip maestro bpmn processes list       [--folder-key <key>] [-l <limit>] [--offset <n>] [--status <status>]
uip maestro bpmn processes incidents  <process-key> --folder-key <key>
uip maestro bpmn processes diagnose   <process-key> --folder-key <key>
uip maestro bpmn processes error-codes <process-key> --folder-key <key>
# Singular — per-folder, operational
uip maestro bpmn process list    -f <folder-key> [--filter <odata>] [--login-validity <minutes>]
uip maestro bpmn process get     <process-key> <feed-id> -f <folder-key> [--login-validity <minutes>]
uip maestro bpmn process run     <process-key> <folder-key> --release-key <key>
                                  [-i, --inputs <json>] [--feed-id <id>] [--robot-ids <ids>]
                                  [--login-validity <minutes>]
uip maestro bpmn process publish <project-path> [output-path] -f <folder-key>
                                  [-n, --name <name>] [--process-name <name>] [-v, --version <version>]
                                  [-i, --inputs <json>] [--feed-id <id>] [--entry-point <path>]
                                  [--wait [--timeout <seconds>] [--poll-interval <seconds>]] [--login-validity <minutes>]

# Plural — tenant-wide summary, incidents, and diagnostics
uip maestro bpmn processes list       [--folder-key <key>] [-l <limit>] [--offset <n>] [--status <status>]
uip maestro bpmn processes incidents  <process-key> --folder-key <key>
uip maestro bpmn processes diagnose   <process-key> --folder-key <key>
uip maestro bpmn processes error-codes <process-key> --folder-key <key>

Todos los subcomandos requieren uip login y respetan las opciones globales. Los códigos de salida siguen el contrato estándar.


lista de procesos bpmn de uip maestro​

Enumera los procesos de Maestro disponibles (versiones) en una carpeta específica.

Opciones​

OpciónObligatorioDescripción
-f, --folder-key <key>SíClave de carpeta (GUID).
--filter <odata>NoFiltro OData adicional aplicado en el lado del servidor.
--login-validity <minutes>NoUmbral de actualización del token (predeterminado 10).

Forma de datos (--output json)​

{
  "Code": "MaestroProcessList",
  "Data": [
    {
      "name":           "InvoiceOrchestration",
      "processKey":     "a1b2c3d4-0000-0000-0000-000000000001",
      "processVersion": "1.0.0",
      "packageId":      "a1b2c3d4-0000-0000-0000-000000000001",
      "packageVersion": "1.0.0",
      "releaseKey":     "e5f6a7b8-0000-0000-0000-000000000001",
      "folderKey":      "c3d4e5f6-0000-0000-0000-000000000001",
      "feedId":         "default",
      "folderId":       42,
      "active":         "Yes",
      "latest":         "Yes"
    }
  ]
}
{
  "Code": "MaestroProcessList",
  "Data": [
    {
      "name":           "InvoiceOrchestration",
      "processKey":     "a1b2c3d4-0000-0000-0000-000000000001",
      "processVersion": "1.0.0",
      "packageId":      "a1b2c3d4-0000-0000-0000-000000000001",
      "packageVersion": "1.0.0",
      "releaseKey":     "e5f6a7b8-0000-0000-0000-000000000001",
      "folderKey":      "c3d4e5f6-0000-0000-0000-000000000001",
      "feedId":         "default",
      "folderId":       42,
      "active":         "Yes",
      "latest":         "Yes"
    }
  ]
}

proceso uip maestro bpmn get​

Obtén el esquema de punto de entrada (esquemas JSON de entrada/salida) para un proceso de Maestro.

Argumentos​

  • <process-key> (obligatorio) : clave de proceso.
  • <feed-id> (obligatorio) : ID de fuente (de list).

Opciones​

  • -f, --folder-key <key> (obligatorio)
  • --login-validity <minutes> (predeterminado 10)

Forma de datos​

{
  "Code": "MaestroProcessGet",
  "Data": [
    {
      "Path":         "/content/main.bpmn#Event_start",
      "DisplayName":  "Manual trigger",
      "Type":         "processorchestration",
      "InputSchema":  "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}
{
  "Code": "MaestroProcessGet",
  "Data": [
    {
      "Path":         "/content/main.bpmn#Event_start",
      "DisplayName":  "Manual trigger",
      "Type":         "processorchestration",
      "InputSchema":  "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}

InputSchema y OutputSchema son cadenas de esquema JSON restringidas.


ejecución del proceso bpmn de uip maestro​

Inicia un trabajo de Maestro para un proceso publicado.

Argumentos​

  • <process-key> obligatorio) : clave del proceso del paquete versionado de process list, por ejemplo MyProcess:1.0.0.
  • <folder-key> (obligatorio) : clave de carpeta (GUID).

Opciones​

OpciónObligatorioDescripción
--release-key <key>SíClave de versión (GUID): desde process list.
-i, --inputs <json>NoEntradas como una cadena JSON o @path/to/file.json. Si se omite y se canaliza la entrada estándar, se analiza la entrada estándar.
--feed-id <id>NoID de fuente para la búsqueda de paquetes (opcional).
--robot-ids <ids>NoID de robot separados por comas (opcional).
--login-validity <minutes>NoUmbral de actualización del token (predeterminado 10).

No hay ninguna --validate opción en este comando: las entradas se envían tal cual; el proceso en sí es responsable de rechazar las entradas incorrectas.

Precedencia de entrada: --inputs <json> / --inputs @file.json > stdin > objeto vacío {}.

Ejemplos​

# Inline JSON
uip maestro bpmn process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
  --release-key <release-key> --inputs '{"amount":100}'

# From a file
uip maestro bpmn process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
  --release-key <release-key> --inputs @inputs.json

# Piped stdin
echo '{"amount":100}' | uip maestro bpmn process run "InvoiceOrchestration:1.0.0" "<folder-key>" --release-key <release-key>
# Inline JSON
uip maestro bpmn process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
  --release-key <release-key> --inputs '{"amount":100}'

# From a file
uip maestro bpmn process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
  --release-key <release-key> --inputs @inputs.json

# Piped stdin
echo '{"amount":100}' | uip maestro bpmn process run "InvoiceOrchestration:1.0.0" "<folder-key>" --release-key <release-key>

Forma de datos​

{
  "Code": "MaestroJobStarted",
  "Data": {
    "jobKey":  "b2c3d4e5-0000-0000-0000-000000000001",
    "state":   "Pending",
    "traceId": "d4e5f6a7-0000-0000-0000-000000000001"
  }
}
{
  "Code": "MaestroJobStarted",
  "Data": {
    "jobKey":  "b2c3d4e5-0000-0000-0000-000000000001",
    "state":   "Pending",
    "traceId": "d4e5f6a7-0000-0000-0000-000000000001"
  }
}

Siguiente paso: uip maestro bpmn job traces <jobKey> a la ejecución de la transmisión o uip maestro bpmn job status <jobKey> al sondeo.


publicación del proceso bpmn de uip maestro​

Empaqueta un directorio de proyectos de Maestro BPMN en un .nupkg y publícalo como una versión del proceso de Orchestrator, en un solo paso.

Argumentos​

  • <project-path> obligatorio) : ruta al directorio del proyecto Maestro BPMN.
  • [output-path] (opcional) : directorio de salida para el .nupkg generado. El valor predeterminado es un directorio temporal.

Opciones​

OpciónDescripción
-f, --folder-key <key>Obligatorio. Clave de carpeta (GUID).
-n, --name <name>Nombre del paquete. Predeterminado: el nombre de la carpeta del proyecto.
--process-name <name>Nombre de la versión del proceso. Predeterminado: el nombre del paquete.
-v, --version <version>Versión del paquete. Predeterminado 1.0.0.
-i, --inputs <json>Parámetros de entrada predeterminados como una cadena JSON, @file.json o - para la entrada estándar.
--feed-id <id>ID de fuente para la carga del paquete (opcional).
--entry-point <path>Ruta del punto de entrada para el proceso.
--waitEspera hasta que los puntos de entrada del paquete publicado estén disponibles, en lugar de volver inmediatamente después de la carga.
--timeout <seconds>Máximo de segundos de espera para publicar la propagación cuando se establece --wait. Predeterminado 300.
--poll-interval <seconds>Segundos entre las comprobaciones de propagación de publicación cuando se establece --wait. Predeterminado 5.
--login-validity <minutes>Umbral de actualización del token. Predeterminado 10.

Ejemplo​

uip maestro bpmn process publish ./invoice-process \
  --folder-key <folder-key> --version 1.2.0 --wait
uip maestro bpmn process publish ./invoice-process \
  --folder-key <folder-key> --version 1.2.0 --wait

Forma de datos​

{
  "Code": "MaestroProcessPublished",
  "Data": {
    "Package": "invoice-process@1.2.0",
    "PackagePath": "/tmp/maestro-process-publish-.../invoice-process.processOrchestration.ProcessOrchestration.1.2.0.nupkg",
    "ProcessKey": "invoice-process.processOrchestration.ProcessOrchestration",
    "ProcessVersion": "1.2.0",
    "ReleaseKey": "e5f6a7b8-0000-0000-0000-000000000001",
    "ReleaseName": "invoice-process",
    "Action": "Created",
    "Upload": [
      { "key": "invoice-process.processOrchestration.ProcessOrchestration", "status": "Created" }
    ],
    "EntryPoints": 1
  }
}
{
  "Code": "MaestroProcessPublished",
  "Data": {
    "Package": "invoice-process@1.2.0",
    "PackagePath": "/tmp/maestro-process-publish-.../invoice-process.processOrchestration.ProcessOrchestration.1.2.0.nupkg",
    "ProcessKey": "invoice-process.processOrchestration.ProcessOrchestration",
    "ProcessVersion": "1.2.0",
    "ReleaseKey": "e5f6a7b8-0000-0000-0000-000000000001",
    "ReleaseName": "invoice-process",
    "Action": "Created",
    "Upload": [
      { "key": "invoice-process.processOrchestration.ProcessOrchestration", "status": "Created" }
    ],
    "EntryPoints": 1
  }
}

Action es "Created" en la primera publicación de una clave de proceso determinada, "Updated" en publicaciones posteriores.


lista de procesos bpmn de uip maestro​

Resumen de todo el tenant (o ámbito de carpeta) de los procesos de Maestro. A diferencia del singular process list, no se aplica ningún filtro processType en el lado del servidor: el comando en plural se comparte entre las herramientas (Maestro, Flow, Case) y no abarca ProcessOrchestration por sí mismo.

Opciones​

OpciónDescripción
--folder-key <key>Opcional. Ámbito del resumen a una carpeta.
-l, --limit <number>Número de elementos a devolver (1-10000).
--offset <number>Número de elementos a omitir (0-1000000). Predeterminado 0.
--status <status>Filtrar por estado del proceso.

Forma de datos​

{
  "Code": "ProcessList",
  "Data": [ /* array of Maestro process summaries */ ]
}
{
  "Code": "ProcessList",
  "Data": [ /* array of Maestro process summaries */ ]
}
Nota:

El tiempo de ejecución de Maestro especifica el conjunto de campos exacto de cada resumen de proceso y puede evolucionar; ejecuta el comando una vez con --output json en un tenant con datos para ver los campos que consumirás y ancla @uipath/cli en CI si analizas campos específicos.


incidentes de procesos bpmn de uip maestro​

Obtener todos los incidentes para una definición de proceso de Maestro específica.

Argumentos​

  • <process-key> (obligatorio) : clave de definición del proceso.

Opciones​

  • --folder-key <key> (obligatorio)

Forma de datos​

{
  "Code": "ProcessIncidents",
  "Data": [ /* array of process incidents */ ]
}
{
  "Code": "ProcessIncidents",
  "Data": [ /* array of process incidents */ ]
}

diagnóstico de procesos bpmn de maestro de uip​

Correlaciona el resumen, las incidencias y los códigos de error de un proceso en una sola llamada: un práctico contenedor sobre processes list, processes incidents y processes error-codes.

Argumentos​

  • <process-key> (obligatorio) : clave de definición del proceso.

Opciones​

  • --folder-key <key> (obligatorio)

Forma de datos​

{
  "Code": "ProcessDiagnostics",
  "Data": {
    "ProcessKey": "InvoiceOrchestration",
    "FolderKey": "c3d4e5f6-0000-0000-0000-000000000001",
    "Summary": { /* the matching process summary object, or null if not found */ },
    "FaultedCount": 2,
    "RunningCount": 5,
    "Incidents": [ /* array of incident objects */ ],
    "IncidentCount": 1,
    "ErrorCodes": [ /* array of error code strings */ ],
    "ErrorCodeCount": 1
  }
}
{
  "Code": "ProcessDiagnostics",
  "Data": {
    "ProcessKey": "InvoiceOrchestration",
    "FolderKey": "c3d4e5f6-0000-0000-0000-000000000001",
    "Summary": { /* the matching process summary object, or null if not found */ },
    "FaultedCount": 2,
    "RunningCount": 5,
    "Incidents": [ /* array of incident objects */ ],
    "IncidentCount": 1,
    "ErrorCodes": [ /* array of error code strings */ ],
    "ErrorCodeCount": 1
  }
}

uip maestro bpmn procesa códigos de error​

Obtén los códigos de error únicos generados por incidentes para un proceso específico.

Argumentos​

  • <process-key> (obligatorio) : clave de definición del proceso.

Opciones​

  • --folder-key <key> (obligatorio)

Forma de datos​

{
  "Code": "ProcessIncidentErrorCodes",
  "Data": [ /* array of error code strings */ ]
}
{
  "Code": "ProcessIncidentErrorCodes",
  "Data": [ /* array of error code strings */ ]
}

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