proceso de caso de uip maestro & trabajo

Sintaxis y opciones para `proceso de caso maestro de uip`, `procesos`, `trabajo`, `instancia` e `incidente`: ejecutar e inspeccionar procesos de gestión de casos y sus ejecuciones.

Comandos de runtime para uip maestro case: process ejecuta un proceso de caso y gestiona su configuración/etiquetas de variable, job inspecciona un intento de ejecución, instance inspecciona/dirige la instancia de proceso resultante, processes proporciona un resumen entre procesos y incident lee incidentes. Consulta Descripción general del caso para conceptos compartidos en todo el subsistema case .

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

instance, incident y processes comparten su implementación con los comandos BPMN y Flujo equivalentes (módulo de comandos compartidos de @uipath/maestro-sdk): los mismos defectos, se aplican las mismas correcciones, parametrizados aquí para el Caso (toolLabel: "Case", processType: "CaseManagement"). Una diferencia de comportamiento real: instance de --folder-key es opcional aquí (folderKeyRequired: false), donde se requiere en los equivalentes de BPMN/Flujo.

Sinopsis

uip maestro case process list --folder-key <key> [--filter <odata>] [--login-validity <minutes>]
uip maestro case process get <process-key> <feed-id> --folder-key <key> [--login-validity <minutes>]
uip maestro case process run <process-key> <folder-key> [--inputs <json|@file>] [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>] [--validate] [--login-validity <minutes>]
uip maestro case process settings get <process-key> --folder-key <key>
uip maestro case process settings set <process-key> --folder-key <key> --inputs <json|@file>
uip maestro case process variable-tags get <process-key> --folder-key <key>
uip maestro case process variable-tags set <process-key> --folder-key <key> [--variable <name>]... [--element-id <id>] [--all] [--searchable <true|false>] [--tags <csv>] [--add-tags <csv>] [--remove-tags <csv>] [--inputs <json|@file>]

uip maestro case processes list [--folder-key <key>] [--limit <n>] [--offset <n>] [--status <status>]
uip maestro case processes incidents <process-key> --folder-key <key>
uip maestro case processes diagnose <process-key> --folder-key <key>
uip maestro case processes error-codes <process-key> --folder-key <key>

uip maestro case job traces <job-key> [--folder-key <key>] [--poll-interval <ms>] [--traces-service <name>] [--pretty] [--login-validity <minutes>]
uip maestro case job status <job-key> [--folder-key <key>] [--detailed] [--login-validity <minutes>]

uip maestro case instance list --folder-key <key> [-l <limit>] [--next-page <cursor>] [--process-key <k>] [--package-id <id>] [--error-code <code>] [--status <status>]... [--from-date <iso-8601>] [--to-date <iso-8601>]
uip maestro case instance get <instance-id> [--folder-key <key>]
uip maestro case instance pause|resume|cancel|retry <instance-id> [--folder-key <key>] [--comment <text>]
uip maestro case instance migrate <instance-id> <new-version> [--folder-key <key>] [--comment <text>]
uip maestro case instance incidents|asset|cursors|element-executions|variables|variables-all|global-variables <instance-id> [--folder-key <key>]
uip maestro case instance variables-set <instance-id> [--folder-key <key>] --inputs <json|@file>
uip maestro case instance goto <instance-id> <transitions> [--folder-key <key>]
uip maestro case instance element cancel|retry <instance-id> <element-id> [--folder-key <key>] [--comment <text>]
uip maestro case instance message send [--folder-key <key>] [--inputs <json|@file>]

uip maestro case incident summary [--folder-key <key>] [-l <limit>] [--offset <n>] [--process-key <k>] [--status <status>] [--severity <severity>]
uip maestro case incident get <incident-id> --folder-key <key>

proceso de caso de uip maestro

Gestionar procesos de casos: enumera lo que se publica en una carpeta, inspecciona el esquema de entrada/salida de un punto de entrada y ejecuta uno.

Nota:

process run toma <folder-key> como argumento posicional, no como marca, a diferencia de todos los demás verbos de esta página (list/get/settings/variable-tags), que utilizan --folder-key/-f. Esta asimetría es real, no un error tipográfico: compruébalo con tu propia versión de CLI --help si un ejemplo de copiar y pegar parece fallar.

lista de procesos de casos de uip maestro

Enumerar procesos de casos publicados en una carpeta.

Opciones

Opción	Obligatorio	Descripción
-f, --folder-key <key>	Sí	Clave de carpeta (GUID).
--filter <odata>	No	Filtro OData adicional.
--login-validity <minutes>	No	Minutos mínimos antes de la caducidad del token para desencadenar una actualización. Predeterminado 10.

Forma de datos

