uiip é um construtor de conectores init & amp; Conector

Sintaxe e opções para estruturar, editar, inspecionar e validar um conector do Integration Service local — init do construtor, predefinido de init aplique, exclua o cabeçalho do init, inspecione e valide.

Parte da cadeia de ferramentas de criação local uip is connectors builder . Esta página abrange os dois verbos que possuem o shell de no disco de um conector:

• builder init crie um novo conector ou edite campos naquele que é resolvido a partir do diretório atual. Também possui init preset apply (semente um pacote de configuração base/paginação) e init header delete (remover um cabeçalho de solicitação global).
• builder inspect / builder validate — resumo da estrutura somente leitura e conjunto de verificação de aprovação/falha classificável por CI. Eles ficam diretamente sob builder, sem wrapper connector no caminho do comando.

Para atividades de estruturação, autenticação, gatilhos ou edições de arquivos de baixo nível, consulte as páginas irmãs.

Conceitos

• Criar versus editar envio — init decide seu modo se um conector for resolvido a partir de --connector-dir (ou do diretório atual, verificando apenas o próprio diretório atual — não subdiretórios, ao contrário da resolução de fallback de outros comandos do construtor). Nenhum conector resolve → criar (requer --name, estrutura uma árvore nova e os padrões de sementes). Um resolve → editar (apenas os sinalizadores que você passa mudam; todo o resto no disco é deixado como está). Se mais de um diretório de conector corresponder, init falha com Code: "connectorAmbiguous" em vez de adivinhar — transmita --connector-dir explicitamente.
• Por que init não verificará subdiretórios — todos os outros comandos do construtor retornarão à verificação de subdiretórios imediatos quando nenhum conector for resolvido no diretório atual (consulte Conceitos na página principal). init pula deliberadamente esse fallback: a verificação se arriscaria a resolver um diretório de conector irmãos abaixo do cwd e editá-lo ou renomeá-lo silenciosamente em vez de criar um novo. Execute init de dentro do próprio diretório do conector ou passe --connector-dir para editar um em outro lugar.
• O que init une — esse único comando substitui o que costumava ser superfície separada connector scaffold, metadata set, global set e base/paginação config preset , portanto, os outros três verbos de criação (auth, activity, trigger) permanecem estreitas. extended displayOrder state patch tags element.json cloneable e estado typeOauth
• Requisito de login ao criar — a criação de um conector sem --organization requer um login ativo, porque a chave do elemento (design-{org}-{slug}) carimbos a organização. Isso verifica o status de login real, não apenas se um nome de organização é armazenado em cache localmente — uma sessão expirada ou com falha de atualização falha na verificação mesmo que a própria uip login status ainda reporte sucesso. Passe --organization <slug> explicitamente para compilações offline ou de CI.
• Criação de cabeçalho versus exclusão de assimetura — adicionar ou atualizar um cabeçalho global é arquivo de init --header VendorName=value (repetível). A remoção de um é o init header delete <vendor-name> separado — a única operação de cabeçalho state patch não pode fazer, porque não pode endereçar um único item de array element.json parameters[] diretamente.

Resumo

uip is connectors builder init [--name <name>] [--connector-dir <path>] [options...]
uip is connectors builder init preset apply --kind <base|pagination> [--override <key=value>]... [--connector-dir <path>] [--force]
uip is connectors builder init header delete <vendor-name> [--connector-dir <path>]
uip is connectors builder inspect [--connector-dir <path>]
uip is connectors builder validate [--connector-dir <path>]

uip é init do construtor de conectores

Criar ou configurar o shell de um conector no disco.

Observação:

Use isso para inicializar um conector novo (--name) ou para definir campos no nível do conector — nome, descrição, categorias, URL base, cabeçalhos, ciclo de vida e nível — em um que já existe. Para adicionar recursos/atividades, use activity create na página Atividade e ganchos . Para configurar a autenticação além do Sugar em linha --auth , use auth set na página Auth . Para editar um campo element.json de final longo que esse comando não expõe como um sinalizador, use state patch.

Opções

