Configuring the Open Metadata Integration Services (OMIS)

The integration services (or Open Metadata Integration Services (OMISs) to give them their full name) run in an Integration Daemon.

Each integration service hosts one or more integration connectors. An integration connector is responsible for the exchange of metadata with a specific deployment of a third party technology. For example, the Database Integrator integration service supports integration connectors that work with relational databases (RDBMS). A deployment of this integration service in an integration daemon may host, say, two integration connectors each loading metadata from their own relational database server.

It is possible to get a description of each of the registered integration services using the following command:

GET {platformURLRoot}/open-metadata/platform-services/users/{userId}/server-platform/registered-services/integration-services

Note the integrationServiceURLMarker for the integration service that you want to configure.

Figure 1 shows the structure of the configuration for an individual integration service.

Figure 1

Figure 1: The configuration document contents for an integration service

The descriptive information and operational status are filled out automatically by the administration services based on the integrationServiceURLMarker value that you supply. The other values are supplied on the configuration call.

Each integration service is configured with the network location of the Metadata Access Point / Metadata Server running the appropriate Open Metadata Access Service. There are a set of options that the integration service supports along with the list of configuration properties for the integration connectors that will be run in the integration service. The integration connector’s configuration properties defines which connector implementation to use and how it should be operated.

POST {platformURLRoot}/open-metadata/admin-services/users/{adminUserId}/servers/{serverName}/integration-services/{integrationServiceURLMarker}
        "class": "IntegrationServiceRequestBody",
        "omagserverPlatformRootURL": "{MDServerURLRoot}",
        "omagserverName" : "{MDServerName}",
        "integrationConnectorConfigs" : [ 
             "class": "IntegrationConnectorConfig",
             "connectorName" : " ... ",             
             "connectorUserId" : " ... ",           
             "connection" : 
                              "class" : "Connection",
                              "connectorType" : 
                                  "class" : "ConnectorType",
                                  "connectorProviderClassName" : "{connector provider class name}"
                              "endpoint" :
                                  "class" : "Endpoint",
                                  "address" : "..."
             "metadataSourceQualifiedName" : " ... ",
             "refreshTimeInterval" : "60", 
             "usesBlockingCalls" : "false",
             "permittedSynchronization" : " ... "
        } ]      


License: CC BY 4.0, Copyright Contributors to the ODPi Egeria project.