UiPath Marketplace-Benutzerhandbuch

Letzte Aktualisierung 5. Sep. 2024

Inhalte

Struktur Ihres Solution Accelerators

Ihr Solution Accelerator muss der folgenden Ordnerstruktur entsprechen, um eine konsistente Erfahrung in allen Solution Accelerators zu gewährleisten. Es kann vier Ordner enthalten:

Bereitstellung (Wenn die Benutzererfahrung Attended ist, z. B. bei Test Data Management, ist dies möglicherweise nicht enthalten)
Dokumentation
Bibliotheken (Wenn der Prozess keine Bibliotheken enthält, sind diese möglicherweise nicht enthalten)
Prozesse

Obwohl bestimmte Elemente in jedem Solution Accelerator einheitlich sind (z. B. die Ordnerstruktur), kann Ihr Solution Accelerator vom spezifischen Anwendungsfall und den UiPath-Produkten beeinflusst werden, die im Solution Accelerator verwendet werden. In der folgenden Tabelle sind die konsistenten Elemente in jedem Solution Accelerator aufgeführt:

Bereitstellung	Dokumentation	Bibliotheken	Prozesse
Asset-Details Warteschlangendetails Lösungsverwaltungspaket Alle Bibliotheks-NUPKG-Dateien Alle zusätzlichen benutzerdefinierten Aktivitäten	Solution Accelerator – Accelerator-Übersicht Solution Accelerator – Bereitstellungsanleitung Solution Accelerator – Technische Dokumentation Lösungsentwurf auf hoher Ebene (.pdf und ursprüngliche Bearbeitungsdatei wie z. B. VSDX) Detaillierter Lösungsentwurf (.pdf und ursprüngliche Bearbeitungsdatei wie z. B. VSDX)	Einzelne Unterordner für jede Bibliothek	Einzelne Unterordner für jeden Prozess

2. Bereitstellungsordner

a. Asset-Details

Assets sind gemeinsam genutzte Variablen oder Anmeldeinformationen, die in verschiedenen Automatisierungsprojekten in einem Solution Accelerator verwendet werden können. Asset Details ist eine Microsoft Excel-Arbeitsmappendatei (.xlsx), die mit dem Orchestrator Manager kompatibel ist, einem Tool, das die API des Orchestrators zum Bearbeiten von Entitäten nutzt. Mit dieser Arbeitsmappe können Benutzer einfach Assets anzeigen und hinzufügen, die in Ihrem gesamten Solution Accelerator verwendet werden.

Gemäß dem folgenden Beispiel wird diese Arbeitsmappe voraussichtlich über zwei Blätter verfügen: Erstellen zum Erstellen von Text-, Bool- und Integer-Assets und Anmeldeinformationen erstellen zum Erstellen von Anmeldeinformationsassets. Die erforderlichen Header und die Reihenfolge der Header für jedes Blatt sowie die Informationen in jeder Zeile werden in den nachfolgenden Tabellen definiert.

Ordnername¹	Elementname¹	Beschreibung¹	Scope¹	Robotername oder Benutzername des Benutzers¹	Geben Sie¹ein	Wert¹	Asset-ID²	Ergebnis²
Auftragsabwicklung	`Dispatcher_PurchaseOrdersEmailsSourceAccount`	Das Postfach, in dem sich die PurchaseOrders-Dokument-E-Mails befinden, die wir verarbeiten müssen.	Global		Text	DURCH BESTIMMTEN WERT ERSETZEN

¹⁾ Spalte erhält Eingaben vom Vorgang, z. B. Namen, Typen und Werte von zu erstellenden Assets.

²⁾ Spalte, die vom Orchestrator Manager verwendet wird, um vom Orchestrator abgerufene Daten zu schreiben, z. B. die IDs der erstellten Assets. Werte hier werden beim nächsten Vorgang Erstellen/Anmeldeinformationen erstellen überschrieben.

Erstellen