Long	Valor	Description
--name <name>	String	Nome de exibição, por exemplo 'Acme Widgets'). Necessário ao criar; a chave do elemento e a pasta padrão são derivadas dela.
--connector-dir <path>	Path	Diretório do conector. Consulte Conceitos acima para obter o comportamento de resolução específico para init.
--organization <name>	campo de dados dinâmico	Campo de dados dinâmico da organização para a chave do elemento (design-{org}-{name}). Apenas modo de criação; o padrão é sua organização conectada.
--description <text>	String	Descrição do conector de uma linha.
--categories <csv>	csv	Lista de categorias separada por vírgulas. A correspondência não diferencia maiúsculas de minúsculas; valores aprovados são canônicos à sua grafia aprovada (por exemplo crm → CRM). Uma categoria não reconhecida falha rapidamente aqui em vez de mais tarde em validate.
--activity-color <hex>	HEX	Cor hexadecimal para a interface gráfica da atividade do Studio.
--base-url <url>	url	URL de base padrão — define a entrada de configuração base.url. Um URL modelado (https://{environment}/api) propaga automaticamente a entrada de configuração de interpolação de suporte de que ele precisa.
--accept-type <value>	String	Accept valor do cabeçalho.
--content-type <value>	String	Content-Type valor do cabeçalho.
--header <kv>	VendorName=value	Cabeçalho de solicitação global. Repetível.
--lifecycle-stage <stage>	String	Estágio do ciclo de vida, por exemplo GA, BETA.
--tier <tier>	String	Nível do conector.
--auth <type>	String	Configurar a autenticação em linha (apenas no modo de criação): qualquer valor auth set --auth-type (oauth2, customApiKey, none, jwtOauth, firstPartyService, …). Com oauth2, --authorization-url, --token-url e --scope são obrigatórios. Os sinalizadores específicos de tipo além dos abaixo precisam de auth set.
--authorization-url <url>	url	URL de login/consentimento do OAuth2. Necessário com --auth oauth2.
--token-url <url>	url	Ponto de extremidade do token OAuth2. Necessário com --auth oauth2.
--token-refresh-url <url>	url	Ponto de extremidade de atualização do OAuth2. O padrão é --token-url.
--token-revoke-url <url>	url	Ponto de extremidade de revogação do token do OAuth2.
--scope <scope>	String	String de escopo delimitada por espaço do OAuth2. Necessário com --auth oauth2.
--api-key-param-name <name>	String	customApiKey — cabeçalho do fornecedor ou nome do parâmetro de consulta.
--api-key-location <where>	header | query	customApiKey — para onde a chave é enviada. headerPadrão.
--api-key-prefix <prefix>	String	customApiKey — prefixo literal.
--key-config-name <key>	String	customApiKey — chave de configuração interna. custom.api.keyPadrão.
--key-config-display-name <name>	String	customApiKey — Rótulo da interface gráfica. API KeyPadrão.
--force	Bandeira	Aplique diferenças em entradas existentes em vez de erros.

Exemplos

# Create a new connector (auth configured later)
uip is connectors builder init --name 'Acme Widgets'

# Create + OAuth2 + base URL in one call
uip is connectors builder init --name 'Acme Widgets' --base-url https://api.acme.com \
  --auth oauth2 --authorization-url https://acme.com/oauth/authorize \
  --token-url https://acme.com/oauth/token --scope 'read write'

# Edit an existing connector — only the passed flags change
uip is connectors builder init --description 'Acme Widgets connector' --categories crm,sales

Formato dos dados (--output json)

{
  "Code": "ConnectorInitialized",
  "Data": {
    "Mode": "created",
    "ElementKey": "design-myorg-acmewidgets",
    "RepoName": "acme-widgets",
    "ConnectorRoot": "/work/periodic-design-myorg-acmewidgets",
    "FilesCreated": ["app/element/element.json", "..."],
    "OrganizationName": "myorg",
    "OrganizationNameSource": "login",
    "HeadersSeeded": [],
    "BaseUrlSet": false,
    "MetadataChanges": [],
    "AuthConfigured": null
  }
}

Mode é "created" "edited"ou. O modo de edição retorna uma forma Data mais estreita: Mode, ConnectorRoot, HeadersChanged, MetadataChanges, BaseUrlSet — não há FilesCreated, OrganizationName ou AuthConfigured, já que eles se aplicam apenas a um framework novo.

uip é construtor de conectores init pré-definição aplicar

Aplique um pacote canônico de entradas de configuração: base (URL de base mais chaves selecionadas/nulas/instância) ou pagination (as quatro chaves de paginação).

Observação:

Use isso para semear as chaves de configuração de base ou de paginação em uma chamada. O pacote de evento/pesquisa é uma predefinição separada alcançada trigger create --event-kind por meio de, não por meio desse comando. Para adicionar uma entrada de configuração sob medida em vez de um pacote, use state patch element.json/configuration/<key>.

Opções

Long	Valor	Description
--kind <kind>	base | pagination	Obrigatório. Predefinido para aplicar.
--override <kv>	key=value	Substituição de defaultValue por entrada. Repetível.
--connector-dir <path>	Path	Diretório do conector.
--force	Bandeira	Aplique diferenças em entradas existentes em vez de erros.

Exemplo

uip is connectors builder init preset apply --kind pagination

Formato dos dados (--output json)

{
  "Code": "ConfigPresetApplied",
  "Data": {
    "Kind": "pagination",
    "Added": ["pagination.max"],
    "Updated": [],
    "Unchanged": [],
    "ConnectorRoot": "/work/periodic-design-myorg-acmewidgets"
  }
}

uip é exclusão do cabeçalho init do construtor de conectores

Remova um cabeçalho de solicitação global por nome do fornecedor.

Observação:

Use isso para remover um cabeçalho global que você não deseja mais enviar. Para adicionar ou atualizar um, use init --header VendorName=value — não há init header create; essa operação reside na própria init.

Argumentos

Name	Required	Finalidade
<vendor-name>	sim	Nome do cabeçalho do fornecedor a ser removido.

Opções

Long	Valor	Description
--connector-dir <path>	Path	Diretório do conector.

Exemplo

uip is connectors builder init header delete X-Tenant

Formato dos dados (--output json)

{
  "Code": "GlobalHeaderRemoved",
  "Data": { "ConnectorRoot": "/work/periodic-design-myorg-acmewidgets", "VendorName": "X-Tenant" }
}

uip é inspeção do construtor de conectores

Produza uma visão geral estruturada somente leitura de um conector: tipos de autenticação, configuração, recursos (com arquivos de recursos padrão e hooks), hooks globais, eventos e metadados.

Observação:

Use isso para obter um mapa rápido de um conector existente antes de editá-lo ou para confirmar quais recursos, hooks e tipos de autenticação estão presentes. Para verificações de aprovação/falha em vez de um resumo de estrutura,validate use.

Opções

Long	Valor	Description
--connector-dir <path>	Path	Diretório do conector.

Exemplo

uip is connectors builder inspect --connector-dir ./my-acme-connector

Formato dos dados (--output json)

{
  "Code": "ConnectorInspected",
  "Data": {
    "ConnectorRoot": "/work/my-acme-connector",
    "ElementKey": "design-myorg-acmewidgets",
    "Name": "Acme Widgets",
    "Description": "Acme Widgets connector",
    "AuthTypes": ["oauth2"],
    "ConfigCount": 5,
    "ConfigKeys": ["base.url", "..."],
    "ResourceCount": 12,
    "ResourceSummary": {
      "/auth_validation": { "Methods": ["GET"], "Type": "standard", "StandardResourceFile": "auth_validation.json", "Hooks": [] }
    },
    "GlobalHooks": [],
    "HasEvents": false,
    "EventTypes": [],
    "Categories": ["CRM"],
    "LifecycleStage": "GA",
    "Metadata": { "...": "verbatim element-metadata.json content" }
  }
}

ResourceSummary é chaveado pelo caminho real no disco do recurso (por exemplo /auth_validation), e Metadata é o conteúdo textual de element-metadata.json. Ambos estão isentas da normalização de chaves PascalCase habitual do CLI — as chaves brutas são preservadas exatamente como aparecem no disco, portanto, um seletor criado a partir dessa saída (por exemplo /auth_validation, {sys_id}) corresponde ao caminho do arquivo real em vez de uma variante /authValidation / {sysId} reformulada.

uip é validação de construtor de conectores

Execute o conjunto de verificação completo em um conector e emita um relatório estruturado. Saídas diferentes de zero quando o conector é inválido, para que o CI possa validá-lo.

Observação:

Use isso para conectar um conector no CI antes da importação ou lançamento e para encontrar erros, avisos e sugestões em element.json, arquivos de recurso padrão, hooks e metadados. Para navegar na estrutura de um conector em vez de executar verificações, use inspect.

Opções

Long	Valor	Description
--connector-dir <path>	Path	Diretório do conector.

Exemplos

uip is connectors builder validate

uip is connectors builder validate --connector-dir ./my-acme-connector

Formato dos dados (--output json)

{
  "Code": "ConnectorValidation",
  "Data": {
    "ConnectorRoot": "/work/my-acme-connector",
    "ElementKey": "design-myorg-acmewidgets",
    "Valid": true,
    "Errors": [],
    "Warnings": [],
    "Info": ["Configuration entries: 5"],
    "Summary": "PASS: 0 error(s), 0 warning(s)"
  }
}

O relatório é emitido tanto em aprovação quanto em falha — um relatório com falha ainda retorna Result: "Success" com Valid: false em Data (o comando em si não gerou erro), mas o processo sai com um código de saída diferente de zero para que a CI possa no resultado sem analisar o corpo.

Relacionado

• o uip é construtor de conectores — conceitos e os verbos do ciclo de vida do tenant (download/import/publish/publish-status).
• Autenticação — configure o esquema de autenticação do conector.
• Atividade e ganchos — defina o que as atividades do conector fazem.
• Gatilho e estado — gatilhos de eventos e edições de arquivo de elementos de baixo nível.

Veja também

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