UIP ou processos

Sintaxe e opções para "uip process", que gerencia as associações de pastas de pacotes a processos executáveis no Orchestrator.

uip or processes gerencia as associações executáveis de pacotes a pastas — o que o Orchestrator chama internamente de Lançamentos. Um processo é o que uip or jobs start tem como alvo; um pacote é o artefato .nupkg subjacente (consulte uip or packages).

Resumo

uip or processes <verb> [options]

Verbo

Texto	Finalidade
list	Liste os processos em uma pasta.
get	Buscar um processo por chave, incluindo esquemas de argumento e retenção.
resources	List package resources (queues, assets, buckets, connections) required by a process.
version-history	List the chronological package-version history for a process.
create	Associe um pacote a uma pasta como um novo processo.
update-version	Adicionar um ou mais processos para a versão mais recente (ou específica) do pacote.
update (alias edit)	Update process settings (PATCH semantics on selected fields).
delete	Delete a process binding by key (does not delete the package).
rollback	Reverter um processo para a versão anterior do pacote.

uip ou lista de processos

Liste os processos em uma pasta. Requer --folder-path ou --folder-key. Retorna a chave do processo (GUID), nome, versão e metadados básicos.

Opções

Short	Long	Valor	Padrão	Description
—	--folder-path	Path	—	Pasta de destino por caminho.
—	--folder-key	GUID	—	Pasta de destino por chave.
—	--all-folders	Bandeira	desativada	Tenant-wide listing. Mutually exclusive with --folder-path/--folder-key.
-n	--name	text	—	Contains-match no nome do processo.
—	--process-type	ENUM	—	Process, Agent, Flow, TestAutomationProcess, WebApp, Api, MCPServer, BusinessRules, CaseManagement, Function.
—	--all-fields	Bandeira	desativada	Retorna a carga útil da API completa.
-l	--limit	Número	50	Tamanho da página
—	--offset	Número	0	Ignorar contagem.
—	--sort-by	Campo	Id desc	Classificação OData.

Exemplos

uip or processes list --folder-path "Shared"
uip or processes list --folder-path "Shared" --process-type Agent
uip or processes list --folder-path "Shared" \
    --output-filter 'Data[].{key:Key, name:Name, v:ProcessVersion}'

# Tenant-wide audit across every folder
uip or processes list --all-folders --name "Invoice"

Formato dos dados (--output json)

{
  "Code": "ProcessList",
  "Data": [
    {
      "Key": "c3d4e5f6-0000-0000-0000-000000000001",
      "Name": "InvoiceProcessing",
      "ProcessKey": "InvoiceProcessing",
      "ProcessVersion": "1.0.2",
      "Description": "",
      "IsLatestVersion": true,
      "RetentionPeriod": 30,
      "RetentionAction": "Delete"
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "HasMore": false }
}

FolderId is added to each row only when --all-folders is used.

uip ou processos obter

Busca um processo por chave GUID. Retorna a versão, o ponto de entrada, os esquemas de argumento de entrada/saída, o tipo de processo e a configuração. Nenhum contexto de pasta necessário — a chave é resolvida entre pastas.

Argumentos

Name	Required	Finalidade
<process-key>	sim	Chave do processo (GUID). Encontre-o com processes list.

Opções

Short	Long	Valor	Padrão	Description
—	--all-fields	Bandeira	desativada	Retorna a carga útil da API completa.

Exemplos

uip or processes get c3d4e5f6-0000-0000-0000-000000000001
uip or processes get c3d4e5f6-0000-0000-0000-000000000001 --all-fields
uip or processes get c3d4e5f6-0000-0000-0000-000000000001 \
    --output-filter 'Data.InputArguments'

Formato dos dados (--output json)

{
  "Code": "ProcessGet",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000001",
    "Name": "InvoiceProcessing",
    "ProcessKey": "InvoiceProcessing",
    "ProcessVersion": "1.0.2",
    "Description": "Processes vendor invoices",
    "IsLatestVersion": true,
    "ProcessType": "Process",
    "EntryPointPath": "Main.xaml",
    "InputArguments": "{\"invoicePath\":\"String\"}",
    "FolderKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "FolderPath": "Shared",
    "AutoUpdate": false,
    "TargetFramework": "Windows",
    "JobPriority": "Normal",
    "SpecificPriorityValue": 50,
    "RetentionPeriod": 30,
    "RetentionAction": "Delete",
    "StaleRetentionPeriod": 0,
    "StaleRetentionAction": "None",
    "HiddenForAttendedUser": false,
    "AutoCreateConnectedTriggers": false
  }
}