Ordnername¹	Elementname¹	Beschreibung¹	Scope¹	Robotername¹ oder Benutzername¹des Benutzers	Geben Sie¹ein	Wert¹	Asset-ID²	Ergebnis²
Wenn Sie Namen von Unterordnern moderner Ordner angeben, müssen Sie den vollständigen Namen des übergeordneten Ordners einschließlich seiner Vorgänger getrennt durch den Schrägstrich (/) eingeben. Beispiel: Wenn ein moderner Ordner namens „Arbeitsgruppe1“ ein Unterordner eines modernen Ordners namens „AbteilungA“ ist, dann lautet der vollständige Name von Arbeitsgruppe1 „AbteilungA/Arbeitsgruppe1“.	Der Name des Assets. Der Name darf höchstens 256 Zeichen lang sein.	Beschreibung des Assets. Die Beschreibung darf maximal 250 Zeichen lang sein.	Das Feld Scope hat eine feste Anzahl möglicher Werte, entsprechend den im Orchestrator verfügbaren Asset-Scopes: Global Roboter (nur in klassischen Ordnern verfügbar) Benutzer (nur in modernen Ordnern verfügbar).	Verwenden Sie beim Erstellen von Assets pro Roboter das Feld Robotername oder Benutzername des Benutzers, um den Namen des Roboters anzugeben, der Zugriff auf den zu definierenden Wert des Assets haben soll. Der Roboter muss sich im selben Ordner wie das erstellte Asset pro Roboter befinden. Werte für mehrere Roboter müssen in separaten Zeilen mit demselben Ordnernamen, Asset-Namen, Scope und Typ angegeben werden.	Das Feld Typ hat eine feste Anzahl möglicher Werte gemäß den im Orchestrator verfügbaren Asset-Typen: Text Bool Integer	Der Wert des Assets. Wenn Asset-Werte vom Benutzer definiert werden müssen, sollten sie als „ZUM ERSETZEN DURCH BESTIMMTEN WERTE“ geschrieben werden. Dieses Feld muss enthalten: Maximal 1.000.000 Zeichen für Texttypen ein Wert zwischen 2147483648 und 2147483648 für Integer-Typen Den Wert TRUE oder FALSE für Bool-Typen.	Die ID des erstellten Assets, wenn das Asset erfolgreich erstellt wurde.	Das Ergebnis der Erstellung des Assets – erfolgreich oder fehlgeschlagen.

¹⁾ Spalte erhält Eingaben vom Vorgang, z. B. Namen, Typen und Werte von zu erstellenden Assets.

Erstellen Sie Anmeldeinformationen

Ordnername¹	Elementname¹	Beschreibung¹	Scope¹	Robotername oder Benutzername des Benutzers¹	Benutzername¹	Kennwort¹	Asset-ID²	Ergebnis²
Wenn Sie Namen von Unterordnern moderner Ordner angeben, müssen Sie den vollständigen Namen des übergeordneten Ordners einschließlich seiner Vorgänger getrennt durch den Schrägstrich (/) eingeben. Beispiel: Wenn ein moderner Ordner namens „Arbeitsgruppe1“ ein Unterordner eines modernen Ordners namens „AbteilungA“ ist, dann lautet der vollständige Name von „Arbeitsgruppe1“ „AbteilungA/Arbeitsgruppe1“.	Der Name des Assets. Der Name darf höchstens 256 Zeichen lang sein.	Beschreibung des Assets. Die Beschreibung darf maximal 250 Zeichen lang sein.	Das Feld Scope hat eine feste Anzahl möglicher Werte, entsprechend den im Orchestrator verfügbaren Asset-Scopes: Global Roboter (nur in klassischen Ordnern verfügbar) Benutzer (nur in modernen Ordnern verfügbar).	Verwenden Sie beim Erstellen von Assets pro Roboter das Feld Robotername oder Benutzername des Benutzers, um den Namen des Roboters anzugeben, der Zugriff auf den zu definierenden Wert des Assets haben soll. Der Roboter muss sich im selben Ordner wie das erstellte Asset pro Roboter befinden. Werte für mehrere Roboter müssen in separaten Zeilen mit demselben Ordnernamen, Asset-Namen, Scope und Typ angegeben werden.	Das Feld „Benutzername“. Da dies von Endbenutzern bereitgestellt wird, sollte dieses Feld immer in jeder Zeile „DURCH BESTIMMTEN WERT ERSETZEN“ enthalten.	Das Kennwort-Feld. Da dies von Endbenutzern bereitgestellt wird, sollte dieses Feld immer in jeder Zeile „DURCH BESTIMMTEN WERT ERSETZEN“ enthalten.	Die ID des erstellten Assets, wenn das Asset erfolgreich erstellt wurde.	Das Ergebnis der Erstellung des Assets – erfolgreich oder fehlgeschlagen.

