uip es un creador de conectores

Sintaxis y opciones para los comandos de creación de conectores y ciclo de vida de Integration Service: descargar, importar, publicar y la cadena de herramientas local del `creador de conectores`.

Los conectores de Integration Service pueden crearse localmente y enviarse a un tenant. Dos capas de comandos cubren esto:

• Ciclo de vida del tenant : uip is connectors download, import, publish, publish-status. Registrados directamente en connectors (no en builder), porque hablan con un tenant y operan en conectores de diseño/autoría en lugar de en el árbol de archivos local. Documentado en esta página.
• Creación local — uip is connectors builder .... Funciona completamente en un directorio de conector local (sin llamada de tenant, excepto la prueba en vivo opcional de builder auth) para andamiar, editar y validar los archivos de un conector antes de importarlos. Dividido en cinco páginas por dominio: consulta Este recurso abarca seis páginas a continuación.

Ninguna capa toca el catálogo de solo lectura cubierto por uip is connectors (list, get, metadata, swagger, event-operations, audit-logs, export): esa página ya trata de descubrir conectores en el catálogo; este se trata de crear uno nuevo o una nueva versión de uno de tu propiedad.

Este recurso abarca seis páginas

• Esta página : conceptos y los verbos del ciclo de vida del tenant: download, import, publish, publish-status.
• Init y conector — builder init (andamio un nuevo conector), builder connector inspect/validate.
• Auth — builder auth set/get/system create/list, el esquema de autenticación del conector.
• Actividad : builder activity CRUD más sus subgrupos field, method y param : el dominio más grande, que define lo que realmente hacen las actividades del conector.
• Enganches de actividad — builder activity hook — transformaciones previas/posteriores a la solicitud de JavaScript, divididas en su propia página para la referencia de contexto de tiempo de ejecución que necesita.
• Desencadenador y estado : builder trigger create, builder state query/patch : desencadenadores impulsados por eventos y ediciones de archivos de elementos de bajo nivel.

Conceptos

• Directorio del conector : una carpeta local que contiene app/element/element.json (y archivos hermanos para actividades, autenticación, desencadenadores). Casi todos los comandos aceptan --connector-dir <path> para apuntar a uno explícitamente. Cuando se omite, la resolución sube desde el directorio actual buscando ese archivo; si no encuentra ninguno, escanea los subdirectorios inmediatos en busca de un solo conector; si aún no se encuentra, recurre al conector registrado por la última ejecución builder init en esta ubicación (.uip-connector.json). Si la resolución encuentra más de un candidato, el comando falla con Code: "connectorAmbiguous" y enumera los candidatos: pasa --connector-dir explícitamente para eliminar la ambigüedad.
• Conector de diseño frente a conector publicado : un conector en desarrollo local activo es un conector de diseño (clave con prefijo design-..., privado para su autor). publish lo promueve a un conector CUSTOM en todo el tenant visible para todos. download/import/publish/publish-status operan en este estado de diseño/publicado del lado del tenant; los siguientes verbos builder operan exclusivamente en archivos locales.
• Descubrimiento : cada grupo de comandos builder incluye una habilidad uipath-connector-builder (consulta uip skills) que se muestra automáticamente a los agentes de codificación de IA, además de un bloque --help en la mayoría de los comandos con explícito "UTILIZAR CUANDO"/"NUNCA UTILIZAR PARA" orientación: lee la propia salida --help de un comando antes de asumir su ámbito solo por el nombre.
• Flujo típico (según el propio texto builder --help de la CLI): builder init → builder auth set → builder activity create → opcionalmente builder activity hook create → opcionalmente builder trigger create → builder connector validate → uip is connectors import → uip is connectors publish.

Sinopsis

uip is connectors download <connector-key> [--connector-dir <path>] [--tenant <name>]
uip is connectors import [--connector-dir <path>] [--tenant <name>]
uip is connectors publish [--connector-dir <path>] [--version <semver>] [--connector-id <id>] [--wait [--timeout-seconds <n>]] [--tenant <name>]
uip is connectors publish-status <publish-id> [--tenant <name>]

--tenant es una opción normal y visible en los cuatro verbos del ciclo de vida.

uip es descarga de conectores

Descarga el árbol de origen editable de un conector de diseño por clave y descomprímelo localmente para editarlo.

Nota:

Utilízalo para extraer un conector de diseño para su edición local, o para arrancar una copia de trabajo de un conector que hayas importado/publicado previamente. Para leer el registro de un conector en su lugar, utiliza connectors get. Para buscar por nombre, utiliza connectors list --filter. Para exportar el zip del paquete de un elemento publicado, utiliza connectors export : una operación diferente de esta.

Argumentos

Nombre	Obligatorio	Propósito
<connector-key>	Sí	Clave de conector de diseño exacta, por ejemplo design-myorg-acmewidgets.

Opciones

Largo	Valor	Descripción
--connector-dir <path>	Ruta	Directorio de destino para el origen desempaquetado. El valor predeterminado es el directorio actual.
--tenant <name>	name	Anula el tenant para las llamadas a la API.

Ejemplo

uip is connectors download design-myorg-acmewidgets --connector-dir ./pulled

