UIP ou tâches

Syntaxe et options pour `uip ou Jobs`, qui démarrent, arrêtent, redémarrent et inspectent les exécutions de processus Orchestrator et leurs journaux.

uip or jobs gère les exécutions de processus: lancer des tâches à partir de processus, les arrêter et les redémarrer, reprendre les tâches suspendues et inspecter les journaux, les traçages, les données de Healing Agent et l'historique de l'état. Chaque tâche est identifiée par une clé GUID qui est unique au niveau global — la plupart des verbes résolvent automatiquement le dossier à partir de la clé.

Synthèse

uip or jobs <verb> [options]

Verbes

Verbe	Objectif
list	Répertoriez les tâches, éventuellement limitées à un dossier et filtrées par état, processus, source ou plage de temps.
get	Récupérer une tâche par clé, y compris les arguments d'entrée/sortie et (pour les tâches en attente) des raisons de diagnostic.
start	Démarrer une ou plusieurs tâches d'un processus; en option, attendre l'achèvement et télécharger la sortie.
stop	Arrêtez petit à petit ou forcez l’arrêt d’une ou plusieurs tâches en cours d’exécution/en attente.
restart	Créez une nouvelle tâche à partir d'une tâche défaillante ou arrêtée.
resume	Reprenez une tâche suspendue, éventuellement avec des arguments d'entrée mis à jour.
logs	Récupérer les journaux d'exécution du robot pour une tâche; filtrer par niveau ou exporter au format CSV.
traces	Récupérer les traçages d'exécution LlmOps pour une tâche agentique (type Agent).
healing-data	Téléchargez les données de récupération de Healing Agent (capture d'écran, données d'IU, journaux) sous forme de ZIP.
history	Affichez les transitions d'état d'une tâche.

liste UIP ou tâches

List jobs in a folder, or across every accessible folder with --all-folders. Returns job key, state, process name, timing, and machine info. Exactly one of a folder selector (--folder-path/--folder-key) or --all-folders is required — the command refuses to run with both or with neither.

Options

Short	Long	Valeur (Value)	Default	Description
—	--folder-path	Chemin d'accès	—	Scope to a folder by path (for example, Shared). Provide this, --folder-key, or --all-folders.
—	--folder-key	GUID	—	Étendue à un dossier par clé.
—	--all-folders	Drapeau	désactivé	List jobs across every accessible folder. Mutually exclusive with the folder selectors.
—	--state	ENUM	—	Pending, Running, Successful, Faulted, Stopped, Stopping, Suspended, Resumed, Terminating
—	--process-name	text	—	Contient une correspondance sur le nom du processus (version).
—	--source	ENUM	—	Filtrez par type de source de tâche (par exemple, Manual, Schedule, Queue, Agent).
—	--created-after	ISO 8601	—	Tâches créées à partir de cette date/heure.
—	--created-before	ISO 8601	—	Tâches créées strictement avant cette date/l'heure.
—	--started-after	ISO 8601	—	Les tâches ont commencé à partir de cette date/heure.
—	--started-before	ISO 8601	—	Les tâches ont commencé strictement avant cette date/l'heure.
—	--ended-after	ISO 8601	—	Les tâches se sont terminées à partir de cette date/heure.
—	--ended-before	ISO 8601	—	Les tâches se sont terminées strictement avant cette date/l’heure.
-l	--limit	Numérique	50	Taille de la page.
—	--offset	Numérique	0	Nombre d'ignorers.
—	--sort-by	Champ	Id desc	Expression de tri OData.
—	--all-fields	Drapeau	désactivé	Renvoyez la charge utile complète de l'API au lieu du résumé sélectionné.

Exemples

# The 50 most recent jobs across every accessible folder
uip or jobs list --all-folders

# Running jobs in a specific folder, newest first
uip or jobs list --folder-path "Shared" --state Running

# Pull only job keys and states, script-friendly
uip or jobs list --all-folders --state Faulted --limit 200 \
    --output-filter 'Data[].{key:Key, state:State}'

Format des données (--sortie json)

