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.

Registre d’incidents uip maestro

Parcourez et recherchez dans le registre d'activités, de déclencheurs, de connecteurs et d'autres ressources d'automatisation de Maestro Case Management à l'aide de `uip maestro case registry`.

uip maestro case registry parcourt et recherche le registre de gestion des cas — un catalogue local mis en cache des ressources d'automatisation (processus, agents, API, flux, activités/déclencheurs de connecteur, applications d'action et éventuellement les propres ressources d'une solution en cours) une définition de cas peuvent connecter des tâches. Extrayez le registre une fois par session, puis recherchez ou récupérez les ressources par identifiant lors de la création d'un incident.

Pour le sous-système uip maestro case global et comment les ressources de registre sont alimentées dans la création des tâches, consultez la vue d'ensemble.

Synthèse​

uip maestro case registry pull [-f, --force] [-s, --solution-id <solutionId>]
uip maestro case registry search [keyword] [-t, --type <type>] [-f, --filter <filter>] [--local]
uip maestro case registry list [--local]
uip maestro case registry get <identifier> [-t, --type <type>] [--connection-id <id>] [--local]
uip maestro case registry get-connector -t, --type <type> --activity-type-id <id>
uip maestro case registry get-connection -t, --type <type> --activity-type-id <id>
uip maestro case registry pull [-f, --force] [-s, --solution-id <solutionId>]
uip maestro case registry search [keyword] [-t, --type <type>] [-f, --filter <filter>] [--local]
uip maestro case registry list [--local]
uip maestro case registry get <identifier> [-t, --type <type>] [--connection-id <id>] [--local]
uip maestro case registry get-connector -t, --type <type> --activity-type-id <id>
uip maestro case registry get-connection -t, --type <type> --activity-type-id <id>

Workflow type:

  1. uip maestro case registry pull: récupère et met en cache le registre de ressources complet (exécuté une fois par session).
  2. uip maestro case registry search <keyword> — recherchez une ressource.
  3. uip maestro case registry get <identifier> — inspecter son schéma complet.
  4. uip maestro case registry get <identifier> --output-filter "Node.inputDefinition.fields" — extraire uniquement les champs d'entrée.

