Administrative Console Features

Administration console is a Python application built on top of TIBCO Graph Database Python client API. The administrative console supports familiar python keyboard handling & user experience.This section covers the general features of the tool.

Auto Complete

The 3.0 Administration Console now supports auto-complete. To start auto-completing press CTRL-i or TAB. If there are multiple options available, then a list will be presented to the user. To iterate through this list, press CTRL-i, TAB, or SPACE to go down the list or SHIFT-TAB to go up the list.

Auto complete

Syntax coloring

The 3.0 Administration Console now supports syntax coloring. These colors tokens are similar the same way to break up a command to more easily digest. There are three different styles of syntax coloring, pictured below in order, are default, vim, and emacs. The command to set the syntax coloring is set (admin|gremlin)_pallet = (default|vim|emacs)

Syntax coloring

Syntax Validation

The 3.0 Administration Console now supports syntax validation. This prevents the user from submitting an improperly formatted command by showing an error message, not accepting the command, and placing the cursor at the location of the first error (at the end of the token that causes the issue).

Syntax validation

Layout

The 3.0 Administration Console displays dense information, like the output of the info command, in a grid-like fashion that adapts to the width of the terminal to improve usability and digestibility.

Layout

Gremlin Queries

The 3.0 Administration Console fully supports Gremlin Queries and will attempt to intelligently layout each query result in an intelligent manner. The user can change the number of elements displayed at the top level via the set gremlin_outlen = <NUM_ELEMENTS>

Gremlin queries

Admin Properties

The following properties are available to set locally on the 3.0 Administration Console to change the look, feel, and behavior.
Name Acceptable Values Default Description
loglevel

(info|user|debug|debugfine|

debugfiner)[componenet_name

info The log level for the 3.0 Administration Console.
gremlin_pallet (default|vim|emacs) default Sets the syntax coloring style for Gremlin Queries
admin_pallet (default|vim|emacs) default Sets the syntax coloring style for Administration Commands
separator <special_character> ; Sets the separator for determining the ending of a command.
gremlin_outlen number> 5 The number of elements in the outermost collection of the gremlin query to display.