The basic server properties are used in logging and events originating from the server. They help to document the purpose of the server (which helps with problem determination) and enable performance improvements by allowing the server to ignore activity or metadata that is not relevant to its operation.
Property
Description
localServerDescription
Description for the server. This is useful information for the administrator to understand the role of the server. The default value is null.
organizationName
Descriptive name for the organization that owns the local server/repository. This is useful when the open metadata repository cluster consists of metadata servers from different organizations, or different departments of an enterprise. The default value is null.
localServerUserId
UserId to use for server-initiated REST calls. The default is OMAGServer.
localServerPassword
Password to use for server-initiated REST calls. The default is null. This means that only the userId is sent in the HTTP header.
localServerURL
The URL of the platform where the server is to be deployed. It should be the value used by external services to call the server since its broadcast across an open metadata repository cohort and used when deploying the server's configuration document to the correct platform.
maxPageSize
The maximum page size that can be set on requests to the server. The default value is 1000. A value of zero means unlimited page size. Although supported, the zero value is not recommended because it provides no protection from a large request denial of service attack.
Typically, these values are set up in a single command.
setBasicServerProperties
Set up the basic server properties in a single request. If any values are left blank, they are cleared in the server configuration document.
StringadminUserId="garygeeke";StringserverName="active-metadata-server"StringadminPlatformURLRoot="https://127.0.0.1:9443";OMAGServerConfigurationClientconfigurationClient=newOMAGServerConfigurationClient(adminUserId,serverName,adminPlatformURLRoot);StringorganizationName="Coco Pharmaceuticals";StringserverDescription="This server supports the governance teams";StringserverUserId="cocomds2npa";StringserverPassword="secret";StringserverURLRoot="https://localhost:9443"intmaxPageSize=1000configurationClient.setBasicServerProperties(organizationName,serverDescription,serverUserId,serverPassword,serverURLRoot,maxPageSize);
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)local_server_description="This server supports the governance teams"organization_name="Coco Pharmaceuticals"local_server_url="https://127.0.0.1:9443"local_server_user_id="cocomds2npa"local_server_password="secret"max_page_size=1000config_client.set_basic_server_properties(local_server_description,organization_name,local_server_url,local_server_user_id,local_server_password,max_page_size)
POST {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/server-properties
with a request body of:
{"localServerDescription":"This server supports the governance teams","organizationName":"Coco Pharmaceuticals","localServerURL":"https://localhost:9443","localServerUserId":"cocomds2npa","localServerPassword":"secret","maxPageSize":600}
Alternatively, you can set these properties one at a time.
setServerDescription
The server description should be set to something that describes the OMAG Server's role. It may be the name of a specific product that it is enabling, or a role in the metadata and governance landscape. Its purpose is to help administrators identify which server configuration they need to work with.
POST {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/server-description
The description is passed in the request body as a text string.
setOrganizationName
The organization name may be the owning organization or you may use it to identify the department or team that is supported by this server.
POST {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/organization-name?name="{{organizationName}}"
setServerUserId
The server's userId is used when processing requests that do not have an end user, such as receiving an event from a topic. The default value is OMAGServer. Ideally each server should have its own userId, so it is possible to restrict the resources that each server has access to and identify the origin of updates to the metadata elements.
POST {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/server-user-id?id="{{serverUserId}}"
setServerPassword
If the password is specified, the userId and password combination are used to provide authentication information on each REST call made by the server.
POST {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/server-user-password?password="{{serverUserPassword}}"
setServerURLRoot
Configure the targetPlatformURLRoot with the platform URL Root value of where the OMAG Server Platform will run.
This may not be the same as platformURLRoot if the configuration document will be deployed to a different OMAG Server Platform from the one used to maintain it.
POST {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/server-url-root?url={{targetPlatformURLRoot}}
What is the difference between {{platformURLRoot}} and {{targetPlatformURLRoot}}?
The {{targetPlatformURLRoot}} gives the location of the OMAG Server Platform on which this configured service is intended to run, while the {{platformURLRoot}} gives the location of the OMAG Server Platform in which this configuration document is maintained.
They could be, but do not need to be, the same location.
setMaxPageSize
The maximum page size value sets an upper limit on the number of results that a caller can request on any paging REST API to this server. Setting maximum page size helps to prevent a denial of service attack that uses very large requests to overwhelm the server. A value of 0 means no limit, and leaves the server open to such attacks.
POST {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/max-page-size?limit={{maxPageSize}}
An OMAG Server uses an event bus such as Apache Kafka to exchange events with other servers and tools.
Egeria manages the specific topic names and the event payloads; however, it needs to know where the event bus is deployed and any properties needed to configure it.
Since the event bus is used in multiple places, the configuration document allows you to set up the details of the event bus which are then incorporated into all the places where the event bus is needed.
Important sequencing information
You need to set up this information before configuring any of the following:
Using an event topic as the destination for the audit log.
The following command creates information about the event bus. This information is used on the subsequent configuration of the OMAG Server subsystems. It does not affect any subsystems that have already been configured in the configuration document and if the event bus is not needed, its values are ignored.
It is possible to add arbitrary name/value pairs as JSON in the request body. The correct properties to use are defined in the connector type for the event bus.
For example, when using Apache Kafka as your event bus you may want to configure properties that control the behavior of the consumer that receives events and the producer that sends events. This is a typical set of producer and consumer properties:
Egeria's audit log provides a configurable set of destinations for audit records and other diagnostic logging for an OMAG Server. Some destinations also support a query interface to allow an administrator to understand how the server is running.
Each audit log record has a severity that can be used to route it to one or more specific destinations. Therefore, when an audit log destination is configured, it is optionally supplied with a list of severities to filter the types of audit log records it should receive.
The audit log severities are as follows:
Severity
Description
Information
The server is providing information about its normal operation.
Event
An event was received from another member of the open metadata repository cohort.
Decision
A decision has been made related to the interaction of the local metadata repository and the rest of the cohort.
Action
An Action is required by the administrator. At a minimum, the situation needs to be investigated and if necessary, corrective action taken.
Error
An error occurred, possibly caused by an incompatibility between the local metadata repository and one of the remote repositories. The local repository may restrict some of the metadata interchange functions as a result.
Exception
An unexpected exception occurred. This means that the server needs some administration attention to correct configuration or fix a logic error because it is not operating as a proper peer in the open metadata repository cohort.
Security
Unauthorized access to a service or metadata instance has been attempted.
Startup
A new component is starting up.
Shutdown
An existing component is shutting down.
Asset
An auditable action relating to an asset has been taken.
Types
Activity is occurring that relates to the open metadata types in use by this server.
Cohort
The server is exchanging registration information about an open metadata repository cohort that it is connecting to.
Trace
This is additional information on the operation of the server that may be of assistance in debugging a problem. It is not normally logged to any destination, but can be added when needed.
PerfMon
This log record contains performance monitoring timing information for specific types of processing. It is not normally logged to any destination, but can be added when needed.
<Unknown>
Uninitialized Severity
The default audit log destination is the console audit log destination. This writes selected parts of each audit log record to "standard out" (stdout).
It is configured to receive log records of all severities except Activity, Event, Trace and PerfMon. It is added automatically to a server's configuration document when other sections are configured.
If the server is a development or test server, then the default audit log configuration is probably sufficient, and you should use the following command:
Note: Using this command overrides all previous audit log destinations configured for the server.
If this server is a production server then you will probably want to set up the audit log destinations explicitly. You can add multiple destinations and each one can be set up to receive different severities of audit log records.
There are various destinations that can be configured for the audit log:
Since the default audit log destination is also a console audit log destination, only use this option to add the Trace and PerfMon severities.
The body of the request should be a list of severities
If an empty list is passed as the request body then all severities are supported by the destination.
This writes full log records to the slf4j ecosystem. When configuring slf4j as destination you also need to specify audit log logger category via the application properties of the OMAG Server Platform. This is described in Connecting the OMAG Audit Log Framework section of the developer logging guide.
The configuration of the slf4j ecosystem determines it ultimate destination(s).
The body of the request should be a list of severities
If an empty list is passed as the request body then all severities are supported by the destination.
This sets up an audit log destination that is described though a connection. In this case, the connection is passed in the request body and the supported severities are supplied in the connection's configuration properties.
It is also possible to set up all the audit log destinations in one command as a list of connections. Using this option overrides all previous audit log destinations and so can be used as the update command. The list of connections is passed in the request body and the supported severities are supplied in each connection's configuration properties.
POST - add a list of connection-based audit log destinations
Security is configured for a specific OMAG Server by adding a connection for this connector to the server's configuration documentusing the following command.
Open Metadata View Services (OMVSs) provide task-oriented, domain-specific REST API services for user interfaces, and other non-Java programming environments, such as python, that integrate with the open metadata ecosystem. The view services call a metadata access server to send and retrieve metadata.
To get a description of each of the view services that are supported by an OMAG Server Platform, list the registered view services.
List registered view services
The registered view services for an OMAG Server Platform are the view services whose implementation is included in the platform's classpath:
{"class":"RegisteredOMAGServicesResponse","relatedHTTPCode":200,"services":[{"serviceId":800,"serviceName":"Glossary Author OMVS","serviceDevelopmentStatus":"IN_DEVELOPMENT","serviceURLMarker":"glossary-author","serviceDescription":"View Service for glossary authoring.","serviceWiki":"https://egeria-project.org/services/omvs/glossary-author/overview"},{"serviceId":803,"serviceName":"Dynamic Infrastructure and Operations OMVS","serviceDevelopmentStatus":"TECHNICAL_PREVIEW","serviceURLMarker":"dino","serviceDescription":"Explore and operate an open metadata ecosystem.","serviceWiki":"https://egeria-project.org/services/omvs/dino/overview"},{"serviceId":801,"serviceName":"Repository Explorer OMVS","serviceDevelopmentStatus":"TECHNICAL_PREVIEW","serviceURLMarker":"rex","serviceDescription":"Explore open metadata instances.","serviceWiki":"https://egeria-project.org/services/omvs/rex/overview"},{"serviceId":806,"serviceName":"Glossary Manager OMVS","serviceDevelopmentStatus":"IN_DEVELOPMENT","serviceURLMarker":"glossary-manager","serviceDescription":"Create glossary terms and organize them into categories as part of a controlled workflow process. It supports the editing glossary and multiple states.","serviceWiki":"https://egeria-project.org/services/omvs/glossary-manager/overview/"},{"serviceId":807,"serviceName":"My Profile OMVS","serviceDevelopmentStatus":"IN_DEVELOPMENT","serviceURLMarker":"my-profile","serviceDescription":"Manage information about the logged on user as well as their preferences.","serviceWiki":"https://egeria-project.org/services/omvs/my-profile/overview/"},{"serviceId":802,"serviceName":"Type Explorer OMVS","serviceDevelopmentStatus":"TECHNICAL_PREVIEW","serviceURLMarker":"tex","serviceDescription":"Explore the open metadata types in a repository or cohort.","serviceWiki":"https://egeria-project.org/services/omvs/tex/overview"},{"serviceId":804,"serviceName":"Server Author OMVS","serviceDevelopmentStatus":"IN_DEVELOPMENT","serviceURLMarker":"server-author","serviceDescription":"Author server configuration.","serviceWiki":"https://egeria-project.org/services/omvs/server-author/overview/"},{"serviceId":805,"serviceName":"Glossary Browser OMVS","serviceDevelopmentStatus":"IN_DEVELOPMENT","serviceURLMarker":"glossary-browser","serviceDescription":"View glossary terms and categories within a glossary.","serviceWiki":"https://egeria-project.org/services/omvs/glossary-browser/overview/"},{"serviceId":808,"serviceName":"Asset Catalog OMVS","serviceDevelopmentStatus":"IN_DEVELOPMENT","serviceURLMarker":"asset-catalog","serviceDescription":"Search and understand your assets.","serviceWiki":"https://egeria-project.org/services/omvs/asset-catalog/overview/"}]}
The values returned for each registered view service are:
Property
Use
serviceId
Unique identifier of the service.
serviceName
Name of the service, used in messages and documentation.
serviceDevelopmentStatus
Describes the relative maturity of the view service.
serviceURLMarker
Returns the unique name for the view service used in REST API URLs to identify a particular view service.
serviceDescription
Returns a short description of the view service to help you choose which ones you want.
serviceWiki
Link to the documentation for the view service.
To activate a specific view service in a view server, add an entry for the view service to the view server's configuration document.
View services can be configured into a view server either altogether or individually.
A specific view service can be individually configured with the following command. Listing the registered view services is a good way to discover the serviceURLMarker values used when configuring individual view services.
Again the request body must contain a ViewServiceRequestBody object. This object is used to configure each of the registered view services.
The ViewServiceRequestBody used on either of these requests contains 4 pieces of information:
omagServerName - the name of the metadata access server that is to provide the metadata services to the view service.
omagServerPlatformRootURL - platform URL root where the metadata access server is running.
viewServiceOptions - optional list of specific options used to configure the behaviour of the view service.
resourceEndpoints - a list of ResourceEndpointConfig objects. These objects are used to configure dropdowns on calling user interfaces used to select a specific OMAG Server Platform or OMAG Server that the UI is to connect to. The aim is to control which platforms and servers can be selected.
A resource endpoint describing a platform contains the following properties:
Property
Use
resourceCategory
required property, set to "Platform".
platformName
required property, a unique name given to a "Platform" resource.
platformURLRoot
required property, the URL root used to call the "Platform" resource.
description
optional property that is displayed by some view services.
A resource endpoint describing an OMAG Server has the following properties:
Property
Use
resourceCategory
required property, set to "Server"
platformName
required property, a reference to a named "Platform" resource endpoint describing where the "Server" resource is located.
serverName
required property, set to the name of the OMAG Server.
serverInstanceName
required property, a unique name for the combination of server and platform.
description
optional property describing the server.
Example ViewServiceRequestBody
{"class":"ViewServiceRequestBody","omagserverName":"active-metadata-store","omagserverPlatformRootURL":"https://localhost:9443","resourceEndpoints":[{"class":"ResourceEndpointConfig","resourceCategory":"Platform","platformName":"Platform:9443","platformRootURL":"http://localhost:9443","description":"This is the default OMAG Server Platform."},{"class":"ResourceEndpointConfig","resourceCategory":"Server","platformName":"Platform:9443","serverInstanceName":"Active Metadata Access Store","serverName":"active-metadata-store","description":"Metadata server with XTDB repository and supporting Apache Kafka notifications."},{"class":"ResourceEndpointConfig","resourceCategory":"Server","platformName":"Platform:9443","serverInstanceName":"Simple Metadata Access Store","serverName":"simple-metadata-store","description":"Metadata server with in-memory repository and no event notifications."},{"class":"ResourceEndpointConfig","resourceCategory":"Server","platformName":"Platform:9443","serverInstanceName":"Integration Daemon","serverName":"integration-daemon","description":"Integration daemon supporting the synchronization of metadata with thrid party platfrms and tools."},{"class":"ResourceEndpointConfig","resourceCategory":"Server","platformName":"Platform:9443","serverInstanceName":"Engine Host","serverName":"engine-host","description":"Engine host server running the AssetSurvey and Asset Governance governance engines."},{"class":"ResourceEndpointConfig","resourceCategory":"Server","platformName":"Platform:9443","serverInstanceName":"View Server","serverName":"view-server","description":"View server providing REST API support to user interfaces and non-Java environments."}]}
It is possible to list the configured view services for a view Server using the following command:
The response will be a RegisteredOMAGServicesResponse which contains a list of RegisteredOMAGService objects, that will look something like the following:
{"class":"RegisteredOMAGServicesResponse","relatedHTTPCode":200,"services":[{"serviceId":800,"serviceName":"Glossary Author OMVS","serviceDevelopmentStatus":"IN_DEVELOPMENT","serviceURLMarker":"glossary-author","serviceDescription":"View Service for glossary authoring.","serviceWiki":"https://egeria-project.org/services/omvs/glossary-author/overview"},{"serviceId":803,"serviceName":"Dynamic Infrastructure and Operations OMVS","serviceDevelopmentStatus":"TECHNICAL_PREVIEW","serviceURLMarker":"dino","serviceDescription":"Explore and operate an open metadata ecosystem.","serviceWiki":"https://egeria-project.org/services/omvs/dino/overview"},{"serviceId":801,"serviceName":"Repository Explorer OMVS","serviceDevelopmentStatus":"TECHNICAL_PREVIEW","serviceURLMarker":"rex","serviceDescription":"Explore open metadata instances.","serviceWiki":"https://egeria-project.org/services/omvs/rex/overview"},{"serviceId":806,"serviceName":"Glossary Manager OMVS","serviceDevelopmentStatus":"IN_DEVELOPMENT","serviceURLMarker":"glossary-manager","serviceDescription":"Create glossary terms and organize them into categories as part of a controlled workflow process. It supports the editing glossary and multiple states.","serviceWiki":"https://egeria-project.org/services/omvs/glossary-manager/overview/"},{"serviceId":807,"serviceName":"My Profile OMVS","serviceDevelopmentStatus":"IN_DEVELOPMENT","serviceURLMarker":"my-profile","serviceDescription":"Manage information about the logged on user as well as their preferences.","serviceWiki":"https://egeria-project.org/services/omvs/my-profile/overview/"},{"serviceId":802,"serviceName":"Type Explorer OMVS","serviceDevelopmentStatus":"TECHNICAL_PREVIEW","serviceURLMarker":"tex","serviceDescription":"Explore the open metadata types in a repository or cohort.","serviceWiki":"https://egeria-project.org/services/omvs/tex/overview"},{"serviceId":804,"serviceName":"Server Author OMVS","serviceDevelopmentStatus":"IN_DEVELOPMENT","serviceURLMarker":"server-author","serviceDescription":"Author server configuration.","serviceWiki":"https://egeria-project.org/services/omvs/server-author/overview/"},{"serviceId":805,"serviceName":"Glossary Browser OMVS","serviceDevelopmentStatus":"IN_DEVELOPMENT","serviceURLMarker":"glossary-browser","serviceDescription":"View glossary terms and categories within a glossary.","serviceWiki":"https://egeria-project.org/services/omvs/glossary-browser/overview/"},{"serviceId":808,"serviceName":"Asset Catalog OMVS","serviceDevelopmentStatus":"IN_DEVELOPMENT","serviceURLMarker":"asset-catalog","serviceDescription":"Search and understand your assets.","serviceWiki":"https://egeria-project.org/services/omvs/asset-catalog/overview/"}]}
It is also possible to retrieve the full configuration for the view services. This contains the additional information provided by the platform.
GET - retrieve a specific view service's configuration