Concepts​

  • Types de ressources - le registre indexe 17 types de ressources: agent, process, api, processOrchestration, caseManagement, flow, action-apps, solution, plus 9 fichiers d'index de connecteur typecache-* diviser par source de catalogue (typecache-activities, typecache-triggers, typecache-packages et les variantes -external-automation-*/-external-agent-* de chacune). Ils sont conservés en tant que fichiers de cache distincts, car les catalogues sous-jacents sont disjoints; leur fusion entraînerait l’écrasement des entrées du type précédent.
  • Mode--local — search, list et get acceptent --local pour rechercher uniquement les ressources de projet frères dans la solution au lieu du cache à l'échelle du locataire. Nécessite un fichier .uipx dans le répertoire actuel ou l'un de ses deux répertoires parents; l'identifiant de get --local est la clé de ressource du frères ou son ID de projet .uipx.
  • solution ressources - le type de ressource solution est mis en cache uniquement lorsque pull est donné --solution-id <id>; rechercher/obtenir --type solution sans l'avoir extrait d'abord renvoie une suggestion explicite pour exécuter pull --solution-id d'abord.
  • Enrichissement du connecteur — get enrichit automatiquement typecache-activities/typecache-triggers correspondances avec les métadonnées du connecteur en direct (recherchées par le uiPathActivityTypeId de l'entrée) lorsque cela est possible; transmettez --connection-id pour obtenir les métadonnées de champ personnalisé spécifiques à la connexion. Cet enrichissement est ignoré en mode silencieux (pas une erreur) si la recherche échoue.
  • get-connector / get-connection — recherches de niveau inférieur par rapport à l'index TypeCache local uniquement (pas le cache des ressources générales): get-connector résout une activité/entrée de déclencheur du connecteur plus sa configuration de connecteur par --activity-type-id; get-connection effectue la même recherche, puis récupère les connexions disponibles du connecteur à partir d'Integration Service.

Extraction du registre de cas uip Maestro​

Récupérez et mettez en cache tous les types de ressources. Exécute tous les types en parallèle et signale une répartition par type, y compris celui qui a échoué.

Options​

ShortLongValeur (Value)Description
-f--forceDrapeauIgnorez le cache et récupérez chaque type de ressource.
-s--solution-id <solutionId>stringExtrayez également et mettez en cache les propres ressources de la solution donnée (type de ressource solution).

Exemple​

uip maestro case registry pull
uip maestro case registry pull

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

{
  "Result": "Success",
  "Code": "PullResourcesSuccess",
  "Data": {
    "TotalNodesCount": 128,
    "FromCache": false,
    "ResourceTypes": [
      {
        "Type": "typecache-activities",
        "NodesCount": 80,
        "FromCache": false,
        "AgeMinutes": null,
        "CacheWritten": true,
        "Info": null
      }
    ],
    "Errors": null
  }
}
{
  "Result": "Success",
  "Code": "PullResourcesSuccess",
  "Data": {
    "TotalNodesCount": 128,
    "FromCache": false,
    "ResourceTypes": [
      {
        "Type": "typecache-activities",
        "NodesCount": 80,
        "FromCache": false,
        "AgeMinutes": null,
        "CacheWritten": true,
        "Info": null
      }
    ],
    "Errors": null
  }
}

Result est "PartialSuccess, N failed" (non "Success") lorsqu'un ou plusieurs types de ressources ne parviennent pas à extraire; Errors répertorie ensuite chaque type ayant échoué avec son message d'erreur; les types extraits avec succès sont toujours mis en cache et reflétés dans ResourceTypes.

Recherchez les ressources mises en cache par mot-clé et/ou filtres de champ. Au moins une des propriétés [keyword] ou --filter est requise.

Arguments​

NomRequisObjectif
[keyword]non*Mot-clé en texte libre à rechercher.

* Il est nécessaire d'indiquer soit [keyword], --filter, soit les deux, l'absence des deux échoue avant toute recherche.

Options​

ShortLongValeur (Value)Description
-t--type <type>ENUMLimitez la recherche à un seul type de ressource. L'un des types consultables — voir Concepts pour la liste complète des 17 types (toutes les valeurs RESOURCE_TYPES sont valides ici).
-f--filter <filter>stringFiltres de champs: field=value ou field:operator=value, séparés par des virgules pour plusieurs (par exemple name:contains=Apple,category=Pipelines). Champs: name, title, description, category, connectorKey. Opérateurs: equals, contains, in, startsWith, endsWith.
—--localDrapeauRecherchez uniquement les ressources frères dans la solution. Voir Concepts.

Exemples​

uip maestro case registry search invoice
uip maestro case registry search invoice
uip maestro case registry search --filter "name:contains=Apple,category=Pipelines"
uip maestro case registry search --filter "name:contains=Apple,category=Pipelines"

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

{
  "Result": "Success",
  "Code": "ResourceSearchSuccess",
  "Data": {
    "Keyword": "invoice",
    "Filters": null,
    "Type": null,
    "Local": false,
    "ResultCount": 1,
    "Resources": [
      {
        "resourceType": "typecache-activities",
        "resource": {
          "name": "InvoiceParser",
          "uiPathActivityTypeId": "a1b2c3d4-0000-0000-0000-000000000001"
        }
      }
    ],
    "FailedTypes": null,
    "Hint": null
  }
}
{
  "Result": "Success",
  "Code": "ResourceSearchSuccess",
  "Data": {
    "Keyword": "invoice",
    "Filters": null,
    "Type": null,
    "Local": false,
    "ResultCount": 1,
    "Resources": [
      {
        "resourceType": "typecache-activities",
        "resource": {
          "name": "InvoiceParser",
          "uiPathActivityTypeId": "a1b2c3d4-0000-0000-0000-000000000001"
        }
      }
    ],
    "FailedTypes": null,
    "Hint": null
  }
}

Hint est renseigné (plutôt qu'omis) spécifiquement lorsque --type solution renvoie zéro résultat et que --local n'a pas été dépassé — il vous pointe sur registry pull --solution-id <id>. FailedTypes répertorie tous les types de ressources qui ont généré des erreurs lors de la recherche (les résultats partiels sont toujours renvoyés pour les types qui ont réussi).

Liste des incidents UIP Maestro​

Répertorie chaque ressource mise en cache, regroupée par type. N’atteint pas le réseau: reflète la pull dernière version mise en cache; exécutez pull d’abord (ou à nouveau) pour actualiser.

Options​

LongValeur (Value)Description
--localDrapeauRépertoriez uniquement les ressources frères dans la solution au lieu du cache à l’échelle du locataire. Voir Concepts.

Exemple​

uip maestro case registry list
uip maestro case registry list

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

{
  "Result": "Success",
  "Code": "ResourceListSuccess",
  "Data": {
    "ResourcesCount": 128,
    "Local": false,
    "ResourceTypes": [
      { "Type": "typecache-activities", "Count": 80 },
      { "Type": "typecache-triggers", "Count": 48 }
    ],
    "resources": []
  }
}
{
  "Result": "Success",
  "Code": "ResourceListSuccess",
  "Data": {
    "ResourcesCount": 128,
    "Local": false,
    "ResourceTypes": [
      { "Type": "typecache-activities", "Count": 80 },
      { "Type": "typecache-triggers", "Count": 48 }
    ],
    "resources": []
  }
}

--local résout la solution et analyse directement son arborescence de ressources (aucun cache impliqué); une solution manquante (aucune .uipx trouvée) est signalée comme une erreur propre plutôt qu’une liste vide.

Obtenir le registre de cas uip maestro​

Obtenez un ou plusieurs enregistrements de ressources complets par identifiant.

Arguments​

NomRequisObjectif
<identifier>ouiLes entityKey (types de processus) ou id (applications d'actions) de la ressource — voir le champ d'identification de chaque type via Concepts. Avec --local, la clé de ressource du projet frères ou l'ID de projet .uipx à la place.

Options​

ShortLongValeur (Value)Description
-t--type <type>ENUMLimitez la recherche à un type de ressource (identique à search --type).
—--connection-id <id>stringID de connexion pour les métadonnées de champ Integration Service spécifiques au connecteur (champs personnalisés). S’applique uniquement aux typecache-* correspondances d’activité/de déclencheur.
—--localDrapeauRésolution par rapport aux ressources frères dans la solution au lieu du cache du locataire. Voir Concepts.

Exemple​

uip maestro case registry get a1b2c3d4-0000-0000-0000-000000000001
uip maestro case registry get a1b2c3d4-0000-0000-0000-000000000001

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

{
  "Result": "Success",
  "Code": "ResourceGetSuccess",
  "Data": {
    "MatchCount": 1,
    "Local": false,
    "Resources": [
      {
        "ResourceType": "typecache-activities",
        "Resource": {
          "uiPathActivityTypeId": "a1b2c3d4-0000-0000-0000-000000000001",
          "name": "InvoiceParser"
        }
      }
    ]
  }
}
{
  "Result": "Success",
  "Code": "ResourceGetSuccess",
  "Data": {
    "MatchCount": 1,
    "Local": false,
    "Resources": [
      {
        "ResourceType": "typecache-activities",
        "Resource": {
          "uiPathActivityTypeId": "a1b2c3d4-0000-0000-0000-000000000001",
          "name": "InvoiceParser"
        }
      }
    ]
  }
}

Les correspondances de zéro correspondent à un échec (Code-moins d'erreur), et non une réussite vide - les Instructions de l'erreur diffèrent par mode: un --local manqué suggère de revérifier la clé de ressource ou l'ID de projet du frères via registry list --local; une erreur --type solution suggère d’exécuter d’abord pull --solution-id; tout le reste des rapports « aucune ressource trouvée».

Obtenir le connecteur du registre de cas uip maestro​

Recherchez une entrée d'activité/de déclencheur unique (et sa configuration de connecteur) directement à partir de l'index TypeCache local, en contournant la recherche de ressources générales.

Options​

ShortLongValeur (Value)RequisDescription
-t--type <type>ENUMouiIndex TypeCache dans lequel rechercher: typecache-activities, typecache-triggers, typecache-external-automation-activities, typecache-external-automation-triggers, typecache-external-agent-activities ou typecache-external-agent-triggers.
—--activity-type-id <id>stringouiLe uiPathActivityTypeId à rechercher.

Exemple​

uip maestro case registry get-connector --type typecache-activities --activity-type-id a1b2c3d4-0000-0000-0000-000000000001
uip maestro case registry get-connector --type typecache-activities --activity-type-id a1b2c3d4-0000-0000-0000-000000000001

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

{
  "Result": "Success",
  "Code": "ConnectorGetSuccess",
  "Data": {
    "Entry": {
      "uiPathActivityTypeId": "a1b2c3d4-0000-0000-0000-000000000001",
      "name": "InvoiceParser"
    },
    "Config": { "connectorKey": "uipath-connector-a" }
  }
}
{
  "Result": "Success",
  "Code": "ConnectorGetSuccess",
  "Data": {
    "Entry": {
      "uiPathActivityTypeId": "a1b2c3d4-0000-0000-0000-000000000001",
      "name": "InvoiceParser"
    },
    "Config": { "connectorKey": "uipath-connector-a" }
  }
}

Obtenir la connexion du registre de cas uip Maestro​

Recherchez une activité/un déclencheur de connecteur (même recherche que get-connector), puis récupérez ses connexions Integration Service disponibles.

Options​

ShortLongValeur (Value)RequisDescription
-t--type <type>ENUMouiMêmes choix d'index TypeCache que get-connector.
—--activity-type-id <id>stringouiLe uiPathActivityTypeId à rechercher.

Exemple​

uip maestro case registry get-connection --type typecache-activities --activity-type-id a1b2c3d4-0000-0000-0000-000000000001
uip maestro case registry get-connection --type typecache-activities --activity-type-id a1b2c3d4-0000-0000-0000-000000000001

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

{
  "Result": "Success",
  "Code": "ConnectionGetSuccess",
  "Data": {
    "Entry": { "uiPathActivityTypeId": "a1b2c3d4-0000-0000-0000-000000000001" },
    "Config": { "connectorKey": "uipath-connector-a" },
    "Connections": [
      { "id": "b2c3d4e5-0000-0000-0000-000000000001", "name": "Default" }
    ]
  }
}
{
  "Result": "Success",
  "Code": "ConnectionGetSuccess",
  "Data": {
    "Entry": { "uiPathActivityTypeId": "a1b2c3d4-0000-0000-0000-000000000001" },
    "Config": { "connectorKey": "uipath-connector-a" },
    "Connections": [
      { "id": "b2c3d4e5-0000-0000-0000-000000000001", "name": "Default" }
    ]
  }
}

Lier une entrée de tâche à une variable​

L'entrée d'une tâche est connectée à une valeur/expression littérale ou à la sortie d'une autre tâche en modifiant directement le fichier de schéma JSON de gestion des cas. Référence de champ: l'entrée d'une tâche au niveau d'un <field-path> séparé par des points (<input-name>[.<key1>[.<key2>...]] — aucun point ne définit input.value directement; chaque segment de point parcourt un niveau de propriété, par exemple body.body.body pour le corps de la requête imbriquée d'une activité de connecteur) prend soit une chaîne littérale, soit une expression avec un préfixe autorisé (=vars., =bindings., =js:, =metadata., =datafabric., =orchestrator.JobAttachments, =response) }, =result, =Error, =jsonString:), ou une expression =vars.<id> générée lors de l’extraction de la sortie d’une autre tâche. Modifiez l’entrée de tâche de caseplan.json directement pour définir l’un de ces éléments, puis exécutez uip maestro case validate <file>.

  • uip maestro case — vue d'ensemble et le reste du sous-système de gestion des cas.

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