{
  "Code": "CaseProcessList",
  "Data": [
    {
      "name": "InvoiceReview",
      "processKey": "a1b2c3d4-0000-0000-0000-000000000001:1.0.0",
      "releaseKey": "e5f6a7b8-0000-0000-0000-000000000001",
      "folderKey": "c3d4e5f6-0000-0000-0000-000000000001",
      "feedId": "default",
      "folderId": 42,
      "active": "Yes",
      "latest": "Yes"
    }
  ]
}

obtención del proceso del caso maestro de uip

Obtener los esquemas de punto de entrada de un proceso: la forma de entrada/salida que process run espera.

Argumentos

Nombre	Obligatorio	Propósito
<process-key>	Sí	Clave de proceso.
<feed-id>	Sí	ID de fuente, del campo feedId de process list.

Opciones

Opción	Obligatorio	Descripción
-f, --folder-key <key>	Sí	Clave de carpeta (GUID).
--login-validity <minutes>	No	Predeterminado 10.

Forma de datos

{
  "Code": "CaseProcessGet",
  "Data": [
    {
      "Path": "/content/caseplan.json.bpmn#Trigger_1",
      "DisplayName": "Start",
      "Type": "CaseManagement",
      "InputSchema": "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}

Data es una matriz: una entrada por punto de entrada que expone el proceso, no un solo objeto. Falla con un error explícito si el proceso no tiene puntos de entrada.

ejecución del proceso de caso de uip maestro

Inicia una instancia de proceso de caso.

Argumentos

Nombre	Obligatorio	Propósito
<process-key>	Sí	Clave de proceso.
<folder-key>	Sí	Clave de carpeta (GUID): posicional aquí, no un marcador.

Opciones

Opción	Obligatorio	Descripción
-i, --inputs <json>	No	Parámetros de entrada como una cadena JSON o @file.json. Omite leer desde la entrada estándar en su lugar; omita ambos para entradas vacías ({}).
--release-key <key>	No	Clave de versión (GUID), desde process list.
--feed-id <id>	No	ID de fuente para la búsqueda de paquetes.
--robot-ids <ids>	No	ID de robots numéricos separados por comas. Falla rápidamente si alguna entrada no es un número.
--validate	No	Ejecute la validación básica del lado del cliente (campos obligatorios + tipos primitivos) contra el esquema de entrada del proceso antes de enviarlo. Imprime ✅/❌ y sale de 1 en caso de fallo sin iniciar un trabajo.
--login-validity <minutes>	No	Predeterminado 10.

Ejemplo

uip maestro case process run a1b2c3d4-0000-0000-0000-000000000001 c3d4e5f6-0000-0000-0000-000000000001 \
  --inputs '{"amount":100}'

Forma de datos

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

El mensaje de éxito le indica uip maestro case job traces <jobKey> para ver la ejecución.

configuración del proceso de caso de uip maestro

Leer o reemplazar el objeto de configuración sin formato de un proceso (el mismo objeto del que variable-tags lee/escribe un campo).

Verbo	Argumentos	Opciones	Notas
get	<process-key>	-f, --folder-key <key> obligatorio	Code: "ProcessSettingsGet".
set	<process-key>	-f, --folder-key <key> requerido, --inputs <json|@file>	Leer-modificar-escribir: OBTENER la configuración actual, PUT tu carga útil como el nuevo objeto. Code: "ProcessSettingsSet".

Etiquetas-variables del proceso del caso de UIP Maestro

Etiquetar las variables de salida de un proceso (por ejemplo, marcar una como buscable para el filtrado de listas de instancias). Dos modos independientes: elige uno, no ambos:

• Modo amigable: --variable <name> (repetible) + --element-id/--all al destino, más --searchable <true|false> o el nivel inferior --tags/--add-tags/--remove-tags para mutar.
• Modo sin procesar: --inputs <json|@file> con la carga útil variableTags completa.

Verbo	Argumentos	Opciones	Notas
get	<process-key>	-f, --folder-key <key> obligatorio	Devuelve solo el objeto variableTags. Code: "ProcessVariableTagsGet".
set	<process-key>	-f, --folder-key <key> requerido, más las marcas descriptivas/sin procesar anteriores	Mezclar --inputs con cualquier bandera amigable es un error. --element-id solo funciona con exactamente un --variable. --searchable no se puede combinar con --tags/--add-tags/--remove-tags. Code: "ProcessVariableTagsSet".

Ejemplo

# Mark the "amount" output searchable
uip maestro case process variable-tags set a1b2c3d4-… --folder-key <key> --variable amount --searchable true

procesos de casos de uip maestro

Vista de resumen entre procesos: enumera los recuentos agregados de cada proceso o profundiza en uno por clave. Comparte la implementación con BPMN processes y el equivalente de Flow, filtrado a processType: "CaseManagement".

Verbo	Argumentos	Opciones	Notas
list	—	--folder-key <key>, -l/--limit <n>, --offset <n>, --status <status>	Code: "ProcessList".
incidents	<process-key>	--folder-key <key> obligatorio	Code: "ProcessIncidents".
diagnose	<process-key>	--folder-key <key> obligatorio	Correlaciona resumen + incidentes + códigos de error en una llamada. Code: "ProcessDiagnostics" con FaultedCount/RunningCount/IncidentCount/ErrorCodeCount acumulaciones.
error-codes	<process-key>	--folder-key <key> obligatorio	Code: "ProcessIncidentErrorCodes".

trabajo de caso de uip maestro

Inspecciona un intento de ejecución (un trabajo) de un proceso de caso.

seguimientos de trabajo de caso de uip maestro

Transmite eventos de seguimiento de ejecución para un trabajo en ejecución o completado recientemente.

Opciones

Opción	Predeterminado	Descripción
--folder-key <key>	—	Opcional: establece el ámbito de la solicitud de seguimiento.
--poll-interval <ms>	2000	Intervalo de sondeo.
--traces-service <name>	llmopstenant_	Nombre del servicio de seguimiento.
--pretty	Desactivado	Líneas de seguimiento legibles por humanos en lugar de JSON sin formato.
--login-validity <minutes>	10	Umbral de actualización del token.

Los seguimientos se transmiten directamente a la salida, sin carga útil Data final. Código de salida 0 en caso de éxito, 1 de lo contrario.

estado del trabajo del caso de uip maestro

Obtener el estado de un trabajo.

Opciones

Opción	Obligatorio	Predeterminado	Descripción
--folder-key <key>	No	carpeta autenticada	Clave de carpeta (GUID, de process list). Opcional aquí : omitir para permitir que el backend resuelva tu carpeta predeterminada.
--detailed	No	Desactivado	Respuesta completa en lugar del resumen seleccionado.
--login-validity <minutes>	No	10	Umbral de actualización del token.

Forma de datos (resumen predeterminado)

{
  "Code": "CaseJobStatus",
  "Data": {
    "key": "b2c3d4e5-0000-0000-0000-000000000001",
    "state": "Successful",
    "runtimeType": "…",
    "processType": "CaseManagement",
    "startTime": "2025-04-15T10:30:00Z",
    "endTime": "2025-04-15T10:32:11Z",
    "creationTime": "…",
    "inputArguments": "…",
    "outputArguments": "…",
    "info": "…",
    "releaseName": "InvoiceReviewProcess",
    "processKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "robotName": "…",
    "hostMachineName": "…"
  }
}

instancia de caso uip maestro

Inspeccionar y dirigir instancias de proceso individuales: una ejecución de un proceso de caso. Comparte la implementación con BPMN instance y Flujo instance; consulta cualquiera de las páginas para obtener la referencia completa verbo por verbo (list, get, pause, resume, cancel, retry, migrate, variables, variables-set, variables-all, global-variables, incidents, asset, cursors, goto, element-executions, element cancel/retry, message send) — cada nombre de opción, predeterminado y forma de datos es idéntico.

La única diferencia real: -f, --folder-key es opcional en cada subcomando instance para Caso (folderKeyRequired: false en la configuración de comandos compartidos), donde BPMN y Flujo lo requieren. Omítelo para limitar el ámbito a tu carpeta predeterminada autenticada.

incidente del caso uip maestro

Leer incidentes en todos los procesos o por ID. Implementación idéntica al equivalente de BPMN incident/Flow: consulta cualquier página para ver la tabla completa de opciones de 6 indicadores summary y el get único requerido --folder-key.

Ejemplos

# Publish check, then run
uip maestro case process list --folder-key <key>
uip maestro case process get a1b2c3d4-… default --folder-key <key>
uip maestro case process run a1b2c3d4-… <key> --inputs '{"amount":100}'

# Watch it through to completion
JOB_KEY=$(uip maestro case process run a1b2c3d4-… <key> --inputs '{}' --output-filter "Data.jobKey" --output plain)
uip maestro case job traces "$JOB_KEY" --pretty
uip maestro case job status "$JOB_KEY" --detailed

# Diagnose a failing process in one call
uip maestro case processes diagnose a1b2c3d4-… --folder-key <key>

Ver también

• Case overview
• uip maestro bpmn instance / uip maestro flow instance — referencia completa de instancia compartida
• uip maestro bpmn incident — referencia completa de incidente compartido
• Trabajos de Orchestrator