Skip to content

Configuration document properties managed by Egeria

The following properties do not need be configured explicitly, the admin services will manage them automatically.

Egeria Managed Properties

Local Server Id

The localServerId is a unique identifier for the server, it is used when accessing resource that require their callers to supply a unique identifier. For example, when an OMAG server is accessing an Apache Kafka topic, it needs to reliably identify itself with a callerId so that the Kafka server knows which events it has received and which it has not. The localServerId is used for this purpose when accessing the open metadata repository cohort topics for example.

Local Server Name

The localServerName is a unique name for the server. This is a name you choose, and the administration services maintains the name in the configuration document.

Local Server Type

The local server type is a classification of the type of the server based on the sections of the configuration document that have been configured. Leave it blank and Egeria will fill it in on server start up. There is also an administration call to query the type of server using the following call:


Return the derived server type that is created from the classification of the server configuration.

String adminUserId = "garygeeke";
String serverName = "active-metadata-server"
String adminPlatformURLRoot = "";

OMAGServerConfigurationClient configurationClient = new OMAGServerConfigurationClient(adminUserId, 

ServerTypeClassificationSummary serverTypeClassification = configurationClient.getServerTypeClassification();
The getServerTypeClassification() method throws OMAGConfigurationErrorException if there is insufficient content in the server's configuration document to determine the type of server.




GET {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/server-type-classification
If there is insufficient content in the server's configuration document, you may get a response like this.
    "class": "ServerClassificationResponse",
    "relatedHTTPCode": 500,
    "exceptionClassName": "org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException",
    "exceptionCausedBy": "org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException",
    "actionDescription": "getServerTypeClassification",
    "exceptionErrorMessage": "OMAG-ADMIN-500-001 Method getServerTypeClassification for OMAG server active-metadata-store returned an unexpected exception of org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException with message OMAG-ADMIN-400-019 OMAG server active-metadata-store has been called with a configuration document that has no services configured",
    "exceptionErrorMessageId": "OMAG-ADMIN-500-001",
    "exceptionErrorMessageParameters": [
        "OMAG-ADMIN-400-019 OMAG server active-metadata-store has been called with a configuration document that has no services configured"
    "exceptionSystemAction": "The function requested failed.",
    "exceptionUserAction": "This is likely to be either a configuration, operational or logic error. Validate the request. Look at the user action for the embedded exception since this will provide the most specific information."

Audit Trail

The audit trail lists the admin commands that have been issued against the configuration document. It is useful in tracking down when changes occurred, particularly when diagnosing problems in the configuration.

Raise an issue or comment below