Nintex Gateway
Nintex Gateway is an on-premises application that enables Nintex Automation Cloud to access on-premises resources, such as:
-
Nintex RPA. Use the Nintex RPA - Start a Nintex RPA automation action A tool for building the processes, logic, and direction within workflows. to run task automations in Nintex RPA.
-
Nintex RPA Central. Use the Nintex RPA LE - Start an RPA botflow action to run botflows in Nintex RPA Central.
-
Microsoft SQL Server on-premises. Use the Microsoft SQL Server on-premises connector A software component that allows seamless integration with third-party services, business applications, and content stores. Examples include Salesforce, Box, and Microsoft SharePoint. Connectors are used to create connections required for workflow actions and start events. to create, delete, retrieve, and update data, and run stored procedures.
-
SharePoint on-premises. Use the SharePoint on-premises connector to create, delete, query, retrieve, or update a list item, and update a list item's permissions.
-
Web Services on-premises. Use the Web Services on-premises connector to make HTTP requests and API calls.
Note: You can use the same Nintex Gateway to connect to Nintex RPA Central, Microsoft SQL Server, and SharePoint on-premises servers, if they are installed within the same Active Directory domain. You can also create multiple different connectors in a Nintex Automation Cloud workflow that use the same Nintex Gateway. You cannot, however, use the same Nintex Gateway for multiple environments/boxes. If you have a test environment, you must use a different Nintex Gateway instance.
For upgrade information and the latest version, see the Nintex Gateway release notes.
Download and Install
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 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:
- cdn.auth0.com
- nintex-portal.auth0.com
-
*.nintex.io
-
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
-
SQL Server 2012 is not supported.
-
SQL Server 2017 and 2022 may work with the Microsoft SQL Server on-premises integration, but have not been tested with it.
Nintex Gateway is an on-premises application that allows Nintex Automation Cloud 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 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
You must install Nintex Gateway on your on-premises computer or server before you can create a Nintex RPA LE, Nintex RPA, Microsoft SQL Server on-premises, SharePoint on-premises, or Web Services on-premises connection.
Before you install Nintex Gateway, contact your IT administrator to verify that the following URLs are accessible via HTTPS (port 443) from the on-premises computer or server where you will install Nintex Gateway:
- *.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:
- cdn.auth0.com
- nintex-portal.auth0.com
-
*.nintex.io
-
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
Note: You can also download Nintex Gateway from Product Releases. Nintex customer registration is required to use the Product Releases download page.
- On the top navigation bar, click Automate, and then select Connections from the left navigation.
-
On the Connections page, click Add new.
- In the Connector field, select Nintex RPA LE, Nintex RPA, Microsoft SQL Server on-premises, SharePoint on-premises, or Web Services on-premises.
- Click Download and save the MSI file to any location that you can access for installation.
- Run the Nintex Gateway installer MSI file.
The Nintex Gateway Setup Wizard opens.
- Click Next.
- Read the Nintex Master Subscription Agreement and select I accept the terms in the License Agreement.
- Click Next.
- Select the install location and click Next.
- Click Install.
- Click Finish.
Next, configure the Nintex Gateway on your on-premises resource.
Configure
- Open the Nintex Gateway application.
- Type your Nintex Automation Cloud tenant name.
- Nintex Gateway validates your Nintex Automation Cloud tenant name. Click Start Gateway.
- The Nintex Automation Cloud sign in screen displays. Sign into Nintex Automation Cloud.
Note: You must be in the administrator role in Nintex Automation Cloud to start Nintex Gateway. See User management.
Nintex Gateway starts and connects to Nintex Automation Cloud.
Create an API key if the Nintex Automation Cloud connector you're connecting to uses Managed Authentication.
Next, create a Nintex RPA LE, Nintex RPA, Microsoft SQL Server on-premises, a SharePoint on-premises , or a Web Services on-premises connection.
You can manage the connection to your Nintex Gateway servers in the Settings > Nintex Gateway management page.
Nintex Gateway fields and buttons
Field/button | Description |
---|---|
Nintex Gateway hostname | The Gateway hostname that will be used and shown under connections. Use this to provide a friendly name for the Gateway. |
Nintex Automation Cloud tenant name |
The name of the Nintex Automation Cloud tenant Nintex Gateway will connect to. |
Authenticate Nintex Gateway |
Starts the authentication process with Nintex Automation Cloud and upon successful sign in as a user with an administrator role. See Nintex Gateway Troubleshooting if you have issues authenticating. |
Options () |
Displays when the Nintex Gateway is connected to a Nintex Automation Cloud tenant. Click to view menu options. |
Change |
Displays when you click the options button. Allows you to edit the Nintex Automation Cloud configuration if you want to connect to a different Nintex Automation Cloud tenant. Does not stop the Nintex Gateway service or disconnect your current Nintex Automation Cloud connection. |
View logs |
Displays when you click the options button. Opens the Nintex Gateway applications and services event viewer logs. |
Resume Gateway |
Displays when you have paused the Nintex Gateway and click the options button. Restarts the Nintex Gateway service with your current Nintex Automation Cloud configuration. |
Disconnect |
Displays when you click the options button. Stops the Nintex Gateway service and removes the Nintex Automation Cloud connection.
|