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:

1. Deployment (If the user experience is Attended, such as Test Data Management, this might not be included)
2. Dokumentation
3. Bibliotheken (Wenn der Prozess keine Bibliotheken enthält, sind diese möglicherweise nicht enthalten)
4. 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 represent shared variables or credentials that can be used in different automation projects across a Solution Accelerator. Asset Details is a Microsoft Excel Workbook file (.xlsx) that is compatible with Orchestrator Manager, a tool that leverages Orchestrator’s API to manipulate entities. This workbook enables users to easily see and add assets which are used throughout your Solution Accelerator.

As per the example below this workbook is expected to have two sheets: Create to create Text, Bool, and Integer assets and Create Credential to create credential assets. The headers needed and order of headers for each sheet, along with the information inside each row, are defined in the tables below.

Keine Angabe	Keine Angabe	Keine Angabe	Keine Angabe	Keine Angabe	Keine Angabe	Keine Angabe	Keine Angabe	Keine Angabe
Folder Name1	Asset Name1	Description1	Scope1	Robot Name or User's Username1	Type1	Value1	Asset ID2	Result2
Auftragsabwicklung	Dispatcher_PurchaseOrdersEmailsSourceAccount	Das Postfach, in dem sich die PurchaseOrders-Dokument-E-Mails befinden, die wir verarbeiten müssen.	Global	Keine Angabe	Text	DURCH BESTIMMTEN WERT ERSETZEN	Keine Angabe	Keine Angabe

¹0 Column receives input from the operation – such as names, types, and values of Assets to be created.

¹1 Column used by Orchestrator Manager to write data retrieved from Orchestrator, such as the IDs of created assets. Values here will be overwritten upon the next Create / Create Credential operation.

Erstellen

Folder Name 1	Asset Name 1	Description 1	Scope 1	Robot Name 1 or User's Username 1	Type 1	Value 1	Asset ID 2	Result 2
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.

¹2 Column receives input from the operation – such as names, types, and values of Assets to be created.

¹3 Column used by Orchestrator Manager to write data retrieved from Orchestrator, such as the IDs of created assets. Values here will be overwritten upon the next Create / Create Credential operation.

Erstellen Sie Anmeldeinformationen

Folder Name 1	Asset Name 1	Description 1	Scope 1	Robot Name or User's Username 1	Username 1	Password 1	Asset ID 2	Result 2
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.

¹4 Column receives input from the operation – such as names, types, and values of Assets to be created.

¹5 Column used by Orchestrator Manager to write data retrieved from Orchestrator, such as the IDs of created assets. Values here will be overwritten upon the next Create / Create Credential operation.

b. Warteschlangendetails

A queue is a container that enables you to hold an unlimited number of items. Queue items can store multiple types of data, such as invoice information or customer details. Queues enable you to create large automation projects, such as Solution Accelerators, underlined by complex logic.

Queue Details is a Microsoft Excel Workbook file (.xlsx) that is compatible with Orchestrator Manager, a tool that leverages Orchestrator’s API to manipulate entities. This workbook enables users to easily see and add queues which are used throughout your Solution Accelerator

As per the example below this workbook is expected to have one sheet: Create to create all queues. The headers needed and order of headers for the sheet, along with the information inside each row, are defined in the table below. Orange header columns receive input from the operation – such as names, description, and max number of retries of queues to be created. Gray header columns are used by Orchestrator Manager to write data retrieved from Orchestrator, such as the IDs of created queues. Values here will be overwritten upon the next Create operation.