{
  "Code": "JobList",
  "Data": [
    {
      "Key": "b2c3d4e5-0000-0000-0000-000000000001",
      "State": "Running",
      "ProcessName": "InvoiceProcessing",
      "ReleaseKey": "c3d4e5f6-0000-0000-0000-000000000001",
      "Source": "Manual",
      "Type": "Unattended",
      "Priority": "Normal",
      "Machine": "prod-worker-01",
      "MachineKey": "a1b2c3d4-0000-0000-0000-000000000001",
      "StartTime": "2025-04-15T10:30:00Z",
      "EndTime": "",
      "CreationTime": "2025-04-15T10:29:55Z"
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "HasMore": false }
}

uip ou tâches obtenir

Récupérez une tâche par clé GUID. Renvoie l'état, les arguments d'entrée/de sortie, le minutage, les informations sur la machine et les détails des erreurs si défaillant. Si l'état de la tâche est Pending, la sortie inclut également PendingReasons (rapport de diagnostic de l'API expliquant pourquoi la tâche n'a pas commencé — disponibilité, capacité du robot, etc.). Aucun contexte de dossier n'est requis.

Si la tâche comporte une OutputFile, elle est automatiquement téléchargée dans le répertoire actuel (ou --output-dir) en tant que output-<job-key>.dat. Saisissez --no-download pour ignorer.

Arguments

Nom	Requis	Objectif
<job-key>	oui	Clé de tâche. Recherchez-le avec uip or jobs list.

Options

Short	Long	Valeur (Value)	Default	Description
—	--output-dir	Chemin d'accès	Répertoire actuel	Répertoire pour le fichier OutputFile téléchargé.
—	--no-download	Drapeau	désactivé	Ignorer le téléchargement automatique de OutputFile .
—	--all-fields	Drapeau	désactivé	Renvoyez la charge utile complète de l'API.

Exemples

uip or jobs get b2c3d4e5-0000-0000-0000-000000000001

# Skip the output-file download (useful in read-only containers)
uip or jobs get b2c3d4e5-0000-0000-0000-000000000001 --no-download

# Extract just output arguments
uip or jobs get b2c3d4e5-0000-0000-0000-000000000001 \
    --output-filter 'Data.OutputArguments'

Format des données (--sortie json)

{
  "Code": "JobGet",
  "Data": {
    "Key": "b2c3d4e5-0000-0000-0000-000000000001",
    "State": "Successful",
    "ReleaseName": "InvoiceProcessing",
    "StartTime": "2025-04-15T10:30:00Z",
    "EndTime": "2025-04-15T10:32:11Z",
    "InputArguments": "{\"invoicePath\":\"/data/inv.pdf\"}",
    "OutputArguments": "{\"result\":\"Processed\"}",
    "HostMachineName": "prod-worker-01",
    "FolderKey": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}

UIP ou tâches démarrées

Démarrez une ou plusieurs tâches d'un processus. Le <process-key> est le GUID renvoyé par uip or processes list (non packages list). Le dossier est facultatif - si ni --folder-path ni --folder-key n'est fourni, il est déduit du processus.

Utilisez uip or packages entry-points pour voir les schémas d'arguments d'entrée/de sortie d'une version de package avant de commencer.

Arguments

Nom	Requis	Objectif
<process-key>	oui	Clé de processus (version) de uip or processes list.

Options

Identité et locataire

Short	Long	Valeur (Value)	Default	Description
—	--folder-path	Chemin d'accès	déduit	Chemin d'accès au dossier; déduit du processus s'il est omis.
—	--folder-key	GUID	déduit	Clé de dossier; déduit du processus s'il est omis.

Stratégie d’exécution

Short	Long	Valeur (Value)	Default	Description
—	--strategy	ENUM	ModernJobsCount	ModernJobsCount, All, Specific, JobsCount.
—	--jobs-count	Numérique	1	Le nombre de tâches à créer (pour les stratégies basées sur le comptage).
—	--runtime-type	ENUM	configuration des dossiers	Unattended, Headless, Serverless, NonProduction, Development, TestAutomation
—	--job-priority	ENUM	—	Low, Normal, High
—	--reference	text	—	Chaîne de référence de forme libre stockée sur la tâche.
—	--run-as-me	Drapeau	désactivé	Exécuter sous l'identité de l'appelant.
—	--healing-agent	Drapeau	désactivé	Enable Healing Agent (Autopilot for Robots) for this run, to recover from selector failures and similar runtime errors. Tenant-level Autopilot must already be enabled.
—	--user-keys	CSV	—	GUID utilisateur à exécuter en tant que (résolu par des Unattended Robots).
—	--machine-keys	CSV	—	GUID de la machine à cibler.

Entrée et pièces jointes

Short	Long	Valeur (Value)	Default	Description
—	--input-arguments	JSON	—	Charge utile JSON intégrée. Déchargement automatique vers InputFile au-dessus de 10 000 caractères. Capture mutuellement exclusive avec --input-file
—	--input-file	Chemin d'accès	—	Téléchargez un fichier en tant que InputFile de la tâche. Capture mutuellement exclusive avec --input-arguments
—	--attachment	[name=]path	—	Chargez un fichier et joignez-le. Répétable. --attachment ./doc.pdf noms automatiques à partir du nom du fichier; --attachment invoice=./report.pdf définit un nom explicite.
—	--attachment-id	GUID	—	Joignez une pièce jointe existante par ID. Répétable. Recherchez des ID avec attachments list --job-key.
—	--environment-variables	text	—	Environment variables as newline-separated KEY=VALUE pairs (not JSON). Validated before submission.

En attente d’achèvement

Short	Long	Valeur (Value)	Default	Description
—	--wait-for-completion	Drapeau	désactivé	Interroger jusqu'à ce que la tâche atteigne Successful, Faulted ou Stopped.
—	--timeout	secondes	300	Temps d’attente maximal (nécessite --wait-for-completion).
—	--poll-interval	secondes	5	Intervalle d’interrogation (nécessite --wait-for-completion).
—	--output-dir	Chemin d'accès	Répertoire actuel	Où enregistrer OutputFile (nécessite --wait-for-completion).
—	--no-download	Drapeau	désactivé	Ignorer le téléchargement de OutputFile (nécessite --wait-for-completion).

Remarque :

--user-keys résout chaque GUID utilisateur vers son robot non assisté dans le dossier cible. Les types de robots Attended et AttendedStudioWeb sont filtrés - les tâches démarrées par CLI ont besoin de Robots Unattended. Si aucun Unattended Robot n'existe pour les utilisateurs dans ce dossier, la commande échoue.

Exemples

# Minimal — start one job for a process
uip or jobs start c3d4e5f6-0000-0000-0000-000000000001

# Start with input arguments and wait for completion
uip or jobs start c3d4e5f6-0000-0000-0000-000000000001 \
    --input-arguments '{"invoicePath":"/data/inv.pdf"}' \
    --wait-for-completion --timeout 600

# Upload a file as input and attach a supporting document
uip or jobs start c3d4e5f6-0000-0000-0000-000000000001 \
    --input-file ./payload.json \
    --attachment invoice=./report.pdf

Format des données (--sortie json)

Sans --wait-for-completion:

{
  "Code": "JobStarted",
  "Data": {
    "Jobs": [
      {
        "Key": "b2c3d4e5-0000-0000-0000-000000000099",
        "State": "Pending",
        "ProcessName": "InvoiceProcessing",
        "Source": "Manual",
        "Type": "Unattended",
        "Priority": "Normal",
        "Machine": "",
        "StartTime": "",
        "EndTime": "",
        "CreationTime": "2025-04-15T10:29:55Z"
      }
    ]
  }
}

Avec --wait-for-completion, le Code est JobCompleted (ou JobFaulted en cas d'échec) et Data a la même forme que jobs get plus un champ Duration . Si la tâche est défaillante, le processus se termine avec le code 1.

Remplacements du code de sortie spécifiques aux verbes

• --wait-for-completion + la tâche se termine dans Faulted: quitte 1 même si la commande a réussi à observer le résultat.
• --wait-for-completion + délai d’attente atteint: quitte 1 avec la clé de tâche actuelle dans Instructions afin que vous puissiez interroger avec jobs get

arrêt de l’UIP ou des tâches

Arrêtez une ou plusieurs tâches en cours d'exécution ou en attente. Avec une seule clé, respecte --strategy (SoftStop ou Kill). Avec plusieurs clés, toujours forcer l’arrêt via l’API en bloc — --strategy est ignoré dans ce cas. Aucun contexte de dossier nécessaire; résolu à partir de la première clé de tâche.

Arguments

Nom	Requis	Objectif
<job-keys...>	oui	Une ou plusieurs clés de tâche.

Options

Short	Long	Valeur (Value)	Default	Description
—	--strategy	ENUM	SoftStop	SoftStop (gratuit) ou Kill (immédiat). S'applique uniquement aux arrêts à clé unique.

Exemples

uip or jobs stop b2c3d4e5-0000-0000-0000-000000000001
uip or jobs stop b2c3d4e5-0000-0000-0000-000000000001 --strategy Kill
uip or jobs stop key-1 key-2 key-3   # bulk force-stop

Format des données (--sortie json)

Clé unique:

{
  "Code": "JobStopped",
  "Data": {
    "JobKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "Strategy": "SoftStop",
    "Status": "Stop requested"
  }
}

Plusieurs clés renvoient Code: "JobsStopped" avec JobKeys, Strategy: "Kill (force stop)" et une chaîne Status .

Redémarrage de l’UIP ou des tâches

Créez une nouvelle tâche à partir d'une tâche défaillante ou arrêtée. Le dossier est résolu à partir de la clé de tâche.

Arguments

Nom	Requis	Objectif
<job-key>	oui	Clé de tâche à redémarrer.

Options

Short	Long	Valeur (Value)	Default	Description

Exemples

uip or jobs restart b2c3d4e5-0000-0000-0000-000000000001
uip or jobs restart b2c3d4e5-0000-0000-0000-000000000001 --output-filter 'Data.Key'

Format des données (--sortie json)

{
  "Code": "JobRestarted",
  "Data": {
    "Key": "b2c3d4e5-0000-0000-0000-000000000050",
    "State": "Pending",
    "ProcessName": "InvoiceProcessing",
    "Status": "Restart requested"
  }
}

UIP ou tâches reprises

Reprenez une tâche suspendue. Les tâches sont suspendues lorsqu’elles utilisent l’activité Suspend dans un workflow de longue durée. Vous pouvez éventuellement transmettre un nouveau --input-arguments pour continuer avec les données mises à jour.

Arguments

Nom	Requis	Objectif
<job-key>	oui	Clé de tâche à reprendre.

Options

Short	Long	Valeur (Value)	Default	Description
—	--input-arguments	JSON	—	Arguments d’entrée de remplacement.

Exemples

uip or jobs resume b2c3d4e5-0000-0000-0000-000000000001
uip or jobs resume b2c3d4e5-0000-0000-0000-000000000001 \
    --input-arguments '{"approved":true}'

Format des données (--sortie json)

{
  "Code": "JobResumed",
  "Data": {
    "Key": "b2c3d4e5-0000-0000-0000-000000000001",
    "State": "Resumed",
    "ProcessName": "ApprovalFlow",
    "Status": "Resume requested"
  }
}

journaux UiP ou de tâches

Récupérer les journaux d'exécution du robot pour une tâche. Les journaux sont renvoyés en premier. Utilisez --level pour filtrer par gravité. Avec --export, les journaux sont exportés côté serveur vers CSV et téléchargés lorsqu'ils sont prêts.

Arguments

Nom	Requis	Objectif
<job-key>	oui	Clé de tâche. Validé en tant qu'UUID avant tout appel d'API.

Options

Short	Long	Valeur (Value)	Default	Description
—	--level	ENUM	—	Fatal, Error, Warning, Info, Trace
-l	--limit	Numérique	50	Taille de la page.
—	--offset	Numérique	0	Nombre d'ignorers.
—	--export	Drapeau	désactivé	Exportez au format CSV via l'API d'exportation côté serveur.
-o	--output	Chemin d'accès	robot-logs-<job-key>.csv	Chemin du fichier CSV de sortie. Uniquement avec --export.

Exemples

uip or jobs logs b2c3d4e5-0000-0000-0000-000000000001 --level Error --limit 100
uip or jobs logs b2c3d4e5-0000-0000-0000-000000000001 --export -o ./run.csv
uip or jobs logs b2c3d4e5-0000-0000-0000-000000000001 \
    --level Error --output-filter 'Data[].Message'

Format des données (--sortie json)

Mode en ligne:

{
  "Code": "JobLogs",
  "Data": [
    {
      "Level": "Error",
      "TimeStamp": "2025-04-15T10:31:02Z",
      "Message": "Selector not found: ctrl[name='submit']"
    }
  ]
}

--export génère Code: "JobLogsExported" avec JobKey, FileName, Size et ExportId.

traçages uip ou de tâches

Récupérer les traçages d'exécution LlmOps pour une tâche agentique — interactions LLM, appels d'outils et décisions de l'agent. Uniquement disponible pour les processus de type Agent. Le dossier est résolu à partir de la clé de tâche.

Arguments

Nom	Requis	Objectif
<job-key>	oui	Clé de tâche.

Options

Short	Long	Valeur (Value)	Default	Description

Exemples

uip or jobs traces b2c3d4e5-0000-0000-0000-000000000001
uip or jobs traces b2c3d4e5-0000-0000-0000-000000000001 \
    --output-filter 'Data.messages'

Format des données (--sortie json)

La charge utile d'API brute est transmise inchangée sous Data:

{
  "Code": "JobTraces",
  "Data": { "...": "raw LlmOps trace payload" }
}

uip ou tâches Healing-data

Téléchargez les données de récupération de healing-agent (Autopilot pour Robots) sous forme de ZIP: captures d'écran, données d'éléments d'IU et journaux de récupération. Uniquement disponible pour les tâches où Healing Agent était actif. La commande déclenche une exportation asynchrone, interroge l'API d'exportation jusqu'à ce qu'elle se termine, puis télécharge le ZIP obtenu.

Arguments

Nom	Requis	Objectif
<job-key>	oui	Clé de tâche.

Options

Short	Long	Valeur (Value)	Default	Description
—	--directory-prefix	préfixe	—	Le filtre de préfixe du chemin a été appliqué aux fichiers exportés.
-o	--output	Chemin d'accès	healing-agent-data-<job-key>.zip	Chemin du fichier ZIP de sortie.

Exemples

uip or jobs healing-data b2c3d4e5-0000-0000-0000-000000000001
uip or jobs healing-data b2c3d4e5-0000-0000-0000-000000000001 \
    -o ./recovery.zip
uip or jobs healing-data b2c3d4e5-0000-0000-0000-000000000001 \
    --output-filter 'Data.FileName'

Format des données (--sortie json)

{
  "Code": "JobHealingData",
  "Data": {
    "JobKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "FileName": "healing-agent-data-b2c3d4e5-0000-0000-0000-000000000001.zip",
    "Size": 254318,
    "ExportId": 4711
  }
}

Remarque :

L’exportation côté serveur est interrogée jusqu’à 30 fois à des intervalles de 2 secondes (60 secondes au total). Si elle ne se termine pas dans cette fenêtre, la commande quitte 1 avec l’ID d’exportation afin que vous puissiez réessayer.

UIP ou historique des tâches

Récupérer l'historique des transitions d'état pour une tâche (Pending → Running → Successful/Faulted). Le dossier est résolu à partir de la clé de tâche.

Arguments

Nom	Requis	Objectif
<job-key>	oui	Clé de tâche.

Options

Short	Long	Valeur (Value)	Default	Description

Exemples

uip or jobs history b2c3d4e5-0000-0000-0000-000000000001
uip or jobs history b2c3d4e5-0000-0000-0000-000000000001 \
    --output-filter 'Data[].{state:State, ts:Timestamp}'
uip or jobs history b2c3d4e5-0000-0000-0000-000000000001 --output table

Format des données (--sortie json)

{
  "Code": "JobHistory",
  "Data": [
    { "State": "Pending", "Timestamp": "2025-04-15T10:29:55Z", "JobId": 1001 },
    { "State": "Running", "Timestamp": "2025-04-15T10:30:00Z", "JobId": 1001 },
    { "State": "Successful", "Timestamp": "2025-04-15T10:32:11Z", "JobId": 1001 }
  ]
}

Codes de sortie

Voir Codes de sortie pour le contrat partagé. Remplacements spécifiques aux verbes:

• jobs start --wait-for-completion quitte 1 si la tâche observée se termine Faulted ou si l'attente expire.
• jobs healing-data quitte 1 si l'exportation côté serveur ne se termine pas dans les ~60 secondes.

Commandes associées

• uip or processes — gérez les liaisons de processus (version) que jobs start cible.
• uip or packages , en particulier packages entry-points pour découvrir les schémas d’arguments d’entrée/de sortie.
• uip or attachments — répertorie et télécharge les pièces jointes de tâche.
• uip or users — résolvez les noms d'utilisateur en clés pour --user-keys.
• uip or machines — résolvez les noms de machine en clés pour --machine-keys.

Voir également

• Options globales — --output, --output-filter, --log-level, --log-file.
• Sessions — la façon dont le contexte du locataire et du dossier est résolu.
• Votre premier pipeline — une présentation de bout en bout à l'aide de jobs start --wait-for-completion.