Jak nasadit a aktualizovat SharePoint Workflow Manager

Články

SharePoint Workflow Manager nahrazuje původní Microsoft Workflow Manager a Service Bus pro běh workflow platformy SharePoint 2013. Instaluje se samostatně od SharePoint Serveru a přechod z původního WFM vyžaduje vlastní postup. Je potřeba připravit serverové i klientské komponenty a správně připojit workflow farmu k SharePointu.

Nejprve si ověřte, jaký produkt používáte. Přechod z původního Workflow Manageru na SharePoint Workflow Manager není běžné CU. A pokud už SharePoint Workflow Manager máte, nemusíte kvůli každé jeho aktualizaci provádět celý postup migrace.

Microsoft nový produkt oznámil 16. 2. 2023. Tento návod popisuje jeho nasazení a přechod z původního WFM. Obecný postup instalace CU a migrace na nové servery jsou označené jako pozdější doplnění.

Součásti a výběr postupu

Než začnete, rozlište základní instalaci serveru, klienta a případnou aktualizaci. Čísla aktuálních balíčků najdete v příslušném oznámení CU a jeho KB, tento návod se na konkrétní vydání neváže.

Součást Účel Umístění
SharePoint Workflow Manager Serverová část workflow infrastruktury Servery workflow farmy
SharePoint Workflow Manager Client Klientské komponenty pro komunikaci s workflow farmou Servery workflow farmy i SharePoint farmy
Serverové CU, pozdější doplnění Aktualizace existující instalace SPWFM Servery workflow farmy, požadovaného klienta určuje KB

Verzi serveru a klienta ověřte v Control Panel – Programs and Features. Rozlišujte názvy Microsoft Workflow Manager a SharePoint Workflow Manager. Samotný stav služeb neříká, který produkt a jakou aktualizaci máte nainstalovanou.

Výchozí stav Postup
Workflow infrastrukturu nemáte Nové nasazení
Původní WFM, zachováváte servery Přechod na stávajících serverech
Původní WFM, měníte servery Migrace na nové servery
SharePoint Workflow Manager už používáte Instalace CU

Příprava před nasazením nebo aktualizací

Rozlišení serveru a klienta

Na všech serverech workflow farmy se instaluje SharePoint Workflow Manager i SharePoint Workflow Manager Client. Na všech serverech SharePoint farmy je potřeba klient. Instalace SharePoint CU tyto komponenty nenahrazuje. Základní instalátory jsou dostupné v Microsoft Download Center, aktualizaci a požadovanou verzi klienta vybírejte podle příslušného KB.

Pro produkční nasazení připravte HTTPS, DNS jméno endpointu a důvěryhodný certifikát. Ověřte podporovaný operační systém, SQL Server, požadované IIS komponenty a Azure Service Fabric podle instalační dokumentace. Service Fabric musí být nainstalovaný před SPWFM. Na samostatném workflow serveru nezapomeňte na IIS včetně Windows Authentication, .NET Extensibility a ASP.NET.

Microsoft doporučuje samostatné workflow servery. Počet uzlů workflow farmy se neřídí počtem SharePoint serverů, podporované jsou liché počty, například jeden nebo tři. Ani více uzlů ale není důvodem slibovat aktualizaci bez odstávky. Připravte servisní okno a ověřte postup pro všechny uzly.

SQL Server 2016 a novější: podle požadavků SPWFM musí mít databáze Workflow Manageru a Service Bus úroveň kompatibility 120. Po jejich vytvoření nebo obnovení nechte DBA ověřit a případně nastavit tuto hodnotu u všech šesti databází ještě před funkčními testy. Názvy přizpůsobte své farmě, tento požadavek se nevztahuje na obsahové ani servisní databáze SharePointu.

Ověřte obousměrnou komunikaci mezi SharePointem a workflow farmou i přístup k SQL. HTTPS endpoint workflow farmy používá ve výchozím nastavení port 12290. Povolte také komunikaci mezi workflow uzly podle konfigurace průvodce. Úspěšné otevření workflow endpointu ze SharePoint serveru samo o sobě neověřuje zpětná volání workflow do SharePointu.

Uložení aktuální konfigurace

Než začnete měnit existující farmu, poznamenejte si SQL instance a názvy databází, servisní účet, AdminGroup, endpoint, certifikáty a scope. Zajistěte zálohy všech databází Workflow Manageru a Service Bus a domluvte konzistentní bod obnovy s databázemi SharePointu. Samotné výpisy konfigurace databázovou zálohu nenahrazují.

Na workflow serveru spusťte Workflow Manager PowerShell jako správce. Příklad uložení konfigurace do existující složky:

Get-WFFarm | Format-List * | Out-File 'C:\Install\WFFarm.txt'
Get-SBFarm | Format-List * | Out-File 'C:\Install\SBFarm.txt'
Get-WFFarmStatus | Out-File 'C:\Install\WFFarmStatus.txt'
Get-SBFarmStatus | Out-File 'C:\Install\SBFarmStatus.txt'

Pro opuštění a opětovné připojení k existující farmě potřebujete původní Certificate Generation Key. Není to heslo servisního účtu. Pokud ho neznáte, neodebírejte poslední funkční uzel, dokud nemáte vyřešené získání klíče nebo postup obnovy pro skutečně používaný produkt. Reset popsaný Microsoftem pro SPWFM se provádí na serveru, který je stále členem farmy. Tento skript nepouštějte bez ověření jeho použitelnosti na původním Classic WFM.

Reset klíče mění také certifikáty Workflow Manageru a Service Bus. Podle stejného postupu potom obnovte důvěru k novému workflow certifikátu na všech SharePoint serverech a spusťte úlohu Refresh Trusted Security Token Services Metadata feed, která aktualizuje metadata důvěryhodného vydavatele tokenů. Bez těchto kroků mohou workflow selhávat i při běžících službách. Klíč a hesla uchovávejte bezpečně mimo běžné výpisy konfigurace.

Scope zjistíte na SharePoint serveru v SharePoint Management Shellu. Následující příklad předpokládá jediný Workflow Service Application Proxy:

$site = (Get-SPWebApplication -IncludeCentralAdministration |
    Where-Object { $_.IsAdministrationWebApplication }).Sites[0]
$proxy = Get-SPServiceApplicationProxy |
    Where-Object { $_.TypeName -eq 'Workflow Service Application Proxy' }
$proxy.GetWorkflowServiceAddress($site)

Ve výsledku například https://workflow.contoso.com:12290/SharePoint2013/ je scope SharePoint2013. Při migraci zachovejte skutečně používanou hodnotu, nevytvářejte automaticky nový scope jen proto, že měníte server.

Nové nasazení SharePoint Workflow Manageru

První server

  1. Připravte účty, SQL, IIS, certifikáty a potřebnou komunikaci. Nainstalujte podporovaný Azure Service Fabric Runtime.
  2. Nainstalujte základní SharePoint Workflow Manager RTM.
  3. Nainstalujte SharePoint Workflow Manager Client. Pokud nasazujete i CU, už v tomto kroku použijte klienta požadovaného jeho KB. Při výměně klienta nejprve odinstalujte jeho starší verzi.
  4. Pozdější doplnění pro vydání CU: pokud instalujete dostupné CU, nejprve ověřte jeho požadovaného klienta, nainstalujte serverový balíček a proveďte případný požadovaný restart. Postup pro novou farmu určuje příslušné KB.
  5. Spusťte Workflow Manager Configuration Wizard a vytvořte novou farmu. Pokud potřebujete vlastní databázové názvy, porty nebo certifikáty, použijte Configure Workflow Manager with Custom Settings.
  6. Uložte zvolený Certificate Generation Key a konfiguraci. Ověřte dokončení průvodce i stav služeb.

Pozdější doplnění: pokud KB vybraného CU předepisuje instalaci aktualizace před vytvořením nové farmy, dodržte toto pořadí. Založení farmy na neaktualizované instalaci a následná instalace CU není automaticky rovnocenný postup.

Další servery a připojení SharePointu

  1. Na dalších workflow serverech připravte stejné komponenty, klienta a CU.
  2. Spusťte průvodce a vyberte Join an Existing Workflow Manager Farm. Použijte konfiguraci existující farmy a její Certificate Generation Key.
  3. Na všech SharePoint serverech nainstalujte požadovaného SPWFM klienta, předtím odinstalujte případného původního klienta.
  4. V SharePoint farmě ověřte App Management a Subscription Settings včetně service applications a proxy. Pokud chybějí, nejprve je nakonfigurujte.
  5. Zajistěte důvěru k certifikátu workflow endpointu podle dokumentace certifikátů. Pokud vydavatel zatím není důvěryhodný, exportujte jeho certifikát z certifikační cesty HTTPS vazby Workflow Management Site. Kořenový certifikát přidejte do Local Computer → Trusted Root Certification Authorities na každém SharePoint serveru a také do důvěry SharePoint farmy přes New-SPTrustedRootAuthority nebo Central Administration → Security → Manage Trust. Samotný import do profilu přihlášeného uživatele nestačí. Ověřte celý certifikační řetězec, platnost a shodu DNS názvu s certifikátem.
  6. Na jednom SharePoint serveru propojte farmy příkazem Register-SPWorkflowService a proveďte kontroly v části Ověření po změně.

Správné workflow URL zjistíte příkazem Get-WFFarm | Select-Object Endpoints. Příklad registrace nové farmy přes HTTPS, který spustíte v SharePoint Management Shellu jako správce s potřebnými oprávněními k workflow farmě:

Register-SPWorkflowService -SPSite 'https://sharepoint.contoso.com' -WorkflowHostUri 'https://workflow.contoso.com:12290'

Názvy upravte podle prostředí. Parametr -SPSite označuje platnou kolekci webů, registraci tím neomezujete pouze na ni. Tento příklad je pro nové připojení, opětovná registrace při migraci má další podmínky.

Přechod z původního WFM na stávajících serverech

SPWFM neinstalujte přes původní Microsoft Workflow Manager. Přechod vyžaduje odstranění původních komponent, zachovává ale existující databáze a workflow. Podrobný postup uvádí Upgrade existing Microsoft Workflow Manager.

  1. Dokončete zálohy, záznam konfigurace a ověření Certificate Generation Key. Naplánujte odstávku.
  2. V původním Workflow Manager Configuration Wizard zvolte Leave Workflow Manager Farm. Dokončete odebrání na všech původních workflow serverech.
  3. Na těchto serverech odinstalujte původní Microsoft Workflow Manager, Workflow Manager Client, Service Bus for Windows Server a případný Windows Fabric. Pokud je server sdílený se SharePointem, nezaměňte Windows Fabric s AppFabric 1.1 pro Distributed Cache.
  4. Odstraňte zbylé složky původní instalace uvedené v dokumentaci Microsoftu, pouze po ověření konkrétní cesty a dokončené odinstalaci. Nemažte databáze ani adresáře jiných komponent. Restartujte server.
  5. Připravte Azure Service Fabric a nainstalujte SharePoint Workflow Manager i jeho klienta.
  6. V průvodci zvolte Join an Existing Workflow Manager Farm. Použijte původní databáze, servisní účet a Certificate Generation Key. Nevytvářejte novou prázdnou farmu.
  7. Znovu spusťte průvodce a dokončete Upgrade Workflow Manager Farm. Dokončete přechod a upgrade na všech workflow serverech.
  8. Na všech SharePoint serverech odinstalujte starého klienta a nainstalujte SPWFM klienta.
  9. Pozdější doplnění pro vydání CU: následně dokončete instalaci zvoleného CU postupem v části Instalace CU, včetně klienta požadovaného tímto CU, a ověřte původní workflow.

Jde o přechod se zachováním původních databází, nikoli o podporovaný upgrade instalací přes starý produkt. U běžného přechodu se stejnou registrací zpravidla není potřeba mazat Workflow Service Application Proxy a znovu spouštět Register-SPWorkflowService. Případnou změnu endpointu nebo certifikátu řešte podle skutečné konfigurace.

Migrace původního WFM na nové servery

Pozdější doplnění k původnímu vydání z 20. 3. 2023: postup migrace na nové servery publikoval Josh Roark 24. 3. 2023. Následně byl převzat do Microsoft Learn. Tato část proto není prezentovaná jako součást původního březnového vydání.

Při změně serverů zachovejte databáze a identitu existující workflow farmy. Čistá instalace s novými databázemi není migrace vašich původních workflow. Následující pořadí vychází z oficiálního migračního postupu, který navazuje na článek Joshe Roarka.

  1. Zaznamenejte konfiguraci, Certificate Generation Key, RunAsAccount, AdminGroup a scope. Připravte nové servery a plán přepnutí.
  2. Na všech původních uzlech použijte Leave Workflow Manager Farm. Migrační záloha workflow a Service Bus databází musí vzniknout až po odebrání všech původních hostů, jinak si přenesete jejich staré záznamy.
  3. Pokud měníte SQL Server a zachováváte původní management databáze, přeneste všech šest databází Workflow Manageru a Service Bus se stejnými názvy. Na všech nových workflow serverech vytvořte SQL alias, který původní jméno SQL instance směruje na novou instanci, a ověřte připojení ještě před opětovným připojením uzlů. Nestačí zadat nový SQL Server pouze v průvodci, připojení k dalším čtyřem databázím je uložené v management databázích.
  4. Na nových serverech připravte IIS, Service Fabric, základní SPWFM a klienta. Připojte je k původním nebo obnoveným databázím pomocí Join an Existing Workflow Manager Farm a dokončete Upgrade Workflow Manager Farm.
  5. Dokončete zvolené CU podle příslušného KB a sjednoťte klienty na serverech obou farem.
  6. Ověřte endpoint a důvěru certifikátům. Pokud scénář vyžaduje opětovnou registraci, použijte původní scope a odpovídající workflow URL.
  7. Přepněte SharePoint na připravené prostředí a ověřte skutečná původní workflow.

Pokud SQL alias použít nemůžete nebo potřebujete měnit databázové názvy, tento postup s opětovným připojením k původním management databázím nepoužívejte. Zvolte samostatný Farm Restore. Ten obnovuje čtyři datové databáze a vytváří nové management databáze, vyžaduje vlastní pořadí kroků a následné obnovení certifikátové důvěry. Oba postupy nemíchejte.

Standardní názvy databází jsou SbGatewayDatabase, SbManagementDB, SBMessageContainer01, WFInstanceManagementDB, WFManagementDB a WFResourceManagementDB. Pokud používáte vlastní názvy, zachovejte je. Během přepnutí zabraňte souběžnému zpracování produkčních workflow ve starém a novém prostředí.

Příklad opětovné registrace při migraci. Hodnotu -ScopeName nahraďte skutečným původním scope, parametr -Force není součástí běžné instalace CU:

Register-SPWorkflowService -SPSite 'https://sharepoint.contoso.com' -WorkflowHostUri 'https://workflow.contoso.com:12290' -ScopeName 'SharePoint2013' -Force

Pokud současně migrujete SharePoint farmu, přeneste také odpovídající obsahové databáze a databázi App Management. Obsahuje aplikační identity používané původními workflow. Její vynechání může způsobit selhání workflow i při správně běžící SPWFM farmě. Podrobný upgrade SharePointu není součástí tohoto návodu, řiďte se jeho vlastní migrační dokumentací a podporovanou cestou mezi verzemi.

Instalace CU do existující SPWFM farmy

Pozdější doplnění po zahájení vydávání CU v roce 2025. Tento postup je určený pro farmu, která již používá SharePoint Workflow Manager. Konkrétní serverový balíček a požadovaného klienta vyberte podle oznámení daného CU a části Prerequisites jeho KB. Dokončení instalace popisuje část More information, zvlášť pro existující a novou farmu.

  1. Ověřte předpoklady, známé problémy a dostupné zálohy. Připravte instalační balíčky a servisní okno pro obě farmy.
  2. Podle KB odinstalujte starý SPWFM Client na všech serverech Workflow Manager farmy i SharePoint farmy. Výjimku použijte pouze tehdy, když oznámení konkrétního CU výslovně dovoluje ponechat již nainstalovaného klienta a jeho verze odpovídá požadavku KB.
  3. Na všech těchto serverech zajistěte klienta požadovaného vybraným CU, buď novou instalací, nebo výslovně povoleným ponecháním odpovídající verze z předchozího kroku. Verzi přebírejte z KB, nemusí být totožná s buildem serverového balíčku.
  4. Na všech serverech workflow farmy nainstalujte vybrané serverové CU. Serverový balíček nepatří na SharePoint servery, které mají pouze klienta.
  5. Restartujte servery, pokud to instalace vyžaduje.
  6. Na workflow serverech dokončete Upgrade Workflow Manager Farm ve Workflow Manager Configuration Wizard.
  7. Zkontrolujte verze, stav farmy, spojení ze SharePointu a funkčnost workflow.

