Systems

A system component represents a computer system that can provide data entities. Its task is to provide common properties and services that can be used by several data sources, such as connection pooling, authentication settings, communication protocol settings and so on.

You can manage any secret property values you do not want to be exposed in the API (or in log files) by using the Secrets manager API.

Note: as with pipe components, you are not allowed to use the forward slash character (“/”) in system id’s.

All systems share a number of common properties:

Prototype

{
    "_id": "a_system_id",
    "type": "system:some-type-of-system",
    "name": "The Foo System",
    "description": "This is a description of the system",
    "comment": "This is a comment",
    "worker_threads": 10,
    "metadata": {
       "some_key": "some_value"
    }
}

Properties

Property

Type

Description

Default

Req

_id

String

A unique ID identifying the system. Any pipe sink or source that uses the system must have a corresponding system property matching this value.

Yes

name

String

A human readable name for this system

description

String or list of strings

A human readable description of the component (optional).

comment

String or list of strings

A human readable comment on the component (optional).

metadata

Object<string, Object>

A object providing metadata for the system. The keys are strings while the values can be any valid JSON object (literals, lists or other objects).

worker_threads

Integer

The maximum number of concurrent pipes running using this system

10