caso de uip maestro

Cree, empaquete, depure, valide y cree proyectos de gestión de casos utilizando `uip maestro case`, la tercera superficie de orquestación de Maestro junto con BPMN y Flow.

uip maestro case , empaqueta, depura y crea proyectos de gestión de casos : una tercera superficie de orquestación de Maestro junto con BPMN y Flow. Un proyecto de caso modela una unidad de trabajo de larga duración impulsada por humanos como un plan de caso: un documento JSON (caseplan.json) que describe etapas, tareas, SLA, desencadenadores y las condiciones de entrada/salida que mueven un caso entre etapas — más cerca de un flujo de trabajo estructurado con un ciclo de vida que de un proceso lineal.

La herramienta se envía como el paquete @uipath/case-tool independiente, cargado dinámicamente por @uipath/maestro-tool en la rama case: cada comando aquí se invoca como uip maestro case <verb>, nunca como un uip case independiente.

Este recurso abarca nueve páginas

• Esta página : conceptos y los comandos del ciclo de vida del proyecto: init, pack, debug, validate, spec.
• registry : explora/busca en el catálogo de recursos de automatización al que un caso asigna tareas, además de cómo vincular una entrada de tarea a una variable.
• cases y stages : leer los metadatos de nivel superior y la lista de etapas del plan de caso.
• tasks — leer, enriquecer y describir definiciones de tareas dentro de una etapa.
• task-entry-conditions : lee las reglas que se activan cuando una tarea se vuelve ejecutable.
• sla : leer reglas de SLA/escalada.
• triggers, sticky-notes, edges : leer desencadenadores de casos, anotaciones de lienzo y transiciones de etapa a etapa.
• case-exit-conditions, stage-entry-conditions, stage-exit-conditions : lee las reglas de condición en el nivel de caso y en el nivel de etapa.
• process, processes, job, instances, incidents : implementar y ejecutar instancias de casos en Orchestrator.

Conceptos

• El modelo de creación: edita caseplan.json directamente y luego validate. No hay una ruta de mutación impulsada por CLI para el contenido del caso. Cree o edite caseplan.json a mano (o haga que un agente lo haga, guiado por las referencias en forma de JSON de la habilidad uipath-maestro-case ) y, a continuación, ejecute uip maestro case validate para comprobarlo. Los verbos read documentados en las páginas relacionadas anteriores (cases get, stages list, tasks get, etc.) existen para ayudarte a inspeccionar el plan mientras lo creas de esta manera: no forman parte de una API de escritura.
• Caso frente a BPMN frente a Flujo : las tres son superficies de orquestación de Maestro que se empaquetan en .nupkg y comparten primitivas de runtime (process/job/instances/incidents/registry), pero la propia Gestión de casos el activo principal es caseplan.json (más un caseplan.json.bpmn generado), y su tipo de proyecto es CaseManagement en operate.json/project.uiproj — distinto del .bpmn de BPMN y del .flow de Flow.
• Perfiles de validación : validate ejecuta uno de los cuatro perfiles dependiendo de lo avanzada que esté la creación: skeleton (solo estructura: nodos, bordes, identidad, tipos), skeleton-v2 (esqueleto más SLA/escalada/entry-exit-regla comprobaciones, aún omitiendo el contenido de la tarea), strict (cada comprobación, incluida la etapa sin tareas, los marcadores $xref no resueltos y la integridad del contexto del conector: la puerta del caso terminado) y el perfil predeterminado full (permisiva, para archivos parcialmente creados o ya empaquetados). --sdd <path> audita la integridad en comparación con un documento de especificaciones e implica --strict.
• spec es una herramienta de planificación, no un mutador de plan de caso: obtiene una descripción normalizada de una actividad o desencadenador del conector de Integration Service (entradas, salidas, campos obligatorios) para que sepas qué poner en caseplan.json 's task/ definiciones de desencadenador antes de escribirlas. Encuentra los valores --activity-type-id/--connection-id que necesita a través de registry get-connector/get-connection.

Sinopsis