¹⁾ Spalte erhält Eingaben vom Vorgang, z. B. Namen, Typen und Werte von zu erstellenden Assets.

b. Warteschlangendetails

Eine Warteschlange ist ein Behälter, in den Sie eine unbegrenzte Anzahl von Elementen aufnehmen können. Warteschlangenelemente können mehrere Arten von Daten speichern, z. B. Rechnungsinformationen oder Kundendaten. Mit Warteschlangen können Sie große Automatisierungsprojekte wie Solution Accelerators erstellen, die mit einer komplexen Logik ausgestattet sind.

Warteschlangendetails ist eine Microsoft Excel-Arbeitsmappen-Datei (.xlsx), die mit dem Orchestrator Manager kompatibel ist, einem Tool, das die API des Orchestrators zum Bearbeiten von Entitäten nutzt. Mit dieser Arbeitsmappe können Benutzer Warteschlangen, die im gesamten Solution Accelerator verwendet werden, einfach anzeigen und hinzufügen

Gemäß dem folgenden Beispiel wird diese Arbeitsmappe voraussichtlich ein Blatt haben: Erstellen , um alle Warteschlangen zu erstellen. Die benötigten Header und die Reihenfolge der Header für das Blatt sowie die Informationen in jeder Zeile sind in der nachfolgenden Tabelle definiert. Orange Headerspalten enthalten Eingaben vom Vorgang – z. B. Namen, Beschreibungen und die maximale Anzahl der Wiederholungen der zu erstellenden Warteschlangen. Graue Headerspalten werden vom Orchestrator Manager verwendet, um vom Orchestrator abgerufene Daten zu schreiben, z. B. die IDs der erstellten Warteschlangen. Werte hier werden beim nächsten Erstellungsvorgang überschrieben.

Ordner Name	Warteschlangenname	Beschreibung	Unique Reference	Auto Retry	Max # of Retries	Asset-ID	Ergebnis
Wenn Sie Namen von Unterordnern moderner Ordner angeben, müssen Sie den vollständigen Namen des übergeordneten Ordners einschließlich seiner Vorgänger getrennt durch den Schrägstrich (/) eingeben. Beispiel: Wenn ein moderner Ordner namens „Arbeitsgruppe1“ ein Unterordner eines modernen Ordners namens „AbteilungA“ ist, dann lautet der vollständige Name von Arbeitsgruppe1 „AbteilungA/Arbeitsgruppe1“.	Der Name der Warteschlange. Der Name darf keine Leerzeichen enthalten. Der Name darf höchstens 50 Zeichen lang sein.	Beschreibung der Warteschlange. Die Beschreibung darf maximal 250 Zeichen lang sein.	Erzwingt, dass Transaktionen Referenzen haben, die eindeutig sind. Muss entweder Ja oder Nein sein.	Aktiviert ein Transaktionselement in der Warteschlange, das mit einer Systemausnahme fehlschlägt, damit es automatisch wiederholt wird. Muss entweder Ja oder Nein sein.	Die maximale Anzahl der Wiederholungen für ein Transaktionselement in der Warteschlange. Muss mindestens 1 sein, wenn „Automatische Wiederholung“ auf „Ja“ festgelegt ist. Kann ein Integer zwischen 1 und 50 sein.	Die ID der erstellten Warteschlange, wenn sie erfolgreich erstellt wurde.	Das Ergebnis der Erstellung der Warteschlange – Erfolg oder Fehlschlag.

c. Lösungsverwaltungspaket

