UiPath Documentation
uipath-cli
latest
false
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.

Guide de l'utilisateur de UiPath CLI

Registre BPMN uip maestro

uip maestro bpmn registry parcourt et recherche le registre BPMN de Maestro - un catalogue des types d'extension BPMN, des connecteurs Integration Service et des processus découverts par Orchestrator sur lesquels Maestro peut créer. Les agents (humains ou autres) l'utilisent pour découvrir les types d'extension existants, rechercher leurs formes et enrichir les types de connecteurs avec les métadonnées Integration Service en direct avant de générer le BPMN.

Sans connexion, seuls les types d’extension intégrés sont disponibles. Connectez-vous pour voir les connecteurs et les processus découverts à partir d'Integration Service et d'Orchestrator.

Synthèse

uip maestro bpmn registry <verb> [options]
uip maestro bpmn registry <verb> [options]

Workflow type:

  1. uip login (facultatif — Les types OOTB fonctionnent hors ligne).
  2. uip maestro bpmn registry pull — synchronisez le registre dans le cache local.
  3. uip maestro bpmn registry search <keyword> — recherchez une entrée.
  4. uip maestro bpmn registry get <extensionType> — inspecter l'ensemble des spécifications.

Verbes

VerbeObjectif
pullRécupérer et mettre en cache le registre (BPMN statique + ressources découvertes).
listRépertoriez les types d'extension mis en cache et les ressources découvertes.
searchRechercher des entrées par mot-clé dans les types d'extension, les connecteurs et les processus.
getObtenez les spécifications complètes pour un seul type d'extension; éventuellement enrichir avec des métadonnées IS.

Tous les verbes respectent les options globales (--output, --output-filter, --log-level, --log-file). Les codes de sortie suivent le contrat standard.

Extraction du registre BPMN uip Maestro

Récupérer et mettre le registre en cache. Par défaut, renvoie les résultats mis en cache lorsqu'ils sont nouveaux; transmettez --force pour synchroniser à nouveau.

Options

ShortLongValeur (Value)DefaultDescription
-f--forceDrapeaudésactivéIgnorez le cache et récupérez.

Exemples

uip maestro bpmn registry pull
uip maestro bpmn registry pull --force
uip maestro bpmn registry pull
uip maestro bpmn registry pull --force

Format des données (--sortie json)

{
  "Code": "RegistryPullSuccess",
  "Data": {
    "ExtensionTypeCount": 48,
    "ConnectorCount": 12,
    "ProcessCount": 5,
    "FromCache": false,
    "AgeMinutes": 0,
    "CacheWritten": true,
    "Message": "Synced fresh registry"
  }
}
{
  "Code": "RegistryPullSuccess",
  "Data": {
    "ExtensionTypeCount": 48,
    "ConnectorCount": 12,
    "ProcessCount": 5,
    "FromCache": false,
    "AgeMinutes": 0,
    "CacheWritten": true,
    "Message": "Synced fresh registry"
  }
}

Lorsque le cache est utilisé, FromCache est true, AgeMinutes indique l'ancienneté du cache et Message est Using cached registry (age: <n>m).

Liste des registres BPMN uip Maestro

Répertoriez les types d'extension mis en cache et les ressources découvertes. La limite par défaut est 30; transmettez --limit -1 pour tous.

Options

ShortLongValeur (Value)DefaultDescription
-l--limitNumérique30Nombre de types d’extension à renvoyer; -1 pour tous.

Exemples

uip maestro bpmn registry list
uip maestro bpmn registry list --limit 100
uip maestro bpmn registry list --limit -1
uip maestro bpmn registry list
uip maestro bpmn registry list --limit 100
uip maestro bpmn registry list --limit -1

Format des données (--sortie json)

{
  "Code": "RegistryListSuccess",
  "Data": {
    "ExtensionTypes": [
      {
        "ExtensionType": "Orchestrator.StartJob",
        "Label": "Start Job",
        "BpmnElement": "bpmn:ServiceTask",
        "ExtensionTag": "uipath:startJob",
        "InputPattern": "...",
        "BindingPattern": "...",
        "RequiresDiscovery": "No"
      }
    ],
    "Connectors": [
      {
        "Key": "slack",
        "Name": "Slack",
        "Connections": 2,
        "Activities": 14,
        "Triggers": 3
      }
    ],
    "Processes": [
      {
        "Name": "InvoiceProcessing",
        "ProcessKey": "c3d4e5f6-0000-0000-0000-000000000001",
        "Type": "Maestro",
        "Folder": "Shared"
      }
    ]
  }
}
{
  "Code": "RegistryListSuccess",
  "Data": {
    "ExtensionTypes": [
      {
        "ExtensionType": "Orchestrator.StartJob",
        "Label": "Start Job",
        "BpmnElement": "bpmn:ServiceTask",
        "ExtensionTag": "uipath:startJob",
        "InputPattern": "...",
        "BindingPattern": "...",
        "RequiresDiscovery": "No"
      }
    ],
    "Connectors": [
      {
        "Key": "slack",
        "Name": "Slack",
        "Connections": 2,
        "Activities": 14,
        "Triggers": 3
      }
    ],
    "Processes": [
      {
        "Name": "InvoiceProcessing",
        "ProcessKey": "c3d4e5f6-0000-0000-0000-000000000001",
        "Type": "Maestro",
        "Folder": "Shared"
      }
    ]
  }
}

