Interfaces

Under interfaces you define every outbound connection the add-on needs – databases, file shares and web services. For ECM-Connect the DocuWare server connection matters most; queries additionally use the ODBC connections.

What is this for?

• Maintain connections centrally instead of repeating them in every configuration.
• Keep credentials in one place.
• Reference the connection by its key in queries and configurations.

How to set it up

1. Create a new interface and pick the type.
2. Enter server, port and database/path.
3. Provide credentials under user and password; tick HTTPS for an encrypted connection.
4. For token-based services also fill in application ID, client key, auth endpoint, token endpoint and redirect URL.
5. Activate the record – the interface is then available for selection.

Fields of the form

Captions taken from the "Interfaces" form (table @NCSODBC).

Field	Meaning
Type	Kind of connection (database, file, web service).
Server	Server or host of the remote end.
Port	Port of the connection.
Format	Data format of the transfer.
Database/Path	Database or path on the remote end.
User	User for the sign-in.
Password	Password; stored encrypted.
Active	Enables the record. Only active records are evaluated.
Configuration	Unique key of the configuration.
HTTPS	Use an encrypted connection.
Description	Descriptive name of the record.
Direction	Direction of the connection (read, write, both).
Version	Version of the remote end or interface.
Filename	File name for file-based connections.
Application ID	Application identifier for token-based sign-in.
Client key	Key of the application.
Auth endpont	Address used for authorisation.
Token endpoint	Address issuing the token.
Redirect URL	Return address after sign-in.
Tenant ID
Connection test
Parameter
Protocol
Use proxy
Proxy server
Authentication
Trusted domain
Trusted user
Trusted password
Scopes
Token store path
Sandbox
Module
API token
not set
Refresh token
Timeout (s)
Remote path
Host key