Overview

The following procedures apply to the WorkflowGen 7.22.5 upgrade pack, available at https://github.com/advantys/workflowgen-releases/releases.

Package contents

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

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 is not the standard DRIVE:\Inetpub\wwwroot\wfgen\App_Data 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 these deprecated files and folders used by Node.js-based applications still exist in your \wfgen folder and delete them if they do.

1. Delete the following files and folders from the \wfgen\graphql folder:

   • \controllers

   • \models

   • \node_modules

   • \services

   • \utils

   • config.js

   • config.production.js

   • server.js

2. 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

3. Delete the following files and folders from the \wfgen\auth folder:

   • \controllers

   • \models

   • \node_modules

   • \static

   • \utils

   • config.js

   • config.production.js

   • server.js

4. Delete the following files and folders from the \wfgen\scim folder:

   • \controllers

   • \models

   • \node_modules

   • \services

   • \utils

   • config.js

   • config.production.js

   • server.js

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.

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.

Update the web configuration file

This section contains configuration parameter changes to be applied based on the version of WorkflowGen from which you are upgrading. For example:

• When upgrading to version 7.22.5 from version 7.19.0, apply the changes in the When upgrading from version 7.20.0 and earlier, When upgrading from version 7.21.0 and earlier, When upgrading from version 7.22.0 and earlier, and When upgrading from version 7.22.4 and earlier sections.

• When upgrading to version 7.22.5 from version 7.22.4, apply the changes in the When upgrading from version 7.22.4 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 are not already there.

<add key="EngineEnableSelfServiceDataAssignException" value="N" />
<add key="EngineNotificationDefaultReplyTo" value="" />
<add key="EngineNotificationMaxFileAttSize" value="10" />
<add key="EngineNotificationTextDetection" value="Y" />
<add key="EngineNotificationServerTimeout" value="3" />
<add key="ApplicationDistributedDatabaseSourceMode" value="0" />
<add key="ApplicationEnableDistributedDatabaseSource" value="N" />
<add key="ApplicationEnableArchiveSiteRedirectConfirmation" value="Y" />
<add key="ApplicationArchiveSiteUrl" value="" />
<add key="ApplicationShowAssociatedDataWithEmptyValue" value="Y" />
<add key="ApplicationSecurityEnableWebAppsSecureMode" value="N" />

<add key="PortalEnableComments" value="Y" />
<add key="PortalCommentsRefreshFrequency" value="30000" />
<add key="PortalCommentsPopUpWidth" value="376" />
<add key="PortalCommentsPopUpHeight" value="545" />
<add key="PortalCommentsSortBy" value="DATE_POST" />
<add key="PortalCommentsSortOrder" value="ASC" />
<add key="PortalCommentsExpandView" value="N" />
<add key="PortalCommentsListSize" value="25" />
<add key="PortalDisplayCodeNames" value="N" />
<add key="PortalMaxListSize" value="1000" />
<add key="PortalQuickViewEnabled" value="Y" />
<add key="PortalQuickViewDataName" value="FORM_ARCHIVE" />
<add key="PortalQuickViewDisplayOnMouseEvent" value="CLICK" />
<add key="PortalTextDetection" value="Y" />
<add key="PortalActivityCompleteInBackground" value="N" />
<add key="PortalEnableSearchResultAutoRedirect" value="Y" />
<add key="PortalCommonProcessDataNameList" value="" />
<add key="PortalReportEnableCustomColumns" value="Y" />
<add key="PortalReportAllowUserToCreateCustomColumns" value="Y" />
<add key="ReportsTextDetection" value="Y" />
<add key="AdministrationFormDataProviderName" value="System.Data.SqlClient, System.Data.OleDb, System.Data.Odbc, System.Data.OracleClient" />
<add key="AdministrationEnableDeletionRulesCheck" value="Y" />
<add key="AdministrationRestrictManagerToModifyGlobalParticipant" value="N" />
<add key="AdministrationFormDesignUndoLimit" value="30" />
<add key="DirectorySynchronizationMaxUserDeletionCount" value="0" />
<add key="DirectorySynchronizationSyncGroupMembersUsedInParticipantOnly" value="N" />
<add key="PortalFrameSetHeight" value="0,68,*,0" />

<add key="PortalEnableCallingCard" value="Y" />
<add key="PortalReportAdvancedViewDefault" value="Y" />
<add key="PortalReportEnableCustomCharts" value="Y" />
<add key="PortalReportEnableQuickMassApproval" value="N" />
<add key="PortalReportAllowUserToCreateCustomCharts" value="Y" />
<add key="PortalDefaultWorkflowGraphicalMode" value="HTML5" />
<add key="ProcessesRuntimeWebServiceAllowedUsers" value="wfgen_admin" />

