Nintex Gateway

Minimum server specification:

• CPU: Single core, 2Ghz or faster.

• Memory: 8 GB or more

• Disk space: 2 GB free space.

Software:

• Microsoft .NET Framework 4.8

• Windows Server 64-bit:

  • Windows Server 2022

  • Windows Server 2019

  • Windows Server 2016

  • Windows Server 2012 R2. If you're using Windows Server 2012 R2, you should consider upgrading.

Configuration:

• Nintex Gateway must be installed on a computer that is joined to an Active Directory domain for the following connectors:

  • Nintex RPA on-premises

  • Nintex RPA LE

  • Microsoft SQL Server on-premises

  • SharePoint on-premises

  • Web Services on-premises

• Nintex Gateway requires access to a Nintex Tenant to be able to complete a connection.

• If a firewall is in place, configure it to allow HTTPS traffic on port 443 to access the following URLs:
  • *.workflowcloud.com
  • The configuration app needs access to:
    • *.nintex.io
      • This is actually for <region>.nintex.io, so you can be more specific with eu.nintex.io if your tenant is in the EU.
      • gbo-cli-vib.nintex.io is also used for some resources on the authentication page.
    • *.auth0.com (for authentication). This can be made more specific into:
      1. cdn.auth0.com
      2. nintex-portal.auth0.com
  • The windows service needs access to
    • *.workflowcloud.com
    •  *.nintex.io
      • Or more specific, <region>.nintex.io as above.
    • A websocket connection to *.servicebus.windows.net.
      • This can also be more specific per region, for example gwyprd01rlyneu01.servicebus.windows.net

Supported Nintex Bot versions

Nintex Gateway integrates with Nintex Bot using the Nintex RPA Central product. Nintex Gateway 2.1.2 and later support Nintex RPA Central version 2.0 and later.

Supported Nintex RPA versions

The Nintex RPA integration is supported for Nintex RPA 22.9.1 or above.

Supported Microsoft SharePoint Server versions

The SharePoint on-premises integration is supported for:

• SharePoint Server 2016

• SharePoint Server 2019

• SharePoint Server Subscription Edition

The integration requires User Profile Services and Managed Metadata Services to be operating correctly.

SharePoint Server 2013 is not supported.

Supported Microsoft SQL Server versions

The Microsoft SQL Server on-premises integration has been tested on and is supported for:

• Any edition of SQL Server 2014

• Any edition of SQL Server 2016

• Any edition of SQL Server 2019

Nintex Gateway is an on-premises application that allows Nintex Workflow to access on-premises resources, such as Nintex RPA Central, Nintex RPA, Microsoft SQL Server on-premises, SharePoint on-premises, and local web services.

After you install Nintex Gateway, you can:

• Create a Nintex RPA LE connection Credentials and other settings that enables workflows to communicate with external systems, services, or applications. It's required to pass data between the workflow and the indicated service, which could be a cloud service, business application, or content store. and add the Nintex RPA LE - Run an RPA botflow action to your workflows

• Create a Nintex RPA connection and add the Nintex RPA - Start a Nintex RPA automation action to your workflow

• Add a SharePoint on-premises connection and use SharePoint on-premises actions in a workflow

• Add a Microsoft SQL Server on-premises connection and use SQL on-premises actions in a workflow

• Add a Web Services on-premises connection and make local HTTP requests and API calls

Note: You can also download Nintex Gateway from Product Releases. Nintex customer registration is required to use the Product Releases download page.

1. On the top navigation bar, click Automate, and then select Connections from the left navigation.

2. On the Connections page, click Add new.

3. In the Connector field, select Nintex RPA LE, Nintex RPA, Microsoft SQL Server on-premises, SharePoint on-premises, or Web Services on-premises.
4. Click Download and save the MSI file to any location that you can access for installation.
5. Run the Nintex Gateway installer MSI file.

   The Nintex Gateway Setup Wizard opens.

6. Click Next.
7. Read the Nintex Master Subscription Agreement and select I accept the terms in the License Agreement.
8. Click Next.
9. Select the install location and click Next.
10. Click Install.
11. Click Finish.

Next, configure the Nintex Gateway on your on-premises resource.

1. Open the Nintex Gateway application.
2. Type your Nintex Workflow tenant name.
3. Nintex Gateway validates your Nintex Workflow tenant name. Click Start Gateway.

Note: You must be in the administrator role in Nintex Workflow to start Nintex Gateway. See User management.

4. The Nintex Workflow sign in screen displays. Sign into Nintex Workflow.

Nintex Gateway starts and connects to Nintex Workflow.

1. Run the latest Nintex Gateway installer. For details about the latest version, see Nintex Gateway Release notes. Follow the existing installation steps outlined in the Nintex Help documentation.
2. Configure the firewall if required based on the port you want to use in Step 3.
   • Open Windows Firewall with Advanced Security from the start menu.

   • In the left pane, select Inbound Rules.

   • Right-click and select New Rule.

   • In the Rule Type dialog, select Port, and then click next.

   • Under Protocol and Ports, do the following:

     • Select TCP.

     • In Specific local ports, enter an unused port number you configured on the Settings page under Gateway Bindings.

     • Click next.

   • Under Action, select Allow the connection, and then click next.

   • Under Profile, select Domain and Private, and then click next.

   • Enter a name for the rule, and then click Finish.

3. Configure the Gateway
   

   In the Nintex Gateway application, go to Settings and select Configure, choose either http or https based on your requirements. If using http, set it up and select Save. If you are using https, follow the steps below:

   Note: Before you begin, ensure that the Nintex Gateway app is connected to a Nintex tenant and that you have a valid SSL certificate.

   • Open the Nintex Gateway Configuration app.

   • Go to the Settings tab, and then click configure.

   • Select HTTPS.

   • Ensure the port number is available and added to the Firewall Inbound Rules.

   • Under Certificate, select Select file, and then choose the SSL certificate from your local computer.

   • Enter the password used to generate the certificate.

   • Click save, and then select yes to confirm and proceed with the configuration.

     The Nintex Gateway service restarts automatically.
     

4. Open the Nintex Gateway app, go to the Settings page to generate a key as you set up the URL. Select Rotate, then copy and save the displayed key for later use in configuring the solution.

5. Open the USER_GUIDE.md file in the relevant WSP_SP20XX_1.0.0.0.zip package for instructions on running the PowerShell scripts. To install the solution for event handling, open the WSP_SP20XX_1.0.0.0.zip file that matches yourSharePoint version and run the PowerShell script included in the package.

   Important:  Download the WSP package that matches your SharePoint on-premises version.

   • WSP_SP2016_1.0.0.0.zip
   • WSP_SP2019_1.0.0.0.zip
   • WSP_SPSE_1.0.0.0.zip

6. Complete the configuration by following the instructions and use the API key and Gateway URL configured earlier to complete the setup.