Si le résultat est tronqué, une note Showing first <n> of <total> extension types est écrite dans les journaux.

Recherchez le registre par mot-clé dans les ID de type d'extension, les libellés, les noms de connecteur et les noms de processus. Le mot-clé correspond de manière insensible à la casse.

Arguments

NomRequisObjectif
<keyword>ouiTermeRecherche.

Exemples

uip maestro bpmn registry search connector
uip maestro bpmn registry search queue
uip maestro bpmn registry search slack
uip maestro bpmn registry search agent
uip maestro bpmn registry search connector
uip maestro bpmn registry search queue
uip maestro bpmn registry search slack
uip maestro bpmn registry search agent

Format des données (--sortie json)

{
  "Code": "RegistrySearchSuccess",
  "Data": {
    "ExtensionTypes": [
      {
        "ExtensionType": "Intsvc.ActivityExecution",
        "Label": "Execute Activity",
        "BpmnElement": "bpmn:ServiceTask",
        "ExtensionTag": "uipath:activityExecution",
        "InputPattern": "...",
        "BindingPattern": "...",
        "RequiresDiscovery": "Yes"
      }
    ],
    "Connectors": [
      { "Key": "slack", "Name": "Slack", "Connections": 2, "Activities": 14, "Triggers": 3 }
    ],
    "Processes": [
      { "Name": "SlackNotifier", "ProcessKey": "c3d4e5f6-0000-0000-0000-000000000002", "Type": "Maestro" }
    ]
  }
}
{
  "Code": "RegistrySearchSuccess",
  "Data": {
    "ExtensionTypes": [
      {
        "ExtensionType": "Intsvc.ActivityExecution",
        "Label": "Execute Activity",
        "BpmnElement": "bpmn:ServiceTask",
        "ExtensionTag": "uipath:activityExecution",
        "InputPattern": "...",
        "BindingPattern": "...",
        "RequiresDiscovery": "Yes"
      }
    ],
    "Connectors": [
      { "Key": "slack", "Name": "Slack", "Connections": 2, "Activities": 14, "Triggers": 3 }
    ],
    "Processes": [
      { "Name": "SlackNotifier", "ProcessKey": "c3d4e5f6-0000-0000-0000-000000000002", "Type": "Maestro" }
    ]
  }
}

Obtenir le registre bpmn uip maestro

Obtenez les spécifications complètes d’un type d’extension unique. Pour les types de connecteur (Intsvc.ActivityExecution, Intsvc.WaitForEvent, …), saisissez --connection-id et --object-name pour enrichir la réponse avec les métadonnées de champ Integration Service en direct.

Arguments

NomRequisObjectif
<extensionType>ouiIdentificateur de type d'extension (par exemple, Orchestrator.StartJob).

Options

ShortLongValeur (Value)DefaultDescription
--connection-idIDID de connexion pour l’enrichissement Integration Service. Nécessite --object-name.
--object-namenameNom de l’objet pour l’enrichissement Integration Service. Nécessite --connection-id.

Exemples

uip maestro bpmn registry get Orchestrator.StartJob

# Connector extension type enriched with live IS metadata
uip maestro bpmn registry get Intsvc.ActivityExecution \
    --connection-id abc123 --object-name contacts

# Just the field names
uip maestro bpmn registry get Orchestrator.StartJob \
    --output-filter 'Data.ExtensionType'
uip maestro bpmn registry get Orchestrator.StartJob

# Connector extension type enriched with live IS metadata
uip maestro bpmn registry get Intsvc.ActivityExecution \
    --connection-id abc123 --object-name contacts

# Just the field names
uip maestro bpmn registry get Orchestrator.StartJob \
    --output-filter 'Data.ExtensionType'

Format des données (--sortie json)

Réponse de base:

{
  "Code": "RegistryGetSuccess",
  "Data": {
    "ExtensionType": {
      "extensionType": "Orchestrator.StartJob",
      "label": "Start Job",
      "bpmnElement": "bpmn:ServiceTask",
      "extensionTag": "uipath:startJob"
    }
  }
}
{
  "Code": "RegistryGetSuccess",
  "Data": {
    "ExtensionType": {
      "extensionType": "Orchestrator.StartJob",
      "label": "Start Job",
      "bpmnElement": "bpmn:ServiceTask",
      "extensionTag": "uipath:startJob"
    }
  }
}

Lorsque les paramètres --connection-id et --object-name sont fournis et que l'appel Integration Service réussit, la réponse inclut également un champ ISEnrichment contenant la charge utile des métadonnées en direct. Si l'appel d'enrichissement échoue, un avertissement est consigné et ISEnrichment est omis — la spécification de base est toujours renvoyée.

  • uip maestro pack — compresser un projet Maestro; le registre indique les types d'extension que vous pouvez utiliser.
  • uip maestro process — découvrez les processus orientés Orchestrator que le registre répertorie.
  • uip login — connectez-vous avant pull pour voir les connecteurs et les processus.

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