<add key="EFormAspxPreviousFilesCleanUp" value="Y" />

<add key="GetUsersFromDirMaxResultNb" value="100" />

<add key="XmlToDatabaseTestMode" value="N" />
<add key="XmlToDatabaseEnableTrace" value="N" />

<add key="XmlTransPreviousFilesCleanUp" value="Y" />
<add key="XmlTransEnableTrace" value="N" />

Remove the following deprecated parameters from <appSettings>:

PortalFollowUpRelevantDataListNumber
PortalPopupRelevantDataListNumber
PortalEnableRequestDataListPopUp

Define the following nodes in <configuration>:

<location path="." inheritInChildApplications="false">
    <system.web>
        <httpRuntime requestValidationMode="2.0" maxRequestLength="10240" />
    </system.web>
</location>
<location path="wfapps/webforms" inheritInChildApplications="false">
    <system.web>
        <httpRuntime requestValidationMode="2.0" maxRequestLength="10240" />
        <pages clientIDMode="AutoID" controlRenderingCompatibilityVersion="3.5" />
    </system.web>
</location>
<location path="ws" inheritInChildApplications="false">
    <system.web>
        <httpRuntime requestValidationMode="2.0" maxRequestLength="10240" />
    </system.web>
</location>

Define or update the following node in <configuration>/<system.web>:

<pages validateRequest="false" enableSessionState="false" />

When upgrading from version 6.0.0 and earlier

Add the following new parameters to <appSettings>:

<add key="AdministrationDefaultWorkflowGraphicalMode" value="HTML5" />
<add key="EngineNotificationLogLevel" value="1" />
<add key="RemoteApprovalLogTraceLevel" value="3" />
<add key="RemoteApprovalMailServerSecurity" value="none" />
<add key="RemoteApprovalRefreshInterval" value="180000" />
<add key="RemoteApprovalMailServerType" value="POP" />
<add key="RemoteApprovalLifeSpan" value="0" />
<add key="RemoteApprovalMailServerPort" value="110" />
<add key="ApplicationSecurityPasswordManagementMode" value="V5" />
<add key="ApplicationSecurityMaxLoginAttempts" value="5" />
<add key="ApplicationSecurityMinimumPasswordLength" value="8" />
<add key="ApplicationSmtpPickupDirectory" value="DRIVE:\inetpub\mailroot\Pickup" />

<add key="ApplicationSmtpServerTimeout" value="3000" />
<add key="ApplicationSmtpDeliveryMethod" value="SmtpServer" />

When upgrading from version 6.1.0 and earlier

Add the following new parameter to <appSettings>:

<add key="AdministrationAssociatedActivitiesToSwimlane" value="Y" />

When upgrading from version 6.1.4 and earlier

Add or modify the AdministrationFormDataProviderName parameter as follows:

<add key="AdministrationFormDataProviderName" value="System.Data.SqlClient,System.Data.OleDb,System.Data.Odbc,System.Data.OracleClient,Oracle.DataAccess.Client" />

When upgrading from version 6.1.6 and earlier

Add the following new parameters to <appSettings>:

<add key="ApplicationWebFormsPath" value="" />
<add key="EngineNotificationDefaultSenderName" value="" />
<add key="PortalDashboardAutoRefreshInterval" value="0" />
<add key="PortalActivityOnCompleteRedirectToView" value="N" />

When upgrading from version 6.4.0 and earlier

Add the following new parameters to <appSettings>:

<add key="SendMessageProvider" value="TWILIO" />
<add key="SendMessageAccountSID" value="" />
<add key="SendMessageAuthToken" value="" />
<add key="SendMessageFrom" value="" />
<add key="SendMessageApiUrl" value="https://api.twilio.com/2010-04-01/Accounts/" />
<add key="SendMessageEnableLogs" value="Y" />

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:

<add key="SendHttpPostLogLevel" value="n" />

When upgrading from version 6.6.0 and earlier

Remove the following deprecated parameters from <appSettings>:

ApplicationImpersonificationUsername
ApplicationImpersonificationPassword
PortalDefaultWorkflowGraphicalMode
ApplicationEnableFlashDetection

When upgrading from version 7.1.1 and earlier

Add the following new parameters to <appSettings>:

