Editing a Dashboard

WSO2 Dashboard Server (WSO2 DS) allows you to create custom dashboard layouts by adding new blocks, resizing, moving them across the dashboard, and much more. The following are the ways in which an editor can edit a dashboard:

Adding a block to a dashboard 

1. If you are not in the process of creating a dashboard, navigate to the Dashboard Designer home page, and click Design to edit the design of a dashboard.
2. Click Add Block.
   
3. If you want to view the size of the existing blocks in the dashboard, click Show Grid. This displays a grid to gauge the size of the block based on its columns.
4. Enter the width and height of the block in the respective text-boxes, or drag the pointer either vertically, horizontally or diagonally to define the size of the block in the grid.
5. Click Add Block to add the block to the page in the dashboard. 

Adding a gadget to a dashboard 

1. If you are not in the process of creating a dashboard, navigate to the Dashboard Designer home page, and click Design to edit the design of a dashboard.
2. Click on Gadgets. All the available gadgets (i.e., shipped with WSO2 DS and the customized gadgets) appears.
   

3. Drag and drop the gadget into the desired block in the dashboard.

   The visual content of some gadgets (e.g., The "Population by History" gadget, which is part of the drilldown Dashboard sample) only appear after you have enabled gadget to gadget communication.

Repositioning a block in the dashboard 

1. If you are not in the process of creating a dashboard, navigate to the Dashboard Designer home page, and click Design to edit the design of a dashboard. 
2. Hover your pointer over the block title bar, drag the pointer, and release the pointer in a preferred location in the dashboard. 

Resizing a block in the dashboard

1. If you are not in the process of creating a dashboard, navigate to the Dashboard Designer home page, and click Design to edit the design of a dashboard. 
2. Hover your pointer over the bottom-right corner of the block. When the resize button appears together with the diagonal pointer, drag the pointer to resize the dashboard.
   

Maximizing and minimizing the view of a gadget

1. If you are not in the process of creating a dashboard, navigate to the Dashboard Designer home page, and click Design to navigate to the dashboard design mode or click View to navigate to the dashboard view mode.
2. If you want to view a gadget in a dashboard in full screen, click on the Maximize button.
   The gadget appears in full screen as shown below.
   
   To revert to the standard view of the gadget, click on the Minimize button.
   

Updating page properties

When creating a dashboard, WSO2 DS automatically creates a default page named Home. Update the properties related to a page as follows:

1. If you are not in the process of creating a dashboard, navigate to the Dashboard Designer home page, and click Design to edit the design of a dashboard.
2. Click Pages.
   
3. Click on the respective page name. 
   
4. Edit the page related properties as required.
   • Title - Name of the page. When a new page is created, by default it is given a generic name (e.g., Page 0, Page 1, etc.). Replace the generic page name with a meaningful name.
   • URL - This is the URL context that is used to access this specific page in the dashboard.
     Format:
     http://<DS_HTTP_HOST>:<HTTP_PORT>/portal/dashboards/<DASHBOARD_NAME_URL_CONTEXT>/<PAGE_NAME_URL_CONTEXT> https://<DS_HTTPS_HOST>:<HTTPS_PORT>/portal/dashboards/<DASHBOARD_NAME_URL_CONTEXT>/<PAGE_NAME_URL_CONTEXT>
     
     Example:
     https://localhost:9443/portal/dashboards/sales-stats/sales-targets
   • Use as Landing - Select this option if you want this page to be the very first page that appears when a user accesses the dashboard.
   • Make Anonymous - Select this option if you want anonymous users to access this page without having to log into the WSO2 Dashboard Server.
   • Full Width - Select this option if you want the page to be displayed in full screen mode without any margins.

Changing user preferences of a gadget

When a dashboard editor changes the userPreferences in the dashboard view page, the changes are saved in the original registry space of the dashboard. 

1. If you are not in the process of creating a dashboard, navigate to the Dashboard Designer home page, and click View to view the dashboard.
   

2. Click Properties.

   The properties button only appears if user preferences are defined, using the <UserPref> tags, in the gadget definition XML file.

3. Enter the required user preference properties.
   You can use the user preference properties, which vary from gadget to gadget, to customize the gadget. 
   For example, when using a text-box gadget, you can customize the wording that appears within the text-box.
   
4. Click Properties.
   The changes are saved to the userPrefs of that particular gadget. In addition, the gadget view is also updated based the new preferences.  

Removing a block in a dashboard

1. If you are not in the process of creating a dashboard, navigate to the Dashboard Designer home page, and click Design to edit the design of the respective dashboard.
2. Click Remove, which appears in the block title bar. 
   
3. Select your delete preference and click Delete.
   • The following message-box appears when you are trying to delete a block that already has a gadget.
     
   • The following message-box appears when you are trying to delete an empty block.
      

Removing a page in a dashboard

1. If you are not in the process of creating a dashboard, navigate to the Dashboard Designer home page, and click Design to edit the design of the respective dashboard.
    
2. Click Next and Previous to navigate to the required page.
3. Click Remove. 
4. Click Yes to confirm the deletion process.