uip-Maestro-Fall

Erstellen, Packen, Debuggen, Validieren und Erstellen von Fallverwaltungsprojekten mithilfe von „uip Maestro Case“, der dritten Oberfläche für Maestro-Orchestrierung neben BPMN und Flow.

uip maestro case erstellt, verpackt, debuggt und erstellt Fallverwaltungsprojekte – eine dritte Maestro-Orchestrierungsoberfläche neben BPMN und Flow. Ein Fallprojekt modelliert eine langlaufende, von Menschen gesteuerte Arbeitseinheit als Fallplan: ein JSON-Dokument (caseplan.json), das Phasen, Aufgaben, SLAs, Trigger und die Eintritts-/Austrittsbedingungen beschreibt, die einen Fall zwischen Phasen verschieben – näher an einem strukturierten Workflow mit einem Lebenszyklus als ein linearer Prozess ist.

Das Tool wird als separates @uipath/case-tool -Paket ausgeliefert, das dynamisch von @uipath/maestro-tool unter der case -Verzweigung geladen wird – jeder Befehl wird hier als uip maestro case <verb> aufgerufen, niemals als eigenständiges uip case.

Diese Ressource umfasst neun Seiten

• Diese Seite – Konzepte und die Befehle für den Projektlebenszyklus: init, pack, debug, validate, spec.
• registry – Durchsuchen/Durchsuchen des Automatisierungsressourcenkatalogs, zu dem Aufgaben verarbeitet werden, und durchsuchen, wie eine Aufgabeneingabe an eine Variable gebunden wird.
• cases und stages – lesen Sie die Metadaten und die Phasenliste des Fallplans auf oberster Ebene.
• tasks – Lesen, anreichern und beschreiben von Aufgabendefinitionen innerhalb einer Phase.
• task-entry-conditions – Liest die Regeln, die festgelegt werden, wenn eine Aufgabe ausführbar wird.
• sla – SLA-/Eskalationsregeln lesen.
• triggers, sticky-notes, edges – Lesen Sie Falltrigger, Anmerkungen auf der Arbeitsfläche und Übergänge von Phase zu Phase.
• case-exit-conditions, stage-entry-conditions, stage-exit-conditions – Lesen Sie die Bedingungsregeln auf Fall- und Phasenebene.
• process, processes, job, instances, incidents – Bereitstellen und Ausführen von Fallinstanzen im Orchestrator.

Konzepte

• Das Autorenmodell: Bearbeiten Sie caseplan.json direkt und dann validate. Es gibt keinen CLI-gesteuerten Migrationspfad für Fallinhalte. Verfassen oder bearbeiten Sie caseplan.json manuell (oder lassen Sie dies von einem Agent ausführen, der sich durch die JSON-Form-Referenzen der uipath-maestro-case -Fähigkeit geführt wird) und führen Sie dann uip maestro case validate aus, um es zu überprüfen. Die read -Verben, die auf den gleichgeordneten Seiten oben dokumentiert sind (cases get, stages list, tasks get usw.) helfen Ihnen, den Plan zu überprüfen, während Sie ihn auf diese Weise erstellen – sie sind nicht Teil einer Schreib-API.
• Fall vs. BPMN vs. Flow – alle drei sind Maestro-Orchestrierungsoberflächen, die auf .nupkg gepackt werden und Runtime / process/job/instances/registry), aber eine eigene für die Fallverwaltungincidentsteilen Das primäre Asset ist caseplan.json (plus ein generiertes caseplan.json.bpmn) und sein Projekttyp ist CaseManagement in operate.json/project.uiproj – unterscheidet sich von .bpmn von BPMN und .flow von Flow.
• Validierungsprofile – validate führt eines von vier Profilen aus, je nachdem, wie weit die Erstellung ist: skeleton (nur Struktur – Knoten, Edges, Identität, Typen), skeleton-v2 (S Zeit dafür überprüft und überspringt immer noch Aufgabeninhalte), strict (jede Prüfung, einschließlich Phase ohne Aufgaben, ungelöste $xref -Marker und Connector-Kontextvollständigkeit – das Gateway für abgeschlossene Fälle) und das Standardprofil full (Übergeordnet, für teilweise erstellte oder bereits gepackte Dateien). --sdd <path> prüft die Vollständigkeit anhand eines Spezifikationsdokuments und impliziert --strict.
• spec ist ein Planungstool und kein Fallplan-Mandator: Es ruft eine normalisierte Beschreibung einer Integration Service-Connector-Aktivität oder eines Triggers ab (Eingaben, Ausgaben, Pflichtfelder), damit Sie wissen, was in die Aufgabe von caseplan.json gesetzt werden soll. Triggerdefinitionen, bevor Sie sie schreiben. Finden Sie die benötigten Werte für --activity-type-id/--connection-id über registry get-connector/get-connection.