Keine Angabe	Keine Angabe	Keine Angabe	Keine Angabe	Keine Angabe	Keine Angabe	Keine Angabe	Keine Angabe
Ordner Name	Warteschlangenname	Beschreibung	Unique Reference	Auto Retry	Max # of Retries	Asset-ID	Ergebnis
When specifying names of subfolders of Modern Folders, it is necessary to input the complete name of the parent Folder, including its ancestors, separated by the forward slash character (/). Example: if a Modern Folder called “WorkGroup1” is a subfolder of a Modern Folder called “DepartmentA”, then the complete name of WorkGroup1 is “DepartmentA/WorkGroup1”.	The name of the Queue. The name cannot have any whitespace. The name must have a maximum of 50 characters.	Description of the Queue. The description must have a maximum of 250 characters.	Enforces transactions to have references which are unique. Must be either Yes or No.	Enables a transaction item within the Queue that fails with a system exception to be automatically retried. Must be either Yes or No.	The Maximum Number of Retries for a transaction item within the Queue. Must be at least 1 if Auto Retry is Yes. Can be an Integer between 1 and 50.	Die ID der erstellten Warteschlange, wenn sie erfolgreich erstellt wurde.	Das Ergebnis der Erstellung der Warteschlange – Erfolg oder Fehlschlag.

c. Lösungsverwaltungspaket

A Solution Accelerator is a bundle of multiple components (processes, assets, queues, etc.) developed on the UiPath platform, that work together to automate a business use case. UiPath Solutions Management provides an out-of-the-box means to manage the lifecycle of Solution Accelerator components once built. This set of capabilities comes into play once development is finished for your Solution Accelerator, and you want to easily promote its components to a new environment.

Solutions Management allows you to conveniently package these components into a single file within the Orchestrator environment the Solution Accelerator was developed on. For a guide on how to create a Solution Management Package, please see the Creating a solution project.

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.
• Processes should NOT be included within the Solution Management zip. Processes are expected to not work immediately without modification for environment and procedure specific enhancements to a Solution Accelerator.
• 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

A library is a project which contains one or more workflows that can be reused as activities in other projects. This enables your Solution Accelerator to use common code throughout each individual process. For information on creating a library, see the Creating a Library section in the library documentation. For information about development standards on creating a library for Solution Accelerators, please see the library development section. A library is saved as NUPKG file when published and can be installed as a dependency from Package Manager. You can either publish a library to a local folder or publish and download from the NuGet package feed to retrieve the relevant NUPKG file.

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.

If the library is expected to be modified to correctly work within the project, it’s expected to not be included in the Deployment folder and the Deployment Guide should make it clear that the library needs to be modified, published, and dependencies updated in any project using that library. If a reusable library is published separately on a feed, such as the UiPath Solution Accelerators Generic Reusables, you do not need to include the NUPKG file.

e. Alle zusätzlichen benutzerdefinierten Aktivitäten

You can create your own custom activities that can be used in UiPath Studio projects. To use custom activities that are created, you must install the NuGet package that contains it in the Solution Accelerator project(s) by accessing Package Manager from UiPath Studio and installing the NUPKG. That NuGet package should be created upon finishing the custom activity. The NUPKG can be included within the Deployment folder of the Solution Accelerator.

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

A UiPath Library is a project which contains one or more workflows that can be reused as activities in other projects. Libraries are saved as NUPKG files when published and can be installed as dependencies from the Package Manager. A Library can only be developed using a Library type of project. Any reusable UI components should also be implemented within a Library using Object Repository. Any Data Service entity should be imported within a Library so the same reference / namespace can be used throughout the entire Solution Accelerator by importing a Library. By importing the within a Library, namespaces will not be conflicting throughout different Processes.

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	Lower Camel Case (e.g., firstName, lastName, myOrganizationStructure )
Namenskonvention für Argumente	Arguments should be named using the PascalCase standard. The name of the arguments should NOT contain in_/out_/io_ prefix because those arguments will appear as properties when the Library is being created. 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

A process is a UiPath project developed using the process design option that can be executed by a UiPath Robot. Any new Process project should be either a Cross Platform Project or a Windows Project. Windows – Legacy uses an older version of the.NET Framework and will no longer be an option for new projects in the near future. Data Service Entities should not be imported within a Process. Importing within an individual process can cause conflicting namespaces throughout a Solution Accelerator.

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	Keeping a consistent variable naming convention throughout an automation process is important for readability and clarity Die typische Standardeinstellung, die UiPath-Entwickler verwenden, sind Kleinbuchstaben (z. B. firstName, myFirstName, lastName, myOrganizationStructure)
Namenskonvention für Argumente	Lower Camel Case with a prefix stating the argument type as either in, out, or in/out, such as 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