Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.

Publisher and Consumer Guidelines

Overview​

DataService provides loosely-coupled data-exchange among integrated applications (also registered as data-sources). Data integration works on the tenant scope, i.e. in the workspace of given customer. Data can be published and consumed using REST API calls and notification messages can almost immediatelly inform consumers about their changes via message broker.

Etiquette​

Publisher​

Publisher is any application which publishes data to virtual data-models.

  • Customer must confirm user consent to publish data from application via integration platform.
  • Publisher is responsible for consistency of published data (i.e. update any outdated data and delete no longer valid data).
    • Note: data can be in any format like json, string, xml or binary.
  • Publisher should read operation results from Operating Log and evaluate severity of result,
    • especially important are validation results (warning or error) and publisher should inform user about consumer's problems to process data

Consumer​

Consumer is any application which consumes data from virtual data-models.

  • Customer must confirm which data to consume by application via integration platform and from which data-source(s).
  • Consumer is responsible for validation of consumed data, because each application ususally has different requirements.
  • Consumer should write operation results to Operating Log and evaluate severity of result,
    • especially important are validation results (warning or error) to inform publisher about problems to process data