uip maestro case init <name> [--force] [--skip-solution-registration]
uip maestro case pack <project-path> <output-path> [-n, --name <name>] [-v, --version <version>] [package-metadata options...]
uip maestro case debug <project-path> [--folder-id <id>] [--poll-interval <ms>] [--login-validity <minutes>]
uip maestro case validate <file> [--skeleton | --skeleton-v2 | --strict] [--sdd <path>]
uip maestro case spec --type <activity|trigger> --activity-type-id <uuid> --connection-id <id> [--object-name <name>] [--skip-case-shape | --input-details <json>]

inicialización de mayúsculas y minúsculas de uip maestro

Cree un nuevo proyecto de caso con archivos estándar: project.uiproj, operate.json, entry-points.json, bindings_v2.json, package-descriptor.json y un caseplan.json mínimo (solo se escribe si no existe uno — volver a ejecutar init nunca afecta a un plan de caso creado). Si se ejecuta fuera de una solución existente, un <name>Solution principal se aplica automáticamente y el proyecto de caso se anida en su interior; si se ejecuta dentro de una, el proyecto se registra en esa solución.

Argumentos

Nombre	Obligatorio	Propósito
<name>	Sí	Nombre del proyecto del caso. Solo letras, números, guiones bajos y guiones.

Opciones

Largo	Valor	Descripción
--force	Marca	Inicializar incluso si el directorio de destino no está vacío. Escribe archivos sin borrar el contenido existente.
--skip-solution-registration	Marca	No registre automáticamente este proyecto en la solución circundante.

Ejemplo

uip maestro case init my-case-project

Forma de datos (--json de salida)

{
  "Code": "CaseInit",
  "Data": {
    "Status": "Created successfully",
    "Path": "/workspace/my-case-project",
    "CasePlan": "/workspace/my-case-project/caseplan.json",
    "CasePlanStatus": "Created",
    "SolutionRegistration": { "Status": "Registered", "Solution": "...", "ProjectId": "..." },
    "AutoCreatedSolution": { "...": "present only when a parent solution was scaffolded" },
    "ProjectArtifacts": { "...": "present only when registered into a parent solution" },
    "NextSteps": "present only when SolutionRegistration.Instructions is set"
  }
}

CasePlanStatus es "Created" en un andamio nuevo o "Preserved" cuando un caseplan.json existente se dejó intacto (volviendo a ejecutar init en un proyecto que ya has creado). SolutionRegistration siempre está presente: su Status es "NotInSolution" en lugar de que el campo se omita cuando no existe una solución principal.

paquete de casos de uip maestro

Empaqueta un directorio de proyecto de caso en un archivo .nupkg, leyendo caseplan.json desde la raíz del proyecto.

Argumentos

Nombre	Obligatorio	Propósito
<project-path>	Sí	Ruta al directorio del proyecto del caso.
<output-path>	Sí	Directorio de salida para el .nupkg.

Opciones

Largo	Valor	Descripción
-n, --name <name>	String	Nombre del paquete. Predeterminado: nombre de la carpeta del proyecto.
-v, --version <version>	String	Versión del paquete. Predeterminado 1.0.0.

También acepta las opciones de metadatos de paquete compartidos de este repositorio (--repository-url/--repository-commit/--repository-branch/--repository-type, --release-notes, --project-url, --author, --description) — consulta cualquier otro comando pack Tabla de opciones (por ejemplo uip maestro bpmn pack) para el conjunto compartido completo, que este comando registra de forma idéntica.

Ejemplo

uip maestro case pack ./my-case-project ./dist --version 1.2.0

Forma de datos (--json de salida)

{
  "Code": "CasePack",
  "Data": {
    "Package": "my-case-project.1.2.0.nupkg",
    "Output": "./dist/my-case-project.1.2.0.nupkg"
  }
}

Un error de esquema durante el empaquetado (un caseplan.json mal formado) se enriquece con orientación específica del caso antes de emerger como un fallo: espera un Instructions accionable, no un error del analizador sin procesar.

depuración de casos de uip maestro

Depura un proyecto de caso cargándolo en Studio Web y ejecutando una sesión de depuración allí: no hay modo de depuración solo local para la gestión de casos (a diferencia de otros comandos de depuración de Maestro).

Argumentos

Nombre	Obligatorio	Propósito
<project-path>	Sí	Ruta al directorio del proyecto del caso. Debe contener project.uiproj.