uip or processes resources

List package resources — queues, assets, buckets, connections, and other package requirements — referenced by a process. Resolves the process's folder automatically; no folder flag needed.

Argumentos

Name	Required	Finalidade
<process-key>	sim	Chave do processo (GUID). Encontre-o com processes list.

Opções

Short	Long	Valor	Padrão	Description
—	--all-fields	Bandeira	desativada	Retorna a carga útil da API completa em vez do resumo selecionado.

Exemplos

uip or processes resources c3d4e5f6-0000-0000-0000-000000000001
uip or processes resources c3d4e5f6-0000-0000-0000-000000000001 --all-fields

Formato dos dados (--output json)

{
  "Code": "ProcessResources",
  "Data": [
    {
      "ResourceType": "Queue",
      "ResourceName": "InvoiceQueue",
      "FolderPath": "Shared",
      "ValidationResult": "Success",
      "ValidationError": "",
      "IsOverwritable": true,
      "ResourceKey": "InvoiceQueue",
      "ResourceId": "123456",
      "Id": 0
    }
  ]
}

uip or processes version-history

List the chronological package-version history associated with a process. Folder is optional — if not provided, it is inferred from the process key.

Argumentos

Name	Required	Finalidade
<process-key>	sim	Chave do processo (GUID).

Opções

Short	Long	Valor	Padrão	Description
—	--folder-path	Path	inferido	Ignore a detecção automática e use esta pasta.
—	--folder-key	GUID	inferido	Ignore a detecção automática e use esta pasta.
—	--all-fields	Bandeira	desativada	Retorna a carga útil da API completa em vez do resumo selecionado.

Exemplos

uip or processes version-history c3d4e5f6-0000-0000-0000-000000000001

Formato dos dados (--output json)

{
  "Code": "ProcessVersionHistory",
  "Data": [
    {
      "Version": "1.0.0",
      "CreatedAt": "2024-01-10T08:30:00.000Z",
      "ReleaseName": "InvoiceProcessing",
      "ReleaseId": 101,
      "Id": 1001
    },
    {
      "Version": "1.0.2",
      "CreatedAt": "2024-01-15T09:45:00.000Z",
      "ReleaseName": "InvoiceProcessing",
      "ReleaseId": 101,
      "Id": 1002
    }
  ]
}

criação de uip ou processos

Associe um pacote a uma pasta como um processo. Requer --folder-path ou --folder-key e três opções de pacote obrigatórias. Use uip or packages list para a chave do pacote e uip or packages versions para as versões disponíveis.

Opções

Required

Short	Long	Valor	Padrão	Description
—	--name	text	—	Nome do processo dentro da pasta.
—	--package-key	text	—	Chave do pacote (a PackageId de packages list).
—	--package-version	2019.x	—	Versão do pacote (por exemplo, 1.0.0).

Identidade e escopo

Short	Long	Valor	Padrão	Description
—	--folder-path	Path	—	Pasta de destino por caminho.
—	--folder-key	GUID	—	Pasta de destino por chave.

Configurações do Processo

Short	Long	Valor	Padrão	Description
—	--description	text	—	Descrição do processo.
—	--entry-point	Path	—	Caminho do fluxo de trabalho no ponto de entrada (para pacotes com vários pontos de entrada).
—	--input-arguments	JSON	—	Argumentos de entrada padrão como JSON.
—	--job-priority	ENUM	—	Low, Normal, High. Mutualmente exclusivo com --specific-priority.
—	--specific-priority	1–100	—	Prioridade numérica. mutuamente exclusivo com --job-priority.
—	--robot-size	ENUM	—	Tamanho do Cloud robot: Small, Standard, Medium, Large.
—	--tags	CSV	—	Nomes de tags separados por vírgulas.
—	--environment-variables	text	—	Environment variables as newline-separated KEY=VALUE pairs (not JSON), e.g. $'FOO=bar\nBAZ=qux'.
—	--auto-update / --no-auto-update	Bandeira	—	Habilite/desabilite a atualização automática para a versão mais recente do pacote.
—	--hidden-for-attended / --visible-for-attended	Bandeira	—	Ocultar ou mostrar para usuários Attended. Mutualmente exclusivos.
—	--auto-create-triggers / --no-auto-create-triggers	Bandeira	—	Crie automaticamente gatilhos conectados na implantação.

