Die UiPath.Orchestrator.dll.config
-Datei (C:\Program Files (x86)\UiPath\Orchestrator
) definiert die Parameter, Einstellungen und Präferenzen, die auf Ihre Orchestrator-Bereitstellung angewendet werden.
Hinweis:
Nur Administratoren sollten die Werte dieser Parameter ändern.
Es wird empfohlen, die Website manuell neu zu starten, nachdem Sie Änderungen an
UiPath.Orchestrator.dll.config
vorgenommen haben.Parameter, die auf dieser Seite nicht dokumentiert sind, dürfen nicht geändert werden und dürfen keine Gegenstücke auf den Seiten für die Einstellungen haben.
Bei allen Parametern wird Groß-/Kleinschreibung berücksichtigt.
App-Einstellungen
Erweiterte Installationseinstellungen
EncryptionKeyPerTenant.Enabled
EncryptionKeyPerTenant.Enabled
-Ermöglicht Ihnen die Verwendung unterschiedlicher Verschlüsselungsschlüssel pro Mandant basierend auf einem Microsoft Azure Key Vault-Konto. Folgende Werte können zugewiesen werden:
false
- Verwendet einen einzelnen Verschlüsselungsschlüssel für die gesamte Orchestrator-Instanz. Dies ist der Standardwert.true
- Verwendet für jeden Mandanten einen anderen Verschlüsselungsschlüssel, verbessert die Sicherheit Ihrer Mandanten und sorgt für eine bessere Trennung Ihrer empfindlichen Daten.
If you enable this feature, you must also fill in the EncryptionKeyPerTenant.KeyProvider
parameter, as well as the ones in the SecureAppSettings section.
EncryptionKeyPerTenant.KeyProvider
EncryptionKeyPerTenant.KeyProvider
Enables you to indicate which key management application to store the encryption keys generated per tenant from Orchestrator. Set it to AzureKeyVault
to use a preconfigured Microsoft Azure Key Vault. We do not provide Azure Key Vault licenses. Please note that you also have to configure the parameters described in the SecureAppSettings section. If EncryptionKeyPerTenant.Enabled
is set to false
, this parameter is not used.
Änderungen, die hier an den Verschlüsselungseinstellungen vorgenommen werden, müssen in der Identity Server-Datei appsettings.Production.json entsprechend der folgenden Feldäquivalenz gespiegelt werden:
Orchestrator UiPath.Orchestrator.dll.config | Identity Server appsettings.Production.json |
---|---|
EncryptionKeyPerTenant.Enabled | EncryptionKeyPerTenant |
Azure.KeyVault.VaultAddress | AzureKeyVaultAddress |
Azure.KeyVault.CertificateThumbprint | AzureKeyVaultCertificateThumbprint |
Azure.KeyVault.ClientId | AzureKeyVaultClientId |
Azure.KeyVault.DirectoryId | AzureKeyVaultDirectoryId |
EncryptionKeyPerTenant.KeyProvider | MultiTenantEncryptionKeyProvider |
Warteschlangen
Hinweis:
Um Änderungen an den Zeitplänen interner Aufträge vorzunehmen, folgen Sie den Schritten unter Aktualisieren von Zeitplänen interner Aufträge.
inProgressMaxNumberOfMinutes
inProgressMaxNumberOfMinutes
Die maximale Zeitdauer, die Warteschlangenobjekte im Status In Bearbeitung verbringen können. Nach dieser Zeit ändert sich der Status der Warteschlangenobjekte in Abgebrochen. Standardmäßig wird dieser Wert auf 1440 Minuten festgelegt (24 Stunden).
QueuesStatisticsScheduleCron
QueuesStatisticsScheduleCron
Die Häufigkeit, mit der die Statistiken von Warteschlangenobjekten auf den Seiten Dashboard und Transaktionen sowie im Fenster Diagramm aktualisiert werden. Standardmäßig werden Sie jede Minuten aktualisiert.
UpdateUncompletedItemsJobCron
UpdateUncompletedItemsJobCron
Die Häufigkeit der Suche in der Datenbank nach Warteschlangen, die in „Abgebrochen“ verschoben werden müssen. Standardmäßig ist dieser Parameter auf jede Stunde eingestellt.
Queue.MaxSlaInMinutes
Queue.MaxSlaInMinutes
Der maximale Wert in Minuten, auf den die SLA eingestellt werden kann. Standardmäßig ist der Wert 129600 Minuten (90 Tage) und wird standardmäßig in UiPath.Orchestrator.dll.config
angezeigt, auch in Update-Szenarien.
Queue.MaxSchemaFileSizeInKilobytes
Queue.MaxSchemaFileSizeInKilobytes
Die maximale Dateigröße (in KB) des JSON-Schemas, anhand derer Warteschlangenelementdaten und -ausgabe überprüft werden. Diese Einstellung wird nicht standardmäßig in der Datei UiPath.Orchestrator.dll.config
angezeigt.
Queue.SlaReadaheadTimeLimitHours
Queue.SlaReadaheadTimeLimitHours
Der Zeitraum, in dem Warteschlangenartikelfristen für die Elemente, die bei der Erstellung von Vorhersagen berücksichtigt werden sollen, fallen müssen. Der Standardwert ist 24 Stunden. Dieser Parameter wird per Standard nicht in UiPath.Orchestrator.dll.config
angezeigt.
Queue.MaxSpecificDataSizeInKiloBytes
Queue.MaxSpecificDataSizeInKiloBytes
Die maximale Größe des Inhalts spezifischer Daten für neue Warteschlangenelemente in Kilobyte. Bei sauberen Orchestrator-Installationen ist dieser Parameter ausgeblendet und hat den Standardwert 1024 (1 MB). In Upgradeszenarien ist dieser Parameter sichtbar und hat den Wert 204800 (200 MB).
Queue.ProcessActivationSchedule
Queue.ProcessActivationSchedule
Der Zeitraum zwischen den Überprüfungen für nicht verarbeitete Warteschlangenelemente. Standardmäßig ist dieser Wert auf 30 Minuten festgelegt. Um das Prüfintervall anzupassen, geben Sie einen Wert zwischen 0 und 59 an, starten Sie IIS neu, löschen Sie dann den vorhandenen Warteschlangentrigger, und erstellen Sie ihn neu.
Warnungen
Hinweis:
Um Änderungen an den Zeitplänen interner Aufträge vorzunehmen, folgen Sie den Schritten unter Aktualisieren von Zeitplänen interner Aufträge.
DailyAlertMailJobCron
DailyAlertMailJobCron
Ermöglicht das Konfigurieren eines CRON-Ausdrucks, der steuert, wann tägliche E-Mail-Benachrichtigungen gesendet werden. Dies funktioniert nur, wenn E-Mail-Benachrichtigungen aktiviert sind. Der Bericht enthält alle am Vortag generierten Warnungen mit den Schweregraden Schwerwiegend und Fehler. Standardmäßig wird er jeden Tag um 7 Uhr gesendet.
Alerts.Email.Enabled
Alerts.Email.Enabled
E-Mail-Warnungen für Fehlermeldungen mit den Schweregraden „Schwerwiegend“ und „Fehler“ aktivieren oder deaktivieren. Dieser Parameter entspricht dem Kontrollkästchen Warn-E-Mails aktivieren auf der Seite Einstellungen. Standardmäßig ist er auf false
festgelegt. Damit dies funktioniert, müssen Sie auch die E-Mail-bezogenen Einstellungen auf der Seite Einstellungen konfigurieren. Der Standardwert wird im Ausgangswert der Datenbank verwendet. Ein späteres Ändern des Werts schaltet die E-Mail-Warnungen nicht um.
NotificationDistributerJobCron
NotificationDistributerJobCron
Die Häufigkeit, mit der Warnungsbenachrichtigungen an die Schnittstelle gesendet werden. Standardmäßig werden Warnungen alle 10 Sekunden gesendet.
PeriodicErrorMailJobCron
PeriodicErrorMailJobCron
Ermöglicht das Konfigurieren eines CRON-Ausdruck, der die Häufigkeit steuert, mit der regelmäßige E-Mail-Benachrichtigungen gesendet werden. Dies funktioniert nur, wenn E-Mail-Benachrichtigungen aktiviert sind. Der Standardwert ist alle 10 Minuten, d. h. der Bericht enthält in den letzten 10 Minuten generierte Warnungen mit den Schweregraden Schwerwiegend und Fehler. Wenn keine Warnungen generiert wurden, wird kein Bericht gesendet.
PasswordComplexity
PasswordComplexity
Steuert die Validierungsregeln für die Passwortkomplexität und wird mithilfe regulärer Ausdrücke ausgedrückt. Die Komplexität gilt standardmäßig für alle Passwörter (auch für das des Host-Administrators). Dennoch kann jeder Mandant die Komplexität des Benutzeranmeldepassworts auf der Registerkarte Sicherheit auf der Seite Einstellungen anpassen. Standardmäßig müssen Passwörter mindestens 8 Zeichen und mindestens einen Buchstaben und eine Ziffer enthalten.
SystemJobs.DetectNotRespondingRobots.MaxAlertCount
SystemJobs.DetectNotRespondingRobots.MaxAlertCount
Ermöglicht Ihnen die Begrenzung der Anzahl der Warnungen, die gesendet werden, wenn Roboter nicht antworten. Dieser Parameter kann nützlich sein, wenn Ihre Orchestrator-Instanz eine sehr hohe Anzahl von Robotern bewältigen muss und die meisten davon häufig nicht antworten. Bitte beachten Sie, dass diese Option nicht standardmäßig in der Konfigurationsdatei angezeigt wird. Wenn Sie zum Beispiel die Anzahl der Warnungen auf 10 begrenzen möchten, die Sie für nicht antwortende Roboter erhalten, fügen Sie <add key="SystemJobs.DetectNotRespondingRobots.MaxAlertCount" value="10" />
in der Datei UiPath.Orchestrator.dll.config
unter allen anderen Warnparametern hinzu. Wenn Sie diese Einstellung übernehmen, beachten Sie bitte, dass in Event Viewer eine Warnmeldung ausgegeben wird, wenn die Gesamtanzahl der Warnungen höher ist als die konfigurierte, zum Beispiel: Alerts not published: total number of unresponsive sessions (21) is bigger than the configured max allowed (10).
.
SystemJobs.LicenseExpirationAlert.DaysBefore
SystemJobs.LicenseExpirationAlert.DaysBefore
Ermöglicht Ihnen, die Zeitintervalle vor dem Lizenzablauflaufdatum zu definieren, wenn Sie E-Mail-Benachrichtigungen erhalten. Der Standardwert ist 180,90,30,14,7,1
und bedeutet, dass Sie 6 Mal E-Mail-Benachrichtigungen erhalten: 180, 90, 30, 14, 7 und 1 Tag(e), bevor Ihre Lizenz abläuft. Sie können weniger Werte definieren, um die Häufigkeit der E-Mail-Benachrichtigungen zu reduzieren. Dies ist zum Beispiel durch Hinzufügen des folgenden Schlüssels in der Datei UiPath.Orchestrator.dll.config
möglich: <add key="SystemJobs.LicenseExpirationAlert.DaysBefore" value="90,30,14" />
.
Bereitstellung
Orchestrator verwendet ein zusammengesetztes Repository. Paketmetadaten werden zur schnelleren Suche und Filterung in der SQL-Datenbank abgelegt. Die Pakete werden an den Speicherorten gespeichert, die in den Parametern Storage.Type
und Storage.Location
angegeben sind.
Hinweis:
Die Verwendung von Kopieren-Einfügen-Befehlen im dedizierten Paketordner wird nicht unterstützt.
Storage.Type
Storage.Type
Definiert das Ziel, auf dem Pakete und Ausführungsmedien gespeichert werden. Kann mit den folgenden Zielen aufgefüllt werden:
File System
-<add key="Storage.Type" value="FileSystem" />
.Azure
-<add key="Storage.Type" value="Azure" />
.Amazon
-<add key="Storage.Type" value="Amazon" />
.Minio
-<add key="Storage.Type" value="Minio" />
.
Storage.Location
Storage.Location
Definiert den tatsächlichen Speicherort, an dem Pakete und Ausführungsmedien gespeichert werden.
Wichtig!
Der Parameter
Storage.Location
ist obligatorisch, wenn:
- ein Upgrade von einer Version von Orchestrator vor 2020.10 vorgenommen wird, und
- der vorherige
NuGet.Repository.Type
warLegacy
und- der vorherige
NuGet.Packages.Path
nicht den Standardwert verwendet hat.
Target | Location |
---|---|
FileSystem | Provide an absolute path using the following format: RootPath=C:\FolderName\AnotherFolderName .Example: <add key="Storage.Location" value="RootPath=C:\FolderName\AnotherFolderName" /> .In the provided folder, the following folder structure gets created: Orchestrator-Host\Libraries - One folder dedicated to the libraries stored in the host feed.Orchestrator-[tenantKey] -One folder for each tenant. The tenant is identified by the tenant key as found in the database. For example Orchestrator-12ab1234-a567-456b-a12b-ab3456b123ab .For each tenant folder, three other sub-directories are created: \ExecutionMedia \Packages \Libraries Files are saved in the dedicated folders at the specified location. By default, they are stored at the following path: C:\Program Files (x86)\UiPath\Orchestrator\Storage . |
Azure | Provide a connection string. Example: <add key="Storage.Location" value="DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net" /> . |
Amazon | Provide a connection string. Example: <add key="Storage.Location" value="EndpointRegion=eu-west-3;accessKey=AKIAZGUEIGXUJ3BBI4MW;secretKey=W/LOzDbI1qumvcwYs8iUf4pRwW6ltKos/paTLVYM;useHttp=false" /> .To disable public access to newly created Amazon S3 buckets, add BlockPublicAccess=true to the connection string. Note that this has no impact on existing buckets.Example: <add key="Storage.Location" value="EndpointRegion=eu-west-3;accessKey=AKIAZGUEIGXUJ3BBI4MW;secretKey=W/LOzDbI1qumvcwYs8iUf4pRwW6ltKos/paTLVYM;useHttp=false;BlockPublicAccess=true" /> .To use the default Amazon S3 credentials, remove AccessKey and SecretKey and add UseDefaultCredentials=true instead. This allows you to use the machine's IAM role on an Amazon EC2 VM.Example: <add key="Storage.Location" value="EndpointRegion=eu-west-3;UseDefaultCredentials=true" /> . |
Minio | Provide a connection string. Example: <add key="Storage.Location" value="host=localhost:9001;accessKey=YVKYFJ0ZY246KDKP0634;secretKey=bdBEk2ubhIFsTNPuQ80PjKL+oqZBj67HoSWBFnw1" /> . |
Beispiel
<add key=\"Storage.Type\" value=\"Azure\" />
<add key=\"Storage.Location\" value=\"DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net\" />
Durch die obige Konfiguration wird Orchestrator angewiesen:
- die Paketmetadaten in der SQL-Datenbank zu speichern,
- die eigentlichen Dateien im Azure Blob Speicher an dem mit dem Verbindungsstring
DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net
angegebenen Speicherort abzulegen, - die Standard-Namenskonvention für den Azure-Behälternamen -
Orchestrator-tenantKey
- zu verwenden.
Wichtig!
Wenn Sie in Orchestrator mehr als 99 Mandanten haben, müssen Sie Ihr Standard-AWS S3 Bucket-Kontolimit passend für die Mandantenanzahl erhöhen. Dies ist erforderlich, weil für jeden Mandanten ein separater Bucket erstellt wird.
NuGet.Packages.ApiKey
NuGet.Packages.ApiKey
Der Lizenzschlüssel Ihres NuGet-Kontos. Wenn die Aktivitäten und Pakete im selben NuGet-Feed gespeichert sind, muss der Wert dieses Parameters identisch mit dem von NuGet.Activities.ApiKey
sein. Der Standardwert wird beim ersten Seeding der Datenbank verwendet. Bitte beachten Sie, dass beliebige Zeichenfolgen auch akzeptiert werden.
NuGet.Activities.ApiKey
NuGet.Activities.ApiKey
Der Lizenzschlüssel Ihres NuGet-Kontos. Wenn die Aktivitäten und Pakete im selben NuGet-Feed gespeichert sind, muss der Wert dieses Parameters identisch mit dem von NuGet.Packages.ApiKey
sein. Bitte beachten Sie, dass beliebige Zeichenfolgen auch akzeptiert werden.
Die Paketsynchronisierung zwischen mehreren Orchestrator-Knoten und der Schnittstelle kann entweder durch Überwachen des Dateisystems oder unter Verwendung von Redis erfolgen. Dies kann mithilfe der Konfiguration unten eingestellt werden. Wir empfehlen die Verwendung von Redis.
Processes.AllowUpdateWithRunningJobs
Processes.AllowUpdateWithRunningJobs
Gibt an, ob Sie einen Prozess löschen können, während diesem laufende oder anstehende Aufträge zugeordnet sind. Bitte beachten Sie, dass dieser Parameter per Standard ausgeblendet ist. Die folgenden Werte sind verfügbar:
true
- Prozesse können gelöscht werden, während laufende oder anstehende Jobs zugeordnet sind.false
- Prozesse können nicht gelöscht werden, während ihnen laufende oder anstehende Aufträge zugeordnet sind. Der Versuch, einen Prozess zu löschen, zeigt in diesem Fall die folgende Fehlermeldung an: „Das Ändern dieses Prozesses ist momentan nicht möglich, da aktive Aufträge mit diesem verknüpft sind. (#1666)". Dies ist der Standardwert.
Wenn Sie zum Beispiel Ihre Prozesse entfernen können möchten, während ein zugeordneter Auftrag ausgeführt werden, fügen <add key="Processes.AllowUpdateWithRunningJobs" value="true" />
in der Datei UiPath.Orchestrator.dll.config
hinzu.
Deployment.Libraries.AllowTenantPublish
Deployment.Libraries.AllowTenantPublish
Hier können Sie angeben, ob die Mandanten, die den Hostfeed verwenden, Bibliotheken in den Feed hochladen können oder nicht. Die folgenden Werte sind verfügbar:
true
- Bibliotheken, die auf Mandantenebene hochgeladen werden, werden an den Hostfeed weitergegeben. Dies ist der Standardwert.false
- Bibliotheken, die auf Mandantenebene hochgeladen werden, werden an den Hostfeed weitergegeben. Beachten Sie jedoch, dass Benutzer Zugriff auf die vorhandenen Bibliotheken im Feed haben.
Sie können dies auch über die Benutzeroberfläche konfigurieren. Die entsprechende Option, Mandantenbenutzern das Hochladen in den Feed erlauben finden Sie auf der Hostebene auf der Seite Einstellungen. Details finden Sie hier.
Speicher-Buckets
Buckets.ContentSecurityPolicy
Buckets.ContentSecurityPolicy
Wird verwendet, um Domänen außerhalb der vertrauenswürdigen Domänen anzuzeigen, an die der Orchestrator Anforderungen stellen kann. Mehrere Werte können durch Kommas getrennt aufgelistet werden. Dieser Parameter überschreibt die entsprechenden Orchestrator-Einstellungen in Bezug auf Azure und AWS, deshalb stellen Sie sicher, dass Sie, bei Bedarf, auch Azure und/oder AWS hinzufügen. Dieser Parameter wird nicht standardmäßig in der Datei UiPath.Orchestrator.dll.config
angezeigt.
Buckets.AvailableProviders
Buckets.AvailableProviders
Used to control which providers can be used in creating storage buckets. The available providers are: Orchestrator, Amazon, Azure, Minio, S3 compatible storage providers, and File System. Multiple values can be entered with a comma separator.
Hinweis : Standardmäßig wird dieser Schlüssel nicht in der Datei UiPath.Orchestrator.dll.config
angezeigt und nur die folgenden Anbieter werden ausgewählt: Orchestrator
, Amazon
, Azure
, Minio
und S3Compatible
. Das Standardverhalten gilt sowohl für Neuinstallationen als auch für Upgrades. Wenn der Schlüssel sichtbar ist, sind die verfügbaren Anbieter auf diejenigen beschränkt, die als Buckets.AvailableProviders
-Werte angegeben sind.
Beispiel: Um nur den Orchestrator, Amazon und Azure als Speicher-Bucket-Anbieter zu verwenden, fügen Sie den folgenden Schlüssel hinzu:
<add key="Buckets.AvailableProviders" value="Orchestrator,Amazon,Azure" />
Buckets.FileSystem.Allowlist
Buckets.FileSystem.Allowlist
Bietet eine Möglichkeit, die Verwendung von FileSystem-Buckets zu steuern. Die Einstellung enthält keinen standardmäßig konfigurierten Wert. Dies bedeutet, dass FileSystem standardmäßig sowohl bei Neuinstallationen als auch bei Upgrades deaktiviert ist, und ebenso, dass zunächst keine FileSystem-Pfade verwendet werden können. Aus Sicherheitsgründen muss ein Administrator FileSystem aktivieren, um die FileSystem-Funktion verwenden zu können, und dann explizit den Zugriff auf eine Liste von Ordnern oder Netzwerkfreigaben zulassen, indem er Buckets.FileSystem.Allowlist
Werte zuweist.
Es können mehrere Werte getrennt durch das Zeichen |
eingegeben werden. Beachten Sie, dass die Pfade vollqualifiziert sein müssen, entweder gerooted mit einem Laufwerk oder einem UNC-Pfad (z. B. c:\
, c:\test
, \\servershare\shared
), und jeder von ihnen stellt ein Präfix dar, das für jeden beliebigen Bucket verwendet werden darf. Ein Bucket kann auf diesem bestimmten Pfad oder einem beliebigen Unterpfad erstellt werden.
Wichtig!
Da das Erstellen einer FileSystem-Zulassungsliste über die Einstellung
Buckets.FileSystem.Allowlist
eine Reihe von Sicherheitsauswirkungen hat, sollten Sie sich unter Sichere Verwendung der FileSystem-Speicherzulassungsliste informieren, bevor sie fortfahren.
Autorisierung
AcceptedRootUrls
AcceptedRootUrls
Ermöglicht das Hinzufügen einer Liste vertrauenswürdiger URLs. Wenn dieser Einstellung kein Wert zugeordnet ist, kann niemand auf Orchestrator zugreifen. Wenn Sie mehrere URLs hinzufügen möchten, tun Sie dies ohne Leerstellen und trennen Sie die Elemente mit Kommas (,
), wie hier "https://server1,https://server2"
.
Auth.Cookie.Expire
Auth.Cookie.Expire
Die Zeitdauer in Minuten, nach der Sie automatisch abgemeldet werden. Standardmäßig ist dieser Wert auf 30 Minuten festgelegt.
This setting does not apply to the host- and organization-level Management portals. If you would like to set a similar timeout interval for these portals, see Setting a timeout interval for the Management portals.
Auth.Bearer.Robot.Expire
Auth.Bearer.Robot.Expire
Die Zeitdauer, nach der das Bearer Token Ihres Roboters erlischt. Standardmäßig ist dieser Wert auf 30 Minuten festgelegt.
Auth.Cookie.ValidateInterval
Auth.Cookie.ValidateInterval
Die Zeit (in Sekunden), bis Sie nach einer Kennwortzurücksetzung oder nach der Erkennung einer neuen Sitzung abgemeldet werden. Standardmäßig ist dieser Wert auf 60
Sekunden festgelegt. Dieser Parameter wird per Standard in der Datei UiPath.Orchestrator.dll.config
nicht angezeigt. Wenn Sie ihn beispielsweise auf 20 Sekunden festlegen möchten, fügen Sie den folgenden Schlüssel hinzu: <add key="Auth.Cookie.ValidateInterval" value="20"/>
.
Auth.DisabledPermissions
Auth.DisabledPermissions
Ermöglicht Ihnen, zu konfigurieren, dass Berechtigungen über die Benutzeroberfläche deaktiviert und bei der Nutzung der API ignoriert werden. Bitte beachten Sie, dass dieser Parameter per Standard ausgeblendet ist. Die Berechtigungen müssen hinzugefügt werden, da sie in der API verwendet werden, und sie müssen durch Komma getrennt sein. Beispiel: Wenn Sie Berechtigungen zum Löschen für Bibliotheken und Maschinen deaktivieren möchten, müssen Sie den folgenden Schlüssel hinzufügen: <add key="Auth.DisabledPermissions" value="Machines.Delete,Libraries.Delete" />
.
Auth.RememberMe.Enabled
Auth.RememberMe.Enabled
Ermöglicht Ihnen, zu konfigurieren, ob das Kontrollkästchen Benutzer speichern auf der Seite Anmelden angezeigt wird oder nicht. Per Standard ist der Parameter auf true
festgelegt, was bedeutet, dass das Kontrollkästchen angezeigt wird. Setzen Sie ihn auf false
, um es auszublenden. Diese Einstellung wird per Standard in der Datei UiPath.Orchestrator.dll.config
nicht angezeigt.
Auth.AllowChangePassword
Auth.AllowChangePassword
Ermöglicht Ihnen die Konfiguration, ob ein Benutzer sein Kennwort im Abschnitt Sicherheit auf der Seite Profil ändern kann. Diese Einstellung wird per Standard in der Datei UiPath.Orchestrator.dll.config
nicht angezeigt. Die folgenden Werte sind verfügbar:
true
- Der Benutzer kann sein Kennwort auf der Profilseite nicht ändern. Dies ist der Standardwert.false
- Der Benutzer kann sein Kennwort auf der Profilseite nicht ändern.
Auth.AllowSelfEmailUpdate
Auth.AllowSelfEmailUpdate
Ermöglicht Ihnen die Konfiguration, ob ein Benutzer seine E-Mail-Adresse im Abschnitt Allgemein auf der Seite Profil ändern kann. Standardmäßig ist der Parameter auf true
festgelegt, d. h. eine Aktualisierung ist möglich. Legen Sie den Parameter auf false
fest, um das Feld schreibgeschützt zu machen. Diese Einstellung wird per Standard in der Datei UiPath.Orchestrator.dll.config
nicht angezeigt.
ExternalAuth.AccessTokenAuth.Enabled
ExternalAuth.AccessTokenAuth.Enabled
Ermöglicht die Konfiguration, ob die Authentifizierung bei Orchestrator mit einem von Auth0 ausgestellten Bearer-Zugriffstoken möglich ist. Diese Einstellung wird per Standard in der Datei UiPath.Orchestrator.dll.config
nicht angezeigt. Die folgenden Werte sind verfügbar:
true
- Der Benutzer kann authentifizierte Anforderungen mithilfe eines von Auth0 ausgestellten Zugriffstokens stellen. Dies wird nur berücksichtigt, wenn Sie eine gültige Zielgruppe für den ParameterExternalAuth.AccessTokenAuth.Audience
festlegen.false
- Der Benutzer kann keine authentifizierten Anforderungen mithilfe eines von Auth0 ausgestellten Zugriffstokens stellen. Dies ist der Standardwert.
ExternalAuth.AccessTokenAuth.Audience
ExternalAuth.AccessTokenAuth.Audience
Enables you to control the target audience of the access token. This parameter needs to be set to a valid audience, which is used to check against the Auth0 token audience. For example, if you want to set the audience to https://cloud.uipath.com, you need to add the following key: <add key="ExternalAuth.AccessTokenAuth.Audience" value="https://cloud.uipath.com" />
. This setting is not displayed by default in the UiPath.Orchestrator.dll.config
file.
ExternalAuth.ShowPII
ExternalAuth.ShowPII
Lassen Sie die Orchestrator-PII-Anzeige zu, indem Sie den folgenden Schlüssel hinzufügen: <add key="ExternalAuth.ShowPII" value="true" />
. Der Schlüssel wird nicht standardmäßig in UiPath.Orchestrator.dll.config
angezeigt, und das Standardverhalten lässt keine PII-Anzeige zu.
RestrictBasicAuthentication
RestrictBasicAuthentication
Moved to Identity Server appsettings.json
.
EnableBasicAuthenticationForHostTenant
EnableBasicAuthenticationForHostTenant
Moved to Identity Server appsettings.json
.
Lastausgleich
Diese Einstellungen sollten nur dann modifiziert werden, wenn Sie einen Lastausgleich verwenden.
LoadBalancer.UseRedis
LoadBalancer.UseRedis
Verwenden Sie Redis als eine Datenbank zum Verteilen von Meldungen von und zu all den Maschinen, die über Ihren Lastausgleich verbunden sind. Standardmäßig auf false
festgelegt.
LoadBalancer.Redis.ConnectionString
LoadBalancer.Redis.ConnectionString
Kann nur verwendet werden, wenn LoadBalancer.UseRedis
auf true
festgelegt ist. Ein Verbindungszeichenfolge, die es Ihnen ermöglicht, Ihren Redis-Server einzurichten. Sie enthält die URL des Servers, das Kennwort und den mit Redis verwendeten Port. Alle HAA-Clusterknoten sollten in der Verbindungszeichenfolge hinzugefügt werden.
It is also possible to enable SSL encrypted connections between the Orchestrator nodes and the Redis service. For more information, please click here. Examples:
- mit aktiviertem SSL -
<add key="LoadBalancer.Redis.ConnectionString" value="10.10.20.184:10000,10.10.24.148:10000,10.10.22.114:10000,password=12345678,ssl=true" />
- ohne aktiviertes SSL -
<add key="LoadBalancer.Redis.ConnectionString" value="10.10.20.184:10000,10.10.24.148:10000,10.10.22.114:10000,password=12345678" />
Passworttresor
Plugins.SecureStores
Plugins.SecureStores
Diese Einstellung sollte aktualisiert werden, um die Plugins aller von Ihnen verwendeten Anmeldeinformationsspeicher einzuschließen. Sie können aus den folgenden Optionen wählen: CyberArk, CyberArk CCP, Azure Key Vault, Thycotic Secret Server, BeyondTrust und HashiCorp Vault. Die Anmeldeinformationsspeicher-Plugins befinden sich im Ordner \Orchestrator\Plugins
Ihres Installationsverzeichnisses. Zum Beispiel:
- Einzelner Speicher:
<add key="Plugins.SecureStores" value="UiPath.Orchestrator.CyberArk.dll"/>
- Mehrere Speicher:
<add key="Plugins.SecureStores" value="UiPath.Orchestrator.CyberArk.dll;UiPath.Orchestrator.AzureKeyVault.SecureStore.dll;UiPath.Orchestrator.SecureStore.CyberArkCCP.dll;UiPath.Orchestrator.SecureStore.HashiCorpVault.dll;UiPath.Orchestrator.SecureStore.BeyondTrust.dll" />
Hinweis:
Beim Aktualisieren einer Orchestrator-Instanz mit einer vorhandenen CyberArk-Integration wird diese Einstellung mit dem CyberArk-Plugin vorab aufgefüllt. Für alle anderen Installationen ist der Einstellungswert standardmäßig leer.
Plugins.SecureStores.CyberArk.CLIPasswordSDKExePath
Plugins.SecureStores.CyberArk.CLIPasswordSDKExePath
Ermöglicht dem CyberArk-Plugin die Suche nach CLIPasswordSDK64.exe
in einem benutzerdefinierten Installationspfad. Wenn beispielsweise D:\CustomFolder\
das CyberArk-Installationsverzeichnis ist, müssen Sie den folgenden Schlüssel hinzufügen: <add key="Plugins.SecureStores.CyberArk.CLIPasswordSDKExePath" value="D:\CustomFolder\CLIPasswordSDK64.exe"/>
. Der Standardwert dieser App-Einstellung ist C:\Program Files (x86)\CyberArk\ApplicationPasswordSdk\CLIPasswordSDK64.exe
.
Plugins.SecureStores.CyberArk.UsePowerShellCLI
Plugins.SecureStores.CyberArk.UsePowerShellCLI
Ermöglicht das Abrufen von Anmeldeinformationen aus einem CyberArk-Tresor bei Verwendung der Pfadauthentifizierung. Der Schlüssel ist standardmäßig ausgeblendet. Der Standardwert ist false
. Fügen Sie den folgenden Schlüssel hinzu, um ihn zu aktivieren: <add key="Plugins.SecureStores.CyberArk.UsePowerShellCLI" value="true"/>
.
Azure-AD-Authentifizierung
The configuration for Azure AD authentication has been moved to Identity Server's External Providers page.
Active Directory-Authentifizierung
Die Konfiguration für die Active Directory-Authentifizierung erfolgt nach der Installation über das Verwaltungsportal des Orchestrators.
For instructions, see Configuring the Active Directory integration page.
Protokolle
Logs.RobotLogs.ReadTarget
Logs.RobotLogs.ReadTarget
Ermöglicht die Konfiguration der Quelle, aus der Orchestrator Protokolle liest und auffüllt (z. B. database
oder robotelasticbuffer
).
RobotsLogs.Flush.Interval
RobotsLogs.Flush.Interval
Mit dieser Einstellung können Sie das Flush-Intervall für den SubmitLogs-Endpunkt ändern. Beachten Sie, dass es nicht standardmäßig in UiPath.Orchestrator.dll.config
angezeigt wird. Sofern nicht anders angegeben, beträgt der Wert 0 Sekunden. Das folgende Beispiel zeigt, wie ein Flush-Intervall von 60 Sekunden festgelegt wird, was bedeutet, dass der Roboter alle 60 Sekunden Protokolle an den Server sendet.
<add key="RobotsLogs.Flush.Interval" value="60" />
Wichtig!
Wenn der Roboter die Verbindung trennt, bevor das Flush-Intervall abgeschlossen ist, wird der letzte Stapel von Protokollen gesendet, wenn er das nächste Mal eine Verbindung mit Orchestrator herstellt.
RobotsLogs.Flush.BatchSize
RobotsLogs.Flush.BatchSize
Diese Einstellung dient dazu, die Flush-Größe für den SubmitLogs-Endpunkt anzupassen. Standardmäßig wird sie nicht in UiPath.Orchestrator.dll.config
angezeigt. Sofern nicht anders angegeben, beträgt der Wert 100 Protokollnachrichteneinträge, was bedeutet, dass der Roboter Batches von 100 Protokollen an den Server sendet.
<add key="RobotsLogs.Flush.BatchSize" value="100" />
Logs.RequestAbortedLogBehavior
Logs.RequestAbortedLogBehavior
Gibt das Protokollierungsverhalten für Abbruchausnahmen an, die beim Abbrechen eines ausgeführten Vorgangs ausgelöst werden. Diese werden z. B. generiert, wenn Sie auf eine Schaltfläche klicken und vor dem Ausführen des Vorgangs auf eine andere Schaltfläche klicken. Bitte beachten Sie, dass dieser Parameter per Standard ausgeblendet ist. Die folgenden Werte sind verfügbar:
Ignore
- Alle Abbruchausnahmen werden ignoriert, wenn die entsprechenden Anforderungen abgebrochen wurden. Dies ist der Standardwert.Info
- Abbruchausnahmen werden mit Info zum Schweregrad protokolliert.None
- Abbruchausnahmen werden mit Fehler-Schweregrad protokolliert.
Wenn Sie keine Abbruchausnahmen protokollieren möchten, müssen Sie <add key="Logs.RequestAbortedLogBehavior" value="Ignore" />
in der Konfigurationsdatei hinzufügen.
Logs.Elasticsearch.SharedIndex
Logs.Elasticsearch.SharedIndex
Ermöglicht das Protokollieren des gleichen Indexes für alle Mandanten. Er muss auf denselben Wert festgelegt werden, der für den Parameter index
im NLog-Ziel verwendet wird. Beispiel: <add key="Logs.Elasticsearch.SharedIndex" value="robotlogs" />
. Details finden Sie hier. Bitte beachten Sie, dass dieser Parameter per Standard ausgeblendet ist.
Logs.Elasticsearch.EnableFolderIdFilter
Logs.Elasticsearch.EnableFolderIdFilter
Steuern Sie die Sichtbarkeit von Protokollen, die vor 2019.10 generiert wurden und auf der Seite Protokolle nicht nach dem enthaltenden Ordner gefiltert werden können. Der Parameter ist standardmäßig auf true
festgelegt, d. h., Protokolle sind ausgeblendet. Legen Sie false
fest, um sie anzuzeigen: <add key="Logs.Elasticsearch.EnableFolderIdFilter" value="false" />
Logs.Elasticsearch.Username
Logs.Elasticsearch.Username
The username required for reading logs in Elasticsearch. Note that you need to configure this parameter only if Elasticsearch authentication is enabled, and you do not use an NLog target. When configuring the parameter, make sure its value matches the Elasticsearch server settings. For more details, see X-Pack Authentication.
Logs.Elasticsearch.Password
Logs.Elasticsearch.Password
The username required for reading logs in Elasticsearch. Note that you need to configure this parameter only if Elasticsearch authentication is enabled, and you do not use an NLog target. When configuring the parameter, make sure its value matches the Elasticsearch server settings. For more details, see X-Pack Authentication.
Logs.Elasticsearch.OAuthEnabled
Logs.Elasticsearch.OAuthEnabled
Legen Sie diesen Parameter auf true
fest, um OAuth2 zu aktivieren und verwenden Sie einen tokenbasierten Authentifizierungsmechanismus zum Lesen von Roboterprotokollen in Elasticsearch als Alternative zum System mit Benutzer und Kennwort. Standardmäßig ist dieser Parameter auf false
festgelegt.
When enabling OAuth authentication, you still need to provide the username and password as in the default authentication method. This is required because the initial token is generated based on those credentials.
See OAuth2 Authentication for detailed instructions on how to configure OAuth2 authentication for Elasticsearch.
Logs.Elasticsearch.OAuthExpireInSeconds
Logs.Elasticsearch.OAuthExpireInSeconds
Ermöglicht Ihnen das Festlegen der Zeit (in Sekunden), bevor das Zugriffstoken, das zum Lesen von Roboterprotokollen in Elasticsearch verwendet wird, abläuft und aktualisiert wird. Der Standardwert beträgt die empfohlenen 1200 Sekunden (20 Minuten), der Maximalwert 3600 Sekunden (60 Minuten). Mit der eigens dafür vorhandenen Schaltfläche im Orchestrator können Sie ein Token ungültig machen.
Before changing the token validity, make sure that Logs.Elasticsearch.OAuthEnabled
is set to true
and that you have properly configured the Elasticsearch server. For more on this, see OAuth2 Authentication.
Logs.Elasticsearch.DisableProductCheckStatus
Logs.Elasticsearch.DisableProductCheckStatus
Allows you to select an Elasticsearch version previous to 7.16.3. To do that, it must be set to true
.
This parameter is hidden, and its default value is false
.
It works in conjunction with the disableProductCheckStatus
in the Nlog file, which is also hidden and false
by default. It must also be set to true
in order to enable the feature.
Webhooks
Die Webhooks-Einstellungen wurden in die Datei appsettings.json
des Webhooks-Dienstes verschoben.
Skalierbarkeit
Scalability.Heartbeat.PeriodSeconds
Scalability.Heartbeat.PeriodSeconds
Das Zeitintervall in Sekunden, mit dem der Roboter einen Heartbeat zum Orchestrator sendet, über den der letztere über den Status informiert wird. Standardmäßig ist dieser Wert auf 30
Sekunde festgelegt.
Scalability.Heartbeat.FailureThreshold
Scalability.Heartbeat.FailureThreshold
Die Anzahl der nacheinander fehlgeschlagenen Heartbeats, die ein Roboter sendet, bis er im Orchestrator als nicht reagierend markiert wird. Dieser Parameter ist standardmäßig auf 4
festgelegt. Das bedeutet, dass ein Roboter nach 2 Minuten fehlgeschlagener Heartbeats (4 x 30 Sekunden = 2 Minuten) als nicht reagierend gekennzeichnet wird.
Scalability.SignalR.Enabled
Scalability.SignalR.Enabled
Gibt an, ob der Roboterdienst die SignalR-Kanäle von Orchestrator abonnieren soll. Standardmäßig ist das auf true
festgelegt. Dieser Parameter wird beim ersten Seeding der Datenbank verwendet. Um nach der Installation Änderungen vorzunehmen, verwenden Sie die Seite Einstellungen auf Mandanten- oder Hostebene.
Scalability.SignalR.Transport
Scalability.SignalR.Transport
Gibt das Transportprotokoll an, das verwendet wird, um sich mit den SignalR-Kanälen von Orchestrator zu verbinden. Folgende Werte können zugeordnet werden (in beliebiger Kombination - bitweise ODER):
- WebSocketTransport = 1
- ServerSentEventsTransport = 2
- LongPollingTransport = 4
- Standardwert: 7 (WebSocketTransport | ServerSentEventsTransport | LongPollingTransport)
Dieser Parameter wird beim ersten Seeding der Datenbank verwendet. Um Nach der Installation Änderungen vorzunehmen, verwenden Sie die Seite Einstellungen auf Mandanten- oder Host-Ebene.
Scalability.AzureSignalR.ConnectionString
Scalability.AzureSignalR.ConnectionString
Unterstützt Sie bei der Aktivierung von Azure SignalR Service und erleichtert die direkte Kommunikation zwischen Ihrer Roboterflotte und dem SignalR-Dienst
Orchestrator no longer intermediates it. This option should be used only if you have an Azure-hosted Orchestrator instance. It can be used in conjunction with the Scalability.AzureSignalR.ConnectionCount
key. This parameter is enabled in our Cloud offering. It is not displayed by default in the UiPath.Orchestrator.dll.config
file.
Bitte beachten Sie, dass bei Aktivierung dieser Option Roboter mit einer niedrigeren Version als 2019.2 für die Kommunikation mit Orchestrator nur das Heartbeat-Protokoll verwenden, d. h. dass ein von Orchestrator gegebener Befehl nur alle 30 Sekunden von einem Roboter aufgenommen wird. Um diesen Parameter zu aktivieren, füllen Sie seinen Wert mit der Verbindungszeichenfolge für Azure Service aus. Beispiel: <add key="Scalability.AzureSignalR.ConnectionString" value="Endpoint=https://test.signalr.net;AccessKey=M1ug+sBu07hyyi12AgyJ52SEd4OgC2Mm6BvllVHCC9c=;Version=1.0;" />
.
Scalability.AzureSignalR.ConnectionCount
Scalability.AzureSignalR.ConnectionCount
Ermöglicht das Ändern der Anzahl der Verbindungen (pro Hub) zwischen dem Server und Azure SignalR Service. Der Standardwert ist 5
. Beispiel: <add key="Scalability.AzureSignalR.ConnectionCount" value="7" />
. Diese Einstellung wird standardmäßig nicht angezeigt und kann nicht ohne den Scalability.AzureSignalR.ConnectionString
-Schlüssel verwendet werden.
Scalability.SignalR.RequireStickySessions
Scalability.SignalR.RequireStickySessions
Aktivieren Sie Sticky Sessions. Wenn true
festgelegt ist, sind alle Transporte aktiviert, und Orchestrator geht davon aus, dass Sticky Sessions auf dem Lastenausgleich aktiviert sind. Wenn Sie Sticky Sessions in UiPath.Orchestrator.dll.config
aktivieren, ohne sie auf dem Lastenausgleich zu aktivieren, führt dies zu fehlerhaften SignalR-Verbindungen.
Insights
Insights.TableCreationRetryCount
Insights.TableCreationRetryCount
Ermöglicht das Festlegen der maximalen Anzahl von Wiederholungsversuchen für die Erstellung neuer Tabellen. Standardmäßig ist der Wert auf 3
festgelegt.
Hinweis: Diese Einstellung ist optional und wird standardmäßig nicht in der UiPath.Orchestrator.dll.config
-Datei angezeigt.
Insights.TableCreationRetryBackoffSeconds
Insights.TableCreationRetryBackoffSeconds
Die Zeitspanne in Sekunden zwischen den Wiederholungsversuchen. Standardmäßig ist der Wert auf 60
festgelegt.
Hinweis: Diese Einstellung ist optional und wird standardmäßig nicht in der UiPath.Orchestrator.dll.config
-Datei angezeigt.
Insights.Ingestion.QueryTimeout
Insights.Ingestion.QueryTimeout
Der SQLServer-Timeout für Abfragen, die für die Orchestrator-Datenbank ausgeführt werden, um die Insights-Datenbank aufzufüllen. Die Einstellung wird standardmäßig nicht in der Datei UiPath.Orchestrator.dll.config
angezeigt. Sie sollten eine Aktualisierung in Betracht ziehen, wenn Timeout-Fehler beim Hintergrundauftrag auftreten, der die Erfassung für Insights vom Orchestrator SQLServer ausführt.
Analytik
Telemetry.Enabled
Telemetry.Enabled
Enables or disables the usage and performance data collection that UiPath uses to help diagnose problems and improve Orchestrator. For more details about UiPath’s privacy practices, please review the privacy statement. The following values are available:
true
- Die Telemetriefunktion ist deaktiviert. Dies ist der Standardwert.false
- Die Telemetriefunktion ist deaktiviert.
Überdies besteht die Möglichkeit, dass Sie sich beim Installieren oder Aktualisieren Ihrer Orchestrator-Instanz für oder gegen die Leistungs- und Nutzungsdatensammlung entscheiden, wie hier beschrieben.
Medienaufzeichnung
MediaRecording.Enabled
MediaRecording.Enabled
Zur Deaktivierung der Aufzeichnungsfunktion auf false
festlegen. Standardmäßig auf true
festgelegt. Das bedeutet, dass die Funktion aktiviert ist. Der Speicher wird mit den Parametern Storage.Type
und Storage.Location
definiert.
Paginierung (Pagination)
Pagination.Limits.Enabled
Pagination.Limits.Enabled
Für Cloud Platform- und Neuinstallationen von lokalen Orchestrator-Instanzen standardmäßig auf true
festgelegt. Fügt einen Standardwert $top
für alle Aufrufe von API-Endpunkten mit Paginierungsparametern hinzu (z. B. odata/Users
).
Auslöser
Triggers.DisableWhenFailedCount
Triggers.DisableWhenFailedCount
Sie können einen Trigger so konfigurieren, dass er nach einer bestimmten Anzahl von fehlgeschlagenen Starts und nicht erfolgreichen Ausführungen in einer bestimmten Anzahl von Tagen automatisch deaktiviert wird. In diesem Kontext können Sie mit Triggers.DisableWhenFailedCount
die Anzahl der fehlgeschlagenen Ausführungen anpassen, während Triggers.DisableWhenFailingSinceDays
Ihnen ermöglicht, die Anzahl der Tage zu ändern. Standardmäßig ist der Triggers.DisableWhenFailedCount
-Wert 10 und der Triggers.DisableWhenFailingSinceDays
-Wert 1, was bedeutet, dass der Trigger nach 10 erfolglosen Starts deaktiviert wird, wenn am letzten Tag keine erfolgreichen Ausführungen vorhanden waren.
Um zu verhindern, dass Trigger deaktiviert werden, wenn sie fehlschlagen, müssen Sie Triggers.DisableWhenFailedCount
auf 0 festlegen.
Triggers.JobsCountStrategy
Triggers.JobsCountStrategy
Ermöglicht es Ihnen, die Strategie für die Auftragsanzahl für Aufträge auszuwählen, die über Trigger gestartet werden. Standardmäßig ausgeblendet. Folgende Optionen stehen zur Verfügung:
PerProcess
- Ein Trigger startet die erforderliche Anzahl von Aufträgen unter Berücksichtigung ausstehender Aufträge für den angegebenen Prozess. Beispielsweise starten zwei Trigger, die für denselben Prozess definiert sind, 3 bzw. 5 Aufträge. Wenn der erste Trigger 3 Aufträge zu einem bestimmten Zeitpunkt startet, wenn der zweite Trigger ausgelöst wird, werden 2 Aufträge gestartet, um die 5 erforderlichen Aufträge zu erreichen. Fügen Sie den folgenden Schlüssel in der Konfigurationsdatei hinzu, um diese Strategie zu verwenden:<add key="Triggers.JobsCountStrategy" value="PerProcess" />
. Dies ist der Standardwert.PerTrigger
- Ein Trigger startet die erforderliche Anzahl von Aufträgen unter Berücksichtigung vorhandener Aufträge, die zuvor von demselben Trigger gestartet wurden. Beispielsweise wird ein Trigger definiert, um 9 Aufträge zu einem bestimmten Zeitpunkt zu starten. Wenn 2 Aufträge bis zum erneuten Auslösen dieses Triggers erfolgreich abgeschlossen wurden, startet Orchestrator weitere 2 Aufträge, um die 9 erforderlichen Aufträge zu erreichen. Fügen Sie den folgenden Schlüssel in der Konfigurationsdatei hinzu, um diese Strategie zu verwenden:<add key="Triggers.JobsCountStrategy" value="PerTrigger" />
.NoLimit
- Der Auslöser startet die erforderliche Anzahl von Aufträgen, unabhängig von vorhandenen ausstehenden Aufträgen. Beispielsweise wird ein Trigger definiert, um 5 Aufträge zu einem bestimmten Zeitpunkt zu starten. Beim zweiten Auslösen des Triggers werden weitere 5 Aufträge gestartet. Fügen Sie den folgenden Schlüssel in der Konfigurationsdatei hinzu, um diese Strategie zu verwenden:<add key="Triggers.JobsCountStrategy" value="NoLimit" />
.
QueueTriggers.PendingJobsStrategy
QueueTriggers.PendingJobsStrategy
Ermöglicht Ihnen die Auswahl der Berechnungsmethode für die Anzahl zusätzlicher Aufträge, die ausgelöst werden sollen, wenn neue Elemente zu einer Warteschlange hinzugefügt werden. Dazu wird die Zahl der Arbeitsplätze in einem bestimmten Status von der angestrebten Höchstzahl der zu schaffenden Arbeitsplätze abgezogen.
The following options are available:
True
- This is the default option. It is best suited for cases where you want Orchestrator to assume that all running jobs have already moved queue items out of the status New. The number is computed as follows:
Maximale Anzahl zusätzlicher Aufträge, die basierend auf neu verfügbaren Warteschlangenelementen erstellt werden können = die maximale Anzahl der gleichzeitig zulässigen ausstehenden und laufenden Aufträge – die Anzahl der Aufträge im Status Ausstehend.False
– Diese Option eignet sich am besten für Fälle, in denen der Orchestrator davon ausgehen soll, dass alle ausgeführten Aufträge Warteschlangenelemente noch aus dem Status Neu verschieben müssen. Die Zahl wird wie folgt berechnet:
Maximale zusätzliche Aufträge, die basierend auf neu verfügbaren Warteschlangenelementen erstellt werden können = die maximale Anzahl der gleichzeitig zulässigen ausstehenden und laufenden Aufträge – die Anzahl der Aufträge in einem der folgenden Zustände: Pending , Resumed , Running , Stopping , Terminating .
Sonstige
PreventAutoRefresh.Enabled
PreventAutoRefresh.Enabled
Steuern Sie, ob die Seite Aufträge im Menü Überwachung automatisch für jeden neu erstellten Auftrag aktualisiert wird. Der Schlüssel <add key="PreventAutoRefresh.Enabled" value="true" />
kann hinzugefügt werden, um die automatische Aktualisierung der Seite einzuschränken, wenn Aufträge ausgeführt werden. Der Schlüssel wird standardmäßig nicht angezeigt, und der Standardwert ist false
. Dies bedeutet, dass Orchestrator die Seite für jeden neuen Auftrag automatisch aktualisiert.
Die Seite wird aktualisiert, wenn Filter angewendet werden oder sich die Auftragszustände ändern, unabhängig vom Parameter PreventAutoRefresh.Enabled
.
QueueActivation.TriggerCache.Expiration.Minutes
QueueActivation.TriggerCache.Expiration.Minutes
Steuern Sie, wie einfache Quarztrigger für Warteschlangen mit zugeordneten Warteschlangentriggern generiert werden.
- Wenn auf
0
festgelegt, wird für jedes Element, das in einer Warteschlange hinzugefügt wird, ein Quarztrigger generiert. - Wenn der Wert größer als 0 ist, prüft das System, ob bereits ein Quarztrigger für diese Warteschlange erstellt wurde und verhindert, dass ein anderer Trigger erstellt wird. Die Einschränkung wird entfernt, wenn die Bedingungen der Warteschlangen-Trigger erfüllt sind. Wenn der Warteschlangentrigger dies nicht tut, wird die Einschränkung entsprechend dem für den Parameter
QueueActivation.TriggerCache.Expiration.Minutes
festgelegten Wert entfernt. Der Standardwert ist5
.
Features.ClassicFolders.Enabled
Features.ClassicFolders.Enabled
Control if the classic folders model is enabled. The default value is false
, meaning classic folders are disabled, and only modern folders are available. This parameter is hidden by default.
Jobs.TerminatingJobsTimeout
Jobs.TerminatingJobsTimeout
Konfigurieren Sie die verstrichene Zeit, bis zu beendende Aufträge als „Fehlgeschlagen“ markiert werden können. Der Standardwert ist 1440
, d. h., Aufträge können nicht als „Fehlgeschlagen“ markiert werden, es sei denn, sie befinden sich mindestens einen Tag lang in einem Beenden-Status. Dieser Parameter ist standardmäßig ausgeblendet.
Jobs.TerminatingJobsCleanupCron
Jobs.TerminatingJobsCleanupCron
Konfigurieren Sie einen Cron-Ausdruck, der die Häufigkeit des Hintergrundauftrags steuert, der zu beendende Aufträge als „Fehlgeschlagen“ markiert. Aufträge können nicht als „Fehlgeschlagen“ markiert werden, es sei denn, sie befinden sich mindestens für die im Parameter Jobs.TerminatingJobsTimeout
festgelegte Dauer in einem Beenden-Status. Die Standardwerte sind 0 0 0/3 1/1 * ? *
für Jobs.TerminatingJobsCleanupCron
und 1440
für Jobs.TerminatingJobsTimeout
, d. h., der Hintergrundauftrag wird einmal alle drei Stunden ausgeführt und ändert nur die Aufträge in „Fehlgeschlagen“, die sich mindestens einen Tag lang im Beenden-Status befinden. Dieser Parameter ist standardmäßig ausgeblendet.
PW.StopExploringCron
PW.StopExploringCron
Konfigurieren Sie einen Cron-Ausdruck, der die Häufigkeit eines Hintergrundauftrags steuert, der überprüft, ob die Benutzer, die persönliche Arbeitsbereiche erkunden, noch über die erforderlichen Berechtigungen verfügen(Anzeigen und Bearbeiten in Ordnern), um sie zu untersuchen. Der Standardwert ist 0 25 * ? * *
, d. h. der Hintergrundauftrag wird in Minute 25 jeder Stunde ausgeführt. Wenn sie nicht über die erforderlichen Berechtigungen verfügen, werden die Erkundungssitzungen beendet. Dieser Parameter ist standardmäßig ausgeblendet.
Features.LongRunning.Enabled
Features.LongRunning.Enabled
Configure whether long running workflows are supported in your instance or not. Add the following key to enable it: <add key="Features.LongRunning.Enabled" value="true" />
.
Tasks.ModuleEnabled
Tasks.ModuleEnabled
Configure whether the Actions feature is enabled in your instance. Add the following key to enable it: <add key="Tasks.ModuleEnabled" value="true" />
. This setting makes the feature available at the instance level. To configure it on a per-tenant basis, follow the steps here. The Features.LongRunning.Enabled
parameter needs to be set to true
for this setting to take effect.
Features.SmartCardAuthentication.Enabled
Features.SmartCardAuthentication.Enabled
Konfigurieren Sie, ob die Smartcard-Authentifizierung in Ihrer Instanz aktiviert ist oder nicht. Fügen Sie den folgenden Schlüssel hinzu, um sie zu aktivieren: <add key="Features.SmartCardAuthentication.Enabled" value="true" />
.
OData.BackwardsCompatible.Enabled
OData.BackwardsCompatible.Enabled
Ermöglicht Ihnen, zu bestimmten, wie Sonderzeichen in der Orchestrator-API geparst werden. Bei Einstellung auf true
werden Sonderzeichen im Hauptteil von Anforderungen und Antworten geparst. Standardmäßig ist dieser Parameter ausgeblendet und auf false
festgelegt.
NotRespondingRobotsJobStartDelay
NotRespondingRobotsJobStartDelay
Ermöglicht Ihnen das Einstellen einer Verzögerung (in Sekunden) der ersten Prüfung, die nach einem Upgrade für den Status Ihrer Roboter durchgeführt wird. Dieser Parameter wird per Standard nicht in UiPath.Orchestrator.dll.config
angezeigt.
Upload.Queues.MaxNumberOfItems
Upload.Queues.MaxNumberOfItems
Ermöglicht Ihnen, die maximale Anzahl der Elemente zu verringern, die mit der Massenuploadfunktion gleichzeitig hochgeladen werden können. Der Standardwert ist 15000
. Bitte beachten Sie, dass dieser Parameter nicht standardmäßig in UiPath.Orchestrator.dll.config
angezeigt wird.
Processes.FilterOutDeleted
Processes.FilterOutDeleted
Ermöglicht die Optimierung der Art und Weise, in der Orchestrator Prozesse abruft. Die Optimierung wird durch das Entfernen unnötiger Überprüfungen für verwaiste Prozesse erreicht, deren zugehörige Pakete gelöscht wurden. Dadurch wird die Gesamtleistung Ihrer Instanz verbessert, insbesondere wenn es sich um eine große Bereitstellung handelt. Die folgenden Werte sind verfügbar:
false
- Der Paketabruf ist optimiert, Überprüfungen werden für verwaiste Prozesse nicht durchgeführt.true
- Der Paketabruf ist nicht optimiert.
Beachten Sie, dass dieser Parameter ausgeblendet ist und standardmäßig auf true
festgelegt ist, was bedeutet, dass der Prozessabruf nicht optimiert ist.
CertificatesStoreLocation
CertificatesStoreLocation
Specify the certificate for your Orchestrator instance is installed on the local machine certificate store using the following setting: <add key="CertificatesStoreLocation" value="LocalMachine" />
. Make sure that AzureKeyVaultCertificateStoreLocation
in appsettings.Production.json
has the same value.
ProxyIntegration.Enabled
ProxyIntegration.Enabled
Provides a way to control the proxy integration. By default, the parameter is not displayed in UiPath.Orchestrator.dll.config
, and its value is set to true
, which means that proxy integration is enabled unless otherwise specified. Use to disable proxy integration.
SecureAppSettings
EncryptionKey
EncryptionKey
Der Verschlüsselungsschlüssel, der zum Schützen der Kennwörter in Anmeldeinformationsassets verwendet wird. Wenn Sie eine Umgebung mit einem Netzwerklastausgleich verwenden, sollte dieser Schlüssel für alle Maschinen derselbe sein.
Mit den folgenden Parametern können Sie Ihren Azure Key Vault einrichten, in dem Sie Ihre mandantenbasierten Verschlüsselungsschlüssel speichern können. Bitte beachten Sie, dass diese Parameter nur verwendet werden können, wenn EncryptionKeyPerTenant.Enabled
auf true
und EncryptionKeyPerTenant.KeyProvider
auf AzureKeyVault
festgelegt sind. Darüber hinaus müssen Sie darauf achten, dass Sie alle Schlüssel, geheimen und Zertifikatsberechtigungen für Ihre Orchestrator-Instanz in den Zugriffsrichtlinien (Access policies) Ihres Azure Key Vault angeben. Die vollständige Beschreibung dieser Prozedur finden Sie auf dieser Seite.
Azure.KeyVault.ClientId
Azure.KeyVault.ClientId
Die Anwendungs-ID Ihrer Orchestrator-Instanz. Diese finden Sie bei Azure unter App-Registrierungen. Das Format muss ae11aa1a-1234-1234-a123-a12a12aaa1aa
sein. Diese Einstellung wird per Standard in der Datei UiPath.Orchestrator.dll.config
nicht angezeigt. Beispiel: <add key="Azure.KeyVault.ClientId" value="ae11aa1a-1234-1234-a123-a12a12aaa1aa" />
.
Azure.KeyVault.CertificateThumbprint
Azure.KeyVault.CertificateThumbprint
Der von Azure für das Orchestrator-Zertifikat generierte Fingerabdruck. Sie finden diesen Wert bei Azure in App Services > Ihre Instanz > SSL-Einstellungen > Private Zertifikate (oder Öffentliche Zertifikate). Diese Einstellung wird per Standard in der Datei UiPath.Orchestrator.dll.config
nicht angezeigt. Beispiel: <add key="Azure.KeyVault.CertificateThumbprint" value="1234123412341234123412341234124312341234" />
Azure.KeyVault.VaultAddress
Azure.KeyVault.VaultAddress
Der DNS-Name Ihres Azure Key Vault. Diesen finden Sie in der Übersicht Ihres Tresors im Feld DNS Name. Das Format muss https://CustomVaultName.vault.azure.net/
sein. Diese Einstellung wird per Standard in der Datei UiPath.Orchestrator.dll.config
nicht angezeigt. Beispiel: <add key="Azure.KeyVault.VaultAddress" value="https://CustomVaultName.vault.azure.net/" />
.
Azure.KeyVault.DirectoryId
Azure.KeyVault.DirectoryId
Geben Sie die Verzeichnis-ID Ihrer Organisation an, die im Azure-Portal angezeigt wird. Obligatorisch, wenn Sie Verschlüsselungsschlüssel pro Mandant in Azure Key Vault speichern. Beispiel: <add key="Azure.KeyVault.DirectoryId" value="c9d0e174-684e-469e-84ea-d32c863ad534" />
.
Identity Server-Einstellungen
Dieser Abschnitt enthält Einstellungen für die Konfiguration der SSO-Anmeldung, S2S-Zugriffstoken und Zugriffstoken für die Roboterbereitstellung.
Einmaliges Anmelden (Single Sign-On, SSO)
Mit den folgenden Parametern können Sie die SSO-Anmeldung über Identity Server konfigurieren:
ExternalAuth.System.OpenIdConnect.ClientId
ExternalAuth.System.OpenIdConnect.ClientId
Ermöglicht es Ihnen, die registrierte Orchestrator-Anwendungs-ID (clientId) für den registrierten Insider Identity Server festzulegen. Der Wert wird zur Installationszeit generiert und in Identity Server gespeichert.
ExternalAuth.System.OpenIdConnect.ClientSecret
ExternalAuth.System.OpenIdConnect.ClientSecret
Ermöglicht es Ihnen, den geheimen Clientschlüssel für die Orchestrator-Anwendung festzulegen, der vom externen Authentifizierungssystem erkannt wird. Der Wert wird zur Installationszeit generiert und in Identity Server gespeichert.
ExternalAuth.System.OpenIdConnect.RedirectUri
ExternalAuth.System.OpenIdConnect.RedirectUri
Gibt die Umleitungs-URL zu Orchestrator nach der Authentifizierung bei Identity Server an. Diese URL wird in Identity Server und Orchestrator automatisch vorkonfiguriert, und Sie sollten sie nicht ändern. Der Standardwert ist http://Orchestrator/signinsystemopenidconnect
.
ExternalAuth.System.OpenIdConnect.PostLogoutRedirectUri
ExternalAuth.System.OpenIdConnect.PostLogoutRedirectUri
Die Adresse, an die Identity Server umleitet, nachdem sich ein Benutzer bei Orchestrator abgemeldet hat. Dieser Wert wird automatisch mit Ihrer Orchestrator-URL aufgefüllt.
Beispielsweise muss UiPath.Orchestrator.dll.config
folgende Schlüssel enthalten:
<add key="ExternalAuth.System.OpenIdConnect.ClientId" value="orchestrator" />
<add key="ExternalAuth.System.OpenIdConnect.ClientSecret" value="49C1A7E1-0C79-4A89-A3D6-A37998FB86B0" />
<add key="ExternalAuth.System.OpenIdConnect.RedirectUri" value="https://Orchestrator/signinsystemopenidconnect" />
<add key="ExternalAuth.System.OpenIdConnect.PostLogoutRedirectUri" value="https://Orchestrator/" />
Integration
Um Daten sicher an Identity Server weiterzuleiten, benötigt Orchestrator ein Zugriffstoken für die Tokenauthentifizierung. Dieses Token wird von Identity Server über den Clientanmeldeinformationsfluss (S2S) abgerufen. Die folgenden Schlüssel müssen UiPath.Orchestrator.dll.config
hinzugefügt werden:
IdentityServer.GroupMembershipCacheExpireHours
IdentityServer.GroupMembershipCacheExpireHours
Ermöglicht Ihnen, die Zeitdauer in Stunden anzugeben, nach der der Cache der Identity Server-Gruppen, die dem Orchestrator hinzugefügt wurden, abläuft. Dieser Parameter ist standardmäßig nicht sichtbar und sein Standardwert ist 1
.
IdentityServer.Integration.Enabled
IdentityServer.Integration.Enabled
Aktiviert/deaktiviert die Integration von Identity Server in Orchestrator. Standardmäßig ist der Wert auf true
festgelegt.
IdentityServer.Integration.Authority
IdentityServer.Integration.Authority
Ermöglicht es Ihnen, den Speicherort des Identitätsservers festzulegen. Standardmäßig ist der Wert auf https://Orchestrator/Identity
festgelegt, wobei Orchestrator
die Installationsadresse Ihres Orchestrators ist.
IdentityServer.Integration.ClientId
IdentityServer.Integration.ClientId
Ermöglicht Ihnen das Festlegen der Anwendungs-ID (Client-ID), die zum Generieren von S2S-Zugriffstoken verwendet wird, die in Identity Server registriert sind. Der Wert wird zur Installationszeit generiert.
IdentityServer.Integration.ClientSecret
IdentityServer.Integration.ClientSecret
Ermöglicht es Ihnen, den geheimen Clientschlüssel für die Orchestrator S2S-Anwendung festzulegen, die von Identity Server erkannt wird. Der Wert wird zur Installationszeit generiert.
IdentityServer.Integration.AccessTokenCacheBufferInSeconds
IdentityServer.Integration.AccessTokenCacheBufferInSeconds
Ermöglicht Ihnen das Festlegen der Zeit in Sekunden, bevor der Cachepuffer des Zugriffstokens abläuft. Standardmäßig ist der Wert auf 50
festgelegt.
IdentityServer.Integration.UserOrchestratorApiAudience
IdentityServer.Integration.UserOrchestratorApiAudience
Identity Server kann mehrere Zugriffstoken mit unterschiedlichen Zielgruppen generieren. Orchestrator-APIs-Anforderungen können mithilfe von Benutzerzugriffstoken autorisiert werden, die diese Zielgruppe haben. Standardmäßig ist der Wert auf OrchestratorApiUserAccess
festgelegt.
<add key="IdentityServer.Integration.Enabled" value="true" />
<add key="IdentityServer.Integration.Authority" value="https://Orchestrator/Identity" />
<add key="IdentityServer.Integration.ClientId" value="orchestratorapiaccess" />
<add key="IdentityServer.Integration.ClientSecret" value="a5d57b1d-5b25-49ba-bff7-33aa57f96a58" />
<add key="IdentityServer.Integration.AccessTokenCacheBufferInSeconds" value="50" />
<add key="IdentityServer.Integration.UserOrchestratorApiAudience" value="OrchestratorApiUserAccess" />
Um die von Identity Server generierten S2S-Zugriffstoken (ClientAnmeldeinformationen) zu verwenden, muss Orchestrator die folgenden Schlüssel zu UiPath.Orchestrator.dll.config
hinzufügen:
IdentityServer.Integration.S2SOrchestratorApiAudience
IdentityServer.Integration.S2SOrchestratorApiAudience
Ermöglicht es Ihnen, die Zielgruppe festzulegen, die Orchestrator beim Überprüfen eines S2S-Zugriffstokens überprüft. Standardmäßig ist der Wert auf OrchestratorApiS2SAccess
festgelegt.
Stellen Sie sicher, dass UiPath.Orchestrator.dll.config
auch die folgenden bereits vorhandenen Schlüssel enthält, deren Werte auf true
gesetzt sind:
MultiTenancy.AllowHostToAccessTenantApi
MultiTenancy.AllowHostToAccessTenantApi
Wenn auf true
festgelegt, können die Hostbenutzer auf die spezifischen Daten anderer Mandanten zugreifen. Standardmäßig ist der Wert auf true
festgelegt.
MultiTenancy.TenantResolvers.HttpGlobalIdHeaderEnabled
MultiTenancy.TenantResolvers.HttpGlobalIdHeaderEnabled
Wenn Orchestrator einen API-Aufruf empfängt, der mit dem S2S-Zugriffstoken autorisiert wurde, lässt die Einstellung true
zu, dass Orchestrator den Mandanten identifiziert, indem die globale Mandanten-ID aus dem Anforderungsheader der API gelesen wird.
<add key="IdentityServer.Integration.S2SOrchestratorApiAudience" value="OrchestratorApiS2SAccess" />
<add key="MultiTenancy.AllowHostToAccessTenantApi" value="true" />
<add key="MultiTenancy.TenantResolvers.HttpGlobalIdHeaderEnabled" value="true" />
Zugriffstoken für Roboterbereitstellung
Orchestrator fungiert als Token-Generator für Roboter. Roboter rufen den Orchestrator-Endpunkt auf, um ein Zugriffstoken zu generieren. Das Zugriffstoken wird dann an Aktivitäten übergeben, die verschiedene Ressourcen aufrufen können, z. B. AI Fabric. Mit der Integration von Identity Service in Orchestrator übernimmt Identity Server die Generierung der Zugriffstoken.
Servereinstellungen aktualisieren
Dieser Abschnitt enthält Parameter zum Konfigurieren des Update-Servers.
UpdateServer.CheckUpdates.PollingInterval
UpdateServer.CheckUpdates.PollingInterval
So oft sucht der Client nach Updates. Der Standardwert ist 180Â Minuten.
UpdateServer.CheckUpdates.DefaultForceInstallAfterMinutes
UpdateServer.CheckUpdates.DefaultForceInstallAfterMinutes
Nach so vielen Minuten beginnt eine Zwangsaktualisierung, wenn die Aktualisierung verschoben wurde. Der Standardwert ist 1440Â Minuten.
UpdateServer.CheckUpdates.ScheduledForceInstallAfterMinutes
UpdateServer.CheckUpdates.ScheduledForceInstallAfterMinutes
Nach so vielen Minuten beginnt eine Zwangsaktualisierung, wenn die Aktualisierung verschoben wurde. Dies ist spezifisch für geplante Updates. Der Standardwert ist 10 Minuten.
UpdateServer.CheckUpdates.MaxRetries
UpdateServer.CheckUpdates.MaxRetries
So oft wird eine fehlgeschlagene Aktualisierung wiederholt. Der Standardwert ist 3.
UpdateServer.UpdateRequest.RetryStepMinutes
UpdateServer.UpdateRequest.RetryStepMinutes
So wird die Wiederholung auf der Grundlage von Zeitreihen durchgeführt.
Beispiel:
- Erster Wiederholungsversuch: nach dem konfigurierten Wert in Minuten.
- Zweiter Wiederholungsversuch: nach dem Zweifachen des konfigurierten Wertes in Minuten.
- Dritter Wiederholungsversuch: nach dem Vierfachen des konfigurierten Wertes in Minuten.
Konfiguration der Protokollierung
Roboter-Protokolle
Dies ist der entsprechende UiPath.Orchestrator.dll.config
-Schlüssel: <logger name="Robot.*" writeTo="database,robotElasticBuffer" final="true" />
. Er wird verwendet, um Protokollmeldungen zu konfigurieren, die von Robotern generiert werden. Folgende Parameter müssen konfiguriert werden:
-
writeTo
- Der Ort, an dem vom Roboter generierte Protokollnachrichten geschrieben werden. Die folgenden Werte sind verfügbar:database
- An die Orchestrator-SQL-Datenbank werden Protokolle gesendet. Dies ist einer der Standardwerte.robotElasticBuffer
- Logs are sent to Elasticsearch. This is the second default value. Please remember this requires additional settings. Details here.
Wenn Sie die Protokolle sowohl zur Orchestrator-SQL-Datenbank als auch zu ElasticSearch schicken, erhalten Sie Protokolle, die nicht zurückgewiesen werden können. Löschen Sie einen der Werte, um die Protokollierung an diesem Speicherplatz anzuhalten.
-
final
- Ein Kennzeichen, das angibt, was zu tun ist, wenn eine Übereinstimmung zwischen einer protokollierten Meldung und dem Namen des Protokollierers gefunden wird. Wenn Sie auftrue
festgelegt ist, wird nach keiner weiteren Übereinstimmung gesucht. Wenn Sie auffalse
festgelegt ist, werden andere Regeln, die mit der gleichen Quelle übereinstimmen überprüft. Standardmäßig ist sie auf festgelegttrue
.
Zeitplanprotokolle
Dies ist der entsprechende UiPath.Orchestrator.dll.config
-Schlüssel: <logger name="Quartz.*" minlevel="Info" writeTo="eventLogQuartz" final="true" />
. Er wird verwendet, um Protokollmeldungen zu konfigurieren, die von Zeitplänen generiert werden.
Hinweis:
Um eine problemlose Ausführung für Zeitpläne in einem Orchestrator-Setup mit Lastausgleich sicherzustellen, sollten Sie auch den Parameter
quartz.jobStore.clustered
auftrue
festlegen.
Überwachungsprotokolle
Dies ist der entsprechende UiPath.Orchestrator.dll.config
-Schlüssel: <logger name="Monitoring.*" writeTo="monitoring" minlevel="Warn" final="true" />
. Es wird verwendet, um die Fehlerprotokolle zu konfigurieren, die auf der Seite Überwachung angezeigt werden. Bitte beachten Sie, wenn Sie diese Regel entfernen oder target
ändern, werden auf der Seite Überwachung keine Fehlerprotokolle angezeigt.
Geschäftsausnahmeprotokolle
Dies ist der entsprechende UiPath.Orchestrator.dll.config
-Schlüssel: <logger name="BusinessException.*" minlevel="Info" writeTo="businessExceptionEventLog" final="true" />
. Er wird verwendet, um die Protokolle für ausgelöste Geschäftsausnahmen zu konfigurieren. Zum Beispiel Validierungsprobleme (z. B. Invalid username
) oder Geschäftskonflikte (z. B. License expired
).
Andere Protokolle
Dies ist der entsprechende UiPath.Orchestrator.dll.config
-Schlüssel: <logger name="*" minlevel="Info" writeTo="eventLog" />
. Er wird verwendet, um alle anderen Protokolle außer den oben beschriebenen zu konfigurieren, einschließlich der von Orchestrator generierten Protokolle.
Hinweis:
Wenn Sie mehr als 2 Millionen Roboterprotokolle pro Woche in der SQL-Datenbank ansammeln, kann die Leistung nach einigen Monaten beeinträchtigt werden, wenn ältere Protokolle nicht bereinigt werden. Für eine so große Anzahl von Protokollen empfehlen wir die Verwendung von Elasticsearch.
Weitere Einstellungen
Elasticsearch
Das folgende NLog-Ziel muss entsprechend Ihrer ElasticSearch-Konfiguration ausgefüllt werden:
<target xsi:type="ElasticSearch" name="robotElastic" uri="<elasticSearch_url_1>,<elasticSearch_url_2>, <elasticSearch_url_3>" index="${event-properties:item=indexName}-${date:format=yyyy.MM}" documentType="logEvent" includeAllProperties="true" disablePing="true" layout="${message}" excludedProperties="agentSessionId,tenantId,organizationUnitId,indexName" />
uri
- die Elasticsearch-URL; beachten Sie, dass Sie das Protokoll und den Port einschließen müssen, z. B.http://elastic_server:9200
. Sie können die Notwendigkeit eines Lastenausgleichs entfernen, indem Sie diesen Parameter mit der Elasticseach-URL jedes Knotens ausfüllen, z. B.uri="http://elastic-node1:9200,http://elastic-node2:9200,http://elastic-node3:9200"
.excludedProperties
– Daten, die nicht in ElasticSearch gespeichert werden sollen.index
- das Format des Protokollierungsindexes, der entweder pro Mandant eindeutig oder von allen Mandanten gemeinsam verwendet werden kann. Details unten.requireAuth
– auftrue
festlegen, um die Authentifizierung beim Verbinden des Orchestrators mit Elasticsearch zu aktivieren.username
– Geben Sie den Benutzernamen an, der zum Anmelden bei Elasticsearch verwendet wird. Sie müssen ihn konfigurieren, wennrequireAuth
auftrue
festgelegt ist undOAuthEnabled
auffalse
.password
– Geben Sie das Kennwort an, das zum Anmelden bei Elasticsearch verwendet wird. Sie müssen es konfigurieren, wennrequireAuth
auftrue
festgelegt ist undOAuthEnabled
auffalse
.OAuthEnabled
- set this parameter totrue
to enable OAuth2 and use a token-based authentication mechanism for the Nlog target for Elasticsearch. When enabling this for the first time, you need to provide your current username and password to generate the initial token. For this parameter to take effect, you need to ensure thatLogs.Elasticsearch.OAuthEnabled
is also set totrue
and that you properly configured the Elasticsearch server. For more on this, see X-Pack Authentication.
Indexkonfiguration
-
Individueller Index -
index="${event-properties:item=indexName}-${date:format=yyyy.MM}"
Für jeden Mandanten wird ein separater Index verwendet, d. h., dass Protokolle, die für einen Mandanten spezifisch sind, basierend auf einem eindeutigen Mandantenbezeichner generiert und abgerufen werden, in diesem FallindexName
, der standardmäßig der Name des Mandanten ist. Dies ist die Standardkonfiguration. In diesem Fall werden Protokolle pro Monat generiert. -
Freigegebener Index -
index="robotlogs-${date:format=yyyy.MM.dd}"
Ein Index wird für alle Mandanten verwendet, d. h., alle Protokolle verwenden denselben Index unabhängig vom Mandanten. In diesem Fall werden Protokolle pro Tag generiert. Um einen Index gemeinsam zu verwenden, müssen Sie auch den folgenden Schlüssel inUiPath.Orchestrator.dll.config
hinzufügen:<add key="Logs.Elasticsearch.SharedIndex" value="robotlogs" />
. Stellen Sie sicher, dass Sie ihn auf den gleichen Wert wie für den Parameterindex
im NLog-Ziel festlegen.
Wichtig!
Protokolle, die mit einem Einzelindex generiert werden, werden beibehalten, wenn Sie zu einem gemeinsam verwendeten Index wechseln. Protokolle, die mit einem gemeinsam verwendeten Index generiert werden, gehen jedoch verloren, wenn Sie zu einem Einzelindex wechseln.
Protokollieren von Ereignissen in der Datenbank
Führen Sie die folgenden Schritte aus, um Systemereignisprotokolle in der Datenbank anstelle der Ereignisanzeige zu speichern:
- Erstellen Sie eine neue Datenbanktabelle, zum Beispiel:
CREATE TABLE [dbo].[EventLogs](
[Id] [bigint] IDENTITY(1,1) NOT NULL,
[Timestamp] [datetime] NOT NULL,
[Level] [int] NOT NULL,
[Message] [nvarchar](max) NULL,
[Exception] [nvarchar](max) NULL)
In der obigen Abfrage erstellen wir eine Tabelle mit dem Namen EventLogs
mit den folgenden Spalten:
Id
- zum Speichern einer ID-Nummer für jedes Protokoll, die hier mit dem Wert1
, der sich mit jedem hinzugefügten Protokoll erhöht;Timestamp
- zum Speichern der Zeit, zu der jedes Ereignis protokolliert wurde;Level
- zum Speichern der numerischen Protokollierungsebene jedes Ereignisses;Message
- zum Speichern der Meldung jedes Ereignisses, falls zutreffend;Exception
- zum Speichern der Ausnahme für jedes protokollierte Ereignis, falls zutreffend.
Hinweis:
Sie können einen beliebigen Namen für Ihre Tabelle verwenden und beliebige Spalten aus der obigen Abfrage entfernen oder andere hinzufügen, um Ihren Bedürfnissen gerecht zu werden.
- Fügen Sie in der
UiPath.Orchestrator.dll.config
-Datei ein neues NLog-Ziel hinzu:
<target xsi:type="Database" connectionString="${ui-connection-strings:item=Default}" name="eventLogDatabase" keepConnection="true">
<commandText>
INSERT INTO dbo.EventLogs (Timestamp, Level, Message, Exception)
VALUES (@timestamp, @level, @message, @exception)
</commandText>
<parameter name="@timestamp" layout="${date:format=yyyy-MM-dd HH\:mm\:ss.fff}" />
<parameter name="@level" layout="${event-properties:item=levelOrdinal}" />
<parameter name="@message" layout="${message}" />
<parameter name="@exception" layout="${onexception:${exception:format=tostring:maxInnerExceptionLevel=5:innerFormat=tostring}}" />
</target>
Definieren eines entsprechenden parameter
für die Daten, die in jeder Datenbankspalte hinzugefügt werden sollen, in diesem Beispiel @timestamp
, @level
, @message
und @exception
.
- Zuletzt verknüpfen Sie das neu erstellte Ziel mit der NLog-Protokollierungsklassifizierung für alle Orchestrator-Meldungen von oben durch Hinzufügen von:
<logger name="*" minlevel="Info" writeTo="eventLog,eventLogDatabase" />
Aktivieren von NLog Debugging
NLog ist eine einfach zu konfigurierende, erweiterungsfähige Open-Source-Protokollierungsplattform für eine Vielzahl von .NET-Plattformen. Mit NLog können Sie Protokollierungsdaten speichern oder an eine beliebige Anzahl vordefinierter oder benutzerdefinierter Ziele weitergeben, wie zum Beispiel an eine lokale Datei, ein Ereignisprotokoll, eine E-Mail-Adresse oder eine Datenbank.
Custom NLog targets are not automatically migrated during an upgrade. You need to migrate them to Identity Server and Webhooks services manually. See NLog documentation in Identity Server.
Though there exists some overlap, NLog and Orchestrator have several differentiating logging levels. For NLog, you can select either Trace
, Debug
, Info
, Warn
, Error
, Fatal
, or Off
. See Logging Levels for a description of the available levels in Orchestrator.
Sie können in NLog Debugging aktivieren, um sicherzustellen, dass es ordnungsgemäß funktioniert. Per Standard ist NLog auf Off
festgelegt. Durch Konfigurieren des folgenden Abschnitts der Datei UiPath.Orchestrator.dll.config
wird es aktiviert:
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" autoReload="true" throwExceptions="false" internalLogLevel="Off" internalLogFile="">
Die festzulegenden Attribute sind:
internalLogLevel
- die gewünschte ProtokollierungsstufeinternalLogFile
- der Speicherort der Protokolldatei
Zum Beispiel:
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" autoReload="true" throwExceptions="false" internalLogLevel="Debug" internalLogFile="C:\logs.txt">
Hinweis:
Das Benutzerprofil, unter dem Orchestrator läuft, muss Zugriff auf den im Attribut
internalLogFile
angegebenen Pfad haben.
Vor etwa einem Monat aktualisiert