Opciones

Largo	Valor	Descripción
--folder-id <id>	Entero	ID de carpeta de Orchestrator (OrganizationUnitId). Se detecta automáticamente cuando se omite.
--poll-interval <ms>	Entero	Intervalo de sondeo en milisegundos. Predeterminado 2000.
--login-validity <minutes>	Entero	Minutos mínimos antes de la caducidad del token para desencadenar una actualización. Predeterminado 10.

Requiere un inicio de sesión activo (uip login) con una organización, un tenant y un token de acceso resolubles: falla rápidamente con un mensaje específico que nombra la parte del estado de inicio de sesión que falta.

Ejemplo

uip maestro case debug ./my-case-project

Forma de datos (--json de salida)

{
  "Code": "CaseDebug",
  "Data": {
    "jobKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "instanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "runId": "d4e5f6a7-0000-0000-0000-000000000001",
    "finalStatus": "Completed",
    "solutionId": "e5f6a7b8-0000-0000-0000-000000000001",
    "studioWebUrl": "https://cloud.uipath.com/org/tenant/studio_/debug/e5f6a7b8",
    "elementExecutions": [
      { "elementId": "Stage_1", "status": "Completed" },
      { "elementId": "Stage_2", "status": "Completed" }
    ]
  }
}

Las claves se mantienen en su camelCase nativo (no en PascalCased): esta carga útil está diseñada para ser leída mediante programación por verificadores de evaluación y SDK, coincidiendo con la misma excepción utilizada por el comando de depuración de Flow y registry get. El comando sale distinto de cero cuando finalStatus es cualquier cosa distinta de "Completed"/"Successful", aunque el propio sobre informe Result: "Success": comprueba el código de salida, no solo la presencia de Data, en los scripts.

validación de caso maestro de uip

Valida un archivo JSON de gestión de casos según las reglas estructurales y empresariales de Gestión de casos.

Argumentos

Nombre	Obligatorio	Propósito
<file>	Sí	Ruta al archivo JSON de gestión de casos (normalmente caseplan.json).

Opciones

Largo	Descripción
--skeleton	Solo comprobaciones estructurales (nodos, bordes, identidad, tipos). Omite el contenido de la tarea, los SLA, las escaladas y las reglas de entrada/salida: útil durante la fase de esqueleto de la creación. Conflicto con --skeleton-v2/--strict.
--skeleton-v2	Comprobaciones de esqueleto más SLA, escalada y comprobaciones de reglas de entrada/salida. Aún omite el contenido de la tarea. Conflicto con --skeleton/--strict.
--strict	Cada comprobación, más el conjunto estricto: una etapa sin tareas, marcadores $xref no resueltos, un conditionExpression izado, formas de enlace de salida/argumento formal e integridad del contexto del conector. La puerta del caso terminado. Conflicto con --skeleton/--skeleton-v2.
--sdd <path>	Audita el plan del caso para comprobar que esté completo en comparación con el SDD (documento de especificaciones) dado: cada etapa, tarea, tipo de tarea, fila de condición, SLA, desencadenador y variable de caso que declara deben estar presentes. Implica --strict.

Omitir los cuatro ejecuta el perfil full predeterminado: flexible, por lo que los archivos parcialmente creados o ya empaquetados siguen siendo válidos.

Ejemplos

uip maestro case validate case.json
uip maestro case validate case.json --skeleton
uip maestro case validate case.json --strict
uip maestro case validate case.json --sdd ./spec.md

Forma de datos (--json de salida)

{
  "Code": "CaseValidate",
  "Data": {
    "File": "case.json",
    "Status": "Valid",
    "Warnings": "2 warning(s):\n  - [stages[0].tasks[1]] ...",
    "Issues": [
      { "Code": "UNRESOLVED_REFERENCE", "Path": "stages[0].tasks[1]", "Message": "...", "Severity": "warning" }
    ]
  }
}

Profile: "strict" se añade a Data solo cuando se aprobó --strict (o --sdd). Warnings/Issues solo están presentes cuando el archivo válido seguía generando advertencias. En caso de fallo (Result: "Failure", salida 1), Data.Issues transporta cada error y advertencia con un Code, Path, Message y Severity estable — analiza esta matriz en lugar del Instructions legible por humanos } si estás impulsando un bucle de reparación.

