The header at the top of the app and the status bar at the bottom stay in the same place on the home screen, in projects and in the management screens. In the header you open other screens from the app menu, move between the projects you opened, and check your account and notifications. In the status bar you see the tasks running in the background and information about the tab you are looking at.
What's on the screen
| No. | Name | Description |
|---|---|---|
| 1 | App menu button | Opens screens from the , , and items. See 'App menu' below. |
| 2 | Logo and version | Click the logo to go to the home screen. The version of the app you are using is next to it. When the desktop app has downloaded a new version, a button to restart and update appears next to it. |
| 3 | Work tab bar | On the desktop app, the projects and management screens you opened sit here as tabs. The tab of the visible project holds the Project Settings and AI Settings buttons, plus the Collaborate button for an account project. See Work tabs. |
| 4 | User menu | Without signing in it shows your operating system user name and a LOCAL mark; when signed in, your account name and plan. See 'User menu' below. |
| 5 | Report a bug button | Opens the Report a Bug panel. You can send a report without signing in (Bug report). |
| 6 | Notifications button | Shows notices and notifications. A count appears when there are unread ones. See 'Notifications' below. |
The header of the web app is slightly different.
- There is no work tab bar. When you open a project, its name appears next to the logo, followed by the project buttons (Collaborate, Project Settings and so on).
- There is a Desktop App button on the right. It opens the NeoSQL website in a new window.
- On screens that are not work tabs (such as database project management), the name of the screen appears next to the logo. The desktop app does the same.
App menu
Click the button at the far left of the header to open the app menu. Hover over an item to open its submenu.
| No. | Item | What it does |
|---|---|---|
| 1 | The item opens the new project window (New project). The item opens a screen that lists your projects in a table (Home). | |
| 2 | Shows up to five projects you opened recently; click one to open it. The item is missing when there are no projects you can open. | |
| 3 | The item and the item (Data dictionary manager). | |
| 4 | The item and the item (Template packs). |
While you are signed in, there is also a item at the bottom of the menu. It is the same as the item in the user menu (Sign-up and sign-in). In the desktop app, there is a item below the Template Pack item that checks whether a new version is available. How a new version is installed is described in Install and update.
User menu
Click the user display at the right of the header to open it.
| State | Display | Menu |
|---|---|---|
| Desktop app, not signed in | Your operating system user name and a LOCAL mark. The name is only shown on screen and is not sent to the server. | The My Page item and the Sign In item |
| Signed in | Your account name (profile picture) and plan name | The My Page item and the Sign Out item |
- The My Page item opens the My page window (My page).
- The Sign In item goes to the sign-in screen. How to sign in is in First run.
Notifications
Click the notifications button in the header to open the Notifications window. What you see depends on whether you are signed in.
| State | What you see |
|---|---|
| Not signed in | Only notices sent to all users. Click a title to expand it. Read marks are stored on this device. |
| Signed in | Notices together with notifications for your account (project and workspace invitations, DDL approval requests and so on). Filter with the All, Invitations, Admin and Unread tabs at the top, and mark everything as read with the Mark all as read button. On the Invitations tab you can select several invitations and accept them at once. |
The app shows important notices in a window of their own, even if you do not open the Notifications window. When a notification is linked to a screen, a button in the notification takes you there.
Status bar
| No. | Name | Description |
|---|---|---|
| 1 | Background Processes button | Shows No background tasks when nothing is running, or the number of running tasks. Its color changes when a task failed. Click it to open the Background Processes window. |
| 2 | Background Processes window | Shows the progress and results of long-running tasks such as exports and update downloads. Connection and schema metadata tasks also appear when they take longer. |
| 3 | Location of the current tab | Shows which project, connection, database and schema the tab you are looking at belongs to, and what it shows. |
| 4 | Information about the current tab | Depending on the kind of tab, values such as the cursor position, the number of selected characters, the number of loaded rows and the transaction mode. |
Use the buttons according to the task status:
Stop a running task with the Cancel button.
Remove a finished task with the Remove button.
Retry a failed task with the Retry button, or copy its error with the Copy error button.
On desktop, open the folder of a task that produced a file with the Show in folder button.
Remove all finished tasks with the Clear finished button.
When a task starts or ends, the Background Processes window opens by itself for a few seconds and then closes. A failed task keeps it open longer than a successful one so that you can read the error. It stays open while the pointer is over it.
When the window opens by itself, it shows only running tasks and the tasks that just started or ended. Click the Show earlier tasks (n) button at the bottom of the window to see earlier tasks. When you open the window yourself with the button (1) in the status bar, it shows all tasks and does not close by itself.
Only one row is kept for the same connection or schema. When a retried task appears or a retry succeeds, the earlier result is removed. The Retry button of a failed connection task does the same as the menu in the explorer.
A task started in another project carries that project's name. If that project is open as a work tab, click the name to go to that tab.
When the server cannot be reached
When you are signed in and the app cannot reach the NeoSQL server to load your plan and account projects, a notice bar appears below the header. Click the Retry button to load them again. When the connection comes back, the bar disappears by itself. You can keep using local projects in the meantime.
Things to keep in mind
- The update button next to the version and the item exist only in the installed desktop app. The web app is always the latest version.
- In the project screen,
Ctrl+IorCmd+Iopens and closes the AI Assistant panel (AI Assistant). The work tab shortcuts are in Work tabs, and the full list is in Keyboard shortcuts. - The Background Processes window keeps the task list only while the app is running. If you need to see where an exported file went, check before closing the app.
Related screens
- Home: the screen the logo takes you to.
- Work tabs: the tab bar in the middle of the header.
- My page: the window you open from the user menu.
- Bug report: the panel the bug report button in the header opens.
- Project screen layout: the project screen below the header.
- Install and update: how to check for and apply updates.