UiPath Documentation
uipath-cli
latest
false
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.

Guía del usuario de UiPath CLI

trabajo de flujo de UIP

uip flow job un trabajo de flujo individual (un intento de ejecución de una instancia de proceso) transmitiendo sus seguimientos u obteniendo su estado detallado.

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

Sinopsis

uip flow job traces <job-key>
                    [-t, --tenant <name>] [--poll-interval <ms>]
                    [--traces-service <name>] [--pretty]
                    [--login-validity <minutes>]

uip flow job status <job-key>
                    [-t, --tenant <name>] [--folder-key <key>] [--detailed]
                    [--login-validity <minutes>]
uip flow job traces <job-key>
                    [-t, --tenant <name>] [--poll-interval <ms>]
                    [--traces-service <name>] [--pretty]
                    [--login-validity <minutes>]

uip flow job status <job-key>
                    [-t, --tenant <name>] [--folder-key <key>] [--detailed]
                    [--login-validity <minutes>]

seguimientos de trabajos de flujo de uip

Transmite eventos de seguimiento de ejecución para un trabajo en ejecución o completado recientemente. Las líneas se transmiten a stderr a medida que llegan; el estado final y la duración también se transmiten.

Argumentos

  • <job-key> (obligatorio) : clave de trabajo (GUID de process run).

Opciones

OpciónPredeterminadoDescripción
-t, --tenant <name>tenant autenticadoNombre del tenant.
--poll-interval <ms>2000Intervalo de sondeo. Debe ser un número positivo.
--traces-service <name>llmopstenant_Nombre del servicio de seguimiento (avanzado; anular solo cuando se le indique).
--prettyDesactivadoEventos de seguimiento de impresión bonita. Sin él, cada evento se emite como una sola línea JSON, fácil de canalizar a jq.
--login-validity <minutes>10Umbral de actualización del token.

Comportamiento

  • Escribe una línea de encabezado en stderr: Streaming traces for job: <key> Polling every Ns...
  • Transmite cada evento de seguimiento a través de ScreenLogger.progress (stderr).
  • Al finalizar, emite Job <key>: <finalState> (<durationMs>ms).
  • Código de salida: 0 si el trabajo se realizó correctamente, 1 de lo contrario (según result.success).

Ejemplos

# Raw JSON lines — best for piping
uip flow job traces b2c3d4e5-| jq -c 'select(.level=="error")'

# Human-readable
uip flow job traces b2c3d4e5---pretty

# Slower polling for quiet jobs
uip flow job traces b2c3d4e5---poll-interval 5000
# Raw JSON lines — best for piping
uip flow job traces b2c3d4e5-… | jq -c 'select(.level=="error")'

# Human-readable
uip flow job traces b2c3d4e5-… --pretty

# Slower polling for quiet jobs
uip flow job traces b2c3d4e5-… --poll-interval 5000

Salida: los seguimientos se transmiten directamente, sin carga útil final Data .

estado del trabajo de flujo de uip

Obtener el estado de un trabajo de flujo. Devuelve un resumen seleccionado de 14 campos de forma predeterminada; --detailed devuelve la respuesta completa de Orchestrator.

Argumentos

  • <job-key> obligatorio) : clave de trabajo (GUID).

Opciones

OpciónPredeterminadoDescripción
-t, --tenant <name>tenant autenticadoNombre del tenant.
--folder-key <key>carpeta autenticadaClave de carpeta (GUID).
--detailedDesactivadoDevuelve la respuesta completa en lugar del resumen de 14 campos.
--login-validity <minutes>10Umbral de actualización del token.

Data shape (default summary)

{
  "Code": "FlowJobStatus",
  "Data": {
    "key":             "b2c3d4e5-…",
    "state":           "Successful",
    "runtimeType":     "…",
    "processType":     "Flow",
    "startTime":       "2025-04-15T10:30:00Z",
    "endTime":         "2025-04-15T10:32:11Z",
    "creationTime":    "2025-04-15T10:29:58Z",
    "inputArguments":  "{}",
    "outputArguments": "{}",
    "info":            "",
    "releaseName":     "InvoiceFlow",
    "processKey":      "a1b2c3d4-…",
    "robotName":       "…",
    "hostMachineName": "…"
  }
}
{
  "Code": "FlowJobStatus",
  "Data": {
    "key":             "b2c3d4e5-…",
    "state":           "Successful",
    "runtimeType":     "…",
    "processType":     "Flow",
    "startTime":       "2025-04-15T10:30:00Z",
    "endTime":         "2025-04-15T10:32:11Z",
    "creationTime":    "2025-04-15T10:29:58Z",
    "inputArguments":  "{}",
    "outputArguments": "{}",
    "info":            "",
    "releaseName":     "InvoiceFlow",
    "processKey":      "a1b2c3d4-…",
    "robotName":       "…",
    "hostMachineName": "…"
  }
}

Con --detailed, Data es el objeto de trabajo de Orchestrator completo (todos los campos, sin aplanar).

Nota:

La forma de respuesta detallada completa es lo que devuelve Orchestrator y no está estrictamente tipada por la CLI. La presencia de campo puede variar entre versiones de Orchestrator: para scripts que analizan campos específicos, consulta de forma defensiva y fija @uipath/cli en CI.

Ejemplos

# Start a job, capture the key, stream traces to completion
JOB_KEY=$(uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "<folder-key>" \
           --inputs '{}' --output-filter "jobKey" --output plain)
uip flow job traces "$JOB_KEY" --pretty

# Get the summary once the job is done
uip flow job status "$JOB_KEY" --folder-key "<folder-key>"

# Full response
uip flow job status "$JOB_KEY" --detailed
# Start a job, capture the key, stream traces to completion
JOB_KEY=$(uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "<folder-key>" \
           --inputs '{}' --output-filter "jobKey" --output plain)
uip flow job traces "$JOB_KEY" --pretty

# Get the summary once the job is done
uip flow job status "$JOB_KEY" --folder-key "<folder-key>"

# Full response
uip flow job status "$JOB_KEY" --detailed

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