Connector Configuration

General Connector Configuration

A Connector needs a Java class that implements the operations every Connector must provide. The SBCS Master Data Hub comes preconfigured with some Connector implementations that are described below.

Enter the complete Java class name of the Connector implementation you want to use into the field Connector Java Class:

SBCS Master Data Hub Connector Java Class

After entering the Java class name of an existing Connector implementation, the system will fill rows in the Properties table.

Connector Properties

SBCS Master Data Hub Connector Properties

Every Connector requires a set of configuration properties to works. The system will fill the rows of the Properties table with all properties available for the chosen Connector implementation. Sensible default values are set, too. You should change the configuration property values to suit your environment.

Changed properties are automatically saved when the focus leaves the table cell.

Included Connectors

The SBCS Master Data Hub comes prepackaged with three Connector implementations. Other implementations are available or you can implement your own.

EspoCRM Connector

Classname: de.ecm4u.mdh.connector.EspoConnector

The EspoCRM Connector allows to read and write from/to an EspoCRM instance.

There are six properties that configure how to access the EspoCRM REST API.

  • EspoConnector.apiProtocol: the protocol to use (default https)
  • EspoConnector.apiHost: the hostname (default espo.example.com)
  • EspoConnector.apiPort: the port (default 443)
  • EspoConnector.apiUrl: the path of the REST API URL (default /api/v1)
  • EspoConnector.username: the username to use (default admin)
  • EspoConnector.password: the password to use (default secret)

Two properties configure a cache inside the SBCS Master Data Hub that keeps retrieved Entity Instances.

  • EspoConnector.cacheHeapSize: How many items to keep in the cache (default: 1000)
  • EspoConnector.cacheTTLInSeconds: How many seconds is an item kept in the cache (default: 60)

SBCS Forms and Workflows Server Connector

Classname: de.ecm4u.mdh.connector.FaWConnector

The SBCS Forms and Workflows Server Connector allows to read data from an FaW Server.

There are five properties that configure how to access the FaW Server REST API.

  • FaWConnector.apiProtocol: the protocl to use (default https)
  • FaWConnector.apiHost: the hostname (default faw.example.com)
  • FaWConnector.apiUrl: the path of the REST API URL (default /api/v1)
  • FaWConnector.cookie: the name of the HTTP cookie that stores the JWT (default ecm4u-jwt), see SBCS Login Server JWT
  • FaWConnector.jwt: the long lived JWT send as the value of the cookie to authenticate and authorize requests (default none)

Two properties configure a cache inside the SBCS Master Data Hub that keeps retrieved Entity Instances.

  • FaWConnector.shortCacheHeapSize: How many items are kept in the cache (default: 1000)
  • FaWConnector.shortCacheTTLInSeconds: How many seconds is an item kept in the cache (default: 10)

Redmine Connector

Classname: de.ecm4u.mdh.connector.RedmineConnector

The Redmine Connector allows to read data from a Redmine instance.

There are five properties taht configure how to access the Redmine REST API.

  • RedmineCOnnector.apiProtocol: the protocol to use (default https)
  • RedmineCOnnector.apiHost: the hostname (default redmine.example.com)
  • RedmineCOnnector.apiUrl: the path of the REST API URL (default /redmine)
  • RedmineCOnnector.username: the username to use (default admin)
  • RedmineCOnnector.password: the password to use (default secret)

Four properties configure a short and a long living cache inside the SBCS Master Data Hub that keep retrieved Entity Instances.

  • RedmineCOnnector.shortCacheHeapSize: How many items are kept in the short lived cache (default 1000)
  • RedmineCOnnector.shortCacheTTLInSeconds: How many seconds is an item kept in the short lived cache (default 600)
  • RedmineCOnnector.longCacheHeapSize: How many items are kept in the long lived cache (default 1000)
  • RedmineCOnnector.longCacheTTLInSeconds: How many seconds is an item kept in the short lived cache (default 360)