uip é construtor de conectores

Sintaxe e opções para os comandos de criação de conectores e ciclo de vida do Integration Service — baixar, importar, publicar e a cadeia de ferramentas local do "construtor de conectores"

Os conectores do Integration Service podem ser criados localmente e enviados para um tenant. Duas camadas de comando cobrem isso:

• Ciclo de vida do tenant — uip is connectors download, import, publish, publish-status. Registrados diretamente em connectors (não em builder), porque eles se comunicam com um tenant e operam em conectores de design/autores, em vez da árvore de arquivos local. Documentado nesta página.
• Criação local — uip is connectors builder .... Funciona inteiramente em um diretório de conector local (sem chamada de tenant, exceto o teste ao vivo opcional do builder auth) para estruturar, editar e validar os arquivos de um conector antes de importá-los. Divida cinco páginas por domínio — consulte Esse recurso abrange seis páginas abaixo.

Nenhuma das camadas afeta o catálogo somente leitura coberto por uip is connectors (list, get, metadata, swagger, event-operations, audit-logs, export) — essa página já é sobre a descoberta de conectores no catálogo; este é sobre a criação de um novo ou de uma nova versão de um que você possui.

Esse recurso abrange seis páginas

• Esta página — conceitos e os verbos do ciclo de vida do tenant: download, import, publish, publish-status.
• Init e conector — builder init (estrutura um novo conector), builder connector inspect/validate.
• Autenticar — builder auth set/get/system create/list, o esquema de autenticação do conector.
• Atividade — builder activity CRUD mais seus subgrupos field, method e param — o maior domínio, definindo o que as atividades do conector realmente fazem.
• Gatilhos de atividade — builder activity hook — Transformações pré/pós-solicitação do JavaScript, divididas em sua própria página para a referência de contexto de runtime de que precisa.
• Gatilho e estado — builder trigger create, builder state query/patch — gatilhos orientados por eventos e edições de arquivos de elementos de baixo nível.

Conceitos

