Web UI¶
Introduction¶
Register and login¶
Registering an Account (Sign Up)¶
- Navigate to the Registration page by clicking the Register button on the login screen.
-
Enter your email address in the "Email" field.
-
Create a password and enter it in the "Password" field. You can click the eye icon to view the password as you type and Confirm your password by re-entering it in the "Confirm Password" field.
-
Click the Register button to submit your registration details.
-
After successful registration, you can return to the login page by clicking the Back to Login button.
Logging In (Sign In)¶
- Open the Depictio Login page.
- Enter your email address in the "Email" field.
- Enter your password in the "Password" field.
- If you want to see the password as you type it, click the eye icon next to the password field.
- Once both fields are filled in, click the Login button.
- You will be redirected to the Depictio landing page (currently
/dashboards
).
Landing page / Dashboards section (/dashboards)¶
Creating a New Dashboard¶
- On the landing page, click the orange "+ New Dashboard" button located in the top right corner.
- A pop-up window will appear with a field labeled "Dashboard Title".
- Enter a name for your new dashboard.
- Your dashboard will be created with the title you provided and added to the section.
- Click the blue "Create Dashboard" button to create the dashboard.
- The new dashboard will appear in the section with informations including name, owner and status (public/private).
Functionalities¶
Viewing a Dashboard¶
- Once a dashboard is created, it will appear under the section.
- Click the "View" button next to the dashboard name to open and explore its content.
Deleting a Dashboard¶
- To delete a dashboard, locate the dashboard in the section.
- Click the red "Delete" button next to the dashboard name.
- A confirmation pop-up will appear, asking "Are you sure you want to delete this dashboard?".
- Click "Delete" to permanently remove the dashboard, or "Cancel" to keep it.
Editing dashboard name¶
- To edit the name of a dashboard, locate the dashboard in the section.
- Click the "Edit name" button next to the dashboard name.
- A pop-up window will appear with a field labeled "New name".
- Enter a new name for your dashboard.
- Click the blue "Save" button to save the new name.
Duplicating a dashboard¶
- To duplicate a dashboard, locate the dashboard in the section.
- Click the "Duplicate" button next to the dashboard name.
- The dashboard will be duplicated and added to the section with the suffix "(copy)".
Note
Both "public" and "private" dashboards are listed in the Dashboards section. Public dashboards are accessible to all users, while private dashboards are only visible to the user who created them. Only the user who created a private dashboard can edit, or delete it.Projects section (/projects)¶
- The left sidebar includes a "Projects" section where users can manage their projects. Click on "Projects" to navigate and view them.
You will have access recursively to the workflows related to the project and the data collections related to each of the workflows. Each entity will allow you to access the details of the entity, to see the related configuration used, as well as previsualize the data (for data collections of type table
).
User Information (/profile)¶
- At the bottom of the left sidebar, you will find:
- Server status: Displays the current server version and online status.
- User information: Displays your username and email (e.g.,
test_user@example.com
).
About section (/about)¶
The About section provides information about the GitHub repository and the documentation.
Admin section (/admin)¶
The Admin section is only accessible to users with admin privileges. It allows admins to view users, projects and dashboards. The Users tab displays a list of all users registered in the system, while the Dashboards tab displays a list of all dashboards. The Projects tab is currently under development.