Zusammenfassung

uip maestro case init <name> [--force] [--skip-solution-registration]
uip maestro case pack <project-path> <output-path> [-n, --name <name>] [-v, --version <version>] [package-metadata options...]
uip maestro case debug <project-path> [--folder-id <id>] [--poll-interval <ms>] [--login-validity <minutes>]
uip maestro case validate <file> [--skeleton | --skeleton-v2 | --strict] [--sdd <path>]
uip maestro case spec --type <activity|trigger> --activity-type-id <uuid> --connection-id <id> [--object-name <name>] [--skip-case-shape | --input-details <json>]

UIP Maestro Fall Init

Erstellen Sie ein neues Fallprojekt mit Textbaustein-Dateien: project.uiproj, operate.json, entry-points.json, bindings_v2.json, package-descriptor.json und einem minimalen caseplan.json (nur geschrieben, wenn noch keins vorhanden ist – erneutes Ausführen von init überlappt nie einen erstellten Fallplan). Wenn die Ausführung außerhalb einer vorhandenen Lösung erfolgt, wird automatisch ein übergeordnetes <name>Solution -Framework erstellt und das Fallprojekt wird darin verschachtelt; Wenn es innerhalb einer ausgeführt wird, wird das Projekt stattdessen in dieser Lösung registriert.

Argumente

Name	Erforderlich	Zweck
<name>	ja	Der Name des Fallprojekts. Nur Buchstaben, Ziffern, Unterstriche und Bindestriche.

Optionen

Long	Wert	Beschreibung
--force	Markieren	Initialisieren Sie auch dann, wenn das Zielverzeichnis nicht leer ist. Schreibt Dateien, ohne vorhandene Inhalte zu löschen.
--skip-solution-registration	Markieren	Registrieren Sie dieses Projekt nicht automatisch in der Umgebungslösung.

Beispiel

uip maestro case init my-case-project

Datenform (--output json)

{
  "Code": "CaseInit",
  "Data": {
    "Status": "Created successfully",
    "Path": "/workspace/my-case-project",
    "CasePlan": "/workspace/my-case-project/caseplan.json",
    "CasePlanStatus": "Created",
    "SolutionRegistration": { "Status": "Registered", "Solution": "...", "ProjectId": "..." },
    "AutoCreatedSolution": { "...": "present only when a parent solution was scaffolded" },
    "ProjectArtifacts": { "...": "present only when registered into a parent solution" },
    "NextSteps": "present only when SolutionRegistration.Instructions is set"
  }
}

CasePlanStatus ist "Created" auf einem neuen Gerüst oder "Preserved", wenn ein vorhandenes caseplan.json unberührt wurde (erneutes Ausführen von init für ein Projekt, das Sie bereits erstellt haben). SolutionRegistration ist immer vorhanden – sein Status ist "NotInSolution" anstelle des Felds, das weggelassen wird, wenn keine übergeordnete Lösung vorhanden ist.

UIP Maestro Fallpack

Packen Sie ein Fallprojektverzeichnis in eine .nupkg -Datei und lesen Sie caseplan.json aus dem Projektstamm.

Argumente

Name	Erforderlich	Zweck
<project-path>	ja	Pfad zum Verzeichnis des Falls.
<output-path>	ja	Ausgabeverzeichnis für .nupkg.

Optionen

Long	Wert	Beschreibung
-n, --name <name>	string	Paketname. Standard: Name des Projektordners.
-v, --version <version>	string	Paketversion Der Standardwert ist 1.0.0.

Akzeptiert auch die freigegebenen Paketmetadatenoptionen dieses Repositorys (--repository-url/--repository-commit/--repository-branch/--repository-type, --release-notes, --project-url, --author, --description) – siehe alle anderen pack -Befehle Optionstabelle (z. B. uip maestro bpmn pack) für den vollständigen freigegebenen Satz, den dieser Befehl identisch registriert.

Beispiel

uip maestro case pack ./my-case-project ./dist --version 1.2.0

Datenform (--output json)

{
  "Code": "CasePack",
  "Data": {
    "Package": "my-case-project.1.2.0.nupkg",
    "Output": "./dist/my-case-project.1.2.0.nupkg"
  }
}

Ein Schemafehler beim Packen (eine falsch formatierte caseplan.json) wird mit fallspezifischen Anweisungen angereichert, bevor er als Fehler angezeigt wird – erwarten Sie eine umsetzbare Instructions, keinen unformatierten Parser-Fehler.

UIP Maestro-Falldebuggen

Debuggen Sie ein Fallprojekt, indem Sie es in Studio Web hochladen und dort eine Debugging-Sitzung ausführen – es gibt keinen lokalen Debugmodus für die Fallverwaltung (im Gegensatz zu einigen anderen Debugging-Befehlen von Maestro).

