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 BPMN uip maestro

Parcourez le registre BPMN Maestro des types d'extension, des connecteurs Integration Service et des processus Orchestrator à l'aide de `uip maestro bpmn registry`.

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,
    "ProcessCountsByType": {
      "Process": 3,
      "ProcessOrchestration": 1,
      "Agent": 1,
      "Flow": 0,
      "Api": 0,
      "Function": 0,
      "CaseManagement": 0,
      "BusinessRules": 0
    },
    "FromCache": false,
    "AgeMinutes": 0,
    "CacheWritten": true,
    "Message": "Synced fresh registry"
  }
}
{
  "Code": "RegistryPullSuccess",
  "Data": {
    "ExtensionTypeCount": 48,
    "ConnectorCount": 12,
    "ProcessCount": 5,
    "ProcessCountsByType": {
      "Process": 3,
      "ProcessOrchestration": 1,
      "Agent": 1,
      "Flow": 0,
      "Api": 0,
      "Function": 0,
      "CaseManagement": 0,
      "BusinessRules": 0
    },
    "FromCache": false,
    "AgeMinutes": 0,
    "CacheWritten": true,
    "Message": "Synced fresh registry"
  }
}

ProcessCountsByType décompose ProcessCount par type de processus découvert.

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"
      }
    ],
    "ProcessesByType": {
      "Process": 3,
      "ProcessOrchestration": 1,
      "Agent": 1,
      "Flow": 0,
      "Api": 0,
      "Function": 0,
      "CaseManagement": 0,
      "BusinessRules": 0
    }
  }
}
{
  "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"
      }
    ],
    "ProcessesByType": {
      "Process": 3,
      "ProcessOrchestration": 1,
      "Agent": 1,
      "Flow": 0,
      "Api": 0,
      "Function": 0,
      "CaseManagement": 0,
      "BusinessRules": 0
    }
  }
}

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" }
    ],
    "ProcessesByType": {
      "Process": 1,
      "ProcessOrchestration": 0,
      "Agent": 0,
      "Flow": 0,
      "Api": 0,
      "Function": 0,
      "CaseManagement": 0,
      "BusinessRules": 0
    }
  }
}
{
  "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" }
    ],
    "ProcessesByType": {
      "Process": 1,
      "ProcessOrchestration": 0,
      "Agent": 0,
      "Flow": 0,
      "Api": 0,
      "Function": 0,
      "CaseManagement": 0,
      "BusinessRules": 0
    }
  }
}

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, Intsvc.EventTrigger,...), saisissez --connection-id et --object-name pour enrichir la réponse avec les métadonnées de champ Integration Service en direct; ajoutez --operation pour sélectionner les champs d'opération à renvoyer.

Arguments​

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

Options​

ShortLongValeur (Value)DefaultDescription
—--connection-idID—ID de connexion pour l’enrichissement Integration Service. Nécessite --object-name.
—--object-namename—Nom de l’objet pour l’enrichissement Integration Service. Nécessite --connection-id.
—--operation <name>name—Opération dont les champs de demande/réponse doivent renvoyer (par ex. Create, INCIDENT_CREATED). Pour les types d’activité, elle prend par défaut la seule opération de l’objet (et la réponse répertorie les opérations disponibles lorsqu’il y en a plus d’une). Pour les types d'événements, il est obligatoire - un objet peut exposer plusieurs opérations d'événements, il n'est donc jamais déduit.

Validation​

  • --connection-id et --object-name doivent être fournis ensemble — la transmission d'un seul échoue avec IS enrichment needs --connection-id and --object-name together (add --operation for event types). Missing: <the missing flag>.
  • --connection-id/--object-name s'appliquent uniquement aux types Intsvc.* - leur utilisation avec un type d'extension non-Intsvc échoue, en nommant Intsvc.ActivityExecution/Intsvc.EventTrigger comme exemples valides.
  • Pour un type d'extension balisé par événement (extensionTag: "uipath:event"), l'absence de --operation échoue avec Event enrichment requires --operation, pointant sur uip is activities list <connector> --triggers pour découvrir les noms d'opération valides.

Exemples​

uip maestro bpmn registry get Orchestrator.StartJob

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

# Connector activity type with a specific operation
uip maestro bpmn registry get Intsvc.ActivityExecution \
    --connection-id abc123 --object-name contacts --operation Create

# Event type — --operation is required
uip maestro bpmn registry get Intsvc.EventTrigger \
    --connection-id abc123 --object-name contacts --operation INCIDENT_CREATED

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

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

# Connector activity type with a specific operation
uip maestro bpmn registry get Intsvc.ActivityExecution \
    --connection-id abc123 --object-name contacts --operation Create

# Event type — --operation is required
uip maestro bpmn registry get Intsvc.EventTrigger \
    --connection-id abc123 --object-name contacts --operation INCIDENT_CREATED

# 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 champs --connection-id et --object-name (et, pour les types d'événements, --operation) 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, y compris lorsque Integration Service ne renvoie aucune métadonnées de champ pour l’objet/l’opération en question, un avertissement est consigné et ISEnrichment est omis; la spécification de base est toujours retournée.

  • uip maestro bpmn pack — compresser un projet Maestro; le registre indique les types d'extension que vous pouvez utiliser.
  • uip maestro bpmn 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