/geoportal-server

FGDC Service Checker Integration

zguo edited this page Jul 8, 2017 · 3 revisions
Clone this wiki locally

The FGDC Service Checker Integration is a feature available as of Geoportal Server version 1.2.2. Hosted by FGDC, the FGDC Service Checker service provides a web service to monitor the availability of registered geospatial web services. This topic will describe how your Geoportal Server instance can be configured to integrate with the FGDC Service Checker service to get and show availability statistics of the registered web services to your users.

When a Geoportal Server instance is configured with FGDC Service Checker service, the FGDC Service Checker service will communicate with the Geoportal server instance and get the list of registered services to monitor from the instance, and start to test and collect the service availability information for each service. The availability statistics will be available on the FGDC Service Checker site, and, as an option, you can request to get a regular email notice for the statistics of your services.

Please visit the FGDC Service Checker site for supported geospatial web service types and other information of FGDC Service Status Checker service.

Table of Contents

How to Enable the FGDC Service Checker Integration

The FGDC Service Checker is only available when your organization has acquired an API key from FGDC for the service checker functionality, and configured in the gpt.xml file that the FGDC Service Checker should appear.

Registration steps to get API key

  • You will need to access your geoportal's ATOM feed service to register for your API Key. Check that the ATOM feed service in your geoportal site is working - it is accessible at http://{base_URL}/{context URL}/Eros.
    • For example, http://server/geoportal/Eros.
    • Note, this URL is protected and only users in the geoportal administrator group can access to the URL. Start with geoportal 1.2.8, a public EROS end-point /geoportal/ErosPublic has also been added.
  • Visit the FGDC Status Checker website and create an account.
  • Register the ATOM feed service URL of your geoportal in the Status Checker website. Important: It is required to register the geoportal administrator account with the URL because the URL is protected and the FGDC Service Checker service needs to use the credentials when it accessing the URL.
  • Request an API key from the Status Checker website and get the API key.
  • Proceed to the next section below to update the gpt.xml file to enable the integration with the geoportal.

Configure the FGDC Service Checker integration in the geoportal

  • After receiving the API key, open the \\geoportal\WEB-INF\classes\gpt\config\gpt.xml file.
  • Find the section for the FGDC Service Checker services.
  • Update the parameters in that section as desired:
    • servicechecker.enabled: designates that the service checker functionality is enabled. Set to "true" to enable.
    • servicechecker.token: the FGDC token provided when you contacted the FGDC Status Checker website.
    • servicechecker.checkUrl: Set this to the service checker URL. For the FGDC Service Checker, the URL is http://registry.fgdc.gov/statuschecker/api/v2/results
    • servicechecker.infoUrl: Set this to the service checker information display URL. For the FGDC Service Checker, the URL is http://registry.fgdc.gov/statuschecker/ServiceDetail.php.
  • After changing these settings, save the gpt.xml file and restart your geoportal web application to see the changes take effect.

Verify the FGDC Service Checker is configured correctly

  • Do a search on live map services within geoportal.
  • Verify the existence of a status icon for these services in the search result page.
  • Click on the status icon and verify it show the status and statistics of the service.
Back to Customizations