Workflow Manager is an added value to the SharePoint 2013, in the previous versions workflow was part of the SharePoint on SharePoint 2013 there are 2 flavors you can use when developing workflows the first one is the SharePoint 2010 workflow and the second and new one is the new workflow manager which is now a separate component, when you install the new workflow manager it will allow to create SharePoint 2013 workflows.
The Architecture of the Workflow Manager depends on several separate databases to save the workflows so now the workflows are stored on those separate databases and not on the content databases so important in any backup and restore to make sure that all those workflows are backed up in case restoration is needed and while restoring there are important steps and scripts that needs to run in certain order to restore the workflow farm correctly.
I will be walking through the steps to restore the workflow farms and the scripts used can be found in this link Scripts
Backup Workflow Manager
There are some components/information which need to be backed up and stored in order to restore workflow manager.
- Backup the following databases by following the Database backup procedures, the frequency of backup the DB is same as content databases.
|WFResourceManagementDB||Workflow Manager Resource Management Store|
|WFInstanceManagementDB||Workflow Manager Instance Management Store|
|SbGatewayDatabase||Service Bus Gateway Database|
|SBMessageContainer01 – n||Service Bus Message Container Databases|
- Document the users/passwords used while configuring workflow manager.
- Copy all the certificates generated during initial Workflow Manager Configuration and the certificate password and Important to save the thumbnail of the service bus certificate.
- Certificates will exist on local certificates in personal folder and full trusted certificates folder all of them need to be exported specially the service bus certificate.
- To know service bus certificate run the command Get-SBFarm the returned result will contain the farm certificate thumbprint, check this thumbprint on the local machine certificates in the personal folder.
- Export certificate with private key.
- Keep track of outage date and time when it happens as it will be needed.
- Document all ports used during initial configuration.
- Get the symmetric key using this command and save it. “Get-SBNamespace -Name WorkflowDefaultNamespace”.
- Save all scopes names specially the one used to register the workflow manager farm to do that run the getscopes.ps1 script
- Prepare a new machine to install workflow manager on the same domain as old machines
- Use the same accounts when the workflow manager was configured originally.
- Make sure that App Management service/service application running and subscription service too
- Make sure to have user profile and user profile synchronization running and run full synchronization.
- Install workflow manager on new machine but don’t configure it.
- To install workflow manager install web platform installer and search for “workflow manager refresh 1”
- Restore the backed up databases.
- Only the following database should be restored.
- SBMessageContainer* (all message container DBs)
- Note: Do not restore the WFManagementDB and SbManagementDb databases as they will be recreated as part of the restore operation.
- Restore any needed content DBs, web applications and site collections.
- Restore the certificates exported during backup.
- Open an elevated SharePoint PowerShell (Run as Administrator) window on the new machine.
- Copy all the scripts and the wfm.config to a folder and navigate to that folder from the SharePoint PowerShell console.
- Run restoreWFStep1 script (modify the parameters in the script as appropriate first).
- Run restoreWFStep2 script (modify the parameters in the script as appropriate first).
- For each container database, run the previous step after modifying the parameters. (optional if more than container database exists)
- Run restoreWFStep3 (modify the parameters in the script as appropriate and put the thumbprint for the imported certificate).
- Run restoreWFStep4 (modify the parameters in the script as appropriate first).
- Set-SBNamespace –PrimarySymmetricKey keyvalue -Name WorkflowDefaultNamespace
- Open new SharePoint PowerShell as Administrator.
- Navigate to the folder containing scripts from the SharePoint PowerShell console.
- Run the following commands
- $filename = Resolve-Path .wfm.config
- [System.AppDomain]::CurrentDomain.SetData(“APP_CONFIG_FILE”, $filename.Path)
- Run restoreWFStep5 script (modify the parameters in the script as appropriate first).
- Run restoreWFStep6 script (modify the parameters in the script as appropriate first).
- Adjust DNS for workflow manager.
- In IIS make sure to have the binding with the port for http for the workflow manager IIS site
- You may need to register the workflow farm with the scope name used in the original farm
- Register-SPWorkflowService -SPSite “http:/webapplication” -WorkflowHostUri “http://workfowsite:12291 ” -AllowOAuthHttp -Force -ScopeName “MyScope”
- This command needs to run on the SharePoint Farm.(It is optional step if the farm didn’t see the workflow)
- Run the following timer jobs from the central admin
- Workflow Auto Cleanup
- Notification Timer Job
- Hold Processing and Reporting
- Bulk workflow task processing
- Refresh Trusted Security Token Services Metadata feed [Farm job – Daily]
To add other workflow manager servers, just import the certificate and run restoreWFStep4 (after modifying the parameters) and then run restoreWFStep6 (after modifying the parameters).
There are other cases for restoration, in case if the application servers are not affected only the SQL server in this case the uninstall workflow manager from existing application server and then follow the above steps, once done you can uninstall workflow manager from other nodes and install workflow manager and reinstall it but don’t configure it just use the commands in script of restoreWFStep4 and restoreWFStep6
There is other case when the the application server is affected, in this case prepare a new machine and apply the above steps, then for any other node you can install workflow manager but don’t configure it just run restoreWFStep4 and restoreWFStep6 in the scripts to add those nodes.