Retenção

Short	Long	Valor	Padrão	Description
—	--retention-period	dias (1–180)	30	Período de retenção do trabalho.
—	--retention-action	ENUM	Delete	Delete, Archive ou None.
—	--retention-bucket	ID do bucket	—	ID do bucket de armazenamento. Obrigatório quando --retention-action Archive.
—	--stale-retention-period	dias	—	Período de retenção de trabalhos obsoletos.
—	--stale-retention-action	ENUM	—	Delete, Archive ou None.

Exemplos

uip or processes create --folder-path "Shared" \
    --name "InvoiceProcessing" \
    --package-key InvoiceProcessing --package-version 1.0.2

uip or processes create --folder-path "Production/EU" \
    --name "InvoiceProcessing" --package-key InvoiceProcessing --package-version 1.0.2 \
    --job-priority High --auto-update --tags "finance,eu"

uip or processes create --folder-path "Shared" \
    --name "InvoiceProcessing" --package-key InvoiceProcessing --package-version 1.0.2 \
    --output-filter 'Data.Key'

Formato dos dados (--output json)

{
  "Code": "ProcessCreated",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000010",
    "Name": "InvoiceProcessing",
    "ProcessKey": "InvoiceProcessing",
    "ProcessVersion": "1.0.2",
    "Description": "",
    "IsLatestVersion": true,
    "RetentionPeriod": 30,
    "RetentionAction": "Delete"
  }
}

uip ou apps update-version

Atualize um ou mais processos para a versão mais recente do pacote ou para uma versão específica com --package-version. A pasta é opcional — se não for fornecida, será inferida da primeira chave do processo.

• Uma chave + sem --package-version → atualizar para a mais recente (chamada de API única).
• Uma chave + --package-version → atualizar para essa versão (chamada de API única).
• Várias chaves + sem --package-version → atualização em massa do mais recente.
• Múltiplas chaves + --package-version → rejeitadas (erro de validação).

Os trabalhos em execução não são afetados; apenas novos trabalhos usarão a versão atualizada.

Argumentos

Name	Required	Finalidade
<process-keys...>	sim	Uma ou mais chaves de processo (GUIDs).

Opções

Short	Long	Valor	Padrão	Description
—	--folder-path	Path	inferido	Ignore a detecção automática e use esta pasta.
—	--folder-key	GUID	inferido	Ignore a detecção automática e use esta pasta.
—	--package-version	2019.x	—	Versão específica. Válido apenas com uma única chave.

Exemplos

uip or processes update-version c3d4e5f6-0000-0000-0000-000000000001

uip or processes update-version c3d4e5f6-0000-0000-0000-000000000001 \
    --package-version 1.0.3

uip or processes update-version \
    c3d4e5f6-0000-0000-0000-000000000001 \
    c3d4e5f6-0000-0000-0000-000000000002 \
    --output-filter 'Data.Version'

Formato dos dados (--output json)

Chave única:

{
  "Code": "ProcessVersionUpdated",
  "Data": { "ProcessKey": "c3d4e5f6-…-000001", "Version": "latest" }
}

Em massa, retorna Code: "ProcessVersionsUpdated" com ProcessKeys, Version e um objeto Result repetido da API.

uip or processes update

Update process settings by key. Reads current values, applies the PATCH fields provided, and saves. Only provided fields are changed; fields omitted on the CLI are preserved from the current state. No folder flag needed — the key resolves cross-folder.

edit is a registered alias for this verb — uip or processes edit works identically to uip or processes update.

Argumentos

