Integrate a yunIO Service via Nintex Gateway

The following article shows how to integrate a yunIO 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 yunIO version 1.26.3 or higher.
• Set up Basic Authentication in yunIO, see Documentation: Access Restrictions.

Setup in yunIO

1. Create a service in yunIO. The depicted example uses the BAPI SD_RFC_CUSTOMER_GET to search and extract customer data from SAP.
2. Click to testrun the service in yunIO . For more information, see Documentation: Run Services in yunIO.
3. Navigate to Settings and select Nintex Gateway as the OpenAPI Target Kind to add predefined Nintex Gateway properties to the service definition.
   
4. Navigate to Services and click 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}" }

Configure a yunIO Xtension in Nintex

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 yunIO service definition from Setup in yunIO.
   
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] .
    

Configure a yunIO Connection in Nintex

1. Click Connections in the dashboard to open the Connections page .
2. Click [Add Connection] in the Connector list .
   
3. Select the yunIO connector from Configure a yunIO Xtension in Nintex.
4. Click [Next].
5. Configure the connection:
   
   
   • 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 yunIO service, including the HTTPS.
   • On-premises application username - enter your yunIO username.
   • On-premises application password - enter your yunIO password.
6. Click [Connect].
   

Use the yunIO Service in a Nintex Workflow

After an Xtension and a Connection is created, the yunIO service can be used in a workflow.

1. Drag and drop the yunIO Xtension from Configure a yunIO Xtension in Nintex into the workflow .
2. Select the connection from Configure a yunIO Connection in Nintex .
   
3. Parameterize the input fields .

Related Links

• Nintex Documentation: Integrate with Theobald yunIO via Nintex Gateway
• Nintex Gateway