General layout

This page talks about the general layout of Cypher Workbench.

AppBar

There is an AppBar at the top of the screen that hosts a number of UI elements.

Hamburger Icon

On the far left is the Hamburger Icon, an icon with 3 horizontal bars. Click on it to open the left panel and reveal the names of the tools. Click on it again to close the left panel. The version number of Cypher Workbench is shown when the panel is expanded.

Title

The title for the current graph doc.

Menus

A set of menus specific to the active tool.

Icons

A set of icons on the far right of the AppBar. Includes the Database icon, Cloud icon, and Settings icon.

Database Icon

The database icon has 2 states:

  • Disconnected: The database icon will be shown with an 'x'. Indicates you are not connected to a Neo4j database.

  • Connected: The database icon will be shown with a checkmark. Indicates you are connected to a Neo4j database.

Hovering over the database icon will show your current connection status. Clicking on the icon will bring up the Neo4j connection dialog. See Connecting to Neo4j.

Cloud Icon

Data is automatically saved to a cloud service as you enter data. The icon changes depending on network connectivity and graph doc editing. Here is a description of the icons:

  • Cloud Check: A cloud icon with a check through it indicates that network connectivity is good and all data is saved. Hovering over the icon will show the last time data was saved.

  • Pencil Icon: When you edit data, the cloud icon will change to a pencil icon. After a change, data is saved after 2 seconds if no changes additional are made.

  • Sync Icon: An icon with 2 curved arrows forming a circle indicates that data is actively being written to the cloud service.

  • Cloud Outline: An outlined cloud icon indicates that there is a network issue. Data queued to be saved will be re-tried for 2 minutes. If not successful after 2 minutes, the icon will switch to offline.

  • Cloud Off: A cloud icon with a line through it. Indicates that the network service cannot be reached. Data changes will be written to local web browser storage. You will need to click on the icon periodically to try and reconnect, or refresh the page.

Note: Any data written to local storage will be written to the cloud service once the connection is re-established. You can attempt to re-establish the connection by clicking on the cloud icon or refreshing the page.

Settings Icon

Clicking this will show the user information pop-up. Click it again to close it. Here are the items in the pop-up:

  • Signed in as: Indicates which email address you are logged in as

  • Organization: (Optionally shown). If your user account is authorized for more than one organization, the current organization is shown here, along with a Switch button. To switch organizations see Switching organizations below.

  • Clear Local Storage and Logout: Clears local storage and logs you out. Note: any Neo4j database usernames and passwords will be cleared out when you do this, as well as any locally stored data if you experienced network issues.

  • Logout: Logs you out of Cypher Workbench.

Tools

A list of tools appears in the left hand panel. Click on a tool icon to switch the active tool. See Tools for a current list of tools. The active tool will take up the main part of the window.

Active Tool

The active tool has a small green line on the right and the background will be a light gray.

Panels

Some tools provide expandable and collapsible panels that contain functionality specific to that tool. Here are the common actions for those panels:

  • Collapse/Expand: Double click on the panel bar or click on the arrow icon

  • Resize: When expanded, click and drag on the panel bar to the desired location

The panels, when present, will appear on the right hand side of the window and/or the bottom of the window.

Accordions

Some tools, such as Cypher Suite, contain a set of accordion panels. Across the tools, the accordion panels work similar to one another. Here are the common features:

  • Collapse/Expand: Click the accordion bar or the arrow icon in the bar.

  • Delete: Click on the 'X' icon.

  • Select: Click on the four-corner square icon. An orange border will surround the selected accordion.

  • Insert: A button above the accordions will let you add one (e.g. Add Cypher in Cypher Suite tool). If an accordion is currently selected, the new item will be placed above the selected item. If an accordion is not selected, it will be placed at the end.

  • Move: You can click and drag on the accordion bar to drag it up or down to re-order the accordions. An orange drop zone will appear where you can drop it.

  • Edit Title: Click on the text in the accordion bar to edit the title. Some titles, like those found in Cypher Builder, cannot be edited.

Connecting to an Aura or Neo4j database

In the database dialog, the following fields are available to change as needed:

  • Database: Select a database from the list if you have previously configured it in the Databases tool.

  • URL: Enter a neo4j:// or bolt:// URL here that points to the Neo4j database you want to import from if not already filled out. Note: neo4j+s, neo4j+ssc, bolt+s, and bolt+ssc are also supported.

  • Database Name: Enter the Database Name to import from. Leaving it blank will import from the default database.

  • Encrypted: For a bolt:// URL, turn this switch on if the Neo4j database is SSL-enabled, and you have not specified bolt+s or bolt+ssc.

  • Username: Enter a username if not already filled out.

  • Password: Enter a password if not already filled out.

Click the Connect button to connect. For more information on URLs see Neo4j database types

Switching organizations

If you are part of more than one organization, you can switch organizations. Only one organization is active at any one time, even if you have multiple windows or tabs open at the same time. To switch organizations, follow these steps:

  • Open the Settings pop-up.

  • Click the Switch button. The Switch Organizations dialog will be shown.

  • Pick the desired Organization in the Switch to Organization drop down.

  • Click the Switch button.

  • If you are not immediately logged out, please logout and log back in.

When you log back in, you will be in the Organization you selected.