UiPath Documentation
uipath-cli
latest
false
Guía del usuario de UiPath CLI
Importante :
Este contenido se ha traducido mediante traducción automática. La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.

Registro bpmn de uip maestro

Explora el registro de Maestro BPMN de tipos de extensión, conectores de Integration Service y procesos de Orchestrator utilizando `uip maestro bpmn registration`.

uip maestro bpmn registry y busca en el registro BPMN de Maestro : un catálogo de los tipos de extensión BPMN, conectores de Integration Service y procesos descubiertos por Orchestrator contra los que Maestro puede crear. Los agentes (humanos o no) lo utilizan para descubrir qué tipos de extensión existen, buscar sus formas y enriquecer los tipos de conectores con metadatos de Integration Service en vivo antes de generar BPMN.

Sin inicio de sesión, solo están disponibles los tipos de extensión integrados (OOTB). Inicia sesión para ver los conectores y procesos descubiertos desde Integration Service y Orchestrator.

Sinopsis​

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

Flujo de trabajo típico:

  1. uip login opcional: los tipos OOTB funcionan sin conexión).
  2. uip maestro bpmn registry pull : sincroniza el registro en la caché local.
  3. uip maestro bpmn registry search <keyword> : busca una entrada.
  4. uip maestro bpmn registry get <extensionType> — inspecciona la especificación completa.

Verbos​

VerboPropósito
pullObtener y almacenar en caché el registro (BPMN estático + recursos descubiertos).
listEnumera los tipos de extensiones en caché y los recursos descubiertos.
searchEncuentre entradas por palabra clave en tipos de extensión, conectores y procesos.
getObtener la especificación completa para un solo tipo de extensión; enriquecer opcionalmente con metadatos de IS.

Todos los verbos respetan las opciones globales (--output, --output-filter, --log-level, --log-file). Los códigos de salida siguen el contrato estándar.

extracción de registro de uip maestro bpmn​

Obtener y almacenar en caché el registro. De forma predeterminada, devuelve los resultados almacenados en caché cuando están nuevos; pase --force para volver a sincronizar.

Opciones​

CortoLargoValorPredeterminadoDescripción
-f--forceMarcaDesactivadoIgnora la caché y vuelve a recuperar.

Ejemplos​

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

Forma de datos (--json de salida)​

{
  "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 desglosa ProcessCount por tipo de proceso descubierto.

Cuando se utiliza la caché, FromCache es true, AgeMinutes informa de la antigüedad de la caché y Message es Using cached registry (age: <n>m).

lista de registro de uip maestro bpmn​

Enumera los tipos de extensiones en caché y los recursos descubiertos. El límite predeterminado es 30; aprobar --limit -1 para todos.

Opciones​

CortoLargoValorPredeterminadoDescripción
-l--limitNúmero30Número de tipos de extensión que se devolverán; -1 para todos.

Ejemplos​

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

Forma de datos (--json de salida)​

{
  "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 el resultado se trunca, se escribe una nota Showing first <n> of <total> extension types en los registros.

Busca en el registro por palabra clave en los ID de tipo de extensión, etiquetas, nombres de conectores y nombres de procesos. La palabra clave coincide sin distinguir entre mayúsculas y minúsculas.

Argumentos​

NombreObligatorioPropósito
<keyword>SíTérmino de búsqueda.

Ejemplos​

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

Forma de datos (--json de salida)​

{
  "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
    }
  }
}

Obtener registro de uip maestro bpmn​

Obtenga la especificación completa para un solo tipo de extensión. Para los tipos de conector (Intsvc.ActivityExecution, Intsvc.WaitForEvent, Intsvc.EventTrigger, …), pasa tanto --connection-id como --object-name para enriquecer la respuesta con metadatos de campo de Integration Service en vivo; añade --operation para seleccionar qué campos de operación devolver.

Argumentos​

NombreObligatorioPropósito
<extensionType>SíIdentificador de tipo de extensión (por ejemplo, Orchestrator.StartJob).

Opciones​

CortoLargoValorPredeterminadoDescripción
—--connection-idID—ID de conexión para el enriquecimiento de Integration Service. Requiere --object-name.
—--object-namename—Nombre de objeto para el enriquecimiento de Integration Service. Requiere --connection-id.
—--operation <name>name—Operación cuyos campos de solicitud/respuesta devolver (p. ej. Create, INCIDENT_CREATED). Para los tipos de actividad, el valor predeterminado es la única operación del objeto (y la respuesta enumera las operaciones disponibles cuando hay más de una). Para los tipos de eventos es obligatorio : un objeto puede exponer varias operaciones de eventos, por lo que nunca se infiere.

Validación​

  • --connection-id y --object-name deben proporcionarse juntos: pasar solo uno falla con IS enrichment needs --connection-id and --object-name together (add --operation for event types). Missing: <the missing flag>.
  • --connection-id/--object-name solo se aplican a los tipos Intsvc.*: utilizarlos contra un tipo de extensión que no seaIntsvc falla, nombrando Intsvc.ActivityExecution/Intsvc.EventTrigger como ejemplos válidos.
  • Para un tipo de extensión etiquetada de evento (extensionTag: "uipath:event"), omitir --operation falla con Event enrichment requires --operation, apuntando a uip is activities list <connector> --triggers para descubrir los nombres de operación válidos.

Ejemplos​

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'

Forma de datos (--json de salida)​

Respuesta 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"
    }
  }
}

Cuando se proporcionan --connection-id y --object-name (y, para los tipos de eventos, --operation) y la llamada de Integration Service tiene éxito, la respuesta también incluye un campo ISEnrichment que contiene la carga útil de metadatos en vivo. Si la llamada de enriquecimiento falla, incluso cuando Integration Service no devuelve metadatos de campo para el objeto/operación dado, se registra una advertencia y se omite ISEnrichment; se sigue devolviendo la especificación base.

  • uip maestro bpmn pack : empaqueta un proyecto de Maestro; el registro informa de los tipos de extensión que puedes utilizar.
  • uip maestro bpmn process : descubre los procesos orientados a Orchestrator que el registro cataloga.
  • uip login : inicia sesión antes de pull para ver conectores y procesos.

Ver también​

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte

¿Quiere aprender? UiPath Academy

¿Tiene alguna pregunta? Foro de UiPath

Manténgase actualizado