Service configuration: Data interface configuration

General

Service configuration plays a central role in integrating the data interface with COGLAS message types. It defines the basic settings and parameters required to ensure smooth communication between the systems.

Input options

Required fields	Description
Name	Name of the service configuration
Client	Client used for the message types
Service URL	URL of the data interface folder with host name as prefix, e.g.: ‘https://xxx.coglas.com/datainterface_xml/’

Optional fields	Description
Description	A brief description of the service configuration
Is deactivated	Checkbox to deactivate the service configuration
Timeout	Time after the query times out
Authentication scheme	Authentication method via API or username & password
Message type configurations	Configuration of message types with version number, automatic sending or retrieval via CURL

(Further input options)	Description
Message type configurations: Version	Specifies the version of the message type
Message type configurations: is auto send	Automatic sending of message types
Message type configurations: is calloff	Calling via CURL command
Authentication Basic	Authentication at a username and password level. Access data is maintained in the Authentication username and Authentication password fields.
Authentication Web API	Authentication via an API key and a secret. API keys and API secrets are maintained via authentication keys and values.
Authentication Client credentials	Authentication via client ID (OAuth 2.0 - client credentials). The corresponding access data can be set: Username (client ID) Password (client_secret) Scope (scope)

Feedback from COGLAS → ITSYSTEM

COGLAS expects a customer-side API interface with the name „**/api/DataInterface/ProcessMessageType“
„**/api/DataInterface/ProcessMessageType“ is automatically appended by COGLAS when directly addressing an endpoint of the web API.
A rewrite URL can be stored in the customer's own web server, e.g. IIS, if the endpoint looks different. Example:
- <system.webServer>
  <rewrite>
  <rules>
  <rule name="Coglas2xxxer">
  <match url="^(?:api/datainterface/processmessagetype$"/>
  <action type="Rewrite" url="xxx/yyyy"/>
  </rule>
  </rules>
  </rewrite>
  </system.webServer>

System role Web-API

To access the data interface, a user in COGLAS is required who has been assigned the role "Web API".
This user is used for the authentication process. The user's password and role are maintained in COGLAS. In addition, the service user is stored with their user name and password in the datainterface web.config to enable access.

Message types configuration

Under Message Type Configurations, you can specify the message type to be used and its version.

Since changes can be made to newer versions of a message type that affect the structure of the message, it is possible to select a specific version. This allows older message types to continue to be used while ensuring compatibility with existing systems.

Detailed explanation:

The “Auto Send” option is used to specify automatic sending of the message type.
The “Is Calloff” option is used to specify whether the message type can be retrieved using the CURL command.
The “+” symbol allows you to add multiple message types for the individual service configuration.

Host feedback for successful receiving:

For correct data receipt by the host, an HTTP 200 successful status message is expected from the host. A specified format is expected for this.

If the format is correct, the interface history is set to ‘successful’.
If the format is incorrect or missing completely, the interface history is set to ‘unsuccessful’.

Expected format from the host for successful receipt of the feedback:

CODE

{
     return Ok(new { received = data, message = "Data received successfully!", Success = true });
}

Warning message

Warning message

Description

Invalid URL

The URL that has been entered does not correspond to a valid URL. e.g. https://xyz.coglas.com/datainterface_json/

Interface history entry unsuccessful

The data arrives, but no successful entry is set in the interface. Then the response must be as follows:

{
return Ok(new { received = data, message = "Data received successfully!", Success = true });
}

→ back to COGLAS processes
→ back to COGLAS menu