Ein Solution Accelerator ist ein Paket aus mehreren Komponenten (Prozesse, Assets, Warteschlangen usw.), die auf der UiPath-Plattform entwickelt wurden und zusammenarbeiten, um einen Geschäftsanwendungsfall zu automatisieren. UiPath Solution Management bietet eine sofort einsatzbereite Möglichkeit, den Lebenszyklus von Solution Accelerator-Komponenten nach der Erstellung zu verwalten. Diese Funktionen kommen ins Spiel, sobald die Entwicklung für Ihren Solution Accelerator abgeschlossen ist und Sie seine Komponenten einfach in eine neue Umgebung übertragen möchten.

Mit der Lösungsverwaltung können Sie diese Komponenten bequem in eine einzige Datei innerhalb der Orchestrator-Umgebung packen, auf der der Lösungsbeschleuniger entwickelt wurde. Eine Anleitung zum Erstellen eines Lösungsverwaltungspakets finden Sie unter Erstellen eines Lösungsprojekts.

Einige Anforderungen und Überlegungen beim Erstellen eines Lösungsverwaltungspakets für Ihren Solution Accelerator:

Alle Assets, bei denen es sich um Anmeldeinformationen handelt, müssen die Felder Benutzername und Kennwort enthalten, die die Werte „DURCH BESTIMMTEN WERT ERSETZEN“ enthalten, da diese von Endbenutzern bereitgestellt werden.
Alle Assets, die Endbenutzerspezifisch sind, wie z. B. Ziel-E-Mail-Adressen oder Umgebungs-URLs, sollten auch die Werte „DURCH BESTIMMTEN WERT ERSETZEN“ haben.
Die Namenskonvention für die Lösungsverwaltungs-ZIP-Datei sollte „Solution Accelerator Name 1.0.0“ lauten. Dabei ist Solution Accelerator Name der Name des Solution Accelerators und 1.0.0 die Version des Lösungsprojekts für die Solution Management-ZIP-Datei.
Alle Speicher-Buckets und Trigger sind in der Lösungsverwaltung enthalten. Speicher-Buckets und Trigger können nicht in manuelle Bereitstellungen aufgenommen werden und müssen in der Dokumentation zum Bereitstellungshandbuch angegeben werden, damit sie manuell erstellt werden kann.
Prozesse dürfen NICHT in die Lösungsverwaltungs-ZIP-Datei aufgenommen werden . Es wird erwartet, dass Prozesse nicht sofort ohne Änderung für Umgebungs- und verfahrensspezifische Verbesserungen an einem Lösungsbeschleuniger funktionieren.
Wenn erwartet wird, dass eine benutzerdefinierte Bibliothek auf jeden Fall geändert wird, sollte sie nicht in das Lösungsverwaltungspaket aufgenommen werden, da sie ohne Änderung nicht sofort funktioniert.

d. NUPKG-Dateien der Bibliothek

Eine Bibliothek ist ein Projekt, das einen oder mehrere Workflows enthält, die als Aktivitäten in anderen Projekten wiederverwendet werden können. Dadurch kann Ihr Solution Accelerator in jedem einzelnen Prozess gemeinsamen Code verwenden. Informationen zum Erstellen einer Bibliothek finden Sie im Abschnitt Erstellen einer Bibliothek in der Bibliotheksdokumentation. Informationen zu Entwicklungsstandards zum Erstellen einer Bibliothek für Solution Accelerators finden Sie im Abschnitt Bibliotheksentwicklung. Eine Bibliothek wird bei der Veröffentlichung als NUPKG- Datei gespeichert und kann als Abhängigkeit vom Paketmanager installiert werden. Sie können entweder eine Bibliothek in einem lokalen Ordner veröffentlichen oder den NuGet-Paketfeed veröffentlichen und herunterladen, um die relevante NUPKG-Datei abzurufen.

Wichtig:

Wenn eine wiederverwendbare Bibliothek so konzipiert ist, dass sie sofort funktioniert, ohne dass Änderungen erforderlich sind, fügen Sie diese bitte in den Bereitstellungsordner ein.

