Web-CLI Operations

Inputing UQL in the Web-CLI will trigger pop-up lists of available commands and parameters, different components of a UQL statement will show in different color; linefeed is allowed in the UQL.

Ultipa Web-CLI executes UQL one at a time upon clicking the 'Play' button to the right end; historical UQLs can be listed by clicking the 'History' icon. The records are listed in time descending order, clicking any record will copy the UQL into the CLI:

Result Tab Operations

The result of each execution of UQL will be recoreded in the current result tab. Open more tabs by clicking the 'Split' icon for better comparision between results of different UQLs:

The UQL history of each tab is folded on the top of the tab, users can retrieve any UQL command and its query result by clicking the UQL record and its return values. Clicking the 'Edit' icon will copy the UQL into the CLI:

The query results are displayed below the uQL in both List View and Graph View.

List View

The list view shows the query result in a traditional table-like view. It can display nodes, edges and paths. Query result of nodes and edges are by default displayed in list view.

Node List

Observe the list view of 'Find Nodes' result. The nodes in the list can be edited or deleted:

Edge list

Observe the list view of 'Find Edges' result. The edges in the list can be edited or deleted; use the Node Selector, an advanced tool for editing the From Node and the To Node of an edge:

For example, click the icon to the right of To Node and popup the Node Selector, input the filtering condition of node in the curly brackets and hit 'Enter', in the search results click any record to select that node as the To Node:

Note: the Node Selector searches for nodes by executing find().nodes(<filter>) as nodes return nodes limit <m>, where the value of limit could be edited in the Setting module from the sidebar.

Path List

Observe the list view of 'A-B Path Finding' result. The nodes and edges that line up alternatively in each path can be edited or deleted in the similar way as instroduced above. Click a node or edge in a path to evoke the operation menu:

In this example, the nodes in the paths are labeled using their values of property 'name', while the edges are labeled using their values of property '_uuid'. The edge label can be adjusted for better intuitiveness. Go to Setting to reset edge label:

Shown in the above screenshot, the edge label is using property 'name', and because the edges have no such property hence Ultipa Manager uses '_uuid' as edge label in the list view.

Modify the setting and use 'schema' as edge label, and check the list view again:

Using schema as label property name means to use schema name as label.

Other Result

Other types of query result such as values, tables, etc., will be displayed in non-editable table format.

Graph View

The graph view visualizes the query result using a 2D or 3D sub-graph which is more intuitive than list or table. Besides editing, deleting and setting labels of nodes and edges, the graph view of query result facilitates users with a lot more operations against meta-data, such as adjusting layout style, creating meta-data in drag-drop manner and appending search result to the current result.

Graph view can display nodes and paths. Query result of paths is by default displayed in 2D view.

2D Graph

The toolbar in a 2D view result tab contains:

Icon	Description
	Locate nodes in current result tab
	Switch to 3D view
	Open meta-data style panel

Locate Nodes

Switch the result of 'Find Nodes' to 2D graphic view:

Ultipa Manager supports secondary search for nodes in 2D view, highlight the found nodes and center them in the tab:

• search for one node by node property '_uuid'
• fulltext search for multiple nodes by node property 'name'

Note: the method of fulltext search by node 'name' does NOT require a fulltext index of node property 'name' to be created; it only requires the graphset to have a node property called 'name' with data type 'string'.

Meta-data Style

Observe the 2D view of 'A-B Path Finding' result:

The edges are using _uuid as label; change the edge label to edge schema following below steps:

• click icon in the toolbar;
• edit style 'default', which is currently in use;
• in the popup panel switch to substyle 'edge--default', and check the box in front of 'Display Schema' at the lower right corner:

Default substyles 'node-default' and 'edge-schema' cannot be renamed or added with new filtering rules, only the style such as color, shape and display can be edited.

Confirm the changes and check the edge label on the graph view:

Add multiple substyles under a style to better describe the query result. Each substyle can have its own color, shape, size/width, and label display, filtering rules are also included as many as needed to cover all the nodes or edges to which the substyle is applicable.

Choose the correct meta-data type when creating substyle:

Add filtering rules under the substyle:

A properly adjusted meta-data style helps highlight the imformation that users want to emphasize of a sub-graph. Below style empahsizes the relationship 'follow' and the start/end node of paths:

Node Operations

Operations on nodes in the 2D view includes:

Note:

• if a node is not locked, it moves when other nodes in the sub-graph move, and it will NOT move with other nodes if it is 'locked';
• the info bar, if not locked, will hide when the hover ends;
• see below descriptions for left/right-click menus.

A screenshot of left-click menu of node in 2D view:

Options in the left-click menu:

Note: editing and deleting node in the 2D view are similar to that in the list view.

See an example of 'Spread' operation:

Find a node and run its 2D view, spread the node via left-click menu:

Three paths are drawn as the maximum number of return is 3. Go to Setting and edit the value of 'Limit' to 5:

Spread the node again and two more paths are drawn:

A screenshot of right-click menu of node in 2D view:

Options in the right-click menu:

Note: a hidden node and its edges will not be drawn again in the same result tab, but this will not affect the function 'Spread' in the left-click menu.

See an example of 'New Edge' operation:

Edge Operations

Operations on edges in the 2D view includes:

A screenshot of left-click menu of edge in 2D view:

Options in the left-click menu:

Note: editing and deleting edge in the 2D view are similar to that in the list view.

Blank Area Operations

Operations on the blank area of the 2D view includes:

A screenshot of right-click menu of blank area in 2D view:

Options in the right-click menu:

See an example of 'Collapse/Expand Edges' operation:

3D Graph

Ultipa Manager automatically display complex query results in 3D space. Users can also switch a 2D view to 3D mode as per needs.

The toolbar in a 3D view result tab contains:

Icon	Description
	Switch to 2D view
	Open meta-data style panel

Meta-data Style

Style settings in the 3D view only support node color and meta-data display label. Nodes are drawn into dot with size 20, and edges are drawn into gray line with width 1.

Node Operations

Operations on nodes in the 3D view includes:

A screenshot of left-click menu of node in 3D view:

Options in the above menu are same with those in a 2D view.

Edge Operations

Operations on edges in the 3D view includes:

Blank Area Operations

Operations on the blank area of the 3D view includes: