Scripts Orchestrator

Publier dans Orchestrator

Le tableau suivant décrit tous les paramètres pouvant être utilisés avec Publish-Orchestrator.ps1.

Paramètre	Description
-action	Obligatoire. Indique le type de scénario que vous souhaitez démarrer. Les options suivantes sont disponibles : Deploy : indique qu'il s'agit d'une nouvelle installation ; Update : indique que vous mettez à jour votre instance d'Orchestrator.
-azureAccountApplicationId	Obligatoire (Mandatory). ID principal du service Azure. Notez que le principal du service utilisé doit se voir attribuer le rôle de contributeur au service d'application de l'étendue de l'abonnement.
-azureAccountPassword	Obligatoire. Mot de passe du jeton Azure pour l'ID de principal de service.
-azureSubscriptionId	Obligatoire. ID d'abonnement Azure pour l'application App Service qui héberge Orchestrator.
-azureAccountTenantId	Obligatoire. ID de locataire Azure.
-resourceGroupName	Obligatoire. Nom du groupe de ressources Azure qui contient l'application App Service d'Orchestrator.
-appServiceName	Obligatoire. Nom de l'application Azure App Service d'Orchestrator.
-package	Obligatoire (Mandatory). Indiquez le chemin d'accès complet UiPath.Orchestrator.Web.zip;
-confirmBlockClassicExecutions	Obligatoire. Si ce paramètre est défini sur 1, l’exécution de la tâche dans les dossiers classiques sera bloquée après la mise à niveau.
-activitiesPackagePath	Facultatif (Optional). Spécifiez le chemin d'accès complet de l'archive UiPathActivities.zip, qui est inclus par défaut, à partir de la version v2018.4.4 dans UiPathOrchestrator.zip. Cela permet d'installer le flux d'activités local dans Azure au moment de l'installation. Notez que ce paramètre ne peut être utilisé qu'avec le type de référentiel Legacy . Sinon, il doit être configuré manuellement.
-testAutomationFeatureEnabled	En option. Ce paramètre active le module d’automatisation de tests, pour les files d’attente de données de test, l’exécution des tests et la planification. Vous pouvez activer cette fonctionnalité en fonction de l’un des scénarios suivants : Prendre un nouveau départ avec une installation Orchestrator de qualité Configurez les paramètres suivants pour votre App Service avant d'exécuter le script Publish-Orchestrator.ps1 en utilisant le paramètre -testAutomationFeatureEnabled : AppSettings : Key=TestAutomation.ModuleEnabled : définissez sur True pour activer le module d'automatisation de test. Paramètres de l'application (AppSettings) : Clé= TestAutomation.FeatureEnabledByDefault - Définissez sur True pour activer le module par défaut Automatisation de test (Test Automation). Par défaut, cette fonctionnalité est désactivée à moins qu'elle ne soit explicitement activée ConnectionString : Name=TestAutomation - définissez la chaîne de connexion de la base de données Automatisation de test (Test Automation). Vous pouvez soit utiliser une chaîne de connexion similaire à celle utilisée pour Orchestrator, soit une chaîne complètement différente. Par exemple : Server=13.13.13.13;Initial Catalog=UiPath;Persist Security Info=False;User ID=dbUser;Password=pass123; MultipleActiveResultSets=False;Encrypt=True; Connection Timeout=30;TrustServerCertificate=True Assurez-vous de marquer ces paramètres en tant que Deployment slot setting , surtout si vous utilisez des créneaux de hotswap. Activez l'automatisation de test après l'installation d'Orchestrator Si vous avez déjà déployé Orchestrator sans activer le module d’automatisation de test, exécutez le script Publish-Orchestrator.ps1 avec les mêmes paramètres que pour une mise à niveau, et ajoutez le paramètre -testAutomationFeatureEnabled. Mise à niveau Orchestrator Si vous mettez à niveau votre instance d’Orchestrator, ajoutez le paramètre -testAutomationFeatureEnabled au script Publish-Orchestrator.ps1 avant de l’exécuter. Pour plus de détails sur la mise à niveau d’Orchestrator, consultez la section Mise à jour Publish-Orchestrator.ps1.
-insightsFeatureEnabled	Facultatif (Optional). Ce paramètre active le module et la fonctionnalité Insights. Vous pouvez activer cette fonctionnalité dans l'un des scénarios suivants : Partir de zéro avec une nouvelle installation d'Orchestrator Configurez les paramètres suivants pour votre App Service avant d’exécuter le script Publish-Orchestrator.ps1 en utilisant le paramètre -insightsFeatureEnabled : ParamètresApplication : Clé= Insights.ModuleEnabled : définissez sur True pour activer le module Insights. ParamètresApplication : Clé= Insights.FeatureEnabledByDefault : Définissez sur True pour activer le module Insights par défaut. Par défaut, cette fonctionnalité est désactivée à moins qu'elle ne soit explicitement activée. ChaîneConnexion : Nom= Insights : Définissez la chaîne de connexion de la base de données Insights. Vous pouvez soit utiliser une chaîne de connexion similaire à celle utilisée pour Orchestrator, soit une chaîne complètement différente. Par exemple : Server=13.13.13.13;Initial Catalog=Insights;Persist Security Info=False;User ID=dbUser;Password=pass123; MultipleActiveResultSets=False;Encrypt=True; Connection Timeout=30;TrustServerCertificate=True Activer Insights après l'installation d'Orchestrator Si vous avez déjà déployé Orchestrator sans activer le module Insights, exécutez le script Publish-Orchestrator.ps1 avec les mêmes paramètres que pour une mise à niveau et ajoutez le paramètre FonctionnalitéInsightsActivée. Mise à niveau Orchestrator Si vous mettez à niveau votre instance d’Orchestrator, ajoutez le paramètre -insightsFeatureEnabled au script Publish-Orchestrator.ps1 avant de l’exécuter. Pour plus de détails sur la mise à niveau d’Orchestrator, consultez la section Mise à jour Publish-Orchestrator.ps1.
-updateServerFeatureEnabled	Facultatif (Optional). Ce paramètre active le module de mise à jour du serveur (Update Server). Vous pouvez activer cette fonctionnalité dans l'un des scénarios suivants : Partir de zéro avec une nouvelle installation d'Orchestrator Configurez les paramètres suivants pour votre App Service avant d'exécuter le script Publish-Orchestrator.ps1 en utilisant le paramètre -updateServerFeatureEnabled : AppSettings: Key=UpdateServer.ModuleEnabled : définissez sur True pour activer le module de mise à jour du serveur. AppSettings: Key=UpdateServer.FeatureEnabledByDefault : définissez sur True pour activer le module de mise à jour du serveur. Par défaut, cette fonctionnalité est désactivée à moins qu'elle ne soit explicitement activée. ConnectionString: Name=UpdateServer : définissez la chaîne de connexion de la base de données de mise à jour du serveur. Vous pouvez soit utiliser une chaîne de connexion similaire à celle utilisée pour Orchestrator, soit une chaîne complètement différente. Par exemple : Server=13.13.13.13;Initial Catalog=UiPath;Persist Security Info=False;User ID=dbUser;Password=pass123; MultipleActiveResultSets=False;Encrypt=True; Connection Timeout=30;TrustServerCertificate=True Activer le module de mise à jour du serveur après l'installation d'Orchestrator Si vous avez déjà déployé Orchestrator sans activer le module de mise à jour du serveur, exécutez le script Publish-Orchestrator.ps1 avec les mêmes paramètres que pour une mise à niveau, et ajoutez le paramètre -updateServerFeatureEnabled. Mise à niveau Orchestrator Si vous mettez à niveau votre instance d’Orchestrator, ajoutez le paramètre -updateServerFeatureEnabled au script Publish-Orchestrator.ps1 avant de l’exécuter. Pour plus de détails sur la mise à niveau d’Orchestrator, consultez la section Mise à jour Publish-Orchestrator.ps1.
-robotsElasticSearchUrl	Facultatif (Optional). Cela ne doit être utilisé que si vous souhaitez utiliser Elasticsearch pour la journalisation. Indiquez l'URL Elasticsearch comme valeur, telle que "http://elasticserver:9200". Si votre instance d'Orchestrator nécessite une authentification, fournissez les paramètres ElasticSearchUsername, ElasticSearchPassword, elasticSearchDiagnosticsUsername et elasticSearchDiagnosticsPassword.
-robotsElasticSearchTargets	Facultatif (Optional). Ce paramètre vous permet d'envoyer les journaux du Robot uniquement au serveur Elasticsearch configuré. Indiquez l'URL Elasticsearch comme valeur, telle que "http://elasticserver:9200". Notez qu'il ne peut être utilisé qu'avec le paramètre -robotsElasticSearchUrl. Si vous ne fournissez pas ce paramètre, les journaux du Robot sont envoyés à la fois à la base de données SQL configurée et à Elasticsearch.
-robotsElasticSearchUsername	Facultatif. Ce paramètre permet d'indiquer le nom d'utilisateur de votre instance d'Elasticsearch, si son authentification est activée.
-robotsElasticSearchPassword	Facultatif. Ce paramètre permet d'indiquer le mot de passe de votre instance d'Elasticsearch, si son authentification est activée.
-serverElasticSearchDiagnosticsUsername	Facultatif (Optional). Ce paramètre permet d'indiquer le nom d'utilisateur de votre instance d'Elasticsearch, si son authentification est activée. Ce paramètre ainsi que elasticSearchDiagnosticsPassword "Password" sont requis pour les journaux internes d'Orchestrator.
-serverElasticSearchDiagnosticsPassword	Facultatif (Optional). Ce paramètre permet d'indiquer le nom d'utilisateur de votre instance d'Elasticsearch, si son authentification est activée. Ce paramètre ainsi que elasticSearchDiagnosticsUsername "Username" sont requis pour les journaux internes d'Orchestrator.
-loadBalancerUseRedis	Facultatif (Optional). Utilisez Redis comme base de données pour distribuer les messages et les mettre en cache vers/depuis toutes les machines connectées via votre équilibreur de charge. Si -redisConnectionString est spécifié, il est automatiquement défini sur true, sinon il est défini sur false.
-redisConnectionString	Facultatif (Optional). Peut être utilisé uniquement si loadBalancerUseRedis est défini sur true. Une chaîne de connexion qui permet de configurer votre serveur Redis, qui contient l'URL du serveur, le mot de passe et le port utilisé avec Redis. Il est également possible d'activer les connexions chiffrées en SSL entre les nœuds d'Orchestrator et le service Redis. Pour plus d'informations, cliquez ici. Exemples : avec SSL activé : -redisConnectionString "docs123.redis.cache.windows.net:6380,password=******,ssl=True" sans SSL activé : -redisConnectionString "docs123.redis.cache.windows.net:6380,password=******,ssl=False"
-azureSignalRConnectionString	Facultatif (Optional). Permet d'activer le service Azure SignalR, facilitant ainsi une communication directe entre votre parc de Robots et le service SignalR. Orchestrator ne sert plus d'intermédiaire. Veuillez noter que, si activé, les Robots avec une version antérieure à 2019.2 s'appuyer uniquement sur le protocole Heartbeat pour communiquer avec Orchestrator, ce qui signifie que toute commande donnée à partir d'Orchestrator n'est captée par un Robot que toutes les 30 secondes. Exemple : -azureSignalRConnectionString "Endpoint=https://doctest.signalr.net;AccessKey=M1ug+sBu07hyyi12AgyJ52SEd4OgC2Mm6BvllVHCC9c=;Version=1.0;"
-storageType	Facultatif. Définit la cible où les supports d'exécution et les paquets doivent être enregistrés. Vous pouvez la renseigner à l'aide des cibles suivantes : FileSystem, par exemple storageType "FileSystem". Il s'agit de la valeur par défaut dans les scénarios de mise à jour et les nouvelles installations, même si le paramètre n'est pas spécifié. Azure : telles que storageType "Azure". Amazon : telles que storageType "Amazon". Minio : telles que storageType "Minio". Si vous avez remplacé le paramètre UiPath.Orchestrator.dll.config Storage.Type dans la section Configuration du service d’application Azure, lors de la mise à niveau, vous devez définir cette valeur comme paramètre de script sur Publish-Orchestrator.ps1.
-storageLocation	Facultatif. Définit l'emplacement réel de l'enregistrement des supports d'exécution et des paquets. Particularités : FileSystem : fournit un chemin d'accès absolu au format RootPath=.\Storage, tel que storageLocation "RootPath=C:\FolderName\AnotherFolderName". Il s'agit de la valeur par défaut dans les scénarios de mise à jour et les nouvelles installations, même si le paramètre n'est pas spécifié. Azure : indiquez une chaîne de connexion, telle que storageLocation "DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net". Amazon : indiquez une chaîne de connexion, telle que storageLocation" "EndpointRegion=eu-west-3;accessKey=AKIAZGUEIGXUJ3BBI4MW;secretKey=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;useHttp=false". Minio : indiquez une chaîne de connexion, telle que storageLocation" "host=localhost:9001;accessKey=YVKYFJ0ZY246KDKP0634;secretKey=bdBEk2ubhIFsTNPuQ80PjKL+oqZBj67HoSWBFnw1". Plus d’informations sur ces types de déploiements sont disponibles ici. Si vous avez remplacé le paramètre UiPath.Orchestrator.dll.config Storage.Location dans la section Configuration du service d’application Azure, lors de la mise à niveau, vous devez définir cette valeur comme paramètre de script sur Publish-Orchestrator.ps1.
-standbyslotname	Facultatif. Il ne peut être utilisé que dans des scénarios de mise à niveau. S'il est spécifié, le script déploie Orchestrator dans l'emplacement de service d'application indiqué au lieu de celui de production. De plus, un emplacement d'échange est effectué avec l'emplacement de production, sans temps d'arrêt. Prérequis : l'emplacement d'App Service de secours doit désigner une autre base de données SQL. la chaîne de connexion de l'emplacement de secours doit être rendue permanente (en cochant la case Paramètre d'emplacement (Slot Setting) sur le portail Azure). le fichier de l'emplacement de production UiPath.Orchestrator.dll.config doit être copié vers l'emplacement de secours à partir de l'emplacement de production.
-productionSlotName	Facultatif. Il ne peut être utilisé que si l'emplacement de déploiement de l'application App Service d'Orchestrator est différent de l'emplacement par défaut de l'application App Service de production défini par Azure.
-appSettings	Facultatif. Paires clé-valeur de paramètres d'application qui sont transmises à la section Configuration de service d'application Azure après le déploiement. Gardez à l'esprit que cela s'applique uniquement aux paramètres de la section Paramètres de l'application (App Settings) du fichier UiPath.Orchestrator.dll.config. Vous pouvez utiliser ce paramètre pour modifier des paramètres spécifiques qui ne sont pas exposés via le script Publish-Orchestrator.ps1. Pour le reste, utilisez leur paramètre dédié lors du déploiement du script. Notez que les paramètres existants sont fusionnés avec les nouveaux.
-stopApplicationBeforePublish	Facultatif. S’il est actif, il arrête l’application avant le déploiement et la démarre une fois le déploiement terminé.
-unattended	Facultatif. S'il est actif, le déploiement se poursuit sans confirmation de l'utilisateur.
-bucketsAvailableProviders	Facultatif (Optional). Une chaîne contenant une liste de fournisseurs de compartiments que vous souhaitez activer, séparés par des virgules. S'il n'est pas spécifié, sa valeur par défaut est Orchestrator,Amazon,Azure,Minio. Vous avez également la possibilité d'activer le fournisseur FileSystem en l'ajoutant à cette liste. Attention : Si vous utilisez le fournisseur FileSystem et effectuez une mise à niveau vers la version 20.10.7 ou une version ultérieure, vous devez insérer une valeur qui inclut FileSystem pour ce paramètre. Si vous ne faites pas cela, ce fournisseur sera désactivé et vous ne serez plus en mesure d’utiliser ces compartiments.
-bucketsFileSystemAllowlist	Obligatoire uniquement lorsque FileSystem est sélectionné comme fournisseur de compartiment. La liste des emplacements auxquels vous souhaitez autoriser la création de compartiments pour le fournisseur FileSystem. Si vous activez le fournisseur FileSystem, vous devez également transmettre une valeur pour ce paramètre. Les valeurs sont une liste de chemins d'accès UNC, séparés par le symbole barre verticale | (par exemple \mysharedstorage\mybyckets\myotherserver\myotherbuckets).
-noAzureAuthentication	Facultatif (Optional). Vous permet de publier sur Azure App Service en vous appuyant sur votre propre identité d'utilisateur, sans avoir à créer un principal de service. Si ce paramètre est utilisé, l'ensemble de paramètres UseServicePrincipal (qui inclut des éléments tels que l'ID d'application Azure, le mot de passe, l'ID d'abonnement et l'ID de locataire) n'est plus nécessaire.
-OrchestratorRootUrl	Facultatif. Permet d'inclure l'URL externe du service d'application Orchestrator dans les cas où une URL personnalisée est utilisée. Si ce paramètre n'est pas renseigné, l'URL par défaut du service d'application est utilisée à la place.
-azureUSGovernmentLogin	Facultatif. Ce paramètre est uniquement utilisé pour les déploiements du gouvernement américain.

Paramètres conservés lors de la mise à jour

Les valeurs du paramètre UiPath.Orchestrator.dll.config suivantes sont automatiquement migrées et conservées lors de l'exécution d'une mise à jour. Pour les modifier, fournissez de nouvelles valeurs lors de l'appel du script Publish-Orchestrator.ps1.

-NuGet.Packages.ApiKey
-NuGet.Activities.ApiKey
-NuGet.Packages.Path
-NuGet.Activities.Path
-machineKey/@decryption
-machineKey/@decryptionKey
-machineKey/@validationKey
-EncryptionKey
-NuGet.Repository.Type
-Storage.Type
-Storage.Location
-LoadBalancer.Redis.ConnectionString
-LoadBalancer.UseRedis
-Scalability.AzureSignalR.ConnectionString
-nlog/targets/target/@name=robotElasticBuffer/@name=RobotElastic/@uri
-nlog/targets/target/@name=robotElasticBuffer/@name=RobotElastic/@username
-nlog/targets/target/@name=robotElasticBuffer/@name=RobotElastic/@password
-nlog/rules/logger/@name=Robot.*/@writeTo
-nlog/targets/target/@name=serverElasticBuffer/@name=serverElastic/@uri
-nlog/targets/target/@name=serverElasticBuffer/@name=serverElastic/@username
-nlog/targets/target/@name=serverElasticBuffer/@name=serverElastic/@password
-nlog/targets/target/@name=serverElasticBuffer/@name=serverElastic/@index
-nlog/rules/logger/@name=*/@writeTo

Exemples

Installation sur un nœud unique

L'exemple suivant permet d'effectuer une nouvelle installation d'Orchestrator sur un nœud, d'utiliser Elasticsearch pour la journalisation et d'enregistrer des paquets dans le stockage d'objets blob Azure et leurs métadonnées dans la base de données SQL. La procédure se déroule d'une manière -unattended et ses étapes sont consignées au niveau de -verbose.

.\Publish-Orchestrator.ps1 `
-action "Deploy" `
-unattended `
-package "E:\Work\Orch\Setup\UiPath.Orchestrator.Web.zip" `
-stopApplicationBeforePublish `
-azureSubscriptionId "8e34be72-1937-4aa0-b70e-81bab19gbf0a" `
-azureAccountTenantId "f8350d2a-n153-4d17-8927-902c51f72797" `
-azureAccountApplicationId "$AzureApplicationId" `
-azureAccountPassword "$AzurePassword" `
-resourceGroupName "DocTest-Orch-RG" `
-appServiceName "DocTests123" `
-testAutomationFeatureEnabled 
-updateServerFeatureEnabled 
-storageType "Azure" `
-storageLocation "DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net" `
-robotsElasticSearchUrl "http://docelasticserver:9200" `
-verbose

Installation à plusieurs nœuds

L'exemple suivant permet d'effectuer une nouvelle installation d'Orchestrator sur plusieurs nœuds, d'utiliser Elasticsearch pour la journalisation et Redis pour la mise en cache et la distribution des messages. Les paquets sont enregistrés dans le stockage d'objets blob Azure et leurs métadonnées dans la base de données SQL. La procédure se déroule de manière -unattended et ses étapes sont consignées au niveau de -verbose.

.\Publish-Orchestrator.ps1 `
-action "Deploy" `
-unattended `
-package "E:\Work\Orch\Setup\UiPath.Orchestrator.Web.zip" `
-stopApplicationBeforePublish `
-azureSubscriptionId "8e34be72-1937-4aa0-b70e-81bab19gbf0a" `
-azureAccountTenantId "f8350d2a-n153-4d17-8927-902c51f72797" `
-azureAccountApplicationId "$AzureApplicationId" `
-azureAccountPassword "$AzurePassword" `
-resourceGroupName "DocTest-Orch-RG" `
-appServiceName "DocTests123" `
-redisConnectionString "docs123.redis.cache.windows.net:6380,passwprd=******,ssl=True" `
-azureSignalRConnectionString "Endpoint=https://doctest.signalr.net;AccessKey=*****;Version=1.0;" `
-robotsElasticSearchUrl "http://docelasticserver:9200" `
-storageType "Azure" `
-storageLocation "DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net" `
-verbose

Mise à jour multinœud

L'exemple suivant permet de mettre à niveau une entité d'Orchestrator multinœud existante vers la dernière version disponible, sans modifier aucun paramètre préexistant. La procédure se déroule dans un mode -unattended et ses étapes sont consignées au niveau de -verbose.

Publish-Orchestrator.ps1 `
-action Update `
-unattended `
-package "E:\Work\Orch\Setup\UiPath.Orchestrator.Web.zip" `
-stopApplicationBeforePublish `
-azureSubscriptionId "8e34be72-1937-4aa0-b70e-81bab19gbf0a" `
-azureAccountTenantId "f8350d2a-n153-4d17-8927-902c51f72797" `
-azureAccountApplicationId "$AzureApplicationId" `
-azureAccountPassword "$AzurePassword" `
-resourceGroupName "DocTest-Orch-RG" `
-appServiceName "DocTests123" `
-verbose

L'exemple suivant permet de mettre à niveau une entité d'Orchestrator multinœud existante vers la dernière version disponible, tout en remplaçant la valeur des paramètres Webhooks.Enabled et Telemetry.Enabled par false. La procédure se déroule dans un mode -unattended et ses étapes sont consignées au niveau de -verbose.

Publish-Orchestrator.ps1 `
-action Update `
-unattended `
-package "E:\Work\Orch\Setup\UiPath.Orchestrator.Web.zip" `
-stopApplicationBeforePublish `
-azureSubscriptionId "8e34be72-1937-4aa0-b70e-81bab19gbf0a" `
-azureAccountTenantId "f8350d2a-n153-4d17-8927-902c51f72797" `
-azureAccountApplicationId "$AzureApplicationId" `
-azureAccountPassword "$AzurePassword" `
-resourceGroupName "DocTest-Orch-RG" `
-appServiceName "DocTests123" `
-appSettings @{"Webhooks.Enabled"="false"; "Telemetry.Enabled"="false"} `
-verbose