UiPath Documentation
uipath-cli
latest
false
UiPath-CLI-Benutzerhandbuch
Wichtig :
Dieser Inhalt wurde maschinell übersetzt. Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.

uip oder process-roi

Syntax und Optionen für „uip oder process-roi“, das die Business-ROI-Konfiguration eines Orchestrator-Prozesses verwaltet.

uip or process-roi verwaltet die Business-ROI-Konfiguration eines Prozesses: die manuelle Zeit, die ein Mensch pro Element aufwendet, das Elementvolumen, die Mitarbeiterkosten und die Kosten pro Element. Jeder Prozess hat höchstens eine ROI-Konfiguration. Dieselbe Konfiguration für eine Warteschlange finden Sie unter uip or queue-roi.

Informationen zu den ressourcenübergreifenden Konventionen (Authentifizierung, Ordner-Scoping, Schlüsseltypen, Ausgabeumschlag) finden Sie in der uip or -Übersicht.

Hinweis:

Jedes Verb benötigt den Scope OR.BusinessValue bei der Anmeldung, die Berechtigung des BusinessValue-Ordners, die dem Verb entspricht (Anzeigen, Erstellen, Bearbeiten oder Löschen), und die für den Mandanten aktivierte Business-ROI-Funktion.

Zusammenfassung​

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>]
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>]

Verben​

VerbZweck
getRufen Sie die ROI-Konfiguration eines Prozesses ab. Meldet Configured: false wenn keine vorhanden ist.
createErstellen Sie die ROI-Konfiguration eines Prozesses. Schlägt fehl, wenn einer vorhanden ist.
updateAktualisieren Sie die ROI-Konfiguration eines Prozesses. Werte, die Sie nicht übergeben, behalten ihre aktuelle Einstellung bei.
deleteLöschen der ROI-Konfiguration eines Prozesses.

Argumente​

Jedes Verb verwendet dasselbe Positionargument.

NameErforderlichZweck
<process>jaProzessname oder Schlüssel (GUID). Ein Name benötigt --folder-path oder --folder-key wenn er in mehreren Ordnern vorhanden ist, die Sie sehen können. Prozesse mit uip or processes list finden.

Ordneroptionen​

Jedes Verb akzeptiert diese Optionen. Sie bereichen eine Namenssuche und werden nicht für einen Schlüssel benötigt.

ShortLongWertStandardBeschreibung
–--folder-pathPfad–Ordnerpfad, in dem der Prozessname gesucht wird (z. B. Shared).
–--folder-keyGUID–Ordnerschlüssel, in dem der Prozessname gesucht wird.

uip oder process-roi abrufen​

Rufen Sie die ROI-Konfiguration eines Prozesses ab. Wenn der Prozess keine ROI-Konfiguration hat, ist der Befehl mit Configured: false erfolgreich.

Beispiele​

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'
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'

Datenform (--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"
  }
}
{
  "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"
  }
}

Ein Prozess ohne ROI-Konfiguration gibt nur ProcessKey, ProcessName, Folder und Configured: false zurück.

FeldBeschreibung
KeySchlüssel der ROI-Konfiguration.
EnabledOb die ROI-Nachverfolgung für den Prozess aktiviert ist.
ManualTimePerItem / ManualTimeUnitManuelle Zeit, die ein Mensch pro Element aufwendet, und dessen Einheit.
ProcessVolume / ProcessVolumePeriodPro Zeitraum verarbeitete Elemente. null wenn nicht festgelegt.
EmployeeCost / EmployeeCostPeriodVollständig geladene Mitarbeiterkosten in USD während des Zeitraums. null wenn nicht festgelegt.
ManualCostPerItemManuelle Kosten pro Element in USD. null wenn nicht festgelegt, dann berechnet die Orchestrator-Benutzeroberfläche ihn aus den anderen Werten.
CurrencyWährung der Kostenwerte.

uip oder process-roi erstellen​

Erstellen Sie die ROI-Konfiguration eines Prozesses. Erfordert --manual-time. Schlägt fehl, wenn der Prozess bereits über eine ROI-Konfiguration verfügt; Verwenden Sie update um dies zu ändern.

Optionen​