Forma de datos (--json de salida)

{
  "Code": "ConnectorDownloaded",
  "Data": {
    "Id": 123,
    "Key": "design-myorg-acmewidgets",
    "ConnectorRoot": "/work/pulled/periodic-design-myorg-acmewidgets"
  }
}

uip es la importación de conectores

Empaqueta el conector local en un zip y créalo o actualízalo en el tenant por clave: creado la primera vez, actualizado en cada ejecución posterior.

Nota:

Utilízalo para publicar los cambios del conector local en un tenant, o para crear un conector de tenant desde un directorio local por primera vez. Para descargar o buscar conectores de tenant, utiliza connectors download / connectors list.

Argumentos

Nada.

Opciones

Largo	Valor	Descripción
--connector-dir <path>	Ruta	Directorio del conector, o cualquier elemento principal de app/element/element.json. El valor predeterminado es el directorio actual.
--tenant <name>	name	Anula el tenant para las llamadas a la API.

Ejemplo

uip is connectors import --connector-dir ./my-acme-connector

Forma de datos (--json de salida)

{
  "Code": "ConnectorImported",
  "Data": {
    "Id": 123,
    "Key": "design-myorg-acmewidgets",
    "Name": "Acme Widgets",
    "Operation": "Created"
  }
}

Operation es "Created" la primera vez que se importa una clave de conector determinada, "Updated" en cada importación posterior.

UIP es publicación de conectores

Promocionar un conector de diseño a un conector CUSTOM para todo el tenant. Dispara y olvida de forma predeterminada: devuelve un PublishId para sondear con publish-status; pase --wait para sondear internamente en su lugar.

Nota:

Utilízalo después de que connectors import tenga éxito, para que el conector sea visible para todos los usuarios del tenant, o para volver a publicar una nueva versión de un conector ya publicado (publicar element-metadata.json:latestVersion primero). Esto no envía los cambios del archivo local a un tenant, connectors import. publish solo funciona en lo que ya se ha importado.

Argumentos

Nada.

Opciones

Largo	Valor	Descripción
--connector-dir <path>	Ruta	Ruta al directorio del conector. Mismo orden de resolución que los conceptos anteriores.
--version <semver>	Segundo	Anula la versión de element-metadata.json:latestVersion. Rara vez es necesario.
--connector-id <id>	Entero	Omite la búsqueda de obtención por clave con un ID numérico explícito. Rara vez es necesario.
--wait	Marca	Estado de la encuesta hasta SUCCESS/FAILURE/timeout en lugar de volver inmediatamente.
--timeout-seconds <seconds>	Entero	Tiempo de espera de sondeo cuando se establece --wait. Predeterminado 600 (10 minutos).
--tenant <name>	name	Utilice la autenticación de este tenant en lugar del valor predeterminado de inicio de sesión.

Tanto --connector-id como --timeout-seconds se validan en el lado del cliente como enteros positivos antes de cualquier llamada de red.

Ejemplos

# Fire-and-forget — returns a PublishId to poll separately (~5-10 min until Studio Web shows it)
uip is connectors publish

# Block until publish completes (or the 10-minute default timeout)
uip is connectors publish --wait

Forma de datos (--json de salida)

{
  "Code": "ConnectorPublishStarted",
  "Data": {
    "ConnectorKey": "design-acmecorp-stripe",
    "ConnectorId": 42,
    "Version": "1.0.0",
    "PublishId": 99,
    "Status": "IN_PROGRESS",
    "Completed": false
  }
}

Con --wait, se utiliza el mismo Code: "ConnectorPublishStarted", pero Data refleja el estado sondeado final (Status: "SUCCESS" o "FAILURE", Completed: true) en lugar de la instantánea IN_PROGRESS inicial.

uip es el estado de publicación de los conectores

Sondear el estado de un trabajo de publicación por publish-id. Devuelve el estado del servidor palabra por palabra.

Argumentos

Nombre	Obligatorio	Propósito
<publish-id>	Sí	ID de trabajo de publicación devuelto por connectors publish.

Opciones

Largo	Valor	Descripción
--tenant <name>	name	Utilice la autenticación de este tenant en lugar del valor predeterminado de inicio de sesión.

Ejemplo

uip is connectors publish-status 99

Forma de datos (--json de salida)

{
  "Code": "ConnectorPublishStatus",
  "Data": { "PublishId": "99", "Status": "SUCCESS" }
}

Status es uno de IN_PROGRESS, SUCCESS o FAILURE, pasado textualmente desde el servidor. Una publicación fallida añade un campo Message con el detalle del fallo.

Relacionado

• Inicialización y conector : andamio en el que opera el conector local download/import/publish .
• Auth : configura el esquema de autenticación del conector.
• Actividad : define lo que hacen las actividades del conector.
• Enganches de actividad : transformaciones previas/posteriores a la solicitud de JavaScript.
• Desencadenador y estado : desencadenadores de eventos y ediciones de archivos de bajo nivel.
• uip is connectors : el catálogo de solo lectura en el que se alimentan estos comandos una vez publicados.

Ver también

• Descripción general de la herramienta de Integration Service
• Opciones globales
• Códigos de salida