UiPath Documentation
uipath-cli
latest
false
Guide de l'utilisateur de UiPath CLI
Important :
Ce contenu a été traduit à l'aide d'une traduction automatique. La localisation du contenu nouvellement publié peut prendre 1 à 2 semaines avant d’être disponible.

tâches d’aperçus uip

Syntaxe et options pour `uip insights Jobs`, qui expose des tableaux de bord Insights prédéfinis sous forme de commandes filtrables par plage de temps et par dossier.

uip insights jobs expose les tableaux de bord Insights prédéfinis sous forme de commandes CLI. Chaque sous-commande publie dans un point de terminaison Insights dédié et renvoie la réponse brute dans l'enveloppe Code/Data standard. Les sept sous-commandes partagent la même surface de filtre (plage de temps, dossiers, processus, machines).

Synthèse​

uip insights jobs <verb> [options]
uip insights jobs <verb> [options]

Verbes​

VerbeObjectif
summaryNombre total de tâches, nombre de réussites, temps moyen de traitement.
completed-timelineTâches terminées au fil du temps, regroupées par état terminal.
uncompleted-timelineTâches non terminées (en cours d'exécution/en attente) au fil du temps.
top-failuresProcessus avec le plus d'échecs de tâche.
failures-by-reasonÉchecs de tâche regroupés par raison d'exception.
process-detailsDécomposition des tâches par processus avec le nombre par état.
failure-detailsLignes d'échec détaillées pour une enquête approfondie.

Filtres partagés​

Chaque sous-commande insights jobs accepte les mêmes options:

DrapeauDescription
--time-range <minutes>Plage de temps relative en minutes (par ex. 1440 pour 1 jour, 43200 pour 30 jours).
--started-after <epoch-ms>Heure de début absolue en millisecondes d’époque Unix.
--started-before <epoch-ms>Heure de fin absolue en millisecondes d’époque Unix.
--folder-key <guid>Filtre de clé de dossier (répétable).
--process-name <name>Filtre de nom de processus (répétable).
--machine-name <name>Filtre par nom de machine (répétable).
--timezone-offset <minutes>Décalage du fuseau horaire du client en minutes par rapport à l’UTC.

Une plage de temps est requise: passez --time-range, ou à la fois --started-after et --started-before ensemble. Le fait de fournir un seul élément de --started-after/--started-before est le même que de n'en fournir aucun — la commande échoue avec A time range is required. et se termine 1. La combinaison de --time-range avec la paire absolue est valide, mais le backend Insights se résout vers l'intervalle le plus court. Tous les autres filtres (--folder-key, --process-name, --machine-name, --timezone-offset) sont facultatifs; --folder-key, --process-name et --machine-name sont répétables - transmettez-les plusieurs fois pour inclure plusieurs valeurs.

Les options de nombre entier (--time-range, --started-after, --started-before, --timezone-offset) sont validées au moment de l'analyse; une valeur non numérique échoue rapidement avec un message nommant l'indicateur.

Résumé des tâches UIP Insights​

Nombre total de tâches, nombre de réussites et temps moyen de traitement.

Options​

Exemples​

uip insights jobs summary --time-range 1440

uip insights jobs summary \
    --process-name Invoicing --process-name Payroll --time-range 43200

uip insights jobs summary --time-range 1440 \
    --output-filter 'Data.{total:TotalJobs, success:SuccessfulJobs}'
uip insights jobs summary --time-range 1440

uip insights jobs summary \
    --process-name Invoicing --process-name Payroll --time-range 43200

uip insights jobs summary --time-range 1440 \
    --output-filter 'Data.{total:TotalJobs, success:SuccessfulJobs}'

Code de réponse: InsightsJobsSummary.

Chronologie du processus UiPath Insights - Tâches terminées​

Tâches terminées au fil du temps, regroupées par état de tâche de terminal.

Options​

Exemples​

uip insights jobs completed-timeline --time-range 10080

uip insights jobs completed-timeline \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001 \
    --time-range 1440 --timezone-offset -480

uip insights jobs completed-timeline \
    --started-after 1714003200000 --started-before 1714608000000
uip insights jobs completed-timeline --time-range 10080

uip insights jobs completed-timeline \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001 \
    --time-range 1440 --timezone-offset -480

uip insights jobs completed-timeline \
    --started-after 1714003200000 --started-before 1714608000000

Code de réponse: InsightsJobsCompletedTimeline.

Tâches uip insights non terminées​

Tâches non terminées (en cours d'exécution/en attente) au fil du temps.

Options​

Exemples​

uip insights jobs uncompleted-timeline --time-range 1440

uip insights jobs uncompleted-timeline \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001 \
    --folder-key f0f0f0f0-0000-0000-0000-000000000002

uip insights jobs uncompleted-timeline --time-range 1440 \
    --machine-name prod-worker-01
uip insights jobs uncompleted-timeline --time-range 1440

uip insights jobs uncompleted-timeline \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001 \
    --folder-key f0f0f0f0-0000-0000-0000-000000000002

uip insights jobs uncompleted-timeline --time-range 1440 \
    --machine-name prod-worker-01

Code de réponse: InsightsJobsUncompletedTimeline.

uip insights - tâches top-échecs​

Processus avec le plus d'échecs dans la fenêtre de filtre.

Options​

Exemples​

uip insights jobs top-failures --time-range 43200

uip insights jobs top-failures --time-range 10080 \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001

uip insights jobs top-failures --time-range 43200 \
    --output-filter 'Data[].{process:ProcessName, count:FailureCount}'
uip insights jobs top-failures --time-range 43200

uip insights jobs top-failures --time-range 10080 \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001

uip insights jobs top-failures --time-range 43200 \
    --output-filter 'Data[].{process:ProcessName, count:FailureCount}'

Code de réponse: InsightsJobsTopFailures.

uip insights - Échecs des tâches par raison​

Échecs de tâche regroupés par raison d'exception.

Options​

Exemples​

uip insights jobs failures-by-reason --time-range 43200

uip insights jobs failures-by-reason --time-range 1440 \
    --process-name Invoicing

uip insights jobs failures-by-reason --time-range 10080 \
    --output-filter 'Data[].{reason:Reason, count:Count}'
uip insights jobs failures-by-reason --time-range 43200

uip insights jobs failures-by-reason --time-range 1440 \
    --process-name Invoicing

uip insights jobs failures-by-reason --time-range 10080 \
    --output-filter 'Data[].{reason:Reason, count:Count}'

Code de réponse: InsightsJobsFailuresByReason.

tâches uip insights - détails du processus​

Décomposition des tâches par processus avec le nombre par état.

Options​

Exemples​

uip insights jobs process-details --process-name Invoicing --time-range 1440

uip insights jobs process-details --time-range 43200 \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001

uip insights jobs process-details \
    --process-name Invoicing --process-name Payroll \
    --started-after 1714003200000 --started-before 1714608000000
uip insights jobs process-details --process-name Invoicing --time-range 1440

uip insights jobs process-details --time-range 43200 \
    --folder-key f0f0f0f0-0000-0000-0000-000000000001

uip insights jobs process-details \
    --process-name Invoicing --process-name Payroll \
    --started-after 1714003200000 --started-before 1714608000000

Code de réponse: InsightsJobsProcessDetails.

tâches uip insights - détails de l’échec​

Lignes d'échec détaillées pour une enquête approfondie.

Options​

Exemples​

uip insights jobs failure-details --process-name Invoicing --time-range 1440

uip insights jobs failure-details --time-range 10080 \
    --machine-name prod-worker-01

uip insights jobs failure-details --time-range 1440 \
    --output-filter 'Data[].{job:JobKey, reason:Reason, ts:StartTime}'
uip insights jobs failure-details --process-name Invoicing --time-range 1440

uip insights jobs failure-details --time-range 10080 \
    --machine-name prod-worker-01

uip insights jobs failure-details --time-range 1440 \
    --output-filter 'Data[].{job:JobKey, reason:Reason, ts:StartTime}'

Code de réponse: InsightsJobsFailureDetails.

Format des données (--sortie json)​

Toutes les commandes renvoient la même enveloppe. Le champ Data porte la réponse Insights spécifique au point de terminaison - la structure interne diffère par point de terminaison mais l'enveloppe est uniforme.

{
  "Code": "InsightsJobsSummary",
  "Data": { "...": "endpoint-specific payload" }
}
{
  "Code": "InsightsJobsSummary",
  "Data": { "...": "endpoint-specific payload" }
}
Remarque :

La structure interne exacte de chaque variante de réponse est spécifiée par l’API Insights et n’est pas énumérée ici. Exécutez la commande une fois avec --output json à l'encontre d'un locataire contenant des données pour voir le schéma que vous utiliserez, et épinglez @uipath/cli dans le CI si vous analysez des champs spécifiques.

Comportement des erreurs​

  • Authentification manquante. La CLI envoie Failure avec Instructions: "Run 'uip login' to authenticate first." et quitte 1.
  • Erreurs backend (4xx/5xx d'Insights). Failure avec Instructions: "Check your authentication, tenant, and filter parameters." et quitte 1.
  • uip insights — Présentation de l'outil.
  • uip login — session utilisée pour chaque appel Insights.
  • uip traces — Étendues d'observabilité LLM, une surface d'observabilité orthogonale.

Voir également​

Cette page vous a-t-elle été utile ?

Connecter

Besoin d'aide ? Assistance

Vous souhaitez apprendre ? UiPath Academy

Vous avez des questions ? UiPath Forum

Rester à jour