ShortLongWertStandardBeschreibung
–--manual-timeganze Zahl, 0 oder mehrerforderlichManuelle Zeit, die ein Mensch pro Element verbringt, in --time-unit.
–--time-unitSeconds, Minutes, HoursMinutesEinheit von --manual-time.
–--volumeganze Zahl, 0 oder mehr–Verarbeitete Elemente pro --volume-period.
–--volume-periodDay, Week, Month, YearMonth wenn --volume festgelegt istZeitraum --volume ist ab. Erfordert --volume.
–--employee-costZahl, 0 oder mehr, bis zu 4 Dezimalstellen–Vollständig geladene Kosten des Mitarbeiters, der die Arbeit ausführt, in USD über --cost-period.
–--cost-periodAnnual, HourlyAnnual wenn --employee-cost festgelegt istZeitraum --employee-cost ist zum Ende ausgedrückt. Erfordert --employee-cost.
–--cost-per-itemZahl, 0 oder mehr, bis zu 4 Dezimalstellen–Manuelle Kosten pro Element in USD. Wenn er nicht angegeben wird, berechnet die Orchestrator-Benutzeroberfläche ihn aus den anderen Werten.
–--disabledMarkierenausErstellen Sie die Konfiguration mit deaktivierter ROI-Nachverfolgung („nicht anwendbar“ der Benutzeroberfläche).

Der Orchestrator wendet die für den Mandanten konfigurierten Obergrenzen an. Standardmäßig sind die Grenzwerte 10.000 für --manual-time, 10.000.000 für --volume und --employee-cost und 100.000 für --cost-per-item.

Beispiele​

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'
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'

Datenform (--output json)​

Code: "ProcessRoiCreated", mit den gleichen Data Feldern wie get.

uip oder process-roi update​

Aktualisieren Sie die ROI-Konfiguration eines Prozesses. Werte, die Sie nicht übergeben, behalten ihre aktuelle Einstellung bei. Übergeben Sie mindestens eine Wertoption, --enabled, --disabled oder eine --no-* -Option. Schlägt mit ErrorCode: "not_found" fehl, wenn der Prozess keine ROI-Konfiguration hat; Verwenden Sie zuerst create .

Optionen​

update akzeptiert die Wertoptionen von create, alle optional und ohne Standardeinstellungen. Wenn Sie --volume oder --employee-cost ohne Zeitraum festlegen, wird der gespeicherte Zeitraum beibehalten oder es wird der Standardwert create verwendet, wenn keiner gespeichert wird. Es akzeptiert auch:

ShortLongWertStandardBeschreibung
–--no-volumeMarkieren–Löschen Sie das gespeicherte Volume und seinen Zeitraum.
–--no-employee-costMarkieren–Löschen Sie die gespeicherten Mitarbeiterkosten und deren Zeitraum.
–--no-cost-per-itemMarkieren–Löschen Sie die manuellen Kosten pro Element, damit die Orchestrator-Benutzeroberfläche sie erneut berechnet.
–--enabledMarkieren–Aktivieren Sie die ROI-Nachverfolgung. Sich gegenseitig mit --disabled ausschließen.
–--disabledMarkieren–ROI-Nachverfolgung deaktivieren. Sich gegenseitig mit --enabled ausschließen.

Beispiele​

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'
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'

Datenform (--output json)​

Code: "ProcessRoiUpdated", mit den gleichen Data Feldern wie get.

uip oder process-roi löschen​

Löschen der ROI-Konfiguration eines Prozesses. Erfordert -y, --yes – die CLI fordert nie zu destruktiven Vorgängen auf.

Optionen​

ShortLongWertStandardBeschreibung
-y--yesMarkieren–Erforderlich. Bestätigt das Löschen.

Beispiele​

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

Datenform (--output json)​

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

Exitcodes​

Weitere Informationen finden Sie unter Austrittscodes für den gemeinsamen Vertrag. Verbspezifisches Verhalten:

  • update beendet 3 (ValidationError), wenn keine Wertoption übergeben wird.
  • create und update beenden 3 wenn --volume-period ohne --volume übergeben wird, wenn --cost-period ohne --employee-cost übergeben wird oder wenn --enabled und --disabled beide übergeben werden.
  • update beendet 1 mit ErrorCode: "not_found" , wenn der Prozess keine ROI-Konfiguration hat.
  • delete beendet 1 wenn -y, --yes weggelassen wird.

Siehe auch​

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support(opens in new window)

Möchten Sie lernen? UiPath Academy(opens in new window)

Haben Sie Fragen? UiPath-Forum(opens in new window)

Auf dem neuesten Stand bleiben