Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new edit mode in dashboards #1978

Merged
merged 2 commits into from
Aug 28, 2024
+24 −23
Merged

Add new edit mode in dashboards #1978

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c53c05
add new edit mode to dashboards.md
ka0ula Aug 28, 2024
d9eed51
Update dashboards.md
ka0ula Aug 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 24 additions & 23 deletions docs/xdr/features/report/dashboards.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ When auto-refresh is enabled, all widgets on the dashboard will automatically re

These options allow you to maintain the most relevant data on your dashboard, whether you prefer manual control or automated updates.

## Create a new dashboard

## Create new Dashboard
### Create from scratch
The default Sekoia.io dashboard cannot be edited. However, you can create your own dashboards to meet your needs.
To do so, several widgets are available to you with the possibility to configure and add multiple filters to them.
Expand All @@ -56,6 +56,7 @@ To create a new dashboard, you have to:
5. Click on `Add widget` and select a widget from the list in the right panel
6. Drag the needed widget in the workspace and edit it following your needs
7. Click on `Save`

To access your dashboards, you have to click on the name of the dashboard in the upper left of the screen and choose a dashboard from the list.

!!! note
Expand All @@ -69,38 +70,38 @@ You can also create a new dashboard by duplicating an existing one. To do so:
3. Click on `Duplicate this dashboard`
4. Rename your dashboard and give it a description
5. Edit the widgets you want and change the layout if needed
6. Save your changes.
6. Save your changes

## Edit and add Widgets to a Dashboard
Dashboards can be easily customized using a variety of widgets, allowing users to tailor the interface to their specific needs.
The customization process is intuitive and accessible through the "Edition Mode," where users can modify, add, or remove widgets on their dashboards.
### Delete a dashboard

To start customizing a dashboard, follow these steps:
To delete a dashboard, you have to:

1. Click the `Edit Dashboard` Button:
Located at the top right corner of the dashboard, this button activates the "Edition Mode."
1. Go to the `Settings` button in the upper right of the screen
2. Click on `Delete this dashboard`

2. Customize Existing Widgets:
Once in "Edition Mode" each widget on the dashboard will display a small edit icon. Click this icon to modify the settings of the widget according to your needs.
The Default Dashboard cannot be deleted.

3. Adding New Widgets:
To add a new widget, click on the `New widget` button. You will be presented with options to choose from a selection of built-in widgets and query builders.
After selecting the desired widget or query builder, you can drag and position it anywhere on the dashboard for optimal placement.
## Add, edit and organize widgets

4. Removing Widgets:
Unwanted widgets can be removed by clicking the delete icon that appears in the widget's options during "Edition Mode"
Dashboards can be easily customized using a variety of widgets, allowing users to tailor the interface to their specific needs.

5. Saving Changes:
After making all desired modifications, it is crucial to save your changes. To do this, click on the `Save` button, located at the top right corner of the dashboard.
If changes are not saved, any modifications made during "Edition Mode" will be lost.
### Add widgets

## Delete a Dashboard
To delete a dashboard, you have to:
To add widgets to your dashboard, click on the `Add New Widget` button located in the top right corner of the screen. From the panel, select the desired widgets from the available queries and presets.

1. Go to the `Settings` button in the upper right of the screen
2. Click on `Delete this dashboard`
### Edit widgets

The Default Dashboard cannot be deleted.
To edit an existing widget, click the `three dots` in the upper right corner of the widget, and then select **Edit Widget**.

- If the widget is a **query visualization**, you will be redirected to the query settings page, where you can edit the query parameters as needed.
- If the widget is a **preset** from the widgets' library, the editing panel will appear, allowing you to adjust options such as the time range or visualization type.

### Reorganize widgets

To reorganize the layout of widgets on your dashboard, click the `Edit button` in the top right corner of the screen. This mode enables you to change both the position and size of each widget. You can easily drag and drop widgets to your preferred locations. Don’t forget to click Save to apply your changes!
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don’t forget to click Save to apply your changes!


### Remove widgets
To remove widgets from your dashboard, click the `three dots` and select **Delete from dashboard**.

## Query Builders Widgets

Expand Down
Loading