Configure the connection
Last updated
Last updated
By following the subsequent steps, the connection with the engine will be added and then tested to verify if it functions correctly.
Note that, in this section, only one engine will be configured and tested. The other engines will be configured in the next sections.
This section contains three points:
Configure the Credentials will be used to connect with the engine. If the button Configure is clicked, the UI Page to introduce the credentials will be shown. It contains a form that will display different fields depending on the authentication type selected:
Basic:
OAuth V2.0:
Configure Engine will be used to enter all information related to the engine. When the “configure” button is clicked, a new modal window is opened displaying two options:
Configure basic connection
Configure OAuth Connection
After clicking on the option required, the following form will be displayed to complete the connection information for the engine.
Depending on the option clicked, the engine will use the Basic or the OAuth v2.0 connection alias to set up this connection. Thus, at this point, it is very important to ensure that the credentials configured in the previous step match with the authentication type chosen for the engine connection.
In this form, the most important fields are listed below:
Host: The URL of the endpoint has to be entered. There is no need to add the protocol. The URL builder will add it automatically in the connection URL field. For example, if we add custom-01-prod-engine-1.nexthink.cloud on the host field_,_ the URL builder will generate the URL https://custom-01-prod-engine-1.nexthink.cloud in the connection URL field).
Override default port: The port used by the Web API v2 service to listen to the engines must be specified in case it is different from 443. By default, this is the default port in Nexthink Experience engines (cloud), so it is possible to leave this field empty. However, the default port for on-premise engines is 1671, therefore in this case it must be declared in the Override default port field.
Use MID Server: In case the connection requires a MID Server, the checkbox Use MID Server should be ticked and the Advance MID Server Configuration should be configured correctly.
To specify the right MID Server, it is necessary to add an MID Application that contains it. The application ALL can be used but it is necessary to add the right MID Server. To do this, the MID Server must be added as the default MID Server or included in the list of MID Servers associated to the application.
Test the connection allows the user to check if the configuration is working properly. This section links to the computers data source.
The data sources include related links to test the connection. In this case, it is possible to click Test Load 20 Records to see if data is being retrieved correctly.
If after importing data the State is Complete and the Completion Code is Success, it means that the connection has been configured correctly. In any other case, you should check the previous configuration to detect why it is not working. To perform this task, the system logs are very useful.