Processus de cas uip Maestro et amp; Tâche

Syntaxe et options pour `uip maestro case process`, `processes`, `job`, `instance` et `incident` — l'exécution et l'inspection des processus de gestion des cas et de leurs exécutions.

Commandes runtime pour uip maestro case: process exécute un processus de cas et gère ses paramètres/balises, job inspecte une tentative d'exécution, instance inspecte/pilote l'instance de processus résultante, processes donne un résumé inter-processus et incident lit les incidents. Voir Vue d’ensemble du cas pour les concepts partagés sur l’ensemble du sous-système case .

Toutes les sous-commandes nécessitent uip login et respectent les options globales. Les codes de sortie suivent le contrat standard.

instance, incident et processes partagent leur implémentation avec les commandes BPMN et Flow équivalentes (module de commandes partagées de @uipath/maestro-sdk) — les mêmes défauts, les mêmes correctifs s'appliquent, paramétré ici pour Cas (toolLabel: "Case", processType: "CaseManagement"). Une réelle différence comportementale: --folder-key deinstance est facultatif ici (folderKeyRequired: false), où il est requis par rapport aux équivalents BPMN/Flow.

Synthèse

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>

Processus de cas uip maestro

Gérer les processus d'incident: répertoriez ce qui est publié dans un dossier, inspectez le schéma d'entrée/sortie d'un point d'entrée et exécutez-en un.

Remarque :

process run prend <folder-key> comme argument positionnel, et non comme indicateur — différent de tous les autres verbes de cette page (list/get/settings/variable-tags), qui utilisent tous --folder-key/-f. Cette asymétrie est réelle, et non une faute de frappe — vérifiez par rapport au --help de votre propre version CLI si un exemple copier-coller semble échouer.

Liste des processus de cas uip Maestro

Répertorie les processus de cas publiés dans un dossier.

Options

Option	Requis	Description
-f, --folder-key <key>	oui	Clé de dossier.
--filter <odata>	non	Filtre OData supplémentaire.
--login-validity <minutes>	non	Nombre minimum de minutes avant l’expiration du jeton pour déclencher une actualisation. Par défaut 10.

Format des données

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

Processus de cas uip maestro - Obtenir

Obtenez les schémas de point d'entrée d'un processus - la forme d'entrée/de sortie process run attendue.

Arguments

Nom	Requis	Objectif
<process-key>	oui	Clé du processus.
<feed-id>	oui	ID de flux, provenant du champ feedId de process list.

Options

Option	Requis	Description
-f, --folder-key <key>	oui	Clé de dossier.
--login-validity <minutes>	non	Par défaut 10.

Format des données

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

Data est un tableau — une entrée par point d'entrée exposé par le processus, et non un objet unique. Échoue avec une erreur explicite si le processus ne contient aucun point d'entrée.

Exécution du processus de cas uip maestro

Démarrez une instance de processus de cas.

Arguments

Nom	Requis	Objectif
<process-key>	oui	Clé du processus.
<folder-key>	oui	Clé de dossier — positionnelle ici, et non un indicateur.

Options

Option	Requis	Description
-i, --inputs <json>	non	Paramètres d'entrée sous forme de chaîne JSON ou @file.json. Omettez de lire à partir de stdin à la place; omettez les deux pour les entrées vides ({}).
--release-key <key>	non	Clé de version (GUID), à partir de process list.
--feed-id <id>	non	ID de flux pour la recherche du package.
--robot-ids <ids>	non	ID de robot numériques séparés par des virgules. Échoue rapidement si une entrée n'est pas un nombre.
--validate	non	Effectuez une validation de base côté client (champs requis + types primitifs) par rapport au schéma d’entrée du processus avant de soumettre. imprime ✅/❌ et quitte 1 en cas d'échec sans démarrer une tâche.
--login-validity <minutes>	non	Par défaut 10.

Exemple

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

Format des données

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

Le message de réussite vous dirige sur uip maestro case job traces <jobKey> pour surveiller l'exécution.

Paramètres de processus de cas uip maestro

Lisez ou remplacez l'objet de paramètres bruts d'un processus (le même objet variable-tags lit/écrit un champ de).

Verbe	Arguments	Options	Remarques
get	<process-key>	-f, --folder-key <key> requis	Code: "ProcessSettingsGet".
set	<process-key>	-f, --folder-key <key> requis, --inputs <json|@file>	Lecture-modification-écriture: OBTENIT les paramètres actuels, PUT votre charge utile comme nouvel objet. Code: "ProcessSettingsSet".

