Processus de flux uip Maestro et Processus de flux uip Maestro

Syntaxe et options pour `uip maestro flow process` et `uip maestro flow processes`, couvrant les opérations de processus de flux publiées par dossier et à l'échelle du locataire.

Une fois qu'un package de flux est publié dans Orchestrator, il devient un processus. Cette page couvre deux groupes de commandes associés:

• uip maestro flow process — opérations par dossier sur une seule définition de processus (répertorier dans un dossier, obtenir son schéma, l'exécuter).
• uip maestro flow processes — résumés à l'échelle du locataire et recherche d'incidents par processus.

Synthèse

# Singular — per-folder, operational
uip maestro flow process list -f <folder-key> [--filter <odata>] [--login-validity <minutes>]
uip maestro flow process get  <process-key> <feed-id> -f <folder-key> [--login-validity <minutes>]
uip maestro flow process run  <process-key> <folder-key>
                       [-i, --inputs <json>]
                       [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>]
                       [--attachment <name=path>]...
                       [--wait [--timeout <seconds>] [--poll-interval <seconds>]]
                       [--validate] [--login-validity <minutes>]
uip maestro flow process settings get       <process-key> -f <folder-key>
uip maestro flow process settings set       <process-key> -f <folder-key> [--inputs <json|@file>]
uip maestro flow process variable-tags get  <process-key> -f <folder-key>
uip maestro flow process variable-tags set  <process-key> -f <folder-key> [--variable <name>]... [--all] [--searchable <bool>] [--tags <csv>] [--add-tags <csv>] [--remove-tags <csv>] [--inputs <json|@file>]

# Plural — tenant-wide summary and incident surface
uip maestro flow processes list
uip maestro flow processes incidents    <process-key> --folder-key <key>
uip maestro flow processes diagnose     <process-key> --folder-key <key>
uip maestro flow processes error-codes  <process-key> --folder-key <key>

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

---

Liste des processus de flux uip Maestro

Répertoriez les processus de flux (versions) disponibles dans un dossier spécifique.

Options

Option	Requis	Description
-f, --folder-key <key>	oui	Clé de dossier.
--filter <odata>	non	Un filtre OData supplémentaire est appliqué côté serveur.
--login-validity <minutes>	non	Seuil d’actualisation du jeton (par défaut 10).

Format des données (--output json)

{
  "Code": "FlowProjectList",
  "Data": [
    {
      "name":       "InvoiceFlow",
      "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"
    }
  ]
}

---

Obtenir le processus de flux uip maestro

Récupérez le schéma du point d'entrée (schéma JSON d'entrée/de sortie) d'un processus de flux. Utilisez le résultat pour créer une charge utile --inputs valide pour process run.

Arguments

• <process-key> (obligatoire) — clé de processus, par exemple MyFlow.flow.Flow:1.0.0 ou <package-id>:<version>.
• <feed-id> (obligatoire) : ID de flux (à partir de la sortie list ).

Options

• -f, --folder-key <key> (requis)
• --login-validity

Format des données

