uip o procesos

Sintaxis y opciones para `uip o procesos`, que gestiona las vinculaciones de carpetas de paquetes a procesos ejecutables en Orchestrator.

uip or processes las vinculaciones ejecutables de paquetes a carpetas, lo que Orchestrator llama internamente Versiones. Un proceso es lo que uip or jobs start apunta; un paquete es el artefacto .nupkg subyacente (consulta uip or packages).

Sinopsis

uip or processes <verb> [options]

Verbos

Verbo	Propósito
list	Enumerar procesos en una carpeta.
get	Obtener un proceso por clave, incluidos los esquemas de argumentos y la retención.
resources	List package resources (queues, assets, buckets, connections) required by a process.
version-history	List the chronological package-version history for a process.
create	Vincula un paquete a una carpeta como un nuevo proceso.
update-version	Actualiza uno o más procesos a la última versión del paquete (o a una específica).
update (alias edit)	Update process settings (PATCH semantics on selected fields).
delete	Delete a process binding by key (does not delete the package).
rollback	Revierte un proceso a su versión anterior del paquete.

uip o lista de procesos

Enumerar procesos en una carpeta. Requiere --folder-path o --folder-key. Devuelve la clave del proceso (GUID), el nombre, la versión y los metadatos básicos.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--folder-path	Ruta	—	Carpeta de destino por ruta.
—	--folder-key	GUID	—	Carpeta de destino por clave.
—	--all-folders	Marca	Desactivado	Tenant-wide listing. Mutually exclusive with --folder-path/--folder-key.
-n	--name	text	—	Contiene coincidencia en el nombre del proceso.
—	--process-type	ENUM	—	Process, Agent, Flow, TestAutomationProcess, WebApp, Api, MCPServer, BusinessRules, CaseManagement, Function.
—	--all-fields	Marca	Desactivado	Devuelve la carga útil de la API completa.
-l	--limit	Número	50	Tamaño de la página.
—	--offset	Número	0	Omitir recuento.
—	--sort-by	Campo	Id desc	Ordenación de OData.

Ejemplos

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"

Forma de datos (--json de salida)