Wenn erwartet wird, dass die Bibliothek geändert wird, damit sie innerhalb des Projekts korrekt funktioniert, wird sie voraussichtlich nicht im Bereitstellungsordner enthalten sein, und das Bereitstellungshandbuch sollte klarstellen, dass die Bibliothek in jedem Projekt geändert, veröffentlicht und Abhängigkeiten aktualisiert werden müssen dieser Bibliothek.

Wenn eine wiederverwendbare Bibliothek separat in einem Feed veröffentlicht wird, z. B. UiPath Solution Accelerators Generic Applications, müssen Sie die NUPKG-Datei nicht einschließen.

e. Alle zusätzlichen benutzerdefinierten Aktivitäten

Sie können eigene benutzerdefinierte Aktivitäten erstellen, die in UiPath Studio-Projekten verwendet werden können. Um benutzerdefinierte Aktivitäten zu verwenden , die erstellt werden, müssen Sie das NuGet-Paket installieren, das sie in den Solution Accelerator-Projekten enthält, indem Sie über UiPath Studio auf den Paketmanager zugreifen und das NUPKG installieren. Dieses NuGet-Paket sollte nach Fertigstellung der benutzerdefinierten Aktivität erstellt werden . Das NUPKG kann in den Bereitstellungsordner des Solution Accelerators aufgenommen werden.

3. Dokumentation

Die Dokumentationsstruktur muss den folgenden Richtlinien entsprechen:

Solution Accelerator – Accelerator-Übersicht
Solution Accelerator – Bereitstellungsanleitung
Solution Accelerator – Technische Dokumentation
Lösungsentwurf auf hoher Ebene (.pdf und ursprüngliche Bearbeitungsdatei wie z. B. VSDX)
Detaillierter Lösungsentwurf (.pdf und ursprüngliche Bearbeitungsdatei wie z. B. VSDX)

4. Bibliotheken

Eine UiPath-Bibliothek ist ein Projekt, das einen oder mehrere Workflows enthält, die als Aktivitäten in anderen Projekten wiederverwendet werden können. Bibliotheken werden bei der Veröffentlichung als NUPKG -Dateien gespeichert und können als Abhängigkeiten vom Paketmanager installiert werden. Eine Bibliothek kann nur mit einem Bibliotheksprojekt entwickelt werden. Alle wiederverwendbaren UI-Komponenten sollten auch innerhalb einer Bibliothek mithilfe von Object Repository implementiert werden. Jede Data Service-Entität sollte in eine Bibliothek importiert werden, sodass die gleiche Referenz/der gleiche Namespace im gesamten Solution Accelerator durch Importieren einer Bibliothek verwendet werden kann. Durch das Importieren innerhalb einer Bibliothek treten keine Konflikte zwischen Namespaces in verschiedenen Prozessen auf.

Eine Bibliothek hat die folgenden Anforderungen:

Projekttyp	Bibliotheksprojekte
Prozessgröße und Workflow-Namenskonvention	Kleine und gut definierte XAMLs Benennung: Verwenden Sie eine „Großschreibung jedes Wort“-Benennung (mit Leerzeichen dazwischen) und nicht PascalCase. Wenn PascalCase für Workflows bevorzugt wird, kann die Konvention „Jedes Wort großschreiben“ (Wiederherstellen der Leerzeichen im Aktivitätsnamen) weiterhin über das Feld „Anzeigename“ des „Aktivitätslayouts“ erfolgen (Rechtsklick-Workflow-Menüoption im Projekt-Explorer). ).
Anmerkungen	Fügen Sie angeheftete Anmerkungen zu jeder Workflow-Datei als Haftungsausschluss/Erläuterung hinzu Kommentieren Sie Aktivitäten mit einer geeigneten beschreibenden Erklärung
Namenskonvention für Variablen	Kleinbuchstaben von BinnenMajuskel (z. B., firstName, lastName, myOrganizationStructure)
Namenskonvention für Argumente	Argumente sollten mit dem PascalCase- Standard benannt werden. Der Name der Argumente darf NICHT das Präfix in_/out_/io_ enthalten, da diese Argumente beim Erstellen der Bibliothek als Eigenschaften angezeigt werden. Für jedes Argument sollten Anmerkungen vorhanden sein, da dies angezeigt wird, wenn eine Bibliotheksaktivität verwendet wird
Argumentergebnisse	Ein Bibliotheksworkflow sollte sich so verhalten, wie der Workflowname beschrieben ist Ein Workflow sollte jedes API- oder GUI-Ergebnis analysieren und das spezifische Datenergebnis zurückgeben
Anmerkungen	Fügen Sie Kommentare hinzu, um die Lesbarkeit von Bibliotheksprojekten zu verbessern
Data Service-Entität	Data Service-Entitäten können innerhalb einer Bibliothek importiert werden. Der Namespace muss der Name der Entität sein. Data Service-Vorgänge können in einer Bibliothek erfolgen, um die Wiederverwendbarkeit der Entität im gesamten Solution Accelerator zu verbessern.
Ausnahmebehandlung	Fehler innerhalb einer Bibliothek sollten als Ausnahmen ausgelöst werden und nicht durch Ausgabeargumente signalisiert werden. Bestätigen Sie das Ergebnis einer Bibliothekskomponente am Ende, indem Sie überprüfen, ob die gewünschte Aktion aufgetreten ist, und eine Ausnahme auslösen, wenn dies nicht der Fall ist.