Name	Required	Finalidade
<process-key>	sim	Chave do processo (GUID).

Opções

Campos iguais ao de processes create , exceto para as três opções de pacote e sinalizadores de escopo obrigatórios. As regras de exclusão múltipla e validação correspondem a create (--job-priority vs --specific-priority, --hidden-for-attended vs --visible-for-attended, Archive a retenção requer --retention-bucket).

Short	Long	Valor	Padrão	Description
-n	--name	text	—	Novo nome de exibição.
-d	--description	text	—	Nova descrição.
—	--entry-point	Path	—	Novo caminho do ponto de entrada.
—	--input-arguments	JSON	—	Argumentos de entrada padrão.
—	--environment-variables	text	—	Newline-separated KEY=VALUE pairs (not JSON). Pass '' to clear them.
—	--job-priority	ENUM	—	Low, Normal, High.
—	--specific-priority	1–100	—	Prioridade numérica.
—	--auto-update / --no-auto-update	Bandeira	—	Alternar atualização automática.
—	--hidden-for-attended / --visible-for-attended	Bandeira	—	Visibilidade assistida.
—	--auto-create-triggers / --no-auto-create-triggers	Bandeira	—	Criação automática de gatilho conectado.
—	--healing-agent / --no-healing-agent	Bandeira	—	Enable or disable Healing Agent (Autopilot for Robots) for this process. Future jobs use it by default once enabled; tenant-level Autopilot must already be on.
—	--retention-period	dias (1–180)	—	Período de retenção do trabalho.
—	--retention-action	ENUM	—	Delete, Archive, None.
—	--retention-bucket	ID do bucket	—	Obrigatório quando --retention-action Archive.
—	--stale-retention-period	dias	—	Período de retenção de trabalhos obsoletos.
—	--stale-retention-action	ENUM	—	Delete, Archive, None.

Exemplos

uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
    --description "Monthly invoice batch"

uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
    --job-priority High --retention-period 60

uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
    --auto-update --output-filter 'Data.Status'

Formato dos dados (--output json)

{
  "Code": "ProcessUpdated",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000001",
    "Name": "InvoiceProcessing",
    "Status": "Updated successfully"
  }
}

uip or processes delete

Delete a process binding by key. This removes the release binding from its folder — it does not delete the underlying package.

Argumentos

Name	Required	Finalidade
<process-key>	sim	Chave do processo (GUID). Encontre-o com processes list.

Opções

Short	Long	Valor	Padrão	Description
-y	--yes	Bandeira	—	Required. Confirms this irreversible operation — the CLI never prompts.

Exemplos

uip or processes delete c3d4e5f6-0000-0000-0000-000000000001 --yes

Formato dos dados (--output json)

{
  "Code": "ProcessDeleted",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000001",
    "Name": "InvoiceProcessing",
    "ProcessKey": "InvoiceProcessing",
    "Status": "Deleted successfully"
  }
}

uip ou reversão de processos

Reverter um processo para a versão anterior do pacote. A pasta é opcional — se não for fornecida, será inferida da chave do processo.

Argumentos

Name	Required	Finalidade
<process-key>	sim	Chave do processo (GUID).

Opções

Short	Long	Valor	Padrão	Description
—	--folder-path	Path	inferido	Ignorar a detecção automática.
—	--folder-key	GUID	inferido	Ignorar a detecção automática.

Exemplos

uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001
uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001 \
    --folder-path "Shared"
uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001 \
    --output-filter 'Data.Status'

Formato dos dados (--output json)

{
  "Code": "ProcessRolledBack",
  "Data": {
    "ProcessKey": "c3d4e5f6-0000-0000-0000-000000000001",
    "Status": "Rolled back to previous version"
  }
}

Códigos de saída

Consulte Códigos de saída. Nenhuma substituição específica do verbo além dos erros de validação padrão.

Comandos relacionados

• uip or packages — encontre chaves de pacote (packages list), versões (packages versions) e pontos de entrada (packages entry-points) antes de chamar processes create.
• uip or jobs — especialmente jobs start, que leva uma chave de processo.
• uip or folders — crie ou localize a pasta de destino antes da vinculação.

Veja também

• Opções globais.
• Sessões.