especificaciones de caso de uip maestro

Genera un ConnectorTaskSpec normalizado: todo lo necesario para construir una actividad ejecutable de Integration Service o una tarea de desencadenador dentro de un plan de caso. Busca el tipo en el TypeCache local, enumera las conexiones de Integration Service para el conector y obtiene los metadatos de Integration Service.

Opciones

Largo	Valor	Obligatorio	Descripción
--type <type>	activity | trigger	Sí	Qué TypeCache buscar.
--activity-type-id <uuid>	Uuid	Sí	Studio Web uiPathActivityTypeId. Encuéntralo a través de registry pull + leyendo el archivo de caché typecache-{activities,triggers}-index.json , o registry get-connector.
--connection-id <id>	Uuid	Sí	ID de conexión. Enumerar candidatos con registry get-connection --type typecache-{activities,triggers} --activity-type-id <uuid>.
--object-name <name>	String	No	Anula TypeCache objectName. Obligatorio para desencadenadores seleccionados de tipo entidad cuyo TypeCache almacena un marcador de posición (por ejemplo Data Service {tenantEntityName|folderEntityName}): elige un nombre de entidad real.
--skip-case-shape	Marca	No	Omite caseShape (inputs[]/outputs[]/context[]) de la respuesta: utilízalo durante la planificación cuando solo necesites el contrato del conector. Mutuamente excluyente con --input-details.
--input-details <json>	JSON	No	Rellene previamente los valores plegados en el caseShape generado. La forma difiere en --type: la actividad acepta {bodyParameters, queryParameters, pathParameters, filter}; el desencadenador acepta {eventParameters, filter}. Mutuamente excluyente con --skip-case-shape.

Ejemplos

# Curated connector activity (Send Email)
uip maestro case spec --type activity \
  --activity-type-id c7ce0a96-2091-3d94-b16f-706ebb1eb351 \
  --connection-id fc82e610-c454-4bc7-a1a5-b5aa529d1ba6

# Curated connector trigger (Email Received)
uip maestro case spec --type trigger \
  --activity-type-id 7dc57f24-894c-5ae2-a902-66056fa40609 \
  --connection-id fc82e610-c454-4bc7-a1a5-b5aa529d1ba6

Forma de datos (--json de salida)

{
  "Code": "ConnectorTaskSpec",
  "Data": {
    "specVersion": 1,
    "identity": {
      "target": "activity",
      "uiPathActivityTypeId": "c7ce0a96-2091-3d94-b16f-706ebb1eb351",
      "connectorKey": "uipath-microsoft-outlook365",
      "objectName": "send-mail-v2",
      "typecacheEntry": { "displayName": "Send Email" }
    },
    "operation": { "name": "POST", "verb": "create", "httpMethod": "POST", "path": "/hubs/productivity/send-mail-v2" },
    "inputs": { "bodyFields": [{ "name": "message.toRecipients", "required": true }] }
  }
}

La forma de una especificación de desencadenador operation difiere (eventMode/nombre de evento en lugar de un verbo/ruta HTTP): consulta el segundo ejemplo anterior.

Relacionado

• registry : descubre recursos a los que hacer referencia en un plan de caso y cómo vincular una entrada de tarea a una variable.
• cases y stages : inspeccionar metadatos y etapas del plan del caso.
• tasks — inspeccionar, enriquecer y describir definiciones de tareas.
• task-entry-conditions : inspeccionar las reglas de entrada a nivel de tarea.
• sla : inspeccionar SLA/reglas de escalada.
• triggers, sticky-notes, edges : inspecciona desencadenadores, notas de lienzo y transiciones.
• condiciones : inspecciona las reglas de condición de entrada/salida a nivel de caso y etapa.
• process, processes, job, instances, incidents : implementar y ejecutar instancias de casos.
• uip maestro — Orquestación BPMN, la superficie hermana.
• uip maestro flow — Orquestación de flujo, la otra superficie hermana.

Ver también

• Descripción general de la herramienta de Maestro
• Opciones globales
• Códigos de salida