5. Prozesse

Ein Prozess ist ein UiPath-Projekt, das mit der Prozessentwurfsoption entwickelt wurde und von einem UiPath-Roboter ausgeführt werden kann. Jedes neue Prozessprojekt muss entweder ein plattformübergreifendes Projekt oder ein Windows-Projekt sein. Windows – Legacy verwendet eine ältere Version des .NET Frameworks und wird in naher Zukunft keine Option mehr für neue Projekte sein. Data Service-Entitäten dürfen nicht innerhalb eines Prozesses importiert werden. Das Importieren innerhalb eines einzelnen Prozesses kann zu widersprüchlichen Namespaces im gesamten Solution Accelerator führen.

Ein Prozess hat die folgenden Anforderungen:

Projekttyp	Windows-Projekte Plattformübergreifende Projekte
Prozessgröße	Kleine und gut abgegrenzte Prozesse
Anmerkungen	Fügen Sie angeheftete Anmerkungen zu jeder Workflow-Datei als Haftungsausschluss/Erläuterung hinzu. Das typische Format beschreibt den Zweck des Workflows neben einer Erklärung der einzelnen Argumente, die in, out und in/out gesendet werden sollen Kommentieren Sie Aktivitäten mit einer geeigneten beschreibenden Erklärung
Namenskonvention für Variablen	Die Beibehaltung einer konsistenten Namenskonvention für Variablen im gesamten Automatisierungsprozess ist wichtig für die Lesbarkeit und Klarheit Die typische Standardeinstellung, die UiPath-Entwickler verwenden, sind Kleinbuchstaben (z. B. firstName, myFirstName, lastName, myOrganizationStructure)
Namenskonvention für Argumente	Binnenmajuskeln mit einem Präfix, das den Argumenttyp als „in“, „out“ oder „in/out“ angibt, z. B. in_defaultTimeout, in_fileName, out_textResult, io_retryNumber. Für jedes Argument sollten Anmerkungen vorhanden sein, da sie angezeigt werden, wenn ein Workflow aufgerufen wird
Anmerkungen	Fügen Sie Kommentaraktivitäten an den richtigen Stellen hinzu, um Konfigurationsbereiche hervorzuheben, in denen die Logik basierend auf den Kundenszenarien geändert werden muss
Data Service-Entität	Data Service-Entitäten dürfen nicht innerhalb eines Prozesses importiert werden. Eine Data Service-Entität sollte innerhalb einer gemeinsamen Bibliothek importiert werden, um widersprüchliche Namespaces zu vermeiden. Data Service-Vorgänge können in einem Prozess mit einem Namespace auftreten, der aus einer Bibliothek importiert wird.
Ebenen	Anwendungsebene (API- oder UI-Automatisierung kann für eine bestimmte Anwendung genutzt werden, jedoch liegt dies im Ermessen des Entwicklers) Geschäftslogik-Ebene/Implementierungsebene