<add key="GraphqlQueryTimeout" value="90000" />
<add key="GraphqlOperationTimeout" value="30000" />
<add key="GraphqlMaxOperationCount" value="10000" />
<add key="GraphqlMaxInputFileSize" value="10240" />
<add key="GraphqlInputFileDownloadTimeout" value="100000" />
<add key="HookslInputFileDownloadTimeout" value="100000" />
<add key="HooksOperationTimeout" value="30000" />
<add key="HooksMaxInputFileSize" value="10240" />
<add key="EngineServiceTempApiFilesLifespan" value="2" />

When upgrading from version 7.3.1 and earlier

Add the following new parameter to <appSettings>:

<add key="AdministrationDefaultConditionLanguage" value="JS" />

When upgrading from version 7.6.0 and earlier

Add the following new parameters to <appSettings>:

<add key="ApplicationSmtpEnableSsl" value="N" />
<add key="ApplicationSmtpPort" value="" />
<add key="ApplicationSmtpUsername" value="" />
<add key="ApplicationSmtpPassword" value="" />

When upgrading from version 7.9.1 and earlier

Add the following new parameters to <appSettings>:

<add key="GraphqlMaxInputFileContentSize" value="0" />
<add key="HooksMaxInputFileContentSize" value="0" />
<add key="GraphqlInputFileAllowedFolders" value="" />
<add key="HooksInputFileAllowedFolders" value="" />

When upgrading from version 7.14.3 and earlier

Add the following new parameter to <appSettings>:

<add key="ApplicationSecurityAuthSessionRefreshEnableIFrame" value="Y" />

When upgrading from version 7.14.8 and earlier

Add the following new parameters to <appSettings>:

<add key="EngineServiceInactiveRequestLifespanUnit" value="d" />
<add key="EFormAspxAcceptEmptyInputTextParam" value="Y" />
<add key="SendHttpPostMaxResponseLength" value="4194304" />
<add key="RestApiClientLogLevel" value="0"/>
<add key="RestApiClientRequestTimeout" value="3000" />
<add key="RestApiClientMaxResponseLength" value="4194304" />
<add key="RestApiClientEnableFilesCleanUp" value="Y" />
<add key="GetUsersFromDirLogLevel" value="0" />
<add key="XmlTransEnableFilesCleanUp" value="Y" />
<add key="MergeFormEnableFilesCleanUp" value="Y" />
<add key="GraphqlInputFileAllowedHttpUrls" value="" /> 
<add key="HooksInputFileAllowedHttpUrls" value="" />

Remove the following deprecated parameters from <appSettings>:

XmlTransPreviousFilesCleanUp
MergeFormTempFilesLifeSpan

When upgrading from version 7.15.2 and earlier

1. Add the following nodes after the existing <location> nodes in \wfgen\web.config:

   <location path="auth" inheritInChildApplications="false">
       <system.webServer>
           <modules>
               <remove name="ApplicationSecurityAuthenticationModule" />
           </modules>
       </system.webServer>
   </location>
   <location path="hooks" inheritInChildApplications="false">
       <system.webServer>
           <modules>
               <remove name="ApplicationSecurityAuthenticationModule" />
           </modules>
       </system.webServer>
   </location>
   <location path="scim" inheritInChildApplications="false">
       <system.webServer>
           <modules>
               <remove name="ApplicationSecurityAuthenticationModule" />
           </modules>
       </system.webServer>
   </location>

2. Remove the node below from \wfgen\auth\web.config, \wfgen\hooks\web.config, and \wfgen\scim\web.config, if present:

   <modules>
       <remove name="ApplicationSecurityAuthenticationModule" />
   </modules>

When upgrading from version 7.15.4 and earlier

Add the following new parameter to <appSettings>:

<add key="PortalRedirectAllowedHttpUrls" value="" />

When upgrading from version 7.15.5 and earlier

1. Change the default value of RestApiClientRequestTimeout from 3000 to 30000 milliseconds.

2. 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:

   <handlers>
      <add name="iisnode" path="dist/server.js" verb="*" modules="iisnode"/>
   </handlers>
   ​
   <rewrite>
      <rules>
         <rule name="DynamicContent">
            <conditions>
               <add input="{{REQUEST_FILENAME}}" matchType="IsFile" negate="True"/>
            </conditions>
            <action type="Rewrite" url="dist/server.js"/>
         </rule>
      </rules>
   </rewrite>   

When upgrading from version 7.16.5 and earlier

Add the following new parameters to <appSettings>:

<add key="AdministrationMaxHelpTextSize" value="10000" />
<add key="ApplicationSecurityAuthAdditionalScopes" value="" />

When upgrading from version 7.18.1 and earlier

Add the following new parameter to <appSettings>:

<add key="ReportsTopProcessesNumber" value="10" />

When upgrading from version 7.18.2 and earlier

1. Add the following new parameter to <appSettings>:

   <add key="ValidationSettings:UnobtrusiveValidationMode" value="None" />

2. Add targetFramework="4.6.1" to the three web apps' httpRuntime nodes. For example:

   <location path="." inheritInChildApplications="false">
       <system.web>
           <httpRuntime targetFramework="4.6.1" />
       </system.web>
   </location>
   <location path="wfapps/webforms" inheritInChildApplications="false">
       <system.web>
           <httpRuntime targetFramework="4.6.1" />
       </system.web>
   </location>
   <location path="ws" inheritInChildApplications="false">
       <system.web>
         <httpRuntime targetFramework="4.6.1" />
       </system.web>
   </location>

When upgrading from version 7.20.0 and earlier

Add the following new parameters to <appSettings>:

<add key="ApplicationSecurityAuthResponseMode" value="" />
<add key="ApplicationSecurityAuthDecodeAccessToken" value="" />

When upgrading from version 7.21.0 and earlier

Add the following new parameter to <appSettings>:

<add key="ExecSqlLogLevel" value="0" />

<add key="GetUsersFromDirLogLevel" value="" />
<add key="MergeFormLogLevel" value="" />
<add key="SendHttpPostLogLevel" value="" />
<add key="RestApiClientLogLevel" value="" />

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:

<location path="graphql" inheritInChildApplications="false">
    <system.webServer>
        <httpProtocol>
            <customHeaders>
                <add name="Access-Control-Allow-Origin" value="*" />
                <add name="Access-Control-Allow-Methods" value="GET, POST, OPTIONS, HEAD" />
                <add name="Access-Control-Allow-Headers" value="Accept, Origin, Authorization, Content-Type, x-wfgen-impersonate-username, x-iisnode-auth_user" />
            </customHeaders>
        </httpProtocol>
    </system.webServer>
</location>

When upgrading from version 7.22.4 and earlier

Add the following new parameters to <appSettings>:

<add key="RemoteApprovalAuthClientId" value="" />
<add key="RemoteApprovalAuthClientSecret" value="" />
<add key="RemoteApprovalAuthScope" value="" />
<add key="RemoteApprovalAuthAccessTokenUri" value="" />

Remove the xmlns attribute

In WorkflowGen version 7.x.x, you must remove the xmlns attribute from these configuration files:

\wfgen\web.config 
\wfgen\ws\web.config 
\wfgen\WfApps\WebForms\web.config 
DRIVE:\Program Files\Advantys\WorkflowGen\Services\bin\WfgWorkflowEngineServer.exe.config
DRIVE:\Program Files\Advantys\WorkflowGen\Services\bin\WfgDirectoriesSyncService.exe.config

To do this, change <configuration xmlns="http://schemas.microsoft.com/.NetConfiguration/v2.0"> to <configuration>.

Update the root web configuration file

Configure the WorkflowGen root website to auto-redirect to the wfgen web app

As 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

1. Make sure the URL Rewrite tool is installed on your WorkflowGen server.

2. 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).

3. Define the rewrite rule node as shown below (configuration / system.webServer / <rewrite> / <rules> / <rule>):

   <?xml version="1.0" encoding="UTF-8"?>
   <configuration>
       <system.webServer>
           <rewrite>
               <rules>
                   <rule name="Rewrite to wfgen" stopProcessing="true">
                       <match url="(^$|^wfgen$|^wfgen/$)" />
                       <action type="Rewrite" url="/wfgen/show.aspx?QUERY=CONTEXT&amp;REQUEST_QUERY=WELCOME&amp;NO_REDIR=Y" />
                   </rule>
               </rules>
           </rewrite>
       </system.webServer>
   </configuration>

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>:

<httpErrors existingResponse="PassThrough" errorMode="Detailed"></httpErrors>

Update the Directory Synchronization configuration file

There is a new configuration parameter 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:

<add key="ServiceName" value="WorkflowGenDirSyncService" />

Update the WorkflowGen Engine Service configuration file

There is a new configuration parameter 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:

<add key="ServiceName" value="WorkflowGenEngineService" />

Move the XMLTODATABASE transactions file

If you are 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.

Upgrade the WorkflowGen database

Run the SQL scripts listed below in order, starting with your current version of WorkflowGen. For example, if you are upgrading from version 5.5.0, run the scripts starting with For version 5.5.0 and earlier until For versions 7.21.0 and earlier, inclusively.

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.