Skip to content

Configuring an OMAG Server

An OMAG Server is a configured set of services and connectors that support the integration of a particular type of technology. This configuration is located in a configuration document that is stored in the configuration document store.

The configuration document is divided into sections. Each section described the configuration of a particular OMAG Subsystem. The configuration document for a specific OMAG Server determines which OMAG subsystems (and hence the types of services) should be activated in the OMAG Server.

There are different types of OMAG Server each with a specific purpose. They then may call to one another once they are running. The server types define the combination of subsystems that need to be active to perform a particular role in the open metadata ecosystem. This means, the configuration document for each type of server, will have different sections filled out.

Configuration Document Sections

Many of the configuration values are connections to allow the server to create the connectors to the digital resources it needs.

These connectors enable Egeria to run in different deployment environments and to connect to different third party technologies.

Connector types supported by the OMAG Servers

Retrieving the configuration document

It is possible to retrieve whole configuration document for a server either as a single structure, or by section. This first command retrieves the whole configuration document.

getStoredConfiguration

Return the stored configuration document for the server.

String adminUserId = "garygeeke";
String serverName = "active-metadata-server"
String adminPlatformURLRoot = "https://127.0.0.1:9443";

OMAGServerConfigurationClient configurationClient = new ConfigurationManagementClient(adminUserId, 
                                                                                      adminPlatformURLRoot);

OMAGServerConfig omagServerConfig = configurationClient.getOMAGServerConfig(serverName);

admin_user_id="garygeeke"
server_name="active-metadata-store"
admin_platform_url_root="https://127.0.0.1:9443"

config_client=CoreServerConfig(server_name,
                               admin_platform_url_root,
                               admin_user_id)

config_client.get_stored_configuration()

GET {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/configuration

This next command retrieves the basic server properties.

getBasicServerProperties

Return the basic server properties in a single request.

String adminUserId = "garygeeke";
String serverName = "active-metadata-server"
String adminPlatformURLRoot = "https://127.0.0.1:9443";

OMAGServerConfigurationClient configurationClient = new OMAGServerConfigurationClient(adminUserId, 
                                                                                      serverName, 
                                                                                      adminPlatformURLRoot);

BasicServerProperties basicServerProperties = configurationClient.getBasicServerProperties();

admin_user_id="garygeeke"
server_name="active-metadata-store"
admin_platform_url_root="https://127.0.0.1:9443"

config_client=CoreServerConfig(server_name,
                               admin_platform_url_root,
                               admin_user_id)

config_client.get_basic_server_properties()

GET {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/server-properties

GET - retrieve the origin of the server

It is also possible to query the origin of the server supporting the open metadata services. For the Egeria OMAG Server Platform, the response is Egeria OMAG Server Platform (version {{releaseName}}).

{{platformURLRoot}}/open-metadata/platform-services/users/{{adminUserId}}/servers/{{serverName}}/server-platform-origin

Raise an issue or comment below