Documentation Center

Pilot Data Server Administrator Guide

Version PDS-8.8 | Published December 21, 2021 ©

Web Interface

The Pilot Data Server web interface offers access to features including the Service Document, Template and Data Element Feeds, Viz Pilot Settings and REST API documentation.

images/download/attachments/85886690/pilotdataserver_dataserver_home.png

Accessing 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. For example: http://dataserver.example:8177

Service

The Service Document resource (for example: http://<dataserver.example>:8177/service) is an Atom Service Document that 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 (for example: http://<dataserver.example>:8177/templates) is an atom feed that 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 (for example: http://<dataserver.example>:8177/dataelements) is an atom feed that contains entries for each data element stored in 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 (for example: http://<dataserver.example>:8177/settings) is used to configure VCP Parameters and Tag Settings. See Setting Parameters for a full description of the Settings tab.

Examples

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

Documentation

The Pilot Data Server Documentation page (for example: http://<dataserver.example>:8177/help) describes the REST API provided by Pilot Data Server. The page includes information on the Resource Types and Content Types that are used in the interface. The API itself lets you access template information, perform image search and person search, and provides a programing interface for other systems.