Argumente

Name	Erforderlich	Zweck
<project-path>	ja	Pfad zum Fallprojektverzeichnis. Muss project.uiproj enthalten.

Optionen

Long	Wert	Beschreibung
--folder-id <id>	Integer	Orchestrator-Ordner-ID (OrganizationUnitId). Automatisch erkennen, wenn er weggelassen wird.
--poll-interval <ms>	Integer	Abrufintervall in Millisekunden. Der Standardwert ist 2000.
--login-validity <minutes>	Integer	Mindestens Minuten vor dem Tokenablauf, um eine Aktualisierung auszulösen. Der Standardwert ist 10.

Erfordert eine aktive Anmeldung (uip login) mit einer auflösbaren Organisation, einem Mandanten und einem Zugriffstoken – schlägt schnell mit einer bestimmten Nachricht fehl, die benennt, welcher Teil des Anmeldestatus fehlt.

Beispiel

uip maestro case debug ./my-case-project

Datenform (--output json)

{
  "Code": "CaseDebug",
  "Data": {
    "jobKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "instanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "runId": "d4e5f6a7-0000-0000-0000-000000000001",
    "finalStatus": "Completed",
    "solutionId": "e5f6a7b8-0000-0000-0000-000000000001",
    "studioWebUrl": "https://cloud.uipath.com/org/tenant/studio_/debug/e5f6a7b8",
    "elementExecutions": [
      { "elementId": "Stage_1", "status": "Completed" },
      { "elementId": "Stage_2", "status": "Completed" }
    ]
  }
}

Die Schlüssel werden in ihrem nativen BinnenMajuskel (nicht in PascalCase) gehalten – diese Nutzlast ist so konzipiert, dass sie von Auswertungsprüfern und SDKs programmgesteuert gelesen wird, und entspricht dem gleichendatensatz, der von dem Debugging-Befehl von Flow und registry get verwendet wird. Der Befehl wird ungleich Null beendet, wenn finalStatus etwas anderes als "Completed"/"Successful" ist, obwohl der Umschlag selbst Result: "Success" meldet – überprüfen Sie den Exitcode, nicht nur das Vorhandensein von Data, in Skripts.

UIP Maestro Fallvalidierung

Validieren Sie eine JSON-Datei für die Fallverwaltung anhand der Struktur- und Geschäftsregeln von Case Management.

Argumente

Name	Erforderlich	Zweck
<file>	ja	Pfad zur JSON-Datei zur Fallverwaltung (normalerweise caseplan.json).

Optionen

Long	Beschreibung
--skeleton	Nur strukturierte Prüfungen (Knoten, Edges, Identität, Typen). Überspringt Aufgabeninhalte, SLAs, Eskalationen und Eintritts-/Austrittsregeln – nützlich während der Skeleton-Phase der Erstellung. Konflikte mit --skeleton-v2/--strict.
--skeleton-v2	Skeleton-Prüfungen sowie SLA, Eskalation und Prüfungen für Eintritts-/Austrittsregeln. Überspringt immer noch Aufgabeninhalte. Konflikte mit --skeleton/--strict.
--strict	Jede Prüfung sowie der strikte Satz: eine Phase ohne Aufgaben, ungelöste $xref -Marker, eine angehaltene conditionExpression, Formen der Formel-/Ausgabebindung und Vollständigkeit des Connector-Kontexts. Das Gateway für abgeschlossene Fälle. Konflikte mit --skeleton/--skeleton-v2.
--sdd <path>	Prüfen Sie den Fallplan auf Vollständigkeit anhand des angegebenen SDD (Spezifikationsdokument) – jede Phase, Aufgabe, Aufgabentyp, Bedingungszeile, SLA, Trigger und Fallvariable müssen vorhanden sein. Impliziert --strict.

Wenn Sie alle vier Ausführungen weglassen, wird das Standardprofil full ausgeführt: nacht, sodass teilweise erstellte oder bereits gepackte Dateien weiterhin validiert werden.

Beispiele

uip maestro case validate case.json
uip maestro case validate case.json --skeleton
uip maestro case validate case.json --strict
uip maestro case validate case.json --sdd ./spec.md

Datenform (--output json)

{
  "Code": "CaseValidate",
  "Data": {
    "File": "case.json",
    "Status": "Valid",
    "Warnings": "2 warning(s):\n  - [stages[0].tasks[1]] ...",
    "Issues": [
      { "Code": "UNRESOLVED_REFERENCE", "Path": "stages[0].tasks[1]", "Message": "...", "Severity": "warning" }
    ]
  }
}

