This upgrade guide covers all of the procedures involved in upgrading WorkflowGen to version 9.2.6. It's aimed at system administrators who'll be updating the existing application.
Important Notes Before Upgrading
Update .NET version
WorkflowGen 9.2.6 requires .NET Framework 4.8, so you must install it before proceeding with this upgrade.
Update the root web.config file's URL rewrite rules
As of WorkflowGen 9.2.0, you MUST update your site's root web.config file with the new URL rewrite rules, based on how your WorkflowGen URL is configured. For instructions on how to do this, see the section.
Using BACKURL_SUBMIT and BACKURL_CANCEL parameters in custom WorkflowGen URLs
As of version 7.15.5, the optional BACKURL_SUBMIT and BACKURL_CANCEL HTTP parameters used in custom WorkflowGen URLs (for example, ) now ONLY support absolute URLs (starting with http:// or https://), relative URLs (starting with /), or URLs defined in the PortalRedirectAllowedHttpUrls configuration parameter (e.g. value='blank.htm, myPage.htm').
Password encryption change
As of version 7.15.0, the SMTP server account and Remote Approval incoming server account passwords are no longer encrypted in the web.config file.
Before upgrading an existing WorkflowGen server, you must manually reset the passwords in cleartext for the ApplicationSmtpPassword and RemoteApprovalIncomingServerPassword parameters in the web.config. Alternatively, you can use the provided convert-web-config-pwd.ps1 PowerShell script in \wfgen to decrypt and convert the passwords in the web.config.
Database server
MS SQL Server
Microsoft SQL Server 2008, 2012, and 2014 are no longer supported. While these versions will still be compatible with WorkflowGen, support for any performance issues or bugs resulting from using SQL Server 2008, 2012, or 2014 will no longer be provided.
For clients currently hosting WorkflowGen on a database server older than MS SQL Server 2016, we highly recommend upgrading to the latest MS SQL Server version for the best performance.
Migrating the WorkflowGen database from MS SQL Server 2005/2008 to 2016 or later
This database compatibility upgrade is mandatory before migrating the WorkflowGen database from MS SQL Server 2005/2008 to 2016 and above.
It's not required if your WorkflowGen database is already running in MS SQL Server 2012 or 2014.
To do this, launch the Update\Databases\MsSQLServer\Update_WFG-V7-0_SQL_Triggers_2012.sql database update script in your SQL Server Management Studio tool.
End of Oracle support
Oracle database is no longer supported as of WorkflowGen 7.16.0.
Node.js modules
The Node.js modules include the GraphQL API, webhooks, SCIM, and Auth. For instructions on how to enable them, see the section.
Upgrade Node.js version
Upgrade Node.js to version 18.20.7 LTS (see ).
GraphQL and incoming webhooks file upload management parameters
As of WorkflowGen version 7.10.0, if you're using incoming webhooks or GraphQL to upload files when starting a new request or completing an action, you must set the GraphqlFileInputAllowedFolders, HooksFileInputAllowedFolders, GraphqlMaxInputFileContentSize, and HooksMaxInputFileContentSize configuration parameters with the appropriate values (see the section).
GraphqlFileInputAllowedFolders and HooksFileInputAllowedFolders: These parameters should contain the physical paths of folders that contain files used in uploads.
GraphqlMaxInputFileContentSize and HooksMaxInputFileContentSize: These parameters should contain the maximum file size in kilobytes when uploading files using the file content method.
JavaScript dependencies updated
The following dependencies have been updated as of WorkflowGen version 8:
jQuery v1.7.2 or 1.10.12 → 3.5.1
jQuery UI v1.8.20 or 1.10.3 → 1.12.1
jQuery Colorbox v1.4.33 → 1.6.4
Some .js, .css, and .png files have been moved to the \wfgen\js\common and \wfgen\App_Themes\Default\common folders, respectively. If you're using the previous versions of the files listed above in your forms, you must re-save the forms in order to use the correct paths and files.
Configuring custom web forms in WorkflowGen 8 or later
If you're using custom web forms configured in .NET 2.0, you can keep using them in .NET 2.0 or migrate them to .NET 4.
To configure custom web forms for .NET 2.0
Use WorkflowGen.My.dll in version 2.x.
Use a .NET 2.0 application pool.
Disable Web apps secure mode in the Security section on the General tab in the Configuration Panel.
To migrate custom web forms to .NET 4
Use WorkflowGen.My.dll in version 8.x.x or later.
Use a .NET 4 application pool.
Define or update the following nodes in the web form’s web.config:
These instructions apply only to configuring web forms to run properly without configuration errors. They do not cover potential migration or compatibility issues that may arise due to changes in the latest version of WorkflowGen.My. You must fully retest all of your web forms before production.
After an upgrade or migration to WorkflowGen 8 or later, custom web forms that use a version 8 or later WorkflowGen.My.dll in their custom
When deploying a custom assembly SDK workflow application
The WorkflowGen.My and Workflow Web Controls assemblies are no longer strong-named in order to allow non-specific version dependency when referenced by other applications such as custom assembly SDK Workflow applications in WorkflowGen.
This simplifies the deployment procedure of an assembly SDK Workflow application to WorkflowGen 6.2.0 and later, and allows upgrading WorkflowGen to a newer version without having to rebuild the application's assembly that was referencing an older version of WorkflowGen.My.
There are some considerations when deploying a custom assembly SDK workflow application in WorkflowGen, namely the assembly location, the reference to WorkflowGen.My, and the reference to other software libraries.
Assembly location
There are two ways of deploying an assembly file in WorkflowGen.
Method 1: Reference by assembly's full name
The assembly file must be copied to the three \bin folders containing the WorkflowGen executable files: \wfgen\bin, \wfgen\ws\bin, and DRIVE:\Program Files\Advantys\WorkflowGen\Services\bin.
Method 2: Reference by assembly's path (full physical path with file name)
The assembly file can be copied to a custom folder such as DRIVE:\MyWorkflowApps\Assembly.dll, and then use that specific path in the workflow application's definition.
Reference to WorkflowGen.My
WorkflowGen.My 3.1.0 and earlier
WorkflowGen.My versions 3.1.0 and earlier are strong-named, which means your assembly must be built with and use the same version as your target WorkflowGen. This requires recompiling your assembly whenever you upgrade WorkflowGen to a newer version.
You can use one of the following workarounds to overcome this requirement:
Install the required WorkflowGen.My version in the system's Global Assembly Cache (GAC). For instructions on how to do this, see .
OR
Add a delegate to handle the assembly resolve event in order to load the current WorkflowGen.My version. For instructions on how to do this, see the WorkflowGen Knowledge Base article.
OR
If your assembly is built with WorkflowGen.My version 3.1.0 or earlier, it can be used in WorkflowGen versions 6.2.0 and later if one of the above workarounds has been implemented.
WorkflowGen.My 3.2.0 and later
As of version 3.2.0, WorkflowGen.My is no longer strong-named in order to allow non-specific version dependency when referenced by your assembly. You can simply deploy your assembly file using one of the two methods in the section above in WorkflowGen version 6.2.0 and later.
If your assembly is built with WorkflowGen.My version 3.2.0 or later, it can be used in WorkflowGen versions prior to 6.2.0 if you've implemented either workaround 2 or 3 above.
Reference to other software libraries
If your assembly uses third-party libraries, then these must also be deployed into the three WorkflowGen executable \bin folders. Alternatively, they can be installed into the system's Global Assembly Cache (GAC) if they are strong-named assemblies.
FIPS compliance configuration
WorkflowGen is FIPS compliant as of version 7.10.0. If you want to enable FIPS compliance in your Windows environment, you have to configure the configuration password management and user password management modes beforehand.
Configuration password management mode
In the Security section on the Configuration Panel General tab, set Configuration password management mode to AES (FIPS Compliant) and enter a 32-character encryption key. When you click Save, the application passwords will automatically be converted to the new symmetric encryption mode.
User password management mode
In the Authentication section on the Configuration Panel General tab, set Password management mode to One-way Hashing (SHA256 FIPS Compliant) mode.
If you're using Applicative authentication in Version 5 (Legacy) password management mode, users' passwords will automatically be converted into One-way Hashing (SHA256 FIPS Compliant) the next time they log into WorkflowGen.
If you're using Applicative authentication in One-way Hashing (SHA256) password management mode:
Select IIS authentication mode.
Legacy software support
Browser and OS versions
WorkflowGen no longer supports Internet Explorer, Windows XP, Windows 7, Windows 8, or Windows Server 2003 or 2008.
Database
MS SQL Server 2005 is no longer supported as of WorkflowGen version 6.2.0, MS SQL Server 2008 is no longer supported as of WorkflowGen version 7.10.0, and MS SQL Server 2012 is no longer supported as of WorkflowGen version 8.2.0.
Oracle database is no longer supported as of WorkflowGen 7.16.0.
Workflow applications
The following applications are deprecated and are no longer provided as of WorkflowGen version 6:
EFORMPDF
DOCAPPROVAL
DOCUPLOAD
However, if any of your processes still use these workflow applications, you can keep them declared under the WorkflowGen website as in version 5.
Third-party software and licenses
The following software is distributed with WorkflowGen (Apache 2.0, BSD, MIT, and other compatible licenses):
bluebird (see )
busboy (see )
body-parser (see )
change-case (see
✏️ Note: We recommend limiting the file content size to small files under 1 megabyte.
jQuery Validation v1.11.1 → 1.19.3
Define or update the following nodes in the web form’s web.config:
If your web form’s authentication is configured to use the built-in WorkflowGen authentication mode, then the new password hashing mode (One-way Hashing) introduced in version 6.1 will not be compatible with your web form. There are two solutions:
Use Version 5 password management mode instead. Make sure to use the Advantys.My.dll and Advantys.Security.dll files from version 5.x in the web form’s \bin folder.
OR
Migrate your web form to .NET 4. Make sure to use the Advantys.My.dll and Advantys.Security.dll files from WorkflowGen version 8.x in the in the web form’s \bin folder. For instructions on how to do this, see the next section.
If your web form’s authentication mode is configured with the built-in WorkflowGen authentication, then make sure to use the Advantys.My.dll and Advantys.Security.dll files from version 8.x.x or later in the web form’s \bin folder.
It's important to clear your browser cache before connecting to the upgraded WorkflowGen website. This will remove the CSS, JavaScript, and image files used in previous versions of WorkflowGen.
Web app addresses
Use the following URLs with the wfgen_admin user account:
If you have the former Remote Approval module configured, you can keep using it, but if you want to migrate to the new integrated feature, you must perform the following steps.
Uninstall the Remote Approval module (it's recommended that you make a backup of all previous Remote Approval files and folders beforehand):
Open the Windows Services list and stop the Remote Approval service, usually named WorkflowGen RemoteApproval or WorkflowGen EmailListener.
Delete the DRIVE:\Program Files (x86)\Advantys\WorkflowGen\RemApp\ folder.
In \wfgen\App_Data\CustomMenus\admin.xml, remove the Remote Approval menuItem node (you can delete the file entirely if it contains only this node).
Check Activate on the Remote Approval tab in the Administration Module Configuration panel.
Verify your Remote Approval settings, which should be the same as in the former module, since they're inherited with the WorkflowGen upgrade.
Remote Approval no longer requires WorkflowGen application-specific credentials, since it now uses the WorkflowGen Engine service.
Disable and remove workflow applications in IIS
The following workflow applications have been integrated as built-in or assembly applications. The corresponding web applications can be disabled and removed in IIS and file system folders since they're no longer used.
To create a clean WorkflowGen database, you must use the full WorkflowGen manual installation pack, which is available at .
Preparation
Overview
You must be administrator of the web server. You must know:
The physical path on the web server where WorkflowGen web application is installed.
The physical path on the web server where WorkflowGen Windows Services are installed.
The URL of the web server where WorkflowGen is installed.
MS SQL Server database:
The name of the MS SQL server.
The credentials of the SA account.
The file path of the SQL server database files on the SQL server machine.
You'll need to perform the following actions:
Update the web application files.
Update the Windows Services files.
Update the web configuration file.
Update the Directory Synchronization and Engine Service files, and move the XMLTODATABASE transaction file.
Update the database structure and contents.
Request new license files and serial numbers
If you're upgrading from WorkflowGen version 5, you must request a new license (trial, unlimited, or per user) and a new serial number for each of your WorkflowGen servers.
The new license file must be copied to the \wfgen\bin folder.
Define the new serial number in the \wfgen\web.config file (e.g. <add key="ApplicationSerialNumber" value="WFG-ENT-XXXXX-XXXXX-XXXX-XXXX" />).
Be sure to back up your previous license file and serial number.
Delete the \wfgen\bin\RemoteApprovalConfig.dll and \wfgen\admin\RemoteApprovalConfig.aspx files.
Whenever you change the Remote Approval refresh interval, you must restart the WorkflowGen Engine service for the new settings to take effect.
Optional: Remove the following web.config settings, which are no longer used as of WorkflowGen 7.3.0 (you should make a backup of the existing web.config file beforehand):
The upgrade pack is distributed as a compressed file containing the following folders:
Inetpub: WorkflowGen web application files
Program Files: WorkflowGen Windows Services files
Databases
IIS server
Stop the IIS server (or at least your WorkflowGen web applications) if other websites are using the same IIS server.
WorkflowGen Windows Services
Stop the WorkflowGen Directory Sync and Engine services in the Windows Services Management Console.
Backup
Application and data files
Back up the following folders:
DRIVE:\Inetpub\wwwroot\wfgen
DRIVE:\Program Files\Advantys\WorkflowGen
If the file storage path isn't the standard DRIVE:\Inetpub\wwwroot\wfgen\App_Data path, then you have to back up the corresponding folder.
Database
Perform a standard database backup using your DBMS tools.
Update WorkflowGen web application files
Delete deprecated Node.js application files and folders
Verify if the following deprecated files and folders used by Node.js-based applications still exist in your \wfgen folder, and delete them if they do.
Delete the following files and folders from the \wfgen\graphql folder:
\controllers
\models
Delete deprecated assembly files
Delete the following deprecated assembly .dll files from the \wfgen\bin, \wfgen\ws\bin, and \Program Files\Advantys\WorkflowGen\services\bin folders:
Advantys.Directories
Advantys.Directories.Web.UI.Administration
Advantys.Web.UI.Charting
Copy the upgrade pack content
Copy and overwrite the upgrade content from Update\Inetpub\wwwroot\wfgen to your WorkflowGen web application folder. By default, the suggested physical path is DRIVE:\Inetpub\wwwroot\wfgen.
Domain users and the Windows accounts used to run the WorkflowGen IIS application pool and Engine service must have read and write permissions for the \wfgen\App_Data folder.
Do NOT copy and overwrite your existing DRIVE:\Inetpub\wwwroot\wfgen\web.config
Update WorkflowGen Windows Services files
Delete deprecated DLL file
Delete the deprecated DRIVE:\Program Files\Advantys\WorkflowGen\Services\bin\EAGetMail40.dll file.
Overwrite the WorkflowGen Windows Services folder
Overwrite the contents of your WorkflowGen Windows Services folder with the contents of Update\Program Files\Advantys\WorkflowGen. By default, the suggested physical path is DRIVE:\Program Files\Advantys\WorkflowGen.
Do NOT copy and overwrite your existing DRIVE:\Program Files\Advantys\WorkflowGen\Services\bin\*.config files.
Update Node.js program files
Copy node.exe.config and trace.config (located in Update\Program Files\nodejs) to DRIVE:\Program Files\nodejs.
If there's already a node.exe.config file in the DRIVE:\Program Files\nodejs folder, do not overwrite it. Instead, add the following to the existing file's <configuration> node:
Update configuration files
This section contains configuration parameter changes you need to apply, based on the version of WorkflowGen from which you're upgrading.
This section has been divided to provide a quicker reference for clients upgrading from versions 8.0.0 and later. If you're upgrading from version 7.22.15 or earlier, see the section and perform the required modifications to the configuration files based on the version from which you're upgrading, then return to this section and continue with the rest of the required modifications.
đź“Ś Examples
When upgrading to version 9.2.6 from version 9.0.1 Beta, apply the changes in the When upgrading from version 9.0.1 Beta (v9 Beta 2) and earlier, When upgrading from version 9.0.2 Beta (v9 Beta 3), When upgrading from version 9.0.7 and earlier, and When upgrading from version 9.1.0 and earlier sections.
When upgrading to version 9.2.6 from version 9.2.5, there are no changes to make to the web configuration file.
When upgrading from version 8.0.0 and earlier
Add the following new parameters to <appSettings>:
Remove the following deprecated parameter from <appSettings>:
When upgrading from version 8.0.1 and earlier
Add the following new parameters to <appSettings>:
When upgrading from version 8.0.2 and earlier
Add the following new parameters to <appSettings>:
When upgrading from version 8.0.7 and earlier
Add the following new parameter to <appSettings> :
Update the value of the EngineServiceTimeoutSystemActionFrequency parameter to 120000 as follows:
When upgrading from version 8.0.10 and earlier
Add the following new parameter to <appSettings> :
When upgrading from version 8.1.0 Beta and earlier
Update the value of the following parameter in <appSettings>:
Remove the following parameters from <appSettings> from version 8.1.0 Beta only:
When upgrading from version 8.1.2 and earlier
Add the following new parameters to <appSettings> :
When upgrading from version 8.1.3 and earlier
Add the following new parameters to <appSettings>:
Update the bindingRedirect node in all of the affected configuration files (listed below) from <bindingRedirect oldVersion="0.0.0.0-12.0.0.0" newVersion="12.0.0.0" /> to <bindingRedirect oldVersion="0.0.0.0-13.0.0.0" newVersion="13.0.0.0" />
When upgrading from version 8.2.4 and earlier
Add the following new parameter to <appSettings>:
Update the value of the following parameter in <appSettings>:
When upgrading from version 8.2.4 and earlier OR from version 9.0.0 Beta (v9 Beta 1)
Add the following new parameters to <appSettings>:
When upgrading from version 9.0.1 Beta (v9 Beta 2) and earlier
Add the following new parameters to <appSettings>:
When upgrading from version 9.0.2 Beta (v9 Beta 3) and earlier
Add the following new parameter to <appSettings>:
When upgrading from version 9.0.7 and earlier
Rename the following parameters in <appSettings>:
as
Add the following new parameter to <appSettings>:
When upgrading from version 9.1.0 and earlier
If you want to enable default HTTP error handling by WorkflowGen, replace the following parameter in <appSettings>:
with the following:
Update the root web configuration file
This step is mandatory when upgrading to version 9.2.2 (9.2 Beta 3) or later, including if you're upgrading from version 9.2.0 (9.2 Beta 1) or 9.2.1 (9.2 Beta 2) and previously updated the root web.config file when you upgraded to that version.
You must update your site's root web.config file with the new URL Rewrite rules.
First, make sure the tool is installed on your WorkflowGen server.
There are two sample files provided in the installation pack.
If your WorkflowGen site uses the /wfgen path in its URL (e.g. https://yoursite/wfgen), refer to the Inetpub\wwwroot\web.config (in the manual installation pack) or Inetpub\wwwroot\web.config.sample sample file (in the update pack) for the new rules.
If your WorkflowGen site does NOT use the /wfgen path in its URL (e.g. https://yoursite
Update the login.aspx sample file (custom authentication only)
As of WorkflowGen 9.2.0, If you're using custom form authentication with a login page created based on the provided /wfgen/login.aspx sample template, you need to update the login page file. To do this:
Open your WorkflowGen site's /wfgen/login.aspx file (which might have been renamed).
Replace the redirectToUrl = "/wfgen/show.aspx?QUERY=WELCOME"; line with redirectToUrl = "/wfgen/dashboard";.
Update Form Designer webforms for versions 8 and later
As of WorkflowGen version 8, the WorkflowGen.My.Web.UI.WebControls.dll assembly has been merged into WorkflowGen.My.dll. This breaking change impacts webforms created in the Form Designer and the webforms' \bin folders, so you must perform one of the following procedures:
Method 1: Use the provided PowerShell script
Run the \update\configuration\update-webforms-wfg-my-assembly.ps1 script in PowerShell inside the \wfgen\wfapps\webforms\ folder. This will automatically update your ASPX webforms and delete deprecated files and folders.
This script requires PowerShell version 7.0 or later.
It will update all .aspx files located in the \webforms folder, including those not managed by the Form Designer. If you have custom webforms in this folder that use another version of WorkflowGen.My.dll, then you should skip the changes to these .aspx files. You can do this by moving these files to a temporary folder before running the script, and then copying them back to the original folder.
đź“Ś Usage example
Method 2: Manually
Delete the following files and folders from the\wfgen\wfapps\webforms\bin\ folder:
WorkflowGen.My.Web.UI.WebControls.dll
WorkflowGen.My.Web.Handlers.dll
Update the GraphQL and webhooks configuration files
In the \wfgen\graphql\web.config and \wfgen\hooks\web.config files, add the following to <system.webServer>:
Upgrade the WorkflowGen database
Run the SQL scripts listed below in order, starting with your current version of WorkflowGen.
This section has been divided to provide a quicker reference for clients upgrading from version 8.0.0 and later. If you're upgrading from version 7.22.15 or earlier, see the section and run the required database update scripts based on the version from which you're upgrading, then return to this section and continue with the rest of the required scripts.
Oracle database is no longer supported as of WorkflowGen 7.16.0.
For versions 8.0.1 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V8-0-2.sql database update script in your SQL Server Management Studio tool.
For versions 8.0.2 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V8-0-3.sql database update script in your SQL Server Management Studio tool.
For versions 8.0.x and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V8-1-0.sql database update script in your SQL Server Management Studio tool.
For versions 8.1.3 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V8-2-0.sql database update script in your SQL Server Management Studio tool.
For versions 8.2.4 and earlier or version 9.0.0 Beta (v9 Beta 1)
Launch the Update\Databases\MsSQLServer\Update_WFG-V9-0-1.sql database update script in your SQL Server Management Studio tool.
For versions 9.0.1 Beta (v9 Beta 2) and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V9-0-2.sql database update script in your SQL Server Management Studio tool.
For versions 9.0.2 Beta (v9 Beta 3) and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V9-0-3.sql database update script in your SQL Server Management Studio tool.
For versions 9.0.7 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V9-1-0.sql database update script in your SQL Server Management Studio tool.
For versions 9.2.5 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V9-2-6.sql database update script in your SQL Server Management Studio tool.
Configure IIS
Domain users and the Windows accounts used to run the WorkflowGen IIS application pool and Engine service must have read and write permissions for the \wfgen\app_data folder.
Update or create the application pool in .NET 4
The WorkflowGen website and web applications must now use an application pool in .NET 4. If this hasn't already been configured, do the following:
Install .NET Framework 4 on the server, if it's not already installed.
Update the existing application pool or create a new application pool using .NET Framework 4 for:
the WorkflowGen website
WorkflowGen Node.js-based web applications
To use the GraphQL, incoming webhooks, OpenID Connect Auth, and SCIM APIs, you must first install the following requirements:
Delete each Node.js-based application's node_modules folder (located under \wfgen\auth, \wfgen\graphql, \wfgen\hooks, and \wfgen\scim) before copying the files from the upgrade pack.
To enable WorkflowGen GraphQL:
In IIS, convert /wfgen/graphql to an application with a .NET 4 application pool (integrated pipeline).
Configure the GraphQL application authentication mode:
For Basic authentication: Enable Basic authentication.
To enable WorkflowGen incoming webhooks:
Update the WorkflowGen web.config file with the following parameters used by incoming webhooks:
In IIS, convert /wfgen/hooks to an application with a .NET 4 application pool (integrated pipeline), and configure the hook application in Anonymous authentication mode.
If your WorkflowGen is configured to use WorkflowGen Applicative authentication or a custom authentication, you must remove the authentication module from the /hooks/web.config file as follows:
For WorkflowGen Applicative authentication:
For Custom authentication:
To enable WorkflowGen SCIM:
In IIS, convert /wfgen/scim to an application with a .NET 4 application pool (integrated pipeline), and configure the application in Anonymous authentication mode.
If your WorkflowGen is configured to use WorkflowGen Applicative authentication or a custom authentication, you must remove the authentication module from the /scim/web.config file as follows:
For WorkflowGen Applicative authentication:
For Custom authentication:
To enable WorkflowGen OpenID Connect Auth:
In IIS, convert /wfgen/auth to an application with a .NET 4 application pool (integrated pipeline), and configure the application in Anonymous authentication mode.
If your WorkflowGen is configured to use WorkflowGen Applicative authentication or a custom authentication, you must remove the authentication module from the \auth\web.config file as follows:
For WorkflowGen Applicative authentication:
For Custom authentication:
Restart the WorkflowGen server
Reboot your WorkflowGen web server.
New location of workflow application temporary and log files
The following workflow applications store their files in these new locations:
Delete the following files and folders from the \wfgen\hooks folder:
\controllers
\models
\node_modules
\services
\test
\utils
config.js
config.production.js
server.js
upload.js
Delete the following files and folders from the \wfgen\auth folder:
\controllers
\models
\node_modules
\static
\utils
config.js
config.production.js
server.js
Delete the following files and folders from the \wfgen\scim folder:
\controllers
\models
\node_modules
\services
\utils
config.js
config.production.js
server.js
Advantys.Workflow.Applications.ExecSql
Advantys.Workflow.Applications.GetUsersFromDir
Advantys.Workflow.Applications.MergeForm
Advantys.Workflow.Applications.RestApiClient
Advantys.Workflow.Applications.SendMessage
Advantys.Workflow.Applications.XmlToDatabase
Advantys.Workflow.Applications.XmlTrans
Advantys.Workflow.Reports
Advantys.Workflow.Web.UI.Reports
file if you want to keep your current WorkflowGen configuration settings and database connection information.
It’s possible that the following default CSS files have been updated in this release and could overwrite any changes you had made in your existing installation:
\wfgen\App_Themes\Default\portal\css\Default.css
\wfgen\App_Themes\Default\admin\css\Default.css
If you've made changes to any of the default files in the following folders (e.g. *.aspx, *.css, *.resx files), make a backup of the existing files prior to the upgrade and manually re-apply these changes to the corresponding version 9.x.x files:
Remove the following deprecated parameters from <appSettings>:
), refer to the
Inetpub\wwwroot\web.config.without-wfgen
sample file for the new rules.
\de
\fr
\hu
\pl
Upgrade each of your webforms created in the Form Designer, either by re-saving them or by manually replacing the <%@ Register Assembly="WorkflowGen.My.Web.UI.WebControls" ... %> tag with <%@ Register Assembly="WorkflowGen.My" ... %> inside each of your .aspx files.
\wfgen
\wfgen\wfapps\webforms (create this IIS web application if it isn’t already created)
\wfgen\ws
If your application pool is set to use Classic Managed Pipeline Mode, make sure ASP.NET v4.0.30319 is set to Allowed in the IIS manager ISAPI and CGI Restrictions list.
Visual C++ Redistributable
✏️ Note: This library is required if you encounter the error The specified module could not be found regarding the edge and edge-js libraries when accessing the /wfgen/graphql, /wfgen/hooks, or /wfgen/scim web apps.
After enabling GraphQL, incoming webhooks, OpenID Connect Auth, or SCIM, the WorkflowGen DLLs will be in use by Node.js, so they'll be locked from being updated. In order to update the DLLs, it's necessary to stop IIS.
For WorkflowGen Applicative authentication:
Make sure the /wfgen web application already has WorkflowGen Applicative authentication enabled.
Enable Anonymous authentication.
Update the WorkflowGen web.config file with the following parameters used by GraphQL:
This section contains instructions for clients upgrading from versions 7.22.15 and earlier. Follow the instructions in this section, then return to the main upgrade section to complete the procedure.
Update configuration files
Apply the changes to the web configuration file based on the version from which you're upgrading. Once you've applied these changes, return to the section in the main upgrade section and continue with the changes there.
đź“Ś Examples
When upgrading from version 6.5.0, apply the changes in the When upgrading from version 6.5.0 section to the When upgrading from all 7.x.x versions and earlier section.
When upgrading from version 7.22.1, apply the changes in the When upgrading from all 7.x.x versions and earlier section only.
When upgrading from version 5.7.4 and earlier
Check the following parameters in your \wfgen\web.config and add them if they aren't already there.
WorkflowGen.My and WorkflowGen.My.Web.UI.WebControls (WorkflowFileUpload) version 3.0 or later are required in all your Visual Studio Web Forms if the ApplicationSecurityEnableWebAppsSecureMode security feature is enabled. For more information, see the WorkflowGen Knowledge Base article.
The first number in the PortalFrameSetHeight value is the height of the banner. If your website is configured to display a banner, enter its height in pixels here. The other default values should not be changed.
You can copy the ProcessesRunTimeWebServiceAllowedUsers parameter from your existing \wfgen\ws\web.config to \wfgen\web.config.
You can copy this parameter from your existing \wfgen\WfApps\WebApps\eFormASPX\web.config to \wfgen\web.config.
You can copy this parameter from your existing \wfgen\WfApps\WebServices\GetUsersFromDir\web.config to \wfgen\web.config.
You can copy these parameters from your existing \wfgen\WfApps\WebServices\XmlToDatabase\web.config to \wfgen\web.config.
You can copy these parameters from your existing \wfgen\WfApps\WebServices\XmlTrans\web.config to \wfgen\web.config.
Remove the following deprecated parameters from <appSettings>:
Define the following nodes in <configuration>:
Define or update the following node in <configuration>/<system.web>:
When upgrading from version 6.0.0 and earlier
Add the following new parameters to <appSettings>:
Replace the ApplicationSmtpPickupDirectory path above with the path of your SMTP gateway pickup folder.
The ApplicationSmtpDeliveryMethod parameter defines the notification delivery method. By default, it uses the SMTP server, but you can change the SMTP delivery method to Pickup directory in the Administration Module Configuration Panel.
When upgrading from version 6.1.0 and earlier
Add the following new parameter to <appSettings>:
When upgrading from version 6.1.4 and earlier
Add or modify the AdministrationFormDataProviderName parameter as follows:
The Oracle.DataAccess.Client value was added to this parameter in version 6.1.5.
When upgrading from version 6.1.6 and earlier
Add the following new parameters to <appSettings>:
When upgrading from version 6.4.0 and earlier
Add the following new parameters to <appSettings>:
When upgrading from version 6.5.0 and earlier
Add the following new parameter to <appSettings> to configure the SENDHTTPPOST workflow application log file, replacing the value n with 0 to disable logging, 1 for simple logs, or 2 for debug logs:
When upgrading from version 6.6.0 and earlier
Remove the following deprecated parameters from <appSettings>:
When upgrading from version 7.1.1 and earlier
Add the following new parameters to <appSettings>:
When upgrading from version 7.3.1 and earlier
Add the following new parameter to <appSettings>:
When upgrading from version 7.6.0 and earlier
Add the following new parameters to <appSettings>:
When upgrading from version 7.9.1 and earlier
Add the following new parameters to <appSettings>:
If you're using folders for GraphQL and/or incoming webhooks file operations (such as sending a file action parameter), you must update the values of the GraphqlInputFileAllowedFolders and HooksInputFileAllowedFolders parameters. See the and sections in the for more information.
When upgrading from version 7.14.3 and earlier
Add the following new parameter to <appSettings>:
When upgrading from version 7.14.8 and earlier
Add the following new parameters to <appSettings>:
If you're using HTTP URLs for GraphQL and/or incoming webhooks file operations (such as sending a file action parameter), you must update the values of the GraphqlInputFileAllowedHttpUrls and HooksInputFileAllowedHttpUrls parameters. See the and sections in the for more information.
Remove the following deprecated parameters from <appSettings>:
When upgrading from version 7.15.2 and earlier
Add the following nodes after the existing <location> nodes in \wfgen\web.config:
Remove the node below from \wfgen\auth\web.config, \wfgen\hooks\web.config, and \wfgen\scim\web.config, if present:
When upgrading from version 7.15.4 and earlier
Add the following new parameter to <appSettings>:
As of version 7.15.5, the optional BACKURL_SUBMIT and BACKURL_CANCEL HTTP parameters used in custom WorkflowGen URLs (for example, ) ONLY support absolute URLs (starting with http:// or https://), relative URLs (starting with /), or URLs defined in the PortalRedirectAllowedHttpUrls configuration parameter (e.g. value='blank.htm, myPage.htm').
When upgrading from version 7.15.5 and earlier
Add the following node after the existing <location> nodes in \wfgen\web.config:
Change the default value of RestApiClientRequestTimeout from 3000 to 30000 milliseconds.
When upgrading from version 7.16.5 and earlier
Add the following new parameters to <appSettings>:
When upgrading from version 7.18.1 and earlier
Add the following new parameter to <appSettings>:
When upgrading from version 7.18.2 and earlier
Add the following new parameter to <appSettings>:
When upgrading from version 7.20.0 and earlier
Add the following new parameters to <appSettings>:
When upgrading from version 7.21.0 and earlier
Add the following new parameter to <appSettings>:
As of WorkflowGen 7.22.0, the log level values for the existing GETUSERSFROMDIR, MERGEFORM, SENDHTTPPOST, and RESTAPICLIENT workflow applications have changed to 0 for no logs (default), 2 for information, and 3 for debugging. You can set (or reset) the log levels by updating the values of the following parameters accordingly:
When upgrading from version 7.22.0 and earlier
Remove the existing Access-Control-Allow-* custom header nodes from location path="graphql" (as shown below), since they are deprecated as of version 7.22.1:
If you want to configure CORS to allow GraphQL API access from a third-party application, you must now follow the instructions in the section in the .
When upgrading from all 7.x.x versions and earlier
Add the following new parameters to <appSettings>:
Remove the following parameters from <appSettings>:
Upgrade the WorkflowGen database
Run the SQL scripts listed below in order, starting with your current version of WorkflowGen, then continue running the scripts in the section in the main upgrade chapter.
Oracle database is no longer supported as of WorkflowGen 7.16.0.
MS SQL Server
For versions 5.1.9 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-2-0.sql database update script in your SQL Server Management Studio tool.
For versions 5.2.x and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-3-0.sql database update script in your SQL Server Management Studio tool.
For versions 5.3.x, 5.4.0 (alpha, beta 1 and beta 2) and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-4-0.sql database update script in your SQL Server Management Studio tool.
For versions 5.4.x official and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-5-0.sql database update script in your SQL Server Management Studio tool.
For versions 5.5.0 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-5-1.sqldatabase update script in your SQL Server Management Studio tool.
For versions 5.5.1 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-5-2.sql database update script in your SQL Server Management Studio tool.
For versions 5.5.4 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-5-5.sql database update script in your SQL Server Management Studio tool.
For versions 5.5.5 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-6-0.sql database update script in your SQL Server Management Studio tool.
For versions 5.6.1 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-6-2.sql database update script in your SQL Server Management Studio tool.
For versions 5.6.2 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-6-3.sql database update script in your SQL Server Management Studio tool.
For versions 5.6.3 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-6-4.sql database update script in your SQL Server Management Studio tool.
For versions 5.7.0 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-7-1.sql database update script in your SQL Server Management Studio tool.
For versions 5.7.1 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-7-2.sql database update script in your SQL Server Management Studio tool.
For versions 5.7.4 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V6-0-0.sql database update script in your SQL Server Management Studio tool.
For versions 6.0.0 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V6-1-0.sql database update script in your SQL Server Management Studio tool.
For versions 6.1.2 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V6-1-3.sql database update script in your SQL Server Management Studio tool.
For versions 6.1.3 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V6-1-4.sql database update script in your SQL Server Management Studio tool.
For versions 6.1.6 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V6-2-0.sql database update script in your SQL Server Management Studio tool.
For versions 6.4.0 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V6-5-0.sql database update script in your SQL Server Management Studio tool.
For versions 6.5.0 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V6-6-0.sql database update script in your SQL Server Management Studio tool.
For versions 6.6.0 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-0-0.sql database update script in your SQL Server Management Studio tool.
For versions 7.1.0 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-1-1.sql database update script in your SQL Server Management Studio tool.
For versions 7.1.1 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-2-0.sql database update script in your SQL Server Management Studio tool.
For versions 7.2.1 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-3-0.sql database update script in your SQL Server Management Studio tool.
For versions 7.5.1 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-6-0.sql database update script in your SQL Server Management Studio tool.
For versions 7.9.1 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-10-0.sql database update script in your SQL Server Management Studio tool.
For versions 7.10.0 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-11-0.sql database update script in your SQL Server Management Studio tool.
For versions 7.11.2 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-12-0.sql database update script in your SQL Server Management Studio tool.
For versions 7.12.2 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-13-0.sql database update script in your SQL Server Management Studio tool.
For versions 7.13.1 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-14-0.sql database update script in your SQL Server Management Studio tool.
For versions 7.14.7 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-15-0.sql database update script in your SQL Server Management Studio tool.
For versions 7.15.1 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-15-2.sql database update script in your SQL Server Management Studio tool.
For versions 7.15.5 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-16-0.sql database update script in your SQL Server Management Studio tool.
For versions 7.16.5 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-17-0.sql database update script in your SQL Server Management Studio tool.
For versions 7.21.0 and earlier
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-22-0.sql database update script in your SQL Server Management Studio tool.
For all 7.x.x and earlier versions
Launch the Update\Databases\MsSQLServer\Update_WFG-V8-0-0.sql database update script in your SQL Server Management Studio tool.
Update the Directory Synchronization configuration file
A new configuration parameter is required when upgrading from version 5.1.5 and earlier. This parameter allows you to provide a unique service name to the WorkflowGen Directory Synchronization service should you have multiple instances of WorkflowGen installed on a single server.
Add the following parameter to DRIVE:\Program Files\Advantys\WorkflowGen\Services\bin\WfgDirectoriesSyncService.exe.config:
Update the WorkflowGen Engine Service configuration file
A new configuration parameter is required when upgrading from version 5.1.5 or earlier. This parameter allows you to provide a unique service name to the WorkflowGen Engine service should you have multiple instances of WorkflowGen installed on a single server.
Add the following parameter to DRIVE:\Program Files\Advantys\WorkflowGen\Services\bin\WfgWorkflowEngineService.exe.config:
Move the XMLTODATABASE transactions file
If you're upgrading from version 5.7.4 or earlier, copy the Transactions.xml file from \wfgen\WfApps\WebServices\XmlToDatabase\App_Data to \wfgen\App_Data\Files\XmlToDatabase.
Remove the xmlns attribute
As of WorkflowGen version 7, you must remove the xmlns attribute from these configuration files:
To do this, change <configuration xmlns="http://schemas.microsoft.com/.NetConfiguration/v2.0"> to <configuration>.
Make the following modifications to each Node.js component's web.config file (located in \wfgen\graphql, \wfgen\hooks, \wfgen\scim, and \wfgen\auth):
Change the iisnode handler path from server.js to dist/server.js.
Change the rewrite rule url property from server.js to dist/server.js.
It should look as follows:
Add the following to the <configuration> node:
Add targetFramework="4.8" to the three web apps' httpRuntime nodes: