Configuration Documents

A configuration document provides the configuration details for a single OMAG Server. It defines which subsystems are activated in the server and which connector implementations it should use.

Configuration document structure

An OMAG Server’s configuration document is structured into elements that each describe the configuration properties for each of its desired capabilities.

Figure 1 provides more details.

Figure 1

Figure 1: Structure of the configuration document

The sections are as follows:

Default Values

At the top of the configuration document are Local Server URL Root and Event Bus Config.

Both of these elements provide default values for other configuration elements.

If they are changed, their new values do not affect existing definitions in the configuration document.

Basic Properties for any OMAG Server

Services for specific types of OMAG Server

Audit Trail

The audit trail allows you to keep track of changes to the configuration document. This is helpful what any recent changes might have been - particularly if a working server suddenly stops working - the first question is always, “what has changed recently?”.

It also acts as a nice summary of how the server has been configured.

Below is an example of an audit trail:

{
 "auditTrail" : [
    "Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for local server's URL root to http://localhost:8081.",
    "Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for maximum page size to 100.",
    "Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for local server type name to Open Metadata Server.",
    "Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for local server's owning organization's name to Coco Pharmaceuticals.",
    "Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for local server's userId to cocoMDS1npa.",
    "Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for local server's password to cocoMDS1passw0rd.",
    "Thu Jan 30 22:37:12 GMT 2020 garygeeke added configuration for an Open Metadata Server Security Connector",
    "Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for default event bus.",
    "Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for the local repository.",
    "Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for the local repository.",
    "Thu Jan 30 22:37:12 GMT 2020 garygeeke preserving local metadata collection id bfdfdc61-01bb-4564-9c29-6b81c0fb79f8.",
    "Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for cohort cocoCohort.",
    "Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for access services.",
    "Thu Jan 30 22:37:12 GMT 2020 garygeeke updated configuration for enterprise repository services (used by access services).",
    "Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for access services.",
    "Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for enterprise repository services (used by access services).",
    "Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for access services.",
    "Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for enterprise repository services (used by access services).",
    "Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for access services.",
    "Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for enterprise repository services (used by access services).",
    "Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for access services.",
    "Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for enterprise repository services (used by access services).",
    "Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for access services.",
    "Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for enterprise repository services (used by access services).",
    "Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for access services.",
    "Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for enterprise repository services (used by access services).",
    "Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for access services.",
    "Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for enterprise repository services (used by access services).",
    "Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for access services.",
    "Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for enterprise repository services (used by access services).",
    "Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for access services.",
    "Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for enterprise repository services (used by access services).",
    "Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for access services.",
    "Thu Jan 30 22:37:13 GMT 2020 garygeeke updated configuration for enterprise repository services (used by access services).",
    "Thu Jan 30 22:44:10 GMT 2020 garygeeke deployed configuration for server."
 ]
}

Storage of the configuration document

By default the configuration document are stored as JSON in a file in the default directory for the OMAG Server Platform that creates them.

These files may contain security certificates and passwords and so should be treated as sensitive. It is possible to change the storage location of configuration documents - or even the type of store. See Configuration document Store Connector for more information.

Further reading


Return to Administration Services Concepts


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