uip or process-roi

Syntax and options for `uip or process-roi`, which manages the Business ROI configuration of an Orchestrator process.

uip or process-roi manages the Business ROI configuration of a process: the manual time a human spends per item, the item volume, the employee cost, and the cost per item. Each process has at most one ROI configuration. For the same configuration on a queue, refer to uip or queue-roi.

For the cross-resource conventions (auth, folder scoping, key types, output envelope), refer to the uip or overview.

Observação:

Every verb needs the OR.BusinessValue scope on the login, the BusinessValue folder permission that matches the verb (View, Create, Edit, or Delete), and the Business ROI feature enabled on the tenant.

Resumo

uip or process-roi get     <process> [--folder-path <path> | --folder-key <key>]
uip or process-roi create  <process> --manual-time <number> [value options] [--disabled] [--folder-path <path> | --folder-key <key>]
uip or process-roi update  <process> [value options] [--no-volume] [--no-employee-cost] [--no-cost-per-item] [--enabled | --disabled] [--folder-path <path> | --folder-key <key>]
uip or process-roi delete  <process> --yes [--folder-path <path> | --folder-key <key>]

Verbo

Texto	Finalidade
get	Get the ROI configuration of a process. Reports Configured: false when none exists.
create	Create the ROI configuration of a process. Fails when one exists.
update	Update the ROI configuration of a process. Values you do not pass keep their current setting.
delete	Delete the ROI configuration of a process.

Argumentos

Every verb takes the same positional argument.

Name	Required	Finalidade
<process>	sim	Process name or key (GUID). A name needs --folder-path or --folder-key when it exists in more than one folder you can see. Find processes with uip or processes list.

Opções de pasta

Every verb accepts these options. They scope a name lookup and are not needed for a key.

Short	Long	Valor	Padrão	Description
—	--folder-path	Path	—	Folder path the process name is looked up in (for example, Shared).
—	--folder-key	GUID	—	Folder key the process name is looked up in.

uip or process-roi get

Get the ROI configuration of a process. When the process has no ROI configuration, the command succeeds with Configured: false.

Exemplos

uip or process-roi get InvoiceProcessing --folder-path Shared
uip or process-roi get c3d4e5f6-0000-0000-0000-000000000001
uip or process-roi get c3d4e5f6-0000-0000-0000-000000000001 \
    --output-filter 'Configured'

Formato dos dados (--output json)

{
  "Code": "ProcessRoiGet",
  "Data": {
    "ProcessKey": "c3d4e5f6-0000-0000-0000-000000000001",
    "ProcessName": "InvoiceProcessing",
    "Folder": "Shared",
    "Configured": true,
    "Key": "e5f6a7b8-0000-0000-0000-000000000001",
    "Enabled": true,
    "ManualTimePerItem": 12,
    "ManualTimeUnit": "Minutes",
    "ProcessVolume": 4000,
    "ProcessVolumePeriod": "Month",
    "EmployeeCost": 65000,
    "EmployeeCostPeriod": "Annual",
    "ManualCostPerItem": null,
    "Currency": "Usd"
  }
}

A process with no ROI configuration returns only ProcessKey, ProcessName, Folder, and Configured: false.

Campo	Description
Key	Key of the ROI configuration.
Enabled	Whether ROI tracking is on for the process.
ManualTimePerItem / ManualTimeUnit	Manual time a human spends per item, and its unit.
ProcessVolume / ProcessVolumePeriod	Items processed per period. null when not set.
EmployeeCost / EmployeeCostPeriod	Fully loaded employee cost, in USD, over the period. null when not set.
ManualCostPerItem	Manual cost per item, in USD. null when not set, in which case the Orchestrator UI computes it from the other values.
Currency	Currency of the cost values.

uip or process-roi create

Create the ROI configuration of a process. Requires --manual-time. Fails when the process already has an ROI configuration; use update to change it.

Opções

