uip maestro flow registry

Syntax and options for `uip maestro flow registry`, which browses the catalog of built-in activities and connector nodes available in Flow.

uip maestro flow registry durchsucht die Flow-Knotenregistrierung – den Katalog der Bausteine, die in einer .flow -Datei verwendet werden können. Die Registrierung enthält OOTB-Aktivitäten (uipath.agent, uipath.http, …) und Connectorknoten, die APIs von Drittanbietern (Slack, Salesforce, Jira, …) aufrufen. Wenn Sie angemeldet sind, enthält die Registrierung zusätzlich Connectorknoten, die in Ihrem Mandanten installiert sind.

Die Registrierung enthält auch Dokumentextraktionsknoten für veröffentlichte UiPath IXP-Modelle (uipath.ixp.*).

Die Registrierung wird für alle UiPath Workflow-Oberflächen freigegeben; Dieselbe Implementierung unterstützt uip maestro (siehe Maestro-Registrierung, verfügbar über uip maestro bpmn registry).

Alle Unterbefehle berücksichtigen globale Optionen. Austrittscodes folgen dem Standardvertrag.

Zusammenfassung

uip maestro flow registry pull   [-f, --force]
uip maestro flow registry list   [-l, --limit <n>] [--local]
uip maestro flow registry search [<keyword>] [-f, --filter <expr>] [--local]
uip maestro flow registry get    <nodeType> [--connection-id <id>] [--local]

Typischer Workflow

# 0. (Optional) Login for the full, tenant-enriched registry
uip login

# 1. Sync the registry (once per session — cache expires after 30 minutes)
uip maestro flow registry pull

# 2. Search for a candidate node
uip maestro flow registry search slack --filter "displayname:contains=send"

# 3. Inspect the full schema
uip maestro flow registry get uipath.connector.slack.send-message

# 4. Extract just the input field definitions (useful for building requests)
uip maestro flow registry get uipath.connector.slack.send-message \
  --output-filter "Node.inputDefinition.fields"

Ohne Anmeldung werden nur integrierte (OOTB)-Knoten zurückgegeben.

---

uip maestro flow registry pull

Ruft die Knotenregistrierung ab und schreibt sie in einen lokalen Cache. Nachfolgende Aufrufe von list, search und get lesen aus diesem Cache.

Optionen

• -f, --force – Erzwingen Sie die Aktualisierung und ignorieren Sie den Cache.

Cache-Verhalten

• Cache läuft nach 30 Minuten ab. Ein abgelaufener oder fehlender Cache löst einen Live-Abruf aus.
• Wenn Sie nicht angemeldet sind, werden OOTB-Knoten zurückgegeben, ohne den Cache zu aktualisieren.
• Bei einem authentifizierten Abruffehler greift der Befehl auf OOTB-Knoten zurück, ohne den Cache zu aktualisieren.

Datenform (--output json)

{
  "Code": "NodePullSuccess",
  "Data": {
    "NodesCount":   184,
    "FromCache":    false,
    "AgeMinutes":   null,
    "Source":       "authenticated",
    "CacheWritten": true,
    "Message":      "Synced fresh nodes",
    "Info":         null
  }
}

Source ist "ootb" (nicht authentifiziert) oder "authenticated" (mandantenspezifisch). AgeMinutes wird ausgefüllt, wenn FromCache: true.

---

uip maestro flow registry list

Beispiele für zwischengespeicherte Knoten. Standardmäßig die ersten 20 Einträge.

Optionen

Option	Standard	Beschreibung
-l, --limit <n>	20	Anzahl der zurückzugebenden Knoten. Übergeben Sie -1 für alle. Muss ein positiver Integer oder -1 sein.
--local	aus	Nur Projektknoten in Lösung anzeigen. Erfordert ein .uipx im CWS, übergeordnetes oder übergeordnetes Element.

Wenn list ohne vorheriges pull aufgerufen wird, ruft der Dienst zuerst Live-Daten ab.

Datenform

{
  "Code": "NodeListSuccess",
  "Data": [
    {
      "NodeType":    "uipath.slack.connector.send-message",
      "Category":    "connector",
      "DisplayName": "Send Message",
      "Description": "Post a message to a Slack channel",
      "Version":     "1.0.0",
      "Tags":        "slack, messaging"
    }
  ]
}

Wenn das Ergebnis abgeschnitten ist, wird eine Protokollzeile für die Standardzeile ausgegeben, in der der Gesamtwert im Vergleich zum angezeigten angezeigt wird.

---

uip maestro flow registry search

Suchen Sie Knoten anhand des Schlüsselworts, des strukturierten Filters oder von beiden.

Argumente

• [keyword] – Teilzeichenfolge, die mit nodeType, category, tags, display.label, description abgeglichen wurde.

Optionen

Option	Beschreibung
-f, --filter <expr>	Strukturierter Feldfilter (siehe Syntax unten).
--local	Suche nur in Lösungsknoten (erfordert .uipx in der Nähe).

Von den Optionen <keyword> und --filter ist mindestens eine erforderlich.

Filtersyntax

field=value                     # equality (default operator)
field:operator=value            # operator variant
field1=v1,field2=v2             # multiple conditions (AND)

Operatoren: equals (Standard), contains, startsWith, endsWith, in.

Filterbare Felder (Alias in Klammern angezeigt):

• category [cat] – z. B connector, agent, trigger
• type [nodetype] – Knotentypbezeichner
• tags [tag] – Knoten-Tags
• displayname [display_name, name, label] – für Menschen lesbarer Name

Beispiele