variable-balises de processus de cas uip maestro

Balisez les variables de sortie d'un processus (par exemple, en marquant une variable consultable pour le filtrage de liste d'instances). Deux modes indépendants — choisissez-en un, pas les deux:

• Mode convivial: --variable <name> (répétable) + --element-id/--all pour cibler, plus --searchable <true|false> ou le niveau inférieur --tags/--add-tags/--remove-tags pour mutater.
• Mode brut: --inputs <json|@file> avec la charge utile variableTags complète.

Verbe	Arguments	Options	Remarques
get	<process-key>	-f, --folder-key <key> requis	Renvoie uniquement l'objet variableTags. Code: "ProcessVariableTagsGet".
set	<process-key>	-f, --folder-key <key> requis, plus les indicateurs conviviaux/ bruts ci-dessus	Le mélange de --inputs avec un indicateur convivial est une erreur. --element-id ne fonctionne qu’avec exactement un --variable. --searchable ne peut pas combiner avec --tags/--add-tags/--remove-tags. Code: "ProcessVariableTagsSet".

Exemple

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

Processus de cas uip maestro

Vue récapitulative inter-processus — répertorie les comptages agrégés de chaque processus ou explorez un par clé. Partage l'implémentation avec BPMN processes et l'équivalent de Flow, filtrée par processType: "CaseManagement".

Verbe	Arguments	Options	Remarques
list	—	--folder-key <key>, -l/--limit <n>, --offset <n>, --status <status>	Code: "ProcessList".
incidents	<process-key>	--folder-key <key> requis	Code: "ProcessIncidents".
diagnose	<process-key>	--folder-key <key> requis	Corréle le résumé + les incidents + les codes d’erreur dans un appel. Code: "ProcessDiagnostics" avec FaultedCount/RunningCount/IncidentCount/ErrorCodeCount déploiements.
error-codes	<process-key>	--folder-key <key> requis	Code: "ProcessIncidentErrorCodes".

tâche de cas uip maestro

Inspectez une tentative d'exécution (une tâche) d'un processus de cas.

Traçages de tâche de cas UIP Maestro

Flux les événements de Trace de l’exécution pour une tâche en cours d’exécution ou récemment terminée.

Options

Option	Default	Description
--folder-key <key>	—	Facultatif: étend la demande de traçage.
--poll-interval <ms>	2000	Intervalle d'interrogation.
--traces-service <name>	llmopstenant_	Nom du service de traçages.
--pretty	désactivé	Lignes de traçage lisibles par un humain au lieu de données JSON brutes.
--login-validity <minutes>	10	Seuil d’actualisation du jeton.

Les traçages sont transmis directement à la sortie — aucune Data charge utile finale. Quittez le code 0 en cas de réussite, 1 dans le cas contraire.

Statut de tâche de cas UIP Maestro

Obtenir le statut d'une tâche.

Options

Option	Requis	Default	Description
--folder-key <key>	non	dossier authentifié	Clé de process list dossier. Facultatif ici — omis de laisser le backend résoudre votre dossier par défaut.
--detailed	non	désactivé	Réponse complète au lieu du résumé sélectionné.
--login-validity <minutes>	non	10	Seuil d’actualisation du jeton.

Format des données (résumé par défaut)

{
  "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": "…"
  }
}

Instance de cas UIP Maestro

Inspecter et piloter les instances de processus individuelles — une exécution d'un processus de cas. Partage l'implémentation avec BPMN instance et le flux instance; faire référence à l'une ou l'autre page pour la référence complète verbe par verbe (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) — chaque nom d'option, valeur par défaut et forme de données est identique.

La seule différence réelle: -f, --folder-key est facultatif sur toutes les sous-commandes instance pour Cas (folderKeyRequired: false dans la configuration des commandes partagées), où BPMN et Flow l'exigent. Omettez-le pour définir l’étendue sur votre dossier par défaut authentifié.

Incident uip maestro

Lire les incidents entre les processus ou par ID. Implémentation identique à BPMN incident/L'équivalent de Flow — voir l'une des pages pour la table d'options summary complète à 6 indicateurs et l'unique --folder-key requis de get.

Exemples

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

Voir également

• Case overview
• uip maestro bpmn instance / uip maestro flow instance — référence d'instance partagée complète
• uip maestro bpmn incident — référence d'incident partagée complète
• Tâches Orchestrator