WorkflowGen 9.1.1 Upgrade
Last updated
Last updated
The following procedures apply to the WorkflowGen 9.1.1 upgrade pack, available at .
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
: WorkflowGen database update and creation files
Stop the IIS server (or at least your WorkflowGen web applications) if other websites are using the same IIS server.
Stop the WorkflowGen Directory Sync and Engine services in the Windows Services Management Console.
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.
Perform a standard database backup using your DBMS tools.
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
\node_modules
\services
\utils
config.js
config.production.js
server.js
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
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
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
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
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:
\wfgen
\wfgen\App_Themes
\wfgen\App_Data\Templates\Emails
\wfgen\App_Data\Templates\Forms
\wfgen\App_Data\Templates\Processes
Delete the deprecated DRIVE:\Program Files\Advantys\WorkflowGen\Services\bin\EAGetMail40.dll
file.
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.
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:
This section contains configuration parameter changes you need to apply, based on the version of WorkflowGen from which you're upgrading.
When upgrading to version 9.1.1 from version 8.2.3, apply the changes in the When upgrading from version 8.2.4 and earlier, When upgrading from version 8.2.4 and earlier OR from version 9.0.0 Beta (v9 Beta 1), When upgrading from version 9.0.1 Beta (v9 Beta 2) and earlier, When upgrading from version 9.0.2 Beta (v9 Beta 3), and When upgrading from version 9.0.7 and earlier sections.
When upgrading to version 9.1.1 from version 9.0.6, apply the changes in the When upgrading from version 9.0.7 and earlier section only.
Check the following parameters in your \wfgen\web.config
and add them if they aren't already there.
Remove the following deprecated parameters from <appSettings>
:
Define the following nodes in <configuration>
:
Define or update the following node in <configuration>/<system.web>
:
Add the following new parameters to <appSettings>
:
Add the following new parameter to <appSettings>
:
Add or modify the AdministrationFormDataProviderName
parameter as follows:
Add the following new parameters to <appSettings>
:
Add the following new parameters to <appSettings>
:
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:
Remove the following deprecated parameters from <appSettings>
:
Add the following new parameters to <appSettings>
:
Add the following new parameter to <appSettings>
:
Add the following new parameters to <appSettings>
:
Add the following new parameters to <appSettings>
:
Add the following new parameter to <appSettings>
:
Add the following new parameters to <appSettings>
:
Remove the following deprecated parameters from <appSettings>
:
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:
Add the following new parameter to <appSettings>
:
Add the following node after the existing <location>
nodes in \wfgen\web.config
:
Change the default value of RestApiClientRequestTimeout
from 3000
to 30000
milliseconds.
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 new parameters to <appSettings>
:
Add the following new parameter to <appSettings>
:
Add the following new parameter to <appSettings>
:
Add the following new parameters to <appSettings>
:
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:
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:
Add the following new parameters to <appSettings>
:
Remove the following parameters from <appSettings>
:
Add the following to the <configuration>
node:
Add targetFramework="4.8"
to the three web apps' httpRuntime
nodes:
Add the following to the <configuration>
node in \Inetpub\wwwroot\wfgen\ws\web.config
:
Add the following to <configuration>
node in \Program Files\Advantys\WorkflowGen\Services\bin\WfgDirectoriesSyncService.exe.config
:
Add the following to the <configuration>
node in \Program Files\Advantys\WorkflowGen\Services\bin\WfgWorkflowEngineService.exe.config
:
Add the following new parameters to <appSettings>
:
Remove the following deprecated parameter from <appSettings>
:
Add the following new parameters to <appSettings>
:
Add the following new parameters to <appSettings>
:
Add the following new parameter to <appSettings>
:
Update the value of the EngineServiceTimeoutSystemActionFrequency
parameter to 120000
as follows:
Add the following new parameter to <appSettings>
:
Update the value of the following parameter in <appSettings>
:
Remove the following parameters from <appSettings>
from version 8.1.0 Beta only:
Add the following new parameters to <appSettings>
:
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" />
:
\wfgen\web.config
\wfgen\ws\web.config
\Program Files\Advantys\WorkflowGen\Services\bin\WfgWorkflowEngineService.exe.config
\Program Files\nodejs\node.exe.config
Add the following new parameter to <appSettings>
:
Update the value of the following parameter in <appSettings>
:
Remove the following deprecated parameters from <appSettings>
:
Add the following new parameters to <appSettings>
:
Add the following new parameters to <appSettings>
:
Add the following new parameter to <appSettings>
:
Rename the following parameters in <appSettings>
:
as
Add the following new parameter to <appSettings>
:
xmlns
attributeAs 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>
.
wfgen
web appAs of WorkflowGen 7.22.0, you should configure your WorkflowGen root website (e.g. https://server
) to auto-redirect to the https://server/wfgen
web app. To do this, follow the procedure below:
Create or update the web.config
file in your website's root folder (e.g. DRIVE:\inetpub\wwwroot\web.config
).
⚠️ Warning: This is not the same web.config
file as the main WorkflowGen web.config
file (located in DRIVE:\inetpub\wwwroot\wfgen\web.config
).
Define the rewrite rule node as shown below (configuration
/ system.webServer
/ <rewrite>
/ <rules>
/ <rule>
):
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:
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.
Delete the following files and folders from the\wfgen\wfapps\webforms\bin\
folder:
WorkflowGen.My.Web.UI.WebControls.dll
WorkflowGen.My.Web.Handlers.dll
\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.
In the \wfgen\graphql\web.config
and \wfgen\hooks\web.config
files, add the following to <system.webServer>
:
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
:
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
:
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
.
Run the SQL scripts listed below in order, starting with your current version of WorkflowGen.
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-2-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-3-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-4-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-5-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-5-1.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-5-2.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-5-5.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-6-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-6-2.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-6-3.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-6-4.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-7-1.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V5-7-2.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V6-0-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V6-1-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V6-1-3.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V6-1-4.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V6-2-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V6-5-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V6-6-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-0-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-1-1.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-2-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-3-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-6-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-10-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-11-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-12-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-13-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-14-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-15-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-15-2.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-16-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-17-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V7-22-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V8-0-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V8-0-2.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V8-0-3.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V8-1-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V8-2-0.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V9-0-1.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V9-0-2.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V9-0-3.sql
database update script in your SQL Server Management Studio tool.
Launch the Update\Databases\MsSQLServer\Update_WFG-V9-1-0.sql
database update script in your SQL Server Management Studio tool.
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.
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
\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.
To use the GraphQL, incoming webhooks, OpenID Connect Auth, and SCIM APIs, you must first install the following requirements:
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.
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:
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.
In IIS, convert /wfgen/scim
to an application with a .NET 4 application pool (integrated pipeline), and configure the application in Anonymous authentication mode.
In IIS, convert /wfgen/auth
to an application with a .NET 4 application pool (integrated pipeline), and configure the application in Anonymous authentication mode.
Reboot your WorkflowGen web server.
The following workflow applications store their files in these new locations:
EFORMASPX: \wfgen\App_Data\Files\EFormAspx
XMLTODATABASE: \wfgen\App_Data\LogFiles\XmlToDatabase
XMLTRANS: \wfgen\App_Data\Files\XmlTrans
and \wfgen\App_Data\LogFiles\XmlTrans
You must remove the xmlns
attribute from the web configuration file regardless of the version from which you're upgrading. See for instructions on how to do this.
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.
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.
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.
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'
).
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 .
Make sure the tool is installed on your WorkflowGen server.
✏️ 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.