Optional

Node.js modules

The Node.js modules include the GraphQL API, webhooks, SCIM, and Auth. To use them, you must first install the following requirements:

To enable WorkflowGen GraphQL:

  1. In IIS, convert /wfgen/graphql to an application with a .NET 4 application pool (integrated pipeline).

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

  3. Update the WorkflowGen web.config file with the following parameters used by GraphQL:

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

<add key="GraphqlMaxBatchSize" value="1000" />

<add key="GraphqlDefaultPageNumber" value="1" />

<add key="GraphqlDefaultPageSize" value="30" />

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

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

<add key="GraphqlDebugEnabled" value="N" />

To enable WorkflowGen incoming webhooks:

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

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

For WorkflowGen Applicative authentication:

<system.webServer>
<modules>
<remove name="ApplicationSecurityAuthenticationModule" />
</modules>
</system.webServer>

For custom authentication:

<system.webServer>
<modules>
<remove name="MyCustomAuthModule" />
</modules>
</system.webServer>
  1. Update the WorkflowGen web.config file with the following parameter used by incoming webhooks:

<add key="HooksDebugEnabled" value="N" />

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.

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

For WorkflowGen Applicative authentication:

<system.webServer>
<modules>
<remove name="ApplicationSecurityAuthenticationModule" />
</modules>
</system.webServer>

For custom authentication:

<system.webServer>
<modules>
<remove name="ApplicationSecurityAuthenticationModule" />
</modules>
</system.webServer>

To enable WorkflowGen 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.

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

For WorkflowGen Applicative authentication:

<system.webServer>
<modules>
<remove name="ApplicationSecurityAuthenticationModule" />
</modules>
</system.webServer>

For custom authentication:

<system.webServer>
<modules>
<remove name="MyCustomAuthModule" />
</modules>
</system.webServer>

Note: After enabling the Node.js modules, the WorkflowGen DLLs will be in use by Node.js, so they will be locked from being updated. In order to update the DLLs, it is necessary to stop IIS.

Remote Approval

Remote Approval is now an integrated feature in WorkflowGen, and is no longer a separate module.

For information on configuring Remote Approval, see the Remote Approval section in the WorkflowGen Administration Guide.

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.

  1. Uninstall the Remote Approval module (it is recommended that you make a backup of all previous Remote Approval files and folders):

    1. Open the Windows Services list and stop the Remote Approval service, usually named WorkflowGen RemoteApproval or WorkflowGen EmailListener.

    2. Delete the DRIVE:\Program Files (x86)\Advantys\WorkflowGen\RemApp\ folder.

    3. Delete the \wfgen\bin\RemoteApprovalConfig.dll and `\wfgen\admin\RemoteApprovalConfig.aspx` files.

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

  3. Check Activate on the Remote Approval tab in the Administration Module Configuration Panel.

Notes:

  • Verify your Remote Approval settings, which should be the same as in the former module, since they are inherited with the WorkflowGen upgrade.

  • Remote Approval no longer requires WorkflowGen application-specific credentials, since it now uses the WorkflowGen Engine service.

  • 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): RemoteApprovalWorkflowGenAppDomain RemoteApprovalEmailListenerServiceName RemoteApprovalWorkflowGenAppUsername RemoteApprovalWorkflowGenAppPassword

  • Optional: Test Remote Approval with an existing process for which Remote Approval was configured using the former module. You can also use the Remote Approval sample process available on the WorkflowGen Forum & Knowledge Base.

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

If you would like your WorkflowGen root website (e.g. https://server) to auto-redirect to the web app (e.g. https://server/wfgen), follow the procedure below.

Note: As of WorkflowGen 7.15.0, the PowerShell setup comes with this configuration pre-installed on your WorkflowGen server. This procedure is applicable only when upgrading an existing previous WorkflowGen server.

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

  2. Create or update the web.config under your website's root folder (e.g. DRIVE:\inetpub\wwwroot\web.config).

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

    <?xml version="1.0" encoding="UTF-8"?>
    <configuration>
    <system.webServer>
    <rewrite>
    <rules>
    <rule name="Root to wfgen" stopProcessing="true">
    <match url="^$" />
    <action type="Redirect" url="/wfgen/" />
    </rule>
    </rules>
    </rewrite>
    </system.webServer>
    </configuration>

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 are no longer used.

  • EFORMASPX: \wfgen\WfApps\WebApps\EFormASPX

  • GETUSERSFROMDIR: \wfgen\WfApps\WebServices\GetUsersFromDir

  • RAISEEXCEPTION: \wfgen\WfApps\WebServices\RaiseException

  • XMLTODATABASE: \wfgen\WfApps\WebServices\XmlToDatabase

  • XMLTRANS: \wfgen\WfApps\WebServices\XmlTrans

Create a clean WorkflowGen database

To create a clean WorkflowGen database, you must use the full WorkflowGen manual installation pack, which is available at https://github.com/advantys/workflowgen-releases/releases.