Profile: "strict" wird nur dann zu Data hinzugefügt, wenn --strict (oder --sdd) übergeben wurde. Warnings/Issues sind nur vorhanden, wenn die gültige Datei noch Warnungen erzeugte. Bei einem Fehler (Result: "Failure", Exit 1) enthält Data.Issues jeden Fehler und jede Warnung mit einem stabilen Code, Path, Message und Severity – analysieren Sie dieses Array anstelle des von Menschen lesbaren Instructions Text, wenn Sie eine Reparaturschleife steuern.

UIP Maestro Fallspezifikation

Generieren Sie ein normalisiertes ConnectorTaskSpec – alles, was zum Erstellen einer ausführbaren Integration Service-Aktivität oder Triggeraufgabe innerhalb eines Fallplans erforderlich ist. Sucht den Typ im lokalen TypeCache, listet Integration Service-Verbindungen für den Connector auf und ruft Integration Service-Metadaten ab.

Optionen

Long	Wert	Erforderlich	Beschreibung
--type <type>	activity | trigger	ja	Welcher TypeCache gesucht werden soll.
--activity-type-id <uuid>	UUID	ja	Studio Web uiPathActivityTypeId. Zu finden über registry pull + Lesen der typecache-{activities,triggers}-index.json Cache-Datei oder registry get-connector.
--connection-id <id>	UUID	ja	Verbindungs-ID. Kandidaten mit registry get-connection --type typecache-{activities,triggers} --activity-type-id <uuid> auflisten.
--object-name <name>	string	nein	Überschreiben Sie den TypeCache objectName. Erforderlich für kuratierte Trigger vom Typ Entität, deren TypeCache einen Platzhalter speichert (z. B Data Service {tenantEntityName|folderEntityName}) – Wählen Sie einen echten Entitätsnamen aus.
--skip-case-shape	Markieren	nein	Lassen Sie caseShape (inputs[]/outputs[]/context[]) aus der Antwort weg – verwenden Sie sie während der Planung, wenn Sie nur den Connector-Vertrag benötigen. Sich gegenseitig mit --input-details ausschließen.
--input-details <json>	JSON	nein	Füllen Sie Werte, die in das generierte caseShape eingeklappt werden, vorab aus. Form unterscheidet sich um --type: Aktivität akzeptiert {bodyParameters, queryParameters, pathParameters, filter}; Trigger akzeptiert {eventParameters, filter}. Sich gegenseitig mit --skip-case-shape ausschließen.

Beispiele

# Curated connector activity (Send Email)
uip maestro case spec --type activity \
  --activity-type-id c7ce0a96-2091-3d94-b16f-706ebb1eb351 \
  --connection-id fc82e610-c454-4bc7-a1a5-b5aa529d1ba6

# Curated connector trigger (Email Received)
uip maestro case spec --type trigger \
  --activity-type-id 7dc57f24-894c-5ae2-a902-66056fa40609 \
  --connection-id fc82e610-c454-4bc7-a1a5-b5aa529d1ba6

Datenform (--output json)

{
  "Code": "ConnectorTaskSpec",
  "Data": {
    "specVersion": 1,
    "identity": {
      "target": "activity",
      "uiPathActivityTypeId": "c7ce0a96-2091-3d94-b16f-706ebb1eb351",
      "connectorKey": "uipath-microsoft-outlook365",
      "objectName": "send-mail-v2",
      "typecacheEntry": { "displayName": "Send Email" }
    },
    "operation": { "name": "POST", "verb": "create", "httpMethod": "POST", "path": "/hubs/productivity/send-mail-v2" },
    "inputs": { "bodyFields": [{ "name": "message.toRecipients", "required": true }] }
  }
}

Die operation -Form einer Triggerspezifikation unterscheidet sich (eventMode/Ereignisname anstelle eines HTTP-Verb/Pfads) – siehe zweites Beispiel oben.

Zugehörig

• registry – Entdecken Sie Ressourcen, auf die in einem Fallplan verwiesen werden kann, und wie eine Aufgabeneingabe an eine Variable gebunden wird.
• cases und stages – überprüfen Sie die Metadaten und Phasen des Fallplans.
• tasks – Überprüfung, Anreicherung und Beschreibung von Aufgabendefinitionen.
• task-entry-conditions – Überprüfung der Eintrittsregeln auf Aufgabenebene.
• sla – Überprüfen Sie die SLA-/Eskalationsregeln.
• triggers, sticky-notes, edges – Überprüfen Sie Trigger, Canvas-Notizen und Übergänge.
• Bedingungen – Überprüfen Sie die Eintritts-/Austrittsbedingungen auf Fallebene und Phasenebene.
• process, processes, job, instances, incidents – Bereitstellen und Ausführen von Fallinstanzen.
• uip maestro – BPMN-Orchestrierung, die gleichgeordnete Oberfläche.
• uip maestro flow – Flow-Orchestrierung, die andere gleichgeordnete Oberfläche.

Siehe auch

• Übersicht über das Maestro-Tool
• Globale Optionen
• Exitcodes