InDev

Open Metadata View Services (OMVS)

The Open Metadata View Services (OMVS) provide task oriented, domain-specific services for user interfaces to integrate with open metadata.

The view services are as follows:

Inside an OMVS

User Interfaces can connect to an OMVS through its REST API. The REST API interacts with a remote OMAG Server. The OMVS APIs are deployed together in a single web application.

The administration services provide the ability to configure, start and stop the view services. An example configuration document for a view server called ‘viewserver’, configured to communicate with a remote server called ‘Server1’ is:

{ 
   "class":"OMAGServerConfig",
   "versionId":"V2.0",
   "localServerId":"a8e40a02-a95a-4dce-a5ba-8d4f68298ec9",
   "localServerName":"viewserver",
   "localServerType":"View Server",
   "localServerURL":"https://localhost:9448",
   "localServerUserId":"OMAGServer",
   "maxPageSize":1000,
   "viewServicesConfig":[ 
      { 
         "class":"ViewServiceConfig",
         "viewServiceId":0,
         "viewServiceFullName":"Glossary Author",
         "viewServiceAdminClass":"org.odpi.openmetadata.viewservices.glossaryauthor.admin.GlossaryAuthorViewAdmin",
         "viewServiceOperationalStatus":"ENABLED",
         "omagserverPlatformRootURL":"https://localhost:9443",
         "omagserverName":"Server1"
      }
   ],
   "repositoryServicesConfig":{ 
      "class":"RepositoryServicesConfig",
      "auditLogConnections":[ 
         { 
            "class":"Connection",
            "type":{ 
               "class":"ElementType",
               "elementTypeId":"114e9f8f-5ff3-4c32-bd37-a7eb42712253",
               "elementTypeName":"Connection",
               "elementTypeVersion":1,
               "elementTypeDescription":"A set of properties to identify and configure a connector instance.",
               "elementOrigin":"CONFIGURATION"
            },
            "guid":"5390bf3e-6b38-4eda-b34a-de55ac4252a7",
            "qualifiedName":"DefaultAuditLog.Connection.viewserver",
            "displayName":"DefaultAuditLog.Connection.viewserver",
            "description":"OMRS default audit log connection.",
            "connectorType":{ 
               "class":"ConnectorType",
               "type":{ 
                  "class":"ElementType",
                  "elementTypeId":"954421eb-33a6-462d-a8ca-b5709a1bd0d4",
                  "elementTypeName":"ConnectorType",
                  "elementTypeVersion":1,
                  "elementTypeDescription":"A set of properties describing a type of connector.",
                  "elementOrigin":"LOCAL_COHORT"
               },
               "guid":"4afac741-3dcc-4c60-a4ca-a6dede994e3f",
               "qualifiedName":"Console Audit Log Store Connector",
               "displayName":"Console Audit Log Store Connector",
               "description":"Connector supports logging of audit log messages to stdout.",
               "connectorProviderClassName":"org.odpi.openmetadata.adapters.repositoryservices.auditlogstore.console.ConsoleAuditLogStoreProvider"
            },
            "endpoint":{ 
               "class":"Endpoint",
               "type":{ 
                  "class":"ElementType",
                  "elementTypeId":"dbc20663-d705-4ff0-8424-80c262c6b8e7",
                  "elementTypeName":"Endpoint",
                  "elementTypeVersion":1,
                  "elementTypeDescription":"Description of the network address and related information needed to call a software service.",
                  "elementOrigin":"CONFIGURATION"
               },
               "guid":"836efeae-ab34-4425-89f0-6adf2faa1f2e",
               "qualifiedName":"DefaultAuditLog.Endpoint.viewserver.auditlog",
               "displayName":"DefaultAuditLog.Endpoint.viewserver.auditlog",
               "description":"OMRS default audit log endpoint.",
               "address":"viewserver.auditlog"
            }
         }
      ]
   }
}

Return to open-metadata-implementation.


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