• Diretório do conector — uma pasta local contendo app/element/element.json (e arquivos irmãos para atividades, autenticação, gatilhos). Quase todo comando aceita --connector-dir <path> para apontar para um explicitamente. Quando omitida, a resolução sobe do diretório atual procurando esse arquivo; se nenhum for encontrado, ele verificará subdiretórios imediatos em busca de um único conector; se ainda não for encontrado, ele recairá no conector registrado pela última execução de builder init nesse local (.uip-connector.json). Se a resolução encontrar mais de um candidato, o comando falhará com Code: "connectorAmbiguous" e listará os candidatos — passe --connector-dir explicitamente para remover a ambiguidade.
• Design versus conector publicado — um conector em desenvolvimento local ativo é um conector de design (chave prefixada design-..., particular de seu autor). publish o promove para um conector PERSONALIZADO em todo o tenant visível para todos. download/import/publish/publish-status operam nesse estado de design/publicação do lado do tenant; os verbos builder abaixo operam exclusivamente em arquivos locais.
• Descoberta — cada grupo de comando builder envia uma habilidade uipath-connector-builder (consulte uip skills) que é exibida automaticamente para agentes de codificação de IA, além de um bloco --help na maioria dos comandos com explícito "USE When" / "NuVER USE FOR" orientação — leia a saída --help do próprio comando antes de supor seu escopo apenas do nome.
• Fluxo típico (de acordo com o texto builder --help da própria 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.

Resumo

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 é uma opção normal e visível nos quatro verbos do ciclo de vida.

uiip é download de conectores

Baixe a árvore de origem editável de um conector de design por chave e descompacte-a localmente para edição.

Observação:

Use isso para puxar um conector de design para edição local ou para inicializar uma cópia de trabalho de um conector que você importou/publicou anteriormente. Para ler o registro de um conector, use connectors get. Para pesquisar por nome, use connectors list --filter. Para exportar o zip do pacote de um elemento publicado, use connectors export — uma operação diferente desta.

Argumentos

Name	Required	Finalidade
<connector-key>	sim	Chave de conector de design exata, por design-myorg-acmewidgets exemplo.

Opções

Long	Valor	Description
--connector-dir <path>	Path	Diretório de destino para a origem descompactada. O padrão para o diretório atual.
--tenant <name>	name	Substitui o tenant para as chamadas de API.

Exemplo

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

Formato dos dados (--output json)

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

uip é importação de conectores

Empacote o conector local em um zip e crie ou atualize-o no tenant por chave — criado na primeira vez, atualizado em cada execução depois disso.

Observação:

Use isso para publicar alterações de conector local em um tenant ou para criar um conector de tenant a partir de um diretório local pela primeira vez. Para baixar ou pesquisar conectores de tenant, use connectors download / connectors list.

Argumentos

Nenhum.

Opções

Long	Valor	Description
--connector-dir <path>	Path	Diretório do conector ou qualquer pai app/element/element.json de. O padrão para o diretório atual.
--tenant <name>	name	Substitui o tenant para as chamadas de API.

Exemplo

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

Formato dos dados (--output json)

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

Operation é "Created" na primeira vez que uma determinada chave de conector é importada, "Updated" em cada importação subsequente.

uip é publicação de conectores

Promover um conector de design para um conector PERSONALIZADO em todo o tenant. Disparar e esquecer por padrão — retorna um PublishId para pesquisar com publish-status; passe --wait para pesquisar internamente.

Observação:

Use isso após connectors import ser bem-sucedido, para tornar o conector visível para todos os usuários no tenant — ou para publicar novamente uma nova versão de um conector já publicado (certifique-se de element-metadata.json:latestVersion primeiro). Isso não envia alterações de arquivos locais para um tenant — ele é connectors import. publish opera apenas no que já foi importado.

Argumentos

Nenhum.

Opções

Long	Valor	Description
--connector-dir <path>	Path	Caminho para o diretório do conector. Mesma ordem de resolução que os Conceitos acima.
--version <semver>	sem servidor	Substitua a versão de element-metadata.json:latestVersion. Raramente necessário.
--connector-id <id>	Número inteiro	Ignore a pesquisa obter por chave com um ID numérico explícito. Raramente necessário.
--wait	Bandeira	Pesquise o status até SUCCESS/FAILURE/tempo limite em vez de retornar imediatamente.
--timeout-seconds <seconds>	Número inteiro	Tempo limite da pesquisa quando --wait é definido. Padrão 600 (10 minutos).
--tenant <name>	name	Use a autenticação deste tenant em vez do padrão conectado.

Ambos --connector-id e --timeout-seconds são validados no lado do cliente como números inteiros positivos antes de qualquer chamada de rede.

Exemplos

# 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

Formato dos dados (--output json)

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

Com --wait, o mesmo Code: "ConnectorPublishStarted" é usado, mas Data reflete o estado final pesquisado (Status: "SUCCESS" ou "FAILURE", Completed: true) em vez do instantâneo IN_PROGRESS inicial.

uip é publicar-status de conectores

Pesquise o status de um trabalho de publicação por publish-id. Retorna o texto do status do servidor.

Argumentos

Name	Required	Finalidade
<publish-id>	sim	Publique o ID do trabalho retornado por connectors publish.

Opções

Long	Valor	Description
--tenant <name>	name	Use a autenticação deste tenant em vez do padrão conectado.

Exemplo

uip is connectors publish-status 99

Formato dos dados (--output json)

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

Status é um destes IN_PROGRESS, SUCCESS, ou FAILURE, passado literalmente do servidor. Uma publicação com falha adiciona um campo Message com os detalhes da falha.

Relacionado

• Inicialização e conector — estrutura em que o conector local download/import/publish operam.
• Autenticação — configure o esquema de autenticação do conector.
• Atividade — defina o que as atividades do conector fazem.
• Lanças de atividade — Transformações pré/pós-solicitação do JavaScript.
• Gatilho e estado — gatilhos de eventos e edições de arquivos de baixo nível.
• uip is connectors — o catálogo somente leitura que esses comandos são alimentados depois de publicados.

Veja também

• Visão geral da ferramenta do Integration Service
• Opções globais
• Códigos de saída