Integrate a Service via Nintex Gateway

The following article shows how to integrate an Xtract Universal.iQ services via the Nintex Gateway.
The Nintex Gateway is an on-premises application that enables Nintex Automation Cloud to access on-premises resources.

Prerequisites

• Install and configure the Nintex Gateway.
• Make sure that the Nintex Gateway has a valid API key for authentication.
• Install Xtract Universal.iQ version 1.26.3 or higher.
• Set up Basic Authentication in Xtract Universal.iQ, see Documentation: Access Restrictions.

Setup in Xtract Universal.iQ

Before integrating Xtract Universal.iQ with third-party tools:

1. Create a service in Xtract Universal.iQ. The depicted example uses the BAPI SD_RFC_CUSTOMER_GET to search and extract customer data from SAP.
2. Testrun the service in Xtract Universal.iQ to make sure it works, see Documentation: Run Services in Xtract Universal.iQ.
3. Open the Settings menu and set OpenAPI Target to Nintex Gateway. This adds predefined Nintex Gateway properties to the service definition.
4. Open the Services menu and click [ Run > Swagger / Open API > Copy URL] to download the service definition.
5. Open the service definition and check if the following properties are available at the end of the service definition:

   Nintex Properties

   256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302

   "securityDefinitions": { "basic": { "type": "basic", "x-ntx-connection-properties": { "type": "object", "required": [ "x-ntx-gateway-id", "x-ntx-gateway-apikey", "x-ntx-gateway-xtension-baseurl", "username", "password" ], "properties": { "x-ntx-gateway-id": { "type": "string", "title": "Select Nintex Gateway" }, "x-ntx-gateway-apikey": { "type": "string", "title": "Nintex Gateway API key" }, "x-ntx-gateway-xtension-baseurl": { "type": "string", "title": "On-premises service URL", "description": "Base URL of the web service.", "pattern": "^(https?:\/\/[^\/?#]+)(?:[\/]|\/.+|)$" }, "username": { "type": "string", "title": "On-premises application username" }, "password": { "type": "string", "title": "On-premises application password" } } } } }, "security": [ { "basic": [] } ], "x-ntx-render-version": 2, "x-ntx-host": "{x-ntx-gateway-uri}" }

The service definition can now be used to integrate the service with third-party tools.

Configure an Xtension in Nintex

To use Xtract Universal.iQ services in the Nintex Automation Cloud:

1. Open your Nintex Automation Cloud tenancy.
2. Click Xtensions in the dashboard to open the Xtensions page .
3. Click in the Private connector list .
4. Click [Choose a file] . Navigate to the Xtract Universal.iQ service definition from Setup in Xtract Universal.iQ.
   
5. Wait for the Nintex Automation Cloud to validate the file.
6. Click [Next]. Nintex Workflow Cloud detects the basic authentication security template.
7. Click [Next].
8. Edit the Name of the Xtension. The entered name becomes the name of the action group in the workflow.
9. Edit the Description of the Xtension. This appears in the Private connector list in the Xtensions page.
10. Optional: select or upload an icon for the Xtension.
11. Click [Publish] .
    

The Xtract Universal.iQ Xtension is now available for use in Nintex workflows.

Configure the Connection in Nintex

To set up a connection to Xtract Universal.iQ via the Nintex Gateway in the Ninex Automation Cloud:

1. Click Connections in the dashboard to open the Connections page .
2. Click [Add Connection] in the Connector list .
   
3. Select the Xtract Universal.iQ connector from Configure an Xtract Universal.iQ Xtension in Nintex.
4. Click [Next].
5. Fill in the following connection properties:
   • Connection name - enter a name to identify the connection.
   • Select Nintex Gateway - select your Nintex Gateway.
   • Nintex Gateway API key - enter a valid API key of your Nintex Gateway.
   • On-premises service URL - enter the base URL of your Xtract Universal.iQ service, including the HTTPS.
   • On-premises application username - enter your Xtract Universal.iQ username.
   • On-premises application password - enter your Xtract Universal.iQ password.
6. Click [Connect].
   

The connection to Xtract Universal.iQ via the Nintex Gateway is now set up and can be used in workflows.

Use the Xtract Universal.iQ Service in a Nintex Workflow

After an Xtension and a Connection is created, the Xtract Universal.iQ service can be used in a workflow:

1. Drag and drop the Xtract Universal.iQ Xtension from Configure an Xtract Universal.iQ Xtension in Nintex into the workflow .
2. Select the connection from Configure an Xtract Universal.iQ Connection in Nintex .
   
3. Parameterize the input fields .
4. Run the workflow.

The Xtract Universal.iQ service runs and returns data in the output of the Nintex workflow action.

Related Topics

• Nintex Documentation: Integrate with Theobald Xtract Universal.iQ via Nintex Gateway
• Nintex Gateway