Documentation Center

Viz Pilot User Guide

Version 8.2 | Published July 23, 2018 ©

Pilot Data Server Web Interface

The Pilot Data Server has a Web Interface which can be used to access several of the Pilot Data Server’s features, including the Service Document, Template and Data Element Feeds, Viz Pilot Settings and REST API documentation.

images/download/attachments/28386234/pilotdataserver_dataserver_home.png

To access the Pilot Data Server Web Interface

  • Select the Pilot Data Server Web Interface from the Windows Start Menu.

  • Alternatively, start the Pilot Data Server in a browser, using the host name of the machine running the Pilot Data Server, and port 8177.
    e.g. http://dataserver.example:8177

The Pilot Data Server Home page has links to the following resources:

  • Service

  • Template Feed

  • Data Element Feed

  • Settings

  • Examples

  • Documentation

Service

The Service Document resource (eg. http://<dataserver.example>:8177/service) is an Atom Service Document which can be used by a client to discover the capabilities of a Pilot Data Server and the locations of the available Atom Publishing Protocol collections hosted on it.

Template Feed

The Template Feed resource (eg. http://<dataserver.example>:8177/templates) is an atom feed which contains entries for each template stored in the Pilot Data Server.

Metadata may include details of the template such as description, creation date, link to a thumbnail image and link to the Viz Data Format (VDF) model document describing the template.

Data Element Feed

The Data Element Feed resource (eg. http://<dataserver.example>:8177/dataelements) is an atom feed which contains entries for each data element stored in the Pilot Data Server.

Metadata may include details of the data element such as description, creation date, link to thumbnails and link to the Viz Data Format (VDF) payload document describing the data element.

Settings

The Settings page (eg. http://<dataserver.example>:8177/settings) is used to configure VCP Parameters and Tag Settings. See Setting Parameters using Pilot Data Server for a full description of the Settings tab.

Examples

The Examples page (eg. http://<dataserver.example>:8177/examples) contains examples on how to interact with the Viz Pilot system.

Documentation

The Pilot Data Server Documentation page (eg. http://<dataserver.example>:8177/help) describes the REST API provided by the Pilot Data Server. It includes information on the Resource Types and Content Types that are used in the interface.

The API itself has several features, for example, getting template information, image search and person search. It provides a programming interface for other systems.