Cas uip Maestro

Créer, compresser, déboguer, valider et créer des projets de gestion des cas à l’aide de `uip maestro case`, la troisième surface d’orchestration Maestro avec BPMN et Flow.

uip maestro case crée, compresse, débogue et crée des projets de gestion des cas — une troisième zone d'orchestration Maestro avec BPMN et Flow. Un projet de cas modélise une unité de travail de longue durée pilotée par un humain sous la forme d’un plan de cas: un document JSON (caseplan.json) décrivant les étapes, les tâches, les SLA, les déclencheurs et les conditions d’entrée/de sortie qui déplacent un cas entre les étapes — plus proche d’un workflow structuré avec un cycle de vie qu’un processus linéaire.

L'outil est fourni sous la forme d'un package @uipath/case-tool distinct, chargé dynamiquement par @uipath/maestro-tool sous la branche case — chaque commande est ici invoquée en tant que uip maestro case <verb>, jamais en tant que uip case autonome.

Cette ressource s’étend sur neuf pages

• Cette page — concepts et les commandes du cycle de vie du projet: init, pack, debug, validate, spec.
• registry — parcourir/rechercher le catalogue des ressources d'automatisation auquel un cas connecte les tâches, plus comment lier une entrée de tâche à une variable.
• cases et stages — lisent les métadonnées de haut niveau et la liste d'étapes du plan de cas.
• tasks — lire, enrichir et décrire les définitions de tâches dans une étape.
• task-entry-conditions — lisez les règles qui s'appliquent lorsqu'une tâche devient exécutable.
• sla — lire les règles SLA/escalade.
• triggers, sticky-notes, edges — lisez les déclencheurs de cas, les annotations de zone de dessin et les transitions d'étape à étape.
• case-exit-conditions, stage-entry-conditions, stage-exit-conditions — lisez les règles de condition au niveau du cas et de l'étape.
• process, processes, job, instances, incidents — déployez et exécutez des instances de cas sur Orchestrator.

Concepts

• Le modèle de création: modifiez caseplan.json directement, puis validate Il n’y a aucun chemin de transformation piloté par une CLI pour le contenu du cas. Créez ou modifiez caseplan.json manuellement (ou demandez à un agent de le faire, guidé par les références de forme JSON de la compétence uipath-maestro-case ), puis exécutez uip maestro case validate pour le vérifier. Les verbes read documentés dans les pages frères ci-dessus (cases get, stages list, tasks get, etc.) existent pour vous aider à inspecter le plan tout en le rédigant de cette manière; ils ne font pas partie d'une API d'écriture.
• Cas vs. BPMN vs. Flux — tous les trois sont des surfaces d’orchestration Maestro qui se packent dans .nupkg et partagent des primitives d’exécution (process/job/instances/incidents/registry), mais la propre gestion des cas La ressource principale est caseplan.json (plus un caseplan.json.bpmn généré), et son type de projet est CaseManagement dans operate.json/project.uiproj — distinct de BPMN .bpmn et de Flow2 .flow.
• Profils de validation — validate exécute l'un des quatre profils en fonction de l'étendue de la création: skeleton (structure uniquement — nœuds, bords, identité, types), skeleton-v2 (squelette plus SLA/escalade/entry-exit-rule les vérifications, en ignorant toujours le contenu des tâches, strict (toutes les vérifications, y compris les étapes sans tâches, les marqueurs $xref non résolus et l’exhaustivité du contexte du connecteur — la passerelle de cas terminés), et le profil full par défaut (Léger, pour les fichiers partiellement créés ou déjà compressés). --sdd <path> audite l'exhaustivité par rapport à un document spécifique et implique --strict.
• spec est un outil de planification, et non un mutateur de plan de cas: il récupère une description normalisée d'une activité ou d'un déclencheur du connecteur Integration Service (entrées, sorties, champs requis) afin que vous sachiez ce qu'il faut mettre dans la tâche/ caseplan.json définir des déclencheurs avant de les écrire. Trouvez les valeurs --activity-type-id/--connection-id dont elle a besoin via registry get-connector/get-connection.

Synthèse

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>]

Initialisation de cas uip maestro

Créez un nouveau projet de cas avec des fichiers passe-partout: project.uiproj, operate.json, entry-points.json, bindings_v2.json, package-descriptor.json et un caseplan.json minimum (écrit uniquement s’il n’en existe pas déjà un — réexécution de init ne bloque jamais un plan de cas créé). S’il est exécuté en dehors d’une solution existante, un parent <name>Solution est automatiquement structuré et le projet de cas est imbriqué à l’intérieur; s'il est exécuté à l'intérieur d'une solution, le projet est plutôt enregistré dans cette solution.