{
  "Code": "FlowProjectGet",
  "Data": [
    {
      "Path":         "/content/main.flow",
      "DisplayName":  "Main",
      "Type":         "Flow",
      "InputSchema":  "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}

InputSchema et OutputSchema sont ré-chaînes JSON; les analyser sous forme de schémas JSON pour piloter la construction d'entrée.

---

Exécution du processus de flux uip maestro

Démarrez une tâche de flux pour un processus publié.

Arguments

• <process-key> (obligatoire) — clé de processus (par ex. MyFlow.flow.Flow:1.0.0).
• <folder-key> (obligatoire) — clé de dossier.

Options

Option	Description
-i, --inputs <json>	Les entrées sous la forme d'une chaîne JSON ou @path/to/file.json. Si ce champ est omis et que stdin est sur la barre de pipeline, st din est analysé en tant qu'entrées.
--release-key <key>	Clé de version — à partir de process list.
--feed-id <id>	ID de flux pour la recherche des packages (facultatif).
--robot-ids <ids>	ID de robot (entiers) séparés par des virgules. Les valeurs non valides échouent rapidement.
--attachment <name=path>	Chargez un fichier local dans Orchestrator et liez-le en tant que variable d'entrée de type fichier. Répétable, par exemple --attachment file1=./resume.pdf. Remplace le même nom de variable s'il est également présent dans --inputs.
--wait	Bloquez jusqu’à ce que la tâche atteigne un état terminal au lieu de revenir immédiatement à l’état Pending.
--timeout <seconds>	Nombre maximal de secondes à attendre. 0 = pas de délai d'attente. Nécessite --wait.
--poll-interval <seconds>	Secondes entre les vérifications du statut pendant l'attente. Nécessite --wait.
--validate	Validez les entrées par rapport au schéma de processus avant l'exécution. Effectue des vérifications de base uniquement - les champs requis présents et les types primitifs correspondent. Les contraintes complexes (énumérations, modèles, références) ne sont pas appliquées par cette transmission.
--login-validity <minutes>	Seuil d’actualisation du jeton (par défaut 10).

Priorité d’entrée: --inputs <json> / --inputs @file.json > stdin > objet vide {}.

Exemples

# Run with inline JSON
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-0000-0000-0000-000000000001" \
  --release-key "e5f6a7b8-…" --inputs '{"amount":100}'

# Run with inputs from a file
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" --inputs @inputs.json

# Run with inputs piped from stdin
echo '{"amount":100}' | uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…"

# Validate before running
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" \
  --inputs '{"amount":100}' --validate

Format des données

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

Étape suivante: uip maestro flow job traces <jobKey> pour diffuser l'exécution ou uip maestro flow job status <jobKey> pour interroger.

---

Paramètres du processus de flux uip maestro

Obtenir ou mettre à jour les paramètres de runtime d'un processus.

Obtenir les paramètres du processus de flux uip maestro

Arguments

• <process-key> (obligatoire) : clé de définition du processus.

Options

• -f, --folder-key <key> (requis)

Format des données

Code: "ProcessSettingsGet", Data est l'objet des paramètres de processus.

Ensemble de paramètres de processus de flux uip maestro

Arguments

• <process-key> (requis)

Options

Option	Description
-f, --folder-key <key>	(requis) Clé de dossier.
--inputs <value>	Paramètres de la charge utile sous la forme d'une chaîne JSON, d'un chemin @file ou d'un pipeline via st din.

Format des données

Code: "ProcessSettingsSet".

variable-balises de processus de flux uip maestro

Obtenez ou mettez à jour les balises de recherche sur les variables de sortie d'un processus — lesquelles variables peuvent être utilisées pour filtrer les instances.

variable-balises du processus de flux uip maestro obtenir

Arguments

• <process-key> (requis)

Options

• -f, --folder-key <key> (requis)

Format des données

Code: "ProcessVariableTagsGet", Data est la carte variableTags du processus ({} si aucune n'est définie).

Ensemble de balises de processus de flux uip Maestro

Deux styles d'entrée mutuellement exclusifs: transmettez --inputs avec une charge utile JSON complète, ou utilisez les indicateurs conviviaux --variable/--all/--searchable/--tags/--add-tags/--remove-tags — la combinaison des deux échoue avec un Erreur.

Arguments

• <process-key> (requis)

Options

Option	Description
-f, --folder-key <key>	(requis) Clé de dossier.
--variable <name>	Nom d'une variable (sortie) à baliser. Répétable afin d'en baliser plusieurs dans un même appel.
--element-id <id>	Élément qui possède la variable — désambiguïsé lorsque le même nom apparaît sur plusieurs éléments. Uniquement valide avec un seul --variable.
--all	Appliquez la modification à chaque variable identifiable.
--searchable <bool>	Marquez la ou les variables recherchables pour le filtrage des instances (true/false).
--tags <csv>	Avancé: remplacez immédiatement les balises actuelles de la variable. La valeur vide les efface.
--add-tags <csv>	Ajoutez des balises aux balises actuelles de la variable.
--remove-tags <csv>	Supprimez les balises des balises actuelles de la variable.
--inputs <value>	Charge utile complète de balises de variables sous la forme d'une chaîne JSON, d'un chemin @file ou d'un pipeline via st din — alternative aux indicateurs ci-dessus.

Format des données

Code: "ProcessVariableTagsSet".

---

Liste des processus de flux uip Maestro

Résumé des processus de flux à l'échelle du locataire (/processes/summary?processType=Flow). Aucun argument, aucune option au-delà des variables globales.

Format des données

{
  "Code": "ProcessList",
  "Data": [
    {
      "processKey":     "…",
      "name":           "…",
      "folderKey":      "…",
      "latestVersion":  "…"
    }
  ]
}

Remarque :

L'ensemble de champs exact de chaque résumé de processus est spécifié par le runtime Maestro et peut évoluer; exécutez la commande une fois avec --output json sur un locataire avec des données pour voir les champs que vous allez utiliser, et épinglez @uipath/cli dans CI si vous analysez des champs spécifiques.

---

incidents de processus de flux uip maestro

Obtenez tous les incidents pour une définition de processus de flux spécifique (pas une instance unique).

Arguments

• <process-key> (obligatoire) : clé de définition du processus.

Options

• --folder-key <key> (obligatoire) — clé de dossier pour étendre la recherche.

Format des données

{
  "Code": "ProcessIncidents",
  "Data": [ /* array of process incidents */ ]
}

Voir uip maestro flow incident pour la forme par incident.

Diagnostic des processus de flux uip maestro

Corrélez le résumé, les incidents et les codes d'erreur d'un processus en un seul appel — une commande de triage rapide.

Arguments

• <process-key> (obligatoire) : clé de définition du processus.

Options

• --folder-key <key> (requis)

Format des données

{
  "Code": "ProcessDiagnostics",
  "Data": {
    "ProcessKey": "…",
    "FolderKey": "…",
    "Summary": { /* this process's entry from processes/summary, or null if not found */ },
    "FaultedCount": 0,
    "RunningCount": 0,
    "Incidents": [ /* array of incidents */ ],
    "IncidentCount": 0,
    "ErrorCodes": [ /* array of error code strings */ ],
    "ErrorCodeCount": 0
  }
}

Codes d'erreur des processus de flux uip Maestro

Obtenez l'ensemble unique de codes d'erreur vus dans les incidents d'un processus.

Arguments

• <process-key> (requis)

Options

• --folder-key <key> (requis)

Format des données

{
  "Code": "ProcessIncidentErrorCodes",
  "Data": ["Process.UnhandledException"]
}

Voir également

• uip maestro flow instance — inspecter et piloter les exécutions en cours d'exécution
• uip maestro flow job — traçages et statut pour une seule tâche
• uip maestro flow incident — résumés et détails des incidents
• Tâches Orchestrator, Processus Orchestrator
• Vue d’ensemble du flux