Command Line Interface

This documentation covers the functionality of the ExtraView Command Line Interface (CLI ).

This document is intended for the experienced computer user who has a good understanding of either the UNIX, Linux, Microsoft Windows NT or the Microsoft Windows 2000 environments from which they will use the Command Line Interface (CLI). To take maximum advantage of the features offered by the CLI, knowledge of languages such as Perl and HTML are helpful.

If you intend to modify the behavior of ExtraView with user custom programming, you will need to be skilled in coding with the Java language. In addition, ExtraView administration skills are required to configure many of the functions offered.

The CLI is implemented on top of the RESTful API which is described in the Application Programming Interface guide. The key features of the CLI are:

  • Insert, update and delete records in the ExtraView database from remote applications
  • Search the ExtraView database and return a set of records defined in a query
  • Export information from the ExtraView database for input to a data warehouse
  • Upload and download file attachments to and from the ExtraView database
  • Provide limited administration access to create metadata and to manage user accounts
  • Show the names of fields within the ExtraView database to which the user has access
  • Provide high-level links via URLs from third-party applications that have no knowledge of ExtraView.

Downloadable PDF

The Command Line Interface Guide is downloadable as a single PDF by clicking here. You will need the Adobe Acrobat Reader to view this.