Arguments

Nom	Requis	Objectif
<name>	oui	Nom du projet de cas. Lettres, chiffres, traits de soulignement et traits d’union uniquement.

Options

Long	Valeur (Value)	Description
--force	Drapeau	Initialisez même si le répertoire cible n'est pas vide. Écrit des fichiers sans effacer le contenu existant.
--skip-solution-registration	Drapeau	N’enregistrez pas automatiquement ce projet dans la solution voisine.

Exemple

uip maestro case init my-case-project

Format des données (--sortie json)

{
  "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 est "Created" sur un nouvel élaboration ou "Preserved" lorsqu'un caseplan.json existant n'a pas été modifié (réexécution de init sur un projet que vous avez déjà créé). SolutionRegistration est toujours présent - son Status est "NotInSolution" plutôt que le champ étant omis lorsqu'aucune solution parente n'existe.

Pack de cas uip maestro

Compressez un répertoire de projet de cas dans un fichier .nupkg, en lisant caseplan.json à partir de la racine du projet.

Arguments

Nom	Requis	Objectif
<project-path>	oui	Chemin d'accès au répertoire du projet de cas.
<output-path>	oui	Répertoire de sortie pour le .nupkg.

Options

Long	Valeur (Value)	Description
-n, --name <name>	string	Nom du package. Par défaut: nom du dossier du projet.
-v, --version <version>	string	Version du package. Par défaut 1.0.0.

Accepte également les options de métadonnées de package partagées de ce référentiel (--repository-url/--repository-commit/--repository-branch/--repository-type, --release-notes, --project-url, --author, --description) — voir toute autre commande pack Table des options (par exemple uip maestro bpmn pack) pour l'ensemble partagé complet, que cette commande enregistre de manière identique.

Exemple

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

Format des données (--sortie json)

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

Une erreur de schéma lors de la compression (une erreur de caseplan.json mal formée) est enrichie de directives spécifiques au cas avant d'être signalée comme un échec. Attendez-vous à Instructions exploitable, et non à une erreur d'analyseur brute.

Débogage de cas UIP Maestro

Déboguez un projet de cas en le téléchargeant sur Studio Web et en y exécutant une session de débogage — il n'existe pas de mode de débogage local uniquement pour la gestion des cas (contrairement à certaines autres commandes de débogage Maestro).

Arguments

Nom	Requis	Objectif
<project-path>	oui	Chemin d’accès au répertoire du projet de cas. Doit contenir project.uiproj.

Options

Long	Valeur (Value)	Description
--folder-id <id>	Integer	ID de dossier Orchestrator (OrganizationUnitId). Détecté automatiquement lorsqu'il est omis.
--poll-interval <ms>	Integer	Intervalle d'interrogation en millisecondes. Par défaut 2000.
--login-validity <minutes>	Integer	Nombre minimum de minutes avant l’expiration du jeton pour déclencher une actualisation. Par défaut 10.

Nécessite une connexion active (uip login) avec une organisation, un locataire et un jeton d'accès résolvable — échoue rapidement avec une affectation de message spécifique nommant quel élément de l'état de connexion est manquant.

Exemple

uip maestro case debug ./my-case-project

Format des données (--sortie json)

{
  "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" }
    ]
  }
}

Les clés sont conservées dans leur camelCase native (pas PascalCase) — cette charge utile est conçue pour être lue par programmation par les contrôleurs d'évaluation et les SDK, correspondant au même profil d'exclusion utilisé par la commande de débogage de Flow et registry get. La commande se termine non zéro lorsque la valeur finalStatus est autre que "Completed"/"Successful", même si l'enveloppe indique Result: "Success" — vérifiez le code de sortie, et pas seulement la présence de Data dans les scripts.

Validation de cas uip maestro

Validez un fichier JSON de gestion des cas au regard des règles structurées et métier de la gestion des cas.

Arguments

Nom	Requis	Objectif
<file>	oui	Chemin d’accès au fichier JSON de gestion des cas (généralement caseplan.json).

Options

Long	Description
--skeleton	Vérifications structurées uniquement (nœuds, bords, identité, types). Ignore le contenu des tâches, les SLA, les escalades et les règles d’entrée/de sortie — utile pendant la phase squelette de la création. Conflit avec --skeleton-v2/--strict.
--skeleton-v2	Vérifications du squelette plus vérifications des SLA, des escalades et des règles d'entrée/de sortie. Ignore toujours le contenu de la tâche. Conflit avec --skeleton/--strict.
--strict	Chaque vérification, plus l'ensemble strict: une étape sans tâches, avec des marqueurs $xref non résolus, une conditionExpression présente, des formes d'arguments formels/de liaison de sortie et l'exhaustivité du contexte du connecteur. La passerelle de cas terminés. Conflit avec --skeleton/--skeleton-v2.
--sdd <path>	Auditez le plan de cas pour vérifier l'exhaustivité par rapport au SDD donné - chaque étape, tâche, type de tâche, ligne de condition, SLA, déclencheur et variable de cas qu'il déclare doit être présent. Implique --strict.

L'absence de quatre exécutions exécute le profil full par défaut: lenient, de sorte que les fichiers partiellement créés ou déjà compressés sont toujours validés.

Exemples

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

Format des données (--sortie json)

{
  "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" est ajouté à Data uniquement lorsque la valeur --strict (ou --sdd) a été dépassée. Warnings/Issues sont présents uniquement lorsque le fichier valide a produit des avertissements. En cas d’échec (Result: "Failure", sortie 1), Data.Issues transmet chaque erreur et avertissement avec un Code, Path, Message et Severity stable — analyser ce tableau plutôt que le fichier Instructions lisible par un humain } si vous pilotez une boucle de réparation.

Spécifications de cas uip maestro

Générez une ConnectorTaskSpec normalisée — tout ce qui est nécessaire pour construire une activité Integration Service ou une tâche de déclenchement exécutable dans un plan de cas. Recherche le type dans le TypeCache local, répertorie les connexions Integration Service pour le connecteur et extrait les métadonnées Integration Service.

Options

Long	Valeur (Value)	Requis	Description
--type <type>	activity | trigger	oui	Quel TypeCache rechercher.
--activity-type-id <uuid>	UUID	oui	Studio Web uiPathActivityTypeId. Recherchez-le via registry pull + lecture du fichier de cache typecache-{activities,triggers}-index.json , ou registry get-connector.
--connection-id <id>	UUID	oui	ID de connexion. Lister les candidats avec registry get-connection --type typecache-{activities,triggers} --activity-type-id <uuid>.
--object-name <name>	string	non	Remplacer le TypeCache objectName. Requis pour les déclencheurs sélectionnés de type entité dont TypeCache stocke un espace réservé (par ex. Data Service {tenantEntityName|folderEntityName}) — choisissez un nom d'entité réel.
--skip-case-shape	Drapeau	non	Omettez caseShape (inputs[]/outputs[]/context[]) de la réponse — à utiliser lors de la planification lorsque vous avez uniquement besoin du contrat du connecteur. Capture mutuellement exclusive avec --input-details.
--input-details <json>	JSON	non	Pré-remplir les valeurs packagées dans le caseShape généré. La forme diffère de --type: l’activité accepte {bodyParameters, queryParameters, pathParameters, filter}; accepte {eventParameters, filter}. Capture mutuellement exclusive avec --skip-case-shape.

Exemples

# 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

Format des données (--sortie json)

{
  "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 forme operation d'une spécification de déclencheur diffère (eventMode/nom d'événement au lieu d'un verbe/d'un chemin HTTP) — voir le deuxième exemple ci-dessus.

Associé

• registry — découvrez les ressources à référencer dans un plan de cas et comment lier une entrée de tâche à une variable.
• cases et stages — inspectent les métadonnées et les étapes du plan de cas.
• tasks — inspecter, enrichir et décrire les définitions de tâches.
• task-entry-conditions — inspecter les règles d'entrée au niveau de la tâche.
• sla — inspecter les règles SLA/escalade.
• triggers, sticky-notes, edges — inspecter les déclencheurs, les notes de zone de dessin et les transitions.
• conditions — inspecter les règles de condition d'entrée/sortie au niveau du cas et au niveau de l'étape.
• process, processes, job, instances, incidents — déployer et exécuter des instances de cas.
• uip maestro — Orchestration BPMN, la surface frères.
• uip maestro flow — Orchestration du flux, l'autre surface frères.

Voir également

• Présentation de l’outil Maestro
• Options globales
• Codes de sortie