Short	Long	Valor	Padrão	Description
—	--manual-time	whole number, 0 or more	necessário	Manual time a human spends per item, in --time-unit.
—	--time-unit	Seconds, Minutes, Hours	Minutes	Unit of --manual-time.
—	--volume	whole number, 0 or more	—	Items processed per --volume-period.
—	--volume-period	Day, Week, Month, Year	Month when --volume is set	Period --volume is measured over. Requires --volume.
—	--employee-cost	number, 0 or more, up to 4 decimals	—	Fully loaded cost of the employee doing the work, in USD, over --cost-period.
—	--cost-period	Annual, Hourly	Annual when --employee-cost is set	Period --employee-cost is expressed over. Requires --employee-cost.
—	--cost-per-item	number, 0 or more, up to 4 decimals	—	Manual cost per item, in USD. When omitted, the Orchestrator UI computes it from the other values.
—	--disabled	Bandeira	desativada	Create the configuration with ROI tracking off (the UI's "not applicable").

Orchestrator applies upper limits configured on the tenant. By default, the limits are 10,000 for --manual-time, 10,000,000 for --volume and --employee-cost, and 100,000 for --cost-per-item.

Exemplos

uip or process-roi create InvoiceProcessing --folder-path Shared --manual-time 12

uip or process-roi create c3d4e5f6-0000-0000-0000-000000000001 \
    --manual-time 12 --time-unit Minutes \
    --volume 4000 --volume-period Month \
    --employee-cost 65000 --cost-period Annual

uip or process-roi create c3d4e5f6-0000-0000-0000-000000000001 \
    --manual-time 0 --disabled --output-filter 'Key'

Formato dos dados (--output json)

Code: "ProcessRoiCreated", with the same Data fields as get.

uip or process-roi update

Update the ROI configuration of a process. Values you do not pass keep their current setting. Pass at least one value option, --enabled, --disabled, or a --no-* option. Fails with ErrorCode: "not_found" when the process has no ROI configuration; use create first.

Opções

update accepts the value options of create, all optional and without defaults. When you set --volume or --employee-cost without a period, the stored period is kept, or the create default is used when none is stored. It also accepts:

Short	Long	Valor	Padrão	Description
—	--no-volume	Bandeira	—	Clear the stored volume and its period.
—	--no-employee-cost	Bandeira	—	Clear the stored employee cost and its period.
—	--no-cost-per-item	Bandeira	—	Clear the manual cost per item, so the Orchestrator UI computes it again.
—	--enabled	Bandeira	—	Turn ROI tracking on. Mutually exclusive with --disabled.
—	--disabled	Bandeira	—	Turn ROI tracking off. Mutually exclusive with --enabled.

Exemplos

uip or process-roi update InvoiceProcessing --folder-path Shared --volume 5000

uip or process-roi update c3d4e5f6-0000-0000-0000-000000000001 \
    --employee-cost 45 --cost-period Hourly --no-cost-per-item

uip or process-roi update c3d4e5f6-0000-0000-0000-000000000001 \
    --disabled --output-filter 'Enabled'

Formato dos dados (--output json)

Code: "ProcessRoiUpdated", with the same Data fields as get.

uip or process-roi delete

Delete the ROI configuration of a process. Requires -y, --yes — the CLI never prompts for destructive operations.

Opções

Short	Long	Valor	Padrão	Description
-y	--yes	Bandeira	—	Required. Confirms the deletion.

Exemplos

uip or process-roi delete c3d4e5f6-0000-0000-0000-000000000001 --yes

Formato dos dados (--output json)

{
  "Code": "ProcessRoiDeleted",
  "Data": {
    "ProcessKey": "c3d4e5f6-0000-0000-0000-000000000001",
    "ProcessName": "InvoiceProcessing",
    "Folder": "Shared",
    "Status": "Deleted"
  }
}

Códigos de saída

Refer to Exit codes for the shared contract. Verb-specific behavior:

• update exits 3 (ValidationError) when no value option is passed.
• create and update exit 3 when --volume-period is passed without --volume, when --cost-period is passed without --employee-cost, or when --enabled and --disabled are both passed.
• update exits 1 with ErrorCode: "not_found" when the process has no ROI configuration.
• delete exits 1 if -y, --yes is omitted.

Comandos relacionados

• uip or processes — find process names and keys.
• uip or queue-roi — the Business ROI configuration of a queue.

Veja também

• Visão geraluip or — convenções compartilhadas para cada verbo uip or .