uip maestro flow registry search slack
uip maestro flow registry search --filter "category=connector"
uip maestro flow registry search --filter "displayname:contains=send message"
uip maestro flow registry search slack --filter "category=connector"
uip maestro flow registry search --filter "tags:in=ai,automation"
uip maestro flow registry search --filter "category=connector,displayname:contains=slack"
uip maestro flow registry search uipath.ixp

Datenform: Die gleiche Form wie list – Code: "NodeSearchSuccess", Data: [flattened nodes…].

---

uip maestro flow registry get

Vollständige Details für einen einzelnen Knoten zurückgeben.

Argumente

• <nodeType> (erforderlich) – Knotentypbezeichner (keine Beachtung von Groß-/Kleinschreibung).

Optionen

Option	Beschreibung
--connection-id <id>	Verbindungs-ID für die Integration Service-Anreicherung. Erforderlich für Connector- Triggerknoten ; Optional für Connector- Aktivitätsknoten .
--local	Nur Knoten aus In-Lösungs-Projekten abrufen.

Integration Service-Anreicherung

Für Knoten mit dem Tag "connector" ruft get automatisch den Integration Service auf und führt Live-Metadaten zusammen:

Connector-Aktivitätsknoten (uipath.connector.*, nicht Trigger):

• inputDefinition.fields[] – Felder zu konfigurieren. Jeder hat name, displayName, type, required und optional reference (Suche: objectName, path, lookupValue, lookupNames, childPath) oder enum.
• outputResponseDefinition – Felder, die nach der Knotenausführung erzeugt werden.
• connectorMethodInfo – HTTP-Methode, Pfad,operationId.
• --connection-id ist optional; Wenn Sie eine übergeben, werden benutzerdefinierte Felder hinzugefügt, die für dieses Konto spezifisch sind.

Connector-Triggerknoten (uipath.connector.trigger.*):

• eventParameters – Felder, die den Trigger konfigurieren (z. B. welcher Ordner überwacht werden soll).
• filterFields – Felder, die verwendet werden, um zu filtern, welche Ereignisse den Trigger auslösen.
• outputResponseDefinition – Felder, die von der Ereignisnutzlast erzeugt werden.
• eventMode – "webhooks" oder "polling".
• Anmeldung und --connection-id sind erforderlich – ohne beides wird keine Anreicherung zurückgegeben.

Metadaten pro Eingabefeld

Jeder Eintrag unter inputDefinition.fields:

Eigenschaften	Beschreibung
name	JSON-Schlüssel für die Anforderung/Antwort.
displayName	Für Menschen lesbare Beschriftung.
type	Datentyp (string, boolean, integer, …).
required	true wenn obligatorisch (nur Eingabefelder).
description	Was das Feld bewirkt.
enum	Zulässige Werte (wenn eingeschränkt).
reference	Objektreferenzmetadaten – Das Feld erwartet eine ID, keinen einfachen Namen.
responseOnly	true in Ausgabefeldern.

Datenform

{
  "Code": "NodeGetSuccess",
  "Data": {
    "Node": {
      "nodeType":        "uipath.slack.connector.send-message",
      "category":        "connector",
      "display":         { "label": "Send Message" },
      "inputDefinition": {
        "fields": [
          { "name": "channel", "required": true, "type": "string" }
        ]
      }
    }
  }
}

Beispiele

# Basic activity lookup (anonymous, OOTB)
uip maestro flow registry get uipath.agent

# Connector activity with optional account-specific enrichment
uip maestro flow registry get uipath.connector.uipath-salesforce-slack.send-message \
  --connection-id <connection-id>

# Connector trigger — requires login + connection-id
uip maestro flow registry get uipath.connector.trigger.uipath-microsoft-outlook365.email-received \
  --connection-id <connection-id>

# Just the input fields, for building a request body
uip maestro flow registry get uipath.connector.slack.send-message \
  --output-filter "Node.inputDefinition.fields" --output json

IXP-Modellknoten

Veröffentlichte UiPath IXP-Extraktionsmodelle werden in der Registrierung als Knotentypen unter dem Namespace uipath.ixp.* angezeigt. Der Bezeichner codiert das Modell – zum Beispiel:

• uipath.ixp.invoice-model.shared-invoice-model
• uipath.ixp.birth-certificates-oob.shared-birth-certificates-oob

Eine Namespace-Suche gibt sie zurück:

uip maestro flow registry search uipath.ixp

uip maestro flow registry get <nodeType> gibt die Bereitstellungskoordinaten unter inputDefaults (inputDefaults.modelName und inputDefaults.folderKey) zurück, die den inputs.model -Block des Knotens ausfüllen, wenn der Knoten zu einem Flow hinzugefügt wird.

Instanzform

Ein uipath.ixp.* -Knoten, der einer .flow -Datei hinzugefügt wurde, muss dieser Form folgen:

Feld	Anforderungen
inputs.model	Objekt mit nicht leerer Zeichenfolge modelName und folderKey.
inputs.fileRef	Ein =js:$vars.… -Ausdruck, der auf eine Upstream-Ausgabe verweist, im Format =js:$vars.<upstream>.output.<field>.
outputs.output	Auf der Instanz vorhanden. Downstream-Knoten lesen $vars.<nodeId>.output.
outputs.error	Auf der Instanz vorhanden. Downstream-Knoten lesen $vars.<nodeId>.error.

Informationen zum Verknüpfen erkannter Knoten mit einem Flow finden Sie unter uip maestro flow node add und uip maestro flow node configure.

Siehe auch

• uip maestro flow node add und uip maestro flow node configure – verbrauchen Knotentypen, die hier erkannt wurden
• Flow-Übersicht