Postup běžného CU neobsahuje Leave Workflow Manager Farm, odinstalaci serverového produktu ani vytváření nových databází. Tyto kroky patří jiným scénářům. Instalace binárních souborů také nenahrazuje dokončení upgradu farmy v průvodci.

Ověření po změně

Než prostředí předáte do provozu, ověřte kompatibilitu 120 u workflow a Service Bus databází na SQL Serveru 2016 nebo novějším. Po migraci zkontrolujte také připojení všech uzlů ke správné SQL instanci a po změně certifikátů dokončení obnovy důvěry a metadat.

Na workflow serverech ověřte verze nainstalovaných komponent a stav farmy. Příklad kontroly v administrátorském Workflow Manager PowerShellu:

Get-WFFarmStatus
Get-SBFarmStatus
Get-WFFarm | Select-Object Endpoints, RunAsAccount, AdminGroup

Ze SharePoint serveru otevřete skutečný workflow endpoint přes HTTPS, například https://workflow.contoso.com:12290/. Pro administrátorskou kontrolu použijte účet s oprávněním k workflow farmě. Ověřte DNS, certifikát a dostupnost služby. Potom v Central Administration zkontrolujte, že Workflow Service Application Proxy hlásí připojení.

Samotný stav Connected nestačí. Spusťte novou instanci existujícího workflow a ověřte akce, práci s úkoly, historii i dokončení. Podle používaných scénářů ověřte také pokračování čekajícího workflow a publikaci testovacího workflow. Test neprovádějte pod SharePoint System Account, použijte běžného testovacího uživatele s potřebnými oprávněními a profilem v User Profile Service.

Při chybě nejprve zkontrolujte View Log v konfiguračním průvodci, události Workflow Manageru a Service Bus a SharePoint ULS. Porovnejte skutečné verze klientů na všech serverech. Neřešte problém se scope nebo oprávněními založením nové prázdné workflow farmy.

Pozdější doplnění

Původní vydání článku je zasazené do 20. 3. 2023. Migrace na nové servery a obecný postup instalace CU jsou pozdější doplnění. Aktuální čísla KB, buildy serveru a požadované verze klienta patří do oznámení jednotlivých CU, nikoli do tohoto návodu.

Aktualizace serveru a klienta

Při každé aktualizaci ověřte předpoklady a známé problémy daného vydání. Server a klient mají samostatné instalační balíčky a jejich verze se mohou lišit. Klienta neodvozujte z čísla serverového buildu. Výchozí postup počítá s jeho výměnou, ponechání již nainstalované verze připadá v úvahu pouze tehdy, pokud to oznámení výslovně dovoluje a verze odpovídá požadavku KB.

Závislosti a změny prostředí

Požadavky na SQL připojení a další knihovny se mezi vydáními mohou měnit. Před migrací nebo aktualizací proto ověřte aktuální dokumentaci a konkrétní KB. Změnu Service Fabric plánujte samostatně podle jeho dokumentace, nejde automaticky o součást každého SPWFM CU. Historický příklad verze Service Fabric není doporučením pro dnešní instalaci.

Podpora a nástroje pro testování

SPWFM se řídí Component Lifecycle Policy a podporou příslušného SharePoint Serveru. Samotný přechod na SPWFM neprodlouží podporu staré SharePoint farmy.

SharePoint Designer 2013 je od července 2026 mimo podporu. Jeho ukázky ve starších návodech proto nepřebírejte jako doporučení pro nové nasazení. Microsoft uvádí Visual Studio jako podporovanou možnost tvorby a úprav SharePoint 2013 workflow po tomto datu, viz informace o ukončení podpory. Ověření existujících workflow provádějte přímo přes SharePoint.