Service Configuration

The Service Configuration page can be reached by an Administrator via the Service Configuration section in the System tab.

If you are a Site AdministratorClosed The site administrator role has access to all administrative capabilities. you can configure 1Data Gateway's connection to 1Integrate.

Service Config tab with the fields filled.

Parameter

Description

Base URI

The base path for your 1Integrate installation, usually a URL location.

Authentication Mode - Username and Password

Username

The Username for the 1Integrate server you are using.

Password

The Password for the 1Integrate server you are using.

Authentication Mode - API Key

API Key

The API Authentication Key for the 1Integrate server you are using.

      Note: If users will be making API calls please refer to 1Integrate Permissions below.

Input the connection details and use Test Connection button to ensure the connection is valid, and then save with Save Settings button. Testing the connection will check the compatibility of the 1Integrate version. A green banner shows support for the 1Integrate version, amber shows if the version is untested, while red shows for versions that are not compatible with the 1Data Gateway version being used.

1Integrate test connection success banner with compatability details.

Closed1Integrate Permissions

The following permissions (roles) must be made available to the API Key used to authenticate 1Integrate:

1int-datastores-read, 1int-datastores-write, 1int-sessions-control, 1int-sessions-read, 1int-sessions-results, and 1int-sessions-write.

The group permissions 1int-user and 1int-admin both contain the required permissions but also contain permissions that are not necessary for 1Data Gateway.

For more information on 1Integrate permissions and APIs please refer to the 1Integrate Documentation.

ClosedClear Capabilities

The 1Integrate connection can be refreshed by clearing the Capabilities Cache.

Doing this will mean that any changes made in 1Integrate since the connection was first established will be picked up upon reconnection.

Clear Capabilities Cache button and warning text.

For information on 1Integrate, please refer to the 1Integrate documentation.