diff --git a/site/docs/guides/admin/configuring-the-omag-server-platform.md b/site/docs/guides/admin/configuring-the-omag-server-platform.md index 4edd437835..56a2c218c1 100644 --- a/site/docs/guides/admin/configuring-the-omag-server-platform.md +++ b/site/docs/guides/admin/configuring-the-omag-server-platform.md @@ -3,12 +3,12 @@ # Configuring the OMAG Server Platform -The [OMAG Server Platform](/concepts/omag-server-platform) is a JVM process that includes a Tomcat web server and uses [Spring Boot :material-dock-window:](https://spring.io/){ target=spring } to support its REST APIs. The Egeria code is in the centre of this and, through configuration, starts up plug-in components called [connectors](/concepts/connector). +The [OMAG Server Platform](/concepts/omag-server-platform) is a JVM process that includes a Tomcat web server and uses [Spring Boot :material-dock-window:](https://spring.io/){ target=spring } to support its REST APIs. The Egeria code is in the centre of this. Through configuration, Egeria starts up plug-in components called [connectors](/concepts/connector) and coordinates calls to them to manage and exchange metadata. ![OMAG Server Platform Onion](omag-server-platform-onion.svg) > High-level structure of the OMAG Server Platform -The behaviour of these components is influenced by: +The behaviour of the OMAG Server Platform components is influenced by: * The command line properties passed when the platform is started. * The contents of the `application.properties` file (or their environment variable equivalents). diff --git a/site/docs/guides/admin/servers/configuring-the-view-services.md b/site/docs/guides/admin/servers/configuring-the-view-services.md index fbc061ec94..062e4b8dc9 100644 --- a/site/docs/guides/admin/servers/configuring-the-view-services.md +++ b/site/docs/guides/admin/servers/configuring-the-view-services.md @@ -3,198 +3,229 @@ ## Configure the view services -The [Open Metadata View Services (OMVS's)](/services/view) run in a [view server](/concepts/view-server). +The [Open Metadata View Services (OMVSs)](/services/view) only run in a [view server](/concepts/view-server). -View services provide task-oriented, domain-specific services for user interfaces that integrate with open metadata. View services are part of a multi-tier architecture for the provision of multi-tenant user interfaces. The front tier consists of web components that are rendered in a web browser and served by a web application called the [presentation server :material-dock-window:](https://github.com/odpi/egeria-react-ui){ target=react }. The presentation server in turn delegates requests to a set of _view services_ that form a second tier running in the view server. Each view service exposes a REST API that supports the domain-specific operations relevant to the service and issues queries and commands to other OMAG Servers. +View services 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](/concepts/metadata-access-server) to send and retrieve metadata. -To get a description of each of the registered view services, and each service's `viewServiceURLMarker`, see [list view services](#list-view-services) instructions below. +To get a description of each of the view services that are supported by an [OMAG Server platform](/concepts/omag-server-platform), list the registered view services. -To activate a specific view service in a view server, it is necessary to add an entry for the view service to the view server's configuration document. - -![Configuration document contents for a view service](/concepts/view-service-config.svg) - -The descriptive information and operational status are filled out automatically by the administration services based on the `viewServiceURLMarker` value that you supply. The other values are supplied on the configuration call. - -There are two types of view services, each with a different type of view service configuration object: +???+ info "List registered view services" + The registered view services for an [OMAG Server Platform](/concepts/omag-server-platform) are the view services whose implementation is included in the platform's classpath: + + !!! get "GET - list registered view services" + ``` + {{platformURLRoot}}/open-metadata/platform-services/users/{{adminUserId}}/server-platform/registered-services/view-services + ``` + + ??? success "Response from listing registered view services" + ```json + { + "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 Workflow OMVS", + "serviceDevelopmentStatus": "IN_DEVELOPMENT", + "serviceURLMarker": "glossary-workflow", + "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-workflow/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: -### Solution view services +| 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. | -A *solution view service* supports operations needed by a solution-oriented user interface. These are typically geared toward a specific [Open Metadata Access Service (OMAS)](/services/omas). For example, the Glossary Author view service supports a user interface for creation and management of glossaries using the Subject Area OMAS. +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 solution view service is configured using a `SolutionViewServiceConfig` object which has the following properties: +=== "Configure a single view service" -| Property | Use | -|---|---| -| `viewServiceId` | required property, set to a unique numeric identifier | -| `viewServiceAdminClass` | required property, set to the admin class of the view service | -| `viewServiceName` | required property, set to the name of the view service being configured | -| `viewServiceFullName` | required property, set to the full name of view service | -| `viewServiceURLMarker` | required property, set to the serviceURL Marker of the service - this can be discovered by [listing the registered view services](#list-view-services) | -| `viewServiceDescription` | optional property that describes the view service | -| `viewServiceWiki` | optional property specifying the location of the view service documentation | -| `viewServiceOperationalStatus` | required property, set to ENABLED or DISABLED | -| `viewServiceOptions` | optional property that specifies options needed by a specific view service (refer to the documentation for the specific service for details) | -| `omagServerPlatformRootURL` | required property (see below) | -| `omagServerName` | required property (see below) | + 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. -A solution view service configuration must include `omagServerPlatformRootURL` and `omagServerName` properties(defined in `OMAGServerClientConfig`). These properties specify the OMAG Server to which to send downstream REST calls to an OMAG Server that is running the OMAS needed by the view service. + !!! post "POST - configure a specific view service" + ``` + {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/view-services/{{serviceURLMarker}} + ``` -!!! example "Example solution view service configuration" - Below is an example of a configuration object for a solution view service. In this example, the view service is [Glossary Author View Service :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/view-services/glossary-author-view){ target=gh }. It would be similar for the other solution view services. - - The configuration contains the name and status of the view service and contains the name and rootURL of the OMAG Server to which 'downstream' requests will be sent. In this example the 'downstream' server is the server running the Subject Area OMAS, required by the Glossary Author view service. + The request body must contain a `ViewServiceRequestBody` object, while the `serviceURLMarker` can + be found by [listing the registered view services](#list-configured-view-services). - ``` - { - "class":"SolutionViewServiceConfig", - "viewServiceAdminClass":"org.odpi.openmetadata.viewservices.glossaryauthor.admin.GlossaryAuthorViewAdmin", - "viewServiceFullName":"Glossary Author", - "viewServiceOperationalStatus":"ENABLED", - "omagserverName":"Subject_Area_Server", - "omagserverPlatformRootURL":"https://localhost:8083" - } - ``` +=== "configure all view services" -### Integration view services + It is also possible to configurate a set of view services at the same time, using the following command: -An *integration view service* supports operations needed by an integration-oriented user interface. Examples -include the [Repository Explorer View Service :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/view-services/rex-view){ target=gh }, [Type Explorer View Service :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/view-services/tex-view){ target=gh } or [Dino View Service :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/view-services/dino-view){ target=gh } for operational management. + !!! post "POST - configure multiple view services" + ``` + {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/view-services/configuration + ``` -It additionally has the following configuration properties: + Again the request body must contain a `ViewServiceRequestBody` object. This object is used to configure each of the registered view services. -| Property | Use | -|---|---| -| `viewServiceId` | required property, set to a unique numeric identifier | -| `viewServiceAdminClass` | required property, set to the admin class of the view service | -| `viewServiceName` | required property, set to the name of the view service being configured | -| `viewServiceFullName` | required property, set to the full name of view service | -| `viewServiceURLMarker` | required property, set to the serviceURL marker of the service - this can be discovered by [listing the registered view services](#list-view-services) | -| `viewServiceDescription` | optional property that describes the view service | -| `viewServiceWiki` | optional property specifying the location of the view service documentation | -| `viewServiceOperationalStatus` | required property, set to ENABLED or DISABLED | -| `viewServiceOptions` | optional property that specifies options needed by a specific view service (refer to the documentation for the specific service for details) | -| `resourceEndpoints` | required property that lists the platform and server endpoints of the OMAG Platforms or Servers to which to send downstream REST calls, for example to query metadata repositories (see below) | +The `ViewServiceRequestBody` used on either of these requests contains 4 pieces of information: -An integration view service configuration does not need the `omagServerPlatformRootURL` and `omagServerName` properties that are required for a solution view service configuration. This is because an integration view service will generally need to perform operations routed to a variety of open metadata servers, selected by the user at runtime. The set of platforms and servers that the user can select are configured by the `resourceEndpoints` configuration property. +* `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. -The `resourceEndpoints` property is a list of `ResourceEndpointConfig` objects, which each have the following properties: +A resource endpoint describing a platform contains the following properties: -| Property | Use | -|---|---| -| `resourceCategory` | required property, set to either "Platform" or "Server" | -| `platformName` | required property, a unique name given to a "Platform" resource, or a reference to a named "Platform" resource endpoint from a "Server" resource | -| `serverName` | required property for a "Server" resource, set to the name of the OMAG Server. Not used for a "Platform" resource. | -| `serverInstanceName` | required property for a "Server" resource, a unique name for the combination of server and platform. | -| `description` | optional property that is displayed by some integration view services | +| 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. | -In an Egeria deployment, a server may be deployed to multiple platforms; this is typically used for clustering. A "Server" `ResourceEndpointConfig` must possess a `serverInstanceName` property which contains a unique name that refers to the specific instance of the server identified by the `serverName` property hosted by the platform identified by the `platformName` property. For example, you could configure a pair of server resource endpoints called `Server1@PlatformA` and `Server1@PlatformB`: both are `Server1`, but hosted on different platforms (`PlatformA` and `PlatformB`). The `serverInstanceName` is used to display the resource in the user interface selector lists. +A resource endpoint describing an OMAG Server has the following properties: -!!! example "Example integration view service configuration" - Below is an example of a configuration object for an Integration View Service. In this example, the view service is [Dino View Service :material-github:](https://github.com/odpi/egeria/tree/main/open-metadata-implementation/view-services/dino-view){ target=gh }. It would be similar for the other integration view services. - - The configuration contains the name and status of the view service and contains a list of the resources that will appear in the platform and server selectors in the user interface. All requests to the view service REST API are based on these configured named resources. When a user selects a platform name or server name from the selector lists, the interface sends the resource name to the view service, which resolves the platform or server name to a resource endpoint to identify the URL needed to send a request to the platform or server. +| 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. | - In the example configuration, the list of `ResourceEndpointConfig` objects represents two platforms and two servers. Every `ResourceEndpointConfig` has a `resourceCategory`, set to either `"Platform"` or `"Server"`. Each platform `ResourceEndpointConfig` has a unique `platformName` and `platformRootURL` and an optional `description` property. Each server `ResourceEndpointConfig` has a `serverInstanceName`, `serverName` and the `platformName` of one of the configured platform resource endpoints. Each server also has an optional `description` property. - You would need to replace the `` and `` variables with your own values: +!!! example "Example ViewServiceRequestBody" ```json { - "class":"IntegrationViewServiceConfig", - "viewServiceAdminClass":"org.odpi.openmetadata.viewservices.rex.admin.RexViewAdmin", - "viewServiceFullName":"RepositoryExplorer", - "viewServiceOperationalStatus":"ENABLED", + "class":"ViewServiceRequestBody", + "omagserverName":"active-metadata-store", + "omagserverPlatformRootURL":"http://localhost:9443", "resourceEndpoints" : [ { "class" : "ResourceEndpointConfig", "resourceCategory" : "Platform", - "platformName" : "Platform1", - "platformRootURL" : "https://:", - "description" : "This platform is running in the development cloud" + "platformName" : "Platform:9443", + "platformRootURL" : "http://localhost:9443", + "description" : "This is the default OMAG Server Platform." }, { "class" : "ResourceEndpointConfig", - "resourceCategory" : "Platform", - "platformName" : "Platform2", - "platformRootURL" : "https://:", - "description" : "This platform is running in the departmental test cluster" + "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", - "serverInstanceName" : "Central Metadata Server", - "serverName" : "Metadata_Server1", - "platformName" : "Platform1", - "description" : "Metadata server with home reopsitory for schema artefacts" + "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", - "serverInstanceName" : "Supplementary Metadata Server", - "serverName" : "Metadata_Server2", - "platformName" : "Platform2", - "description" : "Metadata server with home repository for review artefacts" - } - ] - } - ``` - -### Administrative operations - -#### List view services - -It is possible to list the registered view services for an [OMAG Server Platform](/concepts/omag-server-platform) using the following command: - -!!! get "GET - list view services" - ``` - {{platformURLRoot}}/open-metadata/platform-services/users/{{adminUserId}}/server-platform/registered-services/view-services - ``` - -??? success "Response from listing view services" - ```json - { - "class": "RegisteredOMAGServicesResponse", - "relatedHTTPCode": 200, - "services": [ - { - "serviceName": "Glossary Author", - "serviceURLMarker": "glossary-author", - "serviceDescription": "View Service for glossary authoring.", - "serviceWiki": "https://odpi.github.io/egeria/open-metadata-implementation/access-services/subject-area/" - }, - { - "serviceName": "Repository Explorer", - "serviceURLMarker": "rex", - "serviceDescription": "Explore open metadata instances.", - "serviceWiki": "https://odpi.github.io/egeria/open-metadata-implementation/view-services/rex-view/" + "platformName" : "Platform:9443", + "serverInstanceName" : "Integration Daemon", + "serverName" : "integration-daemon", + "description" : "Integration daemon supporting the synchronization of metadata with thrid party platfrms and tools." }, { - "serviceName": "Type Explorer", - "serviceURLMarker": "tex", - "serviceDescription": "Explore the open metadata types.", - "serviceWiki": "https://odpi.github.io/egeria/open-metadata-implementation/view-services/tex-view/" + "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." }, { - "serviceName": "Dino", - "serviceURLMarker": "dino", - "serviceDescription": "Operate an open metadata topology.", - "serviceWiki": "https://odpi.github.io/egeria/open-metadata-implementation/view-services/dino-view/" + "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." } ] } ``` -These view services are available to configure either together or individually. - -This operation is a good way to discover the `serviceURLMarker` property for each view service, which is needed for various operations described below. - -#### List configured view services - -It is possible to list the configured view services for an [OMAG Server](/concepts/omag-server) using the following command: +It is possible to list the configured view services for a view Server using the following command: !!! get "GET - list configured view services" ``` - {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/view-services/configuration + {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/view-services ``` ??? success "Response from listing configured view services" @@ -206,34 +237,83 @@ It is possible to list the configured view services for an [OMAG Server](/concep "relatedHTTPCode": 200, "services": [ { - "serviceName": "Glossary Author", + "serviceId": 800, + "serviceName": "Glossary Author OMVS", + "serviceDevelopmentStatus": "IN_DEVELOPMENT", "serviceURLMarker": "glossary-author", "serviceDescription": "View Service for glossary authoring.", - "serviceWiki": "https://odpi.github.io/egeria/open-metadata-implementation/access-services/subject-area/" + "serviceWiki": "https://egeria-project.org/services/omvs/glossary-author/overview" }, { - "serviceName": "Repository Explorer", + "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://odpi.github.io/egeria/open-metadata-implementation/view-services/rex-view/" + "serviceWiki": "https://egeria-project.org/services/omvs/rex/overview" + }, + { + "serviceId": 806, + "serviceName": "Glossary Workflow OMVS", + "serviceDevelopmentStatus": "IN_DEVELOPMENT", + "serviceURLMarker": "glossary-workflow", + "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-workflow/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/" }, { - "serviceName": "Type Explorer", + "serviceId": 802, + "serviceName": "Type Explorer OMVS", + "serviceDevelopmentStatus": "TECHNICAL_PREVIEW", "serviceURLMarker": "tex", - "serviceDescription": "Explore the open metadata types.", - "serviceWiki": "https://odpi.github.io/egeria/open-metadata-implementation/view-services/tex-view/" + "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. -These view services are available to configure either together or individually. - -#### Retrieve view service configuration - -=== "individually" - - Retrieve a specific view service's configuration: +=== "Retrieving a specific view service's configuration" !!! get "GET - retrieve a specific view service's configuration" ``` @@ -242,9 +322,7 @@ These view services are available to configure either together or individually. The response will be a `ViewServiceConfigResponse` containing a `ViewServiceConfig` object. -=== "multiple" - - It is also possible to retrieve the current configuration for all configured view services: +=== "Retrieving all configured view services' configuration" !!! get "GET - retrieve current configuration for all configured view services" ``` @@ -253,34 +331,13 @@ These view services are available to configure either together or individually. This will return a `ViewServicesResponse` which will contain a list of `ViewServiceConfig` objects. -#### Configure view services - -=== "individually" - - A specific view service can be individually configured with the following command: - - !!! post "POST - configure a specific view service" - ``` - {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/view-services/{{serviceURLMarker}} - ``` - - The request body must contain a `ViewServiceConfig` object, while the `serviceURLMarker` can - be found by [listing the configured view services](#list-configured-view-services). - -=== "multiple" +The structure of the `ViewServiceConfig` object is illustrated below: - It is also possible to configurate a set of view services at the same time, using the following command: - - !!! post "POST - configure multiple view services" - ``` - {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/view-services/configuration - ``` - - The request body must contain a list of `ViewServiceConfig` objects. +![Configuration document contents for a view service](/concepts/view-service-config.svg) -#### Remove view services +Finally, view service configuration can easily be removed from a server configuration document. -=== "individually" +=== "Removing configuration for a single view service" A specific view service can be individually cleared with the following command. This will remove the view service's configuration from the server. @@ -290,9 +347,9 @@ These view services are available to configure either together or individually. {{platformURLRoot}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{serverName}}/view-services/{{serviceURLMarker}} ``` - The `serviceURLMarker` can be found by [listing the configured view services](#list-configured-view-services). + The `serviceURLMarker` can be found by [listing the registered view services](#list-configured-view-services). -=== "multiple" +=== "Removing configuration for all view services" All the view services configured on a server can be cleared with the following command: