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}}