{
  "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 o procesos get

Obtener un proceso por clave GUID. Devuelve la versión, el punto de entrada, los esquemas de argumentos de entrada/salida, el tipo de proceso y la configuración. No se necesita contexto de carpeta: la clave se resuelve en varias carpetas.

Argumentos

Nombre	Obligatorio	Propósito
<process-key>	Sí	Clave de proceso (GUID). Encuéntralo con processes list.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--all-fields	Marca	Desactivado	Devuelve la carga útil de la API completa.

Ejemplos

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'

Forma de datos (--json de salida)

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

Nombre	Obligatorio	Propósito
<process-key>	Sí	Clave de proceso (GUID). Encuéntralo con processes list.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--all-fields	Marca	Desactivado	Devuelve la carga útil de la API completa en lugar del resumen seleccionado.

Ejemplos

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

Forma de datos (--json de salida)

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

Nombre	Obligatorio	Propósito
<process-key>	Sí	Clave de proceso (GUID).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--folder-path	Ruta	inferido	Omita la detección automática y utilice esta carpeta.
—	--folder-key	GUID	inferido	Omita la detección automática y utilice esta carpeta.
—	--all-fields	Marca	Desactivado	Devuelve la carga útil de la API completa en lugar del resumen seleccionado.

Ejemplos

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

Forma de datos (--json de salida)

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

creación de uip o procesos

Vincula un paquete a una carpeta como proceso. Requiere --folder-path o --folder-key y tres opciones de paquete necesarias. Utiliza uip or packages list para la clave del paquete y uip or packages versions para las versiones disponibles.

Opciones

Obligatorio

Corto	Largo	Valor	Predeterminado	Descripción
—	--name	text	—	Nombre del proceso dentro de la carpeta.
—	--package-key	text	—	Clave de paquete (la PackageId de packages list).
—	--package-version	2020.x	—	Versión del paquete (por ejemplo, 1.0.0).

Identidad y ámbito

Corto	Largo	Valor	Predeterminado	Descripción
—	--folder-path	Ruta	—	Carpeta de destino por ruta.
—	--folder-key	GUID	—	Carpeta de destino por clave.

Configuración del proceso

Corto	Largo	Valor	Predeterminado	Descripción
—	--description	text	—	Descripción del proceso.
—	--entry-point	Ruta	—	Ruta del flujo de trabajo del punto de entrada (para paquetes de varios puntos de entrada).
—	--input-arguments	JSON	—	Argumentos de entrada predeterminados como JSON.
—	--job-priority	ENUM	—	Low, Normal, High. Mutuamente excluyente con --specific-priority.
—	--specific-priority	1–100	—	Prioridad numérica. Mutuamente excluyente con --job-priority.
—	--robot-size	ENUM	—	Tamaño de Cloud Robot: Small, Standard, Medium, Large.
—	--tags	CSV	—	Nombres de etiquetas separados por comas.
—	--environment-variables	text	—	Environment variables as newline-separated KEY=VALUE pairs (not JSON), e.g. $'FOO=bar\nBAZ=qux'.
—	--auto-update / --no-auto-update	Marca	—	Habilitar/deshabilitar la actualización automática a la última versión del paquete.
—	--hidden-for-attended / --visible-for-attended	Marca	—	Ocultar o mostrar a los usuarios atendidos. Mutuamente excluyentes.
—	--auto-create-triggers / --no-auto-create-triggers	Marca	—	Crear automáticamente desencadenadores conectados en la implementación.

Retención

Corto	Largo	Valor	Predeterminado	Descripción
—	--retention-period	días (1–180)	30	Período de retención del trabajo.
—	--retention-action	ENUM	Delete	Delete, Archive o None.
—	--retention-bucket	ID de depósito	—	ID de depósito de almacenamiento. Obligatorio cuando --retention-action Archive.
—	--stale-retention-period	días	—	Período de retención de trabajo obsoleto.
—	--stale-retention-action	ENUM	—	Delete, Archive o None.

Ejemplos

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'

Forma de datos (--json de salida)

{
  "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 o procesos actualizar-versión

Actualiza uno o más procesos a la última versión del paquete o a una versión específica con --package-version. La carpeta es opcional: si no se proporciona, se infiere de la primera clave del proceso.

• Una clave + ninguna --package-version → actualizar a la última (llamada única a la API).
• Una tecla + --package-version → actualizar a esa versión (llamada única a la API).
• Varias claves + ninguna --package-version → actualización masiva a la última.
• Varias claves + --package-version → rechazado (error de validación).

Los trabajos en ejecución no se ven afectados; solo los trabajos nuevos utilizan la versión actualizada.

Argumentos

Nombre	Obligatorio	Propósito
<process-keys...>	Sí	Una o más claves de proceso (GUID).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--folder-path	Ruta	inferido	Omita la detección automática y utilice esta carpeta.
—	--folder-key	GUID	inferido	Omita la detección automática y utilice esta carpeta.
—	--package-version	2020.x	—	Versión específica. Solo es válido con una sola clave.

Ejemplos

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'

Forma de datos (--json de salida)

Clave única:

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

Devuelve Code: "ProcessVersionsUpdated" de forma masiva con ProcessKeys, Version y un objeto Result repetido desde la 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

Nombre	Obligatorio	Propósito
<process-key>	Sí	Clave de proceso (GUID).

Opciones

Los mismos campos que processes create excepto por las tres opciones de paquete necesarias y los marcadores de ámbito. Las reglas de exclusión mutua y validación coinciden create (--job-priority frente a --specific-priority, --hidden-for-attended frente a --visible-for-attended, Archive la retención requiere --retention-bucket).

Corto	Largo	Valor	Predeterminado	Descripción
-n	--name	text	—	Nuevo nombre para mostrar.
-d	--description	text	—	Nueva descripción.
—	--entry-point	Ruta	—	Nueva ruta de punto de entrada.
—	--input-arguments	JSON	—	Argumentos de entrada predeterminados.
—	--environment-variables	text	—	Newline-separated KEY=VALUE pairs (not JSON). Pass '' to clear them.
—	--job-priority	ENUM	—	Low, Normal, High.
—	--specific-priority	1–100	—	Prioridad numérica.
—	--auto-update / --no-auto-update	Marca	—	Alternar actualización automática.
—	--hidden-for-attended / --visible-for-attended	Marca	—	Visibilidad atendida.
—	--auto-create-triggers / --no-auto-create-triggers	Marca	—	Creación automática de desencadenadores conectados.
—	--healing-agent / --no-healing-agent	Marca	—	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	días (1–180)	—	Período de retención del trabajo.
—	--retention-action	ENUM	—	Delete, Archive, None.
—	--retention-bucket	ID de depósito	—	Obligatorio cuando --retention-action Archive.
—	--stale-retention-period	días	—	Período de retención de trabajo obsoleto.
—	--stale-retention-action	ENUM	—	Delete, Archive, None.

Ejemplos

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'

Forma de datos (--json de salida)

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

Nombre	Obligatorio	Propósito
<process-key>	Sí	Clave de proceso (GUID). Encuéntralo con processes list.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-y	--yes	Marca	—	Required. Confirms this irreversible operation — the CLI never prompts.

Ejemplos

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

Forma de datos (--json de salida)

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

reversión de uip o procesos

Revierte un proceso a su versión anterior del paquete. La carpeta es opcional: si no se proporciona, se infiere de la clave del proceso.

Argumentos

Nombre	Obligatorio	Propósito
<process-key>	Sí	Clave de proceso (GUID).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--folder-path	Ruta	inferido	Omitir la detección automática.
—	--folder-key	GUID	inferido	Omitir la detección automática.

Ejemplos

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'

Forma de datos (--json de salida)

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

Códigos de salida

Consulta Códigos de salida. No hay anulaciones específicas de verbos más allá de los errores de validación estándar.

Comandos relacionados

• uip or packages — busca claves de paquete (packages list), versiones (packages versions) y puntos de entrada (packages entry-points) antes de llamar a processes create.
• uip or jobs , especialmente jobs start, que requiere una clave de proceso.
• uip or folders : crea o localiza la carpeta de destino antes de vincular.

Ver también

• Opciones globales.
• Sesiones.